C4/Auth.pm

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