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 IntranetReadingHistoryHolds => C4::Context->preference("IntranetReadingHistoryHolds"),
502 intranetstylesheet => C4::Context->preference("intranetstylesheet"),
503 IntranetUserCSS => C4::Context->preference("IntranetUserCSS"),
504 IntranetUserJS => C4::Context->preference("IntranetUserJS"),
505 LibraryName => C4::Context->preference("LibraryName"),
506 LocalCoverImages => C4::Context->preference('LocalCoverImages'),
507 OPACLocalCoverImages => C4::Context->preference('OPACLocalCoverImages'),
508 PatronAutoComplete => C4::Context->preference("PatronAutoComplete"),
509 pending_checkout_notes => Koha::Checkouts->search( { noteseen => 0 } ),
510 plugins_enabled => C4::Context->config("enable_plugins"),
511 StaffSerialIssueDisplayCount => C4::Context->preference("StaffSerialIssueDisplayCount"),
512 UseCourseReserves => C4::Context->preference("UseCourseReserves"),
513 useDischarge => C4::Context->preference('useDischarge'),
514 virtualshelves => C4::Context->preference("virtualshelves"),
518 warn "template type should be OPAC, here it is=[" . $in->{'type'} . "]" unless ( $in->{'type'} eq 'opac' );
520 #TODO : replace LibraryName syspref with 'system name', and remove this html processing
521 my $LibraryNameTitle = C4::Context->preference("LibraryName");
522 $LibraryNameTitle =~ s/<(?:\/?)(?:br|p)\s*(?:\/?)>/ /sgi;
523 $LibraryNameTitle =~ s/<(?:[^<>'"]|'(?:[^']*)'|"(?:[^"]*)")*>//sg;
525 # clean up the busc param in the session
526 # if the page is not opac-detail and not the "add to list" page
527 # and not the "edit comments" page
528 if ( C4::Context->preference("OpacBrowseResults")
529 && $in->{'template_name'} =~ /opac-(.+)\.(?:tt|tmpl)$/ ) {
531 unless ( $pagename =~ /^(?:MARC|ISBD)?detail$/
532 or $pagename =~ /^showmarc$/
533 or $pagename =~ /^addbybiblionumber$/
534 or $pagename =~ /^review$/ )
536 my $sessionSearch = get_session( $sessionID );
537 $sessionSearch->clear( ["busc"] ) if $sessionSearch;
541 # variables passed from CGI: opac_css_override and opac_search_limits.
542 my $opac_search_limit = $ENV{'OPAC_SEARCH_LIMIT'};
543 my $opac_limit_override = $ENV{'OPAC_LIMIT_OVERRIDE'};
546 ( $opac_limit_override && $opac_search_limit && $opac_search_limit =~ /branch:([\w-]+)/ ) ||
547 ( $in->{'query'}->param('limit') && $in->{'query'}->param('limit') =~ /branch:([\w-]+)/ ) ||
548 ( $in->{'query'}->param('limit') && $in->{'query'}->param('limit') =~ /multibranchlimit:(\w+)/ )
550 $opac_name = $1; # opac_search_limit is a branch, so we use it.
551 } elsif ( $in->{'query'}->param('multibranchlimit') ) {
552 $opac_name = $in->{'query'}->param('multibranchlimit');
553 } elsif ( C4::Context->preference("SearchMyLibraryFirst") && C4::Context->userenv && C4::Context->userenv->{'branch'} ) {
554 $opac_name = C4::Context->userenv->{'branch'};
557 # Decide if the patron can make suggestions in the OPAC
558 my $can_make_suggestions;
559 if ( C4::Context->preference('Suggestion') && C4::Context->preference('AnonSuggestions') ) {
560 $can_make_suggestions = 1;
561 } elsif ( C4::Context->userenv && C4::Context->userenv->{'number'} ) {
562 $can_make_suggestions = Koha::Patrons->find(C4::Context->userenv->{'number'})->category->can_make_suggestions;
565 my @search_groups = Koha::Library::Groups->get_search_groups({ interface => 'opac' })->as_list;
567 AnonSuggestions => "" . C4::Context->preference("AnonSuggestions"),
568 LibrarySearchGroups => \@search_groups,
569 opac_name => $opac_name,
570 LibraryName => "" . C4::Context->preference("LibraryName"),
571 LibraryNameTitle => "" . $LibraryNameTitle,
572 OPACAmazonCoverImages => C4::Context->preference("OPACAmazonCoverImages"),
573 OPACFRBRizeEditions => C4::Context->preference("OPACFRBRizeEditions"),
574 OpacHighlightedWords => C4::Context->preference("OpacHighlightedWords"),
575 OPACShelfBrowser => "" . C4::Context->preference("OPACShelfBrowser"),
576 OPACURLOpenInNewWindow => "" . C4::Context->preference("OPACURLOpenInNewWindow"),
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 opacuserlogin => "" . C4::Context->preference("opacuserlogin"),
597 OpenLibrarySearch => C4::Context->preference("OpenLibrarySearch"),
598 ShowReviewer => C4::Context->preference("ShowReviewer"),
599 ShowReviewerPhoto => C4::Context->preference("ShowReviewerPhoto"),
600 suggestion => $can_make_suggestions,
601 virtualshelves => "" . C4::Context->preference("virtualshelves"),
602 OPACSerialIssueDisplayCount => C4::Context->preference("OPACSerialIssueDisplayCount"),
603 SyndeticsClientCode => C4::Context->preference("SyndeticsClientCode"),
604 SyndeticsEnabled => C4::Context->preference("SyndeticsEnabled"),
605 SyndeticsCoverImages => C4::Context->preference("SyndeticsCoverImages"),
606 SyndeticsTOC => C4::Context->preference("SyndeticsTOC"),
607 SyndeticsSummary => C4::Context->preference("SyndeticsSummary"),
608 SyndeticsEditions => C4::Context->preference("SyndeticsEditions"),
609 SyndeticsExcerpt => C4::Context->preference("SyndeticsExcerpt"),
610 SyndeticsReviews => C4::Context->preference("SyndeticsReviews"),
611 SyndeticsAuthorNotes => C4::Context->preference("SyndeticsAuthorNotes"),
612 SyndeticsAwards => C4::Context->preference("SyndeticsAwards"),
613 SyndeticsSeries => C4::Context->preference("SyndeticsSeries"),
614 SyndeticsCoverImageSize => C4::Context->preference("SyndeticsCoverImageSize"),
615 OPACLocalCoverImages => C4::Context->preference("OPACLocalCoverImages"),
616 PatronSelfRegistration => C4::Context->preference("PatronSelfRegistration"),
617 PatronSelfRegistrationDefaultCategory => C4::Context->preference("PatronSelfRegistrationDefaultCategory"),
618 useDischarge => C4::Context->preference('useDischarge'),
621 $template->param( OpacPublic => '1' ) if ( $user || C4::Context->preference("OpacPublic") );
624 # Check if we were asked using parameters to force a specific language
625 if ( defined $in->{'query'}->param('language') ) {
627 # Extract the language, let C4::Languages::getlanguage choose
629 my $language = C4::Languages::getlanguage( $in->{'query'} );
630 my $languagecookie = C4::Templates::getlanguagecookie( $in->{'query'}, $language );
631 $cookie = $cookie_mgr->replace_in_list( $cookie, $languagecookie );
634 return ( $template, $borrowernumber, $cookie, $flags );
639 ($userid, $cookie, $sessionID) = &checkauth($query, $noauth, $flagsrequired, $type);
641 Verifies that the user is authorized to run this script. If
642 the user is authorized, a (userid, cookie, session-id, flags)
643 quadruple is returned. If the user is not authorized but does
644 not have the required privilege (see $flagsrequired below), it
645 displays an error page and exits. Otherwise, it displays the
646 login page and exits.
648 Note that C<&checkauth> will return if and only if the user
649 is authorized, so it should be called early on, before any
650 unfinished operations (e.g., if you've opened a file, then
651 C<&checkauth> won't close it for you).
653 C<$query> is the CGI object for the script calling C<&checkauth>.
655 The C<$noauth> argument is optional. If it is set, then no
656 authorization is required for the script.
658 C<&checkauth> fetches user and session information from C<$query> and
659 ensures that the user is authorized to run scripts that require
662 The C<$flagsrequired> argument specifies the required privileges
663 the user must have if the username and password are correct.
664 It should be specified as a reference-to-hash; keys in the hash
665 should be the "flags" for the user, as specified in the Members
666 intranet module. Any key specified must correspond to a "flag"
667 in the userflags table. E.g., { circulate => 1 } would specify
668 that the user must have the "circulate" privilege in order to
669 proceed. To make sure that access control is correct, the
670 C<$flagsrequired> parameter must be specified correctly.
672 Koha also has a concept of sub-permissions, also known as
673 granular permissions. This makes the value of each key
674 in the C<flagsrequired> hash take on an additional
679 The user must have access to all subfunctions of the module
680 specified by the hash key.
684 The user must have access to at least one subfunction of the module
685 specified by the hash key.
687 specific permission, e.g., 'export_catalog'
689 The user must have access to the specific subfunction list, which
690 must correspond to a row in the permissions table.
692 The C<$type> argument specifies whether the template should be
693 retrieved from the opac or intranet directory tree. "opac" is
694 assumed if it is not specified; however, if C<$type> is specified,
695 "intranet" is assumed if it is not "opac".
697 If C<$query> does not have a valid session ID associated with it
698 (i.e., the user has not logged in) or if the session has expired,
699 C<&checkauth> presents the user with a login page (from the point of
700 view of the original script, C<&checkauth> does not return). Once the
701 user has authenticated, C<&checkauth> restarts the original script
702 (this time, C<&checkauth> returns).
704 The login page is provided using a HTML::Template, which is set in the
705 systempreferences table or at the top of this file. The variable C<$type>
706 selects which template to use, either the opac or the intranet
707 authentification template.
709 C<&checkauth> returns a user ID, a cookie, and a session ID. The
710 cookie should be sent back to the browser; it verifies that the user
720 # If version syspref is unavailable, it means Koha is being installed,
721 # and so we must redirect to OPAC maintenance page or to the WebInstaller
722 # also, if OpacMaintenance is ON, OPAC should redirect to maintenance
723 if ( C4::Context->preference('OpacMaintenance') && $type eq 'opac' ) {
724 warn "OPAC Install required, redirecting to maintenance";
725 print $query->redirect("/cgi-bin/koha/maintenance.pl");
728 unless ( $version = C4::Context->preference('Version') ) { # assignment, not comparison
729 if ( $type ne 'opac' ) {
730 warn "Install required, redirecting to Installer";
731 print $query->redirect("/cgi-bin/koha/installer/install.pl");
733 warn "OPAC Install required, redirecting to maintenance";
734 print $query->redirect("/cgi-bin/koha/maintenance.pl");
739 # check that database and koha version are the same
740 # there is no DB version, it's a fresh install,
741 # go to web installer
742 # there is a DB version, compare it to the code version
743 my $kohaversion = Koha::version();
745 # remove the 3 last . to have a Perl number
746 $kohaversion =~ s/(.*\..*)\.(.*)\.(.*)/$1$2$3/;
747 Koha::Logger->get->debug("kohaversion : $kohaversion");
748 if ( $version < $kohaversion ) {
749 my $warning = "Database update needed, redirecting to %s. Database is $version and Koha is $kohaversion";
750 if ( $type ne 'opac' ) {
751 warn sprintf( $warning, 'Installer' );
752 print $query->redirect("/cgi-bin/koha/installer/install.pl?step=1&op=updatestructure");
754 warn sprintf( "OPAC: " . $warning, 'maintenance' );
755 print $query->redirect("/cgi-bin/koha/maintenance.pl");
761 sub _timeout_syspref {
762 my $default_timeout = 600;
763 my $timeout = C4::Context->preference('timeout') || $default_timeout;
765 # value in days, convert in seconds
766 if ( $timeout =~ /^(\d+)[dD]$/ ) {
767 $timeout = $1 * 86400;
769 # value in hours, convert in seconds
770 elsif ( $timeout =~ /^(\d+)[hH]$/ ) {
771 $timeout = $1 * 3600;
773 elsif ( $timeout !~ m/^\d+$/ ) {
774 warn "The value of the system preference 'timeout' is not correct, defaulting to $default_timeout";
775 $timeout = $default_timeout;
784 # Get shibboleth login attribute
785 my $shib = C4::Context->config('useshibboleth') && shib_ok();
786 my $shib_login = $shib ? get_login_shib() : undef;
788 # $authnotrequired will be set for scripts which will run without authentication
789 my $authnotrequired = shift;
790 my $flagsrequired = shift;
792 my $emailaddress = shift;
793 my $template_name = shift;
794 $type = 'opac' unless $type;
796 if ( $type eq 'opac' && !C4::Context->preference("OpacPublic") ) {
797 my @allowed_scripts_for_private_opac = qw(
799 opac-registration-email-sent.tt
800 opac-registration-confirmation.tt
801 opac-memberentry-update-submitted.tt
802 opac-password-recovery.tt
803 opac-reset-password.tt
805 $authnotrequired = 0 unless grep { $_ eq $template_name }
806 @allowed_scripts_for_private_opac;
809 my $timeout = _timeout_syspref();
811 my $cookie_mgr = Koha::CookieManager->new;
813 _version_check( $type, $query );
817 my $auth_state = 'failed';
819 my ( $userid, $cookie, $sessionID, $flags );
821 my $logout = $query->param('logout.x');
823 my $anon_search_history;
825 # This parameter is the name of the CAS server we want to authenticate against,
826 # when using authentication against multiple CAS servers, as configured in Auth_cas_servers.yaml
827 my $casparam = $query->param('cas');
828 my $q_userid = $query->param('userid') // '';
831 my $invalid_otp_token;
833 ( $type ne "opac" # Only available for the staff interface
834 && C4::Context->preference('TwoFactorAuthentication') ne "disabled" ) # If "enabled" or "enforced"
837 # Basic authentication is incompatible with the use of Shibboleth,
838 # as Shibboleth may return REMOTE_USER as a Shibboleth attribute,
839 # and it may not be the attribute we want to use to match the koha login.
841 # Also, do not consider an empty REMOTE_USER.
843 # Finally, after those tests, we can assume (although if it would be better with
844 # a syspref) that if we get a REMOTE_USER, that's from basic authentication,
845 # and we can affect it to $userid.
846 if ( !$shib and defined( $ENV{'REMOTE_USER'} ) and $ENV{'REMOTE_USER'} ne '' and $userid = $ENV{'REMOTE_USER'} ) {
848 # Using Basic Authentication, no cookies required
849 $cookie = $cookie_mgr->replace_in_list( $cookie, $query->cookie(
850 -name => 'CGISESSID',
853 -secure => ( C4::Context->https_enabled() ? 1 : 0 ),
858 elsif ( $emailaddress) {
859 # the Google OpenID Connect passes an email address
861 elsif ( $sessionID = $query->cookie("CGISESSID") ) { # assignment, not comparison
862 my ( $return, $more_info );
863 # NOTE: $flags in the following call is still undefined !
864 ( $return, $session, $more_info ) = check_cookie_auth( $sessionID, $flags,
865 { remote_addr => $ENV{REMOTE_ADDR}, skip_version_check => 1 }
868 if ( $return eq 'ok' || $return eq 'additional-auth-needed' ) {
869 $userid = $session->param('id');
873 $return eq 'ok' ? 'completed'
874 : $return eq 'additional-auth-needed' ? 'additional-auth-needed'
877 # We are at the second screen if the waiting-for-2FA is set in session
878 # and otp_token param has been passed
880 && $auth_state eq 'additional-auth-needed'
881 && ( my $otp_token = $query->param('otp_token') ) )
883 my $patron = Koha::Patrons->find( { userid => $userid } );
884 my $auth = Koha::Auth::TwoFactorAuth->new( { patron => $patron } );
885 my $verified = $auth->verify($otp_token);
888 # The token is correct, the user is fully logged in!
889 $auth_state = 'completed';
890 $session->param( 'waiting-for-2FA', 0 );
891 $session->param( 'waiting-for-2FA-setup', 0 );
893 # This is an ugly trick to pass the test
894 # $query->param('koha_login_context') && ( $q_userid ne $userid )
899 $invalid_otp_token = 1;
903 if ( $auth_state eq 'completed' ) {
904 Koha::Logger->get->debug(sprintf "AUTH_SESSION: (%s)\t%s %s - %s", map { $session->param($_) || q{} } qw(cardnumber firstname surname branch));
906 if ( ( $query->param('koha_login_context') && ( $q_userid ne $userid ) )
907 || ( $cas && $query->param('ticket') && !C4::Context->userenv->{'id'} )
908 || ( $shib && $shib_login && !$logout && !C4::Context->userenv->{'id'} )
911 #if a user enters an id ne to the id in the current session, we need to log them in...
912 #first we need to clear the anonymous session...
913 $anon_search_history = $session->param('search_history');
916 $cookie = $cookie_mgr->clear_unless( $query->cookie, @$cookie );
917 C4::Context::_unset_userenv($sessionID);
919 undef $userid; # IMPORTANT: this assures us a new session in code below
920 $auth_state = 'failed';
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 my $patron = Koha::Patrons->find({userid => $userid});
1175 if ( $query->param('branch') && ( haspermission($userid, { 'loggedinlibrary'=> 1 }) || $patron->is_superlibrarian ) ) {
1176 $branchcode = $query->param('branch');
1177 my $library = Koha::Libraries->find($branchcode);
1178 $branchname = $library? $library->branchname: '';
1180 if ( $query->param('desk_id') ) {
1181 $desk_id = $query->param('desk_id');
1182 my $desk = Koha::Desks->find($desk_id);
1183 $desk_name = $desk ? $desk->desk_name : '';
1185 if ( C4::Context->preference('UseCashRegisters') ) {
1187 $query->param('register_id')
1188 ? Koha::Cash::Registers->find($query->param('register_id'))
1189 : Koha::Cash::Registers->search(
1190 { branch => $branchcode, branch_default => 1 },
1191 { rows => 1 } )->single;
1192 $register_id = $register->id if ($register);
1193 $register_name = $register->name if ($register);
1195 my $branches = { map { $_->branchcode => $_->unblessed } Koha::Libraries->search->as_list };
1196 if ( $type ne 'opac' and C4::Context->preference('AutoLocation') ) {
1198 # we have to check they are coming from the right ip range
1199 my $domain = $branches->{$branchcode}->{'branchip'};
1200 $domain =~ s|\.\*||g;
1201 if ( $ip !~ /^$domain/ ) {
1203 $cookie = $cookie_mgr->replace_in_list( $cookie, $query->cookie(
1204 -name => 'CGISESSID',
1207 -secure => ( C4::Context->https_enabled() ? 1 : 0 ),
1210 $info{'wrongip'} = 1;
1214 foreach my $br ( keys %$branches ) {
1216 # now we work with the treatment of ip
1217 my $domain = $branches->{$br}->{'branchip'};
1218 if ( $domain && $ip =~ /^$domain/ ) {
1219 $branchcode = $branches->{$br}->{'branchcode'};
1221 # new op dev : add the branchname to the cookie
1222 $branchname = $branches->{$br}->{'branchname'};
1226 my $is_sco_user = 0;
1227 if ( $query->param('sco_user_login') && ( $query->param('sco_user_login') eq '1' ) ){
1231 $session->param( 'number', $borrowernumber );
1232 $session->param( 'id', $userid );
1233 $session->param( 'cardnumber', $cardnumber );
1234 $session->param( 'firstname', $firstname );
1235 $session->param( 'surname', $surname );
1236 $session->param( 'branch', $branchcode );
1237 $session->param( 'branchname', $branchname );
1238 $session->param( 'desk_id', $desk_id);
1239 $session->param( 'desk_name', $desk_name);
1240 $session->param( 'flags', $userflags );
1241 $session->param( 'emailaddress', $emailaddress );
1242 $session->param( 'ip', $session->remote_addr() );
1243 $session->param( 'lasttime', time() );
1244 $session->param( 'interface', $type);
1245 $session->param( 'shibboleth', $shibSuccess );
1246 $session->param( 'register_id', $register_id );
1247 $session->param( 'register_name', $register_name );
1248 $session->param( 'sco_user', $is_sco_user );
1250 $session->param('cas_ticket', $cas_ticket) if $cas_ticket;
1251 C4::Context->set_userenv(
1252 $session->param('number'), $session->param('id'),
1253 $session->param('cardnumber'), $session->param('firstname'),
1254 $session->param('surname'), $session->param('branch'),
1255 $session->param('branchname'), $session->param('flags'),
1256 $session->param('emailaddress'), $session->param('shibboleth'),
1257 $session->param('desk_id'), $session->param('desk_name'),
1258 $session->param('register_id'), $session->param('register_name')
1262 # $return: 0 = invalid user
1263 # reset to anonymous session
1266 $info{'invalid_username_or_password'} = 1;
1267 C4::Context::_unset_userenv($sessionID);
1269 $session->param( 'lasttime', time() );
1270 $session->param( 'ip', $session->remote_addr() );
1271 $session->param( 'sessiontype', 'anon' );
1272 $session->param( 'interface', $type);
1274 } # END if ( $q_userid
1275 elsif ( $type eq "opac" ) {
1277 # anonymous sessions are created only for the OPAC
1279 # setting a couple of other session vars...
1280 $session->param( 'ip', $session->remote_addr() );
1281 $session->param( 'lasttime', time() );
1282 $session->param( 'sessiontype', 'anon' );
1283 $session->param( 'interface', $type);
1286 } # END unless ($userid)
1289 if ( $auth_state eq 'logged_in' ) {
1290 $auth_state = 'completed';
1292 # Auth is completed unless an additional auth is needed
1293 if ( $require_2FA ) {
1294 my $patron = Koha::Patrons->find({userid => $userid});
1295 if ( C4::Context->preference('TwoFactorAuthentication') eq "enforced" && $patron->auth_method eq 'password' ) {
1296 $auth_state = 'setup-additional-auth-needed';
1297 $session->param('waiting-for-2FA-setup', 1);
1298 %info = ();# We remove the warnings/errors we may have set incorrectly before
1299 } elsif ( $patron->auth_method eq 'two-factor' ) {
1300 # Ask for the OTP token
1301 $auth_state = 'additional-auth-needed';
1302 $session->param('waiting-for-2FA', 1);
1303 %info = ();# We remove the warnings/errors we may have set incorrectly before
1308 # finished authentification, now respond
1309 if ( $auth_state eq 'completed' || $authnotrequired ) {
1312 $cookie = $cookie_mgr->replace_in_list( $cookie, $query->cookie(
1313 -name => 'CGISESSID',
1316 -secure => ( C4::Context->https_enabled() ? 1 : 0 ),
1321 track_login_daily( $userid );
1323 # In case, that this request was a login attempt, we want to prevent that users can repost the opac login
1324 # request. We therefore redirect the user to the requested page again without the login parameters.
1325 # See Post/Redirect/Get (PRG) design pattern: https://en.wikipedia.org/wiki/Post/Redirect/Get
1326 if ( $type eq "opac" && $query->param('koha_login_context') && $query->param('koha_login_context') ne 'sco' && $query->param('password') && $query->param('userid') ) {
1327 my $uri = URI->new($query->url(-relative=>1, -query_string=>1));
1328 $uri->query_param_delete('userid');
1329 $uri->query_param_delete('password');
1330 $uri->query_param_delete('koha_login_context');
1331 print $query->redirect(-uri => $uri->as_string, -cookie => $cookie, -status=>'303 See other');
1335 return ( $userid, $cookie, $sessionID, $flags );
1340 # AUTH rejected, show the login/password template, after checking the DB.
1344 my $patron = Koha::Patrons->find({ userid => $q_userid }); # Not necessary logged in!
1346 # get the inputs from the incoming query
1348 my @inputs_to_clean = qw( userid password ticket logout.x otp_token );
1349 foreach my $name ( param $query) {
1350 next if grep { $name eq $_ } @inputs_to_clean;
1351 my @value = $query->multi_param($name);
1352 push @inputs, { name => $name, value => $_ } for @value;
1355 my $LibraryNameTitle = C4::Context->preference("LibraryName");
1356 $LibraryNameTitle =~ s/<(?:\/?)(?:br|p)\s*(?:\/?)>/ /sgi;
1357 $LibraryNameTitle =~ s/<(?:[^<>'"]|'(?:[^']*)'|"(?:[^"]*)")*>//sg;
1359 my $auth_template_name = ( $type eq 'opac' ) ? 'opac-auth.tt' : 'auth.tt';
1360 my $auth_error = $query->param('auth_error');
1361 my $template = C4::Templates::gettemplate( $auth_template_name, $type, $query );
1365 script_name => get_script_name(),
1366 casAuthentication => C4::Context->preference("casAuthentication"),
1367 shibbolethAuthentication => $shib,
1368 suggestion => C4::Context->preference("suggestion"),
1369 virtualshelves => C4::Context->preference("virtualshelves"),
1370 LibraryName => "" . C4::Context->preference("LibraryName"),
1371 LibraryNameTitle => "" . $LibraryNameTitle,
1372 opacuserlogin => C4::Context->preference("opacuserlogin"),
1373 OpacFavicon => C4::Context->preference("OpacFavicon"),
1374 opacreadinghistory => C4::Context->preference("opacreadinghistory"),
1375 opaclanguagesdisplay => C4::Context->preference("opaclanguagesdisplay"),
1376 opacbookbag => "" . C4::Context->preference("opacbookbag"),
1377 OpacCloud => C4::Context->preference("OpacCloud"),
1378 OpacTopissue => C4::Context->preference("OpacTopissue"),
1379 OpacAuthorities => C4::Context->preference("OpacAuthorities"),
1380 OpacBrowser => C4::Context->preference("OpacBrowser"),
1381 TagsEnabled => C4::Context->preference("TagsEnabled"),
1382 intranetcolorstylesheet => C4::Context->preference("intranetcolorstylesheet"),
1383 intranetstylesheet => C4::Context->preference("intranetstylesheet"),
1384 IntranetNav => C4::Context->preference("IntranetNav"),
1385 IntranetFavicon => C4::Context->preference("IntranetFavicon"),
1386 IntranetUserCSS => C4::Context->preference("IntranetUserCSS"),
1387 IntranetUserJS => C4::Context->preference("IntranetUserJS"),
1388 IndependentBranches => C4::Context->preference("IndependentBranches"),
1389 AutoLocation => C4::Context->preference("AutoLocation"),
1390 wrongip => $info{'wrongip'},
1391 PatronSelfRegistration => C4::Context->preference("PatronSelfRegistration"),
1392 PatronSelfRegistrationDefaultCategory => C4::Context->preference("PatronSelfRegistrationDefaultCategory"),
1393 opac_css_override => $ENV{'OPAC_CSS_OVERRIDE'},
1394 too_many_login_attempts => ( $patron and $patron->account_locked ),
1395 password_has_expired => ( $patron and $patron->password_expired ),
1396 auth_error => $auth_error,
1399 $template->param( SCO_login => 1 ) if ( $query->param('sco_user_login') );
1400 $template->param( SCI_login => 1 ) if ( $query->param('sci_user_login') );
1401 $template->param( OpacPublic => C4::Context->preference("OpacPublic") );
1402 $template->param( loginprompt => 1 ) unless $info{'nopermission'};
1403 if ( $auth_state eq 'additional-auth-needed' ) {
1404 my $patron = Koha::Patrons->find( { userid => $userid } );
1407 invalid_otp_token => $invalid_otp_token,
1408 notice_email_address => $patron->notice_email_address, # We could also pass logged_in_user if necessary
1412 if ( $auth_state eq 'setup-additional-auth-needed' ) {
1418 if ( $type eq 'opac' ) {
1419 require Koha::Virtualshelves;
1420 my $some_public_shelves = Koha::Virtualshelves->get_some_shelves(
1426 some_public_shelves => $some_public_shelves,
1432 # Is authentication against multiple CAS servers enabled?
1433 require C4::Auth_with_cas;
1434 if ( multipleAuth() && !$casparam ) {
1435 my $casservers = getMultipleAuth();
1437 foreach my $key ( keys %$casservers ) {
1438 push @tmplservers, { name => $key, value => login_cas_url( $query, $key, $type ) . "?cas=$key" };
1441 casServersLoop => \@tmplservers
1445 casServerUrl => login_cas_url($query, undef, $type),
1450 invalidCasLogin => $info{'invalidCasLogin'}
1455 #If shibOnly is enabled just go ahead and redirect directly
1456 if ( (($type eq 'opac') && C4::Context->preference('OPACShibOnly')) || (($type ne 'opac') && C4::Context->preference('staffShibOnly')) ) {
1457 my $redirect_url = login_shib_url( $query );
1458 print $query->redirect( -uri => "$redirect_url", -status => 303 );
1463 shibbolethAuthentication => $shib,
1464 shibbolethLoginUrl => login_shib_url($query),
1468 if (C4::Context->preference('GoogleOpenIDConnect')) {
1469 if ($query->param("OpenIDConnectFailed")) {
1470 my $reason = $query->param('OpenIDConnectFailed');
1471 $template->param(invalidGoogleOpenIDConnectLogin => $reason);
1476 LibraryName => C4::Context->preference("LibraryName"),
1478 $template->param(%info);
1480 # $cookie = $query->cookie(CGISESSID => $session->id
1482 print $query->header(
1483 { type => 'text/html',
1486 'X-Frame-Options' => 'SAMEORIGIN',
1494 =head2 check_api_auth
1496 ($status, $cookie, $sessionId) = check_api_auth($query, $userflags);
1498 Given a CGI query containing the parameters 'userid' and 'password' and/or a session
1499 cookie, determine if the user has the privileges specified by C<$userflags>.
1501 C<check_api_auth> is is meant for authenticating users of web services, and
1502 consequently will always return and will not attempt to redirect the user
1505 If a valid session cookie is already present, check_api_auth will return a status
1506 of "ok", the cookie, and the Koha session ID.
1508 If no session cookie is present, check_api_auth will check the 'userid' and 'password
1509 parameters and create a session cookie and Koha session if the supplied credentials
1512 Possible return values in C<$status> are:
1516 =item "ok" -- user authenticated; C<$cookie> and C<$sessionid> have valid values.
1518 =item "failed" -- credentials are not correct; C<$cookie> and C<$sessionid> are undef
1520 =item "maintenance" -- DB is in maintenance mode; no login possible at the moment
1522 =item "expired -- session cookie has expired; API user should resubmit userid and password
1524 =item "restricted" -- The IP has changed (if SessionRestrictionByIP)
1526 =item "additional-auth-needed -- User is in an authentication process that is not finished
1532 sub check_api_auth {
1535 my $flagsrequired = shift;
1536 my $timeout = _timeout_syspref();
1538 unless ( C4::Context->preference('Version') ) {
1540 # database has not been installed yet
1541 return ( "maintenance", undef, undef );
1543 my $kohaversion = Koha::version();
1544 $kohaversion =~ s/(.*\..*)\.(.*)\.(.*)/$1$2$3/;
1545 if ( C4::Context->preference('Version') < $kohaversion ) {
1547 # database in need of version update; assume that
1548 # no API should be called while databsae is in
1550 return ( "maintenance", undef, undef );
1553 my ( $sessionID, $session );
1554 unless ( $query->param('userid') ) {
1555 $sessionID = $query->cookie("CGISESSID");
1557 if ( $sessionID && not( $cas && $query->param('PT') ) ) {
1560 ( $return, $session, undef ) = check_cookie_auth(
1561 $sessionID, $flagsrequired, { remote_addr => $ENV{REMOTE_ADDR} } );
1563 return ( $return, undef, undef ) # Cookie auth failed
1566 my $cookie = $query->cookie(
1567 -name => 'CGISESSID',
1568 -value => $session->id,
1570 -secure => ( C4::Context->https_enabled() ? 1 : 0 ),
1573 return ( $return, $cookie, $session ); # return == 'ok' here
1578 my $userid = $query->param('userid');
1579 my $password = $query->param('password');
1580 my ( $return, $cardnumber, $cas_ticket );
1583 if ( $cas && $query->param('PT') ) {
1586 # In case of a CAS authentication, we use the ticket instead of the password
1587 my $PT = $query->param('PT');
1588 ( $return, $cardnumber, $userid, $cas_ticket ) = check_api_auth_cas( $PT, $query ); # EXTERNAL AUTH
1591 # User / password auth
1592 unless ( $userid and $password ) {
1594 # caller did something wrong, fail the authenticateion
1595 return ( "failed", undef, undef );
1598 ( $return, $cardnumber, $newuserid, $cas_ticket ) = checkpw( $userid, $password, $query );
1601 if ( $return and haspermission( $userid, $flagsrequired ) ) {
1602 my $session = get_session("");
1603 return ( "failed", undef, undef ) unless $session;
1605 my $sessionID = $session->id;
1606 C4::Context->_new_userenv($sessionID);
1607 my $cookie = $query->cookie(
1608 -name => 'CGISESSID',
1609 -value => $sessionID,
1611 -secure => ( C4::Context->https_enabled() ? 1 : 0 ),
1614 if ( $return == 1 ) {
1616 $borrowernumber, $firstname, $surname,
1617 $userflags, $branchcode, $branchname,
1620 my $dbh = C4::Context->dbh;
1623 "select borrowernumber, firstname, surname, flags, borrowers.branchcode, branches.branchname as branchname, email from borrowers left join branches on borrowers.branchcode=branches.branchcode where userid=?"
1625 $sth->execute($userid);
1627 $borrowernumber, $firstname, $surname,
1628 $userflags, $branchcode, $branchname,
1630 ) = $sth->fetchrow if ( $sth->rows );
1632 unless ( $sth->rows ) {
1633 my $sth = $dbh->prepare(
1634 "select borrowernumber, firstname, surname, flags, borrowers.branchcode, branches.branchname as branchname, email from borrowers left join branches on borrowers.branchcode=branches.branchcode where cardnumber=?"
1636 $sth->execute($cardnumber);
1638 $borrowernumber, $firstname, $surname,
1639 $userflags, $branchcode, $branchname,
1641 ) = $sth->fetchrow if ( $sth->rows );
1643 unless ( $sth->rows ) {
1644 $sth->execute($userid);
1646 $borrowernumber, $firstname, $surname, $userflags,
1647 $branchcode, $branchname, $emailaddress
1648 ) = $sth->fetchrow if ( $sth->rows );
1652 my $ip = $ENV{'REMOTE_ADDR'};
1654 # if they specify at login, use that
1655 if ( $query->param('branch') ) {
1656 $branchcode = $query->param('branch');
1657 my $library = Koha::Libraries->find($branchcode);
1658 $branchname = $library? $library->branchname: '';
1660 my $branches = { map { $_->branchcode => $_->unblessed } Koha::Libraries->search->as_list };
1661 foreach my $br ( keys %$branches ) {
1663 # now we work with the treatment of ip
1664 my $domain = $branches->{$br}->{'branchip'};
1665 if ( $domain && $ip =~ /^$domain/ ) {
1666 $branchcode = $branches->{$br}->{'branchcode'};
1668 # new op dev : add the branchname to the cookie
1669 $branchname = $branches->{$br}->{'branchname'};
1672 $session->param( 'number', $borrowernumber );
1673 $session->param( 'id', $userid );
1674 $session->param( 'cardnumber', $cardnumber );
1675 $session->param( 'firstname', $firstname );
1676 $session->param( 'surname', $surname );
1677 $session->param( 'branch', $branchcode );
1678 $session->param( 'branchname', $branchname );
1679 $session->param( 'flags', $userflags );
1680 $session->param( 'emailaddress', $emailaddress );
1681 $session->param( 'ip', $session->remote_addr() );
1682 $session->param( 'lasttime', time() );
1683 $session->param( 'interface', 'api' );
1685 $session->param( 'cas_ticket', $cas_ticket);
1686 C4::Context->set_userenv(
1687 $session->param('number'), $session->param('id'),
1688 $session->param('cardnumber'), $session->param('firstname'),
1689 $session->param('surname'), $session->param('branch'),
1690 $session->param('branchname'), $session->param('flags'),
1691 $session->param('emailaddress'), $session->param('shibboleth'),
1692 $session->param('desk_id'), $session->param('desk_name'),
1693 $session->param('register_id'), $session->param('register_name')
1695 return ( "ok", $cookie, $sessionID );
1697 return ( "failed", undef, undef );
1702 =head2 check_cookie_auth
1704 ($status, $sessionId) = check_cookie_auth($cookie, $userflags);
1706 Given a CGISESSID cookie set during a previous login to Koha, determine
1707 if the user has the privileges specified by C<$userflags>. C<$userflags>
1708 is passed unaltered into C<haspermission> and as such accepts all options
1709 avaiable to that routine with the one caveat that C<check_api_auth> will
1710 also allow 'undef' to be passed and in such a case the permissions check
1711 will be skipped altogether.
1713 C<check_cookie_auth> is meant for authenticating special services
1714 such as tools/upload-file.pl that are invoked by other pages that
1715 have been authenticated in the usual way.
1717 Possible return values in C<$status> are:
1721 =item "ok" -- user authenticated; C<$sessionID> have valid values.
1723 =item "anon" -- user not authenticated but valid for anonymous session.
1725 =item "failed" -- credentials are not correct; C<$sessionid> are undef
1727 =item "maintenance" -- DB is in maintenance mode; no login possible at the moment
1729 =item "expired -- session cookie has expired; API user should resubmit userid and password
1731 =item "restricted" -- The IP has changed (if SessionRestrictionByIP)
1737 sub check_cookie_auth {
1738 my $sessionID = shift;
1739 my $flagsrequired = shift;
1742 my $remote_addr = $params->{remote_addr} || $ENV{REMOTE_ADDR};
1744 my $skip_version_check = $params->{skip_version_check}; # Only for checkauth
1746 unless ( $skip_version_check ) {
1747 unless ( C4::Context->preference('Version') ) {
1749 # database has not been installed yet
1750 return ( "maintenance", undef );
1752 my $kohaversion = Koha::version();
1753 $kohaversion =~ s/(.*\..*)\.(.*)\.(.*)/$1$2$3/;
1754 if ( C4::Context->preference('Version') < $kohaversion ) {
1756 # database in need of version update; assume that
1757 # no API should be called while databsae is in
1759 return ( "maintenance", undef );
1763 # see if we have a valid session cookie already
1764 # however, if a userid parameter is present (i.e., from
1765 # a form submission, assume that any current cookie
1767 unless ( $sessionID ) {
1768 return ( "failed", undef );
1770 C4::Context::_unset_userenv($sessionID); # remove old userenv first
1771 my $session = get_session($sessionID);
1773 my $userid = $session->param('id');
1774 my $ip = $session->param('ip');
1775 my $lasttime = $session->param('lasttime');
1776 my $timeout = _timeout_syspref();
1778 if ( !$lasttime || ( $lasttime < time() - $timeout ) ) {
1782 return ("expired", undef);
1784 } elsif ( C4::Context->preference('SessionRestrictionByIP') && $ip ne $remote_addr ) {
1785 # IP address changed
1788 return ( "restricted", undef, { old_ip => $ip, new_ip => $remote_addr});
1790 } elsif ( $userid ) {
1791 $session->param( 'lasttime', time() );
1792 my $patron = Koha::Patrons->find({ userid => $userid });
1794 # If the user modify their own userid
1795 # Better than 500 but we could do better
1796 unless ( $patron ) {
1799 return ("expired", undef);
1802 $patron = Koha::Patrons->find({ cardnumber => $userid })
1804 return ("password_expired", undef ) if $patron->password_expired;
1805 my $flags = defined($flagsrequired) ? haspermission( $userid, $flagsrequired ) : 1;
1807 C4::Context->_new_userenv($sessionID);
1808 if ( !C4::Context->interface ) {
1809 # No need to override the interface, most often set by get_template_and_user
1810 C4::Context->interface( $session->param('interface') );
1812 C4::Context->set_userenv(
1813 $session->param('number'), $session->param('id') // '',
1814 $session->param('cardnumber'), $session->param('firstname'),
1815 $session->param('surname'), $session->param('branch'),
1816 $session->param('branchname'), $session->param('flags'),
1817 $session->param('emailaddress'), $session->param('shibboleth'),
1818 $session->param('desk_id'), $session->param('desk_name'),
1819 $session->param('register_id'), $session->param('register_name')
1821 if ( C4::Context->preference('TwoFactorAuthentication') ne 'disabled' ) {
1822 return ( "additional-auth-needed", $session )
1823 if $session->param('waiting-for-2FA');
1825 return ( "setup-additional-auth-needed", $session )
1826 if $session->param('waiting-for-2FA-setup');
1829 return ( "ok", $session );
1833 return ( "failed", undef );
1837 C4::Context->_new_userenv($sessionID);
1838 C4::Context->interface($session->param('interface'));
1839 C4::Context->set_userenv( undef, q{} );
1840 return ( "anon", $session );
1843 return ( "expired", undef );
1850 my $session = get_session($sessionID);
1852 Given a session ID, retrieve the CGI::Session object used to store
1853 the session's state. The session object can be used to store
1854 data that needs to be accessed by different scripts during a
1857 If the C<$sessionID> parameter is an empty string, a new session
1862 sub _get_session_params {
1863 my $storage_method = C4::Context->preference('SessionStorage');
1864 if ( $storage_method eq 'mysql' ) {
1865 my $dbh = C4::Context->dbh;
1866 return { dsn => "serializer:yamlxs;driver:MySQL;id:md5", dsn_args => { Handle => $dbh } };
1868 elsif ( $storage_method eq 'Pg' ) {
1869 my $dbh = C4::Context->dbh;
1870 return { dsn => "serializer:yamlxs;driver:PostgreSQL;id:md5", dsn_args => { Handle => $dbh } };
1872 elsif ( $storage_method eq 'memcached' && Koha::Caches->get_instance->memcached_cache ) {
1873 my $memcached = Koha::Caches->get_instance()->memcached_cache;
1874 return { dsn => "serializer:yamlxs;driver:memcached;id:md5", dsn_args => { Memcached => $memcached } };
1877 # catch all defaults to tmp should work on all systems
1878 my $dir = C4::Context::temporary_directory;
1879 my $instance = C4::Context->config( 'database' ); #actually for packages not exactly the instance name, but generally safer to leave it as it is
1880 return { dsn => "serializer:yamlxs;driver:File;id:md5", dsn_args => { Directory => "$dir/cgisess_$instance" } };
1885 my $sessionID = shift;
1886 my $params = _get_session_params();
1888 if( $sessionID ) { # find existing
1889 CGI::Session::ErrorHandler->set_error( q{} ); # clear error, cpan issue #111463
1890 $session = CGI::Session->load( $params->{dsn}, $sessionID, $params->{dsn_args} );
1892 $session = CGI::Session->new( $params->{dsn}, $sessionID, $params->{dsn_args} );
1893 # no need to flush here
1898 =head2 create_basic_session
1900 my $session = create_basic_session({ patron => $patron, interface => $interface });
1902 Creates a session and adds all basic parameters for a session to work
1906 sub create_basic_session {
1908 my $patron = $params->{patron};
1909 my $interface = $params->{interface};
1911 $interface = 'intranet' if $interface eq 'staff';
1913 my $session = get_session("");
1915 $session->param( 'number', $patron->borrowernumber );
1916 $session->param( 'id', $patron->userid );
1917 $session->param( 'cardnumber', $patron->cardnumber );
1918 $session->param( 'firstname', $patron->firstname );
1919 $session->param( 'surname', $patron->surname );
1920 $session->param( 'branch', $patron->branchcode );
1921 $session->param( 'branchname', $patron->library->branchname );
1922 $session->param( 'flags', $patron->flags );
1923 $session->param( 'emailaddress', $patron->email );
1924 $session->param( 'ip', $session->remote_addr() );
1925 $session->param( 'lasttime', time() );
1926 $session->param( 'interface', $interface);
1932 # FIXME no_set_userenv may be replaced with force_branchcode_for_userenv
1933 # (or something similar)
1934 # Currently it's only passed from C4::SIP::ILS::Patron::check_password, but
1935 # not having a userenv defined could cause a crash.
1937 my ( $userid, $password, $query, $type, $no_set_userenv ) = @_;
1938 $type = 'opac' unless $type;
1940 # Get shibboleth login attribute
1941 my $shib = C4::Context->config('useshibboleth') && shib_ok();
1942 my $shib_login = $shib ? get_login_shib() : undef;
1946 if ( defined $userid ){
1947 $patron = Koha::Patrons->find({ userid => $userid });
1948 $patron = Koha::Patrons->find({ cardnumber => $userid }) unless $patron;
1950 my $check_internal_as_fallback = 0;
1952 # Note: checkpw_* routines returns:
1955 # -1 if user bind failed (LDAP only)
1957 if ( $patron and ( $patron->account_locked ) ) {
1958 # Nothing to check, account is locked
1959 } elsif ($ldap && defined($password)) {
1960 my ( $retval, $retcard, $retuserid ) = checkpw_ldap(@_); # EXTERNAL AUTH
1961 if ( $retval == 1 ) {
1962 @return = ( $retval, $retcard, $retuserid );
1965 $check_internal_as_fallback = 1 if $retval == 0;
1967 } elsif ( $cas && $query && $query->param('ticket') ) {
1969 # In case of a CAS authentication, we use the ticket instead of the password
1970 my $ticket = $query->param('ticket');
1971 $query->delete('ticket'); # remove ticket to come back to original URL
1972 my ( $retval, $retcard, $retuserid, $cas_ticket ) = checkpw_cas( $ticket, $query, $type ); # EXTERNAL AUTH
1974 @return = ( $retval, $retcard, $retuserid, $cas_ticket );
1978 $passwd_ok = $retval;
1981 # If we are in a shibboleth session (shibboleth is enabled, and a shibboleth match attribute is present)
1982 # Check for password to asertain whether we want to be testing against shibboleth or another method this
1984 elsif ( $shib && $shib_login && !$password ) {
1986 # In case of a Shibboleth authentication, we expect a shibboleth user attribute
1987 # (defined under shibboleth mapping in koha-conf.xml) to contain the login of the
1988 # shibboleth-authenticated user
1990 # Then, we check if it matches a valid koha user
1992 my ( $retval, $retcard, $retuserid ) = C4::Auth_with_shibboleth::checkpw_shib($shib_login); # EXTERNAL AUTH
1994 @return = ( $retval, $retcard, $retuserid );
1996 $passwd_ok = $retval;
1999 $check_internal_as_fallback = 1;
2003 if ( $check_internal_as_fallback ) {
2004 @return = checkpw_internal( $userid, $password, $no_set_userenv);
2005 $passwd_ok = 1 if $return[0] > 0; # 1 or 2
2010 $patron->update({ login_attempts => 0 });
2011 if( $patron->password_expired ){
2014 } elsif( !$patron->account_locked ) {
2015 $patron->update({ login_attempts => $patron->login_attempts + 1 });
2019 # Optionally log success or failure
2020 if( $patron && $passwd_ok && C4::Context->preference('AuthSuccessLog') ) {
2021 logaction( 'AUTH', 'SUCCESS', $patron->id, "Valid password for $userid", $type );
2022 } elsif( !$passwd_ok && C4::Context->preference('AuthFailureLog') ) {
2023 logaction( 'AUTH', 'FAILURE', $patron ? $patron->id : 0, "Wrong password for $userid", $type );
2029 sub checkpw_internal {
2030 my ( $userid, $password, $no_set_userenv ) = @_;
2032 $password = Encode::encode( 'UTF-8', $password )
2033 if Encode::is_utf8($password);
2035 my $dbh = C4::Context->dbh;
2038 "select password,cardnumber,borrowernumber,userid,firstname,surname,borrowers.branchcode,branches.branchname,flags from borrowers join branches on borrowers.branchcode=branches.branchcode where userid=?"
2040 $sth->execute($userid);
2042 my ( $stored_hash, $cardnumber, $borrowernumber, $userid, $firstname,
2043 $surname, $branchcode, $branchname, $flags )
2046 if ( checkpw_hash( $password, $stored_hash ) ) {
2048 C4::Context->set_userenv( "$borrowernumber", $userid, $cardnumber,
2049 $firstname, $surname, $branchcode, $branchname, $flags ) unless $no_set_userenv;
2050 return 1, $cardnumber, $userid;
2055 "select password,cardnumber,borrowernumber,userid,firstname,surname,borrowers.branchcode,branches.branchname,flags from borrowers join branches on borrowers.branchcode=branches.branchcode where cardnumber=?"
2057 $sth->execute($userid);
2059 my ( $stored_hash, $cardnumber, $borrowernumber, $userid, $firstname,
2060 $surname, $branchcode, $branchname, $flags )
2063 if ( checkpw_hash( $password, $stored_hash ) ) {
2065 C4::Context->set_userenv( $borrowernumber, $userid, $cardnumber,
2066 $firstname, $surname, $branchcode, $branchname, $flags ) unless $no_set_userenv;
2067 return 1, $cardnumber, $userid;
2074 my ( $password, $stored_hash ) = @_;
2076 return if $stored_hash eq '!';
2078 # check what encryption algorithm was implemented: Bcrypt - if the hash starts with '$2' it is Bcrypt else md5
2080 if ( substr( $stored_hash, 0, 2 ) eq '$2' ) {
2081 $hash = hash_password( $password, $stored_hash );
2083 $hash = md5_base64($password);
2085 return $hash eq $stored_hash;
2090 my $authflags = getuserflags($flags, $userid, [$dbh]);
2092 Translates integer flags into permissions strings hash.
2094 C<$flags> is the integer userflags value ( borrowers.userflags )
2095 C<$userid> is the members.userid, used for building subpermissions
2096 C<$authflags> is a hashref of permissions
2103 my $dbh = @_ ? shift : C4::Context->dbh;
2106 # I don't want to do this, but if someone logs in as the database
2107 # user, it would be preferable not to spam them to death with
2108 # numeric warnings. So, we make $flags numeric.
2109 no warnings 'numeric';
2112 my $sth = $dbh->prepare("SELECT bit, flag, defaulton FROM userflags");
2115 while ( my ( $bit, $flag, $defaulton ) = $sth->fetchrow ) {
2116 if ( ( $flags & ( 2**$bit ) ) || $defaulton ) {
2117 $userflags->{$flag} = 1;
2120 $userflags->{$flag} = 0;
2124 # get subpermissions and merge with top-level permissions
2125 my $user_subperms = get_user_subpermissions($userid);
2126 foreach my $module ( keys %$user_subperms ) {
2127 next if $userflags->{$module} == 1; # user already has permission for everything in this module
2128 $userflags->{$module} = $user_subperms->{$module};
2134 =head2 get_user_subpermissions
2136 $user_perm_hashref = get_user_subpermissions($userid);
2138 Given the userid (note, not the borrowernumber) of a staff user,
2139 return a hashref of hashrefs of the specific subpermissions
2140 accorded to the user. An example return is
2144 export_catalog => 1,
2145 import_patrons => 1,
2149 The top-level hash-key is a module or function code from
2150 userflags.flag, while the second-level key is a code
2153 The results of this function do not give a complete picture
2154 of the functions that a staff user can access; it is also
2155 necessary to check borrowers.flags.
2159 sub get_user_subpermissions {
2162 my $dbh = C4::Context->dbh;
2163 my $sth = $dbh->prepare( "SELECT flag, user_permissions.code
2164 FROM user_permissions
2165 JOIN permissions USING (module_bit, code)
2166 JOIN userflags ON (module_bit = bit)
2167 JOIN borrowers USING (borrowernumber)
2168 WHERE userid = ?" );
2169 $sth->execute($userid);
2171 my $user_perms = {};
2172 while ( my $perm = $sth->fetchrow_hashref ) {
2173 $user_perms->{ $perm->{'flag'} }->{ $perm->{'code'} } = 1;
2178 =head2 get_all_subpermissions
2180 my $perm_hashref = get_all_subpermissions();
2182 Returns a hashref of hashrefs defining all specific
2183 permissions currently defined. The return value
2184 has the same structure as that of C<get_user_subpermissions>,
2185 except that the innermost hash value is the description
2186 of the subpermission.
2190 sub get_all_subpermissions {
2191 my $dbh = C4::Context->dbh;
2192 my $sth = $dbh->prepare( "SELECT flag, code
2194 JOIN userflags ON (module_bit = bit)" );
2198 while ( my $perm = $sth->fetchrow_hashref ) {
2199 $all_perms->{ $perm->{'flag'} }->{ $perm->{'code'} } = 1;
2204 =head2 get_cataloguing_page_permissions
2206 my $required_permissions = get_cataloguing_page_permissions();
2208 Returns the required permissions to access the main cataloguing page. Useful for building
2209 the global I<can_see_cataloguing_module> template variable, and also for reusing in
2210 I<cataloging-home.pl>.
2214 sub get_cataloguing_page_permissions {
2216 my @cataloguing_tools_subperms = qw(
2223 marc_modification_templates
2231 { editcatalogue => '*' }, { tools => \@cataloguing_tools_subperms },
2232 C4::Context->preference('StockRotation') ? { stockrotation => 'manage_rotas' } : ()
2236 =head2 haspermission
2238 $flagsrequired = '*'; # Any permission at all
2239 $flagsrequired = 'a_flag'; # a_flag must be satisfied (all subpermissions)
2240 $flagsrequired = [ 'a_flag', 'b_flag' ]; # a_flag OR b_flag must be satisfied
2241 $flagsrequired = { 'a_flag => 1, 'b_flag' => 1 }; # a_flag AND b_flag must be satisfied
2242 $flagsrequired = { 'a_flag' => 'sub_a' }; # sub_a of a_flag must be satisfied
2243 $flagsrequired = { 'a_flag' => [ 'sub_a, 'sub_b' ] }; # sub_a OR sub_b of a_flag must be satisfied
2245 $flags = ($userid, $flagsrequired);
2247 C<$userid> the userid of the member
2248 C<$flags> is a query structure similar to that used by SQL::Abstract that
2249 denotes the combination of flags required. It is a required parameter.
2251 The main logic of this method is that things in arrays are OR'ed, and things
2252 in hashes are AND'ed. The `*` character can be used, at any depth, to denote `ANY`
2254 Returns member's flags or 0 if a permission is not met.
2259 my ($required, $flags) = @_;
2261 my $ref = ref($required);
2263 if ($required eq '*') {
2264 return 0 unless ( $flags or ref( $flags ) );
2266 return 0 unless ( $flags and (!ref( $flags ) || $flags->{$required} ));
2268 } elsif ($ref eq 'HASH') {
2269 foreach my $key (keys %{$required}) {
2270 next if $flags == 1;
2271 my $require = $required->{$key};
2272 my $rflags = $flags->{$key};
2273 return 0 unless _dispatch($require, $rflags);
2275 } elsif ($ref eq 'ARRAY') {
2277 foreach my $require ( @{$required} ) {
2279 ( ref($flags) && !ref($require) && ( $require ne '*' ) )
2280 ? $flags->{$require}
2282 $satisfied++ if _dispatch( $require, $rflags );
2284 return 0 unless $satisfied;
2286 croak "Unexpected structure found: $ref";
2293 my ( $userid, $flagsrequired ) = @_;
2295 #Koha::Exceptions::WrongParameter->throw('$flagsrequired should not be undef')
2296 # unless defined($flagsrequired);
2298 my $sth = C4::Context->dbh->prepare("SELECT flags FROM borrowers WHERE userid=?");
2299 $sth->execute($userid);
2300 my $row = $sth->fetchrow();
2301 my $flags = getuserflags( $row, $userid );
2303 return $flags unless defined($flagsrequired);
2304 return $flags if $flags->{superlibrarian};
2305 return _dispatch($flagsrequired, $flags);
2307 #FIXME - This fcn should return the failed permission so a suitable error msg can be delivered.
2312 $flags = ($iprange);
2314 C<$iprange> A space separated string describing an IP range. Can include single IPs or ranges
2316 Returns 1 if the remote address is in the provided iprange, or 0 otherwise.
2323 my @allowedipranges = $iprange ? split(' ', $iprange) : ();
2324 if (scalar @allowedipranges > 0) {
2326 eval { @rangelist = Net::CIDR::range2cidr(@allowedipranges); }; return 0 if $@;
2327 eval { $result = Net::CIDR::cidrlookup($ENV{'REMOTE_ADDR'}, @rangelist) } || Koha::Logger->get->warn('cidrlookup failed for ' . join(' ',@rangelist) );
2329 return $result ? 1 : 0;
2332 sub getborrowernumber {
2334 my $userenv = C4::Context->userenv;
2335 if ( defined($userenv) && ref($userenv) eq 'HASH' && $userenv->{number} ) {
2336 return $userenv->{number};
2338 my $dbh = C4::Context->dbh;
2339 for my $field ( 'userid', 'cardnumber' ) {
2341 $dbh->prepare("select borrowernumber from borrowers where $field=?");
2342 $sth->execute($userid);
2344 my ($bnumber) = $sth->fetchrow;
2351 =head2 track_login_daily
2353 track_login_daily( $userid );
2355 Wraps the call to $patron->track_login, the method used to update borrowers.lastseen. We only call track_login once a day.
2359 sub track_login_daily {
2361 return if !$userid || !C4::Context->preference('TrackLastPatronActivity');
2363 my $cache = Koha::Caches->get_instance();
2364 my $cache_key = "track_login_" . $userid;
2365 my $cached = $cache->get_from_cache($cache_key);
2366 my $today = dt_from_string()->ymd;
2367 return if $cached && $cached eq $today;
2369 my $patron = Koha::Patrons->find({ userid => $userid });
2370 return unless $patron;
2371 $patron->track_login;
2372 $cache->set_in_cache( $cache_key, $today );
2375 END { } # module clean-up code here (global destructor)
2385 Crypt::Eksblowfish::Bcrypt(3)