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