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