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