C4/Auth.pm

   1 package C4::Auth;
   2
   3 # Copyright 2000-2002 Katipo Communications
   4 #
   5 # This file is part of Koha.
   6 #
   7 # Koha is free software; you can redistribute it and/or modify it
   8 # under the terms of the GNU General Public License as published by
   9 # the Free Software Foundation; either version 3 of the License, or
  10 # (at your option) any later version.
  11 #
  12 # Koha is distributed in the hope that it will be useful, but
  13 # WITHOUT ANY WARRANTY; without even the implied warranty of
  14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  15 # GNU General Public License for more details.
  16 #
  17 # You should have received a copy of the GNU General Public License
  18 # along with Koha; if not, see <http://www.gnu.org/licenses>.
  19
  20 use strict;
  21 use warnings;
  22 use Carp qw/croak/;
  23
  24 use Digest::MD5 qw(md5_base64);
  25 use JSON qw/encode_json/;
  26 use URI::Escape;
  27 use CGI::Session;
  28
  29 require Exporter;
  30 use C4::Context;
  31 use C4::Templates;    # to get the template
  32 use C4::Languages;
  33 use C4::Search::History;
  34 use Koha;
  35 use Koha::Caches;
  36 use Koha::AuthUtils qw(get_script_name hash_password);
  37 use Koha::Checkouts;
  38 use Koha::DateUtils qw(dt_from_string);
  39 use Koha::Library::Groups;
  40 use Koha::Libraries;
  41 use Koha::Patrons;
  42 use Koha::Patron::Consents;
  43 use POSIX qw/strftime/;
  44 use List::MoreUtils qw/ any /;
  45 use Encode qw( encode is_utf8);
  46 use C4::Auth_with_shibboleth;
  47 use Net::CIDR;
  48
  49 # use utf8;
  50 use vars qw(@ISA @EXPORT @EXPORT_OK %EXPORT_TAGS $debug $ldap $cas $caslogout);
  51
  52 BEGIN {
  53     sub psgi_env { any { /^psgi\./ } keys %ENV }
  54
  55     sub safe_exit {
  56         if   (psgi_env) { die 'psgi:exit' }
  57         else            { exit }
  58     }
  59
  60     C4::Context->set_remote_address;
  61
  62     $debug     = $ENV{DEBUG};
  63     @ISA       = qw(Exporter);
  64     @EXPORT    = qw(&checkauth &get_template_and_user &haspermission &get_user_subpermissions);
  65     @EXPORT_OK = qw(&check_api_auth &get_session &check_cookie_auth &checkpw &checkpw_internal &checkpw_hash
  66       &get_all_subpermissions &get_user_subpermissions track_login_daily &in_iprange
  67     );
  68     %EXPORT_TAGS = ( EditPermissions => [qw(get_all_subpermissions get_user_subpermissions)] );
  69     $ldap      = C4::Context->config('useldapserver') || 0;
  70     $cas       = C4::Context->preference('casAuthentication');
  71     $caslogout = C4::Context->preference('casLogout');
  72     require C4::Auth_with_cas;    # no import
  73
  74     if ($ldap) {
  75         require C4::Auth_with_ldap;
  76         import C4::Auth_with_ldap qw(checkpw_ldap);
  77     }
  78     if ($cas) {
  79         import C4::Auth_with_cas qw(check_api_auth_cas checkpw_cas login_cas logout_cas login_cas_url logout_if_required);
  80     }
  81
  82 }
  83
  84 =head1 NAME
  85
  86 C4::Auth - Authenticates Koha users
  87
  88 =head1 SYNOPSIS
  89
  90   use CGI qw ( -utf8 );
  91   use C4::Auth;
  92   use C4::Output;
  93
  94   my $query = new CGI;
  95
  96   my ($template, $borrowernumber, $cookie)
  97     = get_template_and_user(
  98         {
  99             template_name   => "opac-main.tt",
 100             query           => $query,
 101       type            => "opac",
 102       authnotrequired => 0,
 103       flagsrequired   => { catalogue => '*', tools => 'import_patrons' },
 104   }
 105     );
 106
 107   output_html_with_http_headers $query, $cookie, $template->output;
 108
 109 =head1 DESCRIPTION
 110
 111 The main function of this module is to provide
 112 authentification. However the get_template_and_user function has
 113 been provided so that a users login information is passed along
 114 automatically. This gets loaded into the template.
 115
 116 =head1 FUNCTIONS
 117
 118 =head2 get_template_and_user
 119
 120  my ($template, $borrowernumber, $cookie)
 121      = get_template_and_user(
 122        {
 123          template_name   => "opac-main.tt",
 124          query           => $query,
 125          type            => "opac",
 126          authnotrequired => 0,
 127          flagsrequired   => { catalogue => '*', tools => 'import_patrons' },
 128        }
 129      );
 130
 131 This call passes the C<query>, C<flagsrequired> and C<authnotrequired>
 132 to C<&checkauth> (in this module) to perform authentification.
 133 See C<&checkauth> for an explanation of these parameters.
 134
 135 The C<template_name> is then used to find the correct template for
 136 the page. The authenticated users details are loaded onto the
 137 template in the logged_in_user variable (which is a Koha::Patron object). Also the
 138 C<sessionID> is passed to the template. This can be used in templates
 139 if cookies are disabled. It needs to be put as and input to every
 140 authenticated page.
 141
 142 More information on the C<gettemplate> sub can be found in the
 143 Output.pm module.
 144
 145 =cut
 146
 147 sub get_template_and_user {
 148
 149     my $in = shift;
 150     my ( $user, $cookie, $sessionID, $flags );
 151
 152     # Get shibboleth login attribute
 153     my $shib = C4::Context->config('useshibboleth') && shib_ok();
 154     my $shib_login = $shib ? get_login_shib() : undef;
 155
 156     C4::Context->interface( $in->{type} );
 157
 158     $in->{'authnotrequired'} ||= 0;
 159
 160     # the following call includes a bad template check; might croak
 161     my $template = C4::Templates::gettemplate(
 162         $in->{'template_name'},
 163         $in->{'type'},
 164         $in->{'query'},
 165     );
 166
 167     if ( $in->{'template_name'} !~ m/maintenance/ ) {
 168         ( $user, $cookie, $sessionID, $flags ) = checkauth(
 169             $in->{'query'},
 170             $in->{'authnotrequired'},
 171             $in->{'flagsrequired'},
 172             $in->{'type'}
 173         );
 174     }
 175
 176     # If we enforce GDPR and the user did not consent, redirect
 177     # Exceptions for consent page itself and SCI/SCO system
 178     if( $in->{type} eq 'opac' && $user &&
 179         $in->{'template_name'} !~ /^(opac-patron-consent|sc[io]\/)/ &&
 180         C4::Context->preference('GDPR_Policy') eq 'Enforced' )
 181     {
 182         my $consent = Koha::Patron::Consents->search({
 183             borrowernumber => getborrowernumber($user),
 184             type => 'GDPR_PROCESSING',
 185             given_on => { '!=', undef },
 186         })->next;
 187         if( !$consent ) {
 188             print $in->{query}->redirect(-uri => '/cgi-bin/koha/opac-patron-consent.pl', -cookie => $cookie);
 189             safe_exit;
 190         }
 191     }
 192
 193     if ( $in->{type} eq 'opac' && $user ) {
 194         my $kick_out;
 195
 196         if (
 197 # If the user logged in is the SCO user and they try to go out of the SCO module,
 198 # log the user out removing the CGISESSID cookie
 199             $in->{template_name} !~ m|sco/| && $in->{template_name} !~ m|errors/errorpage.tt|
 200             && C4::Context->preference('AutoSelfCheckID')
 201             && $user eq C4::Context->preference('AutoSelfCheckID')
 202           )
 203         {
 204             $kick_out = 1;
 205         }
 206         elsif (
 207 # If the user logged in is the SCI user and they try to go out of the SCI module,
 208 # kick them out unless it is SCO with a valid permission
 209 # or they are a superlibrarian
 210                $in->{template_name} !~ m|sci/|
 211             && haspermission( $user, { self_check => 'self_checkin_module' } )
 212             && !(
 213                 $in->{template_name} =~ m|sco/| && haspermission(
 214                     $user, { self_check => 'self_checkout_module' }
 215                 )
 216             )
 217             && $flags && $flags->{superlibrarian} != 1
 218           )
 219         {
 220             $kick_out = 1;
 221         }
 222
 223         if ($kick_out) {
 224             $template = C4::Templates::gettemplate( 'opac-auth.tt', 'opac',
 225                 $in->{query} );
 226             $cookie = $in->{query}->cookie(
 227                 -name     => 'CGISESSID',
 228                 -value    => '',
 229                 -expires  => '',
 230                 -HttpOnly => 1,
 231             );
 232
 233             $template->param(
 234                 loginprompt => 1,
 235                 script_name => get_script_name(),
 236             );
 237
 238             print $in->{query}->header(
 239                 {
 240                     type              => 'text/html',
 241                     charset           => 'utf-8',
 242                     cookie            => $cookie,
 243                     'X-Frame-Options' => 'SAMEORIGIN'
 244                 }
 245               ),
 246               $template->output;
 247             safe_exit;
 248         }
 249     }
 250
 251     my $borrowernumber;
 252     if ($user) {
 253
 254         # It's possible for $user to be the borrowernumber if they don't have a
 255         # userid defined (and are logging in through some other method, such
 256         # as SSL certs against an email address)
 257         my $patron;
 258         $borrowernumber = getborrowernumber($user) if defined($user);
 259         if ( !defined($borrowernumber) && defined($user) ) {
 260             $patron = Koha::Patrons->find( $user );
 261             if ($patron) {
 262                 $borrowernumber = $user;
 263
 264                 # A bit of a hack, but I don't know there's a nicer way
 265                 # to do it.
 266                 $user = $patron->firstname . ' ' . $patron->surname;
 267             }
 268         } else {
 269             $patron = Koha::Patrons->find( $borrowernumber );
 270             # FIXME What to do if $patron does not exist?
 271         }
 272
 273         # user info
 274         $template->param( loggedinusername   => $user ); # OBSOLETE - Do not reuse this in template, use logged_in_user.userid instead
 275         $template->param( loggedinusernumber => $borrowernumber ); # FIXME Should be replaced with logged_in_user.borrowernumber
 276         $template->param( logged_in_user     => $patron );
 277         $template->param( sessionID          => $sessionID );
 278
 279         if ( $in->{'type'} eq 'opac' ) {
 280             require Koha::Virtualshelves;
 281             my $some_private_shelves = Koha::Virtualshelves->get_some_shelves(
 282                 {
 283                     borrowernumber => $borrowernumber,
 284                     category       => 1,
 285                 }
 286             );
 287             my $some_public_shelves = Koha::Virtualshelves->get_some_shelves(
 288                 {
 289                     category       => 2,
 290                 }
 291             );
 292             $template->param(
 293                 some_private_shelves => $some_private_shelves,
 294                 some_public_shelves  => $some_public_shelves,
 295             );
 296         }
 297
 298         my $all_perms = get_all_subpermissions();
 299
 300         my @flagroots = qw(circulate catalogue parameters borrowers permissions reserveforothers borrow
 301           editcatalogue updatecharges tools editauthorities serials reports acquisition clubs);
 302
 303         # We are going to use the $flags returned by checkauth
 304         # to create the template's parameters that will indicate
 305         # which menus the user can access.
 306         if ( $flags && $flags->{superlibrarian} == 1 ) {
 307             $template->param( CAN_user_circulate        => 1 );
 308             $template->param( CAN_user_catalogue        => 1 );
 309             $template->param( CAN_user_parameters       => 1 );
 310             $template->param( CAN_user_borrowers        => 1 );
 311             $template->param( CAN_user_permissions      => 1 );
 312             $template->param( CAN_user_reserveforothers => 1 );
 313             $template->param( CAN_user_editcatalogue    => 1 );
 314             $template->param( CAN_user_updatecharges    => 1 );
 315             $template->param( CAN_user_acquisition      => 1 );
 316             $template->param( CAN_user_tools            => 1 );
 317             $template->param( CAN_user_editauthorities  => 1 );
 318             $template->param( CAN_user_serials          => 1 );
 319             $template->param( CAN_user_reports          => 1 );
 320             $template->param( CAN_user_staffaccess      => 1 );
 321             $template->param( CAN_user_plugins          => 1 );
 322             $template->param( CAN_user_coursereserves   => 1 );
 323             $template->param( CAN_user_clubs            => 1 );
 324             $template->param( CAN_user_ill              => 1 );
 325             $template->param( CAN_user_stockrotation    => 1 );
 326
 327             foreach my $module ( keys %$all_perms ) {
 328                 foreach my $subperm ( keys %{ $all_perms->{$module} } ) {
 329                     $template->param( "CAN_user_${module}_${subperm}" => 1 );
 330                 }
 331             }
 332         }
 333
 334         if ($flags) {
 335             foreach my $module ( keys %$all_perms ) {
 336                 if ( defined($flags->{$module}) && $flags->{$module} == 1 ) {
 337                     foreach my $subperm ( keys %{ $all_perms->{$module} } ) {
 338                         $template->param( "CAN_user_${module}_${subperm}" => 1 );
 339                     }
 340                 } elsif ( ref( $flags->{$module} ) ) {
 341                     foreach my $subperm ( keys %{ $flags->{$module} } ) {
 342                         $template->param( "CAN_user_${module}_${subperm}" => 1 );
 343                     }
 344                 }
 345             }
 346         }
 347
 348         if ($flags) {
 349             foreach my $module ( keys %$flags ) {
 350                 if ( $flags->{$module} == 1 or ref( $flags->{$module} ) ) {
 351                     $template->param( "CAN_user_$module" => 1 );
 352                 }
 353             }
 354         }
 355
 356         # Logged-in opac search history
 357         # If the requested template is an opac one and opac search history is enabled
 358         if ( $in->{type} eq 'opac' && C4::Context->preference('EnableOpacSearchHistory') ) {
 359             my $dbh   = C4::Context->dbh;
 360             my $query = "SELECT COUNT(*) FROM search_history WHERE userid=?";
 361             my $sth   = $dbh->prepare($query);
 362             $sth->execute($borrowernumber);
 363
 364             # If at least one search has already been performed
 365             if ( $sth->fetchrow_array > 0 ) {
 366
 367                 # We show the link in opac
 368                 $template->param( EnableOpacSearchHistory => 1 );
 369             }
 370             if (C4::Context->preference('LoadSearchHistoryToTheFirstLoggedUser'))
 371             {
 372                 # And if there are searches performed when the user was not logged in,
 373                 # we add them to the logged-in search history
 374                 my @recentSearches = C4::Search::History::get_from_session( { cgi => $in->{'query'} } );
 375                 if (@recentSearches) {
 376                     my $dbh   = C4::Context->dbh;
 377                     my $query = q{
 378                         INSERT INTO search_history(userid, sessionid, query_desc, query_cgi, type,  total, time )
 379                         VALUES (?, ?, ?, ?, ?, ?, ?)
 380                     };
 381                     my $sth = $dbh->prepare($query);
 382                     $sth->execute( $borrowernumber,
 383                         $in->{query}->cookie("CGISESSID"),
 384                         $_->{query_desc},
 385                         $_->{query_cgi},
 386                         $_->{type} || 'biblio',
 387                         $_->{total},
 388                         $_->{time},
 389                     ) foreach @recentSearches;
 390
 391                     # clear out the search history from the session now that
 392                     # we've saved it to the database
 393                  }
 394               }
 395               C4::Search::History::set_to_session( { cgi => $in->{'query'}, search_history => [] } );
 396
 397         } elsif ( $in->{type} eq 'intranet' and C4::Context->preference('EnableSearchHistory') ) {
 398             $template->param( EnableSearchHistory => 1 );
 399         }
 400     }
 401     else {    # if this is an anonymous session, setup to display public lists...
 402
 403         # If shibboleth is enabled, and we're in an anonymous session, we should allow
 404         # the user to attempt login via shibboleth.
 405         if ($shib) {
 406             $template->param( shibbolethAuthentication => $shib,
 407                 shibbolethLoginUrl => login_shib_url( $in->{'query'} ),
 408             );
 409
 410             # If shibboleth is enabled and we have a shibboleth login attribute,
 411             # but we are in an anonymous session, then we clearly have an invalid
 412             # shibboleth koha account.
 413             if ($shib_login) {
 414                 $template->param( invalidShibLogin => '1' );
 415             }
 416         }
 417
 418         $template->param( sessionID => $sessionID );
 419
 420         if ( $in->{'type'} eq 'opac' ){
 421             require Koha::Virtualshelves;
 422             my $some_public_shelves = Koha::Virtualshelves->get_some_shelves(
 423                 {
 424                     category       => 2,
 425                 }
 426             );
 427             $template->param(
 428                 some_public_shelves  => $some_public_shelves,
 429             );
 430         }
 431     }
 432
 433     # Anonymous opac search history
 434     # If opac search history is enabled and at least one search has already been performed
 435     if ( C4::Context->preference('EnableOpacSearchHistory') ) {
 436         my @recentSearches = C4::Search::History::get_from_session( { cgi => $in->{'query'} } );
 437         if (@recentSearches) {
 438             $template->param( EnableOpacSearchHistory => 1 );
 439         }
 440     }
 441
 442     if ( C4::Context->preference('dateformat') ) {
 443         $template->param( dateformat => C4::Context->preference('dateformat') );
 444     }
 445
 446     $template->param(auth_forwarded_hash => scalar $in->{'query'}->param('auth_forwarded_hash'));
 447
 448     # these template parameters are set the same regardless of $in->{'type'}
 449
 450     # Set the using_https variable for templates
 451     # FIXME Under Plack the CGI->https method always returns 'OFF'
 452     my $https = $in->{query}->https();
 453     my $using_https = ( defined $https and $https ne 'OFF' ) ? 1 : 0;
 454
 455     my $minPasswordLength = C4::Context->preference('minPasswordLength');
 456     $minPasswordLength = 3 if not $minPasswordLength or $minPasswordLength < 3;
 457     $template->param(
 458         "BiblioDefaultView" . C4::Context->preference("BiblioDefaultView") => 1,
 459         EnhancedMessagingPreferences                                       => C4::Context->preference('EnhancedMessagingPreferences'),
 460         GoogleJackets                                                      => C4::Context->preference("GoogleJackets"),
 461         OpenLibraryCovers                                                  => C4::Context->preference("OpenLibraryCovers"),
 462         KohaAdminEmailAddress                                              => "" . C4::Context->preference("KohaAdminEmailAddress"),
 463         LoginBranchcode => ( C4::Context->userenv ? C4::Context->userenv->{"branch"}    : undef ),
 464         LoginFirstname  => ( C4::Context->userenv ? C4::Context->userenv->{"firstname"} : "Bel" ),
 465         LoginSurname    => C4::Context->userenv ? C4::Context->userenv->{"surname"}      : "Inconnu",
 466         emailaddress    => C4::Context->userenv ? C4::Context->userenv->{"emailaddress"} : undef,
 467         TagsEnabled     => C4::Context->preference("TagsEnabled"),
 468         hide_marc       => C4::Context->preference("hide_marc"),
 469         item_level_itypes  => C4::Context->preference('item-level_itypes'),
 470         patronimages       => C4::Context->preference("patronimages"),
 471         singleBranchMode   => ( Koha::Libraries->search->count == 1 ),
 472         XSLTDetailsDisplay => C4::Context->preference("XSLTDetailsDisplay"),
 473         XSLTResultsDisplay => C4::Context->preference("XSLTResultsDisplay"),
 474         using_https        => $using_https,
 475         noItemTypeImages   => C4::Context->preference("noItemTypeImages"),
 476         marcflavour        => C4::Context->preference("marcflavour"),
 477         OPACBaseURL        => C4::Context->preference('OPACBaseURL'),
 478         minPasswordLength  => $minPasswordLength,
 479     );
 480     if ( $in->{'type'} eq "intranet" ) {
 481         $template->param(
 482             AmazonCoverImages                                                          => C4::Context->preference("AmazonCoverImages"),
 483             AutoLocation                                                               => C4::Context->preference("AutoLocation"),
 484             "BiblioDefaultView" . C4::Context->preference("IntranetBiblioDefaultView") => 1,
 485             PatronAutoComplete                                                       => C4::Context->preference("PatronAutoComplete"),
 486             FRBRizeEditions                                                            => C4::Context->preference("FRBRizeEditions"),
 487             IndependentBranches                                                        => C4::Context->preference("IndependentBranches"),
 488             IntranetNav                                                                => C4::Context->preference("IntranetNav"),
 489             IntranetmainUserblock                                                      => C4::Context->preference("IntranetmainUserblock"),
 490             LibraryName                                                                => C4::Context->preference("LibraryName"),
 491             LoginBranchname                                                            => ( C4::Context->userenv ? C4::Context->userenv->{"branchname"} : undef ),
 492             advancedMARCEditor                                                         => C4::Context->preference("advancedMARCEditor"),
 493             canreservefromotherbranches                                                => C4::Context->preference('canreservefromotherbranches'),
 494             intranetcolorstylesheet                                                    => C4::Context->preference("intranetcolorstylesheet"),
 495             IntranetFavicon                                                            => C4::Context->preference("IntranetFavicon"),
 496             intranetreadinghistory                                                     => C4::Context->preference("intranetreadinghistory"),
 497             intranetstylesheet                                                         => C4::Context->preference("intranetstylesheet"),
 498             IntranetUserCSS                                                            => C4::Context->preference("IntranetUserCSS"),
 499             IntranetUserJS                                                             => C4::Context->preference("IntranetUserJS"),
 500             intranetbookbag                                                            => C4::Context->preference("intranetbookbag"),
 501             suggestion                                                                 => C4::Context->preference("suggestion"),
 502             virtualshelves                                                             => C4::Context->preference("virtualshelves"),
 503             StaffSerialIssueDisplayCount                                               => C4::Context->preference("StaffSerialIssueDisplayCount"),
 504             EasyAnalyticalRecords                                                      => C4::Context->preference('EasyAnalyticalRecords'),
 505             LocalCoverImages                                                           => C4::Context->preference('LocalCoverImages'),
 506             OPACLocalCoverImages                                                       => C4::Context->preference('OPACLocalCoverImages'),
 507             AllowMultipleCovers                                                        => C4::Context->preference('AllowMultipleCovers'),
 508             EnableBorrowerFiles                                                        => C4::Context->preference('EnableBorrowerFiles'),
 509             UseKohaPlugins                                                             => C4::Context->preference('UseKohaPlugins'),
 510             UseCourseReserves                                                          => C4::Context->preference("UseCourseReserves"),
 511             useDischarge                                                               => C4::Context->preference('useDischarge'),
 512             pending_checkout_notes                                                     => scalar Koha::Checkouts->search({ noteseen => 0 }),
 513         );
 514     }
 515     else {
 516         warn "template type should be OPAC, here it is=[" . $in->{'type'} . "]" unless ( $in->{'type'} eq 'opac' );
 517
 518         #TODO : replace LibraryName syspref with 'system name', and remove this html processing
 519         my $LibraryNameTitle = C4::Context->preference("LibraryName");
 520         $LibraryNameTitle =~ s/<(?:\/?)(?:br|p)\s*(?:\/?)>/ /sgi;
 521         $LibraryNameTitle =~ s/<(?:[^<>'"]|'(?:[^']*)'|"(?:[^"]*)")*>//sg;
 522
 523         # clean up the busc param in the session
 524         # if the page is not opac-detail and not the "add to list" page
 525         # and not the "edit comments" page
 526         if ( C4::Context->preference("OpacBrowseResults")
 527             && $in->{'template_name'} =~ /opac-(.+)\.(?:tt|tmpl)$/ ) {
 528             my $pagename = $1;
 529             unless ( $pagename =~ /^(?:MARC|ISBD)?detail$/
 530                 or $pagename =~ /^addbybiblionumber$/
 531                 or $pagename =~ /^review$/ ) {
 532                 my $sessionSearch = get_session( $sessionID || $in->{'query'}->cookie("CGISESSID") );
 533                 $sessionSearch->clear( ["busc"] ) if ( $sessionSearch->param("busc") );
 534             }
 535         }
 536
 537         # variables passed from CGI: opac_css_override and opac_search_limits.
 538         my $opac_search_limit   = $ENV{'OPAC_SEARCH_LIMIT'};
 539         my $opac_limit_override = $ENV{'OPAC_LIMIT_OVERRIDE'};
 540         my $opac_name           = '';
 541         if (
 542             ( $opac_limit_override && $opac_search_limit && $opac_search_limit =~ /branch:([\w-]+)/ ) ||
 543             ( $in->{'query'}->param('limit') && $in->{'query'}->param('limit') =~ /branch:([\w-]+)/ ) ||
 544             ( $in->{'query'}->param('multibranchlimit') && $in->{'query'}->param('multibranchlimit') =~ /multibranchlimit-(\w+)/ )
 545           ) {
 546             $opac_name = $1;    # opac_search_limit is a branch, so we use it.
 547         } elsif ( $in->{'query'}->param('multibranchlimit') ) {
 548             $opac_name = $in->{'query'}->param('multibranchlimit');
 549         } elsif ( C4::Context->preference("SearchMyLibraryFirst") && C4::Context->userenv && C4::Context->userenv->{'branch'} ) {
 550             $opac_name = C4::Context->userenv->{'branch'};
 551         }
 552
 553         my @search_groups = Koha::Library::Groups->get_search_groups({ interface => 'opac' });
 554         $template->param(
 555             AnonSuggestions                       => "" . C4::Context->preference("AnonSuggestions"),
 556             LibrarySearchGroups                   => \@search_groups,
 557             opac_name                             => $opac_name,
 558             LibraryName                           => "" . C4::Context->preference("LibraryName"),
 559             LibraryNameTitle                      => "" . $LibraryNameTitle,
 560             LoginBranchname                       => C4::Context->userenv ? C4::Context->userenv->{"branchname"} : "",
 561             OPACAmazonCoverImages                 => C4::Context->preference("OPACAmazonCoverImages"),
 562             OPACFRBRizeEditions                   => C4::Context->preference("OPACFRBRizeEditions"),
 563             OpacHighlightedWords                  => C4::Context->preference("OpacHighlightedWords"),
 564             OPACShelfBrowser                      => "" . C4::Context->preference("OPACShelfBrowser"),
 565             OPACURLOpenInNewWindow                => "" . C4::Context->preference("OPACURLOpenInNewWindow"),
 566             OPACUserCSS                           => "" . C4::Context->preference("OPACUserCSS"),
 567             OpacAuthorities                       => C4::Context->preference("OpacAuthorities"),
 568             opac_css_override                     => $ENV{'OPAC_CSS_OVERRIDE'},
 569             opac_search_limit                     => $opac_search_limit,
 570             opac_limit_override                   => $opac_limit_override,
 571             OpacBrowser                           => C4::Context->preference("OpacBrowser"),
 572             OpacCloud                             => C4::Context->preference("OpacCloud"),
 573             OpacKohaUrl                           => C4::Context->preference("OpacKohaUrl"),
 574             OpacMainUserBlock                     => "" . C4::Context->preference("OpacMainUserBlock"),
 575             OpacNav                               => "" . C4::Context->preference("OpacNav"),
 576             OpacNavBottom                         => "" . C4::Context->preference("OpacNavBottom"),
 577             OpacPasswordChange                    => C4::Context->preference("OpacPasswordChange"),
 578             OPACPatronDetails                     => C4::Context->preference("OPACPatronDetails"),
 579             OPACPrivacy                           => C4::Context->preference("OPACPrivacy"),
 580             OPACFinesTab                          => C4::Context->preference("OPACFinesTab"),
 581             OpacTopissue                          => C4::Context->preference("OpacTopissue"),
 582             RequestOnOpac                         => C4::Context->preference("RequestOnOpac"),
 583             'Version'                             => C4::Context->preference('Version'),
 584             hidelostitems                         => C4::Context->preference("hidelostitems"),
 585             mylibraryfirst                        => ( C4::Context->preference("SearchMyLibraryFirst") && C4::Context->userenv ) ? C4::Context->userenv->{'branch'} : '',
 586             opacbookbag                           => "" . C4::Context->preference("opacbookbag"),
 587             opaccredits                           => "" . C4::Context->preference("opaccredits"),
 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'),
 852                 $session->param('shibboleth')
 853             );
 854             C4::Context::set_shelves_userenv( 'bar', $session->param('barshelves') );
 855             C4::Context::set_shelves_userenv( 'pub', $session->param('pubshelves') );
 856             C4::Context::set_shelves_userenv( 'tot', $session->param('totshelves') );
 857             $debug and printf STDERR "AUTH_SESSION: (%s)\t%s %s - %s\n", map { $session->param($_) } qw(cardnumber firstname surname branch);
 858             $ip          = $session->param('ip');
 859             $lasttime    = $session->param('lasttime');
 860             $userid      = $s_userid;
 861             $sessiontype = $session->param('sessiontype') || '';
 862         }
 863         if ( ( $query->param('koha_login_context') && ( $q_userid ne $s_userid ) )
 864             || ( $cas && $query->param('ticket') && !C4::Context->userenv->{'id'} )
 865             || ( $shib && $shib_login && !$logout && !C4::Context->userenv->{'id'} )
 866         ) {
 867
 868             #if a user enters an id ne to the id in the current session, we need to log them in...
 869             #first we need to clear the anonymous session...
 870             $debug and warn "query id = $q_userid but session id = $s_userid";
 871             $anon_search_history = $session->param('search_history');
 872             $session->delete();
 873             $session->flush;
 874             C4::Context->_unset_userenv($sessionID);
 875             $sessionID = undef;
 876             $userid    = undef;
 877         }
 878         elsif ($logout) {
 879
 880             # voluntary logout the user
 881             # check wether the user was using their shibboleth session or a local one
 882             my $shibSuccess = C4::Context->userenv->{'shibboleth'};
 883             $session->delete();
 884             $session->flush;
 885             C4::Context->_unset_userenv($sessionID);
 886
 887             #_session_log(sprintf "%20s from %16s logged out at %30s (manually).\n", $userid,$ip,(strftime "%c",localtime));
 888             $sessionID = undef;
 889             $userid    = undef;
 890
 891             if ($cas and $caslogout) {
 892                 logout_cas($query, $type);
 893             }
 894
 895             # If we are in a shibboleth session (shibboleth is enabled, a shibboleth match attribute is set and matches koha matchpoint)
 896             if ( $shib and $shib_login and $shibSuccess) {
 897                 logout_shib($query);
 898             }
 899         }
 900         elsif ( !$lasttime || ( $lasttime < time() - $timeout ) ) {
 901
 902             # timed logout
 903             $info{'timed_out'} = 1;
 904             if ($session) {
 905                 $session->delete();
 906                 $session->flush;
 907             }
 908             C4::Context->_unset_userenv($sessionID);
 909
 910             #_session_log(sprintf "%20s from %16s logged out at %30s (inactivity).\n", $userid,$ip,(strftime "%c",localtime));
 911             $userid    = undef;
 912             $sessionID = undef;
 913         }
 914         elsif ( C4::Context->preference('SessionRestrictionByIP') && $ip ne $ENV{'REMOTE_ADDR'} ) {
 915
 916             # Different ip than originally logged in from
 917             $info{'oldip'}        = $ip;
 918             $info{'newip'}        = $ENV{'REMOTE_ADDR'};
 919             $info{'different_ip'} = 1;
 920             $session->delete();
 921             $session->flush;
 922             C4::Context->_unset_userenv($sessionID);
 923
 924             #_session_log(sprintf "%20s from %16s logged out at %30s (ip changed to %16s).\n", $userid,$ip,(strftime "%c",localtime), $info{'newip'});
 925             $sessionID = undef;
 926             $userid    = undef;
 927         }
 928         else {
 929             $cookie = $query->cookie(
 930                 -name     => 'CGISESSID',
 931                 -value    => $session->id,
 932                 -HttpOnly => 1
 933             );
 934             $session->param( 'lasttime', time() );
 935             unless ( $sessiontype && $sessiontype eq 'anon' ) {    #if this is an anonymous session, we want to update the session, but not behave as if they are logged in...
 936                 $flags = haspermission( $userid, $flagsrequired );
 937                 if ($flags) {
 938                     $loggedin = 1;
 939                 } else {
 940                     $info{'nopermission'} = 1;
 941                 }
 942             }
 943         }
 944     }
 945     unless ( $userid || $sessionID ) {
 946         #we initiate a session prior to checking for a username to allow for anonymous sessions...
 947         my $session = get_session("") or die "Auth ERROR: Cannot get_session()";
 948
 949         # Save anonymous search history in new session so it can be retrieved
 950         # by get_template_and_user to store it in user's search history after
 951         # a successful login.
 952         if ($anon_search_history) {
 953             $session->param( 'search_history', $anon_search_history );
 954         }
 955
 956         $sessionID = $session->id;
 957         C4::Context->_new_userenv($sessionID);
 958         $cookie = $query->cookie(
 959             -name     => 'CGISESSID',
 960             -value    => $session->id,
 961             -HttpOnly => 1
 962         );
 963         my $pki_field = C4::Context->preference('AllowPKIAuth');
 964         if ( !defined($pki_field) ) {
 965             print STDERR "ERROR: Missing system preference AllowPKIAuth.\n";
 966             $pki_field = 'None';
 967         }
 968         if ( ( $cas && $query->param('ticket') )
 969             || $q_userid
 970             || ( $shib && $shib_login )
 971             || $pki_field ne 'None'
 972             || $emailaddress )
 973         {
 974             my $password    = $query->param('password');
 975             my $shibSuccess = 0;
 976             my ( $return, $cardnumber );
 977
 978             # If shib is enabled and we have a shib login, does the login match a valid koha user
 979             if ( $shib && $shib_login ) {
 980                 my $retuserid;
 981
 982                 # Do not pass password here, else shib will not be checked in checkpw.
 983                 ( $return, $cardnumber, $retuserid ) = checkpw( $dbh, $q_userid, undef, $query );
 984                 $userid      = $retuserid;
 985                 $shibSuccess = $return;
 986                 $info{'invalidShibLogin'} = 1 unless ($return);
 987             }
 988
 989             # If shib login and match were successful, skip further login methods
 990             unless ($shibSuccess) {
 991                 if ( $cas && $query->param('ticket') ) {
 992                     my $retuserid;
 993                     ( $return, $cardnumber, $retuserid, $cas_ticket ) =
 994                       checkpw( $dbh, $userid, $password, $query, $type );
 995                     $userid = $retuserid;
 996                     $info{'invalidCasLogin'} = 1 unless ($return);
 997                 }
 998
 999                 elsif ( $emailaddress ) {
1000                     my $value = $emailaddress;
1001
1002                     # If we're looking up the email, there's a chance that the person
1003                     # doesn't have a userid. So if there is none, we pass along the
1004                     # borrower number, and the bits of code that need to know the user
1005                     # ID will have to be smart enough to handle that.
1006                     my $patrons = Koha::Patrons->search({ email => $value });
1007                     if ($patrons->count) {
1008
1009                         # First the userid, then the borrowernum
1010                         my $patron = $patrons->next;
1011                         $value = $patron->userid || $patron->borrowernumber;
1012                     } else {
1013                         undef $value;
1014                     }
1015                     $return = $value ? 1 : 0;
1016                     $userid = $value;
1017                 }
1018
1019                 elsif (
1020                     ( $pki_field eq 'Common Name' && $ENV{'SSL_CLIENT_S_DN_CN'} )
1021                     || ( $pki_field eq 'emailAddress'
1022                         && $ENV{'SSL_CLIENT_S_DN_Email'} )
1023                   )
1024                 {
1025                     my $value;
1026                     if ( $pki_field eq 'Common Name' ) {
1027                         $value = $ENV{'SSL_CLIENT_S_DN_CN'};
1028                     }
1029                     elsif ( $pki_field eq 'emailAddress' ) {
1030                         $value = $ENV{'SSL_CLIENT_S_DN_Email'};
1031
1032                         # If we're looking up the email, there's a chance that the person
1033                         # doesn't have a userid. So if there is none, we pass along the
1034                         # borrower number, and the bits of code that need to know the user
1035                         # ID will have to be smart enough to handle that.
1036                         my $patrons = Koha::Patrons->search({ email => $value });
1037                         if ($patrons->count) {
1038
1039                             # First the userid, then the borrowernum
1040                             my $patron = $patrons->next;
1041                             $value = $patron->userid || $patron->borrowernumber;
1042                         } else {
1043                             undef $value;
1044                         }
1045                     }
1046
1047                     $return = $value ? 1 : 0;
1048                     $userid = $value;
1049
1050                 }
1051                 else {
1052                     my $retuserid;
1053                     ( $return, $cardnumber, $retuserid, $cas_ticket ) =
1054                       checkpw( $dbh, $q_userid, $password, $query, $type );
1055                     $userid = $retuserid if ($retuserid);
1056                     $info{'invalid_username_or_password'} = 1 unless ($return);
1057                 }
1058             }
1059
1060             # $return: 1 = valid user
1061             if ($return) {
1062
1063                 #_session_log(sprintf "%20s from %16s logged in  at %30s.\n", $userid,$ENV{'REMOTE_ADDR'},(strftime '%c', localtime));
1064                 if ( $flags = haspermission( $userid, $flagsrequired ) ) {
1065                     $loggedin = 1;
1066                 }
1067                 else {
1068                     $info{'nopermission'} = 1;
1069                     C4::Context->_unset_userenv($sessionID);
1070                 }
1071                 my ( $borrowernumber, $firstname, $surname, $userflags,
1072                     $branchcode, $branchname, $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                 );
1167
1168             }
1169             # $return: 0 = invalid user
1170             # reset to anonymous session
1171             else {
1172                 $debug and warn "Login failed, resetting anonymous session...";
1173                 if ($userid) {
1174                     $info{'invalid_username_or_password'} = 1;
1175                     C4::Context->_unset_userenv($sessionID);
1176                 }
1177                 $session->param( 'lasttime', time() );
1178                 $session->param( 'ip',       $session->remote_addr() );
1179                 $session->param( 'sessiontype', 'anon' );
1180                 $session->param( 'interface', $type);
1181             }
1182         }    # END if ( $q_userid
1183         elsif ( $type eq "opac" ) {
1184
1185             # if we are here this is an anonymous session; add public lists to it and a few other items...
1186             # anonymous sessions are created only for the OPAC
1187             $debug and warn "Initiating an anonymous session...";
1188
1189             # setting a couple of other session vars...
1190             $session->param( 'ip',          $session->remote_addr() );
1191             $session->param( 'lasttime',    time() );
1192             $session->param( 'sessiontype', 'anon' );
1193             $session->param( 'interface', $type);
1194         }
1195     }    # END unless ($userid)
1196
1197     # finished authentification, now respond
1198     if ( $loggedin || $authnotrequired )
1199     {
1200         # successful login
1201         unless ($cookie) {
1202             $cookie = $query->cookie(
1203                 -name     => 'CGISESSID',
1204                 -value    => '',
1205                 -HttpOnly => 1
1206             );
1207         }
1208
1209         # In case, that this request was a login attempt, we want to prevent that users can repost the opac login
1210         # request. We therefore redirect the user to the requested page again without the login parameters.
1211         # See Post/Redirect/Get (PRG) design pattern: https://en.wikipedia.org/wiki/Post/Redirect/Get
1212         if ( $type eq "opac" && $query->param('koha_login_context') && $query->param('koha_login_context') ne 'sco' && $query->param('password') && $query->param('userid') ) {
1213             my $uri = URI->new($query->url(-relative=>1, -query_string=>1));
1214             $uri->query_param_delete('userid');
1215             $uri->query_param_delete('password');
1216             $uri->query_param_delete('koha_login_context');
1217             print $query->redirect(-uri => $uri->as_string, -cookie => $cookie, -status=>'303 See other');
1218             exit;
1219         }
1220
1221         track_login_daily( $userid );
1222
1223         return ( $userid, $cookie, $sessionID, $flags );
1224     }
1225
1226     #
1227     #
1228     # AUTH rejected, show the login/password template, after checking the DB.
1229     #
1230     #
1231
1232     # get the inputs from the incoming query
1233     my @inputs = ();
1234     foreach my $name ( param $query) {
1235         (next) if ( $name eq 'userid' || $name eq 'password' || $name eq 'ticket' );
1236         my @value = $query->multi_param($name);
1237         push @inputs, { name => $name, value => $_ } for @value;
1238     }
1239
1240     my $patron = Koha::Patrons->find({ userid => $q_userid }); # Not necessary logged in!
1241
1242     my $LibraryNameTitle = C4::Context->preference("LibraryName");
1243     $LibraryNameTitle =~ s/<(?:\/?)(?:br|p)\s*(?:\/?)>/ /sgi;
1244     $LibraryNameTitle =~ s/<(?:[^<>'"]|'(?:[^']*)'|"(?:[^"]*)")*>//sg;
1245
1246     my $template_name = ( $type eq 'opac' ) ? 'opac-auth.tt' : 'auth.tt';
1247     my $template = C4::Templates::gettemplate( $template_name, $type, $query );
1248     $template->param(
1249         login                                 => 1,
1250         INPUTS                                => \@inputs,
1251         script_name                           => get_script_name(),
1252         casAuthentication                     => C4::Context->preference("casAuthentication"),
1253         shibbolethAuthentication              => $shib,
1254         SessionRestrictionByIP                => C4::Context->preference("SessionRestrictionByIP"),
1255         suggestion                            => C4::Context->preference("suggestion"),
1256         virtualshelves                        => C4::Context->preference("virtualshelves"),
1257         LibraryName                           => "" . C4::Context->preference("LibraryName"),
1258         LibraryNameTitle                      => "" . $LibraryNameTitle,
1259         opacuserlogin                         => C4::Context->preference("opacuserlogin"),
1260         OpacNav                               => C4::Context->preference("OpacNav"),
1261         OpacNavBottom                         => C4::Context->preference("OpacNavBottom"),
1262         opaccredits                           => C4::Context->preference("opaccredits"),
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')
1444             );
1445
1446             my $ip       = $session->param('ip');
1447             my $lasttime = $session->param('lasttime');
1448             my $userid   = $session->param('id');
1449             if ( $lasttime < time() - $timeout ) {
1450
1451                 # time out
1452                 $session->delete();
1453                 $session->flush;
1454                 C4::Context->_unset_userenv($sessionID);
1455                 $userid    = undef;
1456                 $sessionID = undef;
1457                 return ( "expired", undef, undef );
1458             } elsif ( C4::Context->preference('SessionRestrictionByIP') && $ip ne $ENV{'REMOTE_ADDR'} ) {
1459
1460                 # IP address changed
1461                 $session->delete();
1462                 $session->flush;
1463                 C4::Context->_unset_userenv($sessionID);
1464                 $userid    = undef;
1465                 $sessionID = undef;
1466                 return ( "expired", undef, undef );
1467             } else {
1468                 my $cookie = $query->cookie(
1469                     -name     => 'CGISESSID',
1470                     -value    => $session->id,
1471                     -HttpOnly => 1,
1472                 );
1473                 $session->param( 'lasttime', time() );
1474                 my $flags = haspermission( $userid, $flagsrequired );
1475                 if ($flags) {
1476                     return ( "ok", $cookie, $sessionID );
1477                 } else {
1478                     $session->delete();
1479                     $session->flush;
1480                     C4::Context->_unset_userenv($sessionID);
1481                     $userid    = undef;
1482                     $sessionID = undef;
1483                     return ( "failed", undef, undef );
1484                 }
1485             }
1486         } else {
1487             return ( "expired", undef, undef );
1488         }
1489     } else {
1490
1491         # new login
1492         my $userid   = $query->param('userid');
1493         my $password = $query->param('password');
1494         my ( $return, $cardnumber, $cas_ticket );
1495
1496         # Proxy CAS auth
1497         if ( $cas && $query->param('PT') ) {
1498             my $retuserid;
1499             $debug and print STDERR "## check_api_auth - checking CAS\n";
1500
1501             # In case of a CAS authentication, we use the ticket instead of the password
1502             my $PT = $query->param('PT');
1503             ( $return, $cardnumber, $userid, $cas_ticket ) = check_api_auth_cas( $dbh, $PT, $query );    # EXTERNAL AUTH
1504         } else {
1505
1506             # User / password auth
1507             unless ( $userid and $password ) {
1508
1509                 # caller did something wrong, fail the authenticateion
1510                 return ( "failed", undef, undef );
1511             }
1512             my $newuserid;
1513             ( $return, $cardnumber, $newuserid, $cas_ticket ) = checkpw( $dbh, $userid, $password, $query );
1514         }
1515
1516         if ( $return and haspermission( $userid, $flagsrequired ) ) {
1517             my $session = get_session("");
1518             return ( "failed", undef, undef ) unless $session;
1519
1520             my $sessionID = $session->id;
1521             C4::Context->_new_userenv($sessionID);
1522             my $cookie = $query->cookie(
1523                 -name     => 'CGISESSID',
1524                 -value    => $sessionID,
1525                 -HttpOnly => 1,
1526             );
1527             if ( $return == 1 ) {
1528                 my (
1529                     $borrowernumber, $firstname,  $surname,
1530                     $userflags,      $branchcode, $branchname,
1531                     $emailaddress
1532                 );
1533                 my $sth =
1534                   $dbh->prepare(
1535 "select borrowernumber, firstname, surname, flags, borrowers.branchcode, branches.branchname as branchname, email from borrowers left join branches on borrowers.branchcode=branches.branchcode where userid=?"
1536                   );
1537                 $sth->execute($userid);
1538                 (
1539                     $borrowernumber, $firstname,  $surname,
1540                     $userflags,      $branchcode, $branchname,
1541                     $emailaddress
1542                 ) = $sth->fetchrow if ( $sth->rows );
1543
1544                 unless ( $sth->rows ) {
1545                     my $sth = $dbh->prepare(
1546 "select borrowernumber, firstname, surname, flags, borrowers.branchcode, branches.branchname as branchname, email from borrowers left join branches on borrowers.branchcode=branches.branchcode where cardnumber=?"
1547                     );
1548                     $sth->execute($cardnumber);
1549                     (
1550                         $borrowernumber, $firstname,  $surname,
1551                         $userflags,      $branchcode, $branchname,
1552                         $emailaddress
1553                     ) = $sth->fetchrow if ( $sth->rows );
1554
1555                     unless ( $sth->rows ) {
1556                         $sth->execute($userid);
1557                         (
1558                             $borrowernumber, $firstname,  $surname,       $userflags,
1559                             $branchcode,     $branchname, $emailaddress
1560                         ) = $sth->fetchrow if ( $sth->rows );
1561                     }
1562                 }
1563
1564                 my $ip = $ENV{'REMOTE_ADDR'};
1565
1566                 # if they specify at login, use that
1567                 if ( $query->param('branch') ) {
1568                     $branchcode = $query->param('branch');
1569                     my $library = Koha::Libraries->find($branchcode);
1570                     $branchname = $library? $library->branchname: '';
1571                 }
1572                 my $branches = { map { $_->branchcode => $_->unblessed } Koha::Libraries->search };
1573                 foreach my $br ( keys %$branches ) {
1574
1575                     #     now we work with the treatment of ip
1576                     my $domain = $branches->{$br}->{'branchip'};
1577                     if ( $domain && $ip =~ /^$domain/ ) {
1578                         $branchcode = $branches->{$br}->{'branchcode'};
1579
1580                         # new op dev : add the branchname to the cookie
1581                         $branchname    = $branches->{$br}->{'branchname'};
1582                     }
1583                 }
1584                 $session->param( 'number',       $borrowernumber );
1585                 $session->param( 'id',           $userid );
1586                 $session->param( 'cardnumber',   $cardnumber );
1587                 $session->param( 'firstname',    $firstname );
1588                 $session->param( 'surname',      $surname );
1589                 $session->param( 'branch',       $branchcode );
1590                 $session->param( 'branchname',   $branchname );
1591                 $session->param( 'flags',        $userflags );
1592                 $session->param( 'emailaddress', $emailaddress );
1593                 $session->param( 'ip',           $session->remote_addr() );
1594                 $session->param( 'lasttime',     time() );
1595                 $session->param( 'interface',    'api'  );
1596             }
1597             $session->param( 'cas_ticket', $cas_ticket);
1598             C4::Context->set_userenv(
1599                 $session->param('number'),       $session->param('id'),
1600                 $session->param('cardnumber'),   $session->param('firstname'),
1601                 $session->param('surname'),      $session->param('branch'),
1602                 $session->param('branchname'),   $session->param('flags'),
1603                 $session->param('emailaddress')
1604             );
1605             return ( "ok", $cookie, $sessionID );
1606         } else {
1607             return ( "failed", undef, undef );
1608         }
1609     }
1610 }
1611
1612 =head2 check_cookie_auth
1613
1614   ($status, $sessionId) = check_api_auth($cookie, $userflags);
1615
1616 Given a CGISESSID cookie set during a previous login to Koha, determine
1617 if the user has the privileges specified by C<$userflags>. C<$userflags>
1618 is passed unaltered into C<haspermission> and as such accepts all options
1619 avaiable to that routine with the one caveat that C<check_api_auth> will
1620 also allow 'undef' to be passed and in such a case the permissions check
1621 will be skipped altogether.
1622
1623 C<check_cookie_auth> is meant for authenticating special services
1624 such as tools/upload-file.pl that are invoked by other pages that
1625 have been authenticated in the usual way.
1626
1627 Possible return values in C<$status> are:
1628
1629 =over
1630
1631 =item "ok" -- user authenticated; C<$sessionID> have valid values.
1632
1633 =item "failed" -- credentials are not correct; C<$sessionid> are undef
1634
1635 =item "maintenance" -- DB is in maintenance mode; no login possible at the moment
1636
1637 =item "expired -- session cookie has expired; API user should resubmit userid and password
1638
1639 =back
1640
1641 =cut
1642
1643 sub check_cookie_auth {
1644     my $cookie        = shift;
1645     my $flagsrequired = shift;
1646     my $params        = shift;
1647
1648     my $remote_addr = $params->{remote_addr} || $ENV{REMOTE_ADDR};
1649     my $dbh     = C4::Context->dbh;
1650     my $timeout = _timeout_syspref();
1651
1652     unless ( C4::Context->preference('Version') ) {
1653
1654         # database has not been installed yet
1655         return ( "maintenance", undef );
1656     }
1657     my $kohaversion = Koha::version();
1658     $kohaversion =~ s/(.*\..*)\.(.*)\.(.*)/$1$2$3/;
1659     if ( C4::Context->preference('Version') < $kohaversion ) {
1660
1661         # database in need of version update; assume that
1662         # no API should be called while databsae is in
1663         # this condition.
1664         return ( "maintenance", undef );
1665     }
1666
1667     # FIXME -- most of what follows is a copy-and-paste
1668     # of code from checkauth.  There is an obvious need
1669     # for refactoring to separate the various parts of
1670     # the authentication code, but as of 2007-11-23 this
1671     # is deferred so as to not introduce bugs into the
1672     # regular authentication code for Koha 3.0.
1673
1674     # see if we have a valid session cookie already
1675     # however, if a userid parameter is present (i.e., from
1676     # a form submission, assume that any current cookie
1677     # is to be ignored
1678     unless ( defined $cookie and $cookie ) {
1679         return ( "failed", undef );
1680     }
1681     my $sessionID = $cookie;
1682     my $session   = get_session($sessionID);
1683     C4::Context->_new_userenv($sessionID);
1684     if ($session) {
1685         C4::Context->interface($session->param('interface'));
1686         C4::Context->set_userenv(
1687             $session->param('number'),       $session->param('id'),
1688             $session->param('cardnumber'),   $session->param('firstname'),
1689             $session->param('surname'),      $session->param('branch'),
1690             $session->param('branchname'),   $session->param('flags'),
1691             $session->param('emailaddress')
1692         );
1693
1694         my $ip       = $session->param('ip');
1695         my $lasttime = $session->param('lasttime');
1696         my $userid   = $session->param('id');
1697         if ( $lasttime < time() - $timeout ) {
1698
1699             # time out
1700             $session->delete();
1701             $session->flush;
1702             C4::Context->_unset_userenv($sessionID);
1703             $userid    = undef;
1704             $sessionID = undef;
1705             return ("expired", undef);
1706         } elsif ( C4::Context->preference('SessionRestrictionByIP') && $ip ne $remote_addr ) {
1707
1708             # IP address changed
1709             $session->delete();
1710             $session->flush;
1711             C4::Context->_unset_userenv($sessionID);
1712             $userid    = undef;
1713             $sessionID = undef;
1714             return ( "expired", undef );
1715         } else {
1716             $session->param( 'lasttime', time() );
1717             my $flags = defined($flagsrequired) ? haspermission( $userid, $flagsrequired ) : 1;
1718             if ($flags) {
1719                 return ( "ok", $sessionID );
1720             } else {
1721                 $session->delete();
1722                 $session->flush;
1723                 C4::Context->_unset_userenv($sessionID);
1724                 $userid    = undef;
1725                 $sessionID = undef;
1726                 return ( "failed", undef );
1727             }
1728         }
1729     } else {
1730         return ( "expired", undef );
1731     }
1732 }
1733
1734 =head2 get_session
1735
1736   use CGI::Session;
1737   my $session = get_session($sessionID);
1738
1739 Given a session ID, retrieve the CGI::Session object used to store
1740 the session's state.  The session object can be used to store
1741 data that needs to be accessed by different scripts during a
1742 user's session.
1743
1744 If the C<$sessionID> parameter is an empty string, a new session
1745 will be created.
1746
1747 =cut
1748
1749 sub _get_session_params {
1750     my $storage_method = C4::Context->preference('SessionStorage');
1751     if ( $storage_method eq 'mysql' ) {
1752         my $dbh = C4::Context->dbh;
1753         return { dsn => "driver:MySQL;serializer:yaml;id:md5", dsn_args => { Handle => $dbh } };
1754     }
1755     elsif ( $storage_method eq 'Pg' ) {
1756         my $dbh = C4::Context->dbh;
1757         return { dsn => "driver:PostgreSQL;serializer:yaml;id:md5", dsn_args => { Handle => $dbh } };
1758     }
1759     elsif ( $storage_method eq 'memcached' && Koha::Caches->get_instance->memcached_cache ) {
1760         my $memcached = Koha::Caches->get_instance()->memcached_cache;
1761         return { dsn => "driver:memcached;serializer:yaml;id:md5", dsn_args => { Memcached => $memcached } };
1762     }
1763     else {
1764         # catch all defaults to tmp should work on all systems
1765         my $dir = C4::Context::temporary_directory;
1766         my $instance = C4::Context->config( 'database' ); #actually for packages not exactly the instance name, but generally safer to leave it as it is
1767         return { dsn => "driver:File;serializer:yaml;id:md5", dsn_args => { Directory => "$dir/cgisess_$instance" } };
1768     }
1769 }
1770
1771 sub get_session {
1772     my $sessionID      = shift;
1773     my $params = _get_session_params();
1774     return new CGI::Session( $params->{dsn}, $sessionID, $params->{dsn_args} );
1775 }
1776
1777
1778 # FIXME no_set_userenv may be replaced with force_branchcode_for_userenv
1779 # (or something similar)
1780 # Currently it's only passed from C4::SIP::ILS::Patron::check_password, but
1781 # not having a userenv defined could cause a crash.
1782 sub checkpw {
1783     my ( $dbh, $userid, $password, $query, $type, $no_set_userenv ) = @_;
1784     $type = 'opac' unless $type;
1785
1786     # Get shibboleth login attribute
1787     my $shib = C4::Context->config('useshibboleth') && shib_ok();
1788     my $shib_login = $shib ? get_login_shib() : undef;
1789
1790     my @return;
1791     my $patron;
1792     if ( defined $userid ){
1793         $patron = Koha::Patrons->find({ userid => $userid });
1794         $patron = Koha::Patrons->find({ cardnumber => $userid }) unless $patron;
1795     }
1796     my $check_internal_as_fallback = 0;
1797     my $passwd_ok = 0;
1798     # Note: checkpw_* routines returns:
1799     # 1 if auth is ok
1800     # 0 if auth is nok
1801     # -1 if user bind failed (LDAP only)
1802
1803     if ( $patron and $patron->account_locked ) {
1804         # Nothing to check, account is locked
1805     } elsif ($ldap && defined($password)) {
1806         $debug and print STDERR "## checkpw - checking LDAP\n";
1807         my ( $retval, $retcard, $retuserid ) = checkpw_ldap(@_);    # EXTERNAL AUTH
1808         if ( $retval == 1 ) {
1809             @return = ( $retval, $retcard, $retuserid );
1810             $passwd_ok = 1;
1811         }
1812         $check_internal_as_fallback = 1 if $retval == 0;
1813
1814     } elsif ( $cas && $query && $query->param('ticket') ) {
1815         $debug and print STDERR "## checkpw - checking CAS\n";
1816
1817         # In case of a CAS authentication, we use the ticket instead of the password
1818         my $ticket = $query->param('ticket');
1819         $query->delete('ticket');                                   # remove ticket to come back to original URL
1820         my ( $retval, $retcard, $retuserid, $cas_ticket ) = checkpw_cas( $dbh, $ticket, $query, $type );    # EXTERNAL AUTH
1821         if ( $retval ) {
1822             @return = ( $retval, $retcard, $retuserid, $cas_ticket );
1823         } else {
1824             @return = (0);
1825         }
1826         $passwd_ok = $retval;
1827     }
1828
1829     # If we are in a shibboleth session (shibboleth is enabled, and a shibboleth match attribute is present)
1830     # Check for password to asertain whether we want to be testing against shibboleth or another method this
1831     # time around.
1832     elsif ( $shib && $shib_login && !$password ) {
1833
1834         $debug and print STDERR "## checkpw - checking Shibboleth\n";
1835
1836         # In case of a Shibboleth authentication, we expect a shibboleth user attribute
1837         # (defined under shibboleth mapping in koha-conf.xml) to contain the login of the
1838         # shibboleth-authenticated user
1839
1840         # Then, we check if it matches a valid koha user
1841         if ($shib_login) {
1842             my ( $retval, $retcard, $retuserid ) = C4::Auth_with_shibboleth::checkpw_shib($shib_login);    # EXTERNAL AUTH
1843             if ( $retval ) {
1844                 @return = ( $retval, $retcard, $retuserid );
1845             }
1846             $passwd_ok = $retval;
1847         }
1848     } else {
1849         $check_internal_as_fallback = 1;
1850     }
1851
1852     # INTERNAL AUTH
1853     if ( $check_internal_as_fallback ) {
1854         @return = checkpw_internal( $dbh, $userid, $password, $no_set_userenv);
1855         $passwd_ok = 1 if $return[0] > 0; # 1 or 2
1856     }
1857
1858     if( $patron ) {
1859         if ( $passwd_ok ) {
1860             $patron->update({ login_attempts => 0 });
1861         } elsif( !$patron->account_locked ) {
1862             $patron->update({ login_attempts => $patron->login_attempts + 1 });
1863         }
1864     }
1865     return @return;
1866 }
1867
1868 sub checkpw_internal {
1869     my ( $dbh, $userid, $password, $no_set_userenv ) = @_;
1870
1871     $password = Encode::encode( 'UTF-8', $password )
1872       if Encode::is_utf8($password);
1873
1874     my $sth =
1875       $dbh->prepare(
1876         "select password,cardnumber,borrowernumber,userid,firstname,surname,borrowers.branchcode,branches.branchname,flags from borrowers join branches on borrowers.branchcode=branches.branchcode where userid=?"
1877       );
1878     $sth->execute($userid);
1879     if ( $sth->rows ) {
1880         my ( $stored_hash, $cardnumber, $borrowernumber, $userid, $firstname,
1881             $surname, $branchcode, $branchname, $flags )
1882           = $sth->fetchrow;
1883
1884         if ( checkpw_hash( $password, $stored_hash ) ) {
1885
1886             C4::Context->set_userenv( "$borrowernumber", $userid, $cardnumber,
1887                 $firstname, $surname, $branchcode, $branchname, $flags ) unless $no_set_userenv;
1888             return 1, $cardnumber, $userid;
1889         }
1890     }
1891     $sth =
1892       $dbh->prepare(
1893         "select password,cardnumber,borrowernumber,userid,firstname,surname,borrowers.branchcode,branches.branchname,flags from borrowers join branches on borrowers.branchcode=branches.branchcode where cardnumber=?"
1894       );
1895     $sth->execute($userid);
1896     if ( $sth->rows ) {
1897         my ( $stored_hash, $cardnumber, $borrowernumber, $userid, $firstname,
1898             $surname, $branchcode, $branchname, $flags )
1899           = $sth->fetchrow;
1900
1901         if ( checkpw_hash( $password, $stored_hash ) ) {
1902
1903             C4::Context->set_userenv( $borrowernumber, $userid, $cardnumber,
1904                 $firstname, $surname, $branchcode, $branchname, $flags ) unless $no_set_userenv;
1905             return 1, $cardnumber, $userid;
1906         }
1907     }
1908     return 0;
1909 }
1910
1911 sub checkpw_hash {
1912     my ( $password, $stored_hash ) = @_;
1913
1914     return if $stored_hash eq '!';
1915
1916     # check what encryption algorithm was implemented: Bcrypt - if the hash starts with '$2' it is Bcrypt else md5
1917     my $hash;
1918     if ( substr( $stored_hash, 0, 2 ) eq '$2' ) {
1919         $hash = hash_password( $password, $stored_hash );
1920     } else {
1921         $hash = md5_base64($password);
1922     }
1923     return $hash eq $stored_hash;
1924 }
1925
1926 =head2 getuserflags
1927
1928     my $authflags = getuserflags($flags, $userid, [$dbh]);
1929
1930 Translates integer flags into permissions strings hash.
1931
1932 C<$flags> is the integer userflags value ( borrowers.userflags )
1933 C<$userid> is the members.userid, used for building subpermissions
1934 C<$authflags> is a hashref of permissions
1935
1936 =cut
1937
1938 sub getuserflags {
1939     my $flags  = shift;
1940     my $userid = shift;
1941     my $dbh    = @_ ? shift : C4::Context->dbh;
1942     my $userflags;
1943     {
1944         # I don't want to do this, but if someone logs in as the database
1945         # user, it would be preferable not to spam them to death with
1946         # numeric warnings. So, we make $flags numeric.
1947         no warnings 'numeric';
1948         $flags += 0;
1949     }
1950     my $sth = $dbh->prepare("SELECT bit, flag, defaulton FROM userflags");
1951     $sth->execute;
1952
1953     while ( my ( $bit, $flag, $defaulton ) = $sth->fetchrow ) {
1954         if ( ( $flags & ( 2**$bit ) ) || $defaulton ) {
1955             $userflags->{$flag} = 1;
1956         }
1957         else {
1958             $userflags->{$flag} = 0;
1959         }
1960     }
1961
1962     # get subpermissions and merge with top-level permissions
1963     my $user_subperms = get_user_subpermissions($userid);
1964     foreach my $module ( keys %$user_subperms ) {
1965         next if $userflags->{$module} == 1;    # user already has permission for everything in this module
1966         $userflags->{$module} = $user_subperms->{$module};
1967     }
1968
1969     return $userflags;
1970 }
1971
1972 =head2 get_user_subpermissions
1973
1974   $user_perm_hashref = get_user_subpermissions($userid);
1975
1976 Given the userid (note, not the borrowernumber) of a staff user,
1977 return a hashref of hashrefs of the specific subpermissions
1978 accorded to the user.  An example return is
1979
1980  {
1981     tools => {
1982         export_catalog => 1,
1983         import_patrons => 1,
1984     }
1985  }
1986
1987 The top-level hash-key is a module or function code from
1988 userflags.flag, while the second-level key is a code
1989 from permissions.
1990
1991 The results of this function do not give a complete picture
1992 of the functions that a staff user can access; it is also
1993 necessary to check borrowers.flags.
1994
1995 =cut
1996
1997 sub get_user_subpermissions {
1998     my $userid = shift;
1999
2000     my $dbh = C4::Context->dbh;
2001     my $sth = $dbh->prepare( "SELECT flag, user_permissions.code
2002                              FROM user_permissions
2003                              JOIN permissions USING (module_bit, code)
2004                              JOIN userflags ON (module_bit = bit)
2005                              JOIN borrowers USING (borrowernumber)
2006                              WHERE userid = ?" );
2007     $sth->execute($userid);
2008
2009     my $user_perms = {};
2010     while ( my $perm = $sth->fetchrow_hashref ) {
2011         $user_perms->{ $perm->{'flag'} }->{ $perm->{'code'} } = 1;
2012     }
2013     return $user_perms;
2014 }
2015
2016 =head2 get_all_subpermissions
2017
2018   my $perm_hashref = get_all_subpermissions();
2019
2020 Returns a hashref of hashrefs defining all specific
2021 permissions currently defined.  The return value
2022 has the same structure as that of C<get_user_subpermissions>,
2023 except that the innermost hash value is the description
2024 of the subpermission.
2025
2026 =cut
2027
2028 sub get_all_subpermissions {
2029     my $dbh = C4::Context->dbh;
2030     my $sth = $dbh->prepare( "SELECT flag, code
2031                              FROM permissions
2032                              JOIN userflags ON (module_bit = bit)" );
2033     $sth->execute();
2034
2035     my $all_perms = {};
2036     while ( my $perm = $sth->fetchrow_hashref ) {
2037         $all_perms->{ $perm->{'flag'} }->{ $perm->{'code'} } = 1;
2038     }
2039     return $all_perms;
2040 }
2041
2042 =head2 haspermission
2043
2044   $flagsrequired = '*';                                 # Any permission at all
2045   $flagsrequired = 'a_flag';                            # a_flag must be satisfied (all subpermissions)
2046   $flagsrequired = [ 'a_flag', 'b_flag' ];              # a_flag OR b_flag must be satisfied
2047   $flagsrequired = { 'a_flag => 1, 'b_flag' => 1 };     # a_flag AND b_flag must be satisfied
2048   $flagsrequired = { 'a_flag' => 'sub_a' };             # sub_a of a_flag must be satisfied
2049   $flagsrequired = { 'a_flag' => [ 'sub_a, 'sub_b' ] }; # sub_a OR sub_b of a_flag must be satisfied
2050
2051   $flags = ($userid, $flagsrequired);
2052
2053 C<$userid> the userid of the member
2054 C<$flags> is a query structure similar to that used by SQL::Abstract that
2055 denotes the combination of flags required. It is a required parameter.
2056
2057 The main logic of this method is that things in arrays are OR'ed, and things
2058 in hashes are AND'ed. The `*` character can be used, at any depth, to denote `ANY`
2059
2060 Returns member's flags or 0 if a permission is not met.
2061
2062 =cut
2063
2064 sub _dispatch {
2065     my ($required, $flags) = @_;
2066
2067     my $ref = ref($required);
2068     if ($ref eq '') {
2069         if ($required eq '*') {
2070             return 0 unless ( $flags or ref( $flags ) );
2071         } else {
2072             return 0 unless ( $flags and (!ref( $flags ) || $flags->{$required} ));
2073         }
2074     } elsif ($ref eq 'HASH') {
2075         foreach my $key (keys %{$required}) {
2076             next if $flags == 1;
2077             my $require = $required->{$key};
2078             my $rflags  = $flags->{$key};
2079             return 0 unless _dispatch($require, $rflags);
2080         }
2081     } elsif ($ref eq 'ARRAY') {
2082         my $satisfied = 0;
2083         foreach my $require ( @{$required} ) {
2084             my $rflags =
2085               ( ref($flags) && !ref($require) && ( $require ne '*' ) )
2086               ? $flags->{$require}
2087               : $flags;
2088             $satisfied++ if _dispatch( $require, $rflags );
2089         }
2090         return 0 unless $satisfied;
2091     } else {
2092         croak "Unexpected structure found: $ref";
2093     }
2094
2095     return $flags;
2096 };
2097
2098 sub haspermission {
2099     my ( $userid, $flagsrequired ) = @_;
2100
2101     #Koha::Exceptions::WrongParameter->throw('$flagsrequired should not be undef')
2102     #  unless defined($flagsrequired);
2103
2104     my $sth = C4::Context->dbh->prepare("SELECT flags FROM borrowers WHERE userid=?");
2105     $sth->execute($userid);
2106     my $row = $sth->fetchrow();
2107     my $flags = getuserflags( $row, $userid );
2108
2109     return $flags unless defined($flagsrequired);
2110     return $flags if $flags->{superlibrarian};
2111     return _dispatch($flagsrequired, $flags);
2112
2113     #FIXME - This fcn should return the failed permission so a suitable error msg can be delivered.
2114 }
2115
2116 =head2 in_iprange
2117
2118   $flags = ($iprange);
2119
2120 C<$iprange> A space separated string describing an IP range. Can include single IPs or ranges
2121
2122 Returns 1 if the remote address is in the provided iprange, or 0 otherwise.
2123
2124 =cut
2125
2126 sub in_iprange {
2127     my ($iprange) = @_;
2128     my $result = 1;
2129     my @allowedipranges = $iprange ? split(' ', $iprange) : ();
2130     if (scalar @allowedipranges > 0) {
2131         my @rangelist;
2132         eval { @rangelist = Net::CIDR::range2cidr(@allowedipranges); }; return 0 if $@;
2133         eval { $result = Net::CIDR::cidrlookup($ENV{'REMOTE_ADDR'}, @rangelist) } || ( $ENV{DEBUG} && warn 'cidrlookup failed for ' . join(' ',@rangelist) );
2134      }
2135      return $result ? 1 : 0;
2136 }
2137
2138 sub getborrowernumber {
2139     my ($userid) = @_;
2140     my $userenv = C4::Context->userenv;
2141     if ( defined($userenv) && ref($userenv) eq 'HASH' && $userenv->{number} ) {
2142         return $userenv->{number};
2143     }
2144     my $dbh = C4::Context->dbh;
2145     for my $field ( 'userid', 'cardnumber' ) {
2146         my $sth =
2147           $dbh->prepare("select borrowernumber from borrowers where $field=?");
2148         $sth->execute($userid);
2149         if ( $sth->rows ) {
2150             my ($bnumber) = $sth->fetchrow;
2151             return $bnumber;
2152         }
2153     }
2154     return 0;
2155 }
2156
2157 =head2 track_login_daily
2158
2159     track_login_daily( $userid );
2160
2161 Wraps the call to $patron->track_login, the method used to update borrowers.lastseen. We only call track_login once a day.
2162
2163 =cut
2164
2165 sub track_login_daily {
2166     my $userid = shift;
2167     return if !$userid || !C4::Context->preference('TrackLastPatronActivity');
2168
2169     my $cache     = Koha::Caches->get_instance();
2170     my $cache_key = "track_login_" . $userid;
2171     my $cached    = $cache->get_from_cache($cache_key);
2172     my $today = dt_from_string()->ymd;
2173     return if $cached && $cached eq $today;
2174
2175     my $patron = Koha::Patrons->find({ userid => $userid });
2176     return unless $patron;
2177     $patron->track_login;
2178     $cache->set_in_cache( $cache_key, $today );
2179 }
2180
2181 END { }    # module clean-up code here (global destructor)
2182 1;
2183 __END__
2184
2185 =head1 SEE ALSO
2186
2187 CGI(3)
2188
2189 C4::Output(3)
2190
2191 Crypt::Eksblowfish::Bcrypt(3)
2192
2193 Digest::MD5(3)
2194
2195 =cut