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, 1);
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
923 $cookie = $cookie_mgr->replace_in_list( $cookie, $query->cookie(
924 -name => 'CGISESSID',
925 -value => $session->id,
927 -secure => ( C4::Context->https_enabled() ? 1 : 0 ),
931 $flags = haspermission( $userid, $flagsrequired );
933 $auth_state = 'failed';
934 $info{'nopermission'} = 1;
937 } elsif ( !$logout ) {
938 if ( $return eq 'expired' ) {
939 $info{timed_out} = 1;
940 } elsif ( $return eq 'restricted' ) {
941 $info{oldip} = $more_info->{old_ip};
942 $info{newip} = $more_info->{new_ip};
943 $info{different_ip} = 1;
944 } elsif ( $return eq 'password_expired' ) {
945 $info{password_has_expired} = 1;
950 if ( $auth_state eq 'failed' || $logout ) {
957 # voluntary logout the user
958 # check wether the user was using their shibboleth session or a local one
959 my $shibSuccess = C4::Context->userenv ? C4::Context->userenv->{'shibboleth'} : undef;
964 C4::Context::_unset_userenv($sessionID);
965 $cookie = $cookie_mgr->clear_unless( $query->cookie, @$cookie );
967 if ($cas and $caslogout) {
968 logout_cas($query, $type);
971 # If we are in a shibboleth session (shibboleth is enabled, a shibboleth match attribute is set and matches koha matchpoint)
972 if ( $shib and $shib_login and $shibSuccess) {
977 $auth_state = 'logout';
981 #we initiate a session prior to checking for a username to allow for anonymous sessions...
982 if( !$session or !$sessionID ) { # if we cleared sessionID, we need a new session
983 $session = get_session() or die "Auth ERROR: Cannot get_session()";
986 # Save anonymous search history in new session so it can be retrieved
987 # by get_template_and_user to store it in user's search history after
988 # a successful login.
989 if ($anon_search_history) {
990 $session->param( 'search_history', $anon_search_history );
993 $sessionID = $session->id;
994 C4::Context->_new_userenv($sessionID);
995 $cookie = $cookie_mgr->replace_in_list( $cookie, $query->cookie(
996 -name => 'CGISESSID',
997 -value => $sessionID,
999 -secure => ( C4::Context->https_enabled() ? 1 : 0 ),
1002 my $pki_field = C4::Context->preference('AllowPKIAuth');
1003 if ( !defined($pki_field) ) {
1004 print STDERR "ERROR: Missing system preference AllowPKIAuth.\n";
1005 $pki_field = 'None';
1007 if ( ( $cas && $query->param('ticket') )
1009 || ( $shib && $shib_login )
1010 || $pki_field ne 'None'
1013 my $password = $query->param('password');
1014 my $shibSuccess = 0;
1015 my ( $return, $cardnumber );
1017 # If shib is enabled and we have a shib login, does the login match a valid koha user
1018 if ( $shib && $shib_login ) {
1021 # Do not pass password here, else shib will not be checked in checkpw.
1022 ( $return, $cardnumber, $retuserid ) = checkpw( $q_userid, undef, $query );
1023 $userid = $retuserid;
1024 $shibSuccess = $return;
1025 $info{'invalidShibLogin'} = 1 unless ($return);
1028 # If shib login and match were successful, skip further login methods
1029 unless ($shibSuccess) {
1030 if ( $cas && $query->param('ticket') ) {
1032 ( $return, $cardnumber, $retuserid, $cas_ticket ) =
1033 checkpw( $userid, $password, $query, $type );
1034 $userid = $retuserid;
1035 $info{'invalidCasLogin'} = 1 unless ($return);
1038 elsif ( $emailaddress ) {
1039 my $value = $emailaddress;
1041 # If we're looking up the email, there's a chance that the person
1042 # doesn't have a userid. So if there is none, we pass along the
1043 # borrower number, and the bits of code that need to know the user
1044 # ID will have to be smart enough to handle that.
1045 my $patrons = Koha::Patrons->search({ email => $value });
1046 if ($patrons->count) {
1048 # First the userid, then the borrowernum
1049 my $patron = $patrons->next;
1050 $value = $patron->userid || $patron->borrowernumber;
1054 $return = $value ? 1 : 0;
1059 ( $pki_field eq 'Common Name' && $ENV{'SSL_CLIENT_S_DN_CN'} )
1060 || ( $pki_field eq 'emailAddress'
1061 && $ENV{'SSL_CLIENT_S_DN_Email'} )
1065 if ( $pki_field eq 'Common Name' ) {
1066 $value = $ENV{'SSL_CLIENT_S_DN_CN'};
1068 elsif ( $pki_field eq 'emailAddress' ) {
1069 $value = $ENV{'SSL_CLIENT_S_DN_Email'};
1071 # If we're looking up the email, there's a chance that the person
1072 # doesn't have a userid. So if there is none, we pass along the
1073 # borrower number, and the bits of code that need to know the user
1074 # ID will have to be smart enough to handle that.
1075 my $patrons = Koha::Patrons->search({ email => $value });
1076 if ($patrons->count) {
1078 # First the userid, then the borrowernum
1079 my $patron = $patrons->next;
1080 $value = $patron->userid || $patron->borrowernumber;
1086 $return = $value ? 1 : 0;
1092 my $request_method = $query->request_method // q{};
1095 $request_method eq 'POST'
1096 || ( C4::Context->preference('AutoSelfCheckID')
1097 && $q_userid eq C4::Context->preference('AutoSelfCheckID') )
1101 ( $return, $cardnumber, $retuserid, $cas_ticket ) =
1102 checkpw( $q_userid, $password, $query, $type );
1103 $userid = $retuserid if ($retuserid);
1104 $info{'invalid_username_or_password'} = 1 unless ($return);
1109 # If shib configured and shibOnly enabled, we should ignore anything other than a shibboleth type login.
1116 && C4::Context->preference('OPACShibOnly')
1118 || ( ( $type ne 'opac' )
1119 && C4::Context->preference('staffShibOnly') )
1126 # $return: 1 = valid user
1127 if( $return && $return > 0 ) {
1129 if ( $flags = haspermission( $userid, $flagsrequired ) ) {
1130 $auth_state = "logged_in";
1133 $auth_state = 'failed';
1134 # FIXME We could add $return = 0; or even delete the session?
1135 # Currently return == 1 and we will fill session info later on,
1136 # although we do present an authorization failure. (Yes, the
1137 # authentication was actually correct.)
1138 $info{'nopermission'} = 1;
1139 C4::Context::_unset_userenv($sessionID);
1141 my ( $borrowernumber, $firstname, $surname, $userflags,
1142 $branchcode, $branchname, $emailaddress, $desk_id,
1143 $desk_name, $register_id, $register_name );
1145 if ( $return == 1 ) {
1147 SELECT borrowernumber, firstname, surname, flags, borrowers.branchcode,
1148 branches.branchname as branchname, email
1150 LEFT JOIN branches on borrowers.branchcode=branches.branchcode
1152 my $dbh = C4::Context->dbh;
1153 my $sth = $dbh->prepare("$select where userid=?");
1154 $sth->execute($userid);
1155 unless ( $sth->rows ) {
1156 $sth = $dbh->prepare("$select where cardnumber=?");
1157 $sth->execute($cardnumber);
1159 unless ( $sth->rows ) {
1160 $sth->execute($userid);
1164 ( $borrowernumber, $firstname, $surname, $userflags,
1165 $branchcode, $branchname, $emailaddress ) = $sth->fetchrow;
1168 # launch a sequence to check if we have a ip for the branch, i
1169 # if we have one we replace the branchcode of the userenv by the branch bound in the ip.
1171 my $ip = $ENV{'REMOTE_ADDR'};
1173 # if they specify at login, use that
1174 if ( $query->param('branch') ) {
1175 $branchcode = $query->param('branch');
1176 my $library = Koha::Libraries->find($branchcode);
1177 $branchname = $library? $library->branchname: '';
1179 if ( $query->param('desk_id') ) {
1180 $desk_id = $query->param('desk_id');
1181 my $desk = Koha::Desks->find($desk_id);
1182 $desk_name = $desk ? $desk->desk_name : '';
1184 if ( C4::Context->preference('UseCashRegisters') ) {
1186 $query->param('register_id')
1187 ? Koha::Cash::Registers->find($query->param('register_id'))
1188 : Koha::Cash::Registers->search(
1189 { branch => $branchcode, branch_default => 1 },
1190 { rows => 1 } )->single;
1191 $register_id = $register->id if ($register);
1192 $register_name = $register->name if ($register);
1194 my $branches = { map { $_->branchcode => $_->unblessed } Koha::Libraries->search->as_list };
1195 if ( $type ne 'opac' and C4::Context->preference('AutoLocation') ) {
1197 # we have to check they are coming from the right ip range
1198 my $domain = $branches->{$branchcode}->{'branchip'};
1199 $domain =~ s|\.\*||g;
1200 if ( $ip !~ /^$domain/ ) {
1202 $cookie = $cookie_mgr->replace_in_list( $cookie, $query->cookie(
1203 -name => 'CGISESSID',
1206 -secure => ( C4::Context->https_enabled() ? 1 : 0 ),
1209 $info{'wrongip'} = 1;
1213 foreach my $br ( keys %$branches ) {
1215 # now we work with the treatment of ip
1216 my $domain = $branches->{$br}->{'branchip'};
1217 if ( $domain && $ip =~ /^$domain/ ) {
1218 $branchcode = $branches->{$br}->{'branchcode'};
1220 # new op dev : add the branchname to the cookie
1221 $branchname = $branches->{$br}->{'branchname'};
1225 my $is_sco_user = 0;
1226 if ( $query->param('sco_user_login') && ( $query->param('sco_user_login') eq '1' ) ){
1230 $session->param( 'number', $borrowernumber );
1231 $session->param( 'id', $userid );
1232 $session->param( 'cardnumber', $cardnumber );
1233 $session->param( 'firstname', $firstname );
1234 $session->param( 'surname', $surname );
1235 $session->param( 'branch', $branchcode );
1236 $session->param( 'branchname', $branchname );
1237 $session->param( 'desk_id', $desk_id);
1238 $session->param( 'desk_name', $desk_name);
1239 $session->param( 'flags', $userflags );
1240 $session->param( 'emailaddress', $emailaddress );
1241 $session->param( 'ip', $session->remote_addr() );
1242 $session->param( 'lasttime', time() );
1243 $session->param( 'interface', $type);
1244 $session->param( 'shibboleth', $shibSuccess );
1245 $session->param( 'register_id', $register_id );
1246 $session->param( 'register_name', $register_name );
1247 $session->param( 'sco_user', $is_sco_user );
1249 $session->param('cas_ticket', $cas_ticket) if $cas_ticket;
1250 C4::Context->set_userenv(
1251 $session->param('number'), $session->param('id'),
1252 $session->param('cardnumber'), $session->param('firstname'),
1253 $session->param('surname'), $session->param('branch'),
1254 $session->param('branchname'), $session->param('flags'),
1255 $session->param('emailaddress'), $session->param('shibboleth'),
1256 $session->param('desk_id'), $session->param('desk_name'),
1257 $session->param('register_id'), $session->param('register_name')
1261 # $return: 0 = invalid user
1262 # reset to anonymous session
1265 $info{'invalid_username_or_password'} = 1;
1266 C4::Context::_unset_userenv($sessionID);
1268 $session->param( 'lasttime', time() );
1269 $session->param( 'ip', $session->remote_addr() );
1270 $session->param( 'sessiontype', 'anon' );
1271 $session->param( 'interface', $type);
1273 } # END if ( $q_userid
1274 elsif ( $type eq "opac" ) {
1276 # anonymous sessions are created only for the OPAC
1278 # setting a couple of other session vars...
1279 $session->param( 'ip', $session->remote_addr() );
1280 $session->param( 'lasttime', time() );
1281 $session->param( 'sessiontype', 'anon' );
1282 $session->param( 'interface', $type);
1285 } # END unless ($userid)
1288 if ( $auth_state eq 'logged_in' ) {
1289 $auth_state = 'completed';
1291 # Auth is completed unless an additional auth is needed
1292 if ( $require_2FA ) {
1293 my $patron = Koha::Patrons->find({userid => $userid});
1294 if ( C4::Context->preference('TwoFactorAuthentication') eq "enforced" && $patron->auth_method eq 'password' ) {
1295 $auth_state = 'setup-additional-auth-needed';
1296 $session->param('waiting-for-2FA-setup', 1);
1297 %info = ();# We remove the warnings/errors we may have set incorrectly before
1298 } elsif ( $patron->auth_method eq 'two-factor' ) {
1299 # Ask for the OTP token
1300 $auth_state = 'additional-auth-needed';
1301 $session->param('waiting-for-2FA', 1);
1302 %info = ();# We remove the warnings/errors we may have set incorrectly before
1307 # finished authentification, now respond
1308 if ( $auth_state eq 'completed' || $authnotrequired ) {
1311 $cookie = $cookie_mgr->replace_in_list( $cookie, $query->cookie(
1312 -name => 'CGISESSID',
1315 -secure => ( C4::Context->https_enabled() ? 1 : 0 ),
1320 track_login_daily( $userid );
1322 # In case, that this request was a login attempt, we want to prevent that users can repost the opac login
1323 # request. We therefore redirect the user to the requested page again without the login parameters.
1324 # See Post/Redirect/Get (PRG) design pattern: https://en.wikipedia.org/wiki/Post/Redirect/Get
1325 if ( $type eq "opac" && $query->param('koha_login_context') && $query->param('koha_login_context') ne 'sco' && $query->param('password') && $query->param('userid') ) {
1326 my $uri = URI->new($query->url(-relative=>1, -query_string=>1));
1327 $uri->query_param_delete('userid');
1328 $uri->query_param_delete('password');
1329 $uri->query_param_delete('koha_login_context');
1330 print $query->redirect(-uri => $uri->as_string, -cookie => $cookie, -status=>'303 See other');
1334 return ( $userid, $cookie, $sessionID, $flags );
1339 # AUTH rejected, show the login/password template, after checking the DB.
1343 my $patron = Koha::Patrons->find({ userid => $q_userid }); # Not necessary logged in!
1345 # get the inputs from the incoming query
1347 my @inputs_to_clean = qw( userid password ticket logout.x otp_token );
1348 foreach my $name ( param $query) {
1349 next if grep { $name eq $_ } @inputs_to_clean;
1350 my @value = $query->multi_param($name);
1351 push @inputs, { name => $name, value => $_ } for @value;
1354 my $LibraryNameTitle = C4::Context->preference("LibraryName");
1355 $LibraryNameTitle =~ s/<(?:\/?)(?:br|p)\s*(?:\/?)>/ /sgi;
1356 $LibraryNameTitle =~ s/<(?:[^<>'"]|'(?:[^']*)'|"(?:[^"]*)")*>//sg;
1358 my $auth_template_name = ( $type eq 'opac' ) ? 'opac-auth.tt' : 'auth.tt';
1359 my $auth_error = $query->param('auth_error');
1360 my $template = C4::Templates::gettemplate( $auth_template_name, $type, $query );
1364 script_name => get_script_name(),
1365 casAuthentication => C4::Context->preference("casAuthentication"),
1366 shibbolethAuthentication => $shib,
1367 suggestion => C4::Context->preference("suggestion"),
1368 virtualshelves => C4::Context->preference("virtualshelves"),
1369 LibraryName => "" . C4::Context->preference("LibraryName"),
1370 LibraryNameTitle => "" . $LibraryNameTitle,
1371 opacuserlogin => C4::Context->preference("opacuserlogin"),
1372 OpacFavicon => C4::Context->preference("OpacFavicon"),
1373 opacreadinghistory => C4::Context->preference("opacreadinghistory"),
1374 opaclanguagesdisplay => C4::Context->preference("opaclanguagesdisplay"),
1375 OPACUserJS => C4::Context->preference("OPACUserJS"),
1376 OPACUserCSS => C4::Context->preference("OPACUserCSS"),
1377 intranetcolorstylesheet => C4::Context->preference("intranetcolorstylesheet"),
1378 intranetstylesheet => C4::Context->preference("intranetstylesheet"),
1379 IntranetNav => C4::Context->preference("IntranetNav"),
1380 IntranetFavicon => C4::Context->preference("IntranetFavicon"),
1381 IntranetUserCSS => C4::Context->preference("IntranetUserCSS"),
1382 IntranetUserJS => C4::Context->preference("IntranetUserJS"),
1383 IndependentBranches => C4::Context->preference("IndependentBranches"),
1384 AutoLocation => C4::Context->preference("AutoLocation"),
1385 wrongip => $info{'wrongip'},
1386 PatronSelfRegistration => C4::Context->preference("PatronSelfRegistration"),
1387 PatronSelfRegistrationDefaultCategory => C4::Context->preference("PatronSelfRegistrationDefaultCategory"),
1388 opac_css_override => $ENV{'OPAC_CSS_OVERRIDE'},
1389 too_many_login_attempts => ( $patron and $patron->account_locked ),
1390 password_has_expired => ( $patron and $patron->password_expired ),
1391 auth_error => $auth_error,
1394 $template->param( SCO_login => 1 ) if ( $query->param('sco_user_login') );
1395 $template->param( SCI_login => 1 ) if ( $query->param('sci_user_login') );
1396 $template->param( OpacPublic => C4::Context->preference("OpacPublic") );
1397 $template->param( loginprompt => 1 ) unless $info{'nopermission'};
1398 if ( $auth_state eq 'additional-auth-needed' ) {
1399 my $patron = Koha::Patrons->find( { userid => $userid } );
1402 invalid_otp_token => $invalid_otp_token,
1403 notice_email_address => $patron->notice_email_address, # We could also pass logged_in_user if necessary
1407 if ( $auth_state eq 'setup-additional-auth-needed' ) {
1413 if ( $type eq 'opac' ) {
1414 require Koha::Virtualshelves;
1415 my $some_public_shelves = Koha::Virtualshelves->get_some_shelves(
1421 some_public_shelves => $some_public_shelves,
1427 # Is authentication against multiple CAS servers enabled?
1428 require C4::Auth_with_cas;
1429 if ( multipleAuth() && !$casparam ) {
1430 my $casservers = getMultipleAuth();
1432 foreach my $key ( keys %$casservers ) {
1433 push @tmplservers, { name => $key, value => login_cas_url( $query, $key, $type ) . "?cas=$key" };
1436 casServersLoop => \@tmplservers
1440 casServerUrl => login_cas_url($query, undef, $type),
1445 invalidCasLogin => $info{'invalidCasLogin'}
1450 #If shibOnly is enabled just go ahead and redirect directly
1451 if ( (($type eq 'opac') && C4::Context->preference('OPACShibOnly')) || (($type ne 'opac') && C4::Context->preference('staffShibOnly')) ) {
1452 my $redirect_url = login_shib_url( $query );
1453 print $query->redirect( -uri => "$redirect_url", -status => 303 );
1458 shibbolethAuthentication => $shib,
1459 shibbolethLoginUrl => login_shib_url($query),
1463 if (C4::Context->preference('GoogleOpenIDConnect')) {
1464 if ($query->param("OpenIDConnectFailed")) {
1465 my $reason = $query->param('OpenIDConnectFailed');
1466 $template->param(invalidGoogleOpenIDConnectLogin => $reason);
1471 LibraryName => C4::Context->preference("LibraryName"),
1473 $template->param(%info);
1475 # $cookie = $query->cookie(CGISESSID => $session->id
1477 print $query->header(
1478 { type => 'text/html',
1481 'X-Frame-Options' => 'SAMEORIGIN',
1489 =head2 check_api_auth
1491 ($status, $cookie, $sessionId) = check_api_auth($query, $userflags);
1493 Given a CGI query containing the parameters 'userid' and 'password' and/or a session
1494 cookie, determine if the user has the privileges specified by C<$userflags>.
1496 C<check_api_auth> is is meant for authenticating users of web services, and
1497 consequently will always return and will not attempt to redirect the user
1500 If a valid session cookie is already present, check_api_auth will return a status
1501 of "ok", the cookie, and the Koha session ID.
1503 If no session cookie is present, check_api_auth will check the 'userid' and 'password
1504 parameters and create a session cookie and Koha session if the supplied credentials
1507 Possible return values in C<$status> are:
1511 =item "ok" -- user authenticated; C<$cookie> and C<$sessionid> have valid values.
1513 =item "failed" -- credentials are not correct; C<$cookie> and C<$sessionid> are undef
1515 =item "maintenance" -- DB is in maintenance mode; no login possible at the moment
1517 =item "expired -- session cookie has expired; API user should resubmit userid and password
1519 =item "restricted" -- The IP has changed (if SessionRestrictionByIP)
1521 =item "additional-auth-needed -- User is in an authentication process that is not finished
1527 sub check_api_auth {
1530 my $flagsrequired = shift;
1531 my $timeout = _timeout_syspref();
1533 unless ( C4::Context->preference('Version') ) {
1535 # database has not been installed yet
1536 return ( "maintenance", undef, undef );
1538 my $kohaversion = Koha::version();
1539 $kohaversion =~ s/(.*\..*)\.(.*)\.(.*)/$1$2$3/;
1540 if ( C4::Context->preference('Version') < $kohaversion ) {
1542 # database in need of version update; assume that
1543 # no API should be called while databsae is in
1545 return ( "maintenance", undef, undef );
1548 my ( $sessionID, $session );
1549 unless ( $query->param('userid') ) {
1550 $sessionID = $query->cookie("CGISESSID");
1552 if ( $sessionID && not( $cas && $query->param('PT') ) ) {
1555 ( $return, $session, undef ) = check_cookie_auth(
1556 $sessionID, $flagsrequired, { remote_addr => $ENV{REMOTE_ADDR} } );
1558 return ( $return, undef, undef ) # Cookie auth failed
1561 my $cookie = $query->cookie(
1562 -name => 'CGISESSID',
1563 -value => $session->id,
1565 -secure => ( C4::Context->https_enabled() ? 1 : 0 ),
1568 return ( $return, $cookie, $session ); # return == 'ok' here
1573 my $userid = $query->param('userid');
1574 my $password = $query->param('password');
1575 my ( $return, $cardnumber, $cas_ticket );
1578 if ( $cas && $query->param('PT') ) {
1581 # In case of a CAS authentication, we use the ticket instead of the password
1582 my $PT = $query->param('PT');
1583 ( $return, $cardnumber, $userid, $cas_ticket ) = check_api_auth_cas( $PT, $query ); # EXTERNAL AUTH
1586 # User / password auth
1587 unless ( $userid and $password ) {
1589 # caller did something wrong, fail the authenticateion
1590 return ( "failed", undef, undef );
1593 ( $return, $cardnumber, $newuserid, $cas_ticket ) = checkpw( $userid, $password, $query );
1596 if ( $return and haspermission( $userid, $flagsrequired ) ) {
1597 my $session = get_session("");
1598 return ( "failed", undef, undef ) unless $session;
1600 my $sessionID = $session->id;
1601 C4::Context->_new_userenv($sessionID);
1602 my $cookie = $query->cookie(
1603 -name => 'CGISESSID',
1604 -value => $sessionID,
1606 -secure => ( C4::Context->https_enabled() ? 1 : 0 ),
1609 if ( $return == 1 ) {
1611 $borrowernumber, $firstname, $surname,
1612 $userflags, $branchcode, $branchname,
1615 my $dbh = C4::Context->dbh;
1618 "select borrowernumber, firstname, surname, flags, borrowers.branchcode, branches.branchname as branchname, email from borrowers left join branches on borrowers.branchcode=branches.branchcode where userid=?"
1620 $sth->execute($userid);
1622 $borrowernumber, $firstname, $surname,
1623 $userflags, $branchcode, $branchname,
1625 ) = $sth->fetchrow if ( $sth->rows );
1627 unless ( $sth->rows ) {
1628 my $sth = $dbh->prepare(
1629 "select borrowernumber, firstname, surname, flags, borrowers.branchcode, branches.branchname as branchname, email from borrowers left join branches on borrowers.branchcode=branches.branchcode where cardnumber=?"
1631 $sth->execute($cardnumber);
1633 $borrowernumber, $firstname, $surname,
1634 $userflags, $branchcode, $branchname,
1636 ) = $sth->fetchrow if ( $sth->rows );
1638 unless ( $sth->rows ) {
1639 $sth->execute($userid);
1641 $borrowernumber, $firstname, $surname, $userflags,
1642 $branchcode, $branchname, $emailaddress
1643 ) = $sth->fetchrow if ( $sth->rows );
1647 my $ip = $ENV{'REMOTE_ADDR'};
1649 # if they specify at login, use that
1650 if ( $query->param('branch') ) {
1651 $branchcode = $query->param('branch');
1652 my $library = Koha::Libraries->find($branchcode);
1653 $branchname = $library? $library->branchname: '';
1655 my $branches = { map { $_->branchcode => $_->unblessed } Koha::Libraries->search->as_list };
1656 foreach my $br ( keys %$branches ) {
1658 # now we work with the treatment of ip
1659 my $domain = $branches->{$br}->{'branchip'};
1660 if ( $domain && $ip =~ /^$domain/ ) {
1661 $branchcode = $branches->{$br}->{'branchcode'};
1663 # new op dev : add the branchname to the cookie
1664 $branchname = $branches->{$br}->{'branchname'};
1667 $session->param( 'number', $borrowernumber );
1668 $session->param( 'id', $userid );
1669 $session->param( 'cardnumber', $cardnumber );
1670 $session->param( 'firstname', $firstname );
1671 $session->param( 'surname', $surname );
1672 $session->param( 'branch', $branchcode );
1673 $session->param( 'branchname', $branchname );
1674 $session->param( 'flags', $userflags );
1675 $session->param( 'emailaddress', $emailaddress );
1676 $session->param( 'ip', $session->remote_addr() );
1677 $session->param( 'lasttime', time() );
1678 $session->param( 'interface', 'api' );
1680 $session->param( 'cas_ticket', $cas_ticket);
1681 C4::Context->set_userenv(
1682 $session->param('number'), $session->param('id'),
1683 $session->param('cardnumber'), $session->param('firstname'),
1684 $session->param('surname'), $session->param('branch'),
1685 $session->param('branchname'), $session->param('flags'),
1686 $session->param('emailaddress'), $session->param('shibboleth'),
1687 $session->param('desk_id'), $session->param('desk_name'),
1688 $session->param('register_id'), $session->param('register_name')
1690 return ( "ok", $cookie, $sessionID );
1692 return ( "failed", undef, undef );
1697 =head2 check_cookie_auth
1699 ($status, $sessionId) = check_cookie_auth($cookie, $userflags);
1701 Given a CGISESSID cookie set during a previous login to Koha, determine
1702 if the user has the privileges specified by C<$userflags>. C<$userflags>
1703 is passed unaltered into C<haspermission> and as such accepts all options
1704 avaiable to that routine with the one caveat that C<check_api_auth> will
1705 also allow 'undef' to be passed and in such a case the permissions check
1706 will be skipped altogether.
1708 C<check_cookie_auth> is meant for authenticating special services
1709 such as tools/upload-file.pl that are invoked by other pages that
1710 have been authenticated in the usual way.
1712 Possible return values in C<$status> are:
1716 =item "ok" -- user authenticated; C<$sessionID> have valid values.
1718 =item "anon" -- user not authenticated but valid for anonymous session.
1720 =item "failed" -- credentials are not correct; C<$sessionid> are undef
1722 =item "maintenance" -- DB is in maintenance mode; no login possible at the moment
1724 =item "expired -- session cookie has expired; API user should resubmit userid and password
1726 =item "restricted" -- The IP has changed (if SessionRestrictionByIP)
1732 sub check_cookie_auth {
1733 my $sessionID = shift;
1734 my $flagsrequired = shift;
1737 my $remote_addr = $params->{remote_addr} || $ENV{REMOTE_ADDR};
1739 my $skip_version_check = $params->{skip_version_check}; # Only for checkauth
1741 unless ( $skip_version_check ) {
1742 unless ( C4::Context->preference('Version') ) {
1744 # database has not been installed yet
1745 return ( "maintenance", undef );
1747 my $kohaversion = Koha::version();
1748 $kohaversion =~ s/(.*\..*)\.(.*)\.(.*)/$1$2$3/;
1749 if ( C4::Context->preference('Version') < $kohaversion ) {
1751 # database in need of version update; assume that
1752 # no API should be called while databsae is in
1754 return ( "maintenance", undef );
1758 # see if we have a valid session cookie already
1759 # however, if a userid parameter is present (i.e., from
1760 # a form submission, assume that any current cookie
1762 unless ( $sessionID ) {
1763 return ( "failed", undef );
1765 C4::Context::_unset_userenv($sessionID); # remove old userenv first
1766 my $session = get_session($sessionID);
1768 my $userid = $session->param('id');
1769 my $ip = $session->param('ip');
1770 my $lasttime = $session->param('lasttime');
1771 my $timeout = _timeout_syspref();
1773 if ( !$lasttime || ( $lasttime < time() - $timeout ) ) {
1777 return ("expired", undef);
1779 } elsif ( C4::Context->preference('SessionRestrictionByIP') && $ip ne $remote_addr ) {
1780 # IP address changed
1783 return ( "restricted", undef, { old_ip => $ip, new_ip => $remote_addr});
1785 } elsif ( $userid ) {
1786 $session->param( 'lasttime', time() );
1787 my $patron = Koha::Patrons->find({ userid => $userid });
1789 # If the user modify their own userid
1790 # Better than 500 but we could do better
1791 unless ( $patron ) {
1794 return ("expired", undef);
1797 $patron = Koha::Patrons->find({ cardnumber => $userid })
1799 return ("password_expired", undef ) if $patron->password_expired;
1800 my $flags = defined($flagsrequired) ? haspermission( $userid, $flagsrequired ) : 1;
1802 C4::Context->_new_userenv($sessionID);
1803 if ( !C4::Context->interface ) {
1804 # No need to override the interface, most often set by get_template_and_user
1805 C4::Context->interface( $session->param('interface') );
1807 C4::Context->set_userenv(
1808 $session->param('number'), $session->param('id') // '',
1809 $session->param('cardnumber'), $session->param('firstname'),
1810 $session->param('surname'), $session->param('branch'),
1811 $session->param('branchname'), $session->param('flags'),
1812 $session->param('emailaddress'), $session->param('shibboleth'),
1813 $session->param('desk_id'), $session->param('desk_name'),
1814 $session->param('register_id'), $session->param('register_name')
1816 if ( C4::Context->preference('TwoFactorAuthentication') ne 'disabled' ) {
1817 return ( "additional-auth-needed", $session )
1818 if $session->param('waiting-for-2FA');
1820 return ( "setup-additional-auth-needed", $session )
1821 if $session->param('waiting-for-2FA-setup');
1824 return ( "ok", $session );
1828 return ( "failed", undef );
1832 C4::Context->_new_userenv($sessionID);
1833 C4::Context->interface($session->param('interface'));
1834 C4::Context->set_userenv( undef, q{} );
1835 return ( "anon", $session );
1838 return ( "expired", undef );
1845 my $session = get_session($sessionID);
1847 Given a session ID, retrieve the CGI::Session object used to store
1848 the session's state. The session object can be used to store
1849 data that needs to be accessed by different scripts during a
1852 If the C<$sessionID> parameter is an empty string, a new session
1857 sub _get_session_params {
1858 my $storage_method = C4::Context->preference('SessionStorage');
1859 if ( $storage_method eq 'mysql' ) {
1860 my $dbh = C4::Context->dbh;
1861 return { dsn => "serializer:yamlxs;driver:MySQL;id:md5", dsn_args => { Handle => $dbh } };
1863 elsif ( $storage_method eq 'Pg' ) {
1864 my $dbh = C4::Context->dbh;
1865 return { dsn => "serializer:yamlxs;driver:PostgreSQL;id:md5", dsn_args => { Handle => $dbh } };
1867 elsif ( $storage_method eq 'memcached' && Koha::Caches->get_instance->memcached_cache ) {
1868 my $memcached = Koha::Caches->get_instance()->memcached_cache;
1869 return { dsn => "serializer:yamlxs;driver:memcached;id:md5", dsn_args => { Memcached => $memcached } };
1872 # catch all defaults to tmp should work on all systems
1873 my $dir = C4::Context::temporary_directory;
1874 my $instance = C4::Context->config( 'database' ); #actually for packages not exactly the instance name, but generally safer to leave it as it is
1875 return { dsn => "serializer:yamlxs;driver:File;id:md5", dsn_args => { Directory => "$dir/cgisess_$instance" } };
1880 my $sessionID = shift;
1881 my $params = _get_session_params();
1883 if( $sessionID ) { # find existing
1884 CGI::Session::ErrorHandler->set_error( q{} ); # clear error, cpan issue #111463
1885 $session = CGI::Session->load( $params->{dsn}, $sessionID, $params->{dsn_args} );
1887 $session = CGI::Session->new( $params->{dsn}, $sessionID, $params->{dsn_args} );
1888 # no need to flush here
1893 =head2 create_basic_session
1895 my $session = create_basic_session({ patron => $patron, interface => $interface });
1897 Creates a session and adds all basic parameters for a session to work
1901 sub create_basic_session {
1903 my $patron = $params->{patron};
1904 my $interface = $params->{interface};
1906 $interface = 'intranet' if $interface eq 'staff';
1908 my $session = get_session("");
1910 $session->param( 'number', $patron->borrowernumber );
1911 $session->param( 'id', $patron->userid );
1912 $session->param( 'cardnumber', $patron->cardnumber );
1913 $session->param( 'firstname', $patron->firstname );
1914 $session->param( 'surname', $patron->surname );
1915 $session->param( 'branch', $patron->branchcode );
1916 $session->param( 'branchname', $patron->library->branchname );
1917 $session->param( 'flags', $patron->flags );
1918 $session->param( 'emailaddress', $patron->email );
1919 $session->param( 'ip', $session->remote_addr() );
1920 $session->param( 'lasttime', time() );
1921 $session->param( 'interface', $interface);
1927 # FIXME no_set_userenv may be replaced with force_branchcode_for_userenv
1928 # (or something similar)
1929 # Currently it's only passed from C4::SIP::ILS::Patron::check_password, but
1930 # not having a userenv defined could cause a crash.
1932 my ( $userid, $password, $query, $type, $no_set_userenv ) = @_;
1933 $type = 'opac' unless $type;
1935 # Get shibboleth login attribute
1936 my $shib = C4::Context->config('useshibboleth') && shib_ok();
1937 my $shib_login = $shib ? get_login_shib() : undef;
1941 if ( defined $userid ){
1942 $patron = Koha::Patrons->find({ userid => $userid });
1943 $patron = Koha::Patrons->find({ cardnumber => $userid }) unless $patron;
1945 my $check_internal_as_fallback = 0;
1947 # Note: checkpw_* routines returns:
1950 # -1 if user bind failed (LDAP only)
1952 if ( $patron and ( $patron->account_locked ) ) {
1953 # Nothing to check, account is locked
1954 } elsif ($ldap && defined($password)) {
1955 my ( $retval, $retcard, $retuserid ) = checkpw_ldap(@_); # EXTERNAL AUTH
1956 if ( $retval == 1 ) {
1957 @return = ( $retval, $retcard, $retuserid );
1960 $check_internal_as_fallback = 1 if $retval == 0;
1962 } elsif ( $cas && $query && $query->param('ticket') ) {
1964 # In case of a CAS authentication, we use the ticket instead of the password
1965 my $ticket = $query->param('ticket');
1966 $query->delete('ticket'); # remove ticket to come back to original URL
1967 my ( $retval, $retcard, $retuserid, $cas_ticket ) = checkpw_cas( $ticket, $query, $type ); # EXTERNAL AUTH
1969 @return = ( $retval, $retcard, $retuserid, $cas_ticket );
1973 $passwd_ok = $retval;
1976 # If we are in a shibboleth session (shibboleth is enabled, and a shibboleth match attribute is present)
1977 # Check for password to asertain whether we want to be testing against shibboleth or another method this
1979 elsif ( $shib && $shib_login && !$password ) {
1981 # In case of a Shibboleth authentication, we expect a shibboleth user attribute
1982 # (defined under shibboleth mapping in koha-conf.xml) to contain the login of the
1983 # shibboleth-authenticated user
1985 # Then, we check if it matches a valid koha user
1987 my ( $retval, $retcard, $retuserid ) = C4::Auth_with_shibboleth::checkpw_shib($shib_login); # EXTERNAL AUTH
1989 @return = ( $retval, $retcard, $retuserid );
1991 $passwd_ok = $retval;
1994 $check_internal_as_fallback = 1;
1998 if ( $check_internal_as_fallback ) {
1999 @return = checkpw_internal( $userid, $password, $no_set_userenv);
2000 $passwd_ok = 1 if $return[0] > 0; # 1 or 2
2005 $patron->update({ login_attempts => 0 });
2006 if( $patron->password_expired ){
2009 } elsif( !$patron->account_locked ) {
2010 $patron->update({ login_attempts => $patron->login_attempts + 1 });
2014 # Optionally log success or failure
2015 if( $patron && $passwd_ok && C4::Context->preference('AuthSuccessLog') ) {
2016 logaction( 'AUTH', 'SUCCESS', $patron->id, "Valid password for $userid", $type );
2017 } elsif( !$passwd_ok && C4::Context->preference('AuthFailureLog') ) {
2018 logaction( 'AUTH', 'FAILURE', $patron ? $patron->id : 0, "Wrong password for $userid", $type );
2024 sub checkpw_internal {
2025 my ( $userid, $password, $no_set_userenv ) = @_;
2027 $password = Encode::encode( 'UTF-8', $password )
2028 if Encode::is_utf8($password);
2030 my $dbh = C4::Context->dbh;
2033 "select password,cardnumber,borrowernumber,userid,firstname,surname,borrowers.branchcode,branches.branchname,flags from borrowers join branches on borrowers.branchcode=branches.branchcode where userid=?"
2035 $sth->execute($userid);
2037 my ( $stored_hash, $cardnumber, $borrowernumber, $userid, $firstname,
2038 $surname, $branchcode, $branchname, $flags )
2041 if ( checkpw_hash( $password, $stored_hash ) ) {
2043 C4::Context->set_userenv( "$borrowernumber", $userid, $cardnumber,
2044 $firstname, $surname, $branchcode, $branchname, $flags ) unless $no_set_userenv;
2045 return 1, $cardnumber, $userid;
2050 "select password,cardnumber,borrowernumber,userid,firstname,surname,borrowers.branchcode,branches.branchname,flags from borrowers join branches on borrowers.branchcode=branches.branchcode where cardnumber=?"
2052 $sth->execute($userid);
2054 my ( $stored_hash, $cardnumber, $borrowernumber, $userid, $firstname,
2055 $surname, $branchcode, $branchname, $flags )
2058 if ( checkpw_hash( $password, $stored_hash ) ) {
2060 C4::Context->set_userenv( $borrowernumber, $userid, $cardnumber,
2061 $firstname, $surname, $branchcode, $branchname, $flags ) unless $no_set_userenv;
2062 return 1, $cardnumber, $userid;
2069 my ( $password, $stored_hash ) = @_;
2071 return if $stored_hash eq '!';
2073 # check what encryption algorithm was implemented: Bcrypt - if the hash starts with '$2' it is Bcrypt else md5
2075 if ( substr( $stored_hash, 0, 2 ) eq '$2' ) {
2076 $hash = hash_password( $password, $stored_hash );
2078 $hash = md5_base64($password);
2080 return $hash eq $stored_hash;
2085 my $authflags = getuserflags($flags, $userid, [$dbh]);
2087 Translates integer flags into permissions strings hash.
2089 C<$flags> is the integer userflags value ( borrowers.userflags )
2090 C<$userid> is the members.userid, used for building subpermissions
2091 C<$authflags> is a hashref of permissions
2098 my $dbh = @_ ? shift : C4::Context->dbh;
2101 # I don't want to do this, but if someone logs in as the database
2102 # user, it would be preferable not to spam them to death with
2103 # numeric warnings. So, we make $flags numeric.
2104 no warnings 'numeric';
2107 my $sth = $dbh->prepare("SELECT bit, flag, defaulton FROM userflags");
2110 while ( my ( $bit, $flag, $defaulton ) = $sth->fetchrow ) {
2111 if ( ( $flags & ( 2**$bit ) ) || $defaulton ) {
2112 $userflags->{$flag} = 1;
2115 $userflags->{$flag} = 0;
2119 # get subpermissions and merge with top-level permissions
2120 my $user_subperms = get_user_subpermissions($userid);
2121 foreach my $module ( keys %$user_subperms ) {
2122 next if $userflags->{$module} == 1; # user already has permission for everything in this module
2123 $userflags->{$module} = $user_subperms->{$module};
2129 =head2 get_user_subpermissions
2131 $user_perm_hashref = get_user_subpermissions($userid);
2133 Given the userid (note, not the borrowernumber) of a staff user,
2134 return a hashref of hashrefs of the specific subpermissions
2135 accorded to the user. An example return is
2139 export_catalog => 1,
2140 import_patrons => 1,
2144 The top-level hash-key is a module or function code from
2145 userflags.flag, while the second-level key is a code
2148 The results of this function do not give a complete picture
2149 of the functions that a staff user can access; it is also
2150 necessary to check borrowers.flags.
2154 sub get_user_subpermissions {
2157 my $dbh = C4::Context->dbh;
2158 my $sth = $dbh->prepare( "SELECT flag, user_permissions.code
2159 FROM user_permissions
2160 JOIN permissions USING (module_bit, code)
2161 JOIN userflags ON (module_bit = bit)
2162 JOIN borrowers USING (borrowernumber)
2163 WHERE userid = ?" );
2164 $sth->execute($userid);
2166 my $user_perms = {};
2167 while ( my $perm = $sth->fetchrow_hashref ) {
2168 $user_perms->{ $perm->{'flag'} }->{ $perm->{'code'} } = 1;
2173 =head2 get_all_subpermissions
2175 my $perm_hashref = get_all_subpermissions();
2177 Returns a hashref of hashrefs defining all specific
2178 permissions currently defined. The return value
2179 has the same structure as that of C<get_user_subpermissions>,
2180 except that the innermost hash value is the description
2181 of the subpermission.
2185 sub get_all_subpermissions {
2186 my $dbh = C4::Context->dbh;
2187 my $sth = $dbh->prepare( "SELECT flag, code
2189 JOIN userflags ON (module_bit = bit)" );
2193 while ( my $perm = $sth->fetchrow_hashref ) {
2194 $all_perms->{ $perm->{'flag'} }->{ $perm->{'code'} } = 1;
2199 =head2 get_cataloguing_page_permissions
2201 my $required_permissions = get_cataloguing_page_permissions();
2203 Returns the required permissions to access the main cataloguing page. Useful for building
2204 the global I<can_see_cataloguing_module> template variable, and also for reusing in
2205 I<cataloging-home.pl>.
2209 sub get_cataloguing_page_permissions {
2211 my @cataloguing_tools_subperms = qw(
2218 marc_modification_templates
2226 { editcatalogue => '*' }, { tools => \@cataloguing_tools_subperms },
2227 C4::Context->preference('StockRotation') ? { stockrotation => 'manage_rotas' } : ()
2231 =head2 haspermission
2233 $flagsrequired = '*'; # Any permission at all
2234 $flagsrequired = 'a_flag'; # a_flag must be satisfied (all subpermissions)
2235 $flagsrequired = [ 'a_flag', 'b_flag' ]; # a_flag OR b_flag must be satisfied
2236 $flagsrequired = { 'a_flag => 1, 'b_flag' => 1 }; # a_flag AND b_flag must be satisfied
2237 $flagsrequired = { 'a_flag' => 'sub_a' }; # sub_a of a_flag must be satisfied
2238 $flagsrequired = { 'a_flag' => [ 'sub_a, 'sub_b' ] }; # sub_a OR sub_b of a_flag must be satisfied
2240 $flags = ($userid, $flagsrequired);
2242 C<$userid> the userid of the member
2243 C<$flags> is a query structure similar to that used by SQL::Abstract that
2244 denotes the combination of flags required. It is a required parameter.
2246 The main logic of this method is that things in arrays are OR'ed, and things
2247 in hashes are AND'ed. The `*` character can be used, at any depth, to denote `ANY`
2249 Returns member's flags or 0 if a permission is not met.
2254 my ($required, $flags) = @_;
2256 my $ref = ref($required);
2258 if ($required eq '*') {
2259 return 0 unless ( $flags or ref( $flags ) );
2261 return 0 unless ( $flags and (!ref( $flags ) || $flags->{$required} ));
2263 } elsif ($ref eq 'HASH') {
2264 foreach my $key (keys %{$required}) {
2265 next if $flags == 1;
2266 my $require = $required->{$key};
2267 my $rflags = $flags->{$key};
2268 return 0 unless _dispatch($require, $rflags);
2270 } elsif ($ref eq 'ARRAY') {
2272 foreach my $require ( @{$required} ) {
2274 ( ref($flags) && !ref($require) && ( $require ne '*' ) )
2275 ? $flags->{$require}
2277 $satisfied++ if _dispatch( $require, $rflags );
2279 return 0 unless $satisfied;
2281 croak "Unexpected structure found: $ref";
2288 my ( $userid, $flagsrequired ) = @_;
2290 #Koha::Exceptions::WrongParameter->throw('$flagsrequired should not be undef')
2291 # unless defined($flagsrequired);
2293 my $sth = C4::Context->dbh->prepare("SELECT flags FROM borrowers WHERE userid=?");
2294 $sth->execute($userid);
2295 my $row = $sth->fetchrow();
2296 my $flags = getuserflags( $row, $userid );
2298 return $flags unless defined($flagsrequired);
2299 return $flags if $flags->{superlibrarian};
2300 return _dispatch($flagsrequired, $flags);
2302 #FIXME - This fcn should return the failed permission so a suitable error msg can be delivered.
2307 $flags = ($iprange);
2309 C<$iprange> A space separated string describing an IP range. Can include single IPs or ranges
2311 Returns 1 if the remote address is in the provided iprange, or 0 otherwise.
2318 my @allowedipranges = $iprange ? split(' ', $iprange) : ();
2319 if (scalar @allowedipranges > 0) {
2321 eval { @rangelist = Net::CIDR::range2cidr(@allowedipranges); }; return 0 if $@;
2322 eval { $result = Net::CIDR::cidrlookup($ENV{'REMOTE_ADDR'}, @rangelist) } || Koha::Logger->get->warn('cidrlookup failed for ' . join(' ',@rangelist) );
2324 return $result ? 1 : 0;
2327 sub getborrowernumber {
2329 my $userenv = C4::Context->userenv;
2330 if ( defined($userenv) && ref($userenv) eq 'HASH' && $userenv->{number} ) {
2331 return $userenv->{number};
2333 my $dbh = C4::Context->dbh;
2334 for my $field ( 'userid', 'cardnumber' ) {
2336 $dbh->prepare("select borrowernumber from borrowers where $field=?");
2337 $sth->execute($userid);
2339 my ($bnumber) = $sth->fetchrow;
2346 =head2 track_login_daily
2348 track_login_daily( $userid );
2350 Wraps the call to $patron->track_login, the method used to update borrowers.lastseen. We only call track_login once a day.
2354 sub track_login_daily {
2356 return if !$userid || !C4::Context->preference('TrackLastPatronActivity');
2358 my $cache = Koha::Caches->get_instance();
2359 my $cache_key = "track_login_" . $userid;
2360 my $cached = $cache->get_from_cache($cache_key);
2361 my $today = dt_from_string()->ymd;
2362 return if $cached && $cached eq $today;
2364 my $patron = Koha::Patrons->find({ userid => $userid });
2365 return unless $patron;
2366 $patron->track_login;
2367 $cache->set_in_cache( $cache_key, $today );
2370 END { } # module clean-up code here (global destructor)
2380 Crypt::Eksblowfish::Bcrypt(3)