C4/Auth.pm

   1
   2 # -*- tab-width: 8 -*-
   3 # NOTE: This file uses 8-character tabs; do not change the tab size!
   4
   5 package C4::Auth;
   6
   7 # Copyright 2000-2002 Katipo Communications
   8 #
   9 # This file is part of Koha.
  10 #
  11 # Koha is free software; you can redistribute it and/or modify it under the
  12 # terms of the GNU General Public License as published by the Free Software
  13 # Foundation; either version 2 of the License, or (at your option) any later
  14 # version.
  15 #
  16 # Koha is distributed in the hope that it will be useful, but WITHOUT ANY
  17 # WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
  18 # A PARTICULAR PURPOSE.  See the GNU General Public License for more details.
  19 #
  20 # You should have received a copy of the GNU General Public License along with
  21 # Koha; if not, write to the Free Software Foundation, Inc., 59 Temple Place,
  22 # Suite 330, Boston, MA  02111-1307 USA
  23
  24 use strict;
  25 use Digest::MD5 qw(md5_base64);
  26 use CGI::Session;
  27
  28 require Exporter;
  29 use C4::Context;
  30 use C4::Output;    # to get the template
  31 use C4::Members;
  32 use C4::Koha;
  33 use C4::Branch; # GetBranches
  34
  35 # use utf8;
  36 use vars qw($VERSION @ISA @EXPORT @EXPORT_OK %EXPORT_TAGS $debug $ldap);
  37
  38 BEGIN {
  39     $VERSION = 3.01;        # set version for version checking
  40     $debug = $ENV{DEBUG} || 0 ;
  41     @ISA   = qw(Exporter);
  42     @EXPORT    = qw(&checkauth &get_template_and_user);
  43     @EXPORT_OK = qw(&check_api_auth &get_session &check_cookie_auth &checkpw);
  44     $ldap = C4::Context->config('useldapserver') || 0;
  45     if ($ldap) {
  46         require C4::Auth_with_ldap;             # no import
  47         import  C4::Auth_with_ldap qw(checkpw_ldap);
  48     }
  49 }
  50
  51 =head1 NAME
  52
  53 C4::Auth - Authenticates Koha users
  54
  55 =head1 SYNOPSIS
  56
  57   use CGI;
  58   use C4::Auth;
  59
  60   my $query = new CGI;
  61
  62   my ($template, $borrowernumber, $cookie)
  63     = get_template_and_user(
  64         {
  65             template_name   => "opac-main.tmpl",
  66             query           => $query,
  67       type            => "opac",
  68       authnotrequired => 1,
  69       flagsrequired   => {borrow => 1},
  70   }
  71     );
  72
  73   print $query->header(
  74     -type => 'utf-8',
  75     -cookie => $cookie
  76   ), $template->output;
  77
  78
  79 =head1 DESCRIPTION
  80
  81     The main function of this module is to provide
  82     authentification. However the get_template_and_user function has
  83     been provided so that a users login information is passed along
  84     automatically. This gets loaded into the template.
  85
  86 =head1 FUNCTIONS
  87
  88 =over 2
  89
  90 =item get_template_and_user
  91
  92     my ($template, $borrowernumber, $cookie)
  93         = get_template_and_user(
  94           {
  95             template_name   => "opac-main.tmpl",
  96             query           => $query,
  97             type            => "opac",
  98             authnotrequired => 1,
  99             flagsrequired   => {borrow => 1},
 100           }
 101         );
 102
 103     This call passes the C<query>, C<flagsrequired> and C<authnotrequired>
 104     to C<&checkauth> (in this module) to perform authentification.
 105     See C<&checkauth> for an explanation of these parameters.
 106
 107     The C<template_name> is then used to find the correct template for
 108     the page. The authenticated users details are loaded onto the
 109     template in the HTML::Template LOOP variable C<USER_INFO>. Also the
 110     C<sessionID> is passed to the template. This can be used in templates
 111     if cookies are disabled. It needs to be put as and input to every
 112     authenticated page.
 113
 114     More information on the C<gettemplate> sub can be found in the
 115     Output.pm module.
 116
 117 =cut
 118
 119 sub get_template_and_user {
 120     my $in       = shift;
 121     my $template =
 122       gettemplate( $in->{'template_name'}, $in->{'type'}, $in->{'query'} );
 123     my ( $user, $cookie, $sessionID, $flags ) = checkauth(
 124         $in->{'query'},
 125         $in->{'authnotrequired'},
 126         $in->{'flagsrequired'},
 127         $in->{'type'}
 128     ) unless ($in->{'template_name'}=~/maintenance/);
 129
 130     my $borrowernumber;
 131     my $insecure = C4::Context->preference('insecure');
 132     if ($user or $insecure) {
 133
 134         # load the template variables for stylesheets and JavaScript
 135         $template->param( css_libs => $in->{'css_libs'} );
 136         $template->param( css_module => $in->{'css_module'} );
 137         $template->param( css_page => $in->{'css_page'} );
 138         $template->param( css_widgets => $in->{'css_widgets'} );
 139
 140         $template->param( js_libs => $in->{'js_libs'} );
 141         $template->param( js_module => $in->{'js_module'} );
 142         $template->param( js_page => $in->{'js_page'} );
 143         $template->param( js_widgets => $in->{'js_widgets'} );
 144
 145         # user info
 146         $template->param( loggedinusername => $user );
 147         $template->param( sessionID        => $sessionID );
 148
 149         $borrowernumber = getborrowernumber($user);
 150         my ( $borr, $alternativeflags ) =
 151           GetMemberDetails( $borrowernumber );
 152         my @bordat;
 153         $bordat[0] = $borr;
 154         $template->param( "USER_INFO" => \@bordat );
 155
 156         my @flagroots = qw(circulate catalogue parameters borrowers permissions reserveforothers borrow
 157                             editcatalogue updatecharges management tools editauthorities serials reports);
 158         # We are going to use the $flags returned by checkauth
 159         # to create the template's parameters that will indicate
 160         # which menus the user can access.
 161         if (( $flags && $flags->{superlibrarian}==1) or $insecure==1) {
 162             $template->param( CAN_user_circulate        => 1 );
 163             $template->param( CAN_user_catalogue        => 1 );
 164             $template->param( CAN_user_parameters       => 1 );
 165             $template->param( CAN_user_borrowers        => 1 );
 166             $template->param( CAN_user_permission       => 1 );
 167             $template->param( CAN_user_reserveforothers => 1 );
 168             $template->param( CAN_user_borrow           => 1 );
 169             $template->param( CAN_user_editcatalogue    => 1 );
 170             $template->param( CAN_user_updatecharges     => 1 );
 171             $template->param( CAN_user_acquisition      => 1 );
 172             $template->param( CAN_user_management       => 1 );
 173             $template->param( CAN_user_tools            => 1 );
 174             $template->param( CAN_user_editauthorities  => 1 );
 175             $template->param( CAN_user_serials          => 1 );
 176             $template->param( CAN_user_reports          => 1 );
 177             $template->param( CAN_user_staffaccess      => 1 );
 178         }
 179
 180         if ( $flags && $flags->{circulate} == 1 ) {
 181             $template->param( CAN_user_circulate => 1 );
 182         }
 183
 184         if ( $flags && $flags->{catalogue} == 1 ) {
 185             $template->param( CAN_user_catalogue => 1 );
 186         }
 187
 188         if ( $flags && $flags->{parameters} == 1 ) {
 189             $template->param( CAN_user_parameters => 1 );
 190             $template->param( CAN_user_management => 1 );
 191         }
 192
 193         if ( $flags && $flags->{borrowers} == 1 ) {
 194             $template->param( CAN_user_borrowers => 1 );
 195         }
 196
 197         if ( $flags && $flags->{permissions} == 1 ) {
 198             $template->param( CAN_user_permission => 1 );
 199         }
 200
 201         if ( $flags && $flags->{reserveforothers} == 1 ) {
 202             $template->param( CAN_user_reserveforothers => 1 );
 203         }
 204
 205         if ( $flags && $flags->{borrow} == 1 ) {
 206             $template->param( CAN_user_borrow => 1 );
 207         }
 208
 209         if ( $flags && $flags->{editcatalogue} == 1 ) {
 210             $template->param( CAN_user_editcatalogue => 1 );
 211         }
 212
 213         if ( $flags && $flags->{updatecharges} == 1 ) {
 214             $template->param( CAN_user_updatecharges => 1 );
 215         }
 216
 217         if ( $flags && $flags->{acquisition} == 1 ) {
 218             $template->param( CAN_user_acquisition => 1 );
 219         }
 220
 221         if ( $flags && $flags->{tools} == 1 ) {
 222             $template->param( CAN_user_tools => 1 );
 223         }
 224
 225         if ( $flags && $flags->{editauthorities} == 1 ) {
 226             $template->param( CAN_user_editauthorities => 1 );
 227         }
 228
 229         if ( $flags && $flags->{serials} == 1 ) {
 230             $template->param( CAN_user_serials => 1 );
 231         }
 232
 233         if ( $flags && $flags->{reports} == 1 ) {
 234             $template->param( CAN_user_reports => 1 );
 235         }
 236         if ( $flags && $flags->{staffaccess} == 1 ) {
 237             $template->param( CAN_user_staffaccess => 1 );
 238         }
 239     }
 240     if ( $in->{'type'} eq "intranet" ) {
 241         $template->param(
 242             intranetcolorstylesheet => C4::Context->preference("intranetcolorstylesheet"),
 243             intranetstylesheet => C4::Context->preference("intranetstylesheet"),
 244             IntranetNav        => C4::Context->preference("IntranetNav"),
 245             intranetuserjs     => C4::Context->preference("intranetuserjs"),
 246             TemplateEncoding   => C4::Context->preference("TemplateEncoding"),
 247             AmazonContent      => C4::Context->preference("AmazonContent"),
 248             LibraryName        => C4::Context->preference("LibraryName"),
 249             LoginBranchcode    => (C4::Context->userenv?C4::Context->userenv->{"branch"}:"insecure"),
 250             LoginBranchname    => (C4::Context->userenv?C4::Context->userenv->{"branchname"}:"insecure"),
 251             LoginFirstname     => (C4::Context->userenv?C4::Context->userenv->{"firstname"}:"Bel"),
 252             LoginSurname       => C4::Context->userenv?C4::Context->userenv->{"surname"}:"Inconnu",
 253             AutoLocation       => C4::Context->preference("AutoLocation"),
 254             hide_marc          => C4::Context->preference("hide_marc"),
 255             patronimages       => C4::Context->preference("patronimages"),
 256             "BiblioDefaultView".C4::Context->preference("IntranetBiblioDefaultView") => 1,
 257             advancedMARCEditor      => C4::Context->preference("advancedMARCEditor"),
 258             suggestion              => C4::Context->preference("suggestion"),
 259             virtualshelves          => C4::Context->preference("virtualshelves"),
 260             LibraryName             => C4::Context->preference("LibraryName"),
 261             KohaAdminEmailAddress   => "" . C4::Context->preference("KohaAdminEmailAddress"),
 262             IntranetmainUserblock   => C4::Context->preference("IntranetmainUserblock"),
 263             IndependantBranches     => C4::Context->preference("IndependantBranches"),
 264                         CircAutocompl => C4::Context->preference("CircAutocompl"),
 265                         yuipath => C4::Context->preference("yuipath"),
 266                         FRBRizeEditions => C4::Context->preference("FRBRizeEditions"),
 267                         AmazonSimilarItems => C4::Context->preference("AmazonSimilarItems"),
 268                         'item-level_itypes' => C4::Context->preference('item-level_itypes'),
 269                         canreservefromotherbranches => C4::Context->preference('canreservefromotherbranches'),
 270                         intranetreadinghistory => C4::Context->preference("intranetreadinghistory"),
 271                         noItemTypeImages => C4::Context->preference("noItemTypeImages"),
 272         );
 273     }
 274     else {
 275         warn "template type should be OPAC, here it is=[" . $in->{'type'} . "]" unless ( $in->{'type'} eq 'opac' );
 276         my $LibraryNameTitle = C4::Context->preference("LibraryName");
 277         $LibraryNameTitle =~ s/<(?:\/?)(?:br|p)\s*(?:\/?)>/ /sgi;
 278         $LibraryNameTitle =~ s/<(?:[^<>'"]|'(?:[^']*)'|"(?:[^"]*)")*>//sg;
 279   $template->param(
 280             KohaAdminEmailAddress  => "" . C4::Context->preference("KohaAdminEmailAddress"),
 281             AnonSuggestions =>  "" . C4::Context->preference("AnonSuggestions"),
 282             suggestion             => "" . C4::Context->preference("suggestion"),
 283             virtualshelves         => "" . C4::Context->preference("virtualshelves"),
 284             OpacNav                => "" . C4::Context->preference("OpacNav"),
 285             opacheader             => "" . C4::Context->preference("opacheader"),
 286             opaccredits            => "" . C4::Context->preference("opaccredits"),
 287             opacsmallimage         => "" . C4::Context->preference("opacsmallimage"),
 288             opaclargeimage         => "" . C4::Context->preference("opaclargeimage"),
 289             opaclayoutstylesheet   => "". C4::Context->preference("opaclayoutstylesheet"),
 290             opaccolorstylesheet    => "". C4::Context->preference("opaccolorstylesheet"),
 291             opaclanguagesdisplay   => "". C4::Context->preference("opaclanguagesdisplay"),
 292             opacuserlogin          => "" . C4::Context->preference("opacuserlogin"),
 293             opacbookbag            => "" . C4::Context->preference("opacbookbag"),
 294             TemplateEncoding       => "". C4::Context->preference("TemplateEncoding"),
 295             AmazonContent          => "" . C4::Context->preference("AmazonContent"),
 296             LibraryName            => "" . C4::Context->preference("LibraryName"),
 297             LibraryNameTitle       => "" . $LibraryNameTitle,
 298             LoginBranchcode        => (C4::Context->userenv?C4::Context->userenv->{"branch"}:"insecure"),
 299             LoginBranchname        => C4::Context->userenv?C4::Context->userenv->{"branchname"}:"",
 300             LoginFirstname        => (C4::Context->userenv?C4::Context->userenv->{"firstname"}:"Bel"),
 301             LoginSurname        => C4::Context->userenv?C4::Context->userenv->{"surname"}:"Inconnu",
 302             OpacPasswordChange     => C4::Context->preference("OpacPasswordChange"),
 303             opacreadinghistory     => C4::Context->preference("opacreadinghistory"),
 304             opacuserjs             => C4::Context->preference("opacuserjs"),
 305             OpacCloud              => C4::Context->preference("OpacCloud"),
 306             OpacTopissue           => C4::Context->preference("OpacTopissue"),
 307             OpacAuthorities        => C4::Context->preference("OpacAuthorities"),
 308             OpacBrowser            => C4::Context->preference("OpacBrowser"),
 309             RequestOnOpac          => C4::Context->preference("RequestOnOpac"),
 310             reviewson              => C4::Context->preference("reviewson"),
 311             hide_marc              => C4::Context->preference("hide_marc"),
 312             patronimages           => C4::Context->preference("patronimages"),
 313             mylibraryfirst   => C4::Context->preference("SearchMyLibraryFirst"),
 314             "BiblioDefaultView".C4::Context->preference("BiblioDefaultView") => 1,
 315             OPACFRBRizeEditions => C4::Context->preference("OPACFRBRizeEditions"),
 316             'item-level_itypes' => C4::Context->preference('item-level_itypes'),
 317         );
 318     }
 319     return ( $template, $borrowernumber, $cookie, $flags);
 320 }
 321
 322 =item checkauth
 323
 324   ($userid, $cookie, $sessionID) = &checkauth($query, $noauth, $flagsrequired, $type);
 325
 326 Verifies that the user is authorized to run this script.  If
 327 the user is authorized, a (userid, cookie, session-id, flags)
 328 quadruple is returned.  If the user is not authorized but does
 329 not have the required privilege (see $flagsrequired below), it
 330 displays an error page and exits.  Otherwise, it displays the
 331 login page and exits.
 332
 333 Note that C<&checkauth> will return if and only if the user
 334 is authorized, so it should be called early on, before any
 335 unfinished operations (e.g., if you've opened a file, then
 336 C<&checkauth> won't close it for you).
 337
 338 C<$query> is the CGI object for the script calling C<&checkauth>.
 339
 340 The C<$noauth> argument is optional. If it is set, then no
 341 authorization is required for the script.
 342
 343 C<&checkauth> fetches user and session information from C<$query> and
 344 ensures that the user is authorized to run scripts that require
 345 authorization.
 346
 347 The C<$flagsrequired> argument specifies the required privileges
 348 the user must have if the username and password are correct.
 349 It should be specified as a reference-to-hash; keys in the hash
 350 should be the "flags" for the user, as specified in the Members
 351 intranet module. Any key specified must correspond to a "flag"
 352 in the userflags table. E.g., { circulate => 1 } would specify
 353 that the user must have the "circulate" privilege in order to
 354 proceed. To make sure that access control is correct, the
 355 C<$flagsrequired> parameter must be specified correctly.
 356
 357 The C<$type> argument specifies whether the template should be
 358 retrieved from the opac or intranet directory tree.  "opac" is
 359 assumed if it is not specified; however, if C<$type> is specified,
 360 "intranet" is assumed if it is not "opac".
 361
 362 If C<$query> does not have a valid session ID associated with it
 363 (i.e., the user has not logged in) or if the session has expired,
 364 C<&checkauth> presents the user with a login page (from the point of
 365 view of the original script, C<&checkauth> does not return). Once the
 366 user has authenticated, C<&checkauth> restarts the original script
 367 (this time, C<&checkauth> returns).
 368
 369 The login page is provided using a HTML::Template, which is set in the
 370 systempreferences table or at the top of this file. The variable C<$type>
 371 selects which template to use, either the opac or the intranet
 372 authentification template.
 373
 374 C<&checkauth> returns a user ID, a cookie, and a session ID. The
 375 cookie should be sent back to the browser; it verifies that the user
 376 has authenticated.
 377
 378 =cut
 379
 380 sub _version_check ($$) {
 381     my $type = shift;
 382     my $query = shift;
 383     my $version;
 384     # If Version syspref is unavailable, it means Koha is beeing installed,
 385     # and so we must redirect to OPAC maintenance page or to the WebInstaller
 386     #warn "about to check version";
 387     unless ($version = C4::Context->preference('Version')) {    # assignment, not comparison
 388       if ($type ne 'opac') {
 389         warn "Install required, redirecting to Installer";
 390         print $query->redirect("/cgi-bin/koha/installer/install.pl");
 391       }
 392       else {
 393         warn "OPAC Install required, redirecting to maintenance";
 394         print $query->redirect("/cgi-bin/koha/maintenance.pl");
 395       }
 396       exit;
 397     }
 398
 399     # check that database and koha version are the same
 400     # there is no DB version, it's a fresh install,
 401     # go to web installer
 402     # there is a DB version, compare it to the code version
 403     my $kohaversion=C4::Context::KOHAVERSION;
 404     # remove the 3 last . to have a Perl number
 405     $kohaversion =~ s/(.*\..*)\.(.*)\.(.*)/$1$2$3/;
 406     $debug and print STDERR "kohaversion : $kohaversion\n";
 407     if ($version < $kohaversion){
 408         my $warning = "Database update needed, redirecting to %s. Database is $version and Koha is "
 409             . C4::Context->config("kohaversion");
 410         if ($type ne 'opac'){
 411             warn sprintf($warning, 'Installer');
 412             print $query->redirect("/cgi-bin/koha/installer/install.pl?step=3");
 413         } else {
 414             warn sprintf("OPAC: " . $warning, 'maintenance');
 415             print $query->redirect("/cgi-bin/koha/maintenance.pl");
 416         }
 417         exit;
 418     }
 419 }
 420
 421 sub _session_log {
 422     (@_) or return 0;
 423     open L, ">>/tmp/sessionlog" or warn "ERROR: Cannot append to /tmp/sessionlog";
 424     printf L join("\n",@_);
 425     close L;
 426 }
 427
 428 sub checkauth {
 429     my $query = shift;
 430   # warn "Checking Auth";
 431     # $authnotrequired will be set for scripts which will run without authentication
 432     my $authnotrequired = shift;
 433     my $flagsrequired   = shift;
 434     my $type            = shift;
 435     $type = 'opac' unless $type;
 436
 437     my $dbh     = C4::Context->dbh;
 438     my $timeout = C4::Context->preference('timeout');
 439     # days
 440     if ($timeout =~ /(\d+)[dD]/) {
 441         $timeout = $1 * 86400;
 442     };
 443     $timeout = 600 unless $timeout;
 444
 445     _version_check($type,$query);
 446     # state variables
 447     my $loggedin = 0;
 448     my %info;
 449     my ( $userid, $cookie, $sessionID, $flags );
 450     my $logout = $query->param('logout.x');
 451     if ( $userid = $ENV{'REMOTE_USER'} ) {
 452         # Using Basic Authentication, no cookies required
 453         $cookie = $query->cookie(
 454             -name    => 'CGISESSID',
 455             -value   => '',
 456             -expires => ''
 457         );
 458         $loggedin = 1;
 459     }
 460     elsif ( $sessionID = $query->cookie("CGISESSID")) {     # assignment, not comparison
 461         my $session = get_session($sessionID);
 462         C4::Context->_new_userenv($sessionID);
 463         my ($ip, $lasttime);
 464         if ($session){
 465             C4::Context::set_userenv(
 466                 $session->param('number'),       $session->param('id'),
 467                 $session->param('cardnumber'),   $session->param('firstname'),
 468                 $session->param('surname'),      $session->param('branch'),
 469                 $session->param('branchname'),   $session->param('flags'),
 470                 $session->param('emailaddress'), $session->param('branchprinter')
 471             );
 472             $debug and printf STDERR "AUTH_SESSION: (%s)\t%s %s - %s\n", map {$session->param($_)} qw(cardnumber firstname surname branch) ;
 473             $ip       = $session->param('ip');
 474             $lasttime = $session->param('lasttime');
 475             $userid   = $session->param('id');
 476         }
 477
 478         if ($logout) {
 479             # voluntary logout the user
 480             $session->flush;
 481             $session->delete();
 482             C4::Context->_unset_userenv($sessionID);
 483             _session_log(sprintf "%20s from %16s logged out at %30s (manually).\n", $userid,$ip,localtime);
 484             $sessionID = undef;
 485             $userid    = undef;
 486         }
 487         if ($userid) {
 488             if ( $lasttime < time() - $timeout ) {
 489                 # timed logout
 490                 $info{'timed_out'} = 1;
 491                 $session->delete();
 492                 C4::Context->_unset_userenv($sessionID);
 493                 _session_log(sprintf "%20s from %16s logged out at %30s (inactivity).\n", $userid,$ip,localtime);
 494                 $userid    = undef;
 495                 $sessionID = undef;
 496             }
 497             elsif ( $ip ne $ENV{'REMOTE_ADDR'} ) {
 498                 # Different ip than originally logged in from
 499                 $info{'oldip'}        = $ip;
 500                 $info{'newip'}        = $ENV{'REMOTE_ADDR'};
 501                 $info{'different_ip'} = 1;
 502                 $session->delete();
 503                 C4::Context->_unset_userenv($sessionID);
 504                 _session_log(sprintf "%20s from %16s logged out at %30s (ip changed to %16s).\n", $userid,$ip,localtime, $info{'newip'});
 505                 $sessionID = undef;
 506                 $userid    = undef;
 507             }
 508             else {
 509                 $cookie = $query->cookie( CGISESSID => $session->id );
 510                 $session->param('lasttime',time());
 511                 $flags = haspermission( $dbh, $userid, $flagsrequired );
 512                 if ($flags) {
 513                     $loggedin = 1;
 514                 }
 515                 else {
 516                     $info{'nopermission'} = 1;
 517                 }
 518             }
 519         }
 520     }
 521     unless ($userid) {
 522         my $session = get_session("");
 523         my $sessionID;
 524         if ($session) {
 525             $sessionID = $session->id;
 526         }
 527         $userid    = $query->param('userid');
 528         C4::Context->_new_userenv($sessionID);
 529         my $password = $query->param('password');
 530         C4::Context->_new_userenv($sessionID);
 531         my ( $return, $cardnumber ) = checkpw( $dbh, $userid, $password );
 532         if ($return) {
 533             _session_log(sprintf "%20s from %16s logged in  at %30s.\n", $userid,$ENV{'REMOTE_ADDR'},localtime);
 534             $cookie = $query->cookie(CGISESSID => $sessionID);
 535             if ( $flags = haspermission( $dbh, $userid, $flagsrequired ) ) {
 536                                 $loggedin = 1;
 537             }
 538             else {
 539                 $info{'nopermission'} = 1;
 540                 C4::Context->_unset_userenv($sessionID);
 541             }
 542             if ( $return == 1 ) {
 543                 my (
 544                    $borrowernumber, $firstname, $surname, $userflags,
 545                    $branchcode, $branchname, $branchprinter, $emailaddress
 546                 );
 547                 my $select = "
 548                 SELECT borrowernumber, firstname, surname, flags, borrowers.branchcode,
 549                         branches.branchname    as branchname,
 550                         branches.branchprinter as branchprinter,
 551                         email
 552                 FROM borrowers
 553                 LEFT JOIN branches on borrowers.branchcode=branches.branchcode
 554                 ";
 555                 my $sth = $dbh->prepare("$select where userid=?");
 556                 $sth->execute($userid);
 557                 ($sth->rows) and (
 558                     $borrowernumber, $firstname, $surname, $userflags,
 559                     $branchcode, $branchname, $branchprinter, $emailaddress
 560                 ) = $sth->fetchrow;
 561
 562                 $debug and print STDERR "AUTH_1: $cardnumber,$borrowernumber,$userid,$firstname,$surname,$userflags,$branchcode,$emailaddress\n";
 563                 unless ( $sth->rows ) {
 564                     my $sth = $dbh->prepare("$select where cardnumber=?");
 565                     $sth->execute($cardnumber);
 566                     ($sth->rows) and (
 567                         $borrowernumber, $firstname, $surname, $userflags,
 568                         $branchcode, $branchname, $branchprinter, $emailaddress
 569                     ) = $sth->fetchrow;
 570
 571                     $debug and print STDERR "AUTH_2: $cardnumber,$borrowernumber,$userid,$firstname,$surname,$userflags,$branchcode,$emailaddress\n";
 572                     unless ( $sth->rows ) {
 573                         $sth->execute($userid);
 574                         ($sth->rows) and (
 575                             $borrowernumber, $firstname, $surname, $userflags,
 576                             $branchcode, $branchname, $branchprinter, $emailaddress
 577                         ) = $sth->fetchrow;
 578                     }
 579                 }
 580
 581 # launch a sequence to check if we have a ip for the branch, i
 582 # if we have one we replace the branchcode of the userenv by the branch bound in the ip.
 583
 584                 my $ip       = $ENV{'REMOTE_ADDR'};
 585                 # if they specify at login, use that
 586                 if ($query->param('branch')) {
 587                     $branchcode  = $query->param('branch');
 588                     $branchname = GetBranchName($branchcode);
 589                 }
 590                 my $branches = GetBranches();
 591                 if (C4::Context->boolean_preference('IndependantBranches') && C4::Context->boolean_preference('Autolocation')){
 592                                     # we have to check they are coming from the right ip range
 593                                         my $domain = $branches->{$branchcode}->{'branchip'};
 594                                         if ($ip !~ /^$domain/){
 595                                                 $loggedin=0;
 596                                                 $info{'wrongip'} = 1;
 597                                         }
 598                                 }
 599
 600                 my @branchesloop;
 601                 foreach my $br ( keys %$branches ) {
 602                     #     now we work with the treatment of ip
 603                     my $domain = $branches->{$br}->{'branchip'};
 604                     if ( $domain && $ip =~ /^$domain/ ) {
 605                         $branchcode = $branches->{$br}->{'branchcode'};
 606
 607                         # new op dev : add the branchprinter and branchname in the cookie
 608                         $branchprinter = $branches->{$br}->{'branchprinter'};
 609                         $branchname    = $branches->{$br}->{'branchname'};
 610                     }
 611                 }
 612                 $session->param('number',$borrowernumber);
 613                 $session->param('id',$userid);
 614                 $session->param('cardnumber',$cardnumber);
 615                 $session->param('firstname',$firstname);
 616                 $session->param('surname',$surname);
 617                 $session->param('branch',$branchcode);
 618                 $session->param('branchname',$branchname);
 619                 $session->param('flags',$userflags);
 620                 $session->param('emailaddress',$emailaddress);
 621                 $session->param('ip',$session->remote_addr());
 622                 $session->param('lasttime',time());
 623                 $debug and printf STDERR "AUTH_3: (%s)\t%s %s - %s\n", map {$session->param($_)} qw(cardnumber firstname surname branch) ;
 624             }
 625             elsif ( $return == 2 ) {
 626                 #We suppose the user is the superlibrarian
 627                 $session->param('number',0);
 628                 $session->param('id',C4::Context->config('user'));
 629                 $session->param('cardnumber',C4::Context->config('user'));
 630                 $session->param('firstname',C4::Context->config('user'));
 631                 $session->param('surname',C4::Context->config('user'));
 632                 $session->param('branch','NO_LIBRARY_SET');
 633                 $session->param('branchname','NO_LIBRARY_SET');
 634                 $session->param('flags',1);
 635                 $session->param('emailaddress', C4::Context->preference('KohaAdminEmailAddress'));
 636                 $session->param('ip',$session->remote_addr());
 637                 $session->param('lasttime',time());
 638             }
 639             if ($session) {
 640                 C4::Context::set_userenv(
 641                 $session->param('number'),       $session->param('id'),
 642                 $session->param('cardnumber'),   $session->param('firstname'),
 643                 $session->param('surname'),      $session->param('branch'),
 644                 $session->param('branchname'),   $session->param('flags'),
 645                 $session->param('emailaddress'), $session->param('branchprinter')
 646                 );
 647             }
 648         }
 649         else {
 650             if ($userid) {
 651                 $info{'invalid_username_or_password'} = 1;
 652                 C4::Context->_unset_userenv($sessionID);
 653             }
 654
 655         }
 656     }
 657     my $insecure = C4::Context->boolean_preference('insecure');
 658
 659     # finished authentification, now respond
 660     if ( $loggedin || $authnotrequired || ( defined($insecure) && $insecure ) )
 661     {
 662         # successful login
 663         unless ($cookie) {
 664             $cookie = $query->cookie( CGISESSID => '' );
 665         }
 666         return ( $userid, $cookie, $sessionID, $flags );
 667     }
 668
 669 #
 670 #
 671 # AUTH rejected, show the login/password template, after checking the DB.
 672 #
 673 #
 674
 675     # get the inputs from the incoming query
 676     my @inputs = ();
 677     foreach my $name ( param $query) {
 678         (next) if ( $name eq 'userid' || $name eq 'password' );
 679         my $value = $query->param($name);
 680         push @inputs, { name => $name, value => $value };
 681     }
 682     # get the branchloop, which we need for authentication
 683     my $branches = GetBranches();
 684     my @branch_loop;
 685     for my $branch_hash (keys %$branches) {
 686                 push @branch_loop, {branchcode => "$branch_hash", branchname => $branches->{$branch_hash}->{'branchname'}, };
 687     }
 688
 689     my $template_name = ( $type eq 'opac' ) ? 'opac-auth.tmpl' : 'auth.tmpl';
 690     my $template = gettemplate( $template_name, $type, $query );
 691     $template->param(branchloop => \@branch_loop,);
 692     $template->param(
 693     login        => 1,
 694         INPUTS               => \@inputs,
 695         suggestion           => C4::Context->preference("suggestion"),
 696         virtualshelves       => C4::Context->preference("virtualshelves"),
 697         opaclargeimage       => C4::Context->preference("opaclargeimage"),
 698         LibraryName          => C4::Context->preference("LibraryName"),
 699         OpacNav              => C4::Context->preference("OpacNav"),
 700         opaccredits          => C4::Context->preference("opaccredits"),
 701         opacreadinghistory   => C4::Context->preference("opacreadinghistory"),
 702         opacsmallimage       => C4::Context->preference("opacsmallimage"),
 703         opaclayoutstylesheet => C4::Context->preference("opaclayoutstylesheet"),
 704         opaccolorstylesheet  => C4::Context->preference("opaccolorstylesheet"),
 705         opaclanguagesdisplay => C4::Context->preference("opaclanguagesdisplay"),
 706         opacuserjs           => C4::Context->preference("opacuserjs"),
 707         intranetcolorstylesheet =>
 708                                                                 C4::Context->preference("intranetcolorstylesheet"),
 709         intranetstylesheet => C4::Context->preference("intranetstylesheet"),
 710         IntranetNav        => C4::Context->preference("IntranetNav"),
 711         intranetuserjs     => C4::Context->preference("intranetuserjs"),
 712         TemplateEncoding   => C4::Context->preference("TemplateEncoding"),
 713         IndependantBranches=> C4::Context->preference("IndependantBranches"),
 714         AutoLocation       => C4::Context->preference("AutoLocation"),
 715         yuipath            => C4::Context->preference("yuipath"),
 716                 wrongip            => $info{'wrongip'}
 717     );
 718
 719     $template->param( loginprompt => 1 ) unless $info{'nopermission'};
 720
 721     my $self_url = $query->url( -absolute => 1 );
 722     $template->param(
 723         url         => $self_url,
 724         LibraryName => C4::Context->preference("LibraryName"),
 725     );
 726     $template->param( \%info );
 727 #    $cookie = $query->cookie(CGISESSID => $session->id
 728 #   );
 729     print $query->header(
 730         -type   => 'text/html',
 731         -charset => 'utf-8',
 732         -cookie => $cookie
 733       ),
 734       $template->output;
 735     exit;
 736 }
 737
 738 =item check_api_auth
 739
 740   ($status, $cookie, $sessionId) = check_api_auth($query, $userflags);
 741
 742 Given a CGI query containing the parameters 'userid' and 'password' and/or a session
 743 cookie, determine if the user has the privileges specified by C<$userflags>.
 744
 745 C<check_api_auth> is is meant for authenticating users of web services, and
 746 consequently will always return and will not attempt to redirect the user
 747 agent.
 748
 749 If a valid session cookie is already present, check_api_auth will return a status
 750 of "ok", the cookie, and the Koha session ID.
 751
 752 If no session cookie is present, check_api_auth will check the 'userid' and 'password
 753 parameters and create a session cookie and Koha session if the supplied credentials
 754 are OK.
 755
 756 Possible return values in C<$status> are:
 757
 758 =over 4
 759
 760 =item "ok" -- user authenticated; C<$cookie> and C<$sessionid> have valid values.
 761
 762 =item "failed" -- credentials are not correct; C<$cookie> and C<$sessionid> are undef
 763
 764 =item "maintenance" -- DB is in maintenance mode; no login possible at the moment
 765
 766 =item "expired -- session cookie has expired; API user should resubmit userid and password
 767
 768 =back
 769
 770 =cut
 771
 772 sub check_api_auth {
 773     my $query = shift;
 774     my $flagsrequired = shift;
 775
 776     my $dbh     = C4::Context->dbh;
 777     my $timeout = C4::Context->preference('timeout');
 778     $timeout = 600 unless $timeout;
 779
 780     unless (C4::Context->preference('Version')) {
 781         # database has not been installed yet
 782         return ("maintenance", undef, undef);
 783     }
 784     my $kohaversion=C4::Context::KOHAVERSION;
 785     $kohaversion =~ s/(.*\..*)\.(.*)\.(.*)/$1$2$3/;
 786     if (C4::Context->preference('Version') < $kohaversion) {
 787         # database in need of version update; assume that
 788         # no API should be called while databsae is in
 789         # this condition.
 790         return ("maintenance", undef, undef);
 791     }
 792
 793     # FIXME -- most of what follows is a copy-and-paste
 794     # of code from checkauth.  There is an obvious need
 795     # for refactoring to separate the various parts of
 796     # the authentication code, but as of 2007-11-19 this
 797     # is deferred so as to not introduce bugs into the
 798     # regular authentication code for Koha 3.0.
 799
 800     # see if we have a valid session cookie already
 801     # however, if a userid parameter is present (i.e., from
 802     # a form submission, assume that any current cookie
 803     # is to be ignored
 804     my $sessionID = undef;
 805     unless ($query->param('userid')) {
 806         $sessionID = $query->cookie("CGISESSID");
 807     }
 808     if ($sessionID) {
 809         my $session = get_session($sessionID);
 810         C4::Context->_new_userenv($sessionID);
 811         if ($session) {
 812             C4::Context::set_userenv(
 813                 $session->param('number'),       $session->param('id'),
 814                 $session->param('cardnumber'),   $session->param('firstname'),
 815                 $session->param('surname'),      $session->param('branch'),
 816                 $session->param('branchname'),   $session->param('flags'),
 817                 $session->param('emailaddress'), $session->param('branchprinter')
 818             );
 819
 820             my $ip = $session->param('ip');
 821             my $lasttime = $session->param('lasttime');
 822             my $userid = $session->param('id');
 823             if ( $lasttime < time() - $timeout ) {
 824                 # time out
 825                 $session->delete();
 826                 C4::Context->_unset_userenv($sessionID);
 827                 $userid    = undef;
 828                 $sessionID = undef;
 829                 return ("expired", undef, undef);
 830             } elsif ( $ip ne $ENV{'REMOTE_ADDR'} ) {
 831                 # IP address changed
 832                 $session->delete();
 833                 C4::Context->_unset_userenv($sessionID);
 834                 $userid    = undef;
 835                 $sessionID = undef;
 836                 return ("expired", undef, undef);
 837             } else {
 838                 my $cookie = $query->cookie( CGISESSID => $session->id );
 839                 $session->param('lasttime',time());
 840                 my $flags = haspermission( $dbh, $userid, $flagsrequired );
 841                 if ($flags) {
 842                     return ("ok", $cookie, $sessionID);
 843                 } else {
 844                     $session->delete();
 845                     C4::Context->_unset_userenv($sessionID);
 846                     $userid    = undef;
 847                     $sessionID = undef;
 848                     return ("failed", undef, undef);
 849                 }
 850             }
 851         } else {
 852             return ("expired", undef, undef);
 853         }
 854     } else {
 855         # new login
 856         my $userid = $query->param('userid');
 857         my $password = $query->param('password');
 858         unless ($userid and $password) {
 859             # caller did something wrong, fail the authenticateion
 860             return ("failed", undef, undef);
 861         }
 862         my ( $return, $cardnumber ) = checkpw( $dbh, $userid, $password );
 863         if ($return and haspermission( $dbh, $userid, $flagsrequired)) {
 864             my $session = get_session("");
 865             return ("failed", undef, undef) unless $session;
 866
 867             my $sessionID = $session->id;
 868             C4::Context->_new_userenv($sessionID);
 869             my $cookie = $query->cookie(CGISESSID => $sessionID);
 870             if ( $return == 1 ) {
 871                 my (
 872                     $borrowernumber, $firstname,  $surname,
 873                     $userflags,      $branchcode, $branchname,
 874                     $branchprinter,  $emailaddress
 875                 );
 876                 my $sth =
 877                   $dbh->prepare(
 878 "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=?"
 879                   );
 880                 $sth->execute($userid);
 881                 (
 882                     $borrowernumber, $firstname,  $surname,
 883                     $userflags,      $branchcode, $branchname,
 884                     $branchprinter,  $emailaddress
 885                 ) = $sth->fetchrow if ( $sth->rows );
 886
 887                 unless ($sth->rows ) {
 888                     my $sth = $dbh->prepare(
 889 "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=?"
 890                       );
 891                     $sth->execute($cardnumber);
 892                     (
 893                         $borrowernumber, $firstname,  $surname,
 894                         $userflags,      $branchcode, $branchname,
 895                         $branchprinter,  $emailaddress
 896                     ) = $sth->fetchrow if ( $sth->rows );
 897
 898                     unless ( $sth->rows ) {
 899                         $sth->execute($userid);
 900                         (
 901                             $borrowernumber, $firstname, $surname, $userflags,
 902                             $branchcode, $branchname, $branchprinter, $emailaddress
 903                         ) = $sth->fetchrow if ( $sth->rows );
 904                     }
 905                 }
 906
 907                 my $ip       = $ENV{'REMOTE_ADDR'};
 908                 # if they specify at login, use that
 909                 if ($query->param('branch')) {
 910                     $branchcode  = $query->param('branch');
 911                     $branchname = GetBranchName($branchcode);
 912                 }
 913                 my $branches = GetBranches();
 914                 my @branchesloop;
 915                 foreach my $br ( keys %$branches ) {
 916                     #     now we work with the treatment of ip
 917                     my $domain = $branches->{$br}->{'branchip'};
 918                     if ( $domain && $ip =~ /^$domain/ ) {
 919                         $branchcode = $branches->{$br}->{'branchcode'};
 920
 921                         # new op dev : add the branchprinter and branchname in the cookie
 922                         $branchprinter = $branches->{$br}->{'branchprinter'};
 923                         $branchname    = $branches->{$br}->{'branchname'};
 924                     }
 925                 }
 926                 $session->param('number',$borrowernumber);
 927                 $session->param('id',$userid);
 928                 $session->param('cardnumber',$cardnumber);
 929                 $session->param('firstname',$firstname);
 930                 $session->param('surname',$surname);
 931                 $session->param('branch',$branchcode);
 932                 $session->param('branchname',$branchname);
 933                 $session->param('flags',$userflags);
 934                 $session->param('emailaddress',$emailaddress);
 935                 $session->param('ip',$session->remote_addr());
 936                 $session->param('lasttime',time());
 937             } elsif ( $return == 2 ) {
 938                 #We suppose the user is the superlibrarian
 939                 $session->param('number',0);
 940                 $session->param('id',C4::Context->config('user'));
 941                 $session->param('cardnumber',C4::Context->config('user'));
 942                 $session->param('firstname',C4::Context->config('user'));
 943                 $session->param('surname',C4::Context->config('user'));
 944                 $session->param('branch','NO_LIBRARY_SET');
 945                 $session->param('branchname','NO_LIBRARY_SET');
 946                 $session->param('flags',1);
 947                 $session->param('emailaddress', C4::Context->preference('KohaAdminEmailAddress'));
 948                 $session->param('ip',$session->remote_addr());
 949                 $session->param('lasttime',time());
 950             }
 951             C4::Context::set_userenv(
 952                 $session->param('number'),       $session->param('id'),
 953                 $session->param('cardnumber'),   $session->param('firstname'),
 954                 $session->param('surname'),      $session->param('branch'),
 955                 $session->param('branchname'),   $session->param('flags'),
 956                 $session->param('emailaddress'), $session->param('branchprinter')
 957             );
 958             return ("ok", $cookie, $sessionID);
 959         } else {
 960             return ("failed", undef, undef);
 961         }
 962     }
 963 }
 964
 965 =item check_cookie_auth
 966
 967   ($status, $sessionId) = check_api_auth($cookie, $userflags);
 968
 969 Given a CGISESSID cookie set during a previous login to Koha, determine
 970 if the user has the privileges specified by C<$userflags>.
 971
 972 C<check_cookie_auth> is meant for authenticating special services
 973 such as tools/upload-file.pl that are invoked by other pages that
 974 have been authenticated in the usual way.
 975
 976 Possible return values in C<$status> are:
 977
 978 =over 4
 979
 980 =item "ok" -- user authenticated; C<$sessionID> have valid values.
 981
 982 =item "failed" -- credentials are not correct; C<$sessionid> are undef
 983
 984 =item "maintenance" -- DB is in maintenance mode; no login possible at the moment
 985
 986 =item "expired -- session cookie has expired; API user should resubmit userid and password
 987
 988 =back
 989
 990 =cut
 991
 992 sub check_cookie_auth {
 993     my $cookie = shift;
 994     my $flagsrequired = shift;
 995
 996     my $dbh     = C4::Context->dbh;
 997     my $timeout = C4::Context->preference('timeout');
 998     $timeout = 600 unless $timeout;
 999
1000     unless (C4::Context->preference('Version')) {
1001         # database has not been installed yet
1002         return ("maintenance", undef);
1003     }
1004     my $kohaversion=C4::Context::KOHAVERSION;
1005     $kohaversion =~ s/(.*\..*)\.(.*)\.(.*)/$1$2$3/;
1006     if (C4::Context->preference('Version') < $kohaversion) {
1007         # database in need of version update; assume that
1008         # no API should be called while databsae is in
1009         # this condition.
1010         return ("maintenance", undef);
1011     }
1012
1013     # FIXME -- most of what follows is a copy-and-paste
1014     # of code from checkauth.  There is an obvious need
1015     # for refactoring to separate the various parts of
1016     # the authentication code, but as of 2007-11-23 this
1017     # is deferred so as to not introduce bugs into the
1018     # regular authentication code for Koha 3.0.
1019
1020     # see if we have a valid session cookie already
1021     # however, if a userid parameter is present (i.e., from
1022     # a form submission, assume that any current cookie
1023     # is to be ignored
1024     unless (defined $cookie and $cookie) {
1025         return ("failed", undef);
1026     }
1027     my $sessionID = $cookie;
1028     my $session = get_session($sessionID);
1029     C4::Context->_new_userenv($sessionID);
1030     if ($session) {
1031         C4::Context::set_userenv(
1032             $session->param('number'),       $session->param('id'),
1033             $session->param('cardnumber'),   $session->param('firstname'),
1034             $session->param('surname'),      $session->param('branch'),
1035             $session->param('branchname'),   $session->param('flags'),
1036             $session->param('emailaddress'), $session->param('branchprinter')
1037         );
1038
1039         my $ip = $session->param('ip');
1040         my $lasttime = $session->param('lasttime');
1041         my $userid = $session->param('id');
1042         if ( $lasttime < time() - $timeout ) {
1043             # time out
1044             $session->delete();
1045             C4::Context->_unset_userenv($sessionID);
1046             $userid    = undef;
1047             $sessionID = undef;
1048             return ("expired", undef);
1049         } elsif ( $ip ne $ENV{'REMOTE_ADDR'} ) {
1050             # IP address changed
1051             $session->delete();
1052             C4::Context->_unset_userenv($sessionID);
1053             $userid    = undef;
1054             $sessionID = undef;
1055             return ("expired", undef);
1056         } else {
1057             $session->param('lasttime',time());
1058             my $flags = haspermission( $dbh, $userid, $flagsrequired );
1059             if ($flags) {
1060                 return ("ok", $sessionID);
1061             } else {
1062                 $session->delete();
1063                 C4::Context->_unset_userenv($sessionID);
1064                 $userid    = undef;
1065                 $sessionID = undef;
1066                 return ("failed", undef);
1067             }
1068         }
1069     } else {
1070         return ("expired", undef);
1071     }
1072 }
1073
1074 =item get_session
1075
1076   use CGI::Session;
1077   my $session = get_session($sessionID);
1078
1079 Given a session ID, retrieve the CGI::Session object used to store
1080 the session's state.  The session object can be used to store
1081 data that needs to be accessed by different scripts during a
1082 user's session.
1083
1084 If the C<$sessionID> parameter is an empty string, a new session
1085 will be created.
1086
1087 =cut
1088
1089 sub get_session {
1090     my $sessionID = shift;
1091     my $storage_method = C4::Context->preference('SessionStorage');
1092     my $dbh = C4::Context->dbh;
1093     my $session;
1094     if ($storage_method eq 'mysql'){
1095         $session = new CGI::Session("driver:MySQL;serializer:yaml", $sessionID, {Handle=>$dbh});
1096     }
1097     elsif ($storage_method eq 'Pg') {
1098         $session = new CGI::Session("driver:PostgreSQL;serializer:yaml", $sessionID, {Handle=>$dbh});
1099     }
1100     else {
1101         # catch all defaults to tmp should work on all systems
1102         $session = new CGI::Session("driver:File;serializer:yaml", $sessionID, {Directory=>'/tmp'});
1103     }
1104     return $session;
1105 }
1106
1107 sub checkpw {
1108
1109     my ( $dbh, $userid, $password ) = @_;
1110     if ($ldap) {
1111         $debug and print "## checkpw - checking LDAP\n";
1112         my ($retval,$retcard) = checkpw_ldap(@_);    # EXTERNAL AUTH
1113         ($retval) and return ($retval,$retcard);
1114     }
1115
1116     # INTERNAL AUTH
1117     my $sth =
1118       $dbh->prepare(
1119 "select password,cardnumber,borrowernumber,userid,firstname,surname,branchcode,flags from borrowers where userid=?"
1120       );
1121     $sth->execute($userid);
1122     if ( $sth->rows ) {
1123         my ( $md5password, $cardnumber, $borrowernumber, $userid, $firstname,
1124             $surname, $branchcode, $flags )
1125           = $sth->fetchrow;
1126         if ( md5_base64($password) eq $md5password ) {
1127
1128             C4::Context->set_userenv( "$borrowernumber", $userid, $cardnumber,
1129                 $firstname, $surname, $branchcode, $flags );
1130             return 1, $cardnumber;
1131         }
1132     }
1133     $sth =
1134       $dbh->prepare(
1135 "select password,cardnumber,borrowernumber,userid, firstname,surname,branchcode,flags from borrowers where cardnumber=?"
1136       );
1137     $sth->execute($userid);
1138     if ( $sth->rows ) {
1139         my ( $md5password, $cardnumber, $borrowernumber, $userid, $firstname,
1140             $surname, $branchcode, $flags )
1141           = $sth->fetchrow;
1142         if ( md5_base64($password) eq $md5password ) {
1143
1144             C4::Context->set_userenv( $borrowernumber, $userid, $cardnumber,
1145                 $firstname, $surname, $branchcode, $flags );
1146             return 1, $userid;
1147         }
1148     }
1149     if (   $userid && $userid eq C4::Context->config('user')
1150         && "$password" eq C4::Context->config('pass') )
1151     {
1152
1153 # Koha superuser account
1154 #     C4::Context->set_userenv(0,0,C4::Context->config('user'),C4::Context->config('user'),C4::Context->config('user'),"",1);
1155         return 2;
1156     }
1157     if (   $userid && $userid eq 'demo'
1158         && "$password" eq 'demo'
1159         && C4::Context->config('demo') )
1160     {
1161
1162 # DEMO => the demo user is allowed to do everything (if demo set to 1 in koha.conf
1163 # some features won't be effective : modify systempref, modify MARC structure,
1164         return 2;
1165     }
1166     return 0;
1167 }
1168
1169 =item getuserflags
1170
1171  $authflags = getuserflags($flags,$dbh);
1172 Translates integer flags into permissions strings hash.
1173
1174 C<$flags> is the integer userflags value ( borrowers.userflags )
1175 C<$authflags> is a hashref of permissions
1176
1177 =cut
1178
1179 sub getuserflags {
1180     my $flags   = shift;
1181     my $dbh     = shift;
1182     my $userflags;
1183     $flags = 0 unless $flags;
1184     my $sth = $dbh->prepare("SELECT bit, flag, defaulton FROM userflags");
1185     $sth->execute;
1186
1187     while ( my ( $bit, $flag, $defaulton ) = $sth->fetchrow ) {
1188         if ( ( $flags & ( 2**$bit ) ) || $defaulton ) {
1189             $userflags->{$flag} = 1;
1190         }
1191         else {
1192             $userflags->{$flag} = 0;
1193         }
1194     }
1195     return $userflags;
1196 }
1197
1198 =item haspermission
1199
1200   $flags = ($dbh,$member,$flagsrequired);
1201
1202 C<$member> may be either userid or overloaded with $borrower hashref from GetMemberDetails.
1203 C<$flags> is a hashref of required flags lik C<$borrower-&lt;{authflags}>
1204
1205 Returns member's flags or 0 if a permission is not met.
1206
1207 =cut
1208
1209 sub haspermission {
1210     my ( $dbh, $userid, $flagsrequired ) = @_;
1211     my ($flags,$intflags);
1212     $dbh=C4::Context->dbh unless($dbh);
1213     if(ref($userid)) {
1214         $intflags = $userid->{'flags'};
1215     } else {
1216         my $sth = $dbh->prepare("SELECT flags FROM borrowers WHERE userid=?");
1217         $sth->execute($userid);
1218         my ($intflags) = $sth->fetchrow;
1219         $flags = getuserflags( $intflags, $dbh );
1220     }
1221     if ( $userid eq C4::Context->config('user') ) {
1222         # Super User Account from /etc/koha.conf
1223         $flags->{'superlibrarian'} = 1;
1224     }
1225     if ( $userid eq 'demo' && C4::Context->config('demo') ) {
1226         # Demo user that can do "anything" (demo=1 in /etc/koha.conf)
1227         $flags->{'superlibrarian'} = 1;
1228     }
1229     return $flags if $flags->{superlibrarian};
1230     foreach ( keys %$flagsrequired ) {
1231         return 0 unless( $flags->{$_} );
1232     }
1233     return $flags;
1234     #FIXME - This fcn should return the failed permission so a suitable error msg can be delivered.
1235 }
1236
1237
1238 sub getborrowernumber {
1239     my ($userid) = @_;
1240     my $dbh = C4::Context->dbh;
1241     for my $field ( 'userid', 'cardnumber' ) {
1242         my $sth =
1243           $dbh->prepare("select borrowernumber from borrowers where $field=?");
1244         $sth->execute($userid);
1245         if ( $sth->rows ) {
1246             my ($bnumber) = $sth->fetchrow;
1247             return $bnumber;
1248         }
1249     }
1250     return 0;
1251 }
1252
1253 END { }    # module clean-up code here (global destructor)
1254 1;
1255 __END__
1256
1257 =back
1258
1259 =head1 SEE ALSO
1260
1261 CGI(3)
1262
1263 C4::Output(3)
1264
1265 Digest::MD5(3)
1266
1267 =cut