koha-dev.rot13.org Git - koha_ffzg/blob - C4/Auth.pm

   1 package C4::Auth;
   2
   3 # Copyright 2000-2002 Katipo Communications
   4 #
   5 # This file is part of Koha.
   6 #
   7 # Koha is free software; you can redistribute it and/or modify it
   8 # under the terms of the GNU General Public License as published by
   9 # the Free Software Foundation; either version 3 of the License, or
  10 # (at your option) any later version.
  11 #
  12 # Koha is distributed in the hope that it will be useful, but
  13 # WITHOUT ANY WARRANTY; without even the implied warranty of
  14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  15 # GNU General Public License for more details.
  16 #
  17 # You should have received a copy of the GNU General Public License
  18 # along with Koha; if not, see <http://www.gnu.org/licenses>.
  19
  20 use strict;
  21 use warnings;
  22 use 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                $in->{template_name} !~ m|sci/|
 200             && $user
 201             && haspermission( $user, { self_check => 'self_checkin_module' } )
 202             && !(
 203                 $in->{template_name} =~ m|sco/| && haspermission(
 204                     $user, { self_check => 'self_checkout_module' }
 205                 )
 206             )
 207           )
 208         {
 209             $kick_out = 1;
 210         }
 211
 212         if ($kick_out) {
 213             $template = C4::Templates::gettemplate( 'opac-auth.tt', 'opac',
 214                 $in->{query} );
 215             $cookie = $in->{query}->cookie(
 216                 -name     => 'CGISESSID',
 217                 -value    => '',
 218                 -expires  => '',
 219                 -HttpOnly => 1,
 220             );
 221
 222             $template->param(
 223                 loginprompt => 1,
 224                 script_name => get_script_name(),
 225             );
 226
 227             print $in->{query}->header(
 228                 {
 229                     type              => 'text/html',
 230                     charset           => 'utf-8',
 231                     cookie            => $cookie,
 232                     'X-Frame-Options' => 'SAMEORIGIN'
 233                 }
 234               ),
 235               $template->output;
 236             safe_exit;
 237         }
 238     }
 239
 240     my $borrowernumber;
 241     if ($user) {
 242
 243         # It's possible for $user to be the borrowernumber if they don't have a
 244         # userid defined (and are logging in through some other method, such
 245         # as SSL certs against an email address)
 246         my $patron;
 247         $borrowernumber = getborrowernumber($user) if defined($user);
 248         if ( !defined($borrowernumber) && defined($user) ) {
 249             $patron = Koha::Patrons->find( $user );
 250             if ($patron) {
 251                 $borrowernumber = $user;
 252
 253                 # A bit of a hack, but I don't know there's a nicer way
 254                 # to do it.
 255                 $user = $patron->firstname . ' ' . $patron->surname;
 256             }
 257         } else {
 258             $patron = Koha::Patrons->find( $borrowernumber );
 259             # FIXME What to do if $patron does not exist?
 260         }
 261
 262         # user info
 263         $template->param( loggedinusername   => $user ); # FIXME Should be replaced with something like patron-title.inc
 264         $template->param( loggedinusernumber => $borrowernumber ); # FIXME Should be replaced with logged_in_user.borrowernumber
 265         $template->param( logged_in_user     => $patron );
 266         $template->param( sessionID          => $sessionID );
 267
 268         if ( $in->{'type'} eq 'opac' ) {
 269             require Koha::Virtualshelves;
 270             my $some_private_shelves = Koha::Virtualshelves->get_some_shelves(
 271                 {
 272                     borrowernumber => $borrowernumber,
 273                     category       => 1,
 274                 }
 275             );
 276             my $some_public_shelves = Koha::Virtualshelves->get_some_shelves(
 277                 {
 278                     category       => 2,
 279                 }
 280             );
 281             $template->param(
 282                 some_private_shelves => $some_private_shelves,
 283                 some_public_shelves  => $some_public_shelves,
 284             );
 285         }
 286
 287         $template->param( "USER_INFO" => $patron->unblessed ) if $borrowernumber != 0;
 288
 289         my $all_perms = get_all_subpermissions();
 290
 291         my @flagroots = qw(circulate catalogue parameters borrowers permissions reserveforothers borrow
 292           editcatalogue updatecharges management tools editauthorities serials reports acquisition clubs);
 293
 294         # We are going to use the $flags returned by checkauth
 295         # to create the template's parameters that will indicate
 296         # which menus the user can access.
 297         if ( $flags && $flags->{superlibrarian} == 1 ) {
 298             $template->param( CAN_user_circulate        => 1 );
 299             $template->param( CAN_user_catalogue        => 1 );
 300             $template->param( CAN_user_parameters       => 1 );
 301             $template->param( CAN_user_borrowers        => 1 );
 302             $template->param( CAN_user_permissions      => 1 );
 303             $template->param( CAN_user_reserveforothers => 1 );
 304             $template->param( CAN_user_editcatalogue    => 1 );
 305             $template->param( CAN_user_updatecharges    => 1 );
 306             $template->param( CAN_user_acquisition      => 1 );
 307             $template->param( CAN_user_management       => 1 );
 308             $template->param( CAN_user_tools            => 1 );
 309             $template->param( CAN_user_editauthorities  => 1 );
 310             $template->param( CAN_user_serials          => 1 );
 311             $template->param( CAN_user_reports          => 1 );
 312             $template->param( CAN_user_staffaccess      => 1 );
 313             $template->param( CAN_user_plugins          => 1 );
 314             $template->param( CAN_user_coursereserves   => 1 );
 315             $template->param( CAN_user_clubs            => 1 );
 316
 317             foreach my $module ( keys %$all_perms ) {
 318                 foreach my $subperm ( keys %{ $all_perms->{$module} } ) {
 319                     $template->param( "CAN_user_${module}_${subperm}" => 1 );
 320                 }
 321             }
 322         }
 323
 324         if ($flags) {
 325             foreach my $module ( keys %$all_perms ) {
 326                 if ( defined($flags->{$module}) && $flags->{$module} == 1 ) {
 327                     foreach my $subperm ( keys %{ $all_perms->{$module} } ) {
 328                         $template->param( "CAN_user_${module}_${subperm}" => 1 );
 329                     }
 330                 } elsif ( ref( $flags->{$module} ) ) {
 331                     foreach my $subperm ( keys %{ $flags->{$module} } ) {
 332                         $template->param( "CAN_user_${module}_${subperm}" => 1 );
 333                     }
 334                 }
 335             }
 336         }
 337
 338         if ($flags) {
 339             foreach my $module ( keys %$flags ) {
 340                 if ( $flags->{$module} == 1 or ref( $flags->{$module} ) ) {
 341                     $template->param( "CAN_user_$module" => 1 );
 342                     if ( $module eq "parameters" ) {
 343                         $template->param( CAN_user_management => 1 );
 344                     }
 345                 }
 346             }
 347         }
 348
 349         # Logged-in opac search history
 350         # If the requested template is an opac one and opac search history is enabled
 351         if ( $in->{type} eq 'opac' && C4::Context->preference('EnableOpacSearchHistory') ) {
 352             my $dbh   = C4::Context->dbh;
 353             my $query = "SELECT COUNT(*) FROM search_history WHERE userid=?";
 354             my $sth   = $dbh->prepare($query);
 355             $sth->execute($borrowernumber);
 356
 357             # If at least one search has already been performed
 358             if ( $sth->fetchrow_array > 0 ) {
 359
 360                 # We show the link in opac
 361                 $template->param( EnableOpacSearchHistory => 1 );
 362             }
 363             if (C4::Context->preference('LoadSearchHistoryToTheFirstLoggedUser'))
 364             {
 365                 # And if there are searches performed when the user was not logged in,
 366                 # we add them to the logged-in search history
 367                 my @recentSearches = C4::Search::History::get_from_session( { cgi => $in->{'query'} } );
 368                 if (@recentSearches) {
 369                     my $dbh   = C4::Context->dbh;
 370                     my $query = q{
 371                         INSERT INTO search_history(userid, sessionid, query_desc, query_cgi, type,  total, time )
 372                         VALUES (?, ?, ?, ?, ?, ?, ?)
 373                     };
 374                     my $sth = $dbh->prepare($query);
 375                     $sth->execute( $borrowernumber,
 376                         $in->{query}->cookie("CGISESSID"),
 377                         $_->{query_desc},
 378                         $_->{query_cgi},
 379                         $_->{type} || 'biblio',
 380                         $_->{total},
 381                         $_->{time},
 382                     ) foreach @recentSearches;
 383
 384                     # clear out the search history from the session now that
 385                     # we've saved it to the database
 386                  }
 387               }
 388               C4::Search::History::set_to_session( { cgi => $in->{'query'}, search_history => [] } );
 389
 390         } elsif ( $in->{type} eq 'intranet' and C4::Context->preference('EnableSearchHistory') ) {
 391             $template->param( EnableSearchHistory => 1 );
 392         }
 393     }
 394     else {    # if this is an anonymous session, setup to display public lists...
 395
 396         # If shibboleth is enabled, and we're in an anonymous session, we should allow
 397         # the user to attempt login via shibboleth.
 398         if ($shib) {
 399             $template->param( shibbolethAuthentication => $shib,
 400                 shibbolethLoginUrl => login_shib_url( $in->{'query'} ),
 401             );
 402
 403             # If shibboleth is enabled and we have a shibboleth login attribute,
 404             # but we are in an anonymous session, then we clearly have an invalid
 405             # shibboleth koha account.
 406             if ($shib_login) {
 407                 $template->param( invalidShibLogin => '1' );
 408             }
 409         }
 410
 411         $template->param( sessionID => $sessionID );
 412
 413         if ( $in->{'type'} eq 'opac' ){
 414             require Koha::Virtualshelves;
 415             my $some_public_shelves = Koha::Virtualshelves->get_some_shelves(
 416                 {
 417                     category       => 2,
 418                 }
 419             );
 420             $template->param(
 421                 some_public_shelves  => $some_public_shelves,
 422             );
 423         }
 424     }
 425
 426     # Anonymous opac search history
 427     # If opac search history is enabled and at least one search has already been performed
 428     if ( C4::Context->preference('EnableOpacSearchHistory') ) {
 429         my @recentSearches = C4::Search::History::get_from_session( { cgi => $in->{'query'} } );
 430         if (@recentSearches) {
 431             $template->param( EnableOpacSearchHistory => 1 );
 432         }
 433     }
 434
 435     if ( C4::Context->preference('dateformat') ) {
 436         $template->param( dateformat => C4::Context->preference('dateformat') );
 437     }
 438
 439     $template->param(auth_forwarded_hash => scalar $in->{'query'}->param('auth_forwarded_hash'));
 440
 441     # these template parameters are set the same regardless of $in->{'type'}
 442
 443     # Set the using_https variable for templates
 444     # FIXME Under Plack the CGI->https method always returns 'OFF'
 445     my $https = $in->{query}->https();
 446     my $using_https = ( defined $https and $https ne 'OFF' ) ? 1 : 0;
 447
 448     my $minPasswordLength = C4::Context->preference('minPasswordLength');
 449     $minPasswordLength = 3 if not $minPasswordLength or $minPasswordLength < 3;
 450     $template->param(
 451         "BiblioDefaultView" . C4::Context->preference("BiblioDefaultView") => 1,
 452         EnhancedMessagingPreferences                                       => C4::Context->preference('EnhancedMessagingPreferences'),
 453         GoogleJackets                                                      => C4::Context->preference("GoogleJackets"),
 454         OpenLibraryCovers                                                  => C4::Context->preference("OpenLibraryCovers"),
 455         KohaAdminEmailAddress                                              => "" . C4::Context->preference("KohaAdminEmailAddress"),
 456         LoginBranchcode => ( C4::Context->userenv ? C4::Context->userenv->{"branch"}    : undef ),
 457         LoginFirstname  => ( C4::Context->userenv ? C4::Context->userenv->{"firstname"} : "Bel" ),
 458         LoginSurname    => C4::Context->userenv ? C4::Context->userenv->{"surname"}      : "Inconnu",
 459         emailaddress    => C4::Context->userenv ? C4::Context->userenv->{"emailaddress"} : undef,
 460         TagsEnabled     => C4::Context->preference("TagsEnabled"),
 461         hide_marc       => C4::Context->preference("hide_marc"),
 462         item_level_itypes  => C4::Context->preference('item-level_itypes'),
 463         patronimages       => C4::Context->preference("patronimages"),
 464         singleBranchMode   => ( Koha::Libraries->search->count == 1 ),
 465         XSLTDetailsDisplay => C4::Context->preference("XSLTDetailsDisplay"),
 466         XSLTResultsDisplay => C4::Context->preference("XSLTResultsDisplay"),
 467         using_https        => $using_https,
 468         noItemTypeImages   => C4::Context->preference("noItemTypeImages"),
 469         marcflavour        => C4::Context->preference("marcflavour"),
 470         OPACBaseURL        => C4::Context->preference('OPACBaseURL'),
 471         minPasswordLength  => $minPasswordLength,
 472     );
 473     if ( $in->{'type'} eq "intranet" ) {
 474         $template->param(
 475             AmazonCoverImages                                                          => C4::Context->preference("AmazonCoverImages"),
 476             AutoLocation                                                               => C4::Context->preference("AutoLocation"),
 477             "BiblioDefaultView" . C4::Context->preference("IntranetBiblioDefaultView") => 1,
 478             CircAutocompl                                                              => C4::Context->preference("CircAutocompl"),
 479             FRBRizeEditions                                                            => C4::Context->preference("FRBRizeEditions"),
 480             IndependentBranches                                                        => C4::Context->preference("IndependentBranches"),
 481             IntranetNav                                                                => C4::Context->preference("IntranetNav"),
 482             IntranetmainUserblock                                                      => C4::Context->preference("IntranetmainUserblock"),
 483             LibraryName                                                                => C4::Context->preference("LibraryName"),
 484             LoginBranchname                                                            => ( C4::Context->userenv ? C4::Context->userenv->{"branchname"} : undef ),
 485             advancedMARCEditor                                                         => C4::Context->preference("advancedMARCEditor"),
 486             canreservefromotherbranches                                                => C4::Context->preference('canreservefromotherbranches'),
 487             intranetcolorstylesheet                                                    => C4::Context->preference("intranetcolorstylesheet"),
 488             IntranetFavicon                                                            => C4::Context->preference("IntranetFavicon"),
 489             intranetreadinghistory                                                     => C4::Context->preference("intranetreadinghistory"),
 490             intranetstylesheet                                                         => C4::Context->preference("intranetstylesheet"),
 491             IntranetUserCSS                                                            => C4::Context->preference("IntranetUserCSS"),
 492             IntranetUserJS                                                             => C4::Context->preference("IntranetUserJS"),
 493             intranetbookbag                                                            => C4::Context->preference("intranetbookbag"),
 494             suggestion                                                                 => C4::Context->preference("suggestion"),
 495             virtualshelves                                                             => C4::Context->preference("virtualshelves"),
 496             StaffSerialIssueDisplayCount                                               => C4::Context->preference("StaffSerialIssueDisplayCount"),
 497             EasyAnalyticalRecords                                                      => C4::Context->preference('EasyAnalyticalRecords'),
 498             LocalCoverImages                                                           => C4::Context->preference('LocalCoverImages'),
 499             OPACLocalCoverImages                                                       => C4::Context->preference('OPACLocalCoverImages'),
 500             AllowMultipleCovers                                                        => C4::Context->preference('AllowMultipleCovers'),
 501             EnableBorrowerFiles                                                        => C4::Context->preference('EnableBorrowerFiles'),
 502             UseKohaPlugins                                                             => C4::Context->preference('UseKohaPlugins'),
 503             UseCourseReserves                                                          => C4::Context->preference("UseCourseReserves"),
 504             useDischarge                                                               => C4::Context->preference('useDischarge'),
 505             KOHA_VERSION                                                               => C4::Context->preference('Version'),
 506         );
 507     }
 508     else {
 509         warn "template type should be OPAC, here it is=[" . $in->{'type'} . "]" unless ( $in->{'type'} eq 'opac' );
 510
 511         #TODO : replace LibraryName syspref with 'system name', and remove this html processing
 512         my $LibraryNameTitle = C4::Context->preference("LibraryName");
 513         $LibraryNameTitle =~ s/<(?:\/?)(?:br|p)\s*(?:\/?)>/ /sgi;
 514         $LibraryNameTitle =~ s/<(?:[^<>'"]|'(?:[^']*)'|"(?:[^"]*)")*>//sg;
 515
 516         # clean up the busc param in the session
 517         # if the page is not opac-detail and not the "add to list" page
 518         # and not the "edit comments" page
 519         if ( C4::Context->preference("OpacBrowseResults")
 520             && $in->{'template_name'} =~ /opac-(.+)\.(?:tt|tmpl)$/ ) {
 521             my $pagename = $1;
 522             unless ( $pagename =~ /^(?:MARC|ISBD)?detail$/
 523                 or $pagename =~ /^addbybiblionumber$/
 524                 or $pagename =~ /^review$/ ) {
 525                 my $sessionSearch = get_session( $sessionID || $in->{'query'}->cookie("CGISESSID") );
 526                 $sessionSearch->clear( ["busc"] ) if ( $sessionSearch->param("busc") );
 527             }
 528         }
 529
 530         # variables passed from CGI: opac_css_override and opac_search_limits.
 531         my $opac_search_limit   = $ENV{'OPAC_SEARCH_LIMIT'};
 532         my $opac_limit_override = $ENV{'OPAC_LIMIT_OVERRIDE'};
 533         my $opac_name           = '';
 534         if (
 535             ( $opac_limit_override && $opac_search_limit && $opac_search_limit =~ /branch:(\w+)/ ) ||
 536             ( $in->{'query'}->param('limit') && $in->{'query'}->param('limit') =~ /branch:(\w+)/ ) ||
 537             ( $in->{'query'}->param('multibranchlimit') && $in->{'query'}->param('multibranchlimit') =~ /multibranchlimit-(\w+)/ )
 538           ) {
 539             $opac_name = $1;    # opac_search_limit is a branch, so we use it.
 540         } elsif ( $in->{'query'}->param('multibranchlimit') ) {
 541             $opac_name = $in->{'query'}->param('multibranchlimit');
 542         } elsif ( C4::Context->preference("SearchMyLibraryFirst") && C4::Context->userenv && C4::Context->userenv->{'branch'} ) {
 543             $opac_name = C4::Context->userenv->{'branch'};
 544         }
 545
 546         my @search_groups = Koha::Library::Groups->get_search_groups({ interface => 'opac' });
 547         $template->param(
 548             OpacAdditionalStylesheet                   => C4::Context->preference("OpacAdditionalStylesheet"),
 549             AnonSuggestions                       => "" . C4::Context->preference("AnonSuggestions"),
 550             LibrarySearchGroups                   => \@search_groups,
 551             opac_name                             => $opac_name,
 552             LibraryName                           => "" . C4::Context->preference("LibraryName"),
 553             LibraryNameTitle                      => "" . $LibraryNameTitle,
 554             LoginBranchname                       => C4::Context->userenv ? C4::Context->userenv->{"branchname"} : "",
 555             OPACAmazonCoverImages                 => C4::Context->preference("OPACAmazonCoverImages"),
 556             OPACFRBRizeEditions                   => C4::Context->preference("OPACFRBRizeEditions"),
 557             OpacHighlightedWords                  => C4::Context->preference("OpacHighlightedWords"),
 558             OPACShelfBrowser                      => "" . C4::Context->preference("OPACShelfBrowser"),
 559             OPACURLOpenInNewWindow                => "" . C4::Context->preference("OPACURLOpenInNewWindow"),
 560             OPACUserCSS                           => "" . C4::Context->preference("OPACUserCSS"),
 561             OpacAuthorities                       => C4::Context->preference("OpacAuthorities"),
 562             opac_css_override                     => $ENV{'OPAC_CSS_OVERRIDE'},
 563             opac_search_limit                     => $opac_search_limit,
 564             opac_limit_override                   => $opac_limit_override,
 565             OpacBrowser                           => C4::Context->preference("OpacBrowser"),
 566             OpacCloud                             => C4::Context->preference("OpacCloud"),
 567             OpacKohaUrl                           => C4::Context->preference("OpacKohaUrl"),
 568             OpacMainUserBlock                     => "" . C4::Context->preference("OpacMainUserBlock"),
 569             OpacNav                               => "" . C4::Context->preference("OpacNav"),
 570             OpacNavRight                          => "" . C4::Context->preference("OpacNavRight"),
 571             OpacNavBottom                         => "" . C4::Context->preference("OpacNavBottom"),
 572             OpacPasswordChange                    => C4::Context->preference("OpacPasswordChange"),
 573             OPACPatronDetails                     => C4::Context->preference("OPACPatronDetails"),
 574             OPACPrivacy                           => C4::Context->preference("OPACPrivacy"),
 575             OPACFinesTab                          => C4::Context->preference("OPACFinesTab"),
 576             OpacTopissue                          => C4::Context->preference("OpacTopissue"),
 577             RequestOnOpac                         => C4::Context->preference("RequestOnOpac"),
 578             'Version'                             => C4::Context->preference('Version'),
 579             KOHA_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         KOHA_VERSION                          => C4::Context->preference('Version'),
1297     );
1298
1299     $template->param( SCO_login => 1 ) if ( $query->param('sco_user_login') );
1300     $template->param( SCI_login => 1 ) if ( $query->param('sci_user_login') );
1301     $template->param( OpacPublic => C4::Context->preference("OpacPublic") );
1302     $template->param( loginprompt => 1 ) unless $info{'nopermission'};
1303
1304     if ( $type eq 'opac' ) {
1305         require Koha::Virtualshelves;
1306         my $some_public_shelves = Koha::Virtualshelves->get_some_shelves(
1307             {
1308                 category       => 2,
1309             }
1310         );
1311         $template->param(
1312             some_public_shelves  => $some_public_shelves,
1313         );
1314     }
1315
1316     if ($cas) {
1317
1318         # Is authentication against multiple CAS servers enabled?
1319         if ( C4::Auth_with_cas::multipleAuth && !$casparam ) {
1320             my $casservers = C4::Auth_with_cas::getMultipleAuth();
1321             my @tmplservers;
1322             foreach my $key ( keys %$casservers ) {
1323                 push @tmplservers, { name => $key, value => login_cas_url( $query, $key, $type ) . "?cas=$key" };
1324             }
1325             $template->param(
1326                 casServersLoop => \@tmplservers
1327             );
1328         } else {
1329             $template->param(
1330                 casServerUrl => login_cas_url($query, undef, $type),
1331             );
1332         }
1333
1334         $template->param(
1335             invalidCasLogin => $info{'invalidCasLogin'}
1336         );
1337     }
1338
1339     if ($shib) {
1340         $template->param(
1341             shibbolethAuthentication => $shib,
1342             shibbolethLoginUrl       => login_shib_url($query),
1343         );
1344     }
1345
1346     if (C4::Context->preference('GoogleOpenIDConnect')) {
1347         if ($query->param("OpenIDConnectFailed")) {
1348             my $reason = $query->param('OpenIDConnectFailed');
1349             $template->param(invalidGoogleOpenIDConnectLogin => $reason);
1350         }
1351     }
1352
1353     $template->param(
1354         LibraryName => C4::Context->preference("LibraryName"),
1355     );
1356     $template->param(%info);
1357
1358     #    $cookie = $query->cookie(CGISESSID => $session->id
1359     #   );
1360     print $query->header(
1361         {   type              => 'text/html',
1362             charset           => 'utf-8',
1363             cookie            => $cookie,
1364             'X-Frame-Options' => 'SAMEORIGIN'
1365         }
1366       ),
1367       $template->output;
1368     safe_exit;
1369 }
1370
1371 =head2 check_api_auth
1372
1373   ($status, $cookie, $sessionId) = check_api_auth($query, $userflags);
1374
1375 Given a CGI query containing the parameters 'userid' and 'password' and/or a session
1376 cookie, determine if the user has the privileges specified by C<$userflags>.
1377
1378 C<check_api_auth> is is meant for authenticating users of web services, and
1379 consequently will always return and will not attempt to redirect the user
1380 agent.
1381
1382 If a valid session cookie is already present, check_api_auth will return a status
1383 of "ok", the cookie, and the Koha session ID.
1384
1385 If no session cookie is present, check_api_auth will check the 'userid' and 'password
1386 parameters and create a session cookie and Koha session if the supplied credentials
1387 are OK.
1388
1389 Possible return values in C<$status> are:
1390
1391 =over
1392
1393 =item "ok" -- user authenticated; C<$cookie> and C<$sessionid> have valid values.
1394
1395 =item "failed" -- credentials are not correct; C<$cookie> and C<$sessionid> are undef
1396
1397 =item "maintenance" -- DB is in maintenance mode; no login possible at the moment
1398
1399 =item "expired -- session cookie has expired; API user should resubmit userid and password
1400
1401 =back
1402
1403 =cut
1404
1405 sub check_api_auth {
1406
1407     my $query         = shift;
1408     my $flagsrequired = shift;
1409     my $dbh     = C4::Context->dbh;
1410     my $timeout = _timeout_syspref();
1411
1412     unless ( C4::Context->preference('Version') ) {
1413
1414         # database has not been installed yet
1415         return ( "maintenance", undef, undef );
1416     }
1417     my $kohaversion = Koha::version();
1418     $kohaversion =~ s/(.*\..*)\.(.*)\.(.*)/$1$2$3/;
1419     if ( C4::Context->preference('Version') < $kohaversion ) {
1420
1421         # database in need of version update; assume that
1422         # no API should be called while databsae is in
1423         # this condition.
1424         return ( "maintenance", undef, undef );
1425     }
1426
1427     # FIXME -- most of what follows is a copy-and-paste
1428     # of code from checkauth.  There is an obvious need
1429     # for refactoring to separate the various parts of
1430     # the authentication code, but as of 2007-11-19 this
1431     # is deferred so as to not introduce bugs into the
1432     # regular authentication code for Koha 3.0.
1433
1434     # see if we have a valid session cookie already
1435     # however, if a userid parameter is present (i.e., from
1436     # a form submission, assume that any current cookie
1437     # is to be ignored
1438     my $sessionID = undef;
1439     unless ( $query->param('userid') ) {
1440         $sessionID = $query->cookie("CGISESSID");
1441     }
1442     if ( $sessionID && not( $cas && $query->param('PT') ) ) {
1443         my $session = get_session($sessionID);
1444         C4::Context->_new_userenv($sessionID);
1445         if ($session) {
1446             C4::Context->set_userenv(
1447                 $session->param('number'),       $session->param('id'),
1448                 $session->param('cardnumber'),   $session->param('firstname'),
1449                 $session->param('surname'),      $session->param('branch'),
1450                 $session->param('branchname'),   $session->param('flags'),
1451                 $session->param('emailaddress'), $session->param('branchprinter')
1452             );
1453
1454             my $ip       = $session->param('ip');
1455             my $lasttime = $session->param('lasttime');
1456             my $userid   = $session->param('id');
1457             if ( $lasttime < time() - $timeout ) {
1458
1459                 # time out
1460                 $session->delete();
1461                 $session->flush;
1462                 C4::Context->_unset_userenv($sessionID);
1463                 $userid    = undef;
1464                 $sessionID = undef;
1465                 return ( "expired", undef, undef );
1466             } elsif ( C4::Context->preference('SessionRestrictionByIP') && $ip ne $ENV{'REMOTE_ADDR'} ) {
1467
1468                 # IP address changed
1469                 $session->delete();
1470                 $session->flush;
1471                 C4::Context->_unset_userenv($sessionID);
1472                 $userid    = undef;
1473                 $sessionID = undef;
1474                 return ( "expired", undef, undef );
1475             } else {
1476                 my $cookie = $query->cookie(
1477                     -name     => 'CGISESSID',
1478                     -value    => $session->id,
1479                     -HttpOnly => 1,
1480                 );
1481                 $session->param( 'lasttime', time() );
1482                 my $flags = haspermission( $userid, $flagsrequired );
1483                 if ($flags) {
1484                     return ( "ok", $cookie, $sessionID );
1485                 } else {
1486                     $session->delete();
1487                     $session->flush;
1488                     C4::Context->_unset_userenv($sessionID);
1489                     $userid    = undef;
1490                     $sessionID = undef;
1491                     return ( "failed", undef, undef );
1492                 }
1493             }
1494         } else {
1495             return ( "expired", undef, undef );
1496         }
1497     } else {
1498
1499         # new login
1500         my $userid   = $query->param('userid');
1501         my $password = $query->param('password');
1502         my ( $return, $cardnumber, $cas_ticket );
1503
1504         # Proxy CAS auth
1505         if ( $cas && $query->param('PT') ) {
1506             my $retuserid;
1507             $debug and print STDERR "## check_api_auth - checking CAS\n";
1508
1509             # In case of a CAS authentication, we use the ticket instead of the password
1510             my $PT = $query->param('PT');
1511             ( $return, $cardnumber, $userid, $cas_ticket ) = check_api_auth_cas( $dbh, $PT, $query );    # EXTERNAL AUTH
1512         } else {
1513
1514             # User / password auth
1515             unless ( $userid and $password ) {
1516
1517                 # caller did something wrong, fail the authenticateion
1518                 return ( "failed", undef, undef );
1519             }
1520             my $newuserid;
1521             ( $return, $cardnumber, $newuserid, $cas_ticket ) = checkpw( $dbh, $userid, $password, $query );
1522         }
1523
1524         if ( $return and haspermission( $userid, $flagsrequired ) ) {
1525             my $session = get_session("");
1526             return ( "failed", undef, undef ) unless $session;
1527
1528             my $sessionID = $session->id;
1529             C4::Context->_new_userenv($sessionID);
1530             my $cookie = $query->cookie(
1531                 -name     => 'CGISESSID',
1532                 -value    => $sessionID,
1533                 -HttpOnly => 1,
1534             );
1535             if ( $return == 1 ) {
1536                 my (
1537                     $borrowernumber, $firstname,  $surname,
1538                     $userflags,      $branchcode, $branchname,
1539                     $branchprinter,  $emailaddress
1540                 );
1541                 my $sth =
1542                   $dbh->prepare(
1543 "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=?"
1544                   );
1545                 $sth->execute($userid);
1546                 (
1547                     $borrowernumber, $firstname,  $surname,
1548                     $userflags,      $branchcode, $branchname,
1549                     $branchprinter,  $emailaddress
1550                 ) = $sth->fetchrow if ( $sth->rows );
1551
1552                 unless ( $sth->rows ) {
1553                     my $sth = $dbh->prepare(
1554 "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=?"
1555                     );
1556                     $sth->execute($cardnumber);
1557                     (
1558                         $borrowernumber, $firstname,  $surname,
1559                         $userflags,      $branchcode, $branchname,
1560                         $branchprinter,  $emailaddress
1561                     ) = $sth->fetchrow if ( $sth->rows );
1562
1563                     unless ( $sth->rows ) {
1564                         $sth->execute($userid);
1565                         (
1566                             $borrowernumber, $firstname,  $surname,       $userflags,
1567                             $branchcode,     $branchname, $branchprinter, $emailaddress
1568                         ) = $sth->fetchrow if ( $sth->rows );
1569                     }
1570                 }
1571
1572                 my $ip = $ENV{'REMOTE_ADDR'};
1573
1574                 # if they specify at login, use that
1575                 if ( $query->param('branch') ) {
1576                     $branchcode = $query->param('branch');
1577                     my $library = Koha::Libraries->find($branchcode);
1578                     $branchname = $library? $library->branchname: '';
1579                 }
1580                 my $branches = { map { $_->branchcode => $_->unblessed } Koha::Libraries->search };
1581                 foreach my $br ( keys %$branches ) {
1582
1583                     #     now we work with the treatment of ip
1584                     my $domain = $branches->{$br}->{'branchip'};
1585                     if ( $domain && $ip =~ /^$domain/ ) {
1586                         $branchcode = $branches->{$br}->{'branchcode'};
1587
1588                         # new op dev : add the branchprinter and branchname in the cookie
1589                         $branchprinter = $branches->{$br}->{'branchprinter'};
1590                         $branchname    = $branches->{$br}->{'branchname'};
1591                     }
1592                 }
1593                 $session->param( 'number',       $borrowernumber );
1594                 $session->param( 'id',           $userid );
1595                 $session->param( 'cardnumber',   $cardnumber );
1596                 $session->param( 'firstname',    $firstname );
1597                 $session->param( 'surname',      $surname );
1598                 $session->param( 'branch',       $branchcode );
1599                 $session->param( 'branchname',   $branchname );
1600                 $session->param( 'flags',        $userflags );
1601                 $session->param( 'emailaddress', $emailaddress );
1602                 $session->param( 'ip',           $session->remote_addr() );
1603                 $session->param( 'lasttime',     time() );
1604             } elsif ( $return == 2 ) {
1605
1606                 #We suppose the user is the superlibrarian
1607                 $session->param( 'number',       0 );
1608                 $session->param( 'id',           C4::Context->config('user') );
1609                 $session->param( 'cardnumber',   C4::Context->config('user') );
1610                 $session->param( 'firstname',    C4::Context->config('user') );
1611                 $session->param( 'surname',      C4::Context->config('user') );
1612                 $session->param( 'branch',       'NO_LIBRARY_SET' );
1613                 $session->param( 'branchname',   'NO_LIBRARY_SET' );
1614                 $session->param( 'flags',        1 );
1615                 $session->param( 'emailaddress', C4::Context->preference('KohaAdminEmailAddress') );
1616                 $session->param( 'ip',           $session->remote_addr() );
1617                 $session->param( 'lasttime',     time() );
1618             }
1619             $session->param( 'cas_ticket', $cas_ticket);
1620             C4::Context->set_userenv(
1621                 $session->param('number'),       $session->param('id'),
1622                 $session->param('cardnumber'),   $session->param('firstname'),
1623                 $session->param('surname'),      $session->param('branch'),
1624                 $session->param('branchname'),   $session->param('flags'),
1625                 $session->param('emailaddress'), $session->param('branchprinter')
1626             );
1627             return ( "ok", $cookie, $sessionID );
1628         } else {
1629             return ( "failed", undef, undef );
1630         }
1631     }
1632 }
1633
1634 =head2 check_cookie_auth
1635
1636   ($status, $sessionId) = check_api_auth($cookie, $userflags);
1637
1638 Given a CGISESSID cookie set during a previous login to Koha, determine
1639 if the user has the privileges specified by C<$userflags>.
1640
1641 C<check_cookie_auth> is meant for authenticating special services
1642 such as tools/upload-file.pl that are invoked by other pages that
1643 have been authenticated in the usual way.
1644
1645 Possible return values in C<$status> are:
1646
1647 =over
1648
1649 =item "ok" -- user authenticated; C<$sessionID> have valid values.
1650
1651 =item "failed" -- credentials are not correct; C<$sessionid> are undef
1652
1653 =item "maintenance" -- DB is in maintenance mode; no login possible at the moment
1654
1655 =item "expired -- session cookie has expired; API user should resubmit userid and password
1656
1657 =back
1658
1659 =cut
1660
1661 sub check_cookie_auth {
1662     my $cookie        = shift;
1663     my $flagsrequired = shift;
1664     my $params        = shift;
1665
1666     my $remote_addr = $params->{remote_addr} || $ENV{REMOTE_ADDR};
1667     my $dbh     = C4::Context->dbh;
1668     my $timeout = _timeout_syspref();
1669
1670     unless ( C4::Context->preference('Version') ) {
1671
1672         # database has not been installed yet
1673         return ( "maintenance", undef );
1674     }
1675     my $kohaversion = Koha::version();
1676     $kohaversion =~ s/(.*\..*)\.(.*)\.(.*)/$1$2$3/;
1677     if ( C4::Context->preference('Version') < $kohaversion ) {
1678
1679         # database in need of version update; assume that
1680         # no API should be called while databsae is in
1681         # this condition.
1682         return ( "maintenance", undef );
1683     }
1684
1685     # FIXME -- most of what follows is a copy-and-paste
1686     # of code from checkauth.  There is an obvious need
1687     # for refactoring to separate the various parts of
1688     # the authentication code, but as of 2007-11-23 this
1689     # is deferred so as to not introduce bugs into the
1690     # regular authentication code for Koha 3.0.
1691
1692     # see if we have a valid session cookie already
1693     # however, if a userid parameter is present (i.e., from
1694     # a form submission, assume that any current cookie
1695     # is to be ignored
1696     unless ( defined $cookie and $cookie ) {
1697         return ( "failed", undef );
1698     }
1699     my $sessionID = $cookie;
1700     my $session   = get_session($sessionID);
1701     C4::Context->_new_userenv($sessionID);
1702     if ($session) {
1703         C4::Context->set_userenv(
1704             $session->param('number'),       $session->param('id'),
1705             $session->param('cardnumber'),   $session->param('firstname'),
1706             $session->param('surname'),      $session->param('branch'),
1707             $session->param('branchname'),   $session->param('flags'),
1708             $session->param('emailaddress'), $session->param('branchprinter')
1709         );
1710
1711         my $ip       = $session->param('ip');
1712         my $lasttime = $session->param('lasttime');
1713         my $userid   = $session->param('id');
1714         if ( $lasttime < time() - $timeout ) {
1715
1716             # time out
1717             $session->delete();
1718             $session->flush;
1719             C4::Context->_unset_userenv($sessionID);
1720             $userid    = undef;
1721             $sessionID = undef;
1722             return ("expired", undef);
1723         } elsif ( C4::Context->preference('SessionRestrictionByIP') && $ip ne $remote_addr ) {
1724
1725             # IP address changed
1726             $session->delete();
1727             $session->flush;
1728             C4::Context->_unset_userenv($sessionID);
1729             $userid    = undef;
1730             $sessionID = undef;
1731             return ( "expired", undef );
1732         } else {
1733             $session->param( 'lasttime', time() );
1734             my $flags = haspermission( $userid, $flagsrequired );
1735             if ($flags) {
1736                 return ( "ok", $sessionID );
1737             } else {
1738                 $session->delete();
1739                 $session->flush;
1740                 C4::Context->_unset_userenv($sessionID);
1741                 $userid    = undef;
1742                 $sessionID = undef;
1743                 return ( "failed", undef );
1744             }
1745         }
1746     } else {
1747         return ( "expired", undef );
1748     }
1749 }
1750
1751 =head2 get_session
1752
1753   use CGI::Session;
1754   my $session = get_session($sessionID);
1755
1756 Given a session ID, retrieve the CGI::Session object used to store
1757 the session's state.  The session object can be used to store
1758 data that needs to be accessed by different scripts during a
1759 user's session.
1760
1761 If the C<$sessionID> parameter is an empty string, a new session
1762 will be created.
1763
1764 =cut
1765
1766 sub _get_session_params {
1767     my $storage_method = C4::Context->preference('SessionStorage');
1768     if ( $storage_method eq 'mysql' ) {
1769         my $dbh = C4::Context->dbh;
1770         return { dsn => "driver:MySQL;serializer:yaml;id:md5", dsn_args => { Handle => $dbh } };
1771     }
1772     elsif ( $storage_method eq 'Pg' ) {
1773         my $dbh = C4::Context->dbh;
1774         return { dsn => "driver:PostgreSQL;serializer:yaml;id:md5", dsn_args => { Handle => $dbh } };
1775     }
1776     elsif ( $storage_method eq 'memcached' && Koha::Caches->get_instance->memcached_cache ) {
1777         my $memcached = Koha::Caches->get_instance()->memcached_cache;
1778         return { dsn => "driver:memcached;serializer:yaml;id:md5", dsn_args => { Memcached => $memcached } };
1779     }
1780     else {
1781         # catch all defaults to tmp should work on all systems
1782         my $dir = File::Spec->tmpdir;
1783         my $instance = C4::Context->config( 'database' ); #actually for packages not exactly the instance name, but generally safer to leave it as it is
1784         return { dsn => "driver:File;serializer:yaml;id:md5", dsn_args => { Directory => "$dir/cgisess_$instance" } };
1785     }
1786 }
1787
1788 sub get_session {
1789     my $sessionID      = shift;
1790     my $params = _get_session_params();
1791     return new CGI::Session( $params->{dsn}, $sessionID, $params->{dsn_args} );
1792 }
1793
1794
1795 # FIXME no_set_userenv may be replaced with force_branchcode_for_userenv
1796 # (or something similar)
1797 # Currently it's only passed from C4::SIP::ILS::Patron::check_password, but
1798 # not having a userenv defined could cause a crash.
1799 sub checkpw {
1800     my ( $dbh, $userid, $password, $query, $type, $no_set_userenv ) = @_;
1801     $type = 'opac' unless $type;
1802
1803     my @return;
1804     my $patron = Koha::Patrons->find({ userid => $userid });
1805     my $check_internal_as_fallback = 0;
1806     my $passwd_ok = 0;
1807     # Note: checkpw_* routines returns:
1808     # 1 if auth is ok
1809     # 0 if auth is nok
1810     # -1 if user bind failed (LDAP only)
1811     # 2 if DB user is used (internal only)
1812
1813     if ( $patron and $patron->account_locked ) {
1814         # Nothing to check, account is locked
1815     } elsif ($ldap) {
1816         $debug and print STDERR "## checkpw - checking LDAP\n";
1817         my ( $retval, $retcard, $retuserid ) = checkpw_ldap(@_);    # EXTERNAL AUTH
1818         if ( $retval == 1 ) {
1819             @return = ( $retval, $retcard, $retuserid );
1820             $passwd_ok = 1;
1821         }
1822         $check_internal_as_fallback = 1 if $retval == 0;
1823
1824     } elsif ( $cas && $query && $query->param('ticket') ) {
1825         $debug and print STDERR "## checkpw - checking CAS\n";
1826
1827         # In case of a CAS authentication, we use the ticket instead of the password
1828         my $ticket = $query->param('ticket');
1829         $query->delete('ticket');                                   # remove ticket to come back to original URL
1830         my ( $retval, $retcard, $retuserid, $cas_ticket ) = checkpw_cas( $dbh, $ticket, $query, $type );    # EXTERNAL AUTH
1831         if ( $retval ) {
1832             @return = ( $retval, $retcard, $retuserid, $cas_ticket );
1833         } else {
1834             @return = (0);
1835         }
1836         $passwd_ok = $retval;
1837     }
1838
1839     # If we are in a shibboleth session (shibboleth is enabled, and a shibboleth match attribute is present)
1840     # Check for password to asertain whether we want to be testing against shibboleth or another method this
1841     # time around.
1842     elsif ( $shib && $shib_login && !$password ) {
1843
1844         $debug and print STDERR "## checkpw - checking Shibboleth\n";
1845
1846         # In case of a Shibboleth authentication, we expect a shibboleth user attribute
1847         # (defined under shibboleth mapping in koha-conf.xml) to contain the login of the
1848         # shibboleth-authenticated user
1849
1850         # Then, we check if it matches a valid koha user
1851         if ($shib_login) {
1852             my ( $retval, $retcard, $retuserid ) = C4::Auth_with_shibboleth::checkpw_shib($shib_login);    # EXTERNAL AUTH
1853             if ( $retval ) {
1854                 @return = ( $retval, $retcard, $retuserid );
1855             }
1856             $passwd_ok = $retval;
1857         }
1858     } else {
1859         $check_internal_as_fallback = 1;
1860     }
1861
1862     # INTERNAL AUTH
1863     if ( $check_internal_as_fallback ) {
1864         @return = checkpw_internal( $dbh, $userid, $password, $no_set_userenv);
1865         $passwd_ok = 1 if $return[0] > 0; # 1 or 2
1866     }
1867
1868     if( $patron ) {
1869         if ( $passwd_ok ) {
1870             $patron->update({ login_attempts => 0 });
1871         } else {
1872             $patron->update({ login_attempts => $patron->login_attempts + 1 });
1873         }
1874     }
1875     return @return;
1876 }
1877
1878 sub checkpw_internal {
1879     my ( $dbh, $userid, $password, $no_set_userenv ) = @_;
1880
1881     $password = Encode::encode( 'UTF-8', $password )
1882       if Encode::is_utf8($password);
1883
1884     if ( $userid && $userid eq C4::Context->config('user') ) {
1885         if ( $password && $password eq C4::Context->config('pass') ) {
1886
1887             # Koha superuser account
1888             #     C4::Context->set_userenv(0,0,C4::Context->config('user'),C4::Context->config('user'),C4::Context->config('user'),"",1);
1889             return 2;
1890         }
1891         else {
1892             return 0;
1893         }
1894     }
1895
1896     my $sth =
1897       $dbh->prepare(
1898         "select password,cardnumber,borrowernumber,userid,firstname,surname,borrowers.branchcode,branches.branchname,flags from borrowers join branches on borrowers.branchcode=branches.branchcode where userid=?"
1899       );
1900     $sth->execute($userid);
1901     if ( $sth->rows ) {
1902         my ( $stored_hash, $cardnumber, $borrowernumber, $userid, $firstname,
1903             $surname, $branchcode, $branchname, $flags )
1904           = $sth->fetchrow;
1905
1906         if ( checkpw_hash( $password, $stored_hash ) ) {
1907
1908             C4::Context->set_userenv( "$borrowernumber", $userid, $cardnumber,
1909                 $firstname, $surname, $branchcode, $branchname, $flags ) unless $no_set_userenv;
1910             return 1, $cardnumber, $userid;
1911         }
1912     }
1913     $sth =
1914       $dbh->prepare(
1915         "select password,cardnumber,borrowernumber,userid,firstname,surname,borrowers.branchcode,branches.branchname,flags from borrowers join branches on borrowers.branchcode=branches.branchcode where cardnumber=?"
1916       );
1917     $sth->execute($userid);
1918     if ( $sth->rows ) {
1919         my ( $stored_hash, $cardnumber, $borrowernumber, $userid, $firstname,
1920             $surname, $branchcode, $branchname, $flags )
1921           = $sth->fetchrow;
1922
1923         if ( checkpw_hash( $password, $stored_hash ) ) {
1924
1925             C4::Context->set_userenv( $borrowernumber, $userid, $cardnumber,
1926                 $firstname, $surname, $branchcode, $branchname, $flags ) unless $no_set_userenv;
1927             return 1, $cardnumber, $userid;
1928         }
1929     }
1930     return 0;
1931 }
1932
1933 sub checkpw_hash {
1934     my ( $password, $stored_hash ) = @_;
1935
1936     return if $stored_hash eq '!';
1937
1938     # check what encryption algorithm was implemented: Bcrypt - if the hash starts with '$2' it is Bcrypt else md5
1939     my $hash;
1940     if ( substr( $stored_hash, 0, 2 ) eq '$2' ) {
1941         $hash = hash_password( $password, $stored_hash );
1942     } else {
1943         $hash = md5_base64($password);
1944     }
1945     return $hash eq $stored_hash;
1946 }
1947
1948 =head2 getuserflags
1949
1950     my $authflags = getuserflags($flags, $userid, [$dbh]);
1951
1952 Translates integer flags into permissions strings hash.
1953
1954 C<$flags> is the integer userflags value ( borrowers.userflags )
1955 C<$userid> is the members.userid, used for building subpermissions
1956 C<$authflags> is a hashref of permissions
1957
1958 =cut
1959
1960 sub getuserflags {
1961     my $flags  = shift;
1962     my $userid = shift;
1963     my $dbh    = @_ ? shift : C4::Context->dbh;
1964     my $userflags;
1965     {
1966         # I don't want to do this, but if someone logs in as the database
1967         # user, it would be preferable not to spam them to death with
1968         # numeric warnings. So, we make $flags numeric.
1969         no warnings 'numeric';
1970         $flags += 0;
1971     }
1972     my $sth = $dbh->prepare("SELECT bit, flag, defaulton FROM userflags");
1973     $sth->execute;
1974
1975     while ( my ( $bit, $flag, $defaulton ) = $sth->fetchrow ) {
1976         if ( ( $flags & ( 2**$bit ) ) || $defaulton ) {
1977             $userflags->{$flag} = 1;
1978         }
1979         else {
1980             $userflags->{$flag} = 0;
1981         }
1982     }
1983
1984     # get subpermissions and merge with top-level permissions
1985     my $user_subperms = get_user_subpermissions($userid);
1986     foreach my $module ( keys %$user_subperms ) {
1987         next if $userflags->{$module} == 1;    # user already has permission for everything in this module
1988         $userflags->{$module} = $user_subperms->{$module};
1989     }
1990
1991     return $userflags;
1992 }
1993
1994 =head2 get_user_subpermissions
1995
1996   $user_perm_hashref = get_user_subpermissions($userid);
1997
1998 Given the userid (note, not the borrowernumber) of a staff user,
1999 return a hashref of hashrefs of the specific subpermissions
2000 accorded to the user.  An example return is
2001
2002  {
2003     tools => {
2004         export_catalog => 1,
2005         import_patrons => 1,
2006     }
2007  }
2008
2009 The top-level hash-key is a module or function code from
2010 userflags.flag, while the second-level key is a code
2011 from permissions.
2012
2013 The results of this function do not give a complete picture
2014 of the functions that a staff user can access; it is also
2015 necessary to check borrowers.flags.
2016
2017 =cut
2018
2019 sub get_user_subpermissions {
2020     my $userid = shift;
2021
2022     my $dbh = C4::Context->dbh;
2023     my $sth = $dbh->prepare( "SELECT flag, user_permissions.code
2024                              FROM user_permissions
2025                              JOIN permissions USING (module_bit, code)
2026                              JOIN userflags ON (module_bit = bit)
2027                              JOIN borrowers USING (borrowernumber)
2028                              WHERE userid = ?" );
2029     $sth->execute($userid);
2030
2031     my $user_perms = {};
2032     while ( my $perm = $sth->fetchrow_hashref ) {
2033         $user_perms->{ $perm->{'flag'} }->{ $perm->{'code'} } = 1;
2034     }
2035     return $user_perms;
2036 }
2037
2038 =head2 get_all_subpermissions
2039
2040   my $perm_hashref = get_all_subpermissions();
2041
2042 Returns a hashref of hashrefs defining all specific
2043 permissions currently defined.  The return value
2044 has the same structure as that of C<get_user_subpermissions>,
2045 except that the innermost hash value is the description
2046 of the subpermission.
2047
2048 =cut
2049
2050 sub get_all_subpermissions {
2051     my $dbh = C4::Context->dbh;
2052     my $sth = $dbh->prepare( "SELECT flag, code
2053                              FROM permissions
2054                              JOIN userflags ON (module_bit = bit)" );
2055     $sth->execute();
2056
2057     my $all_perms = {};
2058     while ( my $perm = $sth->fetchrow_hashref ) {
2059         $all_perms->{ $perm->{'flag'} }->{ $perm->{'code'} } = 1;
2060     }
2061     return $all_perms;
2062 }
2063
2064 =head2 haspermission
2065
2066   $flags = ($userid, $flagsrequired);
2067
2068 C<$userid> the userid of the member
2069 C<$flags> is a hashref of required flags like C<$borrower-&lt;{authflags}>
2070
2071 Returns member's flags or 0 if a permission is not met.
2072
2073 =cut
2074
2075 sub haspermission {
2076     my ( $userid, $flagsrequired ) = @_;
2077     my $sth = C4::Context->dbh->prepare("SELECT flags FROM borrowers WHERE userid=?");
2078     $sth->execute($userid);
2079     my $row = $sth->fetchrow();
2080     my $flags = getuserflags( $row, $userid );
2081     if ( $userid eq C4::Context->config('user') ) {
2082
2083         # Super User Account from /etc/koha.conf
2084         $flags->{'superlibrarian'} = 1;
2085     }
2086
2087     return $flags if $flags->{superlibrarian};
2088
2089     foreach my $module ( keys %$flagsrequired ) {
2090         my $subperm = $flagsrequired->{$module};
2091         if ( $subperm eq '*' ) {
2092             return 0 unless ( $flags->{$module} == 1 or ref( $flags->{$module} ) );
2093         } else {
2094             return 0 unless (
2095                 ( defined $flags->{$module} and
2096                     $flags->{$module} == 1 )
2097                 or
2098                 ( ref( $flags->{$module} ) and
2099                     exists $flags->{$module}->{$subperm} and
2100                     $flags->{$module}->{$subperm} == 1 )
2101             );
2102         }
2103     }
2104     return $flags;
2105
2106     #FIXME - This fcn should return the failed permission so a suitable error msg can be delivered.
2107 }
2108
2109 sub getborrowernumber {
2110     my ($userid) = @_;
2111     my $userenv = C4::Context->userenv;
2112     if ( defined($userenv) && ref($userenv) eq 'HASH' && $userenv->{number} ) {
2113         return $userenv->{number};
2114     }
2115     my $dbh = C4::Context->dbh;
2116     for my $field ( 'userid', 'cardnumber' ) {
2117         my $sth =
2118           $dbh->prepare("select borrowernumber from borrowers where $field=?");
2119         $sth->execute($userid);
2120         if ( $sth->rows ) {
2121             my ($bnumber) = $sth->fetchrow;
2122             return $bnumber;
2123         }
2124     }
2125     return 0;
2126 }
2127
2128 END { }    # module clean-up code here (global destructor)
2129 1;
2130 __END__
2131
2132 =head1 SEE ALSO
2133
2134 CGI(3)
2135
2136 C4::Output(3)
2137
2138 Crypt::Eksblowfish::Bcrypt(3)
2139
2140 Digest::MD5(3)
2141
2142 =cut