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     my $safe_chars = 'a-zA-Z0-9_\-\/';
 162     die "bad template path" unless $in->{'template_name'} =~ m/^[$safe_chars]+\.tt$/ig; #sanitize input
 163
 164     $in->{'authnotrequired'} ||= 0;
 165     my $template = C4::Templates::gettemplate(
 166         $in->{'template_name'},
 167         $in->{'type'},
 168         $in->{'query'},
 169         $in->{'is_plugin'}
 170     );
 171
 172     if ( $in->{'template_name'} !~ m/maintenance/ ) {
 173         ( $user, $cookie, $sessionID, $flags ) = checkauth(
 174             $in->{'query'},
 175             $in->{'authnotrequired'},
 176             $in->{'flagsrequired'},
 177             $in->{'type'}
 178         );
 179     }
 180
 181     my $borrowernumber;
 182     if ($user) {
 183         require C4::Members;
 184
 185         # It's possible for $user to be the borrowernumber if they don't have a
 186         # userid defined (and are logging in through some other method, such
 187         # as SSL certs against an email address)
 188         $borrowernumber = getborrowernumber($user) if defined($user);
 189         if ( !defined($borrowernumber) && defined($user) ) {
 190             my $borrower = C4::Members::GetMember( borrowernumber => $user );
 191             if ($borrower) {
 192                 $borrowernumber = $user;
 193
 194                 # A bit of a hack, but I don't know there's a nicer way
 195                 # to do it.
 196                 $user = $borrower->{firstname} . ' ' . $borrower->{surname};
 197             }
 198         }
 199
 200         # user info
 201         $template->param( loggedinusername   => $user );
 202         $template->param( loggedinusernumber => $borrowernumber );
 203         $template->param( sessionID          => $sessionID );
 204
 205         if ( $in->{'type'} eq 'opac' ) {
 206             require C4::VirtualShelves;
 207             my ( $total, $pubshelves, $barshelves ) = C4::VirtualShelves::GetSomeShelfNames( $borrowernumber, 'MASTHEAD' );
 208             $template->param(
 209                 pubshelves     => $total->{pubtotal},
 210                 pubshelvesloop => $pubshelves,
 211                 barshelves     => $total->{bartotal},
 212                 barshelvesloop => $barshelves,
 213             );
 214         }
 215
 216         my ($borr) = C4::Members::GetMemberDetails($borrowernumber);
 217         my @bordat;
 218         $bordat[0] = $borr;
 219         $template->param( "USER_INFO" => \@bordat );
 220
 221         my $all_perms = get_all_subpermissions();
 222
 223         my @flagroots = qw(circulate catalogue parameters borrowers permissions reserveforothers borrow
 224           editcatalogue updatecharges management tools editauthorities serials reports acquisition);
 225
 226         # We are going to use the $flags returned by checkauth
 227         # to create the template's parameters that will indicate
 228         # which menus the user can access.
 229         if ( $flags && $flags->{superlibrarian} == 1 ) {
 230             $template->param( CAN_user_circulate        => 1 );
 231             $template->param( CAN_user_catalogue        => 1 );
 232             $template->param( CAN_user_parameters       => 1 );
 233             $template->param( CAN_user_borrowers        => 1 );
 234             $template->param( CAN_user_permissions      => 1 );
 235             $template->param( CAN_user_reserveforothers => 1 );
 236             $template->param( CAN_user_editcatalogue    => 1 );
 237             $template->param( CAN_user_updatecharges    => 1 );
 238             $template->param( CAN_user_acquisition      => 1 );
 239             $template->param( CAN_user_management       => 1 );
 240             $template->param( CAN_user_tools            => 1 );
 241             $template->param( CAN_user_editauthorities  => 1 );
 242             $template->param( CAN_user_serials          => 1 );
 243             $template->param( CAN_user_reports          => 1 );
 244             $template->param( CAN_user_staffaccess      => 1 );
 245             $template->param( CAN_user_plugins          => 1 );
 246             $template->param( CAN_user_coursereserves   => 1 );
 247             foreach my $module ( keys %$all_perms ) {
 248
 249                 foreach my $subperm ( keys %{ $all_perms->{$module} } ) {
 250                     $template->param( "CAN_user_${module}_${subperm}" => 1 );
 251                 }
 252             }
 253         }
 254
 255         if ($flags) {
 256             foreach my $module ( keys %$all_perms ) {
 257                 if ( defined($flags->{$module}) && $flags->{$module} == 1 ) {
 258                     foreach my $subperm ( keys %{ $all_perms->{$module} } ) {
 259                         $template->param( "CAN_user_${module}_${subperm}" => 1 );
 260                     }
 261                 } elsif ( ref( $flags->{$module} ) ) {
 262                     foreach my $subperm ( keys %{ $flags->{$module} } ) {
 263                         $template->param( "CAN_user_${module}_${subperm}" => 1 );
 264                     }
 265                 }
 266             }
 267         }
 268
 269         if ($flags) {
 270             foreach my $module ( keys %$flags ) {
 271                 if ( $flags->{$module} == 1 or ref( $flags->{$module} ) ) {
 272                     $template->param( "CAN_user_$module" => 1 );
 273                     if ( $module eq "parameters" ) {
 274                         $template->param( CAN_user_management => 1 );
 275                     }
 276                 }
 277             }
 278         }
 279
 280         # Logged-in opac search history
 281         # If the requested template is an opac one and opac search history is enabled
 282         if ( $in->{type} eq 'opac' && C4::Context->preference('EnableOpacSearchHistory') ) {
 283             my $dbh   = C4::Context->dbh;
 284             my $query = "SELECT COUNT(*) FROM search_history WHERE userid=?";
 285             my $sth   = $dbh->prepare($query);
 286             $sth->execute($borrowernumber);
 287
 288             # If at least one search has already been performed
 289             if ( $sth->fetchrow_array > 0 ) {
 290
 291                 # We show the link in opac
 292                 $template->param( EnableOpacSearchHistory => 1 );
 293             }
 294
 295             # And if there are searches performed when the user was not logged in,
 296             # we add them to the logged-in search history
 297             my @recentSearches = C4::Search::History::get_from_session( { cgi => $in->{'query'} } );
 298             if (@recentSearches) {
 299                 my $dbh   = C4::Context->dbh;
 300                 my $query = q{
 301                     INSERT INTO search_history(userid, sessionid, query_desc, query_cgi, type,  total, time )
 302                     VALUES (?, ?, ?, ?, ?, ?, ?)
 303                 };
 304
 305                 my $sth = $dbh->prepare($query);
 306                 $sth->execute( $borrowernumber,
 307                     $in->{query}->cookie("CGISESSID"),
 308                     $_->{query_desc},
 309                     $_->{query_cgi},
 310                     $_->{type} || 'biblio',
 311                     $_->{total},
 312                     $_->{time},
 313                 ) foreach @recentSearches;
 314
 315                 # clear out the search history from the session now that
 316                 # we've saved it to the database
 317                 C4::Search::History::set_to_session( { cgi => $in->{'query'}, search_history => [] } );
 318             }
 319         } elsif ( $in->{type} eq 'intranet' and C4::Context->preference('EnableSearchHistory') ) {
 320             $template->param( EnableSearchHistory => 1 );
 321         }
 322     }
 323     else {    # if this is an anonymous session, setup to display public lists...
 324
 325         # If shibboleth is enabled, and we're in an anonymous session, we should allow
 326         # the user to attempt login via shibboleth.
 327         if ($shib) {
 328             $template->param( shibbolethAuthentication => $shib,
 329                 shibbolethLoginUrl => login_shib_url( $in->{'query'} ),
 330             );
 331
 332             # If shibboleth is enabled and we have a shibboleth login attribute,
 333             # but we are in an anonymous session, then we clearly have an invalid
 334             # shibboleth koha account.
 335             if ($shib_login) {
 336                 $template->param( invalidShibLogin => '1' );
 337             }
 338         }
 339
 340         $template->param( sessionID => $sessionID );
 341
 342         if ( $in->{'type'} eq 'opac' ){
 343             require C4::VirtualShelves;
 344             my ( $total, $pubshelves ) = C4::VirtualShelves::GetSomeShelfNames( undef, 'MASTHEAD' );
 345             $template->param(
 346                 pubshelves     => $total->{pubtotal},
 347                 pubshelvesloop => $pubshelves,
 348             );
 349         }
 350     }
 351
 352     # Anonymous opac search history
 353     # If opac search history is enabled and at least one search has already been performed
 354     if ( C4::Context->preference('EnableOpacSearchHistory') ) {
 355         my @recentSearches = C4::Search::History::get_from_session( { cgi => $in->{'query'} } );
 356         if (@recentSearches) {
 357             $template->param( EnableOpacSearchHistory => 1 );
 358         }
 359     }
 360
 361     if ( C4::Context->preference('dateformat') ) {
 362         $template->param( dateformat => C4::Context->preference('dateformat') );
 363     }
 364
 365     # these template parameters are set the same regardless of $in->{'type'}
 366
 367     # Set the using_https variable for templates
 368     # FIXME Under Plack the CGI->https method always returns 'OFF'
 369     my $https = $in->{query}->https();
 370     my $using_https = ( defined $https and $https ne 'OFF' ) ? 1 : 0;
 371
 372     $template->param(
 373         "BiblioDefaultView" . C4::Context->preference("BiblioDefaultView") => 1,
 374         EnhancedMessagingPreferences                                       => C4::Context->preference('EnhancedMessagingPreferences'),
 375         GoogleJackets                                                      => C4::Context->preference("GoogleJackets"),
 376         OpenLibraryCovers                                                  => C4::Context->preference("OpenLibraryCovers"),
 377         KohaAdminEmailAddress                                              => "" . C4::Context->preference("KohaAdminEmailAddress"),
 378         LoginBranchcode => ( C4::Context->userenv ? C4::Context->userenv->{"branch"}    : undef ),
 379         LoginFirstname  => ( C4::Context->userenv ? C4::Context->userenv->{"firstname"} : "Bel" ),
 380         LoginSurname    => C4::Context->userenv ? C4::Context->userenv->{"surname"}      : "Inconnu",
 381         emailaddress    => C4::Context->userenv ? C4::Context->userenv->{"emailaddress"} : undef,
 382         loggedinpersona => C4::Context->userenv ? C4::Context->userenv->{"persona"}      : undef,
 383         TagsEnabled     => C4::Context->preference("TagsEnabled"),
 384         hide_marc       => C4::Context->preference("hide_marc"),
 385         item_level_itypes  => C4::Context->preference('item-level_itypes'),
 386         patronimages       => C4::Context->preference("patronimages"),
 387         singleBranchMode   => C4::Context->preference("singleBranchMode"),
 388         XSLTDetailsDisplay => C4::Context->preference("XSLTDetailsDisplay"),
 389         XSLTResultsDisplay => C4::Context->preference("XSLTResultsDisplay"),
 390         using_https        => $using_https,
 391         noItemTypeImages   => C4::Context->preference("noItemTypeImages"),
 392         marcflavour        => C4::Context->preference("marcflavour"),
 393         persona            => C4::Context->preference("persona"),
 394         OPACBaseURL        => C4::Context->preference('OPACBaseURL'),
 395     );
 396     if ( $in->{'type'} eq "intranet" ) {
 397         $template->param(
 398             AmazonCoverImages                                                          => C4::Context->preference("AmazonCoverImages"),
 399             AutoLocation                                                               => C4::Context->preference("AutoLocation"),
 400             "BiblioDefaultView" . C4::Context->preference("IntranetBiblioDefaultView") => 1,
 401             CircAutocompl                                                              => C4::Context->preference("CircAutocompl"),
 402             FRBRizeEditions                                                            => C4::Context->preference("FRBRizeEditions"),
 403             IndependentBranches                                                        => C4::Context->preference("IndependentBranches"),
 404             IntranetNav                                                                => C4::Context->preference("IntranetNav"),
 405             IntranetmainUserblock                                                      => C4::Context->preference("IntranetmainUserblock"),
 406             LibraryName                                                                => C4::Context->preference("LibraryName"),
 407             LoginBranchname                                                            => ( C4::Context->userenv ? C4::Context->userenv->{"branchname"} : undef ),
 408             advancedMARCEditor                                                         => C4::Context->preference("advancedMARCEditor"),
 409             canreservefromotherbranches                                                => C4::Context->preference('canreservefromotherbranches'),
 410             intranetcolorstylesheet                                                    => C4::Context->preference("intranetcolorstylesheet"),
 411             IntranetFavicon                                                            => C4::Context->preference("IntranetFavicon"),
 412             intranetreadinghistory                                                     => C4::Context->preference("intranetreadinghistory"),
 413             intranetstylesheet                                                         => C4::Context->preference("intranetstylesheet"),
 414             IntranetUserCSS                                                            => C4::Context->preference("IntranetUserCSS"),
 415             IntranetUserJS                                                             => C4::Context->preference("IntranetUserJS"),
 416             intranetbookbag                                                            => C4::Context->preference("intranetbookbag"),
 417             suggestion                                                                 => C4::Context->preference("suggestion"),
 418             virtualshelves                                                             => C4::Context->preference("virtualshelves"),
 419             StaffSerialIssueDisplayCount                                               => C4::Context->preference("StaffSerialIssueDisplayCount"),
 420             EasyAnalyticalRecords                                                      => C4::Context->preference('EasyAnalyticalRecords'),
 421             LocalCoverImages                                                           => C4::Context->preference('LocalCoverImages'),
 422             OPACLocalCoverImages                                                       => C4::Context->preference('OPACLocalCoverImages'),
 423             AllowMultipleCovers                                                        => C4::Context->preference('AllowMultipleCovers'),
 424             EnableBorrowerFiles                                                        => C4::Context->preference('EnableBorrowerFiles'),
 425             UseKohaPlugins                                                             => C4::Context->preference('UseKohaPlugins'),
 426             UseCourseReserves                                                          => C4::Context->preference("UseCourseReserves"),
 427             useDischarge                                                               => C4::Context->preference('useDischarge'),
 428         );
 429     }
 430     else {
 431         warn "template type should be OPAC, here it is=[" . $in->{'type'} . "]" unless ( $in->{'type'} eq 'opac' );
 432
 433         #TODO : replace LibraryName syspref with 'system name', and remove this html processing
 434         my $LibraryNameTitle = C4::Context->preference("LibraryName");
 435         $LibraryNameTitle =~ s/<(?:\/?)(?:br|p)\s*(?:\/?)>/ /sgi;
 436         $LibraryNameTitle =~ s/<(?:[^<>'"]|'(?:[^']*)'|"(?:[^"]*)")*>//sg;
 437
 438         # clean up the busc param in the session
 439         # if the page is not opac-detail and not the "add to list" page
 440         # and not the "edit comments" page
 441         if ( C4::Context->preference("OpacBrowseResults")
 442             && $in->{'template_name'} =~ /opac-(.+)\.(?:tt|tmpl)$/ ) {
 443             my $pagename = $1;
 444             unless ( $pagename =~ /^(?:MARC|ISBD)?detail$/
 445                 or $pagename =~ /^addbybiblionumber$/
 446                 or $pagename =~ /^review$/ ) {
 447                 my $sessionSearch = get_session( $sessionID || $in->{'query'}->cookie("CGISESSID") );
 448                 $sessionSearch->clear( ["busc"] ) if ( $sessionSearch->param("busc") );
 449             }
 450         }
 451
 452         # variables passed from CGI: opac_css_override and opac_search_limits.
 453         my $opac_search_limit   = $ENV{'OPAC_SEARCH_LIMIT'};
 454         my $opac_limit_override = $ENV{'OPAC_LIMIT_OVERRIDE'};
 455         my $opac_name           = '';
 456         if (
 457             ( $opac_limit_override && $opac_search_limit && $opac_search_limit =~ /branch:(\w+)/ ) ||
 458             ( $in->{'query'}->param('limit') && $in->{'query'}->param('limit') =~ /branch:(\w+)/ ) ||
 459             ( $in->{'query'}->param('multibranchlimit') && $in->{'query'}->param('multibranchlimit') =~ /multibranchlimit-(\w+)/ )
 460           ) {
 461             $opac_name = $1;    # opac_search_limit is a branch, so we use it.
 462         } elsif ( $in->{'query'}->param('multibranchlimit') ) {
 463             $opac_name = $in->{'query'}->param('multibranchlimit');
 464         } elsif ( C4::Context->preference("SearchMyLibraryFirst") && C4::Context->userenv && C4::Context->userenv->{'branch'} ) {
 465             $opac_name = C4::Context->userenv->{'branch'};
 466         }
 467
 468         $template->param(
 469             OpacAdditionalStylesheet                   => C4::Context->preference("OpacAdditionalStylesheet"),
 470             AnonSuggestions                       => "" . C4::Context->preference("AnonSuggestions"),
 471             AuthorisedValueImages                 => C4::Context->preference("AuthorisedValueImages"),
 472             BranchesLoop                          => GetBranchesLoop($opac_name),
 473             BranchCategoriesLoop                  => GetBranchCategories( 'searchdomain', 1, $opac_name ),
 474             LibraryName                           => "" . C4::Context->preference("LibraryName"),
 475             LibraryNameTitle                      => "" . $LibraryNameTitle,
 476             LoginBranchname                       => C4::Context->userenv ? C4::Context->userenv->{"branchname"} : "",
 477             OPACAmazonCoverImages                 => C4::Context->preference("OPACAmazonCoverImages"),
 478             OPACFRBRizeEditions                   => C4::Context->preference("OPACFRBRizeEditions"),
 479             OpacHighlightedWords                  => C4::Context->preference("OpacHighlightedWords"),
 480             OPACShelfBrowser                      => "" . C4::Context->preference("OPACShelfBrowser"),
 481             OPACURLOpenInNewWindow                => "" . C4::Context->preference("OPACURLOpenInNewWindow"),
 482             OPACUserCSS                           => "" . C4::Context->preference("OPACUserCSS"),
 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 being 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 don't 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 successful, 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     $template->param(
1249         LibraryName => C4::Context->preference("LibraryName"),
1250     );
1251     $template->param(%info);
1252
1253     #    $cookie = $query->cookie(CGISESSID => $session->id
1254     #   );
1255     print $query->header(
1256         -type    => 'text/html',
1257         -charset => 'utf-8',
1258         -cookie  => $cookie
1259       ),
1260       $template->output;
1261     safe_exit;
1262 }
1263
1264 =head2 check_api_auth
1265
1266   ($status, $cookie, $sessionId) = check_api_auth($query, $userflags);
1267
1268 Given a CGI query containing the parameters 'userid' and 'password' and/or a session
1269 cookie, determine if the user has the privileges specified by C<$userflags>.
1270
1271 C<check_api_auth> is is meant for authenticating users of web services, and
1272 consequently will always return and will not attempt to redirect the user
1273 agent.
1274
1275 If a valid session cookie is already present, check_api_auth will return a status
1276 of "ok", the cookie, and the Koha session ID.
1277
1278 If no session cookie is present, check_api_auth will check the 'userid' and 'password
1279 parameters and create a session cookie and Koha session if the supplied credentials
1280 are OK.
1281
1282 Possible return values in C<$status> are:
1283
1284 =over
1285
1286 =item "ok" -- user authenticated; C<$cookie> and C<$sessionid> have valid values.
1287
1288 =item "failed" -- credentials are not correct; C<$cookie> and C<$sessionid> are undef
1289
1290 =item "maintenance" -- DB is in maintenance mode; no login possible at the moment
1291
1292 =item "expired -- session cookie has expired; API user should resubmit userid and password
1293
1294 =back
1295
1296 =cut
1297
1298 sub check_api_auth {
1299     my $query         = shift;
1300     my $flagsrequired = shift;
1301
1302     my $dbh     = C4::Context->dbh;
1303     my $timeout = _timeout_syspref();
1304
1305     unless ( C4::Context->preference('Version') ) {
1306
1307         # database has not been installed yet
1308         return ( "maintenance", undef, undef );
1309     }
1310     my $kohaversion = Koha::version();
1311     $kohaversion =~ s/(.*\..*)\.(.*)\.(.*)/$1$2$3/;
1312     if ( C4::Context->preference('Version') < $kohaversion ) {
1313
1314         # database in need of version update; assume that
1315         # no API should be called while databsae is in
1316         # this condition.
1317         return ( "maintenance", undef, undef );
1318     }
1319
1320     # FIXME -- most of what follows is a copy-and-paste
1321     # of code from checkauth.  There is an obvious need
1322     # for refactoring to separate the various parts of
1323     # the authentication code, but as of 2007-11-19 this
1324     # is deferred so as to not introduce bugs into the
1325     # regular authentication code for Koha 3.0.
1326
1327     # see if we have a valid session cookie already
1328     # however, if a userid parameter is present (i.e., from
1329     # a form submission, assume that any current cookie
1330     # is to be ignored
1331     my $sessionID = undef;
1332     unless ( $query->param('userid') ) {
1333         $sessionID = $query->cookie("CGISESSID");
1334     }
1335     if ( $sessionID && not( $cas && $query->param('PT') ) ) {
1336         my $session = get_session($sessionID);
1337         C4::Context->_new_userenv($sessionID);
1338         if ($session) {
1339             C4::Context->set_userenv(
1340                 $session->param('number'),       $session->param('id'),
1341                 $session->param('cardnumber'),   $session->param('firstname'),
1342                 $session->param('surname'),      $session->param('branch'),
1343                 $session->param('branchname'),   $session->param('flags'),
1344                 $session->param('emailaddress'), $session->param('branchprinter')
1345             );
1346
1347             my $ip       = $session->param('ip');
1348             my $lasttime = $session->param('lasttime');
1349             my $userid   = $session->param('id');
1350             if ( $lasttime < time() - $timeout ) {
1351
1352                 # time out
1353                 $session->delete();
1354                 $session->flush;
1355                 C4::Context->_unset_userenv($sessionID);
1356                 $userid    = undef;
1357                 $sessionID = undef;
1358                 return ( "expired", undef, undef );
1359             } elsif ( C4::Context->preference('SessionRestrictionByIP') && $ip ne $ENV{'REMOTE_ADDR'} ) {
1360
1361                 # IP address changed
1362                 $session->delete();
1363                 $session->flush;
1364                 C4::Context->_unset_userenv($sessionID);
1365                 $userid    = undef;
1366                 $sessionID = undef;
1367                 return ( "expired", undef, undef );
1368             } else {
1369                 my $cookie = $query->cookie(
1370                     -name     => 'CGISESSID',
1371                     -value    => $session->id,
1372                     -HttpOnly => 1,
1373                 );
1374                 $session->param( 'lasttime', time() );
1375                 my $flags = haspermission( $userid, $flagsrequired );
1376                 if ($flags) {
1377                     return ( "ok", $cookie, $sessionID );
1378                 } else {
1379                     $session->delete();
1380                     $session->flush;
1381                     C4::Context->_unset_userenv($sessionID);
1382                     $userid    = undef;
1383                     $sessionID = undef;
1384                     return ( "failed", undef, undef );
1385                 }
1386             }
1387         } else {
1388             return ( "expired", undef, undef );
1389         }
1390     } else {
1391
1392         # new login
1393         my $userid   = $query->param('userid');
1394         my $password = $query->param('password');
1395         my ( $return, $cardnumber );
1396
1397         # Proxy CAS auth
1398         if ( $cas && $query->param('PT') ) {
1399             my $retuserid;
1400             $debug and print STDERR "## check_api_auth - checking CAS\n";
1401
1402             # In case of a CAS authentication, we use the ticket instead of the password
1403             my $PT = $query->param('PT');
1404             ( $return, $cardnumber, $userid ) = check_api_auth_cas( $dbh, $PT, $query );    # EXTERNAL AUTH
1405         } else {
1406
1407             # User / password auth
1408             unless ( $userid and $password ) {
1409
1410                 # caller did something wrong, fail the authenticateion
1411                 return ( "failed", undef, undef );
1412             }
1413             ( $return, $cardnumber ) = checkpw( $dbh, $userid, $password, $query );
1414         }
1415
1416         if ( $return and haspermission( $userid, $flagsrequired ) ) {
1417             my $session = get_session("");
1418             return ( "failed", undef, undef ) unless $session;
1419
1420             my $sessionID = $session->id;
1421             C4::Context->_new_userenv($sessionID);
1422             my $cookie = $query->cookie(
1423                 -name     => 'CGISESSID',
1424                 -value    => $sessionID,
1425                 -HttpOnly => 1,
1426             );
1427             if ( $return == 1 ) {
1428                 my (
1429                     $borrowernumber, $firstname,  $surname,
1430                     $userflags,      $branchcode, $branchname,
1431                     $branchprinter,  $emailaddress
1432                 );
1433                 my $sth =
1434                   $dbh->prepare(
1435 "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=?"
1436                   );
1437                 $sth->execute($userid);
1438                 (
1439                     $borrowernumber, $firstname,  $surname,
1440                     $userflags,      $branchcode, $branchname,
1441                     $branchprinter,  $emailaddress
1442                 ) = $sth->fetchrow if ( $sth->rows );
1443
1444                 unless ( $sth->rows ) {
1445                     my $sth = $dbh->prepare(
1446 "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=?"
1447                     );
1448                     $sth->execute($cardnumber);
1449                     (
1450                         $borrowernumber, $firstname,  $surname,
1451                         $userflags,      $branchcode, $branchname,
1452                         $branchprinter,  $emailaddress
1453                     ) = $sth->fetchrow if ( $sth->rows );
1454
1455                     unless ( $sth->rows ) {
1456                         $sth->execute($userid);
1457                         (
1458                             $borrowernumber, $firstname,  $surname,       $userflags,
1459                             $branchcode,     $branchname, $branchprinter, $emailaddress
1460                         ) = $sth->fetchrow if ( $sth->rows );
1461                     }
1462                 }
1463
1464                 my $ip = $ENV{'REMOTE_ADDR'};
1465
1466                 # if they specify at login, use that
1467                 if ( $query->param('branch') ) {
1468                     $branchcode = $query->param('branch');
1469                     $branchname = GetBranchName($branchcode);
1470                 }
1471                 my $branches = GetBranches();
1472                 my @branchesloop;
1473                 foreach my $br ( keys %$branches ) {
1474
1475                     #     now we work with the treatment of ip
1476                     my $domain = $branches->{$br}->{'branchip'};
1477                     if ( $domain && $ip =~ /^$domain/ ) {
1478                         $branchcode = $branches->{$br}->{'branchcode'};
1479
1480                         # new op dev : add the branchprinter and branchname in the cookie
1481                         $branchprinter = $branches->{$br}->{'branchprinter'};
1482                         $branchname    = $branches->{$br}->{'branchname'};
1483                     }
1484                 }
1485                 $session->param( 'number',       $borrowernumber );
1486                 $session->param( 'id',           $userid );
1487                 $session->param( 'cardnumber',   $cardnumber );
1488                 $session->param( 'firstname',    $firstname );
1489                 $session->param( 'surname',      $surname );
1490                 $session->param( 'branch',       $branchcode );
1491                 $session->param( 'branchname',   $branchname );
1492                 $session->param( 'flags',        $userflags );
1493                 $session->param( 'emailaddress', $emailaddress );
1494                 $session->param( 'ip',           $session->remote_addr() );
1495                 $session->param( 'lasttime',     time() );
1496             } elsif ( $return == 2 ) {
1497
1498                 #We suppose the user is the superlibrarian
1499                 $session->param( 'number',       0 );
1500                 $session->param( 'id',           C4::Context->config('user') );
1501                 $session->param( 'cardnumber',   C4::Context->config('user') );
1502                 $session->param( 'firstname',    C4::Context->config('user') );
1503                 $session->param( 'surname',      C4::Context->config('user') );
1504                 $session->param( 'branch',       'NO_LIBRARY_SET' );
1505                 $session->param( 'branchname',   'NO_LIBRARY_SET' );
1506                 $session->param( 'flags',        1 );
1507                 $session->param( 'emailaddress', C4::Context->preference('KohaAdminEmailAddress') );
1508                 $session->param( 'ip',           $session->remote_addr() );
1509                 $session->param( 'lasttime',     time() );
1510             }
1511             C4::Context->set_userenv(
1512                 $session->param('number'),       $session->param('id'),
1513                 $session->param('cardnumber'),   $session->param('firstname'),
1514                 $session->param('surname'),      $session->param('branch'),
1515                 $session->param('branchname'),   $session->param('flags'),
1516                 $session->param('emailaddress'), $session->param('branchprinter')
1517             );
1518             return ( "ok", $cookie, $sessionID );
1519         } else {
1520             return ( "failed", undef, undef );
1521         }
1522     }
1523 }
1524
1525 =head2 check_cookie_auth
1526
1527   ($status, $sessionId) = check_api_auth($cookie, $userflags);
1528
1529 Given a CGISESSID cookie set during a previous login to Koha, determine
1530 if the user has the privileges specified by C<$userflags>.
1531
1532 C<check_cookie_auth> is meant for authenticating special services
1533 such as tools/upload-file.pl that are invoked by other pages that
1534 have been authenticated in the usual way.
1535
1536 Possible return values in C<$status> are:
1537
1538 =over
1539
1540 =item "ok" -- user authenticated; C<$sessionID> have valid values.
1541
1542 =item "failed" -- credentials are not correct; C<$sessionid> are undef
1543
1544 =item "maintenance" -- DB is in maintenance mode; no login possible at the moment
1545
1546 =item "expired -- session cookie has expired; API user should resubmit userid and password
1547
1548 =back
1549
1550 =cut
1551
1552 sub check_cookie_auth {
1553     my $cookie        = shift;
1554     my $flagsrequired = shift;
1555
1556     my $dbh     = C4::Context->dbh;
1557     my $timeout = _timeout_syspref();
1558
1559     unless ( C4::Context->preference('Version') ) {
1560
1561         # database has not been installed yet
1562         return ( "maintenance", undef );
1563     }
1564     my $kohaversion = Koha::version();
1565     $kohaversion =~ s/(.*\..*)\.(.*)\.(.*)/$1$2$3/;
1566     if ( C4::Context->preference('Version') < $kohaversion ) {
1567
1568         # database in need of version update; assume that
1569         # no API should be called while databsae is in
1570         # this condition.
1571         return ( "maintenance", undef );
1572     }
1573
1574     # FIXME -- most of what follows is a copy-and-paste
1575     # of code from checkauth.  There is an obvious need
1576     # for refactoring to separate the various parts of
1577     # the authentication code, but as of 2007-11-23 this
1578     # is deferred so as to not introduce bugs into the
1579     # regular authentication code for Koha 3.0.
1580
1581     # see if we have a valid session cookie already
1582     # however, if a userid parameter is present (i.e., from
1583     # a form submission, assume that any current cookie
1584     # is to be ignored
1585     unless ( defined $cookie and $cookie ) {
1586         return ( "failed", undef );
1587     }
1588     my $sessionID = $cookie;
1589     my $session   = get_session($sessionID);
1590     C4::Context->_new_userenv($sessionID);
1591     if ($session) {
1592         C4::Context->set_userenv(
1593             $session->param('number'),       $session->param('id'),
1594             $session->param('cardnumber'),   $session->param('firstname'),
1595             $session->param('surname'),      $session->param('branch'),
1596             $session->param('branchname'),   $session->param('flags'),
1597             $session->param('emailaddress'), $session->param('branchprinter')
1598         );
1599
1600         my $ip       = $session->param('ip');
1601         my $lasttime = $session->param('lasttime');
1602         my $userid   = $session->param('id');
1603         if ( $lasttime < time() - $timeout ) {
1604
1605             # time out
1606             $session->delete();
1607             $session->flush;
1608             C4::Context->_unset_userenv($sessionID);
1609             $userid    = undef;
1610             $sessionID = undef;
1611             return ("expired", undef);
1612         } elsif ( C4::Context->preference('SessionRestrictionByIP') && $ip ne $ENV{'REMOTE_ADDR'} ) {
1613
1614             # IP address changed
1615             $session->delete();
1616             $session->flush;
1617             C4::Context->_unset_userenv($sessionID);
1618             $userid    = undef;
1619             $sessionID = undef;
1620             return ( "expired", undef );
1621         } else {
1622             $session->param( 'lasttime', time() );
1623             my $flags = haspermission( $userid, $flagsrequired );
1624             if ($flags) {
1625                 return ( "ok", $sessionID );
1626             } else {
1627                 $session->delete();
1628                 $session->flush;
1629                 C4::Context->_unset_userenv($sessionID);
1630                 $userid    = undef;
1631                 $sessionID = undef;
1632                 return ( "failed", undef );
1633             }
1634         }
1635     } else {
1636         return ( "expired", undef );
1637     }
1638 }
1639
1640 =head2 get_session
1641
1642   use CGI::Session;
1643   my $session = get_session($sessionID);
1644
1645 Given a session ID, retrieve the CGI::Session object used to store
1646 the session's state.  The session object can be used to store
1647 data that needs to be accessed by different scripts during a
1648 user's session.
1649
1650 If the C<$sessionID> parameter is an empty string, a new session
1651 will be created.
1652
1653 =cut
1654
1655 sub get_session {
1656     my $sessionID      = shift;
1657     my $storage_method = C4::Context->preference('SessionStorage');
1658     my $dbh            = C4::Context->dbh;
1659     my $session;
1660     if ( $storage_method eq 'mysql' ) {
1661         $session = new CGI::Session( "driver:MySQL;serializer:yaml;id:md5", $sessionID, { Handle => $dbh } );
1662     }
1663     elsif ( $storage_method eq 'Pg' ) {
1664         $session = new CGI::Session( "driver:PostgreSQL;serializer:yaml;id:md5", $sessionID, { Handle => $dbh } );
1665     }
1666     elsif ( $storage_method eq 'memcached' && C4::Context->ismemcached ) {
1667         $session = new CGI::Session( "driver:memcached;serializer:yaml;id:md5", $sessionID, { Memcached => C4::Context->memcached } );
1668     }
1669     else {
1670         # catch all defaults to tmp should work on all systems
1671         $session = new CGI::Session( "driver:File;serializer:yaml;id:md5", $sessionID, { Directory => '/tmp' } );
1672     }
1673     return $session;
1674 }
1675
1676 sub checkpw {
1677     my ( $dbh, $userid, $password, $query, $type ) = @_;
1678     $type = 'opac' unless $type;
1679     if ($ldap) {
1680         $debug and print STDERR "## checkpw - checking LDAP\n";
1681         my ( $retval, $retcard, $retuserid ) = checkpw_ldap(@_);    # EXTERNAL AUTH
1682         return 0 if $retval == -1;                                  # Incorrect password for LDAP login attempt
1683         ($retval) and return ( $retval, $retcard, $retuserid );
1684     }
1685
1686     if ( $cas && $query && $query->param('ticket') ) {
1687         $debug and print STDERR "## checkpw - checking CAS\n";
1688
1689         # In case of a CAS authentication, we use the ticket instead of the password
1690         my $ticket = $query->param('ticket');
1691         $query->delete('ticket');                                   # remove ticket to come back to original URL
1692         my ( $retval, $retcard, $retuserid ) = checkpw_cas( $dbh, $ticket, $query, $type );    # EXTERNAL AUTH
1693         ($retval) and return ( $retval, $retcard, $retuserid );
1694         return 0;
1695     }
1696
1697     # If we are in a shibboleth session (shibboleth is enabled, and a shibboleth match attribute is present)
1698     # Check for password to asertain whether we want to be testing against shibboleth or another method this
1699     # time around.
1700     if ( $shib && $shib_login && !$password ) {
1701
1702         $debug and print STDERR "## checkpw - checking Shibboleth\n";
1703
1704         # In case of a Shibboleth authentication, we expect a shibboleth user attribute
1705         # (defined under shibboleth mapping in koha-conf.xml) to contain the login of the
1706         # shibboleth-authenticated user
1707
1708         # Then, we check if it matches a valid koha user
1709         if ($shib_login) {
1710             my ( $retval, $retcard, $retuserid ) = C4::Auth_with_shibboleth::checkpw_shib($shib_login);    # EXTERNAL AUTH
1711             ($retval) and return ( $retval, $retcard, $retuserid );
1712             return 0;
1713         }
1714     }
1715
1716     # INTERNAL AUTH
1717     return checkpw_internal(@_)
1718 }
1719
1720 sub checkpw_internal {
1721     my ( $dbh, $userid, $password ) = @_;
1722
1723     $password = Encode::encode( 'UTF-8', $password )
1724       if Encode::is_utf8($password);
1725
1726     if ( $userid && $userid eq C4::Context->config('user') ) {
1727         if ( $password && $password eq C4::Context->config('pass') ) {
1728
1729             # Koha superuser account
1730             #     C4::Context->set_userenv(0,0,C4::Context->config('user'),C4::Context->config('user'),C4::Context->config('user'),"",1);
1731             return 2;
1732         }
1733         else {
1734             return 0;
1735         }
1736     }
1737
1738     my $sth =
1739       $dbh->prepare(
1740         "select password,cardnumber,borrowernumber,userid,firstname,surname,borrowers.branchcode,branches.branchname,flags from borrowers join branches on borrowers.branchcode=branches.branchcode where userid=?"
1741       );
1742     $sth->execute($userid);
1743     if ( $sth->rows ) {
1744         my ( $stored_hash, $cardnumber, $borrowernumber, $userid, $firstname,
1745             $surname, $branchcode, $branchname, $flags )
1746           = $sth->fetchrow;
1747
1748         if ( checkpw_hash( $password, $stored_hash ) ) {
1749
1750             C4::Context->set_userenv( "$borrowernumber", $userid, $cardnumber,
1751                 $firstname, $surname, $branchcode, $branchname, $flags );
1752             return 1, $cardnumber, $userid;
1753         }
1754     }
1755     $sth =
1756       $dbh->prepare(
1757         "select password,cardnumber,borrowernumber,userid,firstname,surname,borrowers.branchcode,branches.branchname,flags from borrowers join branches on borrowers.branchcode=branches.branchcode where cardnumber=?"
1758       );
1759     $sth->execute($userid);
1760     if ( $sth->rows ) {
1761         my ( $stored_hash, $cardnumber, $borrowernumber, $userid, $firstname,
1762             $surname, $branchcode, $branchname, $flags )
1763           = $sth->fetchrow;
1764
1765         if ( checkpw_hash( $password, $stored_hash ) ) {
1766
1767             C4::Context->set_userenv( $borrowernumber, $userid, $cardnumber,
1768                 $firstname, $surname, $branchcode, $branchname, $flags );
1769             return 1, $cardnumber, $userid;
1770         }
1771     }
1772     if ( $userid && $userid eq 'demo'
1773         && "$password" eq 'demo'
1774         && C4::Context->config('demo') )
1775     {
1776
1777         # DEMO => the demo user is allowed to do everything (if demo set to 1 in koha.conf
1778         # some features won't be effective : modify systempref, modify MARC structure,
1779         return 2;
1780     }
1781     return 0;
1782 }
1783
1784 sub checkpw_hash {
1785     my ( $password, $stored_hash ) = @_;
1786
1787     return if $stored_hash eq '!';
1788
1789     # check what encryption algorithm was implemented: Bcrypt - if the hash starts with '$2' it is Bcrypt else md5
1790     my $hash;
1791     if ( substr( $stored_hash, 0, 2 ) eq '$2' ) {
1792         $hash = hash_password( $password, $stored_hash );
1793     } else {
1794         $hash = md5_base64($password);
1795     }
1796     return $hash eq $stored_hash;
1797 }
1798
1799 =head2 getuserflags
1800
1801     my $authflags = getuserflags($flags, $userid, [$dbh]);
1802
1803 Translates integer flags into permissions strings hash.
1804
1805 C<$flags> is the integer userflags value ( borrowers.userflags )
1806 C<$userid> is the members.userid, used for building subpermissions
1807 C<$authflags> is a hashref of permissions
1808
1809 =cut
1810
1811 sub getuserflags {
1812     my $flags  = shift;
1813     my $userid = shift;
1814     my $dbh    = @_ ? shift : C4::Context->dbh;
1815     my $userflags;
1816     {
1817         # I don't want to do this, but if someone logs in as the database
1818         # user, it would be preferable not to spam them to death with
1819         # numeric warnings. So, we make $flags numeric.
1820         no warnings 'numeric';
1821         $flags += 0;
1822     }
1823     my $sth = $dbh->prepare("SELECT bit, flag, defaulton FROM userflags");
1824     $sth->execute;
1825
1826     while ( my ( $bit, $flag, $defaulton ) = $sth->fetchrow ) {
1827         if ( ( $flags & ( 2**$bit ) ) || $defaulton ) {
1828             $userflags->{$flag} = 1;
1829         }
1830         else {
1831             $userflags->{$flag} = 0;
1832         }
1833     }
1834
1835     # get subpermissions and merge with top-level permissions
1836     my $user_subperms = get_user_subpermissions($userid);
1837     foreach my $module ( keys %$user_subperms ) {
1838         next if $userflags->{$module} == 1;    # user already has permission for everything in this module
1839         $userflags->{$module} = $user_subperms->{$module};
1840     }
1841
1842     return $userflags;
1843 }
1844
1845 =head2 get_user_subpermissions
1846
1847   $user_perm_hashref = get_user_subpermissions($userid);
1848
1849 Given the userid (note, not the borrowernumber) of a staff user,
1850 return a hashref of hashrefs of the specific subpermissions
1851 accorded to the user.  An example return is
1852
1853  {
1854     tools => {
1855         export_catalog => 1,
1856         import_patrons => 1,
1857     }
1858  }
1859
1860 The top-level hash-key is a module or function code from
1861 userflags.flag, while the second-level key is a code
1862 from permissions.
1863
1864 The results of this function do not give a complete picture
1865 of the functions that a staff user can access; it is also
1866 necessary to check borrowers.flags.
1867
1868 =cut
1869
1870 sub get_user_subpermissions {
1871     my $userid = shift;
1872
1873     my $dbh = C4::Context->dbh;
1874     my $sth = $dbh->prepare( "SELECT flag, user_permissions.code
1875                              FROM user_permissions
1876                              JOIN permissions USING (module_bit, code)
1877                              JOIN userflags ON (module_bit = bit)
1878                              JOIN borrowers USING (borrowernumber)
1879                              WHERE userid = ?" );
1880     $sth->execute($userid);
1881
1882     my $user_perms = {};
1883     while ( my $perm = $sth->fetchrow_hashref ) {
1884         $user_perms->{ $perm->{'flag'} }->{ $perm->{'code'} } = 1;
1885     }
1886     return $user_perms;
1887 }
1888
1889 =head2 get_all_subpermissions
1890
1891   my $perm_hashref = get_all_subpermissions();
1892
1893 Returns a hashref of hashrefs defining all specific
1894 permissions currently defined.  The return value
1895 has the same structure as that of C<get_user_subpermissions>,
1896 except that the innermost hash value is the description
1897 of the subpermission.
1898
1899 =cut
1900
1901 sub get_all_subpermissions {
1902     my $dbh = C4::Context->dbh;
1903     my $sth = $dbh->prepare( "SELECT flag, code, description
1904                              FROM permissions
1905                              JOIN userflags ON (module_bit = bit)" );
1906     $sth->execute();
1907
1908     my $all_perms = {};
1909     while ( my $perm = $sth->fetchrow_hashref ) {
1910         $all_perms->{ $perm->{'flag'} }->{ $perm->{'code'} } = $perm->{'description'};
1911     }
1912     return $all_perms;
1913 }
1914
1915 =head2 haspermission
1916
1917   $flags = ($userid, $flagsrequired);
1918
1919 C<$userid> the userid of the member
1920 C<$flags> is a hashref of required flags like C<$borrower-&lt;{authflags}>
1921
1922 Returns member's flags or 0 if a permission is not met.
1923
1924 =cut
1925
1926 sub haspermission {
1927     my ( $userid, $flagsrequired ) = @_;
1928     my $sth = C4::Context->dbh->prepare("SELECT flags FROM borrowers WHERE userid=?");
1929     $sth->execute($userid);
1930     my $row = $sth->fetchrow();
1931     my $flags = getuserflags( $row, $userid );
1932     if ( $userid eq C4::Context->config('user') ) {
1933
1934         # Super User Account from /etc/koha.conf
1935         $flags->{'superlibrarian'} = 1;
1936     }
1937     elsif ( $userid eq 'demo' && C4::Context->config('demo') ) {
1938
1939         # Demo user that can do "anything" (demo=1 in /etc/koha.conf)
1940         $flags->{'superlibrarian'} = 1;
1941     }
1942
1943     return $flags if $flags->{superlibrarian};
1944
1945     foreach my $module ( keys %$flagsrequired ) {
1946         my $subperm = $flagsrequired->{$module};
1947         if ( $subperm eq '*' ) {
1948             return 0 unless ( $flags->{$module} == 1 or ref( $flags->{$module} ) );
1949         } else {
1950             return 0 unless (
1951                 ( defined $flags->{$module} and
1952                     $flags->{$module} == 1 )
1953                 or
1954                 ( ref( $flags->{$module} ) and
1955                     exists $flags->{$module}->{$subperm} and
1956                     $flags->{$module}->{$subperm} == 1 )
1957             );
1958         }
1959     }
1960     return $flags;
1961
1962     #FIXME - This fcn should return the failed permission so a suitable error msg can be delivered.
1963 }
1964
1965 sub getborrowernumber {
1966     my ($userid) = @_;
1967     my $userenv = C4::Context->userenv;
1968     if ( defined($userenv) && ref($userenv) eq 'HASH' && $userenv->{number} ) {
1969         return $userenv->{number};
1970     }
1971     my $dbh = C4::Context->dbh;
1972     for my $field ( 'userid', 'cardnumber' ) {
1973         my $sth =
1974           $dbh->prepare("select borrowernumber from borrowers where $field=?");
1975         $sth->execute($userid);
1976         if ( $sth->rows ) {
1977             my ($bnumber) = $sth->fetchrow;
1978             return $bnumber;
1979         }
1980     }
1981     return 0;
1982 }
1983
1984 END { }    # module clean-up code here (global destructor)
1985 1;
1986 __END__
1987
1988 =head1 SEE ALSO
1989
1990 CGI(3)
1991
1992 C4::Output(3)
1993
1994 Crypt::Eksblowfish::Bcrypt(3)
1995
1996 Digest::MD5(3)
1997
1998 =cut