C4/Auth.pm

   1 package C4::Auth;
   2
   3 # Copyright 2000-2002 Katipo Communications
   4 #
   5 # This file is part of Koha.
   6 #
   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.
  11 #
  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.
  16 #
  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>.
  19
  20 use strict;
  21 use warnings;
  22 use Carp qw( croak );
  23
  24 use Digest::MD5 qw( md5_base64 );
  25 use CGI::Session;
  26 use CGI::Session::ErrorHandler;
  27 use URI;
  28 use URI::QueryParam;
  29 use List::MoreUtils qw( uniq );
  30
  31 use C4::Context;
  32 use C4::Templates;    # to get the template
  33 use C4::Languages;
  34 use C4::Search::History;
  35 use Koha;
  36 use Koha::Logger;
  37 use Koha::Caches;
  38 use Koha::AuthUtils qw( get_script_name hash_password );
  39 use Koha::Auth::TwoFactorAuth;
  40 use Koha::Checkouts;
  41 use Koha::DateUtils qw( dt_from_string );
  42 use Koha::Library::Groups;
  43 use Koha::Libraries;
  44 use Koha::Cash::Registers;
  45 use Koha::Desks;
  46 use Koha::Patrons;
  47 use Koha::Patron::Consents;
  48 use List::MoreUtils qw( any );
  49 use Encode;
  50 use C4::Auth_with_shibboleth qw( shib_ok get_login_shib login_shib_url logout_shib checkpw_shib );
  51 use Net::CIDR;
  52 use C4::Log qw( logaction );
  53 use Koha::CookieManager;
  54 use Koha::Token;
  55
  56 # use utf8;
  57
  58 use vars qw($ldap $cas $caslogout);
  59 our (@ISA, @EXPORT_OK);
  60 BEGIN {
  61     sub psgi_env { any { /^psgi\./ } keys %ENV }
  62
  63     sub safe_exit {
  64         if   (psgi_env) { die 'psgi:exit' }
  65         else            { exit }
  66     }
  67
  68     C4::Context->set_remote_address;
  69
  70     require Exporter;
  71     @ISA = qw(Exporter);
  72
  73     @EXPORT_OK = qw(
  74       checkauth check_api_auth get_session check_cookie_auth checkpw checkpw_internal checkpw_hash
  75       get_all_subpermissions get_user_subpermissions track_login_daily in_iprange
  76       get_template_and_user haspermission
  77     );
  78
  79     $ldap      = C4::Context->config('useldapserver') || 0;
  80     $cas       = C4::Context->preference('casAuthentication');
  81     $caslogout = C4::Context->preference('casLogout');
  82
  83     if ($ldap) {
  84         require C4::Auth_with_ldap;
  85         import C4::Auth_with_ldap qw(checkpw_ldap);
  86     }
  87     if ($cas) {
  88         require C4::Auth_with_cas;    # no import
  89         import C4::Auth_with_cas qw(check_api_auth_cas checkpw_cas login_cas logout_cas login_cas_url logout_if_required multipleAuth getMultipleAuth);
  90     }
  91
  92 }
  93
  94 =head1 NAME
  95
  96 C4::Auth - Authenticates Koha users
  97
  98 =head1 SYNOPSIS
  99
 100   use CGI qw ( -utf8 );
 101   use C4::Auth;
 102   use C4::Output;
 103
 104   my $query = CGI->new;
 105
 106   my ($template, $borrowernumber, $cookie)
 107     = get_template_and_user(
 108         {
 109             template_name   => "opac-main.tt",
 110             query           => $query,
 111       type            => "opac",
 112       authnotrequired => 0,
 113       flagsrequired   => { catalogue => '*', tools => 'import_patrons' },
 114   }
 115     );
 116
 117   output_html_with_http_headers $query, $cookie, $template->output;
 118
 119 =head1 DESCRIPTION
 120
 121 The main function of this module is to provide
 122 authentification. However the get_template_and_user function has
 123 been provided so that a users login information is passed along
 124 automatically. This gets loaded into the template.
 125
 126 =head1 FUNCTIONS
 127
 128 =head2 get_template_and_user
 129
 130  my ($template, $borrowernumber, $cookie)
 131      = get_template_and_user(
 132        {
 133          template_name   => "opac-main.tt",
 134          query           => $query,
 135          type            => "opac",
 136          authnotrequired => 0,
 137          flagsrequired   => { catalogue => '*', tools => 'import_patrons' },
 138        }
 139      );
 140
 141 This call passes the C<query>, C<flagsrequired> and C<authnotrequired>
 142 to C<&checkauth> (in this module) to perform authentification.
 143 See C<&checkauth> for an explanation of these parameters.
 144
 145 The C<template_name> is then used to find the correct template for
 146 the page. The authenticated users details are loaded onto the
 147 template in the logged_in_user variable (which is a Koha::Patron object). Also the
 148 C<sessionID> is passed to the template. This can be used in templates
 149 if cookies are disabled. It needs to be put as and input to every
 150 authenticated page.
 151
 152 More information on the C<gettemplate> sub can be found in the
 153 Output.pm module.
 154
 155 =cut
 156
 157 sub get_template_and_user {
 158
 159     my $in = shift;
 160     my ( $user, $cookie, $sessionID, $flags );
 161     $cookie = [];
 162
 163     my $cookie_mgr = Koha::CookieManager->new;
 164
 165     # Get shibboleth login attribute
 166     my $shib = C4::Context->config('useshibboleth') && shib_ok();
 167     my $shib_login = $shib ? get_login_shib() : undef;
 168
 169     C4::Context->interface( $in->{type} );
 170
 171     $in->{'authnotrequired'} ||= 0;
 172
 173     # the following call includes a bad template check; might croak
 174     my $template = C4::Templates::gettemplate(
 175         $in->{'template_name'},
 176         $in->{'type'},
 177         $in->{'query'},
 178     );
 179
 180     if ( $in->{'template_name'} !~ m/maintenance/ ) {
 181         ( $user, $cookie, $sessionID, $flags ) = checkauth(
 182             $in->{'query'},
 183             $in->{'authnotrequired'},
 184             $in->{'flagsrequired'},
 185             $in->{'type'},
 186             undef,
 187             $in->{template_name},
 188         );
 189     }
 190
 191     # If we enforce GDPR and the user did not consent, redirect
 192     # Exceptions for consent page itself and SCI/SCO system
 193     if( $in->{type} eq 'opac' && $user &&
 194         $in->{'template_name'} !~ /^(opac-patron-consent|sc[io]\/)/ &&
 195         C4::Context->preference('GDPR_Policy') eq 'Enforced' )
 196     {
 197         my $consent = Koha::Patron::Consents->search({
 198             borrowernumber => getborrowernumber($user),
 199             type => 'GDPR_PROCESSING',
 200             given_on => { '!=', undef },
 201         })->next;
 202         if( !$consent ) {
 203             print $in->{query}->redirect(-uri => '/cgi-bin/koha/opac-patron-consent.pl', -cookie => $cookie);
 204             safe_exit;
 205         }
 206     }
 207
 208     if ( $in->{type} eq 'opac' && $user ) {
 209         my $is_sco_user;
 210         if ($sessionID){
 211             my $session = get_session($sessionID);
 212             if ($session){
 213                 $is_sco_user = $session->param('sco_user');
 214             }
 215         }
 216         my $kick_out;
 217
 218         if (
 219 # If the user logged in is the SCO user and they try to go out of the SCO module,
 220 # log the user out removing the CGISESSID cookie
 221             $in->{template_name} !~ m|sco/| && $in->{template_name} !~ m|errors/errorpage.tt|
 222             && (
 223                 $is_sco_user ||
 224                 (
 225                     C4::Context->preference('AutoSelfCheckID')
 226                     && $user eq C4::Context->preference('AutoSelfCheckID')
 227                 )
 228             )
 229           )
 230         {
 231             $kick_out = 1;
 232         }
 233         elsif (
 234 # If the user logged in is the SCI user and they try to go out of the SCI module,
 235 # kick them out unless it is SCO with a valid permission
 236 # or they are a superlibrarian
 237                $in->{template_name} !~ m|sci/|
 238             && haspermission( $user, { self_check => 'self_checkin_module' } )
 239             && !(
 240                 $in->{template_name} =~ m|sco/| && haspermission(
 241                     $user, { self_check => 'self_checkout_module' }
 242                 )
 243             )
 244             && $flags && $flags->{superlibrarian} != 1
 245           )
 246         {
 247             $kick_out = 1;
 248         }
 249
 250         if ($kick_out) {
 251             $template = C4::Templates::gettemplate( 'opac-auth.tt', 'opac',
 252                 $in->{query} );
 253             $cookie = $cookie_mgr->replace_in_list( $cookie, $in->{query}->cookie(
 254                 -name     => 'CGISESSID',
 255                 -value    => '',
 256                 -HttpOnly => 1,
 257                 -secure => ( C4::Context->https_enabled() ? 1 : 0 ),
 258                 -sameSite => 'Lax',
 259             ));
 260
 261             $template->param(
 262                 loginprompt => 1,
 263                 script_name => get_script_name(),
 264             );
 265
 266             print $in->{query}->header(
 267                 {
 268                     type              => 'text/html',
 269                     charset           => 'utf-8',
 270                     cookie            => $cookie,
 271                     'X-Frame-Options' => 'SAMEORIGIN'
 272                 }
 273               ),
 274               $template->output;
 275             safe_exit;
 276         }
 277     }
 278
 279     my $borrowernumber;
 280     my $patron;
 281     if ($user) {
 282
 283         # It's possible for $user to be the borrowernumber if they don't have a
 284         # userid defined (and are logging in through some other method, such
 285         # as SSL certs against an email address)
 286         $borrowernumber = getborrowernumber($user) if defined($user);
 287         if ( !defined($borrowernumber) && defined($user) ) {
 288             $patron = Koha::Patrons->find( $user );
 289             if ($patron) {
 290                 $borrowernumber = $user;
 291
 292                 # A bit of a hack, but I don't know there's a nicer way
 293                 # to do it.
 294                 $user = $patron->firstname . ' ' . $patron->surname;
 295             }
 296         } else {
 297             $patron = Koha::Patrons->find( $borrowernumber );
 298             # FIXME What to do if $patron does not exist?
 299         }
 300
 301         if ( $in->{'type'} eq 'opac' ) {
 302             require Koha::Virtualshelves;
 303             my $some_private_shelves = Koha::Virtualshelves->get_some_shelves(
 304                 {
 305                     borrowernumber => $borrowernumber,
 306                     public         => 0,
 307                 }
 308             );
 309             my $some_public_shelves = Koha::Virtualshelves->get_some_shelves(
 310                 {
 311                     public => 1,
 312                 }
 313             );
 314             $template->param(
 315                 some_private_shelves => $some_private_shelves,
 316                 some_public_shelves  => $some_public_shelves,
 317             );
 318         }
 319
 320         my $all_perms = get_all_subpermissions();
 321
 322         my @flagroots = qw(circulate catalogue parameters borrowers permissions reserveforothers borrow
 323           editcatalogue updatecharges tools editauthorities serials reports acquisition clubs problem_reports);
 324
 325         # We are going to use the $flags returned by checkauth
 326         # to create the template's parameters that will indicate
 327         # which menus the user can access.
 328         if ( $flags && $flags->{superlibrarian} == 1 ) {
 329             $template->param( CAN_user_circulate        => 1 );
 330             $template->param( CAN_user_catalogue        => 1 );
 331             $template->param( CAN_user_parameters       => 1 );
 332             $template->param( CAN_user_borrowers        => 1 );
 333             $template->param( CAN_user_permissions      => 1 );
 334             $template->param( CAN_user_reserveforothers => 1 );
 335             $template->param( CAN_user_editcatalogue    => 1 );
 336             $template->param( CAN_user_updatecharges    => 1 );
 337             $template->param( CAN_user_acquisition      => 1 );
 338             $template->param( CAN_user_suggestions      => 1 );
 339             $template->param( CAN_user_tools            => 1 );
 340             $template->param( CAN_user_editauthorities  => 1 );
 341             $template->param( CAN_user_serials          => 1 );
 342             $template->param( CAN_user_reports          => 1 );
 343             $template->param( CAN_user_staffaccess      => 1 );
 344             $template->param( CAN_user_coursereserves   => 1 );
 345             $template->param( CAN_user_plugins          => 1 );
 346             $template->param( CAN_user_lists            => 1 );
 347             $template->param( CAN_user_clubs            => 1 );
 348             $template->param( CAN_user_ill              => 1 );
 349             $template->param( CAN_user_stockrotation    => 1 );
 350             $template->param( CAN_user_cash_management  => 1 );
 351             $template->param( CAN_user_problem_reports  => 1 );
 352             $template->param( CAN_user_recalls          => 1 );
 353
 354             foreach my $module ( keys %$all_perms ) {
 355                 foreach my $subperm ( keys %{ $all_perms->{$module} } ) {
 356                     $template->param( "CAN_user_${module}_${subperm}" => 1 );
 357                 }
 358             }
 359         }
 360
 361         if ($flags) {
 362             foreach my $module ( keys %$all_perms ) {
 363                 if ( defined($flags->{$module}) && $flags->{$module} == 1 ) {
 364                     foreach my $subperm ( keys %{ $all_perms->{$module} } ) {
 365                         $template->param( "CAN_user_${module}_${subperm}" => 1 );
 366                     }
 367                 } elsif ( ref( $flags->{$module} ) ) {
 368                     foreach my $subperm ( keys %{ $flags->{$module} } ) {
 369                         $template->param( "CAN_user_${module}_${subperm}" => 1 );
 370                     }
 371                 }
 372             }
 373         }
 374
 375         if ($flags) {
 376             foreach my $module ( keys %$flags ) {
 377                 if ( $flags->{$module} == 1 or ref( $flags->{$module} ) ) {
 378                     $template->param( "CAN_user_$module" => 1 );
 379                 }
 380             }
 381         }
 382
 383         # Logged-in opac search history
 384         # If the requested template is an opac one and opac search history is enabled
 385         if ( $in->{type} eq 'opac' && C4::Context->preference('EnableOpacSearchHistory') ) {
 386             my $dbh   = C4::Context->dbh;
 387             my $query = "SELECT COUNT(*) FROM search_history WHERE userid=?";
 388             my $sth   = $dbh->prepare($query);
 389             $sth->execute($borrowernumber);
 390
 391             # If at least one search has already been performed
 392             if ( $sth->fetchrow_array > 0 ) {
 393
 394                 # We show the link in opac
 395                 $template->param( EnableOpacSearchHistory => 1 );
 396             }
 397             if (C4::Context->preference('LoadSearchHistoryToTheFirstLoggedUser'))
 398             {
 399                 # And if there are searches performed when the user was not logged in,
 400                 # we add them to the logged-in search history
 401                 my @recentSearches = C4::Search::History::get_from_session( { cgi => $in->{'query'} } );
 402                 if (@recentSearches) {
 403                     my $query = q{
 404                         INSERT INTO search_history(userid, sessionid, query_desc, query_cgi, type,  total, time )
 405                         VALUES (?, ?, ?, ?, ?, ?, ?)
 406                     };
 407                     my $sth = $dbh->prepare($query);
 408                     $sth->execute( $borrowernumber,
 409                         $in->{query}->cookie("CGISESSID"),
 410                         $_->{query_desc},
 411                         $_->{query_cgi},
 412                         $_->{type} || 'biblio',
 413                         $_->{total},
 414                         $_->{time},
 415                     ) foreach @recentSearches;
 416
 417                     # clear out the search history from the session now that
 418                     # we've saved it to the database
 419                  }
 420               }
 421               C4::Search::History::set_to_session( { cgi => $in->{'query'}, search_history => [] } );
 422
 423         } elsif ( $in->{type} eq 'intranet' and C4::Context->preference('EnableSearchHistory') ) {
 424             $template->param( EnableSearchHistory => 1 );
 425         }
 426     }
 427     else {    # if this is an anonymous session, setup to display public lists...
 428
 429         # If shibboleth is enabled, and we're in an anonymous session, we should allow
 430         # the user to attempt login via shibboleth.
 431         if ($shib) {
 432             $template->param( shibbolethAuthentication => $shib,
 433                 shibbolethLoginUrl => login_shib_url( $in->{'query'} ),
 434             );
 435
 436             # If shibboleth is enabled and we have a shibboleth login attribute,
 437             # but we are in an anonymous session, then we clearly have an invalid
 438             # shibboleth koha account.
 439             if ($shib_login) {
 440                 $template->param( invalidShibLogin => '1' );
 441             }
 442         }
 443
 444         if ( $in->{'type'} eq 'opac' ){
 445             require Koha::Virtualshelves;
 446             my $some_public_shelves = Koha::Virtualshelves->get_some_shelves(
 447                 {
 448                     public => 1,
 449                 }
 450             );
 451             $template->param(
 452                 some_public_shelves  => $some_public_shelves,
 453             );
 454
 455             # Set default branch if one has been passed by the environment.
 456             $template->param( default_branch => $ENV{OPAC_BRANCH_DEFAULT} ) if $ENV{OPAC_BRANCH_DEFAULT};
 457         }
 458     }
 459
 460     # Sysprefs disabled via URL param
 461     # Note that value must be defined in order to override via ENV
 462     foreach my $syspref (
 463         qw(
 464             OPACUserCSS
 465             OPACUserJS
 466             IntranetUserCSS
 467             IntranetUserJS
 468             OpacAdditionalStylesheet
 469             opaclayoutstylesheet
 470             intranetcolorstylesheet
 471             intranetstylesheet
 472         )
 473       )
 474     {
 475         $ENV{"OVERRIDE_SYSPREF_$syspref"} = q{}
 476           if $in->{'query'}->param("DISABLE_SYSPREF_$syspref");
 477     }
 478
 479     # Anonymous opac search history
 480     # If opac search history is enabled and at least one search has already been performed
 481     if ( C4::Context->preference('EnableOpacSearchHistory') ) {
 482         my @recentSearches = C4::Search::History::get_from_session( { cgi => $in->{'query'} } );
 483         if (@recentSearches) {
 484             $template->param( EnableOpacSearchHistory => 1 );
 485         }
 486     }
 487
 488     if ( C4::Context->preference('dateformat') ) {
 489         $template->param( dateformat => C4::Context->preference('dateformat') );
 490     }
 491
 492     $template->param(auth_forwarded_hash => scalar $in->{'query'}->param('auth_forwarded_hash'));
 493
 494     # these template parameters are set the same regardless of $in->{'type'}
 495
 496     my $minPasswordLength = C4::Context->preference('minPasswordLength');
 497     $minPasswordLength = 3 if not $minPasswordLength or $minPasswordLength < 3;
 498     $template->param(
 499         EnhancedMessagingPreferences                                       => C4::Context->preference('EnhancedMessagingPreferences'),
 500         GoogleJackets                                                      => C4::Context->preference("GoogleJackets"),
 501         OpenLibraryCovers                                                  => C4::Context->preference("OpenLibraryCovers"),
 502         KohaAdminEmailAddress                                              => "" . C4::Context->preference("KohaAdminEmailAddress"),
 503         LoginFirstname  => ( C4::Context->userenv ? C4::Context->userenv->{"firstname"} : "Bel" ),
 504         LoginSurname    => C4::Context->userenv ? C4::Context->userenv->{"surname"}      : "Inconnu",
 505         emailaddress    => C4::Context->userenv ? C4::Context->userenv->{"emailaddress"} : undef,
 506         TagsEnabled     => C4::Context->preference("TagsEnabled"),
 507         hide_marc       => C4::Context->preference("hide_marc"),
 508         item_level_itypes  => C4::Context->preference('item-level_itypes'),
 509         patronimages       => C4::Context->preference("patronimages"),
 510         singleBranchMode   => ( Koha::Libraries->search->count == 1 ),
 511         noItemTypeImages   => C4::Context->preference("noItemTypeImages"),
 512         marcflavour        => C4::Context->preference("marcflavour"),
 513         OPACBaseURL        => C4::Context->preference('OPACBaseURL'),
 514         minPasswordLength  => $minPasswordLength,
 515     );
 516     if ( $in->{'type'} eq "intranet" ) {
 517         $template->param(
 518             AmazonCoverImages                                                          => C4::Context->preference("AmazonCoverImages"),
 519             AutoLocation                                                               => C4::Context->preference("AutoLocation"),
 520             PatronAutoComplete                                                         => C4::Context->preference("PatronAutoComplete"),
 521             FRBRizeEditions                                                            => C4::Context->preference("FRBRizeEditions"),
 522             IndependentBranches                                                        => C4::Context->preference("IndependentBranches"),
 523             IntranetNav                                                                => C4::Context->preference("IntranetNav"),
 524             IntranetmainUserblock                                                      => C4::Context->preference("IntranetmainUserblock"),
 525             LibraryName                                                                => C4::Context->preference("LibraryName"),
 526             advancedMARCEditor                                                         => C4::Context->preference("advancedMARCEditor"),
 527             canreservefromotherbranches                                                => C4::Context->preference('canreservefromotherbranches'),
 528             intranetcolorstylesheet                                                    => C4::Context->preference("intranetcolorstylesheet"),
 529             IntranetFavicon                                                            => C4::Context->preference("IntranetFavicon"),
 530             intranetreadinghistory                                                     => C4::Context->preference("intranetreadinghistory"),
 531             intranetstylesheet                                                         => C4::Context->preference("intranetstylesheet"),
 532             IntranetUserCSS                                                            => C4::Context->preference("IntranetUserCSS"),
 533             IntranetUserJS                                                             => C4::Context->preference("IntranetUserJS"),
 534             suggestion                                                                 => C4::Context->preference("suggestion"),
 535             virtualshelves                                                             => C4::Context->preference("virtualshelves"),
 536             StaffSerialIssueDisplayCount                                               => C4::Context->preference("StaffSerialIssueDisplayCount"),
 537             EasyAnalyticalRecords                                                      => C4::Context->preference('EasyAnalyticalRecords'),
 538             LocalCoverImages                                                           => C4::Context->preference('LocalCoverImages'),
 539             OPACLocalCoverImages                                                       => C4::Context->preference('OPACLocalCoverImages'),
 540             AllowMultipleCovers                                                        => C4::Context->preference('AllowMultipleCovers'),
 541             EnableBorrowerFiles                                                        => C4::Context->preference('EnableBorrowerFiles'),
 542             UseCourseReserves                                                          => C4::Context->preference("UseCourseReserves"),
 543             useDischarge                                                               => C4::Context->preference('useDischarge'),
 544             pending_checkout_notes                                                     => Koha::Checkouts->search({ noteseen => 0 }),
 545             plugins_enabled                                                            => C4::Context->config("enable_plugins"),
 546         );
 547     }
 548     else {
 549         warn "template type should be OPAC, here it is=[" . $in->{'type'} . "]" unless ( $in->{'type'} eq 'opac' );
 550
 551         #TODO : replace LibraryName syspref with 'system name', and remove this html processing
 552         my $LibraryNameTitle = C4::Context->preference("LibraryName");
 553         $LibraryNameTitle =~ s/<(?:\/?)(?:br|p)\s*(?:\/?)>/ /sgi;
 554         $LibraryNameTitle =~ s/<(?:[^<>'"]|'(?:[^']*)'|"(?:[^"]*)")*>//sg;
 555
 556         # clean up the busc param in the session
 557         # if the page is not opac-detail and not the "add to list" page
 558         # and not the "edit comments" page
 559         if ( C4::Context->preference("OpacBrowseResults")
 560             && $in->{'template_name'} =~ /opac-(.+)\.(?:tt|tmpl)$/ ) {
 561             my $pagename = $1;
 562             unless ( $pagename =~ /^(?:MARC|ISBD)?detail$/
 563                 or $pagename =~ /^showmarc$/
 564                 or $pagename =~ /^addbybiblionumber$/
 565                 or $pagename =~ /^review$/ )
 566             {
 567                 my $sessionSearch = get_session( $sessionID );
 568                 $sessionSearch->clear( ["busc"] ) if $sessionSearch;
 569             }
 570         }
 571
 572         # variables passed from CGI: opac_css_override and opac_search_limits.
 573         my $opac_search_limit   = $ENV{'OPAC_SEARCH_LIMIT'};
 574         my $opac_limit_override = $ENV{'OPAC_LIMIT_OVERRIDE'};
 575         my $opac_name           = '';
 576         if (
 577             ( $opac_limit_override && $opac_search_limit && $opac_search_limit =~ /branch:([\w-]+)/ ) ||
 578             ( $in->{'query'}->param('limit') && $in->{'query'}->param('limit') =~ /branch:([\w-]+)/ ) ||
 579             ( $in->{'query'}->param('limit') && $in->{'query'}->param('limit') =~ /multibranchlimit:(\w+)/ )
 580           ) {
 581             $opac_name = $1;    # opac_search_limit is a branch, so we use it.
 582         } elsif ( $in->{'query'}->param('multibranchlimit') ) {
 583             $opac_name = $in->{'query'}->param('multibranchlimit');
 584         } elsif ( C4::Context->preference("SearchMyLibraryFirst") && C4::Context->userenv && C4::Context->userenv->{'branch'} ) {
 585             $opac_name = C4::Context->userenv->{'branch'};
 586         }
 587
 588         my @search_groups = Koha::Library::Groups->get_search_groups({ interface => 'opac' })->as_list;
 589         $template->param(
 590             AnonSuggestions                       => "" . C4::Context->preference("AnonSuggestions"),
 591             LibrarySearchGroups                   => \@search_groups,
 592             opac_name                             => $opac_name,
 593             LibraryName                           => "" . C4::Context->preference("LibraryName"),
 594             LibraryNameTitle                      => "" . $LibraryNameTitle,
 595             OPACAmazonCoverImages                 => C4::Context->preference("OPACAmazonCoverImages"),
 596             OPACFRBRizeEditions                   => C4::Context->preference("OPACFRBRizeEditions"),
 597             OpacHighlightedWords                  => C4::Context->preference("OpacHighlightedWords"),
 598             OPACShelfBrowser                      => "" . C4::Context->preference("OPACShelfBrowser"),
 599             OPACURLOpenInNewWindow                => "" . C4::Context->preference("OPACURLOpenInNewWindow"),
 600             OPACUserCSS                           => "" . C4::Context->preference("OPACUserCSS"),
 601             OpacAuthorities                       => C4::Context->preference("OpacAuthorities"),
 602             opac_css_override                     => $ENV{'OPAC_CSS_OVERRIDE'},
 603             opac_search_limit                     => $opac_search_limit,
 604             opac_limit_override                   => $opac_limit_override,
 605             OpacBrowser                           => C4::Context->preference("OpacBrowser"),
 606             OpacCloud                             => C4::Context->preference("OpacCloud"),
 607             OpacKohaUrl                           => C4::Context->preference("OpacKohaUrl"),
 608             OpacPasswordChange                    => C4::Context->preference("OpacPasswordChange"),
 609             OPACPatronDetails                     => C4::Context->preference("OPACPatronDetails"),
 610             OPACPrivacy                           => C4::Context->preference("OPACPrivacy"),
 611             OPACFinesTab                          => C4::Context->preference("OPACFinesTab"),
 612             OpacTopissue                          => C4::Context->preference("OpacTopissue"),
 613             'Version'                             => C4::Context->preference('Version'),
 614             hidelostitems                         => C4::Context->preference("hidelostitems"),
 615             mylibraryfirst                        => ( C4::Context->preference("SearchMyLibraryFirst") && C4::Context->userenv ) ? C4::Context->userenv->{'branch'} : '',
 616             opacbookbag                           => "" . C4::Context->preference("opacbookbag"),
 617             OpacFavicon                           => C4::Context->preference("OpacFavicon"),
 618             opaclanguagesdisplay                  => "" . C4::Context->preference("opaclanguagesdisplay"),
 619             opacreadinghistory                    => C4::Context->preference("opacreadinghistory"),
 620             OPACUserJS                            => C4::Context->preference("OPACUserJS"),
 621             opacuserlogin                         => "" . C4::Context->preference("opacuserlogin"),
 622             OpenLibrarySearch                     => C4::Context->preference("OpenLibrarySearch"),
 623             ShowReviewer                          => C4::Context->preference("ShowReviewer"),
 624             ShowReviewerPhoto                     => C4::Context->preference("ShowReviewerPhoto"),
 625             suggestion                            => "" . C4::Context->preference("suggestion"),
 626             virtualshelves                        => "" . C4::Context->preference("virtualshelves"),
 627             OPACSerialIssueDisplayCount           => C4::Context->preference("OPACSerialIssueDisplayCount"),
 628             SyndeticsClientCode                   => C4::Context->preference("SyndeticsClientCode"),
 629             SyndeticsEnabled                      => C4::Context->preference("SyndeticsEnabled"),
 630             SyndeticsCoverImages                  => C4::Context->preference("SyndeticsCoverImages"),
 631             SyndeticsTOC                          => C4::Context->preference("SyndeticsTOC"),
 632             SyndeticsSummary                      => C4::Context->preference("SyndeticsSummary"),
 633             SyndeticsEditions                     => C4::Context->preference("SyndeticsEditions"),
 634             SyndeticsExcerpt                      => C4::Context->preference("SyndeticsExcerpt"),
 635             SyndeticsReviews                      => C4::Context->preference("SyndeticsReviews"),
 636             SyndeticsAuthorNotes                  => C4::Context->preference("SyndeticsAuthorNotes"),
 637             SyndeticsAwards                       => C4::Context->preference("SyndeticsAwards"),
 638             SyndeticsSeries                       => C4::Context->preference("SyndeticsSeries"),
 639             SyndeticsCoverImageSize               => C4::Context->preference("SyndeticsCoverImageSize"),
 640             OPACLocalCoverImages                  => C4::Context->preference("OPACLocalCoverImages"),
 641             PatronSelfRegistration                => C4::Context->preference("PatronSelfRegistration"),
 642             PatronSelfRegistrationDefaultCategory => C4::Context->preference("PatronSelfRegistrationDefaultCategory"),
 643             useDischarge                 => C4::Context->preference('useDischarge'),
 644         );
 645
 646         $template->param( OpacPublic => '1' ) if ( $user || C4::Context->preference("OpacPublic") );
 647     }
 648
 649     # Check if we were asked using parameters to force a specific language
 650     if ( defined $in->{'query'}->param('language') ) {
 651
 652         # Extract the language, let C4::Languages::getlanguage choose
 653         # what to do
 654         my $language = C4::Languages::getlanguage( $in->{'query'} );
 655         my $languagecookie = C4::Templates::getlanguagecookie( $in->{'query'}, $language );
 656         $cookie = $cookie_mgr->replace_in_list( $cookie, $languagecookie );
 657     }
 658
 659     # user info
 660     $template->param( loggedinusername   => $user ); # OBSOLETE - Do not reuse this in template, use logged_in_user.userid instead
 661     $template->param( loggedinusernumber => $borrowernumber ); # FIXME Should be replaced with logged_in_user.borrowernumber
 662     $template->param( logged_in_user     => $patron );
 663     $template->param( sessionID          => $sessionID );
 664
 665     return ( $template, $borrowernumber, $cookie, $flags );
 666 }
 667
 668 =head2 checkauth
 669
 670   ($userid, $cookie, $sessionID) = &checkauth($query, $noauth, $flagsrequired, $type);
 671
 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.
 678
 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).
 683
 684 C<$query> is the CGI object for the script calling C<&checkauth>.
 685
 686 The C<$noauth> argument is optional. If it is set, then no
 687 authorization is required for the script.
 688
 689 C<&checkauth> fetches user and session information from C<$query> and
 690 ensures that the user is authorized to run scripts that require
 691 authorization.
 692
 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.
 702
 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
 706 meaning, i.e.,
 707
 708  1
 709
 710 The user must have access to all subfunctions of the module
 711 specified by the hash key.
 712
 713  *
 714
 715 The user must have access to at least one subfunction of the module
 716 specified by the hash key.
 717
 718  specific permission, e.g., 'export_catalog'
 719
 720 The user must have access to the specific subfunction list, which
 721 must correspond to a row in the permissions table.
 722
 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".
 727
 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).
 734
 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.
 739
 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
 742 has authenticated.
 743
 744 =cut
 745
 746 sub _version_check {
 747     my $type  = shift;
 748     my $query = shift;
 749     my $version;
 750
 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");
 757         safe_exit;
 758     }
 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");
 763         } else {
 764             warn "OPAC Install required, redirecting to maintenance";
 765             print $query->redirect("/cgi-bin/koha/maintenance.pl");
 766         }
 767         safe_exit;
 768     }
 769
 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();
 775
 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");
 784         } else {
 785             warn sprintf( "OPAC: " . $warning, 'maintenance' );
 786             print $query->redirect("/cgi-bin/koha/maintenance.pl");
 787         }
 788         safe_exit;
 789     }
 790 }
 791
 792 sub _timeout_syspref {
 793     my $default_timeout = 600;
 794     my $timeout = C4::Context->preference('timeout') || $default_timeout;
 795
 796     # value in days, convert in seconds
 797     if ( $timeout =~ /^(\d+)[dD]$/ ) {
 798         $timeout = $1 * 86400;
 799     }
 800     # value in hours, convert in seconds
 801     elsif ( $timeout =~ /^(\d+)[hH]$/ ) {
 802         $timeout = $1 * 3600;
 803     }
 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;
 807     }
 808
 809     return $timeout;
 810 }
 811
 812 sub checkauth {
 813     my $query = shift;
 814
 815     # Get shibboleth login attribute
 816     my $shib = C4::Context->config('useshibboleth') && shib_ok();
 817     my $shib_login = $shib ? get_login_shib() : undef;
 818
 819     # $authnotrequired will be set for scripts which will run without authentication
 820     my $authnotrequired = shift;
 821     my $flagsrequired   = shift;
 822     my $type            = shift;
 823     my $emailaddress    = shift;
 824     my $template_name   = shift;
 825     my $params          = shift || {};    # do_not_print
 826     $type = 'opac' unless $type;
 827
 828     if ( $type eq 'opac' && !C4::Context->preference("OpacPublic") ) {
 829         my @allowed_scripts_for_private_opac = qw(
 830           opac-memberentry.tt
 831           opac-registration-email-sent.tt
 832           opac-registration-confirmation.tt
 833           opac-memberentry-update-submitted.tt
 834           opac-password-recovery.tt
 835           opac-reset-password.tt
 836         );
 837         $authnotrequired = 0 unless grep { $_ eq $template_name }
 838           @allowed_scripts_for_private_opac;
 839     }
 840
 841     my $timeout = _timeout_syspref();
 842
 843     my $cookie_mgr = Koha::CookieManager->new;
 844
 845     _version_check( $type, $query );
 846
 847     # state variables
 848     my $auth_state = 'failed';
 849     my %info;
 850     my ( $userid, $cookie, $sessionID, $flags );
 851     $cookie = [];
 852     my $logout = $query->param('logout.x');
 853
 854     my $anon_search_history;
 855     my $cas_ticket = '';
 856     # This parameter is the name of the CAS server we want to authenticate against,
 857     # when using authentication against multiple CAS servers, as configured in Auth_cas_servers.yaml
 858     my $casparam = $query->param('cas');
 859     my $q_userid = $query->param('userid') // '';
 860
 861     my $session;
 862     my $invalid_otp_token;
 863     my $require_2FA = ( C4::Context->preference('TwoFactorAuthentication') && $type ne "opac" ) ? 1 : 0;
 864
 865     # Basic authentication is incompatible with the use of Shibboleth,
 866     # as Shibboleth may return REMOTE_USER as a Shibboleth attribute,
 867     # and it may not be the attribute we want to use to match the koha login.
 868     #
 869     # Also, do not consider an empty REMOTE_USER.
 870     #
 871     # Finally, after those tests, we can assume (although if it would be better with
 872     # a syspref) that if we get a REMOTE_USER, that's from basic authentication,
 873     # and we can affect it to $userid.
 874     if ( !$shib and defined( $ENV{'REMOTE_USER'} ) and $ENV{'REMOTE_USER'} ne '' and $userid = $ENV{'REMOTE_USER'} ) {
 875
 876         # Using Basic Authentication, no cookies required
 877         $cookie = $cookie_mgr->replace_in_list( $cookie, $query->cookie(
 878             -name     => 'CGISESSID',
 879             -value    => '',
 880             -HttpOnly => 1,
 881             -secure => ( C4::Context->https_enabled() ? 1 : 0 ),
 882             -sameSite => 'Lax',
 883         ));
 884     }
 885     elsif ( $emailaddress) {
 886         # the Google OpenID Connect passes an email address
 887     }
 888     elsif ( $sessionID = $query->cookie("CGISESSID") ) {    # assignment, not comparison
 889         my ( $return, $more_info );
 890         # NOTE: $flags in the following call is still undefined !
 891         ( $return, $session, $more_info ) = check_cookie_auth( $sessionID, $flags,
 892             { remote_addr => $ENV{REMOTE_ADDR}, skip_version_check => 1 }
 893         );
 894
 895         if ( $return eq 'ok' || $return eq 'additional-auth-needed' ) {
 896             $userid = $session->param('id');
 897         }
 898
 899         $auth_state =
 900             $return eq 'ok'                     ? 'completed'
 901           : $return eq 'additional-auth-needed' ? 'additional-auth-needed'
 902           :                                       'failed';
 903
 904         # We are at the second screen if the waiting-for-2FA is set in session
 905         # and otp_token param has been passed
 906         if (   $require_2FA
 907             && $auth_state eq 'additional-auth-needed'
 908             && ( my $otp_token = $query->param('otp_token') ) )
 909         {
 910             my $patron    = Koha::Patrons->find( { userid => $userid } );
 911             my $auth      = Koha::Auth::TwoFactorAuth->new( { patron => $patron } );
 912             my $verified = $auth->verify($otp_token, 1);
 913             $auth->clear;
 914             if ( $verified ) {
 915                 # The token is correct, the user is fully logged in!
 916                 $auth_state = 'completed';
 917                 $session->param( 'waiting-for-2FA', 0 );
 918
 919                # This is an ugly trick to pass the test
 920                # $query->param('koha_login_context') && ( $q_userid ne $userid )
 921                # few lines later
 922                 $q_userid = $userid;
 923             }
 924             else {
 925                 $invalid_otp_token = 1;
 926             }
 927         }
 928
 929         if ( $auth_state eq 'completed' ) {
 930             Koha::Logger->get->debug(sprintf "AUTH_SESSION: (%s)\t%s %s - %s", map { $session->param($_) || q{} } qw(cardnumber firstname surname branch));
 931
 932             if ( ( $query->param('koha_login_context') && ( $q_userid ne $userid ) )
 933                 || ( $cas && $query->param('ticket') && !C4::Context->userenv->{'id'} )
 934                 || ( $shib && $shib_login && !$logout && !C4::Context->userenv->{'id'} )
 935             ) {
 936
 937                 #if a user enters an id ne to the id in the current session, we need to log them in...
 938                 #first we need to clear the anonymous session...
 939                 $anon_search_history = $session->param('search_history');
 940                 $session->delete();
 941                 $session->flush;
 942                 $cookie = $cookie_mgr->clear_unless( $query->cookie, @$cookie );
 943                 C4::Context::_unset_userenv($sessionID);
 944                 $sessionID = undef;
 945                 undef $userid; # IMPORTANT: this assures us a new session in code below
 946                 $auth_state = 'failed';
 947             } elsif (!$logout) {
 948
 949                 $cookie = $cookie_mgr->replace_in_list( $cookie, $query->cookie(
 950                     -name     => 'CGISESSID',
 951                     -value    => $session->id,
 952                     -HttpOnly => 1,
 953                     -secure => ( C4::Context->https_enabled() ? 1 : 0 ),
 954                     -sameSite => 'Lax',
 955                 ));
 956
 957                 $flags = haspermission( $userid, $flagsrequired );
 958                 unless ( $flags ) {
 959                     $auth_state = 'failed';
 960                     $info{'nopermission'} = 1;
 961                 }
 962             }
 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;
 972             }
 973         }
 974     }
 975
 976     if ( $auth_state eq 'failed' || $logout ) {
 977         $sessionID = undef;
 978         $userid    = undef;
 979     }
 980
 981     if ($logout) {
 982
 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 ? C4::Context->userenv->{'shibboleth'} : undef;
 986         if ( $session ) {
 987             $session->delete();
 988             $session->flush;
 989         }
 990         C4::Context::_unset_userenv($sessionID);
 991         $cookie = $cookie_mgr->clear_unless( $query->cookie, @$cookie );
 992
 993         if ($cas and $caslogout) {
 994             logout_cas($query, $type);
 995         }
 996
 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) {
 999             logout_shib($query);
1000         }
1001
1002         $session   = undef;
1003         $auth_state = 'logout';
1004     }
1005
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()";
1010         }
1011
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 );
1017         }
1018
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,
1024             -HttpOnly => 1,
1025             -secure => ( C4::Context->https_enabled() ? 1 : 0 ),
1026             -sameSite => 'Lax',
1027         ));
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';
1032         }
1033         if ( ( $cas && $query->param('ticket') )
1034             || $q_userid
1035             || ( $shib && $shib_login )
1036             || $pki_field ne 'None'
1037             || $emailaddress )
1038         {
1039             my $password    = $query->param('password');
1040             my $shibSuccess = 0;
1041             my ( $return, $cardnumber );
1042
1043             # If shib is enabled and we have a shib login, does the login match a valid koha user
1044             if ( $shib && $shib_login ) {
1045                 my $retuserid;
1046
1047                 # Do not pass password here, else shib will not be checked in checkpw.
1048                 ( $return, $cardnumber, $retuserid ) = checkpw( $q_userid, undef, $query );
1049                 $userid      = $retuserid;
1050                 $shibSuccess = $return;
1051                 $info{'invalidShibLogin'} = 1 unless ($return);
1052             }
1053
1054             # If shib login and match were successful, skip further login methods
1055             unless ($shibSuccess) {
1056                 if ( $cas && $query->param('ticket') ) {
1057                     my $retuserid;
1058                     my $patron;
1059                     ( $return, $cardnumber, $retuserid, $patron, $cas_ticket ) =
1060                       checkpw( $userid, $password, $query, $type );
1061                     $userid = $retuserid;
1062                     $info{'invalidCasLogin'} = 1 unless ($return);
1063                 }
1064
1065                 elsif ( $emailaddress ) {
1066                     my $value = $emailaddress;
1067
1068                     # If we're looking up the email, there's a chance that the person
1069                     # doesn't have a userid. So if there is none, we pass along the
1070                     # borrower number, and the bits of code that need to know the user
1071                     # ID will have to be smart enough to handle that.
1072                     my $patrons = Koha::Patrons->search({ email => $value });
1073                     if ($patrons->count) {
1074
1075                         # First the userid, then the borrowernum
1076                         my $patron = $patrons->next;
1077                         $value = $patron->userid || $patron->borrowernumber;
1078                     } else {
1079                         undef $value;
1080                     }
1081                     $return = $value ? 1 : 0;
1082                     $userid = $value;
1083                 }
1084
1085                 elsif (
1086                     ( $pki_field eq 'Common Name' && $ENV{'SSL_CLIENT_S_DN_CN'} )
1087                     || ( $pki_field eq 'emailAddress'
1088                         && $ENV{'SSL_CLIENT_S_DN_Email'} )
1089                   )
1090                 {
1091                     my $value;
1092                     if ( $pki_field eq 'Common Name' ) {
1093                         $value = $ENV{'SSL_CLIENT_S_DN_CN'};
1094                     }
1095                     elsif ( $pki_field eq 'emailAddress' ) {
1096                         $value = $ENV{'SSL_CLIENT_S_DN_Email'};
1097
1098                         # If we're looking up the email, there's a chance that the person
1099                         # doesn't have a userid. So if there is none, we pass along the
1100                         # borrower number, and the bits of code that need to know the user
1101                         # ID will have to be smart enough to handle that.
1102                         my $patrons = Koha::Patrons->search({ email => $value });
1103                         if ($patrons->count) {
1104
1105                             # First the userid, then the borrowernum
1106                             my $patron = $patrons->next;
1107                             $value = $patron->userid || $patron->borrowernumber;
1108                         } else {
1109                             undef $value;
1110                         }
1111                     }
1112
1113                     $return = $value ? 1 : 0;
1114                     $userid = $value;
1115
1116                 }
1117                 else {
1118                     my $retuserid;
1119                     my $request_method = $query->request_method();
1120
1121                     if (
1122                         $request_method eq 'POST'
1123                         || ( C4::Context->preference('AutoSelfCheckID')
1124                             && $q_userid eq C4::Context->preference('AutoSelfCheckID') )
1125                       )
1126                     {
1127                         my $patron;
1128
1129                         ( $return, $cardnumber, $retuserid, $patron, $cas_ticket ) =
1130                           checkpw( $q_userid, $password, $query, $type );
1131                         $userid = $retuserid if ($retuserid);
1132                         $info{'invalid_username_or_password'} = 1 unless ($return);
1133                     }
1134                 }
1135             }
1136
1137             # If shib configured and shibOnly enabled, we should ignore anything other than a shibboleth type login.
1138             if (
1139                    $shib
1140                 && !$shibSuccess
1141                 && (
1142                     (
1143                         ( $type eq 'opac' )
1144                         && C4::Context->preference('OPACShibOnly')
1145                     )
1146                     || ( ( $type ne 'opac' )
1147                         && C4::Context->preference('staffShibOnly') )
1148                 )
1149               )
1150             {
1151                 $return = 0;
1152             }
1153
1154             # $return: 1 = valid user
1155             if ($return > 0) {
1156
1157                 if ( $flags = haspermission( $userid, $flagsrequired ) ) {
1158                     $auth_state = "logged_in";
1159                 }
1160                 else {
1161                     $auth_state = 'failed';
1162                     # FIXME We could add $return = 0; or even delete the session?
1163                     # Currently return == 1 and we will fill session info later on,
1164                     # although we do present an authorization failure. (Yes, the
1165                     # authentication was actually correct.)
1166                     $info{'nopermission'} = 1;
1167                     C4::Context::_unset_userenv($sessionID);
1168                 }
1169                 my ( $borrowernumber, $firstname, $surname, $userflags,
1170                     $branchcode, $branchname, $emailaddress, $desk_id,
1171                     $desk_name, $register_id, $register_name );
1172
1173                 if ( $return == 1 ) {
1174                     my $select = "
1175                     SELECT borrowernumber, firstname, surname, flags, borrowers.branchcode,
1176                     branches.branchname    as branchname, email
1177                     FROM borrowers
1178                     LEFT JOIN branches on borrowers.branchcode=branches.branchcode
1179                     ";
1180                     my $dbh = C4::Context->dbh;
1181                     my $sth = $dbh->prepare("$select where userid=?");
1182                     $sth->execute($userid);
1183                     unless ( $sth->rows ) {
1184                         $sth = $dbh->prepare("$select where cardnumber=?");
1185                         $sth->execute($cardnumber);
1186
1187                         unless ( $sth->rows ) {
1188                             $sth->execute($userid);
1189                         }
1190                     }
1191                     if ( $sth->rows ) {
1192                         ( $borrowernumber, $firstname, $surname, $userflags,
1193                             $branchcode, $branchname, $emailaddress ) = $sth->fetchrow;
1194                     }
1195
1196                     # launch a sequence to check if we have a ip for the branch, i
1197                     # if we have one we replace the branchcode of the userenv by the branch bound in the ip.
1198
1199                     my $ip = $ENV{'REMOTE_ADDR'};
1200
1201                     # if they specify at login, use that
1202                     if ( $query->param('branch') ) {
1203                         $branchcode = $query->param('branch');
1204                         my $library = Koha::Libraries->find($branchcode);
1205                         $branchname = $library? $library->branchname: '';
1206                     }
1207                     if ( $query->param('desk_id') ) {
1208                         $desk_id = $query->param('desk_id');
1209                         my $desk = Koha::Desks->find($desk_id);
1210                         $desk_name = $desk ? $desk->desk_name : '';
1211                     }
1212                     if ( C4::Context->preference('UseCashRegisters') ) {
1213                         my $register =
1214                           $query->param('register_id')
1215                           ? Koha::Cash::Registers->find($query->param('register_id'))
1216                           : Koha::Cash::Registers->search(
1217                             { branch => $branchcode, branch_default => 1 },
1218                             { rows   => 1 } )->single;
1219                         $register_id   = $register->id   if ($register);
1220                         $register_name = $register->name if ($register);
1221                     }
1222                     my $branches = { map { $_->branchcode => $_->unblessed } Koha::Libraries->search->as_list };
1223                     if ( $type ne 'opac' and C4::Context->preference('AutoLocation') ) {
1224
1225                         # we have to check they are coming from the right ip range
1226                         my $domain = $branches->{$branchcode}->{'branchip'};
1227                         $domain =~ s|\.\*||g;
1228                         if ( $ip !~ /^$domain/ ) {
1229                             $cookie = $cookie_mgr->replace_in_list( $cookie, $query->cookie(
1230                                 -name     => 'CGISESSID',
1231                                 -value    => '',
1232                                 -HttpOnly => 1,
1233                                 -secure => ( C4::Context->https_enabled() ? 1 : 0 ),
1234                                 -sameSite => 'Lax',
1235                             ));
1236                             $info{'wrongip'} = 1;
1237                             $auth_state = "failed";
1238                         }
1239                     }
1240
1241                     if ( C4::Context->preference('AutoLocation') && $auth_state ne 'failed' ) {
1242                         foreach my $br ( uniq( $branchcode, keys %$branches ) ) {
1243
1244                             #     now we work with the treatment of ip
1245                             my $domain = $branches->{$br}->{'branchip'};
1246                             if ( $domain && $ip =~ /^$domain/ ) {
1247                                 $branchcode = $branches->{$br}->{'branchcode'};
1248
1249                                 # new op dev : add the branchname to the cookie
1250                                 $branchname = $branches->{$br}->{'branchname'};
1251                                 last;
1252                             }
1253                         }
1254                     }
1255
1256                     my $is_sco_user = 0;
1257                     if ( $query->param('sco_user_login') && ( $query->param('sco_user_login') eq '1' ) ){
1258                         $is_sco_user = 1;
1259                     }
1260
1261                     $session->param( 'number',       $borrowernumber );
1262                     $session->param( 'id',           $userid );
1263                     $session->param( 'cardnumber',   $cardnumber );
1264                     $session->param( 'firstname',    $firstname );
1265                     $session->param( 'surname',      $surname );
1266                     $session->param( 'branch',       $branchcode );
1267                     $session->param( 'branchname',   $branchname );
1268                     $session->param( 'desk_id',      $desk_id);
1269                     $session->param( 'desk_name',     $desk_name);
1270                     $session->param( 'flags',        $userflags );
1271                     $session->param( 'emailaddress', $emailaddress );
1272                     $session->param( 'ip',           $session->remote_addr() );
1273                     $session->param( 'lasttime',     time() );
1274                     $session->param( 'interface',    $type);
1275                     $session->param( 'shibboleth',   $shibSuccess );
1276                     $session->param( 'register_id',  $register_id );
1277                     $session->param( 'register_name',  $register_name );
1278                     $session->param( 'sco_user', $is_sco_user );
1279                 }
1280                 $session->param('cas_ticket', $cas_ticket) if $cas_ticket;
1281                 C4::Context->set_userenv(
1282                     $session->param('number'),       $session->param('id'),
1283                     $session->param('cardnumber'),   $session->param('firstname'),
1284                     $session->param('surname'),      $session->param('branch'),
1285                     $session->param('branchname'),   $session->param('flags'),
1286                     $session->param('emailaddress'), $session->param('shibboleth'),
1287                     $session->param('desk_id'),      $session->param('desk_name'),
1288                     $session->param('register_id'),  $session->param('register_name')
1289                 );
1290
1291             }
1292             # $return: 0 = invalid user
1293             # reset to anonymous session
1294             else {
1295                 if ($userid) {
1296                     $info{'invalid_username_or_password'} = 1;
1297                     C4::Context::_unset_userenv($sessionID);
1298                 }
1299                 $session->param( 'lasttime', time() );
1300                 $session->param( 'ip',       $session->remote_addr() );
1301                 $session->param( 'sessiontype', 'anon' );
1302                 $session->param( 'interface', $type);
1303             }
1304         }    # END if ( $q_userid
1305         elsif ( $type eq "opac" ) {
1306
1307             # anonymous sessions are created only for the OPAC
1308
1309             # setting a couple of other session vars...
1310             $session->param( 'ip',          $session->remote_addr() );
1311             $session->param( 'lasttime',    time() );
1312             $session->param( 'sessiontype', 'anon' );
1313             $session->param( 'interface', $type);
1314         }
1315         $session->flush;
1316     }    # END unless ($userid)
1317
1318
1319     if ( $auth_state eq 'logged_in' ) {
1320         $auth_state = 'completed';
1321
1322         # Auth is completed unless an additional auth is needed
1323         if ( $require_2FA ) {
1324             my $patron = Koha::Patrons->find({userid => $userid});
1325             if ( $patron->auth_method eq 'two-factor' ) {
1326                 # Ask for the OTP token
1327                 $auth_state = 'additional-auth-needed';
1328                 $session->param('waiting-for-2FA', 1);
1329                 %info = ();# We remove the warnings/errors we may have set incorrectly before
1330             }
1331         }
1332     }
1333
1334     # finished authentification, now respond
1335     if ( $auth_state eq 'completed' || $authnotrequired ) {
1336         # successful login
1337         unless (@$cookie) {
1338             $cookie = $cookie_mgr->replace_in_list( $cookie, $query->cookie(
1339                 -name     => 'CGISESSID',
1340                 -value    => '',
1341                 -HttpOnly => 1,
1342                 -secure => ( C4::Context->https_enabled() ? 1 : 0 ),
1343                 -sameSite => 'Lax',
1344             ));
1345         }
1346
1347         track_login_daily( $userid );
1348
1349         # In case, that this request was a login attempt, we want to prevent that users can repost the opac login
1350         # request. We therefore redirect the user to the requested page again without the login parameters.
1351         # See Post/Redirect/Get (PRG) design pattern: https://en.wikipedia.org/wiki/Post/Redirect/Get
1352         if ( $type eq "opac" && $query->param('koha_login_context') && $query->param('koha_login_context') ne 'sco' && $query->param('password') && $query->param('userid') ) {
1353             my $uri = URI->new($query->url(-relative=>1, -query_string=>1));
1354             $uri->query_param_delete('userid');
1355             $uri->query_param_delete('password');
1356             $uri->query_param_delete('koha_login_context');
1357             unless ( $params->{do_not_print} ) {
1358                 print $query->redirect( -uri => $uri->as_string, -cookie => $cookie, -status => '303 See other' );
1359                 safe_exit;
1360             }
1361         }
1362
1363         return ( $userid, $cookie, $sessionID, $flags );
1364     }
1365
1366     #
1367     #
1368     # AUTH rejected, show the login/password template, after checking the DB.
1369     #
1370     #
1371
1372     my $patron = Koha::Patrons->find({ userid => $q_userid }); # Not necessary logged in!
1373
1374     # get the inputs from the incoming query
1375     my @inputs = ();
1376     my @inputs_to_clean = qw( userid password ticket logout.x otp_token );
1377     foreach my $name ( param $query) {
1378         next if grep { $name eq $_ } @inputs_to_clean;
1379         my @value = $query->multi_param($name);
1380         push @inputs, { name => $name, value => $_ } for @value;
1381     }
1382
1383     my $LibraryNameTitle = C4::Context->preference("LibraryName");
1384     $LibraryNameTitle =~ s/<(?:\/?)(?:br|p)\s*(?:\/?)>/ /sgi;
1385     $LibraryNameTitle =~ s/<(?:[^<>'"]|'(?:[^']*)'|"(?:[^"]*)")*>//sg;
1386
1387     my $auth_template_name = ( $type eq 'opac' ) ? 'opac-auth.tt' : 'auth.tt';
1388     my $template = C4::Templates::gettemplate( $auth_template_name, $type, $query );
1389     $template->param(
1390         login                                 => 1,
1391         INPUTS                                => \@inputs,
1392         script_name                           => get_script_name(),
1393         casAuthentication                     => C4::Context->preference("casAuthentication"),
1394         shibbolethAuthentication              => $shib,
1395         suggestion                            => C4::Context->preference("suggestion"),
1396         virtualshelves                        => C4::Context->preference("virtualshelves"),
1397         LibraryName                           => "" . C4::Context->preference("LibraryName"),
1398         LibraryNameTitle                      => "" . $LibraryNameTitle,
1399         opacuserlogin                         => C4::Context->preference("opacuserlogin"),
1400         OpacFavicon                           => C4::Context->preference("OpacFavicon"),
1401         opacreadinghistory                    => C4::Context->preference("opacreadinghistory"),
1402         opaclanguagesdisplay                  => C4::Context->preference("opaclanguagesdisplay"),
1403         OPACUserJS                            => C4::Context->preference("OPACUserJS"),
1404         OPACUserCSS                           => C4::Context->preference("OPACUserCSS"),
1405         intranetcolorstylesheet               => C4::Context->preference("intranetcolorstylesheet"),
1406         intranetstylesheet                    => C4::Context->preference("intranetstylesheet"),
1407         IntranetNav                           => C4::Context->preference("IntranetNav"),
1408         IntranetFavicon                       => C4::Context->preference("IntranetFavicon"),
1409         IntranetUserCSS                       => C4::Context->preference("IntranetUserCSS"),
1410         IntranetUserJS                        => C4::Context->preference("IntranetUserJS"),
1411         IndependentBranches                   => C4::Context->preference("IndependentBranches"),
1412         AutoLocation                          => C4::Context->preference("AutoLocation"),
1413         wrongip                               => $info{'wrongip'},
1414         PatronSelfRegistration                => C4::Context->preference("PatronSelfRegistration"),
1415         PatronSelfRegistrationDefaultCategory => C4::Context->preference("PatronSelfRegistrationDefaultCategory"),
1416         opac_css_override                     => $ENV{'OPAC_CSS_OVERRIDE'},
1417         too_many_login_attempts               => ( $patron and $patron->account_locked ),
1418         password_has_expired                  => ( $patron and $patron->password_expired ),
1419     );
1420
1421     $template->param( SCO_login => 1 ) if ( $query->param('sco_user_login') );
1422     $template->param( SCI_login => 1 ) if ( $query->param('sci_user_login') );
1423     $template->param( OpacPublic => C4::Context->preference("OpacPublic") );
1424     $template->param( loginprompt => 1 ) unless $info{'nopermission'};
1425     if ( $auth_state eq 'additional-auth-needed' ) {
1426         $template->param(
1427             TwoFA_prompt => 1,
1428             invalid_otp_token => $invalid_otp_token,
1429         );
1430     }
1431
1432     if ( $type eq 'opac' ) {
1433         require Koha::Virtualshelves;
1434         my $some_public_shelves = Koha::Virtualshelves->get_some_shelves(
1435             {
1436                 public => 1,
1437             }
1438         );
1439         $template->param(
1440             some_public_shelves  => $some_public_shelves,
1441         );
1442     }
1443
1444     if ($cas) {
1445
1446         # Is authentication against multiple CAS servers enabled?
1447         require C4::Auth_with_cas;
1448         if ( multipleAuth() && !$casparam ) {
1449             my $casservers = getMultipleAuth();
1450             my @tmplservers;
1451             foreach my $key ( keys %$casservers ) {
1452                 push @tmplservers, { name => $key, value => login_cas_url( $query, $key, $type ) . "?cas=$key" };
1453             }
1454             $template->param(
1455                 casServersLoop => \@tmplservers
1456             );
1457         } else {
1458             $template->param(
1459                 casServerUrl => login_cas_url($query, undef, $type),
1460             );
1461         }
1462
1463         $template->param(
1464             invalidCasLogin => $info{'invalidCasLogin'}
1465         );
1466     }
1467
1468     if ($shib) {
1469         #If shibOnly is enabled just go ahead and redirect directly
1470         if ( (($type eq 'opac') && C4::Context->preference('OPACShibOnly')) || (($type ne 'opac') && C4::Context->preference('staffShibOnly')) ) {
1471             my $redirect_url = login_shib_url( $query );
1472             print $query->redirect( -uri => "$redirect_url", -status => 303 );
1473             safe_exit;
1474         }
1475
1476         $template->param(
1477             shibbolethAuthentication => $shib,
1478             shibbolethLoginUrl       => login_shib_url($query),
1479         );
1480     }
1481
1482     if (C4::Context->preference('GoogleOpenIDConnect')) {
1483         if ($query->param("OpenIDConnectFailed")) {
1484             my $reason = $query->param('OpenIDConnectFailed');
1485             $template->param(invalidGoogleOpenIDConnectLogin => $reason);
1486         }
1487     }
1488
1489     $template->param(
1490         LibraryName => C4::Context->preference("LibraryName"),
1491         %info,
1492         sessionID => $session->id,
1493     );
1494
1495     if ( $params->{do_not_print} ) {
1496         # This must be used for testing purpose only!
1497         return ( undef, undef, undef, undef, $template );
1498     }
1499
1500     print $query->header(
1501         {   type              => 'text/html',
1502             charset           => 'utf-8',
1503             cookie            => $cookie,
1504             'X-Frame-Options' => 'SAMEORIGIN',
1505             -sameSite => 'Lax'
1506         }
1507       ),
1508       $template->output;
1509     safe_exit;
1510 }
1511
1512 =head2 check_api_auth
1513
1514   ($status, $cookie, $sessionId) = check_api_auth($query, $userflags);
1515
1516 Given a CGI query containing the parameters 'userid' and 'password' and/or a session
1517 cookie, determine if the user has the privileges specified by C<$userflags>.
1518
1519 C<check_api_auth> is is meant for authenticating users of web services, and
1520 consequently will always return and will not attempt to redirect the user
1521 agent.
1522
1523 If a valid session cookie is already present, check_api_auth will return a status
1524 of "ok", the cookie, and the Koha session ID.
1525
1526 If no session cookie is present, check_api_auth will check the 'userid' and 'password
1527 parameters and create a session cookie and Koha session if the supplied credentials
1528 are OK.
1529
1530 Possible return values in C<$status> are:
1531
1532 =over
1533
1534 =item "ok" -- user authenticated; C<$cookie> and C<$sessionid> have valid values.
1535
1536 =item "failed" -- credentials are not correct; C<$cookie> and C<$sessionid> are undef
1537
1538 =item "maintenance" -- DB is in maintenance mode; no login possible at the moment
1539
1540 =item "expired -- session cookie has expired; API user should resubmit userid and password
1541
1542 =item "restricted" -- The IP has changed (if SessionRestrictionByIP)
1543
1544 =item "additional-auth-needed -- User is in an authentication process that is not finished
1545
1546 =back
1547
1548 =cut
1549
1550 sub check_api_auth {
1551
1552     my $query         = shift;
1553     my $flagsrequired = shift;
1554     my $timeout = _timeout_syspref();
1555
1556     unless ( C4::Context->preference('Version') ) {
1557
1558         # database has not been installed yet
1559         return ( "maintenance", undef, undef );
1560     }
1561     my $kohaversion = Koha::version();
1562     $kohaversion =~ s/(.*\..*)\.(.*)\.(.*)/$1$2$3/;
1563     if ( C4::Context->preference('Version') < $kohaversion ) {
1564
1565         # database in need of version update; assume that
1566         # no API should be called while databsae is in
1567         # this condition.
1568         return ( "maintenance", undef, undef );
1569     }
1570
1571     my ( $sessionID, $session );
1572     unless ( $query->param('userid') ) {
1573         $sessionID = $query->cookie("CGISESSID");
1574     }
1575     if ( $sessionID && not( $cas && $query->param('PT') ) ) {
1576
1577         my $return;
1578         ( $return, $session, undef ) = check_cookie_auth(
1579             $sessionID, $flagsrequired, { remote_addr => $ENV{REMOTE_ADDR} } );
1580
1581         return ( $return, undef, undef ) # Cookie auth failed
1582             if $return ne "ok";
1583
1584         my $cookie = $query->cookie(
1585             -name     => 'CGISESSID',
1586             -value    => $session->id,
1587             -HttpOnly => 1,
1588             -secure => ( C4::Context->https_enabled() ? 1 : 0 ),
1589             -sameSite => 'Lax'
1590         );
1591         return ( $return, $cookie, $session ); # return == 'ok' here
1592
1593     } else {
1594
1595         # new login
1596         my $userid   = $query->param('userid');
1597         my $password = $query->param('password');
1598         my ( $return, $cardnumber, $cas_ticket );
1599
1600         # Proxy CAS auth
1601         if ( $cas && $query->param('PT') ) {
1602             my $retuserid;
1603
1604             # In case of a CAS authentication, we use the ticket instead of the password
1605             my $PT = $query->param('PT');
1606             ( $return, $cardnumber, $userid, $cas_ticket ) = check_api_auth_cas( $PT, $query );    # EXTERNAL AUTH
1607         } else {
1608
1609             # User / password auth
1610             unless ( $userid and $password ) {
1611
1612                 # caller did something wrong, fail the authenticateion
1613                 return ( "failed", undef, undef );
1614             }
1615             my $newuserid;
1616             my $patron;
1617             ( $return, $cardnumber, $newuserid, $patron, $cas_ticket ) = checkpw( $userid, $password, $query );
1618         }
1619
1620         if ( $return and haspermission( $userid, $flagsrequired ) ) {
1621             my $session = get_session("");
1622             return ( "failed", undef, undef ) unless $session;
1623
1624             my $sessionID = $session->id;
1625             C4::Context->_new_userenv($sessionID);
1626             my $cookie = $query->cookie(
1627                 -name     => 'CGISESSID',
1628                 -value    => $sessionID,
1629                 -HttpOnly => 1,
1630                 -secure => ( C4::Context->https_enabled() ? 1 : 0 ),
1631                 -sameSite => 'Lax'
1632             );
1633             if ( $return == 1 ) {
1634                 my (
1635                     $borrowernumber, $firstname,  $surname,
1636                     $userflags,      $branchcode, $branchname,
1637                     $emailaddress
1638                 );
1639                 my $dbh = C4::Context->dbh;
1640                 my $sth =
1641                   $dbh->prepare(
1642 "select borrowernumber, firstname, surname, flags, borrowers.branchcode, branches.branchname as branchname, email from borrowers left join branches on borrowers.branchcode=branches.branchcode where userid=?"
1643                   );
1644                 $sth->execute($userid);
1645                 (
1646                     $borrowernumber, $firstname,  $surname,
1647                     $userflags,      $branchcode, $branchname,
1648                     $emailaddress
1649                 ) = $sth->fetchrow if ( $sth->rows );
1650
1651                 unless ( $sth->rows ) {
1652                     my $sth = $dbh->prepare(
1653 "select borrowernumber, firstname, surname, flags, borrowers.branchcode, branches.branchname as branchname, email from borrowers left join branches on borrowers.branchcode=branches.branchcode where cardnumber=?"
1654                     );
1655                     $sth->execute($cardnumber);
1656                     (
1657                         $borrowernumber, $firstname,  $surname,
1658                         $userflags,      $branchcode, $branchname,
1659                         $emailaddress
1660                     ) = $sth->fetchrow if ( $sth->rows );
1661
1662                     unless ( $sth->rows ) {
1663                         $sth->execute($userid);
1664                         (
1665                             $borrowernumber, $firstname,  $surname,       $userflags,
1666                             $branchcode,     $branchname, $emailaddress
1667                         ) = $sth->fetchrow if ( $sth->rows );
1668                     }
1669                 }
1670
1671                 my $ip = $ENV{'REMOTE_ADDR'};
1672
1673                 # if they specify at login, use that
1674                 if ( $query->param('branch') ) {
1675                     $branchcode = $query->param('branch');
1676                     my $library = Koha::Libraries->find($branchcode);
1677                     $branchname = $library? $library->branchname: '';
1678                 }
1679                 my $branches = { map { $_->branchcode => $_->unblessed } Koha::Libraries->search->as_list };
1680                 foreach my $br ( keys %$branches ) {
1681
1682                     #     now we work with the treatment of ip
1683                     my $domain = $branches->{$br}->{'branchip'};
1684                     if ( $domain && $ip =~ /^$domain/ ) {
1685                         $branchcode = $branches->{$br}->{'branchcode'};
1686
1687                         # new op dev : add the branchname to the cookie
1688                         $branchname    = $branches->{$br}->{'branchname'};
1689                     }
1690                 }
1691                 $session->param( 'number',       $borrowernumber );
1692                 $session->param( 'id',           $userid );
1693                 $session->param( 'cardnumber',   $cardnumber );
1694                 $session->param( 'firstname',    $firstname );
1695                 $session->param( 'surname',      $surname );
1696                 $session->param( 'branch',       $branchcode );
1697                 $session->param( 'branchname',   $branchname );
1698                 $session->param( 'flags',        $userflags );
1699                 $session->param( 'emailaddress', $emailaddress );
1700                 $session->param( 'ip',           $session->remote_addr() );
1701                 $session->param( 'lasttime',     time() );
1702                 $session->param( 'interface',    'api'  );
1703             }
1704             $session->param( 'cas_ticket', $cas_ticket);
1705             C4::Context->set_userenv(
1706                 $session->param('number'),       $session->param('id'),
1707                 $session->param('cardnumber'),   $session->param('firstname'),
1708                 $session->param('surname'),      $session->param('branch'),
1709                 $session->param('branchname'),   $session->param('flags'),
1710                 $session->param('emailaddress'), $session->param('shibboleth'),
1711                 $session->param('desk_id'),      $session->param('desk_name'),
1712                 $session->param('register_id'),  $session->param('register_name')
1713             );
1714             return ( "ok", $cookie, $sessionID );
1715         } else {
1716             return ( "failed", undef, undef );
1717         }
1718     }
1719 }
1720
1721 =head2 check_cookie_auth
1722
1723   ($status, $sessionId) = check_cookie_auth($cookie, $userflags);
1724
1725 Given a CGISESSID cookie set during a previous login to Koha, determine
1726 if the user has the privileges specified by C<$userflags>. C<$userflags>
1727 is passed unaltered into C<haspermission> and as such accepts all options
1728 avaiable to that routine with the one caveat that C<check_api_auth> will
1729 also allow 'undef' to be passed and in such a case the permissions check
1730 will be skipped altogether.
1731
1732 C<check_cookie_auth> is meant for authenticating special services
1733 such as tools/upload-file.pl that are invoked by other pages that
1734 have been authenticated in the usual way.
1735
1736 Possible return values in C<$status> are:
1737
1738 =over
1739
1740 =item "ok" -- user authenticated; C<$sessionID> have valid values.
1741
1742 =item "anon" -- user not authenticated but valid for anonymous session.
1743
1744 =item "failed" -- credentials are not correct; C<$sessionid> are undef
1745
1746 =item "maintenance" -- DB is in maintenance mode; no login possible at the moment
1747
1748 =item "expired -- session cookie has expired; API user should resubmit userid and password
1749
1750 =item "restricted" -- The IP has changed (if SessionRestrictionByIP)
1751
1752 =back
1753
1754 =cut
1755
1756 sub check_cookie_auth {
1757     my $sessionID     = shift;
1758     my $flagsrequired = shift;
1759     my $params        = shift;
1760
1761     my $remote_addr = $params->{remote_addr} || $ENV{REMOTE_ADDR};
1762
1763     my $skip_version_check = $params->{skip_version_check}; # Only for checkauth
1764
1765     unless ( $skip_version_check ) {
1766         unless ( C4::Context->preference('Version') ) {
1767
1768             # database has not been installed yet
1769             return ( "maintenance", undef );
1770         }
1771         my $kohaversion = Koha::version();
1772         $kohaversion =~ s/(.*\..*)\.(.*)\.(.*)/$1$2$3/;
1773         if ( C4::Context->preference('Version') < $kohaversion ) {
1774
1775             # database in need of version update; assume that
1776             # no API should be called while databsae is in
1777             # this condition.
1778             return ( "maintenance", undef );
1779         }
1780     }
1781
1782     # see if we have a valid session cookie already
1783     # however, if a userid parameter is present (i.e., from
1784     # a form submission, assume that any current cookie
1785     # is to be ignored
1786     unless ( $sessionID ) {
1787         return ( "failed", undef );
1788     }
1789     C4::Context::_unset_userenv($sessionID); # remove old userenv first
1790     my $session   = get_session($sessionID);
1791     if ($session) {
1792         my $userid   = $session->param('id');
1793         my $ip       = $session->param('ip');
1794         my $lasttime = $session->param('lasttime');
1795         my $timeout = _timeout_syspref();
1796
1797         if ( !$lasttime || ( $lasttime < time() - $timeout ) ) {
1798             # time out
1799             $session->delete();
1800             $session->flush;
1801             return ("expired", undef);
1802
1803         } elsif ( C4::Context->preference('SessionRestrictionByIP') && $ip ne $remote_addr ) {
1804             # IP address changed
1805             $session->delete();
1806             $session->flush;
1807             return ( "restricted", undef, { old_ip => $ip, new_ip => $remote_addr});
1808
1809         } elsif ( $userid ) {
1810             $session->param( 'lasttime', time() );
1811             my $patron = Koha::Patrons->find({ userid => $userid });
1812             $patron = Koha::Patron->find({ cardnumber => $userid }) unless $patron;
1813             return ("password_expired", undef ) if $patron->password_expired;
1814             my $flags = defined($flagsrequired) ? haspermission( $userid, $flagsrequired ) : 1;
1815             if ($flags) {
1816                 C4::Context->_new_userenv($sessionID);
1817                 C4::Context->interface($session->param('interface'));
1818                 C4::Context->set_userenv(
1819                     $session->param('number'),       $session->param('id') // '',
1820                     $session->param('cardnumber'),   $session->param('firstname'),
1821                     $session->param('surname'),      $session->param('branch'),
1822                     $session->param('branchname'),   $session->param('flags'),
1823                     $session->param('emailaddress'), $session->param('shibboleth'),
1824                     $session->param('desk_id'),      $session->param('desk_name'),
1825                     $session->param('register_id'),  $session->param('register_name')
1826                 );
1827                 return ( "additional-auth-needed", $session )
1828                     if $session->param('waiting-for-2FA');
1829
1830                 return ( "ok", $session );
1831             } else {
1832                 $session->delete();
1833                 $session->flush;
1834                 return ( "failed", undef );
1835             }
1836
1837         } else {
1838             C4::Context->_new_userenv($sessionID);
1839             C4::Context->interface($session->param('interface'));
1840             C4::Context->set_userenv( undef, q{} );
1841             return ( "anon", $session );
1842         }
1843     } else {
1844         return ( "expired", undef );
1845     }
1846 }
1847
1848 =head2 get_session
1849
1850   use CGI::Session;
1851   my $session = get_session($sessionID);
1852
1853 Given a session ID, retrieve the CGI::Session object used to store
1854 the session's state.  The session object can be used to store
1855 data that needs to be accessed by different scripts during a
1856 user's session.
1857
1858 If the C<$sessionID> parameter is an empty string, a new session
1859 will be created.
1860
1861 =cut
1862
1863 sub _get_session_params {
1864     my $storage_method = C4::Context->preference('SessionStorage');
1865     if ( $storage_method eq 'mysql' ) {
1866         my $dbh = C4::Context->dbh;
1867         return { dsn => "serializer:yamlxs;driver:MySQL;id:md5", dsn_args => { Handle => $dbh } };
1868     }
1869     elsif ( $storage_method eq 'Pg' ) {
1870         my $dbh = C4::Context->dbh;
1871         return { dsn => "serializer:yamlxs;driver:PostgreSQL;id:md5", dsn_args => { Handle => $dbh } };
1872     }
1873     elsif ( $storage_method eq 'memcached' && Koha::Caches->get_instance->memcached_cache ) {
1874         my $memcached = Koha::Caches->get_instance()->memcached_cache;
1875         return { dsn => "serializer:yamlxs;driver:memcached;id:md5", dsn_args => { Memcached => $memcached } };
1876     }
1877     else {
1878         # catch all defaults to tmp should work on all systems
1879         my $dir = C4::Context::temporary_directory;
1880         my $instance = C4::Context->config( 'database' ); #actually for packages not exactly the instance name, but generally safer to leave it as it is
1881         return { dsn => "serializer:yamlxs;driver:File;id:md5", dsn_args => { Directory => "$dir/cgisess_$instance" } };
1882     }
1883 }
1884
1885 sub get_session {
1886     my $sessionID      = shift;
1887     my $params = _get_session_params();
1888     my $session;
1889     if( $sessionID ) { # find existing
1890         CGI::Session::ErrorHandler->set_error( q{} ); # clear error, cpan issue #111463
1891         $session = CGI::Session->load( $params->{dsn}, $sessionID, $params->{dsn_args} );
1892     } else {
1893         $session = CGI::Session->new( $params->{dsn}, $sessionID, $params->{dsn_args} );
1894         # no need to flush here
1895     }
1896     return $session;
1897 }
1898
1899
1900 # FIXME no_set_userenv may be replaced with force_branchcode_for_userenv
1901 # (or something similar)
1902 # Currently it's only passed from C4::SIP::ILS::Patron::check_password, but
1903 # not having a userenv defined could cause a crash.
1904 sub checkpw {
1905     my ( $userid, $password, $query, $type, $no_set_userenv ) = @_;
1906     $type = 'opac' unless $type;
1907
1908     # Get shibboleth login attribute
1909     my $shib       = C4::Context->config('useshibboleth') && shib_ok();
1910     my $shib_login = $shib ? get_login_shib() : undef;
1911
1912     my @return;
1913     my $patron;
1914     if ( defined $userid ) {
1915         $patron = Koha::Patrons->find( { userid     => $userid } );
1916         $patron = Koha::Patrons->find( { cardnumber => $userid } ) unless $patron;
1917     }
1918     my $check_internal_as_fallback = 0;
1919     my $passwd_ok                  = 0;
1920
1921     # Note: checkpw_* routines returns:
1922     # 1 if auth is ok
1923     # 0 if auth is nok
1924     # -1 if user bind failed (LDAP only)
1925
1926     if ( $patron and ( $patron->account_locked ) ) {
1927
1928         # Nothing to check, account is locked
1929     } elsif ( $ldap && defined($password) ) {
1930         my ( $retval, $retcard, $retuserid );
1931         ( $retval, $retcard, $retuserid, $patron ) = checkpw_ldap(@_);    # EXTERNAL AUTH
1932         if ( $retval == 1 ) {
1933             @return    = ( $retval, $retcard, $retuserid, $patron );
1934             $passwd_ok = 1;
1935         }
1936         $check_internal_as_fallback = 1 if $retval == 0;
1937
1938     } elsif ( $cas && $query && $query->param('ticket') ) {
1939
1940         # In case of a CAS authentication, we use the ticket instead of the password
1941         my $ticket = $query->param('ticket');
1942         $query->delete('ticket');                                   # remove ticket to come back to original URL
1943         my ( $retval, $retcard, $retuserid, $cas_ticket, $patron ) = checkpw_cas( $ticket, $query, $type );    # EXTERNAL AUTH
1944         if ( $retval ) {
1945             @return = ( $retval, $retcard, $retuserid, $patron, $cas_ticket );
1946         } else {
1947             @return = (0);
1948         }
1949         $passwd_ok = $retval;
1950     }
1951
1952     # If we are in a shibboleth session (shibboleth is enabled, and a shibboleth match attribute is present)
1953     # Check for password to asertain whether we want to be testing against shibboleth or another method this
1954     # time around.
1955     elsif ( $shib && $shib_login && !$password ) {
1956
1957         # In case of a Shibboleth authentication, we expect a shibboleth user attribute
1958         # (defined under shibboleth mapping in koha-conf.xml) to contain the login of the
1959         # shibboleth-authenticated user
1960
1961         # Then, we check if it matches a valid koha user
1962         if ($shib_login) {
1963             my ( $retval, $retcard, $retuserid, $patron ) =
1964                 C4::Auth_with_shibboleth::checkpw_shib($shib_login);    # EXTERNAL AUTH
1965             if ($retval) {
1966                 @return = ( $retval, $retcard, $retuserid, $patron );
1967             }
1968             $passwd_ok = $retval;
1969         }
1970     } else {
1971         $check_internal_as_fallback = 1;
1972     }
1973
1974     # INTERNAL AUTH
1975     if ( $check_internal_as_fallback ) {
1976         @return = checkpw_internal( $userid, $password, $no_set_userenv);
1977         push( @return, $patron );
1978         $passwd_ok = 1 if $return[0] > 0; # 1 or 2
1979     }
1980
1981     if ($patron) {
1982         if ($passwd_ok) {
1983             $patron->update( { login_attempts => 0 } );
1984             if ( $patron->password_expired ) {
1985                 @return = ( -2, $patron );
1986             }
1987         } elsif ( !$patron->account_locked ) {
1988             $patron->update( { login_attempts => $patron->login_attempts + 1 } );
1989         }
1990     }
1991
1992     # Optionally log success or failure
1993     if ( $patron && $passwd_ok && C4::Context->preference('AuthSuccessLog') ) {
1994         logaction( 'AUTH', 'SUCCESS', $patron->id, "Valid password for $userid", $type );
1995     } elsif ( !$passwd_ok && C4::Context->preference('AuthFailureLog') ) {
1996         logaction( 'AUTH', 'FAILURE', $patron ? $patron->id : 0, "Wrong password for $userid", $type );
1997     }
1998
1999     return @return;
2000 }
2001
2002 sub checkpw_internal {
2003     my ( $userid, $password, $no_set_userenv ) = @_;
2004
2005     $password = Encode::encode( 'UTF-8', $password )
2006       if Encode::is_utf8($password);
2007
2008     my $dbh = C4::Context->dbh;
2009     my $sth =
2010       $dbh->prepare(
2011         "select password,cardnumber,borrowernumber,userid,firstname,surname,borrowers.branchcode,branches.branchname,flags from borrowers join branches on borrowers.branchcode=branches.branchcode where userid=?"
2012       );
2013     $sth->execute($userid);
2014     if ( $sth->rows ) {
2015         my ( $stored_hash, $cardnumber, $borrowernumber, $userid, $firstname,
2016             $surname, $branchcode, $branchname, $flags )
2017           = $sth->fetchrow;
2018
2019         if ( checkpw_hash( $password, $stored_hash ) ) {
2020
2021             C4::Context->set_userenv( "$borrowernumber", $userid, $cardnumber,
2022                 $firstname, $surname, $branchcode, $branchname, $flags ) unless $no_set_userenv;
2023             return 1, $cardnumber, $userid;
2024         }
2025     }
2026     $sth =
2027       $dbh->prepare(
2028         "select password,cardnumber,borrowernumber,userid,firstname,surname,borrowers.branchcode,branches.branchname,flags from borrowers join branches on borrowers.branchcode=branches.branchcode where cardnumber=?"
2029       );
2030     $sth->execute($userid);
2031     if ( $sth->rows ) {
2032         my ( $stored_hash, $cardnumber, $borrowernumber, $userid, $firstname,
2033             $surname, $branchcode, $branchname, $flags )
2034           = $sth->fetchrow;
2035
2036         if ( checkpw_hash( $password, $stored_hash ) ) {
2037
2038             C4::Context->set_userenv( $borrowernumber, $userid, $cardnumber,
2039                 $firstname, $surname, $branchcode, $branchname, $flags ) unless $no_set_userenv;
2040             return 1, $cardnumber, $userid;
2041         }
2042     }
2043     return 0;
2044 }
2045
2046 sub checkpw_hash {
2047     my ( $password, $stored_hash ) = @_;
2048
2049     return if $stored_hash eq '!';
2050
2051     # check what encryption algorithm was implemented: Bcrypt - if the hash starts with '$2' it is Bcrypt else md5
2052     my $hash;
2053     if ( substr( $stored_hash, 0, 2 ) eq '$2' ) {
2054         $hash = hash_password( $password, $stored_hash );
2055     } else {
2056         $hash = md5_base64($password);
2057     }
2058     return $hash eq $stored_hash;
2059 }
2060
2061 =head2 getuserflags
2062
2063     my $authflags = getuserflags($flags, $userid, [$dbh]);
2064
2065 Translates integer flags into permissions strings hash.
2066
2067 C<$flags> is the integer userflags value ( borrowers.userflags )
2068 C<$userid> is the members.userid, used for building subpermissions
2069 C<$authflags> is a hashref of permissions
2070
2071 =cut
2072
2073 sub getuserflags {
2074     my $flags  = shift;
2075     my $userid = shift;
2076     my $dbh    = @_ ? shift : C4::Context->dbh;
2077     my $userflags;
2078     {
2079         # I don't want to do this, but if someone logs in as the database
2080         # user, it would be preferable not to spam them to death with
2081         # numeric warnings. So, we make $flags numeric.
2082         no warnings 'numeric';
2083         $flags += 0;
2084     }
2085     my $sth = $dbh->prepare("SELECT bit, flag, defaulton FROM userflags");
2086     $sth->execute;
2087
2088     while ( my ( $bit, $flag, $defaulton ) = $sth->fetchrow ) {
2089         if ( ( $flags & ( 2**$bit ) ) || $defaulton ) {
2090             $userflags->{$flag} = 1;
2091         }
2092         else {
2093             $userflags->{$flag} = 0;
2094         }
2095     }
2096
2097     # get subpermissions and merge with top-level permissions
2098     my $user_subperms = get_user_subpermissions($userid);
2099     foreach my $module ( keys %$user_subperms ) {
2100         next if $userflags->{$module} == 1;    # user already has permission for everything in this module
2101         $userflags->{$module} = $user_subperms->{$module};
2102     }
2103
2104     return $userflags;
2105 }
2106
2107 =head2 get_user_subpermissions
2108
2109   $user_perm_hashref = get_user_subpermissions($userid);
2110
2111 Given the userid (note, not the borrowernumber) of a staff user,
2112 return a hashref of hashrefs of the specific subpermissions
2113 accorded to the user.  An example return is
2114
2115  {
2116     tools => {
2117         export_catalog => 1,
2118         import_patrons => 1,
2119     }
2120  }
2121
2122 The top-level hash-key is a module or function code from
2123 userflags.flag, while the second-level key is a code
2124 from permissions.
2125
2126 The results of this function do not give a complete picture
2127 of the functions that a staff user can access; it is also
2128 necessary to check borrowers.flags.
2129
2130 =cut
2131
2132 sub get_user_subpermissions {
2133     my $userid = shift;
2134
2135     my $dbh = C4::Context->dbh;
2136     my $sth = $dbh->prepare( "SELECT flag, user_permissions.code
2137                              FROM user_permissions
2138                              JOIN permissions USING (module_bit, code)
2139                              JOIN userflags ON (module_bit = bit)
2140                              JOIN borrowers USING (borrowernumber)
2141                              WHERE userid = ?" );
2142     $sth->execute($userid);
2143
2144     my $user_perms = {};
2145     while ( my $perm = $sth->fetchrow_hashref ) {
2146         $user_perms->{ $perm->{'flag'} }->{ $perm->{'code'} } = 1;
2147     }
2148     return $user_perms;
2149 }
2150
2151 =head2 get_all_subpermissions
2152
2153   my $perm_hashref = get_all_subpermissions();
2154
2155 Returns a hashref of hashrefs defining all specific
2156 permissions currently defined.  The return value
2157 has the same structure as that of C<get_user_subpermissions>,
2158 except that the innermost hash value is the description
2159 of the subpermission.
2160
2161 =cut
2162
2163 sub get_all_subpermissions {
2164     my $dbh = C4::Context->dbh;
2165     my $sth = $dbh->prepare( "SELECT flag, code
2166                              FROM permissions
2167                              JOIN userflags ON (module_bit = bit)" );
2168     $sth->execute();
2169
2170     my $all_perms = {};
2171     while ( my $perm = $sth->fetchrow_hashref ) {
2172         $all_perms->{ $perm->{'flag'} }->{ $perm->{'code'} } = 1;
2173     }
2174     return $all_perms;
2175 }
2176
2177 =head2 haspermission
2178
2179   $flagsrequired = '*';                                 # Any permission at all
2180   $flagsrequired = 'a_flag';                            # a_flag must be satisfied (all subpermissions)
2181   $flagsrequired = [ 'a_flag', 'b_flag' ];              # a_flag OR b_flag must be satisfied
2182   $flagsrequired = { 'a_flag => 1, 'b_flag' => 1 };     # a_flag AND b_flag must be satisfied
2183   $flagsrequired = { 'a_flag' => 'sub_a' };             # sub_a of a_flag must be satisfied
2184   $flagsrequired = { 'a_flag' => [ 'sub_a, 'sub_b' ] }; # sub_a OR sub_b of a_flag must be satisfied
2185
2186   $flags = ($userid, $flagsrequired);
2187
2188 C<$userid> the userid of the member
2189 C<$flags> is a query structure similar to that used by SQL::Abstract that
2190 denotes the combination of flags required. It is a required parameter.
2191
2192 The main logic of this method is that things in arrays are OR'ed, and things
2193 in hashes are AND'ed. The `*` character can be used, at any depth, to denote `ANY`
2194
2195 Returns member's flags or 0 if a permission is not met.
2196
2197 =cut
2198
2199 sub _dispatch {
2200     my ($required, $flags) = @_;
2201
2202     my $ref = ref($required);
2203     if ($ref eq '') {
2204         if ($required eq '*') {
2205             return 0 unless ( $flags or ref( $flags ) );
2206         } else {
2207             return 0 unless ( $flags and (!ref( $flags ) || $flags->{$required} ));
2208         }
2209     } elsif ($ref eq 'HASH') {
2210         foreach my $key (keys %{$required}) {
2211             next if $flags == 1;
2212             my $require = $required->{$key};
2213             my $rflags  = $flags->{$key};
2214             return 0 unless _dispatch($require, $rflags);
2215         }
2216     } elsif ($ref eq 'ARRAY') {
2217         my $satisfied = 0;
2218         foreach my $require ( @{$required} ) {
2219             my $rflags =
2220               ( ref($flags) && !ref($require) && ( $require ne '*' ) )
2221               ? $flags->{$require}
2222               : $flags;
2223             $satisfied++ if _dispatch( $require, $rflags );
2224         }
2225         return 0 unless $satisfied;
2226     } else {
2227         croak "Unexpected structure found: $ref";
2228     }
2229
2230     return $flags;
2231 };
2232
2233 sub haspermission {
2234     my ( $userid, $flagsrequired ) = @_;
2235
2236     #Koha::Exceptions::WrongParameter->throw('$flagsrequired should not be undef')
2237     #  unless defined($flagsrequired);
2238
2239     my $sth = C4::Context->dbh->prepare("SELECT flags FROM borrowers WHERE userid=?");
2240     $sth->execute($userid);
2241     my $row = $sth->fetchrow();
2242     my $flags = getuserflags( $row, $userid );
2243
2244     return $flags unless defined($flagsrequired);
2245     return $flags if $flags->{superlibrarian};
2246     return _dispatch($flagsrequired, $flags);
2247
2248     #FIXME - This fcn should return the failed permission so a suitable error msg can be delivered.
2249 }
2250
2251 =head2 in_iprange
2252
2253   $flags = ($iprange);
2254
2255 C<$iprange> A space separated string describing an IP range. Can include single IPs or ranges
2256
2257 Returns 1 if the remote address is in the provided iprange, or 0 otherwise.
2258
2259 =cut
2260
2261 sub in_iprange {
2262     my ($iprange) = @_;
2263     my $result = 1;
2264     my @allowedipranges = $iprange ? split(' ', $iprange) : ();
2265     if (scalar @allowedipranges > 0) {
2266         my @rangelist;
2267         eval { @rangelist = Net::CIDR::range2cidr(@allowedipranges); }; return 0 if $@;
2268         eval { $result = Net::CIDR::cidrlookup($ENV{'REMOTE_ADDR'}, @rangelist) } || Koha::Logger->get->warn('cidrlookup failed for ' . join(' ',@rangelist) );
2269      }
2270      return $result ? 1 : 0;
2271 }
2272
2273 sub getborrowernumber {
2274     my ($userid) = @_;
2275     my $userenv = C4::Context->userenv;
2276     if ( defined($userenv) && ref($userenv) eq 'HASH' && $userenv->{number} ) {
2277         return $userenv->{number};
2278     }
2279     my $dbh = C4::Context->dbh;
2280     for my $field ( 'userid', 'cardnumber' ) {
2281         my $sth =
2282           $dbh->prepare("select borrowernumber from borrowers where $field=?");
2283         $sth->execute($userid);
2284         if ( $sth->rows ) {
2285             my ($bnumber) = $sth->fetchrow;
2286             return $bnumber;
2287         }
2288     }
2289     return 0;
2290 }
2291
2292 =head2 track_login_daily
2293
2294     track_login_daily( $userid );
2295
2296 Wraps the call to $patron->track_login, the method used to update borrowers.lastseen. We only call track_login once a day.
2297
2298 =cut
2299
2300 sub track_login_daily {
2301     my $userid = shift;
2302     return if !$userid || !C4::Context->preference('TrackLastPatronActivity');
2303
2304     my $cache     = Koha::Caches->get_instance();
2305     my $cache_key = "track_login_" . $userid;
2306     my $cached    = $cache->get_from_cache($cache_key);
2307     my $today = dt_from_string()->ymd;
2308     return if $cached && $cached eq $today;
2309
2310     my $patron = Koha::Patrons->find({ userid => $userid });
2311     return unless $patron;
2312     $patron->track_login;
2313     $cache->set_in_cache( $cache_key, $today );
2314 }
2315
2316 END { }    # module clean-up code here (global destructor)
2317 1;
2318 __END__
2319
2320 =head1 SEE ALSO
2321
2322 CGI(3)
2323
2324 C4::Output(3)
2325
2326 Crypt::Eksblowfish::Bcrypt(3)
2327
2328 Digest::MD5(3)
2329
2330 =cut