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