C4/Auth.pm

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