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_cataloguing_page_permissions 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" ) {
476 can_see_cataloguing_module => haspermission( $user, get_cataloguing_page_permissions() ) ? 1 : 0,
477 AmazonCoverImages => C4::Context->preference("AmazonCoverImages"),
478 AutoLocation => C4::Context->preference("AutoLocation"),
479 PatronAutoComplete => C4::Context->preference("PatronAutoComplete"),
480 FRBRizeEditions => C4::Context->preference("FRBRizeEditions"),
481 IndependentBranches => C4::Context->preference("IndependentBranches"),
482 IntranetNav => C4::Context->preference("IntranetNav"),
483 IntranetmainUserblock => C4::Context->preference("IntranetmainUserblock"),
484 LibraryName => C4::Context->preference("LibraryName"),
485 advancedMARCEditor => C4::Context->preference("advancedMARCEditor"),
486 canreservefromotherbranches => C4::Context->preference('canreservefromotherbranches'),
487 intranetcolorstylesheet => C4::Context->preference("intranetcolorstylesheet"),
488 IntranetFavicon => C4::Context->preference("IntranetFavicon"),
489 intranetreadinghistory => C4::Context->preference("intranetreadinghistory"),
490 intranetstylesheet => C4::Context->preference("intranetstylesheet"),
491 IntranetUserCSS => C4::Context->preference("IntranetUserCSS"),
492 IntranetUserJS => C4::Context->preference("IntranetUserJS"),
493 virtualshelves => C4::Context->preference("virtualshelves"),
494 StaffSerialIssueDisplayCount => C4::Context->preference("StaffSerialIssueDisplayCount"),
495 EasyAnalyticalRecords => C4::Context->preference('EasyAnalyticalRecords'),
496 LocalCoverImages => C4::Context->preference('LocalCoverImages'),
497 OPACLocalCoverImages => C4::Context->preference('OPACLocalCoverImages'),
498 AllowMultipleCovers => C4::Context->preference('AllowMultipleCovers'),
499 EnableBorrowerFiles => C4::Context->preference('EnableBorrowerFiles'),
500 UseCourseReserves => C4::Context->preference("UseCourseReserves"),
501 useDischarge => C4::Context->preference('useDischarge'),
502 pending_checkout_notes => Koha::Checkouts->search({ noteseen => 0 }),
503 plugins_enabled => C4::Context->config("enable_plugins"),
507 warn "template type should be OPAC, here it is=[" . $in->{'type'} . "]" unless ( $in->{'type'} eq 'opac' );
509 #TODO : replace LibraryName syspref with 'system name', and remove this html processing
510 my $LibraryNameTitle = C4::Context->preference("LibraryName");
511 $LibraryNameTitle =~ s/<(?:\/?)(?:br|p)\s*(?:\/?)>/ /sgi;
512 $LibraryNameTitle =~ s/<(?:[^<>'"]|'(?:[^']*)'|"(?:[^"]*)")*>//sg;
514 # clean up the busc param in the session
515 # if the page is not opac-detail and not the "add to list" page
516 # and not the "edit comments" page
517 if ( C4::Context->preference("OpacBrowseResults")
518 && $in->{'template_name'} =~ /opac-(.+)\.(?:tt|tmpl)$/ ) {
520 unless ( $pagename =~ /^(?:MARC|ISBD)?detail$/
521 or $pagename =~ /^showmarc$/
522 or $pagename =~ /^addbybiblionumber$/
523 or $pagename =~ /^review$/ )
525 my $sessionSearch = get_session( $sessionID );
526 $sessionSearch->clear( ["busc"] ) if $sessionSearch;
530 # variables passed from CGI: opac_css_override and opac_search_limits.
531 my $opac_search_limit = $ENV{'OPAC_SEARCH_LIMIT'};
532 my $opac_limit_override = $ENV{'OPAC_LIMIT_OVERRIDE'};
535 ( $opac_limit_override && $opac_search_limit && $opac_search_limit =~ /branch:([\w-]+)/ ) ||
536 ( $in->{'query'}->param('limit') && $in->{'query'}->param('limit') =~ /branch:([\w-]+)/ ) ||
537 ( $in->{'query'}->param('limit') && $in->{'query'}->param('limit') =~ /multibranchlimit:(\w+)/ )
539 $opac_name = $1; # opac_search_limit is a branch, so we use it.
540 } elsif ( $in->{'query'}->param('multibranchlimit') ) {
541 $opac_name = $in->{'query'}->param('multibranchlimit');
542 } elsif ( C4::Context->preference("SearchMyLibraryFirst") && C4::Context->userenv && C4::Context->userenv->{'branch'} ) {
543 $opac_name = C4::Context->userenv->{'branch'};
546 # Decide if the patron can make suggestions in the OPAC
547 my $can_make_suggestions;
548 if ( C4::Context->preference('Suggestion') && C4::Context->preference('AnonSuggestions') ) {
549 $can_make_suggestions = 1;
550 } elsif ( C4::Context->userenv && C4::Context->userenv->{'number'} ) {
551 $can_make_suggestions = Koha::Patrons->find(C4::Context->userenv->{'number'})->category->can_make_suggestions;
554 my @search_groups = Koha::Library::Groups->get_search_groups({ interface => 'opac' })->as_list;
556 AnonSuggestions => "" . C4::Context->preference("AnonSuggestions"),
557 LibrarySearchGroups => \@search_groups,
558 opac_name => $opac_name,
559 LibraryName => "" . C4::Context->preference("LibraryName"),
560 LibraryNameTitle => "" . $LibraryNameTitle,
561 OPACAmazonCoverImages => C4::Context->preference("OPACAmazonCoverImages"),
562 OPACFRBRizeEditions => C4::Context->preference("OPACFRBRizeEditions"),
563 OpacHighlightedWords => C4::Context->preference("OpacHighlightedWords"),
564 OPACShelfBrowser => "" . C4::Context->preference("OPACShelfBrowser"),
565 OPACURLOpenInNewWindow => "" . C4::Context->preference("OPACURLOpenInNewWindow"),
566 OPACUserCSS => "" . C4::Context->preference("OPACUserCSS"),
567 OpacAuthorities => C4::Context->preference("OpacAuthorities"),
568 opac_css_override => $ENV{'OPAC_CSS_OVERRIDE'},
569 opac_search_limit => $opac_search_limit,
570 opac_limit_override => $opac_limit_override,
571 OpacBrowser => C4::Context->preference("OpacBrowser"),
572 OpacCloud => C4::Context->preference("OpacCloud"),
573 OpacKohaUrl => C4::Context->preference("OpacKohaUrl"),
574 OpacPasswordChange => C4::Context->preference("OpacPasswordChange"),
575 OPACPatronDetails => C4::Context->preference("OPACPatronDetails"),
576 OPACPrivacy => C4::Context->preference("OPACPrivacy"),
577 OPACFinesTab => C4::Context->preference("OPACFinesTab"),
578 OpacTopissue => C4::Context->preference("OpacTopissue"),
579 'Version' => C4::Context->preference('Version'),
580 hidelostitems => C4::Context->preference("hidelostitems"),
581 mylibraryfirst => ( C4::Context->preference("SearchMyLibraryFirst") && C4::Context->userenv ) ? C4::Context->userenv->{'branch'} : '',
582 opacbookbag => "" . C4::Context->preference("opacbookbag"),
583 OpacFavicon => C4::Context->preference("OpacFavicon"),
584 opaclanguagesdisplay => "" . C4::Context->preference("opaclanguagesdisplay"),
585 opacreadinghistory => C4::Context->preference("opacreadinghistory"),
586 OPACUserJS => C4::Context->preference("OPACUserJS"),
587 opacuserlogin => "" . C4::Context->preference("opacuserlogin"),
588 OpenLibrarySearch => C4::Context->preference("OpenLibrarySearch"),
589 ShowReviewer => C4::Context->preference("ShowReviewer"),
590 ShowReviewerPhoto => C4::Context->preference("ShowReviewerPhoto"),
591 suggestion => $can_make_suggestions,
592 virtualshelves => "" . C4::Context->preference("virtualshelves"),
593 OPACSerialIssueDisplayCount => C4::Context->preference("OPACSerialIssueDisplayCount"),
594 SyndeticsClientCode => C4::Context->preference("SyndeticsClientCode"),
595 SyndeticsEnabled => C4::Context->preference("SyndeticsEnabled"),
596 SyndeticsCoverImages => C4::Context->preference("SyndeticsCoverImages"),
597 SyndeticsTOC => C4::Context->preference("SyndeticsTOC"),
598 SyndeticsSummary => C4::Context->preference("SyndeticsSummary"),
599 SyndeticsEditions => C4::Context->preference("SyndeticsEditions"),
600 SyndeticsExcerpt => C4::Context->preference("SyndeticsExcerpt"),
601 SyndeticsReviews => C4::Context->preference("SyndeticsReviews"),
602 SyndeticsAuthorNotes => C4::Context->preference("SyndeticsAuthorNotes"),
603 SyndeticsAwards => C4::Context->preference("SyndeticsAwards"),
604 SyndeticsSeries => C4::Context->preference("SyndeticsSeries"),
605 SyndeticsCoverImageSize => C4::Context->preference("SyndeticsCoverImageSize"),
606 OPACLocalCoverImages => C4::Context->preference("OPACLocalCoverImages"),
607 PatronSelfRegistration => C4::Context->preference("PatronSelfRegistration"),
608 PatronSelfRegistrationDefaultCategory => C4::Context->preference("PatronSelfRegistrationDefaultCategory"),
609 useDischarge => C4::Context->preference('useDischarge'),
612 $template->param( OpacPublic => '1' ) if ( $user || C4::Context->preference("OpacPublic") );
615 # Check if we were asked using parameters to force a specific language
616 if ( defined $in->{'query'}->param('language') ) {
618 # Extract the language, let C4::Languages::getlanguage choose
620 my $language = C4::Languages::getlanguage( $in->{'query'} );
621 my $languagecookie = C4::Templates::getlanguagecookie( $in->{'query'}, $language );
622 $cookie = $cookie_mgr->replace_in_list( $cookie, $languagecookie );
625 return ( $template, $borrowernumber, $cookie, $flags );
630 ($userid, $cookie, $sessionID) = &checkauth($query, $noauth, $flagsrequired, $type);
632 Verifies that the user is authorized to run this script. If
633 the user is authorized, a (userid, cookie, session-id, flags)
634 quadruple is returned. If the user is not authorized but does
635 not have the required privilege (see $flagsrequired below), it
636 displays an error page and exits. Otherwise, it displays the
637 login page and exits.
639 Note that C<&checkauth> will return if and only if the user
640 is authorized, so it should be called early on, before any
641 unfinished operations (e.g., if you've opened a file, then
642 C<&checkauth> won't close it for you).
644 C<$query> is the CGI object for the script calling C<&checkauth>.
646 The C<$noauth> argument is optional. If it is set, then no
647 authorization is required for the script.
649 C<&checkauth> fetches user and session information from C<$query> and
650 ensures that the user is authorized to run scripts that require
653 The C<$flagsrequired> argument specifies the required privileges
654 the user must have if the username and password are correct.
655 It should be specified as a reference-to-hash; keys in the hash
656 should be the "flags" for the user, as specified in the Members
657 intranet module. Any key specified must correspond to a "flag"
658 in the userflags table. E.g., { circulate => 1 } would specify
659 that the user must have the "circulate" privilege in order to
660 proceed. To make sure that access control is correct, the
661 C<$flagsrequired> parameter must be specified correctly.
663 Koha also has a concept of sub-permissions, also known as
664 granular permissions. This makes the value of each key
665 in the C<flagsrequired> hash take on an additional
670 The user must have access to all subfunctions of the module
671 specified by the hash key.
675 The user must have access to at least one subfunction of the module
676 specified by the hash key.
678 specific permission, e.g., 'export_catalog'
680 The user must have access to the specific subfunction list, which
681 must correspond to a row in the permissions table.
683 The C<$type> argument specifies whether the template should be
684 retrieved from the opac or intranet directory tree. "opac" is
685 assumed if it is not specified; however, if C<$type> is specified,
686 "intranet" is assumed if it is not "opac".
688 If C<$query> does not have a valid session ID associated with it
689 (i.e., the user has not logged in) or if the session has expired,
690 C<&checkauth> presents the user with a login page (from the point of
691 view of the original script, C<&checkauth> does not return). Once the
692 user has authenticated, C<&checkauth> restarts the original script
693 (this time, C<&checkauth> returns).
695 The login page is provided using a HTML::Template, which is set in the
696 systempreferences table or at the top of this file. The variable C<$type>
697 selects which template to use, either the opac or the intranet
698 authentification template.
700 C<&checkauth> returns a user ID, a cookie, and a session ID. The
701 cookie should be sent back to the browser; it verifies that the user
711 # If version syspref is unavailable, it means Koha is being installed,
712 # and so we must redirect to OPAC maintenance page or to the WebInstaller
713 # also, if OpacMaintenance is ON, OPAC should redirect to maintenance
714 if ( C4::Context->preference('OpacMaintenance') && $type eq 'opac' ) {
715 warn "OPAC Install required, redirecting to maintenance";
716 print $query->redirect("/cgi-bin/koha/maintenance.pl");
719 unless ( $version = C4::Context->preference('Version') ) { # assignment, not comparison
720 if ( $type ne 'opac' ) {
721 warn "Install required, redirecting to Installer";
722 print $query->redirect("/cgi-bin/koha/installer/install.pl");
724 warn "OPAC Install required, redirecting to maintenance";
725 print $query->redirect("/cgi-bin/koha/maintenance.pl");
730 # check that database and koha version are the same
731 # there is no DB version, it's a fresh install,
732 # go to web installer
733 # there is a DB version, compare it to the code version
734 my $kohaversion = Koha::version();
736 # remove the 3 last . to have a Perl number
737 $kohaversion =~ s/(.*\..*)\.(.*)\.(.*)/$1$2$3/;
738 Koha::Logger->get->debug("kohaversion : $kohaversion");
739 if ( $version < $kohaversion ) {
740 my $warning = "Database update needed, redirecting to %s. Database is $version and Koha is $kohaversion";
741 if ( $type ne 'opac' ) {
742 warn sprintf( $warning, 'Installer' );
743 print $query->redirect("/cgi-bin/koha/installer/install.pl?step=1&op=updatestructure");
745 warn sprintf( "OPAC: " . $warning, 'maintenance' );
746 print $query->redirect("/cgi-bin/koha/maintenance.pl");
752 sub _timeout_syspref {
753 my $default_timeout = 600;
754 my $timeout = C4::Context->preference('timeout') || $default_timeout;
756 # value in days, convert in seconds
757 if ( $timeout =~ /^(\d+)[dD]$/ ) {
758 $timeout = $1 * 86400;
760 # value in hours, convert in seconds
761 elsif ( $timeout =~ /^(\d+)[hH]$/ ) {
762 $timeout = $1 * 3600;
764 elsif ( $timeout !~ m/^\d+$/ ) {
765 warn "The value of the system preference 'timeout' is not correct, defaulting to $default_timeout";
766 $timeout = $default_timeout;
775 # Get shibboleth login attribute
776 my $shib = C4::Context->config('useshibboleth') && shib_ok();
777 my $shib_login = $shib ? get_login_shib() : undef;
779 # $authnotrequired will be set for scripts which will run without authentication
780 my $authnotrequired = shift;
781 my $flagsrequired = shift;
783 my $emailaddress = shift;
784 my $template_name = shift;
785 $type = 'opac' unless $type;
787 if ( $type eq 'opac' && !C4::Context->preference("OpacPublic") ) {
788 my @allowed_scripts_for_private_opac = qw(
790 opac-registration-email-sent.tt
791 opac-registration-confirmation.tt
792 opac-memberentry-update-submitted.tt
793 opac-password-recovery.tt
794 opac-reset-password.tt
796 $authnotrequired = 0 unless grep { $_ eq $template_name }
797 @allowed_scripts_for_private_opac;
800 my $timeout = _timeout_syspref();
802 my $cookie_mgr = Koha::CookieManager->new;
804 _version_check( $type, $query );
808 my $auth_state = 'failed';
810 my ( $userid, $cookie, $sessionID, $flags );
812 my $logout = $query->param('logout.x');
814 my $anon_search_history;
816 # This parameter is the name of the CAS server we want to authenticate against,
817 # when using authentication against multiple CAS servers, as configured in Auth_cas_servers.yaml
818 my $casparam = $query->param('cas');
819 my $q_userid = $query->param('userid') // '';
822 my $invalid_otp_token;
824 ( $type ne "opac" # Only available for the staff interface
825 && C4::Context->preference('TwoFactorAuthentication') ne "disabled" ) # If "enabled" or "enforced"
828 # Basic authentication is incompatible with the use of Shibboleth,
829 # as Shibboleth may return REMOTE_USER as a Shibboleth attribute,
830 # and it may not be the attribute we want to use to match the koha login.
832 # Also, do not consider an empty REMOTE_USER.
834 # Finally, after those tests, we can assume (although if it would be better with
835 # a syspref) that if we get a REMOTE_USER, that's from basic authentication,
836 # and we can affect it to $userid.
837 if ( !$shib and defined( $ENV{'REMOTE_USER'} ) and $ENV{'REMOTE_USER'} ne '' and $userid = $ENV{'REMOTE_USER'} ) {
839 # Using Basic Authentication, no cookies required
840 $cookie = $cookie_mgr->replace_in_list( $cookie, $query->cookie(
841 -name => 'CGISESSID',
844 -secure => ( C4::Context->https_enabled() ? 1 : 0 ),
849 elsif ( $emailaddress) {
850 # the Google OpenID Connect passes an email address
852 elsif ( $sessionID = $query->cookie("CGISESSID") ) { # assignment, not comparison
853 my ( $return, $more_info );
854 # NOTE: $flags in the following call is still undefined !
855 ( $return, $session, $more_info ) = check_cookie_auth( $sessionID, $flags,
856 { remote_addr => $ENV{REMOTE_ADDR}, skip_version_check => 1 }
859 if ( $return eq 'ok' || $return eq 'additional-auth-needed' ) {
860 $userid = $session->param('id');
864 $return eq 'ok' ? 'completed'
865 : $return eq 'additional-auth-needed' ? 'additional-auth-needed'
868 # We are at the second screen if the waiting-for-2FA is set in session
869 # and otp_token param has been passed
871 && $auth_state eq 'additional-auth-needed'
872 && ( my $otp_token = $query->param('otp_token') ) )
874 my $patron = Koha::Patrons->find( { userid => $userid } );
875 my $auth = Koha::Auth::TwoFactorAuth->new( { patron => $patron } );
876 my $verified = $auth->verify($otp_token, 1);
879 # The token is correct, the user is fully logged in!
880 $auth_state = 'completed';
881 $session->param( 'waiting-for-2FA', 0 );
882 $session->param( 'waiting-for-2FA-setup', 0 );
884 # This is an ugly trick to pass the test
885 # $query->param('koha_login_context') && ( $q_userid ne $userid )
890 $invalid_otp_token = 1;
894 if ( $auth_state eq 'completed' ) {
895 Koha::Logger->get->debug(sprintf "AUTH_SESSION: (%s)\t%s %s - %s", map { $session->param($_) || q{} } qw(cardnumber firstname surname branch));
897 if ( ( $query->param('koha_login_context') && ( $q_userid ne $userid ) )
898 || ( $cas && $query->param('ticket') && !C4::Context->userenv->{'id'} )
899 || ( $shib && $shib_login && !$logout && !C4::Context->userenv->{'id'} )
902 #if a user enters an id ne to the id in the current session, we need to log them in...
903 #first we need to clear the anonymous session...
904 $anon_search_history = $session->param('search_history');
907 $cookie = $cookie_mgr->clear_unless( $query->cookie, @$cookie );
908 C4::Context::_unset_userenv($sessionID);
910 undef $userid; # IMPORTANT: this assures us a new session in code below
913 $cookie = $cookie_mgr->replace_in_list( $cookie, $query->cookie(
914 -name => 'CGISESSID',
915 -value => $session->id,
917 -secure => ( C4::Context->https_enabled() ? 1 : 0 ),
921 $flags = haspermission( $userid, $flagsrequired );
923 $auth_state = 'failed';
924 $info{'nopermission'} = 1;
927 } elsif ( !$logout ) {
928 if ( $return eq 'expired' ) {
929 $info{timed_out} = 1;
930 } elsif ( $return eq 'restricted' ) {
931 $info{oldip} = $more_info->{old_ip};
932 $info{newip} = $more_info->{new_ip};
933 $info{different_ip} = 1;
934 } elsif ( $return eq 'password_expired' ) {
935 $info{password_has_expired} = 1;
940 if ( $auth_state eq 'failed' || $logout ) {
947 # voluntary logout the user
948 # check wether the user was using their shibboleth session or a local one
949 my $shibSuccess = C4::Context->userenv ? C4::Context->userenv->{'shibboleth'} : undef;
954 C4::Context::_unset_userenv($sessionID);
955 $cookie = $cookie_mgr->clear_unless( $query->cookie, @$cookie );
957 if ($cas and $caslogout) {
958 logout_cas($query, $type);
961 # If we are in a shibboleth session (shibboleth is enabled, a shibboleth match attribute is set and matches koha matchpoint)
962 if ( $shib and $shib_login and $shibSuccess) {
967 $auth_state = 'logout';
971 #we initiate a session prior to checking for a username to allow for anonymous sessions...
972 if( !$session or !$sessionID ) { # if we cleared sessionID, we need a new session
973 $session = get_session() or die "Auth ERROR: Cannot get_session()";
976 # Save anonymous search history in new session so it can be retrieved
977 # by get_template_and_user to store it in user's search history after
978 # a successful login.
979 if ($anon_search_history) {
980 $session->param( 'search_history', $anon_search_history );
983 $sessionID = $session->id;
984 C4::Context->_new_userenv($sessionID);
985 $cookie = $cookie_mgr->replace_in_list( $cookie, $query->cookie(
986 -name => 'CGISESSID',
987 -value => $sessionID,
989 -secure => ( C4::Context->https_enabled() ? 1 : 0 ),
992 my $pki_field = C4::Context->preference('AllowPKIAuth');
993 if ( !defined($pki_field) ) {
994 print STDERR "ERROR: Missing system preference AllowPKIAuth.\n";
997 if ( ( $cas && $query->param('ticket') )
999 || ( $shib && $shib_login )
1000 || $pki_field ne 'None'
1003 my $password = $query->param('password');
1004 my $shibSuccess = 0;
1005 my ( $return, $cardnumber );
1007 # If shib is enabled and we have a shib login, does the login match a valid koha user
1008 if ( $shib && $shib_login ) {
1011 # Do not pass password here, else shib will not be checked in checkpw.
1012 ( $return, $cardnumber, $retuserid ) = checkpw( $q_userid, undef, $query );
1013 $userid = $retuserid;
1014 $shibSuccess = $return;
1015 $info{'invalidShibLogin'} = 1 unless ($return);
1018 # If shib login and match were successful, skip further login methods
1019 unless ($shibSuccess) {
1020 if ( $cas && $query->param('ticket') ) {
1022 ( $return, $cardnumber, $retuserid, $cas_ticket ) =
1023 checkpw( $userid, $password, $query, $type );
1024 $userid = $retuserid;
1025 $info{'invalidCasLogin'} = 1 unless ($return);
1028 elsif ( $emailaddress ) {
1029 my $value = $emailaddress;
1031 # If we're looking up the email, there's a chance that the person
1032 # doesn't have a userid. So if there is none, we pass along the
1033 # borrower number, and the bits of code that need to know the user
1034 # ID will have to be smart enough to handle that.
1035 my $patrons = Koha::Patrons->search({ email => $value });
1036 if ($patrons->count) {
1038 # First the userid, then the borrowernum
1039 my $patron = $patrons->next;
1040 $value = $patron->userid || $patron->borrowernumber;
1044 $return = $value ? 1 : 0;
1049 ( $pki_field eq 'Common Name' && $ENV{'SSL_CLIENT_S_DN_CN'} )
1050 || ( $pki_field eq 'emailAddress'
1051 && $ENV{'SSL_CLIENT_S_DN_Email'} )
1055 if ( $pki_field eq 'Common Name' ) {
1056 $value = $ENV{'SSL_CLIENT_S_DN_CN'};
1058 elsif ( $pki_field eq 'emailAddress' ) {
1059 $value = $ENV{'SSL_CLIENT_S_DN_Email'};
1061 # If we're looking up the email, there's a chance that the person
1062 # doesn't have a userid. So if there is none, we pass along the
1063 # borrower number, and the bits of code that need to know the user
1064 # ID will have to be smart enough to handle that.
1065 my $patrons = Koha::Patrons->search({ email => $value });
1066 if ($patrons->count) {
1068 # First the userid, then the borrowernum
1069 my $patron = $patrons->next;
1070 $value = $patron->userid || $patron->borrowernumber;
1076 $return = $value ? 1 : 0;
1082 my $request_method = $query->request_method // q{};
1085 $request_method eq 'POST'
1086 || ( C4::Context->preference('AutoSelfCheckID')
1087 && $q_userid eq C4::Context->preference('AutoSelfCheckID') )
1091 ( $return, $cardnumber, $retuserid, $cas_ticket ) =
1092 checkpw( $q_userid, $password, $query, $type );
1093 $userid = $retuserid if ($retuserid);
1094 $info{'invalid_username_or_password'} = 1 unless ($return);
1099 # If shib configured and shibOnly enabled, we should ignore anything other than a shibboleth type login.
1106 && C4::Context->preference('OPACShibOnly')
1108 || ( ( $type ne 'opac' )
1109 && C4::Context->preference('staffShibOnly') )
1116 # $return: 1 = valid user
1117 if( $return && $return > 0 ) {
1119 if ( $flags = haspermission( $userid, $flagsrequired ) ) {
1120 $auth_state = "logged_in";
1123 $auth_state = 'failed';
1124 # FIXME We could add $return = 0; or even delete the session?
1125 # Currently return == 1 and we will fill session info later on,
1126 # although we do present an authorization failure. (Yes, the
1127 # authentication was actually correct.)
1128 $info{'nopermission'} = 1;
1129 C4::Context::_unset_userenv($sessionID);
1131 my ( $borrowernumber, $firstname, $surname, $userflags,
1132 $branchcode, $branchname, $emailaddress, $desk_id,
1133 $desk_name, $register_id, $register_name );
1135 if ( $return == 1 ) {
1137 SELECT borrowernumber, firstname, surname, flags, borrowers.branchcode,
1138 branches.branchname as branchname, email
1140 LEFT JOIN branches on borrowers.branchcode=branches.branchcode
1142 my $dbh = C4::Context->dbh;
1143 my $sth = $dbh->prepare("$select where userid=?");
1144 $sth->execute($userid);
1145 unless ( $sth->rows ) {
1146 $sth = $dbh->prepare("$select where cardnumber=?");
1147 $sth->execute($cardnumber);
1149 unless ( $sth->rows ) {
1150 $sth->execute($userid);
1154 ( $borrowernumber, $firstname, $surname, $userflags,
1155 $branchcode, $branchname, $emailaddress ) = $sth->fetchrow;
1158 # launch a sequence to check if we have a ip for the branch, i
1159 # if we have one we replace the branchcode of the userenv by the branch bound in the ip.
1161 my $ip = $ENV{'REMOTE_ADDR'};
1163 # if they specify at login, use that
1164 my $patron = Koha::Patrons->find({userid => $userid});
1165 if ( $query->param('branch') && ( haspermission($userid, { 'loggedinlibrary'=> 1 }) || $patron->is_superlibrarian ) ) {
1166 $branchcode = $query->param('branch');
1167 my $library = Koha::Libraries->find($branchcode);
1168 $branchname = $library? $library->branchname: '';
1170 if ( $query->param('desk_id') ) {
1171 $desk_id = $query->param('desk_id');
1172 my $desk = Koha::Desks->find($desk_id);
1173 $desk_name = $desk ? $desk->desk_name : '';
1175 if ( C4::Context->preference('UseCashRegisters') ) {
1177 $query->param('register_id')
1178 ? Koha::Cash::Registers->find($query->param('register_id'))
1179 : Koha::Cash::Registers->search(
1180 { branch => $branchcode, branch_default => 1 },
1181 { rows => 1 } )->single;
1182 $register_id = $register->id if ($register);
1183 $register_name = $register->name if ($register);
1185 my $branches = { map { $_->branchcode => $_->unblessed } Koha::Libraries->search->as_list };
1186 if ( $type ne 'opac' and C4::Context->preference('AutoLocation') ) {
1188 # we have to check they are coming from the right ip range
1189 my $domain = $branches->{$branchcode}->{'branchip'};
1190 $domain =~ s|\.\*||g;
1191 if ( $ip !~ /^$domain/ ) {
1193 $cookie = $cookie_mgr->replace_in_list( $cookie, $query->cookie(
1194 -name => 'CGISESSID',
1197 -secure => ( C4::Context->https_enabled() ? 1 : 0 ),
1200 $info{'wrongip'} = 1;
1204 foreach my $br ( keys %$branches ) {
1206 # now we work with the treatment of ip
1207 my $domain = $branches->{$br}->{'branchip'};
1208 if ( $domain && $ip =~ /^$domain/ ) {
1209 $branchcode = $branches->{$br}->{'branchcode'};
1211 # new op dev : add the branchname to the cookie
1212 $branchname = $branches->{$br}->{'branchname'};
1216 my $is_sco_user = 0;
1217 if ( $query->param('sco_user_login') && ( $query->param('sco_user_login') eq '1' ) ){
1221 $session->param( 'number', $borrowernumber );
1222 $session->param( 'id', $userid );
1223 $session->param( 'cardnumber', $cardnumber );
1224 $session->param( 'firstname', $firstname );
1225 $session->param( 'surname', $surname );
1226 $session->param( 'branch', $branchcode );
1227 $session->param( 'branchname', $branchname );
1228 $session->param( 'desk_id', $desk_id);
1229 $session->param( 'desk_name', $desk_name);
1230 $session->param( 'flags', $userflags );
1231 $session->param( 'emailaddress', $emailaddress );
1232 $session->param( 'ip', $session->remote_addr() );
1233 $session->param( 'lasttime', time() );
1234 $session->param( 'interface', $type);
1235 $session->param( 'shibboleth', $shibSuccess );
1236 $session->param( 'register_id', $register_id );
1237 $session->param( 'register_name', $register_name );
1238 $session->param( 'sco_user', $is_sco_user );
1240 $session->param('cas_ticket', $cas_ticket) if $cas_ticket;
1241 C4::Context->set_userenv(
1242 $session->param('number'), $session->param('id'),
1243 $session->param('cardnumber'), $session->param('firstname'),
1244 $session->param('surname'), $session->param('branch'),
1245 $session->param('branchname'), $session->param('flags'),
1246 $session->param('emailaddress'), $session->param('shibboleth'),
1247 $session->param('desk_id'), $session->param('desk_name'),
1248 $session->param('register_id'), $session->param('register_name')
1252 # $return: 0 = invalid user
1253 # reset to anonymous session
1256 $info{'invalid_username_or_password'} = 1;
1257 C4::Context::_unset_userenv($sessionID);
1259 $session->param( 'lasttime', time() );
1260 $session->param( 'ip', $session->remote_addr() );
1261 $session->param( 'sessiontype', 'anon' );
1262 $session->param( 'interface', $type);
1264 } # END if ( $q_userid
1265 elsif ( $type eq "opac" ) {
1267 # anonymous sessions are created only for the OPAC
1269 # setting a couple of other session vars...
1270 $session->param( 'ip', $session->remote_addr() );
1271 $session->param( 'lasttime', time() );
1272 $session->param( 'sessiontype', 'anon' );
1273 $session->param( 'interface', $type);
1276 } # END unless ($userid)
1279 if ( $auth_state eq 'logged_in' ) {
1280 $auth_state = 'completed';
1282 # Auth is completed unless an additional auth is needed
1283 if ( $require_2FA ) {
1284 my $patron = Koha::Patrons->find({userid => $userid});
1285 if ( C4::Context->preference('TwoFactorAuthentication') eq "enforced" && $patron->auth_method eq 'password' ) {
1286 $auth_state = 'setup-additional-auth-needed';
1287 $session->param('waiting-for-2FA-setup', 1);
1288 %info = ();# We remove the warnings/errors we may have set incorrectly before
1289 } elsif ( $patron->auth_method eq 'two-factor' ) {
1290 # Ask for the OTP token
1291 $auth_state = 'additional-auth-needed';
1292 $session->param('waiting-for-2FA', 1);
1293 %info = ();# We remove the warnings/errors we may have set incorrectly before
1298 # finished authentification, now respond
1299 if ( $auth_state eq 'completed' || $authnotrequired ) {
1302 $cookie = $cookie_mgr->replace_in_list( $cookie, $query->cookie(
1303 -name => 'CGISESSID',
1306 -secure => ( C4::Context->https_enabled() ? 1 : 0 ),
1311 track_login_daily( $userid );
1313 # In case, that this request was a login attempt, we want to prevent that users can repost the opac login
1314 # request. We therefore redirect the user to the requested page again without the login parameters.
1315 # See Post/Redirect/Get (PRG) design pattern: https://en.wikipedia.org/wiki/Post/Redirect/Get
1316 if ( $type eq "opac" && $query->param('koha_login_context') && $query->param('koha_login_context') ne 'sco' && $query->param('password') && $query->param('userid') ) {
1317 my $uri = URI->new($query->url(-relative=>1, -query_string=>1));
1318 $uri->query_param_delete('userid');
1319 $uri->query_param_delete('password');
1320 $uri->query_param_delete('koha_login_context');
1321 print $query->redirect(-uri => $uri->as_string, -cookie => $cookie, -status=>'303 See other');
1325 return ( $userid, $cookie, $sessionID, $flags );
1330 # AUTH rejected, show the login/password template, after checking the DB.
1334 my $patron = Koha::Patrons->find({ userid => $q_userid }); # Not necessary logged in!
1336 # get the inputs from the incoming query
1338 my @inputs_to_clean = qw( userid password ticket logout.x otp_token );
1339 foreach my $name ( param $query) {
1340 next if grep { $name eq $_ } @inputs_to_clean;
1341 my @value = $query->multi_param($name);
1342 push @inputs, { name => $name, value => $_ } for @value;
1345 my $LibraryNameTitle = C4::Context->preference("LibraryName");
1346 $LibraryNameTitle =~ s/<(?:\/?)(?:br|p)\s*(?:\/?)>/ /sgi;
1347 $LibraryNameTitle =~ s/<(?:[^<>'"]|'(?:[^']*)'|"(?:[^"]*)")*>//sg;
1349 my $auth_template_name = ( $type eq 'opac' ) ? 'opac-auth.tt' : 'auth.tt';
1350 my $auth_error = $query->param('auth_error');
1351 my $template = C4::Templates::gettemplate( $auth_template_name, $type, $query );
1355 script_name => get_script_name(),
1356 casAuthentication => C4::Context->preference("casAuthentication"),
1357 shibbolethAuthentication => $shib,
1358 suggestion => C4::Context->preference("suggestion"),
1359 virtualshelves => C4::Context->preference("virtualshelves"),
1360 LibraryName => "" . C4::Context->preference("LibraryName"),
1361 LibraryNameTitle => "" . $LibraryNameTitle,
1362 opacuserlogin => C4::Context->preference("opacuserlogin"),
1363 OpacFavicon => C4::Context->preference("OpacFavicon"),
1364 opacreadinghistory => C4::Context->preference("opacreadinghistory"),
1365 opaclanguagesdisplay => C4::Context->preference("opaclanguagesdisplay"),
1366 OPACUserJS => C4::Context->preference("OPACUserJS"),
1367 OPACUserCSS => C4::Context->preference("OPACUserCSS"),
1368 intranetcolorstylesheet => C4::Context->preference("intranetcolorstylesheet"),
1369 intranetstylesheet => C4::Context->preference("intranetstylesheet"),
1370 IntranetNav => C4::Context->preference("IntranetNav"),
1371 IntranetFavicon => C4::Context->preference("IntranetFavicon"),
1372 IntranetUserCSS => C4::Context->preference("IntranetUserCSS"),
1373 IntranetUserJS => C4::Context->preference("IntranetUserJS"),
1374 IndependentBranches => C4::Context->preference("IndependentBranches"),
1375 AutoLocation => C4::Context->preference("AutoLocation"),
1376 wrongip => $info{'wrongip'},
1377 PatronSelfRegistration => C4::Context->preference("PatronSelfRegistration"),
1378 PatronSelfRegistrationDefaultCategory => C4::Context->preference("PatronSelfRegistrationDefaultCategory"),
1379 opac_css_override => $ENV{'OPAC_CSS_OVERRIDE'},
1380 too_many_login_attempts => ( $patron and $patron->account_locked ),
1381 password_has_expired => ( $patron and $patron->password_expired ),
1382 auth_error => $auth_error,
1385 $template->param( SCO_login => 1 ) if ( $query->param('sco_user_login') );
1386 $template->param( SCI_login => 1 ) if ( $query->param('sci_user_login') );
1387 $template->param( OpacPublic => C4::Context->preference("OpacPublic") );
1388 $template->param( loginprompt => 1 ) unless $info{'nopermission'};
1389 if ( $auth_state eq 'additional-auth-needed' ) {
1390 my $patron = Koha::Patrons->find( { userid => $userid } );
1393 invalid_otp_token => $invalid_otp_token,
1394 notice_email_address => $patron->notice_email_address, # We could also pass logged_in_user if necessary
1398 if ( $auth_state eq 'setup-additional-auth-needed' ) {
1404 if ( $type eq 'opac' ) {
1405 require Koha::Virtualshelves;
1406 my $some_public_shelves = Koha::Virtualshelves->get_some_shelves(
1412 some_public_shelves => $some_public_shelves,
1418 # Is authentication against multiple CAS servers enabled?
1419 require C4::Auth_with_cas;
1420 if ( multipleAuth() && !$casparam ) {
1421 my $casservers = getMultipleAuth();
1423 foreach my $key ( keys %$casservers ) {
1424 push @tmplservers, { name => $key, value => login_cas_url( $query, $key, $type ) . "?cas=$key" };
1427 casServersLoop => \@tmplservers
1431 casServerUrl => login_cas_url($query, undef, $type),
1436 invalidCasLogin => $info{'invalidCasLogin'}
1441 #If shibOnly is enabled just go ahead and redirect directly
1442 if ( (($type eq 'opac') && C4::Context->preference('OPACShibOnly')) || (($type ne 'opac') && C4::Context->preference('staffShibOnly')) ) {
1443 my $redirect_url = login_shib_url( $query );
1444 print $query->redirect( -uri => "$redirect_url", -status => 303 );
1449 shibbolethAuthentication => $shib,
1450 shibbolethLoginUrl => login_shib_url($query),
1454 if (C4::Context->preference('GoogleOpenIDConnect')) {
1455 if ($query->param("OpenIDConnectFailed")) {
1456 my $reason = $query->param('OpenIDConnectFailed');
1457 $template->param(invalidGoogleOpenIDConnectLogin => $reason);
1462 LibraryName => C4::Context->preference("LibraryName"),
1464 $template->param(%info);
1466 # $cookie = $query->cookie(CGISESSID => $session->id
1468 print $query->header(
1469 { type => 'text/html',
1472 'X-Frame-Options' => 'SAMEORIGIN',
1480 =head2 check_api_auth
1482 ($status, $cookie, $sessionId) = check_api_auth($query, $userflags);
1484 Given a CGI query containing the parameters 'userid' and 'password' and/or a session
1485 cookie, determine if the user has the privileges specified by C<$userflags>.
1487 C<check_api_auth> is is meant for authenticating users of web services, and
1488 consequently will always return and will not attempt to redirect the user
1491 If a valid session cookie is already present, check_api_auth will return a status
1492 of "ok", the cookie, and the Koha session ID.
1494 If no session cookie is present, check_api_auth will check the 'userid' and 'password
1495 parameters and create a session cookie and Koha session if the supplied credentials
1498 Possible return values in C<$status> are:
1502 =item "ok" -- user authenticated; C<$cookie> and C<$sessionid> have valid values.
1504 =item "failed" -- credentials are not correct; C<$cookie> and C<$sessionid> are undef
1506 =item "maintenance" -- DB is in maintenance mode; no login possible at the moment
1508 =item "expired -- session cookie has expired; API user should resubmit userid and password
1510 =item "restricted" -- The IP has changed (if SessionRestrictionByIP)
1512 =item "additional-auth-needed -- User is in an authentication process that is not finished
1518 sub check_api_auth {
1521 my $flagsrequired = shift;
1522 my $timeout = _timeout_syspref();
1524 unless ( C4::Context->preference('Version') ) {
1526 # database has not been installed yet
1527 return ( "maintenance", undef, undef );
1529 my $kohaversion = Koha::version();
1530 $kohaversion =~ s/(.*\..*)\.(.*)\.(.*)/$1$2$3/;
1531 if ( C4::Context->preference('Version') < $kohaversion ) {
1533 # database in need of version update; assume that
1534 # no API should be called while databsae is in
1536 return ( "maintenance", undef, undef );
1539 my ( $sessionID, $session );
1540 unless ( $query->param('userid') ) {
1541 $sessionID = $query->cookie("CGISESSID");
1543 if ( $sessionID && not( $cas && $query->param('PT') ) ) {
1546 ( $return, $session, undef ) = check_cookie_auth(
1547 $sessionID, $flagsrequired, { remote_addr => $ENV{REMOTE_ADDR} } );
1549 return ( $return, undef, undef ) # Cookie auth failed
1552 my $cookie = $query->cookie(
1553 -name => 'CGISESSID',
1554 -value => $session->id,
1556 -secure => ( C4::Context->https_enabled() ? 1 : 0 ),
1559 return ( $return, $cookie, $session ); # return == 'ok' here
1564 my $userid = $query->param('userid');
1565 my $password = $query->param('password');
1566 my ( $return, $cardnumber, $cas_ticket );
1569 if ( $cas && $query->param('PT') ) {
1572 # In case of a CAS authentication, we use the ticket instead of the password
1573 my $PT = $query->param('PT');
1574 ( $return, $cardnumber, $userid, $cas_ticket ) = check_api_auth_cas( $PT, $query ); # EXTERNAL AUTH
1577 # User / password auth
1578 unless ( $userid and $password ) {
1580 # caller did something wrong, fail the authenticateion
1581 return ( "failed", undef, undef );
1584 ( $return, $cardnumber, $newuserid, $cas_ticket ) = checkpw( $userid, $password, $query );
1587 if ( $return and haspermission( $userid, $flagsrequired ) ) {
1588 my $session = get_session("");
1589 return ( "failed", undef, undef ) unless $session;
1591 my $sessionID = $session->id;
1592 C4::Context->_new_userenv($sessionID);
1593 my $cookie = $query->cookie(
1594 -name => 'CGISESSID',
1595 -value => $sessionID,
1597 -secure => ( C4::Context->https_enabled() ? 1 : 0 ),
1600 if ( $return == 1 ) {
1602 $borrowernumber, $firstname, $surname,
1603 $userflags, $branchcode, $branchname,
1606 my $dbh = C4::Context->dbh;
1609 "select borrowernumber, firstname, surname, flags, borrowers.branchcode, branches.branchname as branchname, email from borrowers left join branches on borrowers.branchcode=branches.branchcode where userid=?"
1611 $sth->execute($userid);
1613 $borrowernumber, $firstname, $surname,
1614 $userflags, $branchcode, $branchname,
1616 ) = $sth->fetchrow if ( $sth->rows );
1618 unless ( $sth->rows ) {
1619 my $sth = $dbh->prepare(
1620 "select borrowernumber, firstname, surname, flags, borrowers.branchcode, branches.branchname as branchname, email from borrowers left join branches on borrowers.branchcode=branches.branchcode where cardnumber=?"
1622 $sth->execute($cardnumber);
1624 $borrowernumber, $firstname, $surname,
1625 $userflags, $branchcode, $branchname,
1627 ) = $sth->fetchrow if ( $sth->rows );
1629 unless ( $sth->rows ) {
1630 $sth->execute($userid);
1632 $borrowernumber, $firstname, $surname, $userflags,
1633 $branchcode, $branchname, $emailaddress
1634 ) = $sth->fetchrow if ( $sth->rows );
1638 my $ip = $ENV{'REMOTE_ADDR'};
1640 # if they specify at login, use that
1641 if ( $query->param('branch') ) {
1642 $branchcode = $query->param('branch');
1643 my $library = Koha::Libraries->find($branchcode);
1644 $branchname = $library? $library->branchname: '';
1646 my $branches = { map { $_->branchcode => $_->unblessed } Koha::Libraries->search->as_list };
1647 foreach my $br ( keys %$branches ) {
1649 # now we work with the treatment of ip
1650 my $domain = $branches->{$br}->{'branchip'};
1651 if ( $domain && $ip =~ /^$domain/ ) {
1652 $branchcode = $branches->{$br}->{'branchcode'};
1654 # new op dev : add the branchname to the cookie
1655 $branchname = $branches->{$br}->{'branchname'};
1658 $session->param( 'number', $borrowernumber );
1659 $session->param( 'id', $userid );
1660 $session->param( 'cardnumber', $cardnumber );
1661 $session->param( 'firstname', $firstname );
1662 $session->param( 'surname', $surname );
1663 $session->param( 'branch', $branchcode );
1664 $session->param( 'branchname', $branchname );
1665 $session->param( 'flags', $userflags );
1666 $session->param( 'emailaddress', $emailaddress );
1667 $session->param( 'ip', $session->remote_addr() );
1668 $session->param( 'lasttime', time() );
1669 $session->param( 'interface', 'api' );
1671 $session->param( 'cas_ticket', $cas_ticket);
1672 C4::Context->set_userenv(
1673 $session->param('number'), $session->param('id'),
1674 $session->param('cardnumber'), $session->param('firstname'),
1675 $session->param('surname'), $session->param('branch'),
1676 $session->param('branchname'), $session->param('flags'),
1677 $session->param('emailaddress'), $session->param('shibboleth'),
1678 $session->param('desk_id'), $session->param('desk_name'),
1679 $session->param('register_id'), $session->param('register_name')
1681 return ( "ok", $cookie, $sessionID );
1683 return ( "failed", undef, undef );
1688 =head2 check_cookie_auth
1690 ($status, $sessionId) = check_cookie_auth($cookie, $userflags);
1692 Given a CGISESSID cookie set during a previous login to Koha, determine
1693 if the user has the privileges specified by C<$userflags>. C<$userflags>
1694 is passed unaltered into C<haspermission> and as such accepts all options
1695 avaiable to that routine with the one caveat that C<check_api_auth> will
1696 also allow 'undef' to be passed and in such a case the permissions check
1697 will be skipped altogether.
1699 C<check_cookie_auth> is meant for authenticating special services
1700 such as tools/upload-file.pl that are invoked by other pages that
1701 have been authenticated in the usual way.
1703 Possible return values in C<$status> are:
1707 =item "ok" -- user authenticated; C<$sessionID> have valid values.
1709 =item "anon" -- user not authenticated but valid for anonymous session.
1711 =item "failed" -- credentials are not correct; C<$sessionid> are undef
1713 =item "maintenance" -- DB is in maintenance mode; no login possible at the moment
1715 =item "expired -- session cookie has expired; API user should resubmit userid and password
1717 =item "restricted" -- The IP has changed (if SessionRestrictionByIP)
1723 sub check_cookie_auth {
1724 my $sessionID = shift;
1725 my $flagsrequired = shift;
1728 my $remote_addr = $params->{remote_addr} || $ENV{REMOTE_ADDR};
1730 my $skip_version_check = $params->{skip_version_check}; # Only for checkauth
1732 unless ( $skip_version_check ) {
1733 unless ( C4::Context->preference('Version') ) {
1735 # database has not been installed yet
1736 return ( "maintenance", undef );
1738 my $kohaversion = Koha::version();
1739 $kohaversion =~ s/(.*\..*)\.(.*)\.(.*)/$1$2$3/;
1740 if ( C4::Context->preference('Version') < $kohaversion ) {
1742 # database in need of version update; assume that
1743 # no API should be called while databsae is in
1745 return ( "maintenance", undef );
1749 # see if we have a valid session cookie already
1750 # however, if a userid parameter is present (i.e., from
1751 # a form submission, assume that any current cookie
1753 unless ( $sessionID ) {
1754 return ( "failed", undef );
1756 C4::Context::_unset_userenv($sessionID); # remove old userenv first
1757 my $session = get_session($sessionID);
1759 my $userid = $session->param('id');
1760 my $ip = $session->param('ip');
1761 my $lasttime = $session->param('lasttime');
1762 my $timeout = _timeout_syspref();
1764 if ( !$lasttime || ( $lasttime < time() - $timeout ) ) {
1768 return ("expired", undef);
1770 } elsif ( C4::Context->preference('SessionRestrictionByIP') && $ip ne $remote_addr ) {
1771 # IP address changed
1774 return ( "restricted", undef, { old_ip => $ip, new_ip => $remote_addr});
1776 } elsif ( $userid ) {
1777 $session->param( 'lasttime', time() );
1778 my $patron = Koha::Patrons->find({ userid => $userid });
1780 # If the user modify their own userid
1781 # Better than 500 but we could do better
1782 unless ( $patron ) {
1785 return ("expired", undef);
1788 $patron = Koha::Patrons->find({ cardnumber => $userid })
1790 return ("password_expired", undef ) if $patron->password_expired;
1791 my $flags = defined($flagsrequired) ? haspermission( $userid, $flagsrequired ) : 1;
1793 C4::Context->_new_userenv($sessionID);
1794 if ( !C4::Context->interface ) {
1795 # No need to override the interface, most often set by get_template_and_user
1796 C4::Context->interface( $session->param('interface') );
1798 C4::Context->set_userenv(
1799 $session->param('number'), $session->param('id') // '',
1800 $session->param('cardnumber'), $session->param('firstname'),
1801 $session->param('surname'), $session->param('branch'),
1802 $session->param('branchname'), $session->param('flags'),
1803 $session->param('emailaddress'), $session->param('shibboleth'),
1804 $session->param('desk_id'), $session->param('desk_name'),
1805 $session->param('register_id'), $session->param('register_name')
1807 if ( C4::Context->preference('TwoFactorAuthentication') ne 'disabled' ) {
1808 return ( "additional-auth-needed", $session )
1809 if $session->param('waiting-for-2FA');
1811 return ( "setup-additional-auth-needed", $session )
1812 if $session->param('waiting-for-2FA-setup');
1815 return ( "ok", $session );
1819 return ( "failed", undef );
1823 C4::Context->_new_userenv($sessionID);
1824 C4::Context->interface($session->param('interface'));
1825 C4::Context->set_userenv( undef, q{} );
1826 return ( "anon", $session );
1829 return ( "expired", undef );
1836 my $session = get_session($sessionID);
1838 Given a session ID, retrieve the CGI::Session object used to store
1839 the session's state. The session object can be used to store
1840 data that needs to be accessed by different scripts during a
1843 If the C<$sessionID> parameter is an empty string, a new session
1848 sub _get_session_params {
1849 my $storage_method = C4::Context->preference('SessionStorage');
1850 if ( $storage_method eq 'mysql' ) {
1851 my $dbh = C4::Context->dbh;
1852 return { dsn => "serializer:yamlxs;driver:MySQL;id:md5", dsn_args => { Handle => $dbh } };
1854 elsif ( $storage_method eq 'Pg' ) {
1855 my $dbh = C4::Context->dbh;
1856 return { dsn => "serializer:yamlxs;driver:PostgreSQL;id:md5", dsn_args => { Handle => $dbh } };
1858 elsif ( $storage_method eq 'memcached' && Koha::Caches->get_instance->memcached_cache ) {
1859 my $memcached = Koha::Caches->get_instance()->memcached_cache;
1860 return { dsn => "serializer:yamlxs;driver:memcached;id:md5", dsn_args => { Memcached => $memcached } };
1863 # catch all defaults to tmp should work on all systems
1864 my $dir = C4::Context::temporary_directory;
1865 my $instance = C4::Context->config( 'database' ); #actually for packages not exactly the instance name, but generally safer to leave it as it is
1866 return { dsn => "serializer:yamlxs;driver:File;id:md5", dsn_args => { Directory => "$dir/cgisess_$instance" } };
1871 my $sessionID = shift;
1872 my $params = _get_session_params();
1874 if( $sessionID ) { # find existing
1875 CGI::Session::ErrorHandler->set_error( q{} ); # clear error, cpan issue #111463
1876 $session = CGI::Session->load( $params->{dsn}, $sessionID, $params->{dsn_args} );
1878 $session = CGI::Session->new( $params->{dsn}, $sessionID, $params->{dsn_args} );
1879 # no need to flush here
1884 =head2 create_basic_session
1886 my $session = create_basic_session({ patron => $patron, interface => $interface });
1888 Creates a session and adds all basic parameters for a session to work
1892 sub create_basic_session {
1894 my $patron = $params->{patron};
1895 my $interface = $params->{interface};
1897 $interface = 'intranet' if $interface eq 'staff';
1899 my $session = get_session("");
1901 $session->param( 'number', $patron->borrowernumber );
1902 $session->param( 'id', $patron->userid );
1903 $session->param( 'cardnumber', $patron->cardnumber );
1904 $session->param( 'firstname', $patron->firstname );
1905 $session->param( 'surname', $patron->surname );
1906 $session->param( 'branch', $patron->branchcode );
1907 $session->param( 'branchname', $patron->library->branchname );
1908 $session->param( 'flags', $patron->flags );
1909 $session->param( 'emailaddress', $patron->email );
1910 $session->param( 'ip', $session->remote_addr() );
1911 $session->param( 'lasttime', time() );
1912 $session->param( 'interface', $interface);
1918 # FIXME no_set_userenv may be replaced with force_branchcode_for_userenv
1919 # (or something similar)
1920 # Currently it's only passed from C4::SIP::ILS::Patron::check_password, but
1921 # not having a userenv defined could cause a crash.
1923 my ( $userid, $password, $query, $type, $no_set_userenv ) = @_;
1924 $type = 'opac' unless $type;
1926 # Get shibboleth login attribute
1927 my $shib = C4::Context->config('useshibboleth') && shib_ok();
1928 my $shib_login = $shib ? get_login_shib() : undef;
1932 if ( defined $userid ){
1933 $patron = Koha::Patrons->find({ userid => $userid });
1934 $patron = Koha::Patrons->find({ cardnumber => $userid }) unless $patron;
1936 my $check_internal_as_fallback = 0;
1938 # Note: checkpw_* routines returns:
1941 # -1 if user bind failed (LDAP only)
1943 if ( $patron and ( $patron->account_locked ) ) {
1944 # Nothing to check, account is locked
1945 } elsif ($ldap && defined($password)) {
1946 my ( $retval, $retcard, $retuserid ) = checkpw_ldap(@_); # EXTERNAL AUTH
1947 if ( $retval == 1 ) {
1948 @return = ( $retval, $retcard, $retuserid );
1951 $check_internal_as_fallback = 1 if $retval == 0;
1953 } elsif ( $cas && $query && $query->param('ticket') ) {
1955 # In case of a CAS authentication, we use the ticket instead of the password
1956 my $ticket = $query->param('ticket');
1957 $query->delete('ticket'); # remove ticket to come back to original URL
1958 my ( $retval, $retcard, $retuserid, $cas_ticket ) = checkpw_cas( $ticket, $query, $type ); # EXTERNAL AUTH
1960 @return = ( $retval, $retcard, $retuserid, $cas_ticket );
1964 $passwd_ok = $retval;
1967 # If we are in a shibboleth session (shibboleth is enabled, and a shibboleth match attribute is present)
1968 # Check for password to asertain whether we want to be testing against shibboleth or another method this
1970 elsif ( $shib && $shib_login && !$password ) {
1972 # In case of a Shibboleth authentication, we expect a shibboleth user attribute
1973 # (defined under shibboleth mapping in koha-conf.xml) to contain the login of the
1974 # shibboleth-authenticated user
1976 # Then, we check if it matches a valid koha user
1978 my ( $retval, $retcard, $retuserid ) = C4::Auth_with_shibboleth::checkpw_shib($shib_login); # EXTERNAL AUTH
1980 @return = ( $retval, $retcard, $retuserid );
1982 $passwd_ok = $retval;
1985 $check_internal_as_fallback = 1;
1989 if ( $check_internal_as_fallback ) {
1990 @return = checkpw_internal( $userid, $password, $no_set_userenv);
1991 $passwd_ok = 1 if $return[0] > 0; # 1 or 2
1996 $patron->update({ login_attempts => 0 });
1997 if( $patron->password_expired ){
2000 } elsif( !$patron->account_locked ) {
2001 $patron->update({ login_attempts => $patron->login_attempts + 1 });
2005 # Optionally log success or failure
2006 if( $patron && $passwd_ok && C4::Context->preference('AuthSuccessLog') ) {
2007 logaction( 'AUTH', 'SUCCESS', $patron->id, "Valid password for $userid", $type );
2008 } elsif( !$passwd_ok && C4::Context->preference('AuthFailureLog') ) {
2009 logaction( 'AUTH', 'FAILURE', $patron ? $patron->id : 0, "Wrong password for $userid", $type );
2015 sub checkpw_internal {
2016 my ( $userid, $password, $no_set_userenv ) = @_;
2018 $password = Encode::encode( 'UTF-8', $password )
2019 if Encode::is_utf8($password);
2021 my $dbh = C4::Context->dbh;
2024 "select password,cardnumber,borrowernumber,userid,firstname,surname,borrowers.branchcode,branches.branchname,flags from borrowers join branches on borrowers.branchcode=branches.branchcode where userid=?"
2026 $sth->execute($userid);
2028 my ( $stored_hash, $cardnumber, $borrowernumber, $userid, $firstname,
2029 $surname, $branchcode, $branchname, $flags )
2032 if ( checkpw_hash( $password, $stored_hash ) ) {
2034 C4::Context->set_userenv( "$borrowernumber", $userid, $cardnumber,
2035 $firstname, $surname, $branchcode, $branchname, $flags ) unless $no_set_userenv;
2036 return 1, $cardnumber, $userid;
2041 "select password,cardnumber,borrowernumber,userid,firstname,surname,borrowers.branchcode,branches.branchname,flags from borrowers join branches on borrowers.branchcode=branches.branchcode where cardnumber=?"
2043 $sth->execute($userid);
2045 my ( $stored_hash, $cardnumber, $borrowernumber, $userid, $firstname,
2046 $surname, $branchcode, $branchname, $flags )
2049 if ( checkpw_hash( $password, $stored_hash ) ) {
2051 C4::Context->set_userenv( $borrowernumber, $userid, $cardnumber,
2052 $firstname, $surname, $branchcode, $branchname, $flags ) unless $no_set_userenv;
2053 return 1, $cardnumber, $userid;
2060 my ( $password, $stored_hash ) = @_;
2062 return if $stored_hash eq '!';
2064 # check what encryption algorithm was implemented: Bcrypt - if the hash starts with '$2' it is Bcrypt else md5
2066 if ( substr( $stored_hash, 0, 2 ) eq '$2' ) {
2067 $hash = hash_password( $password, $stored_hash );
2069 $hash = md5_base64($password);
2071 return $hash eq $stored_hash;
2076 my $authflags = getuserflags($flags, $userid, [$dbh]);
2078 Translates integer flags into permissions strings hash.
2080 C<$flags> is the integer userflags value ( borrowers.userflags )
2081 C<$userid> is the members.userid, used for building subpermissions
2082 C<$authflags> is a hashref of permissions
2089 my $dbh = @_ ? shift : C4::Context->dbh;
2092 # I don't want to do this, but if someone logs in as the database
2093 # user, it would be preferable not to spam them to death with
2094 # numeric warnings. So, we make $flags numeric.
2095 no warnings 'numeric';
2098 my $sth = $dbh->prepare("SELECT bit, flag, defaulton FROM userflags");
2101 while ( my ( $bit, $flag, $defaulton ) = $sth->fetchrow ) {
2102 if ( ( $flags & ( 2**$bit ) ) || $defaulton ) {
2103 $userflags->{$flag} = 1;
2106 $userflags->{$flag} = 0;
2110 # get subpermissions and merge with top-level permissions
2111 my $user_subperms = get_user_subpermissions($userid);
2112 foreach my $module ( keys %$user_subperms ) {
2113 next if $userflags->{$module} == 1; # user already has permission for everything in this module
2114 $userflags->{$module} = $user_subperms->{$module};
2120 =head2 get_user_subpermissions
2122 $user_perm_hashref = get_user_subpermissions($userid);
2124 Given the userid (note, not the borrowernumber) of a staff user,
2125 return a hashref of hashrefs of the specific subpermissions
2126 accorded to the user. An example return is
2130 export_catalog => 1,
2131 import_patrons => 1,
2135 The top-level hash-key is a module or function code from
2136 userflags.flag, while the second-level key is a code
2139 The results of this function do not give a complete picture
2140 of the functions that a staff user can access; it is also
2141 necessary to check borrowers.flags.
2145 sub get_user_subpermissions {
2148 my $dbh = C4::Context->dbh;
2149 my $sth = $dbh->prepare( "SELECT flag, user_permissions.code
2150 FROM user_permissions
2151 JOIN permissions USING (module_bit, code)
2152 JOIN userflags ON (module_bit = bit)
2153 JOIN borrowers USING (borrowernumber)
2154 WHERE userid = ?" );
2155 $sth->execute($userid);
2157 my $user_perms = {};
2158 while ( my $perm = $sth->fetchrow_hashref ) {
2159 $user_perms->{ $perm->{'flag'} }->{ $perm->{'code'} } = 1;
2164 =head2 get_all_subpermissions
2166 my $perm_hashref = get_all_subpermissions();
2168 Returns a hashref of hashrefs defining all specific
2169 permissions currently defined. The return value
2170 has the same structure as that of C<get_user_subpermissions>,
2171 except that the innermost hash value is the description
2172 of the subpermission.
2176 sub get_all_subpermissions {
2177 my $dbh = C4::Context->dbh;
2178 my $sth = $dbh->prepare( "SELECT flag, code
2180 JOIN userflags ON (module_bit = bit)" );
2184 while ( my $perm = $sth->fetchrow_hashref ) {
2185 $all_perms->{ $perm->{'flag'} }->{ $perm->{'code'} } = 1;
2190 =head2 get_cataloguing_page_permissions
2192 my $required_permissions = get_cataloguing_page_permissions();
2194 Returns the required permissions to access the main cataloguing page. Useful for building
2195 the global I<can_see_cataloguing_module> template variable, and also for reusing in
2196 I<cataloging-home.pl>.
2200 sub get_cataloguing_page_permissions {
2202 my @cataloguing_tools_subperms = qw(
2209 marc_modification_templates
2217 { editcatalogue => '*' }, { tools => \@cataloguing_tools_subperms },
2218 C4::Context->preference('StockRotation') ? { stockrotation => 'manage_rotas' } : ()
2222 =head2 haspermission
2224 $flagsrequired = '*'; # Any permission at all
2225 $flagsrequired = 'a_flag'; # a_flag must be satisfied (all subpermissions)
2226 $flagsrequired = [ 'a_flag', 'b_flag' ]; # a_flag OR b_flag must be satisfied
2227 $flagsrequired = { 'a_flag => 1, 'b_flag' => 1 }; # a_flag AND b_flag must be satisfied
2228 $flagsrequired = { 'a_flag' => 'sub_a' }; # sub_a of a_flag must be satisfied
2229 $flagsrequired = { 'a_flag' => [ 'sub_a, 'sub_b' ] }; # sub_a OR sub_b of a_flag must be satisfied
2231 $flags = ($userid, $flagsrequired);
2233 C<$userid> the userid of the member
2234 C<$flags> is a query structure similar to that used by SQL::Abstract that
2235 denotes the combination of flags required. It is a required parameter.
2237 The main logic of this method is that things in arrays are OR'ed, and things
2238 in hashes are AND'ed. The `*` character can be used, at any depth, to denote `ANY`
2240 Returns member's flags or 0 if a permission is not met.
2245 my ($required, $flags) = @_;
2247 my $ref = ref($required);
2249 if ($required eq '*') {
2250 return 0 unless ( $flags or ref( $flags ) );
2252 return 0 unless ( $flags and (!ref( $flags ) || $flags->{$required} ));
2254 } elsif ($ref eq 'HASH') {
2255 foreach my $key (keys %{$required}) {
2256 next if $flags == 1;
2257 my $require = $required->{$key};
2258 my $rflags = $flags->{$key};
2259 return 0 unless _dispatch($require, $rflags);
2261 } elsif ($ref eq 'ARRAY') {
2263 foreach my $require ( @{$required} ) {
2265 ( ref($flags) && !ref($require) && ( $require ne '*' ) )
2266 ? $flags->{$require}
2268 $satisfied++ if _dispatch( $require, $rflags );
2270 return 0 unless $satisfied;
2272 croak "Unexpected structure found: $ref";
2279 my ( $userid, $flagsrequired ) = @_;
2281 #Koha::Exceptions::WrongParameter->throw('$flagsrequired should not be undef')
2282 # unless defined($flagsrequired);
2284 my $sth = C4::Context->dbh->prepare("SELECT flags FROM borrowers WHERE userid=?");
2285 $sth->execute($userid);
2286 my $row = $sth->fetchrow();
2287 my $flags = getuserflags( $row, $userid );
2289 return $flags unless defined($flagsrequired);
2290 return $flags if $flags->{superlibrarian};
2291 return _dispatch($flagsrequired, $flags);
2293 #FIXME - This fcn should return the failed permission so a suitable error msg can be delivered.
2298 $flags = ($iprange);
2300 C<$iprange> A space separated string describing an IP range. Can include single IPs or ranges
2302 Returns 1 if the remote address is in the provided iprange, or 0 otherwise.
2309 my @allowedipranges = $iprange ? split(' ', $iprange) : ();
2310 if (scalar @allowedipranges > 0) {
2312 eval { @rangelist = Net::CIDR::range2cidr(@allowedipranges); }; return 0 if $@;
2313 eval { $result = Net::CIDR::cidrlookup($ENV{'REMOTE_ADDR'}, @rangelist) } || Koha::Logger->get->warn('cidrlookup failed for ' . join(' ',@rangelist) );
2315 return $result ? 1 : 0;
2318 sub getborrowernumber {
2320 my $userenv = C4::Context->userenv;
2321 if ( defined($userenv) && ref($userenv) eq 'HASH' && $userenv->{number} ) {
2322 return $userenv->{number};
2324 my $dbh = C4::Context->dbh;
2325 for my $field ( 'userid', 'cardnumber' ) {
2327 $dbh->prepare("select borrowernumber from borrowers where $field=?");
2328 $sth->execute($userid);
2330 my ($bnumber) = $sth->fetchrow;
2337 =head2 track_login_daily
2339 track_login_daily( $userid );
2341 Wraps the call to $patron->track_login, the method used to update borrowers.lastseen. We only call track_login once a day.
2345 sub track_login_daily {
2347 return if !$userid || !C4::Context->preference('TrackLastPatronActivity');
2349 my $cache = Koha::Caches->get_instance();
2350 my $cache_key = "track_login_" . $userid;
2351 my $cached = $cache->get_from_cache($cache_key);
2352 my $today = dt_from_string()->ymd;
2353 return if $cached && $cached eq $today;
2355 my $patron = Koha::Patrons->find({ userid => $userid });
2356 return unless $patron;
2357 $patron->track_login;
2358 $cache->set_in_cache( $cache_key, $today );
2361 END { } # module clean-up code here (global destructor)
2371 Crypt::Eksblowfish::Bcrypt(3)