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 );
158 # Get shibboleth login attribute
159 my $shib = C4::Context->config('useshibboleth') && shib_ok();
160 my $shib_login = $shib ? get_login_shib() : undef;
162 C4::Context->interface( $in->{type} );
164 $in->{'authnotrequired'} ||= 0;
166 # the following call includes a bad template check; might croak
167 my $template = C4::Templates::gettemplate(
168 $in->{'template_name'},
173 if ( $in->{'template_name'} !~ m/maintenance/ ) {
174 ( $user, $cookie, $sessionID, $flags ) = checkauth(
176 $in->{'authnotrequired'},
177 $in->{'flagsrequired'},
180 $in->{template_name},
184 # If we enforce GDPR and the user did not consent, redirect
185 # Exceptions for consent page itself and SCI/SCO system
186 if( $in->{type} eq 'opac' && $user &&
187 $in->{'template_name'} !~ /^(opac-patron-consent|sc[io]\/)/ &&
188 C4::Context->preference('GDPR_Policy') eq 'Enforced' )
190 my $consent = Koha::Patron::Consents->search({
191 borrowernumber => getborrowernumber($user),
192 type => 'GDPR_PROCESSING',
193 given_on => { '!=', undef },
196 print $in->{query}->redirect(-uri => '/cgi-bin/koha/opac-patron-consent.pl', -cookie => $cookie);
201 if ( $in->{type} eq 'opac' && $user ) {
204 my $session = get_session($sessionID);
206 $is_sco_user = $session->param('sco_user');
212 # If the user logged in is the SCO user and they try to go out of the SCO module,
213 # log the user out removing the CGISESSID cookie
214 $in->{template_name} !~ m|sco/| && $in->{template_name} !~ m|errors/errorpage.tt|
218 C4::Context->preference('AutoSelfCheckID')
219 && $user eq C4::Context->preference('AutoSelfCheckID')
227 # If the user logged in is the SCI user and they try to go out of the SCI module,
228 # kick them out unless it is SCO with a valid permission
229 # or they are a superlibrarian
230 $in->{template_name} !~ m|sci/|
231 && haspermission( $user, { self_check => 'self_checkin_module' } )
233 $in->{template_name} =~ m|sco/| && haspermission(
234 $user, { self_check => 'self_checkout_module' }
237 && $flags && $flags->{superlibrarian} != 1
244 $template = C4::Templates::gettemplate( 'opac-auth.tt', 'opac',
246 $cookie = $in->{query}->cookie(
247 -name => 'CGISESSID',
251 -secure => ( C4::Context->https_enabled() ? 1 : 0 ),
256 script_name => get_script_name(),
259 print $in->{query}->header(
264 'X-Frame-Options' => 'SAMEORIGIN'
275 # It's possible for $user to be the borrowernumber if they don't have a
276 # userid defined (and are logging in through some other method, such
277 # as SSL certs against an email address)
279 $borrowernumber = getborrowernumber($user) if defined($user);
280 if ( !defined($borrowernumber) && defined($user) ) {
281 $patron = Koha::Patrons->find( $user );
283 $borrowernumber = $user;
285 # A bit of a hack, but I don't know there's a nicer way
287 $user = $patron->firstname . ' ' . $patron->surname;
290 $patron = Koha::Patrons->find( $borrowernumber );
291 # FIXME What to do if $patron does not exist?
295 $template->param( loggedinusername => $user ); # OBSOLETE - Do not reuse this in template, use logged_in_user.userid instead
296 $template->param( loggedinusernumber => $borrowernumber ); # FIXME Should be replaced with logged_in_user.borrowernumber
297 $template->param( logged_in_user => $patron );
298 $template->param( sessionID => $sessionID );
300 if ( $in->{'type'} eq 'opac' ) {
301 require Koha::Virtualshelves;
302 my $some_private_shelves = Koha::Virtualshelves->get_some_shelves(
304 borrowernumber => $borrowernumber,
308 my $some_public_shelves = Koha::Virtualshelves->get_some_shelves(
314 some_private_shelves => $some_private_shelves,
315 some_public_shelves => $some_public_shelves,
319 my $all_perms = get_all_subpermissions();
321 my @flagroots = qw(circulate catalogue parameters borrowers permissions reserveforothers borrow
322 editcatalogue updatecharges tools editauthorities serials reports acquisition clubs problem_reports);
324 # We are going to use the $flags returned by checkauth
325 # to create the template's parameters that will indicate
326 # which menus the user can access.
327 if ( $flags && $flags->{superlibrarian} == 1 ) {
328 $template->param( CAN_user_circulate => 1 );
329 $template->param( CAN_user_catalogue => 1 );
330 $template->param( CAN_user_parameters => 1 );
331 $template->param( CAN_user_borrowers => 1 );
332 $template->param( CAN_user_permissions => 1 );
333 $template->param( CAN_user_reserveforothers => 1 );
334 $template->param( CAN_user_editcatalogue => 1 );
335 $template->param( CAN_user_updatecharges => 1 );
336 $template->param( CAN_user_acquisition => 1 );
337 $template->param( CAN_user_suggestions => 1 );
338 $template->param( CAN_user_tools => 1 );
339 $template->param( CAN_user_editauthorities => 1 );
340 $template->param( CAN_user_serials => 1 );
341 $template->param( CAN_user_reports => 1 );
342 $template->param( CAN_user_staffaccess => 1 );
343 $template->param( CAN_user_coursereserves => 1 );
344 $template->param( CAN_user_plugins => 1 );
345 $template->param( CAN_user_lists => 1 );
346 $template->param( CAN_user_clubs => 1 );
347 $template->param( CAN_user_ill => 1 );
348 $template->param( CAN_user_stockrotation => 1 );
349 $template->param( CAN_user_cash_management => 1 );
350 $template->param( CAN_user_problem_reports => 1 );
351 $template->param( CAN_user_recalls => 1 );
353 foreach my $module ( keys %$all_perms ) {
354 foreach my $subperm ( keys %{ $all_perms->{$module} } ) {
355 $template->param( "CAN_user_${module}_${subperm}" => 1 );
361 foreach my $module ( keys %$all_perms ) {
362 if ( defined($flags->{$module}) && $flags->{$module} == 1 ) {
363 foreach my $subperm ( keys %{ $all_perms->{$module} } ) {
364 $template->param( "CAN_user_${module}_${subperm}" => 1 );
366 } elsif ( ref( $flags->{$module} ) ) {
367 foreach my $subperm ( keys %{ $flags->{$module} } ) {
368 $template->param( "CAN_user_${module}_${subperm}" => 1 );
375 foreach my $module ( keys %$flags ) {
376 if ( $flags->{$module} == 1 or ref( $flags->{$module} ) ) {
377 $template->param( "CAN_user_$module" => 1 );
382 # Logged-in opac search history
383 # If the requested template is an opac one and opac search history is enabled
384 if ( $in->{type} eq 'opac' && C4::Context->preference('EnableOpacSearchHistory') ) {
385 my $dbh = C4::Context->dbh;
386 my $query = "SELECT COUNT(*) FROM search_history WHERE userid=?";
387 my $sth = $dbh->prepare($query);
388 $sth->execute($borrowernumber);
390 # If at least one search has already been performed
391 if ( $sth->fetchrow_array > 0 ) {
393 # We show the link in opac
394 $template->param( EnableOpacSearchHistory => 1 );
396 if (C4::Context->preference('LoadSearchHistoryToTheFirstLoggedUser'))
398 # And if there are searches performed when the user was not logged in,
399 # we add them to the logged-in search history
400 my @recentSearches = C4::Search::History::get_from_session( { cgi => $in->{'query'} } );
401 if (@recentSearches) {
402 my $dbh = C4::Context->dbh;
404 INSERT INTO search_history(userid, sessionid, query_desc, query_cgi, type, total, time )
405 VALUES (?, ?, ?, ?, ?, ?, ?)
407 my $sth = $dbh->prepare($query);
408 $sth->execute( $borrowernumber,
409 $in->{query}->cookie("CGISESSID"),
412 $_->{type} || 'biblio',
415 ) foreach @recentSearches;
417 # clear out the search history from the session now that
418 # we've saved it to the database
421 C4::Search::History::set_to_session( { cgi => $in->{'query'}, search_history => [] } );
423 } elsif ( $in->{type} eq 'intranet' and C4::Context->preference('EnableSearchHistory') ) {
424 $template->param( EnableSearchHistory => 1 );
427 else { # if this is an anonymous session, setup to display public lists...
429 # If shibboleth is enabled, and we're in an anonymous session, we should allow
430 # the user to attempt login via shibboleth.
432 $template->param( shibbolethAuthentication => $shib,
433 shibbolethLoginUrl => login_shib_url( $in->{'query'} ),
436 # If shibboleth is enabled and we have a shibboleth login attribute,
437 # but we are in an anonymous session, then we clearly have an invalid
438 # shibboleth koha account.
440 $template->param( invalidShibLogin => '1' );
444 $template->param( sessionID => $sessionID );
446 if ( $in->{'type'} eq 'opac' ){
447 require Koha::Virtualshelves;
448 my $some_public_shelves = Koha::Virtualshelves->get_some_shelves(
454 some_public_shelves => $some_public_shelves,
457 # Set default branch if one has been passed by the environment.
458 $template->param( default_branch => $ENV{OPAC_BRANCH_DEFAULT} ) if $ENV{OPAC_BRANCH_DEFAULT};
462 # Sysprefs disabled via URL param
463 # Note that value must be defined in order to override via ENV
464 foreach my $syspref (
470 OpacAdditionalStylesheet
472 intranetcolorstylesheet
477 $ENV{"OVERRIDE_SYSPREF_$syspref"} = q{}
478 if $in->{'query'}->param("DISABLE_SYSPREF_$syspref");
481 # Anonymous opac search history
482 # If opac search history is enabled and at least one search has already been performed
483 if ( C4::Context->preference('EnableOpacSearchHistory') ) {
484 my @recentSearches = C4::Search::History::get_from_session( { cgi => $in->{'query'} } );
485 if (@recentSearches) {
486 $template->param( EnableOpacSearchHistory => 1 );
490 if ( C4::Context->preference('dateformat') ) {
491 $template->param( dateformat => C4::Context->preference('dateformat') );
494 $template->param(auth_forwarded_hash => scalar $in->{'query'}->param('auth_forwarded_hash'));
496 # these template parameters are set the same regardless of $in->{'type'}
498 my $minPasswordLength = C4::Context->preference('minPasswordLength');
499 $minPasswordLength = 3 if not $minPasswordLength or $minPasswordLength < 3;
501 "BiblioDefaultView" . C4::Context->preference("BiblioDefaultView") => 1,
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 "BiblioDefaultView" . C4::Context->preference("IntranetBiblioDefaultView") => 1,
524 PatronAutoComplete => C4::Context->preference("PatronAutoComplete"),
525 FRBRizeEditions => C4::Context->preference("FRBRizeEditions"),
526 IndependentBranches => C4::Context->preference("IndependentBranches"),
527 IntranetNav => C4::Context->preference("IntranetNav"),
528 IntranetmainUserblock => C4::Context->preference("IntranetmainUserblock"),
529 LibraryName => C4::Context->preference("LibraryName"),
530 advancedMARCEditor => C4::Context->preference("advancedMARCEditor"),
531 canreservefromotherbranches => C4::Context->preference('canreservefromotherbranches'),
532 intranetcolorstylesheet => C4::Context->preference("intranetcolorstylesheet"),
533 IntranetFavicon => C4::Context->preference("IntranetFavicon"),
534 intranetreadinghistory => C4::Context->preference("intranetreadinghistory"),
535 intranetstylesheet => C4::Context->preference("intranetstylesheet"),
536 IntranetUserCSS => C4::Context->preference("IntranetUserCSS"),
537 IntranetUserJS => C4::Context->preference("IntranetUserJS"),
538 suggestion => C4::Context->preference("suggestion"),
539 virtualshelves => C4::Context->preference("virtualshelves"),
540 StaffSerialIssueDisplayCount => C4::Context->preference("StaffSerialIssueDisplayCount"),
541 EasyAnalyticalRecords => C4::Context->preference('EasyAnalyticalRecords'),
542 LocalCoverImages => C4::Context->preference('LocalCoverImages'),
543 OPACLocalCoverImages => C4::Context->preference('OPACLocalCoverImages'),
544 AllowMultipleCovers => C4::Context->preference('AllowMultipleCovers'),
545 EnableBorrowerFiles => C4::Context->preference('EnableBorrowerFiles'),
546 UseCourseReserves => C4::Context->preference("UseCourseReserves"),
547 useDischarge => C4::Context->preference('useDischarge'),
548 pending_checkout_notes => Koha::Checkouts->search({ noteseen => 0 }),
552 warn "template type should be OPAC, here it is=[" . $in->{'type'} . "]" unless ( $in->{'type'} eq 'opac' );
554 #TODO : replace LibraryName syspref with 'system name', and remove this html processing
555 my $LibraryNameTitle = C4::Context->preference("LibraryName");
556 $LibraryNameTitle =~ s/<(?:\/?)(?:br|p)\s*(?:\/?)>/ /sgi;
557 $LibraryNameTitle =~ s/<(?:[^<>'"]|'(?:[^']*)'|"(?:[^"]*)")*>//sg;
559 # clean up the busc param in the session
560 # if the page is not opac-detail and not the "add to list" page
561 # and not the "edit comments" page
562 if ( C4::Context->preference("OpacBrowseResults")
563 && $in->{'template_name'} =~ /opac-(.+)\.(?:tt|tmpl)$/ ) {
565 unless ( $pagename =~ /^(?:MARC|ISBD)?detail$/
566 or $pagename =~ /^showmarc$/
567 or $pagename =~ /^addbybiblionumber$/
568 or $pagename =~ /^review$/ )
570 my $sessionSearch = get_session( $sessionID );
571 $sessionSearch->clear( ["busc"] ) if $sessionSearch;
575 # variables passed from CGI: opac_css_override and opac_search_limits.
576 my $opac_search_limit = $ENV{'OPAC_SEARCH_LIMIT'};
577 my $opac_limit_override = $ENV{'OPAC_LIMIT_OVERRIDE'};
580 ( $opac_limit_override && $opac_search_limit && $opac_search_limit =~ /branch:([\w-]+)/ ) ||
581 ( $in->{'query'}->param('limit') && $in->{'query'}->param('limit') =~ /branch:([\w-]+)/ ) ||
582 ( $in->{'query'}->param('limit') && $in->{'query'}->param('limit') =~ /multibranchlimit:(\w+)/ )
584 $opac_name = $1; # opac_search_limit is a branch, so we use it.
585 } elsif ( $in->{'query'}->param('multibranchlimit') ) {
586 $opac_name = $in->{'query'}->param('multibranchlimit');
587 } elsif ( C4::Context->preference("SearchMyLibraryFirst") && C4::Context->userenv && C4::Context->userenv->{'branch'} ) {
588 $opac_name = C4::Context->userenv->{'branch'};
591 my @search_groups = Koha::Library::Groups->get_search_groups({ interface => 'opac' })->as_list;
593 AnonSuggestions => "" . C4::Context->preference("AnonSuggestions"),
594 LibrarySearchGroups => \@search_groups,
595 opac_name => $opac_name,
596 LibraryName => "" . C4::Context->preference("LibraryName"),
597 LibraryNameTitle => "" . $LibraryNameTitle,
598 OPACAmazonCoverImages => C4::Context->preference("OPACAmazonCoverImages"),
599 OPACFRBRizeEditions => C4::Context->preference("OPACFRBRizeEditions"),
600 OpacHighlightedWords => C4::Context->preference("OpacHighlightedWords"),
601 OPACShelfBrowser => "" . C4::Context->preference("OPACShelfBrowser"),
602 OPACURLOpenInNewWindow => "" . C4::Context->preference("OPACURLOpenInNewWindow"),
603 OPACUserCSS => "" . C4::Context->preference("OPACUserCSS"),
604 OpacAuthorities => C4::Context->preference("OpacAuthorities"),
605 opac_css_override => $ENV{'OPAC_CSS_OVERRIDE'},
606 opac_search_limit => $opac_search_limit,
607 opac_limit_override => $opac_limit_override,
608 OpacBrowser => C4::Context->preference("OpacBrowser"),
609 OpacCloud => C4::Context->preference("OpacCloud"),
610 OpacKohaUrl => C4::Context->preference("OpacKohaUrl"),
611 OpacPasswordChange => C4::Context->preference("OpacPasswordChange"),
612 OPACPatronDetails => C4::Context->preference("OPACPatronDetails"),
613 OPACPrivacy => C4::Context->preference("OPACPrivacy"),
614 OPACFinesTab => C4::Context->preference("OPACFinesTab"),
615 OpacTopissue => C4::Context->preference("OpacTopissue"),
616 'Version' => C4::Context->preference('Version'),
617 hidelostitems => C4::Context->preference("hidelostitems"),
618 mylibraryfirst => ( C4::Context->preference("SearchMyLibraryFirst") && C4::Context->userenv ) ? C4::Context->userenv->{'branch'} : '',
619 opacbookbag => "" . C4::Context->preference("opacbookbag"),
620 OpacFavicon => C4::Context->preference("OpacFavicon"),
621 opaclanguagesdisplay => "" . C4::Context->preference("opaclanguagesdisplay"),
622 opacreadinghistory => C4::Context->preference("opacreadinghistory"),
623 OPACUserJS => C4::Context->preference("OPACUserJS"),
624 opacuserlogin => "" . C4::Context->preference("opacuserlogin"),
625 OpenLibrarySearch => C4::Context->preference("OpenLibrarySearch"),
626 ShowReviewer => C4::Context->preference("ShowReviewer"),
627 ShowReviewerPhoto => C4::Context->preference("ShowReviewerPhoto"),
628 suggestion => "" . C4::Context->preference("suggestion"),
629 virtualshelves => "" . C4::Context->preference("virtualshelves"),
630 OPACSerialIssueDisplayCount => C4::Context->preference("OPACSerialIssueDisplayCount"),
631 SyndeticsClientCode => C4::Context->preference("SyndeticsClientCode"),
632 SyndeticsEnabled => C4::Context->preference("SyndeticsEnabled"),
633 SyndeticsCoverImages => C4::Context->preference("SyndeticsCoverImages"),
634 SyndeticsTOC => C4::Context->preference("SyndeticsTOC"),
635 SyndeticsSummary => C4::Context->preference("SyndeticsSummary"),
636 SyndeticsEditions => C4::Context->preference("SyndeticsEditions"),
637 SyndeticsExcerpt => C4::Context->preference("SyndeticsExcerpt"),
638 SyndeticsReviews => C4::Context->preference("SyndeticsReviews"),
639 SyndeticsAuthorNotes => C4::Context->preference("SyndeticsAuthorNotes"),
640 SyndeticsAwards => C4::Context->preference("SyndeticsAwards"),
641 SyndeticsSeries => C4::Context->preference("SyndeticsSeries"),
642 SyndeticsCoverImageSize => C4::Context->preference("SyndeticsCoverImageSize"),
643 OPACLocalCoverImages => C4::Context->preference("OPACLocalCoverImages"),
644 PatronSelfRegistration => C4::Context->preference("PatronSelfRegistration"),
645 PatronSelfRegistrationDefaultCategory => C4::Context->preference("PatronSelfRegistrationDefaultCategory"),
646 useDischarge => C4::Context->preference('useDischarge'),
649 $template->param( OpacPublic => '1' ) if ( $user || C4::Context->preference("OpacPublic") );
652 # Check if we were asked using parameters to force a specific language
653 if ( defined $in->{'query'}->param('language') ) {
655 # Extract the language, let C4::Languages::getlanguage choose
657 my $language = C4::Languages::getlanguage( $in->{'query'} );
658 my $languagecookie = C4::Templates::getlanguagecookie( $in->{'query'}, $language );
659 if ( ref $cookie eq 'ARRAY' ) {
660 push @{$cookie}, $languagecookie;
662 $cookie = [ $cookie, $languagecookie ];
666 return ( $template, $borrowernumber, $cookie, $flags );
671 ($userid, $cookie, $sessionID) = &checkauth($query, $noauth, $flagsrequired, $type);
673 Verifies that the user is authorized to run this script. If
674 the user is authorized, a (userid, cookie, session-id, flags)
675 quadruple is returned. If the user is not authorized but does
676 not have the required privilege (see $flagsrequired below), it
677 displays an error page and exits. Otherwise, it displays the
678 login page and exits.
680 Note that C<&checkauth> will return if and only if the user
681 is authorized, so it should be called early on, before any
682 unfinished operations (e.g., if you've opened a file, then
683 C<&checkauth> won't close it for you).
685 C<$query> is the CGI object for the script calling C<&checkauth>.
687 The C<$noauth> argument is optional. If it is set, then no
688 authorization is required for the script.
690 C<&checkauth> fetches user and session information from C<$query> and
691 ensures that the user is authorized to run scripts that require
694 The C<$flagsrequired> argument specifies the required privileges
695 the user must have if the username and password are correct.
696 It should be specified as a reference-to-hash; keys in the hash
697 should be the "flags" for the user, as specified in the Members
698 intranet module. Any key specified must correspond to a "flag"
699 in the userflags table. E.g., { circulate => 1 } would specify
700 that the user must have the "circulate" privilege in order to
701 proceed. To make sure that access control is correct, the
702 C<$flagsrequired> parameter must be specified correctly.
704 Koha also has a concept of sub-permissions, also known as
705 granular permissions. This makes the value of each key
706 in the C<flagsrequired> hash take on an additional
711 The user must have access to all subfunctions of the module
712 specified by the hash key.
716 The user must have access to at least one subfunction of the module
717 specified by the hash key.
719 specific permission, e.g., 'export_catalog'
721 The user must have access to the specific subfunction list, which
722 must correspond to a row in the permissions table.
724 The C<$type> argument specifies whether the template should be
725 retrieved from the opac or intranet directory tree. "opac" is
726 assumed if it is not specified; however, if C<$type> is specified,
727 "intranet" is assumed if it is not "opac".
729 If C<$query> does not have a valid session ID associated with it
730 (i.e., the user has not logged in) or if the session has expired,
731 C<&checkauth> presents the user with a login page (from the point of
732 view of the original script, C<&checkauth> does not return). Once the
733 user has authenticated, C<&checkauth> restarts the original script
734 (this time, C<&checkauth> returns).
736 The login page is provided using a HTML::Template, which is set in the
737 systempreferences table or at the top of this file. The variable C<$type>
738 selects which template to use, either the opac or the intranet
739 authentification template.
741 C<&checkauth> returns a user ID, a cookie, and a session ID. The
742 cookie should be sent back to the browser; it verifies that the user
752 # If version syspref is unavailable, it means Koha is being installed,
753 # and so we must redirect to OPAC maintenance page or to the WebInstaller
754 # also, if OpacMaintenance is ON, OPAC should redirect to maintenance
755 if ( C4::Context->preference('OpacMaintenance') && $type eq 'opac' ) {
756 warn "OPAC Install required, redirecting to maintenance";
757 print $query->redirect("/cgi-bin/koha/maintenance.pl");
760 unless ( $version = C4::Context->preference('Version') ) { # assignment, not comparison
761 if ( $type ne 'opac' ) {
762 warn "Install required, redirecting to Installer";
763 print $query->redirect("/cgi-bin/koha/installer/install.pl");
765 warn "OPAC Install required, redirecting to maintenance";
766 print $query->redirect("/cgi-bin/koha/maintenance.pl");
771 # check that database and koha version are the same
772 # there is no DB version, it's a fresh install,
773 # go to web installer
774 # there is a DB version, compare it to the code version
775 my $kohaversion = Koha::version();
777 # remove the 3 last . to have a Perl number
778 $kohaversion =~ s/(.*\..*)\.(.*)\.(.*)/$1$2$3/;
779 Koha::Logger->get->debug("kohaversion : $kohaversion");
780 if ( $version < $kohaversion ) {
781 my $warning = "Database update needed, redirecting to %s. Database is $version and Koha is $kohaversion";
782 if ( $type ne 'opac' ) {
783 warn sprintf( $warning, 'Installer' );
784 print $query->redirect("/cgi-bin/koha/installer/install.pl?step=1&op=updatestructure");
786 warn sprintf( "OPAC: " . $warning, 'maintenance' );
787 print $query->redirect("/cgi-bin/koha/maintenance.pl");
793 sub _timeout_syspref {
794 my $default_timeout = 600;
795 my $timeout = C4::Context->preference('timeout') || $default_timeout;
797 # value in days, convert in seconds
798 if ( $timeout =~ /^(\d+)[dD]$/ ) {
799 $timeout = $1 * 86400;
801 # value in hours, convert in seconds
802 elsif ( $timeout =~ /^(\d+)[hH]$/ ) {
803 $timeout = $1 * 3600;
805 elsif ( $timeout !~ m/^\d+$/ ) {
806 warn "The value of the system preference 'timeout' is not correct, defaulting to $default_timeout";
807 $timeout = $default_timeout;
816 # Get shibboleth login attribute
817 my $shib = C4::Context->config('useshibboleth') && shib_ok();
818 my $shib_login = $shib ? get_login_shib() : undef;
820 # $authnotrequired will be set for scripts which will run without authentication
821 my $authnotrequired = shift;
822 my $flagsrequired = shift;
824 my $emailaddress = shift;
825 my $template_name = shift;
826 $type = 'opac' unless $type;
828 unless ( C4::Context->preference("OpacPublic") ) {
829 my @allowed_scripts_for_private_opac = qw(
831 opac-registration-email-sent.tt
832 opac-registration-confirmation.tt
833 opac-memberentry-update-submitted.tt
834 opac-password-recovery.tt
836 $authnotrequired = 0 unless grep { $_ eq $template_name }
837 @allowed_scripts_for_private_opac;
840 my $dbh = C4::Context->dbh;
841 my $timeout = _timeout_syspref();
843 _version_check( $type, $query );
848 my ( $userid, $cookie, $sessionID, $flags );
849 my $logout = $query->param('logout.x');
851 my $anon_search_history;
853 # This parameter is the name of the CAS server we want to authenticate against,
854 # when using authentication against multiple CAS servers, as configured in Auth_cas_servers.yaml
855 my $casparam = $query->param('cas');
856 my $q_userid = $query->param('userid') // '';
860 # Basic authentication is incompatible with the use of Shibboleth,
861 # as Shibboleth may return REMOTE_USER as a Shibboleth attribute,
862 # and it may not be the attribute we want to use to match the koha login.
864 # Also, do not consider an empty REMOTE_USER.
866 # Finally, after those tests, we can assume (although if it would be better with
867 # a syspref) that if we get a REMOTE_USER, that's from basic authentication,
868 # and we can affect it to $userid.
869 if ( !$shib and defined( $ENV{'REMOTE_USER'} ) and $ENV{'REMOTE_USER'} ne '' and $userid = $ENV{'REMOTE_USER'} ) {
871 # Using Basic Authentication, no cookies required
872 $cookie = $query->cookie(
873 -name => 'CGISESSID',
877 -secure => ( C4::Context->https_enabled() ? 1 : 0 ),
881 elsif ( $emailaddress) {
882 # the Google OpenID Connect passes an email address
884 elsif ( $sessionID = $query->cookie("CGISESSID") ) { # assignment, not comparison
885 my ( $return, $more_info );
886 # NOTE: $flags in the following call is still undefined !
887 ( $return, $session, $more_info ) = check_cookie_auth( $sessionID, $flags,
888 { remote_addr => $ENV{REMOTE_ADDR}, skip_version_check => 1 }
891 if ( $return eq 'ok' ) {
892 Koha::Logger->get->debug(sprintf "AUTH_SESSION: (%s)\t%s %s - %s", map { $session->param($_) || q{} } qw(cardnumber firstname surname branch));
894 my $s_userid = $session->param('id');
897 if ( ( $query->param('koha_login_context') && ( $q_userid ne $s_userid ) )
898 || ( $cas && $query->param('ticket') && !C4::Context->userenv->{'id'} )
899 || ( $shib && $shib_login && !$logout && !C4::Context->userenv->{'id'} )
902 #if a user enters an id ne to the id in the current session, we need to log them in...
903 #first we need to clear the anonymous session...
904 $anon_search_history = $session->param('search_history');
907 C4::Context::_unset_userenv($sessionID);
912 # voluntary logout the user
913 # check wether the user was using their shibboleth session or a local one
914 my $shibSuccess = C4::Context->userenv->{'shibboleth'};
917 C4::Context::_unset_userenv($sessionID);
920 if ($cas and $caslogout) {
921 logout_cas($query, $type);
924 # If we are in a shibboleth session (shibboleth is enabled, a shibboleth match attribute is set and matches koha matchpoint)
925 if ( $shib and $shib_login and $shibSuccess) {
930 $cookie = $query->cookie(
931 -name => 'CGISESSID',
932 -value => $session->id,
934 -secure => ( C4::Context->https_enabled() ? 1 : 0 ),
937 $flags = haspermission( $userid, $flagsrequired );
941 $info{'nopermission'} = 1;
944 } elsif ( !$logout ) {
945 if ( $return eq 'expired' ) {
946 $info{timed_out} = 1;
947 } elsif ( $return eq 'restricted' ) {
948 $info{oldip} = $more_info->{old_ip};
949 $info{newip} = $more_info->{new_ip};
950 $info{different_ip} = 1;
955 unless ( $loggedin ) {
960 #we initiate a session prior to checking for a username to allow for anonymous sessions...
961 $session ||= get_session("") or die "Auth ERROR: Cannot get_session()";
963 # Save anonymous search history in new session so it can be retrieved
964 # by get_template_and_user to store it in user's search history after
965 # a successful login.
966 if ($anon_search_history) {
967 $session->param( 'search_history', $anon_search_history );
970 $sessionID = $session->id;
971 C4::Context->_new_userenv($sessionID);
972 $cookie = $query->cookie(
973 -name => 'CGISESSID',
974 -value => $sessionID,
976 -secure => ( C4::Context->https_enabled() ? 1 : 0 ),
978 my $pki_field = C4::Context->preference('AllowPKIAuth');
979 if ( !defined($pki_field) ) {
980 print STDERR "ERROR: Missing system preference AllowPKIAuth.\n";
983 if ( ( $cas && $query->param('ticket') )
985 || ( $shib && $shib_login )
986 || $pki_field ne 'None'
989 my $password = $query->param('password');
991 my ( $return, $cardnumber );
993 # If shib is enabled and we have a shib login, does the login match a valid koha user
994 if ( $shib && $shib_login ) {
997 # Do not pass password here, else shib will not be checked in checkpw.
998 ( $return, $cardnumber, $retuserid ) = checkpw( $dbh, $q_userid, undef, $query );
999 $userid = $retuserid;
1000 $shibSuccess = $return;
1001 $info{'invalidShibLogin'} = 1 unless ($return);
1004 # If shib login and match were successful, skip further login methods
1005 unless ($shibSuccess) {
1006 if ( $cas && $query->param('ticket') ) {
1008 ( $return, $cardnumber, $retuserid, $cas_ticket ) =
1009 checkpw( $dbh, $userid, $password, $query, $type );
1010 $userid = $retuserid;
1011 $info{'invalidCasLogin'} = 1 unless ($return);
1014 elsif ( $emailaddress ) {
1015 my $value = $emailaddress;
1017 # If we're looking up the email, there's a chance that the person
1018 # doesn't have a userid. So if there is none, we pass along the
1019 # borrower number, and the bits of code that need to know the user
1020 # ID will have to be smart enough to handle that.
1021 my $patrons = Koha::Patrons->search({ email => $value });
1022 if ($patrons->count) {
1024 # First the userid, then the borrowernum
1025 my $patron = $patrons->next;
1026 $value = $patron->userid || $patron->borrowernumber;
1030 $return = $value ? 1 : 0;
1035 ( $pki_field eq 'Common Name' && $ENV{'SSL_CLIENT_S_DN_CN'} )
1036 || ( $pki_field eq 'emailAddress'
1037 && $ENV{'SSL_CLIENT_S_DN_Email'} )
1041 if ( $pki_field eq 'Common Name' ) {
1042 $value = $ENV{'SSL_CLIENT_S_DN_CN'};
1044 elsif ( $pki_field eq 'emailAddress' ) {
1045 $value = $ENV{'SSL_CLIENT_S_DN_Email'};
1047 # If we're looking up the email, there's a chance that the person
1048 # doesn't have a userid. So if there is none, we pass along the
1049 # borrower number, and the bits of code that need to know the user
1050 # ID will have to be smart enough to handle that.
1051 my $patrons = Koha::Patrons->search({ email => $value });
1052 if ($patrons->count) {
1054 # First the userid, then the borrowernum
1055 my $patron = $patrons->next;
1056 $value = $patron->userid || $patron->borrowernumber;
1062 $return = $value ? 1 : 0;
1068 my $request_method = $query->request_method();
1071 $request_method eq 'POST'
1072 || ( C4::Context->preference('AutoSelfCheckID')
1073 && $q_userid eq C4::Context->preference('AutoSelfCheckID') )
1077 ( $return, $cardnumber, $retuserid, $cas_ticket ) =
1078 checkpw( $dbh, $q_userid, $password, $query, $type );
1079 $userid = $retuserid if ($retuserid);
1080 $info{'invalid_username_or_password'} = 1 unless ($return);
1085 # If shib configured and shibOnly enabled, we should ignore anything other than a shibboleth type login.
1092 && C4::Context->preference('OPACShibOnly')
1094 || ( ( $type ne 'opac' )
1095 && C4::Context->preference('staffShibOnly') )
1102 # $return: 1 = valid user
1105 if ( $flags = haspermission( $userid, $flagsrequired ) ) {
1109 $info{'nopermission'} = 1;
1110 C4::Context::_unset_userenv($sessionID);
1112 my ( $borrowernumber, $firstname, $surname, $userflags,
1113 $branchcode, $branchname, $emailaddress, $desk_id,
1114 $desk_name, $register_id, $register_name );
1116 if ( $return == 1 ) {
1118 SELECT borrowernumber, firstname, surname, flags, borrowers.branchcode,
1119 branches.branchname as branchname, email
1121 LEFT JOIN branches on borrowers.branchcode=branches.branchcode
1123 my $sth = $dbh->prepare("$select where userid=?");
1124 $sth->execute($userid);
1125 unless ( $sth->rows ) {
1126 $sth = $dbh->prepare("$select where cardnumber=?");
1127 $sth->execute($cardnumber);
1129 unless ( $sth->rows ) {
1130 $sth->execute($userid);
1134 ( $borrowernumber, $firstname, $surname, $userflags,
1135 $branchcode, $branchname, $emailaddress ) = $sth->fetchrow;
1138 # launch a sequence to check if we have a ip for the branch, i
1139 # if we have one we replace the branchcode of the userenv by the branch bound in the ip.
1141 my $ip = $ENV{'REMOTE_ADDR'};
1143 # if they specify at login, use that
1144 if ( $query->param('branch') ) {
1145 $branchcode = $query->param('branch');
1146 my $library = Koha::Libraries->find($branchcode);
1147 $branchname = $library? $library->branchname: '';
1149 if ( $query->param('desk_id') ) {
1150 $desk_id = $query->param('desk_id');
1151 my $desk = Koha::Desks->find($desk_id);
1152 $desk_name = $desk ? $desk->desk_name : '';
1154 if ( C4::Context->preference('UseCashRegisters') ) {
1156 $query->param('register_id')
1157 ? Koha::Cash::Registers->find($query->param('register_id'))
1158 : Koha::Cash::Registers->search(
1159 { branch => $branchcode, branch_default => 1 },
1160 { rows => 1 } )->single;
1161 $register_id = $register->id if ($register);
1162 $register_name = $register->name if ($register);
1164 my $branches = { map { $_->branchcode => $_->unblessed } Koha::Libraries->search->as_list };
1165 if ( $type ne 'opac' and C4::Context->preference('AutoLocation') ) {
1167 # we have to check they are coming from the right ip range
1168 my $domain = $branches->{$branchcode}->{'branchip'};
1169 $domain =~ s|\.\*||g;
1170 if ( $ip !~ /^$domain/ ) {
1172 $cookie = $query->cookie(
1173 -name => 'CGISESSID',
1176 -secure => ( C4::Context->https_enabled() ? 1 : 0 ),
1178 $info{'wrongip'} = 1;
1182 foreach my $br ( keys %$branches ) {
1184 # now we work with the treatment of ip
1185 my $domain = $branches->{$br}->{'branchip'};
1186 if ( $domain && $ip =~ /^$domain/ ) {
1187 $branchcode = $branches->{$br}->{'branchcode'};
1189 # new op dev : add the branchname to the cookie
1190 $branchname = $branches->{$br}->{'branchname'};
1194 my $is_sco_user = 0;
1195 if ( $query->param('sco_user_login') && ( $query->param('sco_user_login') eq '1' ) ){
1199 $session->param( 'number', $borrowernumber );
1200 $session->param( 'id', $userid );
1201 $session->param( 'cardnumber', $cardnumber );
1202 $session->param( 'firstname', $firstname );
1203 $session->param( 'surname', $surname );
1204 $session->param( 'branch', $branchcode );
1205 $session->param( 'branchname', $branchname );
1206 $session->param( 'desk_id', $desk_id);
1207 $session->param( 'desk_name', $desk_name);
1208 $session->param( 'flags', $userflags );
1209 $session->param( 'emailaddress', $emailaddress );
1210 $session->param( 'ip', $session->remote_addr() );
1211 $session->param( 'lasttime', time() );
1212 $session->param( 'interface', $type);
1213 $session->param( 'shibboleth', $shibSuccess );
1214 $session->param( 'register_id', $register_id );
1215 $session->param( 'register_name', $register_name );
1216 $session->param( 'sco_user', $is_sco_user );
1218 $session->param('cas_ticket', $cas_ticket) if $cas_ticket;
1219 C4::Context->set_userenv(
1220 $session->param('number'), $session->param('id'),
1221 $session->param('cardnumber'), $session->param('firstname'),
1222 $session->param('surname'), $session->param('branch'),
1223 $session->param('branchname'), $session->param('flags'),
1224 $session->param('emailaddress'), $session->param('shibboleth'),
1225 $session->param('desk_id'), $session->param('desk_name'),
1226 $session->param('register_id'), $session->param('register_name')
1230 # $return: 0 = invalid user
1231 # reset to anonymous session
1234 $info{'invalid_username_or_password'} = 1;
1235 C4::Context::_unset_userenv($sessionID);
1237 $session->param( 'lasttime', time() );
1238 $session->param( 'ip', $session->remote_addr() );
1239 $session->param( 'sessiontype', 'anon' );
1240 $session->param( 'interface', $type);
1242 } # END if ( $q_userid
1243 elsif ( $type eq "opac" ) {
1245 # anonymous sessions are created only for the OPAC
1247 # setting a couple of other session vars...
1248 $session->param( 'ip', $session->remote_addr() );
1249 $session->param( 'lasttime', time() );
1250 $session->param( 'sessiontype', 'anon' );
1251 $session->param( 'interface', $type);
1254 } # END unless ($userid)
1256 # finished authentification, now respond
1257 if ( $loggedin || $authnotrequired )
1261 $cookie = $query->cookie(
1262 -name => 'CGISESSID',
1265 -secure => ( C4::Context->https_enabled() ? 1 : 0 ),
1269 track_login_daily( $userid );
1271 # In case, that this request was a login attempt, we want to prevent that users can repost the opac login
1272 # request. We therefore redirect the user to the requested page again without the login parameters.
1273 # See Post/Redirect/Get (PRG) design pattern: https://en.wikipedia.org/wiki/Post/Redirect/Get
1274 if ( $type eq "opac" && $query->param('koha_login_context') && $query->param('koha_login_context') ne 'sco' && $query->param('password') && $query->param('userid') ) {
1275 my $uri = URI->new($query->url(-relative=>1, -query_string=>1));
1276 $uri->query_param_delete('userid');
1277 $uri->query_param_delete('password');
1278 $uri->query_param_delete('koha_login_context');
1279 print $query->redirect(-uri => $uri->as_string, -cookie => $cookie, -status=>'303 See other');
1283 return ( $userid, $cookie, $sessionID, $flags );
1288 # AUTH rejected, show the login/password template, after checking the DB.
1292 # get the inputs from the incoming query
1294 foreach my $name ( param $query) {
1295 (next) if ( $name eq 'userid' || $name eq 'password' || $name eq 'ticket' );
1296 my @value = $query->multi_param($name);
1297 push @inputs, { name => $name, value => $_ } for @value;
1300 my $patron = Koha::Patrons->find({ userid => $q_userid }); # Not necessary logged in!
1302 my $LibraryNameTitle = C4::Context->preference("LibraryName");
1303 $LibraryNameTitle =~ s/<(?:\/?)(?:br|p)\s*(?:\/?)>/ /sgi;
1304 $LibraryNameTitle =~ s/<(?:[^<>'"]|'(?:[^']*)'|"(?:[^"]*)")*>//sg;
1306 my $auth_template_name = ( $type eq 'opac' ) ? 'opac-auth.tt' : 'auth.tt';
1307 my $template = C4::Templates::gettemplate( $auth_template_name, $type, $query );
1311 script_name => get_script_name(),
1312 casAuthentication => C4::Context->preference("casAuthentication"),
1313 shibbolethAuthentication => $shib,
1314 suggestion => C4::Context->preference("suggestion"),
1315 virtualshelves => C4::Context->preference("virtualshelves"),
1316 LibraryName => "" . C4::Context->preference("LibraryName"),
1317 LibraryNameTitle => "" . $LibraryNameTitle,
1318 opacuserlogin => C4::Context->preference("opacuserlogin"),
1319 OpacFavicon => C4::Context->preference("OpacFavicon"),
1320 opacreadinghistory => C4::Context->preference("opacreadinghistory"),
1321 opaclanguagesdisplay => C4::Context->preference("opaclanguagesdisplay"),
1322 OPACUserJS => C4::Context->preference("OPACUserJS"),
1323 opacbookbag => "" . C4::Context->preference("opacbookbag"),
1324 OpacCloud => C4::Context->preference("OpacCloud"),
1325 OpacTopissue => C4::Context->preference("OpacTopissue"),
1326 OpacAuthorities => C4::Context->preference("OpacAuthorities"),
1327 OpacBrowser => C4::Context->preference("OpacBrowser"),
1328 TagsEnabled => C4::Context->preference("TagsEnabled"),
1329 OPACUserCSS => C4::Context->preference("OPACUserCSS"),
1330 intranetcolorstylesheet => C4::Context->preference("intranetcolorstylesheet"),
1331 intranetstylesheet => C4::Context->preference("intranetstylesheet"),
1332 IntranetNav => C4::Context->preference("IntranetNav"),
1333 IntranetFavicon => C4::Context->preference("IntranetFavicon"),
1334 IntranetUserCSS => C4::Context->preference("IntranetUserCSS"),
1335 IntranetUserJS => C4::Context->preference("IntranetUserJS"),
1336 IndependentBranches => C4::Context->preference("IndependentBranches"),
1337 AutoLocation => C4::Context->preference("AutoLocation"),
1338 wrongip => $info{'wrongip'},
1339 PatronSelfRegistration => C4::Context->preference("PatronSelfRegistration"),
1340 PatronSelfRegistrationDefaultCategory => C4::Context->preference("PatronSelfRegistrationDefaultCategory"),
1341 opac_css_override => $ENV{'OPAC_CSS_OVERRIDE'},
1342 too_many_login_attempts => ( $patron and $patron->account_locked )
1345 $template->param( SCO_login => 1 ) if ( $query->param('sco_user_login') );
1346 $template->param( SCI_login => 1 ) if ( $query->param('sci_user_login') );
1347 $template->param( OpacPublic => C4::Context->preference("OpacPublic") );
1348 $template->param( loginprompt => 1 ) unless $info{'nopermission'};
1350 if ( $type eq 'opac' ) {
1351 require Koha::Virtualshelves;
1352 my $some_public_shelves = Koha::Virtualshelves->get_some_shelves(
1358 some_public_shelves => $some_public_shelves,
1364 # Is authentication against multiple CAS servers enabled?
1365 require C4::Auth_with_cas;
1366 if ( multipleAuth() && !$casparam ) {
1367 my $casservers = getMultipleAuth();
1369 foreach my $key ( keys %$casservers ) {
1370 push @tmplservers, { name => $key, value => login_cas_url( $query, $key, $type ) . "?cas=$key" };
1373 casServersLoop => \@tmplservers
1377 casServerUrl => login_cas_url($query, undef, $type),
1382 invalidCasLogin => $info{'invalidCasLogin'}
1387 #If shibOnly is enabled just go ahead and redirect directly
1388 if ( (($type eq 'opac') && C4::Context->preference('OPACShibOnly')) || (($type ne 'opac') && C4::Context->preference('staffShibOnly')) ) {
1389 my $redirect_url = login_shib_url( $query );
1390 print $query->redirect( -uri => "$redirect_url", -status => 303 );
1395 shibbolethAuthentication => $shib,
1396 shibbolethLoginUrl => login_shib_url($query),
1400 if (C4::Context->preference('GoogleOpenIDConnect')) {
1401 if ($query->param("OpenIDConnectFailed")) {
1402 my $reason = $query->param('OpenIDConnectFailed');
1403 $template->param(invalidGoogleOpenIDConnectLogin => $reason);
1408 LibraryName => C4::Context->preference("LibraryName"),
1410 $template->param(%info);
1412 # $cookie = $query->cookie(CGISESSID => $session->id
1414 print $query->header(
1415 { type => 'text/html',
1418 'X-Frame-Options' => 'SAMEORIGIN'
1425 =head2 check_api_auth
1427 ($status, $cookie, $sessionId) = check_api_auth($query, $userflags);
1429 Given a CGI query containing the parameters 'userid' and 'password' and/or a session
1430 cookie, determine if the user has the privileges specified by C<$userflags>.
1432 C<check_api_auth> is is meant for authenticating users of web services, and
1433 consequently will always return and will not attempt to redirect the user
1436 If a valid session cookie is already present, check_api_auth will return a status
1437 of "ok", the cookie, and the Koha session ID.
1439 If no session cookie is present, check_api_auth will check the 'userid' and 'password
1440 parameters and create a session cookie and Koha session if the supplied credentials
1443 Possible return values in C<$status> are:
1447 =item "ok" -- user authenticated; C<$cookie> and C<$sessionid> have valid values.
1449 =item "failed" -- credentials are not correct; C<$cookie> and C<$sessionid> are undef
1451 =item "maintenance" -- DB is in maintenance mode; no login possible at the moment
1453 =item "expired -- session cookie has expired; API user should resubmit userid and password
1455 =item "restricted" -- The IP has changed (if SessionRestrictionByIP)
1461 sub check_api_auth {
1464 my $flagsrequired = shift;
1465 my $dbh = C4::Context->dbh;
1466 my $timeout = _timeout_syspref();
1468 unless ( C4::Context->preference('Version') ) {
1470 # database has not been installed yet
1471 return ( "maintenance", undef, undef );
1473 my $kohaversion = Koha::version();
1474 $kohaversion =~ s/(.*\..*)\.(.*)\.(.*)/$1$2$3/;
1475 if ( C4::Context->preference('Version') < $kohaversion ) {
1477 # database in need of version update; assume that
1478 # no API should be called while databsae is in
1480 return ( "maintenance", undef, undef );
1483 my ( $sessionID, $session );
1484 unless ( $query->param('userid') ) {
1485 $sessionID = $query->cookie("CGISESSID");
1487 if ( $sessionID && not( $cas && $query->param('PT') ) ) {
1490 ( $return, $session, undef ) = check_cookie_auth(
1491 $sessionID, $flagsrequired, { remote_addr => $ENV{REMOTE_ADDR} } );
1493 return ( $return, undef, undef ) # Cookie auth failed
1496 my $cookie = $query->cookie(
1497 -name => 'CGISESSID',
1498 -value => $session->id,
1500 -secure => ( C4::Context->https_enabled() ? 1 : 0 ),
1502 return ( $return, undef, $session );
1507 my $userid = $query->param('userid');
1508 my $password = $query->param('password');
1509 my ( $return, $cardnumber, $cas_ticket );
1512 if ( $cas && $query->param('PT') ) {
1515 # In case of a CAS authentication, we use the ticket instead of the password
1516 my $PT = $query->param('PT');
1517 ( $return, $cardnumber, $userid, $cas_ticket ) = check_api_auth_cas( $dbh, $PT, $query ); # EXTERNAL AUTH
1520 # User / password auth
1521 unless ( $userid and $password ) {
1523 # caller did something wrong, fail the authenticateion
1524 return ( "failed", undef, undef );
1527 ( $return, $cardnumber, $newuserid, $cas_ticket ) = checkpw( $dbh, $userid, $password, $query );
1530 if ( $return and haspermission( $userid, $flagsrequired ) ) {
1531 my $session = get_session("");
1532 return ( "failed", undef, undef ) unless $session;
1534 my $sessionID = $session->id;
1535 C4::Context->_new_userenv($sessionID);
1536 my $cookie = $query->cookie(
1537 -name => 'CGISESSID',
1538 -value => $sessionID,
1540 -secure => ( C4::Context->https_enabled() ? 1 : 0 ),
1542 if ( $return == 1 ) {
1544 $borrowernumber, $firstname, $surname,
1545 $userflags, $branchcode, $branchname,
1550 "select borrowernumber, firstname, surname, flags, borrowers.branchcode, branches.branchname as branchname, email from borrowers left join branches on borrowers.branchcode=branches.branchcode where userid=?"
1552 $sth->execute($userid);
1554 $borrowernumber, $firstname, $surname,
1555 $userflags, $branchcode, $branchname,
1557 ) = $sth->fetchrow if ( $sth->rows );
1559 unless ( $sth->rows ) {
1560 my $sth = $dbh->prepare(
1561 "select borrowernumber, firstname, surname, flags, borrowers.branchcode, branches.branchname as branchname, email from borrowers left join branches on borrowers.branchcode=branches.branchcode where cardnumber=?"
1563 $sth->execute($cardnumber);
1565 $borrowernumber, $firstname, $surname,
1566 $userflags, $branchcode, $branchname,
1568 ) = $sth->fetchrow if ( $sth->rows );
1570 unless ( $sth->rows ) {
1571 $sth->execute($userid);
1573 $borrowernumber, $firstname, $surname, $userflags,
1574 $branchcode, $branchname, $emailaddress
1575 ) = $sth->fetchrow if ( $sth->rows );
1579 my $ip = $ENV{'REMOTE_ADDR'};
1581 # if they specify at login, use that
1582 if ( $query->param('branch') ) {
1583 $branchcode = $query->param('branch');
1584 my $library = Koha::Libraries->find($branchcode);
1585 $branchname = $library? $library->branchname: '';
1587 my $branches = { map { $_->branchcode => $_->unblessed } Koha::Libraries->search->as_list };
1588 foreach my $br ( keys %$branches ) {
1590 # now we work with the treatment of ip
1591 my $domain = $branches->{$br}->{'branchip'};
1592 if ( $domain && $ip =~ /^$domain/ ) {
1593 $branchcode = $branches->{$br}->{'branchcode'};
1595 # new op dev : add the branchname to the cookie
1596 $branchname = $branches->{$br}->{'branchname'};
1599 $session->param( 'number', $borrowernumber );
1600 $session->param( 'id', $userid );
1601 $session->param( 'cardnumber', $cardnumber );
1602 $session->param( 'firstname', $firstname );
1603 $session->param( 'surname', $surname );
1604 $session->param( 'branch', $branchcode );
1605 $session->param( 'branchname', $branchname );
1606 $session->param( 'flags', $userflags );
1607 $session->param( 'emailaddress', $emailaddress );
1608 $session->param( 'ip', $session->remote_addr() );
1609 $session->param( 'lasttime', time() );
1610 $session->param( 'interface', 'api' );
1612 $session->param( 'cas_ticket', $cas_ticket);
1613 C4::Context->set_userenv(
1614 $session->param('number'), $session->param('id'),
1615 $session->param('cardnumber'), $session->param('firstname'),
1616 $session->param('surname'), $session->param('branch'),
1617 $session->param('branchname'), $session->param('flags'),
1618 $session->param('emailaddress'), $session->param('shibboleth'),
1619 $session->param('desk_id'), $session->param('desk_name'),
1620 $session->param('register_id'), $session->param('register_name')
1622 return ( "ok", $cookie, $sessionID );
1624 return ( "failed", undef, undef );
1629 =head2 check_cookie_auth
1631 ($status, $sessionId) = check_cookie_auth($cookie, $userflags);
1633 Given a CGISESSID cookie set during a previous login to Koha, determine
1634 if the user has the privileges specified by C<$userflags>. C<$userflags>
1635 is passed unaltered into C<haspermission> and as such accepts all options
1636 avaiable to that routine with the one caveat that C<check_api_auth> will
1637 also allow 'undef' to be passed and in such a case the permissions check
1638 will be skipped altogether.
1640 C<check_cookie_auth> is meant for authenticating special services
1641 such as tools/upload-file.pl that are invoked by other pages that
1642 have been authenticated in the usual way.
1644 Possible return values in C<$status> are:
1648 =item "ok" -- user authenticated; C<$sessionID> have valid values.
1650 =item "anon" -- user not authenticated but valid for anonymous session.
1652 =item "failed" -- credentials are not correct; C<$sessionid> are undef
1654 =item "maintenance" -- DB is in maintenance mode; no login possible at the moment
1656 =item "expired -- session cookie has expired; API user should resubmit userid and password
1658 =item "restricted" -- The IP has changed (if SessionRestrictionByIP)
1664 sub check_cookie_auth {
1665 my $sessionID = shift;
1666 my $flagsrequired = shift;
1669 my $remote_addr = $params->{remote_addr} || $ENV{REMOTE_ADDR};
1671 my $skip_version_check = $params->{skip_version_check}; # Only for checkauth
1673 unless ( $skip_version_check ) {
1674 unless ( C4::Context->preference('Version') ) {
1676 # database has not been installed yet
1677 return ( "maintenance", undef );
1679 my $kohaversion = Koha::version();
1680 $kohaversion =~ s/(.*\..*)\.(.*)\.(.*)/$1$2$3/;
1681 if ( C4::Context->preference('Version') < $kohaversion ) {
1683 # database in need of version update; assume that
1684 # no API should be called while databsae is in
1686 return ( "maintenance", undef );
1690 # see if we have a valid session cookie already
1691 # however, if a userid parameter is present (i.e., from
1692 # a form submission, assume that any current cookie
1694 unless ( $sessionID ) {
1695 return ( "failed", undef );
1697 C4::Context::_unset_userenv($sessionID); # remove old userenv first
1698 my $session = get_session($sessionID);
1700 my $userid = $session->param('id');
1701 my $ip = $session->param('ip');
1702 my $lasttime = $session->param('lasttime');
1703 my $timeout = _timeout_syspref();
1705 if ( !$lasttime || ( $lasttime < time() - $timeout ) ) {
1709 return ("expired", undef);
1711 } elsif ( C4::Context->preference('SessionRestrictionByIP') && $ip ne $remote_addr ) {
1712 # IP address changed
1715 return ( "restricted", undef, { old_ip => $ip, new_ip => $remote_addr});
1717 } elsif ( $userid ) {
1718 $session->param( 'lasttime', time() );
1719 my $flags = defined($flagsrequired) ? haspermission( $userid, $flagsrequired ) : 1;
1721 C4::Context->_new_userenv($sessionID);
1722 C4::Context->interface($session->param('interface'));
1723 C4::Context->set_userenv(
1724 $session->param('number'), $session->param('id') // '',
1725 $session->param('cardnumber'), $session->param('firstname'),
1726 $session->param('surname'), $session->param('branch'),
1727 $session->param('branchname'), $session->param('flags'),
1728 $session->param('emailaddress'), $session->param('shibboleth'),
1729 $session->param('desk_id'), $session->param('desk_name'),
1730 $session->param('register_id'), $session->param('register_name')
1732 return ( "ok", $session );
1736 return ( "failed", undef );
1740 C4::Context->_new_userenv($sessionID);
1741 C4::Context->interface($session->param('interface'));
1742 C4::Context->set_userenv( undef, q{} );
1743 return ( "anon", $session );
1746 return ( "expired", undef );
1753 my $session = get_session($sessionID);
1755 Given a session ID, retrieve the CGI::Session object used to store
1756 the session's state. The session object can be used to store
1757 data that needs to be accessed by different scripts during a
1760 If the C<$sessionID> parameter is an empty string, a new session
1765 sub _get_session_params {
1766 my $storage_method = C4::Context->preference('SessionStorage');
1767 if ( $storage_method eq 'mysql' ) {
1768 my $dbh = C4::Context->dbh;
1769 return { dsn => "serializer:yamlxs;driver:MySQL;id:md5", dsn_args => { Handle => $dbh } };
1771 elsif ( $storage_method eq 'Pg' ) {
1772 my $dbh = C4::Context->dbh;
1773 return { dsn => "serializer:yamlxs;driver:PostgreSQL;id:md5", dsn_args => { Handle => $dbh } };
1775 elsif ( $storage_method eq 'memcached' && Koha::Caches->get_instance->memcached_cache ) {
1776 my $memcached = Koha::Caches->get_instance()->memcached_cache;
1777 return { dsn => "serializer:yamlxs;driver:memcached;id:md5", dsn_args => { Memcached => $memcached } };
1780 # catch all defaults to tmp should work on all systems
1781 my $dir = C4::Context::temporary_directory;
1782 my $instance = C4::Context->config( 'database' ); #actually for packages not exactly the instance name, but generally safer to leave it as it is
1783 return { dsn => "serializer:yamlxs;driver:File;id:md5", dsn_args => { Directory => "$dir/cgisess_$instance" } };
1788 my $sessionID = shift;
1789 my $params = _get_session_params();
1791 if( $sessionID ) { # find existing
1792 CGI::Session::ErrorHandler->set_error( q{} ); # clear error, cpan issue #111463
1793 $session = CGI::Session->load( $params->{dsn}, $sessionID, $params->{dsn_args} );
1795 $session = CGI::Session->new( $params->{dsn}, $sessionID, $params->{dsn_args} );
1802 # FIXME no_set_userenv may be replaced with force_branchcode_for_userenv
1803 # (or something similar)
1804 # Currently it's only passed from C4::SIP::ILS::Patron::check_password, but
1805 # not having a userenv defined could cause a crash.
1807 my ( $dbh, $userid, $password, $query, $type, $no_set_userenv ) = @_;
1808 $type = 'opac' unless $type;
1810 # Get shibboleth login attribute
1811 my $shib = C4::Context->config('useshibboleth') && shib_ok();
1812 my $shib_login = $shib ? get_login_shib() : undef;
1816 if ( defined $userid ){
1817 $patron = Koha::Patrons->find({ userid => $userid });
1818 $patron = Koha::Patrons->find({ cardnumber => $userid }) unless $patron;
1820 my $check_internal_as_fallback = 0;
1822 # Note: checkpw_* routines returns:
1825 # -1 if user bind failed (LDAP only)
1827 if ( $patron and $patron->account_locked ) {
1828 # Nothing to check, account is locked
1829 } elsif ($ldap && defined($password)) {
1830 my ( $retval, $retcard, $retuserid ) = checkpw_ldap(@_); # EXTERNAL AUTH
1831 if ( $retval == 1 ) {
1832 @return = ( $retval, $retcard, $retuserid );
1835 $check_internal_as_fallback = 1 if $retval == 0;
1837 } elsif ( $cas && $query && $query->param('ticket') ) {
1839 # In case of a CAS authentication, we use the ticket instead of the password
1840 my $ticket = $query->param('ticket');
1841 $query->delete('ticket'); # remove ticket to come back to original URL
1842 my ( $retval, $retcard, $retuserid, $cas_ticket ) = checkpw_cas( $dbh, $ticket, $query, $type ); # EXTERNAL AUTH
1844 @return = ( $retval, $retcard, $retuserid, $cas_ticket );
1848 $passwd_ok = $retval;
1851 # If we are in a shibboleth session (shibboleth is enabled, and a shibboleth match attribute is present)
1852 # Check for password to asertain whether we want to be testing against shibboleth or another method this
1854 elsif ( $shib && $shib_login && !$password ) {
1856 # In case of a Shibboleth authentication, we expect a shibboleth user attribute
1857 # (defined under shibboleth mapping in koha-conf.xml) to contain the login of the
1858 # shibboleth-authenticated user
1860 # Then, we check if it matches a valid koha user
1862 my ( $retval, $retcard, $retuserid ) = C4::Auth_with_shibboleth::checkpw_shib($shib_login); # EXTERNAL AUTH
1864 @return = ( $retval, $retcard, $retuserid );
1866 $passwd_ok = $retval;
1869 $check_internal_as_fallback = 1;
1873 if ( $check_internal_as_fallback ) {
1874 @return = checkpw_internal( $dbh, $userid, $password, $no_set_userenv);
1875 $passwd_ok = 1 if $return[0] > 0; # 1 or 2
1880 $patron->update({ login_attempts => 0 });
1881 } elsif( !$patron->account_locked ) {
1882 $patron->update({ login_attempts => $patron->login_attempts + 1 });
1886 # Optionally log success or failure
1887 if( $patron && $passwd_ok && C4::Context->preference('AuthSuccessLog') ) {
1888 logaction( 'AUTH', 'SUCCESS', $patron->id, "Valid password for $userid", $type );
1889 } elsif( !$passwd_ok && C4::Context->preference('AuthFailureLog') ) {
1890 logaction( 'AUTH', 'FAILURE', $patron ? $patron->id : 0, "Wrong password for $userid", $type );
1896 sub checkpw_internal {
1897 my ( $dbh, $userid, $password, $no_set_userenv ) = @_;
1899 $password = Encode::encode( 'UTF-8', $password )
1900 if Encode::is_utf8($password);
1904 "select password,cardnumber,borrowernumber,userid,firstname,surname,borrowers.branchcode,branches.branchname,flags from borrowers join branches on borrowers.branchcode=branches.branchcode where userid=?"
1906 $sth->execute($userid);
1908 my ( $stored_hash, $cardnumber, $borrowernumber, $userid, $firstname,
1909 $surname, $branchcode, $branchname, $flags )
1912 if ( checkpw_hash( $password, $stored_hash ) ) {
1914 C4::Context->set_userenv( "$borrowernumber", $userid, $cardnumber,
1915 $firstname, $surname, $branchcode, $branchname, $flags ) unless $no_set_userenv;
1916 return 1, $cardnumber, $userid;
1921 "select password,cardnumber,borrowernumber,userid,firstname,surname,borrowers.branchcode,branches.branchname,flags from borrowers join branches on borrowers.branchcode=branches.branchcode where cardnumber=?"
1923 $sth->execute($userid);
1925 my ( $stored_hash, $cardnumber, $borrowernumber, $userid, $firstname,
1926 $surname, $branchcode, $branchname, $flags )
1929 if ( checkpw_hash( $password, $stored_hash ) ) {
1931 C4::Context->set_userenv( $borrowernumber, $userid, $cardnumber,
1932 $firstname, $surname, $branchcode, $branchname, $flags ) unless $no_set_userenv;
1933 return 1, $cardnumber, $userid;
1940 my ( $password, $stored_hash ) = @_;
1942 return if $stored_hash eq '!';
1944 # check what encryption algorithm was implemented: Bcrypt - if the hash starts with '$2' it is Bcrypt else md5
1946 if ( substr( $stored_hash, 0, 2 ) eq '$2' ) {
1947 $hash = hash_password( $password, $stored_hash );
1949 $hash = md5_base64($password);
1951 return $hash eq $stored_hash;
1956 my $authflags = getuserflags($flags, $userid, [$dbh]);
1958 Translates integer flags into permissions strings hash.
1960 C<$flags> is the integer userflags value ( borrowers.userflags )
1961 C<$userid> is the members.userid, used for building subpermissions
1962 C<$authflags> is a hashref of permissions
1969 my $dbh = @_ ? shift : C4::Context->dbh;
1972 # I don't want to do this, but if someone logs in as the database
1973 # user, it would be preferable not to spam them to death with
1974 # numeric warnings. So, we make $flags numeric.
1975 no warnings 'numeric';
1978 my $sth = $dbh->prepare("SELECT bit, flag, defaulton FROM userflags");
1981 while ( my ( $bit, $flag, $defaulton ) = $sth->fetchrow ) {
1982 if ( ( $flags & ( 2**$bit ) ) || $defaulton ) {
1983 $userflags->{$flag} = 1;
1986 $userflags->{$flag} = 0;
1990 # get subpermissions and merge with top-level permissions
1991 my $user_subperms = get_user_subpermissions($userid);
1992 foreach my $module ( keys %$user_subperms ) {
1993 next if $userflags->{$module} == 1; # user already has permission for everything in this module
1994 $userflags->{$module} = $user_subperms->{$module};
2000 =head2 get_user_subpermissions
2002 $user_perm_hashref = get_user_subpermissions($userid);
2004 Given the userid (note, not the borrowernumber) of a staff user,
2005 return a hashref of hashrefs of the specific subpermissions
2006 accorded to the user. An example return is
2010 export_catalog => 1,
2011 import_patrons => 1,
2015 The top-level hash-key is a module or function code from
2016 userflags.flag, while the second-level key is a code
2019 The results of this function do not give a complete picture
2020 of the functions that a staff user can access; it is also
2021 necessary to check borrowers.flags.
2025 sub get_user_subpermissions {
2028 my $dbh = C4::Context->dbh;
2029 my $sth = $dbh->prepare( "SELECT flag, user_permissions.code
2030 FROM user_permissions
2031 JOIN permissions USING (module_bit, code)
2032 JOIN userflags ON (module_bit = bit)
2033 JOIN borrowers USING (borrowernumber)
2034 WHERE userid = ?" );
2035 $sth->execute($userid);
2037 my $user_perms = {};
2038 while ( my $perm = $sth->fetchrow_hashref ) {
2039 $user_perms->{ $perm->{'flag'} }->{ $perm->{'code'} } = 1;
2044 =head2 get_all_subpermissions
2046 my $perm_hashref = get_all_subpermissions();
2048 Returns a hashref of hashrefs defining all specific
2049 permissions currently defined. The return value
2050 has the same structure as that of C<get_user_subpermissions>,
2051 except that the innermost hash value is the description
2052 of the subpermission.
2056 sub get_all_subpermissions {
2057 my $dbh = C4::Context->dbh;
2058 my $sth = $dbh->prepare( "SELECT flag, code
2060 JOIN userflags ON (module_bit = bit)" );
2064 while ( my $perm = $sth->fetchrow_hashref ) {
2065 $all_perms->{ $perm->{'flag'} }->{ $perm->{'code'} } = 1;
2070 =head2 haspermission
2072 $flagsrequired = '*'; # Any permission at all
2073 $flagsrequired = 'a_flag'; # a_flag must be satisfied (all subpermissions)
2074 $flagsrequired = [ 'a_flag', 'b_flag' ]; # a_flag OR b_flag must be satisfied
2075 $flagsrequired = { 'a_flag => 1, 'b_flag' => 1 }; # a_flag AND b_flag must be satisfied
2076 $flagsrequired = { 'a_flag' => 'sub_a' }; # sub_a of a_flag must be satisfied
2077 $flagsrequired = { 'a_flag' => [ 'sub_a, 'sub_b' ] }; # sub_a OR sub_b of a_flag must be satisfied
2079 $flags = ($userid, $flagsrequired);
2081 C<$userid> the userid of the member
2082 C<$flags> is a query structure similar to that used by SQL::Abstract that
2083 denotes the combination of flags required. It is a required parameter.
2085 The main logic of this method is that things in arrays are OR'ed, and things
2086 in hashes are AND'ed. The `*` character can be used, at any depth, to denote `ANY`
2088 Returns member's flags or 0 if a permission is not met.
2093 my ($required, $flags) = @_;
2095 my $ref = ref($required);
2097 if ($required eq '*') {
2098 return 0 unless ( $flags or ref( $flags ) );
2100 return 0 unless ( $flags and (!ref( $flags ) || $flags->{$required} ));
2102 } elsif ($ref eq 'HASH') {
2103 foreach my $key (keys %{$required}) {
2104 next if $flags == 1;
2105 my $require = $required->{$key};
2106 my $rflags = $flags->{$key};
2107 return 0 unless _dispatch($require, $rflags);
2109 } elsif ($ref eq 'ARRAY') {
2111 foreach my $require ( @{$required} ) {
2113 ( ref($flags) && !ref($require) && ( $require ne '*' ) )
2114 ? $flags->{$require}
2116 $satisfied++ if _dispatch( $require, $rflags );
2118 return 0 unless $satisfied;
2120 croak "Unexpected structure found: $ref";
2127 my ( $userid, $flagsrequired ) = @_;
2129 #Koha::Exceptions::WrongParameter->throw('$flagsrequired should not be undef')
2130 # unless defined($flagsrequired);
2132 my $sth = C4::Context->dbh->prepare("SELECT flags FROM borrowers WHERE userid=?");
2133 $sth->execute($userid);
2134 my $row = $sth->fetchrow();
2135 my $flags = getuserflags( $row, $userid );
2137 return $flags unless defined($flagsrequired);
2138 return $flags if $flags->{superlibrarian};
2139 return _dispatch($flagsrequired, $flags);
2141 #FIXME - This fcn should return the failed permission so a suitable error msg can be delivered.
2146 $flags = ($iprange);
2148 C<$iprange> A space separated string describing an IP range. Can include single IPs or ranges
2150 Returns 1 if the remote address is in the provided iprange, or 0 otherwise.
2157 my @allowedipranges = $iprange ? split(' ', $iprange) : ();
2158 if (scalar @allowedipranges > 0) {
2160 eval { @rangelist = Net::CIDR::range2cidr(@allowedipranges); }; return 0 if $@;
2161 eval { $result = Net::CIDR::cidrlookup($ENV{'REMOTE_ADDR'}, @rangelist) } || Koha::Logger->get->warn('cidrlookup failed for ' . join(' ',@rangelist) );
2163 return $result ? 1 : 0;
2166 sub getborrowernumber {
2168 my $userenv = C4::Context->userenv;
2169 if ( defined($userenv) && ref($userenv) eq 'HASH' && $userenv->{number} ) {
2170 return $userenv->{number};
2172 my $dbh = C4::Context->dbh;
2173 for my $field ( 'userid', 'cardnumber' ) {
2175 $dbh->prepare("select borrowernumber from borrowers where $field=?");
2176 $sth->execute($userid);
2178 my ($bnumber) = $sth->fetchrow;
2185 =head2 track_login_daily
2187 track_login_daily( $userid );
2189 Wraps the call to $patron->track_login, the method used to update borrowers.lastseen. We only call track_login once a day.
2193 sub track_login_daily {
2195 return if !$userid || !C4::Context->preference('TrackLastPatronActivity');
2197 my $cache = Koha::Caches->get_instance();
2198 my $cache_key = "track_login_" . $userid;
2199 my $cached = $cache->get_from_cache($cache_key);
2200 my $today = dt_from_string()->ymd;
2201 return if $cached && $cached eq $today;
2203 my $patron = Koha::Patrons->find({ userid => $userid });
2204 return unless $patron;
2205 $patron->track_login;
2206 $cache->set_in_cache( $cache_key, $today );
2209 END { } # module clean-up code here (global destructor)
2219 Crypt::Eksblowfish::Bcrypt(3)