C4/Auth.pm

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