C4/Auth.pm

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