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