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