3 # Copyright 2000-2002 Katipo Communications
5 # This file is part of Koha.
7 # Koha is free software; you can redistribute it and/or modify it
8 # under the terms of the GNU General Public License as published by
9 # the Free Software Foundation; either version 3 of the License, or
10 # (at your option) any later version.
12 # Koha is distributed in the hope that it will be useful, but
13 # WITHOUT ANY WARRANTY; without even the implied warranty of
14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 # GNU General Public License for more details.
17 # You should have received a copy of the GNU General Public License
18 # along with Koha; if not, see <http://www.gnu.org/licenses>.
24 use Digest::MD5 qw( md5_base64 );
26 use CGI::Session::ErrorHandler;
31 use C4::Templates; # to get the template
33 use C4::Search::History;
37 use Koha::AuthUtils qw( get_script_name hash_password );
38 use Koha::Auth::TwoFactorAuth;
40 use Koha::DateUtils qw( dt_from_string );
41 use Koha::Library::Groups;
43 use Koha::Cash::Registers;
46 use Koha::Patron::Consents;
47 use List::MoreUtils qw( any );
49 use C4::Auth_with_shibboleth qw( shib_ok get_login_shib login_shib_url logout_shib checkpw_shib );
51 use C4::Log qw( logaction );
52 use Koha::CookieManager;
56 use vars qw($ldap $cas $caslogout);
57 our (@ISA, @EXPORT_OK);
59 sub psgi_env { any { /^psgi\./ } keys %ENV }
62 if (psgi_env) { die 'psgi:exit' }
66 C4::Context->set_remote_address;
72 checkauth check_api_auth get_session check_cookie_auth checkpw checkpw_internal checkpw_hash
73 get_all_subpermissions get_user_subpermissions track_login_daily in_iprange
74 get_template_and_user haspermission
77 $ldap = C4::Context->config('useldapserver') || 0;
78 $cas = C4::Context->preference('casAuthentication');
79 $caslogout = C4::Context->preference('casLogout');
82 require C4::Auth_with_ldap;
83 import C4::Auth_with_ldap qw(checkpw_ldap);
86 require C4::Auth_with_cas; # no import
87 import C4::Auth_with_cas qw(check_api_auth_cas checkpw_cas login_cas logout_cas login_cas_url logout_if_required multipleAuth getMultipleAuth);
94 C4::Auth - Authenticates Koha users
102 my $query = CGI->new;
104 my ($template, $borrowernumber, $cookie)
105 = get_template_and_user(
107 template_name => "opac-main.tt",
110 authnotrequired => 0,
111 flagsrequired => { catalogue => '*', tools => 'import_patrons' },
115 output_html_with_http_headers $query, $cookie, $template->output;
119 The main function of this module is to provide
120 authentification. However the get_template_and_user function has
121 been provided so that a users login information is passed along
122 automatically. This gets loaded into the template.
126 =head2 get_template_and_user
128 my ($template, $borrowernumber, $cookie)
129 = get_template_and_user(
131 template_name => "opac-main.tt",
134 authnotrequired => 0,
135 flagsrequired => { catalogue => '*', tools => 'import_patrons' },
139 This call passes the C<query>, C<flagsrequired> and C<authnotrequired>
140 to C<&checkauth> (in this module) to perform authentification.
141 See C<&checkauth> for an explanation of these parameters.
143 The C<template_name> is then used to find the correct template for
144 the page. The authenticated users details are loaded onto the
145 template in the logged_in_user variable (which is a Koha::Patron object). Also the
146 C<sessionID> is passed to the template. This can be used in templates
147 if cookies are disabled. It needs to be put as and input to every
150 More information on the C<gettemplate> sub can be found in the
155 sub get_template_and_user {
158 my ( $user, $cookie, $sessionID, $flags );
161 my $cookie_mgr = Koha::CookieManager->new;
163 # Get shibboleth login attribute
164 my $shib = C4::Context->config('useshibboleth') && shib_ok();
165 my $shib_login = $shib ? get_login_shib() : undef;
167 C4::Context->interface( $in->{type} );
169 $in->{'authnotrequired'} ||= 0;
171 # the following call includes a bad template check; might croak
172 my $template = C4::Templates::gettemplate(
173 $in->{'template_name'},
178 if ( $in->{'template_name'} !~ m/maintenance/ ) {
179 ( $user, $cookie, $sessionID, $flags ) = checkauth(
181 $in->{'authnotrequired'},
182 $in->{'flagsrequired'},
185 $in->{template_name},
189 # If we enforce GDPR and the user did not consent, redirect
190 # Exceptions for consent page itself and SCI/SCO system
191 if( $in->{type} eq 'opac' && $user &&
192 $in->{'template_name'} !~ /^(opac-patron-consent|sc[io]\/)/ &&
193 C4::Context->preference('GDPR_Policy') eq 'Enforced' )
195 my $consent = Koha::Patron::Consents->search({
196 borrowernumber => getborrowernumber($user),
197 type => 'GDPR_PROCESSING',
198 given_on => { '!=', undef },
201 print $in->{query}->redirect(-uri => '/cgi-bin/koha/opac-patron-consent.pl', -cookie => $cookie);
206 if ( $in->{type} eq 'opac' && $user ) {
209 my $session = get_session($sessionID);
211 $is_sco_user = $session->param('sco_user');
217 # If the user logged in is the SCO user and they try to go out of the SCO module,
218 # log the user out removing the CGISESSID cookie
219 $in->{template_name} !~ m|sco/| && $in->{template_name} !~ m|errors/errorpage.tt|
223 C4::Context->preference('AutoSelfCheckID')
224 && $user eq C4::Context->preference('AutoSelfCheckID')
232 # If the user logged in is the SCI user and they try to go out of the SCI module,
233 # kick them out unless it is SCO with a valid permission
234 # or they are a superlibrarian
235 $in->{template_name} !~ m|sci/|
236 && haspermission( $user, { self_check => 'self_checkin_module' } )
238 $in->{template_name} =~ m|sco/| && haspermission(
239 $user, { self_check => 'self_checkout_module' }
242 && $flags && $flags->{superlibrarian} != 1
249 $template = C4::Templates::gettemplate( 'opac-auth.tt', 'opac',
251 $cookie = $cookie_mgr->replace_in_list( $cookie, $in->{query}->cookie(
252 -name => 'CGISESSID',
255 -secure => ( C4::Context->https_enabled() ? 1 : 0 ),
261 script_name => get_script_name(),
264 print $in->{query}->header(
269 'X-Frame-Options' => 'SAMEORIGIN'
280 # It's possible for $user to be the borrowernumber if they don't have a
281 # userid defined (and are logging in through some other method, such
282 # as SSL certs against an email address)
284 $borrowernumber = getborrowernumber($user) if defined($user);
285 if ( !defined($borrowernumber) && defined($user) ) {
286 $patron = Koha::Patrons->find( $user );
288 $borrowernumber = $user;
290 # A bit of a hack, but I don't know there's a nicer way
292 $user = $patron->firstname . ' ' . $patron->surname;
295 $patron = Koha::Patrons->find( $borrowernumber );
296 # FIXME What to do if $patron does not exist?
300 $template->param( loggedinusername => $user ); # OBSOLETE - Do not reuse this in template, use logged_in_user.userid instead
301 $template->param( loggedinusernumber => $borrowernumber ); # FIXME Should be replaced with logged_in_user.borrowernumber
302 $template->param( logged_in_user => $patron );
303 $template->param( sessionID => $sessionID );
305 if ( $in->{'type'} eq 'opac' ) {
306 require Koha::Virtualshelves;
307 my $some_private_shelves = Koha::Virtualshelves->get_some_shelves(
309 borrowernumber => $borrowernumber,
313 my $some_public_shelves = Koha::Virtualshelves->get_some_shelves(
319 some_private_shelves => $some_private_shelves,
320 some_public_shelves => $some_public_shelves,
324 my $all_perms = get_all_subpermissions();
326 my @flagroots = qw(circulate catalogue parameters borrowers permissions reserveforothers borrow
327 editcatalogue updatecharges tools editauthorities serials reports acquisition clubs problem_reports);
329 # We are going to use the $flags returned by checkauth
330 # to create the template's parameters that will indicate
331 # which menus the user can access.
332 if ( $flags && $flags->{superlibrarian} == 1 ) {
333 $template->param( CAN_user_circulate => 1 );
334 $template->param( CAN_user_catalogue => 1 );
335 $template->param( CAN_user_parameters => 1 );
336 $template->param( CAN_user_borrowers => 1 );
337 $template->param( CAN_user_permissions => 1 );
338 $template->param( CAN_user_reserveforothers => 1 );
339 $template->param( CAN_user_editcatalogue => 1 );
340 $template->param( CAN_user_updatecharges => 1 );
341 $template->param( CAN_user_acquisition => 1 );
342 $template->param( CAN_user_suggestions => 1 );
343 $template->param( CAN_user_tools => 1 );
344 $template->param( CAN_user_editauthorities => 1 );
345 $template->param( CAN_user_serials => 1 );
346 $template->param( CAN_user_reports => 1 );
347 $template->param( CAN_user_staffaccess => 1 );
348 $template->param( CAN_user_coursereserves => 1 );
349 $template->param( CAN_user_plugins => 1 );
350 $template->param( CAN_user_lists => 1 );
351 $template->param( CAN_user_clubs => 1 );
352 $template->param( CAN_user_ill => 1 );
353 $template->param( CAN_user_stockrotation => 1 );
354 $template->param( CAN_user_cash_management => 1 );
355 $template->param( CAN_user_problem_reports => 1 );
356 $template->param( CAN_user_recalls => 1 );
358 foreach my $module ( keys %$all_perms ) {
359 foreach my $subperm ( keys %{ $all_perms->{$module} } ) {
360 $template->param( "CAN_user_${module}_${subperm}" => 1 );
366 foreach my $module ( keys %$all_perms ) {
367 if ( defined($flags->{$module}) && $flags->{$module} == 1 ) {
368 foreach my $subperm ( keys %{ $all_perms->{$module} } ) {
369 $template->param( "CAN_user_${module}_${subperm}" => 1 );
371 } elsif ( ref( $flags->{$module} ) ) {
372 foreach my $subperm ( keys %{ $flags->{$module} } ) {
373 $template->param( "CAN_user_${module}_${subperm}" => 1 );
380 foreach my $module ( keys %$flags ) {
381 if ( $flags->{$module} == 1 or ref( $flags->{$module} ) ) {
382 $template->param( "CAN_user_$module" => 1 );
387 # Logged-in opac search history
388 # If the requested template is an opac one and opac search history is enabled
389 if ( $in->{type} eq 'opac' && C4::Context->preference('EnableOpacSearchHistory') ) {
390 my $dbh = C4::Context->dbh;
391 my $query = "SELECT COUNT(*) FROM search_history WHERE userid=?";
392 my $sth = $dbh->prepare($query);
393 $sth->execute($borrowernumber);
395 # If at least one search has already been performed
396 if ( $sth->fetchrow_array > 0 ) {
398 # We show the link in opac
399 $template->param( EnableOpacSearchHistory => 1 );
401 if (C4::Context->preference('LoadSearchHistoryToTheFirstLoggedUser'))
403 # And if there are searches performed when the user was not logged in,
404 # we add them to the logged-in search history
405 my @recentSearches = C4::Search::History::get_from_session( { cgi => $in->{'query'} } );
406 if (@recentSearches) {
407 my $dbh = C4::Context->dbh;
409 INSERT INTO search_history(userid, sessionid, query_desc, query_cgi, type, total, time )
410 VALUES (?, ?, ?, ?, ?, ?, ?)
412 my $sth = $dbh->prepare($query);
413 $sth->execute( $borrowernumber,
414 $in->{query}->cookie("CGISESSID"),
417 $_->{type} || 'biblio',
420 ) foreach @recentSearches;
422 # clear out the search history from the session now that
423 # we've saved it to the database
426 C4::Search::History::set_to_session( { cgi => $in->{'query'}, search_history => [] } );
428 } elsif ( $in->{type} eq 'intranet' and C4::Context->preference('EnableSearchHistory') ) {
429 $template->param( EnableSearchHistory => 1 );
432 else { # if this is an anonymous session, setup to display public lists...
434 # If shibboleth is enabled, and we're in an anonymous session, we should allow
435 # the user to attempt login via shibboleth.
437 $template->param( shibbolethAuthentication => $shib,
438 shibbolethLoginUrl => login_shib_url( $in->{'query'} ),
441 # If shibboleth is enabled and we have a shibboleth login attribute,
442 # but we are in an anonymous session, then we clearly have an invalid
443 # shibboleth koha account.
445 $template->param( invalidShibLogin => '1' );
449 $template->param( sessionID => $sessionID );
451 if ( $in->{'type'} eq 'opac' ){
452 require Koha::Virtualshelves;
453 my $some_public_shelves = Koha::Virtualshelves->get_some_shelves(
459 some_public_shelves => $some_public_shelves,
462 # Set default branch if one has been passed by the environment.
463 $template->param( default_branch => $ENV{OPAC_BRANCH_DEFAULT} ) if $ENV{OPAC_BRANCH_DEFAULT};
467 # Sysprefs disabled via URL param
468 # Note that value must be defined in order to override via ENV
469 foreach my $syspref (
475 OpacAdditionalStylesheet
477 intranetcolorstylesheet
482 $ENV{"OVERRIDE_SYSPREF_$syspref"} = q{}
483 if $in->{'query'}->param("DISABLE_SYSPREF_$syspref");
486 # Anonymous opac search history
487 # If opac search history is enabled and at least one search has already been performed
488 if ( C4::Context->preference('EnableOpacSearchHistory') ) {
489 my @recentSearches = C4::Search::History::get_from_session( { cgi => $in->{'query'} } );
490 if (@recentSearches) {
491 $template->param( EnableOpacSearchHistory => 1 );
495 if ( C4::Context->preference('dateformat') ) {
496 $template->param( dateformat => C4::Context->preference('dateformat') );
499 $template->param(auth_forwarded_hash => scalar $in->{'query'}->param('auth_forwarded_hash'));
501 # these template parameters are set the same regardless of $in->{'type'}
503 my $minPasswordLength = C4::Context->preference('minPasswordLength');
504 $minPasswordLength = 3 if not $minPasswordLength or $minPasswordLength < 3;
506 EnhancedMessagingPreferences => C4::Context->preference('EnhancedMessagingPreferences'),
507 GoogleJackets => C4::Context->preference("GoogleJackets"),
508 OpenLibraryCovers => C4::Context->preference("OpenLibraryCovers"),
509 KohaAdminEmailAddress => "" . C4::Context->preference("KohaAdminEmailAddress"),
510 LoginFirstname => ( C4::Context->userenv ? C4::Context->userenv->{"firstname"} : "Bel" ),
511 LoginSurname => C4::Context->userenv ? C4::Context->userenv->{"surname"} : "Inconnu",
512 emailaddress => C4::Context->userenv ? C4::Context->userenv->{"emailaddress"} : undef,
513 TagsEnabled => C4::Context->preference("TagsEnabled"),
514 hide_marc => C4::Context->preference("hide_marc"),
515 item_level_itypes => C4::Context->preference('item-level_itypes'),
516 patronimages => C4::Context->preference("patronimages"),
517 singleBranchMode => ( Koha::Libraries->search->count == 1 ),
518 noItemTypeImages => C4::Context->preference("noItemTypeImages"),
519 marcflavour => C4::Context->preference("marcflavour"),
520 OPACBaseURL => C4::Context->preference('OPACBaseURL'),
521 minPasswordLength => $minPasswordLength,
523 if ( $in->{'type'} eq "intranet" ) {
525 AmazonCoverImages => C4::Context->preference("AmazonCoverImages"),
526 AutoLocation => C4::Context->preference("AutoLocation"),
527 PatronAutoComplete => C4::Context->preference("PatronAutoComplete"),
528 FRBRizeEditions => C4::Context->preference("FRBRizeEditions"),
529 IndependentBranches => C4::Context->preference("IndependentBranches"),
530 IntranetNav => C4::Context->preference("IntranetNav"),
531 IntranetmainUserblock => C4::Context->preference("IntranetmainUserblock"),
532 LibraryName => C4::Context->preference("LibraryName"),
533 advancedMARCEditor => C4::Context->preference("advancedMARCEditor"),
534 canreservefromotherbranches => C4::Context->preference('canreservefromotherbranches'),
535 intranetcolorstylesheet => C4::Context->preference("intranetcolorstylesheet"),
536 IntranetFavicon => C4::Context->preference("IntranetFavicon"),
537 intranetreadinghistory => C4::Context->preference("intranetreadinghistory"),
538 intranetstylesheet => C4::Context->preference("intranetstylesheet"),
539 IntranetUserCSS => C4::Context->preference("IntranetUserCSS"),
540 IntranetUserJS => C4::Context->preference("IntranetUserJS"),
541 suggestion => C4::Context->preference("suggestion"),
542 virtualshelves => C4::Context->preference("virtualshelves"),
543 StaffSerialIssueDisplayCount => C4::Context->preference("StaffSerialIssueDisplayCount"),
544 EasyAnalyticalRecords => C4::Context->preference('EasyAnalyticalRecords'),
545 LocalCoverImages => C4::Context->preference('LocalCoverImages'),
546 OPACLocalCoverImages => C4::Context->preference('OPACLocalCoverImages'),
547 AllowMultipleCovers => C4::Context->preference('AllowMultipleCovers'),
548 EnableBorrowerFiles => C4::Context->preference('EnableBorrowerFiles'),
549 UseCourseReserves => C4::Context->preference("UseCourseReserves"),
550 useDischarge => C4::Context->preference('useDischarge'),
551 pending_checkout_notes => Koha::Checkouts->search({ noteseen => 0 }),
555 warn "template type should be OPAC, here it is=[" . $in->{'type'} . "]" unless ( $in->{'type'} eq 'opac' );
557 #TODO : replace LibraryName syspref with 'system name', and remove this html processing
558 my $LibraryNameTitle = C4::Context->preference("LibraryName");
559 $LibraryNameTitle =~ s/<(?:\/?)(?:br|p)\s*(?:\/?)>/ /sgi;
560 $LibraryNameTitle =~ s/<(?:[^<>'"]|'(?:[^']*)'|"(?:[^"]*)")*>//sg;
562 # clean up the busc param in the session
563 # if the page is not opac-detail and not the "add to list" page
564 # and not the "edit comments" page
565 if ( C4::Context->preference("OpacBrowseResults")
566 && $in->{'template_name'} =~ /opac-(.+)\.(?:tt|tmpl)$/ ) {
568 unless ( $pagename =~ /^(?:MARC|ISBD)?detail$/
569 or $pagename =~ /^showmarc$/
570 or $pagename =~ /^addbybiblionumber$/
571 or $pagename =~ /^review$/ )
573 my $sessionSearch = get_session( $sessionID );
574 $sessionSearch->clear( ["busc"] ) if $sessionSearch;
578 # variables passed from CGI: opac_css_override and opac_search_limits.
579 my $opac_search_limit = $ENV{'OPAC_SEARCH_LIMIT'};
580 my $opac_limit_override = $ENV{'OPAC_LIMIT_OVERRIDE'};
583 ( $opac_limit_override && $opac_search_limit && $opac_search_limit =~ /branch:([\w-]+)/ ) ||
584 ( $in->{'query'}->param('limit') && $in->{'query'}->param('limit') =~ /branch:([\w-]+)/ ) ||
585 ( $in->{'query'}->param('limit') && $in->{'query'}->param('limit') =~ /multibranchlimit:(\w+)/ )
587 $opac_name = $1; # opac_search_limit is a branch, so we use it.
588 } elsif ( $in->{'query'}->param('multibranchlimit') ) {
589 $opac_name = $in->{'query'}->param('multibranchlimit');
590 } elsif ( C4::Context->preference("SearchMyLibraryFirst") && C4::Context->userenv && C4::Context->userenv->{'branch'} ) {
591 $opac_name = C4::Context->userenv->{'branch'};
594 my @search_groups = Koha::Library::Groups->get_search_groups({ interface => 'opac' })->as_list;
596 AnonSuggestions => "" . C4::Context->preference("AnonSuggestions"),
597 LibrarySearchGroups => \@search_groups,
598 opac_name => $opac_name,
599 LibraryName => "" . C4::Context->preference("LibraryName"),
600 LibraryNameTitle => "" . $LibraryNameTitle,
601 OPACAmazonCoverImages => C4::Context->preference("OPACAmazonCoverImages"),
602 OPACFRBRizeEditions => C4::Context->preference("OPACFRBRizeEditions"),
603 OpacHighlightedWords => C4::Context->preference("OpacHighlightedWords"),
604 OPACShelfBrowser => "" . C4::Context->preference("OPACShelfBrowser"),
605 OPACURLOpenInNewWindow => "" . C4::Context->preference("OPACURLOpenInNewWindow"),
606 OPACUserCSS => "" . C4::Context->preference("OPACUserCSS"),
607 OpacAuthorities => C4::Context->preference("OpacAuthorities"),
608 opac_css_override => $ENV{'OPAC_CSS_OVERRIDE'},
609 opac_search_limit => $opac_search_limit,
610 opac_limit_override => $opac_limit_override,
611 OpacBrowser => C4::Context->preference("OpacBrowser"),
612 OpacCloud => C4::Context->preference("OpacCloud"),
613 OpacKohaUrl => C4::Context->preference("OpacKohaUrl"),
614 OpacPasswordChange => C4::Context->preference("OpacPasswordChange"),
615 OPACPatronDetails => C4::Context->preference("OPACPatronDetails"),
616 OPACPrivacy => C4::Context->preference("OPACPrivacy"),
617 OPACFinesTab => C4::Context->preference("OPACFinesTab"),
618 OpacTopissue => C4::Context->preference("OpacTopissue"),
619 'Version' => C4::Context->preference('Version'),
620 hidelostitems => C4::Context->preference("hidelostitems"),
621 mylibraryfirst => ( C4::Context->preference("SearchMyLibraryFirst") && C4::Context->userenv ) ? C4::Context->userenv->{'branch'} : '',
622 opacbookbag => "" . C4::Context->preference("opacbookbag"),
623 OpacFavicon => C4::Context->preference("OpacFavicon"),
624 opaclanguagesdisplay => "" . C4::Context->preference("opaclanguagesdisplay"),
625 opacreadinghistory => C4::Context->preference("opacreadinghistory"),
626 OPACUserJS => C4::Context->preference("OPACUserJS"),
627 opacuserlogin => "" . C4::Context->preference("opacuserlogin"),
628 OpenLibrarySearch => C4::Context->preference("OpenLibrarySearch"),
629 ShowReviewer => C4::Context->preference("ShowReviewer"),
630 ShowReviewerPhoto => C4::Context->preference("ShowReviewerPhoto"),
631 suggestion => "" . C4::Context->preference("suggestion"),
632 virtualshelves => "" . C4::Context->preference("virtualshelves"),
633 OPACSerialIssueDisplayCount => C4::Context->preference("OPACSerialIssueDisplayCount"),
634 SyndeticsClientCode => C4::Context->preference("SyndeticsClientCode"),
635 SyndeticsEnabled => C4::Context->preference("SyndeticsEnabled"),
636 SyndeticsCoverImages => C4::Context->preference("SyndeticsCoverImages"),
637 SyndeticsTOC => C4::Context->preference("SyndeticsTOC"),
638 SyndeticsSummary => C4::Context->preference("SyndeticsSummary"),
639 SyndeticsEditions => C4::Context->preference("SyndeticsEditions"),
640 SyndeticsExcerpt => C4::Context->preference("SyndeticsExcerpt"),
641 SyndeticsReviews => C4::Context->preference("SyndeticsReviews"),
642 SyndeticsAuthorNotes => C4::Context->preference("SyndeticsAuthorNotes"),
643 SyndeticsAwards => C4::Context->preference("SyndeticsAwards"),
644 SyndeticsSeries => C4::Context->preference("SyndeticsSeries"),
645 SyndeticsCoverImageSize => C4::Context->preference("SyndeticsCoverImageSize"),
646 OPACLocalCoverImages => C4::Context->preference("OPACLocalCoverImages"),
647 PatronSelfRegistration => C4::Context->preference("PatronSelfRegistration"),
648 PatronSelfRegistrationDefaultCategory => C4::Context->preference("PatronSelfRegistrationDefaultCategory"),
649 useDischarge => C4::Context->preference('useDischarge'),
652 $template->param( OpacPublic => '1' ) if ( $user || C4::Context->preference("OpacPublic") );
655 # Check if we were asked using parameters to force a specific language
656 if ( defined $in->{'query'}->param('language') ) {
658 # Extract the language, let C4::Languages::getlanguage choose
660 my $language = C4::Languages::getlanguage( $in->{'query'} );
661 my $languagecookie = C4::Templates::getlanguagecookie( $in->{'query'}, $language );
662 $cookie = $cookie_mgr->replace_in_list( $cookie, $languagecookie );
665 return ( $template, $borrowernumber, $cookie, $flags );
670 ($userid, $cookie, $sessionID) = &checkauth($query, $noauth, $flagsrequired, $type);
672 Verifies that the user is authorized to run this script. If
673 the user is authorized, a (userid, cookie, session-id, flags)
674 quadruple is returned. If the user is not authorized but does
675 not have the required privilege (see $flagsrequired below), it
676 displays an error page and exits. Otherwise, it displays the
677 login page and exits.
679 Note that C<&checkauth> will return if and only if the user
680 is authorized, so it should be called early on, before any
681 unfinished operations (e.g., if you've opened a file, then
682 C<&checkauth> won't close it for you).
684 C<$query> is the CGI object for the script calling C<&checkauth>.
686 The C<$noauth> argument is optional. If it is set, then no
687 authorization is required for the script.
689 C<&checkauth> fetches user and session information from C<$query> and
690 ensures that the user is authorized to run scripts that require
693 The C<$flagsrequired> argument specifies the required privileges
694 the user must have if the username and password are correct.
695 It should be specified as a reference-to-hash; keys in the hash
696 should be the "flags" for the user, as specified in the Members
697 intranet module. Any key specified must correspond to a "flag"
698 in the userflags table. E.g., { circulate => 1 } would specify
699 that the user must have the "circulate" privilege in order to
700 proceed. To make sure that access control is correct, the
701 C<$flagsrequired> parameter must be specified correctly.
703 Koha also has a concept of sub-permissions, also known as
704 granular permissions. This makes the value of each key
705 in the C<flagsrequired> hash take on an additional
710 The user must have access to all subfunctions of the module
711 specified by the hash key.
715 The user must have access to at least one subfunction of the module
716 specified by the hash key.
718 specific permission, e.g., 'export_catalog'
720 The user must have access to the specific subfunction list, which
721 must correspond to a row in the permissions table.
723 The C<$type> argument specifies whether the template should be
724 retrieved from the opac or intranet directory tree. "opac" is
725 assumed if it is not specified; however, if C<$type> is specified,
726 "intranet" is assumed if it is not "opac".
728 If C<$query> does not have a valid session ID associated with it
729 (i.e., the user has not logged in) or if the session has expired,
730 C<&checkauth> presents the user with a login page (from the point of
731 view of the original script, C<&checkauth> does not return). Once the
732 user has authenticated, C<&checkauth> restarts the original script
733 (this time, C<&checkauth> returns).
735 The login page is provided using a HTML::Template, which is set in the
736 systempreferences table or at the top of this file. The variable C<$type>
737 selects which template to use, either the opac or the intranet
738 authentification template.
740 C<&checkauth> returns a user ID, a cookie, and a session ID. The
741 cookie should be sent back to the browser; it verifies that the user
751 # If version syspref is unavailable, it means Koha is being installed,
752 # and so we must redirect to OPAC maintenance page or to the WebInstaller
753 # also, if OpacMaintenance is ON, OPAC should redirect to maintenance
754 if ( C4::Context->preference('OpacMaintenance') && $type eq 'opac' ) {
755 warn "OPAC Install required, redirecting to maintenance";
756 print $query->redirect("/cgi-bin/koha/maintenance.pl");
759 unless ( $version = C4::Context->preference('Version') ) { # assignment, not comparison
760 if ( $type ne 'opac' ) {
761 warn "Install required, redirecting to Installer";
762 print $query->redirect("/cgi-bin/koha/installer/install.pl");
764 warn "OPAC Install required, redirecting to maintenance";
765 print $query->redirect("/cgi-bin/koha/maintenance.pl");
770 # check that database and koha version are the same
771 # there is no DB version, it's a fresh install,
772 # go to web installer
773 # there is a DB version, compare it to the code version
774 my $kohaversion = Koha::version();
776 # remove the 3 last . to have a Perl number
777 $kohaversion =~ s/(.*\..*)\.(.*)\.(.*)/$1$2$3/;
778 Koha::Logger->get->debug("kohaversion : $kohaversion");
779 if ( $version < $kohaversion ) {
780 my $warning = "Database update needed, redirecting to %s. Database is $version and Koha is $kohaversion";
781 if ( $type ne 'opac' ) {
782 warn sprintf( $warning, 'Installer' );
783 print $query->redirect("/cgi-bin/koha/installer/install.pl?step=1&op=updatestructure");
785 warn sprintf( "OPAC: " . $warning, 'maintenance' );
786 print $query->redirect("/cgi-bin/koha/maintenance.pl");
792 sub _timeout_syspref {
793 my $default_timeout = 600;
794 my $timeout = C4::Context->preference('timeout') || $default_timeout;
796 # value in days, convert in seconds
797 if ( $timeout =~ /^(\d+)[dD]$/ ) {
798 $timeout = $1 * 86400;
800 # value in hours, convert in seconds
801 elsif ( $timeout =~ /^(\d+)[hH]$/ ) {
802 $timeout = $1 * 3600;
804 elsif ( $timeout !~ m/^\d+$/ ) {
805 warn "The value of the system preference 'timeout' is not correct, defaulting to $default_timeout";
806 $timeout = $default_timeout;
815 # Get shibboleth login attribute
816 my $shib = C4::Context->config('useshibboleth') && shib_ok();
817 my $shib_login = $shib ? get_login_shib() : undef;
819 # $authnotrequired will be set for scripts which will run without authentication
820 my $authnotrequired = shift;
821 my $flagsrequired = shift;
823 my $emailaddress = shift;
824 my $template_name = shift;
825 $type = 'opac' unless $type;
827 unless ( C4::Context->preference("OpacPublic") ) {
828 my @allowed_scripts_for_private_opac = qw(
830 opac-registration-email-sent.tt
831 opac-registration-confirmation.tt
832 opac-memberentry-update-submitted.tt
833 opac-password-recovery.tt
834 opac-reset-password.tt
836 $authnotrequired = 0 unless grep { $_ eq $template_name }
837 @allowed_scripts_for_private_opac;
840 my $dbh = C4::Context->dbh;
841 my $timeout = _timeout_syspref();
843 my $cookie_mgr = Koha::CookieManager->new;
845 _version_check( $type, $query );
849 my $auth_state = 'failed';
851 my ( $userid, $cookie, $sessionID, $flags );
853 my $logout = $query->param('logout.x');
855 my $anon_search_history;
857 # This parameter is the name of the CAS server we want to authenticate against,
858 # when using authentication against multiple CAS servers, as configured in Auth_cas_servers.yaml
859 my $casparam = $query->param('cas');
860 my $q_userid = $query->param('userid') // '';
863 my $invalid_otp_token;
864 my $require_2FA = ( C4::Context->preference('TwoFactorAuthentication') && $type ne "OPAC" ) ? 1 : 0;
866 # Basic authentication is incompatible with the use of Shibboleth,
867 # as Shibboleth may return REMOTE_USER as a Shibboleth attribute,
868 # and it may not be the attribute we want to use to match the koha login.
870 # Also, do not consider an empty REMOTE_USER.
872 # Finally, after those tests, we can assume (although if it would be better with
873 # a syspref) that if we get a REMOTE_USER, that's from basic authentication,
874 # and we can affect it to $userid.
875 if ( !$shib and defined( $ENV{'REMOTE_USER'} ) and $ENV{'REMOTE_USER'} ne '' and $userid = $ENV{'REMOTE_USER'} ) {
877 # Using Basic Authentication, no cookies required
878 $cookie = $cookie_mgr->replace_in_list( $cookie, $query->cookie(
879 -name => 'CGISESSID',
882 -secure => ( C4::Context->https_enabled() ? 1 : 0 ),
887 elsif ( $emailaddress) {
888 # the Google OpenID Connect passes an email address
890 elsif ( $sessionID = $query->cookie("CGISESSID") ) { # assignment, not comparison
891 my ( $return, $more_info );
892 # NOTE: $flags in the following call is still undefined !
893 ( $return, $session, $more_info ) = check_cookie_auth( $sessionID, $flags,
894 { remote_addr => $ENV{REMOTE_ADDR}, skip_version_check => 1 }
897 if ( $return eq 'ok' || $return eq 'additional-auth-needed' ) {
898 $userid = $session->param('id');
902 $return eq 'ok' ? 'completed'
903 : $return eq 'additional-auth-needed' ? 'additional-auth-needed'
906 # We are at the second screen if the waiting-for-2FA is set in session
907 # and otp_token param has been passed
909 && $auth_state eq 'additional-auth-needed'
910 && ( my $otp_token = $query->param('otp_token') ) )
912 my $patron = Koha::Patrons->find( { userid => $userid } );
913 my $auth = Koha::Auth::TwoFactorAuth->new( { patron => $patron } );
914 my $verified = $auth->verify($otp_token, 1);
917 # The token is correct, the user is fully logged in!
918 $auth_state = 'completed';
919 $session->param( 'waiting-for-2FA', 0 );
921 # This is an ugly trick to pass the test
922 # $query->param('koha_login_context') && ( $q_userid ne $userid )
927 $invalid_otp_token = 1;
931 if ( $auth_state eq 'completed' ) {
932 Koha::Logger->get->debug(sprintf "AUTH_SESSION: (%s)\t%s %s - %s", map { $session->param($_) || q{} } qw(cardnumber firstname surname branch));
934 if ( ( $query->param('koha_login_context') && ( $q_userid ne $userid ) )
935 || ( $cas && $query->param('ticket') && !C4::Context->userenv->{'id'} )
936 || ( $shib && $shib_login && !$logout && !C4::Context->userenv->{'id'} )
939 #if a user enters an id ne to the id in the current session, we need to log them in...
940 #first we need to clear the anonymous session...
941 $anon_search_history = $session->param('search_history');
944 $cookie = $cookie_mgr->clear_unless( $query->cookie, @$cookie );
945 C4::Context::_unset_userenv($sessionID);
949 $cookie = $cookie_mgr->replace_in_list( $cookie, $query->cookie(
950 -name => 'CGISESSID',
951 -value => $session->id,
953 -secure => ( C4::Context->https_enabled() ? 1 : 0 ),
957 $flags = haspermission( $userid, $flagsrequired );
959 $auth_state = 'failed';
960 $info{'nopermission'} = 1;
963 } elsif ( !$logout ) {
964 if ( $return eq 'expired' ) {
965 $info{timed_out} = 1;
966 } elsif ( $return eq 'restricted' ) {
967 $info{oldip} = $more_info->{old_ip};
968 $info{newip} = $more_info->{new_ip};
969 $info{different_ip} = 1;
970 } elsif ( $return eq 'password_expired' ) {
971 $info{password_has_expired} = 1;
976 if ( $auth_state eq 'failed' || $logout ) {
983 # voluntary logout the user
984 # check wether the user was using their shibboleth session or a local one
985 my $shibSuccess = C4::Context->userenv->{'shibboleth'};
990 C4::Context::_unset_userenv($sessionID);
991 $cookie = $cookie_mgr->clear_unless( $query->cookie, @$cookie );
993 if ($cas and $caslogout) {
994 logout_cas($query, $type);
997 # If we are in a shibboleth session (shibboleth is enabled, a shibboleth match attribute is set and matches koha matchpoint)
998 if ( $shib and $shib_login and $shibSuccess) {
1003 $auth_state = 'logout';
1006 unless ( $userid ) {
1007 #we initiate a session prior to checking for a username to allow for anonymous sessions...
1008 if( !$session or !$sessionID ) { # if we cleared sessionID, we need a new session
1009 $session = get_session() or die "Auth ERROR: Cannot get_session()";
1012 # Save anonymous search history in new session so it can be retrieved
1013 # by get_template_and_user to store it in user's search history after
1014 # a successful login.
1015 if ($anon_search_history) {
1016 $session->param( 'search_history', $anon_search_history );
1019 $sessionID = $session->id;
1020 C4::Context->_new_userenv($sessionID);
1021 $cookie = $cookie_mgr->replace_in_list( $cookie, $query->cookie(
1022 -name => 'CGISESSID',
1023 -value => $sessionID,
1025 -secure => ( C4::Context->https_enabled() ? 1 : 0 ),
1028 my $pki_field = C4::Context->preference('AllowPKIAuth');
1029 if ( !defined($pki_field) ) {
1030 print STDERR "ERROR: Missing system preference AllowPKIAuth.\n";
1031 $pki_field = 'None';
1033 if ( ( $cas && $query->param('ticket') )
1035 || ( $shib && $shib_login )
1036 || $pki_field ne 'None'
1039 my $password = $query->param('password');
1040 my $shibSuccess = 0;
1041 my ( $return, $cardnumber );
1043 # If shib is enabled and we have a shib login, does the login match a valid koha user
1044 if ( $shib && $shib_login ) {
1047 # Do not pass password here, else shib will not be checked in checkpw.
1048 ( $return, $cardnumber, $retuserid ) = checkpw( $dbh, $q_userid, undef, $query );
1049 $userid = $retuserid;
1050 $shibSuccess = $return;
1051 $info{'invalidShibLogin'} = 1 unless ($return);
1054 # If shib login and match were successful, skip further login methods
1055 unless ($shibSuccess) {
1056 if ( $cas && $query->param('ticket') ) {
1058 ( $return, $cardnumber, $retuserid, $cas_ticket ) =
1059 checkpw( $dbh, $userid, $password, $query, $type );
1060 $userid = $retuserid;
1061 $info{'invalidCasLogin'} = 1 unless ($return);
1064 elsif ( $emailaddress ) {
1065 my $value = $emailaddress;
1067 # If we're looking up the email, there's a chance that the person
1068 # doesn't have a userid. So if there is none, we pass along the
1069 # borrower number, and the bits of code that need to know the user
1070 # ID will have to be smart enough to handle that.
1071 my $patrons = Koha::Patrons->search({ email => $value });
1072 if ($patrons->count) {
1074 # First the userid, then the borrowernum
1075 my $patron = $patrons->next;
1076 $value = $patron->userid || $patron->borrowernumber;
1080 $return = $value ? 1 : 0;
1085 ( $pki_field eq 'Common Name' && $ENV{'SSL_CLIENT_S_DN_CN'} )
1086 || ( $pki_field eq 'emailAddress'
1087 && $ENV{'SSL_CLIENT_S_DN_Email'} )
1091 if ( $pki_field eq 'Common Name' ) {
1092 $value = $ENV{'SSL_CLIENT_S_DN_CN'};
1094 elsif ( $pki_field eq 'emailAddress' ) {
1095 $value = $ENV{'SSL_CLIENT_S_DN_Email'};
1097 # If we're looking up the email, there's a chance that the person
1098 # doesn't have a userid. So if there is none, we pass along the
1099 # borrower number, and the bits of code that need to know the user
1100 # ID will have to be smart enough to handle that.
1101 my $patrons = Koha::Patrons->search({ email => $value });
1102 if ($patrons->count) {
1104 # First the userid, then the borrowernum
1105 my $patron = $patrons->next;
1106 $value = $patron->userid || $patron->borrowernumber;
1112 $return = $value ? 1 : 0;
1118 my $request_method = $query->request_method();
1121 $request_method eq 'POST'
1122 || ( C4::Context->preference('AutoSelfCheckID')
1123 && $q_userid eq C4::Context->preference('AutoSelfCheckID') )
1127 ( $return, $cardnumber, $retuserid, $cas_ticket ) =
1128 checkpw( $dbh, $q_userid, $password, $query, $type );
1129 $userid = $retuserid if ($retuserid);
1130 $info{'invalid_username_or_password'} = 1 unless ($return);
1135 # If shib configured and shibOnly enabled, we should ignore anything other than a shibboleth type login.
1142 && C4::Context->preference('OPACShibOnly')
1144 || ( ( $type ne 'opac' )
1145 && C4::Context->preference('staffShibOnly') )
1152 # $return: 1 = valid user
1155 if ( $flags = haspermission( $userid, $flagsrequired ) ) {
1156 $auth_state = "logged_in";
1159 $info{'nopermission'} = 1;
1160 C4::Context::_unset_userenv($sessionID);
1162 my ( $borrowernumber, $firstname, $surname, $userflags,
1163 $branchcode, $branchname, $emailaddress, $desk_id,
1164 $desk_name, $register_id, $register_name );
1166 if ( $return == 1 ) {
1168 SELECT borrowernumber, firstname, surname, flags, borrowers.branchcode,
1169 branches.branchname as branchname, email
1171 LEFT JOIN branches on borrowers.branchcode=branches.branchcode
1173 my $sth = $dbh->prepare("$select where userid=?");
1174 $sth->execute($userid);
1175 unless ( $sth->rows ) {
1176 $sth = $dbh->prepare("$select where cardnumber=?");
1177 $sth->execute($cardnumber);
1179 unless ( $sth->rows ) {
1180 $sth->execute($userid);
1184 ( $borrowernumber, $firstname, $surname, $userflags,
1185 $branchcode, $branchname, $emailaddress ) = $sth->fetchrow;
1188 # launch a sequence to check if we have a ip for the branch, i
1189 # if we have one we replace the branchcode of the userenv by the branch bound in the ip.
1191 my $ip = $ENV{'REMOTE_ADDR'};
1193 # if they specify at login, use that
1194 if ( $query->param('branch') ) {
1195 $branchcode = $query->param('branch');
1196 my $library = Koha::Libraries->find($branchcode);
1197 $branchname = $library? $library->branchname: '';
1199 if ( $query->param('desk_id') ) {
1200 $desk_id = $query->param('desk_id');
1201 my $desk = Koha::Desks->find($desk_id);
1202 $desk_name = $desk ? $desk->desk_name : '';
1204 if ( C4::Context->preference('UseCashRegisters') ) {
1206 $query->param('register_id')
1207 ? Koha::Cash::Registers->find($query->param('register_id'))
1208 : Koha::Cash::Registers->search(
1209 { branch => $branchcode, branch_default => 1 },
1210 { rows => 1 } )->single;
1211 $register_id = $register->id if ($register);
1212 $register_name = $register->name if ($register);
1214 my $branches = { map { $_->branchcode => $_->unblessed } Koha::Libraries->search->as_list };
1215 if ( $type ne 'opac' and C4::Context->preference('AutoLocation') ) {
1217 # we have to check they are coming from the right ip range
1218 my $domain = $branches->{$branchcode}->{'branchip'};
1219 $domain =~ s|\.\*||g;
1220 if ( $ip !~ /^$domain/ ) {
1222 $cookie = $cookie_mgr->replace_in_list( $cookie, $query->cookie(
1223 -name => 'CGISESSID',
1226 -secure => ( C4::Context->https_enabled() ? 1 : 0 ),
1229 $info{'wrongip'} = 1;
1233 foreach my $br ( keys %$branches ) {
1235 # now we work with the treatment of ip
1236 my $domain = $branches->{$br}->{'branchip'};
1237 if ( $domain && $ip =~ /^$domain/ ) {
1238 $branchcode = $branches->{$br}->{'branchcode'};
1240 # new op dev : add the branchname to the cookie
1241 $branchname = $branches->{$br}->{'branchname'};
1245 my $is_sco_user = 0;
1246 if ( $query->param('sco_user_login') && ( $query->param('sco_user_login') eq '1' ) ){
1250 $session->param( 'number', $borrowernumber );
1251 $session->param( 'id', $userid );
1252 $session->param( 'cardnumber', $cardnumber );
1253 $session->param( 'firstname', $firstname );
1254 $session->param( 'surname', $surname );
1255 $session->param( 'branch', $branchcode );
1256 $session->param( 'branchname', $branchname );
1257 $session->param( 'desk_id', $desk_id);
1258 $session->param( 'desk_name', $desk_name);
1259 $session->param( 'flags', $userflags );
1260 $session->param( 'emailaddress', $emailaddress );
1261 $session->param( 'ip', $session->remote_addr() );
1262 $session->param( 'lasttime', time() );
1263 $session->param( 'interface', $type);
1264 $session->param( 'shibboleth', $shibSuccess );
1265 $session->param( 'register_id', $register_id );
1266 $session->param( 'register_name', $register_name );
1267 $session->param( 'sco_user', $is_sco_user );
1269 $session->param('cas_ticket', $cas_ticket) if $cas_ticket;
1270 C4::Context->set_userenv(
1271 $session->param('number'), $session->param('id'),
1272 $session->param('cardnumber'), $session->param('firstname'),
1273 $session->param('surname'), $session->param('branch'),
1274 $session->param('branchname'), $session->param('flags'),
1275 $session->param('emailaddress'), $session->param('shibboleth'),
1276 $session->param('desk_id'), $session->param('desk_name'),
1277 $session->param('register_id'), $session->param('register_name')
1281 # $return: 0 = invalid user
1282 # reset to anonymous session
1285 $info{'invalid_username_or_password'} = 1;
1286 C4::Context::_unset_userenv($sessionID);
1288 $session->param( 'lasttime', time() );
1289 $session->param( 'ip', $session->remote_addr() );
1290 $session->param( 'sessiontype', 'anon' );
1291 $session->param( 'interface', $type);
1293 } # END if ( $q_userid
1294 elsif ( $type eq "opac" ) {
1296 # anonymous sessions are created only for the OPAC
1298 # setting a couple of other session vars...
1299 $session->param( 'ip', $session->remote_addr() );
1300 $session->param( 'lasttime', time() );
1301 $session->param( 'sessiontype', 'anon' );
1302 $session->param( 'interface', $type);
1305 } # END unless ($userid)
1308 if ( $auth_state eq 'logged_in' ) {
1309 $auth_state = 'completed';
1311 # Auth is completed unless an additional auth is needed
1312 if ( $require_2FA ) {
1313 my $patron = Koha::Patrons->find({userid => $userid});
1314 if ( $patron->auth_method eq 'two-factor' ) {
1315 # Ask for the OTP token
1316 $auth_state = 'additional-auth-needed';
1317 $session->param('waiting-for-2FA', 1);
1318 %info = ();# We remove the warnings/errors we may have set incorrectly before
1323 # finished authentification, now respond
1324 if ( $auth_state eq 'completed' || $authnotrequired ) {
1327 $cookie = $cookie_mgr->replace_in_list( $cookie, $query->cookie(
1328 -name => 'CGISESSID',
1331 -secure => ( C4::Context->https_enabled() ? 1 : 0 ),
1336 track_login_daily( $userid );
1338 # In case, that this request was a login attempt, we want to prevent that users can repost the opac login
1339 # request. We therefore redirect the user to the requested page again without the login parameters.
1340 # See Post/Redirect/Get (PRG) design pattern: https://en.wikipedia.org/wiki/Post/Redirect/Get
1341 if ( $type eq "opac" && $query->param('koha_login_context') && $query->param('koha_login_context') ne 'sco' && $query->param('password') && $query->param('userid') ) {
1342 my $uri = URI->new($query->url(-relative=>1, -query_string=>1));
1343 $uri->query_param_delete('userid');
1344 $uri->query_param_delete('password');
1345 $uri->query_param_delete('koha_login_context');
1346 print $query->redirect(-uri => $uri->as_string, -cookie => $cookie, -status=>'303 See other');
1350 return ( $userid, $cookie, $sessionID, $flags );
1355 # AUTH rejected, show the login/password template, after checking the DB.
1359 my $patron = Koha::Patrons->find({ userid => $q_userid }); # Not necessary logged in!
1361 # get the inputs from the incoming query
1363 my @inputs_to_clean = qw( userid password ticket logout.x otp_token );
1364 foreach my $name ( param $query) {
1365 next if grep { $name eq $_ } @inputs_to_clean;
1366 my @value = $query->multi_param($name);
1367 push @inputs, { name => $name, value => $_ } for @value;
1370 my $LibraryNameTitle = C4::Context->preference("LibraryName");
1371 $LibraryNameTitle =~ s/<(?:\/?)(?:br|p)\s*(?:\/?)>/ /sgi;
1372 $LibraryNameTitle =~ s/<(?:[^<>'"]|'(?:[^']*)'|"(?:[^"]*)")*>//sg;
1374 my $auth_template_name = ( $type eq 'opac' ) ? 'opac-auth.tt' : 'auth.tt';
1375 my $template = C4::Templates::gettemplate( $auth_template_name, $type, $query );
1379 script_name => get_script_name(),
1380 casAuthentication => C4::Context->preference("casAuthentication"),
1381 shibbolethAuthentication => $shib,
1382 suggestion => C4::Context->preference("suggestion"),
1383 virtualshelves => C4::Context->preference("virtualshelves"),
1384 LibraryName => "" . C4::Context->preference("LibraryName"),
1385 LibraryNameTitle => "" . $LibraryNameTitle,
1386 opacuserlogin => C4::Context->preference("opacuserlogin"),
1387 OpacFavicon => C4::Context->preference("OpacFavicon"),
1388 opacreadinghistory => C4::Context->preference("opacreadinghistory"),
1389 opaclanguagesdisplay => C4::Context->preference("opaclanguagesdisplay"),
1390 OPACUserJS => C4::Context->preference("OPACUserJS"),
1391 opacbookbag => "" . C4::Context->preference("opacbookbag"),
1392 OpacCloud => C4::Context->preference("OpacCloud"),
1393 OpacTopissue => C4::Context->preference("OpacTopissue"),
1394 OpacAuthorities => C4::Context->preference("OpacAuthorities"),
1395 OpacBrowser => C4::Context->preference("OpacBrowser"),
1396 TagsEnabled => C4::Context->preference("TagsEnabled"),
1397 OPACUserCSS => C4::Context->preference("OPACUserCSS"),
1398 intranetcolorstylesheet => C4::Context->preference("intranetcolorstylesheet"),
1399 intranetstylesheet => C4::Context->preference("intranetstylesheet"),
1400 IntranetNav => C4::Context->preference("IntranetNav"),
1401 IntranetFavicon => C4::Context->preference("IntranetFavicon"),
1402 IntranetUserCSS => C4::Context->preference("IntranetUserCSS"),
1403 IntranetUserJS => C4::Context->preference("IntranetUserJS"),
1404 IndependentBranches => C4::Context->preference("IndependentBranches"),
1405 AutoLocation => C4::Context->preference("AutoLocation"),
1406 wrongip => $info{'wrongip'},
1407 PatronSelfRegistration => C4::Context->preference("PatronSelfRegistration"),
1408 PatronSelfRegistrationDefaultCategory => C4::Context->preference("PatronSelfRegistrationDefaultCategory"),
1409 opac_css_override => $ENV{'OPAC_CSS_OVERRIDE'},
1410 too_many_login_attempts => ( $patron and $patron->account_locked ),
1413 $template->param( SCO_login => 1 ) if ( $query->param('sco_user_login') );
1414 $template->param( SCI_login => 1 ) if ( $query->param('sci_user_login') );
1415 $template->param( OpacPublic => C4::Context->preference("OpacPublic") );
1416 $template->param( loginprompt => 1 ) unless $info{'nopermission'};
1417 if ( $auth_state eq 'additional-auth-needed' ) {
1420 invalid_otp_token => $invalid_otp_token,
1424 if ( $type eq 'opac' ) {
1425 require Koha::Virtualshelves;
1426 my $some_public_shelves = Koha::Virtualshelves->get_some_shelves(
1432 some_public_shelves => $some_public_shelves,
1438 # Is authentication against multiple CAS servers enabled?
1439 require C4::Auth_with_cas;
1440 if ( multipleAuth() && !$casparam ) {
1441 my $casservers = getMultipleAuth();
1443 foreach my $key ( keys %$casservers ) {
1444 push @tmplservers, { name => $key, value => login_cas_url( $query, $key, $type ) . "?cas=$key" };
1447 casServersLoop => \@tmplservers
1451 casServerUrl => login_cas_url($query, undef, $type),
1456 invalidCasLogin => $info{'invalidCasLogin'}
1461 #If shibOnly is enabled just go ahead and redirect directly
1462 if ( (($type eq 'opac') && C4::Context->preference('OPACShibOnly')) || (($type ne 'opac') && C4::Context->preference('staffShibOnly')) ) {
1463 my $redirect_url = login_shib_url( $query );
1464 print $query->redirect( -uri => "$redirect_url", -status => 303 );
1469 shibbolethAuthentication => $shib,
1470 shibbolethLoginUrl => login_shib_url($query),
1474 if (C4::Context->preference('GoogleOpenIDConnect')) {
1475 if ($query->param("OpenIDConnectFailed")) {
1476 my $reason = $query->param('OpenIDConnectFailed');
1477 $template->param(invalidGoogleOpenIDConnectLogin => $reason);
1482 LibraryName => C4::Context->preference("LibraryName"),
1484 $template->param(%info);
1486 # $cookie = $query->cookie(CGISESSID => $session->id
1488 print $query->header(
1489 { type => 'text/html',
1492 'X-Frame-Options' => 'SAMEORIGIN',
1500 =head2 check_api_auth
1502 ($status, $cookie, $sessionId) = check_api_auth($query, $userflags);
1504 Given a CGI query containing the parameters 'userid' and 'password' and/or a session
1505 cookie, determine if the user has the privileges specified by C<$userflags>.
1507 C<check_api_auth> is is meant for authenticating users of web services, and
1508 consequently will always return and will not attempt to redirect the user
1511 If a valid session cookie is already present, check_api_auth will return a status
1512 of "ok", the cookie, and the Koha session ID.
1514 If no session cookie is present, check_api_auth will check the 'userid' and 'password
1515 parameters and create a session cookie and Koha session if the supplied credentials
1518 Possible return values in C<$status> are:
1522 =item "ok" -- user authenticated; C<$cookie> and C<$sessionid> have valid values.
1524 =item "failed" -- credentials are not correct; C<$cookie> and C<$sessionid> are undef
1526 =item "maintenance" -- DB is in maintenance mode; no login possible at the moment
1528 =item "expired -- session cookie has expired; API user should resubmit userid and password
1530 =item "restricted" -- The IP has changed (if SessionRestrictionByIP)
1532 =item "additional-auth-needed -- User is in an authentication process that is not finished
1538 sub check_api_auth {
1541 my $flagsrequired = shift;
1542 my $dbh = C4::Context->dbh;
1543 my $timeout = _timeout_syspref();
1545 unless ( C4::Context->preference('Version') ) {
1547 # database has not been installed yet
1548 return ( "maintenance", undef, undef );
1550 my $kohaversion = Koha::version();
1551 $kohaversion =~ s/(.*\..*)\.(.*)\.(.*)/$1$2$3/;
1552 if ( C4::Context->preference('Version') < $kohaversion ) {
1554 # database in need of version update; assume that
1555 # no API should be called while databsae is in
1557 return ( "maintenance", undef, undef );
1560 my ( $sessionID, $session );
1561 unless ( $query->param('userid') ) {
1562 $sessionID = $query->cookie("CGISESSID");
1564 if ( $sessionID && not( $cas && $query->param('PT') ) ) {
1567 ( $return, $session, undef ) = check_cookie_auth(
1568 $sessionID, $flagsrequired, { remote_addr => $ENV{REMOTE_ADDR} } );
1570 return ( $return, undef, undef ) # Cookie auth failed
1573 my $cookie = $query->cookie(
1574 -name => 'CGISESSID',
1575 -value => $session->id,
1577 -secure => ( C4::Context->https_enabled() ? 1 : 0 ),
1580 return ( $return, $cookie, $session ); # return == 'ok' here
1585 my $userid = $query->param('userid');
1586 my $password = $query->param('password');
1587 my ( $return, $cardnumber, $cas_ticket );
1590 if ( $cas && $query->param('PT') ) {
1593 # In case of a CAS authentication, we use the ticket instead of the password
1594 my $PT = $query->param('PT');
1595 ( $return, $cardnumber, $userid, $cas_ticket ) = check_api_auth_cas( $dbh, $PT, $query ); # EXTERNAL AUTH
1598 # User / password auth
1599 unless ( $userid and $password ) {
1601 # caller did something wrong, fail the authenticateion
1602 return ( "failed", undef, undef );
1605 ( $return, $cardnumber, $newuserid, $cas_ticket ) = checkpw( $dbh, $userid, $password, $query );
1608 if ( $return and haspermission( $userid, $flagsrequired ) ) {
1609 my $session = get_session("");
1610 return ( "failed", undef, undef ) unless $session;
1612 my $sessionID = $session->id;
1613 C4::Context->_new_userenv($sessionID);
1614 my $cookie = $query->cookie(
1615 -name => 'CGISESSID',
1616 -value => $sessionID,
1618 -secure => ( C4::Context->https_enabled() ? 1 : 0 ),
1621 if ( $return == 1 ) {
1623 $borrowernumber, $firstname, $surname,
1624 $userflags, $branchcode, $branchname,
1629 "select borrowernumber, firstname, surname, flags, borrowers.branchcode, branches.branchname as branchname, email from borrowers left join branches on borrowers.branchcode=branches.branchcode where userid=?"
1631 $sth->execute($userid);
1633 $borrowernumber, $firstname, $surname,
1634 $userflags, $branchcode, $branchname,
1636 ) = $sth->fetchrow if ( $sth->rows );
1638 unless ( $sth->rows ) {
1639 my $sth = $dbh->prepare(
1640 "select borrowernumber, firstname, surname, flags, borrowers.branchcode, branches.branchname as branchname, email from borrowers left join branches on borrowers.branchcode=branches.branchcode where cardnumber=?"
1642 $sth->execute($cardnumber);
1644 $borrowernumber, $firstname, $surname,
1645 $userflags, $branchcode, $branchname,
1647 ) = $sth->fetchrow if ( $sth->rows );
1649 unless ( $sth->rows ) {
1650 $sth->execute($userid);
1652 $borrowernumber, $firstname, $surname, $userflags,
1653 $branchcode, $branchname, $emailaddress
1654 ) = $sth->fetchrow if ( $sth->rows );
1658 my $ip = $ENV{'REMOTE_ADDR'};
1660 # if they specify at login, use that
1661 if ( $query->param('branch') ) {
1662 $branchcode = $query->param('branch');
1663 my $library = Koha::Libraries->find($branchcode);
1664 $branchname = $library? $library->branchname: '';
1666 my $branches = { map { $_->branchcode => $_->unblessed } Koha::Libraries->search->as_list };
1667 foreach my $br ( keys %$branches ) {
1669 # now we work with the treatment of ip
1670 my $domain = $branches->{$br}->{'branchip'};
1671 if ( $domain && $ip =~ /^$domain/ ) {
1672 $branchcode = $branches->{$br}->{'branchcode'};
1674 # new op dev : add the branchname to the cookie
1675 $branchname = $branches->{$br}->{'branchname'};
1678 $session->param( 'number', $borrowernumber );
1679 $session->param( 'id', $userid );
1680 $session->param( 'cardnumber', $cardnumber );
1681 $session->param( 'firstname', $firstname );
1682 $session->param( 'surname', $surname );
1683 $session->param( 'branch', $branchcode );
1684 $session->param( 'branchname', $branchname );
1685 $session->param( 'flags', $userflags );
1686 $session->param( 'emailaddress', $emailaddress );
1687 $session->param( 'ip', $session->remote_addr() );
1688 $session->param( 'lasttime', time() );
1689 $session->param( 'interface', 'api' );
1691 $session->param( 'cas_ticket', $cas_ticket);
1692 C4::Context->set_userenv(
1693 $session->param('number'), $session->param('id'),
1694 $session->param('cardnumber'), $session->param('firstname'),
1695 $session->param('surname'), $session->param('branch'),
1696 $session->param('branchname'), $session->param('flags'),
1697 $session->param('emailaddress'), $session->param('shibboleth'),
1698 $session->param('desk_id'), $session->param('desk_name'),
1699 $session->param('register_id'), $session->param('register_name')
1701 return ( "ok", $cookie, $sessionID );
1703 return ( "failed", undef, undef );
1708 =head2 check_cookie_auth
1710 ($status, $sessionId) = check_cookie_auth($cookie, $userflags);
1712 Given a CGISESSID cookie set during a previous login to Koha, determine
1713 if the user has the privileges specified by C<$userflags>. C<$userflags>
1714 is passed unaltered into C<haspermission> and as such accepts all options
1715 avaiable to that routine with the one caveat that C<check_api_auth> will
1716 also allow 'undef' to be passed and in such a case the permissions check
1717 will be skipped altogether.
1719 C<check_cookie_auth> is meant for authenticating special services
1720 such as tools/upload-file.pl that are invoked by other pages that
1721 have been authenticated in the usual way.
1723 Possible return values in C<$status> are:
1727 =item "ok" -- user authenticated; C<$sessionID> have valid values.
1729 =item "anon" -- user not authenticated but valid for anonymous session.
1731 =item "failed" -- credentials are not correct; C<$sessionid> are undef
1733 =item "maintenance" -- DB is in maintenance mode; no login possible at the moment
1735 =item "expired -- session cookie has expired; API user should resubmit userid and password
1737 =item "restricted" -- The IP has changed (if SessionRestrictionByIP)
1743 sub check_cookie_auth {
1744 my $sessionID = shift;
1745 my $flagsrequired = shift;
1748 my $remote_addr = $params->{remote_addr} || $ENV{REMOTE_ADDR};
1750 my $skip_version_check = $params->{skip_version_check}; # Only for checkauth
1752 unless ( $skip_version_check ) {
1753 unless ( C4::Context->preference('Version') ) {
1755 # database has not been installed yet
1756 return ( "maintenance", undef );
1758 my $kohaversion = Koha::version();
1759 $kohaversion =~ s/(.*\..*)\.(.*)\.(.*)/$1$2$3/;
1760 if ( C4::Context->preference('Version') < $kohaversion ) {
1762 # database in need of version update; assume that
1763 # no API should be called while databsae is in
1765 return ( "maintenance", undef );
1769 # see if we have a valid session cookie already
1770 # however, if a userid parameter is present (i.e., from
1771 # a form submission, assume that any current cookie
1773 unless ( $sessionID ) {
1774 return ( "failed", undef );
1776 C4::Context::_unset_userenv($sessionID); # remove old userenv first
1777 my $session = get_session($sessionID);
1779 my $userid = $session->param('id');
1780 my $ip = $session->param('ip');
1781 my $lasttime = $session->param('lasttime');
1782 my $timeout = _timeout_syspref();
1784 if ( !$lasttime || ( $lasttime < time() - $timeout ) ) {
1788 return ("expired", undef);
1790 } elsif ( C4::Context->preference('SessionRestrictionByIP') && $ip ne $remote_addr ) {
1791 # IP address changed
1794 return ( "restricted", undef, { old_ip => $ip, new_ip => $remote_addr});
1796 } elsif ( $userid ) {
1797 $session->param( 'lasttime', time() );
1798 my $patron = Koha::Patrons->find({ userid => $userid });
1799 $patron = Koha::Patron->find({ cardnumber => $userid }) unless $patron;
1800 return ("password_expired", undef ) if $patron->password_expired;
1801 my $flags = defined($flagsrequired) ? haspermission( $userid, $flagsrequired ) : 1;
1803 C4::Context->_new_userenv($sessionID);
1804 C4::Context->interface($session->param('interface'));
1805 C4::Context->set_userenv(
1806 $session->param('number'), $session->param('id') // '',
1807 $session->param('cardnumber'), $session->param('firstname'),
1808 $session->param('surname'), $session->param('branch'),
1809 $session->param('branchname'), $session->param('flags'),
1810 $session->param('emailaddress'), $session->param('shibboleth'),
1811 $session->param('desk_id'), $session->param('desk_name'),
1812 $session->param('register_id'), $session->param('register_name')
1814 return ( "additional-auth-needed", $session )
1815 if $session->param('waiting-for-2FA');
1817 return ( "ok", $session );
1821 return ( "failed", undef );
1825 C4::Context->_new_userenv($sessionID);
1826 C4::Context->interface($session->param('interface'));
1827 C4::Context->set_userenv( undef, q{} );
1828 return ( "anon", $session );
1831 return ( "expired", undef );
1838 my $session = get_session($sessionID);
1840 Given a session ID, retrieve the CGI::Session object used to store
1841 the session's state. The session object can be used to store
1842 data that needs to be accessed by different scripts during a
1845 If the C<$sessionID> parameter is an empty string, a new session
1850 sub _get_session_params {
1851 my $storage_method = C4::Context->preference('SessionStorage');
1852 if ( $storage_method eq 'mysql' ) {
1853 my $dbh = C4::Context->dbh;
1854 return { dsn => "serializer:yamlxs;driver:MySQL;id:md5", dsn_args => { Handle => $dbh } };
1856 elsif ( $storage_method eq 'Pg' ) {
1857 my $dbh = C4::Context->dbh;
1858 return { dsn => "serializer:yamlxs;driver:PostgreSQL;id:md5", dsn_args => { Handle => $dbh } };
1860 elsif ( $storage_method eq 'memcached' && Koha::Caches->get_instance->memcached_cache ) {
1861 my $memcached = Koha::Caches->get_instance()->memcached_cache;
1862 return { dsn => "serializer:yamlxs;driver:memcached;id:md5", dsn_args => { Memcached => $memcached } };
1865 # catch all defaults to tmp should work on all systems
1866 my $dir = C4::Context::temporary_directory;
1867 my $instance = C4::Context->config( 'database' ); #actually for packages not exactly the instance name, but generally safer to leave it as it is
1868 return { dsn => "serializer:yamlxs;driver:File;id:md5", dsn_args => { Directory => "$dir/cgisess_$instance" } };
1873 my $sessionID = shift;
1874 my $params = _get_session_params();
1876 if( $sessionID ) { # find existing
1877 CGI::Session::ErrorHandler->set_error( q{} ); # clear error, cpan issue #111463
1878 $session = CGI::Session->load( $params->{dsn}, $sessionID, $params->{dsn_args} );
1880 $session = CGI::Session->new( $params->{dsn}, $sessionID, $params->{dsn_args} );
1881 # no need to flush here
1887 # FIXME no_set_userenv may be replaced with force_branchcode_for_userenv
1888 # (or something similar)
1889 # Currently it's only passed from C4::SIP::ILS::Patron::check_password, but
1890 # not having a userenv defined could cause a crash.
1892 my ( $dbh, $userid, $password, $query, $type, $no_set_userenv ) = @_;
1893 $type = 'opac' unless $type;
1895 # Get shibboleth login attribute
1896 my $shib = C4::Context->config('useshibboleth') && shib_ok();
1897 my $shib_login = $shib ? get_login_shib() : undef;
1901 if ( defined $userid ){
1902 $patron = Koha::Patrons->find({ userid => $userid });
1903 $patron = Koha::Patrons->find({ cardnumber => $userid }) unless $patron;
1905 my $check_internal_as_fallback = 0;
1907 # Note: checkpw_* routines returns:
1910 # -1 if user bind failed (LDAP only)
1912 if ( $patron and ( $patron->account_locked ) ) {
1913 # Nothing to check, account is locked
1914 } elsif ($ldap && defined($password)) {
1915 my ( $retval, $retcard, $retuserid ) = checkpw_ldap(@_); # EXTERNAL AUTH
1916 if ( $retval == 1 ) {
1917 @return = ( $retval, $retcard, $retuserid );
1920 $check_internal_as_fallback = 1 if $retval == 0;
1922 } elsif ( $cas && $query && $query->param('ticket') ) {
1924 # In case of a CAS authentication, we use the ticket instead of the password
1925 my $ticket = $query->param('ticket');
1926 $query->delete('ticket'); # remove ticket to come back to original URL
1927 my ( $retval, $retcard, $retuserid, $cas_ticket ) = checkpw_cas( $dbh, $ticket, $query, $type ); # EXTERNAL AUTH
1929 @return = ( $retval, $retcard, $retuserid, $cas_ticket );
1933 $passwd_ok = $retval;
1936 # If we are in a shibboleth session (shibboleth is enabled, and a shibboleth match attribute is present)
1937 # Check for password to asertain whether we want to be testing against shibboleth or another method this
1939 elsif ( $shib && $shib_login && !$password ) {
1941 # In case of a Shibboleth authentication, we expect a shibboleth user attribute
1942 # (defined under shibboleth mapping in koha-conf.xml) to contain the login of the
1943 # shibboleth-authenticated user
1945 # Then, we check if it matches a valid koha user
1947 my ( $retval, $retcard, $retuserid ) = C4::Auth_with_shibboleth::checkpw_shib($shib_login); # EXTERNAL AUTH
1949 @return = ( $retval, $retcard, $retuserid );
1951 $passwd_ok = $retval;
1954 $check_internal_as_fallback = 1;
1958 if ( $check_internal_as_fallback ) {
1959 @return = checkpw_internal( $dbh, $userid, $password, $no_set_userenv);
1960 $passwd_ok = 1 if $return[0] > 0; # 1 or 2
1965 $patron->update({ login_attempts => 0 });
1966 if( $patron->password_expired ){
1969 } elsif( !$patron->account_locked ) {
1970 $patron->update({ login_attempts => $patron->login_attempts + 1 });
1974 # Optionally log success or failure
1975 if( $patron && $passwd_ok && C4::Context->preference('AuthSuccessLog') ) {
1976 logaction( 'AUTH', 'SUCCESS', $patron->id, "Valid password for $userid", $type );
1977 } elsif( !$passwd_ok && C4::Context->preference('AuthFailureLog') ) {
1978 logaction( 'AUTH', 'FAILURE', $patron ? $patron->id : 0, "Wrong password for $userid", $type );
1984 sub checkpw_internal {
1985 my ( $dbh, $userid, $password, $no_set_userenv ) = @_;
1987 $password = Encode::encode( 'UTF-8', $password )
1988 if Encode::is_utf8($password);
1992 "select password,cardnumber,borrowernumber,userid,firstname,surname,borrowers.branchcode,branches.branchname,flags from borrowers join branches on borrowers.branchcode=branches.branchcode where userid=?"
1994 $sth->execute($userid);
1996 my ( $stored_hash, $cardnumber, $borrowernumber, $userid, $firstname,
1997 $surname, $branchcode, $branchname, $flags )
2000 if ( checkpw_hash( $password, $stored_hash ) ) {
2002 C4::Context->set_userenv( "$borrowernumber", $userid, $cardnumber,
2003 $firstname, $surname, $branchcode, $branchname, $flags ) unless $no_set_userenv;
2004 return 1, $cardnumber, $userid;
2009 "select password,cardnumber,borrowernumber,userid,firstname,surname,borrowers.branchcode,branches.branchname,flags from borrowers join branches on borrowers.branchcode=branches.branchcode where cardnumber=?"
2011 $sth->execute($userid);
2013 my ( $stored_hash, $cardnumber, $borrowernumber, $userid, $firstname,
2014 $surname, $branchcode, $branchname, $flags )
2017 if ( checkpw_hash( $password, $stored_hash ) ) {
2019 C4::Context->set_userenv( $borrowernumber, $userid, $cardnumber,
2020 $firstname, $surname, $branchcode, $branchname, $flags ) unless $no_set_userenv;
2021 return 1, $cardnumber, $userid;
2028 my ( $password, $stored_hash ) = @_;
2030 return if $stored_hash eq '!';
2032 # check what encryption algorithm was implemented: Bcrypt - if the hash starts with '$2' it is Bcrypt else md5
2034 if ( substr( $stored_hash, 0, 2 ) eq '$2' ) {
2035 $hash = hash_password( $password, $stored_hash );
2037 $hash = md5_base64($password);
2039 return $hash eq $stored_hash;
2044 my $authflags = getuserflags($flags, $userid, [$dbh]);
2046 Translates integer flags into permissions strings hash.
2048 C<$flags> is the integer userflags value ( borrowers.userflags )
2049 C<$userid> is the members.userid, used for building subpermissions
2050 C<$authflags> is a hashref of permissions
2057 my $dbh = @_ ? shift : C4::Context->dbh;
2060 # I don't want to do this, but if someone logs in as the database
2061 # user, it would be preferable not to spam them to death with
2062 # numeric warnings. So, we make $flags numeric.
2063 no warnings 'numeric';
2066 my $sth = $dbh->prepare("SELECT bit, flag, defaulton FROM userflags");
2069 while ( my ( $bit, $flag, $defaulton ) = $sth->fetchrow ) {
2070 if ( ( $flags & ( 2**$bit ) ) || $defaulton ) {
2071 $userflags->{$flag} = 1;
2074 $userflags->{$flag} = 0;
2078 # get subpermissions and merge with top-level permissions
2079 my $user_subperms = get_user_subpermissions($userid);
2080 foreach my $module ( keys %$user_subperms ) {
2081 next if $userflags->{$module} == 1; # user already has permission for everything in this module
2082 $userflags->{$module} = $user_subperms->{$module};
2088 =head2 get_user_subpermissions
2090 $user_perm_hashref = get_user_subpermissions($userid);
2092 Given the userid (note, not the borrowernumber) of a staff user,
2093 return a hashref of hashrefs of the specific subpermissions
2094 accorded to the user. An example return is
2098 export_catalog => 1,
2099 import_patrons => 1,
2103 The top-level hash-key is a module or function code from
2104 userflags.flag, while the second-level key is a code
2107 The results of this function do not give a complete picture
2108 of the functions that a staff user can access; it is also
2109 necessary to check borrowers.flags.
2113 sub get_user_subpermissions {
2116 my $dbh = C4::Context->dbh;
2117 my $sth = $dbh->prepare( "SELECT flag, user_permissions.code
2118 FROM user_permissions
2119 JOIN permissions USING (module_bit, code)
2120 JOIN userflags ON (module_bit = bit)
2121 JOIN borrowers USING (borrowernumber)
2122 WHERE userid = ?" );
2123 $sth->execute($userid);
2125 my $user_perms = {};
2126 while ( my $perm = $sth->fetchrow_hashref ) {
2127 $user_perms->{ $perm->{'flag'} }->{ $perm->{'code'} } = 1;
2132 =head2 get_all_subpermissions
2134 my $perm_hashref = get_all_subpermissions();
2136 Returns a hashref of hashrefs defining all specific
2137 permissions currently defined. The return value
2138 has the same structure as that of C<get_user_subpermissions>,
2139 except that the innermost hash value is the description
2140 of the subpermission.
2144 sub get_all_subpermissions {
2145 my $dbh = C4::Context->dbh;
2146 my $sth = $dbh->prepare( "SELECT flag, code
2148 JOIN userflags ON (module_bit = bit)" );
2152 while ( my $perm = $sth->fetchrow_hashref ) {
2153 $all_perms->{ $perm->{'flag'} }->{ $perm->{'code'} } = 1;
2158 =head2 haspermission
2160 $flagsrequired = '*'; # Any permission at all
2161 $flagsrequired = 'a_flag'; # a_flag must be satisfied (all subpermissions)
2162 $flagsrequired = [ 'a_flag', 'b_flag' ]; # a_flag OR b_flag must be satisfied
2163 $flagsrequired = { 'a_flag => 1, 'b_flag' => 1 }; # a_flag AND b_flag must be satisfied
2164 $flagsrequired = { 'a_flag' => 'sub_a' }; # sub_a of a_flag must be satisfied
2165 $flagsrequired = { 'a_flag' => [ 'sub_a, 'sub_b' ] }; # sub_a OR sub_b of a_flag must be satisfied
2167 $flags = ($userid, $flagsrequired);
2169 C<$userid> the userid of the member
2170 C<$flags> is a query structure similar to that used by SQL::Abstract that
2171 denotes the combination of flags required. It is a required parameter.
2173 The main logic of this method is that things in arrays are OR'ed, and things
2174 in hashes are AND'ed. The `*` character can be used, at any depth, to denote `ANY`
2176 Returns member's flags or 0 if a permission is not met.
2181 my ($required, $flags) = @_;
2183 my $ref = ref($required);
2185 if ($required eq '*') {
2186 return 0 unless ( $flags or ref( $flags ) );
2188 return 0 unless ( $flags and (!ref( $flags ) || $flags->{$required} ));
2190 } elsif ($ref eq 'HASH') {
2191 foreach my $key (keys %{$required}) {
2192 next if $flags == 1;
2193 my $require = $required->{$key};
2194 my $rflags = $flags->{$key};
2195 return 0 unless _dispatch($require, $rflags);
2197 } elsif ($ref eq 'ARRAY') {
2199 foreach my $require ( @{$required} ) {
2201 ( ref($flags) && !ref($require) && ( $require ne '*' ) )
2202 ? $flags->{$require}
2204 $satisfied++ if _dispatch( $require, $rflags );
2206 return 0 unless $satisfied;
2208 croak "Unexpected structure found: $ref";
2215 my ( $userid, $flagsrequired ) = @_;
2217 #Koha::Exceptions::WrongParameter->throw('$flagsrequired should not be undef')
2218 # unless defined($flagsrequired);
2220 my $sth = C4::Context->dbh->prepare("SELECT flags FROM borrowers WHERE userid=?");
2221 $sth->execute($userid);
2222 my $row = $sth->fetchrow();
2223 my $flags = getuserflags( $row, $userid );
2225 return $flags unless defined($flagsrequired);
2226 return $flags if $flags->{superlibrarian};
2227 return _dispatch($flagsrequired, $flags);
2229 #FIXME - This fcn should return the failed permission so a suitable error msg can be delivered.
2234 $flags = ($iprange);
2236 C<$iprange> A space separated string describing an IP range. Can include single IPs or ranges
2238 Returns 1 if the remote address is in the provided iprange, or 0 otherwise.
2245 my @allowedipranges = $iprange ? split(' ', $iprange) : ();
2246 if (scalar @allowedipranges > 0) {
2248 eval { @rangelist = Net::CIDR::range2cidr(@allowedipranges); }; return 0 if $@;
2249 eval { $result = Net::CIDR::cidrlookup($ENV{'REMOTE_ADDR'}, @rangelist) } || Koha::Logger->get->warn('cidrlookup failed for ' . join(' ',@rangelist) );
2251 return $result ? 1 : 0;
2254 sub getborrowernumber {
2256 my $userenv = C4::Context->userenv;
2257 if ( defined($userenv) && ref($userenv) eq 'HASH' && $userenv->{number} ) {
2258 return $userenv->{number};
2260 my $dbh = C4::Context->dbh;
2261 for my $field ( 'userid', 'cardnumber' ) {
2263 $dbh->prepare("select borrowernumber from borrowers where $field=?");
2264 $sth->execute($userid);
2266 my ($bnumber) = $sth->fetchrow;
2273 =head2 track_login_daily
2275 track_login_daily( $userid );
2277 Wraps the call to $patron->track_login, the method used to update borrowers.lastseen. We only call track_login once a day.
2281 sub track_login_daily {
2283 return if !$userid || !C4::Context->preference('TrackLastPatronActivity');
2285 my $cache = Koha::Caches->get_instance();
2286 my $cache_key = "track_login_" . $userid;
2287 my $cached = $cache->get_from_cache($cache_key);
2288 my $today = dt_from_string()->ymd;
2289 return if $cached && $cached eq $today;
2291 my $patron = Koha::Patrons->find({ userid => $userid });
2292 return unless $patron;
2293 $patron->track_login;
2294 $cache->set_in_cache( $cache_key, $today );
2297 END { } # module clean-up code here (global destructor)
2307 Crypt::Eksblowfish::Bcrypt(3)