3 # Copyright 2000-2002 Katipo Communications
5 # This file is part of Koha.
7 # Koha is free software; you can redistribute it and/or modify it
8 # under the terms of the GNU General Public License as published by
9 # the Free Software Foundation; either version 3 of the License, or
10 # (at your option) any later version.
12 # Koha is distributed in the hope that it will be useful, but
13 # WITHOUT ANY WARRANTY; without even the implied warranty of
14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 # GNU General Public License for more details.
17 # You should have received a copy of the GNU General Public License
18 # along with Koha; if not, see <http://www.gnu.org/licenses>.
24 use Digest::MD5 qw( md5_base64 );
26 use CGI::Session::ErrorHandler;
31 use C4::Templates; # to get the template
33 use C4::Search::History;
37 use Koha::AuthUtils qw( get_script_name hash_password );
38 use Koha::Auth::TwoFactorAuth;
40 use Koha::DateUtils qw( dt_from_string );
41 use Koha::Library::Groups;
43 use Koha::Cash::Registers;
46 use Koha::Patron::Consents;
47 use List::MoreUtils qw( any );
49 use C4::Auth_with_shibboleth qw( shib_ok get_login_shib login_shib_url logout_shib checkpw_shib );
51 use C4::Log qw( logaction );
52 use Koha::CookieManager;
53 use Koha::Auth::Permissions;
58 use vars qw($ldap $cas $caslogout);
59 our (@ISA, @EXPORT_OK);
61 #NOTE: The utility of keeping the safe_exit function is that it can be easily re-defined in unit tests and plugins
63 # It's fine for us to "exit" because CGI::Compile (used in Plack::App::WrapCGI) redefines "exit" for us automatically.
64 # Since we only seem to use C4::Auth::safe_exit in a CGI context, we don't actually need PSGI detection at all here.
70 C4::Context->set_remote_address;
76 checkauth check_api_auth get_session check_cookie_auth checkpw checkpw_internal checkpw_hash
77 get_all_subpermissions get_cataloguing_page_permissions get_user_subpermissions track_login_daily in_iprange
78 get_template_and_user haspermission create_basic_session
81 $ldap = C4::Context->config('useldapserver') || 0;
82 $cas = C4::Context->preference('casAuthentication');
83 $caslogout = C4::Context->preference('casLogout');
86 require C4::Auth_with_ldap;
87 import C4::Auth_with_ldap qw(checkpw_ldap);
90 require C4::Auth_with_cas; # no import
91 import C4::Auth_with_cas qw(check_api_auth_cas checkpw_cas login_cas logout_cas login_cas_url logout_if_required multipleAuth getMultipleAuth);
98 C4::Auth - Authenticates Koha users
102 use CGI qw ( -utf8 );
106 my $query = CGI->new;
108 my ($template, $borrowernumber, $cookie)
109 = get_template_and_user(
111 template_name => "opac-main.tt",
114 authnotrequired => 0,
115 flagsrequired => { catalogue => '*', tools => 'import_patrons' },
119 output_html_with_http_headers $query, $cookie, $template->output;
123 The main function of this module is to provide
124 authentification. However the get_template_and_user function has
125 been provided so that a users login information is passed along
126 automatically. This gets loaded into the template.
130 =head2 get_template_and_user
132 my ($template, $borrowernumber, $cookie)
133 = get_template_and_user(
135 template_name => "opac-main.tt",
138 authnotrequired => 0,
139 flagsrequired => { catalogue => '*', tools => 'import_patrons' },
143 This call passes the C<query>, C<flagsrequired> and C<authnotrequired>
144 to C<&checkauth> (in this module) to perform authentification.
145 See C<&checkauth> for an explanation of these parameters.
147 The C<template_name> is then used to find the correct template for
148 the page. The authenticated users details are loaded onto the
149 template in the logged_in_user variable (which is a Koha::Patron object). Also the
150 C<sessionID> is passed to the template. This can be used in templates
151 if cookies are disabled. It needs to be put as and input to every
154 More information on the C<gettemplate> sub can be found in the
159 sub get_template_and_user {
162 my ( $user, $cookie, $sessionID, $flags );
165 my $cookie_mgr = Koha::CookieManager->new;
167 # Get shibboleth login attribute
168 my $shib = C4::Context->config('useshibboleth') && shib_ok();
169 my $shib_login = $shib ? get_login_shib() : undef;
171 C4::Context->interface( $in->{type} );
173 $in->{'authnotrequired'} ||= 0;
175 # the following call includes a bad template check; might croak
176 my $template = C4::Templates::gettemplate(
177 $in->{'template_name'},
182 if ( $in->{'template_name'} !~ m/maintenance/ ) {
183 ( $user, $cookie, $sessionID, $flags ) = checkauth(
185 $in->{'authnotrequired'},
186 $in->{'flagsrequired'},
189 $in->{template_name},
193 # If we enforce GDPR and the user did not consent, redirect
194 # Exceptions for consent page itself and SCI/SCO system
195 if( $in->{type} eq 'opac' && $user &&
196 $in->{'template_name'} !~ /^(opac-page|opac-patron-consent|sc[io]\/)/ &&
197 C4::Context->preference('PrivacyPolicyConsent') eq 'Enforced' )
199 my $consent = Koha::Patron::Consents->search({
200 borrowernumber => getborrowernumber($user),
201 type => 'GDPR_PROCESSING',
202 given_on => { '!=', undef },
205 print $in->{query}->redirect(-uri => '/cgi-bin/koha/opac-patron-consent.pl', -cookie => $cookie);
210 if ( $in->{type} eq 'opac' && $user ) {
213 my $session = get_session($sessionID);
215 $is_sco_user = $session->param('sco_user');
221 # If the user logged in is the SCO user and they try to go out of the SCO module,
222 # log the user out removing the CGISESSID cookie
223 $in->{template_name} !~ m|sco/| && $in->{template_name} !~ m|errors/errorpage.tt|
227 C4::Context->preference('AutoSelfCheckID')
228 && $user eq C4::Context->preference('AutoSelfCheckID')
236 # If the user logged in is the SCI user and they try to go out of the SCI module,
237 # kick them out unless it is SCO with a valid permission
238 # or they are a superlibrarian
239 $in->{template_name} !~ m|sci/|
240 && haspermission( $user, { self_check => 'self_checkin_module' } )
242 $in->{template_name} =~ m|sco/| && haspermission(
243 $user, { self_check => 'self_checkout_module' }
246 && $flags && $flags->{superlibrarian} != 1
253 $template = C4::Templates::gettemplate( 'opac-auth.tt', 'opac',
255 $cookie = $cookie_mgr->replace_in_list( $cookie, $in->{query}->cookie(
256 -name => 'CGISESSID',
259 -secure => ( C4::Context->https_enabled() ? 1 : 0 ),
263 #NOTE: This JWT should only be used by the self-check controllers
264 $cookie = $cookie_mgr->replace_in_list( $cookie, $in->{query}->cookie(
268 -secure => ( C4::Context->https_enabled() ? 1 : 0 ),
272 my $auth_error = $in->{query}->param('auth_error');
276 script_name => get_script_name(),
277 auth_error => $auth_error,
280 print $in->{query}->header(
285 'X-Frame-Options' => 'SAMEORIGIN'
296 # It's possible for $user to be the borrowernumber if they don't have a
297 # userid defined (and are logging in through some other method, such
298 # as SSL certs against an email address)
300 $borrowernumber = getborrowernumber($user) if defined($user);
301 if ( !defined($borrowernumber) && defined($user) ) {
302 $patron = Koha::Patrons->find( $user );
304 $borrowernumber = $user;
306 # A bit of a hack, but I don't know there's a nicer way
308 $user = $patron->firstname . ' ' . $patron->surname;
311 $patron = Koha::Patrons->find( $borrowernumber );
312 # FIXME What to do if $patron does not exist?
316 $template->param( loggedinusername => $user ); # OBSOLETE - Do not reuse this in template, use logged_in_user.userid instead
317 $template->param( loggedinusernumber => $borrowernumber ); # FIXME Should be replaced with logged_in_user.borrowernumber
318 $template->param( logged_in_user => $patron );
319 $template->param( sessionID => $sessionID );
321 if ( $in->{'type'} eq 'opac' ) {
322 require Koha::Virtualshelves;
323 my $some_private_shelves = Koha::Virtualshelves->get_some_shelves(
325 borrowernumber => $borrowernumber,
329 my $some_public_shelves = Koha::Virtualshelves->get_some_shelves(
335 some_private_shelves => $some_private_shelves,
336 some_public_shelves => $some_public_shelves,
340 # We are going to use the $flags returned by checkauth
341 # to create the template's parameters that will indicate
342 # which menus the user can access.
343 my $authz = Koha::Auth::Permissions->get_authz_from_flags({ flags => $flags });
344 foreach my $permission ( keys %{ $authz } ){
345 $template->param( $permission => $authz->{$permission} );
348 # Logged-in opac search history
349 # If the requested template is an opac one and opac search history is enabled
350 if ( $in->{type} eq 'opac' && C4::Context->preference('EnableOpacSearchHistory') ) {
351 my $dbh = C4::Context->dbh;
352 my $query = "SELECT COUNT(*) FROM search_history WHERE userid=?";
353 my $sth = $dbh->prepare($query);
354 $sth->execute($borrowernumber);
356 # If at least one search has already been performed
357 if ( $sth->fetchrow_array > 0 ) {
359 # We show the link in opac
360 $template->param( EnableOpacSearchHistory => 1 );
362 if (C4::Context->preference('LoadSearchHistoryToTheFirstLoggedUser'))
364 # And if there are searches performed when the user was not logged in,
365 # we add them to the logged-in search history
366 my @recentSearches = C4::Search::History::get_from_session( { cgi => $in->{'query'} } );
367 if (@recentSearches) {
369 INSERT INTO search_history(userid, sessionid, query_desc, query_cgi, type, total, time )
370 VALUES (?, ?, ?, ?, ?, ?, ?)
372 my $sth = $dbh->prepare($query);
373 $sth->execute( $borrowernumber,
374 $in->{query}->cookie("CGISESSID"),
377 $_->{type} || 'biblio',
380 ) foreach @recentSearches;
382 # clear out the search history from the session now that
383 # we've saved it to the database
386 C4::Search::History::set_to_session( { cgi => $in->{'query'}, search_history => [] } );
388 } elsif ( $in->{type} eq 'intranet' and C4::Context->preference('EnableSearchHistory') ) {
389 $template->param( EnableSearchHistory => 1 );
392 else { # if this is an anonymous session, setup to display public lists...
394 # If shibboleth is enabled, and we're in an anonymous session, we should allow
395 # the user to attempt login via shibboleth.
397 $template->param( shibbolethAuthentication => $shib,
398 shibbolethLoginUrl => login_shib_url( $in->{'query'} ),
401 # If shibboleth is enabled and we have a shibboleth login attribute,
402 # but we are in an anonymous session, then we clearly have an invalid
403 # shibboleth koha account.
405 $template->param( invalidShibLogin => '1' );
409 $template->param( sessionID => $sessionID );
411 if ( $in->{'type'} eq 'opac' ){
412 require Koha::Virtualshelves;
413 my $some_public_shelves = Koha::Virtualshelves->get_some_shelves(
419 some_public_shelves => $some_public_shelves,
422 # Set default branch if one has been passed by the environment.
423 $template->param( default_branch => $ENV{OPAC_BRANCH_DEFAULT} ) if $ENV{OPAC_BRANCH_DEFAULT};
427 # Sysprefs disabled via URL param
428 # Note that value must be defined in order to override via ENV
429 foreach my $syspref (
435 OpacAdditionalStylesheet
437 intranetcolorstylesheet
442 $ENV{"OVERRIDE_SYSPREF_$syspref"} = q{}
443 if $in->{'query'}->param("DISABLE_SYSPREF_$syspref");
446 # Anonymous opac search history
447 # If opac search history is enabled and at least one search has already been performed
448 if ( C4::Context->preference('EnableOpacSearchHistory') ) {
449 my @recentSearches = C4::Search::History::get_from_session( { cgi => $in->{'query'} } );
450 if (@recentSearches) {
451 $template->param( EnableOpacSearchHistory => 1 );
455 if ( C4::Context->preference('dateformat') ) {
456 $template->param( dateformat => C4::Context->preference('dateformat') );
459 $template->param(auth_forwarded_hash => scalar $in->{'query'}->param('auth_forwarded_hash'));
461 # these template parameters are set the same regardless of $in->{'type'}
463 my $minPasswordLength = C4::Context->preference('minPasswordLength');
464 $minPasswordLength = 3 if not $minPasswordLength or $minPasswordLength < 3;
466 EnhancedMessagingPreferences => C4::Context->preference('EnhancedMessagingPreferences'),
467 GoogleJackets => C4::Context->preference("GoogleJackets"),
468 OpenLibraryCovers => C4::Context->preference("OpenLibraryCovers"),
469 KohaAdminEmailAddress => "" . C4::Context->preference("KohaAdminEmailAddress"),
470 LoginFirstname => ( C4::Context->userenv ? C4::Context->userenv->{"firstname"} : "Bel" ),
471 LoginSurname => C4::Context->userenv ? C4::Context->userenv->{"surname"} : "Inconnu",
472 emailaddress => C4::Context->userenv ? C4::Context->userenv->{"emailaddress"} : undef,
473 TagsEnabled => C4::Context->preference("TagsEnabled"),
474 hide_marc => C4::Context->preference("hide_marc"),
475 item_level_itypes => C4::Context->preference('item-level_itypes'),
476 patronimages => C4::Context->preference("patronimages"),
477 singleBranchMode => ( Koha::Libraries->search->count == 1 ),
478 noItemTypeImages => C4::Context->preference("noItemTypeImages"),
479 marcflavour => C4::Context->preference("marcflavour"),
480 OPACBaseURL => C4::Context->preference('OPACBaseURL'),
481 minPasswordLength => $minPasswordLength,
483 if ( $in->{'type'} eq "intranet" ) {
486 advancedMARCEditor => C4::Context->preference("advancedMARCEditor"),
487 AllowMultipleCovers => C4::Context->preference('AllowMultipleCovers'),
488 AmazonCoverImages => C4::Context->preference("AmazonCoverImages"),
489 AutoLocation => C4::Context->preference("AutoLocation"),
490 can_see_cataloguing_module => haspermission( $user, get_cataloguing_page_permissions() ) ? 1 : 0,
491 canreservefromotherbranches => C4::Context->preference('canreservefromotherbranches'),
492 EasyAnalyticalRecords => C4::Context->preference('EasyAnalyticalRecords'),
493 EnableBorrowerFiles => C4::Context->preference('EnableBorrowerFiles'),
494 FRBRizeEditions => C4::Context->preference("FRBRizeEditions"),
495 IndependentBranches => C4::Context->preference("IndependentBranches"),
496 intranetcolorstylesheet => C4::Context->preference("intranetcolorstylesheet"),
497 IntranetFavicon => C4::Context->preference("IntranetFavicon"),
498 IntranetmainUserblock => C4::Context->preference("IntranetmainUserblock"),
499 IntranetNav => C4::Context->preference("IntranetNav"),
500 intranetreadinghistory => C4::Context->preference("intranetreadinghistory"),
501 intranetstylesheet => C4::Context->preference("intranetstylesheet"),
502 IntranetUserCSS => C4::Context->preference("IntranetUserCSS"),
503 IntranetUserJS => C4::Context->preference("IntranetUserJS"),
504 LibraryName => C4::Context->preference("LibraryName"),
505 LocalCoverImages => C4::Context->preference('LocalCoverImages'),
506 OPACLocalCoverImages => C4::Context->preference('OPACLocalCoverImages'),
507 PatronAutoComplete => C4::Context->preference("PatronAutoComplete"),
508 pending_checkout_notes => Koha::Checkouts->search( { noteseen => 0 } ),
509 plugins_enabled => C4::Context->config("enable_plugins"),
510 StaffSerialIssueDisplayCount => C4::Context->preference("StaffSerialIssueDisplayCount"),
511 UseCourseReserves => C4::Context->preference("UseCourseReserves"),
512 useDischarge => C4::Context->preference('useDischarge'),
513 virtualshelves => C4::Context->preference("virtualshelves"),
517 warn "template type should be OPAC, here it is=[" . $in->{'type'} . "]" unless ( $in->{'type'} eq 'opac' );
519 #TODO : replace LibraryName syspref with 'system name', and remove this html processing
520 my $LibraryNameTitle = C4::Context->preference("LibraryName");
521 $LibraryNameTitle =~ s/<(?:\/?)(?:br|p)\s*(?:\/?)>/ /sgi;
522 $LibraryNameTitle =~ s/<(?:[^<>'"]|'(?:[^']*)'|"(?:[^"]*)")*>//sg;
524 # clean up the busc param in the session
525 # if the page is not opac-detail and not the "add to list" page
526 # and not the "edit comments" page
527 if ( C4::Context->preference("OpacBrowseResults")
528 && $in->{'template_name'} =~ /opac-(.+)\.(?:tt|tmpl)$/ ) {
530 unless ( $pagename =~ /^(?:MARC|ISBD)?detail$/
531 or $pagename =~ /^showmarc$/
532 or $pagename =~ /^addbybiblionumber$/
533 or $pagename =~ /^review$/ )
535 my $sessionSearch = get_session( $sessionID );
536 $sessionSearch->clear( ["busc"] ) if $sessionSearch;
540 # variables passed from CGI: opac_css_override and opac_search_limits.
541 my $opac_search_limit = $ENV{'OPAC_SEARCH_LIMIT'};
542 my $opac_limit_override = $ENV{'OPAC_LIMIT_OVERRIDE'};
545 ( $opac_limit_override && $opac_search_limit && $opac_search_limit =~ /branch:([\w-]+)/ ) ||
546 ( $in->{'query'}->param('limit') && $in->{'query'}->param('limit') =~ /branch:([\w-]+)/ ) ||
547 ( $in->{'query'}->param('limit') && $in->{'query'}->param('limit') =~ /multibranchlimit:(\w+)/ )
549 $opac_name = $1; # opac_search_limit is a branch, so we use it.
550 } elsif ( $in->{'query'}->param('multibranchlimit') ) {
551 $opac_name = $in->{'query'}->param('multibranchlimit');
552 } elsif ( C4::Context->preference("SearchMyLibraryFirst") && C4::Context->userenv && C4::Context->userenv->{'branch'} ) {
553 $opac_name = C4::Context->userenv->{'branch'};
556 # Decide if the patron can make suggestions in the OPAC
557 my $can_make_suggestions;
558 if ( C4::Context->preference('Suggestion') && C4::Context->preference('AnonSuggestions') ) {
559 $can_make_suggestions = 1;
560 } elsif ( C4::Context->userenv && C4::Context->userenv->{'number'} ) {
561 $can_make_suggestions = Koha::Patrons->find(C4::Context->userenv->{'number'})->category->can_make_suggestions;
564 my @search_groups = Koha::Library::Groups->get_search_groups({ interface => 'opac' })->as_list;
566 AnonSuggestions => "" . C4::Context->preference("AnonSuggestions"),
567 LibrarySearchGroups => \@search_groups,
568 opac_name => $opac_name,
569 LibraryName => "" . C4::Context->preference("LibraryName"),
570 LibraryNameTitle => "" . $LibraryNameTitle,
571 OPACAmazonCoverImages => C4::Context->preference("OPACAmazonCoverImages"),
572 OPACFRBRizeEditions => C4::Context->preference("OPACFRBRizeEditions"),
573 OpacHighlightedWords => C4::Context->preference("OpacHighlightedWords"),
574 OPACShelfBrowser => "" . C4::Context->preference("OPACShelfBrowser"),
575 OPACURLOpenInNewWindow => "" . C4::Context->preference("OPACURLOpenInNewWindow"),
576 OPACUserCSS => "" . C4::Context->preference("OPACUserCSS"),
577 OpacAuthorities => C4::Context->preference("OpacAuthorities"),
578 opac_css_override => $ENV{'OPAC_CSS_OVERRIDE'},
579 opac_search_limit => $opac_search_limit,
580 opac_limit_override => $opac_limit_override,
581 OpacBrowser => C4::Context->preference("OpacBrowser"),
582 OpacCloud => C4::Context->preference("OpacCloud"),
583 OpacKohaUrl => C4::Context->preference("OpacKohaUrl"),
584 OpacPasswordChange => C4::Context->preference("OpacPasswordChange"),
585 OPACPatronDetails => C4::Context->preference("OPACPatronDetails"),
586 OPACPrivacy => C4::Context->preference("OPACPrivacy"),
587 OPACFinesTab => C4::Context->preference("OPACFinesTab"),
588 OpacTopissue => C4::Context->preference("OpacTopissue"),
589 'Version' => C4::Context->preference('Version'),
590 hidelostitems => C4::Context->preference("hidelostitems"),
591 mylibraryfirst => ( C4::Context->preference("SearchMyLibraryFirst") && C4::Context->userenv ) ? C4::Context->userenv->{'branch'} : '',
592 opacbookbag => "" . C4::Context->preference("opacbookbag"),
593 OpacFavicon => C4::Context->preference("OpacFavicon"),
594 opaclanguagesdisplay => "" . C4::Context->preference("opaclanguagesdisplay"),
595 opacreadinghistory => C4::Context->preference("opacreadinghistory"),
596 OPACUserJS => C4::Context->preference("OPACUserJS"),
597 opacuserlogin => "" . C4::Context->preference("opacuserlogin"),
598 OpenLibrarySearch => C4::Context->preference("OpenLibrarySearch"),
599 ShowReviewer => C4::Context->preference("ShowReviewer"),
600 ShowReviewerPhoto => C4::Context->preference("ShowReviewerPhoto"),
601 suggestion => $can_make_suggestions,
602 virtualshelves => "" . C4::Context->preference("virtualshelves"),
603 OPACSerialIssueDisplayCount => C4::Context->preference("OPACSerialIssueDisplayCount"),
604 SyndeticsClientCode => C4::Context->preference("SyndeticsClientCode"),
605 SyndeticsEnabled => C4::Context->preference("SyndeticsEnabled"),
606 SyndeticsCoverImages => C4::Context->preference("SyndeticsCoverImages"),
607 SyndeticsTOC => C4::Context->preference("SyndeticsTOC"),
608 SyndeticsSummary => C4::Context->preference("SyndeticsSummary"),
609 SyndeticsEditions => C4::Context->preference("SyndeticsEditions"),
610 SyndeticsExcerpt => C4::Context->preference("SyndeticsExcerpt"),
611 SyndeticsReviews => C4::Context->preference("SyndeticsReviews"),
612 SyndeticsAuthorNotes => C4::Context->preference("SyndeticsAuthorNotes"),
613 SyndeticsAwards => C4::Context->preference("SyndeticsAwards"),
614 SyndeticsSeries => C4::Context->preference("SyndeticsSeries"),
615 SyndeticsCoverImageSize => C4::Context->preference("SyndeticsCoverImageSize"),
616 OPACLocalCoverImages => C4::Context->preference("OPACLocalCoverImages"),
617 PatronSelfRegistration => C4::Context->preference("PatronSelfRegistration"),
618 PatronSelfRegistrationDefaultCategory => C4::Context->preference("PatronSelfRegistrationDefaultCategory"),
619 useDischarge => C4::Context->preference('useDischarge'),
622 $template->param( OpacPublic => '1' ) if ( $user || C4::Context->preference("OpacPublic") );
625 # Check if we were asked using parameters to force a specific language
626 if ( defined $in->{'query'}->param('language') ) {
628 # Extract the language, let C4::Languages::getlanguage choose
630 my $language = C4::Languages::getlanguage( $in->{'query'} );
631 my $languagecookie = C4::Templates::getlanguagecookie( $in->{'query'}, $language );
632 $cookie = $cookie_mgr->replace_in_list( $cookie, $languagecookie );
635 return ( $template, $borrowernumber, $cookie, $flags );
640 ($userid, $cookie, $sessionID) = &checkauth($query, $noauth, $flagsrequired, $type);
642 Verifies that the user is authorized to run this script. If
643 the user is authorized, a (userid, cookie, session-id, flags)
644 quadruple is returned. If the user is not authorized but does
645 not have the required privilege (see $flagsrequired below), it
646 displays an error page and exits. Otherwise, it displays the
647 login page and exits.
649 Note that C<&checkauth> will return if and only if the user
650 is authorized, so it should be called early on, before any
651 unfinished operations (e.g., if you've opened a file, then
652 C<&checkauth> won't close it for you).
654 C<$query> is the CGI object for the script calling C<&checkauth>.
656 The C<$noauth> argument is optional. If it is set, then no
657 authorization is required for the script.
659 C<&checkauth> fetches user and session information from C<$query> and
660 ensures that the user is authorized to run scripts that require
663 The C<$flagsrequired> argument specifies the required privileges
664 the user must have if the username and password are correct.
665 It should be specified as a reference-to-hash; keys in the hash
666 should be the "flags" for the user, as specified in the Members
667 intranet module. Any key specified must correspond to a "flag"
668 in the userflags table. E.g., { circulate => 1 } would specify
669 that the user must have the "circulate" privilege in order to
670 proceed. To make sure that access control is correct, the
671 C<$flagsrequired> parameter must be specified correctly.
673 Koha also has a concept of sub-permissions, also known as
674 granular permissions. This makes the value of each key
675 in the C<flagsrequired> hash take on an additional
680 The user must have access to all subfunctions of the module
681 specified by the hash key.
685 The user must have access to at least one subfunction of the module
686 specified by the hash key.
688 specific permission, e.g., 'export_catalog'
690 The user must have access to the specific subfunction list, which
691 must correspond to a row in the permissions table.
693 The C<$type> argument specifies whether the template should be
694 retrieved from the opac or intranet directory tree. "opac" is
695 assumed if it is not specified; however, if C<$type> is specified,
696 "intranet" is assumed if it is not "opac".
698 If C<$query> does not have a valid session ID associated with it
699 (i.e., the user has not logged in) or if the session has expired,
700 C<&checkauth> presents the user with a login page (from the point of
701 view of the original script, C<&checkauth> does not return). Once the
702 user has authenticated, C<&checkauth> restarts the original script
703 (this time, C<&checkauth> returns).
705 The login page is provided using a HTML::Template, which is set in the
706 systempreferences table or at the top of this file. The variable C<$type>
707 selects which template to use, either the opac or the intranet
708 authentification template.
710 C<&checkauth> returns a user ID, a cookie, and a session ID. The
711 cookie should be sent back to the browser; it verifies that the user
721 # If version syspref is unavailable, it means Koha is being installed,
722 # and so we must redirect to OPAC maintenance page or to the WebInstaller
723 # also, if OpacMaintenance is ON, OPAC should redirect to maintenance
724 if ( C4::Context->preference('OpacMaintenance') && $type eq 'opac' ) {
725 warn "OPAC Install required, redirecting to maintenance";
726 print $query->redirect("/cgi-bin/koha/maintenance.pl");
729 unless ( $version = C4::Context->preference('Version') ) { # assignment, not comparison
730 if ( $type ne 'opac' ) {
731 warn "Install required, redirecting to Installer";
732 print $query->redirect("/cgi-bin/koha/installer/install.pl");
734 warn "OPAC Install required, redirecting to maintenance";
735 print $query->redirect("/cgi-bin/koha/maintenance.pl");
740 # check that database and koha version are the same
741 # there is no DB version, it's a fresh install,
742 # go to web installer
743 # there is a DB version, compare it to the code version
744 my $kohaversion = Koha::version();
746 # remove the 3 last . to have a Perl number
747 $kohaversion =~ s/(.*\..*)\.(.*)\.(.*)/$1$2$3/;
748 Koha::Logger->get->debug("kohaversion : $kohaversion");
749 if ( $version < $kohaversion ) {
750 my $warning = "Database update needed, redirecting to %s. Database is $version and Koha is $kohaversion";
751 if ( $type ne 'opac' ) {
752 warn sprintf( $warning, 'Installer' );
753 print $query->redirect("/cgi-bin/koha/installer/install.pl?step=1&op=updatestructure");
755 warn sprintf( "OPAC: " . $warning, 'maintenance' );
756 print $query->redirect("/cgi-bin/koha/maintenance.pl");
762 sub _timeout_syspref {
763 my $default_timeout = 600;
764 my $timeout = C4::Context->preference('timeout') || $default_timeout;
766 # value in days, convert in seconds
767 if ( $timeout =~ /^(\d+)[dD]$/ ) {
768 $timeout = $1 * 86400;
770 # value in hours, convert in seconds
771 elsif ( $timeout =~ /^(\d+)[hH]$/ ) {
772 $timeout = $1 * 3600;
774 elsif ( $timeout !~ m/^\d+$/ ) {
775 warn "The value of the system preference 'timeout' is not correct, defaulting to $default_timeout";
776 $timeout = $default_timeout;
785 # Get shibboleth login attribute
786 my $shib = C4::Context->config('useshibboleth') && shib_ok();
787 my $shib_login = $shib ? get_login_shib() : undef;
789 # $authnotrequired will be set for scripts which will run without authentication
790 my $authnotrequired = shift;
791 my $flagsrequired = shift;
793 my $emailaddress = shift;
794 my $template_name = shift;
795 $type = 'opac' unless $type;
797 if ( $type eq 'opac' && !C4::Context->preference("OpacPublic") ) {
798 my @allowed_scripts_for_private_opac = qw(
800 opac-registration-email-sent.tt
801 opac-registration-confirmation.tt
802 opac-memberentry-update-submitted.tt
803 opac-password-recovery.tt
804 opac-reset-password.tt
806 $authnotrequired = 0 unless grep { $_ eq $template_name }
807 @allowed_scripts_for_private_opac;
810 my $timeout = _timeout_syspref();
812 my $cookie_mgr = Koha::CookieManager->new;
814 _version_check( $type, $query );
818 my $auth_state = 'failed';
820 my ( $userid, $cookie, $sessionID, $flags );
822 my $logout = $query->param('logout.x');
824 my $anon_search_history;
826 # This parameter is the name of the CAS server we want to authenticate against,
827 # when using authentication against multiple CAS servers, as configured in Auth_cas_servers.yaml
828 my $casparam = $query->param('cas');
829 my $q_userid = $query->param('userid') // '';
832 my $invalid_otp_token;
834 ( $type ne "opac" # Only available for the staff interface
835 && C4::Context->preference('TwoFactorAuthentication') ne "disabled" ) # If "enabled" or "enforced"
838 # Basic authentication is incompatible with the use of Shibboleth,
839 # as Shibboleth may return REMOTE_USER as a Shibboleth attribute,
840 # and it may not be the attribute we want to use to match the koha login.
842 # Also, do not consider an empty REMOTE_USER.
844 # Finally, after those tests, we can assume (although if it would be better with
845 # a syspref) that if we get a REMOTE_USER, that's from basic authentication,
846 # and we can affect it to $userid.
847 if ( !$shib and defined( $ENV{'REMOTE_USER'} ) and $ENV{'REMOTE_USER'} ne '' and $userid = $ENV{'REMOTE_USER'} ) {
849 # Using Basic Authentication, no cookies required
850 $cookie = $cookie_mgr->replace_in_list( $cookie, $query->cookie(
851 -name => 'CGISESSID',
854 -secure => ( C4::Context->https_enabled() ? 1 : 0 ),
859 elsif ( $emailaddress) {
860 # the Google OpenID Connect passes an email address
862 elsif ( $sessionID = $query->cookie("CGISESSID") ) { # assignment, not comparison
863 my ( $return, $more_info );
864 # NOTE: $flags in the following call is still undefined !
865 ( $return, $session, $more_info ) = check_cookie_auth( $sessionID, $flags,
866 { remote_addr => $ENV{REMOTE_ADDR}, skip_version_check => 1 }
869 if ( $return eq 'ok' || $return eq 'additional-auth-needed' ) {
870 $userid = $session->param('id');
874 $return eq 'ok' ? 'completed'
875 : $return eq 'additional-auth-needed' ? 'additional-auth-needed'
878 # We are at the second screen if the waiting-for-2FA is set in session
879 # and otp_token param has been passed
881 && $auth_state eq 'additional-auth-needed'
882 && ( my $otp_token = $query->param('otp_token') ) )
884 my $patron = Koha::Patrons->find( { userid => $userid } );
885 my $auth = Koha::Auth::TwoFactorAuth->new( { patron => $patron } );
886 my $verified = $auth->verify($otp_token);
889 # The token is correct, the user is fully logged in!
890 $auth_state = 'completed';
891 $session->param( 'waiting-for-2FA', 0 );
892 $session->param( 'waiting-for-2FA-setup', 0 );
894 # This is an ugly trick to pass the test
895 # $query->param('koha_login_context') && ( $q_userid ne $userid )
900 $invalid_otp_token = 1;
904 if ( $auth_state eq 'completed' ) {
905 Koha::Logger->get->debug(sprintf "AUTH_SESSION: (%s)\t%s %s - %s", map { $session->param($_) || q{} } qw(cardnumber firstname surname branch));
907 if ( ( $query->param('koha_login_context') && ( $q_userid ne $userid ) )
908 || ( $cas && $query->param('ticket') && !C4::Context->userenv->{'id'} )
909 || ( $shib && $shib_login && !$logout && !C4::Context->userenv->{'id'} )
912 #if a user enters an id ne to the id in the current session, we need to log them in...
913 #first we need to clear the anonymous session...
914 $anon_search_history = $session->param('search_history');
917 $cookie = $cookie_mgr->clear_unless( $query->cookie, @$cookie );
918 C4::Context::_unset_userenv($sessionID);
920 undef $userid; # IMPORTANT: this assures us a new session in code below
921 $auth_state = 'failed';
924 $cookie = $cookie_mgr->replace_in_list( $cookie, $query->cookie(
925 -name => 'CGISESSID',
926 -value => $session->id,
928 -secure => ( C4::Context->https_enabled() ? 1 : 0 ),
932 $flags = haspermission( $userid, $flagsrequired );
934 $auth_state = 'failed';
935 $info{'nopermission'} = 1;
938 } elsif ( !$logout ) {
939 if ( $return eq 'expired' ) {
940 $info{timed_out} = 1;
941 } elsif ( $return eq 'restricted' ) {
942 $info{oldip} = $more_info->{old_ip};
943 $info{newip} = $more_info->{new_ip};
944 $info{different_ip} = 1;
945 } elsif ( $return eq 'password_expired' ) {
946 $info{password_has_expired} = 1;
951 if ( $auth_state eq 'failed' || $logout ) {
958 # voluntary logout the user
959 # check wether the user was using their shibboleth session or a local one
960 my $shibSuccess = C4::Context->userenv ? C4::Context->userenv->{'shibboleth'} : undef;
965 C4::Context::_unset_userenv($sessionID);
966 $cookie = $cookie_mgr->clear_unless( $query->cookie, @$cookie );
968 if ($cas and $caslogout) {
969 logout_cas($query, $type);
972 # If we are in a shibboleth session (shibboleth is enabled, a shibboleth match attribute is set and matches koha matchpoint)
973 if ( $shib and $shib_login and $shibSuccess) {
978 $auth_state = 'logout';
982 #we initiate a session prior to checking for a username to allow for anonymous sessions...
983 if( !$session or !$sessionID ) { # if we cleared sessionID, we need a new session
984 $session = get_session() or die "Auth ERROR: Cannot get_session()";
987 # Save anonymous search history in new session so it can be retrieved
988 # by get_template_and_user to store it in user's search history after
989 # a successful login.
990 if ($anon_search_history) {
991 $session->param( 'search_history', $anon_search_history );
994 $sessionID = $session->id;
995 C4::Context->_new_userenv($sessionID);
996 $cookie = $cookie_mgr->replace_in_list( $cookie, $query->cookie(
997 -name => 'CGISESSID',
998 -value => $sessionID,
1000 -secure => ( C4::Context->https_enabled() ? 1 : 0 ),
1003 my $pki_field = C4::Context->preference('AllowPKIAuth');
1004 if ( !defined($pki_field) ) {
1005 print STDERR "ERROR: Missing system preference AllowPKIAuth.\n";
1006 $pki_field = 'None';
1008 if ( ( $cas && $query->param('ticket') )
1010 || ( $shib && $shib_login )
1011 || $pki_field ne 'None'
1014 my $password = $query->param('password');
1015 my $shibSuccess = 0;
1016 my ( $return, $cardnumber );
1018 # If shib is enabled and we have a shib login, does the login match a valid koha user
1019 if ( $shib && $shib_login ) {
1022 # Do not pass password here, else shib will not be checked in checkpw.
1023 ( $return, $cardnumber, $retuserid ) = checkpw( $q_userid, undef, $query );
1024 $userid = $retuserid;
1025 $shibSuccess = $return;
1026 $info{'invalidShibLogin'} = 1 unless ($return);
1029 # If shib login and match were successful, skip further login methods
1030 unless ($shibSuccess) {
1031 if ( $cas && $query->param('ticket') ) {
1033 ( $return, $cardnumber, $retuserid, $cas_ticket ) =
1034 checkpw( $userid, $password, $query, $type );
1035 $userid = $retuserid;
1036 $info{'invalidCasLogin'} = 1 unless ($return);
1039 elsif ( $emailaddress ) {
1040 my $value = $emailaddress;
1042 # If we're looking up the email, there's a chance that the person
1043 # doesn't have a userid. So if there is none, we pass along the
1044 # borrower number, and the bits of code that need to know the user
1045 # ID will have to be smart enough to handle that.
1046 my $patrons = Koha::Patrons->search({ email => $value });
1047 if ($patrons->count) {
1049 # First the userid, then the borrowernum
1050 my $patron = $patrons->next;
1051 $value = $patron->userid || $patron->borrowernumber;
1055 $return = $value ? 1 : 0;
1060 ( $pki_field eq 'Common Name' && $ENV{'SSL_CLIENT_S_DN_CN'} )
1061 || ( $pki_field eq 'emailAddress'
1062 && $ENV{'SSL_CLIENT_S_DN_Email'} )
1066 if ( $pki_field eq 'Common Name' ) {
1067 $value = $ENV{'SSL_CLIENT_S_DN_CN'};
1069 elsif ( $pki_field eq 'emailAddress' ) {
1070 $value = $ENV{'SSL_CLIENT_S_DN_Email'};
1072 # If we're looking up the email, there's a chance that the person
1073 # doesn't have a userid. So if there is none, we pass along the
1074 # borrower number, and the bits of code that need to know the user
1075 # ID will have to be smart enough to handle that.
1076 my $patrons = Koha::Patrons->search({ email => $value });
1077 if ($patrons->count) {
1079 # First the userid, then the borrowernum
1080 my $patron = $patrons->next;
1081 $value = $patron->userid || $patron->borrowernumber;
1087 $return = $value ? 1 : 0;
1093 my $request_method = $query->request_method // q{};
1096 $request_method eq 'POST'
1097 || ( C4::Context->preference('AutoSelfCheckID')
1098 && $q_userid eq C4::Context->preference('AutoSelfCheckID') )
1102 ( $return, $cardnumber, $retuserid, $cas_ticket ) =
1103 checkpw( $q_userid, $password, $query, $type );
1104 $userid = $retuserid if ($retuserid);
1105 $info{'invalid_username_or_password'} = 1 unless ($return);
1110 # If shib configured and shibOnly enabled, we should ignore anything other than a shibboleth type login.
1117 && C4::Context->preference('OPACShibOnly')
1119 || ( ( $type ne 'opac' )
1120 && C4::Context->preference('staffShibOnly') )
1127 # $return: 1 = valid user
1128 if( $return && $return > 0 ) {
1130 if ( $flags = haspermission( $userid, $flagsrequired ) ) {
1131 $auth_state = "logged_in";
1134 $auth_state = 'failed';
1135 # FIXME We could add $return = 0; or even delete the session?
1136 # Currently return == 1 and we will fill session info later on,
1137 # although we do present an authorization failure. (Yes, the
1138 # authentication was actually correct.)
1139 $info{'nopermission'} = 1;
1140 C4::Context::_unset_userenv($sessionID);
1142 my ( $borrowernumber, $firstname, $surname, $userflags,
1143 $branchcode, $branchname, $emailaddress, $desk_id,
1144 $desk_name, $register_id, $register_name );
1146 if ( $return == 1 ) {
1148 SELECT borrowernumber, firstname, surname, flags, borrowers.branchcode,
1149 branches.branchname as branchname, email
1151 LEFT JOIN branches on borrowers.branchcode=branches.branchcode
1153 my $dbh = C4::Context->dbh;
1154 my $sth = $dbh->prepare("$select where userid=?");
1155 $sth->execute($userid);
1156 unless ( $sth->rows ) {
1157 $sth = $dbh->prepare("$select where cardnumber=?");
1158 $sth->execute($cardnumber);
1160 unless ( $sth->rows ) {
1161 $sth->execute($userid);
1165 ( $borrowernumber, $firstname, $surname, $userflags,
1166 $branchcode, $branchname, $emailaddress ) = $sth->fetchrow;
1169 # launch a sequence to check if we have a ip for the branch, i
1170 # if we have one we replace the branchcode of the userenv by the branch bound in the ip.
1172 my $ip = $ENV{'REMOTE_ADDR'};
1174 # if they specify at login, use that
1175 if ( $query->param('branch') ) {
1176 $branchcode = $query->param('branch');
1177 my $library = Koha::Libraries->find($branchcode);
1178 $branchname = $library? $library->branchname: '';
1180 if ( $query->param('desk_id') ) {
1181 $desk_id = $query->param('desk_id');
1182 my $desk = Koha::Desks->find($desk_id);
1183 $desk_name = $desk ? $desk->desk_name : '';
1185 if ( C4::Context->preference('UseCashRegisters') ) {
1187 $query->param('register_id')
1188 ? Koha::Cash::Registers->find($query->param('register_id'))
1189 : Koha::Cash::Registers->search(
1190 { branch => $branchcode, branch_default => 1 },
1191 { rows => 1 } )->single;
1192 $register_id = $register->id if ($register);
1193 $register_name = $register->name if ($register);
1195 my $branches = { map { $_->branchcode => $_->unblessed } Koha::Libraries->search->as_list };
1196 if ( $type ne 'opac' and C4::Context->preference('AutoLocation') ) {
1198 # we have to check they are coming from the right ip range
1199 my $domain = $branches->{$branchcode}->{'branchip'};
1200 $domain =~ s|\.\*||g;
1201 if ( $ip !~ /^$domain/ ) {
1203 $cookie = $cookie_mgr->replace_in_list( $cookie, $query->cookie(
1204 -name => 'CGISESSID',
1207 -secure => ( C4::Context->https_enabled() ? 1 : 0 ),
1210 $info{'wrongip'} = 1;
1214 foreach my $br ( keys %$branches ) {
1216 # now we work with the treatment of ip
1217 my $domain = $branches->{$br}->{'branchip'};
1218 if ( $domain && $ip =~ /^$domain/ ) {
1219 $branchcode = $branches->{$br}->{'branchcode'};
1221 # new op dev : add the branchname to the cookie
1222 $branchname = $branches->{$br}->{'branchname'};
1226 my $is_sco_user = 0;
1227 if ( $query->param('sco_user_login') && ( $query->param('sco_user_login') eq '1' ) ){
1231 $session->param( 'number', $borrowernumber );
1232 $session->param( 'id', $userid );
1233 $session->param( 'cardnumber', $cardnumber );
1234 $session->param( 'firstname', $firstname );
1235 $session->param( 'surname', $surname );
1236 $session->param( 'branch', $branchcode );
1237 $session->param( 'branchname', $branchname );
1238 $session->param( 'desk_id', $desk_id);
1239 $session->param( 'desk_name', $desk_name);
1240 $session->param( 'flags', $userflags );
1241 $session->param( 'emailaddress', $emailaddress );
1242 $session->param( 'ip', $session->remote_addr() );
1243 $session->param( 'lasttime', time() );
1244 $session->param( 'interface', $type);
1245 $session->param( 'shibboleth', $shibSuccess );
1246 $session->param( 'register_id', $register_id );
1247 $session->param( 'register_name', $register_name );
1248 $session->param( 'sco_user', $is_sco_user );
1250 $session->param('cas_ticket', $cas_ticket) if $cas_ticket;
1251 C4::Context->set_userenv(
1252 $session->param('number'), $session->param('id'),
1253 $session->param('cardnumber'), $session->param('firstname'),
1254 $session->param('surname'), $session->param('branch'),
1255 $session->param('branchname'), $session->param('flags'),
1256 $session->param('emailaddress'), $session->param('shibboleth'),
1257 $session->param('desk_id'), $session->param('desk_name'),
1258 $session->param('register_id'), $session->param('register_name')
1262 # $return: 0 = invalid user
1263 # reset to anonymous session
1266 $info{'invalid_username_or_password'} = 1;
1267 C4::Context::_unset_userenv($sessionID);
1269 $session->param( 'lasttime', time() );
1270 $session->param( 'ip', $session->remote_addr() );
1271 $session->param( 'sessiontype', 'anon' );
1272 $session->param( 'interface', $type);
1274 } # END if ( $q_userid
1275 elsif ( $type eq "opac" ) {
1277 # anonymous sessions are created only for the OPAC
1279 # setting a couple of other session vars...
1280 $session->param( 'ip', $session->remote_addr() );
1281 $session->param( 'lasttime', time() );
1282 $session->param( 'sessiontype', 'anon' );
1283 $session->param( 'interface', $type);
1286 } # END unless ($userid)
1289 if ( $auth_state eq 'logged_in' ) {
1290 $auth_state = 'completed';
1292 # Auth is completed unless an additional auth is needed
1293 if ( $require_2FA ) {
1294 my $patron = Koha::Patrons->find({userid => $userid});
1295 if ( C4::Context->preference('TwoFactorAuthentication') eq "enforced" && $patron->auth_method eq 'password' ) {
1296 $auth_state = 'setup-additional-auth-needed';
1297 $session->param('waiting-for-2FA-setup', 1);
1298 %info = ();# We remove the warnings/errors we may have set incorrectly before
1299 } elsif ( $patron->auth_method eq 'two-factor' ) {
1300 # Ask for the OTP token
1301 $auth_state = 'additional-auth-needed';
1302 $session->param('waiting-for-2FA', 1);
1303 %info = ();# We remove the warnings/errors we may have set incorrectly before
1308 # finished authentification, now respond
1309 if ( $auth_state eq 'completed' || $authnotrequired ) {
1312 $cookie = $cookie_mgr->replace_in_list( $cookie, $query->cookie(
1313 -name => 'CGISESSID',
1316 -secure => ( C4::Context->https_enabled() ? 1 : 0 ),
1321 track_login_daily( $userid );
1323 # In case, that this request was a login attempt, we want to prevent that users can repost the opac login
1324 # request. We therefore redirect the user to the requested page again without the login parameters.
1325 # See Post/Redirect/Get (PRG) design pattern: https://en.wikipedia.org/wiki/Post/Redirect/Get
1326 if ( $type eq "opac" && $query->param('koha_login_context') && $query->param('koha_login_context') ne 'sco' && $query->param('password') && $query->param('userid') ) {
1327 my $uri = URI->new($query->url(-relative=>1, -query_string=>1));
1328 $uri->query_param_delete('userid');
1329 $uri->query_param_delete('password');
1330 $uri->query_param_delete('koha_login_context');
1331 print $query->redirect(-uri => $uri->as_string, -cookie => $cookie, -status=>'303 See other');
1335 return ( $userid, $cookie, $sessionID, $flags );
1340 # AUTH rejected, show the login/password template, after checking the DB.
1344 my $patron = Koha::Patrons->find({ userid => $q_userid }); # Not necessary logged in!
1346 # get the inputs from the incoming query
1348 my @inputs_to_clean = qw( userid password ticket logout.x otp_token );
1349 foreach my $name ( param $query) {
1350 next if grep { $name eq $_ } @inputs_to_clean;
1351 my @value = $query->multi_param($name);
1352 push @inputs, { name => $name, value => $_ } for @value;
1355 my $LibraryNameTitle = C4::Context->preference("LibraryName");
1356 $LibraryNameTitle =~ s/<(?:\/?)(?:br|p)\s*(?:\/?)>/ /sgi;
1357 $LibraryNameTitle =~ s/<(?:[^<>'"]|'(?:[^']*)'|"(?:[^"]*)")*>//sg;
1359 my $auth_template_name = ( $type eq 'opac' ) ? 'opac-auth.tt' : 'auth.tt';
1360 my $auth_error = $query->param('auth_error');
1361 my $template = C4::Templates::gettemplate( $auth_template_name, $type, $query );
1365 script_name => get_script_name(),
1366 casAuthentication => C4::Context->preference("casAuthentication"),
1367 shibbolethAuthentication => $shib,
1368 suggestion => C4::Context->preference("suggestion"),
1369 virtualshelves => C4::Context->preference("virtualshelves"),
1370 LibraryName => "" . C4::Context->preference("LibraryName"),
1371 LibraryNameTitle => "" . $LibraryNameTitle,
1372 opacuserlogin => C4::Context->preference("opacuserlogin"),
1373 OpacFavicon => C4::Context->preference("OpacFavicon"),
1374 opacreadinghistory => C4::Context->preference("opacreadinghistory"),
1375 opaclanguagesdisplay => C4::Context->preference("opaclanguagesdisplay"),
1376 OPACUserJS => C4::Context->preference("OPACUserJS"),
1377 OPACUserCSS => C4::Context->preference("OPACUserCSS"),
1378 intranetcolorstylesheet => C4::Context->preference("intranetcolorstylesheet"),
1379 intranetstylesheet => C4::Context->preference("intranetstylesheet"),
1380 IntranetNav => C4::Context->preference("IntranetNav"),
1381 IntranetFavicon => C4::Context->preference("IntranetFavicon"),
1382 IntranetUserCSS => C4::Context->preference("IntranetUserCSS"),
1383 IntranetUserJS => C4::Context->preference("IntranetUserJS"),
1384 IndependentBranches => C4::Context->preference("IndependentBranches"),
1385 AutoLocation => C4::Context->preference("AutoLocation"),
1386 wrongip => $info{'wrongip'},
1387 PatronSelfRegistration => C4::Context->preference("PatronSelfRegistration"),
1388 PatronSelfRegistrationDefaultCategory => C4::Context->preference("PatronSelfRegistrationDefaultCategory"),
1389 opac_css_override => $ENV{'OPAC_CSS_OVERRIDE'},
1390 too_many_login_attempts => ( $patron and $patron->account_locked ),
1391 password_has_expired => ( $patron and $patron->password_expired ),
1392 auth_error => $auth_error,
1395 $template->param( SCO_login => 1 ) if ( $query->param('sco_user_login') );
1396 $template->param( SCI_login => 1 ) if ( $query->param('sci_user_login') );
1397 $template->param( OpacPublic => C4::Context->preference("OpacPublic") );
1398 $template->param( loginprompt => 1 ) unless $info{'nopermission'};
1399 if ( $auth_state eq 'additional-auth-needed' ) {
1400 my $patron = Koha::Patrons->find( { userid => $userid } );
1403 invalid_otp_token => $invalid_otp_token,
1404 notice_email_address => $patron->notice_email_address, # We could also pass logged_in_user if necessary
1408 if ( $auth_state eq 'setup-additional-auth-needed' ) {
1414 if ( $type eq 'opac' ) {
1415 require Koha::Virtualshelves;
1416 my $some_public_shelves = Koha::Virtualshelves->get_some_shelves(
1422 some_public_shelves => $some_public_shelves,
1428 # Is authentication against multiple CAS servers enabled?
1429 require C4::Auth_with_cas;
1430 if ( multipleAuth() && !$casparam ) {
1431 my $casservers = getMultipleAuth();
1433 foreach my $key ( keys %$casservers ) {
1434 push @tmplservers, { name => $key, value => login_cas_url( $query, $key, $type ) . "?cas=$key" };
1437 casServersLoop => \@tmplservers
1441 casServerUrl => login_cas_url($query, undef, $type),
1446 invalidCasLogin => $info{'invalidCasLogin'}
1451 #If shibOnly is enabled just go ahead and redirect directly
1452 if ( (($type eq 'opac') && C4::Context->preference('OPACShibOnly')) || (($type ne 'opac') && C4::Context->preference('staffShibOnly')) ) {
1453 my $redirect_url = login_shib_url( $query );
1454 print $query->redirect( -uri => "$redirect_url", -status => 303 );
1459 shibbolethAuthentication => $shib,
1460 shibbolethLoginUrl => login_shib_url($query),
1464 if (C4::Context->preference('GoogleOpenIDConnect')) {
1465 if ($query->param("OpenIDConnectFailed")) {
1466 my $reason = $query->param('OpenIDConnectFailed');
1467 $template->param(invalidGoogleOpenIDConnectLogin => $reason);
1472 LibraryName => C4::Context->preference("LibraryName"),
1474 $template->param(%info);
1476 # $cookie = $query->cookie(CGISESSID => $session->id
1478 print $query->header(
1479 { type => 'text/html',
1482 'X-Frame-Options' => 'SAMEORIGIN',
1490 =head2 check_api_auth
1492 ($status, $cookie, $sessionId) = check_api_auth($query, $userflags);
1494 Given a CGI query containing the parameters 'userid' and 'password' and/or a session
1495 cookie, determine if the user has the privileges specified by C<$userflags>.
1497 C<check_api_auth> is is meant for authenticating users of web services, and
1498 consequently will always return and will not attempt to redirect the user
1501 If a valid session cookie is already present, check_api_auth will return a status
1502 of "ok", the cookie, and the Koha session ID.
1504 If no session cookie is present, check_api_auth will check the 'userid' and 'password
1505 parameters and create a session cookie and Koha session if the supplied credentials
1508 Possible return values in C<$status> are:
1512 =item "ok" -- user authenticated; C<$cookie> and C<$sessionid> have valid values.
1514 =item "failed" -- credentials are not correct; C<$cookie> and C<$sessionid> are undef
1516 =item "maintenance" -- DB is in maintenance mode; no login possible at the moment
1518 =item "expired -- session cookie has expired; API user should resubmit userid and password
1520 =item "restricted" -- The IP has changed (if SessionRestrictionByIP)
1522 =item "additional-auth-needed -- User is in an authentication process that is not finished
1528 sub check_api_auth {
1531 my $flagsrequired = shift;
1532 my $timeout = _timeout_syspref();
1534 unless ( C4::Context->preference('Version') ) {
1536 # database has not been installed yet
1537 return ( "maintenance", undef, undef );
1539 my $kohaversion = Koha::version();
1540 $kohaversion =~ s/(.*\..*)\.(.*)\.(.*)/$1$2$3/;
1541 if ( C4::Context->preference('Version') < $kohaversion ) {
1543 # database in need of version update; assume that
1544 # no API should be called while databsae is in
1546 return ( "maintenance", undef, undef );
1549 my ( $sessionID, $session );
1550 unless ( $query->param('userid') ) {
1551 $sessionID = $query->cookie("CGISESSID");
1553 if ( $sessionID && not( $cas && $query->param('PT') ) ) {
1556 ( $return, $session, undef ) = check_cookie_auth(
1557 $sessionID, $flagsrequired, { remote_addr => $ENV{REMOTE_ADDR} } );
1559 return ( $return, undef, undef ) # Cookie auth failed
1562 my $cookie = $query->cookie(
1563 -name => 'CGISESSID',
1564 -value => $session->id,
1566 -secure => ( C4::Context->https_enabled() ? 1 : 0 ),
1569 return ( $return, $cookie, $session ); # return == 'ok' here
1574 my $userid = $query->param('userid');
1575 my $password = $query->param('password');
1576 my ( $return, $cardnumber, $cas_ticket );
1579 if ( $cas && $query->param('PT') ) {
1582 # In case of a CAS authentication, we use the ticket instead of the password
1583 my $PT = $query->param('PT');
1584 ( $return, $cardnumber, $userid, $cas_ticket ) = check_api_auth_cas( $PT, $query ); # EXTERNAL AUTH
1587 # User / password auth
1588 unless ( $userid and $password ) {
1590 # caller did something wrong, fail the authenticateion
1591 return ( "failed", undef, undef );
1594 ( $return, $cardnumber, $newuserid, $cas_ticket ) = checkpw( $userid, $password, $query );
1597 if ( $return and haspermission( $userid, $flagsrequired ) ) {
1598 my $session = get_session("");
1599 return ( "failed", undef, undef ) unless $session;
1601 my $sessionID = $session->id;
1602 C4::Context->_new_userenv($sessionID);
1603 my $cookie = $query->cookie(
1604 -name => 'CGISESSID',
1605 -value => $sessionID,
1607 -secure => ( C4::Context->https_enabled() ? 1 : 0 ),
1610 if ( $return == 1 ) {
1612 $borrowernumber, $firstname, $surname,
1613 $userflags, $branchcode, $branchname,
1616 my $dbh = C4::Context->dbh;
1619 "select borrowernumber, firstname, surname, flags, borrowers.branchcode, branches.branchname as branchname, email from borrowers left join branches on borrowers.branchcode=branches.branchcode where userid=?"
1621 $sth->execute($userid);
1623 $borrowernumber, $firstname, $surname,
1624 $userflags, $branchcode, $branchname,
1626 ) = $sth->fetchrow if ( $sth->rows );
1628 unless ( $sth->rows ) {
1629 my $sth = $dbh->prepare(
1630 "select borrowernumber, firstname, surname, flags, borrowers.branchcode, branches.branchname as branchname, email from borrowers left join branches on borrowers.branchcode=branches.branchcode where cardnumber=?"
1632 $sth->execute($cardnumber);
1634 $borrowernumber, $firstname, $surname,
1635 $userflags, $branchcode, $branchname,
1637 ) = $sth->fetchrow if ( $sth->rows );
1639 unless ( $sth->rows ) {
1640 $sth->execute($userid);
1642 $borrowernumber, $firstname, $surname, $userflags,
1643 $branchcode, $branchname, $emailaddress
1644 ) = $sth->fetchrow if ( $sth->rows );
1648 my $ip = $ENV{'REMOTE_ADDR'};
1650 # if they specify at login, use that
1651 if ( $query->param('branch') ) {
1652 $branchcode = $query->param('branch');
1653 my $library = Koha::Libraries->find($branchcode);
1654 $branchname = $library? $library->branchname: '';
1656 my $branches = { map { $_->branchcode => $_->unblessed } Koha::Libraries->search->as_list };
1657 foreach my $br ( keys %$branches ) {
1659 # now we work with the treatment of ip
1660 my $domain = $branches->{$br}->{'branchip'};
1661 if ( $domain && $ip =~ /^$domain/ ) {
1662 $branchcode = $branches->{$br}->{'branchcode'};
1664 # new op dev : add the branchname to the cookie
1665 $branchname = $branches->{$br}->{'branchname'};
1668 $session->param( 'number', $borrowernumber );
1669 $session->param( 'id', $userid );
1670 $session->param( 'cardnumber', $cardnumber );
1671 $session->param( 'firstname', $firstname );
1672 $session->param( 'surname', $surname );
1673 $session->param( 'branch', $branchcode );
1674 $session->param( 'branchname', $branchname );
1675 $session->param( 'flags', $userflags );
1676 $session->param( 'emailaddress', $emailaddress );
1677 $session->param( 'ip', $session->remote_addr() );
1678 $session->param( 'lasttime', time() );
1679 $session->param( 'interface', 'api' );
1681 $session->param( 'cas_ticket', $cas_ticket);
1682 C4::Context->set_userenv(
1683 $session->param('number'), $session->param('id'),
1684 $session->param('cardnumber'), $session->param('firstname'),
1685 $session->param('surname'), $session->param('branch'),
1686 $session->param('branchname'), $session->param('flags'),
1687 $session->param('emailaddress'), $session->param('shibboleth'),
1688 $session->param('desk_id'), $session->param('desk_name'),
1689 $session->param('register_id'), $session->param('register_name')
1691 return ( "ok", $cookie, $sessionID );
1693 return ( "failed", undef, undef );
1698 =head2 check_cookie_auth
1700 ($status, $sessionId) = check_cookie_auth($cookie, $userflags);
1702 Given a CGISESSID cookie set during a previous login to Koha, determine
1703 if the user has the privileges specified by C<$userflags>. C<$userflags>
1704 is passed unaltered into C<haspermission> and as such accepts all options
1705 avaiable to that routine with the one caveat that C<check_api_auth> will
1706 also allow 'undef' to be passed and in such a case the permissions check
1707 will be skipped altogether.
1709 C<check_cookie_auth> is meant for authenticating special services
1710 such as tools/upload-file.pl that are invoked by other pages that
1711 have been authenticated in the usual way.
1713 Possible return values in C<$status> are:
1717 =item "ok" -- user authenticated; C<$sessionID> have valid values.
1719 =item "anon" -- user not authenticated but valid for anonymous session.
1721 =item "failed" -- credentials are not correct; C<$sessionid> are undef
1723 =item "maintenance" -- DB is in maintenance mode; no login possible at the moment
1725 =item "expired -- session cookie has expired; API user should resubmit userid and password
1727 =item "restricted" -- The IP has changed (if SessionRestrictionByIP)
1733 sub check_cookie_auth {
1734 my $sessionID = shift;
1735 my $flagsrequired = shift;
1738 my $remote_addr = $params->{remote_addr} || $ENV{REMOTE_ADDR};
1740 my $skip_version_check = $params->{skip_version_check}; # Only for checkauth
1742 unless ( $skip_version_check ) {
1743 unless ( C4::Context->preference('Version') ) {
1745 # database has not been installed yet
1746 return ( "maintenance", undef );
1748 my $kohaversion = Koha::version();
1749 $kohaversion =~ s/(.*\..*)\.(.*)\.(.*)/$1$2$3/;
1750 if ( C4::Context->preference('Version') < $kohaversion ) {
1752 # database in need of version update; assume that
1753 # no API should be called while databsae is in
1755 return ( "maintenance", undef );
1759 # see if we have a valid session cookie already
1760 # however, if a userid parameter is present (i.e., from
1761 # a form submission, assume that any current cookie
1763 unless ( $sessionID ) {
1764 return ( "failed", undef );
1766 C4::Context::_unset_userenv($sessionID); # remove old userenv first
1767 my $session = get_session($sessionID);
1769 my $userid = $session->param('id');
1770 my $ip = $session->param('ip');
1771 my $lasttime = $session->param('lasttime');
1772 my $timeout = _timeout_syspref();
1774 if ( !$lasttime || ( $lasttime < time() - $timeout ) ) {
1778 return ("expired", undef);
1780 } elsif ( C4::Context->preference('SessionRestrictionByIP') && $ip ne $remote_addr ) {
1781 # IP address changed
1784 return ( "restricted", undef, { old_ip => $ip, new_ip => $remote_addr});
1786 } elsif ( $userid ) {
1787 $session->param( 'lasttime', time() );
1788 my $patron = Koha::Patrons->find({ userid => $userid });
1790 # If the user modify their own userid
1791 # Better than 500 but we could do better
1792 unless ( $patron ) {
1795 return ("expired", undef);
1798 $patron = Koha::Patrons->find({ cardnumber => $userid })
1800 return ("password_expired", undef ) if $patron->password_expired;
1801 my $flags = defined($flagsrequired) ? haspermission( $userid, $flagsrequired ) : 1;
1803 C4::Context->_new_userenv($sessionID);
1804 if ( !C4::Context->interface ) {
1805 # No need to override the interface, most often set by get_template_and_user
1806 C4::Context->interface( $session->param('interface') );
1808 C4::Context->set_userenv(
1809 $session->param('number'), $session->param('id') // '',
1810 $session->param('cardnumber'), $session->param('firstname'),
1811 $session->param('surname'), $session->param('branch'),
1812 $session->param('branchname'), $session->param('flags'),
1813 $session->param('emailaddress'), $session->param('shibboleth'),
1814 $session->param('desk_id'), $session->param('desk_name'),
1815 $session->param('register_id'), $session->param('register_name')
1817 if ( C4::Context->preference('TwoFactorAuthentication') ne 'disabled' ) {
1818 return ( "additional-auth-needed", $session )
1819 if $session->param('waiting-for-2FA');
1821 return ( "setup-additional-auth-needed", $session )
1822 if $session->param('waiting-for-2FA-setup');
1825 return ( "ok", $session );
1829 return ( "failed", undef );
1833 C4::Context->_new_userenv($sessionID);
1834 C4::Context->interface($session->param('interface'));
1835 C4::Context->set_userenv( undef, q{} );
1836 return ( "anon", $session );
1839 return ( "expired", undef );
1846 my $session = get_session($sessionID);
1848 Given a session ID, retrieve the CGI::Session object used to store
1849 the session's state. The session object can be used to store
1850 data that needs to be accessed by different scripts during a
1853 If the C<$sessionID> parameter is an empty string, a new session
1858 sub _get_session_params {
1859 my $storage_method = C4::Context->preference('SessionStorage');
1860 if ( $storage_method eq 'mysql' ) {
1861 my $dbh = C4::Context->dbh;
1862 return { dsn => "serializer:yamlxs;driver:MySQL;id:md5", dsn_args => { Handle => $dbh } };
1864 elsif ( $storage_method eq 'Pg' ) {
1865 my $dbh = C4::Context->dbh;
1866 return { dsn => "serializer:yamlxs;driver:PostgreSQL;id:md5", dsn_args => { Handle => $dbh } };
1868 elsif ( $storage_method eq 'memcached' && Koha::Caches->get_instance->memcached_cache ) {
1869 my $memcached = Koha::Caches->get_instance()->memcached_cache;
1870 return { dsn => "serializer:yamlxs;driver:memcached;id:md5", dsn_args => { Memcached => $memcached } };
1873 # catch all defaults to tmp should work on all systems
1874 my $dir = C4::Context::temporary_directory;
1875 my $instance = C4::Context->config( 'database' ); #actually for packages not exactly the instance name, but generally safer to leave it as it is
1876 return { dsn => "serializer:yamlxs;driver:File;id:md5", dsn_args => { Directory => "$dir/cgisess_$instance" } };
1881 my $sessionID = shift;
1882 my $params = _get_session_params();
1884 if( $sessionID ) { # find existing
1885 CGI::Session::ErrorHandler->set_error( q{} ); # clear error, cpan issue #111463
1886 $session = CGI::Session->load( $params->{dsn}, $sessionID, $params->{dsn_args} );
1888 $session = CGI::Session->new( $params->{dsn}, $sessionID, $params->{dsn_args} );
1889 # no need to flush here
1894 =head2 create_basic_session
1896 my $session = create_basic_session({ patron => $patron, interface => $interface });
1898 Creates a session and adds all basic parameters for a session to work
1902 sub create_basic_session {
1904 my $patron = $params->{patron};
1905 my $interface = $params->{interface};
1907 $interface = 'intranet' if $interface eq 'staff';
1909 my $session = get_session("");
1911 $session->param( 'number', $patron->borrowernumber );
1912 $session->param( 'id', $patron->userid );
1913 $session->param( 'cardnumber', $patron->cardnumber );
1914 $session->param( 'firstname', $patron->firstname );
1915 $session->param( 'surname', $patron->surname );
1916 $session->param( 'branch', $patron->branchcode );
1917 $session->param( 'branchname', $patron->library->branchname );
1918 $session->param( 'flags', $patron->flags );
1919 $session->param( 'emailaddress', $patron->email );
1920 $session->param( 'ip', $session->remote_addr() );
1921 $session->param( 'lasttime', time() );
1922 $session->param( 'interface', $interface);
1928 # FIXME no_set_userenv may be replaced with force_branchcode_for_userenv
1929 # (or something similar)
1930 # Currently it's only passed from C4::SIP::ILS::Patron::check_password, but
1931 # not having a userenv defined could cause a crash.
1933 my ( $userid, $password, $query, $type, $no_set_userenv ) = @_;
1934 $type = 'opac' unless $type;
1936 # Get shibboleth login attribute
1937 my $shib = C4::Context->config('useshibboleth') && shib_ok();
1938 my $shib_login = $shib ? get_login_shib() : undef;
1942 if ( defined $userid ){
1943 $patron = Koha::Patrons->find({ userid => $userid });
1944 $patron = Koha::Patrons->find({ cardnumber => $userid }) unless $patron;
1946 my $check_internal_as_fallback = 0;
1948 # Note: checkpw_* routines returns:
1951 # -1 if user bind failed (LDAP only)
1953 if ( $patron and ( $patron->account_locked ) ) {
1954 # Nothing to check, account is locked
1955 } elsif ($ldap && defined($password)) {
1956 my ( $retval, $retcard, $retuserid ) = checkpw_ldap(@_); # EXTERNAL AUTH
1957 if ( $retval == 1 ) {
1958 @return = ( $retval, $retcard, $retuserid );
1961 $check_internal_as_fallback = 1 if $retval == 0;
1963 } elsif ( $cas && $query && $query->param('ticket') ) {
1965 # In case of a CAS authentication, we use the ticket instead of the password
1966 my $ticket = $query->param('ticket');
1967 $query->delete('ticket'); # remove ticket to come back to original URL
1968 my ( $retval, $retcard, $retuserid, $cas_ticket ) = checkpw_cas( $ticket, $query, $type ); # EXTERNAL AUTH
1970 @return = ( $retval, $retcard, $retuserid, $cas_ticket );
1974 $passwd_ok = $retval;
1977 # If we are in a shibboleth session (shibboleth is enabled, and a shibboleth match attribute is present)
1978 # Check for password to asertain whether we want to be testing against shibboleth or another method this
1980 elsif ( $shib && $shib_login && !$password ) {
1982 # In case of a Shibboleth authentication, we expect a shibboleth user attribute
1983 # (defined under shibboleth mapping in koha-conf.xml) to contain the login of the
1984 # shibboleth-authenticated user
1986 # Then, we check if it matches a valid koha user
1988 my ( $retval, $retcard, $retuserid ) = C4::Auth_with_shibboleth::checkpw_shib($shib_login); # EXTERNAL AUTH
1990 @return = ( $retval, $retcard, $retuserid );
1992 $passwd_ok = $retval;
1995 $check_internal_as_fallback = 1;
1999 if ( $check_internal_as_fallback ) {
2000 @return = checkpw_internal( $userid, $password, $no_set_userenv);
2001 $passwd_ok = 1 if $return[0] > 0; # 1 or 2
2006 $patron->update({ login_attempts => 0 });
2007 if( $patron->password_expired ){
2010 } elsif( !$patron->account_locked ) {
2011 $patron->update({ login_attempts => $patron->login_attempts + 1 });
2015 # Optionally log success or failure
2016 if( $patron && $passwd_ok && C4::Context->preference('AuthSuccessLog') ) {
2017 logaction( 'AUTH', 'SUCCESS', $patron->id, "Valid password for $userid", $type );
2018 } elsif( !$passwd_ok && C4::Context->preference('AuthFailureLog') ) {
2019 logaction( 'AUTH', 'FAILURE', $patron ? $patron->id : 0, "Wrong password for $userid", $type );
2025 sub checkpw_internal {
2026 my ( $userid, $password, $no_set_userenv ) = @_;
2028 $password = Encode::encode( 'UTF-8', $password )
2029 if Encode::is_utf8($password);
2031 my $dbh = C4::Context->dbh;
2034 "select password,cardnumber,borrowernumber,userid,firstname,surname,borrowers.branchcode,branches.branchname,flags from borrowers join branches on borrowers.branchcode=branches.branchcode where userid=?"
2036 $sth->execute($userid);
2038 my ( $stored_hash, $cardnumber, $borrowernumber, $userid, $firstname,
2039 $surname, $branchcode, $branchname, $flags )
2042 if ( checkpw_hash( $password, $stored_hash ) ) {
2044 C4::Context->set_userenv( "$borrowernumber", $userid, $cardnumber,
2045 $firstname, $surname, $branchcode, $branchname, $flags ) unless $no_set_userenv;
2046 return 1, $cardnumber, $userid;
2051 "select password,cardnumber,borrowernumber,userid,firstname,surname,borrowers.branchcode,branches.branchname,flags from borrowers join branches on borrowers.branchcode=branches.branchcode where cardnumber=?"
2053 $sth->execute($userid);
2055 my ( $stored_hash, $cardnumber, $borrowernumber, $userid, $firstname,
2056 $surname, $branchcode, $branchname, $flags )
2059 if ( checkpw_hash( $password, $stored_hash ) ) {
2061 C4::Context->set_userenv( $borrowernumber, $userid, $cardnumber,
2062 $firstname, $surname, $branchcode, $branchname, $flags ) unless $no_set_userenv;
2063 return 1, $cardnumber, $userid;
2070 my ( $password, $stored_hash ) = @_;
2072 return if $stored_hash eq '!';
2074 # check what encryption algorithm was implemented: Bcrypt - if the hash starts with '$2' it is Bcrypt else md5
2076 if ( substr( $stored_hash, 0, 2 ) eq '$2' ) {
2077 $hash = hash_password( $password, $stored_hash );
2079 $hash = md5_base64($password);
2081 return $hash eq $stored_hash;
2086 my $authflags = getuserflags($flags, $userid, [$dbh]);
2088 Translates integer flags into permissions strings hash.
2090 C<$flags> is the integer userflags value ( borrowers.userflags )
2091 C<$userid> is the members.userid, used for building subpermissions
2092 C<$authflags> is a hashref of permissions
2099 my $dbh = @_ ? shift : C4::Context->dbh;
2102 # I don't want to do this, but if someone logs in as the database
2103 # user, it would be preferable not to spam them to death with
2104 # numeric warnings. So, we make $flags numeric.
2105 no warnings 'numeric';
2108 my $sth = $dbh->prepare("SELECT bit, flag, defaulton FROM userflags");
2111 while ( my ( $bit, $flag, $defaulton ) = $sth->fetchrow ) {
2112 if ( ( $flags & ( 2**$bit ) ) || $defaulton ) {
2113 $userflags->{$flag} = 1;
2116 $userflags->{$flag} = 0;
2120 # get subpermissions and merge with top-level permissions
2121 my $user_subperms = get_user_subpermissions($userid);
2122 foreach my $module ( keys %$user_subperms ) {
2123 next if $userflags->{$module} == 1; # user already has permission for everything in this module
2124 $userflags->{$module} = $user_subperms->{$module};
2130 =head2 get_user_subpermissions
2132 $user_perm_hashref = get_user_subpermissions($userid);
2134 Given the userid (note, not the borrowernumber) of a staff user,
2135 return a hashref of hashrefs of the specific subpermissions
2136 accorded to the user. An example return is
2140 export_catalog => 1,
2141 import_patrons => 1,
2145 The top-level hash-key is a module or function code from
2146 userflags.flag, while the second-level key is a code
2149 The results of this function do not give a complete picture
2150 of the functions that a staff user can access; it is also
2151 necessary to check borrowers.flags.
2155 sub get_user_subpermissions {
2158 my $dbh = C4::Context->dbh;
2159 my $sth = $dbh->prepare( "SELECT flag, user_permissions.code
2160 FROM user_permissions
2161 JOIN permissions USING (module_bit, code)
2162 JOIN userflags ON (module_bit = bit)
2163 JOIN borrowers USING (borrowernumber)
2164 WHERE userid = ?" );
2165 $sth->execute($userid);
2167 my $user_perms = {};
2168 while ( my $perm = $sth->fetchrow_hashref ) {
2169 $user_perms->{ $perm->{'flag'} }->{ $perm->{'code'} } = 1;
2174 =head2 get_all_subpermissions
2176 my $perm_hashref = get_all_subpermissions();
2178 Returns a hashref of hashrefs defining all specific
2179 permissions currently defined. The return value
2180 has the same structure as that of C<get_user_subpermissions>,
2181 except that the innermost hash value is the description
2182 of the subpermission.
2186 sub get_all_subpermissions {
2187 my $dbh = C4::Context->dbh;
2188 my $sth = $dbh->prepare( "SELECT flag, code
2190 JOIN userflags ON (module_bit = bit)" );
2194 while ( my $perm = $sth->fetchrow_hashref ) {
2195 $all_perms->{ $perm->{'flag'} }->{ $perm->{'code'} } = 1;
2200 =head2 get_cataloguing_page_permissions
2202 my $required_permissions = get_cataloguing_page_permissions();
2204 Returns the required permissions to access the main cataloguing page. Useful for building
2205 the global I<can_see_cataloguing_module> template variable, and also for reusing in
2206 I<cataloging-home.pl>.
2210 sub get_cataloguing_page_permissions {
2212 my @cataloguing_tools_subperms = qw(
2219 marc_modification_templates
2227 { editcatalogue => '*' }, { tools => \@cataloguing_tools_subperms },
2228 C4::Context->preference('StockRotation') ? { stockrotation => 'manage_rotas' } : ()
2232 =head2 haspermission
2234 $flagsrequired = '*'; # Any permission at all
2235 $flagsrequired = 'a_flag'; # a_flag must be satisfied (all subpermissions)
2236 $flagsrequired = [ 'a_flag', 'b_flag' ]; # a_flag OR b_flag must be satisfied
2237 $flagsrequired = { 'a_flag => 1, 'b_flag' => 1 }; # a_flag AND b_flag must be satisfied
2238 $flagsrequired = { 'a_flag' => 'sub_a' }; # sub_a of a_flag must be satisfied
2239 $flagsrequired = { 'a_flag' => [ 'sub_a, 'sub_b' ] }; # sub_a OR sub_b of a_flag must be satisfied
2241 $flags = ($userid, $flagsrequired);
2243 C<$userid> the userid of the member
2244 C<$flags> is a query structure similar to that used by SQL::Abstract that
2245 denotes the combination of flags required. It is a required parameter.
2247 The main logic of this method is that things in arrays are OR'ed, and things
2248 in hashes are AND'ed. The `*` character can be used, at any depth, to denote `ANY`
2250 Returns member's flags or 0 if a permission is not met.
2255 my ($required, $flags) = @_;
2257 my $ref = ref($required);
2259 if ($required eq '*') {
2260 return 0 unless ( $flags or ref( $flags ) );
2262 return 0 unless ( $flags and (!ref( $flags ) || $flags->{$required} ));
2264 } elsif ($ref eq 'HASH') {
2265 foreach my $key (keys %{$required}) {
2266 next if $flags == 1;
2267 my $require = $required->{$key};
2268 my $rflags = $flags->{$key};
2269 return 0 unless _dispatch($require, $rflags);
2271 } elsif ($ref eq 'ARRAY') {
2273 foreach my $require ( @{$required} ) {
2275 ( ref($flags) && !ref($require) && ( $require ne '*' ) )
2276 ? $flags->{$require}
2278 $satisfied++ if _dispatch( $require, $rflags );
2280 return 0 unless $satisfied;
2282 croak "Unexpected structure found: $ref";
2289 my ( $userid, $flagsrequired ) = @_;
2291 #Koha::Exceptions::WrongParameter->throw('$flagsrequired should not be undef')
2292 # unless defined($flagsrequired);
2294 my $sth = C4::Context->dbh->prepare("SELECT flags FROM borrowers WHERE userid=?");
2295 $sth->execute($userid);
2296 my $row = $sth->fetchrow();
2297 my $flags = getuserflags( $row, $userid );
2299 return $flags unless defined($flagsrequired);
2300 return $flags if $flags->{superlibrarian};
2301 return _dispatch($flagsrequired, $flags);
2303 #FIXME - This fcn should return the failed permission so a suitable error msg can be delivered.
2308 $flags = ($iprange);
2310 C<$iprange> A space separated string describing an IP range. Can include single IPs or ranges
2312 Returns 1 if the remote address is in the provided iprange, or 0 otherwise.
2319 my @allowedipranges = $iprange ? split(' ', $iprange) : ();
2320 if (scalar @allowedipranges > 0) {
2322 eval { @rangelist = Net::CIDR::range2cidr(@allowedipranges); }; return 0 if $@;
2323 eval { $result = Net::CIDR::cidrlookup($ENV{'REMOTE_ADDR'}, @rangelist) } || Koha::Logger->get->warn('cidrlookup failed for ' . join(' ',@rangelist) );
2325 return $result ? 1 : 0;
2328 sub getborrowernumber {
2330 my $userenv = C4::Context->userenv;
2331 if ( defined($userenv) && ref($userenv) eq 'HASH' && $userenv->{number} ) {
2332 return $userenv->{number};
2334 my $dbh = C4::Context->dbh;
2335 for my $field ( 'userid', 'cardnumber' ) {
2337 $dbh->prepare("select borrowernumber from borrowers where $field=?");
2338 $sth->execute($userid);
2340 my ($bnumber) = $sth->fetchrow;
2347 =head2 track_login_daily
2349 track_login_daily( $userid );
2351 Wraps the call to $patron->track_login, the method used to update borrowers.lastseen. We only call track_login once a day.
2355 sub track_login_daily {
2357 return if !$userid || !C4::Context->preference('TrackLastPatronActivity');
2359 my $cache = Koha::Caches->get_instance();
2360 my $cache_key = "track_login_" . $userid;
2361 my $cached = $cache->get_from_cache($cache_key);
2362 my $today = dt_from_string()->ymd;
2363 return if $cached && $cached eq $today;
2365 my $patron = Koha::Patrons->find({ userid => $userid });
2366 return unless $patron;
2367 $patron->track_login;
2368 $cache->set_in_cache( $cache_key, $today );
2371 END { } # module clean-up code here (global destructor)
2381 Crypt::Eksblowfish::Bcrypt(3)