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