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