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