C4/Auth.pm

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