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 XSLTDetailsDisplay => C4::Context->preference("XSLTDetailsDisplay"),
496 XSLTResultsDisplay => C4::Context->preference("XSLTResultsDisplay"),
497 noItemTypeImages => C4::Context->preference("noItemTypeImages"),
498 marcflavour => C4::Context->preference("marcflavour"),
499 OPACBaseURL => C4::Context->preference('OPACBaseURL'),
500 minPasswordLength => $minPasswordLength,
502 if ( $in->{'type'} eq "intranet" ) {
504 AmazonCoverImages => C4::Context->preference("AmazonCoverImages"),
505 AutoLocation => C4::Context->preference("AutoLocation"),
506 "BiblioDefaultView" . C4::Context->preference("IntranetBiblioDefaultView") => 1,
507 PatronAutoComplete => C4::Context->preference("PatronAutoComplete"),
508 FRBRizeEditions => C4::Context->preference("FRBRizeEditions"),
509 IndependentBranches => C4::Context->preference("IndependentBranches"),
510 IntranetNav => C4::Context->preference("IntranetNav"),
511 IntranetmainUserblock => C4::Context->preference("IntranetmainUserblock"),
512 LibraryName => C4::Context->preference("LibraryName"),
513 advancedMARCEditor => C4::Context->preference("advancedMARCEditor"),
514 canreservefromotherbranches => C4::Context->preference('canreservefromotherbranches'),
515 intranetcolorstylesheet => C4::Context->preference("intranetcolorstylesheet"),
516 IntranetFavicon => C4::Context->preference("IntranetFavicon"),
517 intranetreadinghistory => C4::Context->preference("intranetreadinghistory"),
518 intranetstylesheet => C4::Context->preference("intranetstylesheet"),
519 IntranetUserCSS => C4::Context->preference("IntranetUserCSS"),
520 IntranetUserJS => C4::Context->preference("IntranetUserJS"),
521 suggestion => C4::Context->preference("suggestion"),
522 virtualshelves => C4::Context->preference("virtualshelves"),
523 StaffSerialIssueDisplayCount => C4::Context->preference("StaffSerialIssueDisplayCount"),
524 EasyAnalyticalRecords => C4::Context->preference('EasyAnalyticalRecords'),
525 LocalCoverImages => C4::Context->preference('LocalCoverImages'),
526 OPACLocalCoverImages => C4::Context->preference('OPACLocalCoverImages'),
527 AllowMultipleCovers => C4::Context->preference('AllowMultipleCovers'),
528 EnableBorrowerFiles => C4::Context->preference('EnableBorrowerFiles'),
529 UseCourseReserves => C4::Context->preference("UseCourseReserves"),
530 useDischarge => C4::Context->preference('useDischarge'),
531 pending_checkout_notes => scalar Koha::Checkouts->search({ noteseen => 0 }),
535 warn "template type should be OPAC, here it is=[" . $in->{'type'} . "]" unless ( $in->{'type'} eq 'opac' );
537 #TODO : replace LibraryName syspref with 'system name', and remove this html processing
538 my $LibraryNameTitle = C4::Context->preference("LibraryName");
539 $LibraryNameTitle =~ s/<(?:\/?)(?:br|p)\s*(?:\/?)>/ /sgi;
540 $LibraryNameTitle =~ s/<(?:[^<>'"]|'(?:[^']*)'|"(?:[^"]*)")*>//sg;
542 # clean up the busc param in the session
543 # if the page is not opac-detail and not the "add to list" page
544 # and not the "edit comments" page
545 if ( C4::Context->preference("OpacBrowseResults")
546 && $in->{'template_name'} =~ /opac-(.+)\.(?:tt|tmpl)$/ ) {
548 unless ( $pagename =~ /^(?:MARC|ISBD)?detail$/
549 or $pagename =~ /^showmarc$/
550 or $pagename =~ /^addbybiblionumber$/
551 or $pagename =~ /^review$/ ) {
552 my $sessionSearch = get_session( $sessionID || $in->{'query'}->cookie("CGISESSID") );
553 $sessionSearch->clear( ["busc"] ) if ( $sessionSearch->param("busc") );
557 # variables passed from CGI: opac_css_override and opac_search_limits.
558 my $opac_search_limit = $ENV{'OPAC_SEARCH_LIMIT'};
559 my $opac_limit_override = $ENV{'OPAC_LIMIT_OVERRIDE'};
562 ( $opac_limit_override && $opac_search_limit && $opac_search_limit =~ /branch:([\w-]+)/ ) ||
563 ( $in->{'query'}->param('limit') && $in->{'query'}->param('limit') =~ /branch:([\w-]+)/ ) ||
564 ( $in->{'query'}->param('multibranchlimit') && $in->{'query'}->param('multibranchlimit') =~ /multibranchlimit-(\w+)/ )
566 $opac_name = $1; # opac_search_limit is a branch, so we use it.
567 } elsif ( $in->{'query'}->param('multibranchlimit') ) {
568 $opac_name = $in->{'query'}->param('multibranchlimit');
569 } elsif ( C4::Context->preference("SearchMyLibraryFirst") && C4::Context->userenv && C4::Context->userenv->{'branch'} ) {
570 $opac_name = C4::Context->userenv->{'branch'};
573 my @search_groups = Koha::Library::Groups->get_search_groups({ interface => 'opac' });
575 AnonSuggestions => "" . C4::Context->preference("AnonSuggestions"),
576 LibrarySearchGroups => \@search_groups,
577 opac_name => $opac_name,
578 LibraryName => "" . C4::Context->preference("LibraryName"),
579 LibraryNameTitle => "" . $LibraryNameTitle,
580 OPACAmazonCoverImages => C4::Context->preference("OPACAmazonCoverImages"),
581 OPACFRBRizeEditions => C4::Context->preference("OPACFRBRizeEditions"),
582 OpacHighlightedWords => C4::Context->preference("OpacHighlightedWords"),
583 OPACShelfBrowser => "" . C4::Context->preference("OPACShelfBrowser"),
584 OPACURLOpenInNewWindow => "" . C4::Context->preference("OPACURLOpenInNewWindow"),
585 OPACUserCSS => "" . C4::Context->preference("OPACUserCSS"),
586 OpacAuthorities => C4::Context->preference("OpacAuthorities"),
587 opac_css_override => $ENV{'OPAC_CSS_OVERRIDE'},
588 opac_search_limit => $opac_search_limit,
589 opac_limit_override => $opac_limit_override,
590 OpacBrowser => C4::Context->preference("OpacBrowser"),
591 OpacCloud => C4::Context->preference("OpacCloud"),
592 OpacKohaUrl => C4::Context->preference("OpacKohaUrl"),
593 OpacNav => "" . C4::Context->preference("OpacNav"),
594 OpacNavBottom => "" . C4::Context->preference("OpacNavBottom"),
595 OpacPasswordChange => C4::Context->preference("OpacPasswordChange"),
596 OPACPatronDetails => C4::Context->preference("OPACPatronDetails"),
597 OPACPrivacy => C4::Context->preference("OPACPrivacy"),
598 OPACFinesTab => C4::Context->preference("OPACFinesTab"),
599 OpacTopissue => C4::Context->preference("OpacTopissue"),
600 RequestOnOpac => C4::Context->preference("RequestOnOpac"),
601 'Version' => C4::Context->preference('Version'),
602 hidelostitems => C4::Context->preference("hidelostitems"),
603 mylibraryfirst => ( C4::Context->preference("SearchMyLibraryFirst") && C4::Context->userenv ) ? C4::Context->userenv->{'branch'} : '',
604 opacbookbag => "" . C4::Context->preference("opacbookbag"),
605 OpacFavicon => C4::Context->preference("OpacFavicon"),
606 opaclanguagesdisplay => "" . C4::Context->preference("opaclanguagesdisplay"),
607 opacreadinghistory => C4::Context->preference("opacreadinghistory"),
608 OPACUserJS => C4::Context->preference("OPACUserJS"),
609 opacuserlogin => "" . C4::Context->preference("opacuserlogin"),
610 OpenLibrarySearch => C4::Context->preference("OpenLibrarySearch"),
611 ShowReviewer => C4::Context->preference("ShowReviewer"),
612 ShowReviewerPhoto => C4::Context->preference("ShowReviewerPhoto"),
613 suggestion => "" . C4::Context->preference("suggestion"),
614 virtualshelves => "" . C4::Context->preference("virtualshelves"),
615 OPACSerialIssueDisplayCount => C4::Context->preference("OPACSerialIssueDisplayCount"),
616 OPACXSLTDetailsDisplay => C4::Context->preference("OPACXSLTDetailsDisplay"),
617 OPACXSLTResultsDisplay => C4::Context->preference("OPACXSLTResultsDisplay"),
618 SyndeticsClientCode => C4::Context->preference("SyndeticsClientCode"),
619 SyndeticsEnabled => C4::Context->preference("SyndeticsEnabled"),
620 SyndeticsCoverImages => C4::Context->preference("SyndeticsCoverImages"),
621 SyndeticsTOC => C4::Context->preference("SyndeticsTOC"),
622 SyndeticsSummary => C4::Context->preference("SyndeticsSummary"),
623 SyndeticsEditions => C4::Context->preference("SyndeticsEditions"),
624 SyndeticsExcerpt => C4::Context->preference("SyndeticsExcerpt"),
625 SyndeticsReviews => C4::Context->preference("SyndeticsReviews"),
626 SyndeticsAuthorNotes => C4::Context->preference("SyndeticsAuthorNotes"),
627 SyndeticsAwards => C4::Context->preference("SyndeticsAwards"),
628 SyndeticsSeries => C4::Context->preference("SyndeticsSeries"),
629 SyndeticsCoverImageSize => C4::Context->preference("SyndeticsCoverImageSize"),
630 OPACLocalCoverImages => C4::Context->preference("OPACLocalCoverImages"),
631 PatronSelfRegistration => C4::Context->preference("PatronSelfRegistration"),
632 PatronSelfRegistrationDefaultCategory => C4::Context->preference("PatronSelfRegistrationDefaultCategory"),
633 useDischarge => C4::Context->preference('useDischarge'),
636 $template->param( OpacPublic => '1' ) if ( $user || C4::Context->preference("OpacPublic") );
639 # Check if we were asked using parameters to force a specific language
640 if ( defined $in->{'query'}->param('language') ) {
642 # Extract the language, let C4::Languages::getlanguage choose
644 my $language = C4::Languages::getlanguage( $in->{'query'} );
645 my $languagecookie = C4::Templates::getlanguagecookie( $in->{'query'}, $language );
646 if ( ref $cookie eq 'ARRAY' ) {
647 push @{$cookie}, $languagecookie;
649 $cookie = [ $cookie, $languagecookie ];
653 return ( $template, $borrowernumber, $cookie, $flags );
658 ($userid, $cookie, $sessionID) = &checkauth($query, $noauth, $flagsrequired, $type);
660 Verifies that the user is authorized to run this script. If
661 the user is authorized, a (userid, cookie, session-id, flags)
662 quadruple is returned. If the user is not authorized but does
663 not have the required privilege (see $flagsrequired below), it
664 displays an error page and exits. Otherwise, it displays the
665 login page and exits.
667 Note that C<&checkauth> will return if and only if the user
668 is authorized, so it should be called early on, before any
669 unfinished operations (e.g., if you've opened a file, then
670 C<&checkauth> won't close it for you).
672 C<$query> is the CGI object for the script calling C<&checkauth>.
674 The C<$noauth> argument is optional. If it is set, then no
675 authorization is required for the script.
677 C<&checkauth> fetches user and session information from C<$query> and
678 ensures that the user is authorized to run scripts that require
681 The C<$flagsrequired> argument specifies the required privileges
682 the user must have if the username and password are correct.
683 It should be specified as a reference-to-hash; keys in the hash
684 should be the "flags" for the user, as specified in the Members
685 intranet module. Any key specified must correspond to a "flag"
686 in the userflags table. E.g., { circulate => 1 } would specify
687 that the user must have the "circulate" privilege in order to
688 proceed. To make sure that access control is correct, the
689 C<$flagsrequired> parameter must be specified correctly.
691 Koha also has a concept of sub-permissions, also known as
692 granular permissions. This makes the value of each key
693 in the C<flagsrequired> hash take on an additional
698 The user must have access to all subfunctions of the module
699 specified by the hash key.
703 The user must have access to at least one subfunction of the module
704 specified by the hash key.
706 specific permission, e.g., 'export_catalog'
708 The user must have access to the specific subfunction list, which
709 must correspond to a row in the permissions table.
711 The C<$type> argument specifies whether the template should be
712 retrieved from the opac or intranet directory tree. "opac" is
713 assumed if it is not specified; however, if C<$type> is specified,
714 "intranet" is assumed if it is not "opac".
716 If C<$query> does not have a valid session ID associated with it
717 (i.e., the user has not logged in) or if the session has expired,
718 C<&checkauth> presents the user with a login page (from the point of
719 view of the original script, C<&checkauth> does not return). Once the
720 user has authenticated, C<&checkauth> restarts the original script
721 (this time, C<&checkauth> returns).
723 The login page is provided using a HTML::Template, which is set in the
724 systempreferences table or at the top of this file. The variable C<$type>
725 selects which template to use, either the opac or the intranet
726 authentification template.
728 C<&checkauth> returns a user ID, a cookie, and a session ID. The
729 cookie should be sent back to the browser; it verifies that the user
739 # If version syspref is unavailable, it means Koha is being installed,
740 # and so we must redirect to OPAC maintenance page or to the WebInstaller
741 # also, if OpacMaintenance is ON, OPAC should redirect to maintenance
742 if ( C4::Context->preference('OpacMaintenance') && $type eq 'opac' ) {
743 warn "OPAC Install required, redirecting to maintenance";
744 print $query->redirect("/cgi-bin/koha/maintenance.pl");
747 unless ( $version = C4::Context->preference('Version') ) { # assignment, not comparison
748 if ( $type ne 'opac' ) {
749 warn "Install required, redirecting to Installer";
750 print $query->redirect("/cgi-bin/koha/installer/install.pl");
752 warn "OPAC Install required, redirecting to maintenance";
753 print $query->redirect("/cgi-bin/koha/maintenance.pl");
758 # check that database and koha version are the same
759 # there is no DB version, it's a fresh install,
760 # go to web installer
761 # there is a DB version, compare it to the code version
762 my $kohaversion = Koha::version();
764 # remove the 3 last . to have a Perl number
765 $kohaversion =~ s/(.*\..*)\.(.*)\.(.*)/$1$2$3/;
766 Koha::Logger->get->debug("kohaversion : $kohaversion");
767 if ( $version < $kohaversion ) {
768 my $warning = "Database update needed, redirecting to %s. Database is $version and Koha is $kohaversion";
769 if ( $type ne 'opac' ) {
770 warn sprintf( $warning, 'Installer' );
771 print $query->redirect("/cgi-bin/koha/installer/install.pl?step=1&op=updatestructure");
773 warn sprintf( "OPAC: " . $warning, 'maintenance' );
774 print $query->redirect("/cgi-bin/koha/maintenance.pl");
780 sub _timeout_syspref {
781 my $default_timeout = 600;
782 my $timeout = C4::Context->preference('timeout') || $default_timeout;
784 # value in days, convert in seconds
785 if ( $timeout =~ /^(\d+)[dD]$/ ) {
786 $timeout = $1 * 86400;
788 # value in hours, convert in seconds
789 elsif ( $timeout =~ /^(\d+)[hH]$/ ) {
790 $timeout = $1 * 3600;
792 elsif ( $timeout !~ m/^\d+$/ ) {
793 warn "The value of the system preference 'timeout' is not correct, defaulting to $default_timeout";
794 $timeout = $default_timeout;
803 # Get shibboleth login attribute
804 my $shib = C4::Context->config('useshibboleth') && shib_ok();
805 my $shib_login = $shib ? get_login_shib() : undef;
807 # $authnotrequired will be set for scripts which will run without authentication
808 my $authnotrequired = shift;
809 my $flagsrequired = shift;
811 my $emailaddress = shift;
812 my $template_name = shift;
813 $type = 'opac' unless $type;
815 unless ( C4::Context->preference("OpacPublic") ) {
816 my @allowed_scripts_for_private_opac = qw(
818 opac-registration-email-sent.tt
819 opac-registration-confirmation.tt
820 opac-memberentry-update-submitted.tt
821 opac-password-recovery.tt
823 $authnotrequired = 0 unless grep { $_ eq $template_name }
824 @allowed_scripts_for_private_opac;
827 my $dbh = C4::Context->dbh;
828 my $timeout = _timeout_syspref();
830 _version_check( $type, $query );
835 my ( $userid, $cookie, $sessionID, $flags );
836 my $logout = $query->param('logout.x');
838 my $anon_search_history;
840 # This parameter is the name of the CAS server we want to authenticate against,
841 # when using authentication against multiple CAS servers, as configured in Auth_cas_servers.yaml
842 my $casparam = $query->param('cas');
843 my $q_userid = $query->param('userid') // '';
847 # Basic authentication is incompatible with the use of Shibboleth,
848 # as Shibboleth may return REMOTE_USER as a Shibboleth attribute,
849 # and it may not be the attribute we want to use to match the koha login.
851 # Also, do not consider an empty REMOTE_USER.
853 # Finally, after those tests, we can assume (although if it would be better with
854 # a syspref) that if we get a REMOTE_USER, that's from basic authentication,
855 # and we can affect it to $userid.
856 if ( !$shib and defined( $ENV{'REMOTE_USER'} ) and $ENV{'REMOTE_USER'} ne '' and $userid = $ENV{'REMOTE_USER'} ) {
858 # Using Basic Authentication, no cookies required
859 $cookie = $query->cookie(
860 -name => 'CGISESSID',
864 -secure => ( C4::Context->https_enabled() ? 1 : 0 ),
868 elsif ( $emailaddress) {
869 # the Google OpenID Connect passes an email address
871 elsif ( $sessionID = $query->cookie("CGISESSID") )
872 { # assignment, not comparison
873 $session = get_session($sessionID);
874 C4::Context->_new_userenv($sessionID);
875 my ( $ip, $lasttime, $sessiontype );
878 $s_userid = $session->param('id') // '';
879 C4::Context->set_userenv(
880 $session->param('number'), $s_userid,
881 $session->param('cardnumber'), $session->param('firstname'),
882 $session->param('surname'), $session->param('branch'),
883 $session->param('branchname'), $session->param('flags'),
884 $session->param('emailaddress'), $session->param('shibboleth'),
885 $session->param('desk_id'), $session->param('desk_name'),
886 $session->param('register_id'), $session->param('register_name')
888 Koha::Logger->get->debug(sprintf "AUTH_SESSION: (%s)\t%s %s - %s", map { $session->param($_) || q{} } qw(cardnumber firstname surname branch));
889 $ip = $session->param('ip');
890 $lasttime = $session->param('lasttime');
892 $sessiontype = $session->param('sessiontype') || '';
894 if ( ( $query->param('koha_login_context') && ( $q_userid ne $s_userid ) )
895 || ( $cas && $query->param('ticket') && !C4::Context->userenv->{'id'} )
896 || ( $shib && $shib_login && !$logout && !C4::Context->userenv->{'id'} )
899 #if a user enters an id ne to the id in the current session, we need to log them in...
900 #first we need to clear the anonymous session...
901 $anon_search_history = $session->param('search_history');
904 C4::Context->_unset_userenv($sessionID);
910 # voluntary logout the user
911 # check wether the user was using their shibboleth session or a local one
912 my $shibSuccess = C4::Context->userenv->{'shibboleth'};
915 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) {
929 elsif ( !$lasttime || ( $lasttime < time() - $timeout ) ) {
932 $info{'timed_out'} = 1;
937 C4::Context->_unset_userenv($sessionID);
942 elsif ( C4::Context->preference('SessionRestrictionByIP') && $ip ne $ENV{'REMOTE_ADDR'} ) {
944 # Different ip than originally logged in from
945 $info{'oldip'} = $ip;
946 $info{'newip'} = $ENV{'REMOTE_ADDR'};
947 $info{'different_ip'} = 1;
950 C4::Context->_unset_userenv($sessionID);
956 $cookie = $query->cookie(
957 -name => 'CGISESSID',
958 -value => $session->id,
960 -secure => ( C4::Context->https_enabled() ? 1 : 0 ),
962 $session->param( 'lasttime', time() );
963 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...
964 $flags = haspermission( $userid, $flagsrequired );
968 $info{'nopermission'} = 1;
973 unless ( $userid || $sessionID ) {
974 #we initiate a session prior to checking for a username to allow for anonymous sessions...
975 my $session = get_session("") or die "Auth ERROR: Cannot get_session()";
977 # Save anonymous search history in new session so it can be retrieved
978 # by get_template_and_user to store it in user's search history after
979 # a successful login.
980 if ($anon_search_history) {
981 $session->param( 'search_history', $anon_search_history );
984 $sessionID = $session->id;
985 C4::Context->_new_userenv($sessionID);
986 $cookie = $query->cookie(
987 -name => 'CGISESSID',
988 -value => $session->id,
990 -secure => ( C4::Context->https_enabled() ? 1 : 0 ),
992 my $pki_field = C4::Context->preference('AllowPKIAuth');
993 if ( !defined($pki_field) ) {
994 print STDERR "ERROR: Missing system preference AllowPKIAuth.\n";
997 if ( ( $cas && $query->param('ticket') )
999 || ( $shib && $shib_login )
1000 || $pki_field ne 'None'
1003 my $password = $query->param('password');
1004 my $shibSuccess = 0;
1005 my ( $return, $cardnumber );
1007 # If shib is enabled and we have a shib login, does the login match a valid koha user
1008 if ( $shib && $shib_login ) {
1011 # Do not pass password here, else shib will not be checked in checkpw.
1012 ( $return, $cardnumber, $retuserid ) = checkpw( $dbh, $q_userid, undef, $query );
1013 $userid = $retuserid;
1014 $shibSuccess = $return;
1015 $info{'invalidShibLogin'} = 1 unless ($return);
1018 # If shib login and match were successful, skip further login methods
1019 unless ($shibSuccess) {
1020 if ( $cas && $query->param('ticket') ) {
1022 ( $return, $cardnumber, $retuserid, $cas_ticket ) =
1023 checkpw( $dbh, $userid, $password, $query, $type );
1024 $userid = $retuserid;
1025 $info{'invalidCasLogin'} = 1 unless ($return);
1028 elsif ( $emailaddress ) {
1029 my $value = $emailaddress;
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;
1044 $return = $value ? 1 : 0;
1049 ( $pki_field eq 'Common Name' && $ENV{'SSL_CLIENT_S_DN_CN'} )
1050 || ( $pki_field eq 'emailAddress'
1051 && $ENV{'SSL_CLIENT_S_DN_Email'} )
1055 if ( $pki_field eq 'Common Name' ) {
1056 $value = $ENV{'SSL_CLIENT_S_DN_CN'};
1058 elsif ( $pki_field eq 'emailAddress' ) {
1059 $value = $ENV{'SSL_CLIENT_S_DN_Email'};
1061 # If we're looking up the email, there's a chance that the person
1062 # doesn't have a userid. So if there is none, we pass along the
1063 # borrower number, and the bits of code that need to know the user
1064 # ID will have to be smart enough to handle that.
1065 my $patrons = Koha::Patrons->search({ email => $value });
1066 if ($patrons->count) {
1068 # First the userid, then the borrowernum
1069 my $patron = $patrons->next;
1070 $value = $patron->userid || $patron->borrowernumber;
1076 $return = $value ? 1 : 0;
1082 my $request_method = $query->request_method();
1085 $request_method eq 'POST'
1086 || ( C4::Context->preference('AutoSelfCheckID')
1087 && $q_userid eq C4::Context->preference('AutoSelfCheckID') )
1091 ( $return, $cardnumber, $retuserid, $cas_ticket ) =
1092 checkpw( $dbh, $q_userid, $password, $query, $type );
1093 $userid = $retuserid if ($retuserid);
1094 $info{'invalid_username_or_password'} = 1 unless ($return);
1099 # If shib configured and shibOnly enabled, we should ignore anything other than a shibboleth type login.
1106 && C4::Context->preference('OPACShibOnly')
1108 || ( ( $type ne 'opac' )
1109 && C4::Context->preference('staffShibOnly') )
1116 # $return: 1 = valid user
1119 if ( $flags = haspermission( $userid, $flagsrequired ) ) {
1123 $info{'nopermission'} = 1;
1124 C4::Context->_unset_userenv($sessionID);
1126 my ( $borrowernumber, $firstname, $surname, $userflags,
1127 $branchcode, $branchname, $emailaddress, $desk_id,
1128 $desk_name, $register_id, $register_name );
1130 if ( $return == 1 ) {
1132 SELECT borrowernumber, firstname, surname, flags, borrowers.branchcode,
1133 branches.branchname as branchname, email
1135 LEFT JOIN branches on borrowers.branchcode=branches.branchcode
1137 my $sth = $dbh->prepare("$select where userid=?");
1138 $sth->execute($userid);
1139 unless ( $sth->rows ) {
1140 $sth = $dbh->prepare("$select where cardnumber=?");
1141 $sth->execute($cardnumber);
1143 unless ( $sth->rows ) {
1144 $sth->execute($userid);
1148 ( $borrowernumber, $firstname, $surname, $userflags,
1149 $branchcode, $branchname, $emailaddress ) = $sth->fetchrow;
1152 # launch a sequence to check if we have a ip for the branch, i
1153 # if we have one we replace the branchcode of the userenv by the branch bound in the ip.
1155 my $ip = $ENV{'REMOTE_ADDR'};
1157 # if they specify at login, use that
1158 if ( $query->param('branch') ) {
1159 $branchcode = $query->param('branch');
1160 my $library = Koha::Libraries->find($branchcode);
1161 $branchname = $library? $library->branchname: '';
1163 if ( $query->param('desk_id') ) {
1164 $desk_id = $query->param('desk_id');
1165 my $desk = Koha::Desks->find($desk_id);
1166 $desk_name = $desk ? $desk->desk_name : '';
1168 if ( C4::Context->preference('UseCashRegisters') ) {
1170 $query->param('register_id')
1171 ? Koha::Cash::Registers->find($query->param('register_id'))
1172 : Koha::Cash::Registers->search(
1173 { branch => $branchcode, branch_default => 1 },
1174 { rows => 1 } )->single;
1175 $register_id = $register->id if ($register);
1176 $register_name = $register->name if ($register);
1178 my $branches = { map { $_->branchcode => $_->unblessed } Koha::Libraries->search };
1179 if ( $type ne 'opac' and C4::Context->preference('AutoLocation') ) {
1181 # we have to check they are coming from the right ip range
1182 my $domain = $branches->{$branchcode}->{'branchip'};
1183 $domain =~ s|\.\*||g;
1184 if ( $ip !~ /^$domain/ ) {
1186 $cookie = $query->cookie(
1187 -name => 'CGISESSID',
1190 -secure => ( C4::Context->https_enabled() ? 1 : 0 ),
1192 $info{'wrongip'} = 1;
1196 foreach my $br ( keys %$branches ) {
1198 # now we work with the treatment of ip
1199 my $domain = $branches->{$br}->{'branchip'};
1200 if ( $domain && $ip =~ /^$domain/ ) {
1201 $branchcode = $branches->{$br}->{'branchcode'};
1203 # new op dev : add the branchname to the cookie
1204 $branchname = $branches->{$br}->{'branchname'};
1207 $session->param( 'number', $borrowernumber );
1208 $session->param( 'id', $userid );
1209 $session->param( 'cardnumber', $cardnumber );
1210 $session->param( 'firstname', $firstname );
1211 $session->param( 'surname', $surname );
1212 $session->param( 'branch', $branchcode );
1213 $session->param( 'branchname', $branchname );
1214 $session->param( 'desk_id', $desk_id);
1215 $session->param( 'desk_name', $desk_name);
1216 $session->param( 'flags', $userflags );
1217 $session->param( 'emailaddress', $emailaddress );
1218 $session->param( 'ip', $session->remote_addr() );
1219 $session->param( 'lasttime', time() );
1220 $session->param( 'interface', $type);
1221 $session->param( 'shibboleth', $shibSuccess );
1222 $session->param( 'register_id', $register_id );
1223 $session->param( 'register_name', $register_name );
1225 $session->param('cas_ticket', $cas_ticket) if $cas_ticket;
1226 C4::Context->set_userenv(
1227 $session->param('number'), $session->param('id'),
1228 $session->param('cardnumber'), $session->param('firstname'),
1229 $session->param('surname'), $session->param('branch'),
1230 $session->param('branchname'), $session->param('flags'),
1231 $session->param('emailaddress'), $session->param('shibboleth'),
1232 $session->param('desk_id'), $session->param('desk_name'),
1233 $session->param('register_id'), $session->param('register_name')
1237 # $return: 0 = invalid user
1238 # reset to anonymous session
1241 $info{'invalid_username_or_password'} = 1;
1242 C4::Context->_unset_userenv($sessionID);
1244 $session->param( 'lasttime', time() );
1245 $session->param( 'ip', $session->remote_addr() );
1246 $session->param( 'sessiontype', 'anon' );
1247 $session->param( 'interface', $type);
1249 } # END if ( $q_userid
1250 elsif ( $type eq "opac" ) {
1252 # anonymous sessions are created only for the OPAC
1254 # setting a couple of other session vars...
1255 $session->param( 'ip', $session->remote_addr() );
1256 $session->param( 'lasttime', time() );
1257 $session->param( 'sessiontype', 'anon' );
1258 $session->param( 'interface', $type);
1260 } # END unless ($userid)
1262 # finished authentification, now respond
1263 if ( $loggedin || $authnotrequired )
1267 $cookie = $query->cookie(
1268 -name => 'CGISESSID',
1271 -secure => ( C4::Context->https_enabled() ? 1 : 0 ),
1275 track_login_daily( $userid );
1277 # In case, that this request was a login attempt, we want to prevent that users can repost the opac login
1278 # request. We therefore redirect the user to the requested page again without the login parameters.
1279 # See Post/Redirect/Get (PRG) design pattern: https://en.wikipedia.org/wiki/Post/Redirect/Get
1280 if ( $type eq "opac" && $query->param('koha_login_context') && $query->param('koha_login_context') ne 'sco' && $query->param('password') && $query->param('userid') ) {
1281 my $uri = URI->new($query->url(-relative=>1, -query_string=>1));
1282 $uri->query_param_delete('userid');
1283 $uri->query_param_delete('password');
1284 $uri->query_param_delete('koha_login_context');
1285 print $query->redirect(-uri => $uri->as_string, -cookie => $cookie, -status=>'303 See other');
1289 return ( $userid, $cookie, $sessionID, $flags );
1294 # AUTH rejected, show the login/password template, after checking the DB.
1298 # get the inputs from the incoming query
1300 foreach my $name ( param $query) {
1301 (next) if ( $name eq 'userid' || $name eq 'password' || $name eq 'ticket' );
1302 my @value = $query->multi_param($name);
1303 push @inputs, { name => $name, value => $_ } for @value;
1306 my $patron = Koha::Patrons->find({ userid => $q_userid }); # Not necessary logged in!
1308 my $LibraryNameTitle = C4::Context->preference("LibraryName");
1309 $LibraryNameTitle =~ s/<(?:\/?)(?:br|p)\s*(?:\/?)>/ /sgi;
1310 $LibraryNameTitle =~ s/<(?:[^<>'"]|'(?:[^']*)'|"(?:[^"]*)")*>//sg;
1312 my $auth_template_name = ( $type eq 'opac' ) ? 'opac-auth.tt' : 'auth.tt';
1313 my $template = C4::Templates::gettemplate( $auth_template_name, $type, $query );
1317 script_name => get_script_name(),
1318 casAuthentication => C4::Context->preference("casAuthentication"),
1319 shibbolethAuthentication => $shib,
1320 SessionRestrictionByIP => C4::Context->preference("SessionRestrictionByIP"),
1321 suggestion => C4::Context->preference("suggestion"),
1322 virtualshelves => C4::Context->preference("virtualshelves"),
1323 LibraryName => "" . C4::Context->preference("LibraryName"),
1324 LibraryNameTitle => "" . $LibraryNameTitle,
1325 opacuserlogin => C4::Context->preference("opacuserlogin"),
1326 OpacNav => C4::Context->preference("OpacNav"),
1327 OpacNavBottom => C4::Context->preference("OpacNavBottom"),
1328 OpacFavicon => C4::Context->preference("OpacFavicon"),
1329 opacreadinghistory => C4::Context->preference("opacreadinghistory"),
1330 opaclanguagesdisplay => C4::Context->preference("opaclanguagesdisplay"),
1331 OPACUserJS => C4::Context->preference("OPACUserJS"),
1332 opacbookbag => "" . C4::Context->preference("opacbookbag"),
1333 OpacCloud => C4::Context->preference("OpacCloud"),
1334 OpacTopissue => C4::Context->preference("OpacTopissue"),
1335 OpacAuthorities => C4::Context->preference("OpacAuthorities"),
1336 OpacBrowser => C4::Context->preference("OpacBrowser"),
1337 TagsEnabled => C4::Context->preference("TagsEnabled"),
1338 OPACUserCSS => C4::Context->preference("OPACUserCSS"),
1339 intranetcolorstylesheet => C4::Context->preference("intranetcolorstylesheet"),
1340 intranetstylesheet => C4::Context->preference("intranetstylesheet"),
1341 IntranetNav => C4::Context->preference("IntranetNav"),
1342 IntranetFavicon => C4::Context->preference("IntranetFavicon"),
1343 IntranetUserCSS => C4::Context->preference("IntranetUserCSS"),
1344 IntranetUserJS => C4::Context->preference("IntranetUserJS"),
1345 IndependentBranches => C4::Context->preference("IndependentBranches"),
1346 AutoLocation => C4::Context->preference("AutoLocation"),
1347 wrongip => $info{'wrongip'},
1348 PatronSelfRegistration => C4::Context->preference("PatronSelfRegistration"),
1349 PatronSelfRegistrationDefaultCategory => C4::Context->preference("PatronSelfRegistrationDefaultCategory"),
1350 opac_css_override => $ENV{'OPAC_CSS_OVERRIDE'},
1351 too_many_login_attempts => ( $patron and $patron->account_locked )
1354 $template->param( SCO_login => 1 ) if ( $query->param('sco_user_login') );
1355 $template->param( SCI_login => 1 ) if ( $query->param('sci_user_login') );
1356 $template->param( OpacPublic => C4::Context->preference("OpacPublic") );
1357 $template->param( loginprompt => 1 ) unless $info{'nopermission'};
1359 if ( $type eq 'opac' ) {
1360 require Koha::Virtualshelves;
1361 my $some_public_shelves = Koha::Virtualshelves->get_some_shelves(
1367 some_public_shelves => $some_public_shelves,
1373 # Is authentication against multiple CAS servers enabled?
1374 if ( C4::Auth_with_cas::multipleAuth && !$casparam ) {
1375 my $casservers = C4::Auth_with_cas::getMultipleAuth();
1377 foreach my $key ( keys %$casservers ) {
1378 push @tmplservers, { name => $key, value => login_cas_url( $query, $key, $type ) . "?cas=$key" };
1381 casServersLoop => \@tmplservers
1385 casServerUrl => login_cas_url($query, undef, $type),
1390 invalidCasLogin => $info{'invalidCasLogin'}
1395 #If shibOnly is enabled just go ahead and redirect directly
1396 if ( (($type eq 'opac') && C4::Context->preference('OPACShibOnly')) || (($type ne 'opac') && C4::Context->preference('staffShibOnly')) ) {
1397 my $redirect_url = login_shib_url( $query );
1398 print $query->redirect( -uri => "$redirect_url", -status => 303 );
1403 shibbolethAuthentication => $shib,
1404 shibbolethLoginUrl => login_shib_url($query),
1408 if (C4::Context->preference('GoogleOpenIDConnect')) {
1409 if ($query->param("OpenIDConnectFailed")) {
1410 my $reason = $query->param('OpenIDConnectFailed');
1411 $template->param(invalidGoogleOpenIDConnectLogin => $reason);
1416 LibraryName => C4::Context->preference("LibraryName"),
1418 $template->param(%info);
1420 # $cookie = $query->cookie(CGISESSID => $session->id
1422 print $query->header(
1423 { type => 'text/html',
1426 'X-Frame-Options' => 'SAMEORIGIN'
1433 =head2 check_api_auth
1435 ($status, $cookie, $sessionId) = check_api_auth($query, $userflags);
1437 Given a CGI query containing the parameters 'userid' and 'password' and/or a session
1438 cookie, determine if the user has the privileges specified by C<$userflags>.
1440 C<check_api_auth> is is meant for authenticating users of web services, and
1441 consequently will always return and will not attempt to redirect the user
1444 If a valid session cookie is already present, check_api_auth will return a status
1445 of "ok", the cookie, and the Koha session ID.
1447 If no session cookie is present, check_api_auth will check the 'userid' and 'password
1448 parameters and create a session cookie and Koha session if the supplied credentials
1451 Possible return values in C<$status> are:
1455 =item "ok" -- user authenticated; C<$cookie> and C<$sessionid> have valid values.
1457 =item "failed" -- credentials are not correct; C<$cookie> and C<$sessionid> are undef
1459 =item "maintenance" -- DB is in maintenance mode; no login possible at the moment
1461 =item "expired -- session cookie has expired; API user should resubmit userid and password
1467 sub check_api_auth {
1470 my $flagsrequired = shift;
1471 my $dbh = C4::Context->dbh;
1472 my $timeout = _timeout_syspref();
1474 unless ( C4::Context->preference('Version') ) {
1476 # database has not been installed yet
1477 return ( "maintenance", undef, undef );
1479 my $kohaversion = Koha::version();
1480 $kohaversion =~ s/(.*\..*)\.(.*)\.(.*)/$1$2$3/;
1481 if ( C4::Context->preference('Version') < $kohaversion ) {
1483 # database in need of version update; assume that
1484 # no API should be called while databsae is in
1486 return ( "maintenance", undef, undef );
1489 # FIXME -- most of what follows is a copy-and-paste
1490 # of code from checkauth. There is an obvious need
1491 # for refactoring to separate the various parts of
1492 # the authentication code, but as of 2007-11-19 this
1493 # is deferred so as to not introduce bugs into the
1494 # regular authentication code for Koha 3.0.
1496 # see if we have a valid session cookie already
1497 # however, if a userid parameter is present (i.e., from
1498 # a form submission, assume that any current cookie
1500 my $sessionID = undef;
1501 unless ( $query->param('userid') ) {
1502 $sessionID = $query->cookie("CGISESSID");
1504 if ( $sessionID && not( $cas && $query->param('PT') ) ) {
1505 my $session = get_session($sessionID);
1506 C4::Context->_new_userenv($sessionID);
1508 C4::Context->interface($session->param('interface'));
1509 C4::Context->set_userenv(
1510 $session->param('number'), $session->param('id'),
1511 $session->param('cardnumber'), $session->param('firstname'),
1512 $session->param('surname'), $session->param('branch'),
1513 $session->param('branchname'), $session->param('flags'),
1514 $session->param('emailaddress'), $session->param('shibboleth'),
1515 $session->param('desk_id'), $session->param('desk_name'),
1516 $session->param('register_id'), $session->param('register_name')
1519 my $ip = $session->param('ip');
1520 my $lasttime = $session->param('lasttime');
1521 my $userid = $session->param('id');
1522 if ( $lasttime < time() - $timeout ) {
1527 C4::Context->_unset_userenv($sessionID);
1530 return ( "expired", undef, undef );
1531 } elsif ( C4::Context->preference('SessionRestrictionByIP') && $ip ne $ENV{'REMOTE_ADDR'} ) {
1533 # IP address changed
1536 C4::Context->_unset_userenv($sessionID);
1539 return ( "expired", undef, undef );
1541 my $cookie = $query->cookie(
1542 -name => 'CGISESSID',
1543 -value => $session->id,
1545 -secure => ( C4::Context->https_enabled() ? 1 : 0 ),
1547 $session->param( 'lasttime', time() );
1548 my $flags = haspermission( $userid, $flagsrequired );
1550 return ( "ok", $cookie, $sessionID );
1554 C4::Context->_unset_userenv($sessionID);
1557 return ( "failed", undef, undef );
1561 return ( "expired", undef, undef );
1566 my $userid = $query->param('userid');
1567 my $password = $query->param('password');
1568 my ( $return, $cardnumber, $cas_ticket );
1571 if ( $cas && $query->param('PT') ) {
1574 # In case of a CAS authentication, we use the ticket instead of the password
1575 my $PT = $query->param('PT');
1576 ( $return, $cardnumber, $userid, $cas_ticket ) = check_api_auth_cas( $dbh, $PT, $query ); # EXTERNAL AUTH
1579 # User / password auth
1580 unless ( $userid and $password ) {
1582 # caller did something wrong, fail the authenticateion
1583 return ( "failed", undef, undef );
1586 ( $return, $cardnumber, $newuserid, $cas_ticket ) = checkpw( $dbh, $userid, $password, $query );
1589 if ( $return and haspermission( $userid, $flagsrequired ) ) {
1590 my $session = get_session("");
1591 return ( "failed", undef, undef ) unless $session;
1593 my $sessionID = $session->id;
1594 C4::Context->_new_userenv($sessionID);
1595 my $cookie = $query->cookie(
1596 -name => 'CGISESSID',
1597 -value => $sessionID,
1599 -secure => ( C4::Context->https_enabled() ? 1 : 0 ),
1601 if ( $return == 1 ) {
1603 $borrowernumber, $firstname, $surname,
1604 $userflags, $branchcode, $branchname,
1609 "select borrowernumber, firstname, surname, flags, borrowers.branchcode, branches.branchname as branchname, email from borrowers left join branches on borrowers.branchcode=branches.branchcode where userid=?"
1611 $sth->execute($userid);
1613 $borrowernumber, $firstname, $surname,
1614 $userflags, $branchcode, $branchname,
1616 ) = $sth->fetchrow if ( $sth->rows );
1618 unless ( $sth->rows ) {
1619 my $sth = $dbh->prepare(
1620 "select borrowernumber, firstname, surname, flags, borrowers.branchcode, branches.branchname as branchname, email from borrowers left join branches on borrowers.branchcode=branches.branchcode where cardnumber=?"
1622 $sth->execute($cardnumber);
1624 $borrowernumber, $firstname, $surname,
1625 $userflags, $branchcode, $branchname,
1627 ) = $sth->fetchrow if ( $sth->rows );
1629 unless ( $sth->rows ) {
1630 $sth->execute($userid);
1632 $borrowernumber, $firstname, $surname, $userflags,
1633 $branchcode, $branchname, $emailaddress
1634 ) = $sth->fetchrow if ( $sth->rows );
1638 my $ip = $ENV{'REMOTE_ADDR'};
1640 # if they specify at login, use that
1641 if ( $query->param('branch') ) {
1642 $branchcode = $query->param('branch');
1643 my $library = Koha::Libraries->find($branchcode);
1644 $branchname = $library? $library->branchname: '';
1646 my $branches = { map { $_->branchcode => $_->unblessed } Koha::Libraries->search };
1647 foreach my $br ( keys %$branches ) {
1649 # now we work with the treatment of ip
1650 my $domain = $branches->{$br}->{'branchip'};
1651 if ( $domain && $ip =~ /^$domain/ ) {
1652 $branchcode = $branches->{$br}->{'branchcode'};
1654 # new op dev : add the branchname to the cookie
1655 $branchname = $branches->{$br}->{'branchname'};
1658 $session->param( 'number', $borrowernumber );
1659 $session->param( 'id', $userid );
1660 $session->param( 'cardnumber', $cardnumber );
1661 $session->param( 'firstname', $firstname );
1662 $session->param( 'surname', $surname );
1663 $session->param( 'branch', $branchcode );
1664 $session->param( 'branchname', $branchname );
1665 $session->param( 'flags', $userflags );
1666 $session->param( 'emailaddress', $emailaddress );
1667 $session->param( 'ip', $session->remote_addr() );
1668 $session->param( 'lasttime', time() );
1669 $session->param( 'interface', 'api' );
1671 $session->param( 'cas_ticket', $cas_ticket);
1672 C4::Context->set_userenv(
1673 $session->param('number'), $session->param('id'),
1674 $session->param('cardnumber'), $session->param('firstname'),
1675 $session->param('surname'), $session->param('branch'),
1676 $session->param('branchname'), $session->param('flags'),
1677 $session->param('emailaddress'), $session->param('shibboleth'),
1678 $session->param('desk_id'), $session->param('desk_name'),
1679 $session->param('register_id'), $session->param('register_name')
1681 return ( "ok", $cookie, $sessionID );
1683 return ( "failed", undef, undef );
1688 =head2 check_cookie_auth
1690 ($status, $sessionId) = check_api_auth($cookie, $userflags);
1692 Given a CGISESSID cookie set during a previous login to Koha, determine
1693 if the user has the privileges specified by C<$userflags>. C<$userflags>
1694 is passed unaltered into C<haspermission> and as such accepts all options
1695 avaiable to that routine with the one caveat that C<check_api_auth> will
1696 also allow 'undef' to be passed and in such a case the permissions check
1697 will be skipped altogether.
1699 C<check_cookie_auth> is meant for authenticating special services
1700 such as tools/upload-file.pl that are invoked by other pages that
1701 have been authenticated in the usual way.
1703 Possible return values in C<$status> are:
1707 =item "ok" -- user authenticated; C<$sessionID> have valid values.
1709 =item "failed" -- credentials are not correct; C<$sessionid> are undef
1711 =item "maintenance" -- DB is in maintenance mode; no login possible at the moment
1713 =item "expired -- session cookie has expired; API user should resubmit userid and password
1719 sub check_cookie_auth {
1721 my $flagsrequired = shift;
1724 my $remote_addr = $params->{remote_addr} || $ENV{REMOTE_ADDR};
1725 my $dbh = C4::Context->dbh;
1726 my $timeout = _timeout_syspref();
1728 unless ( C4::Context->preference('Version') ) {
1730 # database has not been installed yet
1731 return ( "maintenance", undef );
1733 my $kohaversion = Koha::version();
1734 $kohaversion =~ s/(.*\..*)\.(.*)\.(.*)/$1$2$3/;
1735 if ( C4::Context->preference('Version') < $kohaversion ) {
1737 # database in need of version update; assume that
1738 # no API should be called while databsae is in
1740 return ( "maintenance", undef );
1743 # FIXME -- most of what follows is a copy-and-paste
1744 # of code from checkauth. There is an obvious need
1745 # for refactoring to separate the various parts of
1746 # the authentication code, but as of 2007-11-23 this
1747 # is deferred so as to not introduce bugs into the
1748 # regular authentication code for Koha 3.0.
1750 # see if we have a valid session cookie already
1751 # however, if a userid parameter is present (i.e., from
1752 # a form submission, assume that any current cookie
1754 unless ( defined $cookie and $cookie ) {
1755 return ( "failed", undef );
1757 my $sessionID = $cookie;
1758 my $session = get_session($sessionID);
1759 C4::Context->_new_userenv($sessionID);
1761 C4::Context->interface($session->param('interface'));
1762 C4::Context->set_userenv(
1763 $session->param('number'), $session->param('id'),
1764 $session->param('cardnumber'), $session->param('firstname'),
1765 $session->param('surname'), $session->param('branch'),
1766 $session->param('branchname'), $session->param('flags'),
1767 $session->param('emailaddress'), $session->param('shibboleth'),
1768 $session->param('desk_id'), $session->param('desk_name'),
1769 $session->param('register_id'), $session->param('register_name')
1772 my $ip = $session->param('ip');
1773 my $lasttime = $session->param('lasttime');
1774 my $userid = $session->param('id');
1775 if ( $lasttime < time() - $timeout ) {
1780 C4::Context->_unset_userenv($sessionID);
1783 return ("expired", undef);
1784 } elsif ( C4::Context->preference('SessionRestrictionByIP') && $ip ne $remote_addr ) {
1786 # IP address changed
1789 C4::Context->_unset_userenv($sessionID);
1792 return ( "expired", undef );
1794 $session->param( 'lasttime', time() );
1795 my $flags = defined($flagsrequired) ? haspermission( $userid, $flagsrequired ) : 1;
1797 return ( "ok", $sessionID );
1801 C4::Context->_unset_userenv($sessionID);
1804 return ( "failed", undef );
1808 return ( "expired", undef );
1815 my $session = get_session($sessionID);
1817 Given a session ID, retrieve the CGI::Session object used to store
1818 the session's state. The session object can be used to store
1819 data that needs to be accessed by different scripts during a
1822 If the C<$sessionID> parameter is an empty string, a new session
1827 sub _get_session_params {
1828 my $storage_method = C4::Context->preference('SessionStorage');
1829 if ( $storage_method eq 'mysql' ) {
1830 my $dbh = C4::Context->dbh;
1831 return { dsn => "serializer:yamlxs;driver:MySQL;id:md5", dsn_args => { Handle => $dbh } };
1833 elsif ( $storage_method eq 'Pg' ) {
1834 my $dbh = C4::Context->dbh;
1835 return { dsn => "serializer:yamlxs;driver:PostgreSQL;id:md5", dsn_args => { Handle => $dbh } };
1837 elsif ( $storage_method eq 'memcached' && Koha::Caches->get_instance->memcached_cache ) {
1838 my $memcached = Koha::Caches->get_instance()->memcached_cache;
1839 return { dsn => "serializer:yamlxs;driver:memcached;id:md5", dsn_args => { Memcached => $memcached } };
1842 # catch all defaults to tmp should work on all systems
1843 my $dir = C4::Context::temporary_directory;
1844 my $instance = C4::Context->config( 'database' ); #actually for packages not exactly the instance name, but generally safer to leave it as it is
1845 return { dsn => "serializer:yamlxs;driver:File;id:md5", dsn_args => { Directory => "$dir/cgisess_$instance" } };
1850 my $sessionID = shift;
1851 my $params = _get_session_params();
1852 my $session = CGI::Session->new( $params->{dsn}, $sessionID, $params->{dsn_args} );
1854 die CGI::Session->errstr();
1860 # FIXME no_set_userenv may be replaced with force_branchcode_for_userenv
1861 # (or something similar)
1862 # Currently it's only passed from C4::SIP::ILS::Patron::check_password, but
1863 # not having a userenv defined could cause a crash.
1865 my ( $dbh, $userid, $password, $query, $type, $no_set_userenv ) = @_;
1866 $type = 'opac' unless $type;
1868 # Get shibboleth login attribute
1869 my $shib = C4::Context->config('useshibboleth') && shib_ok();
1870 my $shib_login = $shib ? get_login_shib() : undef;
1874 if ( defined $userid ){
1875 $patron = Koha::Patrons->find({ userid => $userid });
1876 $patron = Koha::Patrons->find({ cardnumber => $userid }) unless $patron;
1878 my $check_internal_as_fallback = 0;
1880 # Note: checkpw_* routines returns:
1883 # -1 if user bind failed (LDAP only)
1885 if ( $patron and $patron->account_locked ) {
1886 # Nothing to check, account is locked
1887 } elsif ($ldap && defined($password)) {
1888 my ( $retval, $retcard, $retuserid ) = checkpw_ldap(@_); # EXTERNAL AUTH
1889 if ( $retval == 1 ) {
1890 @return = ( $retval, $retcard, $retuserid );
1893 $check_internal_as_fallback = 1 if $retval == 0;
1895 } elsif ( $cas && $query && $query->param('ticket') ) {
1897 # In case of a CAS authentication, we use the ticket instead of the password
1898 my $ticket = $query->param('ticket');
1899 $query->delete('ticket'); # remove ticket to come back to original URL
1900 my ( $retval, $retcard, $retuserid, $cas_ticket ) = checkpw_cas( $dbh, $ticket, $query, $type ); # EXTERNAL AUTH
1902 @return = ( $retval, $retcard, $retuserid, $cas_ticket );
1906 $passwd_ok = $retval;
1909 # If we are in a shibboleth session (shibboleth is enabled, and a shibboleth match attribute is present)
1910 # Check for password to asertain whether we want to be testing against shibboleth or another method this
1912 elsif ( $shib && $shib_login && !$password ) {
1914 # In case of a Shibboleth authentication, we expect a shibboleth user attribute
1915 # (defined under shibboleth mapping in koha-conf.xml) to contain the login of the
1916 # shibboleth-authenticated user
1918 # Then, we check if it matches a valid koha user
1920 my ( $retval, $retcard, $retuserid ) = C4::Auth_with_shibboleth::checkpw_shib($shib_login); # EXTERNAL AUTH
1922 @return = ( $retval, $retcard, $retuserid );
1924 $passwd_ok = $retval;
1927 $check_internal_as_fallback = 1;
1931 if ( $check_internal_as_fallback ) {
1932 @return = checkpw_internal( $dbh, $userid, $password, $no_set_userenv);
1933 $passwd_ok = 1 if $return[0] > 0; # 1 or 2
1938 $patron->update({ login_attempts => 0 });
1939 } elsif( !$patron->account_locked ) {
1940 $patron->update({ login_attempts => $patron->login_attempts + 1 });
1944 # Optionally log success or failure
1945 if( $patron && $passwd_ok && C4::Context->preference('AuthSuccessLog') ) {
1946 logaction( 'AUTH', 'SUCCESS', $patron->id, "Valid password for $userid", $type );
1947 } elsif( !$passwd_ok && C4::Context->preference('AuthFailureLog') ) {
1948 logaction( 'AUTH', 'FAILURE', $patron ? $patron->id : 0, "Wrong password for $userid", $type );
1954 sub checkpw_internal {
1955 my ( $dbh, $userid, $password, $no_set_userenv ) = @_;
1957 $password = Encode::encode( 'UTF-8', $password )
1958 if Encode::is_utf8($password);
1962 "select password,cardnumber,borrowernumber,userid,firstname,surname,borrowers.branchcode,branches.branchname,flags from borrowers join branches on borrowers.branchcode=branches.branchcode where userid=?"
1964 $sth->execute($userid);
1966 my ( $stored_hash, $cardnumber, $borrowernumber, $userid, $firstname,
1967 $surname, $branchcode, $branchname, $flags )
1970 if ( checkpw_hash( $password, $stored_hash ) ) {
1972 C4::Context->set_userenv( "$borrowernumber", $userid, $cardnumber,
1973 $firstname, $surname, $branchcode, $branchname, $flags ) unless $no_set_userenv;
1974 return 1, $cardnumber, $userid;
1979 "select password,cardnumber,borrowernumber,userid,firstname,surname,borrowers.branchcode,branches.branchname,flags from borrowers join branches on borrowers.branchcode=branches.branchcode where cardnumber=?"
1981 $sth->execute($userid);
1983 my ( $stored_hash, $cardnumber, $borrowernumber, $userid, $firstname,
1984 $surname, $branchcode, $branchname, $flags )
1987 if ( checkpw_hash( $password, $stored_hash ) ) {
1989 C4::Context->set_userenv( $borrowernumber, $userid, $cardnumber,
1990 $firstname, $surname, $branchcode, $branchname, $flags ) unless $no_set_userenv;
1991 return 1, $cardnumber, $userid;
1998 my ( $password, $stored_hash ) = @_;
2000 return if $stored_hash eq '!';
2002 # check what encryption algorithm was implemented: Bcrypt - if the hash starts with '$2' it is Bcrypt else md5
2004 if ( substr( $stored_hash, 0, 2 ) eq '$2' ) {
2005 $hash = hash_password( $password, $stored_hash );
2007 $hash = md5_base64($password);
2009 return $hash eq $stored_hash;
2014 my $authflags = getuserflags($flags, $userid, [$dbh]);
2016 Translates integer flags into permissions strings hash.
2018 C<$flags> is the integer userflags value ( borrowers.userflags )
2019 C<$userid> is the members.userid, used for building subpermissions
2020 C<$authflags> is a hashref of permissions
2027 my $dbh = @_ ? shift : C4::Context->dbh;
2030 # I don't want to do this, but if someone logs in as the database
2031 # user, it would be preferable not to spam them to death with
2032 # numeric warnings. So, we make $flags numeric.
2033 no warnings 'numeric';
2036 my $sth = $dbh->prepare("SELECT bit, flag, defaulton FROM userflags");
2039 while ( my ( $bit, $flag, $defaulton ) = $sth->fetchrow ) {
2040 if ( ( $flags & ( 2**$bit ) ) || $defaulton ) {
2041 $userflags->{$flag} = 1;
2044 $userflags->{$flag} = 0;
2048 # get subpermissions and merge with top-level permissions
2049 my $user_subperms = get_user_subpermissions($userid);
2050 foreach my $module ( keys %$user_subperms ) {
2051 next if $userflags->{$module} == 1; # user already has permission for everything in this module
2052 $userflags->{$module} = $user_subperms->{$module};
2058 =head2 get_user_subpermissions
2060 $user_perm_hashref = get_user_subpermissions($userid);
2062 Given the userid (note, not the borrowernumber) of a staff user,
2063 return a hashref of hashrefs of the specific subpermissions
2064 accorded to the user. An example return is
2068 export_catalog => 1,
2069 import_patrons => 1,
2073 The top-level hash-key is a module or function code from
2074 userflags.flag, while the second-level key is a code
2077 The results of this function do not give a complete picture
2078 of the functions that a staff user can access; it is also
2079 necessary to check borrowers.flags.
2083 sub get_user_subpermissions {
2086 my $dbh = C4::Context->dbh;
2087 my $sth = $dbh->prepare( "SELECT flag, user_permissions.code
2088 FROM user_permissions
2089 JOIN permissions USING (module_bit, code)
2090 JOIN userflags ON (module_bit = bit)
2091 JOIN borrowers USING (borrowernumber)
2092 WHERE userid = ?" );
2093 $sth->execute($userid);
2095 my $user_perms = {};
2096 while ( my $perm = $sth->fetchrow_hashref ) {
2097 $user_perms->{ $perm->{'flag'} }->{ $perm->{'code'} } = 1;
2102 =head2 get_all_subpermissions
2104 my $perm_hashref = get_all_subpermissions();
2106 Returns a hashref of hashrefs defining all specific
2107 permissions currently defined. The return value
2108 has the same structure as that of C<get_user_subpermissions>,
2109 except that the innermost hash value is the description
2110 of the subpermission.
2114 sub get_all_subpermissions {
2115 my $dbh = C4::Context->dbh;
2116 my $sth = $dbh->prepare( "SELECT flag, code
2118 JOIN userflags ON (module_bit = bit)" );
2122 while ( my $perm = $sth->fetchrow_hashref ) {
2123 $all_perms->{ $perm->{'flag'} }->{ $perm->{'code'} } = 1;
2128 =head2 haspermission
2130 $flagsrequired = '*'; # Any permission at all
2131 $flagsrequired = 'a_flag'; # a_flag must be satisfied (all subpermissions)
2132 $flagsrequired = [ 'a_flag', 'b_flag' ]; # a_flag OR b_flag must be satisfied
2133 $flagsrequired = { 'a_flag => 1, 'b_flag' => 1 }; # a_flag AND b_flag must be satisfied
2134 $flagsrequired = { 'a_flag' => 'sub_a' }; # sub_a of a_flag must be satisfied
2135 $flagsrequired = { 'a_flag' => [ 'sub_a, 'sub_b' ] }; # sub_a OR sub_b of a_flag must be satisfied
2137 $flags = ($userid, $flagsrequired);
2139 C<$userid> the userid of the member
2140 C<$flags> is a query structure similar to that used by SQL::Abstract that
2141 denotes the combination of flags required. It is a required parameter.
2143 The main logic of this method is that things in arrays are OR'ed, and things
2144 in hashes are AND'ed. The `*` character can be used, at any depth, to denote `ANY`
2146 Returns member's flags or 0 if a permission is not met.
2151 my ($required, $flags) = @_;
2153 my $ref = ref($required);
2155 if ($required eq '*') {
2156 return 0 unless ( $flags or ref( $flags ) );
2158 return 0 unless ( $flags and (!ref( $flags ) || $flags->{$required} ));
2160 } elsif ($ref eq 'HASH') {
2161 foreach my $key (keys %{$required}) {
2162 next if $flags == 1;
2163 my $require = $required->{$key};
2164 my $rflags = $flags->{$key};
2165 return 0 unless _dispatch($require, $rflags);
2167 } elsif ($ref eq 'ARRAY') {
2169 foreach my $require ( @{$required} ) {
2171 ( ref($flags) && !ref($require) && ( $require ne '*' ) )
2172 ? $flags->{$require}
2174 $satisfied++ if _dispatch( $require, $rflags );
2176 return 0 unless $satisfied;
2178 croak "Unexpected structure found: $ref";
2185 my ( $userid, $flagsrequired ) = @_;
2187 #Koha::Exceptions::WrongParameter->throw('$flagsrequired should not be undef')
2188 # unless defined($flagsrequired);
2190 my $sth = C4::Context->dbh->prepare("SELECT flags FROM borrowers WHERE userid=?");
2191 $sth->execute($userid);
2192 my $row = $sth->fetchrow();
2193 my $flags = getuserflags( $row, $userid );
2195 return $flags unless defined($flagsrequired);
2196 return $flags if $flags->{superlibrarian};
2197 return _dispatch($flagsrequired, $flags);
2199 #FIXME - This fcn should return the failed permission so a suitable error msg can be delivered.
2204 $flags = ($iprange);
2206 C<$iprange> A space separated string describing an IP range. Can include single IPs or ranges
2208 Returns 1 if the remote address is in the provided iprange, or 0 otherwise.
2215 my @allowedipranges = $iprange ? split(' ', $iprange) : ();
2216 if (scalar @allowedipranges > 0) {
2218 eval { @rangelist = Net::CIDR::range2cidr(@allowedipranges); }; return 0 if $@;
2219 eval { $result = Net::CIDR::cidrlookup($ENV{'REMOTE_ADDR'}, @rangelist) } || Koha::Logger->get->warn('cidrlookup failed for ' . join(' ',@rangelist) );
2221 return $result ? 1 : 0;
2224 sub getborrowernumber {
2226 my $userenv = C4::Context->userenv;
2227 if ( defined($userenv) && ref($userenv) eq 'HASH' && $userenv->{number} ) {
2228 return $userenv->{number};
2230 my $dbh = C4::Context->dbh;
2231 for my $field ( 'userid', 'cardnumber' ) {
2233 $dbh->prepare("select borrowernumber from borrowers where $field=?");
2234 $sth->execute($userid);
2236 my ($bnumber) = $sth->fetchrow;
2243 =head2 track_login_daily
2245 track_login_daily( $userid );
2247 Wraps the call to $patron->track_login, the method used to update borrowers.lastseen. We only call track_login once a day.
2251 sub track_login_daily {
2253 return if !$userid || !C4::Context->preference('TrackLastPatronActivity');
2255 my $cache = Koha::Caches->get_instance();
2256 my $cache_key = "track_login_" . $userid;
2257 my $cached = $cache->get_from_cache($cache_key);
2258 my $today = dt_from_string()->ymd;
2259 return if $cached && $cached eq $today;
2261 my $patron = Koha::Patrons->find({ userid => $userid });
2262 return unless $patron;
2263 $patron->track_login;
2264 $cache->set_in_cache( $cache_key, $today );
2267 END { } # module clean-up code here (global destructor)
2277 Crypt::Eksblowfish::Bcrypt(3)