C4/Auth.pm

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