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