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'} == "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             BranchesLoop                 => GetBranchesLoop(),
 341             using_https                  => $in->{'query'}->https() ? 1 : 0,
 342             noItemTypeImages            => C4::Context->preference("noItemTypeImages"),
 343     );
 344
 345     if ( $in->{'type'} eq "intranet" ) {
 346         $template->param(
 347             AmazonContent               => C4::Context->preference("AmazonContent"),
 348             AmazonCoverImages           => C4::Context->preference("AmazonCoverImages"),
 349             AmazonEnabled               => C4::Context->preference("AmazonEnabled"),
 350             AmazonSimilarItems          => C4::Context->preference("AmazonSimilarItems"),
 351             AutoLocation                => C4::Context->preference("AutoLocation"),
 352             "BiblioDefaultView".C4::Context->preference("IntranetBiblioDefaultView") => 1,
 353             CircAutocompl               => C4::Context->preference("CircAutocompl"),
 354             FRBRizeEditions             => C4::Context->preference("FRBRizeEditions"),
 355             IndependantBranches         => C4::Context->preference("IndependantBranches"),
 356             IntranetNav                 => C4::Context->preference("IntranetNav"),
 357             IntranetmainUserblock       => C4::Context->preference("IntranetmainUserblock"),
 358             LibraryName                 => C4::Context->preference("LibraryName"),
 359             LoginBranchname             => (C4::Context->userenv?C4::Context->userenv->{"branchname"}:"insecure"),
 360             advancedMARCEditor          => C4::Context->preference("advancedMARCEditor"),
 361             canreservefromotherbranches => C4::Context->preference('canreservefromotherbranches'),
 362             intranetcolorstylesheet     => C4::Context->preference("intranetcolorstylesheet"),
 363             intranetreadinghistory      => C4::Context->preference("intranetreadinghistory"),
 364             intranetstylesheet          => C4::Context->preference("intranetstylesheet"),
 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 $mylibraryfirst = C4::Context->preference("SearchMyLibraryFirst");
 383         my $opac_name;
 384         if($opac_limit_override && ($opac_search_limit =~ /branch:(\w+)/) ){
 385              $opac_name = C4::Branch::GetBranchName($1)   # opac_search_limit is a branch, so we use it.
 386         } elsif($mylibraryfirst){
 387             $opac_name = C4::Branch::GetBranchName($mylibraryfirst);
 388         }
 389         $template->param(
 390             AmazonContent             => "" . C4::Context->preference("AmazonContent"),
 391             AnonSuggestions           => "" . C4::Context->preference("AnonSuggestions"),
 392             AuthorisedValueImages     => C4::Context->preference("AuthorisedValueImages"),
 393             LibraryName               => "" . C4::Context->preference("LibraryName"),
 394             LibraryNameTitle          => "" . $LibraryNameTitle,
 395             LoginBranchname           => C4::Context->userenv?C4::Context->userenv->{"branchname"}:"",
 396             OPACAmazonEnabled         => C4::Context->preference("OPACAmazonEnabled"),
 397             OPACAmazonSimilarItems    => C4::Context->preference("OPACAmazonSimilarItems"),
 398             OPACAmazonCoverImages     => C4::Context->preference("OPACAmazonCoverImages"),
 399             OPACAmazonReviews         => C4::Context->preference("OPACAmazonReviews"),
 400             OPACFRBRizeEditions       => C4::Context->preference("OPACFRBRizeEditions"),
 401             OpacHighlightedWords       => C4::Context->preference("OpacHighlightedWords"),
 402             OPACItemHolds             => C4::Context->preference("OPACItemHolds"),
 403             OPACShelfBrowser          => "". C4::Context->preference("OPACShelfBrowser"),
 404             OPACURLOpenInNewWindow    => "" . C4::Context->preference("OPACURLOpenInNewWindow"),
 405             OPACUserCSS               => "". C4::Context->preference("OPACUserCSS"),
 406             OPACViewOthersSuggestions => "" . C4::Context->preference("OPACViewOthersSuggestions"),
 407             OpacAuthorities           => C4::Context->preference("OpacAuthorities"),
 408             OPACBaseURL               => ($in->{'query'}->https() ? "https://" : "http://") . $ENV{'SERVER_NAME'} .
 409                    ($ENV{'SERVER_PORT'} eq ($in->{'query'}->https() ? "443" : "80") ? '' : ":$ENV{'SERVER_PORT'}"),
 410             opac_name             => $opac_name,
 411             opac_css_override           => $ENV{'OPAC_CSS_OVERRIDE'},
 412             opac_search_limit         => $opac_search_limit,
 413             opac_limit_override       => $opac_limit_override,
 414             OpacBrowser               => C4::Context->preference("OpacBrowser"),
 415             OpacCloud                 => C4::Context->preference("OpacCloud"),
 416             OpacMainUserBlock         => "" . C4::Context->preference("OpacMainUserBlock"),
 417             OpacNav                   => "" . C4::Context->preference("OpacNav"),
 418             OpacPasswordChange        => C4::Context->preference("OpacPasswordChange"),
 419             OPACPatronDetails        => C4::Context->preference("OPACPatronDetails"),
 420             OPACFinesTab              => C4::Context->preference("OPACFinesTab"),
 421             OpacTopissue              => C4::Context->preference("OpacTopissue"),
 422             RequestOnOpac             => C4::Context->preference("RequestOnOpac"),
 423             'Version'                 => C4::Context->preference('Version'),
 424             hidelostitems             => C4::Context->preference("hidelostitems"),
 425             mylibraryfirst            => (C4::Context->preference("SearchMyLibraryFirst") && C4::Context->userenv) ? C4::Context->userenv->{'branch'} : '',
 426             opaclayoutstylesheet      => "" . C4::Context->preference("opaclayoutstylesheet"),
 427             opaccolorstylesheet       => "" . C4::Context->preference("opaccolorstylesheet"),
 428             opacstylesheet            => "" . C4::Context->preference("opacstylesheet"),
 429             opacbookbag               => "" . C4::Context->preference("opacbookbag"),
 430             opaccredits               => "" . C4::Context->preference("opaccredits"),
 431             opacheader                => "" . C4::Context->preference("opacheader"),
 432             opaclanguagesdisplay      => "" . C4::Context->preference("opaclanguagesdisplay"),
 433             opacreadinghistory        => C4::Context->preference("opacreadinghistory"),
 434             opacsmallimage            => "" . C4::Context->preference("opacsmallimage"),
 435             opacuserjs                => C4::Context->preference("opacuserjs"),
 436             opacuserlogin             => "" . C4::Context->preference("opacuserlogin"),
 437             reviewson                 => C4::Context->preference("reviewson"),
 438             suggestion                => "" . C4::Context->preference("suggestion"),
 439             virtualshelves            => "" . C4::Context->preference("virtualshelves"),
 440             OPACSerialIssueDisplayCount => C4::Context->preference("OPACSerialIssueDisplayCount"),
 441             OpacAddMastheadLibraryPulldown => C4::Context->preference("OpacAddMastheadLibraryPulldown"),
 442             OPACXSLTDetailsDisplay           => C4::Context->preference("OPACXSLTDetailsDisplay"),
 443             OPACXSLTResultsDisplay           => C4::Context->preference("OPACXSLTResultsDisplay"),
 444             SyndeticsClientCode          => C4::Context->preference("SyndeticsClientCode"),
 445             SyndeticsEnabled             => C4::Context->preference("SyndeticsEnabled"),
 446             SyndeticsCoverImages         => C4::Context->preference("SyndeticsCoverImages"),
 447             SyndeticsTOC                 => C4::Context->preference("SyndeticsTOC"),
 448             SyndeticsSummary             => C4::Context->preference("SyndeticsSummary"),
 449             SyndeticsEditions            => C4::Context->preference("SyndeticsEditions"),
 450             SyndeticsExcerpt             => C4::Context->preference("SyndeticsExcerpt"),
 451             SyndeticsReviews             => C4::Context->preference("SyndeticsReviews"),
 452             SyndeticsAuthorNotes         => C4::Context->preference("SyndeticsAuthorNotes"),
 453             SyndeticsAwards              => C4::Context->preference("SyndeticsAwards"),
 454             SyndeticsSeries              => C4::Context->preference("SyndeticsSeries"),
 455             SyndeticsCoverImageSize      => C4::Context->preference("SyndeticsCoverImageSize"),
 456         );
 457     }
 458         $template->param(listloop=>[{shelfname=>"Freelist", shelfnumber=>110}]);
 459     return ( $template, $borrowernumber, $cookie, $flags);
 460 }
 461
 462 =head2 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 Koha also has a concept of sub-permissions, also known as
 498 granular permissions.  This makes the value of each key
 499 in the C<flagsrequired> hash take on an additional
 500 meaning, i.e.,
 501
 502  1
 503
 504 The user must have access to all subfunctions of the module
 505 specified by the hash key.
 506
 507  *
 508
 509 The user must have access to at least one subfunction of the module
 510 specified by the hash key.
 511
 512  specific permission, e.g., 'export_catalog'
 513
 514 The user must have access to the specific subfunction list, which
 515 must correspond to a row in the permissions table.
 516
 517 The C<$type> argument specifies whether the template should be
 518 retrieved from the opac or intranet directory tree.  "opac" is
 519 assumed if it is not specified; however, if C<$type> is specified,
 520 "intranet" is assumed if it is not "opac".
 521
 522 If C<$query> does not have a valid session ID associated with it
 523 (i.e., the user has not logged in) or if the session has expired,
 524 C<&checkauth> presents the user with a login page (from the point of
 525 view of the original script, C<&checkauth> does not return). Once the
 526 user has authenticated, C<&checkauth> restarts the original script
 527 (this time, C<&checkauth> returns).
 528
 529 The login page is provided using a HTML::Template, which is set in the
 530 systempreferences table or at the top of this file. The variable C<$type>
 531 selects which template to use, either the opac or the intranet
 532 authentification template.
 533
 534 C<&checkauth> returns a user ID, a cookie, and a session ID. The
 535 cookie should be sent back to the browser; it verifies that the user
 536 has authenticated.
 537
 538 =cut
 539
 540 sub _version_check ($$) {
 541     my $type = shift;
 542     my $query = shift;
 543     my $version;
 544     # If Version syspref is unavailable, it means Koha is beeing installed,
 545     # and so we must redirect to OPAC maintenance page or to the WebInstaller
 546         # also, if OpacMaintenance is ON, OPAC should redirect to maintenance
 547         if (C4::Context->preference('OpacMaintenance') && $type eq 'opac') {
 548                 warn "OPAC Install required, redirecting to maintenance";
 549                 print $query->redirect("/cgi-bin/koha/maintenance.pl");
 550         }
 551     unless ($version = C4::Context->preference('Version')) {    # assignment, not comparison
 552       if ($type ne 'opac') {
 553         warn "Install required, redirecting to Installer";
 554         print $query->redirect("/cgi-bin/koha/installer/install.pl");
 555       }
 556       else {
 557         warn "OPAC Install required, redirecting to maintenance";
 558         print $query->redirect("/cgi-bin/koha/maintenance.pl");
 559       }
 560       exit;
 561     }
 562
 563     # check that database and koha version are the same
 564     # there is no DB version, it's a fresh install,
 565     # go to web installer
 566     # there is a DB version, compare it to the code version
 567     my $kohaversion=C4::Context::KOHAVERSION;
 568     # remove the 3 last . to have a Perl number
 569     $kohaversion =~ s/(.*\..*)\.(.*)\.(.*)/$1$2$3/;
 570     $debug and print STDERR "kohaversion : $kohaversion\n";
 571     if ($version < $kohaversion){
 572         my $warning = "Database update needed, redirecting to %s. Database is $version and Koha is $kohaversion";
 573         if ($type ne 'opac'){
 574             warn sprintf($warning, 'Installer');
 575             print $query->redirect("/cgi-bin/koha/installer/install.pl?step=3");
 576         } else {
 577             warn sprintf("OPAC: " . $warning, 'maintenance');
 578             print $query->redirect("/cgi-bin/koha/maintenance.pl");
 579         }
 580         exit;
 581     }
 582 }
 583
 584 sub _session_log {
 585     (@_) or return 0;
 586     open L, ">>/tmp/sessionlog" or warn "ERROR: Cannot append to /tmp/sessionlog";
 587     printf L join("\n",@_);
 588     close L;
 589 }
 590
 591 sub checkauth {
 592     my $query = shift;
 593         $debug and warn "Checking Auth";
 594     # $authnotrequired will be set for scripts which will run without authentication
 595     my $authnotrequired = shift;
 596     my $flagsrequired   = shift;
 597     my $type            = shift;
 598     $type = 'opac' unless $type;
 599
 600     my $dbh     = C4::Context->dbh;
 601     my $timeout = C4::Context->preference('timeout');
 602     # days
 603     if ($timeout =~ /(\d+)[dD]/) {
 604         $timeout = $1 * 86400;
 605     };
 606     $timeout = 600 unless $timeout;
 607
 608     _version_check($type,$query);
 609     # state variables
 610     my $loggedin = 0;
 611     my %info;
 612     my ( $userid, $cookie, $sessionID, $flags, $barshelves, $pubshelves );
 613     my $logout = $query->param('logout.x');
 614
 615     if ( $userid = $ENV{'REMOTE_USER'} ) {
 616         # Using Basic Authentication, no cookies required
 617         $cookie = $query->cookie(
 618             -name    => 'CGISESSID',
 619             -value   => '',
 620             -expires => ''
 621         );
 622         $loggedin = 1;
 623     }
 624     elsif ( $sessionID = $query->cookie("CGISESSID")) {     # assignment, not comparison
 625         my $session = get_session($sessionID);
 626         C4::Context->_new_userenv($sessionID);
 627         my ($ip, $lasttime, $sessiontype);
 628         if ($session){
 629             C4::Context::set_userenv(
 630                 $session->param('number'),       $session->param('id'),
 631                 $session->param('cardnumber'),   $session->param('firstname'),
 632                 $session->param('surname'),      $session->param('branch'),
 633                 $session->param('branchname'),   $session->param('flags'),
 634                 $session->param('emailaddress'), $session->param('branchprinter')
 635             );
 636             C4::Context::set_shelves_userenv('bar',$session->param('barshelves'));
 637             C4::Context::set_shelves_userenv('pub',$session->param('pubshelves'));
 638             C4::Context::set_shelves_userenv('tot',$session->param('totshelves'));
 639             $debug and printf STDERR "AUTH_SESSION: (%s)\t%s %s - %s\n", map {$session->param($_)} qw(cardnumber firstname surname branch) ;
 640             $ip       = $session->param('ip');
 641             $lasttime = $session->param('lasttime');
 642             $userid   = $session->param('id');
 643                         $sessiontype = $session->param('sessiontype');
 644         }
 645         if ( ($query->param('koha_login_context')) && ($query->param('userid') ne $session->param('id')) ) {
 646             #if a user enters an id ne to the id in the current session, we need to log them in...
 647             #first we need to clear the anonymous session...
 648             $debug and warn "query id = " . $query->param('userid') . " but session id = " . $session->param('id');
 649             $session->flush;
 650             $session->delete();
 651             C4::Context->_unset_userenv($sessionID);
 652                         $sessionID = undef;
 653                         $userid = undef;
 654                 }
 655         elsif ($logout) {
 656             # voluntary logout the user
 657             $session->flush;
 658             $session->delete();
 659             C4::Context->_unset_userenv($sessionID);
 660             _session_log(sprintf "%20s from %16s logged out at %30s (manually).\n", $userid,$ip,(strftime "%c",localtime));
 661             $sessionID = undef;
 662             $userid    = undef;
 663
 664             if ($cas and $caslogout) {
 665                 logout_cas($query);
 666             }
 667         }
 668         elsif ( $lasttime < time() - $timeout ) {
 669             # timed logout
 670             $info{'timed_out'} = 1;
 671             $session->delete();
 672             C4::Context->_unset_userenv($sessionID);
 673             _session_log(sprintf "%20s from %16s logged out at %30s (inactivity).\n", $userid,$ip,(strftime "%c",localtime));
 674             $userid    = undef;
 675             $sessionID = undef;
 676         }
 677         elsif ( $ip ne $ENV{'REMOTE_ADDR'} ) {
 678             # Different ip than originally logged in from
 679             $info{'oldip'}        = $ip;
 680             $info{'newip'}        = $ENV{'REMOTE_ADDR'};
 681             $info{'different_ip'} = 1;
 682             $session->delete();
 683             C4::Context->_unset_userenv($sessionID);
 684             _session_log(sprintf "%20s from %16s logged out at %30s (ip changed to %16s).\n", $userid,$ip,(strftime "%c",localtime), $info{'newip'});
 685             $sessionID = undef;
 686             $userid    = undef;
 687         }
 688         else {
 689             $cookie = $query->cookie( CGISESSID => $session->id );
 690             $session->param('lasttime',time());
 691             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...
 692                 $flags = haspermission($userid, $flagsrequired);
 693                 if ($flags) {
 694                     $loggedin = 1;
 695                 } else {
 696                     $info{'nopermission'} = 1;
 697                 }
 698             }
 699         }
 700     }
 701     unless ($userid || $sessionID) {
 702         #we initiate a session prior to checking for a username to allow for anonymous sessions...
 703                 my $session = get_session("") or die "Auth ERROR: Cannot get_session()";
 704         my $sessionID = $session->id;
 705         C4::Context->_new_userenv($sessionID);
 706         $cookie = $query->cookie(CGISESSID => $sessionID);
 707             $userid    = $query->param('userid');
 708             if ($cas || $userid) {
 709                 my $password = $query->param('password');
 710                 my ($return, $cardnumber);
 711                 if ($cas && $query->param('ticket')) {
 712                     my $retuserid;
 713                     ( $return, $cardnumber, $retuserid ) = checkpw( $dbh, $userid, $password, $query );
 714                     $userid = $retuserid;
 715                     $info{'invalidCasLogin'} = 1 unless ($return);
 716                 } else {
 717                     ( $return, $cardnumber ) = checkpw( $dbh, $userid, $password, $query );
 718                 }
 719                 if ($return) {
 720                 _session_log(sprintf "%20s from %16s logged in  at %30s.\n", $userid,$ENV{'REMOTE_ADDR'},localtime);
 721                 if ( $flags = haspermission(  $userid, $flagsrequired ) ) {
 722                                         $loggedin = 1;
 723                 }
 724                         else {
 725                         $info{'nopermission'} = 1;
 726                         C4::Context->_unset_userenv($sessionID);
 727                 }
 728
 729                                 my ($borrowernumber, $firstname, $surname, $userflags,
 730                                         $branchcode, $branchname, $branchprinter, $emailaddress);
 731
 732                 if ( $return == 1 ) {
 733                         my $select = "
 734                         SELECT borrowernumber, firstname, surname, flags, borrowers.branchcode,
 735                             branches.branchname    as branchname,
 736                                 branches.branchprinter as branchprinter,
 737                                 email
 738                         FROM borrowers
 739                         LEFT JOIN branches on borrowers.branchcode=branches.branchcode
 740                         ";
 741                         my $sth = $dbh->prepare("$select where userid=?");
 742                         $sth->execute($userid);
 743                                         unless ($sth->rows) {
 744                                 $debug and print STDERR "AUTH_1: no rows for userid='$userid'\n";
 745                                                 $sth = $dbh->prepare("$select where cardnumber=?");
 746                                 $sth->execute($cardnumber);
 747                                                 unless ($sth->rows) {
 748                                         $debug and print STDERR "AUTH_2a: no rows for cardnumber='$cardnumber'\n";
 749                                 $sth->execute($userid);
 750                                                         unless ($sth->rows) {
 751                                                 $debug and print STDERR "AUTH_2b: no rows for userid='$userid' AS cardnumber\n";
 752                                                         }
 753                                                 }
 754                                         }
 755                         if ($sth->rows) {
 756                         ($borrowernumber, $firstname, $surname, $userflags,
 757                                 $branchcode, $branchname, $branchprinter, $emailaddress) = $sth->fetchrow;
 758                                                 $debug and print STDERR "AUTH_3 results: " .
 759                                                         "$cardnumber,$borrowernumber,$userid,$firstname,$surname,$userflags,$branchcode,$emailaddress\n";
 760                                         } else {
 761                                                 print STDERR "AUTH_3: no results for userid='$userid', cardnumber='$cardnumber'.\n";
 762                                         }
 763
 764 # launch a sequence to check if we have a ip for the branch, i
 765 # if we have one we replace the branchcode of the userenv by the branch bound in the ip.
 766
 767                                         my $ip       = $ENV{'REMOTE_ADDR'};
 768                                         # if they specify at login, use that
 769                                         if ($query->param('branch')) {
 770                                                 $branchcode  = $query->param('branch');
 771                                                 $branchname = GetBranchName($branchcode);
 772                                         }
 773                                         my $branches = GetBranches();
 774                                         if (C4::Context->boolean_preference('IndependantBranches') && C4::Context->boolean_preference('Autolocation')){
 775                                                 # we have to check they are coming from the right ip range
 776                                                 my $domain = $branches->{$branchcode}->{'branchip'};
 777                                                 if ($ip !~ /^$domain/){
 778                                                         $loggedin=0;
 779                                                         $info{'wrongip'} = 1;
 780                                                 }
 781                                         }
 782
 783                                         my @branchesloop;
 784                                         foreach my $br ( keys %$branches ) {
 785                                                 #     now we work with the treatment of ip
 786                                                 my $domain = $branches->{$br}->{'branchip'};
 787                                                 if ( $domain && $ip =~ /^$domain/ ) {
 788                                                         $branchcode = $branches->{$br}->{'branchcode'};
 789
 790                                                         # new op dev : add the branchprinter and branchname in the cookie
 791                                                         $branchprinter = $branches->{$br}->{'branchprinter'};
 792                                                         $branchname    = $branches->{$br}->{'branchname'};
 793                                                 }
 794                                         }
 795                                         $session->param('number',$borrowernumber);
 796                                         $session->param('id',$userid);
 797                                         $session->param('cardnumber',$cardnumber);
 798                                         $session->param('firstname',$firstname);
 799                                         $session->param('surname',$surname);
 800                                         $session->param('branch',$branchcode);
 801                                         $session->param('branchname',$branchname);
 802                                         $session->param('flags',$userflags);
 803                                         $session->param('emailaddress',$emailaddress);
 804                                         $session->param('ip',$session->remote_addr());
 805                                         $session->param('lasttime',time());
 806                                         $debug and printf STDERR "AUTH_4: (%s)\t%s %s - %s\n", map {$session->param($_)} qw(cardnumber firstname surname branch) ;
 807                                 }
 808                                 elsif ( $return == 2 ) {
 809                                         #We suppose the user is the superlibrarian
 810                                         $borrowernumber = 0;
 811                                         $session->param('number',0);
 812                                         $session->param('id',C4::Context->config('user'));
 813                                         $session->param('cardnumber',C4::Context->config('user'));
 814                                         $session->param('firstname',C4::Context->config('user'));
 815                                         $session->param('surname',C4::Context->config('user'));
 816                                         $session->param('branch','NO_LIBRARY_SET');
 817                                         $session->param('branchname','NO_LIBRARY_SET');
 818                                         $session->param('flags',1);
 819                                         $session->param('emailaddress', C4::Context->preference('KohaAdminEmailAddress'));
 820                                         $session->param('ip',$session->remote_addr());
 821                                         $session->param('lasttime',time());
 822                                 }
 823                                 C4::Context::set_userenv(
 824                                         $session->param('number'),       $session->param('id'),
 825                                         $session->param('cardnumber'),   $session->param('firstname'),
 826                                         $session->param('surname'),      $session->param('branch'),
 827                                         $session->param('branchname'),   $session->param('flags'),
 828                                         $session->param('emailaddress'), $session->param('branchprinter')
 829                                 );
 830
 831                                 # Grab borrower's shelves and public shelves and add them to the session
 832                                 # $row_count determines how many records are returned from the db query
 833                                 # and the number of lists to be displayed of each type in the 'Lists' button drop down
 834                                 my $row_count = 10; # FIXME:This probably should be a syspref
 835                                 my ($total, $totshelves, $barshelves, $pubshelves);
 836                                 ($barshelves, $totshelves) = C4::VirtualShelves::GetRecentShelves(1, $row_count, $borrowernumber);
 837                                 $total->{'bartotal'} = $totshelves;
 838                                 ($pubshelves, $totshelves) = C4::VirtualShelves::GetRecentShelves(2, $row_count, undef);
 839                                 $total->{'pubtotal'} = $totshelves;
 840                                 $session->param('barshelves', $barshelves->[0]);
 841                                 $session->param('pubshelves', $pubshelves->[0]);
 842                                 $session->param('totshelves', $total);
 843
 844                                 C4::Context::set_shelves_userenv('bar',$barshelves->[0]);
 845                                 C4::Context::set_shelves_userenv('pub',$pubshelves->[0]);
 846                                 C4::Context::set_shelves_userenv('tot',$total);
 847                         }
 848                 else {
 849                 if ($userid) {
 850                         $info{'invalid_username_or_password'} = 1;
 851                         C4::Context->_unset_userenv($sessionID);
 852                 }
 853                         }
 854         }       # END if ( $userid    = $query->param('userid') )
 855                 elsif ($type eq "opac") {
 856             # if we are here this is an anonymous session; add public lists to it and a few other items...
 857             # anonymous sessions are created only for the OPAC
 858                         $debug and warn "Initiating an anonymous session...";
 859
 860                         # Grab the public shelves and add to the session...
 861                         my $row_count = 20; # FIXME:This probably should be a syspref
 862                         my ($total, $totshelves, $pubshelves);
 863                         ($pubshelves, $totshelves) = C4::VirtualShelves::GetRecentShelves(2, $row_count, undef);
 864                         $total->{'pubtotal'} = $totshelves;
 865                         $session->param('pubshelves', $pubshelves->[0]);
 866                         $session->param('totshelves', $total);
 867                         C4::Context::set_shelves_userenv('pub',$pubshelves->[0]);
 868                         C4::Context::set_shelves_userenv('tot',$total);
 869
 870                         # setting a couple of other session vars...
 871                         $session->param('ip',$session->remote_addr());
 872                         $session->param('lasttime',time());
 873                         $session->param('sessiontype','anon');
 874                 }
 875     }   # END unless ($userid)
 876     my $insecure = C4::Context->boolean_preference('insecure');
 877
 878     # finished authentification, now respond
 879     if ( $loggedin || $authnotrequired || ( defined($insecure) && $insecure ) )
 880     {
 881         # successful login
 882         unless ($cookie) {
 883             $cookie = $query->cookie( CGISESSID => '' );
 884         }
 885         return ( $userid, $cookie, $sessionID, $flags );
 886     }
 887
 888 #
 889 #
 890 # AUTH rejected, show the login/password template, after checking the DB.
 891 #
 892 #
 893
 894     # get the inputs from the incoming query
 895     my @inputs = ();
 896     foreach my $name ( param $query) {
 897         (next) if ( $name eq 'userid' || $name eq 'password' || $name eq 'ticket' );
 898         my $value = $query->param($name);
 899         push @inputs, { name => $name, value => $value };
 900     }
 901     # get the branchloop, which we need for authentication
 902     my $branches = GetBranches();
 903     my @branch_loop;
 904     for my $branch_hash (sort keys %$branches) {
 905                 push @branch_loop, {branchcode => "$branch_hash", branchname => $branches->{$branch_hash}->{'branchname'}, };
 906     }
 907
 908     my $template_name = ( $type eq 'opac' ) ? 'opac-auth.tmpl' : 'auth.tmpl';
 909     my $template = gettemplate( $template_name, $type, $query );
 910     $template->param(branchloop => \@branch_loop,);
 911     $template->param(
 912     login        => 1,
 913         INPUTS               => \@inputs,
 914         casAuthentication    => C4::Context->preference("casAuthentication"),
 915         suggestion           => C4::Context->preference("suggestion"),
 916         virtualshelves       => C4::Context->preference("virtualshelves"),
 917         LibraryName          => C4::Context->preference("LibraryName"),
 918         opacuserlogin        => C4::Context->preference("opacuserlogin"),
 919         OpacNav              => C4::Context->preference("OpacNav"),
 920         opaccredits          => C4::Context->preference("opaccredits"),
 921         opacreadinghistory   => C4::Context->preference("opacreadinghistory"),
 922         opacsmallimage       => C4::Context->preference("opacsmallimage"),
 923         opaclayoutstylesheet => C4::Context->preference("opaclayoutstylesheet"),
 924         opaccolorstylesheet  => C4::Context->preference("opaccolorstylesheet"),
 925         opaclanguagesdisplay => C4::Context->preference("opaclanguagesdisplay"),
 926         opacuserjs           => C4::Context->preference("opacuserjs"),
 927         opacbookbag          => "" . C4::Context->preference("opacbookbag"),
 928         OpacCloud            => C4::Context->preference("OpacCloud"),
 929         OpacTopissue         => C4::Context->preference("OpacTopissue"),
 930         OpacAuthorities      => C4::Context->preference("OpacAuthorities"),
 931         OpacBrowser          => C4::Context->preference("OpacBrowser"),
 932         opacheader           => C4::Context->preference("opacheader"),
 933         TagsEnabled                  => C4::Context->preference("TagsEnabled"),
 934         OPACUserCSS           => C4::Context->preference("OPACUserCSS"),
 935         intranetcolorstylesheet =>
 936                                                                 C4::Context->preference("intranetcolorstylesheet"),
 937         intranetstylesheet => C4::Context->preference("intranetstylesheet"),
 938         intranetbookbag    => C4::Context->preference("intranetbookbag"),
 939         IntranetNav        => C4::Context->preference("IntranetNav"),
 940         intranetuserjs     => C4::Context->preference("intranetuserjs"),
 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 =head2 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
 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 =head2 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
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 =head2 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 =head2 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 =head2 get_user_subpermissions
1459
1460   $user_perm_hashref = get_user_subpermissions($userid);
1461
1462 Given the userid (note, not the borrowernumber) of a staff user,
1463 return a hashref of hashrefs of the specific subpermissions
1464 accorded to the user.  An example return is
1465
1466  {
1467     tools => {
1468         export_catalog => 1,
1469         import_patrons => 1,
1470     }
1471  }
1472
1473 The top-level hash-key is a module or function code from
1474 userflags.flag, while the second-level key is a code
1475 from permissions.
1476
1477 The results of this function do not give a complete picture
1478 of the functions that a staff user can access; it is also
1479 necessary to check borrowers.flags.
1480
1481 =cut
1482
1483 sub get_user_subpermissions {
1484     my $userid = shift;
1485
1486     my $dbh = C4::Context->dbh;
1487     my $sth = $dbh->prepare("SELECT flag, user_permissions.code
1488                              FROM user_permissions
1489                              JOIN permissions USING (module_bit, code)
1490                              JOIN userflags ON (module_bit = bit)
1491                              JOIN borrowers USING (borrowernumber)
1492                              WHERE userid = ?");
1493     $sth->execute($userid);
1494
1495     my $user_perms = {};
1496     while (my $perm = $sth->fetchrow_hashref) {
1497         $user_perms->{$perm->{'flag'}}->{$perm->{'code'}} = 1;
1498     }
1499     return $user_perms;
1500 }
1501
1502 =head2 get_all_subpermissions
1503
1504   my $perm_hashref = get_all_subpermissions();
1505
1506 Returns a hashref of hashrefs defining all specific
1507 permissions currently defined.  The return value
1508 has the same structure as that of C<get_user_subpermissions>,
1509 except that the innermost hash value is the description
1510 of the subpermission.
1511
1512 =cut
1513
1514 sub get_all_subpermissions {
1515     my $dbh = C4::Context->dbh;
1516     my $sth = $dbh->prepare("SELECT flag, code, description
1517                              FROM permissions
1518                              JOIN userflags ON (module_bit = bit)");
1519     $sth->execute();
1520
1521     my $all_perms = {};
1522     while (my $perm = $sth->fetchrow_hashref) {
1523         $all_perms->{$perm->{'flag'}}->{$perm->{'code'}} = $perm->{'description'};
1524     }
1525     return $all_perms;
1526 }
1527
1528 =head2 haspermission
1529
1530   $flags = ($userid, $flagsrequired);
1531
1532 C<$userid> the userid of the member
1533 C<$flags> is a hashref of required flags like C<$borrower-&lt;{authflags}>
1534
1535 Returns member's flags or 0 if a permission is not met.
1536
1537 =cut
1538
1539 sub haspermission {
1540     my ($userid, $flagsrequired) = @_;
1541     my $sth = C4::Context->dbh->prepare("SELECT flags FROM borrowers WHERE userid=?");
1542     $sth->execute($userid);
1543     my $flags = getuserflags( $sth->fetchrow(), $userid );
1544     if ( $userid eq C4::Context->config('user') ) {
1545         # Super User Account from /etc/koha.conf
1546         $flags->{'superlibrarian'} = 1;
1547     }
1548     elsif ( $userid eq 'demo' && C4::Context->config('demo') ) {
1549         # Demo user that can do "anything" (demo=1 in /etc/koha.conf)
1550         $flags->{'superlibrarian'} = 1;
1551     }
1552     return $flags if $flags->{superlibrarian};
1553     foreach my $module ( keys %$flagsrequired ) {
1554         my $subperm = $flagsrequired->{$module};
1555         if ($subperm eq '*') {
1556             return 0 unless ( $flags->{$module} == 1 or ref($flags->{$module}) );
1557         } else {
1558             return 0 unless ( $flags->{$module} == 1 or
1559                                 ( ref($flags->{$module}) and
1560                                   exists $flags->{$module}->{$subperm} and
1561                                   $flags->{$module}->{$subperm} == 1
1562                                 )
1563                             );
1564         }
1565     }
1566     return $flags;
1567     #FIXME - This fcn should return the failed permission so a suitable error msg can be delivered.
1568 }
1569
1570
1571 sub getborrowernumber {
1572     my ($userid) = @_;
1573     my $userenv = C4::Context->userenv;
1574     if ( defined( $userenv ) && ref( $userenv ) eq 'HASH' && $userenv->{number} ) {
1575         return $userenv->{number};
1576     }
1577     my $dbh = C4::Context->dbh;
1578     for my $field ( 'userid', 'cardnumber' ) {
1579         my $sth =
1580           $dbh->prepare("select borrowernumber from borrowers where $field=?");
1581         $sth->execute($userid);
1582         if ( $sth->rows ) {
1583             my ($bnumber) = $sth->fetchrow;
1584             return $bnumber;
1585         }
1586     }
1587     return 0;
1588 }
1589
1590 END { }    # module clean-up code here (global destructor)
1591 1;
1592 __END__
1593
1594 =head1 SEE ALSO
1595
1596 CGI(3)
1597
1598 C4::Output(3)
1599
1600 Digest::MD5(3)
1601
1602 =cut