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