C4/Auth.pm

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