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