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 );
28 use C4::Templates; # to get the template
30 use C4::Search::History;
34 use Koha::AuthUtils qw( get_script_name hash_password );
36 use Koha::DateUtils qw( dt_from_string );
37 use Koha::Library::Groups;
39 use Koha::Cash::Registers;
42 use Koha::Patron::Consents;
43 use List::MoreUtils qw( any );
45 use C4::Auth_with_shibboleth qw( shib_ok get_login_shib login_shib_url logout_shib checkpw_shib );
47 use C4::Log qw( logaction );
51 use vars qw($ldap $cas $caslogout);
52 our (@ISA, @EXPORT_OK);
54 sub psgi_env { any { /^psgi\./ } keys %ENV }
57 if (psgi_env) { die 'psgi:exit' }
61 C4::Context->set_remote_address;
67 checkauth check_api_auth get_session check_cookie_auth checkpw checkpw_internal checkpw_hash
68 get_all_subpermissions get_user_subpermissions track_login_daily in_iprange
69 get_template_and_user haspermission
72 $ldap = C4::Context->config('useldapserver') || 0;
73 $cas = C4::Context->preference('casAuthentication');
74 $caslogout = C4::Context->preference('casLogout');
75 require C4::Auth_with_cas; # no import
78 require C4::Auth_with_ldap;
79 import C4::Auth_with_ldap qw(checkpw_ldap);
82 import C4::Auth_with_cas qw(check_api_auth_cas checkpw_cas login_cas logout_cas login_cas_url logout_if_required);
89 C4::Auth - Authenticates Koha users
99 my ($template, $borrowernumber, $cookie)
100 = get_template_and_user(
102 template_name => "opac-main.tt",
105 authnotrequired => 0,
106 flagsrequired => { catalogue => '*', tools => 'import_patrons' },
110 output_html_with_http_headers $query, $cookie, $template->output;
114 The main function of this module is to provide
115 authentification. However the get_template_and_user function has
116 been provided so that a users login information is passed along
117 automatically. This gets loaded into the template.
121 =head2 get_template_and_user
123 my ($template, $borrowernumber, $cookie)
124 = get_template_and_user(
126 template_name => "opac-main.tt",
129 authnotrequired => 0,
130 flagsrequired => { catalogue => '*', tools => 'import_patrons' },
134 This call passes the C<query>, C<flagsrequired> and C<authnotrequired>
135 to C<&checkauth> (in this module) to perform authentification.
136 See C<&checkauth> for an explanation of these parameters.
138 The C<template_name> is then used to find the correct template for
139 the page. The authenticated users details are loaded onto the
140 template in the logged_in_user variable (which is a Koha::Patron object). Also the
141 C<sessionID> is passed to the template. This can be used in templates
142 if cookies are disabled. It needs to be put as and input to every
145 More information on the C<gettemplate> sub can be found in the
150 sub get_template_and_user {
153 my ( $user, $cookie, $sessionID, $flags );
155 # Get shibboleth login attribute
156 my $shib = C4::Context->config('useshibboleth') && shib_ok();
157 my $shib_login = $shib ? get_login_shib() : undef;
159 C4::Context->interface( $in->{type} );
161 $in->{'authnotrequired'} ||= 0;
163 # the following call includes a bad template check; might croak
164 my $template = C4::Templates::gettemplate(
165 $in->{'template_name'},
170 if ( $in->{'template_name'} !~ m/maintenance/ ) {
171 ( $user, $cookie, $sessionID, $flags ) = checkauth(
173 $in->{'authnotrequired'},
174 $in->{'flagsrequired'},
177 $in->{template_name},
181 # If we enforce GDPR and the user did not consent, redirect
182 # Exceptions for consent page itself and SCI/SCO system
183 if( $in->{type} eq 'opac' && $user &&
184 $in->{'template_name'} !~ /^(opac-patron-consent|sc[io]\/)/ &&
185 C4::Context->preference('GDPR_Policy') eq 'Enforced' )
187 my $consent = Koha::Patron::Consents->search({
188 borrowernumber => getborrowernumber($user),
189 type => 'GDPR_PROCESSING',
190 given_on => { '!=', undef },
193 print $in->{query}->redirect(-uri => '/cgi-bin/koha/opac-patron-consent.pl', -cookie => $cookie);
198 if ( $in->{type} eq 'opac' && $user ) {
202 # If the user logged in is the SCO user and they try to go out of the SCO module,
203 # log the user out removing the CGISESSID cookie
204 $in->{template_name} !~ m|sco/| && $in->{template_name} !~ m|errors/errorpage.tt|
205 && C4::Context->preference('AutoSelfCheckID')
206 && $user eq C4::Context->preference('AutoSelfCheckID')
212 # If the user logged in is the SCI user and they try to go out of the SCI module,
213 # kick them out unless it is SCO with a valid permission
214 # or they are a superlibrarian
215 $in->{template_name} !~ m|sci/|
216 && haspermission( $user, { self_check => 'self_checkin_module' } )
218 $in->{template_name} =~ m|sco/| && haspermission(
219 $user, { self_check => 'self_checkout_module' }
222 && $flags && $flags->{superlibrarian} != 1
229 $template = C4::Templates::gettemplate( 'opac-auth.tt', 'opac',
231 $cookie = $in->{query}->cookie(
232 -name => 'CGISESSID',
236 -secure => ( C4::Context->https_enabled() ? 1 : 0 ),
241 script_name => get_script_name(),
244 print $in->{query}->header(
249 'X-Frame-Options' => 'SAMEORIGIN'
260 # It's possible for $user to be the borrowernumber if they don't have a
261 # userid defined (and are logging in through some other method, such
262 # as SSL certs against an email address)
264 $borrowernumber = getborrowernumber($user) if defined($user);
265 if ( !defined($borrowernumber) && defined($user) ) {
266 $patron = Koha::Patrons->find( $user );
268 $borrowernumber = $user;
270 # A bit of a hack, but I don't know there's a nicer way
272 $user = $patron->firstname . ' ' . $patron->surname;
275 $patron = Koha::Patrons->find( $borrowernumber );
276 # FIXME What to do if $patron does not exist?
280 $template->param( loggedinusername => $user ); # OBSOLETE - Do not reuse this in template, use logged_in_user.userid instead
281 $template->param( loggedinusernumber => $borrowernumber ); # FIXME Should be replaced with logged_in_user.borrowernumber
282 $template->param( logged_in_user => $patron );
283 $template->param( sessionID => $sessionID );
285 if ( $in->{'type'} eq 'opac' ) {
286 require Koha::Virtualshelves;
287 my $some_private_shelves = Koha::Virtualshelves->get_some_shelves(
289 borrowernumber => $borrowernumber,
293 my $some_public_shelves = Koha::Virtualshelves->get_some_shelves(
299 some_private_shelves => $some_private_shelves,
300 some_public_shelves => $some_public_shelves,
304 my $all_perms = get_all_subpermissions();
306 my @flagroots = qw(circulate catalogue parameters borrowers permissions reserveforothers borrow
307 editcatalogue updatecharges tools editauthorities serials reports acquisition clubs problem_reports);
309 # We are going to use the $flags returned by checkauth
310 # to create the template's parameters that will indicate
311 # which menus the user can access.
312 if ( $flags && $flags->{superlibrarian} == 1 ) {
313 $template->param( CAN_user_circulate => 1 );
314 $template->param( CAN_user_catalogue => 1 );
315 $template->param( CAN_user_parameters => 1 );
316 $template->param( CAN_user_borrowers => 1 );
317 $template->param( CAN_user_permissions => 1 );
318 $template->param( CAN_user_reserveforothers => 1 );
319 $template->param( CAN_user_editcatalogue => 1 );
320 $template->param( CAN_user_updatecharges => 1 );
321 $template->param( CAN_user_acquisition => 1 );
322 $template->param( CAN_user_suggestions => 1 );
323 $template->param( CAN_user_tools => 1 );
324 $template->param( CAN_user_editauthorities => 1 );
325 $template->param( CAN_user_serials => 1 );
326 $template->param( CAN_user_reports => 1 );
327 $template->param( CAN_user_staffaccess => 1 );
328 $template->param( CAN_user_coursereserves => 1 );
329 $template->param( CAN_user_plugins => 1 );
330 $template->param( CAN_user_lists => 1 );
331 $template->param( CAN_user_clubs => 1 );
332 $template->param( CAN_user_ill => 1 );
333 $template->param( CAN_user_stockrotation => 1 );
334 $template->param( CAN_user_cash_management => 1 );
335 $template->param( CAN_user_problem_reports => 1 );
337 foreach my $module ( keys %$all_perms ) {
338 foreach my $subperm ( keys %{ $all_perms->{$module} } ) {
339 $template->param( "CAN_user_${module}_${subperm}" => 1 );
345 foreach my $module ( keys %$all_perms ) {
346 if ( defined($flags->{$module}) && $flags->{$module} == 1 ) {
347 foreach my $subperm ( keys %{ $all_perms->{$module} } ) {
348 $template->param( "CAN_user_${module}_${subperm}" => 1 );
350 } elsif ( ref( $flags->{$module} ) ) {
351 foreach my $subperm ( keys %{ $flags->{$module} } ) {
352 $template->param( "CAN_user_${module}_${subperm}" => 1 );
359 foreach my $module ( keys %$flags ) {
360 if ( $flags->{$module} == 1 or ref( $flags->{$module} ) ) {
361 $template->param( "CAN_user_$module" => 1 );
366 # Logged-in opac search history
367 # If the requested template is an opac one and opac search history is enabled
368 if ( $in->{type} eq 'opac' && C4::Context->preference('EnableOpacSearchHistory') ) {
369 my $dbh = C4::Context->dbh;
370 my $query = "SELECT COUNT(*) FROM search_history WHERE userid=?";
371 my $sth = $dbh->prepare($query);
372 $sth->execute($borrowernumber);
374 # If at least one search has already been performed
375 if ( $sth->fetchrow_array > 0 ) {
377 # We show the link in opac
378 $template->param( EnableOpacSearchHistory => 1 );
380 if (C4::Context->preference('LoadSearchHistoryToTheFirstLoggedUser'))
382 # And if there are searches performed when the user was not logged in,
383 # we add them to the logged-in search history
384 my @recentSearches = C4::Search::History::get_from_session( { cgi => $in->{'query'} } );
385 if (@recentSearches) {
386 my $dbh = C4::Context->dbh;
388 INSERT INTO search_history(userid, sessionid, query_desc, query_cgi, type, total, time )
389 VALUES (?, ?, ?, ?, ?, ?, ?)
391 my $sth = $dbh->prepare($query);
392 $sth->execute( $borrowernumber,
393 $in->{query}->cookie("CGISESSID"),
396 $_->{type} || 'biblio',
399 ) foreach @recentSearches;
401 # clear out the search history from the session now that
402 # we've saved it to the database
405 C4::Search::History::set_to_session( { cgi => $in->{'query'}, search_history => [] } );
407 } elsif ( $in->{type} eq 'intranet' and C4::Context->preference('EnableSearchHistory') ) {
408 $template->param( EnableSearchHistory => 1 );
411 else { # if this is an anonymous session, setup to display public lists...
413 # If shibboleth is enabled, and we're in an anonymous session, we should allow
414 # the user to attempt login via shibboleth.
416 $template->param( shibbolethAuthentication => $shib,
417 shibbolethLoginUrl => login_shib_url( $in->{'query'} ),
420 # If shibboleth is enabled and we have a shibboleth login attribute,
421 # but we are in an anonymous session, then we clearly have an invalid
422 # shibboleth koha account.
424 $template->param( invalidShibLogin => '1' );
428 $template->param( sessionID => $sessionID );
430 if ( $in->{'type'} eq 'opac' ){
431 require Koha::Virtualshelves;
432 my $some_public_shelves = Koha::Virtualshelves->get_some_shelves(
438 some_public_shelves => $some_public_shelves,
443 # Sysprefs disabled via URL param
444 # Note that value must be defined in order to override via ENV
445 foreach my $syspref (
451 OpacAdditionalStylesheet
453 intranetcolorstylesheet
458 $ENV{"OVERRIDE_SYSPREF_$syspref"} = q{}
459 if $in->{'query'}->param("DISABLE_SYSPREF_$syspref");
462 # Anonymous opac search history
463 # If opac search history is enabled and at least one search has already been performed
464 if ( C4::Context->preference('EnableOpacSearchHistory') ) {
465 my @recentSearches = C4::Search::History::get_from_session( { cgi => $in->{'query'} } );
466 if (@recentSearches) {
467 $template->param( EnableOpacSearchHistory => 1 );
471 if ( C4::Context->preference('dateformat') ) {
472 $template->param( dateformat => C4::Context->preference('dateformat') );
475 $template->param(auth_forwarded_hash => scalar $in->{'query'}->param('auth_forwarded_hash'));
477 # these template parameters are set the same regardless of $in->{'type'}
479 my $minPasswordLength = C4::Context->preference('minPasswordLength');
480 $minPasswordLength = 3 if not $minPasswordLength or $minPasswordLength < 3;
482 "BiblioDefaultView" . C4::Context->preference("BiblioDefaultView") => 1,
483 EnhancedMessagingPreferences => C4::Context->preference('EnhancedMessagingPreferences'),
484 GoogleJackets => C4::Context->preference("GoogleJackets"),
485 OpenLibraryCovers => C4::Context->preference("OpenLibraryCovers"),
486 KohaAdminEmailAddress => "" . C4::Context->preference("KohaAdminEmailAddress"),
487 LoginFirstname => ( C4::Context->userenv ? C4::Context->userenv->{"firstname"} : "Bel" ),
488 LoginSurname => C4::Context->userenv ? C4::Context->userenv->{"surname"} : "Inconnu",
489 emailaddress => C4::Context->userenv ? C4::Context->userenv->{"emailaddress"} : undef,
490 TagsEnabled => C4::Context->preference("TagsEnabled"),
491 hide_marc => C4::Context->preference("hide_marc"),
492 item_level_itypes => C4::Context->preference('item-level_itypes'),
493 patronimages => C4::Context->preference("patronimages"),
494 singleBranchMode => ( Koha::Libraries->search->count == 1 ),
495 noItemTypeImages => C4::Context->preference("noItemTypeImages"),
496 marcflavour => C4::Context->preference("marcflavour"),
497 OPACBaseURL => C4::Context->preference('OPACBaseURL'),
498 minPasswordLength => $minPasswordLength,
500 if ( $in->{'type'} eq "intranet" ) {
502 AmazonCoverImages => C4::Context->preference("AmazonCoverImages"),
503 AutoLocation => C4::Context->preference("AutoLocation"),
504 "BiblioDefaultView" . C4::Context->preference("IntranetBiblioDefaultView") => 1,
505 PatronAutoComplete => C4::Context->preference("PatronAutoComplete"),
506 FRBRizeEditions => C4::Context->preference("FRBRizeEditions"),
507 IndependentBranches => C4::Context->preference("IndependentBranches"),
508 IntranetNav => C4::Context->preference("IntranetNav"),
509 IntranetmainUserblock => C4::Context->preference("IntranetmainUserblock"),
510 LibraryName => C4::Context->preference("LibraryName"),
511 advancedMARCEditor => C4::Context->preference("advancedMARCEditor"),
512 canreservefromotherbranches => C4::Context->preference('canreservefromotherbranches'),
513 intranetcolorstylesheet => C4::Context->preference("intranetcolorstylesheet"),
514 IntranetFavicon => C4::Context->preference("IntranetFavicon"),
515 intranetreadinghistory => C4::Context->preference("intranetreadinghistory"),
516 intranetstylesheet => C4::Context->preference("intranetstylesheet"),
517 IntranetUserCSS => C4::Context->preference("IntranetUserCSS"),
518 IntranetUserJS => C4::Context->preference("IntranetUserJS"),
519 suggestion => C4::Context->preference("suggestion"),
520 virtualshelves => C4::Context->preference("virtualshelves"),
521 StaffSerialIssueDisplayCount => C4::Context->preference("StaffSerialIssueDisplayCount"),
522 EasyAnalyticalRecords => C4::Context->preference('EasyAnalyticalRecords'),
523 LocalCoverImages => C4::Context->preference('LocalCoverImages'),
524 OPACLocalCoverImages => C4::Context->preference('OPACLocalCoverImages'),
525 AllowMultipleCovers => C4::Context->preference('AllowMultipleCovers'),
526 EnableBorrowerFiles => C4::Context->preference('EnableBorrowerFiles'),
527 UseCourseReserves => C4::Context->preference("UseCourseReserves"),
528 useDischarge => C4::Context->preference('useDischarge'),
529 pending_checkout_notes => scalar Koha::Checkouts->search({ noteseen => 0 }),
533 warn "template type should be OPAC, here it is=[" . $in->{'type'} . "]" unless ( $in->{'type'} eq 'opac' );
535 #TODO : replace LibraryName syspref with 'system name', and remove this html processing
536 my $LibraryNameTitle = C4::Context->preference("LibraryName");
537 $LibraryNameTitle =~ s/<(?:\/?)(?:br|p)\s*(?:\/?)>/ /sgi;
538 $LibraryNameTitle =~ s/<(?:[^<>'"]|'(?:[^']*)'|"(?:[^"]*)")*>//sg;
540 # clean up the busc param in the session
541 # if the page is not opac-detail and not the "add to list" page
542 # and not the "edit comments" page
543 if ( C4::Context->preference("OpacBrowseResults")
544 && $in->{'template_name'} =~ /opac-(.+)\.(?:tt|tmpl)$/ ) {
546 unless ( $pagename =~ /^(?:MARC|ISBD)?detail$/
547 or $pagename =~ /^showmarc$/
548 or $pagename =~ /^addbybiblionumber$/
549 or $pagename =~ /^review$/ ) {
550 my $sessionSearch = get_session( $sessionID || $in->{'query'}->cookie("CGISESSID") );
551 $sessionSearch->clear( ["busc"] ) if ( $sessionSearch->param("busc") );
555 # variables passed from CGI: opac_css_override and opac_search_limits.
556 my $opac_search_limit = $ENV{'OPAC_SEARCH_LIMIT'};
557 my $opac_limit_override = $ENV{'OPAC_LIMIT_OVERRIDE'};
560 ( $opac_limit_override && $opac_search_limit && $opac_search_limit =~ /branch:([\w-]+)/ ) ||
561 ( $in->{'query'}->param('limit') && $in->{'query'}->param('limit') =~ /branch:([\w-]+)/ ) ||
562 ( $in->{'query'}->param('limit') && $in->{'query'}->param('limit') =~ /multibranchlimit:(\w+)/ )
564 $opac_name = $1; # opac_search_limit is a branch, so we use it.
565 } elsif ( $in->{'query'}->param('multibranchlimit') ) {
566 $opac_name = $in->{'query'}->param('multibranchlimit');
567 } elsif ( C4::Context->preference("SearchMyLibraryFirst") && C4::Context->userenv && C4::Context->userenv->{'branch'} ) {
568 $opac_name = C4::Context->userenv->{'branch'};
571 my @search_groups = Koha::Library::Groups->get_search_groups({ interface => 'opac' });
573 AnonSuggestions => "" . C4::Context->preference("AnonSuggestions"),
574 LibrarySearchGroups => \@search_groups,
575 opac_name => $opac_name,
576 LibraryName => "" . C4::Context->preference("LibraryName"),
577 LibraryNameTitle => "" . $LibraryNameTitle,
578 OPACAmazonCoverImages => C4::Context->preference("OPACAmazonCoverImages"),
579 OPACFRBRizeEditions => C4::Context->preference("OPACFRBRizeEditions"),
580 OpacHighlightedWords => C4::Context->preference("OpacHighlightedWords"),
581 OPACShelfBrowser => "" . C4::Context->preference("OPACShelfBrowser"),
582 OPACURLOpenInNewWindow => "" . C4::Context->preference("OPACURLOpenInNewWindow"),
583 OPACUserCSS => "" . C4::Context->preference("OPACUserCSS"),
584 OpacAuthorities => C4::Context->preference("OpacAuthorities"),
585 opac_css_override => $ENV{'OPAC_CSS_OVERRIDE'},
586 opac_search_limit => $opac_search_limit,
587 opac_limit_override => $opac_limit_override,
588 OpacBrowser => C4::Context->preference("OpacBrowser"),
589 OpacCloud => C4::Context->preference("OpacCloud"),
590 OpacKohaUrl => C4::Context->preference("OpacKohaUrl"),
591 OpacNav => "" . C4::Context->preference("OpacNav"),
592 OpacNavBottom => "" . C4::Context->preference("OpacNavBottom"),
593 OpacPasswordChange => C4::Context->preference("OpacPasswordChange"),
594 OPACPatronDetails => C4::Context->preference("OPACPatronDetails"),
595 OPACPrivacy => C4::Context->preference("OPACPrivacy"),
596 OPACFinesTab => C4::Context->preference("OPACFinesTab"),
597 OpacTopissue => C4::Context->preference("OpacTopissue"),
598 RequestOnOpac => C4::Context->preference("RequestOnOpac"),
599 'Version' => C4::Context->preference('Version'),
600 hidelostitems => C4::Context->preference("hidelostitems"),
601 mylibraryfirst => ( C4::Context->preference("SearchMyLibraryFirst") && C4::Context->userenv ) ? C4::Context->userenv->{'branch'} : '',
602 opacbookbag => "" . C4::Context->preference("opacbookbag"),
603 OpacFavicon => C4::Context->preference("OpacFavicon"),
604 opaclanguagesdisplay => "" . C4::Context->preference("opaclanguagesdisplay"),
605 opacreadinghistory => C4::Context->preference("opacreadinghistory"),
606 OPACUserJS => C4::Context->preference("OPACUserJS"),
607 opacuserlogin => "" . C4::Context->preference("opacuserlogin"),
608 OpenLibrarySearch => C4::Context->preference("OpenLibrarySearch"),
609 ShowReviewer => C4::Context->preference("ShowReviewer"),
610 ShowReviewerPhoto => C4::Context->preference("ShowReviewerPhoto"),
611 suggestion => "" . C4::Context->preference("suggestion"),
612 virtualshelves => "" . C4::Context->preference("virtualshelves"),
613 OPACSerialIssueDisplayCount => C4::Context->preference("OPACSerialIssueDisplayCount"),
614 SyndeticsClientCode => C4::Context->preference("SyndeticsClientCode"),
615 SyndeticsEnabled => C4::Context->preference("SyndeticsEnabled"),
616 SyndeticsCoverImages => C4::Context->preference("SyndeticsCoverImages"),
617 SyndeticsTOC => C4::Context->preference("SyndeticsTOC"),
618 SyndeticsSummary => C4::Context->preference("SyndeticsSummary"),
619 SyndeticsEditions => C4::Context->preference("SyndeticsEditions"),
620 SyndeticsExcerpt => C4::Context->preference("SyndeticsExcerpt"),
621 SyndeticsReviews => C4::Context->preference("SyndeticsReviews"),
622 SyndeticsAuthorNotes => C4::Context->preference("SyndeticsAuthorNotes"),
623 SyndeticsAwards => C4::Context->preference("SyndeticsAwards"),
624 SyndeticsSeries => C4::Context->preference("SyndeticsSeries"),
625 SyndeticsCoverImageSize => C4::Context->preference("SyndeticsCoverImageSize"),
626 OPACLocalCoverImages => C4::Context->preference("OPACLocalCoverImages"),
627 PatronSelfRegistration => C4::Context->preference("PatronSelfRegistration"),
628 PatronSelfRegistrationDefaultCategory => C4::Context->preference("PatronSelfRegistrationDefaultCategory"),
629 useDischarge => C4::Context->preference('useDischarge'),
632 $template->param( OpacPublic => '1' ) if ( $user || C4::Context->preference("OpacPublic") );
635 # Check if we were asked using parameters to force a specific language
636 if ( defined $in->{'query'}->param('language') ) {
638 # Extract the language, let C4::Languages::getlanguage choose
640 my $language = C4::Languages::getlanguage( $in->{'query'} );
641 my $languagecookie = C4::Templates::getlanguagecookie( $in->{'query'}, $language );
642 if ( ref $cookie eq 'ARRAY' ) {
643 push @{$cookie}, $languagecookie;
645 $cookie = [ $cookie, $languagecookie ];
649 return ( $template, $borrowernumber, $cookie, $flags );
654 ($userid, $cookie, $sessionID) = &checkauth($query, $noauth, $flagsrequired, $type);
656 Verifies that the user is authorized to run this script. If
657 the user is authorized, a (userid, cookie, session-id, flags)
658 quadruple is returned. If the user is not authorized but does
659 not have the required privilege (see $flagsrequired below), it
660 displays an error page and exits. Otherwise, it displays the
661 login page and exits.
663 Note that C<&checkauth> will return if and only if the user
664 is authorized, so it should be called early on, before any
665 unfinished operations (e.g., if you've opened a file, then
666 C<&checkauth> won't close it for you).
668 C<$query> is the CGI object for the script calling C<&checkauth>.
670 The C<$noauth> argument is optional. If it is set, then no
671 authorization is required for the script.
673 C<&checkauth> fetches user and session information from C<$query> and
674 ensures that the user is authorized to run scripts that require
677 The C<$flagsrequired> argument specifies the required privileges
678 the user must have if the username and password are correct.
679 It should be specified as a reference-to-hash; keys in the hash
680 should be the "flags" for the user, as specified in the Members
681 intranet module. Any key specified must correspond to a "flag"
682 in the userflags table. E.g., { circulate => 1 } would specify
683 that the user must have the "circulate" privilege in order to
684 proceed. To make sure that access control is correct, the
685 C<$flagsrequired> parameter must be specified correctly.
687 Koha also has a concept of sub-permissions, also known as
688 granular permissions. This makes the value of each key
689 in the C<flagsrequired> hash take on an additional
694 The user must have access to all subfunctions of the module
695 specified by the hash key.
699 The user must have access to at least one subfunction of the module
700 specified by the hash key.
702 specific permission, e.g., 'export_catalog'
704 The user must have access to the specific subfunction list, which
705 must correspond to a row in the permissions table.
707 The C<$type> argument specifies whether the template should be
708 retrieved from the opac or intranet directory tree. "opac" is
709 assumed if it is not specified; however, if C<$type> is specified,
710 "intranet" is assumed if it is not "opac".
712 If C<$query> does not have a valid session ID associated with it
713 (i.e., the user has not logged in) or if the session has expired,
714 C<&checkauth> presents the user with a login page (from the point of
715 view of the original script, C<&checkauth> does not return). Once the
716 user has authenticated, C<&checkauth> restarts the original script
717 (this time, C<&checkauth> returns).
719 The login page is provided using a HTML::Template, which is set in the
720 systempreferences table or at the top of this file. The variable C<$type>
721 selects which template to use, either the opac or the intranet
722 authentification template.
724 C<&checkauth> returns a user ID, a cookie, and a session ID. The
725 cookie should be sent back to the browser; it verifies that the user
735 # If version syspref is unavailable, it means Koha is being installed,
736 # and so we must redirect to OPAC maintenance page or to the WebInstaller
737 # also, if OpacMaintenance is ON, OPAC should redirect to maintenance
738 if ( C4::Context->preference('OpacMaintenance') && $type eq 'opac' ) {
739 warn "OPAC Install required, redirecting to maintenance";
740 print $query->redirect("/cgi-bin/koha/maintenance.pl");
743 unless ( $version = C4::Context->preference('Version') ) { # assignment, not comparison
744 if ( $type ne 'opac' ) {
745 warn "Install required, redirecting to Installer";
746 print $query->redirect("/cgi-bin/koha/installer/install.pl");
748 warn "OPAC Install required, redirecting to maintenance";
749 print $query->redirect("/cgi-bin/koha/maintenance.pl");
754 # check that database and koha version are the same
755 # there is no DB version, it's a fresh install,
756 # go to web installer
757 # there is a DB version, compare it to the code version
758 my $kohaversion = Koha::version();
760 # remove the 3 last . to have a Perl number
761 $kohaversion =~ s/(.*\..*)\.(.*)\.(.*)/$1$2$3/;
762 Koha::Logger->get->debug("kohaversion : $kohaversion");
763 if ( $version < $kohaversion ) {
764 my $warning = "Database update needed, redirecting to %s. Database is $version and Koha is $kohaversion";
765 if ( $type ne 'opac' ) {
766 warn sprintf( $warning, 'Installer' );
767 print $query->redirect("/cgi-bin/koha/installer/install.pl?step=1&op=updatestructure");
769 warn sprintf( "OPAC: " . $warning, 'maintenance' );
770 print $query->redirect("/cgi-bin/koha/maintenance.pl");
776 sub _timeout_syspref {
777 my $default_timeout = 600;
778 my $timeout = C4::Context->preference('timeout') || $default_timeout;
780 # value in days, convert in seconds
781 if ( $timeout =~ /^(\d+)[dD]$/ ) {
782 $timeout = $1 * 86400;
784 # value in hours, convert in seconds
785 elsif ( $timeout =~ /^(\d+)[hH]$/ ) {
786 $timeout = $1 * 3600;
788 elsif ( $timeout !~ m/^\d+$/ ) {
789 warn "The value of the system preference 'timeout' is not correct, defaulting to $default_timeout";
790 $timeout = $default_timeout;
799 # Get shibboleth login attribute
800 my $shib = C4::Context->config('useshibboleth') && shib_ok();
801 my $shib_login = $shib ? get_login_shib() : undef;
803 # $authnotrequired will be set for scripts which will run without authentication
804 my $authnotrequired = shift;
805 my $flagsrequired = shift;
807 my $emailaddress = shift;
808 my $template_name = shift;
809 $type = 'opac' unless $type;
811 unless ( C4::Context->preference("OpacPublic") ) {
812 my @allowed_scripts_for_private_opac = qw(
814 opac-registration-email-sent.tt
815 opac-registration-confirmation.tt
816 opac-memberentry-update-submitted.tt
817 opac-password-recovery.tt
819 $authnotrequired = 0 unless grep { $_ eq $template_name }
820 @allowed_scripts_for_private_opac;
823 my $dbh = C4::Context->dbh;
824 my $timeout = _timeout_syspref();
826 _version_check( $type, $query );
831 my ( $userid, $cookie, $sessionID, $flags );
832 my $logout = $query->param('logout.x');
834 my $anon_search_history;
836 # This parameter is the name of the CAS server we want to authenticate against,
837 # when using authentication against multiple CAS servers, as configured in Auth_cas_servers.yaml
838 my $casparam = $query->param('cas');
839 my $q_userid = $query->param('userid') // '';
843 # Basic authentication is incompatible with the use of Shibboleth,
844 # as Shibboleth may return REMOTE_USER as a Shibboleth attribute,
845 # and it may not be the attribute we want to use to match the koha login.
847 # Also, do not consider an empty REMOTE_USER.
849 # Finally, after those tests, we can assume (although if it would be better with
850 # a syspref) that if we get a REMOTE_USER, that's from basic authentication,
851 # and we can affect it to $userid.
852 if ( !$shib and defined( $ENV{'REMOTE_USER'} ) and $ENV{'REMOTE_USER'} ne '' and $userid = $ENV{'REMOTE_USER'} ) {
854 # Using Basic Authentication, no cookies required
855 $cookie = $query->cookie(
856 -name => 'CGISESSID',
860 -secure => ( C4::Context->https_enabled() ? 1 : 0 ),
864 elsif ( $emailaddress) {
865 # the Google OpenID Connect passes an email address
867 elsif ( $sessionID = $query->cookie("CGISESSID") ) { # assignment, not comparison
868 my ( $return, $more_info );
869 ( $return, $session, $more_info ) = check_cookie_auth( $sessionID, $flags,
870 { remote_addr => $ENV{REMOTE_ADDR}, skip_version_check => 1 }
873 if ( $return eq 'ok' ) {
874 Koha::Logger->get->debug(sprintf "AUTH_SESSION: (%s)\t%s %s - %s", map { $session->param($_) || q{} } qw(cardnumber firstname surname branch));
876 my $s_userid = $session->param('id');
879 if ( ( $query->param('koha_login_context') && ( $q_userid ne $s_userid ) )
880 || ( $cas && $query->param('ticket') && !C4::Context->userenv->{'id'} )
881 || ( $shib && $shib_login && !$logout && !C4::Context->userenv->{'id'} )
884 #if a user enters an id ne to the id in the current session, we need to log them in...
885 #first we need to clear the anonymous session...
886 $anon_search_history = $session->param('search_history');
889 C4::Context->_unset_userenv($sessionID);
893 # voluntary logout the user
894 # check wether the user was using their shibboleth session or a local one
895 my $shibSuccess = C4::Context->userenv->{'shibboleth'};
898 C4::Context->_unset_userenv($sessionID);
900 if ($cas and $caslogout) {
901 logout_cas($query, $type);
904 # If we are in a shibboleth session (shibboleth is enabled, a shibboleth match attribute is set and matches koha matchpoint)
905 if ( $shib and $shib_login and $shibSuccess) {
910 $cookie = $query->cookie(
911 -name => 'CGISESSID',
912 -value => $session->id,
914 -secure => ( C4::Context->https_enabled() ? 1 : 0 ),
917 my $sessiontype = $session->param('sessiontype') || '';
918 unless ( $sessiontype && $sessiontype eq 'anon' ) { #if this is an anonymous session, we want to update the session, but not behave as if they are logged in...
919 $flags = haspermission( $userid, $flagsrequired );
923 $info{'nopermission'} = 1;
927 } elsif ( !$logout ) {
928 if ( $return eq 'expired' ) {
929 $info{timed_out} = 1;
930 } elsif ( $return eq 'restricted' ) {
931 $info{oldip} = $more_info->{old_ip};
932 $info{newip} = $more_info->{new_ip};
933 $info{different_ip} = 1;
938 unless ( $loggedin ) {
944 #we initiate a session prior to checking for a username to allow for anonymous sessions...
945 my $session = get_session("") or die "Auth ERROR: Cannot get_session()";
947 # Save anonymous search history in new session so it can be retrieved
948 # by get_template_and_user to store it in user's search history after
949 # a successful login.
950 if ($anon_search_history) {
951 $session->param( 'search_history', $anon_search_history );
954 $sessionID = $session->id;
955 C4::Context->_new_userenv($sessionID);
956 $cookie = $query->cookie(
957 -name => 'CGISESSID',
958 -value => $sessionID,
960 -secure => ( C4::Context->https_enabled() ? 1 : 0 ),
962 my $pki_field = C4::Context->preference('AllowPKIAuth');
963 if ( !defined($pki_field) ) {
964 print STDERR "ERROR: Missing system preference AllowPKIAuth.\n";
967 if ( ( $cas && $query->param('ticket') )
969 || ( $shib && $shib_login )
970 || $pki_field ne 'None'
973 my $password = $query->param('password');
975 my ( $return, $cardnumber );
977 # If shib is enabled and we have a shib login, does the login match a valid koha user
978 if ( $shib && $shib_login ) {
981 # Do not pass password here, else shib will not be checked in checkpw.
982 ( $return, $cardnumber, $retuserid ) = checkpw( $dbh, $q_userid, undef, $query );
983 $userid = $retuserid;
984 $shibSuccess = $return;
985 $info{'invalidShibLogin'} = 1 unless ($return);
988 # If shib login and match were successful, skip further login methods
989 unless ($shibSuccess) {
990 if ( $cas && $query->param('ticket') ) {
992 ( $return, $cardnumber, $retuserid, $cas_ticket ) =
993 checkpw( $dbh, $userid, $password, $query, $type );
994 $userid = $retuserid;
995 $info{'invalidCasLogin'} = 1 unless ($return);
998 elsif ( $emailaddress ) {
999 my $value = $emailaddress;
1001 # If we're looking up the email, there's a chance that the person
1002 # doesn't have a userid. So if there is none, we pass along the
1003 # borrower number, and the bits of code that need to know the user
1004 # ID will have to be smart enough to handle that.
1005 my $patrons = Koha::Patrons->search({ email => $value });
1006 if ($patrons->count) {
1008 # First the userid, then the borrowernum
1009 my $patron = $patrons->next;
1010 $value = $patron->userid || $patron->borrowernumber;
1014 $return = $value ? 1 : 0;
1019 ( $pki_field eq 'Common Name' && $ENV{'SSL_CLIENT_S_DN_CN'} )
1020 || ( $pki_field eq 'emailAddress'
1021 && $ENV{'SSL_CLIENT_S_DN_Email'} )
1025 if ( $pki_field eq 'Common Name' ) {
1026 $value = $ENV{'SSL_CLIENT_S_DN_CN'};
1028 elsif ( $pki_field eq 'emailAddress' ) {
1029 $value = $ENV{'SSL_CLIENT_S_DN_Email'};
1031 # If we're looking up the email, there's a chance that the person
1032 # doesn't have a userid. So if there is none, we pass along the
1033 # borrower number, and the bits of code that need to know the user
1034 # ID will have to be smart enough to handle that.
1035 my $patrons = Koha::Patrons->search({ email => $value });
1036 if ($patrons->count) {
1038 # First the userid, then the borrowernum
1039 my $patron = $patrons->next;
1040 $value = $patron->userid || $patron->borrowernumber;
1046 $return = $value ? 1 : 0;
1052 my $request_method = $query->request_method();
1055 $request_method eq 'POST'
1056 || ( C4::Context->preference('AutoSelfCheckID')
1057 && $q_userid eq C4::Context->preference('AutoSelfCheckID') )
1061 ( $return, $cardnumber, $retuserid, $cas_ticket ) =
1062 checkpw( $dbh, $q_userid, $password, $query, $type );
1063 $userid = $retuserid if ($retuserid);
1064 $info{'invalid_username_or_password'} = 1 unless ($return);
1069 # If shib configured and shibOnly enabled, we should ignore anything other than a shibboleth type login.
1076 && C4::Context->preference('OPACShibOnly')
1078 || ( ( $type ne 'opac' )
1079 && C4::Context->preference('staffShibOnly') )
1086 # $return: 1 = valid user
1089 if ( $flags = haspermission( $userid, $flagsrequired ) ) {
1093 $info{'nopermission'} = 1;
1094 C4::Context->_unset_userenv($sessionID);
1096 my ( $borrowernumber, $firstname, $surname, $userflags,
1097 $branchcode, $branchname, $emailaddress, $desk_id,
1098 $desk_name, $register_id, $register_name );
1100 if ( $return == 1 ) {
1102 SELECT borrowernumber, firstname, surname, flags, borrowers.branchcode,
1103 branches.branchname as branchname, email
1105 LEFT JOIN branches on borrowers.branchcode=branches.branchcode
1107 my $sth = $dbh->prepare("$select where userid=?");
1108 $sth->execute($userid);
1109 unless ( $sth->rows ) {
1110 $sth = $dbh->prepare("$select where cardnumber=?");
1111 $sth->execute($cardnumber);
1113 unless ( $sth->rows ) {
1114 $sth->execute($userid);
1118 ( $borrowernumber, $firstname, $surname, $userflags,
1119 $branchcode, $branchname, $emailaddress ) = $sth->fetchrow;
1122 # launch a sequence to check if we have a ip for the branch, i
1123 # if we have one we replace the branchcode of the userenv by the branch bound in the ip.
1125 my $ip = $ENV{'REMOTE_ADDR'};
1127 # if they specify at login, use that
1128 if ( $query->param('branch') ) {
1129 $branchcode = $query->param('branch');
1130 my $library = Koha::Libraries->find($branchcode);
1131 $branchname = $library? $library->branchname: '';
1133 if ( $query->param('desk_id') ) {
1134 $desk_id = $query->param('desk_id');
1135 my $desk = Koha::Desks->find($desk_id);
1136 $desk_name = $desk ? $desk->desk_name : '';
1138 if ( C4::Context->preference('UseCashRegisters') ) {
1140 $query->param('register_id')
1141 ? Koha::Cash::Registers->find($query->param('register_id'))
1142 : Koha::Cash::Registers->search(
1143 { branch => $branchcode, branch_default => 1 },
1144 { rows => 1 } )->single;
1145 $register_id = $register->id if ($register);
1146 $register_name = $register->name if ($register);
1148 my $branches = { map { $_->branchcode => $_->unblessed } Koha::Libraries->search };
1149 if ( $type ne 'opac' and C4::Context->preference('AutoLocation') ) {
1151 # we have to check they are coming from the right ip range
1152 my $domain = $branches->{$branchcode}->{'branchip'};
1153 $domain =~ s|\.\*||g;
1154 if ( $ip !~ /^$domain/ ) {
1156 $cookie = $query->cookie(
1157 -name => 'CGISESSID',
1160 -secure => ( C4::Context->https_enabled() ? 1 : 0 ),
1162 $info{'wrongip'} = 1;
1166 foreach my $br ( keys %$branches ) {
1168 # now we work with the treatment of ip
1169 my $domain = $branches->{$br}->{'branchip'};
1170 if ( $domain && $ip =~ /^$domain/ ) {
1171 $branchcode = $branches->{$br}->{'branchcode'};
1173 # new op dev : add the branchname to the cookie
1174 $branchname = $branches->{$br}->{'branchname'};
1177 $session->param( 'number', $borrowernumber );
1178 $session->param( 'id', $userid );
1179 $session->param( 'cardnumber', $cardnumber );
1180 $session->param( 'firstname', $firstname );
1181 $session->param( 'surname', $surname );
1182 $session->param( 'branch', $branchcode );
1183 $session->param( 'branchname', $branchname );
1184 $session->param( 'desk_id', $desk_id);
1185 $session->param( 'desk_name', $desk_name);
1186 $session->param( 'flags', $userflags );
1187 $session->param( 'emailaddress', $emailaddress );
1188 $session->param( 'ip', $session->remote_addr() );
1189 $session->param( 'lasttime', time() );
1190 $session->param( 'interface', $type);
1191 $session->param( 'shibboleth', $shibSuccess );
1192 $session->param( 'register_id', $register_id );
1193 $session->param( 'register_name', $register_name );
1195 $session->param('cas_ticket', $cas_ticket) if $cas_ticket;
1196 C4::Context->set_userenv(
1197 $session->param('number'), $session->param('id'),
1198 $session->param('cardnumber'), $session->param('firstname'),
1199 $session->param('surname'), $session->param('branch'),
1200 $session->param('branchname'), $session->param('flags'),
1201 $session->param('emailaddress'), $session->param('shibboleth'),
1202 $session->param('desk_id'), $session->param('desk_name'),
1203 $session->param('register_id'), $session->param('register_name')
1207 # $return: 0 = invalid user
1208 # reset to anonymous session
1211 $info{'invalid_username_or_password'} = 1;
1212 C4::Context->_unset_userenv($sessionID);
1214 $session->param( 'lasttime', time() );
1215 $session->param( 'ip', $session->remote_addr() );
1216 $session->param( 'sessiontype', 'anon' );
1217 $session->param( 'interface', $type);
1219 } # END if ( $q_userid
1220 elsif ( $type eq "opac" ) {
1222 # anonymous sessions are created only for the OPAC
1224 # setting a couple of other session vars...
1225 $session->param( 'ip', $session->remote_addr() );
1226 $session->param( 'lasttime', time() );
1227 $session->param( 'sessiontype', 'anon' );
1228 $session->param( 'interface', $type);
1230 } # END unless ($userid)
1232 # finished authentification, now respond
1233 if ( $loggedin || $authnotrequired )
1237 $cookie = $query->cookie(
1238 -name => 'CGISESSID',
1241 -secure => ( C4::Context->https_enabled() ? 1 : 0 ),
1245 track_login_daily( $userid );
1247 # In case, that this request was a login attempt, we want to prevent that users can repost the opac login
1248 # request. We therefore redirect the user to the requested page again without the login parameters.
1249 # See Post/Redirect/Get (PRG) design pattern: https://en.wikipedia.org/wiki/Post/Redirect/Get
1250 if ( $type eq "opac" && $query->param('koha_login_context') && $query->param('koha_login_context') ne 'sco' && $query->param('password') && $query->param('userid') ) {
1251 my $uri = URI->new($query->url(-relative=>1, -query_string=>1));
1252 $uri->query_param_delete('userid');
1253 $uri->query_param_delete('password');
1254 $uri->query_param_delete('koha_login_context');
1255 print $query->redirect(-uri => $uri->as_string, -cookie => $cookie, -status=>'303 See other');
1259 return ( $userid, $cookie, $sessionID, $flags );
1264 # AUTH rejected, show the login/password template, after checking the DB.
1268 # get the inputs from the incoming query
1270 foreach my $name ( param $query) {
1271 (next) if ( $name eq 'userid' || $name eq 'password' || $name eq 'ticket' );
1272 my @value = $query->multi_param($name);
1273 push @inputs, { name => $name, value => $_ } for @value;
1276 my $patron = Koha::Patrons->find({ userid => $q_userid }); # Not necessary logged in!
1278 my $LibraryNameTitle = C4::Context->preference("LibraryName");
1279 $LibraryNameTitle =~ s/<(?:\/?)(?:br|p)\s*(?:\/?)>/ /sgi;
1280 $LibraryNameTitle =~ s/<(?:[^<>'"]|'(?:[^']*)'|"(?:[^"]*)")*>//sg;
1282 my $auth_template_name = ( $type eq 'opac' ) ? 'opac-auth.tt' : 'auth.tt';
1283 my $template = C4::Templates::gettemplate( $auth_template_name, $type, $query );
1287 script_name => get_script_name(),
1288 casAuthentication => C4::Context->preference("casAuthentication"),
1289 shibbolethAuthentication => $shib,
1290 suggestion => C4::Context->preference("suggestion"),
1291 virtualshelves => C4::Context->preference("virtualshelves"),
1292 LibraryName => "" . C4::Context->preference("LibraryName"),
1293 LibraryNameTitle => "" . $LibraryNameTitle,
1294 opacuserlogin => C4::Context->preference("opacuserlogin"),
1295 OpacNav => C4::Context->preference("OpacNav"),
1296 OpacNavBottom => C4::Context->preference("OpacNavBottom"),
1297 OpacFavicon => C4::Context->preference("OpacFavicon"),
1298 opacreadinghistory => C4::Context->preference("opacreadinghistory"),
1299 opaclanguagesdisplay => C4::Context->preference("opaclanguagesdisplay"),
1300 OPACUserJS => C4::Context->preference("OPACUserJS"),
1301 opacbookbag => "" . C4::Context->preference("opacbookbag"),
1302 OpacCloud => C4::Context->preference("OpacCloud"),
1303 OpacTopissue => C4::Context->preference("OpacTopissue"),
1304 OpacAuthorities => C4::Context->preference("OpacAuthorities"),
1305 OpacBrowser => C4::Context->preference("OpacBrowser"),
1306 TagsEnabled => C4::Context->preference("TagsEnabled"),
1307 OPACUserCSS => C4::Context->preference("OPACUserCSS"),
1308 intranetcolorstylesheet => C4::Context->preference("intranetcolorstylesheet"),
1309 intranetstylesheet => C4::Context->preference("intranetstylesheet"),
1310 IntranetNav => C4::Context->preference("IntranetNav"),
1311 IntranetFavicon => C4::Context->preference("IntranetFavicon"),
1312 IntranetUserCSS => C4::Context->preference("IntranetUserCSS"),
1313 IntranetUserJS => C4::Context->preference("IntranetUserJS"),
1314 IndependentBranches => C4::Context->preference("IndependentBranches"),
1315 AutoLocation => C4::Context->preference("AutoLocation"),
1316 wrongip => $info{'wrongip'},
1317 PatronSelfRegistration => C4::Context->preference("PatronSelfRegistration"),
1318 PatronSelfRegistrationDefaultCategory => C4::Context->preference("PatronSelfRegistrationDefaultCategory"),
1319 opac_css_override => $ENV{'OPAC_CSS_OVERRIDE'},
1320 too_many_login_attempts => ( $patron and $patron->account_locked )
1323 $template->param( SCO_login => 1 ) if ( $query->param('sco_user_login') );
1324 $template->param( SCI_login => 1 ) if ( $query->param('sci_user_login') );
1325 $template->param( OpacPublic => C4::Context->preference("OpacPublic") );
1326 $template->param( loginprompt => 1 ) unless $info{'nopermission'};
1328 if ( $type eq 'opac' ) {
1329 require Koha::Virtualshelves;
1330 my $some_public_shelves = Koha::Virtualshelves->get_some_shelves(
1336 some_public_shelves => $some_public_shelves,
1342 # Is authentication against multiple CAS servers enabled?
1343 if ( C4::Auth_with_cas::multipleAuth && !$casparam ) {
1344 my $casservers = C4::Auth_with_cas::getMultipleAuth();
1346 foreach my $key ( keys %$casservers ) {
1347 push @tmplservers, { name => $key, value => login_cas_url( $query, $key, $type ) . "?cas=$key" };
1350 casServersLoop => \@tmplservers
1354 casServerUrl => login_cas_url($query, undef, $type),
1359 invalidCasLogin => $info{'invalidCasLogin'}
1364 #If shibOnly is enabled just go ahead and redirect directly
1365 if ( (($type eq 'opac') && C4::Context->preference('OPACShibOnly')) || (($type ne 'opac') && C4::Context->preference('staffShibOnly')) ) {
1366 my $redirect_url = login_shib_url( $query );
1367 print $query->redirect( -uri => "$redirect_url", -status => 303 );
1372 shibbolethAuthentication => $shib,
1373 shibbolethLoginUrl => login_shib_url($query),
1377 if (C4::Context->preference('GoogleOpenIDConnect')) {
1378 if ($query->param("OpenIDConnectFailed")) {
1379 my $reason = $query->param('OpenIDConnectFailed');
1380 $template->param(invalidGoogleOpenIDConnectLogin => $reason);
1385 LibraryName => C4::Context->preference("LibraryName"),
1387 $template->param(%info);
1389 # $cookie = $query->cookie(CGISESSID => $session->id
1391 print $query->header(
1392 { type => 'text/html',
1395 'X-Frame-Options' => 'SAMEORIGIN'
1402 =head2 check_api_auth
1404 ($status, $cookie, $sessionId) = check_api_auth($query, $userflags);
1406 Given a CGI query containing the parameters 'userid' and 'password' and/or a session
1407 cookie, determine if the user has the privileges specified by C<$userflags>.
1409 C<check_api_auth> is is meant for authenticating users of web services, and
1410 consequently will always return and will not attempt to redirect the user
1413 If a valid session cookie is already present, check_api_auth will return a status
1414 of "ok", the cookie, and the Koha session ID.
1416 If no session cookie is present, check_api_auth will check the 'userid' and 'password
1417 parameters and create a session cookie and Koha session if the supplied credentials
1420 Possible return values in C<$status> are:
1424 =item "ok" -- user authenticated; C<$cookie> and C<$sessionid> have valid values.
1426 =item "failed" -- credentials are not correct; C<$cookie> and C<$sessionid> are undef
1428 =item "maintenance" -- DB is in maintenance mode; no login possible at the moment
1430 =item "expired -- session cookie has expired; API user should resubmit userid and password
1432 =item "restricted" -- The IP has changed (if SessionRestrictionByIP)
1438 sub check_api_auth {
1441 my $flagsrequired = shift;
1442 my $dbh = C4::Context->dbh;
1443 my $timeout = _timeout_syspref();
1445 unless ( C4::Context->preference('Version') ) {
1447 # database has not been installed yet
1448 return ( "maintenance", undef, undef );
1450 my $kohaversion = Koha::version();
1451 $kohaversion =~ s/(.*\..*)\.(.*)\.(.*)/$1$2$3/;
1452 if ( C4::Context->preference('Version') < $kohaversion ) {
1454 # database in need of version update; assume that
1455 # no API should be called while databsae is in
1457 return ( "maintenance", undef, undef );
1460 my ( $sessionID, $session );
1461 unless ( $query->param('userid') ) {
1462 $sessionID = $query->cookie("CGISESSID");
1464 if ( $sessionID && not( $cas && $query->param('PT') ) ) {
1467 ( $return, $session, undef ) = check_cookie_auth(
1468 $sessionID, $flagsrequired, { remote_addr => $ENV{REMOTE_ADDR} } );
1470 return ( $return, undef, undef ) # Cookie auth failed
1473 my $cookie = $query->cookie(
1474 -name => 'CGISESSID',
1475 -value => $session->id,
1477 -secure => ( C4::Context->https_enabled() ? 1 : 0 ),
1479 return ( $return, undef, $session );
1484 my $userid = $query->param('userid');
1485 my $password = $query->param('password');
1486 my ( $return, $cardnumber, $cas_ticket );
1489 if ( $cas && $query->param('PT') ) {
1492 # In case of a CAS authentication, we use the ticket instead of the password
1493 my $PT = $query->param('PT');
1494 ( $return, $cardnumber, $userid, $cas_ticket ) = check_api_auth_cas( $dbh, $PT, $query ); # EXTERNAL AUTH
1497 # User / password auth
1498 unless ( $userid and $password ) {
1500 # caller did something wrong, fail the authenticateion
1501 return ( "failed", undef, undef );
1504 ( $return, $cardnumber, $newuserid, $cas_ticket ) = checkpw( $dbh, $userid, $password, $query );
1507 if ( $return and haspermission( $userid, $flagsrequired ) ) {
1508 my $session = get_session("");
1509 return ( "failed", undef, undef ) unless $session;
1511 my $sessionID = $session->id;
1512 C4::Context->_new_userenv($sessionID);
1513 my $cookie = $query->cookie(
1514 -name => 'CGISESSID',
1515 -value => $sessionID,
1517 -secure => ( C4::Context->https_enabled() ? 1 : 0 ),
1519 if ( $return == 1 ) {
1521 $borrowernumber, $firstname, $surname,
1522 $userflags, $branchcode, $branchname,
1527 "select borrowernumber, firstname, surname, flags, borrowers.branchcode, branches.branchname as branchname, email from borrowers left join branches on borrowers.branchcode=branches.branchcode where userid=?"
1529 $sth->execute($userid);
1531 $borrowernumber, $firstname, $surname,
1532 $userflags, $branchcode, $branchname,
1534 ) = $sth->fetchrow if ( $sth->rows );
1536 unless ( $sth->rows ) {
1537 my $sth = $dbh->prepare(
1538 "select borrowernumber, firstname, surname, flags, borrowers.branchcode, branches.branchname as branchname, email from borrowers left join branches on borrowers.branchcode=branches.branchcode where cardnumber=?"
1540 $sth->execute($cardnumber);
1542 $borrowernumber, $firstname, $surname,
1543 $userflags, $branchcode, $branchname,
1545 ) = $sth->fetchrow if ( $sth->rows );
1547 unless ( $sth->rows ) {
1548 $sth->execute($userid);
1550 $borrowernumber, $firstname, $surname, $userflags,
1551 $branchcode, $branchname, $emailaddress
1552 ) = $sth->fetchrow if ( $sth->rows );
1556 my $ip = $ENV{'REMOTE_ADDR'};
1558 # if they specify at login, use that
1559 if ( $query->param('branch') ) {
1560 $branchcode = $query->param('branch');
1561 my $library = Koha::Libraries->find($branchcode);
1562 $branchname = $library? $library->branchname: '';
1564 my $branches = { map { $_->branchcode => $_->unblessed } Koha::Libraries->search };
1565 foreach my $br ( keys %$branches ) {
1567 # now we work with the treatment of ip
1568 my $domain = $branches->{$br}->{'branchip'};
1569 if ( $domain && $ip =~ /^$domain/ ) {
1570 $branchcode = $branches->{$br}->{'branchcode'};
1572 # new op dev : add the branchname to the cookie
1573 $branchname = $branches->{$br}->{'branchname'};
1576 $session->param( 'number', $borrowernumber );
1577 $session->param( 'id', $userid );
1578 $session->param( 'cardnumber', $cardnumber );
1579 $session->param( 'firstname', $firstname );
1580 $session->param( 'surname', $surname );
1581 $session->param( 'branch', $branchcode );
1582 $session->param( 'branchname', $branchname );
1583 $session->param( 'flags', $userflags );
1584 $session->param( 'emailaddress', $emailaddress );
1585 $session->param( 'ip', $session->remote_addr() );
1586 $session->param( 'lasttime', time() );
1587 $session->param( 'interface', 'api' );
1589 $session->param( 'cas_ticket', $cas_ticket);
1590 C4::Context->set_userenv(
1591 $session->param('number'), $session->param('id'),
1592 $session->param('cardnumber'), $session->param('firstname'),
1593 $session->param('surname'), $session->param('branch'),
1594 $session->param('branchname'), $session->param('flags'),
1595 $session->param('emailaddress'), $session->param('shibboleth'),
1596 $session->param('desk_id'), $session->param('desk_name'),
1597 $session->param('register_id'), $session->param('register_name')
1599 return ( "ok", $cookie, $sessionID );
1601 return ( "failed", undef, undef );
1606 =head2 check_cookie_auth
1608 ($status, $sessionId) = check_api_auth($cookie, $userflags);
1610 Given a CGISESSID cookie set during a previous login to Koha, determine
1611 if the user has the privileges specified by C<$userflags>. C<$userflags>
1612 is passed unaltered into C<haspermission> and as such accepts all options
1613 avaiable to that routine with the one caveat that C<check_api_auth> will
1614 also allow 'undef' to be passed and in such a case the permissions check
1615 will be skipped altogether.
1617 C<check_cookie_auth> is meant for authenticating special services
1618 such as tools/upload-file.pl that are invoked by other pages that
1619 have been authenticated in the usual way.
1621 Possible return values in C<$status> are:
1625 =item "ok" -- user authenticated; C<$sessionID> have valid values.
1627 =item "failed" -- credentials are not correct; C<$sessionid> are undef
1629 =item "maintenance" -- DB is in maintenance mode; no login possible at the moment
1631 =item "expired -- session cookie has expired; API user should resubmit userid and password
1633 =item "restricted" -- The IP has changed (if SessionRestrictionByIP)
1639 sub check_cookie_auth {
1640 my $sessionID = shift;
1641 my $flagsrequired = shift;
1644 my $remote_addr = $params->{remote_addr} || $ENV{REMOTE_ADDR};
1646 my $skip_version_check = $params->{skip_version_check}; # Only for checkauth
1648 unless ( $skip_version_check ) {
1649 unless ( C4::Context->preference('Version') ) {
1651 # database has not been installed yet
1652 return ( "maintenance", undef );
1654 my $kohaversion = Koha::version();
1655 $kohaversion =~ s/(.*\..*)\.(.*)\.(.*)/$1$2$3/;
1656 if ( C4::Context->preference('Version') < $kohaversion ) {
1658 # database in need of version update; assume that
1659 # no API should be called while databsae is in
1661 return ( "maintenance", undef );
1665 # see if we have a valid session cookie already
1666 # however, if a userid parameter is present (i.e., from
1667 # a form submission, assume that any current cookie
1669 unless ( defined $sessionID and $sessionID ) {
1670 return ( "failed", undef );
1672 my $session = get_session($sessionID);
1673 C4::Context->_new_userenv($sessionID);
1675 C4::Context->interface($session->param('interface'));
1676 C4::Context->set_userenv(
1677 $session->param('number'), $session->param('id') // '',
1678 $session->param('cardnumber'), $session->param('firstname'),
1679 $session->param('surname'), $session->param('branch'),
1680 $session->param('branchname'), $session->param('flags'),
1681 $session->param('emailaddress'), $session->param('shibboleth'),
1682 $session->param('desk_id'), $session->param('desk_name'),
1683 $session->param('register_id'), $session->param('register_name')
1686 my $userid = $session->param('id');
1687 my $ip = $session->param('ip');
1688 my $lasttime = $session->param('lasttime');
1689 my $timeout = _timeout_syspref();
1691 if ( !$lasttime || ( $lasttime < time() - $timeout ) ) {
1696 C4::Context->_unset_userenv($sessionID);
1697 return ("expired", undef);
1698 } elsif ( C4::Context->preference('SessionRestrictionByIP') && $ip ne $remote_addr ) {
1700 # IP address changed
1703 C4::Context->_unset_userenv($sessionID);
1704 return ( "restricted", undef, { old_ip => $ip, new_ip => $remote_addr});
1706 $session->param( 'lasttime', time() );
1707 my $flags = defined($flagsrequired) ? haspermission( $userid, $flagsrequired ) : 1;
1709 return ( "ok", $session );
1713 C4::Context->_unset_userenv($sessionID);
1714 return ( "failed", undef );
1718 return ( "expired", undef );
1725 my $session = get_session($sessionID);
1727 Given a session ID, retrieve the CGI::Session object used to store
1728 the session's state. The session object can be used to store
1729 data that needs to be accessed by different scripts during a
1732 If the C<$sessionID> parameter is an empty string, a new session
1737 sub _get_session_params {
1738 my $storage_method = C4::Context->preference('SessionStorage');
1739 if ( $storage_method eq 'mysql' ) {
1740 my $dbh = C4::Context->dbh;
1741 return { dsn => "serializer:yamlxs;driver:MySQL;id:md5", dsn_args => { Handle => $dbh } };
1743 elsif ( $storage_method eq 'Pg' ) {
1744 my $dbh = C4::Context->dbh;
1745 return { dsn => "serializer:yamlxs;driver:PostgreSQL;id:md5", dsn_args => { Handle => $dbh } };
1747 elsif ( $storage_method eq 'memcached' && Koha::Caches->get_instance->memcached_cache ) {
1748 my $memcached = Koha::Caches->get_instance()->memcached_cache;
1749 return { dsn => "serializer:yamlxs;driver:memcached;id:md5", dsn_args => { Memcached => $memcached } };
1752 # catch all defaults to tmp should work on all systems
1753 my $dir = C4::Context::temporary_directory;
1754 my $instance = C4::Context->config( 'database' ); #actually for packages not exactly the instance name, but generally safer to leave it as it is
1755 return { dsn => "serializer:yamlxs;driver:File;id:md5", dsn_args => { Directory => "$dir/cgisess_$instance" } };
1760 my $sessionID = shift;
1761 my $params = _get_session_params();
1762 my $session = CGI::Session->new( $params->{dsn}, $sessionID, $params->{dsn_args} );
1764 die CGI::Session->errstr();
1770 # FIXME no_set_userenv may be replaced with force_branchcode_for_userenv
1771 # (or something similar)
1772 # Currently it's only passed from C4::SIP::ILS::Patron::check_password, but
1773 # not having a userenv defined could cause a crash.
1775 my ( $dbh, $userid, $password, $query, $type, $no_set_userenv ) = @_;
1776 $type = 'opac' unless $type;
1778 # Get shibboleth login attribute
1779 my $shib = C4::Context->config('useshibboleth') && shib_ok();
1780 my $shib_login = $shib ? get_login_shib() : undef;
1784 if ( defined $userid ){
1785 $patron = Koha::Patrons->find({ userid => $userid });
1786 $patron = Koha::Patrons->find({ cardnumber => $userid }) unless $patron;
1788 my $check_internal_as_fallback = 0;
1790 # Note: checkpw_* routines returns:
1793 # -1 if user bind failed (LDAP only)
1795 if ( $patron and $patron->account_locked ) {
1796 # Nothing to check, account is locked
1797 } elsif ($ldap && defined($password)) {
1798 my ( $retval, $retcard, $retuserid ) = checkpw_ldap(@_); # EXTERNAL AUTH
1799 if ( $retval == 1 ) {
1800 @return = ( $retval, $retcard, $retuserid );
1803 $check_internal_as_fallback = 1 if $retval == 0;
1805 } elsif ( $cas && $query && $query->param('ticket') ) {
1807 # In case of a CAS authentication, we use the ticket instead of the password
1808 my $ticket = $query->param('ticket');
1809 $query->delete('ticket'); # remove ticket to come back to original URL
1810 my ( $retval, $retcard, $retuserid, $cas_ticket ) = checkpw_cas( $dbh, $ticket, $query, $type ); # EXTERNAL AUTH
1812 @return = ( $retval, $retcard, $retuserid, $cas_ticket );
1816 $passwd_ok = $retval;
1819 # If we are in a shibboleth session (shibboleth is enabled, and a shibboleth match attribute is present)
1820 # Check for password to asertain whether we want to be testing against shibboleth or another method this
1822 elsif ( $shib && $shib_login && !$password ) {
1824 # In case of a Shibboleth authentication, we expect a shibboleth user attribute
1825 # (defined under shibboleth mapping in koha-conf.xml) to contain the login of the
1826 # shibboleth-authenticated user
1828 # Then, we check if it matches a valid koha user
1830 my ( $retval, $retcard, $retuserid ) = C4::Auth_with_shibboleth::checkpw_shib($shib_login); # EXTERNAL AUTH
1832 @return = ( $retval, $retcard, $retuserid );
1834 $passwd_ok = $retval;
1837 $check_internal_as_fallback = 1;
1841 if ( $check_internal_as_fallback ) {
1842 @return = checkpw_internal( $dbh, $userid, $password, $no_set_userenv);
1843 $passwd_ok = 1 if $return[0] > 0; # 1 or 2
1848 $patron->update({ login_attempts => 0 });
1849 } elsif( !$patron->account_locked ) {
1850 $patron->update({ login_attempts => $patron->login_attempts + 1 });
1854 # Optionally log success or failure
1855 if( $patron && $passwd_ok && C4::Context->preference('AuthSuccessLog') ) {
1856 logaction( 'AUTH', 'SUCCESS', $patron->id, "Valid password for $userid", $type );
1857 } elsif( !$passwd_ok && C4::Context->preference('AuthFailureLog') ) {
1858 logaction( 'AUTH', 'FAILURE', $patron ? $patron->id : 0, "Wrong password for $userid", $type );
1864 sub checkpw_internal {
1865 my ( $dbh, $userid, $password, $no_set_userenv ) = @_;
1867 $password = Encode::encode( 'UTF-8', $password )
1868 if Encode::is_utf8($password);
1872 "select password,cardnumber,borrowernumber,userid,firstname,surname,borrowers.branchcode,branches.branchname,flags from borrowers join branches on borrowers.branchcode=branches.branchcode where userid=?"
1874 $sth->execute($userid);
1876 my ( $stored_hash, $cardnumber, $borrowernumber, $userid, $firstname,
1877 $surname, $branchcode, $branchname, $flags )
1880 if ( checkpw_hash( $password, $stored_hash ) ) {
1882 C4::Context->set_userenv( "$borrowernumber", $userid, $cardnumber,
1883 $firstname, $surname, $branchcode, $branchname, $flags ) unless $no_set_userenv;
1884 return 1, $cardnumber, $userid;
1889 "select password,cardnumber,borrowernumber,userid,firstname,surname,borrowers.branchcode,branches.branchname,flags from borrowers join branches on borrowers.branchcode=branches.branchcode where cardnumber=?"
1891 $sth->execute($userid);
1893 my ( $stored_hash, $cardnumber, $borrowernumber, $userid, $firstname,
1894 $surname, $branchcode, $branchname, $flags )
1897 if ( checkpw_hash( $password, $stored_hash ) ) {
1899 C4::Context->set_userenv( $borrowernumber, $userid, $cardnumber,
1900 $firstname, $surname, $branchcode, $branchname, $flags ) unless $no_set_userenv;
1901 return 1, $cardnumber, $userid;
1908 my ( $password, $stored_hash ) = @_;
1910 return if $stored_hash eq '!';
1912 # check what encryption algorithm was implemented: Bcrypt - if the hash starts with '$2' it is Bcrypt else md5
1914 if ( substr( $stored_hash, 0, 2 ) eq '$2' ) {
1915 $hash = hash_password( $password, $stored_hash );
1917 $hash = md5_base64($password);
1919 return $hash eq $stored_hash;
1924 my $authflags = getuserflags($flags, $userid, [$dbh]);
1926 Translates integer flags into permissions strings hash.
1928 C<$flags> is the integer userflags value ( borrowers.userflags )
1929 C<$userid> is the members.userid, used for building subpermissions
1930 C<$authflags> is a hashref of permissions
1937 my $dbh = @_ ? shift : C4::Context->dbh;
1940 # I don't want to do this, but if someone logs in as the database
1941 # user, it would be preferable not to spam them to death with
1942 # numeric warnings. So, we make $flags numeric.
1943 no warnings 'numeric';
1946 my $sth = $dbh->prepare("SELECT bit, flag, defaulton FROM userflags");
1949 while ( my ( $bit, $flag, $defaulton ) = $sth->fetchrow ) {
1950 if ( ( $flags & ( 2**$bit ) ) || $defaulton ) {
1951 $userflags->{$flag} = 1;
1954 $userflags->{$flag} = 0;
1958 # get subpermissions and merge with top-level permissions
1959 my $user_subperms = get_user_subpermissions($userid);
1960 foreach my $module ( keys %$user_subperms ) {
1961 next if $userflags->{$module} == 1; # user already has permission for everything in this module
1962 $userflags->{$module} = $user_subperms->{$module};
1968 =head2 get_user_subpermissions
1970 $user_perm_hashref = get_user_subpermissions($userid);
1972 Given the userid (note, not the borrowernumber) of a staff user,
1973 return a hashref of hashrefs of the specific subpermissions
1974 accorded to the user. An example return is
1978 export_catalog => 1,
1979 import_patrons => 1,
1983 The top-level hash-key is a module or function code from
1984 userflags.flag, while the second-level key is a code
1987 The results of this function do not give a complete picture
1988 of the functions that a staff user can access; it is also
1989 necessary to check borrowers.flags.
1993 sub get_user_subpermissions {
1996 my $dbh = C4::Context->dbh;
1997 my $sth = $dbh->prepare( "SELECT flag, user_permissions.code
1998 FROM user_permissions
1999 JOIN permissions USING (module_bit, code)
2000 JOIN userflags ON (module_bit = bit)
2001 JOIN borrowers USING (borrowernumber)
2002 WHERE userid = ?" );
2003 $sth->execute($userid);
2005 my $user_perms = {};
2006 while ( my $perm = $sth->fetchrow_hashref ) {
2007 $user_perms->{ $perm->{'flag'} }->{ $perm->{'code'} } = 1;
2012 =head2 get_all_subpermissions
2014 my $perm_hashref = get_all_subpermissions();
2016 Returns a hashref of hashrefs defining all specific
2017 permissions currently defined. The return value
2018 has the same structure as that of C<get_user_subpermissions>,
2019 except that the innermost hash value is the description
2020 of the subpermission.
2024 sub get_all_subpermissions {
2025 my $dbh = C4::Context->dbh;
2026 my $sth = $dbh->prepare( "SELECT flag, code
2028 JOIN userflags ON (module_bit = bit)" );
2032 while ( my $perm = $sth->fetchrow_hashref ) {
2033 $all_perms->{ $perm->{'flag'} }->{ $perm->{'code'} } = 1;
2038 =head2 haspermission
2040 $flagsrequired = '*'; # Any permission at all
2041 $flagsrequired = 'a_flag'; # a_flag must be satisfied (all subpermissions)
2042 $flagsrequired = [ 'a_flag', 'b_flag' ]; # a_flag OR b_flag must be satisfied
2043 $flagsrequired = { 'a_flag => 1, 'b_flag' => 1 }; # a_flag AND b_flag must be satisfied
2044 $flagsrequired = { 'a_flag' => 'sub_a' }; # sub_a of a_flag must be satisfied
2045 $flagsrequired = { 'a_flag' => [ 'sub_a, 'sub_b' ] }; # sub_a OR sub_b of a_flag must be satisfied
2047 $flags = ($userid, $flagsrequired);
2049 C<$userid> the userid of the member
2050 C<$flags> is a query structure similar to that used by SQL::Abstract that
2051 denotes the combination of flags required. It is a required parameter.
2053 The main logic of this method is that things in arrays are OR'ed, and things
2054 in hashes are AND'ed. The `*` character can be used, at any depth, to denote `ANY`
2056 Returns member's flags or 0 if a permission is not met.
2061 my ($required, $flags) = @_;
2063 my $ref = ref($required);
2065 if ($required eq '*') {
2066 return 0 unless ( $flags or ref( $flags ) );
2068 return 0 unless ( $flags and (!ref( $flags ) || $flags->{$required} ));
2070 } elsif ($ref eq 'HASH') {
2071 foreach my $key (keys %{$required}) {
2072 next if $flags == 1;
2073 my $require = $required->{$key};
2074 my $rflags = $flags->{$key};
2075 return 0 unless _dispatch($require, $rflags);
2077 } elsif ($ref eq 'ARRAY') {
2079 foreach my $require ( @{$required} ) {
2081 ( ref($flags) && !ref($require) && ( $require ne '*' ) )
2082 ? $flags->{$require}
2084 $satisfied++ if _dispatch( $require, $rflags );
2086 return 0 unless $satisfied;
2088 croak "Unexpected structure found: $ref";
2095 my ( $userid, $flagsrequired ) = @_;
2097 #Koha::Exceptions::WrongParameter->throw('$flagsrequired should not be undef')
2098 # unless defined($flagsrequired);
2100 my $sth = C4::Context->dbh->prepare("SELECT flags FROM borrowers WHERE userid=?");
2101 $sth->execute($userid);
2102 my $row = $sth->fetchrow();
2103 my $flags = getuserflags( $row, $userid );
2105 return $flags unless defined($flagsrequired);
2106 return $flags if $flags->{superlibrarian};
2107 return _dispatch($flagsrequired, $flags);
2109 #FIXME - This fcn should return the failed permission so a suitable error msg can be delivered.
2114 $flags = ($iprange);
2116 C<$iprange> A space separated string describing an IP range. Can include single IPs or ranges
2118 Returns 1 if the remote address is in the provided iprange, or 0 otherwise.
2125 my @allowedipranges = $iprange ? split(' ', $iprange) : ();
2126 if (scalar @allowedipranges > 0) {
2128 eval { @rangelist = Net::CIDR::range2cidr(@allowedipranges); }; return 0 if $@;
2129 eval { $result = Net::CIDR::cidrlookup($ENV{'REMOTE_ADDR'}, @rangelist) } || Koha::Logger->get->warn('cidrlookup failed for ' . join(' ',@rangelist) );
2131 return $result ? 1 : 0;
2134 sub getborrowernumber {
2136 my $userenv = C4::Context->userenv;
2137 if ( defined($userenv) && ref($userenv) eq 'HASH' && $userenv->{number} ) {
2138 return $userenv->{number};
2140 my $dbh = C4::Context->dbh;
2141 for my $field ( 'userid', 'cardnumber' ) {
2143 $dbh->prepare("select borrowernumber from borrowers where $field=?");
2144 $sth->execute($userid);
2146 my ($bnumber) = $sth->fetchrow;
2153 =head2 track_login_daily
2155 track_login_daily( $userid );
2157 Wraps the call to $patron->track_login, the method used to update borrowers.lastseen. We only call track_login once a day.
2161 sub track_login_daily {
2163 return if !$userid || !C4::Context->preference('TrackLastPatronActivity');
2165 my $cache = Koha::Caches->get_instance();
2166 my $cache_key = "track_login_" . $userid;
2167 my $cached = $cache->get_from_cache($cache_key);
2168 my $today = dt_from_string()->ymd;
2169 return if $cached && $cached eq $today;
2171 my $patron = Koha::Patrons->find({ userid => $userid });
2172 return unless $patron;
2173 $patron->track_login;
2174 $cache->set_in_cache( $cache_key, $today );
2177 END { } # module clean-up code here (global destructor)
2187 Crypt::Eksblowfish::Bcrypt(3)