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->{'shibboleth'};
 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         #we initiate a session prior to checking for a username to allow for anonymous sessions...
 963         $session ||= get_session("") or die "Auth ERROR: Cannot get_session()";
 964
 965         # Save anonymous search history in new session so it can be retrieved
 966         # by get_template_and_user to store it in user's search history after
 967         # a successful login.
 968         if ($anon_search_history) {
 969             $session->param( 'search_history', $anon_search_history );
 970         }
 971
 972         $sessionID = $session->id;
 973         C4::Context->_new_userenv($sessionID);
 974         $cookie = $cookie_mgr->replace_in_list( $cookie, $query->cookie(
 975             -name     => 'CGISESSID',
 976             -value    => $sessionID,
 977             -HttpOnly => 1,
 978             -secure => ( C4::Context->https_enabled() ? 1 : 0 ),
 979         ));
 980         my $pki_field = C4::Context->preference('AllowPKIAuth');
 981         if ( !defined($pki_field) ) {
 982             print STDERR "ERROR: Missing system preference AllowPKIAuth.\n";
 983             $pki_field = 'None';
 984         }
 985         if ( ( $cas && $query->param('ticket') )
 986             || $q_userid
 987             || ( $shib && $shib_login )
 988             || $pki_field ne 'None'
 989             || $emailaddress )
 990         {
 991             my $password    = $query->param('password');
 992             my $shibSuccess = 0;
 993             my ( $return, $cardnumber );
 994
 995             # If shib is enabled and we have a shib login, does the login match a valid koha user
 996             if ( $shib && $shib_login ) {
 997                 my $retuserid;
 998
 999                 # Do not pass password here, else shib will not be checked in checkpw.
1000                 ( $return, $cardnumber, $retuserid ) = checkpw( $dbh, $q_userid, undef, $query );
1001                 $userid      = $retuserid;
1002                 $shibSuccess = $return;
1003                 $info{'invalidShibLogin'} = 1 unless ($return);
1004             }
1005
1006             # If shib login and match were successful, skip further login methods
1007             unless ($shibSuccess) {
1008                 if ( $cas && $query->param('ticket') ) {
1009                     my $retuserid;
1010                     ( $return, $cardnumber, $retuserid, $cas_ticket ) =
1011                       checkpw( $dbh, $userid, $password, $query, $type );
1012                     $userid = $retuserid;
1013                     $info{'invalidCasLogin'} = 1 unless ($return);
1014                 }
1015
1016                 elsif ( $emailaddress ) {
1017                     my $value = $emailaddress;
1018
1019                     # If we're looking up the email, there's a chance that the person
1020                     # doesn't have a userid. So if there is none, we pass along the
1021                     # borrower number, and the bits of code that need to know the user
1022                     # ID will have to be smart enough to handle that.
1023                     my $patrons = Koha::Patrons->search({ email => $value });
1024                     if ($patrons->count) {
1025
1026                         # First the userid, then the borrowernum
1027                         my $patron = $patrons->next;
1028                         $value = $patron->userid || $patron->borrowernumber;
1029                     } else {
1030                         undef $value;
1031                     }
1032                     $return = $value ? 1 : 0;
1033                     $userid = $value;
1034                 }
1035
1036                 elsif (
1037                     ( $pki_field eq 'Common Name' && $ENV{'SSL_CLIENT_S_DN_CN'} )
1038                     || ( $pki_field eq 'emailAddress'
1039                         && $ENV{'SSL_CLIENT_S_DN_Email'} )
1040                   )
1041                 {
1042                     my $value;
1043                     if ( $pki_field eq 'Common Name' ) {
1044                         $value = $ENV{'SSL_CLIENT_S_DN_CN'};
1045                     }
1046                     elsif ( $pki_field eq 'emailAddress' ) {
1047                         $value = $ENV{'SSL_CLIENT_S_DN_Email'};
1048
1049                         # If we're looking up the email, there's a chance that the person
1050                         # doesn't have a userid. So if there is none, we pass along the
1051                         # borrower number, and the bits of code that need to know the user
1052                         # ID will have to be smart enough to handle that.
1053                         my $patrons = Koha::Patrons->search({ email => $value });
1054                         if ($patrons->count) {
1055
1056                             # First the userid, then the borrowernum
1057                             my $patron = $patrons->next;
1058                             $value = $patron->userid || $patron->borrowernumber;
1059                         } else {
1060                             undef $value;
1061                         }
1062                     }
1063
1064                     $return = $value ? 1 : 0;
1065                     $userid = $value;
1066
1067                 }
1068                 else {
1069                     my $retuserid;
1070                     my $request_method = $query->request_method();
1071
1072                     if (
1073                         $request_method eq 'POST'
1074                         || ( C4::Context->preference('AutoSelfCheckID')
1075                             && $q_userid eq C4::Context->preference('AutoSelfCheckID') )
1076                       )
1077                     {
1078
1079                         ( $return, $cardnumber, $retuserid, $cas_ticket ) =
1080                           checkpw( $dbh, $q_userid, $password, $query, $type );
1081                         $userid = $retuserid if ($retuserid);
1082                         $info{'invalid_username_or_password'} = 1 unless ($return);
1083                     }
1084                 }
1085             }
1086
1087             # If shib configured and shibOnly enabled, we should ignore anything other than a shibboleth type login.
1088             if (
1089                    $shib
1090                 && !$shibSuccess
1091                 && (
1092                     (
1093                         ( $type eq 'opac' )
1094                         && C4::Context->preference('OPACShibOnly')
1095                     )
1096                     || ( ( $type ne 'opac' )
1097                         && C4::Context->preference('staffShibOnly') )
1098                 )
1099               )
1100             {
1101                 $return = 0;
1102             }
1103
1104             # $return: 1 = valid user
1105             if ($return) {
1106
1107                 if ( $flags = haspermission( $userid, $flagsrequired ) ) {
1108                     $loggedin = 1;
1109                 }
1110                 else {
1111                     $info{'nopermission'} = 1;
1112                     C4::Context::_unset_userenv($sessionID);
1113                     $sessionID = undef;
1114                     $userid    = undef;
1115                 }
1116                 my ( $borrowernumber, $firstname, $surname, $userflags,
1117                     $branchcode, $branchname, $emailaddress, $desk_id,
1118                     $desk_name, $register_id, $register_name );
1119
1120                 if ( $return == 1 ) {
1121                     my $select = "
1122                     SELECT borrowernumber, firstname, surname, flags, borrowers.branchcode,
1123                     branches.branchname    as branchname, email
1124                     FROM borrowers
1125                     LEFT JOIN branches on borrowers.branchcode=branches.branchcode
1126                     ";
1127                     my $sth = $dbh->prepare("$select where userid=?");
1128                     $sth->execute($userid);
1129                     unless ( $sth->rows ) {
1130                         $sth = $dbh->prepare("$select where cardnumber=?");
1131                         $sth->execute($cardnumber);
1132
1133                         unless ( $sth->rows ) {
1134                             $sth->execute($userid);
1135                         }
1136                     }
1137                     if ( $sth->rows ) {
1138                         ( $borrowernumber, $firstname, $surname, $userflags,
1139                             $branchcode, $branchname, $emailaddress ) = $sth->fetchrow;
1140                     }
1141
1142                     # launch a sequence to check if we have a ip for the branch, i
1143                     # if we have one we replace the branchcode of the userenv by the branch bound in the ip.
1144
1145                     my $ip = $ENV{'REMOTE_ADDR'};
1146
1147                     # if they specify at login, use that
1148                     if ( $query->param('branch') ) {
1149                         $branchcode = $query->param('branch');
1150                         my $library = Koha::Libraries->find($branchcode);
1151                         $branchname = $library? $library->branchname: '';
1152                     }
1153                     if ( $query->param('desk_id') ) {
1154                         $desk_id = $query->param('desk_id');
1155                         my $desk = Koha::Desks->find($desk_id);
1156                         $desk_name = $desk ? $desk->desk_name : '';
1157                     }
1158                     if ( C4::Context->preference('UseCashRegisters') ) {
1159                         my $register =
1160                           $query->param('register_id')
1161                           ? Koha::Cash::Registers->find($query->param('register_id'))
1162                           : Koha::Cash::Registers->search(
1163                             { branch => $branchcode, branch_default => 1 },
1164                             { rows   => 1 } )->single;
1165                         $register_id   = $register->id   if ($register);
1166                         $register_name = $register->name if ($register);
1167                     }
1168                     my $branches = { map { $_->branchcode => $_->unblessed } Koha::Libraries->search };
1169                     if ( $type ne 'opac' and C4::Context->preference('AutoLocation') ) {
1170
1171                         # we have to check they are coming from the right ip range
1172                         my $domain = $branches->{$branchcode}->{'branchip'};
1173                         $domain =~ s|\.\*||g;
1174                         if ( $ip !~ /^$domain/ ) {
1175                             $loggedin = 0;
1176                             $cookie = $cookie_mgr->replace_in_list( $cookie, $query->cookie(
1177                                 -name     => 'CGISESSID',
1178                                 -value    => '',
1179                                 -HttpOnly => 1,
1180                                 -secure => ( C4::Context->https_enabled() ? 1 : 0 ),
1181                             ));
1182                             $info{'wrongip'} = 1;
1183                         }
1184                     }
1185
1186                     foreach my $br ( keys %$branches ) {
1187
1188                         #     now we work with the treatment of ip
1189                         my $domain = $branches->{$br}->{'branchip'};
1190                         if ( $domain && $ip =~ /^$domain/ ) {
1191                             $branchcode = $branches->{$br}->{'branchcode'};
1192
1193                             # new op dev : add the branchname to the cookie
1194                             $branchname    = $branches->{$br}->{'branchname'};
1195                         }
1196                     }
1197
1198                     my $is_sco_user = 0;
1199                     if ( $query->param('sco_user_login') && ( $query->param('sco_user_login') eq '1' ) ){
1200                         $is_sco_user = 1;
1201                     }
1202
1203                     $session->param( 'number',       $borrowernumber );
1204                     $session->param( 'id',           $userid );
1205                     $session->param( 'cardnumber',   $cardnumber );
1206                     $session->param( 'firstname',    $firstname );
1207                     $session->param( 'surname',      $surname );
1208                     $session->param( 'branch',       $branchcode );
1209                     $session->param( 'branchname',   $branchname );
1210                     $session->param( 'desk_id',      $desk_id);
1211                     $session->param( 'desk_name',     $desk_name);
1212                     $session->param( 'flags',        $userflags );
1213                     $session->param( 'emailaddress', $emailaddress );
1214                     $session->param( 'ip',           $session->remote_addr() );
1215                     $session->param( 'lasttime',     time() );
1216                     $session->param( 'interface',    $type);
1217                     $session->param( 'shibboleth',   $shibSuccess );
1218                     $session->param( 'register_id',  $register_id );
1219                     $session->param( 'register_name',  $register_name );
1220                     $session->param( 'sco_user', $is_sco_user );
1221                 }
1222                 $session->param('cas_ticket', $cas_ticket) if $cas_ticket;
1223                 C4::Context->set_userenv(
1224                     $session->param('number'),       $session->param('id'),
1225                     $session->param('cardnumber'),   $session->param('firstname'),
1226                     $session->param('surname'),      $session->param('branch'),
1227                     $session->param('branchname'),   $session->param('flags'),
1228                     $session->param('emailaddress'), $session->param('shibboleth'),
1229                     $session->param('desk_id'),      $session->param('desk_name'),
1230                     $session->param('register_id'),  $session->param('register_name')
1231                 );
1232
1233             }
1234             # $return: 0 = invalid user
1235             # reset to anonymous session
1236             else {
1237                 if ($userid) {
1238                     $info{'invalid_username_or_password'} = 1;
1239                     C4::Context::_unset_userenv($sessionID);
1240                 }
1241                 $session->param( 'lasttime', time() );
1242                 $session->param( 'ip',       $session->remote_addr() );
1243                 $session->param( 'sessiontype', 'anon' );
1244                 $session->param( 'interface', $type);
1245             }
1246         }    # END if ( $q_userid
1247         elsif ( $type eq "opac" ) {
1248
1249             # anonymous sessions are created only for the OPAC
1250
1251             # setting a couple of other session vars...
1252             $session->param( 'ip',          $session->remote_addr() );
1253             $session->param( 'lasttime',    time() );
1254             $session->param( 'sessiontype', 'anon' );
1255             $session->param( 'interface', $type);
1256         }
1257         $session->flush;
1258     }    # END unless ($userid)
1259
1260     # finished authentification, now respond
1261     if ( $loggedin || $authnotrequired )
1262     {
1263         # successful login
1264         unless (@$cookie) {
1265             $cookie = $cookie_mgr->replace_in_list( $cookie, $query->cookie(
1266                 -name     => 'CGISESSID',
1267                 -value    => '',
1268                 -HttpOnly => 1,
1269                 -secure => ( C4::Context->https_enabled() ? 1 : 0 ),
1270             ));
1271         }
1272
1273         track_login_daily( $userid );
1274
1275         # In case, that this request was a login attempt, we want to prevent that users can repost the opac login
1276         # request. We therefore redirect the user to the requested page again without the login parameters.
1277         # See Post/Redirect/Get (PRG) design pattern: https://en.wikipedia.org/wiki/Post/Redirect/Get
1278         if ( $type eq "opac" && $query->param('koha_login_context') && $query->param('koha_login_context') ne 'sco' && $query->param('password') && $query->param('userid') ) {
1279             my $uri = URI->new($query->url(-relative=>1, -query_string=>1));
1280             $uri->query_param_delete('userid');
1281             $uri->query_param_delete('password');
1282             $uri->query_param_delete('koha_login_context');
1283             print $query->redirect(-uri => $uri->as_string, -cookie => $cookie, -status=>'303 See other');
1284             safe_exit;
1285         }
1286
1287         return ( $userid, $cookie, $sessionID, $flags );
1288     }
1289
1290     #
1291     #
1292     # AUTH rejected, show the login/password template, after checking the DB.
1293     #
1294     #
1295
1296     # get the inputs from the incoming query
1297     my @inputs = ();
1298     foreach my $name ( param $query) {
1299         (next) if ( $name eq 'userid' || $name eq 'password' || $name eq 'ticket' );
1300         my @value = $query->multi_param($name);
1301         push @inputs, { name => $name, value => $_ } for @value;
1302     }
1303
1304     my $patron = Koha::Patrons->find({ userid => $q_userid }); # Not necessary logged in!
1305
1306     my $LibraryNameTitle = C4::Context->preference("LibraryName");
1307     $LibraryNameTitle =~ s/<(?:\/?)(?:br|p)\s*(?:\/?)>/ /sgi;
1308     $LibraryNameTitle =~ s/<(?:[^<>'"]|'(?:[^']*)'|"(?:[^"]*)")*>//sg;
1309
1310     my $auth_template_name = ( $type eq 'opac' ) ? 'opac-auth.tt' : 'auth.tt';
1311     my $template = C4::Templates::gettemplate( $auth_template_name, $type, $query );
1312     $template->param(
1313         login                                 => 1,
1314         INPUTS                                => \@inputs,
1315         script_name                           => get_script_name(),
1316         casAuthentication                     => C4::Context->preference("casAuthentication"),
1317         shibbolethAuthentication              => $shib,
1318         suggestion                            => C4::Context->preference("suggestion"),
1319         virtualshelves                        => C4::Context->preference("virtualshelves"),
1320         LibraryName                           => "" . C4::Context->preference("LibraryName"),
1321         LibraryNameTitle                      => "" . $LibraryNameTitle,
1322         opacuserlogin                         => C4::Context->preference("opacuserlogin"),
1323         OpacFavicon                           => C4::Context->preference("OpacFavicon"),
1324         opacreadinghistory                    => C4::Context->preference("opacreadinghistory"),
1325         opaclanguagesdisplay                  => C4::Context->preference("opaclanguagesdisplay"),
1326         OPACUserJS                            => C4::Context->preference("OPACUserJS"),
1327         opacbookbag                           => "" . C4::Context->preference("opacbookbag"),
1328         OpacCloud                             => C4::Context->preference("OpacCloud"),
1329         OpacTopissue                          => C4::Context->preference("OpacTopissue"),
1330         OpacAuthorities                       => C4::Context->preference("OpacAuthorities"),
1331         OpacBrowser                           => C4::Context->preference("OpacBrowser"),
1332         TagsEnabled                           => C4::Context->preference("TagsEnabled"),
1333         OPACUserCSS                           => C4::Context->preference("OPACUserCSS"),
1334         intranetcolorstylesheet               => C4::Context->preference("intranetcolorstylesheet"),
1335         intranetstylesheet                    => C4::Context->preference("intranetstylesheet"),
1336         IntranetNav                           => C4::Context->preference("IntranetNav"),
1337         IntranetFavicon                       => C4::Context->preference("IntranetFavicon"),
1338         IntranetUserCSS                       => C4::Context->preference("IntranetUserCSS"),
1339         IntranetUserJS                        => C4::Context->preference("IntranetUserJS"),
1340         IndependentBranches                   => C4::Context->preference("IndependentBranches"),
1341         AutoLocation                          => C4::Context->preference("AutoLocation"),
1342         wrongip                               => $info{'wrongip'},
1343         PatronSelfRegistration                => C4::Context->preference("PatronSelfRegistration"),
1344         PatronSelfRegistrationDefaultCategory => C4::Context->preference("PatronSelfRegistrationDefaultCategory"),
1345         opac_css_override                     => $ENV{'OPAC_CSS_OVERRIDE'},
1346         too_many_login_attempts               => ( $patron and $patron->account_locked )
1347     );
1348
1349     $template->param( SCO_login => 1 ) if ( $query->param('sco_user_login') );
1350     $template->param( SCI_login => 1 ) if ( $query->param('sci_user_login') );
1351     $template->param( OpacPublic => C4::Context->preference("OpacPublic") );
1352     $template->param( loginprompt => 1 ) unless $info{'nopermission'};
1353
1354     if ( $type eq 'opac' ) {
1355         require Koha::Virtualshelves;
1356         my $some_public_shelves = Koha::Virtualshelves->get_some_shelves(
1357             {
1358                 public => 1,
1359             }
1360         );
1361         $template->param(
1362             some_public_shelves  => $some_public_shelves,
1363         );
1364     }
1365
1366     if ($cas) {
1367
1368         # Is authentication against multiple CAS servers enabled?
1369         require C4::Auth_with_cas;
1370         if ( multipleAuth() && !$casparam ) {
1371             my $casservers = getMultipleAuth();
1372             my @tmplservers;
1373             foreach my $key ( keys %$casservers ) {
1374                 push @tmplservers, { name => $key, value => login_cas_url( $query, $key, $type ) . "?cas=$key" };
1375             }
1376             $template->param(
1377                 casServersLoop => \@tmplservers
1378             );
1379         } else {
1380             $template->param(
1381                 casServerUrl => login_cas_url($query, undef, $type),
1382             );
1383         }
1384
1385         $template->param(
1386             invalidCasLogin => $info{'invalidCasLogin'}
1387         );
1388     }
1389
1390     if ($shib) {
1391         #If shibOnly is enabled just go ahead and redirect directly
1392         if ( (($type eq 'opac') && C4::Context->preference('OPACShibOnly')) || (($type ne 'opac') && C4::Context->preference('staffShibOnly')) ) {
1393             my $redirect_url = login_shib_url( $query );
1394             print $query->redirect( -uri => "$redirect_url", -status => 303 );
1395             safe_exit;
1396         }
1397
1398         $template->param(
1399             shibbolethAuthentication => $shib,
1400             shibbolethLoginUrl       => login_shib_url($query),
1401         );
1402     }
1403
1404     if (C4::Context->preference('GoogleOpenIDConnect')) {
1405         if ($query->param("OpenIDConnectFailed")) {
1406             my $reason = $query->param('OpenIDConnectFailed');
1407             $template->param(invalidGoogleOpenIDConnectLogin => $reason);
1408         }
1409     }
1410
1411     $template->param(
1412         LibraryName => C4::Context->preference("LibraryName"),
1413     );
1414     $template->param(%info);
1415
1416     #    $cookie = $query->cookie(CGISESSID => $session->id
1417     #   );
1418     print $query->header(
1419         {   type              => 'text/html',
1420             charset           => 'utf-8',
1421             cookie            => $cookie,
1422             'X-Frame-Options' => 'SAMEORIGIN'
1423         }
1424       ),
1425       $template->output;
1426     safe_exit;
1427 }
1428
1429 =head2 check_api_auth
1430
1431   ($status, $cookie, $sessionId) = check_api_auth($query, $userflags);
1432
1433 Given a CGI query containing the parameters 'userid' and 'password' and/or a session
1434 cookie, determine if the user has the privileges specified by C<$userflags>.
1435
1436 C<check_api_auth> is is meant for authenticating users of web services, and
1437 consequently will always return and will not attempt to redirect the user
1438 agent.
1439
1440 If a valid session cookie is already present, check_api_auth will return a status
1441 of "ok", the cookie, and the Koha session ID.
1442
1443 If no session cookie is present, check_api_auth will check the 'userid' and 'password
1444 parameters and create a session cookie and Koha session if the supplied credentials
1445 are OK.
1446
1447 Possible return values in C<$status> are:
1448
1449 =over
1450
1451 =item "ok" -- user authenticated; C<$cookie> and C<$sessionid> have valid values.
1452
1453 =item "failed" -- credentials are not correct; C<$cookie> and C<$sessionid> are undef
1454
1455 =item "maintenance" -- DB is in maintenance mode; no login possible at the moment
1456
1457 =item "expired -- session cookie has expired; API user should resubmit userid and password
1458
1459 =item "restricted" -- The IP has changed (if SessionRestrictionByIP)
1460
1461 =back
1462
1463 =cut
1464
1465 sub check_api_auth {
1466
1467     my $query         = shift;
1468     my $flagsrequired = shift;
1469     my $dbh     = C4::Context->dbh;
1470     my $timeout = _timeout_syspref();
1471
1472     unless ( C4::Context->preference('Version') ) {
1473
1474         # database has not been installed yet
1475         return ( "maintenance", undef, undef );
1476     }
1477     my $kohaversion = Koha::version();
1478     $kohaversion =~ s/(.*\..*)\.(.*)\.(.*)/$1$2$3/;
1479     if ( C4::Context->preference('Version') < $kohaversion ) {
1480
1481         # database in need of version update; assume that
1482         # no API should be called while databsae is in
1483         # this condition.
1484         return ( "maintenance", undef, undef );
1485     }
1486
1487     my ( $sessionID, $session );
1488     unless ( $query->param('userid') ) {
1489         $sessionID = $query->cookie("CGISESSID");
1490     }
1491     if ( $sessionID && not( $cas && $query->param('PT') ) ) {
1492
1493         my $return;
1494         ( $return, $session, undef ) = check_cookie_auth(
1495             $sessionID, $flagsrequired, { remote_addr => $ENV{REMOTE_ADDR} } );
1496
1497         return ( $return, undef, undef ) # Cookie auth failed
1498             if $return ne "ok";
1499
1500         my $cookie = $query->cookie(
1501             -name     => 'CGISESSID',
1502             -value    => $session->id,
1503             -HttpOnly => 1,
1504             -secure => ( C4::Context->https_enabled() ? 1 : 0 ),
1505         );
1506         return ( $return, $cookie, $session ); # return == 'ok' here
1507
1508     } else {
1509
1510         # new login
1511         my $userid   = $query->param('userid');
1512         my $password = $query->param('password');
1513         my ( $return, $cardnumber, $cas_ticket );
1514
1515         # Proxy CAS auth
1516         if ( $cas && $query->param('PT') ) {
1517             my $retuserid;
1518
1519             # In case of a CAS authentication, we use the ticket instead of the password
1520             my $PT = $query->param('PT');
1521             ( $return, $cardnumber, $userid, $cas_ticket ) = check_api_auth_cas( $dbh, $PT, $query );    # EXTERNAL AUTH
1522         } else {
1523
1524             # User / password auth
1525             unless ( $userid and $password ) {
1526
1527                 # caller did something wrong, fail the authenticateion
1528                 return ( "failed", undef, undef );
1529             }
1530             my $newuserid;
1531             ( $return, $cardnumber, $newuserid, $cas_ticket ) = checkpw( $dbh, $userid, $password, $query );
1532         }
1533
1534         if ( $return and haspermission( $userid, $flagsrequired ) ) {
1535             my $session = get_session("");
1536             return ( "failed", undef, undef ) unless $session;
1537
1538             my $sessionID = $session->id;
1539             C4::Context->_new_userenv($sessionID);
1540             my $cookie = $query->cookie(
1541                 -name     => 'CGISESSID',
1542                 -value    => $sessionID,
1543                 -HttpOnly => 1,
1544                 -secure => ( C4::Context->https_enabled() ? 1 : 0 ),
1545             );
1546             if ( $return == 1 ) {
1547                 my (
1548                     $borrowernumber, $firstname,  $surname,
1549                     $userflags,      $branchcode, $branchname,
1550                     $emailaddress
1551                 );
1552                 my $sth =
1553                   $dbh->prepare(
1554 "select borrowernumber, firstname, surname, flags, borrowers.branchcode, branches.branchname as branchname, email from borrowers left join branches on borrowers.branchcode=branches.branchcode where userid=?"
1555                   );
1556                 $sth->execute($userid);
1557                 (
1558                     $borrowernumber, $firstname,  $surname,
1559                     $userflags,      $branchcode, $branchname,
1560                     $emailaddress
1561                 ) = $sth->fetchrow if ( $sth->rows );
1562
1563                 unless ( $sth->rows ) {
1564                     my $sth = $dbh->prepare(
1565 "select borrowernumber, firstname, surname, flags, borrowers.branchcode, branches.branchname as branchname, email from borrowers left join branches on borrowers.branchcode=branches.branchcode where cardnumber=?"
1566                     );
1567                     $sth->execute($cardnumber);
1568                     (
1569                         $borrowernumber, $firstname,  $surname,
1570                         $userflags,      $branchcode, $branchname,
1571                         $emailaddress
1572                     ) = $sth->fetchrow if ( $sth->rows );
1573
1574                     unless ( $sth->rows ) {
1575                         $sth->execute($userid);
1576                         (
1577                             $borrowernumber, $firstname,  $surname,       $userflags,
1578                             $branchcode,     $branchname, $emailaddress
1579                         ) = $sth->fetchrow if ( $sth->rows );
1580                     }
1581                 }
1582
1583                 my $ip = $ENV{'REMOTE_ADDR'};
1584
1585                 # if they specify at login, use that
1586                 if ( $query->param('branch') ) {
1587                     $branchcode = $query->param('branch');
1588                     my $library = Koha::Libraries->find($branchcode);
1589                     $branchname = $library? $library->branchname: '';
1590                 }
1591                 my $branches = { map { $_->branchcode => $_->unblessed } Koha::Libraries->search };
1592                 foreach my $br ( keys %$branches ) {
1593
1594                     #     now we work with the treatment of ip
1595                     my $domain = $branches->{$br}->{'branchip'};
1596                     if ( $domain && $ip =~ /^$domain/ ) {
1597                         $branchcode = $branches->{$br}->{'branchcode'};
1598
1599                         # new op dev : add the branchname to the cookie
1600                         $branchname    = $branches->{$br}->{'branchname'};
1601                     }
1602                 }
1603                 $session->param( 'number',       $borrowernumber );
1604                 $session->param( 'id',           $userid );
1605                 $session->param( 'cardnumber',   $cardnumber );
1606                 $session->param( 'firstname',    $firstname );
1607                 $session->param( 'surname',      $surname );
1608                 $session->param( 'branch',       $branchcode );
1609                 $session->param( 'branchname',   $branchname );
1610                 $session->param( 'flags',        $userflags );
1611                 $session->param( 'emailaddress', $emailaddress );
1612                 $session->param( 'ip',           $session->remote_addr() );
1613                 $session->param( 'lasttime',     time() );
1614                 $session->param( 'interface',    'api'  );
1615             }
1616             $session->param( 'cas_ticket', $cas_ticket);
1617             C4::Context->set_userenv(
1618                 $session->param('number'),       $session->param('id'),
1619                 $session->param('cardnumber'),   $session->param('firstname'),
1620                 $session->param('surname'),      $session->param('branch'),
1621                 $session->param('branchname'),   $session->param('flags'),
1622                 $session->param('emailaddress'), $session->param('shibboleth'),
1623                 $session->param('desk_id'),      $session->param('desk_name'),
1624                 $session->param('register_id'),  $session->param('register_name')
1625             );
1626             return ( "ok", $cookie, $sessionID );
1627         } else {
1628             return ( "failed", undef, undef );
1629         }
1630     }
1631 }
1632
1633 =head2 check_cookie_auth
1634
1635   ($status, $sessionId) = check_cookie_auth($cookie, $userflags);
1636
1637 Given a CGISESSID cookie set during a previous login to Koha, determine
1638 if the user has the privileges specified by C<$userflags>. C<$userflags>
1639 is passed unaltered into C<haspermission> and as such accepts all options
1640 avaiable to that routine with the one caveat that C<check_api_auth> will
1641 also allow 'undef' to be passed and in such a case the permissions check
1642 will be skipped altogether.
1643
1644 C<check_cookie_auth> is meant for authenticating special services
1645 such as tools/upload-file.pl that are invoked by other pages that
1646 have been authenticated in the usual way.
1647
1648 Possible return values in C<$status> are:
1649
1650 =over
1651
1652 =item "ok" -- user authenticated; C<$sessionID> have valid values.
1653
1654 =item "anon" -- user not authenticated but valid for anonymous session.
1655
1656 =item "failed" -- credentials are not correct; C<$sessionid> are undef
1657
1658 =item "maintenance" -- DB is in maintenance mode; no login possible at the moment
1659
1660 =item "expired -- session cookie has expired; API user should resubmit userid and password
1661
1662 =item "restricted" -- The IP has changed (if SessionRestrictionByIP)
1663
1664 =back
1665
1666 =cut
1667
1668 sub check_cookie_auth {
1669     my $sessionID     = shift;
1670     my $flagsrequired = shift;
1671     my $params        = shift;
1672
1673     my $remote_addr = $params->{remote_addr} || $ENV{REMOTE_ADDR};
1674
1675     my $skip_version_check = $params->{skip_version_check}; # Only for checkauth
1676
1677     unless ( $skip_version_check ) {
1678         unless ( C4::Context->preference('Version') ) {
1679
1680             # database has not been installed yet
1681             return ( "maintenance", undef );
1682         }
1683         my $kohaversion = Koha::version();
1684         $kohaversion =~ s/(.*\..*)\.(.*)\.(.*)/$1$2$3/;
1685         if ( C4::Context->preference('Version') < $kohaversion ) {
1686
1687             # database in need of version update; assume that
1688             # no API should be called while databsae is in
1689             # this condition.
1690             return ( "maintenance", undef );
1691         }
1692     }
1693
1694     # see if we have a valid session cookie already
1695     # however, if a userid parameter is present (i.e., from
1696     # a form submission, assume that any current cookie
1697     # is to be ignored
1698     unless ( $sessionID ) {
1699         return ( "failed", undef );
1700     }
1701     C4::Context::_unset_userenv($sessionID); # remove old userenv first
1702     my $session   = get_session($sessionID);
1703     if ($session) {
1704         my $userid   = $session->param('id');
1705         my $ip       = $session->param('ip');
1706         my $lasttime = $session->param('lasttime');
1707         my $timeout = _timeout_syspref();
1708
1709         if ( !$lasttime || ( $lasttime < time() - $timeout ) ) {
1710             # time out
1711             $session->delete();
1712             $session->flush;
1713             return ("expired", undef);
1714
1715         } elsif ( C4::Context->preference('SessionRestrictionByIP') && $ip ne $remote_addr ) {
1716             # IP address changed
1717             $session->delete();
1718             $session->flush;
1719             return ( "restricted", undef, { old_ip => $ip, new_ip => $remote_addr});
1720
1721         } elsif ( $userid ) {
1722             $session->param( 'lasttime', time() );
1723             my $flags = defined($flagsrequired) ? haspermission( $userid, $flagsrequired ) : 1;
1724             if ($flags) {
1725                 C4::Context->_new_userenv($sessionID);
1726                 C4::Context->interface($session->param('interface'));
1727                 C4::Context->set_userenv(
1728                     $session->param('number'),       $session->param('id') // '',
1729                     $session->param('cardnumber'),   $session->param('firstname'),
1730                     $session->param('surname'),      $session->param('branch'),
1731                     $session->param('branchname'),   $session->param('flags'),
1732                     $session->param('emailaddress'), $session->param('shibboleth'),
1733                     $session->param('desk_id'),      $session->param('desk_name'),
1734                     $session->param('register_id'),  $session->param('register_name')
1735                 );
1736                 return ( "ok", $session );
1737             } else {
1738                 $session->delete();
1739                 $session->flush;
1740                 return ( "failed", undef );
1741             }
1742
1743         } else {
1744             C4::Context->_new_userenv($sessionID);
1745             C4::Context->interface($session->param('interface'));
1746             C4::Context->set_userenv( undef, q{} );
1747             return ( "anon", $session );
1748         }
1749     } else {
1750         return ( "expired", undef );
1751     }
1752 }
1753
1754 =head2 get_session
1755
1756   use CGI::Session;
1757   my $session = get_session($sessionID);
1758
1759 Given a session ID, retrieve the CGI::Session object used to store
1760 the session's state.  The session object can be used to store
1761 data that needs to be accessed by different scripts during a
1762 user's session.
1763
1764 If the C<$sessionID> parameter is an empty string, a new session
1765 will be created.
1766
1767 =cut
1768
1769 sub _get_session_params {
1770     my $storage_method = C4::Context->preference('SessionStorage');
1771     if ( $storage_method eq 'mysql' ) {
1772         my $dbh = C4::Context->dbh;
1773         return { dsn => "serializer:yamlxs;driver:MySQL;id:md5", dsn_args => { Handle => $dbh } };
1774     }
1775     elsif ( $storage_method eq 'Pg' ) {
1776         my $dbh = C4::Context->dbh;
1777         return { dsn => "serializer:yamlxs;driver:PostgreSQL;id:md5", dsn_args => { Handle => $dbh } };
1778     }
1779     elsif ( $storage_method eq 'memcached' && Koha::Caches->get_instance->memcached_cache ) {
1780         my $memcached = Koha::Caches->get_instance()->memcached_cache;
1781         return { dsn => "serializer:yamlxs;driver:memcached;id:md5", dsn_args => { Memcached => $memcached } };
1782     }
1783     else {
1784         # catch all defaults to tmp should work on all systems
1785         my $dir = C4::Context::temporary_directory;
1786         my $instance = C4::Context->config( 'database' ); #actually for packages not exactly the instance name, but generally safer to leave it as it is
1787         return { dsn => "serializer:yamlxs;driver:File;id:md5", dsn_args => { Directory => "$dir/cgisess_$instance" } };
1788     }
1789 }
1790
1791 sub get_session {
1792     my $sessionID      = shift;
1793     my $params = _get_session_params();
1794     my $session;
1795     if( $sessionID ) { # find existing
1796         CGI::Session::ErrorHandler->set_error( q{} ); # clear error, cpan issue #111463
1797         $session = CGI::Session->load( $params->{dsn}, $sessionID, $params->{dsn_args} );
1798     } else {
1799         $session = CGI::Session->new( $params->{dsn}, $sessionID, $params->{dsn_args} );
1800         # $session->flush;
1801     }
1802     return $session;
1803 }
1804
1805
1806 # FIXME no_set_userenv may be replaced with force_branchcode_for_userenv
1807 # (or something similar)
1808 # Currently it's only passed from C4::SIP::ILS::Patron::check_password, but
1809 # not having a userenv defined could cause a crash.
1810 sub checkpw {
1811     my ( $dbh, $userid, $password, $query, $type, $no_set_userenv ) = @_;
1812     $type = 'opac' unless $type;
1813
1814     # Get shibboleth login attribute
1815     my $shib = C4::Context->config('useshibboleth') && shib_ok();
1816     my $shib_login = $shib ? get_login_shib() : undef;
1817
1818     my @return;
1819     my $patron;
1820     if ( defined $userid ){
1821         $patron = Koha::Patrons->find({ userid => $userid });
1822         $patron = Koha::Patrons->find({ cardnumber => $userid }) unless $patron;
1823     }
1824     my $check_internal_as_fallback = 0;
1825     my $passwd_ok = 0;
1826     # Note: checkpw_* routines returns:
1827     # 1 if auth is ok
1828     # 0 if auth is nok
1829     # -1 if user bind failed (LDAP only)
1830
1831     if ( $patron and $patron->account_locked ) {
1832         # Nothing to check, account is locked
1833     } elsif ($ldap && defined($password)) {
1834         my ( $retval, $retcard, $retuserid ) = checkpw_ldap(@_);    # EXTERNAL AUTH
1835         if ( $retval == 1 ) {
1836             @return = ( $retval, $retcard, $retuserid );
1837             $passwd_ok = 1;
1838         }
1839         $check_internal_as_fallback = 1 if $retval == 0;
1840
1841     } elsif ( $cas && $query && $query->param('ticket') ) {
1842
1843         # In case of a CAS authentication, we use the ticket instead of the password
1844         my $ticket = $query->param('ticket');
1845         $query->delete('ticket');                                   # remove ticket to come back to original URL
1846         my ( $retval, $retcard, $retuserid, $cas_ticket ) = checkpw_cas( $dbh, $ticket, $query, $type );    # EXTERNAL AUTH
1847         if ( $retval ) {
1848             @return = ( $retval, $retcard, $retuserid, $cas_ticket );
1849         } else {
1850             @return = (0);
1851         }
1852         $passwd_ok = $retval;
1853     }
1854
1855     # If we are in a shibboleth session (shibboleth is enabled, and a shibboleth match attribute is present)
1856     # Check for password to asertain whether we want to be testing against shibboleth or another method this
1857     # time around.
1858     elsif ( $shib && $shib_login && !$password ) {
1859
1860         # In case of a Shibboleth authentication, we expect a shibboleth user attribute
1861         # (defined under shibboleth mapping in koha-conf.xml) to contain the login of the
1862         # shibboleth-authenticated user
1863
1864         # Then, we check if it matches a valid koha user
1865         if ($shib_login) {
1866             my ( $retval, $retcard, $retuserid ) = C4::Auth_with_shibboleth::checkpw_shib($shib_login);    # EXTERNAL AUTH
1867             if ( $retval ) {
1868                 @return = ( $retval, $retcard, $retuserid );
1869             }
1870             $passwd_ok = $retval;
1871         }
1872     } else {
1873         $check_internal_as_fallback = 1;
1874     }
1875
1876     # INTERNAL AUTH
1877     if ( $check_internal_as_fallback ) {
1878         @return = checkpw_internal( $dbh, $userid, $password, $no_set_userenv);
1879         $passwd_ok = 1 if $return[0] > 0; # 1 or 2
1880     }
1881
1882     if( $patron ) {
1883         if ( $passwd_ok ) {
1884             $patron->update({ login_attempts => 0 });
1885         } elsif( !$patron->account_locked ) {
1886             $patron->update({ login_attempts => $patron->login_attempts + 1 });
1887         }
1888     }
1889
1890     # Optionally log success or failure
1891     if( $patron && $passwd_ok && C4::Context->preference('AuthSuccessLog') ) {
1892         logaction( 'AUTH', 'SUCCESS', $patron->id, "Valid password for $userid", $type );
1893     } elsif( !$passwd_ok && C4::Context->preference('AuthFailureLog') ) {
1894         logaction( 'AUTH', 'FAILURE', $patron ? $patron->id : 0, "Wrong password for $userid", $type );
1895     }
1896
1897     return @return;
1898 }
1899
1900 sub checkpw_internal {
1901     my ( $dbh, $userid, $password, $no_set_userenv ) = @_;
1902
1903     $password = Encode::encode( 'UTF-8', $password )
1904       if Encode::is_utf8($password);
1905
1906     my $sth =
1907       $dbh->prepare(
1908         "select password,cardnumber,borrowernumber,userid,firstname,surname,borrowers.branchcode,branches.branchname,flags from borrowers join branches on borrowers.branchcode=branches.branchcode where userid=?"
1909       );
1910     $sth->execute($userid);
1911     if ( $sth->rows ) {
1912         my ( $stored_hash, $cardnumber, $borrowernumber, $userid, $firstname,
1913             $surname, $branchcode, $branchname, $flags )
1914           = $sth->fetchrow;
1915
1916         if ( checkpw_hash( $password, $stored_hash ) ) {
1917
1918             C4::Context->set_userenv( "$borrowernumber", $userid, $cardnumber,
1919                 $firstname, $surname, $branchcode, $branchname, $flags ) unless $no_set_userenv;
1920             return 1, $cardnumber, $userid;
1921         }
1922     }
1923     $sth =
1924       $dbh->prepare(
1925         "select password,cardnumber,borrowernumber,userid,firstname,surname,borrowers.branchcode,branches.branchname,flags from borrowers join branches on borrowers.branchcode=branches.branchcode where cardnumber=?"
1926       );
1927     $sth->execute($userid);
1928     if ( $sth->rows ) {
1929         my ( $stored_hash, $cardnumber, $borrowernumber, $userid, $firstname,
1930             $surname, $branchcode, $branchname, $flags )
1931           = $sth->fetchrow;
1932
1933         if ( checkpw_hash( $password, $stored_hash ) ) {
1934
1935             C4::Context->set_userenv( $borrowernumber, $userid, $cardnumber,
1936                 $firstname, $surname, $branchcode, $branchname, $flags ) unless $no_set_userenv;
1937             return 1, $cardnumber, $userid;
1938         }
1939     }
1940     return 0;
1941 }
1942
1943 sub checkpw_hash {
1944     my ( $password, $stored_hash ) = @_;
1945
1946     return if $stored_hash eq '!';
1947
1948     # check what encryption algorithm was implemented: Bcrypt - if the hash starts with '$2' it is Bcrypt else md5
1949     my $hash;
1950     if ( substr( $stored_hash, 0, 2 ) eq '$2' ) {
1951         $hash = hash_password( $password, $stored_hash );
1952     } else {
1953         $hash = md5_base64($password);
1954     }
1955     return $hash eq $stored_hash;
1956 }
1957
1958 =head2 getuserflags
1959
1960     my $authflags = getuserflags($flags, $userid, [$dbh]);
1961
1962 Translates integer flags into permissions strings hash.
1963
1964 C<$flags> is the integer userflags value ( borrowers.userflags )
1965 C<$userid> is the members.userid, used for building subpermissions
1966 C<$authflags> is a hashref of permissions
1967
1968 =cut
1969
1970 sub getuserflags {
1971     my $flags  = shift;
1972     my $userid = shift;
1973     my $dbh    = @_ ? shift : C4::Context->dbh;
1974     my $userflags;
1975     {
1976         # I don't want to do this, but if someone logs in as the database
1977         # user, it would be preferable not to spam them to death with
1978         # numeric warnings. So, we make $flags numeric.
1979         no warnings 'numeric';
1980         $flags += 0;
1981     }
1982     my $sth = $dbh->prepare("SELECT bit, flag, defaulton FROM userflags");
1983     $sth->execute;
1984
1985     while ( my ( $bit, $flag, $defaulton ) = $sth->fetchrow ) {
1986         if ( ( $flags & ( 2**$bit ) ) || $defaulton ) {
1987             $userflags->{$flag} = 1;
1988         }
1989         else {
1990             $userflags->{$flag} = 0;
1991         }
1992     }
1993
1994     # get subpermissions and merge with top-level permissions
1995     my $user_subperms = get_user_subpermissions($userid);
1996     foreach my $module ( keys %$user_subperms ) {
1997         next if $userflags->{$module} == 1;    # user already has permission for everything in this module
1998         $userflags->{$module} = $user_subperms->{$module};
1999     }
2000
2001     return $userflags;
2002 }
2003
2004 =head2 get_user_subpermissions
2005
2006   $user_perm_hashref = get_user_subpermissions($userid);
2007
2008 Given the userid (note, not the borrowernumber) of a staff user,
2009 return a hashref of hashrefs of the specific subpermissions
2010 accorded to the user.  An example return is
2011
2012  {
2013     tools => {
2014         export_catalog => 1,
2015         import_patrons => 1,
2016     }
2017  }
2018
2019 The top-level hash-key is a module or function code from
2020 userflags.flag, while the second-level key is a code
2021 from permissions.
2022
2023 The results of this function do not give a complete picture
2024 of the functions that a staff user can access; it is also
2025 necessary to check borrowers.flags.
2026
2027 =cut
2028
2029 sub get_user_subpermissions {
2030     my $userid = shift;
2031
2032     my $dbh = C4::Context->dbh;
2033     my $sth = $dbh->prepare( "SELECT flag, user_permissions.code
2034                              FROM user_permissions
2035                              JOIN permissions USING (module_bit, code)
2036                              JOIN userflags ON (module_bit = bit)
2037                              JOIN borrowers USING (borrowernumber)
2038                              WHERE userid = ?" );
2039     $sth->execute($userid);
2040
2041     my $user_perms = {};
2042     while ( my $perm = $sth->fetchrow_hashref ) {
2043         $user_perms->{ $perm->{'flag'} }->{ $perm->{'code'} } = 1;
2044     }
2045     return $user_perms;
2046 }
2047
2048 =head2 get_all_subpermissions
2049
2050   my $perm_hashref = get_all_subpermissions();
2051
2052 Returns a hashref of hashrefs defining all specific
2053 permissions currently defined.  The return value
2054 has the same structure as that of C<get_user_subpermissions>,
2055 except that the innermost hash value is the description
2056 of the subpermission.
2057
2058 =cut
2059
2060 sub get_all_subpermissions {
2061     my $dbh = C4::Context->dbh;
2062     my $sth = $dbh->prepare( "SELECT flag, code
2063                              FROM permissions
2064                              JOIN userflags ON (module_bit = bit)" );
2065     $sth->execute();
2066
2067     my $all_perms = {};
2068     while ( my $perm = $sth->fetchrow_hashref ) {
2069         $all_perms->{ $perm->{'flag'} }->{ $perm->{'code'} } = 1;
2070     }
2071     return $all_perms;
2072 }
2073
2074 =head2 haspermission
2075
2076   $flagsrequired = '*';                                 # Any permission at all
2077   $flagsrequired = 'a_flag';                            # a_flag must be satisfied (all subpermissions)
2078   $flagsrequired = [ 'a_flag', 'b_flag' ];              # a_flag OR b_flag must be satisfied
2079   $flagsrequired = { 'a_flag => 1, 'b_flag' => 1 };     # a_flag AND b_flag must be satisfied
2080   $flagsrequired = { 'a_flag' => 'sub_a' };             # sub_a of a_flag must be satisfied
2081   $flagsrequired = { 'a_flag' => [ 'sub_a, 'sub_b' ] }; # sub_a OR sub_b of a_flag must be satisfied
2082
2083   $flags = ($userid, $flagsrequired);
2084
2085 C<$userid> the userid of the member
2086 C<$flags> is a query structure similar to that used by SQL::Abstract that
2087 denotes the combination of flags required. It is a required parameter.
2088
2089 The main logic of this method is that things in arrays are OR'ed, and things
2090 in hashes are AND'ed. The `*` character can be used, at any depth, to denote `ANY`
2091
2092 Returns member's flags or 0 if a permission is not met.
2093
2094 =cut
2095
2096 sub _dispatch {
2097     my ($required, $flags) = @_;
2098
2099     my $ref = ref($required);
2100     if ($ref eq '') {
2101         if ($required eq '*') {
2102             return 0 unless ( $flags or ref( $flags ) );
2103         } else {
2104             return 0 unless ( $flags and (!ref( $flags ) || $flags->{$required} ));
2105         }
2106     } elsif ($ref eq 'HASH') {
2107         foreach my $key (keys %{$required}) {
2108             next if $flags == 1;
2109             my $require = $required->{$key};
2110             my $rflags  = $flags->{$key};
2111             return 0 unless _dispatch($require, $rflags);
2112         }
2113     } elsif ($ref eq 'ARRAY') {
2114         my $satisfied = 0;
2115         foreach my $require ( @{$required} ) {
2116             my $rflags =
2117               ( ref($flags) && !ref($require) && ( $require ne '*' ) )
2118               ? $flags->{$require}
2119               : $flags;
2120             $satisfied++ if _dispatch( $require, $rflags );
2121         }
2122         return 0 unless $satisfied;
2123     } else {
2124         croak "Unexpected structure found: $ref";
2125     }
2126
2127     return $flags;
2128 };
2129
2130 sub haspermission {
2131     my ( $userid, $flagsrequired ) = @_;
2132
2133     #Koha::Exceptions::WrongParameter->throw('$flagsrequired should not be undef')
2134     #  unless defined($flagsrequired);
2135
2136     my $sth = C4::Context->dbh->prepare("SELECT flags FROM borrowers WHERE userid=?");
2137     $sth->execute($userid);
2138     my $row = $sth->fetchrow();
2139     my $flags = getuserflags( $row, $userid );
2140
2141     return $flags unless defined($flagsrequired);
2142     return $flags if $flags->{superlibrarian};
2143     return _dispatch($flagsrequired, $flags);
2144
2145     #FIXME - This fcn should return the failed permission so a suitable error msg can be delivered.
2146 }
2147
2148 =head2 in_iprange
2149
2150   $flags = ($iprange);
2151
2152 C<$iprange> A space separated string describing an IP range. Can include single IPs or ranges
2153
2154 Returns 1 if the remote address is in the provided iprange, or 0 otherwise.
2155
2156 =cut
2157
2158 sub in_iprange {
2159     my ($iprange) = @_;
2160     my $result = 1;
2161     my @allowedipranges = $iprange ? split(' ', $iprange) : ();
2162     if (scalar @allowedipranges > 0) {
2163         my @rangelist;
2164         eval { @rangelist = Net::CIDR::range2cidr(@allowedipranges); }; return 0 if $@;
2165         eval { $result = Net::CIDR::cidrlookup($ENV{'REMOTE_ADDR'}, @rangelist) } || Koha::Logger->get->warn('cidrlookup failed for ' . join(' ',@rangelist) );
2166      }
2167      return $result ? 1 : 0;
2168 }
2169
2170 sub getborrowernumber {
2171     my ($userid) = @_;
2172     my $userenv = C4::Context->userenv;
2173     if ( defined($userenv) && ref($userenv) eq 'HASH' && $userenv->{number} ) {
2174         return $userenv->{number};
2175     }
2176     my $dbh = C4::Context->dbh;
2177     for my $field ( 'userid', 'cardnumber' ) {
2178         my $sth =
2179           $dbh->prepare("select borrowernumber from borrowers where $field=?");
2180         $sth->execute($userid);
2181         if ( $sth->rows ) {
2182             my ($bnumber) = $sth->fetchrow;
2183             return $bnumber;
2184         }
2185     }
2186     return 0;
2187 }
2188
2189 =head2 track_login_daily
2190
2191     track_login_daily( $userid );
2192
2193 Wraps the call to $patron->track_login, the method used to update borrowers.lastseen. We only call track_login once a day.
2194
2195 =cut
2196
2197 sub track_login_daily {
2198     my $userid = shift;
2199     return if !$userid || !C4::Context->preference('TrackLastPatronActivity');
2200
2201     my $cache     = Koha::Caches->get_instance();
2202     my $cache_key = "track_login_" . $userid;
2203     my $cached    = $cache->get_from_cache($cache_key);
2204     my $today = dt_from_string()->ymd;
2205     return if $cached && $cached eq $today;
2206
2207     my $patron = Koha::Patrons->find({ userid => $userid });
2208     return unless $patron;
2209     $patron->track_login;
2210     $cache->set_in_cache( $cache_key, $today );
2211 }
2212
2213 END { }    # module clean-up code here (global destructor)
2214 1;
2215 __END__
2216
2217 =head1 SEE ALSO
2218
2219 CGI(3)
2220
2221 C4::Output(3)
2222
2223 Crypt::Eksblowfish::Bcrypt(3)
2224
2225 Digest::MD5(3)
2226
2227 =cut