3 # Copyright 2000-2002 Katipo Communications
5 # This file is part of Koha.
7 # Koha is free software; you can redistribute it and/or modify it
8 # under the terms of the GNU General Public License as published by
9 # the Free Software Foundation; either version 3 of the License, or
10 # (at your option) any later version.
12 # Koha is distributed in the hope that it will be useful, but
13 # WITHOUT ANY WARRANTY; without even the implied warranty of
14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 # GNU General Public License for more details.
17 # You should have received a copy of the GNU General Public License
18 # along with Koha; if not, see <http://www.gnu.org/licenses>.
24 use Digest::MD5 qw( md5_base64 );
26 use CGI::Session::ErrorHandler;
31 use C4::Templates; # to get the template
33 use C4::Search::History;
37 use Koha::AuthUtils qw( get_script_name hash_password );
38 use Koha::Auth::TwoFactorAuth;
40 use Koha::DateUtils qw( dt_from_string );
41 use Koha::Library::Groups;
43 use Koha::Cash::Registers;
46 use Koha::Patron::Consents;
47 use List::MoreUtils qw( any );
49 use C4::Auth_with_shibboleth qw( shib_ok get_login_shib login_shib_url logout_shib checkpw_shib );
51 use C4::Log qw( logaction );
52 use Koha::CookieManager;
56 use vars qw($ldap $cas $caslogout);
57 our (@ISA, @EXPORT_OK);
59 sub psgi_env { any { /^psgi\./ } keys %ENV }
62 if (psgi_env) { die 'psgi:exit' }
66 C4::Context->set_remote_address;
72 checkauth check_api_auth get_session check_cookie_auth checkpw checkpw_internal checkpw_hash
73 get_all_subpermissions get_user_subpermissions track_login_daily in_iprange
74 get_template_and_user haspermission
77 $ldap = C4::Context->config('useldapserver') || 0;
78 $cas = C4::Context->preference('casAuthentication');
79 $caslogout = C4::Context->preference('casLogout');
82 require C4::Auth_with_ldap;
83 import C4::Auth_with_ldap qw(checkpw_ldap);
86 require C4::Auth_with_cas; # no import
87 import C4::Auth_with_cas qw(check_api_auth_cas checkpw_cas login_cas logout_cas login_cas_url logout_if_required multipleAuth getMultipleAuth);
94 C4::Auth - Authenticates Koha users
102 my $query = CGI->new;
104 my ($template, $borrowernumber, $cookie)
105 = get_template_and_user(
107 template_name => "opac-main.tt",
110 authnotrequired => 0,
111 flagsrequired => { catalogue => '*', tools => 'import_patrons' },
115 output_html_with_http_headers $query, $cookie, $template->output;
119 The main function of this module is to provide
120 authentification. However the get_template_and_user function has
121 been provided so that a users login information is passed along
122 automatically. This gets loaded into the template.
126 =head2 get_template_and_user
128 my ($template, $borrowernumber, $cookie)
129 = get_template_and_user(
131 template_name => "opac-main.tt",
134 authnotrequired => 0,
135 flagsrequired => { catalogue => '*', tools => 'import_patrons' },
139 This call passes the C<query>, C<flagsrequired> and C<authnotrequired>
140 to C<&checkauth> (in this module) to perform authentification.
141 See C<&checkauth> for an explanation of these parameters.
143 The C<template_name> is then used to find the correct template for
144 the page. The authenticated users details are loaded onto the
145 template in the logged_in_user variable (which is a Koha::Patron object). Also the
146 C<sessionID> is passed to the template. This can be used in templates
147 if cookies are disabled. It needs to be put as and input to every
150 More information on the C<gettemplate> sub can be found in the
155 sub get_template_and_user {
158 my ( $user, $cookie, $sessionID, $flags );
161 my $cookie_mgr = Koha::CookieManager->new;
163 # Get shibboleth login attribute
164 my $shib = C4::Context->config('useshibboleth') && shib_ok();
165 my $shib_login = $shib ? get_login_shib() : undef;
167 C4::Context->interface( $in->{type} );
169 $in->{'authnotrequired'} ||= 0;
171 # the following call includes a bad template check; might croak
172 my $template = C4::Templates::gettemplate(
173 $in->{'template_name'},
178 if ( $in->{'template_name'} !~ m/maintenance/ ) {
179 ( $user, $cookie, $sessionID, $flags ) = checkauth(
181 $in->{'authnotrequired'},
182 $in->{'flagsrequired'},
185 $in->{template_name},
189 # If we enforce GDPR and the user did not consent, redirect
190 # Exceptions for consent page itself and SCI/SCO system
191 if( $in->{type} eq 'opac' && $user &&
192 $in->{'template_name'} !~ /^(opac-patron-consent|sc[io]\/)/ &&
193 C4::Context->preference('GDPR_Policy') eq 'Enforced' )
195 my $consent = Koha::Patron::Consents->search({
196 borrowernumber => getborrowernumber($user),
197 type => 'GDPR_PROCESSING',
198 given_on => { '!=', undef },
201 print $in->{query}->redirect(-uri => '/cgi-bin/koha/opac-patron-consent.pl', -cookie => $cookie);
206 if ( $in->{type} eq 'opac' && $user ) {
209 my $session = get_session($sessionID);
211 $is_sco_user = $session->param('sco_user');
217 # If the user logged in is the SCO user and they try to go out of the SCO module,
218 # log the user out removing the CGISESSID cookie
219 $in->{template_name} !~ m|sco/| && $in->{template_name} !~ m|errors/errorpage.tt|
223 C4::Context->preference('AutoSelfCheckID')
224 && $user eq C4::Context->preference('AutoSelfCheckID')
232 # If the user logged in is the SCI user and they try to go out of the SCI module,
233 # kick them out unless it is SCO with a valid permission
234 # or they are a superlibrarian
235 $in->{template_name} !~ m|sci/|
236 && haspermission( $user, { self_check => 'self_checkin_module' } )
238 $in->{template_name} =~ m|sco/| && haspermission(
239 $user, { self_check => 'self_checkout_module' }
242 && $flags && $flags->{superlibrarian} != 1
249 $template = C4::Templates::gettemplate( 'opac-auth.tt', 'opac',
251 $cookie = $cookie_mgr->replace_in_list( $cookie, $in->{query}->cookie(
252 -name => 'CGISESSID',
255 -secure => ( C4::Context->https_enabled() ? 1 : 0 ),
261 script_name => get_script_name(),
264 print $in->{query}->header(
269 'X-Frame-Options' => 'SAMEORIGIN'
280 # It's possible for $user to be the borrowernumber if they don't have a
281 # userid defined (and are logging in through some other method, such
282 # as SSL certs against an email address)
284 $borrowernumber = getborrowernumber($user) if defined($user);
285 if ( !defined($borrowernumber) && defined($user) ) {
286 $patron = Koha::Patrons->find( $user );
288 $borrowernumber = $user;
290 # A bit of a hack, but I don't know there's a nicer way
292 $user = $patron->firstname . ' ' . $patron->surname;
295 $patron = Koha::Patrons->find( $borrowernumber );
296 # FIXME What to do if $patron does not exist?
300 $template->param( loggedinusername => $user ); # OBSOLETE - Do not reuse this in template, use logged_in_user.userid instead
301 $template->param( loggedinusernumber => $borrowernumber ); # FIXME Should be replaced with logged_in_user.borrowernumber
302 $template->param( logged_in_user => $patron );
303 $template->param( sessionID => $sessionID );
305 if ( $in->{'type'} eq 'opac' ) {
306 require Koha::Virtualshelves;
307 my $some_private_shelves = Koha::Virtualshelves->get_some_shelves(
309 borrowernumber => $borrowernumber,
313 my $some_public_shelves = Koha::Virtualshelves->get_some_shelves(
319 some_private_shelves => $some_private_shelves,
320 some_public_shelves => $some_public_shelves,
324 my $all_perms = get_all_subpermissions();
326 my @flagroots = qw(circulate catalogue parameters borrowers permissions reserveforothers borrow
327 editcatalogue updatecharges tools editauthorities serials reports acquisition clubs problem_reports);
329 # We are going to use the $flags returned by checkauth
330 # to create the template's parameters that will indicate
331 # which menus the user can access.
332 if ( $flags && $flags->{superlibrarian} == 1 ) {
333 $template->param( CAN_user_circulate => 1 );
334 $template->param( CAN_user_catalogue => 1 );
335 $template->param( CAN_user_parameters => 1 );
336 $template->param( CAN_user_borrowers => 1 );
337 $template->param( CAN_user_permissions => 1 );
338 $template->param( CAN_user_reserveforothers => 1 );
339 $template->param( CAN_user_editcatalogue => 1 );
340 $template->param( CAN_user_updatecharges => 1 );
341 $template->param( CAN_user_acquisition => 1 );
342 $template->param( CAN_user_suggestions => 1 );
343 $template->param( CAN_user_tools => 1 );
344 $template->param( CAN_user_editauthorities => 1 );
345 $template->param( CAN_user_serials => 1 );
346 $template->param( CAN_user_reports => 1 );
347 $template->param( CAN_user_staffaccess => 1 );
348 $template->param( CAN_user_coursereserves => 1 );
349 $template->param( CAN_user_plugins => 1 );
350 $template->param( CAN_user_lists => 1 );
351 $template->param( CAN_user_clubs => 1 );
352 $template->param( CAN_user_ill => 1 );
353 $template->param( CAN_user_stockrotation => 1 );
354 $template->param( CAN_user_cash_management => 1 );
355 $template->param( CAN_user_problem_reports => 1 );
356 $template->param( CAN_user_recalls => 1 );
358 foreach my $module ( keys %$all_perms ) {
359 foreach my $subperm ( keys %{ $all_perms->{$module} } ) {
360 $template->param( "CAN_user_${module}_${subperm}" => 1 );
366 foreach my $module ( keys %$all_perms ) {
367 if ( defined($flags->{$module}) && $flags->{$module} == 1 ) {
368 foreach my $subperm ( keys %{ $all_perms->{$module} } ) {
369 $template->param( "CAN_user_${module}_${subperm}" => 1 );
371 } elsif ( ref( $flags->{$module} ) ) {
372 foreach my $subperm ( keys %{ $flags->{$module} } ) {
373 $template->param( "CAN_user_${module}_${subperm}" => 1 );
380 foreach my $module ( keys %$flags ) {
381 if ( $flags->{$module} == 1 or ref( $flags->{$module} ) ) {
382 $template->param( "CAN_user_$module" => 1 );
387 # Logged-in opac search history
388 # If the requested template is an opac one and opac search history is enabled
389 if ( $in->{type} eq 'opac' && C4::Context->preference('EnableOpacSearchHistory') ) {
390 my $dbh = C4::Context->dbh;
391 my $query = "SELECT COUNT(*) FROM search_history WHERE userid=?";
392 my $sth = $dbh->prepare($query);
393 $sth->execute($borrowernumber);
395 # If at least one search has already been performed
396 if ( $sth->fetchrow_array > 0 ) {
398 # We show the link in opac
399 $template->param( EnableOpacSearchHistory => 1 );
401 if (C4::Context->preference('LoadSearchHistoryToTheFirstLoggedUser'))
403 # And if there are searches performed when the user was not logged in,
404 # we add them to the logged-in search history
405 my @recentSearches = C4::Search::History::get_from_session( { cgi => $in->{'query'} } );
406 if (@recentSearches) {
408 INSERT INTO search_history(userid, sessionid, query_desc, query_cgi, type, total, time )
409 VALUES (?, ?, ?, ?, ?, ?, ?)
411 my $sth = $dbh->prepare($query);
412 $sth->execute( $borrowernumber,
413 $in->{query}->cookie("CGISESSID"),
416 $_->{type} || 'biblio',
419 ) foreach @recentSearches;
421 # clear out the search history from the session now that
422 # we've saved it to the database
425 C4::Search::History::set_to_session( { cgi => $in->{'query'}, search_history => [] } );
427 } elsif ( $in->{type} eq 'intranet' and C4::Context->preference('EnableSearchHistory') ) {
428 $template->param( EnableSearchHistory => 1 );
431 else { # if this is an anonymous session, setup to display public lists...
433 # If shibboleth is enabled, and we're in an anonymous session, we should allow
434 # the user to attempt login via shibboleth.
436 $template->param( shibbolethAuthentication => $shib,
437 shibbolethLoginUrl => login_shib_url( $in->{'query'} ),
440 # If shibboleth is enabled and we have a shibboleth login attribute,
441 # but we are in an anonymous session, then we clearly have an invalid
442 # shibboleth koha account.
444 $template->param( invalidShibLogin => '1' );
448 $template->param( sessionID => $sessionID );
450 if ( $in->{'type'} eq 'opac' ){
451 require Koha::Virtualshelves;
452 my $some_public_shelves = Koha::Virtualshelves->get_some_shelves(
458 some_public_shelves => $some_public_shelves,
461 # Set default branch if one has been passed by the environment.
462 $template->param( default_branch => $ENV{OPAC_BRANCH_DEFAULT} ) if $ENV{OPAC_BRANCH_DEFAULT};
466 # Sysprefs disabled via URL param
467 # Note that value must be defined in order to override via ENV
468 foreach my $syspref (
474 OpacAdditionalStylesheet
476 intranetcolorstylesheet
481 $ENV{"OVERRIDE_SYSPREF_$syspref"} = q{}
482 if $in->{'query'}->param("DISABLE_SYSPREF_$syspref");
485 # Anonymous opac search history
486 # If opac search history is enabled and at least one search has already been performed
487 if ( C4::Context->preference('EnableOpacSearchHistory') ) {
488 my @recentSearches = C4::Search::History::get_from_session( { cgi => $in->{'query'} } );
489 if (@recentSearches) {
490 $template->param( EnableOpacSearchHistory => 1 );
494 if ( C4::Context->preference('dateformat') ) {
495 $template->param( dateformat => C4::Context->preference('dateformat') );
498 $template->param(auth_forwarded_hash => scalar $in->{'query'}->param('auth_forwarded_hash'));
500 # these template parameters are set the same regardless of $in->{'type'}
502 my $minPasswordLength = C4::Context->preference('minPasswordLength');
503 $minPasswordLength = 3 if not $minPasswordLength or $minPasswordLength < 3;
505 EnhancedMessagingPreferences => C4::Context->preference('EnhancedMessagingPreferences'),
506 GoogleJackets => C4::Context->preference("GoogleJackets"),
507 OpenLibraryCovers => C4::Context->preference("OpenLibraryCovers"),
508 KohaAdminEmailAddress => "" . C4::Context->preference("KohaAdminEmailAddress"),
509 LoginFirstname => ( C4::Context->userenv ? C4::Context->userenv->{"firstname"} : "Bel" ),
510 LoginSurname => C4::Context->userenv ? C4::Context->userenv->{"surname"} : "Inconnu",
511 emailaddress => C4::Context->userenv ? C4::Context->userenv->{"emailaddress"} : undef,
512 TagsEnabled => C4::Context->preference("TagsEnabled"),
513 hide_marc => C4::Context->preference("hide_marc"),
514 item_level_itypes => C4::Context->preference('item-level_itypes'),
515 patronimages => C4::Context->preference("patronimages"),
516 singleBranchMode => ( Koha::Libraries->search->count == 1 ),
517 noItemTypeImages => C4::Context->preference("noItemTypeImages"),
518 marcflavour => C4::Context->preference("marcflavour"),
519 OPACBaseURL => C4::Context->preference('OPACBaseURL'),
520 minPasswordLength => $minPasswordLength,
522 if ( $in->{'type'} eq "intranet" ) {
524 AmazonCoverImages => C4::Context->preference("AmazonCoverImages"),
525 AutoLocation => C4::Context->preference("AutoLocation"),
526 PatronAutoComplete => C4::Context->preference("PatronAutoComplete"),
527 FRBRizeEditions => C4::Context->preference("FRBRizeEditions"),
528 IndependentBranches => C4::Context->preference("IndependentBranches"),
529 IntranetNav => C4::Context->preference("IntranetNav"),
530 IntranetmainUserblock => C4::Context->preference("IntranetmainUserblock"),
531 LibraryName => C4::Context->preference("LibraryName"),
532 advancedMARCEditor => C4::Context->preference("advancedMARCEditor"),
533 canreservefromotherbranches => C4::Context->preference('canreservefromotherbranches'),
534 intranetcolorstylesheet => C4::Context->preference("intranetcolorstylesheet"),
535 IntranetFavicon => C4::Context->preference("IntranetFavicon"),
536 intranetreadinghistory => C4::Context->preference("intranetreadinghistory"),
537 intranetstylesheet => C4::Context->preference("intranetstylesheet"),
538 IntranetUserCSS => C4::Context->preference("IntranetUserCSS"),
539 IntranetUserJS => C4::Context->preference("IntranetUserJS"),
540 suggestion => C4::Context->preference("suggestion"),
541 virtualshelves => C4::Context->preference("virtualshelves"),
542 StaffSerialIssueDisplayCount => C4::Context->preference("StaffSerialIssueDisplayCount"),
543 EasyAnalyticalRecords => C4::Context->preference('EasyAnalyticalRecords'),
544 LocalCoverImages => C4::Context->preference('LocalCoverImages'),
545 OPACLocalCoverImages => C4::Context->preference('OPACLocalCoverImages'),
546 AllowMultipleCovers => C4::Context->preference('AllowMultipleCovers'),
547 EnableBorrowerFiles => C4::Context->preference('EnableBorrowerFiles'),
548 UseCourseReserves => C4::Context->preference("UseCourseReserves"),
549 useDischarge => C4::Context->preference('useDischarge'),
550 pending_checkout_notes => Koha::Checkouts->search({ noteseen => 0 }),
551 plugins_enabled => C4::Context->config("enable_plugins"),
555 warn "template type should be OPAC, here it is=[" . $in->{'type'} . "]" unless ( $in->{'type'} eq 'opac' );
557 #TODO : replace LibraryName syspref with 'system name', and remove this html processing
558 my $LibraryNameTitle = C4::Context->preference("LibraryName");
559 $LibraryNameTitle =~ s/<(?:\/?)(?:br|p)\s*(?:\/?)>/ /sgi;
560 $LibraryNameTitle =~ s/<(?:[^<>'"]|'(?:[^']*)'|"(?:[^"]*)")*>//sg;
562 # clean up the busc param in the session
563 # if the page is not opac-detail and not the "add to list" page
564 # and not the "edit comments" page
565 if ( C4::Context->preference("OpacBrowseResults")
566 && $in->{'template_name'} =~ /opac-(.+)\.(?:tt|tmpl)$/ ) {
568 unless ( $pagename =~ /^(?:MARC|ISBD)?detail$/
569 or $pagename =~ /^showmarc$/
570 or $pagename =~ /^addbybiblionumber$/
571 or $pagename =~ /^review$/ )
573 my $sessionSearch = get_session( $sessionID );
574 $sessionSearch->clear( ["busc"] ) if $sessionSearch;
578 # variables passed from CGI: opac_css_override and opac_search_limits.
579 my $opac_search_limit = $ENV{'OPAC_SEARCH_LIMIT'};
580 my $opac_limit_override = $ENV{'OPAC_LIMIT_OVERRIDE'};
583 ( $opac_limit_override && $opac_search_limit && $opac_search_limit =~ /branch:([\w-]+)/ ) ||
584 ( $in->{'query'}->param('limit') && $in->{'query'}->param('limit') =~ /branch:([\w-]+)/ ) ||
585 ( $in->{'query'}->param('limit') && $in->{'query'}->param('limit') =~ /multibranchlimit:(\w+)/ )
587 $opac_name = $1; # opac_search_limit is a branch, so we use it.
588 } elsif ( $in->{'query'}->param('multibranchlimit') ) {
589 $opac_name = $in->{'query'}->param('multibranchlimit');
590 } elsif ( C4::Context->preference("SearchMyLibraryFirst") && C4::Context->userenv && C4::Context->userenv->{'branch'} ) {
591 $opac_name = C4::Context->userenv->{'branch'};
594 my @search_groups = Koha::Library::Groups->get_search_groups({ interface => 'opac' })->as_list;
596 AnonSuggestions => "" . C4::Context->preference("AnonSuggestions"),
597 LibrarySearchGroups => \@search_groups,
598 opac_name => $opac_name,
599 LibraryName => "" . C4::Context->preference("LibraryName"),
600 LibraryNameTitle => "" . $LibraryNameTitle,
601 OPACAmazonCoverImages => C4::Context->preference("OPACAmazonCoverImages"),
602 OPACFRBRizeEditions => C4::Context->preference("OPACFRBRizeEditions"),
603 OpacHighlightedWords => C4::Context->preference("OpacHighlightedWords"),
604 OPACShelfBrowser => "" . C4::Context->preference("OPACShelfBrowser"),
605 OPACURLOpenInNewWindow => "" . C4::Context->preference("OPACURLOpenInNewWindow"),
606 OPACUserCSS => "" . C4::Context->preference("OPACUserCSS"),
607 OpacAuthorities => C4::Context->preference("OpacAuthorities"),
608 opac_css_override => $ENV{'OPAC_CSS_OVERRIDE'},
609 opac_search_limit => $opac_search_limit,
610 opac_limit_override => $opac_limit_override,
611 OpacBrowser => C4::Context->preference("OpacBrowser"),
612 OpacCloud => C4::Context->preference("OpacCloud"),
613 OpacKohaUrl => C4::Context->preference("OpacKohaUrl"),
614 OpacPasswordChange => C4::Context->preference("OpacPasswordChange"),
615 OPACPatronDetails => C4::Context->preference("OPACPatronDetails"),
616 OPACPrivacy => C4::Context->preference("OPACPrivacy"),
617 OPACFinesTab => C4::Context->preference("OPACFinesTab"),
618 OpacTopissue => C4::Context->preference("OpacTopissue"),
619 'Version' => C4::Context->preference('Version'),
620 hidelostitems => C4::Context->preference("hidelostitems"),
621 mylibraryfirst => ( C4::Context->preference("SearchMyLibraryFirst") && C4::Context->userenv ) ? C4::Context->userenv->{'branch'} : '',
622 opacbookbag => "" . C4::Context->preference("opacbookbag"),
623 OpacFavicon => C4::Context->preference("OpacFavicon"),
624 opaclanguagesdisplay => "" . C4::Context->preference("opaclanguagesdisplay"),
625 opacreadinghistory => C4::Context->preference("opacreadinghistory"),
626 OPACUserJS => C4::Context->preference("OPACUserJS"),
627 opacuserlogin => "" . C4::Context->preference("opacuserlogin"),
628 OpenLibrarySearch => C4::Context->preference("OpenLibrarySearch"),
629 ShowReviewer => C4::Context->preference("ShowReviewer"),
630 ShowReviewerPhoto => C4::Context->preference("ShowReviewerPhoto"),
631 suggestion => "" . C4::Context->preference("suggestion"),
632 virtualshelves => "" . C4::Context->preference("virtualshelves"),
633 OPACSerialIssueDisplayCount => C4::Context->preference("OPACSerialIssueDisplayCount"),
634 SyndeticsClientCode => C4::Context->preference("SyndeticsClientCode"),
635 SyndeticsEnabled => C4::Context->preference("SyndeticsEnabled"),
636 SyndeticsCoverImages => C4::Context->preference("SyndeticsCoverImages"),
637 SyndeticsTOC => C4::Context->preference("SyndeticsTOC"),
638 SyndeticsSummary => C4::Context->preference("SyndeticsSummary"),
639 SyndeticsEditions => C4::Context->preference("SyndeticsEditions"),
640 SyndeticsExcerpt => C4::Context->preference("SyndeticsExcerpt"),
641 SyndeticsReviews => C4::Context->preference("SyndeticsReviews"),
642 SyndeticsAuthorNotes => C4::Context->preference("SyndeticsAuthorNotes"),
643 SyndeticsAwards => C4::Context->preference("SyndeticsAwards"),
644 SyndeticsSeries => C4::Context->preference("SyndeticsSeries"),
645 SyndeticsCoverImageSize => C4::Context->preference("SyndeticsCoverImageSize"),
646 OPACLocalCoverImages => C4::Context->preference("OPACLocalCoverImages"),
647 PatronSelfRegistration => C4::Context->preference("PatronSelfRegistration"),
648 PatronSelfRegistrationDefaultCategory => C4::Context->preference("PatronSelfRegistrationDefaultCategory"),
649 useDischarge => C4::Context->preference('useDischarge'),
652 $template->param( OpacPublic => '1' ) if ( $user || C4::Context->preference("OpacPublic") );
655 # Check if we were asked using parameters to force a specific language
656 if ( defined $in->{'query'}->param('language') ) {
658 # Extract the language, let C4::Languages::getlanguage choose
660 my $language = C4::Languages::getlanguage( $in->{'query'} );
661 my $languagecookie = C4::Templates::getlanguagecookie( $in->{'query'}, $language );
662 $cookie = $cookie_mgr->replace_in_list( $cookie, $languagecookie );
665 return ( $template, $borrowernumber, $cookie, $flags );
670 ($userid, $cookie, $sessionID) = &checkauth($query, $noauth, $flagsrequired, $type);
672 Verifies that the user is authorized to run this script. If
673 the user is authorized, a (userid, cookie, session-id, flags)
674 quadruple is returned. If the user is not authorized but does
675 not have the required privilege (see $flagsrequired below), it
676 displays an error page and exits. Otherwise, it displays the
677 login page and exits.
679 Note that C<&checkauth> will return if and only if the user
680 is authorized, so it should be called early on, before any
681 unfinished operations (e.g., if you've opened a file, then
682 C<&checkauth> won't close it for you).
684 C<$query> is the CGI object for the script calling C<&checkauth>.
686 The C<$noauth> argument is optional. If it is set, then no
687 authorization is required for the script.
689 C<&checkauth> fetches user and session information from C<$query> and
690 ensures that the user is authorized to run scripts that require
693 The C<$flagsrequired> argument specifies the required privileges
694 the user must have if the username and password are correct.
695 It should be specified as a reference-to-hash; keys in the hash
696 should be the "flags" for the user, as specified in the Members
697 intranet module. Any key specified must correspond to a "flag"
698 in the userflags table. E.g., { circulate => 1 } would specify
699 that the user must have the "circulate" privilege in order to
700 proceed. To make sure that access control is correct, the
701 C<$flagsrequired> parameter must be specified correctly.
703 Koha also has a concept of sub-permissions, also known as
704 granular permissions. This makes the value of each key
705 in the C<flagsrequired> hash take on an additional
710 The user must have access to all subfunctions of the module
711 specified by the hash key.
715 The user must have access to at least one subfunction of the module
716 specified by the hash key.
718 specific permission, e.g., 'export_catalog'
720 The user must have access to the specific subfunction list, which
721 must correspond to a row in the permissions table.
723 The C<$type> argument specifies whether the template should be
724 retrieved from the opac or intranet directory tree. "opac" is
725 assumed if it is not specified; however, if C<$type> is specified,
726 "intranet" is assumed if it is not "opac".
728 If C<$query> does not have a valid session ID associated with it
729 (i.e., the user has not logged in) or if the session has expired,
730 C<&checkauth> presents the user with a login page (from the point of
731 view of the original script, C<&checkauth> does not return). Once the
732 user has authenticated, C<&checkauth> restarts the original script
733 (this time, C<&checkauth> returns).
735 The login page is provided using a HTML::Template, which is set in the
736 systempreferences table or at the top of this file. The variable C<$type>
737 selects which template to use, either the opac or the intranet
738 authentification template.
740 C<&checkauth> returns a user ID, a cookie, and a session ID. The
741 cookie should be sent back to the browser; it verifies that the user
751 # If version syspref is unavailable, it means Koha is being installed,
752 # and so we must redirect to OPAC maintenance page or to the WebInstaller
753 # also, if OpacMaintenance is ON, OPAC should redirect to maintenance
754 if ( C4::Context->preference('OpacMaintenance') && $type eq 'opac' ) {
755 warn "OPAC Install required, redirecting to maintenance";
756 print $query->redirect("/cgi-bin/koha/maintenance.pl");
759 unless ( $version = C4::Context->preference('Version') ) { # assignment, not comparison
760 if ( $type ne 'opac' ) {
761 warn "Install required, redirecting to Installer";
762 print $query->redirect("/cgi-bin/koha/installer/install.pl");
764 warn "OPAC Install required, redirecting to maintenance";
765 print $query->redirect("/cgi-bin/koha/maintenance.pl");
770 # check that database and koha version are the same
771 # there is no DB version, it's a fresh install,
772 # go to web installer
773 # there is a DB version, compare it to the code version
774 my $kohaversion = Koha::version();
776 # remove the 3 last . to have a Perl number
777 $kohaversion =~ s/(.*\..*)\.(.*)\.(.*)/$1$2$3/;
778 Koha::Logger->get->debug("kohaversion : $kohaversion");
779 if ( $version < $kohaversion ) {
780 my $warning = "Database update needed, redirecting to %s. Database is $version and Koha is $kohaversion";
781 if ( $type ne 'opac' ) {
782 warn sprintf( $warning, 'Installer' );
783 print $query->redirect("/cgi-bin/koha/installer/install.pl?step=1&op=updatestructure");
785 warn sprintf( "OPAC: " . $warning, 'maintenance' );
786 print $query->redirect("/cgi-bin/koha/maintenance.pl");
792 sub _timeout_syspref {
793 my $default_timeout = 600;
794 my $timeout = C4::Context->preference('timeout') || $default_timeout;
796 # value in days, convert in seconds
797 if ( $timeout =~ /^(\d+)[dD]$/ ) {
798 $timeout = $1 * 86400;
800 # value in hours, convert in seconds
801 elsif ( $timeout =~ /^(\d+)[hH]$/ ) {
802 $timeout = $1 * 3600;
804 elsif ( $timeout !~ m/^\d+$/ ) {
805 warn "The value of the system preference 'timeout' is not correct, defaulting to $default_timeout";
806 $timeout = $default_timeout;
815 # Get shibboleth login attribute
816 my $shib = C4::Context->config('useshibboleth') && shib_ok();
817 my $shib_login = $shib ? get_login_shib() : undef;
819 # $authnotrequired will be set for scripts which will run without authentication
820 my $authnotrequired = shift;
821 my $flagsrequired = shift;
823 my $emailaddress = shift;
824 my $template_name = shift;
825 $type = 'opac' unless $type;
827 if ( $type eq 'opac' && !C4::Context->preference("OpacPublic") ) {
828 my @allowed_scripts_for_private_opac = qw(
830 opac-registration-email-sent.tt
831 opac-registration-confirmation.tt
832 opac-memberentry-update-submitted.tt
833 opac-password-recovery.tt
834 opac-reset-password.tt
836 $authnotrequired = 0 unless grep { $_ eq $template_name }
837 @allowed_scripts_for_private_opac;
840 my $timeout = _timeout_syspref();
842 my $cookie_mgr = Koha::CookieManager->new;
844 _version_check( $type, $query );
848 my $auth_state = 'failed';
850 my ( $userid, $cookie, $sessionID, $flags );
852 my $logout = $query->param('logout.x');
854 my $anon_search_history;
856 # This parameter is the name of the CAS server we want to authenticate against,
857 # when using authentication against multiple CAS servers, as configured in Auth_cas_servers.yaml
858 my $casparam = $query->param('cas');
859 my $q_userid = $query->param('userid') // '';
862 my $invalid_otp_token;
863 my $require_2FA = ( C4::Context->preference('TwoFactorAuthentication') && $type ne "opac" ) ? 1 : 0;
865 # Basic authentication is incompatible with the use of Shibboleth,
866 # as Shibboleth may return REMOTE_USER as a Shibboleth attribute,
867 # and it may not be the attribute we want to use to match the koha login.
869 # Also, do not consider an empty REMOTE_USER.
871 # Finally, after those tests, we can assume (although if it would be better with
872 # a syspref) that if we get a REMOTE_USER, that's from basic authentication,
873 # and we can affect it to $userid.
874 if ( !$shib and defined( $ENV{'REMOTE_USER'} ) and $ENV{'REMOTE_USER'} ne '' and $userid = $ENV{'REMOTE_USER'} ) {
876 # Using Basic Authentication, no cookies required
877 $cookie = $cookie_mgr->replace_in_list( $cookie, $query->cookie(
878 -name => 'CGISESSID',
881 -secure => ( C4::Context->https_enabled() ? 1 : 0 ),
886 elsif ( $emailaddress) {
887 # the Google OpenID Connect passes an email address
889 elsif ( $sessionID = $query->cookie("CGISESSID") ) { # assignment, not comparison
890 my ( $return, $more_info );
891 # NOTE: $flags in the following call is still undefined !
892 ( $return, $session, $more_info ) = check_cookie_auth( $sessionID, $flags,
893 { remote_addr => $ENV{REMOTE_ADDR}, skip_version_check => 1 }
896 if ( $return eq 'ok' || $return eq 'additional-auth-needed' ) {
897 $userid = $session->param('id');
901 $return eq 'ok' ? 'completed'
902 : $return eq 'additional-auth-needed' ? 'additional-auth-needed'
905 # We are at the second screen if the waiting-for-2FA is set in session
906 # and otp_token param has been passed
908 && $auth_state eq 'additional-auth-needed'
909 && ( my $otp_token = $query->param('otp_token') ) )
911 my $patron = Koha::Patrons->find( { userid => $userid } );
912 my $auth = Koha::Auth::TwoFactorAuth->new( { patron => $patron } );
913 my $verified = $auth->verify($otp_token, 1);
916 # The token is correct, the user is fully logged in!
917 $auth_state = 'completed';
918 $session->param( 'waiting-for-2FA', 0 );
920 # This is an ugly trick to pass the test
921 # $query->param('koha_login_context') && ( $q_userid ne $userid )
926 $invalid_otp_token = 1;
930 if ( $auth_state eq 'completed' ) {
931 Koha::Logger->get->debug(sprintf "AUTH_SESSION: (%s)\t%s %s - %s", map { $session->param($_) || q{} } qw(cardnumber firstname surname branch));
933 if ( ( $query->param('koha_login_context') && ( $q_userid ne $userid ) )
934 || ( $cas && $query->param('ticket') && !C4::Context->userenv->{'id'} )
935 || ( $shib && $shib_login && !$logout && !C4::Context->userenv->{'id'} )
938 #if a user enters an id ne to the id in the current session, we need to log them in...
939 #first we need to clear the anonymous session...
940 $anon_search_history = $session->param('search_history');
943 $cookie = $cookie_mgr->clear_unless( $query->cookie, @$cookie );
944 C4::Context::_unset_userenv($sessionID);
948 $cookie = $cookie_mgr->replace_in_list( $cookie, $query->cookie(
949 -name => 'CGISESSID',
950 -value => $session->id,
952 -secure => ( C4::Context->https_enabled() ? 1 : 0 ),
956 $flags = haspermission( $userid, $flagsrequired );
958 $auth_state = 'failed';
959 $info{'nopermission'} = 1;
962 } elsif ( !$logout ) {
963 if ( $return eq 'expired' ) {
964 $info{timed_out} = 1;
965 } elsif ( $return eq 'restricted' ) {
966 $info{oldip} = $more_info->{old_ip};
967 $info{newip} = $more_info->{new_ip};
968 $info{different_ip} = 1;
969 } elsif ( $return eq 'password_expired' ) {
970 $info{password_has_expired} = 1;
975 if ( $auth_state eq 'failed' || $logout ) {
982 # voluntary logout the user
983 # check wether the user was using their shibboleth session or a local one
984 my $shibSuccess = C4::Context->userenv ? C4::Context->userenv->{'shibboleth'} : undef;
989 C4::Context::_unset_userenv($sessionID);
990 $cookie = $cookie_mgr->clear_unless( $query->cookie, @$cookie );
992 if ($cas and $caslogout) {
993 logout_cas($query, $type);
996 # If we are in a shibboleth session (shibboleth is enabled, a shibboleth match attribute is set and matches koha matchpoint)
997 if ( $shib and $shib_login and $shibSuccess) {
1002 $auth_state = 'logout';
1005 unless ( $userid ) {
1006 #we initiate a session prior to checking for a username to allow for anonymous sessions...
1007 if( !$session or !$sessionID ) { # if we cleared sessionID, we need a new session
1008 $session = get_session() or die "Auth ERROR: Cannot get_session()";
1011 # Save anonymous search history in new session so it can be retrieved
1012 # by get_template_and_user to store it in user's search history after
1013 # a successful login.
1014 if ($anon_search_history) {
1015 $session->param( 'search_history', $anon_search_history );
1018 $sessionID = $session->id;
1019 C4::Context->_new_userenv($sessionID);
1020 $cookie = $cookie_mgr->replace_in_list( $cookie, $query->cookie(
1021 -name => 'CGISESSID',
1022 -value => $sessionID,
1024 -secure => ( C4::Context->https_enabled() ? 1 : 0 ),
1027 my $pki_field = C4::Context->preference('AllowPKIAuth');
1028 if ( !defined($pki_field) ) {
1029 print STDERR "ERROR: Missing system preference AllowPKIAuth.\n";
1030 $pki_field = 'None';
1032 if ( ( $cas && $query->param('ticket') )
1034 || ( $shib && $shib_login )
1035 || $pki_field ne 'None'
1038 my $password = $query->param('password');
1039 my $shibSuccess = 0;
1040 my ( $return, $cardnumber );
1042 # If shib is enabled and we have a shib login, does the login match a valid koha user
1043 if ( $shib && $shib_login ) {
1046 # Do not pass password here, else shib will not be checked in checkpw.
1047 ( $return, $cardnumber, $retuserid ) = checkpw( $q_userid, undef, $query );
1048 $userid = $retuserid;
1049 $shibSuccess = $return;
1050 $info{'invalidShibLogin'} = 1 unless ($return);
1053 # If shib login and match were successful, skip further login methods
1054 unless ($shibSuccess) {
1055 if ( $cas && $query->param('ticket') ) {
1057 ( $return, $cardnumber, $retuserid, $cas_ticket ) =
1058 checkpw( $userid, $password, $query, $type );
1059 $userid = $retuserid;
1060 $info{'invalidCasLogin'} = 1 unless ($return);
1063 elsif ( $emailaddress ) {
1064 my $value = $emailaddress;
1066 # If we're looking up the email, there's a chance that the person
1067 # doesn't have a userid. So if there is none, we pass along the
1068 # borrower number, and the bits of code that need to know the user
1069 # ID will have to be smart enough to handle that.
1070 my $patrons = Koha::Patrons->search({ email => $value });
1071 if ($patrons->count) {
1073 # First the userid, then the borrowernum
1074 my $patron = $patrons->next;
1075 $value = $patron->userid || $patron->borrowernumber;
1079 $return = $value ? 1 : 0;
1084 ( $pki_field eq 'Common Name' && $ENV{'SSL_CLIENT_S_DN_CN'} )
1085 || ( $pki_field eq 'emailAddress'
1086 && $ENV{'SSL_CLIENT_S_DN_Email'} )
1090 if ( $pki_field eq 'Common Name' ) {
1091 $value = $ENV{'SSL_CLIENT_S_DN_CN'};
1093 elsif ( $pki_field eq 'emailAddress' ) {
1094 $value = $ENV{'SSL_CLIENT_S_DN_Email'};
1096 # If we're looking up the email, there's a chance that the person
1097 # doesn't have a userid. So if there is none, we pass along the
1098 # borrower number, and the bits of code that need to know the user
1099 # ID will have to be smart enough to handle that.
1100 my $patrons = Koha::Patrons->search({ email => $value });
1101 if ($patrons->count) {
1103 # First the userid, then the borrowernum
1104 my $patron = $patrons->next;
1105 $value = $patron->userid || $patron->borrowernumber;
1111 $return = $value ? 1 : 0;
1117 my $request_method = $query->request_method();
1120 $request_method eq 'POST'
1121 || ( C4::Context->preference('AutoSelfCheckID')
1122 && $q_userid eq C4::Context->preference('AutoSelfCheckID') )
1126 ( $return, $cardnumber, $retuserid, $cas_ticket ) =
1127 checkpw( $q_userid, $password, $query, $type );
1128 $userid = $retuserid if ($retuserid);
1129 $info{'invalid_username_or_password'} = 1 unless ($return);
1134 # If shib configured and shibOnly enabled, we should ignore anything other than a shibboleth type login.
1141 && C4::Context->preference('OPACShibOnly')
1143 || ( ( $type ne 'opac' )
1144 && C4::Context->preference('staffShibOnly') )
1151 # $return: 1 = valid user
1154 if ( $flags = haspermission( $userid, $flagsrequired ) ) {
1155 $auth_state = "logged_in";
1158 $info{'nopermission'} = 1;
1159 C4::Context::_unset_userenv($sessionID);
1161 my ( $borrowernumber, $firstname, $surname, $userflags,
1162 $branchcode, $branchname, $emailaddress, $desk_id,
1163 $desk_name, $register_id, $register_name );
1165 if ( $return == 1 ) {
1167 SELECT borrowernumber, firstname, surname, flags, borrowers.branchcode,
1168 branches.branchname as branchname, email
1170 LEFT JOIN branches on borrowers.branchcode=branches.branchcode
1172 my $dbh = C4::Context->dbh;
1173 my $sth = $dbh->prepare("$select where userid=?");
1174 $sth->execute($userid);
1175 unless ( $sth->rows ) {
1176 $sth = $dbh->prepare("$select where cardnumber=?");
1177 $sth->execute($cardnumber);
1179 unless ( $sth->rows ) {
1180 $sth->execute($userid);
1184 ( $borrowernumber, $firstname, $surname, $userflags,
1185 $branchcode, $branchname, $emailaddress ) = $sth->fetchrow;
1188 # launch a sequence to check if we have a ip for the branch, i
1189 # if we have one we replace the branchcode of the userenv by the branch bound in the ip.
1191 my $ip = $ENV{'REMOTE_ADDR'};
1193 # if they specify at login, use that
1194 if ( $query->param('branch') ) {
1195 $branchcode = $query->param('branch');
1196 my $library = Koha::Libraries->find($branchcode);
1197 $branchname = $library? $library->branchname: '';
1199 if ( $query->param('desk_id') ) {
1200 $desk_id = $query->param('desk_id');
1201 my $desk = Koha::Desks->find($desk_id);
1202 $desk_name = $desk ? $desk->desk_name : '';
1204 if ( C4::Context->preference('UseCashRegisters') ) {
1206 $query->param('register_id')
1207 ? Koha::Cash::Registers->find($query->param('register_id'))
1208 : Koha::Cash::Registers->search(
1209 { branch => $branchcode, branch_default => 1 },
1210 { rows => 1 } )->single;
1211 $register_id = $register->id if ($register);
1212 $register_name = $register->name if ($register);
1214 my $branches = { map { $_->branchcode => $_->unblessed } Koha::Libraries->search->as_list };
1215 if ( $type ne 'opac' and C4::Context->preference('AutoLocation') ) {
1217 # we have to check they are coming from the right ip range
1218 my $domain = $branches->{$branchcode}->{'branchip'};
1219 $domain =~ s|\.\*||g;
1220 if ( $ip !~ /^$domain/ ) {
1222 $cookie = $cookie_mgr->replace_in_list( $cookie, $query->cookie(
1223 -name => 'CGISESSID',
1226 -secure => ( C4::Context->https_enabled() ? 1 : 0 ),
1229 $info{'wrongip'} = 1;
1233 foreach my $br ( keys %$branches ) {
1235 # now we work with the treatment of ip
1236 my $domain = $branches->{$br}->{'branchip'};
1237 if ( $domain && $ip =~ /^$domain/ ) {
1238 $branchcode = $branches->{$br}->{'branchcode'};
1240 # new op dev : add the branchname to the cookie
1241 $branchname = $branches->{$br}->{'branchname'};
1245 my $is_sco_user = 0;
1246 if ( $query->param('sco_user_login') && ( $query->param('sco_user_login') eq '1' ) ){
1250 $session->param( 'number', $borrowernumber );
1251 $session->param( 'id', $userid );
1252 $session->param( 'cardnumber', $cardnumber );
1253 $session->param( 'firstname', $firstname );
1254 $session->param( 'surname', $surname );
1255 $session->param( 'branch', $branchcode );
1256 $session->param( 'branchname', $branchname );
1257 $session->param( 'desk_id', $desk_id);
1258 $session->param( 'desk_name', $desk_name);
1259 $session->param( 'flags', $userflags );
1260 $session->param( 'emailaddress', $emailaddress );
1261 $session->param( 'ip', $session->remote_addr() );
1262 $session->param( 'lasttime', time() );
1263 $session->param( 'interface', $type);
1264 $session->param( 'shibboleth', $shibSuccess );
1265 $session->param( 'register_id', $register_id );
1266 $session->param( 'register_name', $register_name );
1267 $session->param( 'sco_user', $is_sco_user );
1269 $session->param('cas_ticket', $cas_ticket) if $cas_ticket;
1270 C4::Context->set_userenv(
1271 $session->param('number'), $session->param('id'),
1272 $session->param('cardnumber'), $session->param('firstname'),
1273 $session->param('surname'), $session->param('branch'),
1274 $session->param('branchname'), $session->param('flags'),
1275 $session->param('emailaddress'), $session->param('shibboleth'),
1276 $session->param('desk_id'), $session->param('desk_name'),
1277 $session->param('register_id'), $session->param('register_name')
1281 # $return: 0 = invalid user
1282 # reset to anonymous session
1285 $info{'invalid_username_or_password'} = 1;
1286 C4::Context::_unset_userenv($sessionID);
1288 $session->param( 'lasttime', time() );
1289 $session->param( 'ip', $session->remote_addr() );
1290 $session->param( 'sessiontype', 'anon' );
1291 $session->param( 'interface', $type);
1293 } # END if ( $q_userid
1294 elsif ( $type eq "opac" ) {
1296 # anonymous sessions are created only for the OPAC
1298 # setting a couple of other session vars...
1299 $session->param( 'ip', $session->remote_addr() );
1300 $session->param( 'lasttime', time() );
1301 $session->param( 'sessiontype', 'anon' );
1302 $session->param( 'interface', $type);
1305 } # END unless ($userid)
1308 if ( $auth_state eq 'logged_in' ) {
1309 $auth_state = 'completed';
1311 # Auth is completed unless an additional auth is needed
1312 if ( $require_2FA ) {
1313 my $patron = Koha::Patrons->find({userid => $userid});
1314 if ( $patron->auth_method eq 'two-factor' ) {
1315 # Ask for the OTP token
1316 $auth_state = 'additional-auth-needed';
1317 $session->param('waiting-for-2FA', 1);
1318 %info = ();# We remove the warnings/errors we may have set incorrectly before
1323 # finished authentification, now respond
1324 if ( $auth_state eq 'completed' || $authnotrequired ) {
1327 $cookie = $cookie_mgr->replace_in_list( $cookie, $query->cookie(
1328 -name => 'CGISESSID',
1331 -secure => ( C4::Context->https_enabled() ? 1 : 0 ),
1336 track_login_daily( $userid );
1338 # In case, that this request was a login attempt, we want to prevent that users can repost the opac login
1339 # request. We therefore redirect the user to the requested page again without the login parameters.
1340 # See Post/Redirect/Get (PRG) design pattern: https://en.wikipedia.org/wiki/Post/Redirect/Get
1341 if ( $type eq "opac" && $query->param('koha_login_context') && $query->param('koha_login_context') ne 'sco' && $query->param('password') && $query->param('userid') ) {
1342 my $uri = URI->new($query->url(-relative=>1, -query_string=>1));
1343 $uri->query_param_delete('userid');
1344 $uri->query_param_delete('password');
1345 $uri->query_param_delete('koha_login_context');
1346 print $query->redirect(-uri => $uri->as_string, -cookie => $cookie, -status=>'303 See other');
1350 return ( $userid, $cookie, $sessionID, $flags );
1355 # AUTH rejected, show the login/password template, after checking the DB.
1359 my $patron = Koha::Patrons->find({ userid => $q_userid }); # Not necessary logged in!
1361 # get the inputs from the incoming query
1363 my @inputs_to_clean = qw( userid password ticket logout.x otp_token );
1364 foreach my $name ( param $query) {
1365 next if grep { $name eq $_ } @inputs_to_clean;
1366 my @value = $query->multi_param($name);
1367 push @inputs, { name => $name, value => $_ } for @value;
1370 my $LibraryNameTitle = C4::Context->preference("LibraryName");
1371 $LibraryNameTitle =~ s/<(?:\/?)(?:br|p)\s*(?:\/?)>/ /sgi;
1372 $LibraryNameTitle =~ s/<(?:[^<>'"]|'(?:[^']*)'|"(?:[^"]*)")*>//sg;
1374 my $auth_template_name = ( $type eq 'opac' ) ? 'opac-auth.tt' : 'auth.tt';
1375 my $template = C4::Templates::gettemplate( $auth_template_name, $type, $query );
1379 script_name => get_script_name(),
1380 casAuthentication => C4::Context->preference("casAuthentication"),
1381 shibbolethAuthentication => $shib,
1382 suggestion => C4::Context->preference("suggestion"),
1383 virtualshelves => C4::Context->preference("virtualshelves"),
1384 LibraryName => "" . C4::Context->preference("LibraryName"),
1385 LibraryNameTitle => "" . $LibraryNameTitle,
1386 opacuserlogin => C4::Context->preference("opacuserlogin"),
1387 OpacFavicon => C4::Context->preference("OpacFavicon"),
1388 opacreadinghistory => C4::Context->preference("opacreadinghistory"),
1389 opaclanguagesdisplay => C4::Context->preference("opaclanguagesdisplay"),
1390 OPACUserJS => C4::Context->preference("OPACUserJS"),
1391 opacbookbag => "" . C4::Context->preference("opacbookbag"),
1392 OpacCloud => C4::Context->preference("OpacCloud"),
1393 OpacTopissue => C4::Context->preference("OpacTopissue"),
1394 OpacAuthorities => C4::Context->preference("OpacAuthorities"),
1395 OpacBrowser => C4::Context->preference("OpacBrowser"),
1396 TagsEnabled => C4::Context->preference("TagsEnabled"),
1397 OPACUserCSS => C4::Context->preference("OPACUserCSS"),
1398 intranetcolorstylesheet => C4::Context->preference("intranetcolorstylesheet"),
1399 intranetstylesheet => C4::Context->preference("intranetstylesheet"),
1400 IntranetNav => C4::Context->preference("IntranetNav"),
1401 IntranetFavicon => C4::Context->preference("IntranetFavicon"),
1402 IntranetUserCSS => C4::Context->preference("IntranetUserCSS"),
1403 IntranetUserJS => C4::Context->preference("IntranetUserJS"),
1404 IndependentBranches => C4::Context->preference("IndependentBranches"),
1405 AutoLocation => C4::Context->preference("AutoLocation"),
1406 wrongip => $info{'wrongip'},
1407 PatronSelfRegistration => C4::Context->preference("PatronSelfRegistration"),
1408 PatronSelfRegistrationDefaultCategory => C4::Context->preference("PatronSelfRegistrationDefaultCategory"),
1409 opac_css_override => $ENV{'OPAC_CSS_OVERRIDE'},
1410 too_many_login_attempts => ( $patron and $patron->account_locked ),
1411 password_has_expired => ( $patron and $patron->password_expired ),
1414 $template->param( SCO_login => 1 ) if ( $query->param('sco_user_login') );
1415 $template->param( SCI_login => 1 ) if ( $query->param('sci_user_login') );
1416 $template->param( OpacPublic => C4::Context->preference("OpacPublic") );
1417 $template->param( loginprompt => 1 ) unless $info{'nopermission'};
1418 if ( $auth_state eq 'additional-auth-needed' ) {
1419 my $patron = Koha::Patrons->find( { userid => $userid } );
1422 invalid_otp_token => $invalid_otp_token,
1423 notice_email_address => $patron->notice_email_address, # We could also pass logged_in_user if necessary
1427 if ( $type eq 'opac' ) {
1428 require Koha::Virtualshelves;
1429 my $some_public_shelves = Koha::Virtualshelves->get_some_shelves(
1435 some_public_shelves => $some_public_shelves,
1441 # Is authentication against multiple CAS servers enabled?
1442 require C4::Auth_with_cas;
1443 if ( multipleAuth() && !$casparam ) {
1444 my $casservers = getMultipleAuth();
1446 foreach my $key ( keys %$casservers ) {
1447 push @tmplservers, { name => $key, value => login_cas_url( $query, $key, $type ) . "?cas=$key" };
1450 casServersLoop => \@tmplservers
1454 casServerUrl => login_cas_url($query, undef, $type),
1459 invalidCasLogin => $info{'invalidCasLogin'}
1464 #If shibOnly is enabled just go ahead and redirect directly
1465 if ( (($type eq 'opac') && C4::Context->preference('OPACShibOnly')) || (($type ne 'opac') && C4::Context->preference('staffShibOnly')) ) {
1466 my $redirect_url = login_shib_url( $query );
1467 print $query->redirect( -uri => "$redirect_url", -status => 303 );
1472 shibbolethAuthentication => $shib,
1473 shibbolethLoginUrl => login_shib_url($query),
1477 if (C4::Context->preference('GoogleOpenIDConnect')) {
1478 if ($query->param("OpenIDConnectFailed")) {
1479 my $reason = $query->param('OpenIDConnectFailed');
1480 $template->param(invalidGoogleOpenIDConnectLogin => $reason);
1485 LibraryName => C4::Context->preference("LibraryName"),
1487 $template->param(%info);
1489 # $cookie = $query->cookie(CGISESSID => $session->id
1491 print $query->header(
1492 { type => 'text/html',
1495 'X-Frame-Options' => 'SAMEORIGIN',
1503 =head2 check_api_auth
1505 ($status, $cookie, $sessionId) = check_api_auth($query, $userflags);
1507 Given a CGI query containing the parameters 'userid' and 'password' and/or a session
1508 cookie, determine if the user has the privileges specified by C<$userflags>.
1510 C<check_api_auth> is is meant for authenticating users of web services, and
1511 consequently will always return and will not attempt to redirect the user
1514 If a valid session cookie is already present, check_api_auth will return a status
1515 of "ok", the cookie, and the Koha session ID.
1517 If no session cookie is present, check_api_auth will check the 'userid' and 'password
1518 parameters and create a session cookie and Koha session if the supplied credentials
1521 Possible return values in C<$status> are:
1525 =item "ok" -- user authenticated; C<$cookie> and C<$sessionid> have valid values.
1527 =item "failed" -- credentials are not correct; C<$cookie> and C<$sessionid> are undef
1529 =item "maintenance" -- DB is in maintenance mode; no login possible at the moment
1531 =item "expired -- session cookie has expired; API user should resubmit userid and password
1533 =item "restricted" -- The IP has changed (if SessionRestrictionByIP)
1535 =item "additional-auth-needed -- User is in an authentication process that is not finished
1541 sub check_api_auth {
1544 my $flagsrequired = shift;
1545 my $timeout = _timeout_syspref();
1547 unless ( C4::Context->preference('Version') ) {
1549 # database has not been installed yet
1550 return ( "maintenance", undef, undef );
1552 my $kohaversion = Koha::version();
1553 $kohaversion =~ s/(.*\..*)\.(.*)\.(.*)/$1$2$3/;
1554 if ( C4::Context->preference('Version') < $kohaversion ) {
1556 # database in need of version update; assume that
1557 # no API should be called while databsae is in
1559 return ( "maintenance", undef, undef );
1562 my ( $sessionID, $session );
1563 unless ( $query->param('userid') ) {
1564 $sessionID = $query->cookie("CGISESSID");
1566 if ( $sessionID && not( $cas && $query->param('PT') ) ) {
1569 ( $return, $session, undef ) = check_cookie_auth(
1570 $sessionID, $flagsrequired, { remote_addr => $ENV{REMOTE_ADDR} } );
1572 return ( $return, undef, undef ) # Cookie auth failed
1575 my $cookie = $query->cookie(
1576 -name => 'CGISESSID',
1577 -value => $session->id,
1579 -secure => ( C4::Context->https_enabled() ? 1 : 0 ),
1582 return ( $return, $cookie, $session ); # return == 'ok' here
1587 my $userid = $query->param('userid');
1588 my $password = $query->param('password');
1589 my ( $return, $cardnumber, $cas_ticket );
1592 if ( $cas && $query->param('PT') ) {
1595 # In case of a CAS authentication, we use the ticket instead of the password
1596 my $PT = $query->param('PT');
1597 ( $return, $cardnumber, $userid, $cas_ticket ) = check_api_auth_cas( $PT, $query ); # EXTERNAL AUTH
1600 # User / password auth
1601 unless ( $userid and $password ) {
1603 # caller did something wrong, fail the authenticateion
1604 return ( "failed", undef, undef );
1607 ( $return, $cardnumber, $newuserid, $cas_ticket ) = checkpw( $userid, $password, $query );
1610 if ( $return and haspermission( $userid, $flagsrequired ) ) {
1611 my $session = get_session("");
1612 return ( "failed", undef, undef ) unless $session;
1614 my $sessionID = $session->id;
1615 C4::Context->_new_userenv($sessionID);
1616 my $cookie = $query->cookie(
1617 -name => 'CGISESSID',
1618 -value => $sessionID,
1620 -secure => ( C4::Context->https_enabled() ? 1 : 0 ),
1623 if ( $return == 1 ) {
1625 $borrowernumber, $firstname, $surname,
1626 $userflags, $branchcode, $branchname,
1629 my $dbh = C4::Context->dbh;
1632 "select borrowernumber, firstname, surname, flags, borrowers.branchcode, branches.branchname as branchname, email from borrowers left join branches on borrowers.branchcode=branches.branchcode where userid=?"
1634 $sth->execute($userid);
1636 $borrowernumber, $firstname, $surname,
1637 $userflags, $branchcode, $branchname,
1639 ) = $sth->fetchrow if ( $sth->rows );
1641 unless ( $sth->rows ) {
1642 my $sth = $dbh->prepare(
1643 "select borrowernumber, firstname, surname, flags, borrowers.branchcode, branches.branchname as branchname, email from borrowers left join branches on borrowers.branchcode=branches.branchcode where cardnumber=?"
1645 $sth->execute($cardnumber);
1647 $borrowernumber, $firstname, $surname,
1648 $userflags, $branchcode, $branchname,
1650 ) = $sth->fetchrow if ( $sth->rows );
1652 unless ( $sth->rows ) {
1653 $sth->execute($userid);
1655 $borrowernumber, $firstname, $surname, $userflags,
1656 $branchcode, $branchname, $emailaddress
1657 ) = $sth->fetchrow if ( $sth->rows );
1661 my $ip = $ENV{'REMOTE_ADDR'};
1663 # if they specify at login, use that
1664 if ( $query->param('branch') ) {
1665 $branchcode = $query->param('branch');
1666 my $library = Koha::Libraries->find($branchcode);
1667 $branchname = $library? $library->branchname: '';
1669 my $branches = { map { $_->branchcode => $_->unblessed } Koha::Libraries->search->as_list };
1670 foreach my $br ( keys %$branches ) {
1672 # now we work with the treatment of ip
1673 my $domain = $branches->{$br}->{'branchip'};
1674 if ( $domain && $ip =~ /^$domain/ ) {
1675 $branchcode = $branches->{$br}->{'branchcode'};
1677 # new op dev : add the branchname to the cookie
1678 $branchname = $branches->{$br}->{'branchname'};
1681 $session->param( 'number', $borrowernumber );
1682 $session->param( 'id', $userid );
1683 $session->param( 'cardnumber', $cardnumber );
1684 $session->param( 'firstname', $firstname );
1685 $session->param( 'surname', $surname );
1686 $session->param( 'branch', $branchcode );
1687 $session->param( 'branchname', $branchname );
1688 $session->param( 'flags', $userflags );
1689 $session->param( 'emailaddress', $emailaddress );
1690 $session->param( 'ip', $session->remote_addr() );
1691 $session->param( 'lasttime', time() );
1692 $session->param( 'interface', 'api' );
1694 $session->param( 'cas_ticket', $cas_ticket);
1695 C4::Context->set_userenv(
1696 $session->param('number'), $session->param('id'),
1697 $session->param('cardnumber'), $session->param('firstname'),
1698 $session->param('surname'), $session->param('branch'),
1699 $session->param('branchname'), $session->param('flags'),
1700 $session->param('emailaddress'), $session->param('shibboleth'),
1701 $session->param('desk_id'), $session->param('desk_name'),
1702 $session->param('register_id'), $session->param('register_name')
1704 return ( "ok", $cookie, $sessionID );
1706 return ( "failed", undef, undef );
1711 =head2 check_cookie_auth
1713 ($status, $sessionId) = check_cookie_auth($cookie, $userflags);
1715 Given a CGISESSID cookie set during a previous login to Koha, determine
1716 if the user has the privileges specified by C<$userflags>. C<$userflags>
1717 is passed unaltered into C<haspermission> and as such accepts all options
1718 avaiable to that routine with the one caveat that C<check_api_auth> will
1719 also allow 'undef' to be passed and in such a case the permissions check
1720 will be skipped altogether.
1722 C<check_cookie_auth> is meant for authenticating special services
1723 such as tools/upload-file.pl that are invoked by other pages that
1724 have been authenticated in the usual way.
1726 Possible return values in C<$status> are:
1730 =item "ok" -- user authenticated; C<$sessionID> have valid values.
1732 =item "anon" -- user not authenticated but valid for anonymous session.
1734 =item "failed" -- credentials are not correct; C<$sessionid> are undef
1736 =item "maintenance" -- DB is in maintenance mode; no login possible at the moment
1738 =item "expired -- session cookie has expired; API user should resubmit userid and password
1740 =item "restricted" -- The IP has changed (if SessionRestrictionByIP)
1746 sub check_cookie_auth {
1747 my $sessionID = shift;
1748 my $flagsrequired = shift;
1751 my $remote_addr = $params->{remote_addr} || $ENV{REMOTE_ADDR};
1753 my $skip_version_check = $params->{skip_version_check}; # Only for checkauth
1755 unless ( $skip_version_check ) {
1756 unless ( C4::Context->preference('Version') ) {
1758 # database has not been installed yet
1759 return ( "maintenance", undef );
1761 my $kohaversion = Koha::version();
1762 $kohaversion =~ s/(.*\..*)\.(.*)\.(.*)/$1$2$3/;
1763 if ( C4::Context->preference('Version') < $kohaversion ) {
1765 # database in need of version update; assume that
1766 # no API should be called while databsae is in
1768 return ( "maintenance", undef );
1772 # see if we have a valid session cookie already
1773 # however, if a userid parameter is present (i.e., from
1774 # a form submission, assume that any current cookie
1776 unless ( $sessionID ) {
1777 return ( "failed", undef );
1779 C4::Context::_unset_userenv($sessionID); # remove old userenv first
1780 my $session = get_session($sessionID);
1782 my $userid = $session->param('id');
1783 my $ip = $session->param('ip');
1784 my $lasttime = $session->param('lasttime');
1785 my $timeout = _timeout_syspref();
1787 if ( !$lasttime || ( $lasttime < time() - $timeout ) ) {
1791 return ("expired", undef);
1793 } elsif ( C4::Context->preference('SessionRestrictionByIP') && $ip ne $remote_addr ) {
1794 # IP address changed
1797 return ( "restricted", undef, { old_ip => $ip, new_ip => $remote_addr});
1799 } elsif ( $userid ) {
1800 $session->param( 'lasttime', time() );
1801 my $patron = Koha::Patrons->find({ userid => $userid });
1802 $patron = Koha::Patron->find({ cardnumber => $userid }) unless $patron;
1803 return ("password_expired", undef ) if $patron->password_expired;
1804 my $flags = defined($flagsrequired) ? haspermission( $userid, $flagsrequired ) : 1;
1806 C4::Context->_new_userenv($sessionID);
1807 C4::Context->interface($session->param('interface'));
1808 C4::Context->set_userenv(
1809 $session->param('number'), $session->param('id') // '',
1810 $session->param('cardnumber'), $session->param('firstname'),
1811 $session->param('surname'), $session->param('branch'),
1812 $session->param('branchname'), $session->param('flags'),
1813 $session->param('emailaddress'), $session->param('shibboleth'),
1814 $session->param('desk_id'), $session->param('desk_name'),
1815 $session->param('register_id'), $session->param('register_name')
1817 return ( "additional-auth-needed", $session )
1818 if $session->param('waiting-for-2FA');
1820 return ( "ok", $session );
1824 return ( "failed", undef );
1828 C4::Context->_new_userenv($sessionID);
1829 C4::Context->interface($session->param('interface'));
1830 C4::Context->set_userenv( undef, q{} );
1831 return ( "anon", $session );
1834 return ( "expired", undef );
1841 my $session = get_session($sessionID);
1843 Given a session ID, retrieve the CGI::Session object used to store
1844 the session's state. The session object can be used to store
1845 data that needs to be accessed by different scripts during a
1848 If the C<$sessionID> parameter is an empty string, a new session
1853 sub _get_session_params {
1854 my $storage_method = C4::Context->preference('SessionStorage');
1855 if ( $storage_method eq 'mysql' ) {
1856 my $dbh = C4::Context->dbh;
1857 return { dsn => "serializer:yamlxs;driver:MySQL;id:md5", dsn_args => { Handle => $dbh } };
1859 elsif ( $storage_method eq 'Pg' ) {
1860 my $dbh = C4::Context->dbh;
1861 return { dsn => "serializer:yamlxs;driver:PostgreSQL;id:md5", dsn_args => { Handle => $dbh } };
1863 elsif ( $storage_method eq 'memcached' && Koha::Caches->get_instance->memcached_cache ) {
1864 my $memcached = Koha::Caches->get_instance()->memcached_cache;
1865 return { dsn => "serializer:yamlxs;driver:memcached;id:md5", dsn_args => { Memcached => $memcached } };
1868 # catch all defaults to tmp should work on all systems
1869 my $dir = C4::Context::temporary_directory;
1870 my $instance = C4::Context->config( 'database' ); #actually for packages not exactly the instance name, but generally safer to leave it as it is
1871 return { dsn => "serializer:yamlxs;driver:File;id:md5", dsn_args => { Directory => "$dir/cgisess_$instance" } };
1876 my $sessionID = shift;
1877 my $params = _get_session_params();
1879 if( $sessionID ) { # find existing
1880 CGI::Session::ErrorHandler->set_error( q{} ); # clear error, cpan issue #111463
1881 $session = CGI::Session->load( $params->{dsn}, $sessionID, $params->{dsn_args} );
1883 $session = CGI::Session->new( $params->{dsn}, $sessionID, $params->{dsn_args} );
1884 # no need to flush here
1890 # FIXME no_set_userenv may be replaced with force_branchcode_for_userenv
1891 # (or something similar)
1892 # Currently it's only passed from C4::SIP::ILS::Patron::check_password, but
1893 # not having a userenv defined could cause a crash.
1895 my ( $userid, $password, $query, $type, $no_set_userenv ) = @_;
1896 $type = 'opac' unless $type;
1898 # Get shibboleth login attribute
1899 my $shib = C4::Context->config('useshibboleth') && shib_ok();
1900 my $shib_login = $shib ? get_login_shib() : undef;
1904 if ( defined $userid ){
1905 $patron = Koha::Patrons->find({ userid => $userid });
1906 $patron = Koha::Patrons->find({ cardnumber => $userid }) unless $patron;
1908 my $check_internal_as_fallback = 0;
1910 # Note: checkpw_* routines returns:
1913 # -1 if user bind failed (LDAP only)
1915 if ( $patron and ( $patron->account_locked ) ) {
1916 # Nothing to check, account is locked
1917 } elsif ($ldap && defined($password)) {
1918 my ( $retval, $retcard, $retuserid ) = checkpw_ldap(@_); # EXTERNAL AUTH
1919 if ( $retval == 1 ) {
1920 @return = ( $retval, $retcard, $retuserid );
1923 $check_internal_as_fallback = 1 if $retval == 0;
1925 } elsif ( $cas && $query && $query->param('ticket') ) {
1927 # In case of a CAS authentication, we use the ticket instead of the password
1928 my $ticket = $query->param('ticket');
1929 $query->delete('ticket'); # remove ticket to come back to original URL
1930 my ( $retval, $retcard, $retuserid, $cas_ticket ) = checkpw_cas( $ticket, $query, $type ); # EXTERNAL AUTH
1932 @return = ( $retval, $retcard, $retuserid, $cas_ticket );
1936 $passwd_ok = $retval;
1939 # If we are in a shibboleth session (shibboleth is enabled, and a shibboleth match attribute is present)
1940 # Check for password to asertain whether we want to be testing against shibboleth or another method this
1942 elsif ( $shib && $shib_login && !$password ) {
1944 # In case of a Shibboleth authentication, we expect a shibboleth user attribute
1945 # (defined under shibboleth mapping in koha-conf.xml) to contain the login of the
1946 # shibboleth-authenticated user
1948 # Then, we check if it matches a valid koha user
1950 my ( $retval, $retcard, $retuserid ) = C4::Auth_with_shibboleth::checkpw_shib($shib_login); # EXTERNAL AUTH
1952 @return = ( $retval, $retcard, $retuserid );
1954 $passwd_ok = $retval;
1957 $check_internal_as_fallback = 1;
1961 if ( $check_internal_as_fallback ) {
1962 @return = checkpw_internal( $userid, $password, $no_set_userenv);
1963 $passwd_ok = 1 if $return[0] > 0; # 1 or 2
1968 $patron->update({ login_attempts => 0 });
1969 if( $patron->password_expired ){
1972 } elsif( !$patron->account_locked ) {
1973 $patron->update({ login_attempts => $patron->login_attempts + 1 });
1977 # Optionally log success or failure
1978 if( $patron && $passwd_ok && C4::Context->preference('AuthSuccessLog') ) {
1979 logaction( 'AUTH', 'SUCCESS', $patron->id, "Valid password for $userid", $type );
1980 } elsif( !$passwd_ok && C4::Context->preference('AuthFailureLog') ) {
1981 logaction( 'AUTH', 'FAILURE', $patron ? $patron->id : 0, "Wrong password for $userid", $type );
1987 sub checkpw_internal {
1988 my ( $userid, $password, $no_set_userenv ) = @_;
1990 $password = Encode::encode( 'UTF-8', $password )
1991 if Encode::is_utf8($password);
1993 my $dbh = C4::Context->dbh;
1996 "select password,cardnumber,borrowernumber,userid,firstname,surname,borrowers.branchcode,branches.branchname,flags from borrowers join branches on borrowers.branchcode=branches.branchcode where userid=?"
1998 $sth->execute($userid);
2000 my ( $stored_hash, $cardnumber, $borrowernumber, $userid, $firstname,
2001 $surname, $branchcode, $branchname, $flags )
2004 if ( checkpw_hash( $password, $stored_hash ) ) {
2006 C4::Context->set_userenv( "$borrowernumber", $userid, $cardnumber,
2007 $firstname, $surname, $branchcode, $branchname, $flags ) unless $no_set_userenv;
2008 return 1, $cardnumber, $userid;
2013 "select password,cardnumber,borrowernumber,userid,firstname,surname,borrowers.branchcode,branches.branchname,flags from borrowers join branches on borrowers.branchcode=branches.branchcode where cardnumber=?"
2015 $sth->execute($userid);
2017 my ( $stored_hash, $cardnumber, $borrowernumber, $userid, $firstname,
2018 $surname, $branchcode, $branchname, $flags )
2021 if ( checkpw_hash( $password, $stored_hash ) ) {
2023 C4::Context->set_userenv( $borrowernumber, $userid, $cardnumber,
2024 $firstname, $surname, $branchcode, $branchname, $flags ) unless $no_set_userenv;
2025 return 1, $cardnumber, $userid;
2032 my ( $password, $stored_hash ) = @_;
2034 return if $stored_hash eq '!';
2036 # check what encryption algorithm was implemented: Bcrypt - if the hash starts with '$2' it is Bcrypt else md5
2038 if ( substr( $stored_hash, 0, 2 ) eq '$2' ) {
2039 $hash = hash_password( $password, $stored_hash );
2041 $hash = md5_base64($password);
2043 return $hash eq $stored_hash;
2048 my $authflags = getuserflags($flags, $userid, [$dbh]);
2050 Translates integer flags into permissions strings hash.
2052 C<$flags> is the integer userflags value ( borrowers.userflags )
2053 C<$userid> is the members.userid, used for building subpermissions
2054 C<$authflags> is a hashref of permissions
2061 my $dbh = @_ ? shift : C4::Context->dbh;
2064 # I don't want to do this, but if someone logs in as the database
2065 # user, it would be preferable not to spam them to death with
2066 # numeric warnings. So, we make $flags numeric.
2067 no warnings 'numeric';
2070 my $sth = $dbh->prepare("SELECT bit, flag, defaulton FROM userflags");
2073 while ( my ( $bit, $flag, $defaulton ) = $sth->fetchrow ) {
2074 if ( ( $flags & ( 2**$bit ) ) || $defaulton ) {
2075 $userflags->{$flag} = 1;
2078 $userflags->{$flag} = 0;
2082 # get subpermissions and merge with top-level permissions
2083 my $user_subperms = get_user_subpermissions($userid);
2084 foreach my $module ( keys %$user_subperms ) {
2085 next if $userflags->{$module} == 1; # user already has permission for everything in this module
2086 $userflags->{$module} = $user_subperms->{$module};
2092 =head2 get_user_subpermissions
2094 $user_perm_hashref = get_user_subpermissions($userid);
2096 Given the userid (note, not the borrowernumber) of a staff user,
2097 return a hashref of hashrefs of the specific subpermissions
2098 accorded to the user. An example return is
2102 export_catalog => 1,
2103 import_patrons => 1,
2107 The top-level hash-key is a module or function code from
2108 userflags.flag, while the second-level key is a code
2111 The results of this function do not give a complete picture
2112 of the functions that a staff user can access; it is also
2113 necessary to check borrowers.flags.
2117 sub get_user_subpermissions {
2120 my $dbh = C4::Context->dbh;
2121 my $sth = $dbh->prepare( "SELECT flag, user_permissions.code
2122 FROM user_permissions
2123 JOIN permissions USING (module_bit, code)
2124 JOIN userflags ON (module_bit = bit)
2125 JOIN borrowers USING (borrowernumber)
2126 WHERE userid = ?" );
2127 $sth->execute($userid);
2129 my $user_perms = {};
2130 while ( my $perm = $sth->fetchrow_hashref ) {
2131 $user_perms->{ $perm->{'flag'} }->{ $perm->{'code'} } = 1;
2136 =head2 get_all_subpermissions
2138 my $perm_hashref = get_all_subpermissions();
2140 Returns a hashref of hashrefs defining all specific
2141 permissions currently defined. The return value
2142 has the same structure as that of C<get_user_subpermissions>,
2143 except that the innermost hash value is the description
2144 of the subpermission.
2148 sub get_all_subpermissions {
2149 my $dbh = C4::Context->dbh;
2150 my $sth = $dbh->prepare( "SELECT flag, code
2152 JOIN userflags ON (module_bit = bit)" );
2156 while ( my $perm = $sth->fetchrow_hashref ) {
2157 $all_perms->{ $perm->{'flag'} }->{ $perm->{'code'} } = 1;
2162 =head2 haspermission
2164 $flagsrequired = '*'; # Any permission at all
2165 $flagsrequired = 'a_flag'; # a_flag must be satisfied (all subpermissions)
2166 $flagsrequired = [ 'a_flag', 'b_flag' ]; # a_flag OR b_flag must be satisfied
2167 $flagsrequired = { 'a_flag => 1, 'b_flag' => 1 }; # a_flag AND b_flag must be satisfied
2168 $flagsrequired = { 'a_flag' => 'sub_a' }; # sub_a of a_flag must be satisfied
2169 $flagsrequired = { 'a_flag' => [ 'sub_a, 'sub_b' ] }; # sub_a OR sub_b of a_flag must be satisfied
2171 $flags = ($userid, $flagsrequired);
2173 C<$userid> the userid of the member
2174 C<$flags> is a query structure similar to that used by SQL::Abstract that
2175 denotes the combination of flags required. It is a required parameter.
2177 The main logic of this method is that things in arrays are OR'ed, and things
2178 in hashes are AND'ed. The `*` character can be used, at any depth, to denote `ANY`
2180 Returns member's flags or 0 if a permission is not met.
2185 my ($required, $flags) = @_;
2187 my $ref = ref($required);
2189 if ($required eq '*') {
2190 return 0 unless ( $flags or ref( $flags ) );
2192 return 0 unless ( $flags and (!ref( $flags ) || $flags->{$required} ));
2194 } elsif ($ref eq 'HASH') {
2195 foreach my $key (keys %{$required}) {
2196 next if $flags == 1;
2197 my $require = $required->{$key};
2198 my $rflags = $flags->{$key};
2199 return 0 unless _dispatch($require, $rflags);
2201 } elsif ($ref eq 'ARRAY') {
2203 foreach my $require ( @{$required} ) {
2205 ( ref($flags) && !ref($require) && ( $require ne '*' ) )
2206 ? $flags->{$require}
2208 $satisfied++ if _dispatch( $require, $rflags );
2210 return 0 unless $satisfied;
2212 croak "Unexpected structure found: $ref";
2219 my ( $userid, $flagsrequired ) = @_;
2221 #Koha::Exceptions::WrongParameter->throw('$flagsrequired should not be undef')
2222 # unless defined($flagsrequired);
2224 my $sth = C4::Context->dbh->prepare("SELECT flags FROM borrowers WHERE userid=?");
2225 $sth->execute($userid);
2226 my $row = $sth->fetchrow();
2227 my $flags = getuserflags( $row, $userid );
2229 return $flags unless defined($flagsrequired);
2230 return $flags if $flags->{superlibrarian};
2231 return _dispatch($flagsrequired, $flags);
2233 #FIXME - This fcn should return the failed permission so a suitable error msg can be delivered.
2238 $flags = ($iprange);
2240 C<$iprange> A space separated string describing an IP range. Can include single IPs or ranges
2242 Returns 1 if the remote address is in the provided iprange, or 0 otherwise.
2249 my @allowedipranges = $iprange ? split(' ', $iprange) : ();
2250 if (scalar @allowedipranges > 0) {
2252 eval { @rangelist = Net::CIDR::range2cidr(@allowedipranges); }; return 0 if $@;
2253 eval { $result = Net::CIDR::cidrlookup($ENV{'REMOTE_ADDR'}, @rangelist) } || Koha::Logger->get->warn('cidrlookup failed for ' . join(' ',@rangelist) );
2255 return $result ? 1 : 0;
2258 sub getborrowernumber {
2260 my $userenv = C4::Context->userenv;
2261 if ( defined($userenv) && ref($userenv) eq 'HASH' && $userenv->{number} ) {
2262 return $userenv->{number};
2264 my $dbh = C4::Context->dbh;
2265 for my $field ( 'userid', 'cardnumber' ) {
2267 $dbh->prepare("select borrowernumber from borrowers where $field=?");
2268 $sth->execute($userid);
2270 my ($bnumber) = $sth->fetchrow;
2277 =head2 track_login_daily
2279 track_login_daily( $userid );
2281 Wraps the call to $patron->track_login, the method used to update borrowers.lastseen. We only call track_login once a day.
2285 sub track_login_daily {
2287 return if !$userid || !C4::Context->preference('TrackLastPatronActivity');
2289 my $cache = Koha::Caches->get_instance();
2290 my $cache_key = "track_login_" . $userid;
2291 my $cached = $cache->get_from_cache($cache_key);
2292 my $today = dt_from_string()->ymd;
2293 return if $cached && $cached eq $today;
2295 my $patron = Koha::Patrons->find({ userid => $userid });
2296 return unless $patron;
2297 $patron->track_login;
2298 $cache->set_in_cache( $cache_key, $today );
2301 END { } # module clean-up code here (global destructor)
2311 Crypt::Eksblowfish::Bcrypt(3)