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