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