C4/Auth.pm

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