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;
53 use Koha::Auth::Permissions;
57 use vars qw($ldap $cas $caslogout);
58 our (@ISA, @EXPORT_OK);
60 #NOTE: The utility of keeping the safe_exit function is that it can be easily re-defined in unit tests and plugins
62 # It's fine for us to "exit" because CGI::Compile (used in Plack::App::WrapCGI) redefines "exit" for us automatically.
63 # Since we only seem to use C4::Auth::safe_exit in a CGI context, we don't actually need PSGI detection at all here.
69 C4::Context->set_remote_address;
75 checkauth check_api_auth get_session check_cookie_auth checkpw checkpw_internal checkpw_hash
76 get_all_subpermissions get_user_subpermissions track_login_daily in_iprange
77 get_template_and_user haspermission create_basic_session
80 $ldap = C4::Context->config('useldapserver') || 0;
81 $cas = C4::Context->preference('casAuthentication');
82 $caslogout = C4::Context->preference('casLogout');
85 require C4::Auth_with_ldap;
86 import C4::Auth_with_ldap qw(checkpw_ldap);
89 require C4::Auth_with_cas; # no import
90 import C4::Auth_with_cas qw(check_api_auth_cas checkpw_cas login_cas logout_cas login_cas_url logout_if_required multipleAuth getMultipleAuth);
97 C4::Auth - Authenticates Koha users
101 use CGI qw ( -utf8 );
105 my $query = CGI->new;
107 my ($template, $borrowernumber, $cookie)
108 = get_template_and_user(
110 template_name => "opac-main.tt",
113 authnotrequired => 0,
114 flagsrequired => { catalogue => '*', tools => 'import_patrons' },
118 output_html_with_http_headers $query, $cookie, $template->output;
122 The main function of this module is to provide
123 authentification. However the get_template_and_user function has
124 been provided so that a users login information is passed along
125 automatically. This gets loaded into the template.
129 =head2 get_template_and_user
131 my ($template, $borrowernumber, $cookie)
132 = get_template_and_user(
134 template_name => "opac-main.tt",
137 authnotrequired => 0,
138 flagsrequired => { catalogue => '*', tools => 'import_patrons' },
142 This call passes the C<query>, C<flagsrequired> and C<authnotrequired>
143 to C<&checkauth> (in this module) to perform authentification.
144 See C<&checkauth> for an explanation of these parameters.
146 The C<template_name> is then used to find the correct template for
147 the page. The authenticated users details are loaded onto the
148 template in the logged_in_user variable (which is a Koha::Patron object). Also the
149 C<sessionID> is passed to the template. This can be used in templates
150 if cookies are disabled. It needs to be put as and input to every
153 More information on the C<gettemplate> sub can be found in the
158 sub get_template_and_user {
161 my ( $user, $cookie, $sessionID, $flags );
164 my $cookie_mgr = Koha::CookieManager->new;
166 # Get shibboleth login attribute
167 my $shib = C4::Context->config('useshibboleth') && shib_ok();
168 my $shib_login = $shib ? get_login_shib() : undef;
170 C4::Context->interface( $in->{type} );
172 $in->{'authnotrequired'} ||= 0;
174 # the following call includes a bad template check; might croak
175 my $template = C4::Templates::gettemplate(
176 $in->{'template_name'},
181 if ( $in->{'template_name'} !~ m/maintenance/ ) {
182 ( $user, $cookie, $sessionID, $flags ) = checkauth(
184 $in->{'authnotrequired'},
185 $in->{'flagsrequired'},
188 $in->{template_name},
192 # If we enforce GDPR and the user did not consent, redirect
193 # Exceptions for consent page itself and SCI/SCO system
194 if( $in->{type} eq 'opac' && $user &&
195 $in->{'template_name'} !~ /^(opac-page|opac-patron-consent|sc[io]\/)/ &&
196 C4::Context->preference('PrivacyPolicyConsent') eq 'Enforced' )
198 my $consent = Koha::Patron::Consents->search({
199 borrowernumber => getborrowernumber($user),
200 type => 'GDPR_PROCESSING',
201 given_on => { '!=', undef },
204 print $in->{query}->redirect(-uri => '/cgi-bin/koha/opac-patron-consent.pl', -cookie => $cookie);
209 if ( $in->{type} eq 'opac' && $user ) {
212 my $session = get_session($sessionID);
214 $is_sco_user = $session->param('sco_user');
220 # If the user logged in is the SCO user and they try to go out of the SCO module,
221 # log the user out removing the CGISESSID cookie
222 $in->{template_name} !~ m|sco/| && $in->{template_name} !~ m|errors/errorpage.tt|
226 C4::Context->preference('AutoSelfCheckID')
227 && $user eq C4::Context->preference('AutoSelfCheckID')
235 # If the user logged in is the SCI user and they try to go out of the SCI module,
236 # kick them out unless it is SCO with a valid permission
237 # or they are a superlibrarian
238 $in->{template_name} !~ m|sci/|
239 && haspermission( $user, { self_check => 'self_checkin_module' } )
241 $in->{template_name} =~ m|sco/| && haspermission(
242 $user, { self_check => 'self_checkout_module' }
245 && $flags && $flags->{superlibrarian} != 1
252 $template = C4::Templates::gettemplate( 'opac-auth.tt', 'opac',
254 $cookie = $cookie_mgr->replace_in_list( $cookie, $in->{query}->cookie(
255 -name => 'CGISESSID',
258 -secure => ( C4::Context->https_enabled() ? 1 : 0 ),
262 my $auth_error = $in->{query}->param('auth_error');
266 script_name => get_script_name(),
267 auth_error => $auth_error,
270 print $in->{query}->header(
275 'X-Frame-Options' => 'SAMEORIGIN'
286 # It's possible for $user to be the borrowernumber if they don't have a
287 # userid defined (and are logging in through some other method, such
288 # as SSL certs against an email address)
290 $borrowernumber = getborrowernumber($user) if defined($user);
291 if ( !defined($borrowernumber) && defined($user) ) {
292 $patron = Koha::Patrons->find( $user );
294 $borrowernumber = $user;
296 # A bit of a hack, but I don't know there's a nicer way
298 $user = $patron->firstname . ' ' . $patron->surname;
301 $patron = Koha::Patrons->find( $borrowernumber );
302 # FIXME What to do if $patron does not exist?
306 $template->param( loggedinusername => $user ); # OBSOLETE - Do not reuse this in template, use logged_in_user.userid instead
307 $template->param( loggedinusernumber => $borrowernumber ); # FIXME Should be replaced with logged_in_user.borrowernumber
308 $template->param( logged_in_user => $patron );
309 $template->param( sessionID => $sessionID );
311 if ( $in->{'type'} eq 'opac' ) {
312 require Koha::Virtualshelves;
313 my $some_private_shelves = Koha::Virtualshelves->get_some_shelves(
315 borrowernumber => $borrowernumber,
319 my $some_public_shelves = Koha::Virtualshelves->get_some_shelves(
325 some_private_shelves => $some_private_shelves,
326 some_public_shelves => $some_public_shelves,
330 # We are going to use the $flags returned by checkauth
331 # to create the template's parameters that will indicate
332 # which menus the user can access.
333 my $authz = Koha::Auth::Permissions->get_authz_from_flags({ flags => $flags });
334 foreach my $permission ( keys %{ $authz } ){
335 $template->param( $permission => $authz->{$permission} );
338 # Logged-in opac search history
339 # If the requested template is an opac one and opac search history is enabled
340 if ( $in->{type} eq 'opac' && C4::Context->preference('EnableOpacSearchHistory') ) {
341 my $dbh = C4::Context->dbh;
342 my $query = "SELECT COUNT(*) FROM search_history WHERE userid=?";
343 my $sth = $dbh->prepare($query);
344 $sth->execute($borrowernumber);
346 # If at least one search has already been performed
347 if ( $sth->fetchrow_array > 0 ) {
349 # We show the link in opac
350 $template->param( EnableOpacSearchHistory => 1 );
352 if (C4::Context->preference('LoadSearchHistoryToTheFirstLoggedUser'))
354 # And if there are searches performed when the user was not logged in,
355 # we add them to the logged-in search history
356 my @recentSearches = C4::Search::History::get_from_session( { cgi => $in->{'query'} } );
357 if (@recentSearches) {
359 INSERT INTO search_history(userid, sessionid, query_desc, query_cgi, type, total, time )
360 VALUES (?, ?, ?, ?, ?, ?, ?)
362 my $sth = $dbh->prepare($query);
363 $sth->execute( $borrowernumber,
364 $in->{query}->cookie("CGISESSID"),
367 $_->{type} || 'biblio',
370 ) foreach @recentSearches;
372 # clear out the search history from the session now that
373 # we've saved it to the database
376 C4::Search::History::set_to_session( { cgi => $in->{'query'}, search_history => [] } );
378 } elsif ( $in->{type} eq 'intranet' and C4::Context->preference('EnableSearchHistory') ) {
379 $template->param( EnableSearchHistory => 1 );
382 else { # if this is an anonymous session, setup to display public lists...
384 # If shibboleth is enabled, and we're in an anonymous session, we should allow
385 # the user to attempt login via shibboleth.
387 $template->param( shibbolethAuthentication => $shib,
388 shibbolethLoginUrl => login_shib_url( $in->{'query'} ),
391 # If shibboleth is enabled and we have a shibboleth login attribute,
392 # but we are in an anonymous session, then we clearly have an invalid
393 # shibboleth koha account.
395 $template->param( invalidShibLogin => '1' );
399 $template->param( sessionID => $sessionID );
401 if ( $in->{'type'} eq 'opac' ){
402 require Koha::Virtualshelves;
403 my $some_public_shelves = Koha::Virtualshelves->get_some_shelves(
409 some_public_shelves => $some_public_shelves,
412 # Set default branch if one has been passed by the environment.
413 $template->param( default_branch => $ENV{OPAC_BRANCH_DEFAULT} ) if $ENV{OPAC_BRANCH_DEFAULT};
417 # Sysprefs disabled via URL param
418 # Note that value must be defined in order to override via ENV
419 foreach my $syspref (
425 OpacAdditionalStylesheet
427 intranetcolorstylesheet
432 $ENV{"OVERRIDE_SYSPREF_$syspref"} = q{}
433 if $in->{'query'}->param("DISABLE_SYSPREF_$syspref");
436 # Anonymous opac search history
437 # If opac search history is enabled and at least one search has already been performed
438 if ( C4::Context->preference('EnableOpacSearchHistory') ) {
439 my @recentSearches = C4::Search::History::get_from_session( { cgi => $in->{'query'} } );
440 if (@recentSearches) {
441 $template->param( EnableOpacSearchHistory => 1 );
445 if ( C4::Context->preference('dateformat') ) {
446 $template->param( dateformat => C4::Context->preference('dateformat') );
449 $template->param(auth_forwarded_hash => scalar $in->{'query'}->param('auth_forwarded_hash'));
451 # these template parameters are set the same regardless of $in->{'type'}
453 my $minPasswordLength = C4::Context->preference('minPasswordLength');
454 $minPasswordLength = 3 if not $minPasswordLength or $minPasswordLength < 3;
456 EnhancedMessagingPreferences => C4::Context->preference('EnhancedMessagingPreferences'),
457 GoogleJackets => C4::Context->preference("GoogleJackets"),
458 OpenLibraryCovers => C4::Context->preference("OpenLibraryCovers"),
459 KohaAdminEmailAddress => "" . C4::Context->preference("KohaAdminEmailAddress"),
460 LoginFirstname => ( C4::Context->userenv ? C4::Context->userenv->{"firstname"} : "Bel" ),
461 LoginSurname => C4::Context->userenv ? C4::Context->userenv->{"surname"} : "Inconnu",
462 emailaddress => C4::Context->userenv ? C4::Context->userenv->{"emailaddress"} : undef,
463 TagsEnabled => C4::Context->preference("TagsEnabled"),
464 hide_marc => C4::Context->preference("hide_marc"),
465 item_level_itypes => C4::Context->preference('item-level_itypes'),
466 patronimages => C4::Context->preference("patronimages"),
467 singleBranchMode => ( Koha::Libraries->search->count == 1 ),
468 noItemTypeImages => C4::Context->preference("noItemTypeImages"),
469 marcflavour => C4::Context->preference("marcflavour"),
470 OPACBaseURL => C4::Context->preference('OPACBaseURL'),
471 minPasswordLength => $minPasswordLength,
473 if ( $in->{'type'} eq "intranet" ) {
475 AmazonCoverImages => C4::Context->preference("AmazonCoverImages"),
476 AutoLocation => C4::Context->preference("AutoLocation"),
477 PatronAutoComplete => C4::Context->preference("PatronAutoComplete"),
478 FRBRizeEditions => C4::Context->preference("FRBRizeEditions"),
479 IndependentBranches => C4::Context->preference("IndependentBranches"),
480 IntranetNav => C4::Context->preference("IntranetNav"),
481 IntranetmainUserblock => C4::Context->preference("IntranetmainUserblock"),
482 LibraryName => C4::Context->preference("LibraryName"),
483 advancedMARCEditor => C4::Context->preference("advancedMARCEditor"),
484 canreservefromotherbranches => C4::Context->preference('canreservefromotherbranches'),
485 intranetcolorstylesheet => C4::Context->preference("intranetcolorstylesheet"),
486 IntranetFavicon => C4::Context->preference("IntranetFavicon"),
487 intranetreadinghistory => C4::Context->preference("intranetreadinghistory"),
488 intranetstylesheet => C4::Context->preference("intranetstylesheet"),
489 IntranetUserCSS => C4::Context->preference("IntranetUserCSS"),
490 IntranetUserJS => C4::Context->preference("IntranetUserJS"),
491 virtualshelves => C4::Context->preference("virtualshelves"),
492 StaffSerialIssueDisplayCount => C4::Context->preference("StaffSerialIssueDisplayCount"),
493 EasyAnalyticalRecords => C4::Context->preference('EasyAnalyticalRecords'),
494 LocalCoverImages => C4::Context->preference('LocalCoverImages'),
495 OPACLocalCoverImages => C4::Context->preference('OPACLocalCoverImages'),
496 AllowMultipleCovers => C4::Context->preference('AllowMultipleCovers'),
497 EnableBorrowerFiles => C4::Context->preference('EnableBorrowerFiles'),
498 UseCourseReserves => C4::Context->preference("UseCourseReserves"),
499 useDischarge => C4::Context->preference('useDischarge'),
500 pending_checkout_notes => Koha::Checkouts->search({ noteseen => 0 }),
501 plugins_enabled => C4::Context->config("enable_plugins"),
505 warn "template type should be OPAC, here it is=[" . $in->{'type'} . "]" unless ( $in->{'type'} eq 'opac' );
507 #TODO : replace LibraryName syspref with 'system name', and remove this html processing
508 my $LibraryNameTitle = C4::Context->preference("LibraryName");
509 $LibraryNameTitle =~ s/<(?:\/?)(?:br|p)\s*(?:\/?)>/ /sgi;
510 $LibraryNameTitle =~ s/<(?:[^<>'"]|'(?:[^']*)'|"(?:[^"]*)")*>//sg;
512 # clean up the busc param in the session
513 # if the page is not opac-detail and not the "add to list" page
514 # and not the "edit comments" page
515 if ( C4::Context->preference("OpacBrowseResults")
516 && $in->{'template_name'} =~ /opac-(.+)\.(?:tt|tmpl)$/ ) {
518 unless ( $pagename =~ /^(?:MARC|ISBD)?detail$/
519 or $pagename =~ /^showmarc$/
520 or $pagename =~ /^addbybiblionumber$/
521 or $pagename =~ /^review$/ )
523 my $sessionSearch = get_session( $sessionID );
524 $sessionSearch->clear( ["busc"] ) if $sessionSearch;
528 # variables passed from CGI: opac_css_override and opac_search_limits.
529 my $opac_search_limit = $ENV{'OPAC_SEARCH_LIMIT'};
530 my $opac_limit_override = $ENV{'OPAC_LIMIT_OVERRIDE'};
533 ( $opac_limit_override && $opac_search_limit && $opac_search_limit =~ /branch:([\w-]+)/ ) ||
534 ( $in->{'query'}->param('limit') && $in->{'query'}->param('limit') =~ /branch:([\w-]+)/ ) ||
535 ( $in->{'query'}->param('limit') && $in->{'query'}->param('limit') =~ /multibranchlimit:(\w+)/ )
537 $opac_name = $1; # opac_search_limit is a branch, so we use it.
538 } elsif ( $in->{'query'}->param('multibranchlimit') ) {
539 $opac_name = $in->{'query'}->param('multibranchlimit');
540 } elsif ( C4::Context->preference("SearchMyLibraryFirst") && C4::Context->userenv && C4::Context->userenv->{'branch'} ) {
541 $opac_name = C4::Context->userenv->{'branch'};
544 # Decide if the patron can make suggestions in the OPAC
545 my $can_make_suggestions;
546 if ( C4::Context->preference('Suggestion') && C4::Context->preference('AnonSuggestions') ) {
547 $can_make_suggestions = 1;
548 } elsif ( C4::Context->userenv && C4::Context->userenv->{'number'} ) {
549 $can_make_suggestions = Koha::Patrons->find(C4::Context->userenv->{'number'})->category->can_make_suggestions;
552 my @search_groups = Koha::Library::Groups->get_search_groups({ interface => 'opac' })->as_list;
554 AnonSuggestions => "" . C4::Context->preference("AnonSuggestions"),
555 LibrarySearchGroups => \@search_groups,
556 opac_name => $opac_name,
557 LibraryName => "" . C4::Context->preference("LibraryName"),
558 LibraryNameTitle => "" . $LibraryNameTitle,
559 OPACAmazonCoverImages => C4::Context->preference("OPACAmazonCoverImages"),
560 OPACFRBRizeEditions => C4::Context->preference("OPACFRBRizeEditions"),
561 OpacHighlightedWords => C4::Context->preference("OpacHighlightedWords"),
562 OPACShelfBrowser => "" . C4::Context->preference("OPACShelfBrowser"),
563 OPACURLOpenInNewWindow => "" . C4::Context->preference("OPACURLOpenInNewWindow"),
564 OPACUserCSS => "" . C4::Context->preference("OPACUserCSS"),
565 OpacAuthorities => C4::Context->preference("OpacAuthorities"),
566 opac_css_override => $ENV{'OPAC_CSS_OVERRIDE'},
567 opac_search_limit => $opac_search_limit,
568 opac_limit_override => $opac_limit_override,
569 OpacBrowser => C4::Context->preference("OpacBrowser"),
570 OpacCloud => C4::Context->preference("OpacCloud"),
571 OpacKohaUrl => C4::Context->preference("OpacKohaUrl"),
572 OpacPasswordChange => C4::Context->preference("OpacPasswordChange"),
573 OPACPatronDetails => C4::Context->preference("OPACPatronDetails"),
574 OPACPrivacy => C4::Context->preference("OPACPrivacy"),
575 OPACFinesTab => C4::Context->preference("OPACFinesTab"),
576 OpacTopissue => C4::Context->preference("OpacTopissue"),
577 'Version' => C4::Context->preference('Version'),
578 hidelostitems => C4::Context->preference("hidelostitems"),
579 mylibraryfirst => ( C4::Context->preference("SearchMyLibraryFirst") && C4::Context->userenv ) ? C4::Context->userenv->{'branch'} : '',
580 opacbookbag => "" . C4::Context->preference("opacbookbag"),
581 OpacFavicon => C4::Context->preference("OpacFavicon"),
582 opaclanguagesdisplay => "" . C4::Context->preference("opaclanguagesdisplay"),
583 opacreadinghistory => C4::Context->preference("opacreadinghistory"),
584 OPACUserJS => C4::Context->preference("OPACUserJS"),
585 opacuserlogin => "" . C4::Context->preference("opacuserlogin"),
586 OpenLibrarySearch => C4::Context->preference("OpenLibrarySearch"),
587 ShowReviewer => C4::Context->preference("ShowReviewer"),
588 ShowReviewerPhoto => C4::Context->preference("ShowReviewerPhoto"),
589 suggestion => $can_make_suggestions,
590 virtualshelves => "" . C4::Context->preference("virtualshelves"),
591 OPACSerialIssueDisplayCount => C4::Context->preference("OPACSerialIssueDisplayCount"),
592 SyndeticsClientCode => C4::Context->preference("SyndeticsClientCode"),
593 SyndeticsEnabled => C4::Context->preference("SyndeticsEnabled"),
594 SyndeticsCoverImages => C4::Context->preference("SyndeticsCoverImages"),
595 SyndeticsTOC => C4::Context->preference("SyndeticsTOC"),
596 SyndeticsSummary => C4::Context->preference("SyndeticsSummary"),
597 SyndeticsEditions => C4::Context->preference("SyndeticsEditions"),
598 SyndeticsExcerpt => C4::Context->preference("SyndeticsExcerpt"),
599 SyndeticsReviews => C4::Context->preference("SyndeticsReviews"),
600 SyndeticsAuthorNotes => C4::Context->preference("SyndeticsAuthorNotes"),
601 SyndeticsAwards => C4::Context->preference("SyndeticsAwards"),
602 SyndeticsSeries => C4::Context->preference("SyndeticsSeries"),
603 SyndeticsCoverImageSize => C4::Context->preference("SyndeticsCoverImageSize"),
604 OPACLocalCoverImages => C4::Context->preference("OPACLocalCoverImages"),
605 PatronSelfRegistration => C4::Context->preference("PatronSelfRegistration"),
606 PatronSelfRegistrationDefaultCategory => C4::Context->preference("PatronSelfRegistrationDefaultCategory"),
607 useDischarge => C4::Context->preference('useDischarge'),
610 $template->param( OpacPublic => '1' ) if ( $user || C4::Context->preference("OpacPublic") );
613 # Check if we were asked using parameters to force a specific language
614 if ( defined $in->{'query'}->param('language') ) {
616 # Extract the language, let C4::Languages::getlanguage choose
618 my $language = C4::Languages::getlanguage( $in->{'query'} );
619 my $languagecookie = C4::Templates::getlanguagecookie( $in->{'query'}, $language );
620 $cookie = $cookie_mgr->replace_in_list( $cookie, $languagecookie );
623 return ( $template, $borrowernumber, $cookie, $flags );
628 ($userid, $cookie, $sessionID) = &checkauth($query, $noauth, $flagsrequired, $type);
630 Verifies that the user is authorized to run this script. If
631 the user is authorized, a (userid, cookie, session-id, flags)
632 quadruple is returned. If the user is not authorized but does
633 not have the required privilege (see $flagsrequired below), it
634 displays an error page and exits. Otherwise, it displays the
635 login page and exits.
637 Note that C<&checkauth> will return if and only if the user
638 is authorized, so it should be called early on, before any
639 unfinished operations (e.g., if you've opened a file, then
640 C<&checkauth> won't close it for you).
642 C<$query> is the CGI object for the script calling C<&checkauth>.
644 The C<$noauth> argument is optional. If it is set, then no
645 authorization is required for the script.
647 C<&checkauth> fetches user and session information from C<$query> and
648 ensures that the user is authorized to run scripts that require
651 The C<$flagsrequired> argument specifies the required privileges
652 the user must have if the username and password are correct.
653 It should be specified as a reference-to-hash; keys in the hash
654 should be the "flags" for the user, as specified in the Members
655 intranet module. Any key specified must correspond to a "flag"
656 in the userflags table. E.g., { circulate => 1 } would specify
657 that the user must have the "circulate" privilege in order to
658 proceed. To make sure that access control is correct, the
659 C<$flagsrequired> parameter must be specified correctly.
661 Koha also has a concept of sub-permissions, also known as
662 granular permissions. This makes the value of each key
663 in the C<flagsrequired> hash take on an additional
668 The user must have access to all subfunctions of the module
669 specified by the hash key.
673 The user must have access to at least one subfunction of the module
674 specified by the hash key.
676 specific permission, e.g., 'export_catalog'
678 The user must have access to the specific subfunction list, which
679 must correspond to a row in the permissions table.
681 The C<$type> argument specifies whether the template should be
682 retrieved from the opac or intranet directory tree. "opac" is
683 assumed if it is not specified; however, if C<$type> is specified,
684 "intranet" is assumed if it is not "opac".
686 If C<$query> does not have a valid session ID associated with it
687 (i.e., the user has not logged in) or if the session has expired,
688 C<&checkauth> presents the user with a login page (from the point of
689 view of the original script, C<&checkauth> does not return). Once the
690 user has authenticated, C<&checkauth> restarts the original script
691 (this time, C<&checkauth> returns).
693 The login page is provided using a HTML::Template, which is set in the
694 systempreferences table or at the top of this file. The variable C<$type>
695 selects which template to use, either the opac or the intranet
696 authentification template.
698 C<&checkauth> returns a user ID, a cookie, and a session ID. The
699 cookie should be sent back to the browser; it verifies that the user
709 # If version syspref is unavailable, it means Koha is being installed,
710 # and so we must redirect to OPAC maintenance page or to the WebInstaller
711 # also, if OpacMaintenance is ON, OPAC should redirect to maintenance
712 if ( C4::Context->preference('OpacMaintenance') && $type eq 'opac' ) {
713 warn "OPAC Install required, redirecting to maintenance";
714 print $query->redirect("/cgi-bin/koha/maintenance.pl");
717 unless ( $version = C4::Context->preference('Version') ) { # assignment, not comparison
718 if ( $type ne 'opac' ) {
719 warn "Install required, redirecting to Installer";
720 print $query->redirect("/cgi-bin/koha/installer/install.pl");
722 warn "OPAC Install required, redirecting to maintenance";
723 print $query->redirect("/cgi-bin/koha/maintenance.pl");
728 # check that database and koha version are the same
729 # there is no DB version, it's a fresh install,
730 # go to web installer
731 # there is a DB version, compare it to the code version
732 my $kohaversion = Koha::version();
734 # remove the 3 last . to have a Perl number
735 $kohaversion =~ s/(.*\..*)\.(.*)\.(.*)/$1$2$3/;
736 Koha::Logger->get->debug("kohaversion : $kohaversion");
737 if ( $version < $kohaversion ) {
738 my $warning = "Database update needed, redirecting to %s. Database is $version and Koha is $kohaversion";
739 if ( $type ne 'opac' ) {
740 warn sprintf( $warning, 'Installer' );
741 print $query->redirect("/cgi-bin/koha/installer/install.pl?step=1&op=updatestructure");
743 warn sprintf( "OPAC: " . $warning, 'maintenance' );
744 print $query->redirect("/cgi-bin/koha/maintenance.pl");
750 sub _timeout_syspref {
751 my $default_timeout = 600;
752 my $timeout = C4::Context->preference('timeout') || $default_timeout;
754 # value in days, convert in seconds
755 if ( $timeout =~ /^(\d+)[dD]$/ ) {
756 $timeout = $1 * 86400;
758 # value in hours, convert in seconds
759 elsif ( $timeout =~ /^(\d+)[hH]$/ ) {
760 $timeout = $1 * 3600;
762 elsif ( $timeout !~ m/^\d+$/ ) {
763 warn "The value of the system preference 'timeout' is not correct, defaulting to $default_timeout";
764 $timeout = $default_timeout;
773 # Get shibboleth login attribute
774 my $shib = C4::Context->config('useshibboleth') && shib_ok();
775 my $shib_login = $shib ? get_login_shib() : undef;
777 # $authnotrequired will be set for scripts which will run without authentication
778 my $authnotrequired = shift;
779 my $flagsrequired = shift;
781 my $emailaddress = shift;
782 my $template_name = shift;
783 $type = 'opac' unless $type;
785 if ( $type eq 'opac' && !C4::Context->preference("OpacPublic") ) {
786 my @allowed_scripts_for_private_opac = qw(
788 opac-registration-email-sent.tt
789 opac-registration-confirmation.tt
790 opac-memberentry-update-submitted.tt
791 opac-password-recovery.tt
792 opac-reset-password.tt
794 $authnotrequired = 0 unless grep { $_ eq $template_name }
795 @allowed_scripts_for_private_opac;
798 my $timeout = _timeout_syspref();
800 my $cookie_mgr = Koha::CookieManager->new;
802 _version_check( $type, $query );
806 my $auth_state = 'failed';
808 my ( $userid, $cookie, $sessionID, $flags );
810 my $logout = $query->param('logout.x');
812 my $anon_search_history;
814 # This parameter is the name of the CAS server we want to authenticate against,
815 # when using authentication against multiple CAS servers, as configured in Auth_cas_servers.yaml
816 my $casparam = $query->param('cas');
817 my $q_userid = $query->param('userid') // '';
820 my $invalid_otp_token;
822 ( $type ne "opac" # Only available for the staff interface
823 && C4::Context->preference('TwoFactorAuthentication') ne "disabled" ) # If "enabled" or "enforced"
826 # Basic authentication is incompatible with the use of Shibboleth,
827 # as Shibboleth may return REMOTE_USER as a Shibboleth attribute,
828 # and it may not be the attribute we want to use to match the koha login.
830 # Also, do not consider an empty REMOTE_USER.
832 # Finally, after those tests, we can assume (although if it would be better with
833 # a syspref) that if we get a REMOTE_USER, that's from basic authentication,
834 # and we can affect it to $userid.
835 if ( !$shib and defined( $ENV{'REMOTE_USER'} ) and $ENV{'REMOTE_USER'} ne '' and $userid = $ENV{'REMOTE_USER'} ) {
837 # Using Basic Authentication, no cookies required
838 $cookie = $cookie_mgr->replace_in_list( $cookie, $query->cookie(
839 -name => 'CGISESSID',
842 -secure => ( C4::Context->https_enabled() ? 1 : 0 ),
847 elsif ( $emailaddress) {
848 # the Google OpenID Connect passes an email address
850 elsif ( $sessionID = $query->cookie("CGISESSID") ) { # assignment, not comparison
851 my ( $return, $more_info );
852 # NOTE: $flags in the following call is still undefined !
853 ( $return, $session, $more_info ) = check_cookie_auth( $sessionID, $flags,
854 { remote_addr => $ENV{REMOTE_ADDR}, skip_version_check => 1 }
857 if ( $return eq 'ok' || $return eq 'additional-auth-needed' ) {
858 $userid = $session->param('id');
862 $return eq 'ok' ? 'completed'
863 : $return eq 'additional-auth-needed' ? 'additional-auth-needed'
866 # We are at the second screen if the waiting-for-2FA is set in session
867 # and otp_token param has been passed
869 && $auth_state eq 'additional-auth-needed'
870 && ( my $otp_token = $query->param('otp_token') ) )
872 my $patron = Koha::Patrons->find( { userid => $userid } );
873 my $auth = Koha::Auth::TwoFactorAuth->new( { patron => $patron } );
874 my $verified = $auth->verify($otp_token, 1);
877 # The token is correct, the user is fully logged in!
878 $auth_state = 'completed';
879 $session->param( 'waiting-for-2FA', 0 );
880 $session->param( 'waiting-for-2FA-setup', 0 );
882 # This is an ugly trick to pass the test
883 # $query->param('koha_login_context') && ( $q_userid ne $userid )
888 $invalid_otp_token = 1;
892 if ( $auth_state eq 'completed' ) {
893 Koha::Logger->get->debug(sprintf "AUTH_SESSION: (%s)\t%s %s - %s", map { $session->param($_) || q{} } qw(cardnumber firstname surname branch));
895 if ( ( $query->param('koha_login_context') && ( $q_userid ne $userid ) )
896 || ( $cas && $query->param('ticket') && !C4::Context->userenv->{'id'} )
897 || ( $shib && $shib_login && !$logout && !C4::Context->userenv->{'id'} )
900 #if a user enters an id ne to the id in the current session, we need to log them in...
901 #first we need to clear the anonymous session...
902 $anon_search_history = $session->param('search_history');
905 $cookie = $cookie_mgr->clear_unless( $query->cookie, @$cookie );
906 C4::Context::_unset_userenv($sessionID);
908 undef $userid; # IMPORTANT: this assures us a new session in code below
911 $cookie = $cookie_mgr->replace_in_list( $cookie, $query->cookie(
912 -name => 'CGISESSID',
913 -value => $session->id,
915 -secure => ( C4::Context->https_enabled() ? 1 : 0 ),
919 $flags = haspermission( $userid, $flagsrequired );
921 $auth_state = 'failed';
922 $info{'nopermission'} = 1;
925 } elsif ( !$logout ) {
926 if ( $return eq 'expired' ) {
927 $info{timed_out} = 1;
928 } elsif ( $return eq 'restricted' ) {
929 $info{oldip} = $more_info->{old_ip};
930 $info{newip} = $more_info->{new_ip};
931 $info{different_ip} = 1;
932 } elsif ( $return eq 'password_expired' ) {
933 $info{password_has_expired} = 1;
938 if ( $auth_state eq 'failed' || $logout ) {
945 # voluntary logout the user
946 # check wether the user was using their shibboleth session or a local one
947 my $shibSuccess = C4::Context->userenv ? C4::Context->userenv->{'shibboleth'} : undef;
952 C4::Context::_unset_userenv($sessionID);
953 $cookie = $cookie_mgr->clear_unless( $query->cookie, @$cookie );
955 if ($cas and $caslogout) {
956 logout_cas($query, $type);
959 # If we are in a shibboleth session (shibboleth is enabled, a shibboleth match attribute is set and matches koha matchpoint)
960 if ( $shib and $shib_login and $shibSuccess) {
965 $auth_state = 'logout';
969 #we initiate a session prior to checking for a username to allow for anonymous sessions...
970 if( !$session or !$sessionID ) { # if we cleared sessionID, we need a new session
971 $session = get_session() or die "Auth ERROR: Cannot get_session()";
974 # Save anonymous search history in new session so it can be retrieved
975 # by get_template_and_user to store it in user's search history after
976 # a successful login.
977 if ($anon_search_history) {
978 $session->param( 'search_history', $anon_search_history );
981 $sessionID = $session->id;
982 C4::Context->_new_userenv($sessionID);
983 $cookie = $cookie_mgr->replace_in_list( $cookie, $query->cookie(
984 -name => 'CGISESSID',
985 -value => $sessionID,
987 -secure => ( C4::Context->https_enabled() ? 1 : 0 ),
990 my $pki_field = C4::Context->preference('AllowPKIAuth');
991 if ( !defined($pki_field) ) {
992 print STDERR "ERROR: Missing system preference AllowPKIAuth.\n";
995 if ( ( $cas && $query->param('ticket') )
997 || ( $shib && $shib_login )
998 || $pki_field ne 'None'
1001 my $password = $query->param('password');
1002 my $shibSuccess = 0;
1003 my ( $return, $cardnumber );
1005 # If shib is enabled and we have a shib login, does the login match a valid koha user
1006 if ( $shib && $shib_login ) {
1009 # Do not pass password here, else shib will not be checked in checkpw.
1010 ( $return, $cardnumber, $retuserid ) = checkpw( $q_userid, undef, $query );
1011 $userid = $retuserid;
1012 $shibSuccess = $return;
1013 $info{'invalidShibLogin'} = 1 unless ($return);
1016 # If shib login and match were successful, skip further login methods
1017 unless ($shibSuccess) {
1018 if ( $cas && $query->param('ticket') ) {
1020 ( $return, $cardnumber, $retuserid, $cas_ticket ) =
1021 checkpw( $userid, $password, $query, $type );
1022 $userid = $retuserid;
1023 $info{'invalidCasLogin'} = 1 unless ($return);
1026 elsif ( $emailaddress ) {
1027 my $value = $emailaddress;
1029 # If we're looking up the email, there's a chance that the person
1030 # doesn't have a userid. So if there is none, we pass along the
1031 # borrower number, and the bits of code that need to know the user
1032 # ID will have to be smart enough to handle that.
1033 my $patrons = Koha::Patrons->search({ email => $value });
1034 if ($patrons->count) {
1036 # First the userid, then the borrowernum
1037 my $patron = $patrons->next;
1038 $value = $patron->userid || $patron->borrowernumber;
1042 $return = $value ? 1 : 0;
1047 ( $pki_field eq 'Common Name' && $ENV{'SSL_CLIENT_S_DN_CN'} )
1048 || ( $pki_field eq 'emailAddress'
1049 && $ENV{'SSL_CLIENT_S_DN_Email'} )
1053 if ( $pki_field eq 'Common Name' ) {
1054 $value = $ENV{'SSL_CLIENT_S_DN_CN'};
1056 elsif ( $pki_field eq 'emailAddress' ) {
1057 $value = $ENV{'SSL_CLIENT_S_DN_Email'};
1059 # If we're looking up the email, there's a chance that the person
1060 # doesn't have a userid. So if there is none, we pass along the
1061 # borrower number, and the bits of code that need to know the user
1062 # ID will have to be smart enough to handle that.
1063 my $patrons = Koha::Patrons->search({ email => $value });
1064 if ($patrons->count) {
1066 # First the userid, then the borrowernum
1067 my $patron = $patrons->next;
1068 $value = $patron->userid || $patron->borrowernumber;
1074 $return = $value ? 1 : 0;
1080 my $request_method = $query->request_method // q{};
1083 $request_method eq 'POST'
1084 || ( C4::Context->preference('AutoSelfCheckID')
1085 && $q_userid eq C4::Context->preference('AutoSelfCheckID') )
1089 ( $return, $cardnumber, $retuserid, $cas_ticket ) =
1090 checkpw( $q_userid, $password, $query, $type );
1091 $userid = $retuserid if ($retuserid);
1092 $info{'invalid_username_or_password'} = 1 unless ($return);
1097 # If shib configured and shibOnly enabled, we should ignore anything other than a shibboleth type login.
1104 && C4::Context->preference('OPACShibOnly')
1106 || ( ( $type ne 'opac' )
1107 && C4::Context->preference('staffShibOnly') )
1114 # $return: 1 = valid user
1115 if( $return && $return > 0 ) {
1117 if ( $flags = haspermission( $userid, $flagsrequired ) ) {
1118 $auth_state = "logged_in";
1121 $auth_state = 'failed';
1122 # FIXME We could add $return = 0; or even delete the session?
1123 # Currently return == 1 and we will fill session info later on,
1124 # although we do present an authorization failure. (Yes, the
1125 # authentication was actually correct.)
1126 $info{'nopermission'} = 1;
1127 C4::Context::_unset_userenv($sessionID);
1129 my ( $borrowernumber, $firstname, $surname, $userflags,
1130 $branchcode, $branchname, $emailaddress, $desk_id,
1131 $desk_name, $register_id, $register_name );
1133 if ( $return == 1 ) {
1135 SELECT borrowernumber, firstname, surname, flags, borrowers.branchcode,
1136 branches.branchname as branchname, email
1138 LEFT JOIN branches on borrowers.branchcode=branches.branchcode
1140 my $dbh = C4::Context->dbh;
1141 my $sth = $dbh->prepare("$select where userid=?");
1142 $sth->execute($userid);
1143 unless ( $sth->rows ) {
1144 $sth = $dbh->prepare("$select where cardnumber=?");
1145 $sth->execute($cardnumber);
1147 unless ( $sth->rows ) {
1148 $sth->execute($userid);
1152 ( $borrowernumber, $firstname, $surname, $userflags,
1153 $branchcode, $branchname, $emailaddress ) = $sth->fetchrow;
1156 # launch a sequence to check if we have a ip for the branch, i
1157 # if we have one we replace the branchcode of the userenv by the branch bound in the ip.
1159 my $ip = $ENV{'REMOTE_ADDR'};
1161 # if they specify at login, use that
1162 my $patron = Koha::Patrons->find({userid => $userid});
1163 if ( $query->param('branch') && ( haspermission($userid, { 'loggedinlibrary'=> 1 }) || $patron->is_superlibrarian ) ) {
1164 $branchcode = $query->param('branch');
1165 my $library = Koha::Libraries->find($branchcode);
1166 $branchname = $library? $library->branchname: '';
1168 if ( $query->param('desk_id') ) {
1169 $desk_id = $query->param('desk_id');
1170 my $desk = Koha::Desks->find($desk_id);
1171 $desk_name = $desk ? $desk->desk_name : '';
1173 if ( C4::Context->preference('UseCashRegisters') ) {
1175 $query->param('register_id')
1176 ? Koha::Cash::Registers->find($query->param('register_id'))
1177 : Koha::Cash::Registers->search(
1178 { branch => $branchcode, branch_default => 1 },
1179 { rows => 1 } )->single;
1180 $register_id = $register->id if ($register);
1181 $register_name = $register->name if ($register);
1183 my $branches = { map { $_->branchcode => $_->unblessed } Koha::Libraries->search->as_list };
1184 if ( $type ne 'opac' and C4::Context->preference('AutoLocation') ) {
1186 # we have to check they are coming from the right ip range
1187 my $domain = $branches->{$branchcode}->{'branchip'};
1188 $domain =~ s|\.\*||g;
1189 if ( $ip !~ /^$domain/ ) {
1191 $cookie = $cookie_mgr->replace_in_list( $cookie, $query->cookie(
1192 -name => 'CGISESSID',
1195 -secure => ( C4::Context->https_enabled() ? 1 : 0 ),
1198 $info{'wrongip'} = 1;
1202 foreach my $br ( keys %$branches ) {
1204 # now we work with the treatment of ip
1205 my $domain = $branches->{$br}->{'branchip'};
1206 if ( $domain && $ip =~ /^$domain/ ) {
1207 $branchcode = $branches->{$br}->{'branchcode'};
1209 # new op dev : add the branchname to the cookie
1210 $branchname = $branches->{$br}->{'branchname'};
1214 my $is_sco_user = 0;
1215 if ( $query->param('sco_user_login') && ( $query->param('sco_user_login') eq '1' ) ){
1219 $session->param( 'number', $borrowernumber );
1220 $session->param( 'id', $userid );
1221 $session->param( 'cardnumber', $cardnumber );
1222 $session->param( 'firstname', $firstname );
1223 $session->param( 'surname', $surname );
1224 $session->param( 'branch', $branchcode );
1225 $session->param( 'branchname', $branchname );
1226 $session->param( 'desk_id', $desk_id);
1227 $session->param( 'desk_name', $desk_name);
1228 $session->param( 'flags', $userflags );
1229 $session->param( 'emailaddress', $emailaddress );
1230 $session->param( 'ip', $session->remote_addr() );
1231 $session->param( 'lasttime', time() );
1232 $session->param( 'interface', $type);
1233 $session->param( 'shibboleth', $shibSuccess );
1234 $session->param( 'register_id', $register_id );
1235 $session->param( 'register_name', $register_name );
1236 $session->param( 'sco_user', $is_sco_user );
1238 $session->param('cas_ticket', $cas_ticket) if $cas_ticket;
1239 C4::Context->set_userenv(
1240 $session->param('number'), $session->param('id'),
1241 $session->param('cardnumber'), $session->param('firstname'),
1242 $session->param('surname'), $session->param('branch'),
1243 $session->param('branchname'), $session->param('flags'),
1244 $session->param('emailaddress'), $session->param('shibboleth'),
1245 $session->param('desk_id'), $session->param('desk_name'),
1246 $session->param('register_id'), $session->param('register_name')
1250 # $return: 0 = invalid user
1251 # reset to anonymous session
1254 $info{'invalid_username_or_password'} = 1;
1255 C4::Context::_unset_userenv($sessionID);
1257 $session->param( 'lasttime', time() );
1258 $session->param( 'ip', $session->remote_addr() );
1259 $session->param( 'sessiontype', 'anon' );
1260 $session->param( 'interface', $type);
1262 } # END if ( $q_userid
1263 elsif ( $type eq "opac" ) {
1265 # anonymous sessions are created only for the OPAC
1267 # setting a couple of other session vars...
1268 $session->param( 'ip', $session->remote_addr() );
1269 $session->param( 'lasttime', time() );
1270 $session->param( 'sessiontype', 'anon' );
1271 $session->param( 'interface', $type);
1274 } # END unless ($userid)
1277 if ( $auth_state eq 'logged_in' ) {
1278 $auth_state = 'completed';
1280 # Auth is completed unless an additional auth is needed
1281 if ( $require_2FA ) {
1282 my $patron = Koha::Patrons->find({userid => $userid});
1283 if ( C4::Context->preference('TwoFactorAuthentication') eq "enforced" && $patron->auth_method eq 'password' ) {
1284 $auth_state = 'setup-additional-auth-needed';
1285 $session->param('waiting-for-2FA-setup', 1);
1286 %info = ();# We remove the warnings/errors we may have set incorrectly before
1287 } elsif ( $patron->auth_method eq 'two-factor' ) {
1288 # Ask for the OTP token
1289 $auth_state = 'additional-auth-needed';
1290 $session->param('waiting-for-2FA', 1);
1291 %info = ();# We remove the warnings/errors we may have set incorrectly before
1296 # finished authentification, now respond
1297 if ( $auth_state eq 'completed' || $authnotrequired ) {
1300 $cookie = $cookie_mgr->replace_in_list( $cookie, $query->cookie(
1301 -name => 'CGISESSID',
1304 -secure => ( C4::Context->https_enabled() ? 1 : 0 ),
1309 track_login_daily( $userid );
1311 # In case, that this request was a login attempt, we want to prevent that users can repost the opac login
1312 # request. We therefore redirect the user to the requested page again without the login parameters.
1313 # See Post/Redirect/Get (PRG) design pattern: https://en.wikipedia.org/wiki/Post/Redirect/Get
1314 if ( $type eq "opac" && $query->param('koha_login_context') && $query->param('koha_login_context') ne 'sco' && $query->param('password') && $query->param('userid') ) {
1315 my $uri = URI->new($query->url(-relative=>1, -query_string=>1));
1316 $uri->query_param_delete('userid');
1317 $uri->query_param_delete('password');
1318 $uri->query_param_delete('koha_login_context');
1319 print $query->redirect(-uri => $uri->as_string, -cookie => $cookie, -status=>'303 See other');
1323 return ( $userid, $cookie, $sessionID, $flags );
1328 # AUTH rejected, show the login/password template, after checking the DB.
1332 my $patron = Koha::Patrons->find({ userid => $q_userid }); # Not necessary logged in!
1334 # get the inputs from the incoming query
1336 my @inputs_to_clean = qw( userid password ticket logout.x otp_token );
1337 foreach my $name ( param $query) {
1338 next if grep { $name eq $_ } @inputs_to_clean;
1339 my @value = $query->multi_param($name);
1340 push @inputs, { name => $name, value => $_ } for @value;
1343 my $LibraryNameTitle = C4::Context->preference("LibraryName");
1344 $LibraryNameTitle =~ s/<(?:\/?)(?:br|p)\s*(?:\/?)>/ /sgi;
1345 $LibraryNameTitle =~ s/<(?:[^<>'"]|'(?:[^']*)'|"(?:[^"]*)")*>//sg;
1347 my $auth_template_name = ( $type eq 'opac' ) ? 'opac-auth.tt' : 'auth.tt';
1348 my $auth_error = $query->param('auth_error');
1349 my $template = C4::Templates::gettemplate( $auth_template_name, $type, $query );
1353 script_name => get_script_name(),
1354 casAuthentication => C4::Context->preference("casAuthentication"),
1355 shibbolethAuthentication => $shib,
1356 suggestion => C4::Context->preference("suggestion"),
1357 virtualshelves => C4::Context->preference("virtualshelves"),
1358 LibraryName => "" . C4::Context->preference("LibraryName"),
1359 LibraryNameTitle => "" . $LibraryNameTitle,
1360 opacuserlogin => C4::Context->preference("opacuserlogin"),
1361 OpacFavicon => C4::Context->preference("OpacFavicon"),
1362 opacreadinghistory => C4::Context->preference("opacreadinghistory"),
1363 opaclanguagesdisplay => C4::Context->preference("opaclanguagesdisplay"),
1364 OPACUserJS => C4::Context->preference("OPACUserJS"),
1365 OPACUserCSS => C4::Context->preference("OPACUserCSS"),
1366 intranetcolorstylesheet => C4::Context->preference("intranetcolorstylesheet"),
1367 intranetstylesheet => C4::Context->preference("intranetstylesheet"),
1368 IntranetNav => C4::Context->preference("IntranetNav"),
1369 IntranetFavicon => C4::Context->preference("IntranetFavicon"),
1370 IntranetUserCSS => C4::Context->preference("IntranetUserCSS"),
1371 IntranetUserJS => C4::Context->preference("IntranetUserJS"),
1372 IndependentBranches => C4::Context->preference("IndependentBranches"),
1373 AutoLocation => C4::Context->preference("AutoLocation"),
1374 wrongip => $info{'wrongip'},
1375 PatronSelfRegistration => C4::Context->preference("PatronSelfRegistration"),
1376 PatronSelfRegistrationDefaultCategory => C4::Context->preference("PatronSelfRegistrationDefaultCategory"),
1377 opac_css_override => $ENV{'OPAC_CSS_OVERRIDE'},
1378 too_many_login_attempts => ( $patron and $patron->account_locked ),
1379 password_has_expired => ( $patron and $patron->password_expired ),
1380 auth_error => $auth_error,
1383 $template->param( SCO_login => 1 ) if ( $query->param('sco_user_login') );
1384 $template->param( SCI_login => 1 ) if ( $query->param('sci_user_login') );
1385 $template->param( OpacPublic => C4::Context->preference("OpacPublic") );
1386 $template->param( loginprompt => 1 ) unless $info{'nopermission'};
1387 if ( $auth_state eq 'additional-auth-needed' ) {
1388 my $patron = Koha::Patrons->find( { userid => $userid } );
1391 invalid_otp_token => $invalid_otp_token,
1392 notice_email_address => $patron->notice_email_address, # We could also pass logged_in_user if necessary
1396 if ( $auth_state eq 'setup-additional-auth-needed' ) {
1402 if ( $type eq 'opac' ) {
1403 require Koha::Virtualshelves;
1404 my $some_public_shelves = Koha::Virtualshelves->get_some_shelves(
1410 some_public_shelves => $some_public_shelves,
1416 # Is authentication against multiple CAS servers enabled?
1417 require C4::Auth_with_cas;
1418 if ( multipleAuth() && !$casparam ) {
1419 my $casservers = getMultipleAuth();
1421 foreach my $key ( keys %$casservers ) {
1422 push @tmplservers, { name => $key, value => login_cas_url( $query, $key, $type ) . "?cas=$key" };
1425 casServersLoop => \@tmplservers
1429 casServerUrl => login_cas_url($query, undef, $type),
1434 invalidCasLogin => $info{'invalidCasLogin'}
1439 #If shibOnly is enabled just go ahead and redirect directly
1440 if ( (($type eq 'opac') && C4::Context->preference('OPACShibOnly')) || (($type ne 'opac') && C4::Context->preference('staffShibOnly')) ) {
1441 my $redirect_url = login_shib_url( $query );
1442 print $query->redirect( -uri => "$redirect_url", -status => 303 );
1447 shibbolethAuthentication => $shib,
1448 shibbolethLoginUrl => login_shib_url($query),
1452 if (C4::Context->preference('GoogleOpenIDConnect')) {
1453 if ($query->param("OpenIDConnectFailed")) {
1454 my $reason = $query->param('OpenIDConnectFailed');
1455 $template->param(invalidGoogleOpenIDConnectLogin => $reason);
1460 LibraryName => C4::Context->preference("LibraryName"),
1462 $template->param(%info);
1464 # $cookie = $query->cookie(CGISESSID => $session->id
1466 print $query->header(
1467 { type => 'text/html',
1470 'X-Frame-Options' => 'SAMEORIGIN',
1478 =head2 check_api_auth
1480 ($status, $cookie, $sessionId) = check_api_auth($query, $userflags);
1482 Given a CGI query containing the parameters 'userid' and 'password' and/or a session
1483 cookie, determine if the user has the privileges specified by C<$userflags>.
1485 C<check_api_auth> is is meant for authenticating users of web services, and
1486 consequently will always return and will not attempt to redirect the user
1489 If a valid session cookie is already present, check_api_auth will return a status
1490 of "ok", the cookie, and the Koha session ID.
1492 If no session cookie is present, check_api_auth will check the 'userid' and 'password
1493 parameters and create a session cookie and Koha session if the supplied credentials
1496 Possible return values in C<$status> are:
1500 =item "ok" -- user authenticated; C<$cookie> and C<$sessionid> have valid values.
1502 =item "failed" -- credentials are not correct; C<$cookie> and C<$sessionid> are undef
1504 =item "maintenance" -- DB is in maintenance mode; no login possible at the moment
1506 =item "expired -- session cookie has expired; API user should resubmit userid and password
1508 =item "restricted" -- The IP has changed (if SessionRestrictionByIP)
1510 =item "additional-auth-needed -- User is in an authentication process that is not finished
1516 sub check_api_auth {
1519 my $flagsrequired = shift;
1520 my $timeout = _timeout_syspref();
1522 unless ( C4::Context->preference('Version') ) {
1524 # database has not been installed yet
1525 return ( "maintenance", undef, undef );
1527 my $kohaversion = Koha::version();
1528 $kohaversion =~ s/(.*\..*)\.(.*)\.(.*)/$1$2$3/;
1529 if ( C4::Context->preference('Version') < $kohaversion ) {
1531 # database in need of version update; assume that
1532 # no API should be called while databsae is in
1534 return ( "maintenance", undef, undef );
1537 my ( $sessionID, $session );
1538 unless ( $query->param('userid') ) {
1539 $sessionID = $query->cookie("CGISESSID");
1541 if ( $sessionID && not( $cas && $query->param('PT') ) ) {
1544 ( $return, $session, undef ) = check_cookie_auth(
1545 $sessionID, $flagsrequired, { remote_addr => $ENV{REMOTE_ADDR} } );
1547 return ( $return, undef, undef ) # Cookie auth failed
1550 my $cookie = $query->cookie(
1551 -name => 'CGISESSID',
1552 -value => $session->id,
1554 -secure => ( C4::Context->https_enabled() ? 1 : 0 ),
1557 return ( $return, $cookie, $session ); # return == 'ok' here
1562 my $userid = $query->param('userid');
1563 my $password = $query->param('password');
1564 my ( $return, $cardnumber, $cas_ticket );
1567 if ( $cas && $query->param('PT') ) {
1570 # In case of a CAS authentication, we use the ticket instead of the password
1571 my $PT = $query->param('PT');
1572 ( $return, $cardnumber, $userid, $cas_ticket ) = check_api_auth_cas( $PT, $query ); # EXTERNAL AUTH
1575 # User / password auth
1576 unless ( $userid and $password ) {
1578 # caller did something wrong, fail the authenticateion
1579 return ( "failed", undef, undef );
1582 ( $return, $cardnumber, $newuserid, $cas_ticket ) = checkpw( $userid, $password, $query );
1585 if ( $return and haspermission( $userid, $flagsrequired ) ) {
1586 my $session = get_session("");
1587 return ( "failed", undef, undef ) unless $session;
1589 my $sessionID = $session->id;
1590 C4::Context->_new_userenv($sessionID);
1591 my $cookie = $query->cookie(
1592 -name => 'CGISESSID',
1593 -value => $sessionID,
1595 -secure => ( C4::Context->https_enabled() ? 1 : 0 ),
1598 if ( $return == 1 ) {
1600 $borrowernumber, $firstname, $surname,
1601 $userflags, $branchcode, $branchname,
1604 my $dbh = C4::Context->dbh;
1607 "select borrowernumber, firstname, surname, flags, borrowers.branchcode, branches.branchname as branchname, email from borrowers left join branches on borrowers.branchcode=branches.branchcode where userid=?"
1609 $sth->execute($userid);
1611 $borrowernumber, $firstname, $surname,
1612 $userflags, $branchcode, $branchname,
1614 ) = $sth->fetchrow if ( $sth->rows );
1616 unless ( $sth->rows ) {
1617 my $sth = $dbh->prepare(
1618 "select borrowernumber, firstname, surname, flags, borrowers.branchcode, branches.branchname as branchname, email from borrowers left join branches on borrowers.branchcode=branches.branchcode where cardnumber=?"
1620 $sth->execute($cardnumber);
1622 $borrowernumber, $firstname, $surname,
1623 $userflags, $branchcode, $branchname,
1625 ) = $sth->fetchrow if ( $sth->rows );
1627 unless ( $sth->rows ) {
1628 $sth->execute($userid);
1630 $borrowernumber, $firstname, $surname, $userflags,
1631 $branchcode, $branchname, $emailaddress
1632 ) = $sth->fetchrow if ( $sth->rows );
1636 my $ip = $ENV{'REMOTE_ADDR'};
1638 # if they specify at login, use that
1639 if ( $query->param('branch') ) {
1640 $branchcode = $query->param('branch');
1641 my $library = Koha::Libraries->find($branchcode);
1642 $branchname = $library? $library->branchname: '';
1644 my $branches = { map { $_->branchcode => $_->unblessed } Koha::Libraries->search->as_list };
1645 foreach my $br ( keys %$branches ) {
1647 # now we work with the treatment of ip
1648 my $domain = $branches->{$br}->{'branchip'};
1649 if ( $domain && $ip =~ /^$domain/ ) {
1650 $branchcode = $branches->{$br}->{'branchcode'};
1652 # new op dev : add the branchname to the cookie
1653 $branchname = $branches->{$br}->{'branchname'};
1656 $session->param( 'number', $borrowernumber );
1657 $session->param( 'id', $userid );
1658 $session->param( 'cardnumber', $cardnumber );
1659 $session->param( 'firstname', $firstname );
1660 $session->param( 'surname', $surname );
1661 $session->param( 'branch', $branchcode );
1662 $session->param( 'branchname', $branchname );
1663 $session->param( 'flags', $userflags );
1664 $session->param( 'emailaddress', $emailaddress );
1665 $session->param( 'ip', $session->remote_addr() );
1666 $session->param( 'lasttime', time() );
1667 $session->param( 'interface', 'api' );
1669 $session->param( 'cas_ticket', $cas_ticket);
1670 C4::Context->set_userenv(
1671 $session->param('number'), $session->param('id'),
1672 $session->param('cardnumber'), $session->param('firstname'),
1673 $session->param('surname'), $session->param('branch'),
1674 $session->param('branchname'), $session->param('flags'),
1675 $session->param('emailaddress'), $session->param('shibboleth'),
1676 $session->param('desk_id'), $session->param('desk_name'),
1677 $session->param('register_id'), $session->param('register_name')
1679 return ( "ok", $cookie, $sessionID );
1681 return ( "failed", undef, undef );
1686 =head2 check_cookie_auth
1688 ($status, $sessionId) = check_cookie_auth($cookie, $userflags);
1690 Given a CGISESSID cookie set during a previous login to Koha, determine
1691 if the user has the privileges specified by C<$userflags>. C<$userflags>
1692 is passed unaltered into C<haspermission> and as such accepts all options
1693 avaiable to that routine with the one caveat that C<check_api_auth> will
1694 also allow 'undef' to be passed and in such a case the permissions check
1695 will be skipped altogether.
1697 C<check_cookie_auth> is meant for authenticating special services
1698 such as tools/upload-file.pl that are invoked by other pages that
1699 have been authenticated in the usual way.
1701 Possible return values in C<$status> are:
1705 =item "ok" -- user authenticated; C<$sessionID> have valid values.
1707 =item "anon" -- user not authenticated but valid for anonymous session.
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
1715 =item "restricted" -- The IP has changed (if SessionRestrictionByIP)
1721 sub check_cookie_auth {
1722 my $sessionID = shift;
1723 my $flagsrequired = shift;
1726 my $remote_addr = $params->{remote_addr} || $ENV{REMOTE_ADDR};
1728 my $skip_version_check = $params->{skip_version_check}; # Only for checkauth
1730 unless ( $skip_version_check ) {
1731 unless ( C4::Context->preference('Version') ) {
1733 # database has not been installed yet
1734 return ( "maintenance", undef );
1736 my $kohaversion = Koha::version();
1737 $kohaversion =~ s/(.*\..*)\.(.*)\.(.*)/$1$2$3/;
1738 if ( C4::Context->preference('Version') < $kohaversion ) {
1740 # database in need of version update; assume that
1741 # no API should be called while databsae is in
1743 return ( "maintenance", undef );
1747 # see if we have a valid session cookie already
1748 # however, if a userid parameter is present (i.e., from
1749 # a form submission, assume that any current cookie
1751 unless ( $sessionID ) {
1752 return ( "failed", undef );
1754 C4::Context::_unset_userenv($sessionID); # remove old userenv first
1755 my $session = get_session($sessionID);
1757 my $userid = $session->param('id');
1758 my $ip = $session->param('ip');
1759 my $lasttime = $session->param('lasttime');
1760 my $timeout = _timeout_syspref();
1762 if ( !$lasttime || ( $lasttime < time() - $timeout ) ) {
1766 return ("expired", undef);
1768 } elsif ( C4::Context->preference('SessionRestrictionByIP') && $ip ne $remote_addr ) {
1769 # IP address changed
1772 return ( "restricted", undef, { old_ip => $ip, new_ip => $remote_addr});
1774 } elsif ( $userid ) {
1775 $session->param( 'lasttime', time() );
1776 my $patron = Koha::Patrons->find({ userid => $userid });
1778 # If the user modify their own userid
1779 # Better than 500 but we could do better
1780 unless ( $patron ) {
1783 return ("expired", undef);
1786 $patron = Koha::Patrons->find({ cardnumber => $userid })
1788 return ("password_expired", undef ) if $patron->password_expired;
1789 my $flags = defined($flagsrequired) ? haspermission( $userid, $flagsrequired ) : 1;
1791 C4::Context->_new_userenv($sessionID);
1792 if ( !C4::Context->interface ) {
1793 # No need to override the interface, most often set by get_template_and_user
1794 C4::Context->interface( $session->param('interface') );
1796 C4::Context->set_userenv(
1797 $session->param('number'), $session->param('id') // '',
1798 $session->param('cardnumber'), $session->param('firstname'),
1799 $session->param('surname'), $session->param('branch'),
1800 $session->param('branchname'), $session->param('flags'),
1801 $session->param('emailaddress'), $session->param('shibboleth'),
1802 $session->param('desk_id'), $session->param('desk_name'),
1803 $session->param('register_id'), $session->param('register_name')
1805 if ( C4::Context->preference('TwoFactorAuthentication') ne 'disabled' ) {
1806 return ( "additional-auth-needed", $session )
1807 if $session->param('waiting-for-2FA');
1809 return ( "setup-additional-auth-needed", $session )
1810 if $session->param('waiting-for-2FA-setup');
1813 return ( "ok", $session );
1817 return ( "failed", undef );
1821 C4::Context->_new_userenv($sessionID);
1822 C4::Context->interface($session->param('interface'));
1823 C4::Context->set_userenv( undef, q{} );
1824 return ( "anon", $session );
1827 return ( "expired", undef );
1834 my $session = get_session($sessionID);
1836 Given a session ID, retrieve the CGI::Session object used to store
1837 the session's state. The session object can be used to store
1838 data that needs to be accessed by different scripts during a
1841 If the C<$sessionID> parameter is an empty string, a new session
1846 sub _get_session_params {
1847 my $storage_method = C4::Context->preference('SessionStorage');
1848 if ( $storage_method eq 'mysql' ) {
1849 my $dbh = C4::Context->dbh;
1850 return { dsn => "serializer:yamlxs;driver:MySQL;id:md5", dsn_args => { Handle => $dbh } };
1852 elsif ( $storage_method eq 'Pg' ) {
1853 my $dbh = C4::Context->dbh;
1854 return { dsn => "serializer:yamlxs;driver:PostgreSQL;id:md5", dsn_args => { Handle => $dbh } };
1856 elsif ( $storage_method eq 'memcached' && Koha::Caches->get_instance->memcached_cache ) {
1857 my $memcached = Koha::Caches->get_instance()->memcached_cache;
1858 return { dsn => "serializer:yamlxs;driver:memcached;id:md5", dsn_args => { Memcached => $memcached } };
1861 # catch all defaults to tmp should work on all systems
1862 my $dir = C4::Context::temporary_directory;
1863 my $instance = C4::Context->config( 'database' ); #actually for packages not exactly the instance name, but generally safer to leave it as it is
1864 return { dsn => "serializer:yamlxs;driver:File;id:md5", dsn_args => { Directory => "$dir/cgisess_$instance" } };
1869 my $sessionID = shift;
1870 my $params = _get_session_params();
1872 if( $sessionID ) { # find existing
1873 CGI::Session::ErrorHandler->set_error( q{} ); # clear error, cpan issue #111463
1874 $session = CGI::Session->load( $params->{dsn}, $sessionID, $params->{dsn_args} );
1876 $session = CGI::Session->new( $params->{dsn}, $sessionID, $params->{dsn_args} );
1877 # no need to flush here
1882 =head2 create_basic_session
1884 my $session = create_basic_session({ patron => $patron, interface => $interface });
1886 Creates a session and adds all basic parameters for a session to work
1890 sub create_basic_session {
1892 my $patron = $params->{patron};
1893 my $interface = $params->{interface};
1895 $interface = 'intranet' if $interface eq 'staff';
1897 my $session = get_session("");
1899 $session->param( 'number', $patron->borrowernumber );
1900 $session->param( 'id', $patron->userid );
1901 $session->param( 'cardnumber', $patron->cardnumber );
1902 $session->param( 'firstname', $patron->firstname );
1903 $session->param( 'surname', $patron->surname );
1904 $session->param( 'branch', $patron->branchcode );
1905 $session->param( 'branchname', $patron->library->branchname );
1906 $session->param( 'flags', $patron->flags );
1907 $session->param( 'emailaddress', $patron->email );
1908 $session->param( 'ip', $session->remote_addr() );
1909 $session->param( 'lasttime', time() );
1910 $session->param( 'interface', $interface);
1916 # FIXME no_set_userenv may be replaced with force_branchcode_for_userenv
1917 # (or something similar)
1918 # Currently it's only passed from C4::SIP::ILS::Patron::check_password, but
1919 # not having a userenv defined could cause a crash.
1921 my ( $userid, $password, $query, $type, $no_set_userenv ) = @_;
1922 $type = 'opac' unless $type;
1924 # Get shibboleth login attribute
1925 my $shib = C4::Context->config('useshibboleth') && shib_ok();
1926 my $shib_login = $shib ? get_login_shib() : undef;
1930 if ( defined $userid ){
1931 $patron = Koha::Patrons->find({ userid => $userid });
1932 $patron = Koha::Patrons->find({ cardnumber => $userid }) unless $patron;
1934 my $check_internal_as_fallback = 0;
1936 # Note: checkpw_* routines returns:
1939 # -1 if user bind failed (LDAP only)
1941 if ( $patron and ( $patron->account_locked ) ) {
1942 # Nothing to check, account is locked
1943 } elsif ($ldap && defined($password)) {
1944 my ( $retval, $retcard, $retuserid ) = checkpw_ldap(@_); # EXTERNAL AUTH
1945 if ( $retval == 1 ) {
1946 @return = ( $retval, $retcard, $retuserid );
1949 $check_internal_as_fallback = 1 if $retval == 0;
1951 } elsif ( $cas && $query && $query->param('ticket') ) {
1953 # In case of a CAS authentication, we use the ticket instead of the password
1954 my $ticket = $query->param('ticket');
1955 $query->delete('ticket'); # remove ticket to come back to original URL
1956 my ( $retval, $retcard, $retuserid, $cas_ticket ) = checkpw_cas( $ticket, $query, $type ); # EXTERNAL AUTH
1958 @return = ( $retval, $retcard, $retuserid, $cas_ticket );
1962 $passwd_ok = $retval;
1965 # If we are in a shibboleth session (shibboleth is enabled, and a shibboleth match attribute is present)
1966 # Check for password to asertain whether we want to be testing against shibboleth or another method this
1968 elsif ( $shib && $shib_login && !$password ) {
1970 # In case of a Shibboleth authentication, we expect a shibboleth user attribute
1971 # (defined under shibboleth mapping in koha-conf.xml) to contain the login of the
1972 # shibboleth-authenticated user
1974 # Then, we check if it matches a valid koha user
1976 my ( $retval, $retcard, $retuserid ) = C4::Auth_with_shibboleth::checkpw_shib($shib_login); # EXTERNAL AUTH
1978 @return = ( $retval, $retcard, $retuserid );
1980 $passwd_ok = $retval;
1983 $check_internal_as_fallback = 1;
1987 if ( $check_internal_as_fallback ) {
1988 @return = checkpw_internal( $userid, $password, $no_set_userenv);
1989 $passwd_ok = 1 if $return[0] > 0; # 1 or 2
1994 $patron->update({ login_attempts => 0 });
1995 if( $patron->password_expired ){
1998 } elsif( !$patron->account_locked ) {
1999 $patron->update({ login_attempts => $patron->login_attempts + 1 });
2003 # Optionally log success or failure
2004 if( $patron && $passwd_ok && C4::Context->preference('AuthSuccessLog') ) {
2005 logaction( 'AUTH', 'SUCCESS', $patron->id, "Valid password for $userid", $type );
2006 } elsif( !$passwd_ok && C4::Context->preference('AuthFailureLog') ) {
2007 logaction( 'AUTH', 'FAILURE', $patron ? $patron->id : 0, "Wrong password for $userid", $type );
2013 sub checkpw_internal {
2014 my ( $userid, $password, $no_set_userenv ) = @_;
2016 $password = Encode::encode( 'UTF-8', $password )
2017 if Encode::is_utf8($password);
2019 my $dbh = C4::Context->dbh;
2022 "select password,cardnumber,borrowernumber,userid,firstname,surname,borrowers.branchcode,branches.branchname,flags from borrowers join branches on borrowers.branchcode=branches.branchcode where userid=?"
2024 $sth->execute($userid);
2026 my ( $stored_hash, $cardnumber, $borrowernumber, $userid, $firstname,
2027 $surname, $branchcode, $branchname, $flags )
2030 if ( checkpw_hash( $password, $stored_hash ) ) {
2032 C4::Context->set_userenv( "$borrowernumber", $userid, $cardnumber,
2033 $firstname, $surname, $branchcode, $branchname, $flags ) unless $no_set_userenv;
2034 return 1, $cardnumber, $userid;
2039 "select password,cardnumber,borrowernumber,userid,firstname,surname,borrowers.branchcode,branches.branchname,flags from borrowers join branches on borrowers.branchcode=branches.branchcode where cardnumber=?"
2041 $sth->execute($userid);
2043 my ( $stored_hash, $cardnumber, $borrowernumber, $userid, $firstname,
2044 $surname, $branchcode, $branchname, $flags )
2047 if ( checkpw_hash( $password, $stored_hash ) ) {
2049 C4::Context->set_userenv( $borrowernumber, $userid, $cardnumber,
2050 $firstname, $surname, $branchcode, $branchname, $flags ) unless $no_set_userenv;
2051 return 1, $cardnumber, $userid;
2058 my ( $password, $stored_hash ) = @_;
2060 return if $stored_hash eq '!';
2062 # check what encryption algorithm was implemented: Bcrypt - if the hash starts with '$2' it is Bcrypt else md5
2064 if ( substr( $stored_hash, 0, 2 ) eq '$2' ) {
2065 $hash = hash_password( $password, $stored_hash );
2067 $hash = md5_base64($password);
2069 return $hash eq $stored_hash;
2074 my $authflags = getuserflags($flags, $userid, [$dbh]);
2076 Translates integer flags into permissions strings hash.
2078 C<$flags> is the integer userflags value ( borrowers.userflags )
2079 C<$userid> is the members.userid, used for building subpermissions
2080 C<$authflags> is a hashref of permissions
2087 my $dbh = @_ ? shift : C4::Context->dbh;
2090 # I don't want to do this, but if someone logs in as the database
2091 # user, it would be preferable not to spam them to death with
2092 # numeric warnings. So, we make $flags numeric.
2093 no warnings 'numeric';
2096 my $sth = $dbh->prepare("SELECT bit, flag, defaulton FROM userflags");
2099 while ( my ( $bit, $flag, $defaulton ) = $sth->fetchrow ) {
2100 if ( ( $flags & ( 2**$bit ) ) || $defaulton ) {
2101 $userflags->{$flag} = 1;
2104 $userflags->{$flag} = 0;
2108 # get subpermissions and merge with top-level permissions
2109 my $user_subperms = get_user_subpermissions($userid);
2110 foreach my $module ( keys %$user_subperms ) {
2111 next if $userflags->{$module} == 1; # user already has permission for everything in this module
2112 $userflags->{$module} = $user_subperms->{$module};
2118 =head2 get_user_subpermissions
2120 $user_perm_hashref = get_user_subpermissions($userid);
2122 Given the userid (note, not the borrowernumber) of a staff user,
2123 return a hashref of hashrefs of the specific subpermissions
2124 accorded to the user. An example return is
2128 export_catalog => 1,
2129 import_patrons => 1,
2133 The top-level hash-key is a module or function code from
2134 userflags.flag, while the second-level key is a code
2137 The results of this function do not give a complete picture
2138 of the functions that a staff user can access; it is also
2139 necessary to check borrowers.flags.
2143 sub get_user_subpermissions {
2146 my $dbh = C4::Context->dbh;
2147 my $sth = $dbh->prepare( "SELECT flag, user_permissions.code
2148 FROM user_permissions
2149 JOIN permissions USING (module_bit, code)
2150 JOIN userflags ON (module_bit = bit)
2151 JOIN borrowers USING (borrowernumber)
2152 WHERE userid = ?" );
2153 $sth->execute($userid);
2155 my $user_perms = {};
2156 while ( my $perm = $sth->fetchrow_hashref ) {
2157 $user_perms->{ $perm->{'flag'} }->{ $perm->{'code'} } = 1;
2162 =head2 get_all_subpermissions
2164 my $perm_hashref = get_all_subpermissions();
2166 Returns a hashref of hashrefs defining all specific
2167 permissions currently defined. The return value
2168 has the same structure as that of C<get_user_subpermissions>,
2169 except that the innermost hash value is the description
2170 of the subpermission.
2174 sub get_all_subpermissions {
2175 my $dbh = C4::Context->dbh;
2176 my $sth = $dbh->prepare( "SELECT flag, code
2178 JOIN userflags ON (module_bit = bit)" );
2182 while ( my $perm = $sth->fetchrow_hashref ) {
2183 $all_perms->{ $perm->{'flag'} }->{ $perm->{'code'} } = 1;
2188 =head2 haspermission
2190 $flagsrequired = '*'; # Any permission at all
2191 $flagsrequired = 'a_flag'; # a_flag must be satisfied (all subpermissions)
2192 $flagsrequired = [ 'a_flag', 'b_flag' ]; # a_flag OR b_flag must be satisfied
2193 $flagsrequired = { 'a_flag => 1, 'b_flag' => 1 }; # a_flag AND b_flag must be satisfied
2194 $flagsrequired = { 'a_flag' => 'sub_a' }; # sub_a of a_flag must be satisfied
2195 $flagsrequired = { 'a_flag' => [ 'sub_a, 'sub_b' ] }; # sub_a OR sub_b of a_flag must be satisfied
2197 $flags = ($userid, $flagsrequired);
2199 C<$userid> the userid of the member
2200 C<$flags> is a query structure similar to that used by SQL::Abstract that
2201 denotes the combination of flags required. It is a required parameter.
2203 The main logic of this method is that things in arrays are OR'ed, and things
2204 in hashes are AND'ed. The `*` character can be used, at any depth, to denote `ANY`
2206 Returns member's flags or 0 if a permission is not met.
2211 my ($required, $flags) = @_;
2213 my $ref = ref($required);
2215 if ($required eq '*') {
2216 return 0 unless ( $flags or ref( $flags ) );
2218 return 0 unless ( $flags and (!ref( $flags ) || $flags->{$required} ));
2220 } elsif ($ref eq 'HASH') {
2221 foreach my $key (keys %{$required}) {
2222 next if $flags == 1;
2223 my $require = $required->{$key};
2224 my $rflags = $flags->{$key};
2225 return 0 unless _dispatch($require, $rflags);
2227 } elsif ($ref eq 'ARRAY') {
2229 foreach my $require ( @{$required} ) {
2231 ( ref($flags) && !ref($require) && ( $require ne '*' ) )
2232 ? $flags->{$require}
2234 $satisfied++ if _dispatch( $require, $rflags );
2236 return 0 unless $satisfied;
2238 croak "Unexpected structure found: $ref";
2245 my ( $userid, $flagsrequired ) = @_;
2247 #Koha::Exceptions::WrongParameter->throw('$flagsrequired should not be undef')
2248 # unless defined($flagsrequired);
2250 my $sth = C4::Context->dbh->prepare("SELECT flags FROM borrowers WHERE userid=?");
2251 $sth->execute($userid);
2252 my $row = $sth->fetchrow();
2253 my $flags = getuserflags( $row, $userid );
2255 return $flags unless defined($flagsrequired);
2256 return $flags if $flags->{superlibrarian};
2257 return _dispatch($flagsrequired, $flags);
2259 #FIXME - This fcn should return the failed permission so a suitable error msg can be delivered.
2264 $flags = ($iprange);
2266 C<$iprange> A space separated string describing an IP range. Can include single IPs or ranges
2268 Returns 1 if the remote address is in the provided iprange, or 0 otherwise.
2275 my @allowedipranges = $iprange ? split(' ', $iprange) : ();
2276 if (scalar @allowedipranges > 0) {
2278 eval { @rangelist = Net::CIDR::range2cidr(@allowedipranges); }; return 0 if $@;
2279 eval { $result = Net::CIDR::cidrlookup($ENV{'REMOTE_ADDR'}, @rangelist) } || Koha::Logger->get->warn('cidrlookup failed for ' . join(' ',@rangelist) );
2281 return $result ? 1 : 0;
2284 sub getborrowernumber {
2286 my $userenv = C4::Context->userenv;
2287 if ( defined($userenv) && ref($userenv) eq 'HASH' && $userenv->{number} ) {
2288 return $userenv->{number};
2290 my $dbh = C4::Context->dbh;
2291 for my $field ( 'userid', 'cardnumber' ) {
2293 $dbh->prepare("select borrowernumber from borrowers where $field=?");
2294 $sth->execute($userid);
2296 my ($bnumber) = $sth->fetchrow;
2303 =head2 track_login_daily
2305 track_login_daily( $userid );
2307 Wraps the call to $patron->track_login, the method used to update borrowers.lastseen. We only call track_login once a day.
2311 sub track_login_daily {
2313 return if !$userid || !C4::Context->preference('TrackLastPatronActivity');
2315 my $cache = Koha::Caches->get_instance();
2316 my $cache_key = "track_login_" . $userid;
2317 my $cached = $cache->get_from_cache($cache_key);
2318 my $today = dt_from_string()->ymd;
2319 return if $cached && $cached eq $today;
2321 my $patron = Koha::Patrons->find({ userid => $userid });
2322 return unless $patron;
2323 $patron->track_login;
2324 $cache->set_in_cache( $cache_key, $today );
2327 END { } # module clean-up code here (global destructor)
2337 Crypt::Eksblowfish::Bcrypt(3)