C4/Auth.pm

   1 package C4::Auth;
   2
   3 # Copyright 2000-2002 Katipo Communications
   4 #
   5 # This file is part of Koha.
   6 #
   7 # Koha is free software; you can redistribute it and/or modify it
   8 # under the terms of the GNU General Public License as published by
   9 # the Free Software Foundation; either version 3 of the License, or
  10 # (at your option) any later version.
  11 #
  12 # Koha is distributed in the hope that it will be useful, but
  13 # WITHOUT ANY WARRANTY; without even the implied warranty of
  14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  15 # GNU General Public License for more details.
  16 #
  17 # You should have received a copy of the GNU General Public License
  18 # along with Koha; if not, see <http://www.gnu.org/licenses>.
  19
  20 use strict;
  21 use warnings;
  22 use Digest::MD5 qw(md5_base64);
  23 use File::Spec;
  24 use JSON qw/encode_json/;
  25 use URI::Escape;
  26 use CGI::Session;
  27
  28 require Exporter;
  29 use C4::Context;
  30 use C4::Templates;    # to get the template
  31 use C4::Languages;
  32 use C4::Search::History;
  33 use Koha;
  34 use Koha::Caches;
  35 use Koha::AuthUtils qw(get_script_name hash_password);
  36 use Koha::Library::Groups;
  37 use Koha::Libraries;
  38 use Koha::Patrons;
  39 use POSIX qw/strftime/;
  40 use List::MoreUtils qw/ any /;
  41 use Encode qw( encode is_utf8);
  42
  43 # use utf8;
  44 use vars qw(@ISA @EXPORT @EXPORT_OK %EXPORT_TAGS $debug $ldap $cas $caslogout $shib $shib_login);
  45
  46 BEGIN {
  47     sub psgi_env { any { /^psgi\./ } keys %ENV }
  48
  49     sub safe_exit {
  50         if   (psgi_env) { die 'psgi:exit' }
  51         else            { exit }
  52     }
  53
  54     $debug     = $ENV{DEBUG};
  55     @ISA       = qw(Exporter);
  56     @EXPORT    = qw(&checkauth &get_template_and_user &haspermission &get_user_subpermissions);
  57     @EXPORT_OK = qw(&check_api_auth &get_session &check_cookie_auth &checkpw &checkpw_internal &checkpw_hash
  58       &get_all_subpermissions &get_user_subpermissions
  59     );
  60     %EXPORT_TAGS = ( EditPermissions => [qw(get_all_subpermissions get_user_subpermissions)] );
  61     $ldap      = C4::Context->config('useldapserver') || 0;
  62     $cas       = C4::Context->preference('casAuthentication');
  63     $shib      = C4::Context->config('useshibboleth') || 0;
  64     $caslogout = C4::Context->preference('casLogout');
  65     require C4::Auth_with_cas;    # no import
  66
  67     if ($ldap) {
  68         require C4::Auth_with_ldap;
  69         import C4::Auth_with_ldap qw(checkpw_ldap);
  70     }
  71     if ($shib) {
  72         require C4::Auth_with_shibboleth;
  73         import C4::Auth_with_shibboleth
  74           qw(shib_ok checkpw_shib logout_shib login_shib_url get_login_shib);
  75
  76         # Check for good config
  77         if ( shib_ok() ) {
  78
  79             # Get shibboleth login attribute
  80             $shib_login = get_login_shib();
  81         }
  82
  83         # Bad config, disable shibboleth
  84         else {
  85             $shib = 0;
  86         }
  87     }
  88     if ($cas) {
  89         import C4::Auth_with_cas qw(check_api_auth_cas checkpw_cas login_cas logout_cas login_cas_url);
  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 $patron;
 217         $borrowernumber = getborrowernumber($user) if defined($user);
 218         if ( !defined($borrowernumber) && defined($user) ) {
 219             $patron = Koha::Patrons->find( $user );
 220             if ($patron) {
 221                 $borrowernumber = $user;
 222
 223                 # A bit of a hack, but I don't know there's a nicer way
 224                 # to do it.
 225                 $user = $patron->firstname . ' ' . $patron->surname;
 226             }
 227         } else {
 228             $patron = Koha::Patrons->find( $borrowernumber );
 229             # FIXME What to do if $patron does not exist?
 230         }
 231
 232         # user info
 233         $template->param( loggedinusername   => $user ); # FIXME Should be replaced with something like patron-title.inc
 234         $template->param( loggedinusernumber => $borrowernumber ); # FIXME Should be replaced with logged_in_user.borrowernumber
 235         $template->param( logged_in_user     => $patron );
 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" => $patron->unblessed );
 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             KOHA_VERSION                                                               => C4::Context->preference('Version'),
 476         );
 477     }
 478     else {
 479         warn "template type should be OPAC, here it is=[" . $in->{'type'} . "]" unless ( $in->{'type'} eq 'opac' );
 480
 481         #TODO : replace LibraryName syspref with 'system name', and remove this html processing
 482         my $LibraryNameTitle = C4::Context->preference("LibraryName");
 483         $LibraryNameTitle =~ s/<(?:\/?)(?:br|p)\s*(?:\/?)>/ /sgi;
 484         $LibraryNameTitle =~ s/<(?:[^<>'"]|'(?:[^']*)'|"(?:[^"]*)")*>//sg;
 485
 486         # clean up the busc param in the session
 487         # if the page is not opac-detail and not the "add to list" page
 488         # and not the "edit comments" page
 489         if ( C4::Context->preference("OpacBrowseResults")
 490             && $in->{'template_name'} =~ /opac-(.+)\.(?:tt|tmpl)$/ ) {
 491             my $pagename = $1;
 492             unless ( $pagename =~ /^(?:MARC|ISBD)?detail$/
 493                 or $pagename =~ /^addbybiblionumber$/
 494                 or $pagename =~ /^review$/ ) {
 495                 my $sessionSearch = get_session( $sessionID || $in->{'query'}->cookie("CGISESSID") );
 496                 $sessionSearch->clear( ["busc"] ) if ( $sessionSearch->param("busc") );
 497             }
 498         }
 499
 500         # variables passed from CGI: opac_css_override and opac_search_limits.
 501         my $opac_search_limit   = $ENV{'OPAC_SEARCH_LIMIT'};
 502         my $opac_limit_override = $ENV{'OPAC_LIMIT_OVERRIDE'};
 503         my $opac_name           = '';
 504         if (
 505             ( $opac_limit_override && $opac_search_limit && $opac_search_limit =~ /branch:(\w+)/ ) ||
 506             ( $in->{'query'}->param('limit') && $in->{'query'}->param('limit') =~ /branch:(\w+)/ ) ||
 507             ( $in->{'query'}->param('multibranchlimit') && $in->{'query'}->param('multibranchlimit') =~ /multibranchlimit-(\w+)/ )
 508           ) {
 509             $opac_name = $1;    # opac_search_limit is a branch, so we use it.
 510         } elsif ( $in->{'query'}->param('multibranchlimit') ) {
 511             $opac_name = $in->{'query'}->param('multibranchlimit');
 512         } elsif ( C4::Context->preference("SearchMyLibraryFirst") && C4::Context->userenv && C4::Context->userenv->{'branch'} ) {
 513             $opac_name = C4::Context->userenv->{'branch'};
 514         }
 515
 516         my $search_groups = Koha::Library::Groups->get_search_groups();
 517         $template->param(
 518             OpacAdditionalStylesheet                   => C4::Context->preference("OpacAdditionalStylesheet"),
 519             AnonSuggestions                       => "" . C4::Context->preference("AnonSuggestions"),
 520             LibrarySearchGroups                   => $search_groups,
 521             opac_name                             => $opac_name,
 522             LibraryName                           => "" . C4::Context->preference("LibraryName"),
 523             LibraryNameTitle                      => "" . $LibraryNameTitle,
 524             LoginBranchname                       => C4::Context->userenv ? C4::Context->userenv->{"branchname"} : "",
 525             OPACAmazonCoverImages                 => C4::Context->preference("OPACAmazonCoverImages"),
 526             OPACFRBRizeEditions                   => C4::Context->preference("OPACFRBRizeEditions"),
 527             OpacHighlightedWords                  => C4::Context->preference("OpacHighlightedWords"),
 528             OPACShelfBrowser                      => "" . C4::Context->preference("OPACShelfBrowser"),
 529             OPACURLOpenInNewWindow                => "" . C4::Context->preference("OPACURLOpenInNewWindow"),
 530             OPACUserCSS                           => "" . C4::Context->preference("OPACUserCSS"),
 531             OpacAuthorities                       => C4::Context->preference("OpacAuthorities"),
 532             opac_css_override                     => $ENV{'OPAC_CSS_OVERRIDE'},
 533             opac_search_limit                     => $opac_search_limit,
 534             opac_limit_override                   => $opac_limit_override,
 535             OpacBrowser                           => C4::Context->preference("OpacBrowser"),
 536             OpacCloud                             => C4::Context->preference("OpacCloud"),
 537             OpacKohaUrl                           => C4::Context->preference("OpacKohaUrl"),
 538             OpacMainUserBlock                     => "" . C4::Context->preference("OpacMainUserBlock"),
 539             OpacNav                               => "" . C4::Context->preference("OpacNav"),
 540             OpacNavRight                          => "" . C4::Context->preference("OpacNavRight"),
 541             OpacNavBottom                         => "" . C4::Context->preference("OpacNavBottom"),
 542             OpacPasswordChange                    => C4::Context->preference("OpacPasswordChange"),
 543             OPACPatronDetails                     => C4::Context->preference("OPACPatronDetails"),
 544             OPACPrivacy                           => C4::Context->preference("OPACPrivacy"),
 545             OPACFinesTab                          => C4::Context->preference("OPACFinesTab"),
 546             OpacTopissue                          => C4::Context->preference("OpacTopissue"),
 547             RequestOnOpac                         => C4::Context->preference("RequestOnOpac"),
 548             'Version'                             => C4::Context->preference('Version'),
 549             KOHA_VERSION                          => C4::Context->preference('Version'),
 550             hidelostitems                         => C4::Context->preference("hidelostitems"),
 551             mylibraryfirst                        => ( C4::Context->preference("SearchMyLibraryFirst") && C4::Context->userenv ) ? C4::Context->userenv->{'branch'} : '',
 552             opaclayoutstylesheet                  => "" . C4::Context->preference("opaclayoutstylesheet"),
 553             opacbookbag                           => "" . C4::Context->preference("opacbookbag"),
 554             opaccredits                           => "" . C4::Context->preference("opaccredits"),
 555             OpacFavicon                           => C4::Context->preference("OpacFavicon"),
 556             opacheader                            => "" . C4::Context->preference("opacheader"),
 557             opaclanguagesdisplay                  => "" . C4::Context->preference("opaclanguagesdisplay"),
 558             opacreadinghistory                    => C4::Context->preference("opacreadinghistory"),
 559             OPACUserJS                            => C4::Context->preference("OPACUserJS"),
 560             opacuserlogin                         => "" . C4::Context->preference("opacuserlogin"),
 561             OpenLibrarySearch                     => C4::Context->preference("OpenLibrarySearch"),
 562             ShowReviewer                          => C4::Context->preference("ShowReviewer"),
 563             ShowReviewerPhoto                     => C4::Context->preference("ShowReviewerPhoto"),
 564             suggestion                            => "" . C4::Context->preference("suggestion"),
 565             virtualshelves                        => "" . C4::Context->preference("virtualshelves"),
 566             OPACSerialIssueDisplayCount           => C4::Context->preference("OPACSerialIssueDisplayCount"),
 567             OPACXSLTDetailsDisplay                => C4::Context->preference("OPACXSLTDetailsDisplay"),
 568             OPACXSLTResultsDisplay                => C4::Context->preference("OPACXSLTResultsDisplay"),
 569             SyndeticsClientCode                   => C4::Context->preference("SyndeticsClientCode"),
 570             SyndeticsEnabled                      => C4::Context->preference("SyndeticsEnabled"),
 571             SyndeticsCoverImages                  => C4::Context->preference("SyndeticsCoverImages"),
 572             SyndeticsTOC                          => C4::Context->preference("SyndeticsTOC"),
 573             SyndeticsSummary                      => C4::Context->preference("SyndeticsSummary"),
 574             SyndeticsEditions                     => C4::Context->preference("SyndeticsEditions"),
 575             SyndeticsExcerpt                      => C4::Context->preference("SyndeticsExcerpt"),
 576             SyndeticsReviews                      => C4::Context->preference("SyndeticsReviews"),
 577             SyndeticsAuthorNotes                  => C4::Context->preference("SyndeticsAuthorNotes"),
 578             SyndeticsAwards                       => C4::Context->preference("SyndeticsAwards"),
 579             SyndeticsSeries                       => C4::Context->preference("SyndeticsSeries"),
 580             SyndeticsCoverImageSize               => C4::Context->preference("SyndeticsCoverImageSize"),
 581             OPACLocalCoverImages                  => C4::Context->preference("OPACLocalCoverImages"),
 582             PatronSelfRegistration                => C4::Context->preference("PatronSelfRegistration"),
 583             PatronSelfRegistrationDefaultCategory => C4::Context->preference("PatronSelfRegistrationDefaultCategory"),
 584             useDischarge                 => C4::Context->preference('useDischarge'),
 585         );
 586
 587         $template->param( OpacPublic => '1' ) if ( $user || C4::Context->preference("OpacPublic") );
 588     }
 589
 590     # Check if we were asked using parameters to force a specific language
 591     if ( defined $in->{'query'}->param('language') ) {
 592
 593         # Extract the language, let C4::Languages::getlanguage choose
 594         # what to do
 595         my $language = C4::Languages::getlanguage( $in->{'query'} );
 596         my $languagecookie = C4::Templates::getlanguagecookie( $in->{'query'}, $language );
 597         if ( ref $cookie eq 'ARRAY' ) {
 598             push @{$cookie}, $languagecookie;
 599         } else {
 600             $cookie = [ $cookie, $languagecookie ];
 601         }
 602     }
 603
 604     return ( $template, $borrowernumber, $cookie, $flags );
 605 }
 606
 607 =head2 checkauth
 608
 609   ($userid, $cookie, $sessionID) = &checkauth($query, $noauth, $flagsrequired, $type);
 610
 611 Verifies that the user is authorized to run this script.  If
 612 the user is authorized, a (userid, cookie, session-id, flags)
 613 quadruple is returned.  If the user is not authorized but does
 614 not have the required privilege (see $flagsrequired below), it
 615 displays an error page and exits.  Otherwise, it displays the
 616 login page and exits.
 617
 618 Note that C<&checkauth> will return if and only if the user
 619 is authorized, so it should be called early on, before any
 620 unfinished operations (e.g., if you've opened a file, then
 621 C<&checkauth> won't close it for you).
 622
 623 C<$query> is the CGI object for the script calling C<&checkauth>.
 624
 625 The C<$noauth> argument is optional. If it is set, then no
 626 authorization is required for the script.
 627
 628 C<&checkauth> fetches user and session information from C<$query> and
 629 ensures that the user is authorized to run scripts that require
 630 authorization.
 631
 632 The C<$flagsrequired> argument specifies the required privileges
 633 the user must have if the username and password are correct.
 634 It should be specified as a reference-to-hash; keys in the hash
 635 should be the "flags" for the user, as specified in the Members
 636 intranet module. Any key specified must correspond to a "flag"
 637 in the userflags table. E.g., { circulate => 1 } would specify
 638 that the user must have the "circulate" privilege in order to
 639 proceed. To make sure that access control is correct, the
 640 C<$flagsrequired> parameter must be specified correctly.
 641
 642 Koha also has a concept of sub-permissions, also known as
 643 granular permissions.  This makes the value of each key
 644 in the C<flagsrequired> hash take on an additional
 645 meaning, i.e.,
 646
 647  1
 648
 649 The user must have access to all subfunctions of the module
 650 specified by the hash key.
 651
 652  *
 653
 654 The user must have access to at least one subfunction of the module
 655 specified by the hash key.
 656
 657  specific permission, e.g., 'export_catalog'
 658
 659 The user must have access to the specific subfunction list, which
 660 must correspond to a row in the permissions table.
 661
 662 The C<$type> argument specifies whether the template should be
 663 retrieved from the opac or intranet directory tree.  "opac" is
 664 assumed if it is not specified; however, if C<$type> is specified,
 665 "intranet" is assumed if it is not "opac".
 666
 667 If C<$query> does not have a valid session ID associated with it
 668 (i.e., the user has not logged in) or if the session has expired,
 669 C<&checkauth> presents the user with a login page (from the point of
 670 view of the original script, C<&checkauth> does not return). Once the
 671 user has authenticated, C<&checkauth> restarts the original script
 672 (this time, C<&checkauth> returns).
 673
 674 The login page is provided using a HTML::Template, which is set in the
 675 systempreferences table or at the top of this file. The variable C<$type>
 676 selects which template to use, either the opac or the intranet
 677 authentification template.
 678
 679 C<&checkauth> returns a user ID, a cookie, and a session ID. The
 680 cookie should be sent back to the browser; it verifies that the user
 681 has authenticated.
 682
 683 =cut
 684
 685 sub _version_check {
 686     my $type  = shift;
 687     my $query = shift;
 688     my $version;
 689
 690     # If version syspref is unavailable, it means Koha is being installed,
 691     # and so we must redirect to OPAC maintenance page or to the WebInstaller
 692     # also, if OpacMaintenance is ON, OPAC should redirect to maintenance
 693     if ( C4::Context->preference('OpacMaintenance') && $type eq 'opac' ) {
 694         warn "OPAC Install required, redirecting to maintenance";
 695         print $query->redirect("/cgi-bin/koha/maintenance.pl");
 696         safe_exit;
 697     }
 698     unless ( $version = C4::Context->preference('Version') ) {    # assignment, not comparison
 699         if ( $type ne 'opac' ) {
 700             warn "Install required, redirecting to Installer";
 701             print $query->redirect("/cgi-bin/koha/installer/install.pl");
 702         } else {
 703             warn "OPAC Install required, redirecting to maintenance";
 704             print $query->redirect("/cgi-bin/koha/maintenance.pl");
 705         }
 706         safe_exit;
 707     }
 708
 709     # check that database and koha version are the same
 710     # there is no DB version, it's a fresh install,
 711     # go to web installer
 712     # there is a DB version, compare it to the code version
 713     my $kohaversion = Koha::version();
 714
 715     # remove the 3 last . to have a Perl number
 716     $kohaversion =~ s/(.*\..*)\.(.*)\.(.*)/$1$2$3/;
 717     $debug and print STDERR "kohaversion : $kohaversion\n";
 718     if ( $version < $kohaversion ) {
 719         my $warning = "Database update needed, redirecting to %s. Database is $version and Koha is $kohaversion";
 720         if ( $type ne 'opac' ) {
 721             warn sprintf( $warning, 'Installer' );
 722             print $query->redirect("/cgi-bin/koha/installer/install.pl?step=1&op=updatestructure");
 723         } else {
 724             warn sprintf( "OPAC: " . $warning, 'maintenance' );
 725             print $query->redirect("/cgi-bin/koha/maintenance.pl");
 726         }
 727         safe_exit;
 728     }
 729 }
 730
 731 sub _session_log {
 732     (@_) or return 0;
 733     open my $fh, '>>', "/tmp/sessionlog" or warn "ERROR: Cannot append to /tmp/sessionlog";
 734     printf $fh join( "\n", @_ );
 735     close $fh;
 736 }
 737
 738 sub _timeout_syspref {
 739     my $timeout = C4::Context->preference('timeout') || 600;
 740
 741     # value in days, convert in seconds
 742     if ( $timeout =~ /(\d+)[dD]/ ) {
 743         $timeout = $1 * 86400;
 744     }
 745     return $timeout;
 746 }
 747
 748 sub checkauth {
 749     my $query = shift;
 750     $debug and warn "Checking Auth";
 751
 752     # $authnotrequired will be set for scripts which will run without authentication
 753     my $authnotrequired = shift;
 754     my $flagsrequired   = shift;
 755     my $type            = shift;
 756     my $emailaddress    = shift;
 757     $type = 'opac' unless $type;
 758
 759     my $dbh     = C4::Context->dbh;
 760     my $timeout = _timeout_syspref();
 761
 762     _version_check( $type, $query );
 763
 764     # state variables
 765     my $loggedin = 0;
 766     my %info;
 767     my ( $userid, $cookie, $sessionID, $flags );
 768     my $logout = $query->param('logout.x');
 769
 770     my $anon_search_history;
 771
 772     # This parameter is the name of the CAS server we want to authenticate against,
 773     # when using authentication against multiple CAS servers, as configured in Auth_cas_servers.yaml
 774     my $casparam = $query->param('cas');
 775     my $q_userid = $query->param('userid') // '';
 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         my $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         if ( $userid ) {
1194             # track_login also depends on pref TrackLastPatronActivity
1195             my $patron = Koha::Patrons->find({ userid => $userid });
1196             $patron->track_login if $patron;
1197         }
1198
1199         return ( $userid, $cookie, $sessionID, $flags );
1200     }
1201
1202     #
1203     #
1204     # AUTH rejected, show the login/password template, after checking the DB.
1205     #
1206     #
1207
1208     # get the inputs from the incoming query
1209     my @inputs = ();
1210     foreach my $name ( param $query) {
1211         (next) if ( $name eq 'userid' || $name eq 'password' || $name eq 'ticket' );
1212         my $value = $query->param($name);
1213         push @inputs, { name => $name, value => $value };
1214     }
1215
1216     my $patron = Koha::Patrons->find({ userid => $q_userid }); # Not necessary logged in!
1217
1218     my $LibraryNameTitle = C4::Context->preference("LibraryName");
1219     $LibraryNameTitle =~ s/<(?:\/?)(?:br|p)\s*(?:\/?)>/ /sgi;
1220     $LibraryNameTitle =~ s/<(?:[^<>'"]|'(?:[^']*)'|"(?:[^"]*)")*>//sg;
1221
1222     my $template_name = ( $type eq 'opac' ) ? 'opac-auth.tt' : 'auth.tt';
1223     my $template = C4::Templates::gettemplate( $template_name, $type, $query );
1224     $template->param(
1225         OpacAdditionalStylesheet                   => C4::Context->preference("OpacAdditionalStylesheet"),
1226         opaclayoutstylesheet                  => C4::Context->preference("opaclayoutstylesheet"),
1227         login                                 => 1,
1228         INPUTS                                => \@inputs,
1229         script_name                           => get_script_name(),
1230         casAuthentication                     => C4::Context->preference("casAuthentication"),
1231         shibbolethAuthentication              => $shib,
1232         SessionRestrictionByIP                => C4::Context->preference("SessionRestrictionByIP"),
1233         suggestion                            => C4::Context->preference("suggestion"),
1234         virtualshelves                        => C4::Context->preference("virtualshelves"),
1235         LibraryName                           => "" . C4::Context->preference("LibraryName"),
1236         LibraryNameTitle                      => "" . $LibraryNameTitle,
1237         opacuserlogin                         => C4::Context->preference("opacuserlogin"),
1238         OpacNav                               => C4::Context->preference("OpacNav"),
1239         OpacNavRight                          => C4::Context->preference("OpacNavRight"),
1240         OpacNavBottom                         => C4::Context->preference("OpacNavBottom"),
1241         opaccredits                           => C4::Context->preference("opaccredits"),
1242         OpacFavicon                           => C4::Context->preference("OpacFavicon"),
1243         opacreadinghistory                    => C4::Context->preference("opacreadinghistory"),
1244         opaclanguagesdisplay                  => C4::Context->preference("opaclanguagesdisplay"),
1245         OPACUserJS                            => C4::Context->preference("OPACUserJS"),
1246         opacbookbag                           => "" . C4::Context->preference("opacbookbag"),
1247         OpacCloud                             => C4::Context->preference("OpacCloud"),
1248         OpacTopissue                          => C4::Context->preference("OpacTopissue"),
1249         OpacAuthorities                       => C4::Context->preference("OpacAuthorities"),
1250         OpacBrowser                           => C4::Context->preference("OpacBrowser"),
1251         opacheader                            => C4::Context->preference("opacheader"),
1252         TagsEnabled                           => C4::Context->preference("TagsEnabled"),
1253         OPACUserCSS                           => C4::Context->preference("OPACUserCSS"),
1254         intranetcolorstylesheet               => C4::Context->preference("intranetcolorstylesheet"),
1255         intranetstylesheet                    => C4::Context->preference("intranetstylesheet"),
1256         intranetbookbag                       => C4::Context->preference("intranetbookbag"),
1257         IntranetNav                           => C4::Context->preference("IntranetNav"),
1258         IntranetFavicon                       => C4::Context->preference("IntranetFavicon"),
1259         IntranetUserCSS                       => C4::Context->preference("IntranetUserCSS"),
1260         IntranetUserJS                        => C4::Context->preference("IntranetUserJS"),
1261         IndependentBranches                   => C4::Context->preference("IndependentBranches"),
1262         AutoLocation                          => C4::Context->preference("AutoLocation"),
1263         wrongip                               => $info{'wrongip'},
1264         PatronSelfRegistration                => C4::Context->preference("PatronSelfRegistration"),
1265         PatronSelfRegistrationDefaultCategory => C4::Context->preference("PatronSelfRegistrationDefaultCategory"),
1266         opac_css_override                     => $ENV{'OPAC_CSS_OVERRIDE'},
1267         too_many_login_attempts               => ( $patron and $patron->account_locked ),
1268     );
1269
1270     $template->param( SCO_login => 1 ) if ( $query->param('sco_user_login') );
1271     $template->param( OpacPublic => C4::Context->preference("OpacPublic") );
1272     $template->param( loginprompt => 1 ) unless $info{'nopermission'};
1273
1274     if ( $type eq 'opac' ) {
1275         require Koha::Virtualshelves;
1276         my $some_public_shelves = Koha::Virtualshelves->get_some_shelves(
1277             {
1278                 category       => 2,
1279             }
1280         );
1281         $template->param(
1282             some_public_shelves  => $some_public_shelves,
1283         );
1284     }
1285
1286     if ($cas) {
1287
1288         # Is authentication against multiple CAS servers enabled?
1289         if ( C4::Auth_with_cas::multipleAuth && !$casparam ) {
1290             my $casservers = C4::Auth_with_cas::getMultipleAuth();
1291             my @tmplservers;
1292             foreach my $key ( keys %$casservers ) {
1293                 push @tmplservers, { name => $key, value => login_cas_url( $query, $key, $type ) . "?cas=$key" };
1294             }
1295             $template->param(
1296                 casServersLoop => \@tmplservers
1297             );
1298         } else {
1299             $template->param(
1300                 casServerUrl => login_cas_url($query, undef, $type),
1301             );
1302         }
1303
1304         $template->param(
1305             invalidCasLogin => $info{'invalidCasLogin'}
1306         );
1307     }
1308
1309     if ($shib) {
1310         $template->param(
1311             shibbolethAuthentication => $shib,
1312             shibbolethLoginUrl       => login_shib_url($query),
1313         );
1314     }
1315
1316     if (C4::Context->preference('GoogleOpenIDConnect')) {
1317         if ($query->param("OpenIDConnectFailed")) {
1318             my $reason = $query->param('OpenIDConnectFailed');
1319             $template->param(invalidGoogleOpenIDConnectLogin => $reason);
1320         }
1321     }
1322
1323     $template->param(
1324         LibraryName => C4::Context->preference("LibraryName"),
1325     );
1326     $template->param(%info);
1327
1328     #    $cookie = $query->cookie(CGISESSID => $session->id
1329     #   );
1330     print $query->header(
1331         {   type              => 'text/html',
1332             charset           => 'utf-8',
1333             cookie            => $cookie,
1334             'X-Frame-Options' => 'SAMEORIGIN'
1335         }
1336       ),
1337       $template->output;
1338     safe_exit;
1339 }
1340
1341 =head2 check_api_auth
1342
1343   ($status, $cookie, $sessionId) = check_api_auth($query, $userflags);
1344
1345 Given a CGI query containing the parameters 'userid' and 'password' and/or a session
1346 cookie, determine if the user has the privileges specified by C<$userflags>.
1347
1348 C<check_api_auth> is is meant for authenticating users of web services, and
1349 consequently will always return and will not attempt to redirect the user
1350 agent.
1351
1352 If a valid session cookie is already present, check_api_auth will return a status
1353 of "ok", the cookie, and the Koha session ID.
1354
1355 If no session cookie is present, check_api_auth will check the 'userid' and 'password
1356 parameters and create a session cookie and Koha session if the supplied credentials
1357 are OK.
1358
1359 Possible return values in C<$status> are:
1360
1361 =over
1362
1363 =item "ok" -- user authenticated; C<$cookie> and C<$sessionid> have valid values.
1364
1365 =item "failed" -- credentials are not correct; C<$cookie> and C<$sessionid> are undef
1366
1367 =item "maintenance" -- DB is in maintenance mode; no login possible at the moment
1368
1369 =item "expired -- session cookie has expired; API user should resubmit userid and password
1370
1371 =back
1372
1373 =cut
1374
1375 sub check_api_auth {
1376     my $query         = shift;
1377     my $flagsrequired = shift;
1378
1379     my $dbh     = C4::Context->dbh;
1380     my $timeout = _timeout_syspref();
1381
1382     unless ( C4::Context->preference('Version') ) {
1383
1384         # database has not been installed yet
1385         return ( "maintenance", undef, undef );
1386     }
1387     my $kohaversion = Koha::version();
1388     $kohaversion =~ s/(.*\..*)\.(.*)\.(.*)/$1$2$3/;
1389     if ( C4::Context->preference('Version') < $kohaversion ) {
1390
1391         # database in need of version update; assume that
1392         # no API should be called while databsae is in
1393         # this condition.
1394         return ( "maintenance", undef, undef );
1395     }
1396
1397     # FIXME -- most of what follows is a copy-and-paste
1398     # of code from checkauth.  There is an obvious need
1399     # for refactoring to separate the various parts of
1400     # the authentication code, but as of 2007-11-19 this
1401     # is deferred so as to not introduce bugs into the
1402     # regular authentication code for Koha 3.0.
1403
1404     # see if we have a valid session cookie already
1405     # however, if a userid parameter is present (i.e., from
1406     # a form submission, assume that any current cookie
1407     # is to be ignored
1408     my $sessionID = undef;
1409     unless ( $query->param('userid') ) {
1410         $sessionID = $query->cookie("CGISESSID");
1411     }
1412     if ( $sessionID && not( $cas && $query->param('PT') ) ) {
1413         my $session = get_session($sessionID);
1414         C4::Context->_new_userenv($sessionID);
1415         if ($session) {
1416             C4::Context->set_userenv(
1417                 $session->param('number'),       $session->param('id'),
1418                 $session->param('cardnumber'),   $session->param('firstname'),
1419                 $session->param('surname'),      $session->param('branch'),
1420                 $session->param('branchname'),   $session->param('flags'),
1421                 $session->param('emailaddress'), $session->param('branchprinter')
1422             );
1423
1424             my $ip       = $session->param('ip');
1425             my $lasttime = $session->param('lasttime');
1426             my $userid   = $session->param('id');
1427             if ( $lasttime < time() - $timeout ) {
1428
1429                 # time out
1430                 $session->delete();
1431                 $session->flush;
1432                 C4::Context->_unset_userenv($sessionID);
1433                 $userid    = undef;
1434                 $sessionID = undef;
1435                 return ( "expired", undef, undef );
1436             } elsif ( C4::Context->preference('SessionRestrictionByIP') && $ip ne $ENV{'REMOTE_ADDR'} ) {
1437
1438                 # IP address changed
1439                 $session->delete();
1440                 $session->flush;
1441                 C4::Context->_unset_userenv($sessionID);
1442                 $userid    = undef;
1443                 $sessionID = undef;
1444                 return ( "expired", undef, undef );
1445             } else {
1446                 my $cookie = $query->cookie(
1447                     -name     => 'CGISESSID',
1448                     -value    => $session->id,
1449                     -HttpOnly => 1,
1450                 );
1451                 $session->param( 'lasttime', time() );
1452                 my $flags = haspermission( $userid, $flagsrequired );
1453                 if ($flags) {
1454                     return ( "ok", $cookie, $sessionID );
1455                 } else {
1456                     $session->delete();
1457                     $session->flush;
1458                     C4::Context->_unset_userenv($sessionID);
1459                     $userid    = undef;
1460                     $sessionID = undef;
1461                     return ( "failed", undef, undef );
1462                 }
1463             }
1464         } else {
1465             return ( "expired", undef, undef );
1466         }
1467     } else {
1468
1469         # new login
1470         my $userid   = $query->param('userid');
1471         my $password = $query->param('password');
1472         my ( $return, $cardnumber );
1473
1474         # Proxy CAS auth
1475         if ( $cas && $query->param('PT') ) {
1476             my $retuserid;
1477             $debug and print STDERR "## check_api_auth - checking CAS\n";
1478
1479             # In case of a CAS authentication, we use the ticket instead of the password
1480             my $PT = $query->param('PT');
1481             ( $return, $cardnumber, $userid ) = check_api_auth_cas( $dbh, $PT, $query );    # EXTERNAL AUTH
1482         } else {
1483
1484             # User / password auth
1485             unless ( $userid and $password ) {
1486
1487                 # caller did something wrong, fail the authenticateion
1488                 return ( "failed", undef, undef );
1489             }
1490             ( $return, $cardnumber ) = checkpw( $dbh, $userid, $password, $query );
1491         }
1492
1493         if ( $return and haspermission( $userid, $flagsrequired ) ) {
1494             my $session = get_session("");
1495             return ( "failed", undef, undef ) unless $session;
1496
1497             my $sessionID = $session->id;
1498             C4::Context->_new_userenv($sessionID);
1499             my $cookie = $query->cookie(
1500                 -name     => 'CGISESSID',
1501                 -value    => $sessionID,
1502                 -HttpOnly => 1,
1503             );
1504             if ( $return == 1 ) {
1505                 my (
1506                     $borrowernumber, $firstname,  $surname,
1507                     $userflags,      $branchcode, $branchname,
1508                     $branchprinter,  $emailaddress
1509                 );
1510                 my $sth =
1511                   $dbh->prepare(
1512 "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=?"
1513                   );
1514                 $sth->execute($userid);
1515                 (
1516                     $borrowernumber, $firstname,  $surname,
1517                     $userflags,      $branchcode, $branchname,
1518                     $branchprinter,  $emailaddress
1519                 ) = $sth->fetchrow if ( $sth->rows );
1520
1521                 unless ( $sth->rows ) {
1522                     my $sth = $dbh->prepare(
1523 "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=?"
1524                     );
1525                     $sth->execute($cardnumber);
1526                     (
1527                         $borrowernumber, $firstname,  $surname,
1528                         $userflags,      $branchcode, $branchname,
1529                         $branchprinter,  $emailaddress
1530                     ) = $sth->fetchrow if ( $sth->rows );
1531
1532                     unless ( $sth->rows ) {
1533                         $sth->execute($userid);
1534                         (
1535                             $borrowernumber, $firstname,  $surname,       $userflags,
1536                             $branchcode,     $branchname, $branchprinter, $emailaddress
1537                         ) = $sth->fetchrow if ( $sth->rows );
1538                     }
1539                 }
1540
1541                 my $ip = $ENV{'REMOTE_ADDR'};
1542
1543                 # if they specify at login, use that
1544                 if ( $query->param('branch') ) {
1545                     $branchcode = $query->param('branch');
1546                     my $library = Koha::Libraries->find($branchcode);
1547                     $branchname = $library? $library->branchname: '';
1548                 }
1549                 my $branches = { map { $_->branchcode => $_->unblessed } Koha::Libraries->search };
1550                 foreach my $br ( keys %$branches ) {
1551
1552                     #     now we work with the treatment of ip
1553                     my $domain = $branches->{$br}->{'branchip'};
1554                     if ( $domain && $ip =~ /^$domain/ ) {
1555                         $branchcode = $branches->{$br}->{'branchcode'};
1556
1557                         # new op dev : add the branchprinter and branchname in the cookie
1558                         $branchprinter = $branches->{$br}->{'branchprinter'};
1559                         $branchname    = $branches->{$br}->{'branchname'};
1560                     }
1561                 }
1562                 $session->param( 'number',       $borrowernumber );
1563                 $session->param( 'id',           $userid );
1564                 $session->param( 'cardnumber',   $cardnumber );
1565                 $session->param( 'firstname',    $firstname );
1566                 $session->param( 'surname',      $surname );
1567                 $session->param( 'branch',       $branchcode );
1568                 $session->param( 'branchname',   $branchname );
1569                 $session->param( 'flags',        $userflags );
1570                 $session->param( 'emailaddress', $emailaddress );
1571                 $session->param( 'ip',           $session->remote_addr() );
1572                 $session->param( 'lasttime',     time() );
1573             } elsif ( $return == 2 ) {
1574
1575                 #We suppose the user is the superlibrarian
1576                 $session->param( 'number',       0 );
1577                 $session->param( 'id',           C4::Context->config('user') );
1578                 $session->param( 'cardnumber',   C4::Context->config('user') );
1579                 $session->param( 'firstname',    C4::Context->config('user') );
1580                 $session->param( 'surname',      C4::Context->config('user') );
1581                 $session->param( 'branch',       'NO_LIBRARY_SET' );
1582                 $session->param( 'branchname',   'NO_LIBRARY_SET' );
1583                 $session->param( 'flags',        1 );
1584                 $session->param( 'emailaddress', C4::Context->preference('KohaAdminEmailAddress') );
1585                 $session->param( 'ip',           $session->remote_addr() );
1586                 $session->param( 'lasttime',     time() );
1587             }
1588             C4::Context->set_userenv(
1589                 $session->param('number'),       $session->param('id'),
1590                 $session->param('cardnumber'),   $session->param('firstname'),
1591                 $session->param('surname'),      $session->param('branch'),
1592                 $session->param('branchname'),   $session->param('flags'),
1593                 $session->param('emailaddress'), $session->param('branchprinter')
1594             );
1595             return ( "ok", $cookie, $sessionID );
1596         } else {
1597             return ( "failed", undef, undef );
1598         }
1599     }
1600 }
1601
1602 =head2 check_cookie_auth
1603
1604   ($status, $sessionId) = check_api_auth($cookie, $userflags);
1605
1606 Given a CGISESSID cookie set during a previous login to Koha, determine
1607 if the user has the privileges specified by C<$userflags>.
1608
1609 C<check_cookie_auth> is meant for authenticating special services
1610 such as tools/upload-file.pl that are invoked by other pages that
1611 have been authenticated in the usual way.
1612
1613 Possible return values in C<$status> are:
1614
1615 =over
1616
1617 =item "ok" -- user authenticated; C<$sessionID> have valid values.
1618
1619 =item "failed" -- credentials are not correct; C<$sessionid> are undef
1620
1621 =item "maintenance" -- DB is in maintenance mode; no login possible at the moment
1622
1623 =item "expired -- session cookie has expired; API user should resubmit userid and password
1624
1625 =back
1626
1627 =cut
1628
1629 sub check_cookie_auth {
1630     my $cookie        = shift;
1631     my $flagsrequired = shift;
1632     my $params        = shift;
1633
1634     my $remote_addr = $params->{remote_addr} || $ENV{REMOTE_ADDR};
1635     my $dbh     = C4::Context->dbh;
1636     my $timeout = _timeout_syspref();
1637
1638     unless ( C4::Context->preference('Version') ) {
1639
1640         # database has not been installed yet
1641         return ( "maintenance", undef );
1642     }
1643     my $kohaversion = Koha::version();
1644     $kohaversion =~ s/(.*\..*)\.(.*)\.(.*)/$1$2$3/;
1645     if ( C4::Context->preference('Version') < $kohaversion ) {
1646
1647         # database in need of version update; assume that
1648         # no API should be called while databsae is in
1649         # this condition.
1650         return ( "maintenance", undef );
1651     }
1652
1653     # FIXME -- most of what follows is a copy-and-paste
1654     # of code from checkauth.  There is an obvious need
1655     # for refactoring to separate the various parts of
1656     # the authentication code, but as of 2007-11-23 this
1657     # is deferred so as to not introduce bugs into the
1658     # regular authentication code for Koha 3.0.
1659
1660     # see if we have a valid session cookie already
1661     # however, if a userid parameter is present (i.e., from
1662     # a form submission, assume that any current cookie
1663     # is to be ignored
1664     unless ( defined $cookie and $cookie ) {
1665         return ( "failed", undef );
1666     }
1667     my $sessionID = $cookie;
1668     my $session   = get_session($sessionID);
1669     C4::Context->_new_userenv($sessionID);
1670     if ($session) {
1671         C4::Context->set_userenv(
1672             $session->param('number'),       $session->param('id'),
1673             $session->param('cardnumber'),   $session->param('firstname'),
1674             $session->param('surname'),      $session->param('branch'),
1675             $session->param('branchname'),   $session->param('flags'),
1676             $session->param('emailaddress'), $session->param('branchprinter')
1677         );
1678
1679         my $ip       = $session->param('ip');
1680         my $lasttime = $session->param('lasttime');
1681         my $userid   = $session->param('id');
1682         if ( $lasttime < time() - $timeout ) {
1683
1684             # time out
1685             $session->delete();
1686             $session->flush;
1687             C4::Context->_unset_userenv($sessionID);
1688             $userid    = undef;
1689             $sessionID = undef;
1690             return ("expired", undef);
1691         } elsif ( C4::Context->preference('SessionRestrictionByIP') && $ip ne $remote_addr ) {
1692
1693             # IP address changed
1694             $session->delete();
1695             $session->flush;
1696             C4::Context->_unset_userenv($sessionID);
1697             $userid    = undef;
1698             $sessionID = undef;
1699             return ( "expired", undef );
1700         } else {
1701             $session->param( 'lasttime', time() );
1702             my $flags = haspermission( $userid, $flagsrequired );
1703             if ($flags) {
1704                 return ( "ok", $sessionID );
1705             } else {
1706                 $session->delete();
1707                 $session->flush;
1708                 C4::Context->_unset_userenv($sessionID);
1709                 $userid    = undef;
1710                 $sessionID = undef;
1711                 return ( "failed", undef );
1712             }
1713         }
1714     } else {
1715         return ( "expired", undef );
1716     }
1717 }
1718
1719 =head2 get_session
1720
1721   use CGI::Session;
1722   my $session = get_session($sessionID);
1723
1724 Given a session ID, retrieve the CGI::Session object used to store
1725 the session's state.  The session object can be used to store
1726 data that needs to be accessed by different scripts during a
1727 user's session.
1728
1729 If the C<$sessionID> parameter is an empty string, a new session
1730 will be created.
1731
1732 =cut
1733
1734 sub get_session {
1735     my $sessionID      = shift;
1736     my $storage_method = C4::Context->preference('SessionStorage');
1737     my $dbh            = C4::Context->dbh;
1738     my $session;
1739     if ( $storage_method eq 'mysql' ) {
1740         $session = new CGI::Session( "driver:MySQL;serializer:yaml;id:md5", $sessionID, { Handle => $dbh } );
1741     }
1742     elsif ( $storage_method eq 'Pg' ) {
1743         $session = new CGI::Session( "driver:PostgreSQL;serializer:yaml;id:md5", $sessionID, { Handle => $dbh } );
1744     }
1745     elsif ( $storage_method eq 'memcached' && Koha::Caches->get_instance->memcached_cache ) {
1746         my $memcached = Koha::Caches->get_instance()->memcached_cache;
1747         $session = new CGI::Session( "driver:memcached;serializer:yaml;id:md5", $sessionID, { Memcached => $memcached } );
1748     }
1749     else {
1750         # catch all defaults to tmp should work on all systems
1751         my $dir = File::Spec->tmpdir;
1752         my $instance = C4::Context->config( 'database' ); #actually for packages not exactly the instance name, but generally safer to leave it as it is
1753         $session = new CGI::Session( "driver:File;serializer:yaml;id:md5", $sessionID, { Directory => "$dir/cgisess_$instance" } );
1754     }
1755     return $session;
1756 }
1757
1758
1759 # FIXME no_set_userenv may be replaced with force_branchcode_for_userenv
1760 # (or something similar)
1761 # Currently it's only passed from C4::SIP::ILS::Patron::check_password, but
1762 # not having a userenv defined could cause a crash.
1763 sub checkpw {
1764     my ( $dbh, $userid, $password, $query, $type, $no_set_userenv ) = @_;
1765     $type = 'opac' unless $type;
1766
1767     my @return;
1768     my $patron = Koha::Patrons->find({ userid => $userid });
1769     my $check_internal_as_fallback = 0;
1770     my $passwd_ok = 0;
1771     # Note: checkpw_* routines returns:
1772     # 1 if auth is ok
1773     # 0 if auth is nok
1774     # -1 if user bind failed (LDAP only)
1775     # 2 if DB user is used (internal only)
1776
1777     if ( $patron and $patron->account_locked ) {
1778         # Nothing to check, account is locked
1779     } elsif ($ldap) {
1780         $debug and print STDERR "## checkpw - checking LDAP\n";
1781         my ( $retval, $retcard, $retuserid ) = checkpw_ldap(@_);    # EXTERNAL AUTH
1782         if ( $retval == 1 ) {
1783             @return = ( $retval, $retcard, $retuserid );
1784             $passwd_ok = 1;
1785         }
1786         $check_internal_as_fallback = 1 if $retval == 0;
1787
1788     } elsif ( $cas && $query && $query->param('ticket') ) {
1789         $debug and print STDERR "## checkpw - checking CAS\n";
1790
1791         # In case of a CAS authentication, we use the ticket instead of the password
1792         my $ticket = $query->param('ticket');
1793         $query->delete('ticket');                                   # remove ticket to come back to original URL
1794         my ( $retval, $retcard, $retuserid ) = checkpw_cas( $dbh, $ticket, $query, $type );    # EXTERNAL AUTH
1795         if ( $retval ) {
1796             @return = ( $retval, $retcard, $retuserid );
1797         }
1798         $passwd_ok = $retval;
1799     }
1800
1801     # If we are in a shibboleth session (shibboleth is enabled, and a shibboleth match attribute is present)
1802     # Check for password to asertain whether we want to be testing against shibboleth or another method this
1803     # time around.
1804     elsif ( $shib && $shib_login && !$password ) {
1805
1806         $debug and print STDERR "## checkpw - checking Shibboleth\n";
1807
1808         # In case of a Shibboleth authentication, we expect a shibboleth user attribute
1809         # (defined under shibboleth mapping in koha-conf.xml) to contain the login of the
1810         # shibboleth-authenticated user
1811
1812         # Then, we check if it matches a valid koha user
1813         if ($shib_login) {
1814             my ( $retval, $retcard, $retuserid ) = C4::Auth_with_shibboleth::checkpw_shib($shib_login);    # EXTERNAL AUTH
1815             if ( $retval ) {
1816                 @return = ( $retval, $retcard, $retuserid );
1817             }
1818             $passwd_ok = $retval;
1819         }
1820     } else {
1821         $check_internal_as_fallback = 1;
1822     }
1823
1824     # INTERNAL AUTH
1825     if ( $check_internal_as_fallback ) {
1826         @return = checkpw_internal( $dbh, $userid, $password, $no_set_userenv);
1827         $passwd_ok = 1 if $return[0] > 0; # 1 or 2
1828     }
1829
1830     if( $patron ) {
1831         if ( $passwd_ok ) {
1832             $patron->update({ login_attempts => 0 });
1833         } else {
1834             $patron->update({ login_attempts => $patron->login_attempts + 1 });
1835         }
1836     }
1837     return @return;
1838 }
1839
1840 sub checkpw_internal {
1841     my ( $dbh, $userid, $password, $no_set_userenv ) = @_;
1842
1843     $password = Encode::encode( 'UTF-8', $password )
1844       if Encode::is_utf8($password);
1845
1846     if ( $userid && $userid eq C4::Context->config('user') ) {
1847         if ( $password && $password eq C4::Context->config('pass') ) {
1848
1849             # Koha superuser account
1850             #     C4::Context->set_userenv(0,0,C4::Context->config('user'),C4::Context->config('user'),C4::Context->config('user'),"",1);
1851             return 2;
1852         }
1853         else {
1854             return 0;
1855         }
1856     }
1857
1858     my $sth =
1859       $dbh->prepare(
1860         "select password,cardnumber,borrowernumber,userid,firstname,surname,borrowers.branchcode,branches.branchname,flags from borrowers join branches on borrowers.branchcode=branches.branchcode where userid=?"
1861       );
1862     $sth->execute($userid);
1863     if ( $sth->rows ) {
1864         my ( $stored_hash, $cardnumber, $borrowernumber, $userid, $firstname,
1865             $surname, $branchcode, $branchname, $flags )
1866           = $sth->fetchrow;
1867
1868         if ( checkpw_hash( $password, $stored_hash ) ) {
1869
1870             C4::Context->set_userenv( "$borrowernumber", $userid, $cardnumber,
1871                 $firstname, $surname, $branchcode, $branchname, $flags ) unless $no_set_userenv;
1872             return 1, $cardnumber, $userid;
1873         }
1874     }
1875     $sth =
1876       $dbh->prepare(
1877         "select password,cardnumber,borrowernumber,userid,firstname,surname,borrowers.branchcode,branches.branchname,flags from borrowers join branches on borrowers.branchcode=branches.branchcode where cardnumber=?"
1878       );
1879     $sth->execute($userid);
1880     if ( $sth->rows ) {
1881         my ( $stored_hash, $cardnumber, $borrowernumber, $userid, $firstname,
1882             $surname, $branchcode, $branchname, $flags )
1883           = $sth->fetchrow;
1884
1885         if ( checkpw_hash( $password, $stored_hash ) ) {
1886
1887             C4::Context->set_userenv( $borrowernumber, $userid, $cardnumber,
1888                 $firstname, $surname, $branchcode, $branchname, $flags ) unless $no_set_userenv;
1889             return 1, $cardnumber, $userid;
1890         }
1891     }
1892     return 0;
1893 }
1894
1895 sub checkpw_hash {
1896     my ( $password, $stored_hash ) = @_;
1897
1898     return if $stored_hash eq '!';
1899
1900     # check what encryption algorithm was implemented: Bcrypt - if the hash starts with '$2' it is Bcrypt else md5
1901     my $hash;
1902     if ( substr( $stored_hash, 0, 2 ) eq '$2' ) {
1903         $hash = hash_password( $password, $stored_hash );
1904     } else {
1905         $hash = md5_base64($password);
1906     }
1907     return $hash eq $stored_hash;
1908 }
1909
1910 =head2 getuserflags
1911
1912     my $authflags = getuserflags($flags, $userid, [$dbh]);
1913
1914 Translates integer flags into permissions strings hash.
1915
1916 C<$flags> is the integer userflags value ( borrowers.userflags )
1917 C<$userid> is the members.userid, used for building subpermissions
1918 C<$authflags> is a hashref of permissions
1919
1920 =cut
1921
1922 sub getuserflags {
1923     my $flags  = shift;
1924     my $userid = shift;
1925     my $dbh    = @_ ? shift : C4::Context->dbh;
1926     my $userflags;
1927     {
1928         # I don't want to do this, but if someone logs in as the database
1929         # user, it would be preferable not to spam them to death with
1930         # numeric warnings. So, we make $flags numeric.
1931         no warnings 'numeric';
1932         $flags += 0;
1933     }
1934     my $sth = $dbh->prepare("SELECT bit, flag, defaulton FROM userflags");
1935     $sth->execute;
1936
1937     while ( my ( $bit, $flag, $defaulton ) = $sth->fetchrow ) {
1938         if ( ( $flags & ( 2**$bit ) ) || $defaulton ) {
1939             $userflags->{$flag} = 1;
1940         }
1941         else {
1942             $userflags->{$flag} = 0;
1943         }
1944     }
1945
1946     # get subpermissions and merge with top-level permissions
1947     my $user_subperms = get_user_subpermissions($userid);
1948     foreach my $module ( keys %$user_subperms ) {
1949         next if $userflags->{$module} == 1;    # user already has permission for everything in this module
1950         $userflags->{$module} = $user_subperms->{$module};
1951     }
1952
1953     return $userflags;
1954 }
1955
1956 =head2 get_user_subpermissions
1957
1958   $user_perm_hashref = get_user_subpermissions($userid);
1959
1960 Given the userid (note, not the borrowernumber) of a staff user,
1961 return a hashref of hashrefs of the specific subpermissions
1962 accorded to the user.  An example return is
1963
1964  {
1965     tools => {
1966         export_catalog => 1,
1967         import_patrons => 1,
1968     }
1969  }
1970
1971 The top-level hash-key is a module or function code from
1972 userflags.flag, while the second-level key is a code
1973 from permissions.
1974
1975 The results of this function do not give a complete picture
1976 of the functions that a staff user can access; it is also
1977 necessary to check borrowers.flags.
1978
1979 =cut
1980
1981 sub get_user_subpermissions {
1982     my $userid = shift;
1983
1984     my $dbh = C4::Context->dbh;
1985     my $sth = $dbh->prepare( "SELECT flag, user_permissions.code
1986                              FROM user_permissions
1987                              JOIN permissions USING (module_bit, code)
1988                              JOIN userflags ON (module_bit = bit)
1989                              JOIN borrowers USING (borrowernumber)
1990                              WHERE userid = ?" );
1991     $sth->execute($userid);
1992
1993     my $user_perms = {};
1994     while ( my $perm = $sth->fetchrow_hashref ) {
1995         $user_perms->{ $perm->{'flag'} }->{ $perm->{'code'} } = 1;
1996     }
1997     return $user_perms;
1998 }
1999
2000 =head2 get_all_subpermissions
2001
2002   my $perm_hashref = get_all_subpermissions();
2003
2004 Returns a hashref of hashrefs defining all specific
2005 permissions currently defined.  The return value
2006 has the same structure as that of C<get_user_subpermissions>,
2007 except that the innermost hash value is the description
2008 of the subpermission.
2009
2010 =cut
2011
2012 sub get_all_subpermissions {
2013     my $dbh = C4::Context->dbh;
2014     my $sth = $dbh->prepare( "SELECT flag, code
2015                              FROM permissions
2016                              JOIN userflags ON (module_bit = bit)" );
2017     $sth->execute();
2018
2019     my $all_perms = {};
2020     while ( my $perm = $sth->fetchrow_hashref ) {
2021         $all_perms->{ $perm->{'flag'} }->{ $perm->{'code'} } = 1;
2022     }
2023     return $all_perms;
2024 }
2025
2026 =head2 haspermission
2027
2028   $flags = ($userid, $flagsrequired);
2029
2030 C<$userid> the userid of the member
2031 C<$flags> is a hashref of required flags like C<$borrower-&lt;{authflags}>
2032
2033 Returns member's flags or 0 if a permission is not met.
2034
2035 =cut
2036
2037 sub haspermission {
2038     my ( $userid, $flagsrequired ) = @_;
2039     my $sth = C4::Context->dbh->prepare("SELECT flags FROM borrowers WHERE userid=?");
2040     $sth->execute($userid);
2041     my $row = $sth->fetchrow();
2042     my $flags = getuserflags( $row, $userid );
2043     if ( $userid eq C4::Context->config('user') ) {
2044
2045         # Super User Account from /etc/koha.conf
2046         $flags->{'superlibrarian'} = 1;
2047     }
2048
2049     return $flags if $flags->{superlibrarian};
2050
2051     foreach my $module ( keys %$flagsrequired ) {
2052         my $subperm = $flagsrequired->{$module};
2053         if ( $subperm eq '*' ) {
2054             return 0 unless ( $flags->{$module} == 1 or ref( $flags->{$module} ) );
2055         } else {
2056             return 0 unless (
2057                 ( defined $flags->{$module} and
2058                     $flags->{$module} == 1 )
2059                 or
2060                 ( ref( $flags->{$module} ) and
2061                     exists $flags->{$module}->{$subperm} and
2062                     $flags->{$module}->{$subperm} == 1 )
2063             );
2064         }
2065     }
2066     return $flags;
2067
2068     #FIXME - This fcn should return the failed permission so a suitable error msg can be delivered.
2069 }
2070
2071 sub getborrowernumber {
2072     my ($userid) = @_;
2073     my $userenv = C4::Context->userenv;
2074     if ( defined($userenv) && ref($userenv) eq 'HASH' && $userenv->{number} ) {
2075         return $userenv->{number};
2076     }
2077     my $dbh = C4::Context->dbh;
2078     for my $field ( 'userid', 'cardnumber' ) {
2079         my $sth =
2080           $dbh->prepare("select borrowernumber from borrowers where $field=?");
2081         $sth->execute($userid);
2082         if ( $sth->rows ) {
2083             my ($bnumber) = $sth->fetchrow;
2084             return $bnumber;
2085         }
2086     }
2087     return 0;
2088 }
2089
2090 END { }    # module clean-up code here (global destructor)
2091 1;
2092 __END__
2093
2094 =head1 SEE ALSO
2095
2096 CGI(3)
2097
2098 C4::Output(3)
2099
2100 Crypt::Eksblowfish::Bcrypt(3)
2101
2102 Digest::MD5(3)
2103
2104 =cut