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         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             EnableBorrowerFiles         => C4::Context->preference('EnableBorrowerFiles'),
 369         );
 370     }
 371     else {
 372         warn "template type should be OPAC, here it is=[" . $in->{'type'} . "]" unless ( $in->{'type'} eq 'opac' );
 373         #TODO : replace LibraryName syspref with 'system name', and remove this html processing
 374         my $LibraryNameTitle = C4::Context->preference("LibraryName");
 375         $LibraryNameTitle =~ s/<(?:\/?)(?:br|p)\s*(?:\/?)>/ /sgi;
 376         $LibraryNameTitle =~ s/<(?:[^<>'"]|'(?:[^']*)'|"(?:[^"]*)")*>//sg;
 377         # clean up the busc param in the session if the page is not opac-detail
 378         if (C4::Context->preference("OpacBrowseResults") && $in->{'template_name'} =~ /opac-(.+)\.(?:tt|tmpl)$/ && $1 !~ /^(?:MARC|ISBD)?detail$/) {
 379             my $sessionSearch = get_session($sessionID || $in->{'query'}->cookie("CGISESSID"));
 380             $sessionSearch->clear(["busc"]) if ($sessionSearch->param("busc"));
 381         }
 382         # variables passed from CGI: opac_css_override and opac_search_limits.
 383         my $opac_search_limit = $ENV{'OPAC_SEARCH_LIMIT'};
 384         my $opac_limit_override = $ENV{'OPAC_LIMIT_OVERRIDE'};
 385         my $opac_name = '';
 386         if (($opac_search_limit =~ /branch:(\w+)/ && $opac_limit_override) || $in->{'query'}->param('limit') =~ /branch:(\w+)/){
 387             $opac_name = $1;   # opac_search_limit is a branch, so we use it.
 388         } elsif (C4::Context->preference("SearchMyLibraryFirst") && C4::Context->userenv && C4::Context->userenv->{'branch'}) {
 389             $opac_name = C4::Context->userenv->{'branch'};
 390         }
 391         my $checkstyle = C4::Context->preference("opaccolorstylesheet");
 392         if ($checkstyle =~ /http/)
 393         {
 394                 $template->param( opacexternalsheet => $checkstyle);
 395         } else
 396         {
 397                 my $opaccolorstylesheet = C4::Context->preference("opaccolorstylesheet");
 398             $template->param( opaccolorstylesheet => $opaccolorstylesheet);
 399         }
 400         $template->param(
 401             AmazonContent             => "" . C4::Context->preference("AmazonContent"),
 402             AnonSuggestions           => "" . C4::Context->preference("AnonSuggestions"),
 403             AuthorisedValueImages     => C4::Context->preference("AuthorisedValueImages"),
 404             BranchesLoop              => GetBranchesLoop($opac_name),
 405             CalendarFirstDayOfWeek      => (C4::Context->preference("CalendarFirstDayOfWeek") eq "Sunday")?0:1,
 406             LibraryName               => "" . C4::Context->preference("LibraryName"),
 407             LibraryNameTitle          => "" . $LibraryNameTitle,
 408             LoginBranchname           => C4::Context->userenv?C4::Context->userenv->{"branchname"}:"",
 409             OPACAmazonEnabled         => C4::Context->preference("OPACAmazonEnabled"),
 410             OPACAmazonSimilarItems    => C4::Context->preference("OPACAmazonSimilarItems"),
 411             OPACAmazonCoverImages     => C4::Context->preference("OPACAmazonCoverImages"),
 412             OPACAmazonReviews         => C4::Context->preference("OPACAmazonReviews"),
 413             OPACFRBRizeEditions       => C4::Context->preference("OPACFRBRizeEditions"),
 414             OpacHighlightedWords       => C4::Context->preference("OpacHighlightedWords"),
 415             OPACItemHolds             => C4::Context->preference("OPACItemHolds"),
 416             OPACShelfBrowser          => "". C4::Context->preference("OPACShelfBrowser"),
 417             OpacShowRecentComments    => C4::Context->preference("OpacShowRecentComments"),
 418             OPACURLOpenInNewWindow    => "" . C4::Context->preference("OPACURLOpenInNewWindow"),
 419             OPACUserCSS               => "". C4::Context->preference("OPACUserCSS"),
 420             OPACViewOthersSuggestions => "" . C4::Context->preference("OPACViewOthersSuggestions"),
 421             OpacAuthorities           => C4::Context->preference("OpacAuthorities"),
 422             OPACBaseURL               => ($in->{'query'}->https() ? "https://" : "http://") . $ENV{'SERVER_NAME'} .
 423                    ($ENV{'SERVER_PORT'} eq ($in->{'query'}->https() ? "443" : "80") ? '' : ":$ENV{'SERVER_PORT'}"),
 424             opac_css_override           => $ENV{'OPAC_CSS_OVERRIDE'},
 425             opac_search_limit         => $opac_search_limit,
 426             opac_limit_override       => $opac_limit_override,
 427             OpacBrowser               => C4::Context->preference("OpacBrowser"),
 428             OpacCloud                 => C4::Context->preference("OpacCloud"),
 429             OpacKohaUrl               => C4::Context->preference("OpacKohaUrl"),
 430             OpacMainUserBlock         => "" . C4::Context->preference("OpacMainUserBlock"),
 431             OpacNav                   => "" . C4::Context->preference("OpacNav"),
 432             OpacNavRight              => "" . C4::Context->preference("OpacNavRight"),
 433             OpacNavBottom             => "" . C4::Context->preference("OpacNavBottom"),
 434             OpacPasswordChange        => C4::Context->preference("OpacPasswordChange"),
 435             OPACPatronDetails        => C4::Context->preference("OPACPatronDetails"),
 436             OPACPrivacy               => C4::Context->preference("OPACPrivacy"),
 437             OPACFinesTab              => C4::Context->preference("OPACFinesTab"),
 438             OpacTopissue              => C4::Context->preference("OpacTopissue"),
 439             RequestOnOpac             => C4::Context->preference("RequestOnOpac"),
 440             'Version'                 => C4::Context->preference('Version'),
 441             hidelostitems             => C4::Context->preference("hidelostitems"),
 442             mylibraryfirst            => (C4::Context->preference("SearchMyLibraryFirst") && C4::Context->userenv) ? C4::Context->userenv->{'branch'} : '',
 443             opaclayoutstylesheet      => "" . C4::Context->preference("opaclayoutstylesheet"),
 444             opacstylesheet            => "" . C4::Context->preference("opacstylesheet"),
 445             opacbookbag               => "" . C4::Context->preference("opacbookbag"),
 446             opaccredits               => "" . C4::Context->preference("opaccredits"),
 447             OpacFavicon               => C4::Context->preference("OpacFavicon"),
 448             opacheader                => "" . C4::Context->preference("opacheader"),
 449             opaclanguagesdisplay      => "" . C4::Context->preference("opaclanguagesdisplay"),
 450             opacreadinghistory        => C4::Context->preference("opacreadinghistory"),
 451             opacsmallimage            => "" . C4::Context->preference("opacsmallimage"),
 452             opacuserjs                => C4::Context->preference("opacuserjs"),
 453             opacuserlogin             => "" . C4::Context->preference("opacuserlogin"),
 454             reviewson                 => C4::Context->preference("reviewson"),
 455             ShowReviewer              => C4::Context->preference("ShowReviewer"),
 456             ShowReviewerPhoto         => C4::Context->preference("ShowReviewerPhoto"),
 457             suggestion                => "" . C4::Context->preference("suggestion"),
 458             virtualshelves            => "" . C4::Context->preference("virtualshelves"),
 459             OPACSerialIssueDisplayCount => C4::Context->preference("OPACSerialIssueDisplayCount"),
 460             OpacAddMastheadLibraryPulldown => C4::Context->preference("OpacAddMastheadLibraryPulldown"),
 461             OPACXSLTDetailsDisplay           => C4::Context->preference("OPACXSLTDetailsDisplay"),
 462             OPACXSLTResultsDisplay           => C4::Context->preference("OPACXSLTResultsDisplay"),
 463             SyndeticsClientCode          => C4::Context->preference("SyndeticsClientCode"),
 464             SyndeticsEnabled             => C4::Context->preference("SyndeticsEnabled"),
 465             SyndeticsCoverImages         => C4::Context->preference("SyndeticsCoverImages"),
 466             SyndeticsTOC                 => C4::Context->preference("SyndeticsTOC"),
 467             SyndeticsSummary             => C4::Context->preference("SyndeticsSummary"),
 468             SyndeticsEditions            => C4::Context->preference("SyndeticsEditions"),
 469             SyndeticsExcerpt             => C4::Context->preference("SyndeticsExcerpt"),
 470             SyndeticsReviews             => C4::Context->preference("SyndeticsReviews"),
 471             SyndeticsAuthorNotes         => C4::Context->preference("SyndeticsAuthorNotes"),
 472             SyndeticsAwards              => C4::Context->preference("SyndeticsAwards"),
 473             SyndeticsSeries              => C4::Context->preference("SyndeticsSeries"),
 474             SyndeticsCoverImageSize      => C4::Context->preference("SyndeticsCoverImageSize"),
 475             OPACLocalCoverImages         => C4::Context->preference("OPACLocalCoverImages"),
 476         );
 477
 478         $template->param(OpacPublic => '1') if ($user || C4::Context->preference("OpacPublic"));
 479     }
 480     return ( $template, $borrowernumber, $cookie, $flags);
 481 }
 482
 483 =head2 checkauth
 484
 485   ($userid, $cookie, $sessionID) = &checkauth($query, $noauth, $flagsrequired, $type);
 486
 487 Verifies that the user is authorized to run this script.  If
 488 the user is authorized, a (userid, cookie, session-id, flags)
 489 quadruple is returned.  If the user is not authorized but does
 490 not have the required privilege (see $flagsrequired below), it
 491 displays an error page and exits.  Otherwise, it displays the
 492 login page and exits.
 493
 494 Note that C<&checkauth> will return if and only if the user
 495 is authorized, so it should be called early on, before any
 496 unfinished operations (e.g., if you've opened a file, then
 497 C<&checkauth> won't close it for you).
 498
 499 C<$query> is the CGI object for the script calling C<&checkauth>.
 500
 501 The C<$noauth> argument is optional. If it is set, then no
 502 authorization is required for the script.
 503
 504 C<&checkauth> fetches user and session information from C<$query> and
 505 ensures that the user is authorized to run scripts that require
 506 authorization.
 507
 508 The C<$flagsrequired> argument specifies the required privileges
 509 the user must have if the username and password are correct.
 510 It should be specified as a reference-to-hash; keys in the hash
 511 should be the "flags" for the user, as specified in the Members
 512 intranet module. Any key specified must correspond to a "flag"
 513 in the userflags table. E.g., { circulate => 1 } would specify
 514 that the user must have the "circulate" privilege in order to
 515 proceed. To make sure that access control is correct, the
 516 C<$flagsrequired> parameter must be specified correctly.
 517
 518 Koha also has a concept of sub-permissions, also known as
 519 granular permissions.  This makes the value of each key
 520 in the C<flagsrequired> hash take on an additional
 521 meaning, i.e.,
 522
 523  1
 524
 525 The user must have access to all subfunctions of the module
 526 specified by the hash key.
 527
 528  *
 529
 530 The user must have access to at least one subfunction of the module
 531 specified by the hash key.
 532
 533  specific permission, e.g., 'export_catalog'
 534
 535 The user must have access to the specific subfunction list, which
 536 must correspond to a row in the permissions table.
 537
 538 The C<$type> argument specifies whether the template should be
 539 retrieved from the opac or intranet directory tree.  "opac" is
 540 assumed if it is not specified; however, if C<$type> is specified,
 541 "intranet" is assumed if it is not "opac".
 542
 543 If C<$query> does not have a valid session ID associated with it
 544 (i.e., the user has not logged in) or if the session has expired,
 545 C<&checkauth> presents the user with a login page (from the point of
 546 view of the original script, C<&checkauth> does not return). Once the
 547 user has authenticated, C<&checkauth> restarts the original script
 548 (this time, C<&checkauth> returns).
 549
 550 The login page is provided using a HTML::Template, which is set in the
 551 systempreferences table or at the top of this file. The variable C<$type>
 552 selects which template to use, either the opac or the intranet
 553 authentification template.
 554
 555 C<&checkauth> returns a user ID, a cookie, and a session ID. The
 556 cookie should be sent back to the browser; it verifies that the user
 557 has authenticated.
 558
 559 =cut
 560
 561 sub _version_check ($$) {
 562     my $type = shift;
 563     my $query = shift;
 564     my $version;
 565     # If Version syspref is unavailable, it means Koha is beeing installed,
 566     # and so we must redirect to OPAC maintenance page or to the WebInstaller
 567         # also, if OpacMaintenance is ON, OPAC should redirect to maintenance
 568         if (C4::Context->preference('OpacMaintenance') && $type eq 'opac') {
 569         warn "OPAC Install required, redirecting to maintenance";
 570         print $query->redirect("/cgi-bin/koha/maintenance.pl");
 571     }
 572     unless ( $version = C4::Context->preference('Version') ) {    # assignment, not comparison
 573         if ( $type ne 'opac' ) {
 574             warn "Install required, redirecting to Installer";
 575             print $query->redirect("/cgi-bin/koha/installer/install.pl");
 576         } else {
 577             warn "OPAC Install required, redirecting to maintenance";
 578             print $query->redirect("/cgi-bin/koha/maintenance.pl");
 579         }
 580         safe_exit;
 581     }
 582
 583     # check that database and koha version are the same
 584     # there is no DB version, it's a fresh install,
 585     # go to web installer
 586     # there is a DB version, compare it to the code version
 587     my $kohaversion=C4::Context::KOHAVERSION;
 588     # remove the 3 last . to have a Perl number
 589     $kohaversion =~ s/(.*\..*)\.(.*)\.(.*)/$1$2$3/;
 590     $debug and print STDERR "kohaversion : $kohaversion\n";
 591     if ($version < $kohaversion){
 592         my $warning = "Database update needed, redirecting to %s. Database is $version and Koha is $kohaversion";
 593         if ($type ne 'opac'){
 594             warn sprintf($warning, 'Installer');
 595             print $query->redirect("/cgi-bin/koha/installer/install.pl?step=3");
 596         } else {
 597             warn sprintf("OPAC: " . $warning, 'maintenance');
 598             print $query->redirect("/cgi-bin/koha/maintenance.pl");
 599         }
 600         safe_exit;
 601     }
 602 }
 603
 604 sub _session_log {
 605     (@_) or return 0;
 606     open L, ">>/tmp/sessionlog" or warn "ERROR: Cannot append to /tmp/sessionlog";
 607     printf L join("\n",@_);
 608     close L;
 609 }
 610
 611 sub checkauth {
 612     my $query = shift;
 613         $debug and warn "Checking Auth";
 614     # $authnotrequired will be set for scripts which will run without authentication
 615     my $authnotrequired = shift;
 616     my $flagsrequired   = shift;
 617     my $type            = shift;
 618     $type = 'opac' unless $type;
 619
 620     my $dbh     = C4::Context->dbh;
 621     my $timeout = C4::Context->preference('timeout');
 622     # days
 623     if ($timeout =~ /(\d+)[dD]/) {
 624         $timeout = $1 * 86400;
 625     };
 626     $timeout = 600 unless $timeout;
 627
 628     _version_check($type,$query);
 629     # state variables
 630     my $loggedin = 0;
 631     my %info;
 632     my ( $userid, $cookie, $sessionID, $flags, $barshelves, $pubshelves );
 633     my $logout = $query->param('logout.x');
 634
 635     # This parameter is the name of the CAS server we want to authenticate against,
 636     # when using authentication against multiple CAS servers, as configured in Auth_cas_servers.yaml
 637     my $casparam = $query->param('cas');
 638
 639     if ( $userid = $ENV{'REMOTE_USER'} ) {
 640         # Using Basic Authentication, no cookies required
 641         $cookie = $query->cookie(
 642             -name    => 'CGISESSID',
 643             -value   => '',
 644             -expires => ''
 645         );
 646         $loggedin = 1;
 647     }
 648     elsif ( $sessionID = $query->cookie("CGISESSID")) {     # assignment, not comparison
 649         my $session = get_session($sessionID);
 650         C4::Context->_new_userenv($sessionID);
 651         my ($ip, $lasttime, $sessiontype);
 652         if ($session){
 653             C4::Context::set_userenv(
 654                 $session->param('number'),       $session->param('id'),
 655                 $session->param('cardnumber'),   $session->param('firstname'),
 656                 $session->param('surname'),      $session->param('branch'),
 657                 $session->param('branchname'),   $session->param('flags'),
 658                 $session->param('emailaddress'), $session->param('branchprinter')
 659             );
 660             C4::Context::set_shelves_userenv('bar',$session->param('barshelves'));
 661             C4::Context::set_shelves_userenv('pub',$session->param('pubshelves'));
 662             C4::Context::set_shelves_userenv('tot',$session->param('totshelves'));
 663             $debug and printf STDERR "AUTH_SESSION: (%s)\t%s %s - %s\n", map {$session->param($_)} qw(cardnumber firstname surname branch) ;
 664             $ip       = $session->param('ip');
 665             $lasttime = $session->param('lasttime');
 666             $userid   = $session->param('id');
 667                         $sessiontype = $session->param('sessiontype');
 668         }
 669         if ( ( ($query->param('koha_login_context')) && ($query->param('userid') ne $session->param('id')) )
 670           || ( $cas && $query->param('ticket') ) ) {
 671             #if a user enters an id ne to the id in the current session, we need to log them in...
 672             #first we need to clear the anonymous session...
 673             $debug and warn "query id = " . $query->param('userid') . " but session id = " . $session->param('id');
 674             $session->flush;
 675             $session->delete();
 676             C4::Context->_unset_userenv($sessionID);
 677                         $sessionID = undef;
 678                         $userid = undef;
 679                 }
 680         elsif ($logout) {
 681             # voluntary logout the user
 682             $session->flush;
 683             $session->delete();
 684             C4::Context->_unset_userenv($sessionID);
 685             #_session_log(sprintf "%20s from %16s logged out at %30s (manually).\n", $userid,$ip,(strftime "%c",localtime));
 686             $sessionID = undef;
 687             $userid    = undef;
 688
 689             if ($cas and $caslogout) {
 690                 logout_cas($query);
 691             }
 692         }
 693         elsif ( $lasttime < time() - $timeout ) {
 694             # timed logout
 695             $info{'timed_out'} = 1;
 696             $session->delete() if $session;
 697             C4::Context->_unset_userenv($sessionID);
 698             #_session_log(sprintf "%20s from %16s logged out at %30s (inactivity).\n", $userid,$ip,(strftime "%c",localtime));
 699             $userid    = undef;
 700             $sessionID = undef;
 701         }
 702         elsif ( $ip ne $ENV{'REMOTE_ADDR'} ) {
 703             # Different ip than originally logged in from
 704             $info{'oldip'}        = $ip;
 705             $info{'newip'}        = $ENV{'REMOTE_ADDR'};
 706             $info{'different_ip'} = 1;
 707             $session->delete();
 708             C4::Context->_unset_userenv($sessionID);
 709             #_session_log(sprintf "%20s from %16s logged out at %30s (ip changed to %16s).\n", $userid,$ip,(strftime "%c",localtime), $info{'newip'});
 710             $sessionID = undef;
 711             $userid    = undef;
 712         }
 713         else {
 714             $cookie = $query->cookie( CGISESSID => $session->id );
 715             $session->param('lasttime',time());
 716             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...
 717                 $flags = haspermission($userid, $flagsrequired);
 718                 if ($flags) {
 719                     $loggedin = 1;
 720                 } else {
 721                     $info{'nopermission'} = 1;
 722                 }
 723             }
 724         }
 725     }
 726     unless ($userid || $sessionID) {
 727         #we initiate a session prior to checking for a username to allow for anonymous sessions...
 728         my $session = get_session("") or die "Auth ERROR: Cannot get_session()";
 729         my $sessionID = $session->id;
 730         C4::Context->_new_userenv($sessionID);
 731         $cookie = $query->cookie( CGISESSID => $sessionID );
 732         $userid = $query->param('userid');
 733         if (   ( $cas && $query->param('ticket') )
 734             || $userid
 735             || ( my $pki_field = C4::Context->preference('AllowPKIAuth') ) ne
 736             'None' )
 737         {
 738             my $password = $query->param('password');
 739             my ( $return, $cardnumber );
 740             if ( $cas && $query->param('ticket') ) {
 741                 my $retuserid;
 742                 ( $return, $cardnumber, $retuserid ) =
 743                   checkpw( $dbh, $userid, $password, $query );
 744                 $userid = $retuserid;
 745                 $info{'invalidCasLogin'} = 1 unless ($return);
 746             }
 747             elsif (
 748                 ( $pki_field eq 'Common Name' && $ENV{'SSL_CLIENT_S_DN_CN'} )
 749                 || (   $pki_field eq 'emailAddress'
 750                     && $ENV{'SSL_CLIENT_S_DN_Email'} )
 751               )
 752             {
 753                 my $value;
 754                 if ( $pki_field eq 'Common Name' ) {
 755                     $value = $ENV{'SSL_CLIENT_S_DN_CN'};
 756                 }
 757                 elsif ( $pki_field eq 'emailAddress' ) {
 758                     $value = $ENV{'SSL_CLIENT_S_DN_Email'};
 759
 760               # If we're looking up the email, there's a chance that the person
 761               # doesn't have a userid. So if there is none, we pass along the
 762               # borrower number, and the bits of code that need to know the user
 763               # ID will have to be smart enough to handle that.
 764                     require C4::Members;
 765                     my @users_info = C4::Members::GetBorrowersWithEmail($value);
 766                     if (@users_info) {
 767
 768                         # First the userid, then the borrowernum
 769                         $value = $users_info[0][1] || $users_info[0][0];
 770                     } else {
 771                         undef $value;
 772                     }
 773                 }
 774
 775                 # 0 for no user, 1 for normal, 2 for demo user.
 776                 $return = $value ? 1 : 0;
 777                 $userid = $value;
 778             }
 779             else {
 780                 my $retuserid;
 781                 ( $return, $cardnumber, $retuserid ) =
 782                   checkpw( $dbh, $userid, $password, $query );
 783                 $userid = $retuserid if ( $retuserid ne '' );
 784             }
 785                 if ($return) {
 786                #_session_log(sprintf "%20s from %16s logged in  at %30s.\n", $userid,$ENV{'REMOTE_ADDR'},(strftime '%c', localtime));
 787                 if ( $flags = haspermission(  $userid, $flagsrequired ) ) {
 788                                         $loggedin = 1;
 789                 }
 790                         else {
 791                         $info{'nopermission'} = 1;
 792                         C4::Context->_unset_userenv($sessionID);
 793                 }
 794                 my ($borrowernumber, $firstname, $surname, $userflags,
 795                     $branchcode, $branchname, $branchprinter, $emailaddress);
 796
 797                 if ( $return == 1 ) {
 798                     my $select = "
 799                     SELECT borrowernumber, firstname, surname, flags, borrowers.branchcode,
 800                     branches.branchname    as branchname,
 801                     branches.branchprinter as branchprinter,
 802                     email
 803                     FROM borrowers
 804                     LEFT JOIN branches on borrowers.branchcode=branches.branchcode
 805                     ";
 806                     my $sth = $dbh->prepare("$select where userid=?");
 807                     $sth->execute($userid);
 808                     unless ($sth->rows) {
 809                         $debug and print STDERR "AUTH_1: no rows for userid='$userid'\n";
 810                         $sth = $dbh->prepare("$select where cardnumber=?");
 811                         $sth->execute($cardnumber);
 812
 813                         unless ($sth->rows) {
 814                             $debug and print STDERR "AUTH_2a: no rows for cardnumber='$cardnumber'\n";
 815                             $sth->execute($userid);
 816                             unless ($sth->rows) {
 817                                 $debug and print STDERR "AUTH_2b: no rows for userid='$userid' AS cardnumber\n";
 818                             }
 819                         }
 820                     }
 821                     if ($sth->rows) {
 822                         ($borrowernumber, $firstname, $surname, $userflags,
 823                             $branchcode, $branchname, $branchprinter, $emailaddress) = $sth->fetchrow;
 824                         $debug and print STDERR "AUTH_3 results: " .
 825                         "$cardnumber,$borrowernumber,$userid,$firstname,$surname,$userflags,$branchcode,$emailaddress\n";
 826                     } else {
 827                         print STDERR "AUTH_3: no results for userid='$userid', cardnumber='$cardnumber'.\n";
 828                     }
 829
 830 # launch a sequence to check if we have a ip for the branch, i
 831 # if we have one we replace the branchcode of the userenv by the branch bound in the ip.
 832
 833                     my $ip       = $ENV{'REMOTE_ADDR'};
 834                     # if they specify at login, use that
 835                     if ($query->param('branch')) {
 836                         $branchcode  = $query->param('branch');
 837                         $branchname = GetBranchName($branchcode);
 838                     }
 839                     my $branches = GetBranches();
 840                     if (C4::Context->boolean_preference('IndependantBranches') && C4::Context->boolean_preference('Autolocation')){
 841                         # we have to check they are coming from the right ip range
 842                         my $domain = $branches->{$branchcode}->{'branchip'};
 843                         if ($ip !~ /^$domain/){
 844                             $loggedin=0;
 845                             $info{'wrongip'} = 1;
 846                         }
 847                     }
 848
 849                     my @branchesloop;
 850                     foreach my $br ( keys %$branches ) {
 851                         #     now we work with the treatment of ip
 852                         my $domain = $branches->{$br}->{'branchip'};
 853                         if ( $domain && $ip =~ /^$domain/ ) {
 854                             $branchcode = $branches->{$br}->{'branchcode'};
 855
 856                             # new op dev : add the branchprinter and branchname in the cookie
 857                             $branchprinter = $branches->{$br}->{'branchprinter'};
 858                             $branchname    = $branches->{$br}->{'branchname'};
 859                         }
 860                     }
 861                     $session->param('number',$borrowernumber);
 862                     $session->param('id',$userid);
 863                     $session->param('cardnumber',$cardnumber);
 864                     $session->param('firstname',$firstname);
 865                     $session->param('surname',$surname);
 866                     $session->param('branch',$branchcode);
 867                     $session->param('branchname',$branchname);
 868                     $session->param('flags',$userflags);
 869                     $session->param('emailaddress',$emailaddress);
 870                     $session->param('ip',$session->remote_addr());
 871                     $session->param('lasttime',time());
 872                     $debug and printf STDERR "AUTH_4: (%s)\t%s %s - %s\n", map {$session->param($_)} qw(cardnumber firstname surname branch) ;
 873                 }
 874                 elsif ( $return == 2 ) {
 875                     #We suppose the user is the superlibrarian
 876                     $borrowernumber = 0;
 877                     $session->param('number',0);
 878                     $session->param('id',C4::Context->config('user'));
 879                     $session->param('cardnumber',C4::Context->config('user'));
 880                     $session->param('firstname',C4::Context->config('user'));
 881                     $session->param('surname',C4::Context->config('user'));
 882                     $session->param('branch','NO_LIBRARY_SET');
 883                     $session->param('branchname','NO_LIBRARY_SET');
 884                     $session->param('flags',1);
 885                     $session->param('emailaddress', C4::Context->preference('KohaAdminEmailAddress'));
 886                     $session->param('ip',$session->remote_addr());
 887                     $session->param('lasttime',time());
 888                 }
 889                 C4::Context::set_userenv(
 890                     $session->param('number'),       $session->param('id'),
 891                     $session->param('cardnumber'),   $session->param('firstname'),
 892                     $session->param('surname'),      $session->param('branch'),
 893                     $session->param('branchname'),   $session->param('flags'),
 894                     $session->param('emailaddress'), $session->param('branchprinter')
 895                 );
 896
 897             }
 898                 else {
 899                 if ($userid) {
 900                         $info{'invalid_username_or_password'} = 1;
 901                         C4::Context->_unset_userenv($sessionID);
 902                 }
 903                         }
 904         }       # END if ( $userid    = $query->param('userid') )
 905                 elsif ($type eq "opac") {
 906             # if we are here this is an anonymous session; add public lists to it and a few other items...
 907             # anonymous sessions are created only for the OPAC
 908                         $debug and warn "Initiating an anonymous session...";
 909
 910                         # setting a couple of other session vars...
 911                         $session->param('ip',$session->remote_addr());
 912                         $session->param('lasttime',time());
 913                         $session->param('sessiontype','anon');
 914                 }
 915     }   # END unless ($userid)
 916     my $insecure = C4::Context->boolean_preference('insecure');
 917
 918     # finished authentification, now respond
 919     if ( $loggedin || $authnotrequired || ( defined($insecure) && $insecure ) )
 920     {
 921         # successful login
 922         unless ($cookie) {
 923             $cookie = $query->cookie( CGISESSID => '' );
 924         }
 925         return ( $userid, $cookie, $sessionID, $flags );
 926     }
 927
 928 #
 929 #
 930 # AUTH rejected, show the login/password template, after checking the DB.
 931 #
 932 #
 933
 934     # get the inputs from the incoming query
 935     my @inputs = ();
 936     foreach my $name ( param $query) {
 937         (next) if ( $name eq 'userid' || $name eq 'password' || $name eq 'ticket' );
 938         my $value = $query->param($name);
 939         push @inputs, { name => $name, value => $value };
 940     }
 941     # get the branchloop, which we need for authentication
 942     my $branches = GetBranches();
 943     my @branch_loop;
 944     for my $branch_hash (sort keys %$branches) {
 945                 push @branch_loop, {branchcode => "$branch_hash", branchname => $branches->{$branch_hash}->{'branchname'}, };
 946     }
 947
 948     my $template_name = ( $type eq 'opac' ) ? 'opac-auth.tmpl' : 'auth.tmpl';
 949     my $template = C4::Templates::gettemplate( $template_name, $type, $query );
 950     $template->param(branchloop => \@branch_loop,);
 951     my $checkstyle = C4::Context->preference("opaccolorstylesheet");
 952     if ($checkstyle =~ /\//)
 953         {
 954                 $template->param( opacexternalsheet => $checkstyle);
 955         } else
 956         {
 957                 my $opaccolorstylesheet = C4::Context->preference("opaccolorstylesheet");
 958             $template->param( opaccolorstylesheet => $opaccolorstylesheet);
 959         }
 960     $template->param(
 961     login        => 1,
 962         INPUTS               => \@inputs,
 963         casAuthentication    => C4::Context->preference("casAuthentication"),
 964         suggestion           => C4::Context->preference("suggestion"),
 965         virtualshelves       => C4::Context->preference("virtualshelves"),
 966         LibraryName          => C4::Context->preference("LibraryName"),
 967         opacuserlogin        => C4::Context->preference("opacuserlogin"),
 968         OpacNav              => C4::Context->preference("OpacNav"),
 969         OpacNavRight         => C4::Context->preference("OpacNavRight"),
 970         OpacNavBottom        => C4::Context->preference("OpacNavBottom"),
 971         opaccredits          => C4::Context->preference("opaccredits"),
 972         OpacFavicon          => C4::Context->preference("OpacFavicon"),
 973         opacreadinghistory   => C4::Context->preference("opacreadinghistory"),
 974         opacsmallimage       => C4::Context->preference("opacsmallimage"),
 975         opaclayoutstylesheet => C4::Context->preference("opaclayoutstylesheet"),
 976         opaclanguagesdisplay => C4::Context->preference("opaclanguagesdisplay"),
 977         opacuserjs           => C4::Context->preference("opacuserjs"),
 978         opacbookbag          => "" . C4::Context->preference("opacbookbag"),
 979         OpacCloud            => C4::Context->preference("OpacCloud"),
 980         OpacTopissue         => C4::Context->preference("OpacTopissue"),
 981         OpacAuthorities      => C4::Context->preference("OpacAuthorities"),
 982         OpacBrowser          => C4::Context->preference("OpacBrowser"),
 983         opacheader           => C4::Context->preference("opacheader"),
 984         TagsEnabled                  => C4::Context->preference("TagsEnabled"),
 985         OPACUserCSS           => C4::Context->preference("OPACUserCSS"),
 986         opacstylesheet       => C4::Context->preference("opacstylesheet"),
 987         intranetcolorstylesheet =>
 988                                                                 C4::Context->preference("intranetcolorstylesheet"),
 989         intranetstylesheet => C4::Context->preference("intranetstylesheet"),
 990         intranetbookbag    => C4::Context->preference("intranetbookbag"),
 991         IntranetNav        => C4::Context->preference("IntranetNav"),
 992         intranetuserjs     => C4::Context->preference("intranetuserjs"),
 993         IndependantBranches=> C4::Context->preference("IndependantBranches"),
 994         AutoLocation       => C4::Context->preference("AutoLocation"),
 995                 wrongip            => $info{'wrongip'},
 996     );
 997
 998     $template->param( OpacPublic => C4::Context->preference("OpacPublic"));
 999     $template->param( loginprompt => 1 ) unless $info{'nopermission'};
1000
1001     if ($cas) {
1002
1003         # Is authentication against multiple CAS servers enabled?
1004         if (C4::Auth_with_cas::multipleAuth && !$casparam) {
1005             my $casservers = C4::Auth_with_cas::getMultipleAuth();
1006             my @tmplservers;
1007             foreach my $key (keys %$casservers) {
1008                 push @tmplservers, {name => $key, value => login_cas_url($query, $key) . "?cas=$key" };
1009             }
1010             #warn Data::Dumper::Dumper(\@tmplservers);
1011             $template->param(
1012                 casServersLoop => \@tmplservers
1013             );
1014         } else {
1015         $template->param(
1016             casServerUrl    => login_cas_url($query),
1017             );
1018         }
1019
1020         $template->param(
1021             invalidCasLogin => $info{'invalidCasLogin'}
1022         );
1023     }
1024
1025     my $self_url = $query->url( -absolute => 1 );
1026     $template->param(
1027         url         => $self_url,
1028         LibraryName => C4::Context->preference("LibraryName"),
1029     );
1030     $template->param( %info );
1031 #    $cookie = $query->cookie(CGISESSID => $session->id
1032 #   );
1033     print $query->header(
1034         -type   => 'text/html',
1035         -charset => 'utf-8',
1036         -cookie => $cookie
1037       ),
1038       $template->output;
1039     safe_exit;
1040 }
1041
1042 =head2 check_api_auth
1043
1044   ($status, $cookie, $sessionId) = check_api_auth($query, $userflags);
1045
1046 Given a CGI query containing the parameters 'userid' and 'password' and/or a session
1047 cookie, determine if the user has the privileges specified by C<$userflags>.
1048
1049 C<check_api_auth> is is meant for authenticating users of web services, and
1050 consequently will always return and will not attempt to redirect the user
1051 agent.
1052
1053 If a valid session cookie is already present, check_api_auth will return a status
1054 of "ok", the cookie, and the Koha session ID.
1055
1056 If no session cookie is present, check_api_auth will check the 'userid' and 'password
1057 parameters and create a session cookie and Koha session if the supplied credentials
1058 are OK.
1059
1060 Possible return values in C<$status> are:
1061
1062 =over
1063
1064 =item "ok" -- user authenticated; C<$cookie> and C<$sessionid> have valid values.
1065
1066 =item "failed" -- credentials are not correct; C<$cookie> and C<$sessionid> are undef
1067
1068 =item "maintenance" -- DB is in maintenance mode; no login possible at the moment
1069
1070 =item "expired -- session cookie has expired; API user should resubmit userid and password
1071
1072 =back
1073
1074 =cut
1075
1076 sub check_api_auth {
1077     my $query = shift;
1078     my $flagsrequired = shift;
1079
1080     my $dbh     = C4::Context->dbh;
1081     my $timeout = C4::Context->preference('timeout');
1082     $timeout = 600 unless $timeout;
1083
1084     unless (C4::Context->preference('Version')) {
1085         # database has not been installed yet
1086         return ("maintenance", undef, undef);
1087     }
1088     my $kohaversion=C4::Context::KOHAVERSION;
1089     $kohaversion =~ s/(.*\..*)\.(.*)\.(.*)/$1$2$3/;
1090     if (C4::Context->preference('Version') < $kohaversion) {
1091         # database in need of version update; assume that
1092         # no API should be called while databsae is in
1093         # this condition.
1094         return ("maintenance", undef, undef);
1095     }
1096
1097     # FIXME -- most of what follows is a copy-and-paste
1098     # of code from checkauth.  There is an obvious need
1099     # for refactoring to separate the various parts of
1100     # the authentication code, but as of 2007-11-19 this
1101     # is deferred so as to not introduce bugs into the
1102     # regular authentication code for Koha 3.0.
1103
1104     # see if we have a valid session cookie already
1105     # however, if a userid parameter is present (i.e., from
1106     # a form submission, assume that any current cookie
1107     # is to be ignored
1108     my $sessionID = undef;
1109     unless ($query->param('userid')) {
1110         $sessionID = $query->cookie("CGISESSID");
1111     }
1112     if ($sessionID && not ($cas && $query->param('PT')) ) {
1113         my $session = get_session($sessionID);
1114         C4::Context->_new_userenv($sessionID);
1115         if ($session) {
1116             C4::Context::set_userenv(
1117                 $session->param('number'),       $session->param('id'),
1118                 $session->param('cardnumber'),   $session->param('firstname'),
1119                 $session->param('surname'),      $session->param('branch'),
1120                 $session->param('branchname'),   $session->param('flags'),
1121                 $session->param('emailaddress'), $session->param('branchprinter')
1122             );
1123
1124             my $ip = $session->param('ip');
1125             my $lasttime = $session->param('lasttime');
1126             my $userid = $session->param('id');
1127             if ( $lasttime < time() - $timeout ) {
1128                 # time out
1129                 $session->delete();
1130                 C4::Context->_unset_userenv($sessionID);
1131                 $userid    = undef;
1132                 $sessionID = undef;
1133                 return ("expired", undef, undef);
1134             } elsif ( $ip ne $ENV{'REMOTE_ADDR'} ) {
1135                 # IP address changed
1136                 $session->delete();
1137                 C4::Context->_unset_userenv($sessionID);
1138                 $userid    = undef;
1139                 $sessionID = undef;
1140                 return ("expired", undef, undef);
1141             } else {
1142                 my $cookie = $query->cookie( CGISESSID => $session->id );
1143                 $session->param('lasttime',time());
1144                 my $flags = haspermission($userid, $flagsrequired);
1145                 if ($flags) {
1146                     return ("ok", $cookie, $sessionID);
1147                 } else {
1148                     $session->delete();
1149                     C4::Context->_unset_userenv($sessionID);
1150                     $userid    = undef;
1151                     $sessionID = undef;
1152                     return ("failed", undef, undef);
1153                 }
1154             }
1155         } else {
1156             return ("expired", undef, undef);
1157         }
1158     } else {
1159         # new login
1160         my $userid = $query->param('userid');
1161         my $password = $query->param('password');
1162         my ($return, $cardnumber);
1163
1164         # Proxy CAS auth
1165         if ($cas && $query->param('PT')) {
1166             my $retuserid;
1167             $debug and print STDERR "## check_api_auth - checking CAS\n";
1168             # In case of a CAS authentication, we use the ticket instead of the password
1169             my $PT = $query->param('PT');
1170             ($return,$cardnumber,$userid) = check_api_auth_cas($dbh, $PT, $query);    # EXTERNAL AUTH
1171         } else {
1172             # User / password auth
1173             unless ($userid and $password) {
1174                 # caller did something wrong, fail the authenticateion
1175                 return ("failed", undef, undef);
1176             }
1177             ( $return, $cardnumber ) = checkpw( $dbh, $userid, $password, $query );
1178         }
1179
1180         if ($return and haspermission(  $userid, $flagsrequired)) {
1181             my $session = get_session("");
1182             return ("failed", undef, undef) unless $session;
1183
1184             my $sessionID = $session->id;
1185             C4::Context->_new_userenv($sessionID);
1186             my $cookie = $query->cookie(CGISESSID => $sessionID);
1187             if ( $return == 1 ) {
1188                 my (
1189                     $borrowernumber, $firstname,  $surname,
1190                     $userflags,      $branchcode, $branchname,
1191                     $branchprinter,  $emailaddress
1192                 );
1193                 my $sth =
1194                   $dbh->prepare(
1195 "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=?"
1196                   );
1197                 $sth->execute($userid);
1198                 (
1199                     $borrowernumber, $firstname,  $surname,
1200                     $userflags,      $branchcode, $branchname,
1201                     $branchprinter,  $emailaddress
1202                 ) = $sth->fetchrow if ( $sth->rows );
1203
1204                 unless ($sth->rows ) {
1205                     my $sth = $dbh->prepare(
1206 "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=?"
1207                       );
1208                     $sth->execute($cardnumber);
1209                     (
1210                         $borrowernumber, $firstname,  $surname,
1211                         $userflags,      $branchcode, $branchname,
1212                         $branchprinter,  $emailaddress
1213                     ) = $sth->fetchrow if ( $sth->rows );
1214
1215                     unless ( $sth->rows ) {
1216                         $sth->execute($userid);
1217                         (
1218                             $borrowernumber, $firstname, $surname, $userflags,
1219                             $branchcode, $branchname, $branchprinter, $emailaddress
1220                         ) = $sth->fetchrow if ( $sth->rows );
1221                     }
1222                 }
1223
1224                 my $ip       = $ENV{'REMOTE_ADDR'};
1225                 # if they specify at login, use that
1226                 if ($query->param('branch')) {
1227                     $branchcode  = $query->param('branch');
1228                     $branchname = GetBranchName($branchcode);
1229                 }
1230                 my $branches = GetBranches();
1231                 my @branchesloop;
1232                 foreach my $br ( keys %$branches ) {
1233                     #     now we work with the treatment of ip
1234                     my $domain = $branches->{$br}->{'branchip'};
1235                     if ( $domain && $ip =~ /^$domain/ ) {
1236                         $branchcode = $branches->{$br}->{'branchcode'};
1237
1238                         # new op dev : add the branchprinter and branchname in the cookie
1239                         $branchprinter = $branches->{$br}->{'branchprinter'};
1240                         $branchname    = $branches->{$br}->{'branchname'};
1241                     }
1242                 }
1243                 $session->param('number',$borrowernumber);
1244                 $session->param('id',$userid);
1245                 $session->param('cardnumber',$cardnumber);
1246                 $session->param('firstname',$firstname);
1247                 $session->param('surname',$surname);
1248                 $session->param('branch',$branchcode);
1249                 $session->param('branchname',$branchname);
1250                 $session->param('flags',$userflags);
1251                 $session->param('emailaddress',$emailaddress);
1252                 $session->param('ip',$session->remote_addr());
1253                 $session->param('lasttime',time());
1254             } elsif ( $return == 2 ) {
1255                 #We suppose the user is the superlibrarian
1256                 $session->param('number',0);
1257                 $session->param('id',C4::Context->config('user'));
1258                 $session->param('cardnumber',C4::Context->config('user'));
1259                 $session->param('firstname',C4::Context->config('user'));
1260                 $session->param('surname',C4::Context->config('user'));
1261                 $session->param('branch','NO_LIBRARY_SET');
1262                 $session->param('branchname','NO_LIBRARY_SET');
1263                 $session->param('flags',1);
1264                 $session->param('emailaddress', C4::Context->preference('KohaAdminEmailAddress'));
1265                 $session->param('ip',$session->remote_addr());
1266                 $session->param('lasttime',time());
1267             }
1268             C4::Context::set_userenv(
1269                 $session->param('number'),       $session->param('id'),
1270                 $session->param('cardnumber'),   $session->param('firstname'),
1271                 $session->param('surname'),      $session->param('branch'),
1272                 $session->param('branchname'),   $session->param('flags'),
1273                 $session->param('emailaddress'), $session->param('branchprinter')
1274             );
1275             return ("ok", $cookie, $sessionID);
1276         } else {
1277             return ("failed", undef, undef);
1278         }
1279     }
1280 }
1281
1282 =head2 check_cookie_auth
1283
1284   ($status, $sessionId) = check_api_auth($cookie, $userflags);
1285
1286 Given a CGISESSID cookie set during a previous login to Koha, determine
1287 if the user has the privileges specified by C<$userflags>.
1288
1289 C<check_cookie_auth> is meant for authenticating special services
1290 such as tools/upload-file.pl that are invoked by other pages that
1291 have been authenticated in the usual way.
1292
1293 Possible return values in C<$status> are:
1294
1295 =over
1296
1297 =item "ok" -- user authenticated; C<$sessionID> have valid values.
1298
1299 =item "failed" -- credentials are not correct; C<$sessionid> are undef
1300
1301 =item "maintenance" -- DB is in maintenance mode; no login possible at the moment
1302
1303 =item "expired -- session cookie has expired; API user should resubmit userid and password
1304
1305 =back
1306
1307 =cut
1308
1309 sub check_cookie_auth {
1310     my $cookie = shift;
1311     my $flagsrequired = shift;
1312
1313     my $dbh     = C4::Context->dbh;
1314     my $timeout = C4::Context->preference('timeout');
1315     $timeout = 600 unless $timeout;
1316
1317     unless (C4::Context->preference('Version')) {
1318         # database has not been installed yet
1319         return ("maintenance", undef);
1320     }
1321     my $kohaversion=C4::Context::KOHAVERSION;
1322     $kohaversion =~ s/(.*\..*)\.(.*)\.(.*)/$1$2$3/;
1323     if (C4::Context->preference('Version') < $kohaversion) {
1324         # database in need of version update; assume that
1325         # no API should be called while databsae is in
1326         # this condition.
1327         return ("maintenance", undef);
1328     }
1329
1330     # FIXME -- most of what follows is a copy-and-paste
1331     # of code from checkauth.  There is an obvious need
1332     # for refactoring to separate the various parts of
1333     # the authentication code, but as of 2007-11-23 this
1334     # is deferred so as to not introduce bugs into the
1335     # regular authentication code for Koha 3.0.
1336
1337     # see if we have a valid session cookie already
1338     # however, if a userid parameter is present (i.e., from
1339     # a form submission, assume that any current cookie
1340     # is to be ignored
1341     unless (defined $cookie and $cookie) {
1342         return ("failed", undef);
1343     }
1344     my $sessionID = $cookie;
1345     my $session = get_session($sessionID);
1346     C4::Context->_new_userenv($sessionID);
1347     if ($session) {
1348         C4::Context::set_userenv(
1349             $session->param('number'),       $session->param('id'),
1350             $session->param('cardnumber'),   $session->param('firstname'),
1351             $session->param('surname'),      $session->param('branch'),
1352             $session->param('branchname'),   $session->param('flags'),
1353             $session->param('emailaddress'), $session->param('branchprinter')
1354         );
1355
1356         my $ip = $session->param('ip');
1357         my $lasttime = $session->param('lasttime');
1358         my $userid = $session->param('id');
1359         if ( $lasttime < time() - $timeout ) {
1360             # time out
1361             $session->delete();
1362             C4::Context->_unset_userenv($sessionID);
1363             $userid    = undef;
1364             $sessionID = undef;
1365             return ("expired", undef);
1366         } elsif ( $ip ne $ENV{'REMOTE_ADDR'} ) {
1367             # IP address changed
1368             $session->delete();
1369             C4::Context->_unset_userenv($sessionID);
1370             $userid    = undef;
1371             $sessionID = undef;
1372             return ("expired", undef);
1373         } else {
1374             $session->param('lasttime',time());
1375             my $flags = haspermission($userid, $flagsrequired);
1376             if ($flags) {
1377                 return ("ok", $sessionID);
1378             } else {
1379                 $session->delete();
1380                 C4::Context->_unset_userenv($sessionID);
1381                 $userid    = undef;
1382                 $sessionID = undef;
1383                 return ("failed", undef);
1384             }
1385         }
1386     } else {
1387         return ("expired", undef);
1388     }
1389 }
1390
1391 =head2 get_session
1392
1393   use CGI::Session;
1394   my $session = get_session($sessionID);
1395
1396 Given a session ID, retrieve the CGI::Session object used to store
1397 the session's state.  The session object can be used to store
1398 data that needs to be accessed by different scripts during a
1399 user's session.
1400
1401 If the C<$sessionID> parameter is an empty string, a new session
1402 will be created.
1403
1404 =cut
1405
1406 sub get_session {
1407     my $sessionID = shift;
1408     my $storage_method = C4::Context->preference('SessionStorage');
1409     my $dbh = C4::Context->dbh;
1410     my $session;
1411     if ($storage_method eq 'mysql'){
1412         $session = new CGI::Session("driver:MySQL;serializer:yaml;id:md5", $sessionID, {Handle=>$dbh});
1413     }
1414     elsif ($storage_method eq 'Pg') {
1415         $session = new CGI::Session("driver:PostgreSQL;serializer:yaml;id:md5", $sessionID, {Handle=>$dbh});
1416     }
1417     elsif ($storage_method eq 'memcached' && C4::Context->ismemcached){
1418         $session = new CGI::Session("driver:memcached;serializer:yaml;id:md5", $sessionID, { Memcached => C4::Context->memcached } );
1419     }
1420     else {
1421         # catch all defaults to tmp should work on all systems
1422         $session = new CGI::Session("driver:File;serializer:yaml;id:md5", $sessionID, {Directory=>'/tmp'});
1423     }
1424     return $session;
1425 }
1426
1427 sub checkpw {
1428
1429     my ( $dbh, $userid, $password, $query ) = @_;
1430     if ($ldap) {
1431         $debug and print STDERR "## checkpw - checking LDAP\n";
1432         my ($retval,$retcard,$retuserid) = checkpw_ldap(@_);    # EXTERNAL AUTH
1433         ($retval) and return ($retval,$retcard,$retuserid);
1434     }
1435
1436     if ($cas && $query && $query->param('ticket')) {
1437         $debug and print STDERR "## checkpw - checking CAS\n";
1438         # In case of a CAS authentication, we use the ticket instead of the password
1439         my $ticket = $query->param('ticket');
1440         my ($retval,$retcard,$retuserid) = checkpw_cas($dbh, $ticket, $query);    # EXTERNAL AUTH
1441         ($retval) and return ($retval,$retcard,$retuserid);
1442         return 0;
1443     }
1444
1445     # INTERNAL AUTH
1446     my $sth =
1447       $dbh->prepare(
1448 "select password,cardnumber,borrowernumber,userid,firstname,surname,branchcode,flags from borrowers where userid=?"
1449       );
1450     $sth->execute($userid);
1451     if ( $sth->rows ) {
1452         my ( $md5password, $cardnumber, $borrowernumber, $userid, $firstname,
1453             $surname, $branchcode, $flags )
1454           = $sth->fetchrow;
1455         if ( md5_base64($password) eq $md5password and $md5password ne "!") {
1456
1457             C4::Context->set_userenv( "$borrowernumber", $userid, $cardnumber,
1458                 $firstname, $surname, $branchcode, $flags );
1459             return 1, $cardnumber, $userid;
1460         }
1461     }
1462     $sth =
1463       $dbh->prepare(
1464 "select password,cardnumber,borrowernumber,userid, firstname,surname,branchcode,flags from borrowers where cardnumber=?"
1465       );
1466     $sth->execute($userid);
1467     if ( $sth->rows ) {
1468         my ( $md5password, $cardnumber, $borrowernumber, $userid, $firstname,
1469             $surname, $branchcode, $flags )
1470           = $sth->fetchrow;
1471         if ( md5_base64($password) eq $md5password ) {
1472
1473             C4::Context->set_userenv( $borrowernumber, $userid, $cardnumber,
1474                 $firstname, $surname, $branchcode, $flags );
1475             return 1, $cardnumber, $userid;
1476         }
1477     }
1478     if (   $userid && $userid eq C4::Context->config('user')
1479         && "$password" eq C4::Context->config('pass') )
1480     {
1481
1482 # Koha superuser account
1483 #     C4::Context->set_userenv(0,0,C4::Context->config('user'),C4::Context->config('user'),C4::Context->config('user'),"",1);
1484         return 2;
1485     }
1486     if (   $userid && $userid eq 'demo'
1487         && "$password" eq 'demo'
1488         && C4::Context->config('demo') )
1489     {
1490
1491 # DEMO => the demo user is allowed to do everything (if demo set to 1 in koha.conf
1492 # some features won't be effective : modify systempref, modify MARC structure,
1493         return 2;
1494     }
1495     return 0;
1496 }
1497
1498 =head2 getuserflags
1499
1500     my $authflags = getuserflags($flags, $userid, [$dbh]);
1501
1502 Translates integer flags into permissions strings hash.
1503
1504 C<$flags> is the integer userflags value ( borrowers.userflags )
1505 C<$userid> is the members.userid, used for building subpermissions
1506 C<$authflags> is a hashref of permissions
1507
1508 =cut
1509
1510 sub getuserflags {
1511     my $flags   = shift;
1512     my $userid  = shift;
1513     my $dbh     = @_ ? shift : C4::Context->dbh;
1514     my $userflags;
1515     $flags = 0 unless $flags;
1516     my $sth = $dbh->prepare("SELECT bit, flag, defaulton FROM userflags");
1517     $sth->execute;
1518
1519     while ( my ( $bit, $flag, $defaulton ) = $sth->fetchrow ) {
1520         if ( ( $flags & ( 2**$bit ) ) || $defaulton ) {
1521             $userflags->{$flag} = 1;
1522         }
1523         else {
1524             $userflags->{$flag} = 0;
1525         }
1526     }
1527
1528     # get subpermissions and merge with top-level permissions
1529     my $user_subperms = get_user_subpermissions($userid);
1530     foreach my $module (keys %$user_subperms) {
1531         next if $userflags->{$module} == 1; # user already has permission for everything in this module
1532         $userflags->{$module} = $user_subperms->{$module};
1533     }
1534
1535     return $userflags;
1536 }
1537
1538 =head2 get_user_subpermissions
1539
1540   $user_perm_hashref = get_user_subpermissions($userid);
1541
1542 Given the userid (note, not the borrowernumber) of a staff user,
1543 return a hashref of hashrefs of the specific subpermissions
1544 accorded to the user.  An example return is
1545
1546  {
1547     tools => {
1548         export_catalog => 1,
1549         import_patrons => 1,
1550     }
1551  }
1552
1553 The top-level hash-key is a module or function code from
1554 userflags.flag, while the second-level key is a code
1555 from permissions.
1556
1557 The results of this function do not give a complete picture
1558 of the functions that a staff user can access; it is also
1559 necessary to check borrowers.flags.
1560
1561 =cut
1562
1563 sub get_user_subpermissions {
1564     my $userid = shift;
1565
1566     my $dbh = C4::Context->dbh;
1567     my $sth = $dbh->prepare("SELECT flag, user_permissions.code
1568                              FROM user_permissions
1569                              JOIN permissions USING (module_bit, code)
1570                              JOIN userflags ON (module_bit = bit)
1571                              JOIN borrowers USING (borrowernumber)
1572                              WHERE userid = ?");
1573     $sth->execute($userid);
1574
1575     my $user_perms = {};
1576     while (my $perm = $sth->fetchrow_hashref) {
1577         $user_perms->{$perm->{'flag'}}->{$perm->{'code'}} = 1;
1578     }
1579     return $user_perms;
1580 }
1581
1582 =head2 get_all_subpermissions
1583
1584   my $perm_hashref = get_all_subpermissions();
1585
1586 Returns a hashref of hashrefs defining all specific
1587 permissions currently defined.  The return value
1588 has the same structure as that of C<get_user_subpermissions>,
1589 except that the innermost hash value is the description
1590 of the subpermission.
1591
1592 =cut
1593
1594 sub get_all_subpermissions {
1595     my $dbh = C4::Context->dbh;
1596     my $sth = $dbh->prepare("SELECT flag, code, description
1597                              FROM permissions
1598                              JOIN userflags ON (module_bit = bit)");
1599     $sth->execute();
1600
1601     my $all_perms = {};
1602     while (my $perm = $sth->fetchrow_hashref) {
1603         $all_perms->{$perm->{'flag'}}->{$perm->{'code'}} = $perm->{'description'};
1604     }
1605     return $all_perms;
1606 }
1607
1608 =head2 haspermission
1609
1610   $flags = ($userid, $flagsrequired);
1611
1612 C<$userid> the userid of the member
1613 C<$flags> is a hashref of required flags like C<$borrower-&lt;{authflags}>
1614
1615 Returns member's flags or 0 if a permission is not met.
1616
1617 =cut
1618
1619 sub haspermission {
1620     my ($userid, $flagsrequired) = @_;
1621     my $sth = C4::Context->dbh->prepare("SELECT flags FROM borrowers WHERE userid=?");
1622     $sth->execute($userid);
1623     my $flags = getuserflags($sth->fetchrow(), $userid);
1624     if ( $userid eq C4::Context->config('user') ) {
1625         # Super User Account from /etc/koha.conf
1626         $flags->{'superlibrarian'} = 1;
1627     }
1628     elsif ( $userid eq 'demo' && C4::Context->config('demo') ) {
1629         # Demo user that can do "anything" (demo=1 in /etc/koha.conf)
1630         $flags->{'superlibrarian'} = 1;
1631     }
1632
1633     return $flags if $flags->{superlibrarian};
1634
1635     foreach my $module ( keys %$flagsrequired ) {
1636         my $subperm = $flagsrequired->{$module};
1637         if ($subperm eq '*') {
1638             return 0 unless ( $flags->{$module} == 1 or ref($flags->{$module}) );
1639         } else {
1640             return 0 unless ( $flags->{$module} == 1 or
1641                                 ( ref($flags->{$module}) and
1642                                   exists $flags->{$module}->{$subperm} and
1643                                   $flags->{$module}->{$subperm} == 1
1644                                 )
1645                             );
1646         }
1647     }
1648     return $flags;
1649     #FIXME - This fcn should return the failed permission so a suitable error msg can be delivered.
1650 }
1651
1652
1653 sub getborrowernumber {
1654     my ($userid) = @_;
1655     my $userenv = C4::Context->userenv;
1656     if ( defined( $userenv ) && ref( $userenv ) eq 'HASH' && $userenv->{number} ) {
1657         return $userenv->{number};
1658     }
1659     my $dbh = C4::Context->dbh;
1660     for my $field ( 'userid', 'cardnumber' ) {
1661         my $sth =
1662           $dbh->prepare("select borrowernumber from borrowers where $field=?");
1663         $sth->execute($userid);
1664         if ( $sth->rows ) {
1665             my ($bnumber) = $sth->fetchrow;
1666             return $bnumber;
1667         }
1668     }
1669     return 0;
1670 }
1671
1672
1673 END { }    # module clean-up code here (global destructor)
1674 1;
1675 __END__
1676
1677 =head1 SEE ALSO
1678
1679 CGI(3)
1680
1681 C4::Output(3)
1682
1683 Digest::MD5(3)
1684
1685 =cut