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