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             OpacAuthorities                       => C4::Context->preference("OpacAuthorities"),
 577             opac_css_override                     => $ENV{'OPAC_CSS_OVERRIDE'},
 578             opac_search_limit                     => $opac_search_limit,
 579             opac_limit_override                   => $opac_limit_override,
 580             OpacBrowser                           => C4::Context->preference("OpacBrowser"),
 581             OpacCloud                             => C4::Context->preference("OpacCloud"),
 582             OpacKohaUrl                           => C4::Context->preference("OpacKohaUrl"),
 583             OpacPasswordChange                    => C4::Context->preference("OpacPasswordChange"),
 584             OPACPatronDetails                     => C4::Context->preference("OPACPatronDetails"),
 585             OPACPrivacy                           => C4::Context->preference("OPACPrivacy"),
 586             OPACFinesTab                          => C4::Context->preference("OPACFinesTab"),
 587             OpacTopissue                          => C4::Context->preference("OpacTopissue"),
 588             'Version'                             => C4::Context->preference('Version'),
 589             hidelostitems                         => C4::Context->preference("hidelostitems"),
 590             mylibraryfirst                        => ( C4::Context->preference("SearchMyLibraryFirst") && C4::Context->userenv ) ? C4::Context->userenv->{'branch'} : '',
 591             opacbookbag                           => "" . C4::Context->preference("opacbookbag"),
 592             OpacFavicon                           => C4::Context->preference("OpacFavicon"),
 593             opaclanguagesdisplay                  => "" . C4::Context->preference("opaclanguagesdisplay"),
 594             opacreadinghistory                    => C4::Context->preference("opacreadinghistory"),
 595             opacuserlogin                         => "" . C4::Context->preference("opacuserlogin"),
 596             OpenLibrarySearch                     => C4::Context->preference("OpenLibrarySearch"),
 597             ShowReviewer                          => C4::Context->preference("ShowReviewer"),
 598             ShowReviewerPhoto                     => C4::Context->preference("ShowReviewerPhoto"),
 599             suggestion                            => $can_make_suggestions,
 600             virtualshelves                        => "" . C4::Context->preference("virtualshelves"),
 601             OPACSerialIssueDisplayCount           => C4::Context->preference("OPACSerialIssueDisplayCount"),
 602             SyndeticsClientCode                   => C4::Context->preference("SyndeticsClientCode"),
 603             SyndeticsEnabled                      => C4::Context->preference("SyndeticsEnabled"),
 604             SyndeticsCoverImages                  => C4::Context->preference("SyndeticsCoverImages"),
 605             SyndeticsTOC                          => C4::Context->preference("SyndeticsTOC"),
 606             SyndeticsSummary                      => C4::Context->preference("SyndeticsSummary"),
 607             SyndeticsEditions                     => C4::Context->preference("SyndeticsEditions"),
 608             SyndeticsExcerpt                      => C4::Context->preference("SyndeticsExcerpt"),
 609             SyndeticsReviews                      => C4::Context->preference("SyndeticsReviews"),
 610             SyndeticsAuthorNotes                  => C4::Context->preference("SyndeticsAuthorNotes"),
 611             SyndeticsAwards                       => C4::Context->preference("SyndeticsAwards"),
 612             SyndeticsSeries                       => C4::Context->preference("SyndeticsSeries"),
 613             SyndeticsCoverImageSize               => C4::Context->preference("SyndeticsCoverImageSize"),
 614             OPACLocalCoverImages                  => C4::Context->preference("OPACLocalCoverImages"),
 615             PatronSelfRegistration                => C4::Context->preference("PatronSelfRegistration"),
 616             PatronSelfRegistrationDefaultCategory => C4::Context->preference("PatronSelfRegistrationDefaultCategory"),
 617             useDischarge                 => C4::Context->preference('useDischarge'),
 618         );
 619
 620         $template->param( OpacPublic => '1' ) if ( $user || C4::Context->preference("OpacPublic") );
 621     }
 622
 623     # Check if we were asked using parameters to force a specific language
 624     if ( defined $in->{'query'}->param('language') ) {
 625
 626         # Extract the language, let C4::Languages::getlanguage choose
 627         # what to do
 628         my $language = C4::Languages::getlanguage( $in->{'query'} );
 629         my $languagecookie = C4::Templates::getlanguagecookie( $in->{'query'}, $language );
 630         $cookie = $cookie_mgr->replace_in_list( $cookie, $languagecookie );
 631     }
 632
 633     return ( $template, $borrowernumber, $cookie, $flags );
 634 }
 635
 636 =head2 checkauth
 637
 638   ($userid, $cookie, $sessionID) = &checkauth($query, $noauth, $flagsrequired, $type);
 639
 640 Verifies that the user is authorized to run this script.  If
 641 the user is authorized, a (userid, cookie, session-id, flags)
 642 quadruple is returned.  If the user is not authorized but does
 643 not have the required privilege (see $flagsrequired below), it
 644 displays an error page and exits.  Otherwise, it displays the
 645 login page and exits.
 646
 647 Note that C<&checkauth> will return if and only if the user
 648 is authorized, so it should be called early on, before any
 649 unfinished operations (e.g., if you've opened a file, then
 650 C<&checkauth> won't close it for you).
 651
 652 C<$query> is the CGI object for the script calling C<&checkauth>.
 653
 654 The C<$noauth> argument is optional. If it is set, then no
 655 authorization is required for the script.
 656
 657 C<&checkauth> fetches user and session information from C<$query> and
 658 ensures that the user is authorized to run scripts that require
 659 authorization.
 660
 661 The C<$flagsrequired> argument specifies the required privileges
 662 the user must have if the username and password are correct.
 663 It should be specified as a reference-to-hash; keys in the hash
 664 should be the "flags" for the user, as specified in the Members
 665 intranet module. Any key specified must correspond to a "flag"
 666 in the userflags table. E.g., { circulate => 1 } would specify
 667 that the user must have the "circulate" privilege in order to
 668 proceed. To make sure that access control is correct, the
 669 C<$flagsrequired> parameter must be specified correctly.
 670
 671 Koha also has a concept of sub-permissions, also known as
 672 granular permissions.  This makes the value of each key
 673 in the C<flagsrequired> hash take on an additional
 674 meaning, i.e.,
 675
 676  1
 677
 678 The user must have access to all subfunctions of the module
 679 specified by the hash key.
 680
 681  *
 682
 683 The user must have access to at least one subfunction of the module
 684 specified by the hash key.
 685
 686  specific permission, e.g., 'export_catalog'
 687
 688 The user must have access to the specific subfunction list, which
 689 must correspond to a row in the permissions table.
 690
 691 The C<$type> argument specifies whether the template should be
 692 retrieved from the opac or intranet directory tree.  "opac" is
 693 assumed if it is not specified; however, if C<$type> is specified,
 694 "intranet" is assumed if it is not "opac".
 695
 696 If C<$query> does not have a valid session ID associated with it
 697 (i.e., the user has not logged in) or if the session has expired,
 698 C<&checkauth> presents the user with a login page (from the point of
 699 view of the original script, C<&checkauth> does not return). Once the
 700 user has authenticated, C<&checkauth> restarts the original script
 701 (this time, C<&checkauth> returns).
 702
 703 The login page is provided using a HTML::Template, which is set in the
 704 systempreferences table or at the top of this file. The variable C<$type>
 705 selects which template to use, either the opac or the intranet
 706 authentification template.
 707
 708 C<&checkauth> returns a user ID, a cookie, and a session ID. The
 709 cookie should be sent back to the browser; it verifies that the user
 710 has authenticated.
 711
 712 =cut
 713
 714 sub _version_check {
 715     my $type  = shift;
 716     my $query = shift;
 717     my $version;
 718
 719     # If version syspref is unavailable, it means Koha is being installed,
 720     # and so we must redirect to OPAC maintenance page or to the WebInstaller
 721     # also, if OpacMaintenance is ON, OPAC should redirect to maintenance
 722     if ( C4::Context->preference('OpacMaintenance') && $type eq 'opac' ) {
 723         warn "OPAC Install required, redirecting to maintenance";
 724         print $query->redirect("/cgi-bin/koha/maintenance.pl");
 725         safe_exit;
 726     }
 727     unless ( $version = C4::Context->preference('Version') ) {    # assignment, not comparison
 728         if ( $type ne 'opac' ) {
 729             warn "Install required, redirecting to Installer";
 730             print $query->redirect("/cgi-bin/koha/installer/install.pl");
 731         } else {
 732             warn "OPAC Install required, redirecting to maintenance";
 733             print $query->redirect("/cgi-bin/koha/maintenance.pl");
 734         }
 735         safe_exit;
 736     }
 737
 738     # check that database and koha version are the same
 739     # there is no DB version, it's a fresh install,
 740     # go to web installer
 741     # there is a DB version, compare it to the code version
 742     my $kohaversion = Koha::version();
 743
 744     # remove the 3 last . to have a Perl number
 745     $kohaversion =~ s/(.*\..*)\.(.*)\.(.*)/$1$2$3/;
 746     Koha::Logger->get->debug("kohaversion : $kohaversion");
 747     if ( $version < $kohaversion ) {
 748         my $warning = "Database update needed, redirecting to %s. Database is $version and Koha is $kohaversion";
 749         if ( $type ne 'opac' ) {
 750             warn sprintf( $warning, 'Installer' );
 751             print $query->redirect("/cgi-bin/koha/installer/install.pl?step=1&op=updatestructure");
 752         } else {
 753             warn sprintf( "OPAC: " . $warning, 'maintenance' );
 754             print $query->redirect("/cgi-bin/koha/maintenance.pl");
 755         }
 756         safe_exit;
 757     }
 758 }
 759
 760 sub _timeout_syspref {
 761     my $default_timeout = 600;
 762     my $timeout = C4::Context->preference('timeout') || $default_timeout;
 763
 764     # value in days, convert in seconds
 765     if ( $timeout =~ /^(\d+)[dD]$/ ) {
 766         $timeout = $1 * 86400;
 767     }
 768     # value in hours, convert in seconds
 769     elsif ( $timeout =~ /^(\d+)[hH]$/ ) {
 770         $timeout = $1 * 3600;
 771     }
 772     elsif ( $timeout !~ m/^\d+$/ ) {
 773         warn "The value of the system preference 'timeout' is not correct, defaulting to $default_timeout";
 774         $timeout = $default_timeout;
 775     }
 776
 777     return $timeout;
 778 }
 779
 780 sub checkauth {
 781     my $query = shift;
 782
 783     # Get shibboleth login attribute
 784     my $shib = C4::Context->config('useshibboleth') && shib_ok();
 785     my $shib_login = $shib ? get_login_shib() : undef;
 786
 787     # $authnotrequired will be set for scripts which will run without authentication
 788     my $authnotrequired = shift;
 789     my $flagsrequired   = shift;
 790     my $type            = shift;
 791     my $emailaddress    = shift;
 792     my $template_name   = shift;
 793     $type = 'opac' unless $type;
 794
 795     if ( $type eq 'opac' && !C4::Context->preference("OpacPublic") ) {
 796         my @allowed_scripts_for_private_opac = qw(
 797           opac-memberentry.tt
 798           opac-registration-email-sent.tt
 799           opac-registration-confirmation.tt
 800           opac-memberentry-update-submitted.tt
 801           opac-password-recovery.tt
 802           opac-reset-password.tt
 803         );
 804         $authnotrequired = 0 unless grep { $_ eq $template_name }
 805           @allowed_scripts_for_private_opac;
 806     }
 807
 808     my $timeout = _timeout_syspref();
 809
 810     my $cookie_mgr = Koha::CookieManager->new;
 811
 812     _version_check( $type, $query );
 813
 814     # state variables
 815     my $loggedin = 0;
 816     my $auth_state = 'failed';
 817     my %info;
 818     my ( $userid, $cookie, $sessionID, $flags );
 819     $cookie = [];
 820     my $logout = $query->param('logout.x');
 821
 822     my $anon_search_history;
 823     my $cas_ticket = '';
 824     # This parameter is the name of the CAS server we want to authenticate against,
 825     # when using authentication against multiple CAS servers, as configured in Auth_cas_servers.yaml
 826     my $casparam = $query->param('cas');
 827     my $q_userid = $query->param('userid') // '';
 828
 829     my $session;
 830     my $invalid_otp_token;
 831     my $require_2FA =
 832       ( $type ne "opac" # Only available for the staff interface
 833           && C4::Context->preference('TwoFactorAuthentication') ne "disabled" ) # If "enabled" or "enforced"
 834       ? 1 : 0;
 835
 836     # Basic authentication is incompatible with the use of Shibboleth,
 837     # as Shibboleth may return REMOTE_USER as a Shibboleth attribute,
 838     # and it may not be the attribute we want to use to match the koha login.
 839     #
 840     # Also, do not consider an empty REMOTE_USER.
 841     #
 842     # Finally, after those tests, we can assume (although if it would be better with
 843     # a syspref) that if we get a REMOTE_USER, that's from basic authentication,
 844     # and we can affect it to $userid.
 845     if ( !$shib and defined( $ENV{'REMOTE_USER'} ) and $ENV{'REMOTE_USER'} ne '' and $userid = $ENV{'REMOTE_USER'} ) {
 846
 847         # Using Basic Authentication, no cookies required
 848         $cookie = $cookie_mgr->replace_in_list( $cookie, $query->cookie(
 849             -name     => 'CGISESSID',
 850             -value    => '',
 851             -HttpOnly => 1,
 852             -secure => ( C4::Context->https_enabled() ? 1 : 0 ),
 853             -sameSite => 'Lax',
 854         ));
 855         $loggedin = 1;
 856     }
 857     elsif ( $emailaddress) {
 858         # the Google OpenID Connect passes an email address
 859     }
 860     elsif ( $sessionID = $query->cookie("CGISESSID") ) {    # assignment, not comparison
 861         my ( $return, $more_info );
 862         # NOTE: $flags in the following call is still undefined !
 863         ( $return, $session, $more_info ) = check_cookie_auth( $sessionID, $flags,
 864             { remote_addr => $ENV{REMOTE_ADDR}, skip_version_check => 1 }
 865         );
 866
 867         if ( $return eq 'ok' || $return eq 'additional-auth-needed' ) {
 868             $userid = $session->param('id');
 869         }
 870
 871         $auth_state =
 872             $return eq 'ok'                     ? 'completed'
 873           : $return eq 'additional-auth-needed' ? 'additional-auth-needed'
 874           :                                       'failed';
 875
 876         # We are at the second screen if the waiting-for-2FA is set in session
 877         # and otp_token param has been passed
 878         if (   $require_2FA
 879             && $auth_state eq 'additional-auth-needed'
 880             && ( my $otp_token = $query->param('otp_token') ) )
 881         {
 882             my $patron    = Koha::Patrons->find( { userid => $userid } );
 883             my $auth      = Koha::Auth::TwoFactorAuth->new( { patron => $patron } );
 884             my $verified = $auth->verify($otp_token);
 885             $auth->clear;
 886             if ( $verified ) {
 887                 # The token is correct, the user is fully logged in!
 888                 $auth_state = 'completed';
 889                 $session->param( 'waiting-for-2FA', 0 );
 890                 $session->param( 'waiting-for-2FA-setup', 0 );
 891
 892                # This is an ugly trick to pass the test
 893                # $query->param('koha_login_context') && ( $q_userid ne $userid )
 894                # few lines later
 895                 $q_userid = $userid;
 896             }
 897             else {
 898                 $invalid_otp_token = 1;
 899             }
 900         }
 901
 902         if ( $auth_state eq 'completed' ) {
 903             Koha::Logger->get->debug(sprintf "AUTH_SESSION: (%s)\t%s %s - %s", map { $session->param($_) || q{} } qw(cardnumber firstname surname branch));
 904
 905             if ( ( $query->param('koha_login_context') && ( $q_userid ne $userid ) )
 906                 || ( $cas && $query->param('ticket') && !C4::Context->userenv->{'id'} )
 907                 || ( $shib && $shib_login && !$logout && !C4::Context->userenv->{'id'} )
 908             ) {
 909
 910                 #if a user enters an id ne to the id in the current session, we need to log them in...
 911                 #first we need to clear the anonymous session...
 912                 $anon_search_history = $session->param('search_history');
 913                 $session->delete();
 914                 $session->flush;
 915                 $cookie = $cookie_mgr->clear_unless( $query->cookie, @$cookie );
 916                 C4::Context::_unset_userenv($sessionID);
 917                 $sessionID = undef;
 918                 undef $userid; # IMPORTANT: this assures us a new session in code below
 919                 $auth_state = 'failed';
 920             } elsif (!$logout) {
 921
 922                 $cookie = $cookie_mgr->replace_in_list( $cookie, $query->cookie(
 923                     -name     => 'CGISESSID',
 924                     -value    => $session->id,
 925                     -HttpOnly => 1,
 926                     -secure => ( C4::Context->https_enabled() ? 1 : 0 ),
 927                     -sameSite => 'Lax',
 928                 ));
 929
 930                 $flags = haspermission( $userid, $flagsrequired );
 931                 unless ( $flags ) {
 932                     $auth_state = 'failed';
 933                     $info{'nopermission'} = 1;
 934                 }
 935             }
 936         } elsif ( !$logout ) {
 937             if ( $return eq 'expired' ) {
 938                 $info{timed_out} = 1;
 939             } elsif ( $return eq 'restricted' ) {
 940                 $info{oldip}        = $more_info->{old_ip};
 941                 $info{newip}        = $more_info->{new_ip};
 942                 $info{different_ip} = 1;
 943             } elsif ( $return eq 'password_expired' ) {
 944                 $info{password_has_expired} = 1;
 945             }
 946         }
 947     }
 948
 949     if ( $auth_state eq 'failed' || $logout ) {
 950         $sessionID = undef;
 951         $userid    = undef;
 952     }
 953
 954     if ($logout) {
 955
 956         # voluntary logout the user
 957         # check wether the user was using their shibboleth session or a local one
 958         my $shibSuccess = C4::Context->userenv ? C4::Context->userenv->{'shibboleth'} : undef;
 959         if ( $session ) {
 960             $session->delete();
 961             $session->flush;
 962         }
 963         C4::Context::_unset_userenv($sessionID);
 964         $cookie = $cookie_mgr->clear_unless( $query->cookie, @$cookie );
 965
 966         if ($cas and $caslogout) {
 967             logout_cas($query, $type);
 968         }
 969
 970         # If we are in a shibboleth session (shibboleth is enabled, a shibboleth match attribute is set and matches koha matchpoint)
 971         if ( $shib and $shib_login and $shibSuccess) {
 972             logout_shib($query);
 973         }
 974
 975         $session   = undef;
 976         $auth_state = 'logout';
 977     }
 978
 979     unless ( $userid ) {
 980         #we initiate a session prior to checking for a username to allow for anonymous sessions...
 981         if( !$session or !$sessionID ) { # if we cleared sessionID, we need a new session
 982             $session = get_session() or die "Auth ERROR: Cannot get_session()";
 983         }
 984
 985         # Save anonymous search history in new session so it can be retrieved
 986         # by get_template_and_user to store it in user's search history after
 987         # a successful login.
 988         if ($anon_search_history) {
 989             $session->param( 'search_history', $anon_search_history );
 990         }
 991
 992         $sessionID = $session->id;
 993         C4::Context->_new_userenv($sessionID);
 994         $cookie = $cookie_mgr->replace_in_list( $cookie, $query->cookie(
 995             -name     => 'CGISESSID',
 996             -value    => $sessionID,
 997             -HttpOnly => 1,
 998             -secure => ( C4::Context->https_enabled() ? 1 : 0 ),
 999             -sameSite => 'Lax',
1000         ));
1001         my $pki_field = C4::Context->preference('AllowPKIAuth');
1002         if ( !defined($pki_field) ) {
1003             print STDERR "ERROR: Missing system preference AllowPKIAuth.\n";
1004             $pki_field = 'None';
1005         }
1006         if ( ( $cas && $query->param('ticket') )
1007             || $q_userid
1008             || ( $shib && $shib_login )
1009             || $pki_field ne 'None'
1010             || $emailaddress )
1011         {
1012             my $password    = $query->param('password');
1013             my $shibSuccess = 0;
1014             my ( $return, $cardnumber );
1015
1016             # If shib is enabled and we have a shib login, does the login match a valid koha user
1017             if ( $shib && $shib_login ) {
1018                 my $retuserid;
1019
1020                 # Do not pass password here, else shib will not be checked in checkpw.
1021                 ( $return, $cardnumber, $retuserid ) = checkpw( $q_userid, undef, $query );
1022                 $userid      = $retuserid;
1023                 $shibSuccess = $return;
1024                 $info{'invalidShibLogin'} = 1 unless ($return);
1025             }
1026
1027             # If shib login and match were successful, skip further login methods
1028             unless ($shibSuccess) {
1029                 if ( $cas && $query->param('ticket') ) {
1030                     my $retuserid;
1031                     ( $return, $cardnumber, $retuserid, $cas_ticket ) =
1032                       checkpw( $userid, $password, $query, $type );
1033                     $userid = $retuserid;
1034                     $info{'invalidCasLogin'} = 1 unless ($return);
1035                 }
1036
1037                 elsif ( $emailaddress ) {
1038                     my $value = $emailaddress;
1039
1040                     # If we're looking up the email, there's a chance that the person
1041                     # doesn't have a userid. So if there is none, we pass along the
1042                     # borrower number, and the bits of code that need to know the user
1043                     # ID will have to be smart enough to handle that.
1044                     my $patrons = Koha::Patrons->search({ email => $value });
1045                     if ($patrons->count) {
1046
1047                         # First the userid, then the borrowernum
1048                         my $patron = $patrons->next;
1049                         $value = $patron->userid || $patron->borrowernumber;
1050                     } else {
1051                         undef $value;
1052                     }
1053                     $return = $value ? 1 : 0;
1054                     $userid = $value;
1055                 }
1056
1057                 elsif (
1058                     ( $pki_field eq 'Common Name' && $ENV{'SSL_CLIENT_S_DN_CN'} )
1059                     || ( $pki_field eq 'emailAddress'
1060                         && $ENV{'SSL_CLIENT_S_DN_Email'} )
1061                   )
1062                 {
1063                     my $value;
1064                     if ( $pki_field eq 'Common Name' ) {
1065                         $value = $ENV{'SSL_CLIENT_S_DN_CN'};
1066                     }
1067                     elsif ( $pki_field eq 'emailAddress' ) {
1068                         $value = $ENV{'SSL_CLIENT_S_DN_Email'};
1069
1070                         # If we're looking up the email, there's a chance that the person
1071                         # doesn't have a userid. So if there is none, we pass along the
1072                         # borrower number, and the bits of code that need to know the user
1073                         # ID will have to be smart enough to handle that.
1074                         my $patrons = Koha::Patrons->search({ email => $value });
1075                         if ($patrons->count) {
1076
1077                             # First the userid, then the borrowernum
1078                             my $patron = $patrons->next;
1079                             $value = $patron->userid || $patron->borrowernumber;
1080                         } else {
1081                             undef $value;
1082                         }
1083                     }
1084
1085                     $return = $value ? 1 : 0;
1086                     $userid = $value;
1087
1088                 }
1089                 else {
1090                     my $retuserid;
1091                     my $request_method = $query->request_method // q{};
1092
1093                     if (
1094                         $request_method eq 'POST'
1095                         || ( C4::Context->preference('AutoSelfCheckID')
1096                             && $q_userid eq C4::Context->preference('AutoSelfCheckID') )
1097                       )
1098                     {
1099
1100                         ( $return, $cardnumber, $retuserid, $cas_ticket ) =
1101                           checkpw( $q_userid, $password, $query, $type );
1102                         $userid = $retuserid if ($retuserid);
1103                         $info{'invalid_username_or_password'} = 1 unless ($return);
1104                     }
1105                 }
1106             }
1107
1108             # If shib configured and shibOnly enabled, we should ignore anything other than a shibboleth type login.
1109             if (
1110                    $shib
1111                 && !$shibSuccess
1112                 && (
1113                     (
1114                         ( $type eq 'opac' )
1115                         && C4::Context->preference('OPACShibOnly')
1116                     )
1117                     || ( ( $type ne 'opac' )
1118                         && C4::Context->preference('staffShibOnly') )
1119                 )
1120               )
1121             {
1122                 $return = 0;
1123             }
1124
1125             # $return: 1 = valid user
1126             if( $return && $return > 0 ) {
1127
1128                 if ( $flags = haspermission( $userid, $flagsrequired ) ) {
1129                     $auth_state = "logged_in";
1130                 }
1131                 else {
1132                     $auth_state = 'failed';
1133                     # FIXME We could add $return = 0; or even delete the session?
1134                     # Currently return == 1 and we will fill session info later on,
1135                     # although we do present an authorization failure. (Yes, the
1136                     # authentication was actually correct.)
1137                     $info{'nopermission'} = 1;
1138                     C4::Context::_unset_userenv($sessionID);
1139                 }
1140                 my ( $borrowernumber, $firstname, $surname, $userflags,
1141                     $branchcode, $branchname, $emailaddress, $desk_id,
1142                     $desk_name, $register_id, $register_name );
1143
1144                 if ( $return == 1 ) {
1145                     my $select = "
1146                     SELECT borrowernumber, firstname, surname, flags, borrowers.branchcode,
1147                     branches.branchname    as branchname, email
1148                     FROM borrowers
1149                     LEFT JOIN branches on borrowers.branchcode=branches.branchcode
1150                     ";
1151                     my $dbh = C4::Context->dbh;
1152                     my $sth = $dbh->prepare("$select where userid=?");
1153                     $sth->execute($userid);
1154                     unless ( $sth->rows ) {
1155                         $sth = $dbh->prepare("$select where cardnumber=?");
1156                         $sth->execute($cardnumber);
1157
1158                         unless ( $sth->rows ) {
1159                             $sth->execute($userid);
1160                         }
1161                     }
1162                     if ( $sth->rows ) {
1163                         ( $borrowernumber, $firstname, $surname, $userflags,
1164                             $branchcode, $branchname, $emailaddress ) = $sth->fetchrow;
1165                     }
1166
1167                     # launch a sequence to check if we have a ip for the branch, i
1168                     # if we have one we replace the branchcode of the userenv by the branch bound in the ip.
1169
1170                     my $ip = $ENV{'REMOTE_ADDR'};
1171
1172                     # if they specify at login, use that
1173                     my $patron = Koha::Patrons->find({userid => $userid});
1174                     if ( $query->param('branch')  && ( haspermission($userid, {  'loggedinlibrary'=> 1 }) || $patron->is_superlibrarian ) ) {
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         opacbookbag                           => "" . C4::Context->preference("opacbookbag"),
1376         OpacCloud                             => C4::Context->preference("OpacCloud"),
1377         OpacTopissue                          => C4::Context->preference("OpacTopissue"),
1378         OpacAuthorities                       => C4::Context->preference("OpacAuthorities"),
1379         OpacBrowser                           => C4::Context->preference("OpacBrowser"),
1380         TagsEnabled                           => C4::Context->preference("TagsEnabled"),
1381         intranetcolorstylesheet               => C4::Context->preference("intranetcolorstylesheet"),
1382         intranetstylesheet                    => C4::Context->preference("intranetstylesheet"),
1383         IntranetNav                           => C4::Context->preference("IntranetNav"),
1384         IntranetFavicon                       => C4::Context->preference("IntranetFavicon"),
1385         IntranetUserCSS                       => C4::Context->preference("IntranetUserCSS"),
1386         IntranetUserJS                        => C4::Context->preference("IntranetUserJS"),
1387         IndependentBranches                   => C4::Context->preference("IndependentBranches"),
1388         AutoLocation                          => C4::Context->preference("AutoLocation"),
1389         wrongip                               => $info{'wrongip'},
1390         PatronSelfRegistration                => C4::Context->preference("PatronSelfRegistration"),
1391         PatronSelfRegistrationDefaultCategory => C4::Context->preference("PatronSelfRegistrationDefaultCategory"),
1392         opac_css_override                     => $ENV{'OPAC_CSS_OVERRIDE'},
1393         too_many_login_attempts               => ( $patron and $patron->account_locked ),
1394         password_has_expired                  => ( $patron and $patron->password_expired ),
1395         auth_error                            => $auth_error,
1396     );
1397
1398     $template->param( SCO_login => 1 ) if ( $query->param('sco_user_login') );
1399     $template->param( SCI_login => 1 ) if ( $query->param('sci_user_login') );
1400     $template->param( OpacPublic => C4::Context->preference("OpacPublic") );
1401     $template->param( loginprompt => 1 ) unless $info{'nopermission'};
1402     if ( $auth_state eq 'additional-auth-needed' ) {
1403         my $patron = Koha::Patrons->find( { userid => $userid } );
1404         $template->param(
1405             TwoFA_prompt => 1,
1406             invalid_otp_token => $invalid_otp_token,
1407             notice_email_address => $patron->notice_email_address, # We could also pass logged_in_user if necessary
1408         );
1409     }
1410
1411     if ( $auth_state eq 'setup-additional-auth-needed' ) {
1412         $template->param(
1413             TwoFA_setup => 1,
1414         );
1415     }
1416
1417     if ( $type eq 'opac' ) {
1418         require Koha::Virtualshelves;
1419         my $some_public_shelves = Koha::Virtualshelves->get_some_shelves(
1420             {
1421                 public => 1,
1422             }
1423         );
1424         $template->param(
1425             some_public_shelves  => $some_public_shelves,
1426         );
1427     }
1428
1429     if ($cas) {
1430
1431         # Is authentication against multiple CAS servers enabled?
1432         require C4::Auth_with_cas;
1433         if ( multipleAuth() && !$casparam ) {
1434             my $casservers = getMultipleAuth();
1435             my @tmplservers;
1436             foreach my $key ( keys %$casservers ) {
1437                 push @tmplservers, { name => $key, value => login_cas_url( $query, $key, $type ) . "?cas=$key" };
1438             }
1439             $template->param(
1440                 casServersLoop => \@tmplservers
1441             );
1442         } else {
1443             $template->param(
1444                 casServerUrl => login_cas_url($query, undef, $type),
1445             );
1446         }
1447
1448         $template->param(
1449             invalidCasLogin => $info{'invalidCasLogin'}
1450         );
1451     }
1452
1453     if ($shib) {
1454         #If shibOnly is enabled just go ahead and redirect directly
1455         if ( (($type eq 'opac') && C4::Context->preference('OPACShibOnly')) || (($type ne 'opac') && C4::Context->preference('staffShibOnly')) ) {
1456             my $redirect_url = login_shib_url( $query );
1457             print $query->redirect( -uri => "$redirect_url", -status => 303 );
1458             safe_exit;
1459         }
1460
1461         $template->param(
1462             shibbolethAuthentication => $shib,
1463             shibbolethLoginUrl       => login_shib_url($query),
1464         );
1465     }
1466
1467     if (C4::Context->preference('GoogleOpenIDConnect')) {
1468         if ($query->param("OpenIDConnectFailed")) {
1469             my $reason = $query->param('OpenIDConnectFailed');
1470             $template->param(invalidGoogleOpenIDConnectLogin => $reason);
1471         }
1472     }
1473
1474     $template->param(
1475         LibraryName => C4::Context->preference("LibraryName"),
1476     );
1477     $template->param(%info);
1478
1479     #    $cookie = $query->cookie(CGISESSID => $session->id
1480     #   );
1481     print $query->header(
1482         {   type              => 'text/html',
1483             charset           => 'utf-8',
1484             cookie            => $cookie,
1485             'X-Frame-Options' => 'SAMEORIGIN',
1486             -sameSite => 'Lax'
1487         }
1488       ),
1489       $template->output;
1490     safe_exit;
1491 }
1492
1493 =head2 check_api_auth
1494
1495   ($status, $cookie, $sessionId) = check_api_auth($query, $userflags);
1496
1497 Given a CGI query containing the parameters 'userid' and 'password' and/or a session
1498 cookie, determine if the user has the privileges specified by C<$userflags>.
1499
1500 C<check_api_auth> is is meant for authenticating users of web services, and
1501 consequently will always return and will not attempt to redirect the user
1502 agent.
1503
1504 If a valid session cookie is already present, check_api_auth will return a status
1505 of "ok", the cookie, and the Koha session ID.
1506
1507 If no session cookie is present, check_api_auth will check the 'userid' and 'password
1508 parameters and create a session cookie and Koha session if the supplied credentials
1509 are OK.
1510
1511 Possible return values in C<$status> are:
1512
1513 =over
1514
1515 =item "ok" -- user authenticated; C<$cookie> and C<$sessionid> have valid values.
1516
1517 =item "failed" -- credentials are not correct; C<$cookie> and C<$sessionid> are undef
1518
1519 =item "maintenance" -- DB is in maintenance mode; no login possible at the moment
1520
1521 =item "expired -- session cookie has expired; API user should resubmit userid and password
1522
1523 =item "restricted" -- The IP has changed (if SessionRestrictionByIP)
1524
1525 =item "additional-auth-needed -- User is in an authentication process that is not finished
1526
1527 =back
1528
1529 =cut
1530
1531 sub check_api_auth {
1532
1533     my $query         = shift;
1534     my $flagsrequired = shift;
1535     my $timeout = _timeout_syspref();
1536
1537     unless ( C4::Context->preference('Version') ) {
1538
1539         # database has not been installed yet
1540         return ( "maintenance", undef, undef );
1541     }
1542     my $kohaversion = Koha::version();
1543     $kohaversion =~ s/(.*\..*)\.(.*)\.(.*)/$1$2$3/;
1544     if ( C4::Context->preference('Version') < $kohaversion ) {
1545
1546         # database in need of version update; assume that
1547         # no API should be called while databsae is in
1548         # this condition.
1549         return ( "maintenance", undef, undef );
1550     }
1551
1552     my ( $sessionID, $session );
1553     unless ( $query->param('userid') ) {
1554         $sessionID = $query->cookie("CGISESSID");
1555     }
1556     if ( $sessionID && not( $cas && $query->param('PT') ) ) {
1557
1558         my $return;
1559         ( $return, $session, undef ) = check_cookie_auth(
1560             $sessionID, $flagsrequired, { remote_addr => $ENV{REMOTE_ADDR} } );
1561
1562         return ( $return, undef, undef ) # Cookie auth failed
1563             if $return ne "ok";
1564
1565         my $cookie = $query->cookie(
1566             -name     => 'CGISESSID',
1567             -value    => $session->id,
1568             -HttpOnly => 1,
1569             -secure => ( C4::Context->https_enabled() ? 1 : 0 ),
1570             -sameSite => 'Lax'
1571         );
1572         return ( $return, $cookie, $session ); # return == 'ok' here
1573
1574     } else {
1575
1576         # new login
1577         my $userid   = $query->param('userid');
1578         my $password = $query->param('password');
1579         my ( $return, $cardnumber, $cas_ticket );
1580
1581         # Proxy CAS auth
1582         if ( $cas && $query->param('PT') ) {
1583             my $retuserid;
1584
1585             # In case of a CAS authentication, we use the ticket instead of the password
1586             my $PT = $query->param('PT');
1587             ( $return, $cardnumber, $userid, $cas_ticket ) = check_api_auth_cas( $PT, $query );    # EXTERNAL AUTH
1588         } else {
1589
1590             # User / password auth
1591             unless ( $userid and $password ) {
1592
1593                 # caller did something wrong, fail the authenticateion
1594                 return ( "failed", undef, undef );
1595             }
1596             my $newuserid;
1597             ( $return, $cardnumber, $newuserid, $cas_ticket ) = checkpw( $userid, $password, $query );
1598         }
1599
1600         if ( $return and haspermission( $userid, $flagsrequired ) ) {
1601             my $session = get_session("");
1602             return ( "failed", undef, undef ) unless $session;
1603
1604             my $sessionID = $session->id;
1605             C4::Context->_new_userenv($sessionID);
1606             my $cookie = $query->cookie(
1607                 -name     => 'CGISESSID',
1608                 -value    => $sessionID,
1609                 -HttpOnly => 1,
1610                 -secure => ( C4::Context->https_enabled() ? 1 : 0 ),
1611                 -sameSite => 'Lax'
1612             );
1613             if ( $return == 1 ) {
1614                 my (
1615                     $borrowernumber, $firstname,  $surname,
1616                     $userflags,      $branchcode, $branchname,
1617                     $emailaddress
1618                 );
1619                 my $dbh = C4::Context->dbh;
1620                 my $sth =
1621                   $dbh->prepare(
1622 "select borrowernumber, firstname, surname, flags, borrowers.branchcode, branches.branchname as branchname, email from borrowers left join branches on borrowers.branchcode=branches.branchcode where userid=?"
1623                   );
1624                 $sth->execute($userid);
1625                 (
1626                     $borrowernumber, $firstname,  $surname,
1627                     $userflags,      $branchcode, $branchname,
1628                     $emailaddress
1629                 ) = $sth->fetchrow if ( $sth->rows );
1630
1631                 unless ( $sth->rows ) {
1632                     my $sth = $dbh->prepare(
1633 "select borrowernumber, firstname, surname, flags, borrowers.branchcode, branches.branchname as branchname, email from borrowers left join branches on borrowers.branchcode=branches.branchcode where cardnumber=?"
1634                     );
1635                     $sth->execute($cardnumber);
1636                     (
1637                         $borrowernumber, $firstname,  $surname,
1638                         $userflags,      $branchcode, $branchname,
1639                         $emailaddress
1640                     ) = $sth->fetchrow if ( $sth->rows );
1641
1642                     unless ( $sth->rows ) {
1643                         $sth->execute($userid);
1644                         (
1645                             $borrowernumber, $firstname,  $surname,       $userflags,
1646                             $branchcode,     $branchname, $emailaddress
1647                         ) = $sth->fetchrow if ( $sth->rows );
1648                     }
1649                 }
1650
1651                 my $ip = $ENV{'REMOTE_ADDR'};
1652
1653                 # if they specify at login, use that
1654                 if ( $query->param('branch') ) {
1655                     $branchcode = $query->param('branch');
1656                     my $library = Koha::Libraries->find($branchcode);
1657                     $branchname = $library? $library->branchname: '';
1658                 }
1659                 my $branches = { map { $_->branchcode => $_->unblessed } Koha::Libraries->search->as_list };
1660                 foreach my $br ( keys %$branches ) {
1661
1662                     #     now we work with the treatment of ip
1663                     my $domain = $branches->{$br}->{'branchip'};
1664                     if ( $domain && $ip =~ /^$domain/ ) {
1665                         $branchcode = $branches->{$br}->{'branchcode'};
1666
1667                         # new op dev : add the branchname to the cookie
1668                         $branchname    = $branches->{$br}->{'branchname'};
1669                     }
1670                 }
1671                 $session->param( 'number',       $borrowernumber );
1672                 $session->param( 'id',           $userid );
1673                 $session->param( 'cardnumber',   $cardnumber );
1674                 $session->param( 'firstname',    $firstname );
1675                 $session->param( 'surname',      $surname );
1676                 $session->param( 'branch',       $branchcode );
1677                 $session->param( 'branchname',   $branchname );
1678                 $session->param( 'flags',        $userflags );
1679                 $session->param( 'emailaddress', $emailaddress );
1680                 $session->param( 'ip',           $session->remote_addr() );
1681                 $session->param( 'lasttime',     time() );
1682                 $session->param( 'interface',    'api'  );
1683             }
1684             $session->param( 'cas_ticket', $cas_ticket);
1685             C4::Context->set_userenv(
1686                 $session->param('number'),       $session->param('id'),
1687                 $session->param('cardnumber'),   $session->param('firstname'),
1688                 $session->param('surname'),      $session->param('branch'),
1689                 $session->param('branchname'),   $session->param('flags'),
1690                 $session->param('emailaddress'), $session->param('shibboleth'),
1691                 $session->param('desk_id'),      $session->param('desk_name'),
1692                 $session->param('register_id'),  $session->param('register_name')
1693             );
1694             return ( "ok", $cookie, $sessionID );
1695         } else {
1696             return ( "failed", undef, undef );
1697         }
1698     }
1699 }
1700
1701 =head2 check_cookie_auth
1702
1703   ($status, $sessionId) = check_cookie_auth($cookie, $userflags);
1704
1705 Given a CGISESSID cookie set during a previous login to Koha, determine
1706 if the user has the privileges specified by C<$userflags>. C<$userflags>
1707 is passed unaltered into C<haspermission> and as such accepts all options
1708 avaiable to that routine with the one caveat that C<check_api_auth> will
1709 also allow 'undef' to be passed and in such a case the permissions check
1710 will be skipped altogether.
1711
1712 C<check_cookie_auth> is meant for authenticating special services
1713 such as tools/upload-file.pl that are invoked by other pages that
1714 have been authenticated in the usual way.
1715
1716 Possible return values in C<$status> are:
1717
1718 =over
1719
1720 =item "ok" -- user authenticated; C<$sessionID> have valid values.
1721
1722 =item "anon" -- user not authenticated but valid for anonymous session.
1723
1724 =item "failed" -- credentials are not correct; C<$sessionid> are undef
1725
1726 =item "maintenance" -- DB is in maintenance mode; no login possible at the moment
1727
1728 =item "expired -- session cookie has expired; API user should resubmit userid and password
1729
1730 =item "restricted" -- The IP has changed (if SessionRestrictionByIP)
1731
1732 =back
1733
1734 =cut
1735
1736 sub check_cookie_auth {
1737     my $sessionID     = shift;
1738     my $flagsrequired = shift;
1739     my $params        = shift;
1740
1741     my $remote_addr = $params->{remote_addr} || $ENV{REMOTE_ADDR};
1742
1743     my $skip_version_check = $params->{skip_version_check}; # Only for checkauth
1744
1745     unless ( $skip_version_check ) {
1746         unless ( C4::Context->preference('Version') ) {
1747
1748             # database has not been installed yet
1749             return ( "maintenance", undef );
1750         }
1751         my $kohaversion = Koha::version();
1752         $kohaversion =~ s/(.*\..*)\.(.*)\.(.*)/$1$2$3/;
1753         if ( C4::Context->preference('Version') < $kohaversion ) {
1754
1755             # database in need of version update; assume that
1756             # no API should be called while databsae is in
1757             # this condition.
1758             return ( "maintenance", undef );
1759         }
1760     }
1761
1762     # see if we have a valid session cookie already
1763     # however, if a userid parameter is present (i.e., from
1764     # a form submission, assume that any current cookie
1765     # is to be ignored
1766     unless ( $sessionID ) {
1767         return ( "failed", undef );
1768     }
1769     C4::Context::_unset_userenv($sessionID); # remove old userenv first
1770     my $session   = get_session($sessionID);
1771     if ($session) {
1772         my $userid   = $session->param('id');
1773         my $ip       = $session->param('ip');
1774         my $lasttime = $session->param('lasttime');
1775         my $timeout = _timeout_syspref();
1776
1777         if ( !$lasttime || ( $lasttime < time() - $timeout ) ) {
1778             # time out
1779             $session->delete();
1780             $session->flush;
1781             return ("expired", undef);
1782
1783         } elsif ( C4::Context->preference('SessionRestrictionByIP') && $ip ne $remote_addr ) {
1784             # IP address changed
1785             $session->delete();
1786             $session->flush;
1787             return ( "restricted", undef, { old_ip => $ip, new_ip => $remote_addr});
1788
1789         } elsif ( $userid ) {
1790             $session->param( 'lasttime', time() );
1791             my $patron = Koha::Patrons->find({ userid => $userid });
1792
1793             # If the user modify their own userid
1794             # Better than 500 but we could do better
1795             unless ( $patron ) {
1796                 $session->delete();
1797                 $session->flush;
1798                 return ("expired", undef);
1799             }
1800
1801             $patron = Koha::Patrons->find({ cardnumber => $userid })
1802               unless $patron;
1803             return ("password_expired", undef ) if $patron->password_expired;
1804             my $flags = defined($flagsrequired) ? haspermission( $userid, $flagsrequired ) : 1;
1805             if ($flags) {
1806                 C4::Context->_new_userenv($sessionID);
1807                 if ( !C4::Context->interface ) {
1808                     # No need to override the interface, most often set by get_template_and_user
1809                     C4::Context->interface( $session->param('interface') );
1810                 }
1811                 C4::Context->set_userenv(
1812                     $session->param('number'),       $session->param('id') // '',
1813                     $session->param('cardnumber'),   $session->param('firstname'),
1814                     $session->param('surname'),      $session->param('branch'),
1815                     $session->param('branchname'),   $session->param('flags'),
1816                     $session->param('emailaddress'), $session->param('shibboleth'),
1817                     $session->param('desk_id'),      $session->param('desk_name'),
1818                     $session->param('register_id'),  $session->param('register_name')
1819                 );
1820                 if ( C4::Context->preference('TwoFactorAuthentication') ne 'disabled' ) {
1821                     return ( "additional-auth-needed", $session )
1822                         if $session->param('waiting-for-2FA');
1823
1824                     return ( "setup-additional-auth-needed", $session )
1825                         if $session->param('waiting-for-2FA-setup');
1826                 }
1827
1828                 return ( "ok", $session );
1829             } else {
1830                 $session->delete();
1831                 $session->flush;
1832                 return ( "failed", undef );
1833             }
1834
1835         } else {
1836             C4::Context->_new_userenv($sessionID);
1837             C4::Context->interface($session->param('interface'));
1838             C4::Context->set_userenv( undef, q{} );
1839             return ( "anon", $session );
1840         }
1841     } else {
1842         return ( "expired", undef );
1843     }
1844 }
1845
1846 =head2 get_session
1847
1848   use CGI::Session;
1849   my $session = get_session($sessionID);
1850
1851 Given a session ID, retrieve the CGI::Session object used to store
1852 the session's state.  The session object can be used to store
1853 data that needs to be accessed by different scripts during a
1854 user's session.
1855
1856 If the C<$sessionID> parameter is an empty string, a new session
1857 will be created.
1858
1859 =cut
1860
1861 sub _get_session_params {
1862     my $storage_method = C4::Context->preference('SessionStorage');
1863     if ( $storage_method eq 'mysql' ) {
1864         my $dbh = C4::Context->dbh;
1865         return { dsn => "serializer:yamlxs;driver:MySQL;id:md5", dsn_args => { Handle => $dbh } };
1866     }
1867     elsif ( $storage_method eq 'Pg' ) {
1868         my $dbh = C4::Context->dbh;
1869         return { dsn => "serializer:yamlxs;driver:PostgreSQL;id:md5", dsn_args => { Handle => $dbh } };
1870     }
1871     elsif ( $storage_method eq 'memcached' && Koha::Caches->get_instance->memcached_cache ) {
1872         my $memcached = Koha::Caches->get_instance()->memcached_cache;
1873         return { dsn => "serializer:yamlxs;driver:memcached;id:md5", dsn_args => { Memcached => $memcached } };
1874     }
1875     else {
1876         # catch all defaults to tmp should work on all systems
1877         my $dir = C4::Context::temporary_directory;
1878         my $instance = C4::Context->config( 'database' ); #actually for packages not exactly the instance name, but generally safer to leave it as it is
1879         return { dsn => "serializer:yamlxs;driver:File;id:md5", dsn_args => { Directory => "$dir/cgisess_$instance" } };
1880     }
1881 }
1882
1883 sub get_session {
1884     my $sessionID      = shift;
1885     my $params = _get_session_params();
1886     my $session;
1887     if( $sessionID ) { # find existing
1888         CGI::Session::ErrorHandler->set_error( q{} ); # clear error, cpan issue #111463
1889         $session = CGI::Session->load( $params->{dsn}, $sessionID, $params->{dsn_args} );
1890     } else {
1891         $session = CGI::Session->new( $params->{dsn}, $sessionID, $params->{dsn_args} );
1892         # no need to flush here
1893     }
1894     return $session;
1895 }
1896
1897 =head2 create_basic_session
1898
1899 my $session = create_basic_session({ patron => $patron, interface => $interface });
1900
1901 Creates a session and adds all basic parameters for a session to work
1902
1903 =cut
1904
1905 sub create_basic_session {
1906     my $params    = shift;
1907     my $patron    = $params->{patron};
1908     my $interface = $params->{interface};
1909
1910     $interface = 'intranet' if $interface eq 'staff';
1911
1912     my $session = get_session("");
1913
1914     $session->param( 'number',       $patron->borrowernumber );
1915     $session->param( 'id',           $patron->userid );
1916     $session->param( 'cardnumber',   $patron->cardnumber );
1917     $session->param( 'firstname',    $patron->firstname );
1918     $session->param( 'surname',      $patron->surname );
1919     $session->param( 'branch',       $patron->branchcode );
1920     $session->param( 'branchname',   $patron->library->branchname );
1921     $session->param( 'flags',        $patron->flags );
1922     $session->param( 'emailaddress', $patron->email );
1923     $session->param( 'ip',           $session->remote_addr() );
1924     $session->param( 'lasttime',     time() );
1925     $session->param( 'interface',    $interface);
1926
1927     return $session;
1928 }
1929
1930
1931 # FIXME no_set_userenv may be replaced with force_branchcode_for_userenv
1932 # (or something similar)
1933 # Currently it's only passed from C4::SIP::ILS::Patron::check_password, but
1934 # not having a userenv defined could cause a crash.
1935 sub checkpw {
1936     my ( $userid, $password, $query, $type, $no_set_userenv ) = @_;
1937     $type = 'opac' unless $type;
1938
1939     # Get shibboleth login attribute
1940     my $shib = C4::Context->config('useshibboleth') && shib_ok();
1941     my $shib_login = $shib ? get_login_shib() : undef;
1942
1943     my @return;
1944     my $patron;
1945     if ( defined $userid ){
1946         $patron = Koha::Patrons->find({ userid => $userid });
1947         $patron = Koha::Patrons->find({ cardnumber => $userid }) unless $patron;
1948     }
1949     my $check_internal_as_fallback = 0;
1950     my $passwd_ok = 0;
1951     # Note: checkpw_* routines returns:
1952     # 1 if auth is ok
1953     # 0 if auth is nok
1954     # -1 if user bind failed (LDAP only)
1955
1956     if ( $patron and ( $patron->account_locked )  ) {
1957         # Nothing to check, account is locked
1958     } elsif ($ldap && defined($password)) {
1959         my ( $retval, $retcard, $retuserid ) = checkpw_ldap(@_);    # EXTERNAL AUTH
1960         if ( $retval == 1 ) {
1961             @return = ( $retval, $retcard, $retuserid );
1962             $passwd_ok = 1;
1963         }
1964         $check_internal_as_fallback = 1 if $retval == 0;
1965
1966     } elsif ( $cas && $query && $query->param('ticket') ) {
1967
1968         # In case of a CAS authentication, we use the ticket instead of the password
1969         my $ticket = $query->param('ticket');
1970         $query->delete('ticket');                                   # remove ticket to come back to original URL
1971         my ( $retval, $retcard, $retuserid, $cas_ticket ) = checkpw_cas( $ticket, $query, $type );    # EXTERNAL AUTH
1972         if ( $retval ) {
1973             @return = ( $retval, $retcard, $retuserid, $cas_ticket );
1974         } else {
1975             @return = (0);
1976         }
1977         $passwd_ok = $retval;
1978     }
1979
1980     # If we are in a shibboleth session (shibboleth is enabled, and a shibboleth match attribute is present)
1981     # Check for password to asertain whether we want to be testing against shibboleth or another method this
1982     # time around.
1983     elsif ( $shib && $shib_login && !$password ) {
1984
1985         # In case of a Shibboleth authentication, we expect a shibboleth user attribute
1986         # (defined under shibboleth mapping in koha-conf.xml) to contain the login of the
1987         # shibboleth-authenticated user
1988
1989         # Then, we check if it matches a valid koha user
1990         if ($shib_login) {
1991             my ( $retval, $retcard, $retuserid ) = C4::Auth_with_shibboleth::checkpw_shib($shib_login);    # EXTERNAL AUTH
1992             if ( $retval ) {
1993                 @return = ( $retval, $retcard, $retuserid );
1994             }
1995             $passwd_ok = $retval;
1996         }
1997     } else {
1998         $check_internal_as_fallback = 1;
1999     }
2000
2001     # INTERNAL AUTH
2002     if ( $check_internal_as_fallback ) {
2003         @return = checkpw_internal( $userid, $password, $no_set_userenv);
2004         $passwd_ok = 1 if $return[0] > 0; # 1 or 2
2005     }
2006
2007     if( $patron ) {
2008         if ( $passwd_ok ) {
2009             $patron->update({ login_attempts => 0 });
2010             if( $patron->password_expired ){
2011                 @return = (-2);
2012             }
2013         } elsif( !$patron->account_locked ) {
2014             $patron->update({ login_attempts => $patron->login_attempts + 1 });
2015         }
2016     }
2017
2018     # Optionally log success or failure
2019     if( $patron && $passwd_ok && C4::Context->preference('AuthSuccessLog') ) {
2020         logaction( 'AUTH', 'SUCCESS', $patron->id, "Valid password for $userid", $type );
2021     } elsif( !$passwd_ok && C4::Context->preference('AuthFailureLog') ) {
2022         logaction( 'AUTH', 'FAILURE', $patron ? $patron->id : 0, "Wrong password for $userid", $type );
2023     }
2024
2025     return @return;
2026 }
2027
2028 sub checkpw_internal {
2029     my ( $userid, $password, $no_set_userenv ) = @_;
2030
2031     $password = Encode::encode( 'UTF-8', $password )
2032       if Encode::is_utf8($password);
2033
2034     my $dbh = C4::Context->dbh;
2035     my $sth =
2036       $dbh->prepare(
2037         "select password,cardnumber,borrowernumber,userid,firstname,surname,borrowers.branchcode,branches.branchname,flags from borrowers join branches on borrowers.branchcode=branches.branchcode where userid=?"
2038       );
2039     $sth->execute($userid);
2040     if ( $sth->rows ) {
2041         my ( $stored_hash, $cardnumber, $borrowernumber, $userid, $firstname,
2042             $surname, $branchcode, $branchname, $flags )
2043           = $sth->fetchrow;
2044
2045         if ( checkpw_hash( $password, $stored_hash ) ) {
2046
2047             C4::Context->set_userenv( "$borrowernumber", $userid, $cardnumber,
2048                 $firstname, $surname, $branchcode, $branchname, $flags ) unless $no_set_userenv;
2049             return 1, $cardnumber, $userid;
2050         }
2051     }
2052     $sth =
2053       $dbh->prepare(
2054         "select password,cardnumber,borrowernumber,userid,firstname,surname,borrowers.branchcode,branches.branchname,flags from borrowers join branches on borrowers.branchcode=branches.branchcode where cardnumber=?"
2055       );
2056     $sth->execute($userid);
2057     if ( $sth->rows ) {
2058         my ( $stored_hash, $cardnumber, $borrowernumber, $userid, $firstname,
2059             $surname, $branchcode, $branchname, $flags )
2060           = $sth->fetchrow;
2061
2062         if ( checkpw_hash( $password, $stored_hash ) ) {
2063
2064             C4::Context->set_userenv( $borrowernumber, $userid, $cardnumber,
2065                 $firstname, $surname, $branchcode, $branchname, $flags ) unless $no_set_userenv;
2066             return 1, $cardnumber, $userid;
2067         }
2068     }
2069     return 0;
2070 }
2071
2072 sub checkpw_hash {
2073     my ( $password, $stored_hash ) = @_;
2074
2075     return if $stored_hash eq '!';
2076
2077     # check what encryption algorithm was implemented: Bcrypt - if the hash starts with '$2' it is Bcrypt else md5
2078     my $hash;
2079     if ( substr( $stored_hash, 0, 2 ) eq '$2' ) {
2080         $hash = hash_password( $password, $stored_hash );
2081     } else {
2082         $hash = md5_base64($password);
2083     }
2084     return $hash eq $stored_hash;
2085 }
2086
2087 =head2 getuserflags
2088
2089     my $authflags = getuserflags($flags, $userid, [$dbh]);
2090
2091 Translates integer flags into permissions strings hash.
2092
2093 C<$flags> is the integer userflags value ( borrowers.userflags )
2094 C<$userid> is the members.userid, used for building subpermissions
2095 C<$authflags> is a hashref of permissions
2096
2097 =cut
2098
2099 sub getuserflags {
2100     my $flags  = shift;
2101     my $userid = shift;
2102     my $dbh    = @_ ? shift : C4::Context->dbh;
2103     my $userflags;
2104     {
2105         # I don't want to do this, but if someone logs in as the database
2106         # user, it would be preferable not to spam them to death with
2107         # numeric warnings. So, we make $flags numeric.
2108         no warnings 'numeric';
2109         $flags += 0;
2110     }
2111     my $sth = $dbh->prepare("SELECT bit, flag, defaulton FROM userflags");
2112     $sth->execute;
2113
2114     while ( my ( $bit, $flag, $defaulton ) = $sth->fetchrow ) {
2115         if ( ( $flags & ( 2**$bit ) ) || $defaulton ) {
2116             $userflags->{$flag} = 1;
2117         }
2118         else {
2119             $userflags->{$flag} = 0;
2120         }
2121     }
2122
2123     # get subpermissions and merge with top-level permissions
2124     my $user_subperms = get_user_subpermissions($userid);
2125     foreach my $module ( keys %$user_subperms ) {
2126         next if $userflags->{$module} == 1;    # user already has permission for everything in this module
2127         $userflags->{$module} = $user_subperms->{$module};
2128     }
2129
2130     return $userflags;
2131 }
2132
2133 =head2 get_user_subpermissions
2134
2135   $user_perm_hashref = get_user_subpermissions($userid);
2136
2137 Given the userid (note, not the borrowernumber) of a staff user,
2138 return a hashref of hashrefs of the specific subpermissions
2139 accorded to the user.  An example return is
2140
2141  {
2142     tools => {
2143         export_catalog => 1,
2144         import_patrons => 1,
2145     }
2146  }
2147
2148 The top-level hash-key is a module or function code from
2149 userflags.flag, while the second-level key is a code
2150 from permissions.
2151
2152 The results of this function do not give a complete picture
2153 of the functions that a staff user can access; it is also
2154 necessary to check borrowers.flags.
2155
2156 =cut
2157
2158 sub get_user_subpermissions {
2159     my $userid = shift;
2160
2161     my $dbh = C4::Context->dbh;
2162     my $sth = $dbh->prepare( "SELECT flag, user_permissions.code
2163                              FROM user_permissions
2164                              JOIN permissions USING (module_bit, code)
2165                              JOIN userflags ON (module_bit = bit)
2166                              JOIN borrowers USING (borrowernumber)
2167                              WHERE userid = ?" );
2168     $sth->execute($userid);
2169
2170     my $user_perms = {};
2171     while ( my $perm = $sth->fetchrow_hashref ) {
2172         $user_perms->{ $perm->{'flag'} }->{ $perm->{'code'} } = 1;
2173     }
2174     return $user_perms;
2175 }
2176
2177 =head2 get_all_subpermissions
2178
2179   my $perm_hashref = get_all_subpermissions();
2180
2181 Returns a hashref of hashrefs defining all specific
2182 permissions currently defined.  The return value
2183 has the same structure as that of C<get_user_subpermissions>,
2184 except that the innermost hash value is the description
2185 of the subpermission.
2186
2187 =cut
2188
2189 sub get_all_subpermissions {
2190     my $dbh = C4::Context->dbh;
2191     my $sth = $dbh->prepare( "SELECT flag, code
2192                              FROM permissions
2193                              JOIN userflags ON (module_bit = bit)" );
2194     $sth->execute();
2195
2196     my $all_perms = {};
2197     while ( my $perm = $sth->fetchrow_hashref ) {
2198         $all_perms->{ $perm->{'flag'} }->{ $perm->{'code'} } = 1;
2199     }
2200     return $all_perms;
2201 }
2202
2203 =head2 get_cataloguing_page_permissions
2204
2205     my $required_permissions = get_cataloguing_page_permissions();
2206
2207 Returns the required permissions to access the main cataloguing page. Useful for building
2208 the global I<can_see_cataloguing_module> template variable, and also for reusing in
2209 I<cataloging-home.pl>.
2210
2211 =cut
2212
2213 sub get_cataloguing_page_permissions {
2214
2215     my @cataloguing_tools_subperms = qw(
2216         inventory
2217         items_batchdel
2218         items_batchmod
2219         items_batchmod
2220         label_creator
2221         manage_staged_marc
2222         marc_modification_templates
2223         records_batchdel
2224         records_batchmod
2225         stage_marc_import
2226         upload_cover_images
2227     );
2228
2229     return [
2230         { editcatalogue => '*' }, { tools => \@cataloguing_tools_subperms },
2231         C4::Context->preference('StockRotation') ? { stockrotation => 'manage_rotas' } : ()
2232     ];
2233 }
2234
2235 =head2 haspermission
2236
2237   $flagsrequired = '*';                                 # Any permission at all
2238   $flagsrequired = 'a_flag';                            # a_flag must be satisfied (all subpermissions)
2239   $flagsrequired = [ 'a_flag', 'b_flag' ];              # a_flag OR b_flag must be satisfied
2240   $flagsrequired = { 'a_flag => 1, 'b_flag' => 1 };     # a_flag AND b_flag must be satisfied
2241   $flagsrequired = { 'a_flag' => 'sub_a' };             # sub_a of a_flag must be satisfied
2242   $flagsrequired = { 'a_flag' => [ 'sub_a, 'sub_b' ] }; # sub_a OR sub_b of a_flag must be satisfied
2243
2244   $flags = ($userid, $flagsrequired);
2245
2246 C<$userid> the userid of the member
2247 C<$flags> is a query structure similar to that used by SQL::Abstract that
2248 denotes the combination of flags required. It is a required parameter.
2249
2250 The main logic of this method is that things in arrays are OR'ed, and things
2251 in hashes are AND'ed. The `*` character can be used, at any depth, to denote `ANY`
2252
2253 Returns member's flags or 0 if a permission is not met.
2254
2255 =cut
2256
2257 sub _dispatch {
2258     my ($required, $flags) = @_;
2259
2260     my $ref = ref($required);
2261     if ($ref eq '') {
2262         if ($required eq '*') {
2263             return 0 unless ( $flags or ref( $flags ) );
2264         } else {
2265             return 0 unless ( $flags and (!ref( $flags ) || $flags->{$required} ));
2266         }
2267     } elsif ($ref eq 'HASH') {
2268         foreach my $key (keys %{$required}) {
2269             next if $flags == 1;
2270             my $require = $required->{$key};
2271             my $rflags  = $flags->{$key};
2272             return 0 unless _dispatch($require, $rflags);
2273         }
2274     } elsif ($ref eq 'ARRAY') {
2275         my $satisfied = 0;
2276         foreach my $require ( @{$required} ) {
2277             my $rflags =
2278               ( ref($flags) && !ref($require) && ( $require ne '*' ) )
2279               ? $flags->{$require}
2280               : $flags;
2281             $satisfied++ if _dispatch( $require, $rflags );
2282         }
2283         return 0 unless $satisfied;
2284     } else {
2285         croak "Unexpected structure found: $ref";
2286     }
2287
2288     return $flags;
2289 };
2290
2291 sub haspermission {
2292     my ( $userid, $flagsrequired ) = @_;
2293
2294     #Koha::Exceptions::WrongParameter->throw('$flagsrequired should not be undef')
2295     #  unless defined($flagsrequired);
2296
2297     my $sth = C4::Context->dbh->prepare("SELECT flags FROM borrowers WHERE userid=?");
2298     $sth->execute($userid);
2299     my $row = $sth->fetchrow();
2300     my $flags = getuserflags( $row, $userid );
2301
2302     return $flags unless defined($flagsrequired);
2303     return $flags if $flags->{superlibrarian};
2304     return _dispatch($flagsrequired, $flags);
2305
2306     #FIXME - This fcn should return the failed permission so a suitable error msg can be delivered.
2307 }
2308
2309 =head2 in_iprange
2310
2311   $flags = ($iprange);
2312
2313 C<$iprange> A space separated string describing an IP range. Can include single IPs or ranges
2314
2315 Returns 1 if the remote address is in the provided iprange, or 0 otherwise.
2316
2317 =cut
2318
2319 sub in_iprange {
2320     my ($iprange) = @_;
2321     my $result = 1;
2322     my @allowedipranges = $iprange ? split(' ', $iprange) : ();
2323     if (scalar @allowedipranges > 0) {
2324         my @rangelist;
2325         eval { @rangelist = Net::CIDR::range2cidr(@allowedipranges); }; return 0 if $@;
2326         eval { $result = Net::CIDR::cidrlookup($ENV{'REMOTE_ADDR'}, @rangelist) } || Koha::Logger->get->warn('cidrlookup failed for ' . join(' ',@rangelist) );
2327      }
2328      return $result ? 1 : 0;
2329 }
2330
2331 sub getborrowernumber {
2332     my ($userid) = @_;
2333     my $userenv = C4::Context->userenv;
2334     if ( defined($userenv) && ref($userenv) eq 'HASH' && $userenv->{number} ) {
2335         return $userenv->{number};
2336     }
2337     my $dbh = C4::Context->dbh;
2338     for my $field ( 'userid', 'cardnumber' ) {
2339         my $sth =
2340           $dbh->prepare("select borrowernumber from borrowers where $field=?");
2341         $sth->execute($userid);
2342         if ( $sth->rows ) {
2343             my ($bnumber) = $sth->fetchrow;
2344             return $bnumber;
2345         }
2346     }
2347     return 0;
2348 }
2349
2350 =head2 track_login_daily
2351
2352     track_login_daily( $userid );
2353
2354 Wraps the call to $patron->track_login, the method used to update borrowers.lastseen. We only call track_login once a day.
2355
2356 =cut
2357
2358 sub track_login_daily {
2359     my $userid = shift;
2360     return if !$userid || !C4::Context->preference('TrackLastPatronActivity');
2361
2362     my $cache     = Koha::Caches->get_instance();
2363     my $cache_key = "track_login_" . $userid;
2364     my $cached    = $cache->get_from_cache($cache_key);
2365     my $today = dt_from_string()->ymd;
2366     return if $cached && $cached eq $today;
2367
2368     my $patron = Koha::Patrons->find({ userid => $userid });
2369     return unless $patron;
2370     $patron->track_login;
2371     $cache->set_in_cache( $cache_key, $today );
2372 }
2373
2374 END { }    # module clean-up code here (global destructor)
2375 1;
2376 __END__
2377
2378 =head1 SEE ALSO
2379
2380 CGI(3)
2381
2382 C4::Output(3)
2383
2384 Crypt::Eksblowfish::Bcrypt(3)
2385
2386 Digest::MD5(3)
2387
2388 =cut