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