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 OpacAuthorities => C4::Context->preference("OpacAuthorities"),
577 opac_css_override => $ENV{'OPAC_CSS_OVERRIDE'},
578 opac_search_limit => $opac_search_limit,
579 opac_limit_override => $opac_limit_override,
580 OpacBrowser => C4::Context->preference("OpacBrowser"),
581 OpacCloud => C4::Context->preference("OpacCloud"),
582 OpacKohaUrl => C4::Context->preference("OpacKohaUrl"),
583 OpacPasswordChange => C4::Context->preference("OpacPasswordChange"),
584 OPACPatronDetails => C4::Context->preference("OPACPatronDetails"),
585 OPACPrivacy => C4::Context->preference("OPACPrivacy"),
586 OPACFinesTab => C4::Context->preference("OPACFinesTab"),
587 OpacTopissue => C4::Context->preference("OpacTopissue"),
588 'Version' => C4::Context->preference('Version'),
589 hidelostitems => C4::Context->preference("hidelostitems"),
590 mylibraryfirst => ( C4::Context->preference("SearchMyLibraryFirst") && C4::Context->userenv ) ? C4::Context->userenv->{'branch'} : '',
591 opacbookbag => "" . C4::Context->preference("opacbookbag"),
592 OpacFavicon => C4::Context->preference("OpacFavicon"),
593 opaclanguagesdisplay => "" . C4::Context->preference("opaclanguagesdisplay"),
594 opacreadinghistory => C4::Context->preference("opacreadinghistory"),
595 opacuserlogin => "" . C4::Context->preference("opacuserlogin"),
596 OpenLibrarySearch => C4::Context->preference("OpenLibrarySearch"),
597 ShowReviewer => C4::Context->preference("ShowReviewer"),
598 ShowReviewerPhoto => C4::Context->preference("ShowReviewerPhoto"),
599 suggestion => $can_make_suggestions,
600 virtualshelves => "" . C4::Context->preference("virtualshelves"),
601 OPACSerialIssueDisplayCount => C4::Context->preference("OPACSerialIssueDisplayCount"),
602 SyndeticsClientCode => C4::Context->preference("SyndeticsClientCode"),
603 SyndeticsEnabled => C4::Context->preference("SyndeticsEnabled"),
604 SyndeticsCoverImages => C4::Context->preference("SyndeticsCoverImages"),
605 SyndeticsTOC => C4::Context->preference("SyndeticsTOC"),
606 SyndeticsSummary => C4::Context->preference("SyndeticsSummary"),
607 SyndeticsEditions => C4::Context->preference("SyndeticsEditions"),
608 SyndeticsExcerpt => C4::Context->preference("SyndeticsExcerpt"),
609 SyndeticsReviews => C4::Context->preference("SyndeticsReviews"),
610 SyndeticsAuthorNotes => C4::Context->preference("SyndeticsAuthorNotes"),
611 SyndeticsAwards => C4::Context->preference("SyndeticsAwards"),
612 SyndeticsSeries => C4::Context->preference("SyndeticsSeries"),
613 SyndeticsCoverImageSize => C4::Context->preference("SyndeticsCoverImageSize"),
614 OPACLocalCoverImages => C4::Context->preference("OPACLocalCoverImages"),
615 PatronSelfRegistration => C4::Context->preference("PatronSelfRegistration"),
616 PatronSelfRegistrationDefaultCategory => C4::Context->preference("PatronSelfRegistrationDefaultCategory"),
617 useDischarge => C4::Context->preference('useDischarge'),
620 $template->param( OpacPublic => '1' ) if ( $user || C4::Context->preference("OpacPublic") );
623 # Check if we were asked using parameters to force a specific language
624 if ( defined $in->{'query'}->param('language') ) {
626 # Extract the language, let C4::Languages::getlanguage choose
628 my $language = C4::Languages::getlanguage( $in->{'query'} );
629 my $languagecookie = C4::Templates::getlanguagecookie( $in->{'query'}, $language );
630 $cookie = $cookie_mgr->replace_in_list( $cookie, $languagecookie );
633 return ( $template, $borrowernumber, $cookie, $flags );
638 ($userid, $cookie, $sessionID) = &checkauth($query, $noauth, $flagsrequired, $type);
640 Verifies that the user is authorized to run this script. If
641 the user is authorized, a (userid, cookie, session-id, flags)
642 quadruple is returned. If the user is not authorized but does
643 not have the required privilege (see $flagsrequired below), it
644 displays an error page and exits. Otherwise, it displays the
645 login page and exits.
647 Note that C<&checkauth> will return if and only if the user
648 is authorized, so it should be called early on, before any
649 unfinished operations (e.g., if you've opened a file, then
650 C<&checkauth> won't close it for you).
652 C<$query> is the CGI object for the script calling C<&checkauth>.
654 The C<$noauth> argument is optional. If it is set, then no
655 authorization is required for the script.
657 C<&checkauth> fetches user and session information from C<$query> and
658 ensures that the user is authorized to run scripts that require
661 The C<$flagsrequired> argument specifies the required privileges
662 the user must have if the username and password are correct.
663 It should be specified as a reference-to-hash; keys in the hash
664 should be the "flags" for the user, as specified in the Members
665 intranet module. Any key specified must correspond to a "flag"
666 in the userflags table. E.g., { circulate => 1 } would specify
667 that the user must have the "circulate" privilege in order to
668 proceed. To make sure that access control is correct, the
669 C<$flagsrequired> parameter must be specified correctly.
671 Koha also has a concept of sub-permissions, also known as
672 granular permissions. This makes the value of each key
673 in the C<flagsrequired> hash take on an additional
678 The user must have access to all subfunctions of the module
679 specified by the hash key.
683 The user must have access to at least one subfunction of the module
684 specified by the hash key.
686 specific permission, e.g., 'export_catalog'
688 The user must have access to the specific subfunction list, which
689 must correspond to a row in the permissions table.
691 The C<$type> argument specifies whether the template should be
692 retrieved from the opac or intranet directory tree. "opac" is
693 assumed if it is not specified; however, if C<$type> is specified,
694 "intranet" is assumed if it is not "opac".
696 If C<$query> does not have a valid session ID associated with it
697 (i.e., the user has not logged in) or if the session has expired,
698 C<&checkauth> presents the user with a login page (from the point of
699 view of the original script, C<&checkauth> does not return). Once the
700 user has authenticated, C<&checkauth> restarts the original script
701 (this time, C<&checkauth> returns).
703 The login page is provided using a HTML::Template, which is set in the
704 systempreferences table or at the top of this file. The variable C<$type>
705 selects which template to use, either the opac or the intranet
706 authentification template.
708 C<&checkauth> returns a user ID, a cookie, and a session ID. The
709 cookie should be sent back to the browser; it verifies that the user
719 # If version syspref is unavailable, it means Koha is being installed,
720 # and so we must redirect to OPAC maintenance page or to the WebInstaller
721 # also, if OpacMaintenance is ON, OPAC should redirect to maintenance
722 if ( C4::Context->preference('OpacMaintenance') && $type eq 'opac' ) {
723 warn "OPAC Install required, redirecting to maintenance";
724 print $query->redirect("/cgi-bin/koha/maintenance.pl");
727 unless ( $version = C4::Context->preference('Version') ) { # assignment, not comparison
728 if ( $type ne 'opac' ) {
729 warn "Install required, redirecting to Installer";
730 print $query->redirect("/cgi-bin/koha/installer/install.pl");
732 warn "OPAC Install required, redirecting to maintenance";
733 print $query->redirect("/cgi-bin/koha/maintenance.pl");
738 # check that database and koha version are the same
739 # there is no DB version, it's a fresh install,
740 # go to web installer
741 # there is a DB version, compare it to the code version
742 my $kohaversion = Koha::version();
744 # remove the 3 last . to have a Perl number
745 $kohaversion =~ s/(.*\..*)\.(.*)\.(.*)/$1$2$3/;
746 Koha::Logger->get->debug("kohaversion : $kohaversion");
747 if ( $version < $kohaversion ) {
748 my $warning = "Database update needed, redirecting to %s. Database is $version and Koha is $kohaversion";
749 if ( $type ne 'opac' ) {
750 warn sprintf( $warning, 'Installer' );
751 print $query->redirect("/cgi-bin/koha/installer/install.pl?step=1&op=updatestructure");
753 warn sprintf( "OPAC: " . $warning, 'maintenance' );
754 print $query->redirect("/cgi-bin/koha/maintenance.pl");
760 sub _timeout_syspref {
761 my $default_timeout = 600;
762 my $timeout = C4::Context->preference('timeout') || $default_timeout;
764 # value in days, convert in seconds
765 if ( $timeout =~ /^(\d+)[dD]$/ ) {
766 $timeout = $1 * 86400;
768 # value in hours, convert in seconds
769 elsif ( $timeout =~ /^(\d+)[hH]$/ ) {
770 $timeout = $1 * 3600;
772 elsif ( $timeout !~ m/^\d+$/ ) {
773 warn "The value of the system preference 'timeout' is not correct, defaulting to $default_timeout";
774 $timeout = $default_timeout;
783 # Get shibboleth login attribute
784 my $shib = C4::Context->config('useshibboleth') && shib_ok();
785 my $shib_login = $shib ? get_login_shib() : undef;
787 # $authnotrequired will be set for scripts which will run without authentication
788 my $authnotrequired = shift;
789 my $flagsrequired = shift;
791 my $emailaddress = shift;
792 my $template_name = shift;
793 $type = 'opac' unless $type;
795 if ( $type eq 'opac' && !C4::Context->preference("OpacPublic") ) {
796 my @allowed_scripts_for_private_opac = qw(
798 opac-registration-email-sent.tt
799 opac-registration-confirmation.tt
800 opac-memberentry-update-submitted.tt
801 opac-password-recovery.tt
802 opac-reset-password.tt
804 $authnotrequired = 0 unless grep { $_ eq $template_name }
805 @allowed_scripts_for_private_opac;
808 my $timeout = _timeout_syspref();
810 my $cookie_mgr = Koha::CookieManager->new;
812 _version_check( $type, $query );
816 my $auth_state = 'failed';
818 my ( $userid, $cookie, $sessionID, $flags );
820 my $logout = $query->param('logout.x');
822 my $anon_search_history;
824 # This parameter is the name of the CAS server we want to authenticate against,
825 # when using authentication against multiple CAS servers, as configured in Auth_cas_servers.yaml
826 my $casparam = $query->param('cas');
827 my $q_userid = $query->param('userid') // '';
830 my $invalid_otp_token;
832 ( $type ne "opac" # Only available for the staff interface
833 && C4::Context->preference('TwoFactorAuthentication') ne "disabled" ) # If "enabled" or "enforced"
836 # Basic authentication is incompatible with the use of Shibboleth,
837 # as Shibboleth may return REMOTE_USER as a Shibboleth attribute,
838 # and it may not be the attribute we want to use to match the koha login.
840 # Also, do not consider an empty REMOTE_USER.
842 # Finally, after those tests, we can assume (although if it would be better with
843 # a syspref) that if we get a REMOTE_USER, that's from basic authentication,
844 # and we can affect it to $userid.
845 if ( !$shib and defined( $ENV{'REMOTE_USER'} ) and $ENV{'REMOTE_USER'} ne '' and $userid = $ENV{'REMOTE_USER'} ) {
847 # Using Basic Authentication, no cookies required
848 $cookie = $cookie_mgr->replace_in_list( $cookie, $query->cookie(
849 -name => 'CGISESSID',
852 -secure => ( C4::Context->https_enabled() ? 1 : 0 ),
857 elsif ( $emailaddress) {
858 # the Google OpenID Connect passes an email address
860 elsif ( $sessionID = $query->cookie("CGISESSID") ) { # assignment, not comparison
861 my ( $return, $more_info );
862 # NOTE: $flags in the following call is still undefined !
863 ( $return, $session, $more_info ) = check_cookie_auth( $sessionID, $flags,
864 { remote_addr => $ENV{REMOTE_ADDR}, skip_version_check => 1 }
867 if ( $return eq 'ok' || $return eq 'additional-auth-needed' ) {
868 $userid = $session->param('id');
872 $return eq 'ok' ? 'completed'
873 : $return eq 'additional-auth-needed' ? 'additional-auth-needed'
876 # We are at the second screen if the waiting-for-2FA is set in session
877 # and otp_token param has been passed
879 && $auth_state eq 'additional-auth-needed'
880 && ( my $otp_token = $query->param('otp_token') ) )
882 my $patron = Koha::Patrons->find( { userid => $userid } );
883 my $auth = Koha::Auth::TwoFactorAuth->new( { patron => $patron } );
884 my $verified = $auth->verify($otp_token);
887 # The token is correct, the user is fully logged in!
888 $auth_state = 'completed';
889 $session->param( 'waiting-for-2FA', 0 );
890 $session->param( 'waiting-for-2FA-setup', 0 );
892 # This is an ugly trick to pass the test
893 # $query->param('koha_login_context') && ( $q_userid ne $userid )
898 $invalid_otp_token = 1;
902 if ( $auth_state eq 'completed' ) {
903 Koha::Logger->get->debug(sprintf "AUTH_SESSION: (%s)\t%s %s - %s", map { $session->param($_) || q{} } qw(cardnumber firstname surname branch));
905 if ( ( $query->param('koha_login_context') && ( $q_userid ne $userid ) )
906 || ( $cas && $query->param('ticket') && !C4::Context->userenv->{'id'} )
907 || ( $shib && $shib_login && !$logout && !C4::Context->userenv->{'id'} )
910 #if a user enters an id ne to the id in the current session, we need to log them in...
911 #first we need to clear the anonymous session...
912 $anon_search_history = $session->param('search_history');
915 $cookie = $cookie_mgr->clear_unless( $query->cookie, @$cookie );
916 C4::Context::_unset_userenv($sessionID);
918 undef $userid; # IMPORTANT: this assures us a new session in code below
919 $auth_state = 'failed';
922 $cookie = $cookie_mgr->replace_in_list( $cookie, $query->cookie(
923 -name => 'CGISESSID',
924 -value => $session->id,
926 -secure => ( C4::Context->https_enabled() ? 1 : 0 ),
930 $flags = haspermission( $userid, $flagsrequired );
932 $auth_state = 'failed';
933 $info{'nopermission'} = 1;
936 } elsif ( !$logout ) {
937 if ( $return eq 'expired' ) {
938 $info{timed_out} = 1;
939 } elsif ( $return eq 'restricted' ) {
940 $info{oldip} = $more_info->{old_ip};
941 $info{newip} = $more_info->{new_ip};
942 $info{different_ip} = 1;
943 } elsif ( $return eq 'password_expired' ) {
944 $info{password_has_expired} = 1;
949 if ( $auth_state eq 'failed' || $logout ) {
956 # voluntary logout the user
957 # check wether the user was using their shibboleth session or a local one
958 my $shibSuccess = C4::Context->userenv ? C4::Context->userenv->{'shibboleth'} : undef;
963 C4::Context::_unset_userenv($sessionID);
964 $cookie = $cookie_mgr->clear_unless( $query->cookie, @$cookie );
966 if ($cas and $caslogout) {
967 logout_cas($query, $type);
970 # If we are in a shibboleth session (shibboleth is enabled, a shibboleth match attribute is set and matches koha matchpoint)
971 if ( $shib and $shib_login and $shibSuccess) {
976 $auth_state = 'logout';
980 #we initiate a session prior to checking for a username to allow for anonymous sessions...
981 if( !$session or !$sessionID ) { # if we cleared sessionID, we need a new session
982 $session = get_session() or die "Auth ERROR: Cannot get_session()";
985 # Save anonymous search history in new session so it can be retrieved
986 # by get_template_and_user to store it in user's search history after
987 # a successful login.
988 if ($anon_search_history) {
989 $session->param( 'search_history', $anon_search_history );
992 $sessionID = $session->id;
993 C4::Context->_new_userenv($sessionID);
994 $cookie = $cookie_mgr->replace_in_list( $cookie, $query->cookie(
995 -name => 'CGISESSID',
996 -value => $sessionID,
998 -secure => ( C4::Context->https_enabled() ? 1 : 0 ),
1001 my $pki_field = C4::Context->preference('AllowPKIAuth');
1002 if ( !defined($pki_field) ) {
1003 print STDERR "ERROR: Missing system preference AllowPKIAuth.\n";
1004 $pki_field = 'None';
1006 if ( ( $cas && $query->param('ticket') )
1008 || ( $shib && $shib_login )
1009 || $pki_field ne 'None'
1012 my $password = $query->param('password');
1013 my $shibSuccess = 0;
1014 my ( $return, $cardnumber );
1016 # If shib is enabled and we have a shib login, does the login match a valid koha user
1017 if ( $shib && $shib_login ) {
1020 # Do not pass password here, else shib will not be checked in checkpw.
1021 ( $return, $cardnumber, $retuserid ) = checkpw( $q_userid, undef, $query );
1022 $userid = $retuserid;
1023 $shibSuccess = $return;
1024 $info{'invalidShibLogin'} = 1 unless ($return);
1027 # If shib login and match were successful, skip further login methods
1028 unless ($shibSuccess) {
1029 if ( $cas && $query->param('ticket') ) {
1031 ( $return, $cardnumber, $retuserid, $cas_ticket ) =
1032 checkpw( $userid, $password, $query, $type );
1033 $userid = $retuserid;
1034 $info{'invalidCasLogin'} = 1 unless ($return);
1037 elsif ( $emailaddress ) {
1038 my $value = $emailaddress;
1040 # If we're looking up the email, there's a chance that the person
1041 # doesn't have a userid. So if there is none, we pass along the
1042 # borrower number, and the bits of code that need to know the user
1043 # ID will have to be smart enough to handle that.
1044 my $patrons = Koha::Patrons->search({ email => $value });
1045 if ($patrons->count) {
1047 # First the userid, then the borrowernum
1048 my $patron = $patrons->next;
1049 $value = $patron->userid || $patron->borrowernumber;
1053 $return = $value ? 1 : 0;
1058 ( $pki_field eq 'Common Name' && $ENV{'SSL_CLIENT_S_DN_CN'} )
1059 || ( $pki_field eq 'emailAddress'
1060 && $ENV{'SSL_CLIENT_S_DN_Email'} )
1064 if ( $pki_field eq 'Common Name' ) {
1065 $value = $ENV{'SSL_CLIENT_S_DN_CN'};
1067 elsif ( $pki_field eq 'emailAddress' ) {
1068 $value = $ENV{'SSL_CLIENT_S_DN_Email'};
1070 # If we're looking up the email, there's a chance that the person
1071 # doesn't have a userid. So if there is none, we pass along the
1072 # borrower number, and the bits of code that need to know the user
1073 # ID will have to be smart enough to handle that.
1074 my $patrons = Koha::Patrons->search({ email => $value });
1075 if ($patrons->count) {
1077 # First the userid, then the borrowernum
1078 my $patron = $patrons->next;
1079 $value = $patron->userid || $patron->borrowernumber;
1085 $return = $value ? 1 : 0;
1091 my $request_method = $query->request_method // q{};
1094 $request_method eq 'POST'
1095 || ( C4::Context->preference('AutoSelfCheckID')
1096 && $q_userid eq C4::Context->preference('AutoSelfCheckID') )
1100 ( $return, $cardnumber, $retuserid, $cas_ticket ) =
1101 checkpw( $q_userid, $password, $query, $type );
1102 $userid = $retuserid if ($retuserid);
1103 $info{'invalid_username_or_password'} = 1 unless ($return);
1108 # If shib configured and shibOnly enabled, we should ignore anything other than a shibboleth type login.
1115 && C4::Context->preference('OPACShibOnly')
1117 || ( ( $type ne 'opac' )
1118 && C4::Context->preference('staffShibOnly') )
1125 # $return: 1 = valid user
1126 if( $return && $return > 0 ) {
1128 if ( $flags = haspermission( $userid, $flagsrequired ) ) {
1129 $auth_state = "logged_in";
1132 $auth_state = 'failed';
1133 # FIXME We could add $return = 0; or even delete the session?
1134 # Currently return == 1 and we will fill session info later on,
1135 # although we do present an authorization failure. (Yes, the
1136 # authentication was actually correct.)
1137 $info{'nopermission'} = 1;
1138 C4::Context::_unset_userenv($sessionID);
1140 my ( $borrowernumber, $firstname, $surname, $userflags,
1141 $branchcode, $branchname, $emailaddress, $desk_id,
1142 $desk_name, $register_id, $register_name );
1144 if ( $return == 1 ) {
1146 SELECT borrowernumber, firstname, surname, flags, borrowers.branchcode,
1147 branches.branchname as branchname, email
1149 LEFT JOIN branches on borrowers.branchcode=branches.branchcode
1151 my $dbh = C4::Context->dbh;
1152 my $sth = $dbh->prepare("$select where userid=?");
1153 $sth->execute($userid);
1154 unless ( $sth->rows ) {
1155 $sth = $dbh->prepare("$select where cardnumber=?");
1156 $sth->execute($cardnumber);
1158 unless ( $sth->rows ) {
1159 $sth->execute($userid);
1163 ( $borrowernumber, $firstname, $surname, $userflags,
1164 $branchcode, $branchname, $emailaddress ) = $sth->fetchrow;
1167 # launch a sequence to check if we have a ip for the branch, i
1168 # if we have one we replace the branchcode of the userenv by the branch bound in the ip.
1170 my $ip = $ENV{'REMOTE_ADDR'};
1172 # if they specify at login, use that
1173 my $patron = Koha::Patrons->find({userid => $userid});
1174 if ( $query->param('branch') && ( haspermission($userid, { 'loggedinlibrary'=> 1 }) || $patron->is_superlibrarian ) ) {
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 opacbookbag => "" . C4::Context->preference("opacbookbag"),
1376 OpacCloud => C4::Context->preference("OpacCloud"),
1377 OpacTopissue => C4::Context->preference("OpacTopissue"),
1378 OpacAuthorities => C4::Context->preference("OpacAuthorities"),
1379 OpacBrowser => C4::Context->preference("OpacBrowser"),
1380 TagsEnabled => C4::Context->preference("TagsEnabled"),
1381 OPACUserJS => C4::Context->preference("OPACUserJS"),
1382 OPACUserCSS => C4::Context->preference("OPACUserCSS"),
1383 intranetcolorstylesheet => C4::Context->preference("intranetcolorstylesheet"),
1384 intranetstylesheet => C4::Context->preference("intranetstylesheet"),
1385 IntranetNav => C4::Context->preference("IntranetNav"),
1386 IntranetFavicon => C4::Context->preference("IntranetFavicon"),
1387 IntranetUserCSS => C4::Context->preference("IntranetUserCSS"),
1388 IntranetUserJS => C4::Context->preference("IntranetUserJS"),
1389 IndependentBranches => C4::Context->preference("IndependentBranches"),
1390 AutoLocation => C4::Context->preference("AutoLocation"),
1391 wrongip => $info{'wrongip'},
1392 PatronSelfRegistration => C4::Context->preference("PatronSelfRegistration"),
1393 PatronSelfRegistrationDefaultCategory => C4::Context->preference("PatronSelfRegistrationDefaultCategory"),
1394 opac_css_override => $ENV{'OPAC_CSS_OVERRIDE'},
1395 too_many_login_attempts => ( $patron and $patron->account_locked ),
1396 password_has_expired => ( $patron and $patron->password_expired ),
1397 auth_error => $auth_error,
1400 $template->param( SCO_login => 1 ) if ( $query->param('sco_user_login') );
1401 $template->param( SCI_login => 1 ) if ( $query->param('sci_user_login') );
1402 $template->param( OpacPublic => C4::Context->preference("OpacPublic") );
1403 $template->param( loginprompt => 1 ) unless $info{'nopermission'};
1404 if ( $auth_state eq 'additional-auth-needed' ) {
1405 my $patron = Koha::Patrons->find( { userid => $userid } );
1408 invalid_otp_token => $invalid_otp_token,
1409 notice_email_address => $patron->notice_email_address, # We could also pass logged_in_user if necessary
1413 if ( $auth_state eq 'setup-additional-auth-needed' ) {
1419 if ( $type eq 'opac' ) {
1420 require Koha::Virtualshelves;
1421 my $some_public_shelves = Koha::Virtualshelves->get_some_shelves(
1427 some_public_shelves => $some_public_shelves,
1433 # Is authentication against multiple CAS servers enabled?
1434 require C4::Auth_with_cas;
1435 if ( multipleAuth() && !$casparam ) {
1436 my $casservers = getMultipleAuth();
1438 foreach my $key ( keys %$casservers ) {
1439 push @tmplservers, { name => $key, value => login_cas_url( $query, $key, $type ) . "?cas=$key" };
1442 casServersLoop => \@tmplservers
1446 casServerUrl => login_cas_url($query, undef, $type),
1451 invalidCasLogin => $info{'invalidCasLogin'}
1456 #If shibOnly is enabled just go ahead and redirect directly
1457 if ( (($type eq 'opac') && C4::Context->preference('OPACShibOnly')) || (($type ne 'opac') && C4::Context->preference('staffShibOnly')) ) {
1458 my $redirect_url = login_shib_url( $query );
1459 print $query->redirect( -uri => "$redirect_url", -status => 303 );
1464 shibbolethAuthentication => $shib,
1465 shibbolethLoginUrl => login_shib_url($query),
1469 if (C4::Context->preference('GoogleOpenIDConnect')) {
1470 if ($query->param("OpenIDConnectFailed")) {
1471 my $reason = $query->param('OpenIDConnectFailed');
1472 $template->param(invalidGoogleOpenIDConnectLogin => $reason);
1477 LibraryName => C4::Context->preference("LibraryName"),
1479 $template->param(%info);
1481 # $cookie = $query->cookie(CGISESSID => $session->id
1483 print $query->header(
1484 { type => 'text/html',
1487 'X-Frame-Options' => 'SAMEORIGIN',
1495 =head2 check_api_auth
1497 ($status, $cookie, $sessionId) = check_api_auth($query, $userflags);
1499 Given a CGI query containing the parameters 'userid' and 'password' and/or a session
1500 cookie, determine if the user has the privileges specified by C<$userflags>.
1502 C<check_api_auth> is is meant for authenticating users of web services, and
1503 consequently will always return and will not attempt to redirect the user
1506 If a valid session cookie is already present, check_api_auth will return a status
1507 of "ok", the cookie, and the Koha session ID.
1509 If no session cookie is present, check_api_auth will check the 'userid' and 'password
1510 parameters and create a session cookie and Koha session if the supplied credentials
1513 Possible return values in C<$status> are:
1517 =item "ok" -- user authenticated; C<$cookie> and C<$sessionid> have valid values.
1519 =item "failed" -- credentials are not correct; C<$cookie> and C<$sessionid> are undef
1521 =item "maintenance" -- DB is in maintenance mode; no login possible at the moment
1523 =item "expired -- session cookie has expired; API user should resubmit userid and password
1525 =item "restricted" -- The IP has changed (if SessionRestrictionByIP)
1527 =item "additional-auth-needed -- User is in an authentication process that is not finished
1533 sub check_api_auth {
1536 my $flagsrequired = shift;
1537 my $timeout = _timeout_syspref();
1539 unless ( C4::Context->preference('Version') ) {
1541 # database has not been installed yet
1542 return ( "maintenance", undef, undef );
1544 my $kohaversion = Koha::version();
1545 $kohaversion =~ s/(.*\..*)\.(.*)\.(.*)/$1$2$3/;
1546 if ( C4::Context->preference('Version') < $kohaversion ) {
1548 # database in need of version update; assume that
1549 # no API should be called while databsae is in
1551 return ( "maintenance", undef, undef );
1554 my ( $sessionID, $session );
1555 unless ( $query->param('userid') ) {
1556 $sessionID = $query->cookie("CGISESSID");
1558 if ( $sessionID && not( $cas && $query->param('PT') ) ) {
1561 ( $return, $session, undef ) = check_cookie_auth(
1562 $sessionID, $flagsrequired, { remote_addr => $ENV{REMOTE_ADDR} } );
1564 return ( $return, undef, undef ) # Cookie auth failed
1567 my $cookie = $query->cookie(
1568 -name => 'CGISESSID',
1569 -value => $session->id,
1571 -secure => ( C4::Context->https_enabled() ? 1 : 0 ),
1574 return ( $return, $cookie, $session ); # return == 'ok' here
1579 my $userid = $query->param('userid');
1580 my $password = $query->param('password');
1581 my ( $return, $cardnumber, $cas_ticket );
1584 if ( $cas && $query->param('PT') ) {
1587 # In case of a CAS authentication, we use the ticket instead of the password
1588 my $PT = $query->param('PT');
1589 ( $return, $cardnumber, $userid, $cas_ticket ) = check_api_auth_cas( $PT, $query ); # EXTERNAL AUTH
1592 # User / password auth
1593 unless ( $userid and $password ) {
1595 # caller did something wrong, fail the authenticateion
1596 return ( "failed", undef, undef );
1599 ( $return, $cardnumber, $newuserid, $cas_ticket ) = checkpw( $userid, $password, $query );
1602 if ( $return and haspermission( $userid, $flagsrequired ) ) {
1603 my $session = get_session("");
1604 return ( "failed", undef, undef ) unless $session;
1606 my $sessionID = $session->id;
1607 C4::Context->_new_userenv($sessionID);
1608 my $cookie = $query->cookie(
1609 -name => 'CGISESSID',
1610 -value => $sessionID,
1612 -secure => ( C4::Context->https_enabled() ? 1 : 0 ),
1615 if ( $return == 1 ) {
1617 $borrowernumber, $firstname, $surname,
1618 $userflags, $branchcode, $branchname,
1621 my $dbh = C4::Context->dbh;
1624 "select borrowernumber, firstname, surname, flags, borrowers.branchcode, branches.branchname as branchname, email from borrowers left join branches on borrowers.branchcode=branches.branchcode where userid=?"
1626 $sth->execute($userid);
1628 $borrowernumber, $firstname, $surname,
1629 $userflags, $branchcode, $branchname,
1631 ) = $sth->fetchrow if ( $sth->rows );
1633 unless ( $sth->rows ) {
1634 my $sth = $dbh->prepare(
1635 "select borrowernumber, firstname, surname, flags, borrowers.branchcode, branches.branchname as branchname, email from borrowers left join branches on borrowers.branchcode=branches.branchcode where cardnumber=?"
1637 $sth->execute($cardnumber);
1639 $borrowernumber, $firstname, $surname,
1640 $userflags, $branchcode, $branchname,
1642 ) = $sth->fetchrow if ( $sth->rows );
1644 unless ( $sth->rows ) {
1645 $sth->execute($userid);
1647 $borrowernumber, $firstname, $surname, $userflags,
1648 $branchcode, $branchname, $emailaddress
1649 ) = $sth->fetchrow if ( $sth->rows );
1653 my $ip = $ENV{'REMOTE_ADDR'};
1655 # if they specify at login, use that
1656 if ( $query->param('branch') ) {
1657 $branchcode = $query->param('branch');
1658 my $library = Koha::Libraries->find($branchcode);
1659 $branchname = $library? $library->branchname: '';
1661 my $branches = { map { $_->branchcode => $_->unblessed } Koha::Libraries->search->as_list };
1662 foreach my $br ( keys %$branches ) {
1664 # now we work with the treatment of ip
1665 my $domain = $branches->{$br}->{'branchip'};
1666 if ( $domain && $ip =~ /^$domain/ ) {
1667 $branchcode = $branches->{$br}->{'branchcode'};
1669 # new op dev : add the branchname to the cookie
1670 $branchname = $branches->{$br}->{'branchname'};
1673 $session->param( 'number', $borrowernumber );
1674 $session->param( 'id', $userid );
1675 $session->param( 'cardnumber', $cardnumber );
1676 $session->param( 'firstname', $firstname );
1677 $session->param( 'surname', $surname );
1678 $session->param( 'branch', $branchcode );
1679 $session->param( 'branchname', $branchname );
1680 $session->param( 'flags', $userflags );
1681 $session->param( 'emailaddress', $emailaddress );
1682 $session->param( 'ip', $session->remote_addr() );
1683 $session->param( 'lasttime', time() );
1684 $session->param( 'interface', 'api' );
1686 $session->param( 'cas_ticket', $cas_ticket);
1687 C4::Context->set_userenv(
1688 $session->param('number'), $session->param('id'),
1689 $session->param('cardnumber'), $session->param('firstname'),
1690 $session->param('surname'), $session->param('branch'),
1691 $session->param('branchname'), $session->param('flags'),
1692 $session->param('emailaddress'), $session->param('shibboleth'),
1693 $session->param('desk_id'), $session->param('desk_name'),
1694 $session->param('register_id'), $session->param('register_name')
1696 return ( "ok", $cookie, $sessionID );
1698 return ( "failed", undef, undef );
1703 =head2 check_cookie_auth
1705 ($status, $sessionId) = check_cookie_auth($cookie, $userflags);
1707 Given a CGISESSID cookie set during a previous login to Koha, determine
1708 if the user has the privileges specified by C<$userflags>. C<$userflags>
1709 is passed unaltered into C<haspermission> and as such accepts all options
1710 avaiable to that routine with the one caveat that C<check_api_auth> will
1711 also allow 'undef' to be passed and in such a case the permissions check
1712 will be skipped altogether.
1714 C<check_cookie_auth> is meant for authenticating special services
1715 such as tools/upload-file.pl that are invoked by other pages that
1716 have been authenticated in the usual way.
1718 Possible return values in C<$status> are:
1722 =item "ok" -- user authenticated; C<$sessionID> have valid values.
1724 =item "anon" -- user not authenticated but valid for anonymous session.
1726 =item "failed" -- credentials are not correct; C<$sessionid> are undef
1728 =item "maintenance" -- DB is in maintenance mode; no login possible at the moment
1730 =item "expired -- session cookie has expired; API user should resubmit userid and password
1732 =item "restricted" -- The IP has changed (if SessionRestrictionByIP)
1738 sub check_cookie_auth {
1739 my $sessionID = shift;
1740 my $flagsrequired = shift;
1743 my $remote_addr = $params->{remote_addr} || $ENV{REMOTE_ADDR};
1745 my $skip_version_check = $params->{skip_version_check}; # Only for checkauth
1747 unless ( $skip_version_check ) {
1748 unless ( C4::Context->preference('Version') ) {
1750 # database has not been installed yet
1751 return ( "maintenance", undef );
1753 my $kohaversion = Koha::version();
1754 $kohaversion =~ s/(.*\..*)\.(.*)\.(.*)/$1$2$3/;
1755 if ( C4::Context->preference('Version') < $kohaversion ) {
1757 # database in need of version update; assume that
1758 # no API should be called while databsae is in
1760 return ( "maintenance", undef );
1764 # see if we have a valid session cookie already
1765 # however, if a userid parameter is present (i.e., from
1766 # a form submission, assume that any current cookie
1768 unless ( $sessionID ) {
1769 return ( "failed", undef );
1771 C4::Context::_unset_userenv($sessionID); # remove old userenv first
1772 my $session = get_session($sessionID);
1774 my $userid = $session->param('id');
1775 my $ip = $session->param('ip');
1776 my $lasttime = $session->param('lasttime');
1777 my $timeout = _timeout_syspref();
1779 if ( !$lasttime || ( $lasttime < time() - $timeout ) ) {
1783 return ("expired", undef);
1785 } elsif ( C4::Context->preference('SessionRestrictionByIP') && $ip ne $remote_addr ) {
1786 # IP address changed
1789 return ( "restricted", undef, { old_ip => $ip, new_ip => $remote_addr});
1791 } elsif ( $userid ) {
1792 $session->param( 'lasttime', time() );
1793 my $patron = Koha::Patrons->find({ userid => $userid });
1795 # If the user modify their own userid
1796 # Better than 500 but we could do better
1797 unless ( $patron ) {
1800 return ("expired", undef);
1803 $patron = Koha::Patrons->find({ cardnumber => $userid })
1805 return ("password_expired", undef ) if $patron->password_expired;
1806 my $flags = defined($flagsrequired) ? haspermission( $userid, $flagsrequired ) : 1;
1808 C4::Context->_new_userenv($sessionID);
1809 if ( !C4::Context->interface ) {
1810 # No need to override the interface, most often set by get_template_and_user
1811 C4::Context->interface( $session->param('interface') );
1813 C4::Context->set_userenv(
1814 $session->param('number'), $session->param('id') // '',
1815 $session->param('cardnumber'), $session->param('firstname'),
1816 $session->param('surname'), $session->param('branch'),
1817 $session->param('branchname'), $session->param('flags'),
1818 $session->param('emailaddress'), $session->param('shibboleth'),
1819 $session->param('desk_id'), $session->param('desk_name'),
1820 $session->param('register_id'), $session->param('register_name')
1822 if ( C4::Context->preference('TwoFactorAuthentication') ne 'disabled' ) {
1823 return ( "additional-auth-needed", $session )
1824 if $session->param('waiting-for-2FA');
1826 return ( "setup-additional-auth-needed", $session )
1827 if $session->param('waiting-for-2FA-setup');
1830 return ( "ok", $session );
1834 return ( "failed", undef );
1838 C4::Context->_new_userenv($sessionID);
1839 C4::Context->interface($session->param('interface'));
1840 C4::Context->set_userenv( undef, q{} );
1841 return ( "anon", $session );
1844 return ( "expired", undef );
1851 my $session = get_session($sessionID);
1853 Given a session ID, retrieve the CGI::Session object used to store
1854 the session's state. The session object can be used to store
1855 data that needs to be accessed by different scripts during a
1858 If the C<$sessionID> parameter is an empty string, a new session
1863 sub _get_session_params {
1864 my $storage_method = C4::Context->preference('SessionStorage');
1865 if ( $storage_method eq 'mysql' ) {
1866 my $dbh = C4::Context->dbh;
1867 return { dsn => "serializer:yamlxs;driver:MySQL;id:md5", dsn_args => { Handle => $dbh } };
1869 elsif ( $storage_method eq 'Pg' ) {
1870 my $dbh = C4::Context->dbh;
1871 return { dsn => "serializer:yamlxs;driver:PostgreSQL;id:md5", dsn_args => { Handle => $dbh } };
1873 elsif ( $storage_method eq 'memcached' && Koha::Caches->get_instance->memcached_cache ) {
1874 my $memcached = Koha::Caches->get_instance()->memcached_cache;
1875 return { dsn => "serializer:yamlxs;driver:memcached;id:md5", dsn_args => { Memcached => $memcached } };
1878 # catch all defaults to tmp should work on all systems
1879 my $dir = C4::Context::temporary_directory;
1880 my $instance = C4::Context->config( 'database' ); #actually for packages not exactly the instance name, but generally safer to leave it as it is
1881 return { dsn => "serializer:yamlxs;driver:File;id:md5", dsn_args => { Directory => "$dir/cgisess_$instance" } };
1886 my $sessionID = shift;
1887 my $params = _get_session_params();
1889 if( $sessionID ) { # find existing
1890 CGI::Session::ErrorHandler->set_error( q{} ); # clear error, cpan issue #111463
1891 $session = CGI::Session->load( $params->{dsn}, $sessionID, $params->{dsn_args} );
1893 $session = CGI::Session->new( $params->{dsn}, $sessionID, $params->{dsn_args} );
1894 # no need to flush here
1899 =head2 create_basic_session
1901 my $session = create_basic_session({ patron => $patron, interface => $interface });
1903 Creates a session and adds all basic parameters for a session to work
1907 sub create_basic_session {
1909 my $patron = $params->{patron};
1910 my $interface = $params->{interface};
1912 $interface = 'intranet' if $interface eq 'staff';
1914 my $session = get_session("");
1916 $session->param( 'number', $patron->borrowernumber );
1917 $session->param( 'id', $patron->userid );
1918 $session->param( 'cardnumber', $patron->cardnumber );
1919 $session->param( 'firstname', $patron->firstname );
1920 $session->param( 'surname', $patron->surname );
1921 $session->param( 'branch', $patron->branchcode );
1922 $session->param( 'branchname', $patron->library->branchname );
1923 $session->param( 'flags', $patron->flags );
1924 $session->param( 'emailaddress', $patron->email );
1925 $session->param( 'ip', $session->remote_addr() );
1926 $session->param( 'lasttime', time() );
1927 $session->param( 'interface', $interface);
1933 # FIXME no_set_userenv may be replaced with force_branchcode_for_userenv
1934 # (or something similar)
1935 # Currently it's only passed from C4::SIP::ILS::Patron::check_password, but
1936 # not having a userenv defined could cause a crash.
1938 my ( $userid, $password, $query, $type, $no_set_userenv ) = @_;
1939 $type = 'opac' unless $type;
1941 # Get shibboleth login attribute
1942 my $shib = C4::Context->config('useshibboleth') && shib_ok();
1943 my $shib_login = $shib ? get_login_shib() : undef;
1947 if ( defined $userid ){
1948 $patron = Koha::Patrons->find({ userid => $userid });
1949 $patron = Koha::Patrons->find({ cardnumber => $userid }) unless $patron;
1951 my $check_internal_as_fallback = 0;
1953 # Note: checkpw_* routines returns:
1956 # -1 if user bind failed (LDAP only)
1958 if ( $patron and ( $patron->account_locked ) ) {
1959 # Nothing to check, account is locked
1960 } elsif ($ldap && defined($password)) {
1961 my ( $retval, $retcard, $retuserid ) = checkpw_ldap(@_); # EXTERNAL AUTH
1962 if ( $retval == 1 ) {
1963 @return = ( $retval, $retcard, $retuserid );
1966 $check_internal_as_fallback = 1 if $retval == 0;
1968 } elsif ( $cas && $query && $query->param('ticket') ) {
1970 # In case of a CAS authentication, we use the ticket instead of the password
1971 my $ticket = $query->param('ticket');
1972 $query->delete('ticket'); # remove ticket to come back to original URL
1973 my ( $retval, $retcard, $retuserid, $cas_ticket ) = checkpw_cas( $ticket, $query, $type ); # EXTERNAL AUTH
1975 @return = ( $retval, $retcard, $retuserid, $cas_ticket );
1979 $passwd_ok = $retval;
1982 # If we are in a shibboleth session (shibboleth is enabled, and a shibboleth match attribute is present)
1983 # Check for password to asertain whether we want to be testing against shibboleth or another method this
1985 elsif ( $shib && $shib_login && !$password ) {
1987 # In case of a Shibboleth authentication, we expect a shibboleth user attribute
1988 # (defined under shibboleth mapping in koha-conf.xml) to contain the login of the
1989 # shibboleth-authenticated user
1991 # Then, we check if it matches a valid koha user
1993 my ( $retval, $retcard, $retuserid ) = C4::Auth_with_shibboleth::checkpw_shib($shib_login); # EXTERNAL AUTH
1995 @return = ( $retval, $retcard, $retuserid );
1997 $passwd_ok = $retval;
2000 $check_internal_as_fallback = 1;
2004 if ( $check_internal_as_fallback ) {
2005 @return = checkpw_internal( $userid, $password, $no_set_userenv);
2006 $passwd_ok = 1 if $return[0] > 0; # 1 or 2
2011 $patron->update({ login_attempts => 0 });
2012 if( $patron->password_expired ){
2015 } elsif( !$patron->account_locked ) {
2016 $patron->update({ login_attempts => $patron->login_attempts + 1 });
2020 # Optionally log success or failure
2021 if( $patron && $passwd_ok && C4::Context->preference('AuthSuccessLog') ) {
2022 logaction( 'AUTH', 'SUCCESS', $patron->id, "Valid password for $userid", $type );
2023 } elsif( !$passwd_ok && C4::Context->preference('AuthFailureLog') ) {
2024 logaction( 'AUTH', 'FAILURE', $patron ? $patron->id : 0, "Wrong password for $userid", $type );
2030 sub checkpw_internal {
2031 my ( $userid, $password, $no_set_userenv ) = @_;
2033 $password = Encode::encode( 'UTF-8', $password )
2034 if Encode::is_utf8($password);
2036 my $dbh = C4::Context->dbh;
2039 "select password,cardnumber,borrowernumber,userid,firstname,surname,borrowers.branchcode,branches.branchname,flags from borrowers join branches on borrowers.branchcode=branches.branchcode where userid=?"
2041 $sth->execute($userid);
2043 my ( $stored_hash, $cardnumber, $borrowernumber, $userid, $firstname,
2044 $surname, $branchcode, $branchname, $flags )
2047 if ( checkpw_hash( $password, $stored_hash ) ) {
2049 C4::Context->set_userenv( "$borrowernumber", $userid, $cardnumber,
2050 $firstname, $surname, $branchcode, $branchname, $flags ) unless $no_set_userenv;
2051 return 1, $cardnumber, $userid;
2056 "select password,cardnumber,borrowernumber,userid,firstname,surname,borrowers.branchcode,branches.branchname,flags from borrowers join branches on borrowers.branchcode=branches.branchcode where cardnumber=?"
2058 $sth->execute($userid);
2060 my ( $stored_hash, $cardnumber, $borrowernumber, $userid, $firstname,
2061 $surname, $branchcode, $branchname, $flags )
2064 if ( checkpw_hash( $password, $stored_hash ) ) {
2066 C4::Context->set_userenv( $borrowernumber, $userid, $cardnumber,
2067 $firstname, $surname, $branchcode, $branchname, $flags ) unless $no_set_userenv;
2068 return 1, $cardnumber, $userid;
2075 my ( $password, $stored_hash ) = @_;
2077 return if $stored_hash eq '!';
2079 # check what encryption algorithm was implemented: Bcrypt - if the hash starts with '$2' it is Bcrypt else md5
2081 if ( substr( $stored_hash, 0, 2 ) eq '$2' ) {
2082 $hash = hash_password( $password, $stored_hash );
2084 $hash = md5_base64($password);
2086 return $hash eq $stored_hash;
2091 my $authflags = getuserflags($flags, $userid, [$dbh]);
2093 Translates integer flags into permissions strings hash.
2095 C<$flags> is the integer userflags value ( borrowers.userflags )
2096 C<$userid> is the members.userid, used for building subpermissions
2097 C<$authflags> is a hashref of permissions
2104 my $dbh = @_ ? shift : C4::Context->dbh;
2107 # I don't want to do this, but if someone logs in as the database
2108 # user, it would be preferable not to spam them to death with
2109 # numeric warnings. So, we make $flags numeric.
2110 no warnings 'numeric';
2113 my $sth = $dbh->prepare("SELECT bit, flag, defaulton FROM userflags");
2116 while ( my ( $bit, $flag, $defaulton ) = $sth->fetchrow ) {
2117 if ( ( $flags & ( 2**$bit ) ) || $defaulton ) {
2118 $userflags->{$flag} = 1;
2121 $userflags->{$flag} = 0;
2125 # get subpermissions and merge with top-level permissions
2126 my $user_subperms = get_user_subpermissions($userid);
2127 foreach my $module ( keys %$user_subperms ) {
2128 next if $userflags->{$module} == 1; # user already has permission for everything in this module
2129 $userflags->{$module} = $user_subperms->{$module};
2135 =head2 get_user_subpermissions
2137 $user_perm_hashref = get_user_subpermissions($userid);
2139 Given the userid (note, not the borrowernumber) of a staff user,
2140 return a hashref of hashrefs of the specific subpermissions
2141 accorded to the user. An example return is
2145 export_catalog => 1,
2146 import_patrons => 1,
2150 The top-level hash-key is a module or function code from
2151 userflags.flag, while the second-level key is a code
2154 The results of this function do not give a complete picture
2155 of the functions that a staff user can access; it is also
2156 necessary to check borrowers.flags.
2160 sub get_user_subpermissions {
2163 my $dbh = C4::Context->dbh;
2164 my $sth = $dbh->prepare( "SELECT flag, user_permissions.code
2165 FROM user_permissions
2166 JOIN permissions USING (module_bit, code)
2167 JOIN userflags ON (module_bit = bit)
2168 JOIN borrowers USING (borrowernumber)
2169 WHERE userid = ?" );
2170 $sth->execute($userid);
2172 my $user_perms = {};
2173 while ( my $perm = $sth->fetchrow_hashref ) {
2174 $user_perms->{ $perm->{'flag'} }->{ $perm->{'code'} } = 1;
2179 =head2 get_all_subpermissions
2181 my $perm_hashref = get_all_subpermissions();
2183 Returns a hashref of hashrefs defining all specific
2184 permissions currently defined. The return value
2185 has the same structure as that of C<get_user_subpermissions>,
2186 except that the innermost hash value is the description
2187 of the subpermission.
2191 sub get_all_subpermissions {
2192 my $dbh = C4::Context->dbh;
2193 my $sth = $dbh->prepare( "SELECT flag, code
2195 JOIN userflags ON (module_bit = bit)" );
2199 while ( my $perm = $sth->fetchrow_hashref ) {
2200 $all_perms->{ $perm->{'flag'} }->{ $perm->{'code'} } = 1;
2205 =head2 get_cataloguing_page_permissions
2207 my $required_permissions = get_cataloguing_page_permissions();
2209 Returns the required permissions to access the main cataloguing page. Useful for building
2210 the global I<can_see_cataloguing_module> template variable, and also for reusing in
2211 I<cataloging-home.pl>.
2215 sub get_cataloguing_page_permissions {
2217 my @cataloguing_tools_subperms = qw(
2224 marc_modification_templates
2232 { editcatalogue => '*' }, { tools => \@cataloguing_tools_subperms },
2233 C4::Context->preference('StockRotation') ? { stockrotation => 'manage_rotas' } : ()
2237 =head2 haspermission
2239 $flagsrequired = '*'; # Any permission at all
2240 $flagsrequired = 'a_flag'; # a_flag must be satisfied (all subpermissions)
2241 $flagsrequired = [ 'a_flag', 'b_flag' ]; # a_flag OR b_flag must be satisfied
2242 $flagsrequired = { 'a_flag => 1, 'b_flag' => 1 }; # a_flag AND b_flag must be satisfied
2243 $flagsrequired = { 'a_flag' => 'sub_a' }; # sub_a of a_flag must be satisfied
2244 $flagsrequired = { 'a_flag' => [ 'sub_a, 'sub_b' ] }; # sub_a OR sub_b of a_flag must be satisfied
2246 $flags = ($userid, $flagsrequired);
2248 C<$userid> the userid of the member
2249 C<$flags> is a query structure similar to that used by SQL::Abstract that
2250 denotes the combination of flags required. It is a required parameter.
2252 The main logic of this method is that things in arrays are OR'ed, and things
2253 in hashes are AND'ed. The `*` character can be used, at any depth, to denote `ANY`
2255 Returns member's flags or 0 if a permission is not met.
2260 my ($required, $flags) = @_;
2262 my $ref = ref($required);
2264 if ($required eq '*') {
2265 return 0 unless ( $flags or ref( $flags ) );
2267 return 0 unless ( $flags and (!ref( $flags ) || $flags->{$required} ));
2269 } elsif ($ref eq 'HASH') {
2270 foreach my $key (keys %{$required}) {
2271 next if $flags == 1;
2272 my $require = $required->{$key};
2273 my $rflags = $flags->{$key};
2274 return 0 unless _dispatch($require, $rflags);
2276 } elsif ($ref eq 'ARRAY') {
2278 foreach my $require ( @{$required} ) {
2280 ( ref($flags) && !ref($require) && ( $require ne '*' ) )
2281 ? $flags->{$require}
2283 $satisfied++ if _dispatch( $require, $rflags );
2285 return 0 unless $satisfied;
2287 croak "Unexpected structure found: $ref";
2294 my ( $userid, $flagsrequired ) = @_;
2296 #Koha::Exceptions::WrongParameter->throw('$flagsrequired should not be undef')
2297 # unless defined($flagsrequired);
2299 my $sth = C4::Context->dbh->prepare("SELECT flags FROM borrowers WHERE userid=?");
2300 $sth->execute($userid);
2301 my $row = $sth->fetchrow();
2302 my $flags = getuserflags( $row, $userid );
2304 return $flags unless defined($flagsrequired);
2305 return $flags if $flags->{superlibrarian};
2306 return _dispatch($flagsrequired, $flags);
2308 #FIXME - This fcn should return the failed permission so a suitable error msg can be delivered.
2313 $flags = ($iprange);
2315 C<$iprange> A space separated string describing an IP range. Can include single IPs or ranges
2317 Returns 1 if the remote address is in the provided iprange, or 0 otherwise.
2324 my @allowedipranges = $iprange ? split(' ', $iprange) : ();
2325 if (scalar @allowedipranges > 0) {
2327 eval { @rangelist = Net::CIDR::range2cidr(@allowedipranges); }; return 0 if $@;
2328 eval { $result = Net::CIDR::cidrlookup($ENV{'REMOTE_ADDR'}, @rangelist) } || Koha::Logger->get->warn('cidrlookup failed for ' . join(' ',@rangelist) );
2330 return $result ? 1 : 0;
2333 sub getborrowernumber {
2335 my $userenv = C4::Context->userenv;
2336 if ( defined($userenv) && ref($userenv) eq 'HASH' && $userenv->{number} ) {
2337 return $userenv->{number};
2339 my $dbh = C4::Context->dbh;
2340 for my $field ( 'userid', 'cardnumber' ) {
2342 $dbh->prepare("select borrowernumber from borrowers where $field=?");
2343 $sth->execute($userid);
2345 my ($bnumber) = $sth->fetchrow;
2352 =head2 track_login_daily
2354 track_login_daily( $userid );
2356 Wraps the call to $patron->track_login, the method used to update borrowers.lastseen. We only call track_login once a day.
2360 sub track_login_daily {
2362 return if !$userid || !C4::Context->preference('TrackLastPatronActivity');
2364 my $cache = Koha::Caches->get_instance();
2365 my $cache_key = "track_login_" . $userid;
2366 my $cached = $cache->get_from_cache($cache_key);
2367 my $today = dt_from_string()->ymd;
2368 return if $cached && $cached eq $today;
2370 my $patron = Koha::Patrons->find({ userid => $userid });
2371 return unless $patron;
2372 $patron->track_login;
2373 $cache->set_in_cache( $cache_key, $today );
2376 END { } # module clean-up code here (global destructor)
2386 Crypt::Eksblowfish::Bcrypt(3)