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::Members;
  31 use C4::Koha;
  32 use C4::Branch; # GetBranches
  33 use C4::VirtualShelves;
  34 use POSIX qw/strftime/;
  35 use List::MoreUtils qw/ any /;
  36
  37 # use utf8;
  38 use vars qw($VERSION @ISA @EXPORT @EXPORT_OK %EXPORT_TAGS $debug $ldap $cas $caslogout $servers $memcached);
  39
  40 BEGIN {
  41     sub psgi_env { any { /^psgi\./ } keys %ENV }
  42     sub safe_exit {
  43         if ( psgi_env ) { die 'psgi:exit' }
  44         else { exit }
  45     }
  46
  47     $VERSION     = 3.02;                                                                                                            # set version for version checking
  48     $debug       = $ENV{DEBUG};
  49     @ISA         = qw(Exporter);
  50     @EXPORT      = qw(&checkauth &get_template_and_user &haspermission &get_user_subpermissions);
  51     @EXPORT_OK   = qw(&check_api_auth &get_session &check_cookie_auth &checkpw &get_all_subpermissions &get_user_subpermissions);
  52     %EXPORT_TAGS = ( EditPermissions => [qw(get_all_subpermissions get_user_subpermissions)] );
  53     $ldap        = C4::Context->config('useldapserver') || 0;
  54     $cas         = C4::Context->preference('casAuthentication');
  55     $caslogout   = C4::Context->preference('casLogout');
  56     require C4::Auth_with_cas;             # no import
  57     if ($ldap) {
  58         require C4::Auth_with_ldap;
  59         import C4::Auth_with_ldap qw(checkpw_ldap);
  60     }
  61     if ($cas) {
  62         import  C4::Auth_with_cas qw(check_api_auth_cas checkpw_cas login_cas logout_cas login_cas_url);
  63     }
  64     $servers = C4::Context->config('memcached_servers');
  65     if ($servers) {
  66         require Cache::Memcached;
  67         $memcached = Cache::Memcached->new({
  68                                                servers => [ $servers ],
  69                                                debug   => 0,
  70                                                compress_threshold => 10_000,
  71                                                namespace => C4::Context->config('memcached_namespace') || 'koha',
  72                                            });
  73     }
  74 }
  75
  76 =head1 NAME
  77
  78 C4::Auth - Authenticates Koha users
  79
  80 =head1 SYNOPSIS
  81
  82   use CGI;
  83   use C4::Auth;
  84   use C4::Output;
  85
  86   my $query = new CGI;
  87
  88   my ($template, $borrowernumber, $cookie)
  89     = get_template_and_user(
  90         {
  91             template_name   => "opac-main.tmpl",
  92             query           => $query,
  93       type            => "opac",
  94       authnotrequired => 1,
  95       flagsrequired   => {borrow => 1, catalogue => '*', tools => 'import_patrons' },
  96   }
  97     );
  98
  99   output_html_with_http_headers $query, $cookie, $template->output;
 100
 101 =head1 DESCRIPTION
 102
 103 The main function of this module is to provide
 104 authentification. However the get_template_and_user function has
 105 been provided so that a users login information is passed along
 106 automatically. This gets loaded into the template.
 107
 108 =head1 FUNCTIONS
 109
 110 =head2 get_template_and_user
 111
 112  my ($template, $borrowernumber, $cookie)
 113      = get_template_and_user(
 114        {
 115          template_name   => "opac-main.tmpl",
 116          query           => $query,
 117          type            => "opac",
 118          authnotrequired => 1,
 119          flagsrequired   => {borrow => 1, catalogue => '*', tools => 'import_patrons' },
 120        }
 121      );
 122
 123 This call passes the C<query>, C<flagsrequired> and C<authnotrequired>
 124 to C<&checkauth> (in this module) to perform authentification.
 125 See C<&checkauth> for an explanation of these parameters.
 126
 127 The C<template_name> is then used to find the correct template for
 128 the page. The authenticated users details are loaded onto the
 129 template in the HTML::Template LOOP variable C<USER_INFO>. Also the
 130 C<sessionID> is passed to the template. This can be used in templates
 131 if cookies are disabled. It needs to be put as and input to every
 132 authenticated page.
 133
 134 More information on the C<gettemplate> sub can be found in the
 135 Output.pm module.
 136
 137 =cut
 138
 139 my $SEARCH_HISTORY_INSERT_SQL =<<EOQ;
 140 INSERT INTO search_history(userid, sessionid, query_desc, query_cgi, total, time            )
 141 VALUES                    (     ?,         ?,          ?,         ?,          ?, FROM_UNIXTIME(?))
 142 EOQ
 143 sub get_template_and_user {
 144     my $in       = shift;
 145     my $template =
 146       C4::Templates::gettemplate( $in->{'template_name'}, $in->{'type'}, $in->{'query'} );
 147     my ( $user, $cookie, $sessionID, $flags );
 148     if ( $in->{'template_name'} !~m/maintenance/ ) {
 149         ( $user, $cookie, $sessionID, $flags ) = checkauth(
 150             $in->{'query'},
 151             $in->{'authnotrequired'},
 152             $in->{'flagsrequired'},
 153             $in->{'type'}
 154         );
 155     }
 156
 157     my $borrowernumber;
 158     my $insecure = C4::Context->preference('insecure');
 159     if ($user or $insecure) {
 160
 161         # load the template variables for stylesheets and JavaScript
 162         $template->param( css_libs => $in->{'css_libs'} );
 163         $template->param( css_module => $in->{'css_module'} );
 164         $template->param( css_page => $in->{'css_page'} );
 165         $template->param( css_widgets => $in->{'css_widgets'} );
 166
 167         $template->param( js_libs => $in->{'js_libs'} );
 168         $template->param( js_module => $in->{'js_module'} );
 169         $template->param( js_page => $in->{'js_page'} );
 170         $template->param( js_widgets => $in->{'js_widgets'} );
 171
 172         # user info
 173         $template->param( loggedinusername => $user );
 174         $template->param( sessionID        => $sessionID );
 175
 176         my ($total, $pubshelves, $barshelves) = C4::Context->get_shelves_userenv();
 177         if (defined($pubshelves)) {
 178             $template->param( pubshelves     => scalar @{$pubshelves},
 179                               pubshelvesloop => $pubshelves,
 180             );
 181             $template->param( pubtotal   => $total->{'pubtotal'}, ) if ($total->{'pubtotal'} > scalar @{$pubshelves});
 182         }
 183         if (defined($barshelves)) {
 184             $template->param( barshelves      => scalar @{$barshelves},
 185                               barshelvesloop  => $barshelves,
 186             );
 187             $template->param( bartotal  => $total->{'bartotal'}, ) if ($total->{'bartotal'} > scalar @{$barshelves});
 188         }
 189
 190         $borrowernumber = getborrowernumber($user) if defined($user);
 191
 192         my ( $borr ) = GetMemberDetails( $borrowernumber );
 193         my @bordat;
 194         $bordat[0] = $borr;
 195         $template->param( "USER_INFO" => \@bordat );
 196
 197         my $all_perms = get_all_subpermissions();
 198
 199         my @flagroots = qw(circulate catalogue parameters borrowers permissions reserveforothers borrow
 200                             editcatalogue updatecharges management tools editauthorities serials reports acquisition);
 201         # We are going to use the $flags returned by checkauth
 202         # to create the template's parameters that will indicate
 203         # which menus the user can access.
 204         if (( $flags && $flags->{superlibrarian}==1) or $insecure==1) {
 205             $template->param( CAN_user_circulate        => 1 );
 206             $template->param( CAN_user_catalogue        => 1 );
 207             $template->param( CAN_user_parameters       => 1 );
 208             $template->param( CAN_user_borrowers        => 1 );
 209             $template->param( CAN_user_permissions      => 1 );
 210             $template->param( CAN_user_reserveforothers => 1 );
 211             $template->param( CAN_user_borrow           => 1 );
 212             $template->param( CAN_user_editcatalogue    => 1 );
 213             $template->param( CAN_user_updatecharges     => 1 );
 214             $template->param( CAN_user_acquisition      => 1 );
 215             $template->param( CAN_user_management       => 1 );
 216             $template->param( CAN_user_tools            => 1 );
 217             $template->param( CAN_user_editauthorities  => 1 );
 218             $template->param( CAN_user_serials          => 1 );
 219             $template->param( CAN_user_reports          => 1 );
 220             $template->param( CAN_user_staffaccess      => 1 );
 221             foreach my $module (keys %$all_perms) {
 222                 foreach my $subperm (keys %{ $all_perms->{$module} }) {
 223                     $template->param( "CAN_user_${module}_${subperm}" => 1 );
 224                 }
 225             }
 226         }
 227
 228         if ( $flags ) {
 229             foreach my $module (keys %$all_perms) {
 230                 if ( $flags->{$module} == 1) {
 231                     foreach my $subperm (keys %{ $all_perms->{$module} }) {
 232                         $template->param( "CAN_user_${module}_${subperm}" => 1 );
 233                     }
 234                 } elsif ( ref($flags->{$module}) ) {
 235                     foreach my $subperm (keys %{ $flags->{$module} } ) {
 236                         $template->param( "CAN_user_${module}_${subperm}" => 1 );
 237                     }
 238                 }
 239             }
 240         }
 241
 242         if ($flags) {
 243             foreach my $module (keys %$flags) {
 244                 if ( $flags->{$module} == 1 or ref($flags->{$module}) ) {
 245                     $template->param( "CAN_user_$module" => 1 );
 246                     if ($module eq "parameters") {
 247                         $template->param( CAN_user_management => 1 );
 248                     }
 249                 }
 250             }
 251         }
 252                 # Logged-in opac search history
 253                 # If the requested template is an opac one and opac search history is enabled
 254                 if ($in->{type} eq 'opac' && C4::Context->preference('EnableOpacSearchHistory')) {
 255                         my $dbh = C4::Context->dbh;
 256                         my $query = "SELECT COUNT(*) FROM search_history WHERE userid=?";
 257                         my $sth = $dbh->prepare($query);
 258                         $sth->execute($borrowernumber);
 259
 260                         # If at least one search has already been performed
 261                         if ($sth->fetchrow_array > 0) {
 262                         # We show the link in opac
 263                         $template->param(ShowOpacRecentSearchLink => 1);
 264                         }
 265
 266                         # And if there's a cookie with searches performed when the user was not logged in,
 267                         # we add them to the logged-in search history
 268                         my $searchcookie = $in->{'query'}->cookie('KohaOpacRecentSearches');
 269                         if ($searchcookie){
 270                                 $searchcookie = uri_unescape($searchcookie);
 271                                 my @recentSearches = @{thaw($searchcookie) || []};
 272                                 if (@recentSearches) {
 273                                         my $sth = $dbh->prepare($SEARCH_HISTORY_INSERT_SQL);
 274                                         $sth->execute( $borrowernumber,
 275                                                        $in->{'query'}->cookie("CGISESSID"),
 276                                                        $_->{'query_desc'},
 277                                                        $_->{'query_cgi'},
 278                                                        $_->{'total'},
 279                                                        $_->{'time'},
 280                             ) foreach @recentSearches;
 281
 282                                         # And then, delete the cookie's content
 283                                         my $newsearchcookie = $in->{'query'}->cookie(
 284                                                                                                 -name => 'KohaOpacRecentSearches',
 285                                                                                                 -value => freeze([]),
 286                                                                                                 -expires => ''
 287                                                                                          );
 288                                         $cookie = [$cookie, $newsearchcookie];
 289                                 }
 290                         }
 291                 }
 292     }
 293         else {  # if this is an anonymous session, setup to display public lists...
 294
 295         # load the template variables for stylesheets and JavaScript
 296         $template->param( css_libs => $in->{'css_libs'} );
 297         $template->param( css_module => $in->{'css_module'} );
 298         $template->param( css_page => $in->{'css_page'} );
 299         $template->param( css_widgets => $in->{'css_widgets'} );
 300
 301         $template->param( js_libs => $in->{'js_libs'} );
 302         $template->param( js_module => $in->{'js_module'} );
 303         $template->param( js_page => $in->{'js_page'} );
 304         $template->param( js_widgets => $in->{'js_widgets'} );
 305
 306         $template->param( sessionID        => $sessionID );
 307
 308         my ($total, $pubshelves) = C4::Context->get_shelves_userenv();  # an anonymous user has no 'barshelves'...
 309         if (defined $pubshelves) {
 310             $template->param(   pubshelves      => scalar @{$pubshelves},
 311                                 pubshelvesloop  => $pubshelves,
 312                             );
 313             $template->param(   pubtotal        => $total->{'pubtotal'}, ) if ($total->{'pubtotal'} > scalar @{$pubshelves});
 314         }
 315
 316     }
 317         # Anonymous opac search history
 318         # If opac search history is enabled and at least one search has already been performed
 319         if (C4::Context->preference('EnableOpacSearchHistory')) {
 320                 my $searchcookie = $in->{'query'}->cookie('KohaOpacRecentSearches');
 321                 if ($searchcookie){
 322                         $searchcookie = uri_unescape($searchcookie);
 323                         my @recentSearches = @{thaw($searchcookie) || []};
 324             # We show the link in opac
 325                         if (@recentSearches) {
 326                                 $template->param(ShowOpacRecentSearchLink => 1);
 327                         }
 328             }
 329         }
 330
 331     if(C4::Context->preference('dateformat')){
 332         if(C4::Context->preference('dateformat') eq "metric"){
 333             $template->param(dateformat_metric => 1);
 334         } elsif(C4::Context->preference('dateformat') eq "us"){
 335             $template->param(dateformat_us => 1);
 336         } else {
 337             $template->param(dateformat_iso => 1);
 338         }
 339     } else {
 340         $template->param(dateformat_iso => 1);
 341     }
 342
 343     # these template parameters are set the same regardless of $in->{'type'}
 344     $template->param(
 345             "BiblioDefaultView".C4::Context->preference("BiblioDefaultView")         => 1,
 346             EnhancedMessagingPreferences => C4::Context->preference('EnhancedMessagingPreferences'),
 347             GoogleJackets                => C4::Context->preference("GoogleJackets"),
 348             OpenLibraryCovers            => C4::Context->preference("OpenLibraryCovers"),
 349             KohaAdminEmailAddress        => "" . C4::Context->preference("KohaAdminEmailAddress"),
 350             LoginBranchcode              => (C4::Context->userenv?C4::Context->userenv->{"branch"}:"insecure"),
 351             LoginFirstname               => (C4::Context->userenv?C4::Context->userenv->{"firstname"}:"Bel"),
 352             LoginSurname                 => C4::Context->userenv?C4::Context->userenv->{"surname"}:"Inconnu",
 353             TagsEnabled                  => C4::Context->preference("TagsEnabled"),
 354             hide_marc                    => C4::Context->preference("hide_marc"),
 355             item_level_itypes            => C4::Context->preference('item-level_itypes'),
 356             patronimages                 => C4::Context->preference("patronimages"),
 357             singleBranchMode             => C4::Context->preference("singleBranchMode"),
 358             XSLTDetailsDisplay           => C4::Context->preference("XSLTDetailsDisplay"),
 359             XSLTResultsDisplay           => C4::Context->preference("XSLTResultsDisplay"),
 360             using_https                  => $in->{'query'}->https() ? 1 : 0,
 361             noItemTypeImages            => C4::Context->preference("noItemTypeImages"),
 362     );
 363
 364     if ( $in->{'type'} eq "intranet" ) {
 365         $template->param(
 366             AmazonContent               => C4::Context->preference("AmazonContent"),
 367             AmazonCoverImages           => C4::Context->preference("AmazonCoverImages"),
 368             AmazonEnabled               => C4::Context->preference("AmazonEnabled"),
 369             AmazonSimilarItems          => C4::Context->preference("AmazonSimilarItems"),
 370             AutoLocation                => C4::Context->preference("AutoLocation"),
 371             "BiblioDefaultView".C4::Context->preference("IntranetBiblioDefaultView") => 1,
 372             CircAutocompl               => C4::Context->preference("CircAutocompl"),
 373             FRBRizeEditions             => C4::Context->preference("FRBRizeEditions"),
 374             IndependantBranches         => C4::Context->preference("IndependantBranches"),
 375             IntranetNav                 => C4::Context->preference("IntranetNav"),
 376             IntranetmainUserblock       => C4::Context->preference("IntranetmainUserblock"),
 377             LibraryName                 => C4::Context->preference("LibraryName"),
 378             LoginBranchname             => (C4::Context->userenv?C4::Context->userenv->{"branchname"}:"insecure"),
 379             advancedMARCEditor          => C4::Context->preference("advancedMARCEditor"),
 380             canreservefromotherbranches => C4::Context->preference('canreservefromotherbranches'),
 381             intranetcolorstylesheet     => C4::Context->preference("intranetcolorstylesheet"),
 382             IntranetFavicon             => C4::Context->preference("IntranetFavicon"),
 383             intranetreadinghistory      => C4::Context->preference("intranetreadinghistory"),
 384             intranetstylesheet          => C4::Context->preference("intranetstylesheet"),
 385             IntranetUserCSS             => C4::Context->preference("IntranetUserCSS"),
 386             intranetuserjs              => C4::Context->preference("intranetuserjs"),
 387             intranetbookbag             => C4::Context->preference("intranetbookbag"),
 388             suggestion                  => C4::Context->preference("suggestion"),
 389             virtualshelves              => C4::Context->preference("virtualshelves"),
 390             StaffSerialIssueDisplayCount => C4::Context->preference("StaffSerialIssueDisplayCount"),
 391             NoZebra                     => C4::Context->preference('NoZebra'),
 392                 EasyAnalyticalRecords => C4::Context->preference('EasyAnalyticalRecords'),
 393         );
 394     }
 395     else {
 396         warn "template type should be OPAC, here it is=[" . $in->{'type'} . "]" unless ( $in->{'type'} eq 'opac' );
 397         #TODO : replace LibraryName syspref with 'system name', and remove this html processing
 398         my $LibraryNameTitle = C4::Context->preference("LibraryName");
 399         $LibraryNameTitle =~ s/<(?:\/?)(?:br|p)\s*(?:\/?)>/ /sgi;
 400         $LibraryNameTitle =~ s/<(?:[^<>'"]|'(?:[^']*)'|"(?:[^"]*)")*>//sg;
 401         # variables passed from CGI: opac_css_override and opac_search_limits.
 402         my $opac_search_limit = $ENV{'OPAC_SEARCH_LIMIT'};
 403         my $opac_limit_override = $ENV{'OPAC_LIMIT_OVERRIDE'};
 404         my $opac_name = '';
 405         if (($opac_search_limit =~ /branch:(\w+)/ && $opac_limit_override) || $in->{'query'}->param('limit') =~ /branch:(\w+)/){
 406             $opac_name = $1;   # opac_search_limit is a branch, so we use it.
 407         } elsif (C4::Context->preference("SearchMyLibraryFirst") && C4::Context->userenv && C4::Context->userenv->{'branch'}) {
 408             $opac_name = C4::Context->userenv->{'branch'};
 409         }
 410         my $checkstyle = C4::Context->preference("opaccolorstylesheet");
 411         if ($checkstyle =~ /http/)
 412         {
 413                 $template->param( opacexternalsheet => $checkstyle);
 414         } else
 415         {
 416                 my $opaccolorstylesheet = C4::Context->preference("opaccolorstylesheet");
 417             $template->param( opaccolorstylesheet => $opaccolorstylesheet);
 418         }
 419         $template->param(
 420             AmazonContent             => "" . C4::Context->preference("AmazonContent"),
 421             AnonSuggestions           => "" . C4::Context->preference("AnonSuggestions"),
 422             AuthorisedValueImages     => C4::Context->preference("AuthorisedValueImages"),
 423             BranchesLoop              => GetBranchesLoop($opac_name),
 424             LibraryName               => "" . C4::Context->preference("LibraryName"),
 425             LibraryNameTitle          => "" . $LibraryNameTitle,
 426             LoginBranchname           => C4::Context->userenv?C4::Context->userenv->{"branchname"}:"",
 427             OPACAmazonEnabled         => C4::Context->preference("OPACAmazonEnabled"),
 428             OPACAmazonSimilarItems    => C4::Context->preference("OPACAmazonSimilarItems"),
 429             OPACAmazonCoverImages     => C4::Context->preference("OPACAmazonCoverImages"),
 430             OPACAmazonReviews         => C4::Context->preference("OPACAmazonReviews"),
 431             OPACFRBRizeEditions       => C4::Context->preference("OPACFRBRizeEditions"),
 432             OpacHighlightedWords       => C4::Context->preference("OpacHighlightedWords"),
 433             OPACItemHolds             => C4::Context->preference("OPACItemHolds"),
 434             OPACShelfBrowser          => "". C4::Context->preference("OPACShelfBrowser"),
 435             OPACURLOpenInNewWindow    => "" . C4::Context->preference("OPACURLOpenInNewWindow"),
 436             OPACUserCSS               => "". C4::Context->preference("OPACUserCSS"),
 437             OPACViewOthersSuggestions => "" . C4::Context->preference("OPACViewOthersSuggestions"),
 438             OpacAuthorities           => C4::Context->preference("OpacAuthorities"),
 439             OPACBaseURL               => ($in->{'query'}->https() ? "https://" : "http://") . $ENV{'SERVER_NAME'} .
 440                    ($ENV{'SERVER_PORT'} eq ($in->{'query'}->https() ? "443" : "80") ? '' : ":$ENV{'SERVER_PORT'}"),
 441             opac_css_override           => $ENV{'OPAC_CSS_OVERRIDE'},
 442             opac_search_limit         => $opac_search_limit,
 443             opac_limit_override       => $opac_limit_override,
 444             OpacBrowser               => C4::Context->preference("OpacBrowser"),
 445             OpacCloud                 => C4::Context->preference("OpacCloud"),
 446             OpacKohaUrl               => C4::Context->preference("OpacKohaUrl"),
 447             OpacMainUserBlock         => "" . C4::Context->preference("OpacMainUserBlock"),
 448             OpacNav                   => "" . C4::Context->preference("OpacNav"),
 449             OpacPasswordChange        => C4::Context->preference("OpacPasswordChange"),
 450             OPACPatronDetails        => C4::Context->preference("OPACPatronDetails"),
 451             OPACPrivacy               => C4::Context->preference("OPACPrivacy"),
 452             OPACFinesTab              => C4::Context->preference("OPACFinesTab"),
 453             OpacTopissue              => C4::Context->preference("OpacTopissue"),
 454             RequestOnOpac             => C4::Context->preference("RequestOnOpac"),
 455             'Version'                 => C4::Context->preference('Version'),
 456             hidelostitems             => C4::Context->preference("hidelostitems"),
 457             mylibraryfirst            => (C4::Context->preference("SearchMyLibraryFirst") && C4::Context->userenv) ? C4::Context->userenv->{'branch'} : '',
 458             opaclayoutstylesheet      => "" . C4::Context->preference("opaclayoutstylesheet"),
 459             opacstylesheet            => "" . C4::Context->preference("opacstylesheet"),
 460             opacbookbag               => "" . C4::Context->preference("opacbookbag"),
 461             opaccredits               => "" . C4::Context->preference("opaccredits"),
 462             OpacFavicon               => C4::Context->preference("OpacFavicon"),
 463             opacheader                => "" . C4::Context->preference("opacheader"),
 464             opaclanguagesdisplay      => "" . C4::Context->preference("opaclanguagesdisplay"),
 465             opacreadinghistory        => C4::Context->preference("opacreadinghistory"),
 466             opacsmallimage            => "" . C4::Context->preference("opacsmallimage"),
 467             opacuserjs                => C4::Context->preference("opacuserjs"),
 468             opacuserlogin             => "" . C4::Context->preference("opacuserlogin"),
 469             reviewson                 => C4::Context->preference("reviewson"),
 470             ShowReviewer              => C4::Context->preference("ShowReviewer"),
 471             ShowReviewerPhoto         => C4::Context->preference("ShowReviewerPhoto"),
 472             suggestion                => "" . C4::Context->preference("suggestion"),
 473             virtualshelves            => "" . C4::Context->preference("virtualshelves"),
 474             OPACSerialIssueDisplayCount => C4::Context->preference("OPACSerialIssueDisplayCount"),
 475             OpacAddMastheadLibraryPulldown => C4::Context->preference("OpacAddMastheadLibraryPulldown"),
 476             OPACXSLTDetailsDisplay           => C4::Context->preference("OPACXSLTDetailsDisplay"),
 477             OPACXSLTResultsDisplay           => C4::Context->preference("OPACXSLTResultsDisplay"),
 478             SyndeticsClientCode          => C4::Context->preference("SyndeticsClientCode"),
 479             SyndeticsEnabled             => C4::Context->preference("SyndeticsEnabled"),
 480             SyndeticsCoverImages         => C4::Context->preference("SyndeticsCoverImages"),
 481             SyndeticsTOC                 => C4::Context->preference("SyndeticsTOC"),
 482             SyndeticsSummary             => C4::Context->preference("SyndeticsSummary"),
 483             SyndeticsEditions            => C4::Context->preference("SyndeticsEditions"),
 484             SyndeticsExcerpt             => C4::Context->preference("SyndeticsExcerpt"),
 485             SyndeticsReviews             => C4::Context->preference("SyndeticsReviews"),
 486             SyndeticsAuthorNotes         => C4::Context->preference("SyndeticsAuthorNotes"),
 487             SyndeticsAwards              => C4::Context->preference("SyndeticsAwards"),
 488             SyndeticsSeries              => C4::Context->preference("SyndeticsSeries"),
 489             SyndeticsCoverImageSize      => C4::Context->preference("SyndeticsCoverImageSize"),
 490         );
 491
 492         $template->param(OpacPublic => '1') if ($user || C4::Context->preference("OpacPublic"));
 493     }
 494         $template->param(listloop=>[{shelfname=>"Freelist", shelfnumber=>110}]);
 495     return ( $template, $borrowernumber, $cookie, $flags);
 496 }
 497
 498 =head2 checkauth
 499
 500   ($userid, $cookie, $sessionID) = &checkauth($query, $noauth, $flagsrequired, $type);
 501
 502 Verifies that the user is authorized to run this script.  If
 503 the user is authorized, a (userid, cookie, session-id, flags)
 504 quadruple is returned.  If the user is not authorized but does
 505 not have the required privilege (see $flagsrequired below), it
 506 displays an error page and exits.  Otherwise, it displays the
 507 login page and exits.
 508
 509 Note that C<&checkauth> will return if and only if the user
 510 is authorized, so it should be called early on, before any
 511 unfinished operations (e.g., if you've opened a file, then
 512 C<&checkauth> won't close it for you).
 513
 514 C<$query> is the CGI object for the script calling C<&checkauth>.
 515
 516 The C<$noauth> argument is optional. If it is set, then no
 517 authorization is required for the script.
 518
 519 C<&checkauth> fetches user and session information from C<$query> and
 520 ensures that the user is authorized to run scripts that require
 521 authorization.
 522
 523 The C<$flagsrequired> argument specifies the required privileges
 524 the user must have if the username and password are correct.
 525 It should be specified as a reference-to-hash; keys in the hash
 526 should be the "flags" for the user, as specified in the Members
 527 intranet module. Any key specified must correspond to a "flag"
 528 in the userflags table. E.g., { circulate => 1 } would specify
 529 that the user must have the "circulate" privilege in order to
 530 proceed. To make sure that access control is correct, the
 531 C<$flagsrequired> parameter must be specified correctly.
 532
 533 Koha also has a concept of sub-permissions, also known as
 534 granular permissions.  This makes the value of each key
 535 in the C<flagsrequired> hash take on an additional
 536 meaning, i.e.,
 537
 538  1
 539
 540 The user must have access to all subfunctions of the module
 541 specified by the hash key.
 542
 543  *
 544
 545 The user must have access to at least one subfunction of the module
 546 specified by the hash key.
 547
 548  specific permission, e.g., 'export_catalog'
 549
 550 The user must have access to the specific subfunction list, which
 551 must correspond to a row in the permissions table.
 552
 553 The C<$type> argument specifies whether the template should be
 554 retrieved from the opac or intranet directory tree.  "opac" is
 555 assumed if it is not specified; however, if C<$type> is specified,
 556 "intranet" is assumed if it is not "opac".
 557
 558 If C<$query> does not have a valid session ID associated with it
 559 (i.e., the user has not logged in) or if the session has expired,
 560 C<&checkauth> presents the user with a login page (from the point of
 561 view of the original script, C<&checkauth> does not return). Once the
 562 user has authenticated, C<&checkauth> restarts the original script
 563 (this time, C<&checkauth> returns).
 564
 565 The login page is provided using a HTML::Template, which is set in the
 566 systempreferences table or at the top of this file. The variable C<$type>
 567 selects which template to use, either the opac or the intranet
 568 authentification template.
 569
 570 C<&checkauth> returns a user ID, a cookie, and a session ID. The
 571 cookie should be sent back to the browser; it verifies that the user
 572 has authenticated.
 573
 574 =cut
 575
 576 sub _version_check ($$) {
 577     my $type = shift;
 578     my $query = shift;
 579     my $version;
 580     # If Version syspref is unavailable, it means Koha is beeing installed,
 581     # and so we must redirect to OPAC maintenance page or to the WebInstaller
 582         # also, if OpacMaintenance is ON, OPAC should redirect to maintenance
 583         if (C4::Context->preference('OpacMaintenance') && $type eq 'opac') {
 584         warn "OPAC Install required, redirecting to maintenance";
 585         print $query->redirect("/cgi-bin/koha/maintenance.pl");
 586     }
 587     unless ( $version = C4::Context->preference('Version') ) {    # assignment, not comparison
 588         if ( $type ne 'opac' ) {
 589             warn "Install required, redirecting to Installer";
 590             print $query->redirect("/cgi-bin/koha/installer/install.pl");
 591         } else {
 592             warn "OPAC Install required, redirecting to maintenance";
 593             print $query->redirect("/cgi-bin/koha/maintenance.pl");
 594         }
 595         safe_exit;
 596     }
 597
 598     # check that database and koha version are the same
 599     # there is no DB version, it's a fresh install,
 600     # go to web installer
 601     # there is a DB version, compare it to the code version
 602     my $kohaversion=C4::Context::KOHAVERSION;
 603     # remove the 3 last . to have a Perl number
 604     $kohaversion =~ s/(.*\..*)\.(.*)\.(.*)/$1$2$3/;
 605     $debug and print STDERR "kohaversion : $kohaversion\n";
 606     if ($version < $kohaversion){
 607         my $warning = "Database update needed, redirecting to %s. Database is $version and Koha is $kohaversion";
 608         if ($type ne 'opac'){
 609             warn sprintf($warning, 'Installer');
 610             print $query->redirect("/cgi-bin/koha/installer/install.pl?step=3");
 611         } else {
 612             warn sprintf("OPAC: " . $warning, 'maintenance');
 613             print $query->redirect("/cgi-bin/koha/maintenance.pl");
 614         }
 615         safe_exit;
 616     }
 617 }
 618
 619 sub _session_log {
 620     (@_) or return 0;
 621     open L, ">>/tmp/sessionlog" or warn "ERROR: Cannot append to /tmp/sessionlog";
 622     printf L join("\n",@_);
 623     close L;
 624 }
 625
 626 sub checkauth {
 627     my $query = shift;
 628         $debug and warn "Checking Auth";
 629     # $authnotrequired will be set for scripts which will run without authentication
 630     my $authnotrequired = shift;
 631     my $flagsrequired   = shift;
 632     my $type            = shift;
 633     $type = 'opac' unless $type;
 634
 635     my $dbh     = C4::Context->dbh;
 636     my $timeout = C4::Context->preference('timeout');
 637     # days
 638     if ($timeout =~ /(\d+)[dD]/) {
 639         $timeout = $1 * 86400;
 640     };
 641     $timeout = 600 unless $timeout;
 642
 643     _version_check($type,$query);
 644     # state variables
 645     my $loggedin = 0;
 646     my %info;
 647     my ( $userid, $cookie, $sessionID, $flags, $barshelves, $pubshelves );
 648     my $logout = $query->param('logout.x');
 649
 650     # This parameter is the name of the CAS server we want to authenticate against,
 651     # when using authentication against multiple CAS servers, as configured in Auth_cas_servers.yaml
 652     my $casparam = $query->param('cas');
 653
 654     if ( $userid = $ENV{'REMOTE_USER'} ) {
 655         # Using Basic Authentication, no cookies required
 656         $cookie = $query->cookie(
 657             -name    => 'CGISESSID',
 658             -value   => '',
 659             -expires => ''
 660         );
 661         $loggedin = 1;
 662     }
 663     elsif ( $sessionID = $query->cookie("CGISESSID")) {     # assignment, not comparison
 664         my $session = get_session($sessionID);
 665         C4::Context->_new_userenv($sessionID);
 666         my ($ip, $lasttime, $sessiontype);
 667         if ($session){
 668             C4::Context::set_userenv(
 669                 $session->param('number'),       $session->param('id'),
 670                 $session->param('cardnumber'),   $session->param('firstname'),
 671                 $session->param('surname'),      $session->param('branch'),
 672                 $session->param('branchname'),   $session->param('flags'),
 673                 $session->param('emailaddress'), $session->param('branchprinter')
 674             );
 675             C4::Context::set_shelves_userenv('bar',$session->param('barshelves'));
 676             C4::Context::set_shelves_userenv('pub',$session->param('pubshelves'));
 677             C4::Context::set_shelves_userenv('tot',$session->param('totshelves'));
 678             $debug and printf STDERR "AUTH_SESSION: (%s)\t%s %s - %s\n", map {$session->param($_)} qw(cardnumber firstname surname branch) ;
 679             $ip       = $session->param('ip');
 680             $lasttime = $session->param('lasttime');
 681             $userid   = $session->param('id');
 682                         $sessiontype = $session->param('sessiontype');
 683         }
 684         if ( ($query->param('koha_login_context')) && ($query->param('userid') ne $session->param('id')) ) {
 685             #if a user enters an id ne to the id in the current session, we need to log them in...
 686             #first we need to clear the anonymous session...
 687             $debug and warn "query id = " . $query->param('userid') . " but session id = " . $session->param('id');
 688             $session->flush;
 689             $session->delete();
 690             C4::Context->_unset_userenv($sessionID);
 691                         $sessionID = undef;
 692                         $userid = undef;
 693                 }
 694         elsif ($logout) {
 695             # voluntary logout the user
 696             $session->flush;
 697             $session->delete();
 698             C4::Context->_unset_userenv($sessionID);
 699             _session_log(sprintf "%20s from %16s logged out at %30s (manually).\n", $userid,$ip,(strftime "%c",localtime));
 700             $sessionID = undef;
 701             $userid    = undef;
 702
 703             if ($cas and $caslogout) {
 704                 logout_cas($query);
 705             }
 706         }
 707         elsif ( $lasttime < time() - $timeout ) {
 708             # timed logout
 709             $info{'timed_out'} = 1;
 710             $session->delete();
 711             C4::Context->_unset_userenv($sessionID);
 712             _session_log(sprintf "%20s from %16s logged out at %30s (inactivity).\n", $userid,$ip,(strftime "%c",localtime));
 713             $userid    = undef;
 714             $sessionID = undef;
 715         }
 716         elsif ( $ip ne $ENV{'REMOTE_ADDR'} ) {
 717             # Different ip than originally logged in from
 718             $info{'oldip'}        = $ip;
 719             $info{'newip'}        = $ENV{'REMOTE_ADDR'};
 720             $info{'different_ip'} = 1;
 721             $session->delete();
 722             C4::Context->_unset_userenv($sessionID);
 723             _session_log(sprintf "%20s from %16s logged out at %30s (ip changed to %16s).\n", $userid,$ip,(strftime "%c",localtime), $info{'newip'});
 724             $sessionID = undef;
 725             $userid    = undef;
 726         }
 727         else {
 728             $cookie = $query->cookie( CGISESSID => $session->id );
 729             $session->param('lasttime',time());
 730             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...
 731                 $flags = haspermission($userid, $flagsrequired);
 732                 if ($flags) {
 733                     $loggedin = 1;
 734                 } else {
 735                     $info{'nopermission'} = 1;
 736                 }
 737             }
 738         }
 739     }
 740     unless ($userid || $sessionID) {
 741         #we initiate a session prior to checking for a username to allow for anonymous sessions...
 742                 my $session = get_session("") or die "Auth ERROR: Cannot get_session()";
 743         my $sessionID = $session->id;
 744         C4::Context->_new_userenv($sessionID);
 745         $cookie = $query->cookie(CGISESSID => $sessionID);
 746             $userid    = $query->param('userid');
 747             if ($cas || $userid) {
 748                 my $password = $query->param('password');
 749                 my ($return, $cardnumber);
 750                 if ($cas && $query->param('ticket')) {
 751                     my $retuserid;
 752                     ( $return, $cardnumber, $retuserid ) = checkpw( $dbh, $userid, $password, $query );
 753                     $userid = $retuserid;
 754                     $info{'invalidCasLogin'} = 1 unless ($return);
 755                 } else {
 756                     my $retuserid;
 757                     ( $return, $retuserid ) = checkpw( $dbh, $userid, $password, $query );
 758                     $userid = $retuserid if ($retuserid ne '');
 759                 }
 760                 if ($return) {
 761                _session_log(sprintf "%20s from %16s logged in  at %30s.\n", $userid,$ENV{'REMOTE_ADDR'},(strftime '%c', localtime));
 762                 if ( $flags = haspermission(  $userid, $flagsrequired ) ) {
 763                                         $loggedin = 1;
 764                 }
 765                         else {
 766                         $info{'nopermission'} = 1;
 767                         C4::Context->_unset_userenv($sessionID);
 768                 }
 769
 770                                 my ($borrowernumber, $firstname, $surname, $userflags,
 771                                         $branchcode, $branchname, $branchprinter, $emailaddress);
 772
 773                 if ( $return == 1 ) {
 774                         my $select = "
 775                         SELECT borrowernumber, firstname, surname, flags, borrowers.branchcode,
 776                             branches.branchname    as branchname,
 777                                 branches.branchprinter as branchprinter,
 778                                 email
 779                         FROM borrowers
 780                         LEFT JOIN branches on borrowers.branchcode=branches.branchcode
 781                         ";
 782                         my $sth = $dbh->prepare("$select where userid=?");
 783                         $sth->execute($userid);
 784                         unless ($sth->rows) {
 785                             $debug and print STDERR "AUTH_1: no rows for userid='$userid'\n";
 786                             $sth = $dbh->prepare("$select where cardnumber=?");
 787                             $sth->execute($cardnumber);
 788
 789                             unless ($sth->rows) {
 790                                 $debug and print STDERR "AUTH_2a: no rows for cardnumber='$cardnumber'\n";
 791                                 $sth->execute($userid);
 792                                 unless ($sth->rows) {
 793                                     $debug and print STDERR "AUTH_2b: no rows for userid='$userid' AS cardnumber\n";
 794                                 }
 795                             }
 796                         }
 797                         if ($sth->rows) {
 798                             ($borrowernumber, $firstname, $surname, $userflags,
 799                                 $branchcode, $branchname, $branchprinter, $emailaddress) = $sth->fetchrow;
 800                                                 $debug and print STDERR "AUTH_3 results: " .
 801                                                         "$cardnumber,$borrowernumber,$userid,$firstname,$surname,$userflags,$branchcode,$emailaddress\n";
 802                                         } else {
 803                                                 print STDERR "AUTH_3: no results for userid='$userid', cardnumber='$cardnumber'.\n";
 804                                         }
 805
 806 # launch a sequence to check if we have a ip for the branch, i
 807 # if we have one we replace the branchcode of the userenv by the branch bound in the ip.
 808
 809                                         my $ip       = $ENV{'REMOTE_ADDR'};
 810                                         # if they specify at login, use that
 811                                         if ($query->param('branch')) {
 812                                                 $branchcode  = $query->param('branch');
 813                                                 $branchname = GetBranchName($branchcode);
 814                                         }
 815                                         my $branches = GetBranches();
 816                                         if (C4::Context->boolean_preference('IndependantBranches') && C4::Context->boolean_preference('Autolocation')){
 817                                                 # we have to check they are coming from the right ip range
 818                                                 my $domain = $branches->{$branchcode}->{'branchip'};
 819                                                 if ($ip !~ /^$domain/){
 820                                                         $loggedin=0;
 821                                                         $info{'wrongip'} = 1;
 822                                                 }
 823                                         }
 824
 825                                         my @branchesloop;
 826                                         foreach my $br ( keys %$branches ) {
 827                                                 #     now we work with the treatment of ip
 828                                                 my $domain = $branches->{$br}->{'branchip'};
 829                                                 if ( $domain && $ip =~ /^$domain/ ) {
 830                                                         $branchcode = $branches->{$br}->{'branchcode'};
 831
 832                                                         # new op dev : add the branchprinter and branchname in the cookie
 833                                                         $branchprinter = $branches->{$br}->{'branchprinter'};
 834                                                         $branchname    = $branches->{$br}->{'branchname'};
 835                                                 }
 836                                         }
 837                                         $session->param('number',$borrowernumber);
 838                                         $session->param('id',$userid);
 839                                         $session->param('cardnumber',$cardnumber);
 840                                         $session->param('firstname',$firstname);
 841                                         $session->param('surname',$surname);
 842                                         $session->param('branch',$branchcode);
 843                                         $session->param('branchname',$branchname);
 844                                         $session->param('flags',$userflags);
 845                                         $session->param('emailaddress',$emailaddress);
 846                                         $session->param('ip',$session->remote_addr());
 847                                         $session->param('lasttime',time());
 848                                         $debug and printf STDERR "AUTH_4: (%s)\t%s %s - %s\n", map {$session->param($_)} qw(cardnumber firstname surname branch) ;
 849                                 }
 850                                 elsif ( $return == 2 ) {
 851                                         #We suppose the user is the superlibrarian
 852                                         $borrowernumber = 0;
 853                                         $session->param('number',0);
 854                                         $session->param('id',C4::Context->config('user'));
 855                                         $session->param('cardnumber',C4::Context->config('user'));
 856                                         $session->param('firstname',C4::Context->config('user'));
 857                                         $session->param('surname',C4::Context->config('user'));
 858                                         $session->param('branch','NO_LIBRARY_SET');
 859                                         $session->param('branchname','NO_LIBRARY_SET');
 860                                         $session->param('flags',1);
 861                                         $session->param('emailaddress', C4::Context->preference('KohaAdminEmailAddress'));
 862                                         $session->param('ip',$session->remote_addr());
 863                                         $session->param('lasttime',time());
 864                                 }
 865                                 C4::Context::set_userenv(
 866                                         $session->param('number'),       $session->param('id'),
 867                                         $session->param('cardnumber'),   $session->param('firstname'),
 868                                         $session->param('surname'),      $session->param('branch'),
 869                                         $session->param('branchname'),   $session->param('flags'),
 870                                         $session->param('emailaddress'), $session->param('branchprinter')
 871                                 );
 872
 873                                 # Grab borrower's shelves and public shelves and add them to the session
 874                                 # $row_count determines how many records are returned from the db query
 875                                 # and the number of lists to be displayed of each type in the 'Lists' button drop down
 876                                 my $row_count = 10; # FIXME:This probably should be a syspref
 877                                 my ($total, $totshelves, $barshelves, $pubshelves);
 878                                 ($barshelves, $totshelves) = C4::VirtualShelves::GetRecentShelves(1, $row_count, $borrowernumber);
 879                                 $total->{'bartotal'} = $totshelves;
 880                                 ($pubshelves, $totshelves) = C4::VirtualShelves::GetRecentShelves(2, $row_count, undef);
 881                                 $total->{'pubtotal'} = $totshelves;
 882                                 $session->param('barshelves', $barshelves);
 883                                 $session->param('pubshelves', $pubshelves);
 884                                 $session->param('totshelves', $total);
 885
 886                                 C4::Context::set_shelves_userenv('bar',$barshelves);
 887                                 C4::Context::set_shelves_userenv('pub',$pubshelves);
 888                                 C4::Context::set_shelves_userenv('tot',$total);
 889                         }
 890                 else {
 891                 if ($userid) {
 892                         $info{'invalid_username_or_password'} = 1;
 893                         C4::Context->_unset_userenv($sessionID);
 894                 }
 895                         }
 896         }       # END if ( $userid    = $query->param('userid') )
 897                 elsif ($type eq "opac") {
 898             # if we are here this is an anonymous session; add public lists to it and a few other items...
 899             # anonymous sessions are created only for the OPAC
 900                         $debug and warn "Initiating an anonymous session...";
 901
 902                         # Grab the public shelves and add to the session...
 903                         my $row_count = 20; # FIXME:This probably should be a syspref
 904                         my ($total, $totshelves, $pubshelves);
 905                         ($pubshelves, $totshelves) = C4::VirtualShelves::GetRecentShelves(2, $row_count, undef);
 906                         $total->{'pubtotal'} = $totshelves;
 907                         $session->param('pubshelves', $pubshelves);
 908                         $session->param('totshelves', $total);
 909                         C4::Context::set_shelves_userenv('pub',$pubshelves);
 910                         C4::Context::set_shelves_userenv('tot',$total);
 911
 912                         # setting a couple of other session vars...
 913                         $session->param('ip',$session->remote_addr());
 914                         $session->param('lasttime',time());
 915                         $session->param('sessiontype','anon');
 916                 }
 917     }   # END unless ($userid)
 918     my $insecure = C4::Context->boolean_preference('insecure');
 919
 920     # finished authentification, now respond
 921     if ( $loggedin || $authnotrequired || ( defined($insecure) && $insecure ) )
 922     {
 923         # successful login
 924         unless ($cookie) {
 925             $cookie = $query->cookie( CGISESSID => '' );
 926         }
 927         return ( $userid, $cookie, $sessionID, $flags );
 928     }
 929
 930 #
 931 #
 932 # AUTH rejected, show the login/password template, after checking the DB.
 933 #
 934 #
 935
 936     # get the inputs from the incoming query
 937     my @inputs = ();
 938     foreach my $name ( param $query) {
 939         (next) if ( $name eq 'userid' || $name eq 'password' || $name eq 'ticket' );
 940         my $value = $query->param($name);
 941         push @inputs, { name => $name, value => $value };
 942     }
 943     # get the branchloop, which we need for authentication
 944     my $branches = GetBranches();
 945     my @branch_loop;
 946     for my $branch_hash (sort keys %$branches) {
 947                 push @branch_loop, {branchcode => "$branch_hash", branchname => $branches->{$branch_hash}->{'branchname'}, };
 948     }
 949
 950     my $template_name = ( $type eq 'opac' ) ? 'opac-auth.tmpl' : 'auth.tmpl';
 951     my $template = C4::Templates::gettemplate( $template_name, $type, $query );
 952     $template->param(branchloop => \@branch_loop,);
 953     my $checkstyle = C4::Context->preference("opaccolorstylesheet");
 954     if ($checkstyle =~ /\//)
 955         {
 956                 $template->param( opacexternalsheet => $checkstyle);
 957         } else
 958         {
 959                 my $opaccolorstylesheet = C4::Context->preference("opaccolorstylesheet");
 960             $template->param( opaccolorstylesheet => $opaccolorstylesheet);
 961         }
 962     $template->param(
 963     login        => 1,
 964         INPUTS               => \@inputs,
 965         casAuthentication    => C4::Context->preference("casAuthentication"),
 966         suggestion           => C4::Context->preference("suggestion"),
 967         virtualshelves       => C4::Context->preference("virtualshelves"),
 968         LibraryName          => C4::Context->preference("LibraryName"),
 969         opacuserlogin        => C4::Context->preference("opacuserlogin"),
 970         OpacNav              => C4::Context->preference("OpacNav"),
 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) {
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' && $servers){
1418         $session = new CGI::Session("driver:memcached;serializer:yaml;id:md5", $sessionID, { Memcached => $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 "## checkpw - checking LDAP\n";
1432         my ($retval,$retcard) = checkpw_ldap(@_);    # EXTERNAL AUTH
1433         ($retval) and return ($retval,$retcard);
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, $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, $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 END { }    # module clean-up code here (global destructor)
1673 1;
1674 __END__
1675
1676 =head1 SEE ALSO
1677
1678 CGI(3)
1679
1680 C4::Output(3)
1681
1682 Digest::MD5(3)
1683
1684 =cut