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