C4/Auth.pm

   1 package C4::Auth;
   2
   3 # Copyright 2000-2002 Katipo Communications
   4 #
   5 # This file is part of Koha.
   6 #
   7 # Koha is free software; you can redistribute it and/or modify it under the
   8 # terms of the GNU General Public License as published by the Free Software
   9 # Foundation; either version 2 of the License, or (at your option) any later
  10 # version.
  11 #
  12 # Koha is distributed in the hope that it will be useful, but WITHOUT ANY
  13 # WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
  14 # A PARTICULAR PURPOSE.  See the GNU General Public License for more details.
  15 #
  16 # You should have received a copy of the GNU General Public License along
  17 # with Koha; if not, write to the Free Software Foundation, Inc.,
  18 # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  19
  20 use strict;
  21 #use warnings; FIXME - Bug 2505
  22 use Digest::MD5 qw(md5_base64);
  23 use Storable qw(thaw freeze);
  24 use URI::Escape;
  25 use CGI::Session;
  26
  27 require Exporter;
  28 use C4::Context;
  29 use C4::Output;    # to get the template
  30 use C4::Members;
  31 use C4::Koha;
  32 use C4::Branch; # GetBranches
  33 use C4::VirtualShelves;
  34 use POSIX qw/strftime/;
  35
  36 # use utf8;
  37 use vars qw($VERSION @ISA @EXPORT @EXPORT_OK %EXPORT_TAGS $debug $ldap $cas $caslogout);
  38
  39 BEGIN {
  40     $VERSION = 3.02;        # set version for version checking
  41     $debug = $ENV{DEBUG};
  42     @ISA   = qw(Exporter);
  43     @EXPORT    = qw(&checkauth &get_template_and_user &haspermission &get_user_subpermissions);
  44     @EXPORT_OK = qw(&check_api_auth &get_session &check_cookie_auth &checkpw &get_all_subpermissions &get_user_subpermissions);
  45     %EXPORT_TAGS = (EditPermissions => [qw(get_all_subpermissions get_user_subpermissions)]);
  46     $ldap = C4::Context->config('useldapserver') || 0;
  47     $cas = C4::Context->preference('casAuthentication');
  48     $caslogout = C4::Context->preference('casLogout');
  49     if ($ldap) {
  50         require C4::Auth_with_ldap;             # no import
  51         import  C4::Auth_with_ldap qw(checkpw_ldap);
  52     }
  53     if ($cas) {
  54         require C4::Auth_with_cas;             # no import
  55         import  C4::Auth_with_cas qw(checkpw_cas login_cas logout_cas login_cas_url);
  56     }
  57
  58 }
  59
  60 =head1 NAME
  61
  62 C4::Auth - Authenticates Koha users
  63
  64 =head1 SYNOPSIS
  65
  66   use CGI;
  67   use C4::Auth;
  68   use C4::Output;
  69
  70   my $query = new CGI;
  71
  72   my ($template, $borrowernumber, $cookie)
  73     = get_template_and_user(
  74         {
  75             template_name   => "opac-main.tmpl",
  76             query           => $query,
  77       type            => "opac",
  78       authnotrequired => 1,
  79       flagsrequired   => {borrow => 1, catalogue => '*', tools => 'import_patrons' },
  80   }
  81     );
  82
  83   output_html_with_http_headers $query, $cookie, $template->output;
  84
  85 =head1 DESCRIPTION
  86
  87 The main function of this module is to provide
  88 authentification. However the get_template_and_user function has
  89 been provided so that a users login information is passed along
  90 automatically. This gets loaded into the template.
  91
  92 =head1 FUNCTIONS
  93
  94 =head2 get_template_and_user
  95
  96  my ($template, $borrowernumber, $cookie)
  97      = get_template_and_user(
  98        {
  99          template_name   => "opac-main.tmpl",
 100          query           => $query,
 101          type            => "opac",
 102          authnotrequired => 1,
 103          flagsrequired   => {borrow => 1, catalogue => '*', tools => 'import_patrons' },
 104        }
 105      );
 106
 107 This call passes the C<query>, C<flagsrequired> and C<authnotrequired>
 108 to C<&checkauth> (in this module) to perform authentification.
 109 See C<&checkauth> for an explanation of these parameters.
 110
 111 The C<template_name> is then used to find the correct template for
 112 the page. The authenticated users details are loaded onto the
 113 template in the HTML::Template LOOP variable C<USER_INFO>. Also the
 114 C<sessionID> is passed to the template. This can be used in templates
 115 if cookies are disabled. It needs to be put as and input to every
 116 authenticated page.
 117
 118 More information on the C<gettemplate> sub can be found in the
 119 Output.pm module.
 120
 121 =cut
 122
 123 my $SEARCH_HISTORY_INSERT_SQL =<<EOQ;
 124 INSERT INTO search_history(userid, sessionid, query_desc, query_cgi, total, time            )
 125 VALUES                    (     ?,         ?,          ?,         ?,     ?, FROM_UNIXTIME(?))
 126 EOQ
 127 sub get_template_and_user {
 128     my $in       = shift;
 129     my $template =
 130       gettemplate( $in->{'template_name'}, $in->{'type'}, $in->{'query'} );
 131     my ( $user, $cookie, $sessionID, $flags ) = checkauth(
 132         $in->{'query'},
 133         $in->{'authnotrequired'},
 134         $in->{'flagsrequired'},
 135         $in->{'type'}
 136     ) unless ($in->{'template_name'}=~/maintenance/);
 137
 138     my $borrowernumber;
 139     my $insecure = C4::Context->preference('insecure');
 140     if ($user or $insecure) {
 141
 142         # load the template variables for stylesheets and JavaScript
 143         $template->param( css_libs => $in->{'css_libs'} );
 144         $template->param( css_module => $in->{'css_module'} );
 145         $template->param( css_page => $in->{'css_page'} );
 146         $template->param( css_widgets => $in->{'css_widgets'} );
 147
 148         $template->param( js_libs => $in->{'js_libs'} );
 149         $template->param( js_module => $in->{'js_module'} );
 150         $template->param( js_page => $in->{'js_page'} );
 151         $template->param( js_widgets => $in->{'js_widgets'} );
 152
 153         # user info
 154         $template->param( loggedinusername => $user );
 155         $template->param( sessionID        => $sessionID );
 156
 157                 my ($total, $pubshelves, $barshelves) = C4::Context->get_shelves_userenv();
 158                 if (defined($pubshelves)) {
 159                 $template->param(       pubshelves      => scalar (@$pubshelves),
 160                                                         pubshelvesloop  => $pubshelves,
 161                                                         );
 162                         $template->param(       pubtotal                => $total->{'pubtotal'}, ) if ($total->{'pubtotal'} > scalar (@$pubshelves));
 163                 }
 164                 if (defined($barshelves)) {
 165                 $template->param(       barshelves      => scalar (@$barshelves),
 166                                                         barshelvesloop  => $barshelves,
 167                                                         );
 168                         $template->param(       bartotal                => $total->{'bartotal'}, ) if ($total->{'bartotal'} > scalar (@$barshelves));
 169                 }
 170
 171         $borrowernumber = getborrowernumber($user) if defined($user);
 172
 173         my ( $borr ) = GetMemberDetails( $borrowernumber );
 174         my @bordat;
 175         $bordat[0] = $borr;
 176         $template->param( "USER_INFO" => \@bordat );
 177
 178         my $all_perms = get_all_subpermissions();
 179
 180         my @flagroots = qw(circulate catalogue parameters borrowers permissions reserveforothers borrow
 181                             editcatalogue updatecharges management tools editauthorities serials reports acquisition);
 182         # We are going to use the $flags returned by checkauth
 183         # to create the template's parameters that will indicate
 184         # which menus the user can access.
 185         if (( $flags && $flags->{superlibrarian}==1) or $insecure==1) {
 186             $template->param( CAN_user_circulate        => 1 );
 187             $template->param( CAN_user_catalogue        => 1 );
 188             $template->param( CAN_user_parameters       => 1 );
 189             $template->param( CAN_user_borrowers        => 1 );
 190             $template->param( CAN_user_permissions      => 1 );
 191             $template->param( CAN_user_reserveforothers => 1 );
 192             $template->param( CAN_user_borrow           => 1 );
 193             $template->param( CAN_user_editcatalogue    => 1 );
 194             $template->param( CAN_user_updatecharges     => 1 );
 195             $template->param( CAN_user_acquisition      => 1 );
 196             $template->param( CAN_user_management       => 1 );
 197             $template->param( CAN_user_tools            => 1 );
 198             $template->param( CAN_user_editauthorities  => 1 );
 199             $template->param( CAN_user_serials          => 1 );
 200             $template->param( CAN_user_reports          => 1 );
 201             $template->param( CAN_user_staffaccess      => 1 );
 202             foreach my $module (keys %$all_perms) {
 203                 foreach my $subperm (keys %{ $all_perms->{$module} }) {
 204                     $template->param( "CAN_user_${module}_${subperm}" => 1 );
 205                 }
 206             }
 207         }
 208
 209         if ( $flags ) {
 210             foreach my $module (keys %$all_perms) {
 211                 if ( $flags->{$module} == 1) {
 212                     foreach my $subperm (keys %{ $all_perms->{$module} }) {
 213                         $template->param( "CAN_user_${module}_${subperm}" => 1 );
 214                     }
 215                 } elsif ( ref($flags->{$module}) ) {
 216                     foreach my $subperm (keys %{ $flags->{$module} } ) {
 217                         $template->param( "CAN_user_${module}_${subperm}" => 1 );
 218                     }
 219                 }
 220             }
 221         }
 222
 223         if ($flags) {
 224             foreach my $module (keys %$flags) {
 225                 if ( $flags->{$module} == 1 or ref($flags->{$module}) ) {
 226                     $template->param( "CAN_user_$module" => 1 );
 227                     if ($module eq "parameters") {
 228                         $template->param( CAN_user_management => 1 );
 229                     }
 230                 }
 231             }
 232         }
 233                 # Logged-in opac search history
 234                 # If the requested template is an opac one and opac search history is enabled
 235                 if ($in->{type} eq 'opac' && C4::Context->preference('EnableOpacSearchHistory')) {
 236                         my $dbh = C4::Context->dbh;
 237                         my $query = "SELECT COUNT(*) FROM search_history WHERE userid=?";
 238                         my $sth = $dbh->prepare($query);
 239                         $sth->execute($borrowernumber);
 240
 241                         # If at least one search has already been performed
 242                         if ($sth->fetchrow_array > 0) {
 243                         # We show the link in opac
 244                         $template->param(ShowOpacRecentSearchLink => 1);
 245                         }
 246
 247                         # And if there's a cookie with searches performed when the user was not logged in,
 248                         # we add them to the logged-in search history
 249                         my $searchcookie = $in->{'query'}->cookie('KohaOpacRecentSearches');
 250                         if ($searchcookie){
 251                                 $searchcookie = uri_unescape($searchcookie);
 252                                 my @recentSearches = @{thaw($searchcookie) || []};
 253                                 if (@recentSearches) {
 254                                         my $sth = $dbh->prepare($SEARCH_HISTORY_INSERT_SQL);
 255                                         $sth->execute( $borrowernumber,
 256                                                        $in->{'query'}->cookie("CGISESSID"),
 257                                                        $_->{'query_desc'},
 258                                                        $_->{'query_cgi'},
 259                                                        $_->{'total'},
 260                                                        $_->{'time'},
 261                                         ) foreach @recentSearches;
 262
 263                                         # And then, delete the cookie's content
 264                                         my $newsearchcookie = $in->{'query'}->cookie(
 265                                                                                                 -name => 'KohaOpacRecentSearches',
 266                                                                                                 -value => freeze([]),
 267                                                                                                 -expires => ''
 268                                                                                          );
 269                                         $cookie = [$cookie, $newsearchcookie];
 270                                 }
 271                         }
 272                 }
 273     }
 274         else {  # if this is an anonymous session, setup to display public lists...
 275
 276         # load the template variables for stylesheets and JavaScript
 277         $template->param( css_libs => $in->{'css_libs'} );
 278         $template->param( css_module => $in->{'css_module'} );
 279         $template->param( css_page => $in->{'css_page'} );
 280         $template->param( css_widgets => $in->{'css_widgets'} );
 281
 282         $template->param( js_libs => $in->{'js_libs'} );
 283         $template->param( js_module => $in->{'js_module'} );
 284         $template->param( js_page => $in->{'js_page'} );
 285         $template->param( js_widgets => $in->{'js_widgets'} );
 286
 287         $template->param( sessionID        => $sessionID );
 288
 289         my ($total, $pubshelves) = C4::Context->get_shelves_userenv();  # an anonymous user has no 'barshelves'...
 290         if (defined(($pubshelves))) {
 291             $template->param(   pubshelves      => scalar (@$pubshelves),
 292                                 pubshelvesloop  => $pubshelves,
 293                             );
 294             $template->param(   pubtotal        => $total->{'pubtotal'}, ) if ($total->{'pubtotal'} > scalar (@$pubshelves));
 295         }
 296
 297     }
 298         # Anonymous opac search history
 299         # If opac search history is enabled and at least one search has already been performed
 300         if (C4::Context->preference('EnableOpacSearchHistory')) {
 301                 my $searchcookie = $in->{'query'}->cookie('KohaOpacRecentSearches');
 302                 if ($searchcookie){
 303                         $searchcookie = uri_unescape($searchcookie);
 304                         my @recentSearches = @{thaw($searchcookie) || []};
 305             # We show the link in opac
 306                         if (@recentSearches) {
 307                                 $template->param(ShowOpacRecentSearchLink => 1);
 308                         }
 309             }
 310         }
 311
 312     if(C4::Context->preference('dateformat')){
 313         if(C4::Context->preference('dateformat') eq "metric"){
 314             $template->param(dateformat_metric => 1);
 315         } elsif(C4::Context->preference('dateformat') eq "us"){
 316             $template->param(dateformat_us => 1);
 317         } else {
 318             $template->param(dateformat_iso => 1);
 319         }
 320     } else {
 321         $template->param(dateformat_iso => 1);
 322     }
 323
 324     # these template parameters are set the same regardless of $in->{'type'}
 325     $template->param(
 326             "BiblioDefaultView".C4::Context->preference("BiblioDefaultView")         => 1,
 327             EnhancedMessagingPreferences => C4::Context->preference('EnhancedMessagingPreferences'),
 328             GoogleJackets                => C4::Context->preference("GoogleJackets"),
 329             KohaAdminEmailAddress        => "" . C4::Context->preference("KohaAdminEmailAddress"),
 330             LoginBranchcode              => (C4::Context->userenv?C4::Context->userenv->{"branch"}:"insecure"),
 331             LoginFirstname               => (C4::Context->userenv?C4::Context->userenv->{"firstname"}:"Bel"),
 332             LoginSurname                 => C4::Context->userenv?C4::Context->userenv->{"surname"}:"Inconnu",
 333             TagsEnabled                  => C4::Context->preference("TagsEnabled"),
 334             hide_marc                    => C4::Context->preference("hide_marc"),
 335             item_level_itypes            => C4::Context->preference('item-level_itypes'),
 336             patronimages                 => C4::Context->preference("patronimages"),
 337             singleBranchMode             => C4::Context->preference("singleBranchMode"),
 338             XSLTDetailsDisplay           => C4::Context->preference("XSLTDetailsDisplay"),
 339             XSLTResultsDisplay           => C4::Context->preference("XSLTResultsDisplay"),
 340             using_https                  => $in->{'query'}->https() ? 1 : 0,
 341             noItemTypeImages            => C4::Context->preference("noItemTypeImages"),
 342     );
 343
 344     if ( $in->{'type'} eq "intranet" ) {
 345         $template->param(
 346             AmazonContent               => C4::Context->preference("AmazonContent"),
 347             AmazonCoverImages           => C4::Context->preference("AmazonCoverImages"),
 348             AmazonEnabled               => C4::Context->preference("AmazonEnabled"),
 349             AmazonSimilarItems          => C4::Context->preference("AmazonSimilarItems"),
 350             AutoLocation                => C4::Context->preference("AutoLocation"),
 351             "BiblioDefaultView".C4::Context->preference("IntranetBiblioDefaultView") => 1,
 352             CircAutocompl               => C4::Context->preference("CircAutocompl"),
 353             FRBRizeEditions             => C4::Context->preference("FRBRizeEditions"),
 354             IndependantBranches         => C4::Context->preference("IndependantBranches"),
 355             IntranetNav                 => C4::Context->preference("IntranetNav"),
 356             IntranetmainUserblock       => C4::Context->preference("IntranetmainUserblock"),
 357             LibraryName                 => C4::Context->preference("LibraryName"),
 358             LoginBranchname             => (C4::Context->userenv?C4::Context->userenv->{"branchname"}:"insecure"),
 359             advancedMARCEditor          => C4::Context->preference("advancedMARCEditor"),
 360             canreservefromotherbranches => C4::Context->preference('canreservefromotherbranches'),
 361             intranetcolorstylesheet     => C4::Context->preference("intranetcolorstylesheet"),
 362             intranetreadinghistory      => C4::Context->preference("intranetreadinghistory"),
 363             intranetstylesheet          => C4::Context->preference("intranetstylesheet"),
 364             IntranetUserCSS             => C4::Context->preference("IntranetUserCSS"),
 365             intranetuserjs              => C4::Context->preference("intranetuserjs"),
 366             intranetbookbag             => C4::Context->preference("intranetbookbag"),
 367             suggestion                  => C4::Context->preference("suggestion"),
 368             virtualshelves              => C4::Context->preference("virtualshelves"),
 369             StaffSerialIssueDisplayCount => C4::Context->preference("StaffSerialIssueDisplayCount"),
 370             NoZebra                     => C4::Context->preference('NoZebra'),
 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         # variables passed from CGI: opac_css_override and opac_search_limits.
 380         my $opac_search_limit = $ENV{'OPAC_SEARCH_LIMIT'};
 381         my $opac_limit_override = $ENV{'OPAC_LIMIT_OVERRIDE'};
 382         my $opac_name = '';
 383         if (($opac_search_limit =~ /branch:(\w+)/ && $opac_limit_override) || $in->{'query'}->param('limit') =~ /branch:(\w+)/){
 384             $opac_name = $1;   # opac_search_limit is a branch, so we use it.
 385         } elsif (C4::Context->preference("SearchMyLibraryFirst") && C4::Context->userenv && C4::Context->userenv->{'branch'}) {
 386             $opac_name = C4::Context->userenv->{'branch'};
 387         }
 388         my $checkstyle = C4::Context->preference("opaccolorstylesheet");
 389         if ($checkstyle =~ /http/)
 390         {
 391                 $template->param( opacexternalsheet => $checkstyle);
 392         } else
 393         {
 394                 my $opaccolorstylesheet = C4::Context->preference("opaccolorstylesheet");
 395             $template->param( opaccolorstylesheet => $opaccolorstylesheet);
 396         }
 397         $template->param(
 398             AmazonContent             => "" . C4::Context->preference("AmazonContent"),
 399             AnonSuggestions           => "" . C4::Context->preference("AnonSuggestions"),
 400             AuthorisedValueImages     => C4::Context->preference("AuthorisedValueImages"),
 401             BranchesLoop              => GetBranchesLoop($opac_name),
 402             LibraryName               => "" . C4::Context->preference("LibraryName"),
 403             LibraryNameTitle          => "" . $LibraryNameTitle,
 404             LoginBranchname           => C4::Context->userenv?C4::Context->userenv->{"branchname"}:"",
 405             OPACAmazonEnabled         => C4::Context->preference("OPACAmazonEnabled"),
 406             OPACAmazonSimilarItems    => C4::Context->preference("OPACAmazonSimilarItems"),
 407             OPACAmazonCoverImages     => C4::Context->preference("OPACAmazonCoverImages"),
 408             OPACAmazonReviews         => C4::Context->preference("OPACAmazonReviews"),
 409             OPACFRBRizeEditions       => C4::Context->preference("OPACFRBRizeEditions"),
 410             OpacHighlightedWords       => C4::Context->preference("OpacHighlightedWords"),
 411             OPACItemHolds             => C4::Context->preference("OPACItemHolds"),
 412             OPACShelfBrowser          => "". C4::Context->preference("OPACShelfBrowser"),
 413             OPACURLOpenInNewWindow    => "" . C4::Context->preference("OPACURLOpenInNewWindow"),
 414             OPACUserCSS               => "". C4::Context->preference("OPACUserCSS"),
 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             OpacMainUserBlock         => "" . C4::Context->preference("OpacMainUserBlock"),
 425             OpacNav                   => "" . C4::Context->preference("OpacNav"),
 426             OpacPasswordChange        => C4::Context->preference("OpacPasswordChange"),
 427             OPACPatronDetails        => C4::Context->preference("OPACPatronDetails"),
 428             OPACPrivacy               => C4::Context->preference("OPACPrivacy"),
 429             OPACFinesTab              => C4::Context->preference("OPACFinesTab"),
 430             OpacTopissue              => C4::Context->preference("OpacTopissue"),
 431             RequestOnOpac             => C4::Context->preference("RequestOnOpac"),
 432             'Version'                 => C4::Context->preference('Version'),
 433             hidelostitems             => C4::Context->preference("hidelostitems"),
 434             mylibraryfirst            => (C4::Context->preference("SearchMyLibraryFirst") && C4::Context->userenv) ? C4::Context->userenv->{'branch'} : '',
 435             opaclayoutstylesheet      => "" . C4::Context->preference("opaclayoutstylesheet"),
 436             opacstylesheet            => "" . C4::Context->preference("opacstylesheet"),
 437             opacbookbag               => "" . C4::Context->preference("opacbookbag"),
 438             opaccredits               => "" . C4::Context->preference("opaccredits"),
 439             opacheader                => "" . C4::Context->preference("opacheader"),
 440             opaclanguagesdisplay      => "" . C4::Context->preference("opaclanguagesdisplay"),
 441             opacreadinghistory        => C4::Context->preference("opacreadinghistory"),
 442             opacsmallimage            => "" . C4::Context->preference("opacsmallimage"),
 443             opacuserjs                => C4::Context->preference("opacuserjs"),
 444             opacuserlogin             => "" . C4::Context->preference("opacuserlogin"),
 445             reviewson                 => C4::Context->preference("reviewson"),
 446             suggestion                => "" . C4::Context->preference("suggestion"),
 447             virtualshelves            => "" . C4::Context->preference("virtualshelves"),
 448             OPACSerialIssueDisplayCount => C4::Context->preference("OPACSerialIssueDisplayCount"),
 449             OpacAddMastheadLibraryPulldown => C4::Context->preference("OpacAddMastheadLibraryPulldown"),
 450             OPACXSLTDetailsDisplay           => C4::Context->preference("OPACXSLTDetailsDisplay"),
 451             OPACXSLTResultsDisplay           => C4::Context->preference("OPACXSLTResultsDisplay"),
 452             SyndeticsClientCode          => C4::Context->preference("SyndeticsClientCode"),
 453             SyndeticsEnabled             => C4::Context->preference("SyndeticsEnabled"),
 454             SyndeticsCoverImages         => C4::Context->preference("SyndeticsCoverImages"),
 455             SyndeticsTOC                 => C4::Context->preference("SyndeticsTOC"),
 456             SyndeticsSummary             => C4::Context->preference("SyndeticsSummary"),
 457             SyndeticsEditions            => C4::Context->preference("SyndeticsEditions"),
 458             SyndeticsExcerpt             => C4::Context->preference("SyndeticsExcerpt"),
 459             SyndeticsReviews             => C4::Context->preference("SyndeticsReviews"),
 460             SyndeticsAuthorNotes         => C4::Context->preference("SyndeticsAuthorNotes"),
 461             SyndeticsAwards              => C4::Context->preference("SyndeticsAwards"),
 462             SyndeticsSeries              => C4::Context->preference("SyndeticsSeries"),
 463             SyndeticsCoverImageSize      => C4::Context->preference("SyndeticsCoverImageSize"),
 464         );
 465
 466         $template->param(OpacPublic => '1') if ($template->param( 'loggedinusername') || C4::Context->preference("OpacPublic"));
 467     }
 468         $template->param(listloop=>[{shelfname=>"Freelist", shelfnumber=>110}]);
 469     return ( $template, $borrowernumber, $cookie, $flags);
 470 }
 471
 472 =head2 checkauth
 473
 474   ($userid, $cookie, $sessionID) = &checkauth($query, $noauth, $flagsrequired, $type);
 475
 476 Verifies that the user is authorized to run this script.  If
 477 the user is authorized, a (userid, cookie, session-id, flags)
 478 quadruple is returned.  If the user is not authorized but does
 479 not have the required privilege (see $flagsrequired below), it
 480 displays an error page and exits.  Otherwise, it displays the
 481 login page and exits.
 482
 483 Note that C<&checkauth> will return if and only if the user
 484 is authorized, so it should be called early on, before any
 485 unfinished operations (e.g., if you've opened a file, then
 486 C<&checkauth> won't close it for you).
 487
 488 C<$query> is the CGI object for the script calling C<&checkauth>.
 489
 490 The C<$noauth> argument is optional. If it is set, then no
 491 authorization is required for the script.
 492
 493 C<&checkauth> fetches user and session information from C<$query> and
 494 ensures that the user is authorized to run scripts that require
 495 authorization.
 496
 497 The C<$flagsrequired> argument specifies the required privileges
 498 the user must have if the username and password are correct.
 499 It should be specified as a reference-to-hash; keys in the hash
 500 should be the "flags" for the user, as specified in the Members
 501 intranet module. Any key specified must correspond to a "flag"
 502 in the userflags table. E.g., { circulate => 1 } would specify
 503 that the user must have the "circulate" privilege in order to
 504 proceed. To make sure that access control is correct, the
 505 C<$flagsrequired> parameter must be specified correctly.
 506
 507 Koha also has a concept of sub-permissions, also known as
 508 granular permissions.  This makes the value of each key
 509 in the C<flagsrequired> hash take on an additional
 510 meaning, i.e.,
 511
 512  1
 513
 514 The user must have access to all subfunctions of the module
 515 specified by the hash key.
 516
 517  *
 518
 519 The user must have access to at least one subfunction of the module
 520 specified by the hash key.
 521
 522  specific permission, e.g., 'export_catalog'
 523
 524 The user must have access to the specific subfunction list, which
 525 must correspond to a row in the permissions table.
 526
 527 The C<$type> argument specifies whether the template should be
 528 retrieved from the opac or intranet directory tree.  "opac" is
 529 assumed if it is not specified; however, if C<$type> is specified,
 530 "intranet" is assumed if it is not "opac".
 531
 532 If C<$query> does not have a valid session ID associated with it
 533 (i.e., the user has not logged in) or if the session has expired,
 534 C<&checkauth> presents the user with a login page (from the point of
 535 view of the original script, C<&checkauth> does not return). Once the
 536 user has authenticated, C<&checkauth> restarts the original script
 537 (this time, C<&checkauth> returns).
 538
 539 The login page is provided using a HTML::Template, which is set in the
 540 systempreferences table or at the top of this file. The variable C<$type>
 541 selects which template to use, either the opac or the intranet
 542 authentification template.
 543
 544 C<&checkauth> returns a user ID, a cookie, and a session ID. The
 545 cookie should be sent back to the browser; it verifies that the user
 546 has authenticated.
 547
 548 =cut
 549
 550 sub _version_check ($$) {
 551     my $type = shift;
 552     my $query = shift;
 553     my $version;
 554     # If Version syspref is unavailable, it means Koha is beeing installed,
 555     # and so we must redirect to OPAC maintenance page or to the WebInstaller
 556         # also, if OpacMaintenance is ON, OPAC should redirect to maintenance
 557         if (C4::Context->preference('OpacMaintenance') && $type eq 'opac') {
 558                 warn "OPAC Install required, redirecting to maintenance";
 559                 print $query->redirect("/cgi-bin/koha/maintenance.pl");
 560         }
 561     unless ($version = C4::Context->preference('Version')) {    # assignment, not comparison
 562       if ($type ne 'opac') {
 563         warn "Install required, redirecting to Installer";
 564         print $query->redirect("/cgi-bin/koha/installer/install.pl");
 565       }
 566       else {
 567         warn "OPAC Install required, redirecting to maintenance";
 568         print $query->redirect("/cgi-bin/koha/maintenance.pl");
 569       }
 570       exit;
 571     }
 572
 573     # check that database and koha version are the same
 574     # there is no DB version, it's a fresh install,
 575     # go to web installer
 576     # there is a DB version, compare it to the code version
 577     my $kohaversion=C4::Context::KOHAVERSION;
 578     # remove the 3 last . to have a Perl number
 579     $kohaversion =~ s/(.*\..*)\.(.*)\.(.*)/$1$2$3/;
 580     $debug and print STDERR "kohaversion : $kohaversion\n";
 581     if ($version < $kohaversion){
 582         my $warning = "Database update needed, redirecting to %s. Database is $version and Koha is $kohaversion";
 583         if ($type ne 'opac'){
 584             warn sprintf($warning, 'Installer');
 585             print $query->redirect("/cgi-bin/koha/installer/install.pl?step=3");
 586         } else {
 587             warn sprintf("OPAC: " . $warning, 'maintenance');
 588             print $query->redirect("/cgi-bin/koha/maintenance.pl");
 589         }
 590         exit;
 591     }
 592 }
 593
 594 sub _session_log {
 595     (@_) or return 0;
 596     open L, ">>/tmp/sessionlog" or warn "ERROR: Cannot append to /tmp/sessionlog";
 597     printf L join("\n",@_);
 598     close L;
 599 }
 600
 601 sub checkauth {
 602     my $query = shift;
 603         $debug and warn "Checking Auth";
 604     # $authnotrequired will be set for scripts which will run without authentication
 605     my $authnotrequired = shift;
 606     my $flagsrequired   = shift;
 607     my $type            = shift;
 608     $type = 'opac' unless $type;
 609
 610     my $dbh     = C4::Context->dbh;
 611     my $timeout = C4::Context->preference('timeout');
 612     # days
 613     if ($timeout =~ /(\d+)[dD]/) {
 614         $timeout = $1 * 86400;
 615     };
 616     $timeout = 600 unless $timeout;
 617
 618     _version_check($type,$query);
 619     # state variables
 620     my $loggedin = 0;
 621     my %info;
 622     my ( $userid, $cookie, $sessionID, $flags, $barshelves, $pubshelves );
 623     my $logout = $query->param('logout.x');
 624
 625     if ( $userid = $ENV{'REMOTE_USER'} ) {
 626         # Using Basic Authentication, no cookies required
 627         $cookie = $query->cookie(
 628             -name    => 'CGISESSID',
 629             -value   => '',
 630             -expires => ''
 631         );
 632         $loggedin = 1;
 633     }
 634     elsif ( $sessionID = $query->cookie("CGISESSID")) {     # assignment, not comparison
 635         my $session = get_session($sessionID);
 636         C4::Context->_new_userenv($sessionID);
 637         my ($ip, $lasttime, $sessiontype);
 638         if ($session){
 639             C4::Context::set_userenv(
 640                 $session->param('number'),       $session->param('id'),
 641                 $session->param('cardnumber'),   $session->param('firstname'),
 642                 $session->param('surname'),      $session->param('branch'),
 643                 $session->param('branchname'),   $session->param('flags'),
 644                 $session->param('emailaddress'), $session->param('branchprinter')
 645             );
 646             C4::Context::set_shelves_userenv('bar',$session->param('barshelves'));
 647             C4::Context::set_shelves_userenv('pub',$session->param('pubshelves'));
 648             C4::Context::set_shelves_userenv('tot',$session->param('totshelves'));
 649             $debug and printf STDERR "AUTH_SESSION: (%s)\t%s %s - %s\n", map {$session->param($_)} qw(cardnumber firstname surname branch) ;
 650             $ip       = $session->param('ip');
 651             $lasttime = $session->param('lasttime');
 652             $userid   = $session->param('id');
 653                         $sessiontype = $session->param('sessiontype');
 654         }
 655         if ( ($query->param('koha_login_context')) && ($query->param('userid') ne $session->param('id')) ) {
 656             #if a user enters an id ne to the id in the current session, we need to log them in...
 657             #first we need to clear the anonymous session...
 658             $debug and warn "query id = " . $query->param('userid') . " but session id = " . $session->param('id');
 659             $session->flush;
 660             $session->delete();
 661             C4::Context->_unset_userenv($sessionID);
 662                         $sessionID = undef;
 663                         $userid = undef;
 664                 }
 665         elsif ($logout) {
 666             # voluntary logout the user
 667             $session->flush;
 668             $session->delete();
 669             C4::Context->_unset_userenv($sessionID);
 670             _session_log(sprintf "%20s from %16s logged out at %30s (manually).\n", $userid,$ip,(strftime "%c",localtime));
 671             $sessionID = undef;
 672             $userid    = undef;
 673
 674             if ($cas and $caslogout) {
 675                 logout_cas($query);
 676             }
 677         }
 678         elsif ( $lasttime < time() - $timeout ) {
 679             # timed logout
 680             $info{'timed_out'} = 1;
 681             $session->delete();
 682             C4::Context->_unset_userenv($sessionID);
 683             _session_log(sprintf "%20s from %16s logged out at %30s (inactivity).\n", $userid,$ip,(strftime "%c",localtime));
 684             $userid    = undef;
 685             $sessionID = undef;
 686         }
 687         elsif ( $ip ne $ENV{'REMOTE_ADDR'} ) {
 688             # Different ip than originally logged in from
 689             $info{'oldip'}        = $ip;
 690             $info{'newip'}        = $ENV{'REMOTE_ADDR'};
 691             $info{'different_ip'} = 1;
 692             $session->delete();
 693             C4::Context->_unset_userenv($sessionID);
 694             _session_log(sprintf "%20s from %16s logged out at %30s (ip changed to %16s).\n", $userid,$ip,(strftime "%c",localtime), $info{'newip'});
 695             $sessionID = undef;
 696             $userid    = undef;
 697         }
 698         else {
 699             $cookie = $query->cookie( CGISESSID => $session->id );
 700             $session->param('lasttime',time());
 701             unless ( $sessiontype eq 'anon' ) { #if this is an anonymous session, we want to update the session, but not behave as if they are logged in...
 702                 $flags = haspermission($userid, $flagsrequired);
 703                 if ($flags) {
 704                     $loggedin = 1;
 705                 } else {
 706                     $info{'nopermission'} = 1;
 707                 }
 708             }
 709         }
 710     }
 711     unless ($userid || $sessionID) {
 712         #we initiate a session prior to checking for a username to allow for anonymous sessions...
 713                 my $session = get_session("") or die "Auth ERROR: Cannot get_session()";
 714         my $sessionID = $session->id;
 715         C4::Context->_new_userenv($sessionID);
 716         $cookie = $query->cookie(CGISESSID => $sessionID);
 717             $userid    = $query->param('userid');
 718             if ($cas || $userid) {
 719                 my $password = $query->param('password');
 720                 my ($return, $cardnumber);
 721                 if ($cas && $query->param('ticket')) {
 722                     my $retuserid;
 723                     ( $return, $cardnumber, $retuserid ) = checkpw( $dbh, $userid, $password, $query );
 724                     $userid = $retuserid;
 725                     $info{'invalidCasLogin'} = 1 unless ($return);
 726                 } else {
 727                     ( $return, $cardnumber ) = checkpw( $dbh, $userid, $password, $query );
 728                 }
 729                 if ($return) {
 730                _session_log(sprintf "%20s from %16s logged in  at %30s.\n", $userid,$ENV{'REMOTE_ADDR'},(strftime '%c', localtime));
 731                 if ( $flags = haspermission(  $userid, $flagsrequired ) ) {
 732                                         $loggedin = 1;
 733                 }
 734                         else {
 735                         $info{'nopermission'} = 1;
 736                         C4::Context->_unset_userenv($sessionID);
 737                 }
 738
 739                                 my ($borrowernumber, $firstname, $surname, $userflags,
 740                                         $branchcode, $branchname, $branchprinter, $emailaddress);
 741
 742                 if ( $return == 1 ) {
 743                         my $select = "
 744                         SELECT borrowernumber, firstname, surname, flags, borrowers.branchcode,
 745                             branches.branchname    as branchname,
 746                                 branches.branchprinter as branchprinter,
 747                                 email
 748                         FROM borrowers
 749                         LEFT JOIN branches on borrowers.branchcode=branches.branchcode
 750                         ";
 751                         my $sth = $dbh->prepare("$select where userid=?");
 752                         $sth->execute($userid);
 753                                         unless ($sth->rows) {
 754                                 $debug and print STDERR "AUTH_1: no rows for userid='$userid'\n";
 755                                                 $sth = $dbh->prepare("$select where cardnumber=?");
 756                                 $sth->execute($cardnumber);
 757                                                 unless ($sth->rows) {
 758                                         $debug and print STDERR "AUTH_2a: no rows for cardnumber='$cardnumber'\n";
 759                                 $sth->execute($userid);
 760                                                         unless ($sth->rows) {
 761                                                 $debug and print STDERR "AUTH_2b: no rows for userid='$userid' AS cardnumber\n";
 762                                                         }
 763                                                 }
 764                                         }
 765                         if ($sth->rows) {
 766                         ($borrowernumber, $firstname, $surname, $userflags,
 767                                 $branchcode, $branchname, $branchprinter, $emailaddress) = $sth->fetchrow;
 768                                                 $debug and print STDERR "AUTH_3 results: " .
 769                                                         "$cardnumber,$borrowernumber,$userid,$firstname,$surname,$userflags,$branchcode,$emailaddress\n";
 770                                         } else {
 771                                                 print STDERR "AUTH_3: no results for userid='$userid', cardnumber='$cardnumber'.\n";
 772                                         }
 773
 774 # launch a sequence to check if we have a ip for the branch, i
 775 # if we have one we replace the branchcode of the userenv by the branch bound in the ip.
 776
 777                                         my $ip       = $ENV{'REMOTE_ADDR'};
 778                                         # if they specify at login, use that
 779                                         if ($query->param('branch')) {
 780                                                 $branchcode  = $query->param('branch');
 781                                                 $branchname = GetBranchName($branchcode);
 782                                         }
 783                                         my $branches = GetBranches();
 784                                         if (C4::Context->boolean_preference('IndependantBranches') && C4::Context->boolean_preference('Autolocation')){
 785                                                 # we have to check they are coming from the right ip range
 786                                                 my $domain = $branches->{$branchcode}->{'branchip'};
 787                                                 if ($ip !~ /^$domain/){
 788                                                         $loggedin=0;
 789                                                         $info{'wrongip'} = 1;
 790                                                 }
 791                                         }
 792
 793                                         my @branchesloop;
 794                                         foreach my $br ( keys %$branches ) {
 795                                                 #     now we work with the treatment of ip
 796                                                 my $domain = $branches->{$br}->{'branchip'};
 797                                                 if ( $domain && $ip =~ /^$domain/ ) {
 798                                                         $branchcode = $branches->{$br}->{'branchcode'};
 799
 800                                                         # new op dev : add the branchprinter and branchname in the cookie
 801                                                         $branchprinter = $branches->{$br}->{'branchprinter'};
 802                                                         $branchname    = $branches->{$br}->{'branchname'};
 803                                                 }
 804                                         }
 805                                         $session->param('number',$borrowernumber);
 806                                         $session->param('id',$userid);
 807                                         $session->param('cardnumber',$cardnumber);
 808                                         $session->param('firstname',$firstname);
 809                                         $session->param('surname',$surname);
 810                                         $session->param('branch',$branchcode);
 811                                         $session->param('branchname',$branchname);
 812                                         $session->param('flags',$userflags);
 813                                         $session->param('emailaddress',$emailaddress);
 814                                         $session->param('ip',$session->remote_addr());
 815                                         $session->param('lasttime',time());
 816                                         $debug and printf STDERR "AUTH_4: (%s)\t%s %s - %s\n", map {$session->param($_)} qw(cardnumber firstname surname branch) ;
 817                                 }
 818                                 elsif ( $return == 2 ) {
 819                                         #We suppose the user is the superlibrarian
 820                                         $borrowernumber = 0;
 821                                         $session->param('number',0);
 822                                         $session->param('id',C4::Context->config('user'));
 823                                         $session->param('cardnumber',C4::Context->config('user'));
 824                                         $session->param('firstname',C4::Context->config('user'));
 825                                         $session->param('surname',C4::Context->config('user'));
 826                                         $session->param('branch','NO_LIBRARY_SET');
 827                                         $session->param('branchname','NO_LIBRARY_SET');
 828                                         $session->param('flags',1);
 829                                         $session->param('emailaddress', C4::Context->preference('KohaAdminEmailAddress'));
 830                                         $session->param('ip',$session->remote_addr());
 831                                         $session->param('lasttime',time());
 832                                 }
 833                                 C4::Context::set_userenv(
 834                                         $session->param('number'),       $session->param('id'),
 835                                         $session->param('cardnumber'),   $session->param('firstname'),
 836                                         $session->param('surname'),      $session->param('branch'),
 837                                         $session->param('branchname'),   $session->param('flags'),
 838                                         $session->param('emailaddress'), $session->param('branchprinter')
 839                                 );
 840
 841                                 # Grab borrower's shelves and public shelves and add them to the session
 842                                 # $row_count determines how many records are returned from the db query
 843                                 # and the number of lists to be displayed of each type in the 'Lists' button drop down
 844                                 my $row_count = 10; # FIXME:This probably should be a syspref
 845                                 my ($total, $totshelves, $barshelves, $pubshelves);
 846                                 ($barshelves, $totshelves) = C4::VirtualShelves::GetRecentShelves(1, $row_count, $borrowernumber);
 847                                 $total->{'bartotal'} = $totshelves;
 848                                 ($pubshelves, $totshelves) = C4::VirtualShelves::GetRecentShelves(2, $row_count, undef);
 849                                 $total->{'pubtotal'} = $totshelves;
 850                                 $session->param('barshelves', $barshelves->[0]);
 851                                 $session->param('pubshelves', $pubshelves->[0]);
 852                                 $session->param('totshelves', $total);
 853
 854                                 C4::Context::set_shelves_userenv('bar',$barshelves->[0]);
 855                                 C4::Context::set_shelves_userenv('pub',$pubshelves->[0]);
 856                                 C4::Context::set_shelves_userenv('tot',$total);
 857                         }
 858                 else {
 859                 if ($userid) {
 860                         $info{'invalid_username_or_password'} = 1;
 861                         C4::Context->_unset_userenv($sessionID);
 862                 }
 863                         }
 864         }       # END if ( $userid    = $query->param('userid') )
 865                 elsif ($type eq "opac") {
 866             # if we are here this is an anonymous session; add public lists to it and a few other items...
 867             # anonymous sessions are created only for the OPAC
 868                         $debug and warn "Initiating an anonymous session...";
 869
 870                         # Grab the public shelves and add to the session...
 871                         my $row_count = 20; # FIXME:This probably should be a syspref
 872                         my ($total, $totshelves, $pubshelves);
 873                         ($pubshelves, $totshelves) = C4::VirtualShelves::GetRecentShelves(2, $row_count, undef);
 874                         $total->{'pubtotal'} = $totshelves;
 875                         $session->param('pubshelves', $pubshelves->[0]);
 876                         $session->param('totshelves', $total);
 877                         C4::Context::set_shelves_userenv('pub',$pubshelves->[0]);
 878                         C4::Context::set_shelves_userenv('tot',$total);
 879
 880                         # setting a couple of other session vars...
 881                         $session->param('ip',$session->remote_addr());
 882                         $session->param('lasttime',time());
 883                         $session->param('sessiontype','anon');
 884                 }
 885     }   # END unless ($userid)
 886     my $insecure = C4::Context->boolean_preference('insecure');
 887
 888     # finished authentification, now respond
 889     if ( $loggedin || $authnotrequired || ( defined($insecure) && $insecure ) )
 890     {
 891         # successful login
 892         unless ($cookie) {
 893             $cookie = $query->cookie( CGISESSID => '' );
 894         }
 895         return ( $userid, $cookie, $sessionID, $flags );
 896     }
 897
 898 #
 899 #
 900 # AUTH rejected, show the login/password template, after checking the DB.
 901 #
 902 #
 903
 904     # get the inputs from the incoming query
 905     my @inputs = ();
 906     foreach my $name ( param $query) {
 907         (next) if ( $name eq 'userid' || $name eq 'password' || $name eq 'ticket' );
 908         my $value = $query->param($name);
 909         push @inputs, { name => $name, value => $value };
 910     }
 911     # get the branchloop, which we need for authentication
 912     my $branches = GetBranches();
 913     my @branch_loop;
 914     for my $branch_hash (sort keys %$branches) {
 915                 push @branch_loop, {branchcode => "$branch_hash", branchname => $branches->{$branch_hash}->{'branchname'}, };
 916     }
 917
 918     my $template_name = ( $type eq 'opac' ) ? 'opac-auth.tmpl' : 'auth.tmpl';
 919     my $template = gettemplate( $template_name, $type, $query );
 920     $template->param(branchloop => \@branch_loop,);
 921     my $checkstyle = C4::Context->preference("opaccolorstylesheet");
 922     if ($checkstyle =~ /\//)
 923         {
 924                 $template->param( opacexternalsheet => $checkstyle);
 925         } else
 926         {
 927                 my $opaccolorstylesheet = C4::Context->preference("opaccolorstylesheet");
 928             $template->param( opaccolorstylesheet => $opaccolorstylesheet);
 929         }
 930     $template->param(
 931     login        => 1,
 932         INPUTS               => \@inputs,
 933         casAuthentication    => C4::Context->preference("casAuthentication"),
 934         suggestion           => C4::Context->preference("suggestion"),
 935         virtualshelves       => C4::Context->preference("virtualshelves"),
 936         LibraryName          => C4::Context->preference("LibraryName"),
 937         opacuserlogin        => C4::Context->preference("opacuserlogin"),
 938         OpacNav              => C4::Context->preference("OpacNav"),
 939         opaccredits          => C4::Context->preference("opaccredits"),
 940         opacreadinghistory   => C4::Context->preference("opacreadinghistory"),
 941         opacsmallimage       => C4::Context->preference("opacsmallimage"),
 942         opaclayoutstylesheet => C4::Context->preference("opaclayoutstylesheet"),
 943         opaclanguagesdisplay => C4::Context->preference("opaclanguagesdisplay"),
 944         opacuserjs           => C4::Context->preference("opacuserjs"),
 945         opacbookbag          => "" . C4::Context->preference("opacbookbag"),
 946         OpacCloud            => C4::Context->preference("OpacCloud"),
 947         OpacTopissue         => C4::Context->preference("OpacTopissue"),
 948         OpacAuthorities      => C4::Context->preference("OpacAuthorities"),
 949         OpacBrowser          => C4::Context->preference("OpacBrowser"),
 950         opacheader           => C4::Context->preference("opacheader"),
 951         TagsEnabled                  => C4::Context->preference("TagsEnabled"),
 952         OPACUserCSS           => C4::Context->preference("OPACUserCSS"),
 953         intranetcolorstylesheet =>
 954                                                                 C4::Context->preference("intranetcolorstylesheet"),
 955         intranetstylesheet => C4::Context->preference("intranetstylesheet"),
 956         intranetbookbag    => C4::Context->preference("intranetbookbag"),
 957         IntranetNav        => C4::Context->preference("IntranetNav"),
 958         intranetuserjs     => C4::Context->preference("intranetuserjs"),
 959         IndependantBranches=> C4::Context->preference("IndependantBranches"),
 960         AutoLocation       => C4::Context->preference("AutoLocation"),
 961                 wrongip            => $info{'wrongip'},
 962     );
 963
 964     $template->param( OpacPublic => C4::Context->preference("OpacPublic"));
 965     $template->param( loginprompt => 1 ) unless $info{'nopermission'};
 966
 967     if ($cas) {
 968         $template->param(
 969             casServerUrl    => login_cas_url(),
 970             invalidCasLogin => $info{'invalidCasLogin'}
 971         );
 972     }
 973
 974     my $self_url = $query->url( -absolute => 1 );
 975     $template->param(
 976         url         => $self_url,
 977         LibraryName => C4::Context->preference("LibraryName"),
 978     );
 979     $template->param( \%info );
 980 #    $cookie = $query->cookie(CGISESSID => $session->id
 981 #   );
 982     print $query->header(
 983         -type   => 'text/html',
 984         -charset => 'utf-8',
 985         -cookie => $cookie
 986       ),
 987       $template->output;
 988     exit;
 989 }
 990
 991 =head2 check_api_auth
 992
 993   ($status, $cookie, $sessionId) = check_api_auth($query, $userflags);
 994
 995 Given a CGI query containing the parameters 'userid' and 'password' and/or a session
 996 cookie, determine if the user has the privileges specified by C<$userflags>.
 997
 998 C<check_api_auth> is is meant for authenticating users of web services, and
 999 consequently will always return and will not attempt to redirect the user
1000 agent.
1001
1002 If a valid session cookie is already present, check_api_auth will return a status
1003 of "ok", the cookie, and the Koha session ID.
1004
1005 If no session cookie is present, check_api_auth will check the 'userid' and 'password
1006 parameters and create a session cookie and Koha session if the supplied credentials
1007 are OK.
1008
1009 Possible return values in C<$status> are:
1010
1011 =over
1012
1013 =item "ok" -- user authenticated; C<$cookie> and C<$sessionid> have valid values.
1014
1015 =item "failed" -- credentials are not correct; C<$cookie> and C<$sessionid> are undef
1016
1017 =item "maintenance" -- DB is in maintenance mode; no login possible at the moment
1018
1019 =item "expired -- session cookie has expired; API user should resubmit userid and password
1020
1021 =back
1022
1023 =cut
1024
1025 sub check_api_auth {
1026     my $query = shift;
1027     my $flagsrequired = shift;
1028
1029     my $dbh     = C4::Context->dbh;
1030     my $timeout = C4::Context->preference('timeout');
1031     $timeout = 600 unless $timeout;
1032
1033     unless (C4::Context->preference('Version')) {
1034         # database has not been installed yet
1035         return ("maintenance", undef, undef);
1036     }
1037     my $kohaversion=C4::Context::KOHAVERSION;
1038     $kohaversion =~ s/(.*\..*)\.(.*)\.(.*)/$1$2$3/;
1039     if (C4::Context->preference('Version') < $kohaversion) {
1040         # database in need of version update; assume that
1041         # no API should be called while databsae is in
1042         # this condition.
1043         return ("maintenance", undef, undef);
1044     }
1045
1046     # FIXME -- most of what follows is a copy-and-paste
1047     # of code from checkauth.  There is an obvious need
1048     # for refactoring to separate the various parts of
1049     # the authentication code, but as of 2007-11-19 this
1050     # is deferred so as to not introduce bugs into the
1051     # regular authentication code for Koha 3.0.
1052
1053     # see if we have a valid session cookie already
1054     # however, if a userid parameter is present (i.e., from
1055     # a form submission, assume that any current cookie
1056     # is to be ignored
1057     my $sessionID = undef;
1058     unless ($query->param('userid')) {
1059         $sessionID = $query->cookie("CGISESSID");
1060     }
1061     if ($sessionID) {
1062         my $session = get_session($sessionID);
1063         C4::Context->_new_userenv($sessionID);
1064         if ($session) {
1065             C4::Context::set_userenv(
1066                 $session->param('number'),       $session->param('id'),
1067                 $session->param('cardnumber'),   $session->param('firstname'),
1068                 $session->param('surname'),      $session->param('branch'),
1069                 $session->param('branchname'),   $session->param('flags'),
1070                 $session->param('emailaddress'), $session->param('branchprinter')
1071             );
1072
1073             my $ip = $session->param('ip');
1074             my $lasttime = $session->param('lasttime');
1075             my $userid = $session->param('id');
1076             if ( $lasttime < time() - $timeout ) {
1077                 # time out
1078                 $session->delete();
1079                 C4::Context->_unset_userenv($sessionID);
1080                 $userid    = undef;
1081                 $sessionID = undef;
1082                 return ("expired", undef, undef);
1083             } elsif ( $ip ne $ENV{'REMOTE_ADDR'} ) {
1084                 # IP address changed
1085                 $session->delete();
1086                 C4::Context->_unset_userenv($sessionID);
1087                 $userid    = undef;
1088                 $sessionID = undef;
1089                 return ("expired", undef, undef);
1090             } else {
1091                 my $cookie = $query->cookie( CGISESSID => $session->id );
1092                 $session->param('lasttime',time());
1093                 my $flags = haspermission($userid, $flagsrequired);
1094                 if ($flags) {
1095                     return ("ok", $cookie, $sessionID);
1096                 } else {
1097                     $session->delete();
1098                     C4::Context->_unset_userenv($sessionID);
1099                     $userid    = undef;
1100                     $sessionID = undef;
1101                     return ("failed", undef, undef);
1102                 }
1103             }
1104         } else {
1105             return ("expired", undef, undef);
1106         }
1107     } else {
1108         # new login
1109         my $userid = $query->param('userid');
1110         my $password = $query->param('password');
1111         unless ($userid and $password) {
1112             # caller did something wrong, fail the authenticateion
1113             return ("failed", undef, undef);
1114         }
1115         my ($return, $cardnumber);
1116         if ($cas && $query->param('ticket')) {
1117             my $retuserid;
1118             ( $return, $cardnumber, $retuserid ) = checkpw( $dbh, $userid, $password, $query );
1119             $userid = $retuserid;
1120         } else {
1121             ( $return, $cardnumber ) = checkpw( $dbh, $userid, $password, $query );
1122         }
1123         if ($return and haspermission(  $userid, $flagsrequired)) {
1124             my $session = get_session("");
1125             return ("failed", undef, undef) unless $session;
1126
1127             my $sessionID = $session->id;
1128             C4::Context->_new_userenv($sessionID);
1129             my $cookie = $query->cookie(CGISESSID => $sessionID);
1130             if ( $return == 1 ) {
1131                 my (
1132                     $borrowernumber, $firstname,  $surname,
1133                     $userflags,      $branchcode, $branchname,
1134                     $branchprinter,  $emailaddress
1135                 );
1136                 my $sth =
1137                   $dbh->prepare(
1138 "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=?"
1139                   );
1140                 $sth->execute($userid);
1141                 (
1142                     $borrowernumber, $firstname,  $surname,
1143                     $userflags,      $branchcode, $branchname,
1144                     $branchprinter,  $emailaddress
1145                 ) = $sth->fetchrow if ( $sth->rows );
1146
1147                 unless ($sth->rows ) {
1148                     my $sth = $dbh->prepare(
1149 "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=?"
1150                       );
1151                     $sth->execute($cardnumber);
1152                     (
1153                         $borrowernumber, $firstname,  $surname,
1154                         $userflags,      $branchcode, $branchname,
1155                         $branchprinter,  $emailaddress
1156                     ) = $sth->fetchrow if ( $sth->rows );
1157
1158                     unless ( $sth->rows ) {
1159                         $sth->execute($userid);
1160                         (
1161                             $borrowernumber, $firstname, $surname, $userflags,
1162                             $branchcode, $branchname, $branchprinter, $emailaddress
1163                         ) = $sth->fetchrow if ( $sth->rows );
1164                     }
1165                 }
1166
1167                 my $ip       = $ENV{'REMOTE_ADDR'};
1168                 # if they specify at login, use that
1169                 if ($query->param('branch')) {
1170                     $branchcode  = $query->param('branch');
1171                     $branchname = GetBranchName($branchcode);
1172                 }
1173                 my $branches = GetBranches();
1174                 my @branchesloop;
1175                 foreach my $br ( keys %$branches ) {
1176                     #     now we work with the treatment of ip
1177                     my $domain = $branches->{$br}->{'branchip'};
1178                     if ( $domain && $ip =~ /^$domain/ ) {
1179                         $branchcode = $branches->{$br}->{'branchcode'};
1180
1181                         # new op dev : add the branchprinter and branchname in the cookie
1182                         $branchprinter = $branches->{$br}->{'branchprinter'};
1183                         $branchname    = $branches->{$br}->{'branchname'};
1184                     }
1185                 }
1186                 $session->param('number',$borrowernumber);
1187                 $session->param('id',$userid);
1188                 $session->param('cardnumber',$cardnumber);
1189                 $session->param('firstname',$firstname);
1190                 $session->param('surname',$surname);
1191                 $session->param('branch',$branchcode);
1192                 $session->param('branchname',$branchname);
1193                 $session->param('flags',$userflags);
1194                 $session->param('emailaddress',$emailaddress);
1195                 $session->param('ip',$session->remote_addr());
1196                 $session->param('lasttime',time());
1197             } elsif ( $return == 2 ) {
1198                 #We suppose the user is the superlibrarian
1199                 $session->param('number',0);
1200                 $session->param('id',C4::Context->config('user'));
1201                 $session->param('cardnumber',C4::Context->config('user'));
1202                 $session->param('firstname',C4::Context->config('user'));
1203                 $session->param('surname',C4::Context->config('user'));
1204                 $session->param('branch','NO_LIBRARY_SET');
1205                 $session->param('branchname','NO_LIBRARY_SET');
1206                 $session->param('flags',1);
1207                 $session->param('emailaddress', C4::Context->preference('KohaAdminEmailAddress'));
1208                 $session->param('ip',$session->remote_addr());
1209                 $session->param('lasttime',time());
1210             }
1211             C4::Context::set_userenv(
1212                 $session->param('number'),       $session->param('id'),
1213                 $session->param('cardnumber'),   $session->param('firstname'),
1214                 $session->param('surname'),      $session->param('branch'),
1215                 $session->param('branchname'),   $session->param('flags'),
1216                 $session->param('emailaddress'), $session->param('branchprinter')
1217             );
1218             return ("ok", $cookie, $sessionID);
1219         } else {
1220             return ("failed", undef, undef);
1221         }
1222     }
1223 }
1224
1225 =head2 check_cookie_auth
1226
1227   ($status, $sessionId) = check_api_auth($cookie, $userflags);
1228
1229 Given a CGISESSID cookie set during a previous login to Koha, determine
1230 if the user has the privileges specified by C<$userflags>.
1231
1232 C<check_cookie_auth> is meant for authenticating special services
1233 such as tools/upload-file.pl that are invoked by other pages that
1234 have been authenticated in the usual way.
1235
1236 Possible return values in C<$status> are:
1237
1238 =over
1239
1240 =item "ok" -- user authenticated; C<$sessionID> have valid values.
1241
1242 =item "failed" -- credentials are not correct; C<$sessionid> are undef
1243
1244 =item "maintenance" -- DB is in maintenance mode; no login possible at the moment
1245
1246 =item "expired -- session cookie has expired; API user should resubmit userid and password
1247
1248 =back
1249
1250 =cut
1251
1252 sub check_cookie_auth {
1253     my $cookie = shift;
1254     my $flagsrequired = shift;
1255
1256     my $dbh     = C4::Context->dbh;
1257     my $timeout = C4::Context->preference('timeout');
1258     $timeout = 600 unless $timeout;
1259
1260     unless (C4::Context->preference('Version')) {
1261         # database has not been installed yet
1262         return ("maintenance", undef);
1263     }
1264     my $kohaversion=C4::Context::KOHAVERSION;
1265     $kohaversion =~ s/(.*\..*)\.(.*)\.(.*)/$1$2$3/;
1266     if (C4::Context->preference('Version') < $kohaversion) {
1267         # database in need of version update; assume that
1268         # no API should be called while databsae is in
1269         # this condition.
1270         return ("maintenance", undef);
1271     }
1272
1273     # FIXME -- most of what follows is a copy-and-paste
1274     # of code from checkauth.  There is an obvious need
1275     # for refactoring to separate the various parts of
1276     # the authentication code, but as of 2007-11-23 this
1277     # is deferred so as to not introduce bugs into the
1278     # regular authentication code for Koha 3.0.
1279
1280     # see if we have a valid session cookie already
1281     # however, if a userid parameter is present (i.e., from
1282     # a form submission, assume that any current cookie
1283     # is to be ignored
1284     unless (defined $cookie and $cookie) {
1285         return ("failed", undef);
1286     }
1287     my $sessionID = $cookie;
1288     my $session = get_session($sessionID);
1289     C4::Context->_new_userenv($sessionID);
1290     if ($session) {
1291         C4::Context::set_userenv(
1292             $session->param('number'),       $session->param('id'),
1293             $session->param('cardnumber'),   $session->param('firstname'),
1294             $session->param('surname'),      $session->param('branch'),
1295             $session->param('branchname'),   $session->param('flags'),
1296             $session->param('emailaddress'), $session->param('branchprinter')
1297         );
1298
1299         my $ip = $session->param('ip');
1300         my $lasttime = $session->param('lasttime');
1301         my $userid = $session->param('id');
1302         if ( $lasttime < time() - $timeout ) {
1303             # time out
1304             $session->delete();
1305             C4::Context->_unset_userenv($sessionID);
1306             $userid    = undef;
1307             $sessionID = undef;
1308             return ("expired", undef);
1309         } elsif ( $ip ne $ENV{'REMOTE_ADDR'} ) {
1310             # IP address changed
1311             $session->delete();
1312             C4::Context->_unset_userenv($sessionID);
1313             $userid    = undef;
1314             $sessionID = undef;
1315             return ("expired", undef);
1316         } else {
1317             $session->param('lasttime',time());
1318             my $flags = haspermission($userid, $flagsrequired);
1319             if ($flags) {
1320                 return ("ok", $sessionID);
1321             } else {
1322                 $session->delete();
1323                 C4::Context->_unset_userenv($sessionID);
1324                 $userid    = undef;
1325                 $sessionID = undef;
1326                 return ("failed", undef);
1327             }
1328         }
1329     } else {
1330         return ("expired", undef);
1331     }
1332 }
1333
1334 =head2 get_session
1335
1336   use CGI::Session;
1337   my $session = get_session($sessionID);
1338
1339 Given a session ID, retrieve the CGI::Session object used to store
1340 the session's state.  The session object can be used to store
1341 data that needs to be accessed by different scripts during a
1342 user's session.
1343
1344 If the C<$sessionID> parameter is an empty string, a new session
1345 will be created.
1346
1347 =cut
1348
1349 sub get_session {
1350     my $sessionID = shift;
1351     my $storage_method = C4::Context->preference('SessionStorage');
1352     my $dbh = C4::Context->dbh;
1353     my $session;
1354     if ($storage_method eq 'mysql'){
1355         $session = new CGI::Session("driver:MySQL;serializer:yaml;id:md5", $sessionID, {Handle=>$dbh});
1356     }
1357     elsif ($storage_method eq 'Pg') {
1358         $session = new CGI::Session("driver:PostgreSQL;serializer:yaml;id:md5", $sessionID, {Handle=>$dbh});
1359     }
1360     else {
1361         # catch all defaults to tmp should work on all systems
1362         $session = new CGI::Session("driver:File;serializer:yaml;id:md5", $sessionID, {Directory=>'/tmp'});
1363     }
1364     return $session;
1365 }
1366
1367 sub checkpw {
1368
1369     my ( $dbh, $userid, $password, $query ) = @_;
1370     if ($ldap) {
1371         $debug and print "## checkpw - checking LDAP\n";
1372         my ($retval,$retcard) = checkpw_ldap(@_);    # EXTERNAL AUTH
1373         ($retval) and return ($retval,$retcard);
1374     }
1375
1376     if ($cas && $query->param('ticket')) {
1377         $debug and print STDERR "## checkpw - checking CAS\n";
1378         # In case of a CAS authentication, we use the ticket instead of the password
1379         my $ticket = $query->param('ticket');
1380         my ($retval,$retcard,$retuserid) = checkpw_cas($dbh, $ticket, $query);    # EXTERNAL AUTH
1381         ($retval) and return ($retval,$retcard,$retuserid);
1382         return 0;
1383     }
1384
1385     # INTERNAL AUTH
1386     my $sth =
1387       $dbh->prepare(
1388 "select password,cardnumber,borrowernumber,userid,firstname,surname,branchcode,flags from borrowers where userid=?"
1389       );
1390     $sth->execute($userid);
1391     if ( $sth->rows ) {
1392         my ( $md5password, $cardnumber, $borrowernumber, $userid, $firstname,
1393             $surname, $branchcode, $flags )
1394           = $sth->fetchrow;
1395         if ( md5_base64($password) eq $md5password and $md5password ne "!") {
1396
1397             C4::Context->set_userenv( "$borrowernumber", $userid, $cardnumber,
1398                 $firstname, $surname, $branchcode, $flags );
1399             return 1, $cardnumber;
1400         }
1401     }
1402     $sth =
1403       $dbh->prepare(
1404 "select password,cardnumber,borrowernumber,userid, firstname,surname,branchcode,flags from borrowers where cardnumber=?"
1405       );
1406     $sth->execute($userid);
1407     if ( $sth->rows ) {
1408         my ( $md5password, $cardnumber, $borrowernumber, $userid, $firstname,
1409             $surname, $branchcode, $flags )
1410           = $sth->fetchrow;
1411         if ( md5_base64($password) eq $md5password ) {
1412
1413             C4::Context->set_userenv( $borrowernumber, $userid, $cardnumber,
1414                 $firstname, $surname, $branchcode, $flags );
1415             return 1, $userid;
1416         }
1417     }
1418     if (   $userid && $userid eq C4::Context->config('user')
1419         && "$password" eq C4::Context->config('pass') )
1420     {
1421
1422 # Koha superuser account
1423 #     C4::Context->set_userenv(0,0,C4::Context->config('user'),C4::Context->config('user'),C4::Context->config('user'),"",1);
1424         return 2;
1425     }
1426     if (   $userid && $userid eq 'demo'
1427         && "$password" eq 'demo'
1428         && C4::Context->config('demo') )
1429     {
1430
1431 # DEMO => the demo user is allowed to do everything (if demo set to 1 in koha.conf
1432 # some features won't be effective : modify systempref, modify MARC structure,
1433         return 2;
1434     }
1435     return 0;
1436 }
1437
1438 =head2 getuserflags
1439
1440     my $authflags = getuserflags($flags, $userid, [$dbh]);
1441
1442 Translates integer flags into permissions strings hash.
1443
1444 C<$flags> is the integer userflags value ( borrowers.userflags )
1445 C<$userid> is the members.userid, used for building subpermissions
1446 C<$authflags> is a hashref of permissions
1447
1448 =cut
1449
1450 sub getuserflags {
1451     my $flags   = shift;
1452     my $userid  = shift;
1453     my $dbh     = @_ ? shift : C4::Context->dbh;
1454     my $userflags;
1455     $flags = 0 unless $flags;
1456     my $sth = $dbh->prepare("SELECT bit, flag, defaulton FROM userflags");
1457     $sth->execute;
1458
1459     while ( my ( $bit, $flag, $defaulton ) = $sth->fetchrow ) {
1460         if ( ( $flags & ( 2**$bit ) ) || $defaulton ) {
1461             $userflags->{$flag} = 1;
1462         }
1463         else {
1464             $userflags->{$flag} = 0;
1465         }
1466     }
1467
1468     # get subpermissions and merge with top-level permissions
1469     my $user_subperms = get_user_subpermissions($userid);
1470     foreach my $module (keys %$user_subperms) {
1471         next if $userflags->{$module} == 1; # user already has permission for everything in this module
1472         $userflags->{$module} = $user_subperms->{$module};
1473     }
1474
1475     return $userflags;
1476 }
1477
1478 =head2 get_user_subpermissions
1479
1480   $user_perm_hashref = get_user_subpermissions($userid);
1481
1482 Given the userid (note, not the borrowernumber) of a staff user,
1483 return a hashref of hashrefs of the specific subpermissions
1484 accorded to the user.  An example return is
1485
1486  {
1487     tools => {
1488         export_catalog => 1,
1489         import_patrons => 1,
1490     }
1491  }
1492
1493 The top-level hash-key is a module or function code from
1494 userflags.flag, while the second-level key is a code
1495 from permissions.
1496
1497 The results of this function do not give a complete picture
1498 of the functions that a staff user can access; it is also
1499 necessary to check borrowers.flags.
1500
1501 =cut
1502
1503 sub get_user_subpermissions {
1504     my $userid = shift;
1505
1506     my $dbh = C4::Context->dbh;
1507     my $sth = $dbh->prepare("SELECT flag, user_permissions.code
1508                              FROM user_permissions
1509                              JOIN permissions USING (module_bit, code)
1510                              JOIN userflags ON (module_bit = bit)
1511                              JOIN borrowers USING (borrowernumber)
1512                              WHERE userid = ?");
1513     $sth->execute($userid);
1514
1515     my $user_perms = {};
1516     while (my $perm = $sth->fetchrow_hashref) {
1517         $user_perms->{$perm->{'flag'}}->{$perm->{'code'}} = 1;
1518     }
1519     return $user_perms;
1520 }
1521
1522 =head2 get_all_subpermissions
1523
1524   my $perm_hashref = get_all_subpermissions();
1525
1526 Returns a hashref of hashrefs defining all specific
1527 permissions currently defined.  The return value
1528 has the same structure as that of C<get_user_subpermissions>,
1529 except that the innermost hash value is the description
1530 of the subpermission.
1531
1532 =cut
1533
1534 sub get_all_subpermissions {
1535     my $dbh = C4::Context->dbh;
1536     my $sth = $dbh->prepare("SELECT flag, code, description
1537                              FROM permissions
1538                              JOIN userflags ON (module_bit = bit)");
1539     $sth->execute();
1540
1541     my $all_perms = {};
1542     while (my $perm = $sth->fetchrow_hashref) {
1543         $all_perms->{$perm->{'flag'}}->{$perm->{'code'}} = $perm->{'description'};
1544     }
1545     return $all_perms;
1546 }
1547
1548 =head2 haspermission
1549
1550   $flags = ($userid, $flagsrequired);
1551
1552 C<$userid> the userid of the member
1553 C<$flags> is a hashref of required flags like C<$borrower-&lt;{authflags}>
1554
1555 Returns member's flags or 0 if a permission is not met.
1556
1557 =cut
1558
1559 sub haspermission {
1560     my ($userid, $flagsrequired) = @_;
1561     my $sth = C4::Context->dbh->prepare("SELECT flags FROM borrowers WHERE userid=?");
1562     $sth->execute($userid);
1563     my $flags = getuserflags( $sth->fetchrow(), $userid );
1564     if ( $userid eq C4::Context->config('user') ) {
1565         # Super User Account from /etc/koha.conf
1566         $flags->{'superlibrarian'} = 1;
1567     }
1568     elsif ( $userid eq 'demo' && C4::Context->config('demo') ) {
1569         # Demo user that can do "anything" (demo=1 in /etc/koha.conf)
1570         $flags->{'superlibrarian'} = 1;
1571     }
1572     return $flags if $flags->{superlibrarian};
1573     foreach my $module ( keys %$flagsrequired ) {
1574         my $subperm = $flagsrequired->{$module};
1575         if ($subperm eq '*') {
1576             return 0 unless ( $flags->{$module} == 1 or ref($flags->{$module}) );
1577         } else {
1578             return 0 unless ( $flags->{$module} == 1 or
1579                                 ( ref($flags->{$module}) and
1580                                   exists $flags->{$module}->{$subperm} and
1581                                   $flags->{$module}->{$subperm} == 1
1582                                 )
1583                             );
1584         }
1585     }
1586     return $flags;
1587     #FIXME - This fcn should return the failed permission so a suitable error msg can be delivered.
1588 }
1589
1590
1591 sub getborrowernumber {
1592     my ($userid) = @_;
1593     my $userenv = C4::Context->userenv;
1594     if ( defined( $userenv ) && ref( $userenv ) eq 'HASH' && $userenv->{number} ) {
1595         return $userenv->{number};
1596     }
1597     my $dbh = C4::Context->dbh;
1598     for my $field ( 'userid', 'cardnumber' ) {
1599         my $sth =
1600           $dbh->prepare("select borrowernumber from borrowers where $field=?");
1601         $sth->execute($userid);
1602         if ( $sth->rows ) {
1603             my ($bnumber) = $sth->fetchrow;
1604             return $bnumber;
1605         }
1606     }
1607     return 0;
1608 }
1609
1610 END { }    # module clean-up code here (global destructor)
1611 1;
1612 __END__
1613
1614 =head1 SEE ALSO
1615
1616 CGI(3)
1617
1618 C4::Output(3)
1619
1620 Digest::MD5(3)
1621
1622 =cut