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