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