C4/Auth.pm

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