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