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             advancedMARCEditor           => C4::Context->preference("advancedMARCEditor"),
 477             AllowMultipleCovers          => C4::Context->preference('AllowMultipleCovers'),
 478             AmazonCoverImages            => C4::Context->preference("AmazonCoverImages"),
 479             AutoLocation                 => C4::Context->preference("AutoLocation"),
 480             can_see_cataloguing_module   => haspermission( $user, get_cataloguing_page_permissions() ) ? 1 : 0,
 481             canreservefromotherbranches  => C4::Context->preference('canreservefromotherbranches'),
 482             EasyAnalyticalRecords        => C4::Context->preference('EasyAnalyticalRecords'),
 483             EnableBorrowerFiles          => C4::Context->preference('EnableBorrowerFiles'),
 484             FRBRizeEditions              => C4::Context->preference("FRBRizeEditions"),
 485             IndependentBranches          => C4::Context->preference("IndependentBranches"),
 486             intranetcolorstylesheet      => C4::Context->preference("intranetcolorstylesheet"),
 487             IntranetFavicon              => C4::Context->preference("IntranetFavicon"),
 488             IntranetmainUserblock        => C4::Context->preference("IntranetmainUserblock"),
 489             IntranetNav                  => C4::Context->preference("IntranetNav"),
 490             intranetreadinghistory       => C4::Context->preference("intranetreadinghistory"),
 491             intranetstylesheet           => C4::Context->preference("intranetstylesheet"),
 492             IntranetUserCSS              => C4::Context->preference("IntranetUserCSS"),
 493             IntranetUserJS               => C4::Context->preference("IntranetUserJS"),
 494             LibraryName                  => C4::Context->preference("LibraryName"),
 495             LocalCoverImages             => C4::Context->preference('LocalCoverImages'),
 496             OPACLocalCoverImages         => C4::Context->preference('OPACLocalCoverImages'),
 497             PatronAutoComplete           => C4::Context->preference("PatronAutoComplete"),
 498             pending_checkout_notes       => Koha::Checkouts->search( { noteseen => 0 } ),
 499             plugins_enabled              => C4::Context->config("enable_plugins"),
 500             StaffSerialIssueDisplayCount => C4::Context->preference("StaffSerialIssueDisplayCount"),
 501             UseCourseReserves            => C4::Context->preference("UseCourseReserves"),
 502             useDischarge                 => C4::Context->preference('useDischarge'),
 503             virtualshelves               => C4::Context->preference("virtualshelves"),
 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                     if ( $query->param('branch') ) {
1165                         $branchcode = $query->param('branch');
1166                         my $library = Koha::Libraries->find($branchcode);
1167                         $branchname = $library? $library->branchname: '';
1168                     }
1169                     if ( $query->param('desk_id') ) {
1170                         $desk_id = $query->param('desk_id');
1171                         my $desk = Koha::Desks->find($desk_id);
1172                         $desk_name = $desk ? $desk->desk_name : '';
1173                     }
1174                     if ( C4::Context->preference('UseCashRegisters') ) {
1175                         my $register =
1176                           $query->param('register_id')
1177                           ? Koha::Cash::Registers->find($query->param('register_id'))
1178                           : Koha::Cash::Registers->search(
1179                             { branch => $branchcode, branch_default => 1 },
1180                             { rows   => 1 } )->single;
1181                         $register_id   = $register->id   if ($register);
1182                         $register_name = $register->name if ($register);
1183                     }
1184                     my $branches = { map { $_->branchcode => $_->unblessed } Koha::Libraries->search->as_list };
1185                     if ( $type ne 'opac' and C4::Context->preference('AutoLocation') ) {
1186
1187                         # we have to check they are coming from the right ip range
1188                         my $domain = $branches->{$branchcode}->{'branchip'};
1189                         $domain =~ s|\.\*||g;
1190                         if ( $ip !~ /^$domain/ ) {
1191                             $loggedin = 0;
1192                             $cookie = $cookie_mgr->replace_in_list( $cookie, $query->cookie(
1193                                 -name     => 'CGISESSID',
1194                                 -value    => '',
1195                                 -HttpOnly => 1,
1196                                 -secure => ( C4::Context->https_enabled() ? 1 : 0 ),
1197                                 -sameSite => 'Lax',
1198                             ));
1199                             $info{'wrongip'} = 1;
1200                         }
1201                     }
1202
1203                     foreach my $br ( keys %$branches ) {
1204
1205                         #     now we work with the treatment of ip
1206                         my $domain = $branches->{$br}->{'branchip'};
1207                         if ( $domain && $ip =~ /^$domain/ ) {
1208                             $branchcode = $branches->{$br}->{'branchcode'};
1209
1210                             # new op dev : add the branchname to the cookie
1211                             $branchname    = $branches->{$br}->{'branchname'};
1212                         }
1213                     }
1214
1215                     my $is_sco_user = 0;
1216                     if ( $query->param('sco_user_login') && ( $query->param('sco_user_login') eq '1' ) ){
1217                         $is_sco_user = 1;
1218                     }
1219
1220                     $session->param( 'number',       $borrowernumber );
1221                     $session->param( 'id',           $userid );
1222                     $session->param( 'cardnumber',   $cardnumber );
1223                     $session->param( 'firstname',    $firstname );
1224                     $session->param( 'surname',      $surname );
1225                     $session->param( 'branch',       $branchcode );
1226                     $session->param( 'branchname',   $branchname );
1227                     $session->param( 'desk_id',      $desk_id);
1228                     $session->param( 'desk_name',     $desk_name);
1229                     $session->param( 'flags',        $userflags );
1230                     $session->param( 'emailaddress', $emailaddress );
1231                     $session->param( 'ip',           $session->remote_addr() );
1232                     $session->param( 'lasttime',     time() );
1233                     $session->param( 'interface',    $type);
1234                     $session->param( 'shibboleth',   $shibSuccess );
1235                     $session->param( 'register_id',  $register_id );
1236                     $session->param( 'register_name',  $register_name );
1237                     $session->param( 'sco_user', $is_sco_user );
1238                 }
1239                 $session->param('cas_ticket', $cas_ticket) if $cas_ticket;
1240                 C4::Context->set_userenv(
1241                     $session->param('number'),       $session->param('id'),
1242                     $session->param('cardnumber'),   $session->param('firstname'),
1243                     $session->param('surname'),      $session->param('branch'),
1244                     $session->param('branchname'),   $session->param('flags'),
1245                     $session->param('emailaddress'), $session->param('shibboleth'),
1246                     $session->param('desk_id'),      $session->param('desk_name'),
1247                     $session->param('register_id'),  $session->param('register_name')
1248                 );
1249
1250             }
1251             # $return: 0 = invalid user
1252             # reset to anonymous session
1253             else {
1254                 if ($userid) {
1255                     $info{'invalid_username_or_password'} = 1;
1256                     C4::Context::_unset_userenv($sessionID);
1257                 }
1258                 $session->param( 'lasttime', time() );
1259                 $session->param( 'ip',       $session->remote_addr() );
1260                 $session->param( 'sessiontype', 'anon' );
1261                 $session->param( 'interface', $type);
1262             }
1263         }    # END if ( $q_userid
1264         elsif ( $type eq "opac" ) {
1265
1266             # anonymous sessions are created only for the OPAC
1267
1268             # setting a couple of other session vars...
1269             $session->param( 'ip',          $session->remote_addr() );
1270             $session->param( 'lasttime',    time() );
1271             $session->param( 'sessiontype', 'anon' );
1272             $session->param( 'interface', $type);
1273         }
1274         $session->flush;
1275     }    # END unless ($userid)
1276
1277
1278     if ( $auth_state eq 'logged_in' ) {
1279         $auth_state = 'completed';
1280
1281         # Auth is completed unless an additional auth is needed
1282         if ( $require_2FA ) {
1283             my $patron = Koha::Patrons->find({userid => $userid});
1284             if ( C4::Context->preference('TwoFactorAuthentication') eq "enforced" && $patron->auth_method eq 'password' ) {
1285                 $auth_state = 'setup-additional-auth-needed';
1286                 $session->param('waiting-for-2FA-setup', 1);
1287                 %info = ();# We remove the warnings/errors we may have set incorrectly before
1288             } elsif ( $patron->auth_method eq 'two-factor' ) {
1289                 # Ask for the OTP token
1290                 $auth_state = 'additional-auth-needed';
1291                 $session->param('waiting-for-2FA', 1);
1292                 %info = ();# We remove the warnings/errors we may have set incorrectly before
1293             }
1294         }
1295     }
1296
1297     # finished authentification, now respond
1298     if ( $auth_state eq 'completed' || $authnotrequired ) {
1299         # successful login
1300         unless (@$cookie) {
1301             $cookie = $cookie_mgr->replace_in_list( $cookie, $query->cookie(
1302                 -name     => 'CGISESSID',
1303                 -value    => '',
1304                 -HttpOnly => 1,
1305                 -secure => ( C4::Context->https_enabled() ? 1 : 0 ),
1306                 -sameSite => 'Lax',
1307             ));
1308         }
1309
1310         track_login_daily( $userid );
1311
1312         # In case, that this request was a login attempt, we want to prevent that users can repost the opac login
1313         # request. We therefore redirect the user to the requested page again without the login parameters.
1314         # See Post/Redirect/Get (PRG) design pattern: https://en.wikipedia.org/wiki/Post/Redirect/Get
1315         if ( $type eq "opac" && $query->param('koha_login_context') && $query->param('koha_login_context') ne 'sco' && $query->param('password') && $query->param('userid') ) {
1316             my $uri = URI->new($query->url(-relative=>1, -query_string=>1));
1317             $uri->query_param_delete('userid');
1318             $uri->query_param_delete('password');
1319             $uri->query_param_delete('koha_login_context');
1320             print $query->redirect(-uri => $uri->as_string, -cookie => $cookie, -status=>'303 See other');
1321             safe_exit;
1322         }
1323
1324         return ( $userid, $cookie, $sessionID, $flags );
1325     }
1326
1327     #
1328     #
1329     # AUTH rejected, show the login/password template, after checking the DB.
1330     #
1331     #
1332
1333     my $patron = Koha::Patrons->find({ userid => $q_userid }); # Not necessary logged in!
1334
1335     # get the inputs from the incoming query
1336     my @inputs = ();
1337     my @inputs_to_clean = qw( userid password ticket logout.x otp_token );
1338     foreach my $name ( param $query) {
1339         next if grep { $name eq $_ } @inputs_to_clean;
1340         my @value = $query->multi_param($name);
1341         push @inputs, { name => $name, value => $_ } for @value;
1342     }
1343
1344     my $LibraryNameTitle = C4::Context->preference("LibraryName");
1345     $LibraryNameTitle =~ s/<(?:\/?)(?:br|p)\s*(?:\/?)>/ /sgi;
1346     $LibraryNameTitle =~ s/<(?:[^<>'"]|'(?:[^']*)'|"(?:[^"]*)")*>//sg;
1347
1348     my $auth_template_name = ( $type eq 'opac' ) ? 'opac-auth.tt' : 'auth.tt';
1349     my $auth_error = $query->param('auth_error');
1350     my $template = C4::Templates::gettemplate( $auth_template_name, $type, $query );
1351     $template->param(
1352         login                                 => 1,
1353         INPUTS                                => \@inputs,
1354         script_name                           => get_script_name(),
1355         casAuthentication                     => C4::Context->preference("casAuthentication"),
1356         shibbolethAuthentication              => $shib,
1357         suggestion                            => C4::Context->preference("suggestion"),
1358         virtualshelves                        => C4::Context->preference("virtualshelves"),
1359         LibraryName                           => "" . C4::Context->preference("LibraryName"),
1360         LibraryNameTitle                      => "" . $LibraryNameTitle,
1361         opacuserlogin                         => C4::Context->preference("opacuserlogin"),
1362         OpacFavicon                           => C4::Context->preference("OpacFavicon"),
1363         opacreadinghistory                    => C4::Context->preference("opacreadinghistory"),
1364         opaclanguagesdisplay                  => C4::Context->preference("opaclanguagesdisplay"),
1365         OPACUserJS                            => C4::Context->preference("OPACUserJS"),
1366         OPACUserCSS                           => C4::Context->preference("OPACUserCSS"),
1367         intranetcolorstylesheet               => C4::Context->preference("intranetcolorstylesheet"),
1368         intranetstylesheet                    => C4::Context->preference("intranetstylesheet"),
1369         IntranetNav                           => C4::Context->preference("IntranetNav"),
1370         IntranetFavicon                       => C4::Context->preference("IntranetFavicon"),
1371         IntranetUserCSS                       => C4::Context->preference("IntranetUserCSS"),
1372         IntranetUserJS                        => C4::Context->preference("IntranetUserJS"),
1373         IndependentBranches                   => C4::Context->preference("IndependentBranches"),
1374         AutoLocation                          => C4::Context->preference("AutoLocation"),
1375         wrongip                               => $info{'wrongip'},
1376         PatronSelfRegistration                => C4::Context->preference("PatronSelfRegistration"),
1377         PatronSelfRegistrationDefaultCategory => C4::Context->preference("PatronSelfRegistrationDefaultCategory"),
1378         opac_css_override                     => $ENV{'OPAC_CSS_OVERRIDE'},
1379         too_many_login_attempts               => ( $patron and $patron->account_locked ),
1380         password_has_expired                  => ( $patron and $patron->password_expired ),
1381         auth_error                            => $auth_error,
1382     );
1383
1384     $template->param( SCO_login => 1 ) if ( $query->param('sco_user_login') );
1385     $template->param( SCI_login => 1 ) if ( $query->param('sci_user_login') );
1386     $template->param( OpacPublic => C4::Context->preference("OpacPublic") );
1387     $template->param( loginprompt => 1 ) unless $info{'nopermission'};
1388     if ( $auth_state eq 'additional-auth-needed' ) {
1389         my $patron = Koha::Patrons->find( { userid => $userid } );
1390         $template->param(
1391             TwoFA_prompt => 1,
1392             invalid_otp_token => $invalid_otp_token,
1393             notice_email_address => $patron->notice_email_address, # We could also pass logged_in_user if necessary
1394         );
1395     }
1396
1397     if ( $auth_state eq 'setup-additional-auth-needed' ) {
1398         $template->param(
1399             TwoFA_setup => 1,
1400         );
1401     }
1402
1403     if ( $type eq 'opac' ) {
1404         require Koha::Virtualshelves;
1405         my $some_public_shelves = Koha::Virtualshelves->get_some_shelves(
1406             {
1407                 public => 1,
1408             }
1409         );
1410         $template->param(
1411             some_public_shelves  => $some_public_shelves,
1412         );
1413     }
1414
1415     if ($cas) {
1416
1417         # Is authentication against multiple CAS servers enabled?
1418         require C4::Auth_with_cas;
1419         if ( multipleAuth() && !$casparam ) {
1420             my $casservers = getMultipleAuth();
1421             my @tmplservers;
1422             foreach my $key ( keys %$casservers ) {
1423                 push @tmplservers, { name => $key, value => login_cas_url( $query, $key, $type ) . "?cas=$key" };
1424             }
1425             $template->param(
1426                 casServersLoop => \@tmplservers
1427             );
1428         } else {
1429             $template->param(
1430                 casServerUrl => login_cas_url($query, undef, $type),
1431             );
1432         }
1433
1434         $template->param(
1435             invalidCasLogin => $info{'invalidCasLogin'}
1436         );
1437     }
1438
1439     if ($shib) {
1440         #If shibOnly is enabled just go ahead and redirect directly
1441         if ( (($type eq 'opac') && C4::Context->preference('OPACShibOnly')) || (($type ne 'opac') && C4::Context->preference('staffShibOnly')) ) {
1442             my $redirect_url = login_shib_url( $query );
1443             print $query->redirect( -uri => "$redirect_url", -status => 303 );
1444             safe_exit;
1445         }
1446
1447         $template->param(
1448             shibbolethAuthentication => $shib,
1449             shibbolethLoginUrl       => login_shib_url($query),
1450         );
1451     }
1452
1453     if (C4::Context->preference('GoogleOpenIDConnect')) {
1454         if ($query->param("OpenIDConnectFailed")) {
1455             my $reason = $query->param('OpenIDConnectFailed');
1456             $template->param(invalidGoogleOpenIDConnectLogin => $reason);
1457         }
1458     }
1459
1460     $template->param(
1461         LibraryName => C4::Context->preference("LibraryName"),
1462     );
1463     $template->param(%info);
1464
1465     #    $cookie = $query->cookie(CGISESSID => $session->id
1466     #   );
1467     print $query->header(
1468         {   type              => 'text/html',
1469             charset           => 'utf-8',
1470             cookie            => $cookie,
1471             'X-Frame-Options' => 'SAMEORIGIN',
1472             -sameSite => 'Lax'
1473         }
1474       ),
1475       $template->output;
1476     safe_exit;
1477 }
1478
1479 =head2 check_api_auth
1480
1481   ($status, $cookie, $sessionId) = check_api_auth($query, $userflags);
1482
1483 Given a CGI query containing the parameters 'userid' and 'password' and/or a session
1484 cookie, determine if the user has the privileges specified by C<$userflags>.
1485
1486 C<check_api_auth> is is meant for authenticating users of web services, and
1487 consequently will always return and will not attempt to redirect the user
1488 agent.
1489
1490 If a valid session cookie is already present, check_api_auth will return a status
1491 of "ok", the cookie, and the Koha session ID.
1492
1493 If no session cookie is present, check_api_auth will check the 'userid' and 'password
1494 parameters and create a session cookie and Koha session if the supplied credentials
1495 are OK.
1496
1497 Possible return values in C<$status> are:
1498
1499 =over
1500
1501 =item "ok" -- user authenticated; C<$cookie> and C<$sessionid> have valid values.
1502
1503 =item "failed" -- credentials are not correct; C<$cookie> and C<$sessionid> are undef
1504
1505 =item "maintenance" -- DB is in maintenance mode; no login possible at the moment
1506
1507 =item "expired -- session cookie has expired; API user should resubmit userid and password
1508
1509 =item "restricted" -- The IP has changed (if SessionRestrictionByIP)
1510
1511 =item "additional-auth-needed -- User is in an authentication process that is not finished
1512
1513 =back
1514
1515 =cut
1516
1517 sub check_api_auth {
1518
1519     my $query         = shift;
1520     my $flagsrequired = shift;
1521     my $timeout = _timeout_syspref();
1522
1523     unless ( C4::Context->preference('Version') ) {
1524
1525         # database has not been installed yet
1526         return ( "maintenance", undef, undef );
1527     }
1528     my $kohaversion = Koha::version();
1529     $kohaversion =~ s/(.*\..*)\.(.*)\.(.*)/$1$2$3/;
1530     if ( C4::Context->preference('Version') < $kohaversion ) {
1531
1532         # database in need of version update; assume that
1533         # no API should be called while databsae is in
1534         # this condition.
1535         return ( "maintenance", undef, undef );
1536     }
1537
1538     my ( $sessionID, $session );
1539     unless ( $query->param('userid') ) {
1540         $sessionID = $query->cookie("CGISESSID");
1541     }
1542     if ( $sessionID && not( $cas && $query->param('PT') ) ) {
1543
1544         my $return;
1545         ( $return, $session, undef ) = check_cookie_auth(
1546             $sessionID, $flagsrequired, { remote_addr => $ENV{REMOTE_ADDR} } );
1547
1548         return ( $return, undef, undef ) # Cookie auth failed
1549             if $return ne "ok";
1550
1551         my $cookie = $query->cookie(
1552             -name     => 'CGISESSID',
1553             -value    => $session->id,
1554             -HttpOnly => 1,
1555             -secure => ( C4::Context->https_enabled() ? 1 : 0 ),
1556             -sameSite => 'Lax'
1557         );
1558         return ( $return, $cookie, $session ); # return == 'ok' here
1559
1560     } else {
1561
1562         # new login
1563         my $userid   = $query->param('userid');
1564         my $password = $query->param('password');
1565         my ( $return, $cardnumber, $cas_ticket );
1566
1567         # Proxy CAS auth
1568         if ( $cas && $query->param('PT') ) {
1569             my $retuserid;
1570
1571             # In case of a CAS authentication, we use the ticket instead of the password
1572             my $PT = $query->param('PT');
1573             ( $return, $cardnumber, $userid, $cas_ticket ) = check_api_auth_cas( $PT, $query );    # EXTERNAL AUTH
1574         } else {
1575
1576             # User / password auth
1577             unless ( $userid and $password ) {
1578
1579                 # caller did something wrong, fail the authenticateion
1580                 return ( "failed", undef, undef );
1581             }
1582             my $newuserid;
1583             ( $return, $cardnumber, $newuserid, $cas_ticket ) = checkpw( $userid, $password, $query );
1584         }
1585
1586         if ( $return and haspermission( $userid, $flagsrequired ) ) {
1587             my $session = get_session("");
1588             return ( "failed", undef, undef ) unless $session;
1589
1590             my $sessionID = $session->id;
1591             C4::Context->_new_userenv($sessionID);
1592             my $cookie = $query->cookie(
1593                 -name     => 'CGISESSID',
1594                 -value    => $sessionID,
1595                 -HttpOnly => 1,
1596                 -secure => ( C4::Context->https_enabled() ? 1 : 0 ),
1597                 -sameSite => 'Lax'
1598             );
1599             if ( $return == 1 ) {
1600                 my (
1601                     $borrowernumber, $firstname,  $surname,
1602                     $userflags,      $branchcode, $branchname,
1603                     $emailaddress
1604                 );
1605                 my $dbh = C4::Context->dbh;
1606                 my $sth =
1607                   $dbh->prepare(
1608 "select borrowernumber, firstname, surname, flags, borrowers.branchcode, branches.branchname as branchname, email from borrowers left join branches on borrowers.branchcode=branches.branchcode where userid=?"
1609                   );
1610                 $sth->execute($userid);
1611                 (
1612                     $borrowernumber, $firstname,  $surname,
1613                     $userflags,      $branchcode, $branchname,
1614                     $emailaddress
1615                 ) = $sth->fetchrow if ( $sth->rows );
1616
1617                 unless ( $sth->rows ) {
1618                     my $sth = $dbh->prepare(
1619 "select borrowernumber, firstname, surname, flags, borrowers.branchcode, branches.branchname as branchname, email from borrowers left join branches on borrowers.branchcode=branches.branchcode where cardnumber=?"
1620                     );
1621                     $sth->execute($cardnumber);
1622                     (
1623                         $borrowernumber, $firstname,  $surname,
1624                         $userflags,      $branchcode, $branchname,
1625                         $emailaddress
1626                     ) = $sth->fetchrow if ( $sth->rows );
1627
1628                     unless ( $sth->rows ) {
1629                         $sth->execute($userid);
1630                         (
1631                             $borrowernumber, $firstname,  $surname,       $userflags,
1632                             $branchcode,     $branchname, $emailaddress
1633                         ) = $sth->fetchrow if ( $sth->rows );
1634                     }
1635                 }
1636
1637                 my $ip = $ENV{'REMOTE_ADDR'};
1638
1639                 # if they specify at login, use that
1640                 if ( $query->param('branch') ) {
1641                     $branchcode = $query->param('branch');
1642                     my $library = Koha::Libraries->find($branchcode);
1643                     $branchname = $library? $library->branchname: '';
1644                 }
1645                 my $branches = { map { $_->branchcode => $_->unblessed } Koha::Libraries->search->as_list };
1646                 foreach my $br ( keys %$branches ) {
1647
1648                     #     now we work with the treatment of ip
1649                     my $domain = $branches->{$br}->{'branchip'};
1650                     if ( $domain && $ip =~ /^$domain/ ) {
1651                         $branchcode = $branches->{$br}->{'branchcode'};
1652
1653                         # new op dev : add the branchname to the cookie
1654                         $branchname    = $branches->{$br}->{'branchname'};
1655                     }
1656                 }
1657                 $session->param( 'number',       $borrowernumber );
1658                 $session->param( 'id',           $userid );
1659                 $session->param( 'cardnumber',   $cardnumber );
1660                 $session->param( 'firstname',    $firstname );
1661                 $session->param( 'surname',      $surname );
1662                 $session->param( 'branch',       $branchcode );
1663                 $session->param( 'branchname',   $branchname );
1664                 $session->param( 'flags',        $userflags );
1665                 $session->param( 'emailaddress', $emailaddress );
1666                 $session->param( 'ip',           $session->remote_addr() );
1667                 $session->param( 'lasttime',     time() );
1668                 $session->param( 'interface',    'api'  );
1669             }
1670             $session->param( 'cas_ticket', $cas_ticket);
1671             C4::Context->set_userenv(
1672                 $session->param('number'),       $session->param('id'),
1673                 $session->param('cardnumber'),   $session->param('firstname'),
1674                 $session->param('surname'),      $session->param('branch'),
1675                 $session->param('branchname'),   $session->param('flags'),
1676                 $session->param('emailaddress'), $session->param('shibboleth'),
1677                 $session->param('desk_id'),      $session->param('desk_name'),
1678                 $session->param('register_id'),  $session->param('register_name')
1679             );
1680             return ( "ok", $cookie, $sessionID );
1681         } else {
1682             return ( "failed", undef, undef );
1683         }
1684     }
1685 }
1686
1687 =head2 check_cookie_auth
1688
1689   ($status, $sessionId) = check_cookie_auth($cookie, $userflags);
1690
1691 Given a CGISESSID cookie set during a previous login to Koha, determine
1692 if the user has the privileges specified by C<$userflags>. C<$userflags>
1693 is passed unaltered into C<haspermission> and as such accepts all options
1694 avaiable to that routine with the one caveat that C<check_api_auth> will
1695 also allow 'undef' to be passed and in such a case the permissions check
1696 will be skipped altogether.
1697
1698 C<check_cookie_auth> is meant for authenticating special services
1699 such as tools/upload-file.pl that are invoked by other pages that
1700 have been authenticated in the usual way.
1701
1702 Possible return values in C<$status> are:
1703
1704 =over
1705
1706 =item "ok" -- user authenticated; C<$sessionID> have valid values.
1707
1708 =item "anon" -- user not authenticated but valid for anonymous session.
1709
1710 =item "failed" -- credentials are not correct; C<$sessionid> are undef
1711
1712 =item "maintenance" -- DB is in maintenance mode; no login possible at the moment
1713
1714 =item "expired -- session cookie has expired; API user should resubmit userid and password
1715
1716 =item "restricted" -- The IP has changed (if SessionRestrictionByIP)
1717
1718 =back
1719
1720 =cut
1721
1722 sub check_cookie_auth {
1723     my $sessionID     = shift;
1724     my $flagsrequired = shift;
1725     my $params        = shift;
1726
1727     my $remote_addr = $params->{remote_addr} || $ENV{REMOTE_ADDR};
1728
1729     my $skip_version_check = $params->{skip_version_check}; # Only for checkauth
1730
1731     unless ( $skip_version_check ) {
1732         unless ( C4::Context->preference('Version') ) {
1733
1734             # database has not been installed yet
1735             return ( "maintenance", undef );
1736         }
1737         my $kohaversion = Koha::version();
1738         $kohaversion =~ s/(.*\..*)\.(.*)\.(.*)/$1$2$3/;
1739         if ( C4::Context->preference('Version') < $kohaversion ) {
1740
1741             # database in need of version update; assume that
1742             # no API should be called while databsae is in
1743             # this condition.
1744             return ( "maintenance", undef );
1745         }
1746     }
1747
1748     # see if we have a valid session cookie already
1749     # however, if a userid parameter is present (i.e., from
1750     # a form submission, assume that any current cookie
1751     # is to be ignored
1752     unless ( $sessionID ) {
1753         return ( "failed", undef );
1754     }
1755     C4::Context::_unset_userenv($sessionID); # remove old userenv first
1756     my $session   = get_session($sessionID);
1757     if ($session) {
1758         my $userid   = $session->param('id');
1759         my $ip       = $session->param('ip');
1760         my $lasttime = $session->param('lasttime');
1761         my $timeout = _timeout_syspref();
1762
1763         if ( !$lasttime || ( $lasttime < time() - $timeout ) ) {
1764             # time out
1765             $session->delete();
1766             $session->flush;
1767             return ("expired", undef);
1768
1769         } elsif ( C4::Context->preference('SessionRestrictionByIP') && $ip ne $remote_addr ) {
1770             # IP address changed
1771             $session->delete();
1772             $session->flush;
1773             return ( "restricted", undef, { old_ip => $ip, new_ip => $remote_addr});
1774
1775         } elsif ( $userid ) {
1776             $session->param( 'lasttime', time() );
1777             my $patron = Koha::Patrons->find({ userid => $userid });
1778
1779             # If the user modify their own userid
1780             # Better than 500 but we could do better
1781             unless ( $patron ) {
1782                 $session->delete();
1783                 $session->flush;
1784                 return ("expired", undef);
1785             }
1786
1787             $patron = Koha::Patrons->find({ cardnumber => $userid })
1788               unless $patron;
1789             return ("password_expired", undef ) if $patron->password_expired;
1790             my $flags = defined($flagsrequired) ? haspermission( $userid, $flagsrequired ) : 1;
1791             if ($flags) {
1792                 C4::Context->_new_userenv($sessionID);
1793                 if ( !C4::Context->interface ) {
1794                     # No need to override the interface, most often set by get_template_and_user
1795                     C4::Context->interface( $session->param('interface') );
1796                 }
1797                 C4::Context->set_userenv(
1798                     $session->param('number'),       $session->param('id') // '',
1799                     $session->param('cardnumber'),   $session->param('firstname'),
1800                     $session->param('surname'),      $session->param('branch'),
1801                     $session->param('branchname'),   $session->param('flags'),
1802                     $session->param('emailaddress'), $session->param('shibboleth'),
1803                     $session->param('desk_id'),      $session->param('desk_name'),
1804                     $session->param('register_id'),  $session->param('register_name')
1805                 );
1806                 if ( C4::Context->preference('TwoFactorAuthentication') ne 'disabled' ) {
1807                     return ( "additional-auth-needed", $session )
1808                         if $session->param('waiting-for-2FA');
1809
1810                     return ( "setup-additional-auth-needed", $session )
1811                         if $session->param('waiting-for-2FA-setup');
1812                 }
1813
1814                 return ( "ok", $session );
1815             } else {
1816                 $session->delete();
1817                 $session->flush;
1818                 return ( "failed", undef );
1819             }
1820
1821         } else {
1822             C4::Context->_new_userenv($sessionID);
1823             C4::Context->interface($session->param('interface'));
1824             C4::Context->set_userenv( undef, q{} );
1825             return ( "anon", $session );
1826         }
1827     } else {
1828         return ( "expired", undef );
1829     }
1830 }
1831
1832 =head2 get_session
1833
1834   use CGI::Session;
1835   my $session = get_session($sessionID);
1836
1837 Given a session ID, retrieve the CGI::Session object used to store
1838 the session's state.  The session object can be used to store
1839 data that needs to be accessed by different scripts during a
1840 user's session.
1841
1842 If the C<$sessionID> parameter is an empty string, a new session
1843 will be created.
1844
1845 =cut
1846
1847 sub _get_session_params {
1848     my $storage_method = C4::Context->preference('SessionStorage');
1849     if ( $storage_method eq 'mysql' ) {
1850         my $dbh = C4::Context->dbh;
1851         return { dsn => "serializer:yamlxs;driver:MySQL;id:md5", dsn_args => { Handle => $dbh } };
1852     }
1853     elsif ( $storage_method eq 'Pg' ) {
1854         my $dbh = C4::Context->dbh;
1855         return { dsn => "serializer:yamlxs;driver:PostgreSQL;id:md5", dsn_args => { Handle => $dbh } };
1856     }
1857     elsif ( $storage_method eq 'memcached' && Koha::Caches->get_instance->memcached_cache ) {
1858         my $memcached = Koha::Caches->get_instance()->memcached_cache;
1859         return { dsn => "serializer:yamlxs;driver:memcached;id:md5", dsn_args => { Memcached => $memcached } };
1860     }
1861     else {
1862         # catch all defaults to tmp should work on all systems
1863         my $dir = C4::Context::temporary_directory;
1864         my $instance = C4::Context->config( 'database' ); #actually for packages not exactly the instance name, but generally safer to leave it as it is
1865         return { dsn => "serializer:yamlxs;driver:File;id:md5", dsn_args => { Directory => "$dir/cgisess_$instance" } };
1866     }
1867 }
1868
1869 sub get_session {
1870     my $sessionID      = shift;
1871     my $params = _get_session_params();
1872     my $session;
1873     if( $sessionID ) { # find existing
1874         CGI::Session::ErrorHandler->set_error( q{} ); # clear error, cpan issue #111463
1875         $session = CGI::Session->load( $params->{dsn}, $sessionID, $params->{dsn_args} );
1876     } else {
1877         $session = CGI::Session->new( $params->{dsn}, $sessionID, $params->{dsn_args} );
1878         # no need to flush here
1879     }
1880     return $session;
1881 }
1882
1883 =head2 create_basic_session
1884
1885 my $session = create_basic_session({ patron => $patron, interface => $interface });
1886
1887 Creates a session and adds all basic parameters for a session to work
1888
1889 =cut
1890
1891 sub create_basic_session {
1892     my $params    = shift;
1893     my $patron    = $params->{patron};
1894     my $interface = $params->{interface};
1895
1896     $interface = 'intranet' if $interface eq 'staff';
1897
1898     my $session = get_session("");
1899
1900     $session->param( 'number',       $patron->borrowernumber );
1901     $session->param( 'id',           $patron->userid );
1902     $session->param( 'cardnumber',   $patron->cardnumber );
1903     $session->param( 'firstname',    $patron->firstname );
1904     $session->param( 'surname',      $patron->surname );
1905     $session->param( 'branch',       $patron->branchcode );
1906     $session->param( 'branchname',   $patron->library->branchname );
1907     $session->param( 'flags',        $patron->flags );
1908     $session->param( 'emailaddress', $patron->email );
1909     $session->param( 'ip',           $session->remote_addr() );
1910     $session->param( 'lasttime',     time() );
1911     $session->param( 'interface',    $interface);
1912
1913     return $session;
1914 }
1915
1916
1917 # FIXME no_set_userenv may be replaced with force_branchcode_for_userenv
1918 # (or something similar)
1919 # Currently it's only passed from C4::SIP::ILS::Patron::check_password, but
1920 # not having a userenv defined could cause a crash.
1921 sub checkpw {
1922     my ( $userid, $password, $query, $type, $no_set_userenv ) = @_;
1923     $type = 'opac' unless $type;
1924
1925     # Get shibboleth login attribute
1926     my $shib = C4::Context->config('useshibboleth') && shib_ok();
1927     my $shib_login = $shib ? get_login_shib() : undef;
1928
1929     my @return;
1930     my $patron;
1931     if ( defined $userid ){
1932         $patron = Koha::Patrons->find({ userid => $userid });
1933         $patron = Koha::Patrons->find({ cardnumber => $userid }) unless $patron;
1934     }
1935     my $check_internal_as_fallback = 0;
1936     my $passwd_ok = 0;
1937     # Note: checkpw_* routines returns:
1938     # 1 if auth is ok
1939     # 0 if auth is nok
1940     # -1 if user bind failed (LDAP only)
1941
1942     if ( $patron and ( $patron->account_locked )  ) {
1943         # Nothing to check, account is locked
1944     } elsif ($ldap && defined($password)) {
1945         my ( $retval, $retcard, $retuserid ) = checkpw_ldap(@_);    # EXTERNAL AUTH
1946         if ( $retval == 1 ) {
1947             @return = ( $retval, $retcard, $retuserid );
1948             $passwd_ok = 1;
1949         }
1950         $check_internal_as_fallback = 1 if $retval == 0;
1951
1952     } elsif ( $cas && $query && $query->param('ticket') ) {
1953
1954         # In case of a CAS authentication, we use the ticket instead of the password
1955         my $ticket = $query->param('ticket');
1956         $query->delete('ticket');                                   # remove ticket to come back to original URL
1957         my ( $retval, $retcard, $retuserid, $cas_ticket ) = checkpw_cas( $ticket, $query, $type );    # EXTERNAL AUTH
1958         if ( $retval ) {
1959             @return = ( $retval, $retcard, $retuserid, $cas_ticket );
1960         } else {
1961             @return = (0);
1962         }
1963         $passwd_ok = $retval;
1964     }
1965
1966     # If we are in a shibboleth session (shibboleth is enabled, and a shibboleth match attribute is present)
1967     # Check for password to asertain whether we want to be testing against shibboleth or another method this
1968     # time around.
1969     elsif ( $shib && $shib_login && !$password ) {
1970
1971         # In case of a Shibboleth authentication, we expect a shibboleth user attribute
1972         # (defined under shibboleth mapping in koha-conf.xml) to contain the login of the
1973         # shibboleth-authenticated user
1974
1975         # Then, we check if it matches a valid koha user
1976         if ($shib_login) {
1977             my ( $retval, $retcard, $retuserid ) = C4::Auth_with_shibboleth::checkpw_shib($shib_login);    # EXTERNAL AUTH
1978             if ( $retval ) {
1979                 @return = ( $retval, $retcard, $retuserid );
1980             }
1981             $passwd_ok = $retval;
1982         }
1983     } else {
1984         $check_internal_as_fallback = 1;
1985     }
1986
1987     # INTERNAL AUTH
1988     if ( $check_internal_as_fallback ) {
1989         @return = checkpw_internal( $userid, $password, $no_set_userenv);
1990         $passwd_ok = 1 if $return[0] > 0; # 1 or 2
1991     }
1992
1993     if( $patron ) {
1994         if ( $passwd_ok ) {
1995             $patron->update({ login_attempts => 0 });
1996             if( $patron->password_expired ){
1997                 @return = (-2);
1998             }
1999         } elsif( !$patron->account_locked ) {
2000             $patron->update({ login_attempts => $patron->login_attempts + 1 });
2001         }
2002     }
2003
2004     # Optionally log success or failure
2005     if( $patron && $passwd_ok && C4::Context->preference('AuthSuccessLog') ) {
2006         logaction( 'AUTH', 'SUCCESS', $patron->id, "Valid password for $userid", $type );
2007     } elsif( !$passwd_ok && C4::Context->preference('AuthFailureLog') ) {
2008         logaction( 'AUTH', 'FAILURE', $patron ? $patron->id : 0, "Wrong password for $userid", $type );
2009     }
2010
2011     return @return;
2012 }
2013
2014 sub checkpw_internal {
2015     my ( $userid, $password, $no_set_userenv ) = @_;
2016
2017     $password = Encode::encode( 'UTF-8', $password )
2018       if Encode::is_utf8($password);
2019
2020     my $dbh = C4::Context->dbh;
2021     my $sth =
2022       $dbh->prepare(
2023         "select password,cardnumber,borrowernumber,userid,firstname,surname,borrowers.branchcode,branches.branchname,flags from borrowers join branches on borrowers.branchcode=branches.branchcode where userid=?"
2024       );
2025     $sth->execute($userid);
2026     if ( $sth->rows ) {
2027         my ( $stored_hash, $cardnumber, $borrowernumber, $userid, $firstname,
2028             $surname, $branchcode, $branchname, $flags )
2029           = $sth->fetchrow;
2030
2031         if ( checkpw_hash( $password, $stored_hash ) ) {
2032
2033             C4::Context->set_userenv( "$borrowernumber", $userid, $cardnumber,
2034                 $firstname, $surname, $branchcode, $branchname, $flags ) unless $no_set_userenv;
2035             return 1, $cardnumber, $userid;
2036         }
2037     }
2038     $sth =
2039       $dbh->prepare(
2040         "select password,cardnumber,borrowernumber,userid,firstname,surname,borrowers.branchcode,branches.branchname,flags from borrowers join branches on borrowers.branchcode=branches.branchcode where cardnumber=?"
2041       );
2042     $sth->execute($userid);
2043     if ( $sth->rows ) {
2044         my ( $stored_hash, $cardnumber, $borrowernumber, $userid, $firstname,
2045             $surname, $branchcode, $branchname, $flags )
2046           = $sth->fetchrow;
2047
2048         if ( checkpw_hash( $password, $stored_hash ) ) {
2049
2050             C4::Context->set_userenv( $borrowernumber, $userid, $cardnumber,
2051                 $firstname, $surname, $branchcode, $branchname, $flags ) unless $no_set_userenv;
2052             return 1, $cardnumber, $userid;
2053         }
2054     }
2055     return 0;
2056 }
2057
2058 sub checkpw_hash {
2059     my ( $password, $stored_hash ) = @_;
2060
2061     return if $stored_hash eq '!';
2062
2063     # check what encryption algorithm was implemented: Bcrypt - if the hash starts with '$2' it is Bcrypt else md5
2064     my $hash;
2065     if ( substr( $stored_hash, 0, 2 ) eq '$2' ) {
2066         $hash = hash_password( $password, $stored_hash );
2067     } else {
2068         $hash = md5_base64($password);
2069     }
2070     return $hash eq $stored_hash;
2071 }
2072
2073 =head2 getuserflags
2074
2075     my $authflags = getuserflags($flags, $userid, [$dbh]);
2076
2077 Translates integer flags into permissions strings hash.
2078
2079 C<$flags> is the integer userflags value ( borrowers.userflags )
2080 C<$userid> is the members.userid, used for building subpermissions
2081 C<$authflags> is a hashref of permissions
2082
2083 =cut
2084
2085 sub getuserflags {
2086     my $flags  = shift;
2087     my $userid = shift;
2088     my $dbh    = @_ ? shift : C4::Context->dbh;
2089     my $userflags;
2090     {
2091         # I don't want to do this, but if someone logs in as the database
2092         # user, it would be preferable not to spam them to death with
2093         # numeric warnings. So, we make $flags numeric.
2094         no warnings 'numeric';
2095         $flags += 0;
2096     }
2097     my $sth = $dbh->prepare("SELECT bit, flag, defaulton FROM userflags");
2098     $sth->execute;
2099
2100     while ( my ( $bit, $flag, $defaulton ) = $sth->fetchrow ) {
2101         if ( ( $flags & ( 2**$bit ) ) || $defaulton ) {
2102             $userflags->{$flag} = 1;
2103         }
2104         else {
2105             $userflags->{$flag} = 0;
2106         }
2107     }
2108
2109     # get subpermissions and merge with top-level permissions
2110     my $user_subperms = get_user_subpermissions($userid);
2111     foreach my $module ( keys %$user_subperms ) {
2112         next if $userflags->{$module} == 1;    # user already has permission for everything in this module
2113         $userflags->{$module} = $user_subperms->{$module};
2114     }
2115
2116     return $userflags;
2117 }
2118
2119 =head2 get_user_subpermissions
2120
2121   $user_perm_hashref = get_user_subpermissions($userid);
2122
2123 Given the userid (note, not the borrowernumber) of a staff user,
2124 return a hashref of hashrefs of the specific subpermissions
2125 accorded to the user.  An example return is
2126
2127  {
2128     tools => {
2129         export_catalog => 1,
2130         import_patrons => 1,
2131     }
2132  }
2133
2134 The top-level hash-key is a module or function code from
2135 userflags.flag, while the second-level key is a code
2136 from permissions.
2137
2138 The results of this function do not give a complete picture
2139 of the functions that a staff user can access; it is also
2140 necessary to check borrowers.flags.
2141
2142 =cut
2143
2144 sub get_user_subpermissions {
2145     my $userid = shift;
2146
2147     my $dbh = C4::Context->dbh;
2148     my $sth = $dbh->prepare( "SELECT flag, user_permissions.code
2149                              FROM user_permissions
2150                              JOIN permissions USING (module_bit, code)
2151                              JOIN userflags ON (module_bit = bit)
2152                              JOIN borrowers USING (borrowernumber)
2153                              WHERE userid = ?" );
2154     $sth->execute($userid);
2155
2156     my $user_perms = {};
2157     while ( my $perm = $sth->fetchrow_hashref ) {
2158         $user_perms->{ $perm->{'flag'} }->{ $perm->{'code'} } = 1;
2159     }
2160     return $user_perms;
2161 }
2162
2163 =head2 get_all_subpermissions
2164
2165   my $perm_hashref = get_all_subpermissions();
2166
2167 Returns a hashref of hashrefs defining all specific
2168 permissions currently defined.  The return value
2169 has the same structure as that of C<get_user_subpermissions>,
2170 except that the innermost hash value is the description
2171 of the subpermission.
2172
2173 =cut
2174
2175 sub get_all_subpermissions {
2176     my $dbh = C4::Context->dbh;
2177     my $sth = $dbh->prepare( "SELECT flag, code
2178                              FROM permissions
2179                              JOIN userflags ON (module_bit = bit)" );
2180     $sth->execute();
2181
2182     my $all_perms = {};
2183     while ( my $perm = $sth->fetchrow_hashref ) {
2184         $all_perms->{ $perm->{'flag'} }->{ $perm->{'code'} } = 1;
2185     }
2186     return $all_perms;
2187 }
2188
2189 =head2 get_cataloguing_page_permissions
2190
2191     my $required_permissions = get_cataloguing_page_permissions();
2192
2193 Returns the required permissions to access the main cataloguing page. Useful for building
2194 the global I<can_see_cataloguing_module> template variable, and also for reusing in
2195 I<cataloging-home.pl>.
2196
2197 =cut
2198
2199 sub get_cataloguing_page_permissions {
2200
2201     my @cataloguing_tools_subperms = qw(
2202         inventory
2203         items_batchdel
2204         items_batchmod
2205         items_batchmod
2206         label_creator
2207         manage_staged_marc
2208         marc_modification_templates
2209         records_batchdel
2210         records_batchmod
2211         stage_marc_import
2212         upload_cover_images
2213     );
2214
2215     return [
2216         { editcatalogue => '*' }, { tools => \@cataloguing_tools_subperms },
2217         C4::Context->preference('StockRotation') ? { stockrotation => 'manage_rotas' } : ()
2218     ];
2219 }
2220
2221 =head2 haspermission
2222
2223   $flagsrequired = '*';                                 # Any permission at all
2224   $flagsrequired = 'a_flag';                            # a_flag must be satisfied (all subpermissions)
2225   $flagsrequired = [ 'a_flag', 'b_flag' ];              # a_flag OR b_flag must be satisfied
2226   $flagsrequired = { 'a_flag => 1, 'b_flag' => 1 };     # a_flag AND b_flag must be satisfied
2227   $flagsrequired = { 'a_flag' => 'sub_a' };             # sub_a of a_flag must be satisfied
2228   $flagsrequired = { 'a_flag' => [ 'sub_a, 'sub_b' ] }; # sub_a OR sub_b of a_flag must be satisfied
2229
2230   $flags = ($userid, $flagsrequired);
2231
2232 C<$userid> the userid of the member
2233 C<$flags> is a query structure similar to that used by SQL::Abstract that
2234 denotes the combination of flags required. It is a required parameter.
2235
2236 The main logic of this method is that things in arrays are OR'ed, and things
2237 in hashes are AND'ed. The `*` character can be used, at any depth, to denote `ANY`
2238
2239 Returns member's flags or 0 if a permission is not met.
2240
2241 =cut
2242
2243 sub _dispatch {
2244     my ($required, $flags) = @_;
2245
2246     my $ref = ref($required);
2247     if ($ref eq '') {
2248         if ($required eq '*') {
2249             return 0 unless ( $flags or ref( $flags ) );
2250         } else {
2251             return 0 unless ( $flags and (!ref( $flags ) || $flags->{$required} ));
2252         }
2253     } elsif ($ref eq 'HASH') {
2254         foreach my $key (keys %{$required}) {
2255             next if $flags == 1;
2256             my $require = $required->{$key};
2257             my $rflags  = $flags->{$key};
2258             return 0 unless _dispatch($require, $rflags);
2259         }
2260     } elsif ($ref eq 'ARRAY') {
2261         my $satisfied = 0;
2262         foreach my $require ( @{$required} ) {
2263             my $rflags =
2264               ( ref($flags) && !ref($require) && ( $require ne '*' ) )
2265               ? $flags->{$require}
2266               : $flags;
2267             $satisfied++ if _dispatch( $require, $rflags );
2268         }
2269         return 0 unless $satisfied;
2270     } else {
2271         croak "Unexpected structure found: $ref";
2272     }
2273
2274     return $flags;
2275 };
2276
2277 sub haspermission {
2278     my ( $userid, $flagsrequired ) = @_;
2279
2280     #Koha::Exceptions::WrongParameter->throw('$flagsrequired should not be undef')
2281     #  unless defined($flagsrequired);
2282
2283     my $sth = C4::Context->dbh->prepare("SELECT flags FROM borrowers WHERE userid=?");
2284     $sth->execute($userid);
2285     my $row = $sth->fetchrow();
2286     my $flags = getuserflags( $row, $userid );
2287
2288     return $flags unless defined($flagsrequired);
2289     return $flags if $flags->{superlibrarian};
2290     return _dispatch($flagsrequired, $flags);
2291
2292     #FIXME - This fcn should return the failed permission so a suitable error msg can be delivered.
2293 }
2294
2295 =head2 in_iprange
2296
2297   $flags = ($iprange);
2298
2299 C<$iprange> A space separated string describing an IP range. Can include single IPs or ranges
2300
2301 Returns 1 if the remote address is in the provided iprange, or 0 otherwise.
2302
2303 =cut
2304
2305 sub in_iprange {
2306     my ($iprange) = @_;
2307     my $result = 1;
2308     my @allowedipranges = $iprange ? split(' ', $iprange) : ();
2309     if (scalar @allowedipranges > 0) {
2310         my @rangelist;
2311         eval { @rangelist = Net::CIDR::range2cidr(@allowedipranges); }; return 0 if $@;
2312         eval { $result = Net::CIDR::cidrlookup($ENV{'REMOTE_ADDR'}, @rangelist) } || Koha::Logger->get->warn('cidrlookup failed for ' . join(' ',@rangelist) );
2313      }
2314      return $result ? 1 : 0;
2315 }
2316
2317 sub getborrowernumber {
2318     my ($userid) = @_;
2319     my $userenv = C4::Context->userenv;
2320     if ( defined($userenv) && ref($userenv) eq 'HASH' && $userenv->{number} ) {
2321         return $userenv->{number};
2322     }
2323     my $dbh = C4::Context->dbh;
2324     for my $field ( 'userid', 'cardnumber' ) {
2325         my $sth =
2326           $dbh->prepare("select borrowernumber from borrowers where $field=?");
2327         $sth->execute($userid);
2328         if ( $sth->rows ) {
2329             my ($bnumber) = $sth->fetchrow;
2330             return $bnumber;
2331         }
2332     }
2333     return 0;
2334 }
2335
2336 =head2 track_login_daily
2337
2338     track_login_daily( $userid );
2339
2340 Wraps the call to $patron->track_login, the method used to update borrowers.lastseen. We only call track_login once a day.
2341
2342 =cut
2343
2344 sub track_login_daily {
2345     my $userid = shift;
2346     return if !$userid || !C4::Context->preference('TrackLastPatronActivity');
2347
2348     my $cache     = Koha::Caches->get_instance();
2349     my $cache_key = "track_login_" . $userid;
2350     my $cached    = $cache->get_from_cache($cache_key);
2351     my $today = dt_from_string()->ymd;
2352     return if $cached && $cached eq $today;
2353
2354     my $patron = Koha::Patrons->find({ userid => $userid });
2355     return unless $patron;
2356     $patron->track_login;
2357     $cache->set_in_cache( $cache_key, $today );
2358 }
2359
2360 END { }    # module clean-up code here (global destructor)
2361 1;
2362 __END__
2363
2364 =head1 SEE ALSO
2365
2366 CGI(3)
2367
2368 C4::Output(3)
2369
2370 Crypt::Eksblowfish::Bcrypt(3)
2371
2372 Digest::MD5(3)
2373
2374 =cut