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