C4/Auth.pm

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