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