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