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 );
39 use Koha::DateUtils qw( dt_from_string );
40 use Koha::Library::Groups;
42 use Koha::Cash::Registers;
45 use Koha::Patron::Consents;
46 use List::MoreUtils qw( any );
48 use C4::Auth_with_shibboleth qw( shib_ok get_login_shib login_shib_url logout_shib checkpw_shib );
50 use C4::Log qw( logaction );
54 use vars qw($ldap $cas $caslogout);
55 our (@ISA, @EXPORT_OK);
57 sub psgi_env { any { /^psgi\./ } keys %ENV }
60 if (psgi_env) { die 'psgi:exit' }
64 C4::Context->set_remote_address;
70 checkauth check_api_auth get_session check_cookie_auth checkpw checkpw_internal checkpw_hash
71 get_all_subpermissions get_user_subpermissions track_login_daily in_iprange
72 get_template_and_user haspermission
75 $ldap = C4::Context->config('useldapserver') || 0;
76 $cas = C4::Context->preference('casAuthentication');
77 $caslogout = C4::Context->preference('casLogout');
80 require C4::Auth_with_ldap;
81 import C4::Auth_with_ldap qw(checkpw_ldap);
84 require C4::Auth_with_cas; # no import
85 import C4::Auth_with_cas qw(check_api_auth_cas checkpw_cas login_cas logout_cas login_cas_url logout_if_required multipleAuth getMultipleAuth);
92 C4::Auth - Authenticates Koha users
100 my $query = CGI->new;
102 my ($template, $borrowernumber, $cookie)
103 = get_template_and_user(
105 template_name => "opac-main.tt",
108 authnotrequired => 0,
109 flagsrequired => { catalogue => '*', tools => 'import_patrons' },
113 output_html_with_http_headers $query, $cookie, $template->output;
117 The main function of this module is to provide
118 authentification. However the get_template_and_user function has
119 been provided so that a users login information is passed along
120 automatically. This gets loaded into the template.
124 =head2 get_template_and_user
126 my ($template, $borrowernumber, $cookie)
127 = get_template_and_user(
129 template_name => "opac-main.tt",
132 authnotrequired => 0,
133 flagsrequired => { catalogue => '*', tools => 'import_patrons' },
137 This call passes the C<query>, C<flagsrequired> and C<authnotrequired>
138 to C<&checkauth> (in this module) to perform authentification.
139 See C<&checkauth> for an explanation of these parameters.
141 The C<template_name> is then used to find the correct template for
142 the page. The authenticated users details are loaded onto the
143 template in the logged_in_user variable (which is a Koha::Patron object). Also the
144 C<sessionID> is passed to the template. This can be used in templates
145 if cookies are disabled. It needs to be put as and input to every
148 More information on the C<gettemplate> sub can be found in the
153 sub get_template_and_user {
156 my ( $user, $cookie, $sessionID, $flags );
159 # Get shibboleth login attribute
160 my $shib = C4::Context->config('useshibboleth') && shib_ok();
161 my $shib_login = $shib ? get_login_shib() : undef;
163 C4::Context->interface( $in->{type} );
165 $in->{'authnotrequired'} ||= 0;
167 # the following call includes a bad template check; might croak
168 my $template = C4::Templates::gettemplate(
169 $in->{'template_name'},
174 if ( $in->{'template_name'} !~ m/maintenance/ ) {
175 ( $user, $cookie, $sessionID, $flags ) = checkauth(
177 $in->{'authnotrequired'},
178 $in->{'flagsrequired'},
181 $in->{template_name},
185 # If we enforce GDPR and the user did not consent, redirect
186 # Exceptions for consent page itself and SCI/SCO system
187 if( $in->{type} eq 'opac' && $user &&
188 $in->{'template_name'} !~ /^(opac-patron-consent|sc[io]\/)/ &&
189 C4::Context->preference('GDPR_Policy') eq 'Enforced' )
191 my $consent = Koha::Patron::Consents->search({
192 borrowernumber => getborrowernumber($user),
193 type => 'GDPR_PROCESSING',
194 given_on => { '!=', undef },
197 print $in->{query}->redirect(-uri => '/cgi-bin/koha/opac-patron-consent.pl', -cookie => $cookie);
202 if ( $in->{type} eq 'opac' && $user ) {
205 my $session = get_session($sessionID);
207 $is_sco_user = $session->param('sco_user');
213 # If the user logged in is the SCO user and they try to go out of the SCO module,
214 # log the user out removing the CGISESSID cookie
215 $in->{template_name} !~ m|sco/| && $in->{template_name} !~ m|errors/errorpage.tt|
219 C4::Context->preference('AutoSelfCheckID')
220 && $user eq C4::Context->preference('AutoSelfCheckID')
228 # If the user logged in is the SCI user and they try to go out of the SCI module,
229 # kick them out unless it is SCO with a valid permission
230 # or they are a superlibrarian
231 $in->{template_name} !~ m|sci/|
232 && haspermission( $user, { self_check => 'self_checkin_module' } )
234 $in->{template_name} =~ m|sco/| && haspermission(
235 $user, { self_check => 'self_checkout_module' }
238 && $flags && $flags->{superlibrarian} != 1
245 $template = C4::Templates::gettemplate( 'opac-auth.tt', 'opac',
247 push @$cookie, $in->{query}->cookie(
248 -name => 'CGISESSID',
252 -secure => ( C4::Context->https_enabled() ? 1 : 0 ),
257 script_name => get_script_name(),
260 print $in->{query}->header(
265 'X-Frame-Options' => 'SAMEORIGIN'
276 # It's possible for $user to be the borrowernumber if they don't have a
277 # userid defined (and are logging in through some other method, such
278 # as SSL certs against an email address)
280 $borrowernumber = getborrowernumber($user) if defined($user);
281 if ( !defined($borrowernumber) && defined($user) ) {
282 $patron = Koha::Patrons->find( $user );
284 $borrowernumber = $user;
286 # A bit of a hack, but I don't know there's a nicer way
288 $user = $patron->firstname . ' ' . $patron->surname;
291 $patron = Koha::Patrons->find( $borrowernumber );
292 # FIXME What to do if $patron does not exist?
296 $template->param( loggedinusername => $user ); # OBSOLETE - Do not reuse this in template, use logged_in_user.userid instead
297 $template->param( loggedinusernumber => $borrowernumber ); # FIXME Should be replaced with logged_in_user.borrowernumber
298 $template->param( logged_in_user => $patron );
299 $template->param( sessionID => $sessionID );
301 if ( $in->{'type'} eq 'opac' ) {
302 require Koha::Virtualshelves;
303 my $some_private_shelves = Koha::Virtualshelves->get_some_shelves(
305 borrowernumber => $borrowernumber,
309 my $some_public_shelves = Koha::Virtualshelves->get_some_shelves(
315 some_private_shelves => $some_private_shelves,
316 some_public_shelves => $some_public_shelves,
320 my $all_perms = get_all_subpermissions();
322 my @flagroots = qw(circulate catalogue parameters borrowers permissions reserveforothers borrow
323 editcatalogue updatecharges tools editauthorities serials reports acquisition clubs problem_reports);
325 # We are going to use the $flags returned by checkauth
326 # to create the template's parameters that will indicate
327 # which menus the user can access.
328 if ( $flags && $flags->{superlibrarian} == 1 ) {
329 $template->param( CAN_user_circulate => 1 );
330 $template->param( CAN_user_catalogue => 1 );
331 $template->param( CAN_user_parameters => 1 );
332 $template->param( CAN_user_borrowers => 1 );
333 $template->param( CAN_user_permissions => 1 );
334 $template->param( CAN_user_reserveforothers => 1 );
335 $template->param( CAN_user_editcatalogue => 1 );
336 $template->param( CAN_user_updatecharges => 1 );
337 $template->param( CAN_user_acquisition => 1 );
338 $template->param( CAN_user_suggestions => 1 );
339 $template->param( CAN_user_tools => 1 );
340 $template->param( CAN_user_editauthorities => 1 );
341 $template->param( CAN_user_serials => 1 );
342 $template->param( CAN_user_reports => 1 );
343 $template->param( CAN_user_staffaccess => 1 );
344 $template->param( CAN_user_coursereserves => 1 );
345 $template->param( CAN_user_plugins => 1 );
346 $template->param( CAN_user_lists => 1 );
347 $template->param( CAN_user_clubs => 1 );
348 $template->param( CAN_user_ill => 1 );
349 $template->param( CAN_user_stockrotation => 1 );
350 $template->param( CAN_user_cash_management => 1 );
351 $template->param( CAN_user_problem_reports => 1 );
352 $template->param( CAN_user_recalls => 1 );
354 foreach my $module ( keys %$all_perms ) {
355 foreach my $subperm ( keys %{ $all_perms->{$module} } ) {
356 $template->param( "CAN_user_${module}_${subperm}" => 1 );
362 foreach my $module ( keys %$all_perms ) {
363 if ( defined($flags->{$module}) && $flags->{$module} == 1 ) {
364 foreach my $subperm ( keys %{ $all_perms->{$module} } ) {
365 $template->param( "CAN_user_${module}_${subperm}" => 1 );
367 } elsif ( ref( $flags->{$module} ) ) {
368 foreach my $subperm ( keys %{ $flags->{$module} } ) {
369 $template->param( "CAN_user_${module}_${subperm}" => 1 );
376 foreach my $module ( keys %$flags ) {
377 if ( $flags->{$module} == 1 or ref( $flags->{$module} ) ) {
378 $template->param( "CAN_user_$module" => 1 );
383 # Logged-in opac search history
384 # If the requested template is an opac one and opac search history is enabled
385 if ( $in->{type} eq 'opac' && C4::Context->preference('EnableOpacSearchHistory') ) {
386 my $dbh = C4::Context->dbh;
387 my $query = "SELECT COUNT(*) FROM search_history WHERE userid=?";
388 my $sth = $dbh->prepare($query);
389 $sth->execute($borrowernumber);
391 # If at least one search has already been performed
392 if ( $sth->fetchrow_array > 0 ) {
394 # We show the link in opac
395 $template->param( EnableOpacSearchHistory => 1 );
397 if (C4::Context->preference('LoadSearchHistoryToTheFirstLoggedUser'))
399 # And if there are searches performed when the user was not logged in,
400 # we add them to the logged-in search history
401 my @recentSearches = C4::Search::History::get_from_session( { cgi => $in->{'query'} } );
402 if (@recentSearches) {
403 my $dbh = C4::Context->dbh;
405 INSERT INTO search_history(userid, sessionid, query_desc, query_cgi, type, total, time )
406 VALUES (?, ?, ?, ?, ?, ?, ?)
408 my $sth = $dbh->prepare($query);
409 $sth->execute( $borrowernumber,
410 $in->{query}->cookie("CGISESSID"),
413 $_->{type} || 'biblio',
416 ) foreach @recentSearches;
418 # clear out the search history from the session now that
419 # we've saved it to the database
422 C4::Search::History::set_to_session( { cgi => $in->{'query'}, search_history => [] } );
424 } elsif ( $in->{type} eq 'intranet' and C4::Context->preference('EnableSearchHistory') ) {
425 $template->param( EnableSearchHistory => 1 );
428 else { # if this is an anonymous session, setup to display public lists...
430 # If shibboleth is enabled, and we're in an anonymous session, we should allow
431 # the user to attempt login via shibboleth.
433 $template->param( shibbolethAuthentication => $shib,
434 shibbolethLoginUrl => login_shib_url( $in->{'query'} ),
437 # If shibboleth is enabled and we have a shibboleth login attribute,
438 # but we are in an anonymous session, then we clearly have an invalid
439 # shibboleth koha account.
441 $template->param( invalidShibLogin => '1' );
445 $template->param( sessionID => $sessionID );
447 if ( $in->{'type'} eq 'opac' ){
448 require Koha::Virtualshelves;
449 my $some_public_shelves = Koha::Virtualshelves->get_some_shelves(
455 some_public_shelves => $some_public_shelves,
458 # Set default branch if one has been passed by the environment.
459 $template->param( default_branch => $ENV{OPAC_BRANCH_DEFAULT} ) if $ENV{OPAC_BRANCH_DEFAULT};
463 # Sysprefs disabled via URL param
464 # Note that value must be defined in order to override via ENV
465 foreach my $syspref (
471 OpacAdditionalStylesheet
473 intranetcolorstylesheet
478 $ENV{"OVERRIDE_SYSPREF_$syspref"} = q{}
479 if $in->{'query'}->param("DISABLE_SYSPREF_$syspref");
482 # Anonymous opac search history
483 # If opac search history is enabled and at least one search has already been performed
484 if ( C4::Context->preference('EnableOpacSearchHistory') ) {
485 my @recentSearches = C4::Search::History::get_from_session( { cgi => $in->{'query'} } );
486 if (@recentSearches) {
487 $template->param( EnableOpacSearchHistory => 1 );
491 if ( C4::Context->preference('dateformat') ) {
492 $template->param( dateformat => C4::Context->preference('dateformat') );
495 $template->param(auth_forwarded_hash => scalar $in->{'query'}->param('auth_forwarded_hash'));
497 # these template parameters are set the same regardless of $in->{'type'}
499 my $minPasswordLength = C4::Context->preference('minPasswordLength');
500 $minPasswordLength = 3 if not $minPasswordLength or $minPasswordLength < 3;
502 EnhancedMessagingPreferences => C4::Context->preference('EnhancedMessagingPreferences'),
503 GoogleJackets => C4::Context->preference("GoogleJackets"),
504 OpenLibraryCovers => C4::Context->preference("OpenLibraryCovers"),
505 KohaAdminEmailAddress => "" . C4::Context->preference("KohaAdminEmailAddress"),
506 LoginFirstname => ( C4::Context->userenv ? C4::Context->userenv->{"firstname"} : "Bel" ),
507 LoginSurname => C4::Context->userenv ? C4::Context->userenv->{"surname"} : "Inconnu",
508 emailaddress => C4::Context->userenv ? C4::Context->userenv->{"emailaddress"} : undef,
509 TagsEnabled => C4::Context->preference("TagsEnabled"),
510 hide_marc => C4::Context->preference("hide_marc"),
511 item_level_itypes => C4::Context->preference('item-level_itypes'),
512 patronimages => C4::Context->preference("patronimages"),
513 singleBranchMode => ( Koha::Libraries->search->count == 1 ),
514 noItemTypeImages => C4::Context->preference("noItemTypeImages"),
515 marcflavour => C4::Context->preference("marcflavour"),
516 OPACBaseURL => C4::Context->preference('OPACBaseURL'),
517 minPasswordLength => $minPasswordLength,
519 if ( $in->{'type'} eq "intranet" ) {
521 AmazonCoverImages => C4::Context->preference("AmazonCoverImages"),
522 AutoLocation => C4::Context->preference("AutoLocation"),
523 PatronAutoComplete => C4::Context->preference("PatronAutoComplete"),
524 FRBRizeEditions => C4::Context->preference("FRBRizeEditions"),
525 IndependentBranches => C4::Context->preference("IndependentBranches"),
526 IntranetNav => C4::Context->preference("IntranetNav"),
527 IntranetmainUserblock => C4::Context->preference("IntranetmainUserblock"),
528 LibraryName => C4::Context->preference("LibraryName"),
529 advancedMARCEditor => C4::Context->preference("advancedMARCEditor"),
530 canreservefromotherbranches => C4::Context->preference('canreservefromotherbranches'),
531 intranetcolorstylesheet => C4::Context->preference("intranetcolorstylesheet"),
532 IntranetFavicon => C4::Context->preference("IntranetFavicon"),
533 intranetreadinghistory => C4::Context->preference("intranetreadinghistory"),
534 intranetstylesheet => C4::Context->preference("intranetstylesheet"),
535 IntranetUserCSS => C4::Context->preference("IntranetUserCSS"),
536 IntranetUserJS => C4::Context->preference("IntranetUserJS"),
537 suggestion => C4::Context->preference("suggestion"),
538 virtualshelves => C4::Context->preference("virtualshelves"),
539 StaffSerialIssueDisplayCount => C4::Context->preference("StaffSerialIssueDisplayCount"),
540 EasyAnalyticalRecords => C4::Context->preference('EasyAnalyticalRecords'),
541 LocalCoverImages => C4::Context->preference('LocalCoverImages'),
542 OPACLocalCoverImages => C4::Context->preference('OPACLocalCoverImages'),
543 AllowMultipleCovers => C4::Context->preference('AllowMultipleCovers'),
544 EnableBorrowerFiles => C4::Context->preference('EnableBorrowerFiles'),
545 UseCourseReserves => C4::Context->preference("UseCourseReserves"),
546 useDischarge => C4::Context->preference('useDischarge'),
547 pending_checkout_notes => Koha::Checkouts->search({ noteseen => 0 }),
551 warn "template type should be OPAC, here it is=[" . $in->{'type'} . "]" unless ( $in->{'type'} eq 'opac' );
553 #TODO : replace LibraryName syspref with 'system name', and remove this html processing
554 my $LibraryNameTitle = C4::Context->preference("LibraryName");
555 $LibraryNameTitle =~ s/<(?:\/?)(?:br|p)\s*(?:\/?)>/ /sgi;
556 $LibraryNameTitle =~ s/<(?:[^<>'"]|'(?:[^']*)'|"(?:[^"]*)")*>//sg;
558 # clean up the busc param in the session
559 # if the page is not opac-detail and not the "add to list" page
560 # and not the "edit comments" page
561 if ( C4::Context->preference("OpacBrowseResults")
562 && $in->{'template_name'} =~ /opac-(.+)\.(?:tt|tmpl)$/ ) {
564 unless ( $pagename =~ /^(?:MARC|ISBD)?detail$/
565 or $pagename =~ /^showmarc$/
566 or $pagename =~ /^addbybiblionumber$/
567 or $pagename =~ /^review$/ )
569 my $sessionSearch = get_session( $sessionID );
570 $sessionSearch->clear( ["busc"] ) if $sessionSearch;
574 # variables passed from CGI: opac_css_override and opac_search_limits.
575 my $opac_search_limit = $ENV{'OPAC_SEARCH_LIMIT'};
576 my $opac_limit_override = $ENV{'OPAC_LIMIT_OVERRIDE'};
579 ( $opac_limit_override && $opac_search_limit && $opac_search_limit =~ /branch:([\w-]+)/ ) ||
580 ( $in->{'query'}->param('limit') && $in->{'query'}->param('limit') =~ /branch:([\w-]+)/ ) ||
581 ( $in->{'query'}->param('limit') && $in->{'query'}->param('limit') =~ /multibranchlimit:(\w+)/ )
583 $opac_name = $1; # opac_search_limit is a branch, so we use it.
584 } elsif ( $in->{'query'}->param('multibranchlimit') ) {
585 $opac_name = $in->{'query'}->param('multibranchlimit');
586 } elsif ( C4::Context->preference("SearchMyLibraryFirst") && C4::Context->userenv && C4::Context->userenv->{'branch'} ) {
587 $opac_name = C4::Context->userenv->{'branch'};
590 my @search_groups = Koha::Library::Groups->get_search_groups({ interface => 'opac' })->as_list;
592 AnonSuggestions => "" . C4::Context->preference("AnonSuggestions"),
593 LibrarySearchGroups => \@search_groups,
594 opac_name => $opac_name,
595 LibraryName => "" . C4::Context->preference("LibraryName"),
596 LibraryNameTitle => "" . $LibraryNameTitle,
597 OPACAmazonCoverImages => C4::Context->preference("OPACAmazonCoverImages"),
598 OPACFRBRizeEditions => C4::Context->preference("OPACFRBRizeEditions"),
599 OpacHighlightedWords => C4::Context->preference("OpacHighlightedWords"),
600 OPACShelfBrowser => "" . C4::Context->preference("OPACShelfBrowser"),
601 OPACURLOpenInNewWindow => "" . C4::Context->preference("OPACURLOpenInNewWindow"),
602 OPACUserCSS => "" . C4::Context->preference("OPACUserCSS"),
603 OpacAuthorities => C4::Context->preference("OpacAuthorities"),
604 opac_css_override => $ENV{'OPAC_CSS_OVERRIDE'},
605 opac_search_limit => $opac_search_limit,
606 opac_limit_override => $opac_limit_override,
607 OpacBrowser => C4::Context->preference("OpacBrowser"),
608 OpacCloud => C4::Context->preference("OpacCloud"),
609 OpacKohaUrl => C4::Context->preference("OpacKohaUrl"),
610 OpacPasswordChange => C4::Context->preference("OpacPasswordChange"),
611 OPACPatronDetails => C4::Context->preference("OPACPatronDetails"),
612 OPACPrivacy => C4::Context->preference("OPACPrivacy"),
613 OPACFinesTab => C4::Context->preference("OPACFinesTab"),
614 OpacTopissue => C4::Context->preference("OpacTopissue"),
615 'Version' => C4::Context->preference('Version'),
616 hidelostitems => C4::Context->preference("hidelostitems"),
617 mylibraryfirst => ( C4::Context->preference("SearchMyLibraryFirst") && C4::Context->userenv ) ? C4::Context->userenv->{'branch'} : '',
618 opacbookbag => "" . C4::Context->preference("opacbookbag"),
619 OpacFavicon => C4::Context->preference("OpacFavicon"),
620 opaclanguagesdisplay => "" . C4::Context->preference("opaclanguagesdisplay"),
621 opacreadinghistory => C4::Context->preference("opacreadinghistory"),
622 OPACUserJS => C4::Context->preference("OPACUserJS"),
623 opacuserlogin => "" . C4::Context->preference("opacuserlogin"),
624 OpenLibrarySearch => C4::Context->preference("OpenLibrarySearch"),
625 ShowReviewer => C4::Context->preference("ShowReviewer"),
626 ShowReviewerPhoto => C4::Context->preference("ShowReviewerPhoto"),
627 suggestion => "" . C4::Context->preference("suggestion"),
628 virtualshelves => "" . C4::Context->preference("virtualshelves"),
629 OPACSerialIssueDisplayCount => C4::Context->preference("OPACSerialIssueDisplayCount"),
630 SyndeticsClientCode => C4::Context->preference("SyndeticsClientCode"),
631 SyndeticsEnabled => C4::Context->preference("SyndeticsEnabled"),
632 SyndeticsCoverImages => C4::Context->preference("SyndeticsCoverImages"),
633 SyndeticsTOC => C4::Context->preference("SyndeticsTOC"),
634 SyndeticsSummary => C4::Context->preference("SyndeticsSummary"),
635 SyndeticsEditions => C4::Context->preference("SyndeticsEditions"),
636 SyndeticsExcerpt => C4::Context->preference("SyndeticsExcerpt"),
637 SyndeticsReviews => C4::Context->preference("SyndeticsReviews"),
638 SyndeticsAuthorNotes => C4::Context->preference("SyndeticsAuthorNotes"),
639 SyndeticsAwards => C4::Context->preference("SyndeticsAwards"),
640 SyndeticsSeries => C4::Context->preference("SyndeticsSeries"),
641 SyndeticsCoverImageSize => C4::Context->preference("SyndeticsCoverImageSize"),
642 OPACLocalCoverImages => C4::Context->preference("OPACLocalCoverImages"),
643 PatronSelfRegistration => C4::Context->preference("PatronSelfRegistration"),
644 PatronSelfRegistrationDefaultCategory => C4::Context->preference("PatronSelfRegistrationDefaultCategory"),
645 useDischarge => C4::Context->preference('useDischarge'),
648 $template->param( OpacPublic => '1' ) if ( $user || C4::Context->preference("OpacPublic") );
651 # Check if we were asked using parameters to force a specific language
652 if ( defined $in->{'query'}->param('language') ) {
654 # Extract the language, let C4::Languages::getlanguage choose
656 my $language = C4::Languages::getlanguage( $in->{'query'} );
657 my $languagecookie = C4::Templates::getlanguagecookie( $in->{'query'}, $language );
658 push @{$cookie}, $languagecookie;
661 return ( $template, $borrowernumber, $cookie, $flags );
666 ($userid, $cookie, $sessionID) = &checkauth($query, $noauth, $flagsrequired, $type);
668 Verifies that the user is authorized to run this script. If
669 the user is authorized, a (userid, cookie, session-id, flags)
670 quadruple is returned. If the user is not authorized but does
671 not have the required privilege (see $flagsrequired below), it
672 displays an error page and exits. Otherwise, it displays the
673 login page and exits.
675 Note that C<&checkauth> will return if and only if the user
676 is authorized, so it should be called early on, before any
677 unfinished operations (e.g., if you've opened a file, then
678 C<&checkauth> won't close it for you).
680 C<$query> is the CGI object for the script calling C<&checkauth>.
682 The C<$noauth> argument is optional. If it is set, then no
683 authorization is required for the script.
685 C<&checkauth> fetches user and session information from C<$query> and
686 ensures that the user is authorized to run scripts that require
689 The C<$flagsrequired> argument specifies the required privileges
690 the user must have if the username and password are correct.
691 It should be specified as a reference-to-hash; keys in the hash
692 should be the "flags" for the user, as specified in the Members
693 intranet module. Any key specified must correspond to a "flag"
694 in the userflags table. E.g., { circulate => 1 } would specify
695 that the user must have the "circulate" privilege in order to
696 proceed. To make sure that access control is correct, the
697 C<$flagsrequired> parameter must be specified correctly.
699 Koha also has a concept of sub-permissions, also known as
700 granular permissions. This makes the value of each key
701 in the C<flagsrequired> hash take on an additional
706 The user must have access to all subfunctions of the module
707 specified by the hash key.
711 The user must have access to at least one subfunction of the module
712 specified by the hash key.
714 specific permission, e.g., 'export_catalog'
716 The user must have access to the specific subfunction list, which
717 must correspond to a row in the permissions table.
719 The C<$type> argument specifies whether the template should be
720 retrieved from the opac or intranet directory tree. "opac" is
721 assumed if it is not specified; however, if C<$type> is specified,
722 "intranet" is assumed if it is not "opac".
724 If C<$query> does not have a valid session ID associated with it
725 (i.e., the user has not logged in) or if the session has expired,
726 C<&checkauth> presents the user with a login page (from the point of
727 view of the original script, C<&checkauth> does not return). Once the
728 user has authenticated, C<&checkauth> restarts the original script
729 (this time, C<&checkauth> returns).
731 The login page is provided using a HTML::Template, which is set in the
732 systempreferences table or at the top of this file. The variable C<$type>
733 selects which template to use, either the opac or the intranet
734 authentification template.
736 C<&checkauth> returns a user ID, a cookie, and a session ID. The
737 cookie should be sent back to the browser; it verifies that the user
747 # If version syspref is unavailable, it means Koha is being installed,
748 # and so we must redirect to OPAC maintenance page or to the WebInstaller
749 # also, if OpacMaintenance is ON, OPAC should redirect to maintenance
750 if ( C4::Context->preference('OpacMaintenance') && $type eq 'opac' ) {
751 warn "OPAC Install required, redirecting to maintenance";
752 print $query->redirect("/cgi-bin/koha/maintenance.pl");
755 unless ( $version = C4::Context->preference('Version') ) { # assignment, not comparison
756 if ( $type ne 'opac' ) {
757 warn "Install required, redirecting to Installer";
758 print $query->redirect("/cgi-bin/koha/installer/install.pl");
760 warn "OPAC Install required, redirecting to maintenance";
761 print $query->redirect("/cgi-bin/koha/maintenance.pl");
766 # check that database and koha version are the same
767 # there is no DB version, it's a fresh install,
768 # go to web installer
769 # there is a DB version, compare it to the code version
770 my $kohaversion = Koha::version();
772 # remove the 3 last . to have a Perl number
773 $kohaversion =~ s/(.*\..*)\.(.*)\.(.*)/$1$2$3/;
774 Koha::Logger->get->debug("kohaversion : $kohaversion");
775 if ( $version < $kohaversion ) {
776 my $warning = "Database update needed, redirecting to %s. Database is $version and Koha is $kohaversion";
777 if ( $type ne 'opac' ) {
778 warn sprintf( $warning, 'Installer' );
779 print $query->redirect("/cgi-bin/koha/installer/install.pl?step=1&op=updatestructure");
781 warn sprintf( "OPAC: " . $warning, 'maintenance' );
782 print $query->redirect("/cgi-bin/koha/maintenance.pl");
788 sub _timeout_syspref {
789 my $default_timeout = 600;
790 my $timeout = C4::Context->preference('timeout') || $default_timeout;
792 # value in days, convert in seconds
793 if ( $timeout =~ /^(\d+)[dD]$/ ) {
794 $timeout = $1 * 86400;
796 # value in hours, convert in seconds
797 elsif ( $timeout =~ /^(\d+)[hH]$/ ) {
798 $timeout = $1 * 3600;
800 elsif ( $timeout !~ m/^\d+$/ ) {
801 warn "The value of the system preference 'timeout' is not correct, defaulting to $default_timeout";
802 $timeout = $default_timeout;
808 sub clear_all_cookies {
809 my ( $query ) = shift;
811 for my $cookie_name ( $query->cookie ) {
812 push @cookies, $query->cookie( -name => $cookie_name, -value => '', -expires => '', -HttpOnly => 1 );
820 # Get shibboleth login attribute
821 my $shib = C4::Context->config('useshibboleth') && shib_ok();
822 my $shib_login = $shib ? get_login_shib() : undef;
824 # $authnotrequired will be set for scripts which will run without authentication
825 my $authnotrequired = shift;
826 my $flagsrequired = shift;
828 my $emailaddress = shift;
829 my $template_name = shift;
830 $type = 'opac' unless $type;
832 unless ( C4::Context->preference("OpacPublic") ) {
833 my @allowed_scripts_for_private_opac = qw(
835 opac-registration-email-sent.tt
836 opac-registration-confirmation.tt
837 opac-memberentry-update-submitted.tt
838 opac-password-recovery.tt
840 $authnotrequired = 0 unless grep { $_ eq $template_name }
841 @allowed_scripts_for_private_opac;
844 my $dbh = C4::Context->dbh;
845 my $timeout = _timeout_syspref();
847 _version_check( $type, $query );
852 my ( $userid, $cookie, $sessionID, $flags );
854 my $logout = $query->param('logout.x');
856 my $anon_search_history;
858 # This parameter is the name of the CAS server we want to authenticate against,
859 # when using authentication against multiple CAS servers, as configured in Auth_cas_servers.yaml
860 my $casparam = $query->param('cas');
861 my $q_userid = $query->param('userid') // '';
865 # Basic authentication is incompatible with the use of Shibboleth,
866 # as Shibboleth may return REMOTE_USER as a Shibboleth attribute,
867 # and it may not be the attribute we want to use to match the koha login.
869 # Also, do not consider an empty REMOTE_USER.
871 # Finally, after those tests, we can assume (although if it would be better with
872 # a syspref) that if we get a REMOTE_USER, that's from basic authentication,
873 # and we can affect it to $userid.
874 if ( !$shib and defined( $ENV{'REMOTE_USER'} ) and $ENV{'REMOTE_USER'} ne '' and $userid = $ENV{'REMOTE_USER'} ) {
876 # Using Basic Authentication, no cookies required
877 push @$cookie, $query->cookie(
878 -name => 'CGISESSID',
882 -secure => ( C4::Context->https_enabled() ? 1 : 0 ),
886 elsif ( $emailaddress) {
887 # the Google OpenID Connect passes an email address
889 elsif ( $sessionID = $query->cookie("CGISESSID") ) { # assignment, not comparison
890 my ( $return, $more_info );
891 # NOTE: $flags in the following call is still undefined !
892 ( $return, $session, $more_info ) = check_cookie_auth( $sessionID, $flags,
893 { remote_addr => $ENV{REMOTE_ADDR}, skip_version_check => 1 }
896 if ( $return eq 'ok' ) {
897 Koha::Logger->get->debug(sprintf "AUTH_SESSION: (%s)\t%s %s - %s", map { $session->param($_) || q{} } qw(cardnumber firstname surname branch));
899 my $s_userid = $session->param('id');
902 if ( ( $query->param('koha_login_context') && ( $q_userid ne $s_userid ) )
903 || ( $cas && $query->param('ticket') && !C4::Context->userenv->{'id'} )
904 || ( $shib && $shib_login && !$logout && !C4::Context->userenv->{'id'} )
907 #if a user enters an id ne to the id in the current session, we need to log them in...
908 #first we need to clear the anonymous session...
909 $anon_search_history = $session->param('search_history');
912 C4::Context::_unset_userenv($sessionID);
917 # voluntary logout the user
918 # check wether the user was using their shibboleth session or a local one
919 my $shibSuccess = C4::Context->userenv->{'shibboleth'};
922 $cookie = clear_all_cookies($query);
923 C4::Context::_unset_userenv($sessionID);
926 if ($cas and $caslogout) {
927 logout_cas($query, $type);
930 # If we are in a shibboleth session (shibboleth is enabled, a shibboleth match attribute is set and matches koha matchpoint)
931 if ( $shib and $shib_login and $shibSuccess) {
936 push @$cookie, $query->cookie(
937 -name => 'CGISESSID',
938 -value => $session->id,
940 -secure => ( C4::Context->https_enabled() ? 1 : 0 ),
943 $flags = haspermission( $userid, $flagsrequired );
947 $info{'nopermission'} = 1;
950 } elsif ( !$logout ) {
951 if ( $return eq 'expired' ) {
952 $info{timed_out} = 1;
953 } elsif ( $return eq 'restricted' ) {
954 $info{oldip} = $more_info->{old_ip};
955 $info{newip} = $more_info->{new_ip};
956 $info{different_ip} = 1;
961 unless ( $loggedin ) {
966 #we initiate a session prior to checking for a username to allow for anonymous sessions...
967 if( !$session or !$sessionID ) { # if we cleared sessionID, we need a new session
968 $session = get_session() or die "Auth ERROR: Cannot get_session()";
971 # Save anonymous search history in new session so it can be retrieved
972 # by get_template_and_user to store it in user's search history after
973 # a successful login.
974 if ($anon_search_history) {
975 $session->param( 'search_history', $anon_search_history );
978 $sessionID = $session->id;
979 C4::Context->_new_userenv($sessionID);
980 push @$cookie, $query->cookie(
981 -name => 'CGISESSID',
982 -value => $sessionID,
984 -secure => ( C4::Context->https_enabled() ? 1 : 0 ),
986 my $pki_field = C4::Context->preference('AllowPKIAuth');
987 if ( !defined($pki_field) ) {
988 print STDERR "ERROR: Missing system preference AllowPKIAuth.\n";
991 if ( ( $cas && $query->param('ticket') )
993 || ( $shib && $shib_login )
994 || $pki_field ne 'None'
997 my $password = $query->param('password');
999 my ( $return, $cardnumber );
1001 # If shib is enabled and we have a shib login, does the login match a valid koha user
1002 if ( $shib && $shib_login ) {
1005 # Do not pass password here, else shib will not be checked in checkpw.
1006 ( $return, $cardnumber, $retuserid ) = checkpw( $dbh, $q_userid, undef, $query );
1007 $userid = $retuserid;
1008 $shibSuccess = $return;
1009 $info{'invalidShibLogin'} = 1 unless ($return);
1012 # If shib login and match were successful, skip further login methods
1013 unless ($shibSuccess) {
1014 if ( $cas && $query->param('ticket') ) {
1016 ( $return, $cardnumber, $retuserid, $cas_ticket ) =
1017 checkpw( $dbh, $userid, $password, $query, $type );
1018 $userid = $retuserid;
1019 $info{'invalidCasLogin'} = 1 unless ($return);
1022 elsif ( $emailaddress ) {
1023 my $value = $emailaddress;
1025 # If we're looking up the email, there's a chance that the person
1026 # doesn't have a userid. So if there is none, we pass along the
1027 # borrower number, and the bits of code that need to know the user
1028 # ID will have to be smart enough to handle that.
1029 my $patrons = Koha::Patrons->search({ email => $value });
1030 if ($patrons->count) {
1032 # First the userid, then the borrowernum
1033 my $patron = $patrons->next;
1034 $value = $patron->userid || $patron->borrowernumber;
1038 $return = $value ? 1 : 0;
1043 ( $pki_field eq 'Common Name' && $ENV{'SSL_CLIENT_S_DN_CN'} )
1044 || ( $pki_field eq 'emailAddress'
1045 && $ENV{'SSL_CLIENT_S_DN_Email'} )
1049 if ( $pki_field eq 'Common Name' ) {
1050 $value = $ENV{'SSL_CLIENT_S_DN_CN'};
1052 elsif ( $pki_field eq 'emailAddress' ) {
1053 $value = $ENV{'SSL_CLIENT_S_DN_Email'};
1055 # If we're looking up the email, there's a chance that the person
1056 # doesn't have a userid. So if there is none, we pass along the
1057 # borrower number, and the bits of code that need to know the user
1058 # ID will have to be smart enough to handle that.
1059 my $patrons = Koha::Patrons->search({ email => $value });
1060 if ($patrons->count) {
1062 # First the userid, then the borrowernum
1063 my $patron = $patrons->next;
1064 $value = $patron->userid || $patron->borrowernumber;
1070 $return = $value ? 1 : 0;
1076 my $request_method = $query->request_method();
1079 $request_method eq 'POST'
1080 || ( C4::Context->preference('AutoSelfCheckID')
1081 && $q_userid eq C4::Context->preference('AutoSelfCheckID') )
1085 ( $return, $cardnumber, $retuserid, $cas_ticket ) =
1086 checkpw( $dbh, $q_userid, $password, $query, $type );
1087 $userid = $retuserid if ($retuserid);
1088 $info{'invalid_username_or_password'} = 1 unless ($return);
1093 # If shib configured and shibOnly enabled, we should ignore anything other than a shibboleth type login.
1100 && C4::Context->preference('OPACShibOnly')
1102 || ( ( $type ne 'opac' )
1103 && C4::Context->preference('staffShibOnly') )
1110 # $return: 1 = valid user
1113 if ( $flags = haspermission( $userid, $flagsrequired ) ) {
1117 $info{'nopermission'} = 1;
1118 C4::Context::_unset_userenv($sessionID);
1120 my ( $borrowernumber, $firstname, $surname, $userflags,
1121 $branchcode, $branchname, $emailaddress, $desk_id,
1122 $desk_name, $register_id, $register_name );
1124 if ( $return == 1 ) {
1126 SELECT borrowernumber, firstname, surname, flags, borrowers.branchcode,
1127 branches.branchname as branchname, email
1129 LEFT JOIN branches on borrowers.branchcode=branches.branchcode
1131 my $sth = $dbh->prepare("$select where userid=?");
1132 $sth->execute($userid);
1133 unless ( $sth->rows ) {
1134 $sth = $dbh->prepare("$select where cardnumber=?");
1135 $sth->execute($cardnumber);
1137 unless ( $sth->rows ) {
1138 $sth->execute($userid);
1142 ( $borrowernumber, $firstname, $surname, $userflags,
1143 $branchcode, $branchname, $emailaddress ) = $sth->fetchrow;
1146 # launch a sequence to check if we have a ip for the branch, i
1147 # if we have one we replace the branchcode of the userenv by the branch bound in the ip.
1149 my $ip = $ENV{'REMOTE_ADDR'};
1151 # if they specify at login, use that
1152 if ( $query->param('branch') ) {
1153 $branchcode = $query->param('branch');
1154 my $library = Koha::Libraries->find($branchcode);
1155 $branchname = $library? $library->branchname: '';
1157 if ( $query->param('desk_id') ) {
1158 $desk_id = $query->param('desk_id');
1159 my $desk = Koha::Desks->find($desk_id);
1160 $desk_name = $desk ? $desk->desk_name : '';
1162 if ( C4::Context->preference('UseCashRegisters') ) {
1164 $query->param('register_id')
1165 ? Koha::Cash::Registers->find($query->param('register_id'))
1166 : Koha::Cash::Registers->search(
1167 { branch => $branchcode, branch_default => 1 },
1168 { rows => 1 } )->single;
1169 $register_id = $register->id if ($register);
1170 $register_name = $register->name if ($register);
1172 my $branches = { map { $_->branchcode => $_->unblessed } Koha::Libraries->search->as_list };
1173 if ( $type ne 'opac' and C4::Context->preference('AutoLocation') ) {
1175 # we have to check they are coming from the right ip range
1176 my $domain = $branches->{$branchcode}->{'branchip'};
1177 $domain =~ s|\.\*||g;
1178 if ( $ip !~ /^$domain/ ) {
1180 push @$cookie, $query->cookie(
1181 -name => 'CGISESSID',
1184 -secure => ( C4::Context->https_enabled() ? 1 : 0 ),
1186 $info{'wrongip'} = 1;
1190 foreach my $br ( keys %$branches ) {
1192 # now we work with the treatment of ip
1193 my $domain = $branches->{$br}->{'branchip'};
1194 if ( $domain && $ip =~ /^$domain/ ) {
1195 $branchcode = $branches->{$br}->{'branchcode'};
1197 # new op dev : add the branchname to the cookie
1198 $branchname = $branches->{$br}->{'branchname'};
1202 my $is_sco_user = 0;
1203 if ( $query->param('sco_user_login') && ( $query->param('sco_user_login') eq '1' ) ){
1207 $session->param( 'number', $borrowernumber );
1208 $session->param( 'id', $userid );
1209 $session->param( 'cardnumber', $cardnumber );
1210 $session->param( 'firstname', $firstname );
1211 $session->param( 'surname', $surname );
1212 $session->param( 'branch', $branchcode );
1213 $session->param( 'branchname', $branchname );
1214 $session->param( 'desk_id', $desk_id);
1215 $session->param( 'desk_name', $desk_name);
1216 $session->param( 'flags', $userflags );
1217 $session->param( 'emailaddress', $emailaddress );
1218 $session->param( 'ip', $session->remote_addr() );
1219 $session->param( 'lasttime', time() );
1220 $session->param( 'interface', $type);
1221 $session->param( 'shibboleth', $shibSuccess );
1222 $session->param( 'register_id', $register_id );
1223 $session->param( 'register_name', $register_name );
1224 $session->param( 'sco_user', $is_sco_user );
1226 $session->param('cas_ticket', $cas_ticket) if $cas_ticket;
1227 C4::Context->set_userenv(
1228 $session->param('number'), $session->param('id'),
1229 $session->param('cardnumber'), $session->param('firstname'),
1230 $session->param('surname'), $session->param('branch'),
1231 $session->param('branchname'), $session->param('flags'),
1232 $session->param('emailaddress'), $session->param('shibboleth'),
1233 $session->param('desk_id'), $session->param('desk_name'),
1234 $session->param('register_id'), $session->param('register_name')
1238 # $return: 0 = invalid user
1239 # reset to anonymous session
1242 $info{'invalid_username_or_password'} = 1;
1243 C4::Context::_unset_userenv($sessionID);
1245 $session->param( 'lasttime', time() );
1246 $session->param( 'ip', $session->remote_addr() );
1247 $session->param( 'sessiontype', 'anon' );
1248 $session->param( 'interface', $type);
1250 } # END if ( $q_userid
1251 elsif ( $type eq "opac" ) {
1253 # anonymous sessions are created only for the OPAC
1255 # setting a couple of other session vars...
1256 $session->param( 'ip', $session->remote_addr() );
1257 $session->param( 'lasttime', time() );
1258 $session->param( 'sessiontype', 'anon' );
1259 $session->param( 'interface', $type);
1262 } # END unless ($userid)
1264 # finished authentification, now respond
1265 if ( $loggedin || $authnotrequired )
1269 push @$cookie, $query->cookie(
1270 -name => 'CGISESSID',
1273 -secure => ( C4::Context->https_enabled() ? 1 : 0 ),
1277 track_login_daily( $userid );
1279 # In case, that this request was a login attempt, we want to prevent that users can repost the opac login
1280 # request. We therefore redirect the user to the requested page again without the login parameters.
1281 # See Post/Redirect/Get (PRG) design pattern: https://en.wikipedia.org/wiki/Post/Redirect/Get
1282 if ( $type eq "opac" && $query->param('koha_login_context') && $query->param('koha_login_context') ne 'sco' && $query->param('password') && $query->param('userid') ) {
1283 my $uri = URI->new($query->url(-relative=>1, -query_string=>1));
1284 $uri->query_param_delete('userid');
1285 $uri->query_param_delete('password');
1286 $uri->query_param_delete('koha_login_context');
1287 print $query->redirect(-uri => $uri->as_string, -cookie => $cookie, -status=>'303 See other');
1291 return ( $userid, $cookie, $sessionID, $flags );
1296 # AUTH rejected, show the login/password template, after checking the DB.
1300 # get the inputs from the incoming query
1302 foreach my $name ( param $query) {
1303 (next) if ( $name eq 'userid' || $name eq 'password' || $name eq 'ticket' );
1304 my @value = $query->multi_param($name);
1305 push @inputs, { name => $name, value => $_ } for @value;
1308 my $patron = Koha::Patrons->find({ userid => $q_userid }); # Not necessary logged in!
1310 my $LibraryNameTitle = C4::Context->preference("LibraryName");
1311 $LibraryNameTitle =~ s/<(?:\/?)(?:br|p)\s*(?:\/?)>/ /sgi;
1312 $LibraryNameTitle =~ s/<(?:[^<>'"]|'(?:[^']*)'|"(?:[^"]*)")*>//sg;
1314 my $auth_template_name = ( $type eq 'opac' ) ? 'opac-auth.tt' : 'auth.tt';
1315 my $template = C4::Templates::gettemplate( $auth_template_name, $type, $query );
1319 script_name => get_script_name(),
1320 casAuthentication => C4::Context->preference("casAuthentication"),
1321 shibbolethAuthentication => $shib,
1322 suggestion => C4::Context->preference("suggestion"),
1323 virtualshelves => C4::Context->preference("virtualshelves"),
1324 LibraryName => "" . C4::Context->preference("LibraryName"),
1325 LibraryNameTitle => "" . $LibraryNameTitle,
1326 opacuserlogin => C4::Context->preference("opacuserlogin"),
1327 OpacFavicon => C4::Context->preference("OpacFavicon"),
1328 opacreadinghistory => C4::Context->preference("opacreadinghistory"),
1329 opaclanguagesdisplay => C4::Context->preference("opaclanguagesdisplay"),
1330 OPACUserJS => C4::Context->preference("OPACUserJS"),
1331 opacbookbag => "" . C4::Context->preference("opacbookbag"),
1332 OpacCloud => C4::Context->preference("OpacCloud"),
1333 OpacTopissue => C4::Context->preference("OpacTopissue"),
1334 OpacAuthorities => C4::Context->preference("OpacAuthorities"),
1335 OpacBrowser => C4::Context->preference("OpacBrowser"),
1336 TagsEnabled => C4::Context->preference("TagsEnabled"),
1337 OPACUserCSS => C4::Context->preference("OPACUserCSS"),
1338 intranetcolorstylesheet => C4::Context->preference("intranetcolorstylesheet"),
1339 intranetstylesheet => C4::Context->preference("intranetstylesheet"),
1340 IntranetNav => C4::Context->preference("IntranetNav"),
1341 IntranetFavicon => C4::Context->preference("IntranetFavicon"),
1342 IntranetUserCSS => C4::Context->preference("IntranetUserCSS"),
1343 IntranetUserJS => C4::Context->preference("IntranetUserJS"),
1344 IndependentBranches => C4::Context->preference("IndependentBranches"),
1345 AutoLocation => C4::Context->preference("AutoLocation"),
1346 wrongip => $info{'wrongip'},
1347 PatronSelfRegistration => C4::Context->preference("PatronSelfRegistration"),
1348 PatronSelfRegistrationDefaultCategory => C4::Context->preference("PatronSelfRegistrationDefaultCategory"),
1349 opac_css_override => $ENV{'OPAC_CSS_OVERRIDE'},
1350 too_many_login_attempts => ( $patron and $patron->account_locked )
1353 $template->param( SCO_login => 1 ) if ( $query->param('sco_user_login') );
1354 $template->param( SCI_login => 1 ) if ( $query->param('sci_user_login') );
1355 $template->param( OpacPublic => C4::Context->preference("OpacPublic") );
1356 $template->param( loginprompt => 1 ) unless $info{'nopermission'};
1358 if ( $type eq 'opac' ) {
1359 require Koha::Virtualshelves;
1360 my $some_public_shelves = Koha::Virtualshelves->get_some_shelves(
1366 some_public_shelves => $some_public_shelves,
1372 # Is authentication against multiple CAS servers enabled?
1373 require C4::Auth_with_cas;
1374 if ( multipleAuth() && !$casparam ) {
1375 my $casservers = getMultipleAuth();
1377 foreach my $key ( keys %$casservers ) {
1378 push @tmplservers, { name => $key, value => login_cas_url( $query, $key, $type ) . "?cas=$key" };
1381 casServersLoop => \@tmplservers
1385 casServerUrl => login_cas_url($query, undef, $type),
1390 invalidCasLogin => $info{'invalidCasLogin'}
1395 #If shibOnly is enabled just go ahead and redirect directly
1396 if ( (($type eq 'opac') && C4::Context->preference('OPACShibOnly')) || (($type ne 'opac') && C4::Context->preference('staffShibOnly')) ) {
1397 my $redirect_url = login_shib_url( $query );
1398 print $query->redirect( -uri => "$redirect_url", -status => 303 );
1403 shibbolethAuthentication => $shib,
1404 shibbolethLoginUrl => login_shib_url($query),
1408 if (C4::Context->preference('GoogleOpenIDConnect')) {
1409 if ($query->param("OpenIDConnectFailed")) {
1410 my $reason = $query->param('OpenIDConnectFailed');
1411 $template->param(invalidGoogleOpenIDConnectLogin => $reason);
1416 LibraryName => C4::Context->preference("LibraryName"),
1418 $template->param(%info);
1420 # $cookie = $query->cookie(CGISESSID => $session->id
1422 print $query->header(
1423 { type => 'text/html',
1426 'X-Frame-Options' => 'SAMEORIGIN'
1433 =head2 check_api_auth
1435 ($status, $cookie, $sessionId) = check_api_auth($query, $userflags);
1437 Given a CGI query containing the parameters 'userid' and 'password' and/or a session
1438 cookie, determine if the user has the privileges specified by C<$userflags>.
1440 C<check_api_auth> is is meant for authenticating users of web services, and
1441 consequently will always return and will not attempt to redirect the user
1444 If a valid session cookie is already present, check_api_auth will return a status
1445 of "ok", the cookie, and the Koha session ID.
1447 If no session cookie is present, check_api_auth will check the 'userid' and 'password
1448 parameters and create a session cookie and Koha session if the supplied credentials
1451 Possible return values in C<$status> are:
1455 =item "ok" -- user authenticated; C<$cookie> and C<$sessionid> have valid values.
1457 =item "failed" -- credentials are not correct; C<$cookie> and C<$sessionid> are undef
1459 =item "maintenance" -- DB is in maintenance mode; no login possible at the moment
1461 =item "expired -- session cookie has expired; API user should resubmit userid and password
1463 =item "restricted" -- The IP has changed (if SessionRestrictionByIP)
1469 sub check_api_auth {
1472 my $flagsrequired = shift;
1473 my $dbh = C4::Context->dbh;
1474 my $timeout = _timeout_syspref();
1476 unless ( C4::Context->preference('Version') ) {
1478 # database has not been installed yet
1479 return ( "maintenance", undef, undef );
1481 my $kohaversion = Koha::version();
1482 $kohaversion =~ s/(.*\..*)\.(.*)\.(.*)/$1$2$3/;
1483 if ( C4::Context->preference('Version') < $kohaversion ) {
1485 # database in need of version update; assume that
1486 # no API should be called while databsae is in
1488 return ( "maintenance", undef, undef );
1491 my ( $sessionID, $session );
1492 unless ( $query->param('userid') ) {
1493 $sessionID = $query->cookie("CGISESSID");
1495 if ( $sessionID && not( $cas && $query->param('PT') ) ) {
1498 ( $return, $session, undef ) = check_cookie_auth(
1499 $sessionID, $flagsrequired, { remote_addr => $ENV{REMOTE_ADDR} } );
1501 return ( $return, undef, undef ) # Cookie auth failed
1504 my $cookie = $query->cookie(
1505 -name => 'CGISESSID',
1506 -value => $session->id,
1508 -secure => ( C4::Context->https_enabled() ? 1 : 0 ),
1510 return ( $return, undef, $session );
1515 my $userid = $query->param('userid');
1516 my $password = $query->param('password');
1517 my ( $return, $cardnumber, $cas_ticket );
1520 if ( $cas && $query->param('PT') ) {
1523 # In case of a CAS authentication, we use the ticket instead of the password
1524 my $PT = $query->param('PT');
1525 ( $return, $cardnumber, $userid, $cas_ticket ) = check_api_auth_cas( $dbh, $PT, $query ); # EXTERNAL AUTH
1528 # User / password auth
1529 unless ( $userid and $password ) {
1531 # caller did something wrong, fail the authenticateion
1532 return ( "failed", undef, undef );
1535 ( $return, $cardnumber, $newuserid, $cas_ticket ) = checkpw( $dbh, $userid, $password, $query );
1538 if ( $return and haspermission( $userid, $flagsrequired ) ) {
1539 my $session = get_session("");
1540 return ( "failed", undef, undef ) unless $session;
1542 my $sessionID = $session->id;
1543 C4::Context->_new_userenv($sessionID);
1544 my $cookie = $query->cookie(
1545 -name => 'CGISESSID',
1546 -value => $sessionID,
1548 -secure => ( C4::Context->https_enabled() ? 1 : 0 ),
1550 if ( $return == 1 ) {
1552 $borrowernumber, $firstname, $surname,
1553 $userflags, $branchcode, $branchname,
1558 "select borrowernumber, firstname, surname, flags, borrowers.branchcode, branches.branchname as branchname, email from borrowers left join branches on borrowers.branchcode=branches.branchcode where userid=?"
1560 $sth->execute($userid);
1562 $borrowernumber, $firstname, $surname,
1563 $userflags, $branchcode, $branchname,
1565 ) = $sth->fetchrow if ( $sth->rows );
1567 unless ( $sth->rows ) {
1568 my $sth = $dbh->prepare(
1569 "select borrowernumber, firstname, surname, flags, borrowers.branchcode, branches.branchname as branchname, email from borrowers left join branches on borrowers.branchcode=branches.branchcode where cardnumber=?"
1571 $sth->execute($cardnumber);
1573 $borrowernumber, $firstname, $surname,
1574 $userflags, $branchcode, $branchname,
1576 ) = $sth->fetchrow if ( $sth->rows );
1578 unless ( $sth->rows ) {
1579 $sth->execute($userid);
1581 $borrowernumber, $firstname, $surname, $userflags,
1582 $branchcode, $branchname, $emailaddress
1583 ) = $sth->fetchrow if ( $sth->rows );
1587 my $ip = $ENV{'REMOTE_ADDR'};
1589 # if they specify at login, use that
1590 if ( $query->param('branch') ) {
1591 $branchcode = $query->param('branch');
1592 my $library = Koha::Libraries->find($branchcode);
1593 $branchname = $library? $library->branchname: '';
1595 my $branches = { map { $_->branchcode => $_->unblessed } Koha::Libraries->search->as_list };
1596 foreach my $br ( keys %$branches ) {
1598 # now we work with the treatment of ip
1599 my $domain = $branches->{$br}->{'branchip'};
1600 if ( $domain && $ip =~ /^$domain/ ) {
1601 $branchcode = $branches->{$br}->{'branchcode'};
1603 # new op dev : add the branchname to the cookie
1604 $branchname = $branches->{$br}->{'branchname'};
1607 $session->param( 'number', $borrowernumber );
1608 $session->param( 'id', $userid );
1609 $session->param( 'cardnumber', $cardnumber );
1610 $session->param( 'firstname', $firstname );
1611 $session->param( 'surname', $surname );
1612 $session->param( 'branch', $branchcode );
1613 $session->param( 'branchname', $branchname );
1614 $session->param( 'flags', $userflags );
1615 $session->param( 'emailaddress', $emailaddress );
1616 $session->param( 'ip', $session->remote_addr() );
1617 $session->param( 'lasttime', time() );
1618 $session->param( 'interface', 'api' );
1620 $session->param( 'cas_ticket', $cas_ticket);
1621 C4::Context->set_userenv(
1622 $session->param('number'), $session->param('id'),
1623 $session->param('cardnumber'), $session->param('firstname'),
1624 $session->param('surname'), $session->param('branch'),
1625 $session->param('branchname'), $session->param('flags'),
1626 $session->param('emailaddress'), $session->param('shibboleth'),
1627 $session->param('desk_id'), $session->param('desk_name'),
1628 $session->param('register_id'), $session->param('register_name')
1630 return ( "ok", $cookie, $sessionID );
1632 return ( "failed", undef, undef );
1637 =head2 check_cookie_auth
1639 ($status, $sessionId) = check_cookie_auth($cookie, $userflags);
1641 Given a CGISESSID cookie set during a previous login to Koha, determine
1642 if the user has the privileges specified by C<$userflags>. C<$userflags>
1643 is passed unaltered into C<haspermission> and as such accepts all options
1644 avaiable to that routine with the one caveat that C<check_api_auth> will
1645 also allow 'undef' to be passed and in such a case the permissions check
1646 will be skipped altogether.
1648 C<check_cookie_auth> is meant for authenticating special services
1649 such as tools/upload-file.pl that are invoked by other pages that
1650 have been authenticated in the usual way.
1652 Possible return values in C<$status> are:
1656 =item "ok" -- user authenticated; C<$sessionID> have valid values.
1658 =item "anon" -- user not authenticated but valid for anonymous session.
1660 =item "failed" -- credentials are not correct; C<$sessionid> are undef
1662 =item "maintenance" -- DB is in maintenance mode; no login possible at the moment
1664 =item "expired -- session cookie has expired; API user should resubmit userid and password
1666 =item "restricted" -- The IP has changed (if SessionRestrictionByIP)
1672 sub check_cookie_auth {
1673 my $sessionID = shift;
1674 my $flagsrequired = shift;
1677 my $remote_addr = $params->{remote_addr} || $ENV{REMOTE_ADDR};
1679 my $skip_version_check = $params->{skip_version_check}; # Only for checkauth
1681 unless ( $skip_version_check ) {
1682 unless ( C4::Context->preference('Version') ) {
1684 # database has not been installed yet
1685 return ( "maintenance", undef );
1687 my $kohaversion = Koha::version();
1688 $kohaversion =~ s/(.*\..*)\.(.*)\.(.*)/$1$2$3/;
1689 if ( C4::Context->preference('Version') < $kohaversion ) {
1691 # database in need of version update; assume that
1692 # no API should be called while databsae is in
1694 return ( "maintenance", undef );
1698 # see if we have a valid session cookie already
1699 # however, if a userid parameter is present (i.e., from
1700 # a form submission, assume that any current cookie
1702 unless ( $sessionID ) {
1703 return ( "failed", undef );
1705 C4::Context::_unset_userenv($sessionID); # remove old userenv first
1706 my $session = get_session($sessionID);
1708 my $userid = $session->param('id');
1709 my $ip = $session->param('ip');
1710 my $lasttime = $session->param('lasttime');
1711 my $timeout = _timeout_syspref();
1713 if ( !$lasttime || ( $lasttime < time() - $timeout ) ) {
1717 return ("expired", undef);
1719 } elsif ( C4::Context->preference('SessionRestrictionByIP') && $ip ne $remote_addr ) {
1720 # IP address changed
1723 return ( "restricted", undef, { old_ip => $ip, new_ip => $remote_addr});
1725 } elsif ( $userid ) {
1726 $session->param( 'lasttime', time() );
1727 my $flags = defined($flagsrequired) ? haspermission( $userid, $flagsrequired ) : 1;
1729 C4::Context->_new_userenv($sessionID);
1730 C4::Context->interface($session->param('interface'));
1731 C4::Context->set_userenv(
1732 $session->param('number'), $session->param('id') // '',
1733 $session->param('cardnumber'), $session->param('firstname'),
1734 $session->param('surname'), $session->param('branch'),
1735 $session->param('branchname'), $session->param('flags'),
1736 $session->param('emailaddress'), $session->param('shibboleth'),
1737 $session->param('desk_id'), $session->param('desk_name'),
1738 $session->param('register_id'), $session->param('register_name')
1740 return ( "ok", $session );
1744 return ( "failed", undef );
1748 C4::Context->_new_userenv($sessionID);
1749 C4::Context->interface($session->param('interface'));
1750 C4::Context->set_userenv( undef, q{} );
1751 return ( "anon", $session );
1754 return ( "expired", undef );
1761 my $session = get_session($sessionID);
1763 Given a session ID, retrieve the CGI::Session object used to store
1764 the session's state. The session object can be used to store
1765 data that needs to be accessed by different scripts during a
1768 If the C<$sessionID> parameter is an empty string, a new session
1773 sub _get_session_params {
1774 my $storage_method = C4::Context->preference('SessionStorage');
1775 if ( $storage_method eq 'mysql' ) {
1776 my $dbh = C4::Context->dbh;
1777 return { dsn => "serializer:yamlxs;driver:MySQL;id:md5", dsn_args => { Handle => $dbh } };
1779 elsif ( $storage_method eq 'Pg' ) {
1780 my $dbh = C4::Context->dbh;
1781 return { dsn => "serializer:yamlxs;driver:PostgreSQL;id:md5", dsn_args => { Handle => $dbh } };
1783 elsif ( $storage_method eq 'memcached' && Koha::Caches->get_instance->memcached_cache ) {
1784 my $memcached = Koha::Caches->get_instance()->memcached_cache;
1785 return { dsn => "serializer:yamlxs;driver:memcached;id:md5", dsn_args => { Memcached => $memcached } };
1788 # catch all defaults to tmp should work on all systems
1789 my $dir = C4::Context::temporary_directory;
1790 my $instance = C4::Context->config( 'database' ); #actually for packages not exactly the instance name, but generally safer to leave it as it is
1791 return { dsn => "serializer:yamlxs;driver:File;id:md5", dsn_args => { Directory => "$dir/cgisess_$instance" } };
1796 my $sessionID = shift;
1797 my $params = _get_session_params();
1799 if( $sessionID ) { # find existing
1800 CGI::Session::ErrorHandler->set_error( q{} ); # clear error, cpan issue #111463
1801 $session = CGI::Session->load( $params->{dsn}, $sessionID, $params->{dsn_args} );
1803 $session = CGI::Session->new( $params->{dsn}, $sessionID, $params->{dsn_args} );
1804 # no need to flush here
1810 # FIXME no_set_userenv may be replaced with force_branchcode_for_userenv
1811 # (or something similar)
1812 # Currently it's only passed from C4::SIP::ILS::Patron::check_password, but
1813 # not having a userenv defined could cause a crash.
1815 my ( $dbh, $userid, $password, $query, $type, $no_set_userenv ) = @_;
1816 $type = 'opac' unless $type;
1818 # Get shibboleth login attribute
1819 my $shib = C4::Context->config('useshibboleth') && shib_ok();
1820 my $shib_login = $shib ? get_login_shib() : undef;
1824 if ( defined $userid ){
1825 $patron = Koha::Patrons->find({ userid => $userid });
1826 $patron = Koha::Patrons->find({ cardnumber => $userid }) unless $patron;
1828 my $check_internal_as_fallback = 0;
1830 # Note: checkpw_* routines returns:
1833 # -1 if user bind failed (LDAP only)
1835 if ( $patron and $patron->account_locked ) {
1836 # Nothing to check, account is locked
1837 } elsif ($ldap && defined($password)) {
1838 my ( $retval, $retcard, $retuserid ) = checkpw_ldap(@_); # EXTERNAL AUTH
1839 if ( $retval == 1 ) {
1840 @return = ( $retval, $retcard, $retuserid );
1843 $check_internal_as_fallback = 1 if $retval == 0;
1845 } elsif ( $cas && $query && $query->param('ticket') ) {
1847 # In case of a CAS authentication, we use the ticket instead of the password
1848 my $ticket = $query->param('ticket');
1849 $query->delete('ticket'); # remove ticket to come back to original URL
1850 my ( $retval, $retcard, $retuserid, $cas_ticket ) = checkpw_cas( $dbh, $ticket, $query, $type ); # EXTERNAL AUTH
1852 @return = ( $retval, $retcard, $retuserid, $cas_ticket );
1856 $passwd_ok = $retval;
1859 # If we are in a shibboleth session (shibboleth is enabled, and a shibboleth match attribute is present)
1860 # Check for password to asertain whether we want to be testing against shibboleth or another method this
1862 elsif ( $shib && $shib_login && !$password ) {
1864 # In case of a Shibboleth authentication, we expect a shibboleth user attribute
1865 # (defined under shibboleth mapping in koha-conf.xml) to contain the login of the
1866 # shibboleth-authenticated user
1868 # Then, we check if it matches a valid koha user
1870 my ( $retval, $retcard, $retuserid ) = C4::Auth_with_shibboleth::checkpw_shib($shib_login); # EXTERNAL AUTH
1872 @return = ( $retval, $retcard, $retuserid );
1874 $passwd_ok = $retval;
1877 $check_internal_as_fallback = 1;
1881 if ( $check_internal_as_fallback ) {
1882 @return = checkpw_internal( $dbh, $userid, $password, $no_set_userenv);
1883 $passwd_ok = 1 if $return[0] > 0; # 1 or 2
1888 $patron->update({ login_attempts => 0 });
1889 } elsif( !$patron->account_locked ) {
1890 $patron->update({ login_attempts => $patron->login_attempts + 1 });
1894 # Optionally log success or failure
1895 if( $patron && $passwd_ok && C4::Context->preference('AuthSuccessLog') ) {
1896 logaction( 'AUTH', 'SUCCESS', $patron->id, "Valid password for $userid", $type );
1897 } elsif( !$passwd_ok && C4::Context->preference('AuthFailureLog') ) {
1898 logaction( 'AUTH', 'FAILURE', $patron ? $patron->id : 0, "Wrong password for $userid", $type );
1904 sub checkpw_internal {
1905 my ( $dbh, $userid, $password, $no_set_userenv ) = @_;
1907 $password = Encode::encode( 'UTF-8', $password )
1908 if Encode::is_utf8($password);
1912 "select password,cardnumber,borrowernumber,userid,firstname,surname,borrowers.branchcode,branches.branchname,flags from borrowers join branches on borrowers.branchcode=branches.branchcode where userid=?"
1914 $sth->execute($userid);
1916 my ( $stored_hash, $cardnumber, $borrowernumber, $userid, $firstname,
1917 $surname, $branchcode, $branchname, $flags )
1920 if ( checkpw_hash( $password, $stored_hash ) ) {
1922 C4::Context->set_userenv( "$borrowernumber", $userid, $cardnumber,
1923 $firstname, $surname, $branchcode, $branchname, $flags ) unless $no_set_userenv;
1924 return 1, $cardnumber, $userid;
1929 "select password,cardnumber,borrowernumber,userid,firstname,surname,borrowers.branchcode,branches.branchname,flags from borrowers join branches on borrowers.branchcode=branches.branchcode where cardnumber=?"
1931 $sth->execute($userid);
1933 my ( $stored_hash, $cardnumber, $borrowernumber, $userid, $firstname,
1934 $surname, $branchcode, $branchname, $flags )
1937 if ( checkpw_hash( $password, $stored_hash ) ) {
1939 C4::Context->set_userenv( $borrowernumber, $userid, $cardnumber,
1940 $firstname, $surname, $branchcode, $branchname, $flags ) unless $no_set_userenv;
1941 return 1, $cardnumber, $userid;
1948 my ( $password, $stored_hash ) = @_;
1950 return if $stored_hash eq '!';
1952 # check what encryption algorithm was implemented: Bcrypt - if the hash starts with '$2' it is Bcrypt else md5
1954 if ( substr( $stored_hash, 0, 2 ) eq '$2' ) {
1955 $hash = hash_password( $password, $stored_hash );
1957 $hash = md5_base64($password);
1959 return $hash eq $stored_hash;
1964 my $authflags = getuserflags($flags, $userid, [$dbh]);
1966 Translates integer flags into permissions strings hash.
1968 C<$flags> is the integer userflags value ( borrowers.userflags )
1969 C<$userid> is the members.userid, used for building subpermissions
1970 C<$authflags> is a hashref of permissions
1977 my $dbh = @_ ? shift : C4::Context->dbh;
1980 # I don't want to do this, but if someone logs in as the database
1981 # user, it would be preferable not to spam them to death with
1982 # numeric warnings. So, we make $flags numeric.
1983 no warnings 'numeric';
1986 my $sth = $dbh->prepare("SELECT bit, flag, defaulton FROM userflags");
1989 while ( my ( $bit, $flag, $defaulton ) = $sth->fetchrow ) {
1990 if ( ( $flags & ( 2**$bit ) ) || $defaulton ) {
1991 $userflags->{$flag} = 1;
1994 $userflags->{$flag} = 0;
1998 # get subpermissions and merge with top-level permissions
1999 my $user_subperms = get_user_subpermissions($userid);
2000 foreach my $module ( keys %$user_subperms ) {
2001 next if $userflags->{$module} == 1; # user already has permission for everything in this module
2002 $userflags->{$module} = $user_subperms->{$module};
2008 =head2 get_user_subpermissions
2010 $user_perm_hashref = get_user_subpermissions($userid);
2012 Given the userid (note, not the borrowernumber) of a staff user,
2013 return a hashref of hashrefs of the specific subpermissions
2014 accorded to the user. An example return is
2018 export_catalog => 1,
2019 import_patrons => 1,
2023 The top-level hash-key is a module or function code from
2024 userflags.flag, while the second-level key is a code
2027 The results of this function do not give a complete picture
2028 of the functions that a staff user can access; it is also
2029 necessary to check borrowers.flags.
2033 sub get_user_subpermissions {
2036 my $dbh = C4::Context->dbh;
2037 my $sth = $dbh->prepare( "SELECT flag, user_permissions.code
2038 FROM user_permissions
2039 JOIN permissions USING (module_bit, code)
2040 JOIN userflags ON (module_bit = bit)
2041 JOIN borrowers USING (borrowernumber)
2042 WHERE userid = ?" );
2043 $sth->execute($userid);
2045 my $user_perms = {};
2046 while ( my $perm = $sth->fetchrow_hashref ) {
2047 $user_perms->{ $perm->{'flag'} }->{ $perm->{'code'} } = 1;
2052 =head2 get_all_subpermissions
2054 my $perm_hashref = get_all_subpermissions();
2056 Returns a hashref of hashrefs defining all specific
2057 permissions currently defined. The return value
2058 has the same structure as that of C<get_user_subpermissions>,
2059 except that the innermost hash value is the description
2060 of the subpermission.
2064 sub get_all_subpermissions {
2065 my $dbh = C4::Context->dbh;
2066 my $sth = $dbh->prepare( "SELECT flag, code
2068 JOIN userflags ON (module_bit = bit)" );
2072 while ( my $perm = $sth->fetchrow_hashref ) {
2073 $all_perms->{ $perm->{'flag'} }->{ $perm->{'code'} } = 1;
2078 =head2 haspermission
2080 $flagsrequired = '*'; # Any permission at all
2081 $flagsrequired = 'a_flag'; # a_flag must be satisfied (all subpermissions)
2082 $flagsrequired = [ 'a_flag', 'b_flag' ]; # a_flag OR b_flag must be satisfied
2083 $flagsrequired = { 'a_flag => 1, 'b_flag' => 1 }; # a_flag AND b_flag must be satisfied
2084 $flagsrequired = { 'a_flag' => 'sub_a' }; # sub_a of a_flag must be satisfied
2085 $flagsrequired = { 'a_flag' => [ 'sub_a, 'sub_b' ] }; # sub_a OR sub_b of a_flag must be satisfied
2087 $flags = ($userid, $flagsrequired);
2089 C<$userid> the userid of the member
2090 C<$flags> is a query structure similar to that used by SQL::Abstract that
2091 denotes the combination of flags required. It is a required parameter.
2093 The main logic of this method is that things in arrays are OR'ed, and things
2094 in hashes are AND'ed. The `*` character can be used, at any depth, to denote `ANY`
2096 Returns member's flags or 0 if a permission is not met.
2101 my ($required, $flags) = @_;
2103 my $ref = ref($required);
2105 if ($required eq '*') {
2106 return 0 unless ( $flags or ref( $flags ) );
2108 return 0 unless ( $flags and (!ref( $flags ) || $flags->{$required} ));
2110 } elsif ($ref eq 'HASH') {
2111 foreach my $key (keys %{$required}) {
2112 next if $flags == 1;
2113 my $require = $required->{$key};
2114 my $rflags = $flags->{$key};
2115 return 0 unless _dispatch($require, $rflags);
2117 } elsif ($ref eq 'ARRAY') {
2119 foreach my $require ( @{$required} ) {
2121 ( ref($flags) && !ref($require) && ( $require ne '*' ) )
2122 ? $flags->{$require}
2124 $satisfied++ if _dispatch( $require, $rflags );
2126 return 0 unless $satisfied;
2128 croak "Unexpected structure found: $ref";
2135 my ( $userid, $flagsrequired ) = @_;
2137 #Koha::Exceptions::WrongParameter->throw('$flagsrequired should not be undef')
2138 # unless defined($flagsrequired);
2140 my $sth = C4::Context->dbh->prepare("SELECT flags FROM borrowers WHERE userid=?");
2141 $sth->execute($userid);
2142 my $row = $sth->fetchrow();
2143 my $flags = getuserflags( $row, $userid );
2145 return $flags unless defined($flagsrequired);
2146 return $flags if $flags->{superlibrarian};
2147 return _dispatch($flagsrequired, $flags);
2149 #FIXME - This fcn should return the failed permission so a suitable error msg can be delivered.
2154 $flags = ($iprange);
2156 C<$iprange> A space separated string describing an IP range. Can include single IPs or ranges
2158 Returns 1 if the remote address is in the provided iprange, or 0 otherwise.
2165 my @allowedipranges = $iprange ? split(' ', $iprange) : ();
2166 if (scalar @allowedipranges > 0) {
2168 eval { @rangelist = Net::CIDR::range2cidr(@allowedipranges); }; return 0 if $@;
2169 eval { $result = Net::CIDR::cidrlookup($ENV{'REMOTE_ADDR'}, @rangelist) } || Koha::Logger->get->warn('cidrlookup failed for ' . join(' ',@rangelist) );
2171 return $result ? 1 : 0;
2174 sub getborrowernumber {
2176 my $userenv = C4::Context->userenv;
2177 if ( defined($userenv) && ref($userenv) eq 'HASH' && $userenv->{number} ) {
2178 return $userenv->{number};
2180 my $dbh = C4::Context->dbh;
2181 for my $field ( 'userid', 'cardnumber' ) {
2183 $dbh->prepare("select borrowernumber from borrowers where $field=?");
2184 $sth->execute($userid);
2186 my ($bnumber) = $sth->fetchrow;
2193 =head2 track_login_daily
2195 track_login_daily( $userid );
2197 Wraps the call to $patron->track_login, the method used to update borrowers.lastseen. We only call track_login once a day.
2201 sub track_login_daily {
2203 return if !$userid || !C4::Context->preference('TrackLastPatronActivity');
2205 my $cache = Koha::Caches->get_instance();
2206 my $cache_key = "track_login_" . $userid;
2207 my $cached = $cache->get_from_cache($cache_key);
2208 my $today = dt_from_string()->ymd;
2209 return if $cached && $cached eq $today;
2211 my $patron = Koha::Patrons->find({ userid => $userid });
2212 return unless $patron;
2213 $patron->track_login;
2214 $cache->set_in_cache( $cache_key, $today );
2217 END { } # module clean-up code here (global destructor)
2227 Crypt::Eksblowfish::Bcrypt(3)