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