C4/Auth.pm

   1 package C4::Auth;
   2
   3 # Copyright 2000-2002 Katipo Communications
   4 #
   5 # This file is part of Koha.
   6 #
   7 # Koha is free software; you can redistribute it and/or modify it under the
   8 # terms of the GNU General Public License as published by the Free Software
   9 # Foundation; either version 2 of the License, or (at your option) any later
  10 # version.
  11 #
  12 # Koha is distributed in the hope that it will be useful, but WITHOUT ANY
  13 # WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
  14 # A PARTICULAR PURPOSE.  See the GNU General Public License for more details.
  15 #
  16 # You should have received a copy of the GNU General Public License along
  17 # with Koha; if not, write to the Free Software Foundation, Inc.,
  18 # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  19
  20 use strict;
  21 #use warnings; FIXME - Bug 2505
  22 use Digest::MD5 qw(md5_base64);
  23 use Storable qw(thaw freeze);
  24 use URI::Escape;
  25 use CGI::Session;
  26
  27 require Exporter;
  28 use C4::Context;
  29 use C4::Templates;    # to get the template
  30 use C4::Branch; # GetBranches
  31 use C4::VirtualShelves;
  32 use POSIX qw/strftime/;
  33 use List::MoreUtils qw/ any /;
  34
  35 # use utf8;
  36 use vars qw($VERSION @ISA @EXPORT @EXPORT_OK %EXPORT_TAGS $debug $ldap $cas $caslogout);
  37
  38 BEGIN {
  39     sub psgi_env { any { /^psgi\./ } keys %ENV }
  40     sub safe_exit {
  41         if ( psgi_env ) { die 'psgi:exit' }
  42         else { exit }
  43     }
  44     $VERSION     = 3.07.00.049;   # set version for version checking
  45
  46     $debug       = $ENV{DEBUG};
  47     @ISA         = qw(Exporter);
  48     @EXPORT      = qw(&checkauth &get_template_and_user &haspermission &get_user_subpermissions);
  49     @EXPORT_OK   = qw(&check_api_auth &get_session &check_cookie_auth &checkpw &get_all_subpermissions &get_user_subpermissions);
  50     %EXPORT_TAGS = ( EditPermissions => [qw(get_all_subpermissions get_user_subpermissions)] );
  51     $ldap        = C4::Context->config('useldapserver') || 0;
  52     $cas         = C4::Context->preference('casAuthentication');
  53     $caslogout   = C4::Context->preference('casLogout');
  54     require C4::Auth_with_cas;             # no import
  55     if ($ldap) {
  56         require C4::Auth_with_ldap;
  57         import C4::Auth_with_ldap qw(checkpw_ldap);
  58     }
  59     if ($cas) {
  60         import  C4::Auth_with_cas qw(check_api_auth_cas checkpw_cas login_cas logout_cas login_cas_url);
  61     }
  62
  63 }
  64
  65 =head1 NAME
  66
  67 C4::Auth - Authenticates Koha users
  68
  69 =head1 SYNOPSIS
  70
  71   use CGI;
  72   use C4::Auth;
  73   use C4::Output;
  74
  75   my $query = new CGI;
  76
  77   my ($template, $borrowernumber, $cookie)
  78     = get_template_and_user(
  79         {
  80             template_name   => "opac-main.tmpl",
  81             query           => $query,
  82       type            => "opac",
  83       authnotrequired => 1,
  84       flagsrequired   => {borrow => 1, catalogue => '*', tools => 'import_patrons' },
  85   }
  86     );
  87
  88   output_html_with_http_headers $query, $cookie, $template->output;
  89
  90 =head1 DESCRIPTION
  91
  92 The main function of this module is to provide
  93 authentification. However the get_template_and_user function has
  94 been provided so that a users login information is passed along
  95 automatically. This gets loaded into the template.
  96
  97 =head1 FUNCTIONS
  98
  99 =head2 get_template_and_user
 100
 101  my ($template, $borrowernumber, $cookie)
 102      = get_template_and_user(
 103        {
 104          template_name   => "opac-main.tmpl",
 105          query           => $query,
 106          type            => "opac",
 107          authnotrequired => 1,
 108          flagsrequired   => {borrow => 1, catalogue => '*', tools => 'import_patrons' },
 109        }
 110      );
 111
 112 This call passes the C<query>, C<flagsrequired> and C<authnotrequired>
 113 to C<&checkauth> (in this module) to perform authentification.
 114 See C<&checkauth> for an explanation of these parameters.
 115
 116 The C<template_name> is then used to find the correct template for
 117 the page. The authenticated users details are loaded onto the
 118 template in the HTML::Template LOOP variable C<USER_INFO>. Also the
 119 C<sessionID> is passed to the template. This can be used in templates
 120 if cookies are disabled. It needs to be put as and input to every
 121 authenticated page.
 122
 123 More information on the C<gettemplate> sub can be found in the
 124 Output.pm module.
 125
 126 =cut
 127
 128 my $SEARCH_HISTORY_INSERT_SQL =<<EOQ;
 129 INSERT INTO search_history(userid, sessionid, query_desc, query_cgi, total, time            )
 130 VALUES                    (     ?,         ?,          ?,         ?,          ?, FROM_UNIXTIME(?))
 131 EOQ
 132 sub get_template_and_user {
 133     my $in       = shift;
 134     my $template =
 135       C4::Templates::gettemplate( $in->{'template_name'}, $in->{'type'}, $in->{'query'} );
 136     my ( $user, $cookie, $sessionID, $flags );
 137     if ( $in->{'template_name'} !~m/maintenance/ ) {
 138         ( $user, $cookie, $sessionID, $flags ) = checkauth(
 139             $in->{'query'},
 140             $in->{'authnotrequired'},
 141             $in->{'flagsrequired'},
 142             $in->{'type'}
 143         );
 144     }
 145
 146     my $borrowernumber;
 147     my $insecure = C4::Context->preference('insecure');
 148     if ($user or $insecure) {
 149         # It's possible for $user to be the borrowernumber if they don't have a
 150         # userid defined (and are logging in through some other method, such
 151         # as SSL certs against an email address)
 152         $borrowernumber = getborrowernumber($user) if defined($user);
 153         if (!defined($borrowernumber) && defined($user)) {
 154                 my $borrower = GetMember(borrowernumber => $user);
 155                 if ($borrower) {
 156                 $borrowernumber = $user;
 157                 # A bit of a hack, but I don't know there's a nicer way
 158                 # to do it.
 159                 $user = $borrower->{firstname} . ' ' . $borrower->{surname};
 160             }
 161         }
 162
 163         # user info
 164         $template->param( loggedinusername => $user );
 165         $template->param( sessionID        => $sessionID );
 166
 167         my ($total, $pubshelves, $barshelves) = C4::VirtualShelves::GetSomeShelfNames($borrowernumber, 'MASTHEAD');
 168         $template->param(
 169             pubshelves     => $total->{pubtotal},
 170             pubshelvesloop => $pubshelves,
 171             barshelves      => $total->{bartotal},
 172             barshelvesloop  => $barshelves,
 173         );
 174
 175         require C4::Members;
 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 =~ /branch:(\w+)/ && $opac_limit_override) || $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     }
 570     unless ( $version = C4::Context->preference('Version') ) {    # assignment, not comparison
 571         if ( $type ne 'opac' ) {
 572             warn "Install required, redirecting to Installer";
 573             print $query->redirect("/cgi-bin/koha/installer/install.pl");
 574         } else {
 575             warn "OPAC Install required, redirecting to maintenance";
 576             print $query->redirect("/cgi-bin/koha/maintenance.pl");
 577         }
 578         safe_exit;
 579     }
 580
 581     # check that database and koha version are the same
 582     # there is no DB version, it's a fresh install,
 583     # go to web installer
 584     # there is a DB version, compare it to the code version
 585     my $kohaversion=C4::Context::KOHAVERSION;
 586     # remove the 3 last . to have a Perl number
 587     $kohaversion =~ s/(.*\..*)\.(.*)\.(.*)/$1$2$3/;
 588     $debug and print STDERR "kohaversion : $kohaversion\n";
 589     if ($version < $kohaversion){
 590         my $warning = "Database update needed, redirecting to %s. Database is $version and Koha is $kohaversion";
 591         if ($type ne 'opac'){
 592             warn sprintf($warning, 'Installer');
 593             print $query->redirect("/cgi-bin/koha/installer/install.pl?step=3");
 594         } else {
 595             warn sprintf("OPAC: " . $warning, 'maintenance');
 596             print $query->redirect("/cgi-bin/koha/maintenance.pl");
 597         }
 598         safe_exit;
 599     }
 600 }
 601
 602 sub _session_log {
 603     (@_) or return 0;
 604     open L, ">>/tmp/sessionlog" or warn "ERROR: Cannot append to /tmp/sessionlog";
 605     printf L join("\n",@_);
 606     close L;
 607 }
 608
 609 sub checkauth {
 610     my $query = shift;
 611         $debug and warn "Checking Auth";
 612     # $authnotrequired will be set for scripts which will run without authentication
 613     my $authnotrequired = shift;
 614     my $flagsrequired   = shift;
 615     my $type            = shift;
 616     $type = 'opac' unless $type;
 617
 618     my $dbh     = C4::Context->dbh;
 619     my $timeout = C4::Context->preference('timeout');
 620     # days
 621     if ($timeout =~ /(\d+)[dD]/) {
 622         $timeout = $1 * 86400;
 623     };
 624     $timeout = 600 unless $timeout;
 625
 626     _version_check($type,$query);
 627     # state variables
 628     my $loggedin = 0;
 629     my %info;
 630     my ( $userid, $cookie, $sessionID, $flags, $barshelves, $pubshelves );
 631     my $logout = $query->param('logout.x');
 632
 633     # This parameter is the name of the CAS server we want to authenticate against,
 634     # when using authentication against multiple CAS servers, as configured in Auth_cas_servers.yaml
 635     my $casparam = $query->param('cas');
 636
 637     if ( $userid = $ENV{'REMOTE_USER'} ) {
 638         # Using Basic Authentication, no cookies required
 639         $cookie = $query->cookie(
 640             -name    => 'CGISESSID',
 641             -value   => '',
 642             -expires => ''
 643         );
 644         $loggedin = 1;
 645     }
 646     elsif ( $sessionID = $query->cookie("CGISESSID")) {     # assignment, not comparison
 647         my $session = get_session($sessionID);
 648         C4::Context->_new_userenv($sessionID);
 649         my ($ip, $lasttime, $sessiontype);
 650         if ($session){
 651             C4::Context::set_userenv(
 652                 $session->param('number'),       $session->param('id'),
 653                 $session->param('cardnumber'),   $session->param('firstname'),
 654                 $session->param('surname'),      $session->param('branch'),
 655                 $session->param('branchname'),   $session->param('flags'),
 656                 $session->param('emailaddress'), $session->param('branchprinter')
 657             );
 658             C4::Context::set_shelves_userenv('bar',$session->param('barshelves'));
 659             C4::Context::set_shelves_userenv('pub',$session->param('pubshelves'));
 660             C4::Context::set_shelves_userenv('tot',$session->param('totshelves'));
 661             $debug and printf STDERR "AUTH_SESSION: (%s)\t%s %s - %s\n", map {$session->param($_)} qw(cardnumber firstname surname branch) ;
 662             $ip       = $session->param('ip');
 663             $lasttime = $session->param('lasttime');
 664             $userid   = $session->param('id');
 665                         $sessiontype = $session->param('sessiontype');
 666         }
 667         if ( ( ($query->param('koha_login_context')) && ($query->param('userid') ne $session->param('id')) )
 668           || ( $cas && $query->param('ticket') ) ) {
 669             #if a user enters an id ne to the id in the current session, we need to log them in...
 670             #first we need to clear the anonymous session...
 671             $debug and warn "query id = " . $query->param('userid') . " but session id = " . $session->param('id');
 672             $session->flush;
 673             $session->delete();
 674             C4::Context->_unset_userenv($sessionID);
 675                         $sessionID = undef;
 676                         $userid = undef;
 677                 }
 678         elsif ($logout) {
 679             # voluntary logout the user
 680             $session->flush;
 681             $session->delete();
 682             C4::Context->_unset_userenv($sessionID);
 683             #_session_log(sprintf "%20s from %16s logged out at %30s (manually).\n", $userid,$ip,(strftime "%c",localtime));
 684             $sessionID = undef;
 685             $userid    = undef;
 686
 687             if ($cas and $caslogout) {
 688                 logout_cas($query);
 689             }
 690         }
 691         elsif ( $lasttime < time() - $timeout ) {
 692             # timed logout
 693             $info{'timed_out'} = 1;
 694             $session->delete() if $session;
 695             C4::Context->_unset_userenv($sessionID);
 696             #_session_log(sprintf "%20s from %16s logged out at %30s (inactivity).\n", $userid,$ip,(strftime "%c",localtime));
 697             $userid    = undef;
 698             $sessionID = undef;
 699         }
 700         elsif ( $ip ne $ENV{'REMOTE_ADDR'} ) {
 701             # Different ip than originally logged in from
 702             $info{'oldip'}        = $ip;
 703             $info{'newip'}        = $ENV{'REMOTE_ADDR'};
 704             $info{'different_ip'} = 1;
 705             $session->delete();
 706             C4::Context->_unset_userenv($sessionID);
 707             #_session_log(sprintf "%20s from %16s logged out at %30s (ip changed to %16s).\n", $userid,$ip,(strftime "%c",localtime), $info{'newip'});
 708             $sessionID = undef;
 709             $userid    = undef;
 710         }
 711         else {
 712             $cookie = $query->cookie( CGISESSID => $session->id );
 713             $session->param('lasttime',time());
 714             unless ( $sessiontype eq 'anon' ) { #if this is an anonymous session, we want to update the session, but not behave as if they are logged in...
 715                 $flags = haspermission($userid, $flagsrequired);
 716                 if ($flags) {
 717                     $loggedin = 1;
 718                 } else {
 719                     $info{'nopermission'} = 1;
 720                 }
 721             }
 722         }
 723     }
 724     unless ($userid || $sessionID) {
 725         #we initiate a session prior to checking for a username to allow for anonymous sessions...
 726         my $session = get_session("") or die "Auth ERROR: Cannot get_session()";
 727         my $sessionID = $session->id;
 728         C4::Context->_new_userenv($sessionID);
 729         $cookie = $query->cookie( CGISESSID => $sessionID );
 730         $userid = $query->param('userid');
 731         if (   ( $cas && $query->param('ticket') )
 732             || $userid
 733             || ( my $pki_field = C4::Context->preference('AllowPKIAuth') ) ne
 734             'None' )
 735         {
 736             my $password = $query->param('password');
 737             my ( $return, $cardnumber );
 738             if ( $cas && $query->param('ticket') ) {
 739                 my $retuserid;
 740                 ( $return, $cardnumber, $retuserid ) =
 741                   checkpw( $dbh, $userid, $password, $query );
 742                 $userid = $retuserid;
 743                 $info{'invalidCasLogin'} = 1 unless ($return);
 744             }
 745             elsif (
 746                 ( $pki_field eq 'Common Name' && $ENV{'SSL_CLIENT_S_DN_CN'} )
 747                 || (   $pki_field eq 'emailAddress'
 748                     && $ENV{'SSL_CLIENT_S_DN_Email'} )
 749               )
 750             {
 751                 my $value;
 752                 if ( $pki_field eq 'Common Name' ) {
 753                     $value = $ENV{'SSL_CLIENT_S_DN_CN'};
 754                 }
 755                 elsif ( $pki_field eq 'emailAddress' ) {
 756                     $value = $ENV{'SSL_CLIENT_S_DN_Email'};
 757
 758               # If we're looking up the email, there's a chance that the person
 759               # doesn't have a userid. So if there is none, we pass along the
 760               # borrower number, and the bits of code that need to know the user
 761               # ID will have to be smart enough to handle that.
 762                     require C4::Members;
 763                     my @users_info = C4::Members::GetBorrowersWithEmail($value);
 764                     if (@users_info) {
 765
 766                         # First the userid, then the borrowernum
 767                         $value = $users_info[0][1] || $users_info[0][0];
 768                     } else {
 769                         undef $value;
 770                     }
 771                 }
 772
 773                 # 0 for no user, 1 for normal, 2 for demo user.
 774                 $return = $value ? 1 : 0;
 775                 $userid = $value;
 776             }
 777             else {
 778                 my $retuserid;
 779                 ( $return, $cardnumber, $retuserid ) =
 780                   checkpw( $dbh, $userid, $password, $query );
 781                 $userid = $retuserid if ( $retuserid ne '' );
 782             }
 783                 if ($return) {
 784                #_session_log(sprintf "%20s from %16s logged in  at %30s.\n", $userid,$ENV{'REMOTE_ADDR'},(strftime '%c', localtime));
 785                 if ( $flags = haspermission(  $userid, $flagsrequired ) ) {
 786                                         $loggedin = 1;
 787                 }
 788                         else {
 789                         $info{'nopermission'} = 1;
 790                         C4::Context->_unset_userenv($sessionID);
 791                 }
 792                 my ($borrowernumber, $firstname, $surname, $userflags,
 793                     $branchcode, $branchname, $branchprinter, $emailaddress);
 794
 795                 if ( $return == 1 ) {
 796                     my $select = "
 797                     SELECT borrowernumber, firstname, surname, flags, borrowers.branchcode,
 798                     branches.branchname    as branchname,
 799                     branches.branchprinter as branchprinter,
 800                     email
 801                     FROM borrowers
 802                     LEFT JOIN branches on borrowers.branchcode=branches.branchcode
 803                     ";
 804                     my $sth = $dbh->prepare("$select where userid=?");
 805                     $sth->execute($userid);
 806                     unless ($sth->rows) {
 807                         $debug and print STDERR "AUTH_1: no rows for userid='$userid'\n";
 808                         $sth = $dbh->prepare("$select where cardnumber=?");
 809                         $sth->execute($cardnumber);
 810
 811                         unless ($sth->rows) {
 812                             $debug and print STDERR "AUTH_2a: no rows for cardnumber='$cardnumber'\n";
 813                             $sth->execute($userid);
 814                             unless ($sth->rows) {
 815                                 $debug and print STDERR "AUTH_2b: no rows for userid='$userid' AS cardnumber\n";
 816                             }
 817                         }
 818                     }
 819                     if ($sth->rows) {
 820                         ($borrowernumber, $firstname, $surname, $userflags,
 821                             $branchcode, $branchname, $branchprinter, $emailaddress) = $sth->fetchrow;
 822                         $debug and print STDERR "AUTH_3 results: " .
 823                         "$cardnumber,$borrowernumber,$userid,$firstname,$surname,$userflags,$branchcode,$emailaddress\n";
 824                     } else {
 825                         print STDERR "AUTH_3: no results for userid='$userid', cardnumber='$cardnumber'.\n";
 826                     }
 827
 828 # launch a sequence to check if we have a ip for the branch, i
 829 # if we have one we replace the branchcode of the userenv by the branch bound in the ip.
 830
 831                     my $ip       = $ENV{'REMOTE_ADDR'};
 832                     # if they specify at login, use that
 833                     if ($query->param('branch')) {
 834                         $branchcode  = $query->param('branch');
 835                         $branchname = GetBranchName($branchcode);
 836                     }
 837                     my $branches = GetBranches();
 838                     if (C4::Context->boolean_preference('IndependantBranches') && C4::Context->boolean_preference('Autolocation')){
 839                         # we have to check they are coming from the right ip range
 840                         my $domain = $branches->{$branchcode}->{'branchip'};
 841                         if ($ip !~ /^$domain/){
 842                             $loggedin=0;
 843                             $info{'wrongip'} = 1;
 844                         }
 845                     }
 846
 847                     my @branchesloop;
 848                     foreach my $br ( keys %$branches ) {
 849                         #     now we work with the treatment of ip
 850                         my $domain = $branches->{$br}->{'branchip'};
 851                         if ( $domain && $ip =~ /^$domain/ ) {
 852                             $branchcode = $branches->{$br}->{'branchcode'};
 853
 854                             # new op dev : add the branchprinter and branchname in the cookie
 855                             $branchprinter = $branches->{$br}->{'branchprinter'};
 856                             $branchname    = $branches->{$br}->{'branchname'};
 857                         }
 858                     }
 859                     $session->param('number',$borrowernumber);
 860                     $session->param('id',$userid);
 861                     $session->param('cardnumber',$cardnumber);
 862                     $session->param('firstname',$firstname);
 863                     $session->param('surname',$surname);
 864                     $session->param('branch',$branchcode);
 865                     $session->param('branchname',$branchname);
 866                     $session->param('flags',$userflags);
 867                     $session->param('emailaddress',$emailaddress);
 868                     $session->param('ip',$session->remote_addr());
 869                     $session->param('lasttime',time());
 870                     $debug and printf STDERR "AUTH_4: (%s)\t%s %s - %s\n", map {$session->param($_)} qw(cardnumber firstname surname branch) ;
 871                 }
 872                 elsif ( $return == 2 ) {
 873                     #We suppose the user is the superlibrarian
 874                     $borrowernumber = 0;
 875                     $session->param('number',0);
 876                     $session->param('id',C4::Context->config('user'));
 877                     $session->param('cardnumber',C4::Context->config('user'));
 878                     $session->param('firstname',C4::Context->config('user'));
 879                     $session->param('surname',C4::Context->config('user'));
 880                     $session->param('branch','NO_LIBRARY_SET');
 881                     $session->param('branchname','NO_LIBRARY_SET');
 882                     $session->param('flags',1);
 883                     $session->param('emailaddress', C4::Context->preference('KohaAdminEmailAddress'));
 884                     $session->param('ip',$session->remote_addr());
 885                     $session->param('lasttime',time());
 886                 }
 887                 C4::Context::set_userenv(
 888                     $session->param('number'),       $session->param('id'),
 889                     $session->param('cardnumber'),   $session->param('firstname'),
 890                     $session->param('surname'),      $session->param('branch'),
 891                     $session->param('branchname'),   $session->param('flags'),
 892                     $session->param('emailaddress'), $session->param('branchprinter')
 893                 );
 894
 895             }
 896                 else {
 897                 if ($userid) {
 898                         $info{'invalid_username_or_password'} = 1;
 899                         C4::Context->_unset_userenv($sessionID);
 900                 }
 901                         }
 902         }       # END if ( $userid    = $query->param('userid') )
 903                 elsif ($type eq "opac") {
 904             # if we are here this is an anonymous session; add public lists to it and a few other items...
 905             # anonymous sessions are created only for the OPAC
 906                         $debug and warn "Initiating an anonymous session...";
 907
 908                         # setting a couple of other session vars...
 909                         $session->param('ip',$session->remote_addr());
 910                         $session->param('lasttime',time());
 911                         $session->param('sessiontype','anon');
 912                 }
 913     }   # END unless ($userid)
 914     my $insecure = C4::Context->boolean_preference('insecure');
 915
 916     # finished authentification, now respond
 917     if ( $loggedin || $authnotrequired || ( defined($insecure) && $insecure ) )
 918     {
 919         # successful login
 920         unless ($cookie) {
 921             $cookie = $query->cookie( CGISESSID => '' );
 922         }
 923         return ( $userid, $cookie, $sessionID, $flags );
 924     }
 925
 926 #
 927 #
 928 # AUTH rejected, show the login/password template, after checking the DB.
 929 #
 930 #
 931
 932     # get the inputs from the incoming query
 933     my @inputs = ();
 934     foreach my $name ( param $query) {
 935         (next) if ( $name eq 'userid' || $name eq 'password' || $name eq 'ticket' );
 936         my $value = $query->param($name);
 937         push @inputs, { name => $name, value => $value };
 938     }
 939     # get the branchloop, which we need for authentication
 940     my $branches = GetBranches();
 941     my @branch_loop;
 942     for my $branch_hash (sort keys %$branches) {
 943                 push @branch_loop, {branchcode => "$branch_hash", branchname => $branches->{$branch_hash}->{'branchname'}, };
 944     }
 945
 946     my $template_name = ( $type eq 'opac' ) ? 'opac-auth.tmpl' : 'auth.tmpl';
 947     my $template = C4::Templates::gettemplate( $template_name, $type, $query );
 948     $template->param(branchloop => \@branch_loop,);
 949     my $checkstyle = C4::Context->preference("opaccolorstylesheet");
 950     if ($checkstyle =~ /\//)
 951         {
 952                 $template->param( opacexternalsheet => $checkstyle);
 953         } else
 954         {
 955                 my $opaccolorstylesheet = C4::Context->preference("opaccolorstylesheet");
 956             $template->param( opaccolorstylesheet => $opaccolorstylesheet);
 957         }
 958     $template->param(
 959     login        => 1,
 960         INPUTS               => \@inputs,
 961         casAuthentication    => C4::Context->preference("casAuthentication"),
 962         suggestion           => C4::Context->preference("suggestion"),
 963         virtualshelves       => C4::Context->preference("virtualshelves"),
 964         LibraryName          => C4::Context->preference("LibraryName"),
 965         opacuserlogin        => C4::Context->preference("opacuserlogin"),
 966         OpacNav              => C4::Context->preference("OpacNav"),
 967         OpacNavBottom        => C4::Context->preference("OpacNavBottom"),
 968         opaccredits          => C4::Context->preference("opaccredits"),
 969         OpacFavicon          => C4::Context->preference("OpacFavicon"),
 970         opacreadinghistory   => C4::Context->preference("opacreadinghistory"),
 971         opacsmallimage       => C4::Context->preference("opacsmallimage"),
 972         opaclayoutstylesheet => C4::Context->preference("opaclayoutstylesheet"),
 973         opaclanguagesdisplay => C4::Context->preference("opaclanguagesdisplay"),
 974         opacuserjs           => C4::Context->preference("opacuserjs"),
 975         opacbookbag          => "" . C4::Context->preference("opacbookbag"),
 976         OpacCloud            => C4::Context->preference("OpacCloud"),
 977         OpacTopissue         => C4::Context->preference("OpacTopissue"),
 978         OpacAuthorities      => C4::Context->preference("OpacAuthorities"),
 979         OpacBrowser          => C4::Context->preference("OpacBrowser"),
 980         opacheader           => C4::Context->preference("opacheader"),
 981         TagsEnabled                  => C4::Context->preference("TagsEnabled"),
 982         OPACUserCSS           => C4::Context->preference("OPACUserCSS"),
 983         opacstylesheet       => C4::Context->preference("opacstylesheet"),
 984         intranetcolorstylesheet =>
 985                                                                 C4::Context->preference("intranetcolorstylesheet"),
 986         intranetstylesheet => C4::Context->preference("intranetstylesheet"),
 987         intranetbookbag    => C4::Context->preference("intranetbookbag"),
 988         IntranetNav        => C4::Context->preference("IntranetNav"),
 989         intranetuserjs     => C4::Context->preference("intranetuserjs"),
 990         IndependantBranches=> C4::Context->preference("IndependantBranches"),
 991         AutoLocation       => C4::Context->preference("AutoLocation"),
 992                 wrongip            => $info{'wrongip'},
 993     );
 994
 995     $template->param( OpacPublic => C4::Context->preference("OpacPublic"));
 996     $template->param( loginprompt => 1 ) unless $info{'nopermission'};
 997
 998     if ($cas) {
 999
1000         # Is authentication against multiple CAS servers enabled?
1001         if (C4::Auth_with_cas::multipleAuth && !$casparam) {
1002             my $casservers = C4::Auth_with_cas::getMultipleAuth();
1003             my @tmplservers;
1004             foreach my $key (keys %$casservers) {
1005                 push @tmplservers, {name => $key, value => login_cas_url($query, $key) . "?cas=$key" };
1006             }
1007             #warn Data::Dumper::Dumper(\@tmplservers);
1008             $template->param(
1009                 casServersLoop => \@tmplservers
1010             );
1011         } else {
1012         $template->param(
1013             casServerUrl    => login_cas_url($query),
1014             );
1015         }
1016
1017         $template->param(
1018             invalidCasLogin => $info{'invalidCasLogin'}
1019         );
1020     }
1021
1022     my $self_url = $query->url( -absolute => 1 );
1023     $template->param(
1024         url         => $self_url,
1025         LibraryName => C4::Context->preference("LibraryName"),
1026     );
1027     $template->param( %info );
1028 #    $cookie = $query->cookie(CGISESSID => $session->id
1029 #   );
1030     print $query->header(
1031         -type   => 'text/html',
1032         -charset => 'utf-8',
1033         -cookie => $cookie
1034       ),
1035       $template->output;
1036     safe_exit;
1037 }
1038
1039 =head2 check_api_auth
1040
1041   ($status, $cookie, $sessionId) = check_api_auth($query, $userflags);
1042
1043 Given a CGI query containing the parameters 'userid' and 'password' and/or a session
1044 cookie, determine if the user has the privileges specified by C<$userflags>.
1045
1046 C<check_api_auth> is is meant for authenticating users of web services, and
1047 consequently will always return and will not attempt to redirect the user
1048 agent.
1049
1050 If a valid session cookie is already present, check_api_auth will return a status
1051 of "ok", the cookie, and the Koha session ID.
1052
1053 If no session cookie is present, check_api_auth will check the 'userid' and 'password
1054 parameters and create a session cookie and Koha session if the supplied credentials
1055 are OK.
1056
1057 Possible return values in C<$status> are:
1058
1059 =over
1060
1061 =item "ok" -- user authenticated; C<$cookie> and C<$sessionid> have valid values.
1062
1063 =item "failed" -- credentials are not correct; C<$cookie> and C<$sessionid> are undef
1064
1065 =item "maintenance" -- DB is in maintenance mode; no login possible at the moment
1066
1067 =item "expired -- session cookie has expired; API user should resubmit userid and password
1068
1069 =back
1070
1071 =cut
1072
1073 sub check_api_auth {
1074     my $query = shift;
1075     my $flagsrequired = shift;
1076
1077     my $dbh     = C4::Context->dbh;
1078     my $timeout = C4::Context->preference('timeout');
1079     $timeout = 600 unless $timeout;
1080
1081     unless (C4::Context->preference('Version')) {
1082         # database has not been installed yet
1083         return ("maintenance", undef, undef);
1084     }
1085     my $kohaversion=C4::Context::KOHAVERSION;
1086     $kohaversion =~ s/(.*\..*)\.(.*)\.(.*)/$1$2$3/;
1087     if (C4::Context->preference('Version') < $kohaversion) {
1088         # database in need of version update; assume that
1089         # no API should be called while databsae is in
1090         # this condition.
1091         return ("maintenance", undef, undef);
1092     }
1093
1094     # FIXME -- most of what follows is a copy-and-paste
1095     # of code from checkauth.  There is an obvious need
1096     # for refactoring to separate the various parts of
1097     # the authentication code, but as of 2007-11-19 this
1098     # is deferred so as to not introduce bugs into the
1099     # regular authentication code for Koha 3.0.
1100
1101     # see if we have a valid session cookie already
1102     # however, if a userid parameter is present (i.e., from
1103     # a form submission, assume that any current cookie
1104     # is to be ignored
1105     my $sessionID = undef;
1106     unless ($query->param('userid')) {
1107         $sessionID = $query->cookie("CGISESSID");
1108     }
1109     if ($sessionID && not ($cas && $query->param('PT')) ) {
1110         my $session = get_session($sessionID);
1111         C4::Context->_new_userenv($sessionID);
1112         if ($session) {
1113             C4::Context::set_userenv(
1114                 $session->param('number'),       $session->param('id'),
1115                 $session->param('cardnumber'),   $session->param('firstname'),
1116                 $session->param('surname'),      $session->param('branch'),
1117                 $session->param('branchname'),   $session->param('flags'),
1118                 $session->param('emailaddress'), $session->param('branchprinter')
1119             );
1120
1121             my $ip = $session->param('ip');
1122             my $lasttime = $session->param('lasttime');
1123             my $userid = $session->param('id');
1124             if ( $lasttime < time() - $timeout ) {
1125                 # time out
1126                 $session->delete();
1127                 C4::Context->_unset_userenv($sessionID);
1128                 $userid    = undef;
1129                 $sessionID = undef;
1130                 return ("expired", undef, undef);
1131             } elsif ( $ip ne $ENV{'REMOTE_ADDR'} ) {
1132                 # IP address changed
1133                 $session->delete();
1134                 C4::Context->_unset_userenv($sessionID);
1135                 $userid    = undef;
1136                 $sessionID = undef;
1137                 return ("expired", undef, undef);
1138             } else {
1139                 my $cookie = $query->cookie( CGISESSID => $session->id );
1140                 $session->param('lasttime',time());
1141                 my $flags = haspermission($userid, $flagsrequired);
1142                 if ($flags) {
1143                     return ("ok", $cookie, $sessionID);
1144                 } else {
1145                     $session->delete();
1146                     C4::Context->_unset_userenv($sessionID);
1147                     $userid    = undef;
1148                     $sessionID = undef;
1149                     return ("failed", undef, undef);
1150                 }
1151             }
1152         } else {
1153             return ("expired", undef, undef);
1154         }
1155     } else {
1156         # new login
1157         my $userid = $query->param('userid');
1158         my $password = $query->param('password');
1159         my ($return, $cardnumber);
1160
1161         # Proxy CAS auth
1162         if ($cas && $query->param('PT')) {
1163             my $retuserid;
1164             $debug and print STDERR "## check_api_auth - checking CAS\n";
1165             # In case of a CAS authentication, we use the ticket instead of the password
1166             my $PT = $query->param('PT');
1167             ($return,$cardnumber,$userid) = check_api_auth_cas($dbh, $PT, $query);    # EXTERNAL AUTH
1168         } else {
1169             # User / password auth
1170             unless ($userid and $password) {
1171                 # caller did something wrong, fail the authenticateion
1172                 return ("failed", undef, undef);
1173             }
1174             ( $return, $cardnumber ) = checkpw( $dbh, $userid, $password, $query );
1175         }
1176
1177         if ($return and haspermission(  $userid, $flagsrequired)) {
1178             my $session = get_session("");
1179             return ("failed", undef, undef) unless $session;
1180
1181             my $sessionID = $session->id;
1182             C4::Context->_new_userenv($sessionID);
1183             my $cookie = $query->cookie(CGISESSID => $sessionID);
1184             if ( $return == 1 ) {
1185                 my (
1186                     $borrowernumber, $firstname,  $surname,
1187                     $userflags,      $branchcode, $branchname,
1188                     $branchprinter,  $emailaddress
1189                 );
1190                 my $sth =
1191                   $dbh->prepare(
1192 "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=?"
1193                   );
1194                 $sth->execute($userid);
1195                 (
1196                     $borrowernumber, $firstname,  $surname,
1197                     $userflags,      $branchcode, $branchname,
1198                     $branchprinter,  $emailaddress
1199                 ) = $sth->fetchrow if ( $sth->rows );
1200
1201                 unless ($sth->rows ) {
1202                     my $sth = $dbh->prepare(
1203 "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=?"
1204                       );
1205                     $sth->execute($cardnumber);
1206                     (
1207                         $borrowernumber, $firstname,  $surname,
1208                         $userflags,      $branchcode, $branchname,
1209                         $branchprinter,  $emailaddress
1210                     ) = $sth->fetchrow if ( $sth->rows );
1211
1212                     unless ( $sth->rows ) {
1213                         $sth->execute($userid);
1214                         (
1215                             $borrowernumber, $firstname, $surname, $userflags,
1216                             $branchcode, $branchname, $branchprinter, $emailaddress
1217                         ) = $sth->fetchrow if ( $sth->rows );
1218                     }
1219                 }
1220
1221                 my $ip       = $ENV{'REMOTE_ADDR'};
1222                 # if they specify at login, use that
1223                 if ($query->param('branch')) {
1224                     $branchcode  = $query->param('branch');
1225                     $branchname = GetBranchName($branchcode);
1226                 }
1227                 my $branches = GetBranches();
1228                 my @branchesloop;
1229                 foreach my $br ( keys %$branches ) {
1230                     #     now we work with the treatment of ip
1231                     my $domain = $branches->{$br}->{'branchip'};
1232                     if ( $domain && $ip =~ /^$domain/ ) {
1233                         $branchcode = $branches->{$br}->{'branchcode'};
1234
1235                         # new op dev : add the branchprinter and branchname in the cookie
1236                         $branchprinter = $branches->{$br}->{'branchprinter'};
1237                         $branchname    = $branches->{$br}->{'branchname'};
1238                     }
1239                 }
1240                 $session->param('number',$borrowernumber);
1241                 $session->param('id',$userid);
1242                 $session->param('cardnumber',$cardnumber);
1243                 $session->param('firstname',$firstname);
1244                 $session->param('surname',$surname);
1245                 $session->param('branch',$branchcode);
1246                 $session->param('branchname',$branchname);
1247                 $session->param('flags',$userflags);
1248                 $session->param('emailaddress',$emailaddress);
1249                 $session->param('ip',$session->remote_addr());
1250                 $session->param('lasttime',time());
1251             } elsif ( $return == 2 ) {
1252                 #We suppose the user is the superlibrarian
1253                 $session->param('number',0);
1254                 $session->param('id',C4::Context->config('user'));
1255                 $session->param('cardnumber',C4::Context->config('user'));
1256                 $session->param('firstname',C4::Context->config('user'));
1257                 $session->param('surname',C4::Context->config('user'));
1258                 $session->param('branch','NO_LIBRARY_SET');
1259                 $session->param('branchname','NO_LIBRARY_SET');
1260                 $session->param('flags',1);
1261                 $session->param('emailaddress', C4::Context->preference('KohaAdminEmailAddress'));
1262                 $session->param('ip',$session->remote_addr());
1263                 $session->param('lasttime',time());
1264             }
1265             C4::Context::set_userenv(
1266                 $session->param('number'),       $session->param('id'),
1267                 $session->param('cardnumber'),   $session->param('firstname'),
1268                 $session->param('surname'),      $session->param('branch'),
1269                 $session->param('branchname'),   $session->param('flags'),
1270                 $session->param('emailaddress'), $session->param('branchprinter')
1271             );
1272             return ("ok", $cookie, $sessionID);
1273         } else {
1274             return ("failed", undef, undef);
1275         }
1276     }
1277 }
1278
1279 =head2 check_cookie_auth
1280
1281   ($status, $sessionId) = check_api_auth($cookie, $userflags);
1282
1283 Given a CGISESSID cookie set during a previous login to Koha, determine
1284 if the user has the privileges specified by C<$userflags>.
1285
1286 C<check_cookie_auth> is meant for authenticating special services
1287 such as tools/upload-file.pl that are invoked by other pages that
1288 have been authenticated in the usual way.
1289
1290 Possible return values in C<$status> are:
1291
1292 =over
1293
1294 =item "ok" -- user authenticated; C<$sessionID> have valid values.
1295
1296 =item "failed" -- credentials are not correct; C<$sessionid> are undef
1297
1298 =item "maintenance" -- DB is in maintenance mode; no login possible at the moment
1299
1300 =item "expired -- session cookie has expired; API user should resubmit userid and password
1301
1302 =back
1303
1304 =cut
1305
1306 sub check_cookie_auth {
1307     my $cookie = shift;
1308     my $flagsrequired = shift;
1309
1310     my $dbh     = C4::Context->dbh;
1311     my $timeout = C4::Context->preference('timeout');
1312     $timeout = 600 unless $timeout;
1313
1314     unless (C4::Context->preference('Version')) {
1315         # database has not been installed yet
1316         return ("maintenance", undef);
1317     }
1318     my $kohaversion=C4::Context::KOHAVERSION;
1319     $kohaversion =~ s/(.*\..*)\.(.*)\.(.*)/$1$2$3/;
1320     if (C4::Context->preference('Version') < $kohaversion) {
1321         # database in need of version update; assume that
1322         # no API should be called while databsae is in
1323         # this condition.
1324         return ("maintenance", undef);
1325     }
1326
1327     # FIXME -- most of what follows is a copy-and-paste
1328     # of code from checkauth.  There is an obvious need
1329     # for refactoring to separate the various parts of
1330     # the authentication code, but as of 2007-11-23 this
1331     # is deferred so as to not introduce bugs into the
1332     # regular authentication code for Koha 3.0.
1333
1334     # see if we have a valid session cookie already
1335     # however, if a userid parameter is present (i.e., from
1336     # a form submission, assume that any current cookie
1337     # is to be ignored
1338     unless (defined $cookie and $cookie) {
1339         return ("failed", undef);
1340     }
1341     my $sessionID = $cookie;
1342     my $session = get_session($sessionID);
1343     C4::Context->_new_userenv($sessionID);
1344     if ($session) {
1345         C4::Context::set_userenv(
1346             $session->param('number'),       $session->param('id'),
1347             $session->param('cardnumber'),   $session->param('firstname'),
1348             $session->param('surname'),      $session->param('branch'),
1349             $session->param('branchname'),   $session->param('flags'),
1350             $session->param('emailaddress'), $session->param('branchprinter')
1351         );
1352
1353         my $ip = $session->param('ip');
1354         my $lasttime = $session->param('lasttime');
1355         my $userid = $session->param('id');
1356         if ( $lasttime < time() - $timeout ) {
1357             # time out
1358             $session->delete();
1359             C4::Context->_unset_userenv($sessionID);
1360             $userid    = undef;
1361             $sessionID = undef;
1362             return ("expired", undef);
1363         } elsif ( $ip ne $ENV{'REMOTE_ADDR'} ) {
1364             # IP address changed
1365             $session->delete();
1366             C4::Context->_unset_userenv($sessionID);
1367             $userid    = undef;
1368             $sessionID = undef;
1369             return ("expired", undef);
1370         } else {
1371             $session->param('lasttime',time());
1372             my $flags = haspermission($userid, $flagsrequired);
1373             if ($flags) {
1374                 return ("ok", $sessionID);
1375             } else {
1376                 $session->delete();
1377                 C4::Context->_unset_userenv($sessionID);
1378                 $userid    = undef;
1379                 $sessionID = undef;
1380                 return ("failed", undef);
1381             }
1382         }
1383     } else {
1384         return ("expired", undef);
1385     }
1386 }
1387
1388 =head2 get_session
1389
1390   use CGI::Session;
1391   my $session = get_session($sessionID);
1392
1393 Given a session ID, retrieve the CGI::Session object used to store
1394 the session's state.  The session object can be used to store
1395 data that needs to be accessed by different scripts during a
1396 user's session.
1397
1398 If the C<$sessionID> parameter is an empty string, a new session
1399 will be created.
1400
1401 =cut
1402
1403 sub get_session {
1404     my $sessionID = shift;
1405     my $storage_method = C4::Context->preference('SessionStorage');
1406     my $dbh = C4::Context->dbh;
1407     my $session;
1408     if ($storage_method eq 'mysql'){
1409         $session = new CGI::Session("driver:MySQL;serializer:yaml;id:md5", $sessionID, {Handle=>$dbh});
1410     }
1411     elsif ($storage_method eq 'Pg') {
1412         $session = new CGI::Session("driver:PostgreSQL;serializer:yaml;id:md5", $sessionID, {Handle=>$dbh});
1413     }
1414     elsif ($storage_method eq 'memcached' && C4::Context->ismemcached){
1415         $session = new CGI::Session("driver:memcached;serializer:yaml;id:md5", $sessionID, { Memcached => C4::Context->memcached } );
1416     }
1417     else {
1418         # catch all defaults to tmp should work on all systems
1419         $session = new CGI::Session("driver:File;serializer:yaml;id:md5", $sessionID, {Directory=>'/tmp'});
1420     }
1421     return $session;
1422 }
1423
1424 sub checkpw {
1425
1426     my ( $dbh, $userid, $password, $query ) = @_;
1427     if ($ldap) {
1428         $debug and print STDERR "## checkpw - checking LDAP\n";
1429         my ($retval,$retcard,$retuserid) = checkpw_ldap(@_);    # EXTERNAL AUTH
1430         ($retval) and return ($retval,$retcard,$retuserid);
1431     }
1432
1433     if ($cas && $query && $query->param('ticket')) {
1434         $debug and print STDERR "## checkpw - checking CAS\n";
1435         # In case of a CAS authentication, we use the ticket instead of the password
1436         my $ticket = $query->param('ticket');
1437         my ($retval,$retcard,$retuserid) = checkpw_cas($dbh, $ticket, $query);    # EXTERNAL AUTH
1438         ($retval) and return ($retval,$retcard,$retuserid);
1439         return 0;
1440     }
1441
1442     # INTERNAL AUTH
1443     my $sth =
1444       $dbh->prepare(
1445 "select password,cardnumber,borrowernumber,userid,firstname,surname,branchcode,flags from borrowers where userid=?"
1446       );
1447     $sth->execute($userid);
1448     if ( $sth->rows ) {
1449         my ( $md5password, $cardnumber, $borrowernumber, $userid, $firstname,
1450             $surname, $branchcode, $flags )
1451           = $sth->fetchrow;
1452         if ( md5_base64($password) eq $md5password and $md5password ne "!") {
1453
1454             C4::Context->set_userenv( "$borrowernumber", $userid, $cardnumber,
1455                 $firstname, $surname, $branchcode, $flags );
1456             return 1, $cardnumber, $userid;
1457         }
1458     }
1459     $sth =
1460       $dbh->prepare(
1461 "select password,cardnumber,borrowernumber,userid, firstname,surname,branchcode,flags from borrowers where cardnumber=?"
1462       );
1463     $sth->execute($userid);
1464     if ( $sth->rows ) {
1465         my ( $md5password, $cardnumber, $borrowernumber, $userid, $firstname,
1466             $surname, $branchcode, $flags )
1467           = $sth->fetchrow;
1468         if ( md5_base64($password) eq $md5password ) {
1469
1470             C4::Context->set_userenv( $borrowernumber, $userid, $cardnumber,
1471                 $firstname, $surname, $branchcode, $flags );
1472             return 1, $cardnumber, $userid;
1473         }
1474     }
1475     if (   $userid && $userid eq C4::Context->config('user')
1476         && "$password" eq C4::Context->config('pass') )
1477     {
1478
1479 # Koha superuser account
1480 #     C4::Context->set_userenv(0,0,C4::Context->config('user'),C4::Context->config('user'),C4::Context->config('user'),"",1);
1481         return 2;
1482     }
1483     if (   $userid && $userid eq 'demo'
1484         && "$password" eq 'demo'
1485         && C4::Context->config('demo') )
1486     {
1487
1488 # DEMO => the demo user is allowed to do everything (if demo set to 1 in koha.conf
1489 # some features won't be effective : modify systempref, modify MARC structure,
1490         return 2;
1491     }
1492     return 0;
1493 }
1494
1495 =head2 getuserflags
1496
1497     my $authflags = getuserflags($flags, $userid, [$dbh]);
1498
1499 Translates integer flags into permissions strings hash.
1500
1501 C<$flags> is the integer userflags value ( borrowers.userflags )
1502 C<$userid> is the members.userid, used for building subpermissions
1503 C<$authflags> is a hashref of permissions
1504
1505 =cut
1506
1507 sub getuserflags {
1508     my $flags   = shift;
1509     my $userid  = shift;
1510     my $dbh     = @_ ? shift : C4::Context->dbh;
1511     my $userflags;
1512     $flags = 0 unless $flags;
1513     my $sth = $dbh->prepare("SELECT bit, flag, defaulton FROM userflags");
1514     $sth->execute;
1515
1516     while ( my ( $bit, $flag, $defaulton ) = $sth->fetchrow ) {
1517         if ( ( $flags & ( 2**$bit ) ) || $defaulton ) {
1518             $userflags->{$flag} = 1;
1519         }
1520         else {
1521             $userflags->{$flag} = 0;
1522         }
1523     }
1524
1525     # get subpermissions and merge with top-level permissions
1526     my $user_subperms = get_user_subpermissions($userid);
1527     foreach my $module (keys %$user_subperms) {
1528         next if $userflags->{$module} == 1; # user already has permission for everything in this module
1529         $userflags->{$module} = $user_subperms->{$module};
1530     }
1531
1532     return $userflags;
1533 }
1534
1535 =head2 get_user_subpermissions
1536
1537   $user_perm_hashref = get_user_subpermissions($userid);
1538
1539 Given the userid (note, not the borrowernumber) of a staff user,
1540 return a hashref of hashrefs of the specific subpermissions
1541 accorded to the user.  An example return is
1542
1543  {
1544     tools => {
1545         export_catalog => 1,
1546         import_patrons => 1,
1547     }
1548  }
1549
1550 The top-level hash-key is a module or function code from
1551 userflags.flag, while the second-level key is a code
1552 from permissions.
1553
1554 The results of this function do not give a complete picture
1555 of the functions that a staff user can access; it is also
1556 necessary to check borrowers.flags.
1557
1558 =cut
1559
1560 sub get_user_subpermissions {
1561     my $userid = shift;
1562
1563     my $dbh = C4::Context->dbh;
1564     my $sth = $dbh->prepare("SELECT flag, user_permissions.code
1565                              FROM user_permissions
1566                              JOIN permissions USING (module_bit, code)
1567                              JOIN userflags ON (module_bit = bit)
1568                              JOIN borrowers USING (borrowernumber)
1569                              WHERE userid = ?");
1570     $sth->execute($userid);
1571
1572     my $user_perms = {};
1573     while (my $perm = $sth->fetchrow_hashref) {
1574         $user_perms->{$perm->{'flag'}}->{$perm->{'code'}} = 1;
1575     }
1576     return $user_perms;
1577 }
1578
1579 =head2 get_all_subpermissions
1580
1581   my $perm_hashref = get_all_subpermissions();
1582
1583 Returns a hashref of hashrefs defining all specific
1584 permissions currently defined.  The return value
1585 has the same structure as that of C<get_user_subpermissions>,
1586 except that the innermost hash value is the description
1587 of the subpermission.
1588
1589 =cut
1590
1591 sub get_all_subpermissions {
1592     my $dbh = C4::Context->dbh;
1593     my $sth = $dbh->prepare("SELECT flag, code, description
1594                              FROM permissions
1595                              JOIN userflags ON (module_bit = bit)");
1596     $sth->execute();
1597
1598     my $all_perms = {};
1599     while (my $perm = $sth->fetchrow_hashref) {
1600         $all_perms->{$perm->{'flag'}}->{$perm->{'code'}} = $perm->{'description'};
1601     }
1602     return $all_perms;
1603 }
1604
1605 =head2 haspermission
1606
1607   $flags = ($userid, $flagsrequired);
1608
1609 C<$userid> the userid of the member
1610 C<$flags> is a hashref of required flags like C<$borrower-&lt;{authflags}>
1611
1612 Returns member's flags or 0 if a permission is not met.
1613
1614 =cut
1615
1616 sub haspermission {
1617     my ($userid, $flagsrequired) = @_;
1618     my $sth = C4::Context->dbh->prepare("SELECT flags FROM borrowers WHERE userid=?");
1619     $sth->execute($userid);
1620     my $flags = getuserflags($sth->fetchrow(), $userid);
1621     if ( $userid eq C4::Context->config('user') ) {
1622         # Super User Account from /etc/koha.conf
1623         $flags->{'superlibrarian'} = 1;
1624     }
1625     elsif ( $userid eq 'demo' && C4::Context->config('demo') ) {
1626         # Demo user that can do "anything" (demo=1 in /etc/koha.conf)
1627         $flags->{'superlibrarian'} = 1;
1628     }
1629
1630     return $flags if $flags->{superlibrarian};
1631
1632     foreach my $module ( keys %$flagsrequired ) {
1633         my $subperm = $flagsrequired->{$module};
1634         if ($subperm eq '*') {
1635             return 0 unless ( $flags->{$module} == 1 or ref($flags->{$module}) );
1636         } else {
1637             return 0 unless ( $flags->{$module} == 1 or
1638                                 ( ref($flags->{$module}) and
1639                                   exists $flags->{$module}->{$subperm} and
1640                                   $flags->{$module}->{$subperm} == 1
1641                                 )
1642                             );
1643         }
1644     }
1645     return $flags;
1646     #FIXME - This fcn should return the failed permission so a suitable error msg can be delivered.
1647 }
1648
1649
1650 sub getborrowernumber {
1651     my ($userid) = @_;
1652     my $userenv = C4::Context->userenv;
1653     if ( defined( $userenv ) && ref( $userenv ) eq 'HASH' && $userenv->{number} ) {
1654         return $userenv->{number};
1655     }
1656     my $dbh = C4::Context->dbh;
1657     for my $field ( 'userid', 'cardnumber' ) {
1658         my $sth =
1659           $dbh->prepare("select borrowernumber from borrowers where $field=?");
1660         $sth->execute($userid);
1661         if ( $sth->rows ) {
1662             my ($bnumber) = $sth->fetchrow;
1663             return $bnumber;
1664         }
1665     }
1666     return 0;
1667 }
1668
1669
1670 END { }    # module clean-up code here (global destructor)
1671 1;
1672 __END__
1673
1674 =head1 SEE ALSO
1675
1676 CGI(3)
1677
1678 C4::Output(3)
1679
1680 Digest::MD5(3)
1681
1682 =cut