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