C4/Auth.pm

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