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