C4/Auth.pm

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