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         );
 640         $loggedin = 1;
 641     }
 642     elsif ( $sessionID = $query->cookie("CGISESSID")) {     # assignment, not comparison
 643         my $session = get_session($sessionID);
 644         C4::Context->_new_userenv($sessionID);
 645         my ($ip, $lasttime, $sessiontype);
 646         if ($session){
 647             C4::Context::set_userenv(
 648                 $session->param('number'),       $session->param('id'),
 649                 $session->param('cardnumber'),   $session->param('firstname'),
 650                 $session->param('surname'),      $session->param('branch'),
 651                 $session->param('branchname'),   $session->param('flags'),
 652                 $session->param('emailaddress'), $session->param('branchprinter')
 653             );
 654             C4::Context::set_shelves_userenv('bar',$session->param('barshelves'));
 655             C4::Context::set_shelves_userenv('pub',$session->param('pubshelves'));
 656             C4::Context::set_shelves_userenv('tot',$session->param('totshelves'));
 657             $debug and printf STDERR "AUTH_SESSION: (%s)\t%s %s - %s\n", map {$session->param($_)} qw(cardnumber firstname surname branch) ;
 658             $ip       = $session->param('ip');
 659             $lasttime = $session->param('lasttime');
 660             $userid   = $session->param('id');
 661             $sessiontype = $session->param('sessiontype') || '';
 662         }
 663         if ( ( ($query->param('koha_login_context')) && ($query->param('userid') ne $session->param('id')) )
 664           || ( $cas && $query->param('ticket') ) ) {
 665             #if a user enters an id ne to the id in the current session, we need to log them in...
 666             #first we need to clear the anonymous session...
 667             $debug and warn "query id = " . $query->param('userid') . " but session id = " . $session->param('id');
 668             $session->flush;
 669             $session->delete();
 670             C4::Context->_unset_userenv($sessionID);
 671                         $sessionID = undef;
 672                         $userid = undef;
 673                 }
 674         elsif ($logout) {
 675             # voluntary logout the user
 676             $session->flush;
 677             $session->delete();
 678             C4::Context->_unset_userenv($sessionID);
 679             #_session_log(sprintf "%20s from %16s logged out at %30s (manually).\n", $userid,$ip,(strftime "%c",localtime));
 680             $sessionID = undef;
 681             $userid    = undef;
 682
 683             if ($cas and $caslogout) {
 684                 logout_cas($query);
 685             }
 686         }
 687         elsif ( $lasttime < time() - $timeout ) {
 688             # timed logout
 689             $info{'timed_out'} = 1;
 690             $session->delete() if $session;
 691             C4::Context->_unset_userenv($sessionID);
 692             #_session_log(sprintf "%20s from %16s logged out at %30s (inactivity).\n", $userid,$ip,(strftime "%c",localtime));
 693             $userid    = undef;
 694             $sessionID = undef;
 695         }
 696         elsif ( $ip ne $ENV{'REMOTE_ADDR'} ) {
 697             # Different ip than originally logged in from
 698             $info{'oldip'}        = $ip;
 699             $info{'newip'}        = $ENV{'REMOTE_ADDR'};
 700             $info{'different_ip'} = 1;
 701             $session->delete();
 702             C4::Context->_unset_userenv($sessionID);
 703             #_session_log(sprintf "%20s from %16s logged out at %30s (ip changed to %16s).\n", $userid,$ip,(strftime "%c",localtime), $info{'newip'});
 704             $sessionID = undef;
 705             $userid    = undef;
 706         }
 707         else {
 708             $cookie = $query->cookie( CGISESSID => $session->id );
 709             $session->param('lasttime',time());
 710             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...
 711                 $flags = haspermission($userid, $flagsrequired);
 712                 if ($flags) {
 713                     $loggedin = 1;
 714                 } else {
 715                     $info{'nopermission'} = 1;
 716                 }
 717             }
 718         }
 719     }
 720     unless ($userid || $sessionID) {
 721         #we initiate a session prior to checking for a username to allow for anonymous sessions...
 722         my $session = get_session("") or die "Auth ERROR: Cannot get_session()";
 723         my $sessionID = $session->id;
 724         C4::Context->_new_userenv($sessionID);
 725         $cookie = $query->cookie( CGISESSID => $sessionID );
 726         $userid = $query->param('userid');
 727         if (   ( $cas && $query->param('ticket') )
 728             || $userid
 729             || ( my $pki_field = C4::Context->preference('AllowPKIAuth') ) ne
 730             'None' )
 731         {
 732             my $password = $query->param('password');
 733             my ( $return, $cardnumber );
 734             if ( $cas && $query->param('ticket') ) {
 735                 my $retuserid;
 736                 ( $return, $cardnumber, $retuserid ) =
 737                   checkpw( $dbh, $userid, $password, $query );
 738                 $userid = $retuserid;
 739                 $info{'invalidCasLogin'} = 1 unless ($return);
 740             }
 741             elsif (
 742                 ( $pki_field eq 'Common Name' && $ENV{'SSL_CLIENT_S_DN_CN'} )
 743                 || (   $pki_field eq 'emailAddress'
 744                     && $ENV{'SSL_CLIENT_S_DN_Email'} )
 745               )
 746             {
 747                 my $value;
 748                 if ( $pki_field eq 'Common Name' ) {
 749                     $value = $ENV{'SSL_CLIENT_S_DN_CN'};
 750                 }
 751                 elsif ( $pki_field eq 'emailAddress' ) {
 752                     $value = $ENV{'SSL_CLIENT_S_DN_Email'};
 753
 754               # If we're looking up the email, there's a chance that the person
 755               # doesn't have a userid. So if there is none, we pass along the
 756               # borrower number, and the bits of code that need to know the user
 757               # ID will have to be smart enough to handle that.
 758                     require C4::Members;
 759                     my @users_info = C4::Members::GetBorrowersWithEmail($value);
 760                     if (@users_info) {
 761
 762                         # First the userid, then the borrowernum
 763                         $value = $users_info[0][1] || $users_info[0][0];
 764                     } else {
 765                         undef $value;
 766                     }
 767                 }
 768
 769                 # 0 for no user, 1 for normal, 2 for demo user.
 770                 $return = $value ? 1 : 0;
 771                 $userid = $value;
 772             }
 773             else {
 774                 my $retuserid;
 775                 ( $return, $cardnumber, $retuserid ) =
 776                   checkpw( $dbh, $userid, $password, $query );
 777                 $userid = $retuserid if ( $retuserid ne '' );
 778             }
 779                 if ($return) {
 780                #_session_log(sprintf "%20s from %16s logged in  at %30s.\n", $userid,$ENV{'REMOTE_ADDR'},(strftime '%c', localtime));
 781                 if ( $flags = haspermission(  $userid, $flagsrequired ) ) {
 782                                         $loggedin = 1;
 783                 }
 784                         else {
 785                         $info{'nopermission'} = 1;
 786                         C4::Context->_unset_userenv($sessionID);
 787                 }
 788                 my ($borrowernumber, $firstname, $surname, $userflags,
 789                     $branchcode, $branchname, $branchprinter, $emailaddress);
 790
 791                 if ( $return == 1 ) {
 792                     my $select = "
 793                     SELECT borrowernumber, firstname, surname, flags, borrowers.branchcode,
 794                     branches.branchname    as branchname,
 795                     branches.branchprinter as branchprinter,
 796                     email
 797                     FROM borrowers
 798                     LEFT JOIN branches on borrowers.branchcode=branches.branchcode
 799                     ";
 800                     my $sth = $dbh->prepare("$select where userid=?");
 801                     $sth->execute($userid);
 802                     unless ($sth->rows) {
 803                         $debug and print STDERR "AUTH_1: no rows for userid='$userid'\n";
 804                         $sth = $dbh->prepare("$select where cardnumber=?");
 805                         $sth->execute($cardnumber);
 806
 807                         unless ($sth->rows) {
 808                             $debug and print STDERR "AUTH_2a: no rows for cardnumber='$cardnumber'\n";
 809                             $sth->execute($userid);
 810                             unless ($sth->rows) {
 811                                 $debug and print STDERR "AUTH_2b: no rows for userid='$userid' AS cardnumber\n";
 812                             }
 813                         }
 814                     }
 815                     if ($sth->rows) {
 816                         ($borrowernumber, $firstname, $surname, $userflags,
 817                             $branchcode, $branchname, $branchprinter, $emailaddress) = $sth->fetchrow;
 818                         $debug and print STDERR "AUTH_3 results: " .
 819                         "$cardnumber,$borrowernumber,$userid,$firstname,$surname,$userflags,$branchcode,$emailaddress\n";
 820                     } else {
 821                         print STDERR "AUTH_3: no results for userid='$userid', cardnumber='$cardnumber'.\n";
 822                     }
 823
 824 # launch a sequence to check if we have a ip for the branch, i
 825 # if we have one we replace the branchcode of the userenv by the branch bound in the ip.
 826
 827                     my $ip       = $ENV{'REMOTE_ADDR'};
 828                     # if they specify at login, use that
 829                     if ($query->param('branch')) {
 830                         $branchcode  = $query->param('branch');
 831                         $branchname = GetBranchName($branchcode);
 832                     }
 833                     my $branches = GetBranches();
 834                     if (C4::Context->boolean_preference('IndependantBranches') && C4::Context->boolean_preference('Autolocation')){
 835                         # we have to check they are coming from the right ip range
 836                         my $domain = $branches->{$branchcode}->{'branchip'};
 837                         if ($ip !~ /^$domain/){
 838                             $loggedin=0;
 839                             $info{'wrongip'} = 1;
 840                         }
 841                     }
 842
 843                     my @branchesloop;
 844                     foreach my $br ( keys %$branches ) {
 845                         #     now we work with the treatment of ip
 846                         my $domain = $branches->{$br}->{'branchip'};
 847                         if ( $domain && $ip =~ /^$domain/ ) {
 848                             $branchcode = $branches->{$br}->{'branchcode'};
 849
 850                             # new op dev : add the branchprinter and branchname in the cookie
 851                             $branchprinter = $branches->{$br}->{'branchprinter'};
 852                             $branchname    = $branches->{$br}->{'branchname'};
 853                         }
 854                     }
 855                     $session->param('number',$borrowernumber);
 856                     $session->param('id',$userid);
 857                     $session->param('cardnumber',$cardnumber);
 858                     $session->param('firstname',$firstname);
 859                     $session->param('surname',$surname);
 860                     $session->param('branch',$branchcode);
 861                     $session->param('branchname',$branchname);
 862                     $session->param('flags',$userflags);
 863                     $session->param('emailaddress',$emailaddress);
 864                     $session->param('ip',$session->remote_addr());
 865                     $session->param('lasttime',time());
 866                     $debug and printf STDERR "AUTH_4: (%s)\t%s %s - %s\n", map {$session->param($_)} qw(cardnumber firstname surname branch) ;
 867                 }
 868                 elsif ( $return == 2 ) {
 869                     #We suppose the user is the superlibrarian
 870                     $borrowernumber = 0;
 871                     $session->param('number',0);
 872                     $session->param('id',C4::Context->config('user'));
 873                     $session->param('cardnumber',C4::Context->config('user'));
 874                     $session->param('firstname',C4::Context->config('user'));
 875                     $session->param('surname',C4::Context->config('user'));
 876                     $session->param('branch','NO_LIBRARY_SET');
 877                     $session->param('branchname','NO_LIBRARY_SET');
 878                     $session->param('flags',1);
 879                     $session->param('emailaddress', C4::Context->preference('KohaAdminEmailAddress'));
 880                     $session->param('ip',$session->remote_addr());
 881                     $session->param('lasttime',time());
 882                 }
 883                 C4::Context::set_userenv(
 884                     $session->param('number'),       $session->param('id'),
 885                     $session->param('cardnumber'),   $session->param('firstname'),
 886                     $session->param('surname'),      $session->param('branch'),
 887                     $session->param('branchname'),   $session->param('flags'),
 888                     $session->param('emailaddress'), $session->param('branchprinter')
 889                 );
 890
 891             }
 892                 else {
 893                 if ($userid) {
 894                         $info{'invalid_username_or_password'} = 1;
 895                         C4::Context->_unset_userenv($sessionID);
 896                 }
 897                         }
 898         }       # END if ( $userid    = $query->param('userid') )
 899                 elsif ($type eq "opac") {
 900             # if we are here this is an anonymous session; add public lists to it and a few other items...
 901             # anonymous sessions are created only for the OPAC
 902                         $debug and warn "Initiating an anonymous session...";
 903
 904                         # setting a couple of other session vars...
 905                         $session->param('ip',$session->remote_addr());
 906                         $session->param('lasttime',time());
 907                         $session->param('sessiontype','anon');
 908                 }
 909     }   # END unless ($userid)
 910     my $insecure = C4::Context->boolean_preference('insecure');
 911
 912     # finished authentification, now respond
 913     if ( $loggedin || $authnotrequired || ( defined($insecure) && $insecure ) )
 914     {
 915         # successful login
 916         unless ($cookie) {
 917             $cookie = $query->cookie( CGISESSID => '' );
 918         }
 919         return ( $userid, $cookie, $sessionID, $flags );
 920     }
 921
 922 #
 923 #
 924 # AUTH rejected, show the login/password template, after checking the DB.
 925 #
 926 #
 927
 928     # get the inputs from the incoming query
 929     my @inputs = ();
 930     foreach my $name ( param $query) {
 931         (next) if ( $name eq 'userid' || $name eq 'password' || $name eq 'ticket' );
 932         my $value = $query->param($name);
 933         push @inputs, { name => $name, value => $value };
 934     }
 935     # get the branchloop, which we need for authentication
 936     my $branches = GetBranches();
 937     my @branch_loop;
 938     for my $branch_hash (sort keys %$branches) {
 939                 push @branch_loop, {branchcode => "$branch_hash", branchname => $branches->{$branch_hash}->{'branchname'}, };
 940     }
 941
 942     my $template_name = ( $type eq 'opac' ) ? 'opac-auth.tmpl' : 'auth.tmpl';
 943     my $template = C4::Templates::gettemplate($template_name, $type, $query );
 944     $template->param(
 945         branchloop           => \@branch_loop,
 946         opaccolorstylesheet  => C4::Context->preference("opaccolorstylesheet"),
 947         opaclayoutstylesheet => C4::Context->preference("opaclayoutstylesheet"),
 948         login                => 1,
 949         INPUTS               => \@inputs,
 950         casAuthentication    => C4::Context->preference("casAuthentication"),
 951         suggestion           => C4::Context->preference("suggestion"),
 952         virtualshelves       => C4::Context->preference("virtualshelves"),
 953         LibraryName          => C4::Context->preference("LibraryName"),
 954         opacuserlogin        => C4::Context->preference("opacuserlogin"),
 955         OpacNav              => C4::Context->preference("OpacNav"),
 956         OpacNavRight         => C4::Context->preference("OpacNavRight"),
 957         OpacNavBottom        => C4::Context->preference("OpacNavBottom"),
 958         opaccredits          => C4::Context->preference("opaccredits"),
 959         OpacFavicon          => C4::Context->preference("OpacFavicon"),
 960         opacreadinghistory   => C4::Context->preference("opacreadinghistory"),
 961         opacsmallimage       => C4::Context->preference("opacsmallimage"),
 962         opaclanguagesdisplay => C4::Context->preference("opaclanguagesdisplay"),
 963         opacuserjs           => C4::Context->preference("opacuserjs"),
 964         opacbookbag          => "" . C4::Context->preference("opacbookbag"),
 965         OpacCloud            => C4::Context->preference("OpacCloud"),
 966         OpacTopissue         => C4::Context->preference("OpacTopissue"),
 967         OpacAuthorities      => C4::Context->preference("OpacAuthorities"),
 968         OpacBrowser          => C4::Context->preference("OpacBrowser"),
 969         opacheader           => C4::Context->preference("opacheader"),
 970         TagsEnabled                  => C4::Context->preference("TagsEnabled"),
 971         OPACUserCSS           => C4::Context->preference("OPACUserCSS"),
 972         intranetcolorstylesheet =>
 973                                                                 C4::Context->preference("intranetcolorstylesheet"),
 974         intranetstylesheet => C4::Context->preference("intranetstylesheet"),
 975         intranetbookbag    => C4::Context->preference("intranetbookbag"),
 976         IntranetNav        => C4::Context->preference("IntranetNav"),
 977         IntranetFavicon    => C4::Context->preference("IntranetFavicon"),
 978         intranetuserjs     => C4::Context->preference("intranetuserjs"),
 979         IndependantBranches=> C4::Context->preference("IndependantBranches"),
 980         AutoLocation       => C4::Context->preference("AutoLocation"),
 981                 wrongip            => $info{'wrongip'},
 982     );
 983
 984     $template->param( OpacPublic => C4::Context->preference("OpacPublic"));
 985     $template->param( loginprompt => 1 ) unless $info{'nopermission'};
 986
 987     if ($cas) {
 988
 989         # Is authentication against multiple CAS servers enabled?
 990         if (C4::Auth_with_cas::multipleAuth && !$casparam) {
 991             my $casservers = C4::Auth_with_cas::getMultipleAuth();
 992             my @tmplservers;
 993             foreach my $key (keys %$casservers) {
 994                 push @tmplservers, {name => $key, value => login_cas_url($query, $key) . "?cas=$key" };
 995             }
 996             #warn Data::Dumper::Dumper(\@tmplservers);
 997             $template->param(
 998                 casServersLoop => \@tmplservers
 999             );
1000         } else {
1001         $template->param(
1002             casServerUrl    => login_cas_url($query),
1003             );
1004         }
1005
1006         $template->param(
1007             invalidCasLogin => $info{'invalidCasLogin'}
1008         );
1009     }
1010
1011     my $self_url = $query->url( -absolute => 1 );
1012     $template->param(
1013         url         => $self_url,
1014         LibraryName => C4::Context->preference("LibraryName"),
1015     );
1016     $template->param( %info );
1017 #    $cookie = $query->cookie(CGISESSID => $session->id
1018 #   );
1019     print $query->header(
1020         -type   => 'text/html',
1021         -charset => 'utf-8',
1022         -cookie => $cookie
1023       ),
1024       $template->output;
1025     safe_exit;
1026 }
1027
1028 =head2 check_api_auth
1029
1030   ($status, $cookie, $sessionId) = check_api_auth($query, $userflags);
1031
1032 Given a CGI query containing the parameters 'userid' and 'password' and/or a session
1033 cookie, determine if the user has the privileges specified by C<$userflags>.
1034
1035 C<check_api_auth> is is meant for authenticating users of web services, and
1036 consequently will always return and will not attempt to redirect the user
1037 agent.
1038
1039 If a valid session cookie is already present, check_api_auth will return a status
1040 of "ok", the cookie, and the Koha session ID.
1041
1042 If no session cookie is present, check_api_auth will check the 'userid' and 'password
1043 parameters and create a session cookie and Koha session if the supplied credentials
1044 are OK.
1045
1046 Possible return values in C<$status> are:
1047
1048 =over
1049
1050 =item "ok" -- user authenticated; C<$cookie> and C<$sessionid> have valid values.
1051
1052 =item "failed" -- credentials are not correct; C<$cookie> and C<$sessionid> are undef
1053
1054 =item "maintenance" -- DB is in maintenance mode; no login possible at the moment
1055
1056 =item "expired -- session cookie has expired; API user should resubmit userid and password
1057
1058 =back
1059
1060 =cut
1061
1062 sub check_api_auth {
1063     my $query = shift;
1064     my $flagsrequired = shift;
1065
1066     my $dbh     = C4::Context->dbh;
1067     my $timeout = _timeout_syspref();
1068
1069     unless (C4::Context->preference('Version')) {
1070         # database has not been installed yet
1071         return ("maintenance", undef, undef);
1072     }
1073     my $kohaversion=C4::Context::KOHAVERSION;
1074     $kohaversion =~ s/(.*\..*)\.(.*)\.(.*)/$1$2$3/;
1075     if (C4::Context->preference('Version') < $kohaversion) {
1076         # database in need of version update; assume that
1077         # no API should be called while databsae is in
1078         # this condition.
1079         return ("maintenance", undef, undef);
1080     }
1081
1082     # FIXME -- most of what follows is a copy-and-paste
1083     # of code from checkauth.  There is an obvious need
1084     # for refactoring to separate the various parts of
1085     # the authentication code, but as of 2007-11-19 this
1086     # is deferred so as to not introduce bugs into the
1087     # regular authentication code for Koha 3.0.
1088
1089     # see if we have a valid session cookie already
1090     # however, if a userid parameter is present (i.e., from
1091     # a form submission, assume that any current cookie
1092     # is to be ignored
1093     my $sessionID = undef;
1094     unless ($query->param('userid')) {
1095         $sessionID = $query->cookie("CGISESSID");
1096     }
1097     if ($sessionID && not ($cas && $query->param('PT')) ) {
1098         my $session = get_session($sessionID);
1099         C4::Context->_new_userenv($sessionID);
1100         if ($session) {
1101             C4::Context::set_userenv(
1102                 $session->param('number'),       $session->param('id'),
1103                 $session->param('cardnumber'),   $session->param('firstname'),
1104                 $session->param('surname'),      $session->param('branch'),
1105                 $session->param('branchname'),   $session->param('flags'),
1106                 $session->param('emailaddress'), $session->param('branchprinter')
1107             );
1108
1109             my $ip = $session->param('ip');
1110             my $lasttime = $session->param('lasttime');
1111             my $userid = $session->param('id');
1112             if ( $lasttime < time() - $timeout ) {
1113                 # time out
1114                 $session->delete();
1115                 C4::Context->_unset_userenv($sessionID);
1116                 $userid    = undef;
1117                 $sessionID = undef;
1118                 return ("expired", undef, undef);
1119             } elsif ( $ip ne $ENV{'REMOTE_ADDR'} ) {
1120                 # IP address changed
1121                 $session->delete();
1122                 C4::Context->_unset_userenv($sessionID);
1123                 $userid    = undef;
1124                 $sessionID = undef;
1125                 return ("expired", undef, undef);
1126             } else {
1127                 my $cookie = $query->cookie( CGISESSID => $session->id );
1128                 $session->param('lasttime',time());
1129                 my $flags = haspermission($userid, $flagsrequired);
1130                 if ($flags) {
1131                     return ("ok", $cookie, $sessionID);
1132                 } else {
1133                     $session->delete();
1134                     C4::Context->_unset_userenv($sessionID);
1135                     $userid    = undef;
1136                     $sessionID = undef;
1137                     return ("failed", undef, undef);
1138                 }
1139             }
1140         } else {
1141             return ("expired", undef, undef);
1142         }
1143     } else {
1144         # new login
1145         my $userid = $query->param('userid');
1146         my $password = $query->param('password');
1147         my ($return, $cardnumber);
1148
1149         # Proxy CAS auth
1150         if ($cas && $query->param('PT')) {
1151             my $retuserid;
1152             $debug and print STDERR "## check_api_auth - checking CAS\n";
1153             # In case of a CAS authentication, we use the ticket instead of the password
1154             my $PT = $query->param('PT');
1155             ($return,$cardnumber,$userid) = check_api_auth_cas($dbh, $PT, $query);    # EXTERNAL AUTH
1156         } else {
1157             # User / password auth
1158             unless ($userid and $password) {
1159                 # caller did something wrong, fail the authenticateion
1160                 return ("failed", undef, undef);
1161             }
1162             ( $return, $cardnumber ) = checkpw( $dbh, $userid, $password, $query );
1163         }
1164
1165         if ($return and haspermission(  $userid, $flagsrequired)) {
1166             my $session = get_session("");
1167             return ("failed", undef, undef) unless $session;
1168
1169             my $sessionID = $session->id;
1170             C4::Context->_new_userenv($sessionID);
1171             my $cookie = $query->cookie(CGISESSID => $sessionID);
1172             if ( $return == 1 ) {
1173                 my (
1174                     $borrowernumber, $firstname,  $surname,
1175                     $userflags,      $branchcode, $branchname,
1176                     $branchprinter,  $emailaddress
1177                 );
1178                 my $sth =
1179                   $dbh->prepare(
1180 "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=?"
1181                   );
1182                 $sth->execute($userid);
1183                 (
1184                     $borrowernumber, $firstname,  $surname,
1185                     $userflags,      $branchcode, $branchname,
1186                     $branchprinter,  $emailaddress
1187                 ) = $sth->fetchrow if ( $sth->rows );
1188
1189                 unless ($sth->rows ) {
1190                     my $sth = $dbh->prepare(
1191 "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=?"
1192                       );
1193                     $sth->execute($cardnumber);
1194                     (
1195                         $borrowernumber, $firstname,  $surname,
1196                         $userflags,      $branchcode, $branchname,
1197                         $branchprinter,  $emailaddress
1198                     ) = $sth->fetchrow if ( $sth->rows );
1199
1200                     unless ( $sth->rows ) {
1201                         $sth->execute($userid);
1202                         (
1203                             $borrowernumber, $firstname, $surname, $userflags,
1204                             $branchcode, $branchname, $branchprinter, $emailaddress
1205                         ) = $sth->fetchrow if ( $sth->rows );
1206                     }
1207                 }
1208
1209                 my $ip       = $ENV{'REMOTE_ADDR'};
1210                 # if they specify at login, use that
1211                 if ($query->param('branch')) {
1212                     $branchcode  = $query->param('branch');
1213                     $branchname = GetBranchName($branchcode);
1214                 }
1215                 my $branches = GetBranches();
1216                 my @branchesloop;
1217                 foreach my $br ( keys %$branches ) {
1218                     #     now we work with the treatment of ip
1219                     my $domain = $branches->{$br}->{'branchip'};
1220                     if ( $domain && $ip =~ /^$domain/ ) {
1221                         $branchcode = $branches->{$br}->{'branchcode'};
1222
1223                         # new op dev : add the branchprinter and branchname in the cookie
1224                         $branchprinter = $branches->{$br}->{'branchprinter'};
1225                         $branchname    = $branches->{$br}->{'branchname'};
1226                     }
1227                 }
1228                 $session->param('number',$borrowernumber);
1229                 $session->param('id',$userid);
1230                 $session->param('cardnumber',$cardnumber);
1231                 $session->param('firstname',$firstname);
1232                 $session->param('surname',$surname);
1233                 $session->param('branch',$branchcode);
1234                 $session->param('branchname',$branchname);
1235                 $session->param('flags',$userflags);
1236                 $session->param('emailaddress',$emailaddress);
1237                 $session->param('ip',$session->remote_addr());
1238                 $session->param('lasttime',time());
1239             } elsif ( $return == 2 ) {
1240                 #We suppose the user is the superlibrarian
1241                 $session->param('number',0);
1242                 $session->param('id',C4::Context->config('user'));
1243                 $session->param('cardnumber',C4::Context->config('user'));
1244                 $session->param('firstname',C4::Context->config('user'));
1245                 $session->param('surname',C4::Context->config('user'));
1246                 $session->param('branch','NO_LIBRARY_SET');
1247                 $session->param('branchname','NO_LIBRARY_SET');
1248                 $session->param('flags',1);
1249                 $session->param('emailaddress', C4::Context->preference('KohaAdminEmailAddress'));
1250                 $session->param('ip',$session->remote_addr());
1251                 $session->param('lasttime',time());
1252             }
1253             C4::Context::set_userenv(
1254                 $session->param('number'),       $session->param('id'),
1255                 $session->param('cardnumber'),   $session->param('firstname'),
1256                 $session->param('surname'),      $session->param('branch'),
1257                 $session->param('branchname'),   $session->param('flags'),
1258                 $session->param('emailaddress'), $session->param('branchprinter')
1259             );
1260             return ("ok", $cookie, $sessionID);
1261         } else {
1262             return ("failed", undef, undef);
1263         }
1264     }
1265 }
1266
1267 =head2 check_cookie_auth
1268
1269   ($status, $sessionId) = check_api_auth($cookie, $userflags);
1270
1271 Given a CGISESSID cookie set during a previous login to Koha, determine
1272 if the user has the privileges specified by C<$userflags>.
1273
1274 C<check_cookie_auth> is meant for authenticating special services
1275 such as tools/upload-file.pl that are invoked by other pages that
1276 have been authenticated in the usual way.
1277
1278 Possible return values in C<$status> are:
1279
1280 =over
1281
1282 =item "ok" -- user authenticated; C<$sessionID> have valid values.
1283
1284 =item "failed" -- credentials are not correct; C<$sessionid> are undef
1285
1286 =item "maintenance" -- DB is in maintenance mode; no login possible at the moment
1287
1288 =item "expired -- session cookie has expired; API user should resubmit userid and password
1289
1290 =back
1291
1292 =cut
1293
1294 sub check_cookie_auth {
1295     my $cookie = shift;
1296     my $flagsrequired = shift;
1297
1298     my $dbh     = C4::Context->dbh;
1299     my $timeout = _timeout_syspref();
1300
1301     unless (C4::Context->preference('Version')) {
1302         # database has not been installed yet
1303         return ("maintenance", undef);
1304     }
1305     my $kohaversion=C4::Context::KOHAVERSION;
1306     $kohaversion =~ s/(.*\..*)\.(.*)\.(.*)/$1$2$3/;
1307     if (C4::Context->preference('Version') < $kohaversion) {
1308         # database in need of version update; assume that
1309         # no API should be called while databsae is in
1310         # this condition.
1311         return ("maintenance", undef);
1312     }
1313
1314     # FIXME -- most of what follows is a copy-and-paste
1315     # of code from checkauth.  There is an obvious need
1316     # for refactoring to separate the various parts of
1317     # the authentication code, but as of 2007-11-23 this
1318     # is deferred so as to not introduce bugs into the
1319     # regular authentication code for Koha 3.0.
1320
1321     # see if we have a valid session cookie already
1322     # however, if a userid parameter is present (i.e., from
1323     # a form submission, assume that any current cookie
1324     # is to be ignored
1325     unless (defined $cookie and $cookie) {
1326         return ("failed", undef);
1327     }
1328     my $sessionID = $cookie;
1329     my $session = get_session($sessionID);
1330     C4::Context->_new_userenv($sessionID);
1331     if ($session) {
1332         C4::Context::set_userenv(
1333             $session->param('number'),       $session->param('id'),
1334             $session->param('cardnumber'),   $session->param('firstname'),
1335             $session->param('surname'),      $session->param('branch'),
1336             $session->param('branchname'),   $session->param('flags'),
1337             $session->param('emailaddress'), $session->param('branchprinter')
1338         );
1339
1340         my $ip = $session->param('ip');
1341         my $lasttime = $session->param('lasttime');
1342         my $userid = $session->param('id');
1343         if ( $lasttime < time() - $timeout ) {
1344             # time out
1345             $session->delete();
1346             C4::Context->_unset_userenv($sessionID);
1347             $userid    = undef;
1348             $sessionID = undef;
1349             return ("expired", undef);
1350         } elsif ( $ip ne $ENV{'REMOTE_ADDR'} ) {
1351             # IP address changed
1352             $session->delete();
1353             C4::Context->_unset_userenv($sessionID);
1354             $userid    = undef;
1355             $sessionID = undef;
1356             return ("expired", undef);
1357         } else {
1358             $session->param('lasttime',time());
1359             my $flags = haspermission($userid, $flagsrequired);
1360             if ($flags) {
1361                 return ("ok", $sessionID);
1362             } else {
1363                 $session->delete();
1364                 C4::Context->_unset_userenv($sessionID);
1365                 $userid    = undef;
1366                 $sessionID = undef;
1367                 return ("failed", undef);
1368             }
1369         }
1370     } else {
1371         return ("expired", undef);
1372     }
1373 }
1374
1375 =head2 get_session
1376
1377   use CGI::Session;
1378   my $session = get_session($sessionID);
1379
1380 Given a session ID, retrieve the CGI::Session object used to store
1381 the session's state.  The session object can be used to store
1382 data that needs to be accessed by different scripts during a
1383 user's session.
1384
1385 If the C<$sessionID> parameter is an empty string, a new session
1386 will be created.
1387
1388 =cut
1389
1390 sub get_session {
1391     my $sessionID = shift;
1392     my $storage_method = C4::Context->preference('SessionStorage');
1393     my $dbh = C4::Context->dbh;
1394     my $session;
1395     if ($storage_method eq 'mysql'){
1396         $session = new CGI::Session("driver:MySQL;serializer:yaml;id:md5", $sessionID, {Handle=>$dbh});
1397     }
1398     elsif ($storage_method eq 'Pg') {
1399         $session = new CGI::Session("driver:PostgreSQL;serializer:yaml;id:md5", $sessionID, {Handle=>$dbh});
1400     }
1401     elsif ($storage_method eq 'memcached' && C4::Context->ismemcached){
1402         $session = new CGI::Session("driver:memcached;serializer:yaml;id:md5", $sessionID, { Memcached => C4::Context->memcached } );
1403     }
1404     else {
1405         # catch all defaults to tmp should work on all systems
1406         $session = new CGI::Session("driver:File;serializer:yaml;id:md5", $sessionID, {Directory=>'/tmp'});
1407     }
1408     return $session;
1409 }
1410
1411 sub checkpw {
1412
1413     my ( $dbh, $userid, $password, $query ) = @_;
1414     if ($ldap) {
1415         $debug and print STDERR "## checkpw - checking LDAP\n";
1416         my ($retval,$retcard,$retuserid) = checkpw_ldap(@_);    # EXTERNAL AUTH
1417         ($retval) and return ($retval,$retcard,$retuserid);
1418     }
1419
1420     if ($cas && $query && $query->param('ticket')) {
1421         $debug and print STDERR "## checkpw - checking CAS\n";
1422         # In case of a CAS authentication, we use the ticket instead of the password
1423         my $ticket = $query->param('ticket');
1424         my ($retval,$retcard,$retuserid) = checkpw_cas($dbh, $ticket, $query);    # EXTERNAL AUTH
1425         ($retval) and return ($retval,$retcard,$retuserid);
1426         return 0;
1427     }
1428
1429     # INTERNAL AUTH
1430     my $sth =
1431       $dbh->prepare(
1432 "select password,cardnumber,borrowernumber,userid,firstname,surname,branchcode,flags from borrowers where userid=?"
1433       );
1434     $sth->execute($userid);
1435     if ( $sth->rows ) {
1436         my ( $md5password, $cardnumber, $borrowernumber, $userid, $firstname,
1437             $surname, $branchcode, $flags )
1438           = $sth->fetchrow;
1439         if ( md5_base64($password) eq $md5password and $md5password ne "!") {
1440
1441             C4::Context->set_userenv( "$borrowernumber", $userid, $cardnumber,
1442                 $firstname, $surname, $branchcode, $flags );
1443             return 1, $cardnumber, $userid;
1444         }
1445     }
1446     $sth =
1447       $dbh->prepare(
1448 "select password,cardnumber,borrowernumber,userid, firstname,surname,branchcode,flags from borrowers where cardnumber=?"
1449       );
1450     $sth->execute($userid);
1451     if ( $sth->rows ) {
1452         my ( $md5password, $cardnumber, $borrowernumber, $userid, $firstname,
1453             $surname, $branchcode, $flags )
1454           = $sth->fetchrow;
1455         if ( md5_base64($password) eq $md5password ) {
1456
1457             C4::Context->set_userenv( $borrowernumber, $userid, $cardnumber,
1458                 $firstname, $surname, $branchcode, $flags );
1459             return 1, $cardnumber, $userid;
1460         }
1461     }
1462     if (   $userid && $userid eq C4::Context->config('user')
1463         && "$password" eq C4::Context->config('pass') )
1464     {
1465
1466 # Koha superuser account
1467 #     C4::Context->set_userenv(0,0,C4::Context->config('user'),C4::Context->config('user'),C4::Context->config('user'),"",1);
1468         return 2;
1469     }
1470     if (   $userid && $userid eq 'demo'
1471         && "$password" eq 'demo'
1472         && C4::Context->config('demo') )
1473     {
1474
1475 # DEMO => the demo user is allowed to do everything (if demo set to 1 in koha.conf
1476 # some features won't be effective : modify systempref, modify MARC structure,
1477         return 2;
1478     }
1479     return 0;
1480 }
1481
1482 =head2 getuserflags
1483
1484     my $authflags = getuserflags($flags, $userid, [$dbh]);
1485
1486 Translates integer flags into permissions strings hash.
1487
1488 C<$flags> is the integer userflags value ( borrowers.userflags )
1489 C<$userid> is the members.userid, used for building subpermissions
1490 C<$authflags> is a hashref of permissions
1491
1492 =cut
1493
1494 sub getuserflags {
1495     my $flags   = shift;
1496     my $userid  = shift;
1497     my $dbh     = @_ ? shift : C4::Context->dbh;
1498     my $userflags;
1499     {
1500         # I don't want to do this, but if someone logs in as the database
1501         # user, it would be preferable not to spam them to death with
1502         # numeric warnings. So, we make $flags numeric.
1503         no warnings 'numeric';
1504         $flags += 0;
1505     }
1506     my $sth = $dbh->prepare("SELECT bit, flag, defaulton FROM userflags");
1507     $sth->execute;
1508
1509     while ( my ( $bit, $flag, $defaulton ) = $sth->fetchrow ) {
1510         if ( ( $flags & ( 2**$bit ) ) || $defaulton ) {
1511             $userflags->{$flag} = 1;
1512         }
1513         else {
1514             $userflags->{$flag} = 0;
1515         }
1516     }
1517
1518     # get subpermissions and merge with top-level permissions
1519     my $user_subperms = get_user_subpermissions($userid);
1520     foreach my $module (keys %$user_subperms) {
1521         next if $userflags->{$module} == 1; # user already has permission for everything in this module
1522         $userflags->{$module} = $user_subperms->{$module};
1523     }
1524
1525     return $userflags;
1526 }
1527
1528 =head2 get_user_subpermissions
1529
1530   $user_perm_hashref = get_user_subpermissions($userid);
1531
1532 Given the userid (note, not the borrowernumber) of a staff user,
1533 return a hashref of hashrefs of the specific subpermissions
1534 accorded to the user.  An example return is
1535
1536  {
1537     tools => {
1538         export_catalog => 1,
1539         import_patrons => 1,
1540     }
1541  }
1542
1543 The top-level hash-key is a module or function code from
1544 userflags.flag, while the second-level key is a code
1545 from permissions.
1546
1547 The results of this function do not give a complete picture
1548 of the functions that a staff user can access; it is also
1549 necessary to check borrowers.flags.
1550
1551 =cut
1552
1553 sub get_user_subpermissions {
1554     my $userid = shift;
1555
1556     my $dbh = C4::Context->dbh;
1557     my $sth = $dbh->prepare("SELECT flag, user_permissions.code
1558                              FROM user_permissions
1559                              JOIN permissions USING (module_bit, code)
1560                              JOIN userflags ON (module_bit = bit)
1561                              JOIN borrowers USING (borrowernumber)
1562                              WHERE userid = ?");
1563     $sth->execute($userid);
1564
1565     my $user_perms = {};
1566     while (my $perm = $sth->fetchrow_hashref) {
1567         $user_perms->{$perm->{'flag'}}->{$perm->{'code'}} = 1;
1568     }
1569     return $user_perms;
1570 }
1571
1572 =head2 get_all_subpermissions
1573
1574   my $perm_hashref = get_all_subpermissions();
1575
1576 Returns a hashref of hashrefs defining all specific
1577 permissions currently defined.  The return value
1578 has the same structure as that of C<get_user_subpermissions>,
1579 except that the innermost hash value is the description
1580 of the subpermission.
1581
1582 =cut
1583
1584 sub get_all_subpermissions {
1585     my $dbh = C4::Context->dbh;
1586     my $sth = $dbh->prepare("SELECT flag, code, description
1587                              FROM permissions
1588                              JOIN userflags ON (module_bit = bit)");
1589     $sth->execute();
1590
1591     my $all_perms = {};
1592     while (my $perm = $sth->fetchrow_hashref) {
1593         $all_perms->{$perm->{'flag'}}->{$perm->{'code'}} = $perm->{'description'};
1594     }
1595     return $all_perms;
1596 }
1597
1598 =head2 haspermission
1599
1600   $flags = ($userid, $flagsrequired);
1601
1602 C<$userid> the userid of the member
1603 C<$flags> is a hashref of required flags like C<$borrower-&lt;{authflags}>
1604
1605 Returns member's flags or 0 if a permission is not met.
1606
1607 =cut
1608
1609 sub haspermission {
1610     my ($userid, $flagsrequired) = @_;
1611     my $sth = C4::Context->dbh->prepare("SELECT flags FROM borrowers WHERE userid=?");
1612     $sth->execute($userid);
1613     my $flags = getuserflags($sth->fetchrow(), $userid);
1614     if ( $userid eq C4::Context->config('user') ) {
1615         # Super User Account from /etc/koha.conf
1616         $flags->{'superlibrarian'} = 1;
1617     }
1618     elsif ( $userid eq 'demo' && C4::Context->config('demo') ) {
1619         # Demo user that can do "anything" (demo=1 in /etc/koha.conf)
1620         $flags->{'superlibrarian'} = 1;
1621     }
1622
1623     return $flags if $flags->{superlibrarian};
1624
1625     foreach my $module ( keys %$flagsrequired ) {
1626         my $subperm = $flagsrequired->{$module};
1627         if ($subperm eq '*') {
1628             return 0 unless ( $flags->{$module} == 1 or ref($flags->{$module}) );
1629         } else {
1630             return 0 unless ( $flags->{$module} == 1 or
1631                                 ( ref($flags->{$module}) and
1632                                   exists $flags->{$module}->{$subperm} and
1633                                   $flags->{$module}->{$subperm} == 1
1634                                 )
1635                             );
1636         }
1637     }
1638     return $flags;
1639     #FIXME - This fcn should return the failed permission so a suitable error msg can be delivered.
1640 }
1641
1642
1643 sub getborrowernumber {
1644     my ($userid) = @_;
1645     my $userenv = C4::Context->userenv;
1646     if ( defined( $userenv ) && ref( $userenv ) eq 'HASH' && $userenv->{number} ) {
1647         return $userenv->{number};
1648     }
1649     my $dbh = C4::Context->dbh;
1650     for my $field ( 'userid', 'cardnumber' ) {
1651         my $sth =
1652           $dbh->prepare("select borrowernumber from borrowers where $field=?");
1653         $sth->execute($userid);
1654         if ( $sth->rows ) {
1655             my ($bnumber) = $sth->fetchrow;
1656             return $bnumber;
1657         }
1658     }
1659     return 0;
1660 }
1661
1662
1663 END { }    # module clean-up code here (global destructor)
1664 1;
1665 __END__
1666
1667 =head1 SEE ALSO
1668
1669 CGI(3)
1670
1671 C4::Output(3)
1672
1673 Digest::MD5(3)
1674
1675 =cut