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