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