C4/Auth.pm

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