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