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