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