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