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