C4/Auth.pm

   1 # -*- tab-width: 8 -*-
   2 # NOTE: This file uses 8-character tabs; do not change the tab size!
   3
   4 package C4::Auth;
   5
   6 # Copyright 2000-2002 Katipo Communications
   7 #
   8 # This file is part of Koha.
   9 #
  10 # Koha is free software; you can redistribute it and/or modify it under the
  11 # terms of the GNU General Public License as published by the Free Software
  12 # Foundation; either version 2 of the License, or (at your option) any later
  13 # version.
  14 #
  15 # Koha is distributed in the hope that it will be useful, but WITHOUT ANY
  16 # WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
  17 # A PARTICULAR PURPOSE.  See the GNU General Public License for more details.
  18 #
  19 # You should have received a copy of the GNU General Public License along with
  20 # Koha; if not, write to the Free Software Foundation, Inc., 59 Temple Place,
  21 # Suite 330, Boston, MA  02111-1307 USA
  22
  23 use strict;
  24 use Digest::MD5 qw(md5_base64);
  25 use CGI::Session;
  26
  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 Net::LDAP;
  37 # use Net::LDAP qw(:all);
  38
  39 use vars qw($VERSION @ISA @EXPORT @EXPORT_OK %EXPORT_TAGS);
  40
  41 # set the version for version checking
  42 $VERSION = do { my @v = '$Revision$' =~ /\d+/g;
  43     shift(@v) . "." . join( "_", map { sprintf "%03d", $_ } @v );
  44 };
  45
  46 =head1 NAME
  47
  48 C4::Auth - Authenticates Koha users
  49
  50 =head1 SYNOPSIS
  51
  52   use CGI;
  53   use C4::Auth;
  54
  55   my $query = new CGI;
  56
  57   my ($template, $borrowernumber, $cookie)
  58     = get_template_and_user(
  59         {
  60             template_name   => "opac-main.tmpl",
  61             query           => $query,
  62       type            => "opac",
  63       authnotrequired => 1,
  64       flagsrequired   => {borrow => 1},
  65   }
  66     );
  67
  68   print $query->header(
  69     -type => 'utf-8',
  70     -cookie => $cookie
  71   ), $template->output;
  72
  73
  74 =head1 DESCRIPTION
  75
  76     The main function of this module is to provide
  77     authentification. However the get_template_and_user function has
  78     been provided so that a users login information is passed along
  79     automatically. This gets loaded into the template.
  80
  81 =head1 FUNCTIONS
  82
  83 =over 2
  84
  85 =cut
  86
  87 @ISA    = qw(Exporter);
  88 @EXPORT = qw(
  89   &checkauth
  90   &get_template_and_user
  91 );
  92
  93 =item get_template_and_user
  94
  95   my ($template, $borrowernumber, $cookie)
  96     = get_template_and_user(
  97         {
  98            template_name   => "opac-main.tmpl",
  99            query           => $query,
 100      type            => "opac",
 101      authnotrequired => 1,
 102      flagsrequired   => {borrow => 1},
 103   }
 104     );
 105
 106     This call passes the C<query>, C<flagsrequired> and C<authnotrequired>
 107     to C<&checkauth> (in this module) to perform authentification.
 108     See C<&checkauth> for an explanation of these parameters.
 109
 110     The C<template_name> is then used to find the correct template for
 111     the page. The authenticated users details are loaded onto the
 112     template in the HTML::Template LOOP variable C<USER_INFO>. Also the
 113     C<sessionID> is passed to the template. This can be used in templates
 114     if cookies are disabled. It needs to be put as and input to every
 115     authenticated page.
 116
 117     More information on the C<gettemplate> sub can be found in the
 118     Output.pm module.
 119
 120 =cut
 121
 122 sub get_template_and_user {
 123     my $in       = shift;
 124     my $template =
 125       gettemplate( $in->{'template_name'}, $in->{'type'}, $in->{'query'} );
 126     my ( $user, $cookie, $sessionID, $flags ) = checkauth(
 127         $in->{'query'},
 128         $in->{'authnotrequired'},
 129         $in->{'flagsrequired'},
 130         $in->{'type'}
 131     ) unless ($in->{'template_name'}=~/maintenance/);
 132
 133     my $borrowernumber;
 134     my $insecure = C4::Context->preference('insecure');
 135     if ($user or $insecure) {
 136
 137                 # load the template variables for stylesheets and JavaScript
 138                 $template->param( css_libs => $in->{'css_libs'} );
 139                 $template->param( css_module => $in->{'css_module'} );
 140                 $template->param( css_page => $in->{'css_page'} );
 141                 $template->param( css_widgets => $in->{'css_widgets'} );
 142
 143         $template->param( js_libs => $in->{'js_libs'} );
 144         $template->param( js_module => $in->{'js_module'} );
 145         $template->param( js_page => $in->{'js_page'} );
 146         $template->param( js_widgets => $in->{'js_widgets'} );
 147
 148                 # user info
 149         $template->param( loggedinusername => $user );
 150         $template->param( sessionID        => $sessionID );
 151
 152         $borrowernumber = getborrowernumber($user);
 153         my ( $borr, $alternativeflags ) =
 154           GetMemberDetails( $borrowernumber );
 155         my @bordat;
 156         $bordat[0] = $borr;
 157         $template->param( "USER_INFO" => \@bordat );
 158
 159         # We are going to use the $flags returned by checkauth
 160         # to create the template's parameters that will indicate
 161         # which menus the user can access.
 162         if (( $flags && $flags->{superlibrarian}==1) or $insecure==1) {
 163             $template->param( CAN_user_circulate        => 1 );
 164             $template->param( CAN_user_catalogue        => 1 );
 165             $template->param( CAN_user_parameters       => 1 );
 166             $template->param( CAN_user_borrowers        => 1 );
 167             $template->param( CAN_user_permission       => 1 );
 168             $template->param( CAN_user_reserveforothers => 1 );
 169             $template->param( CAN_user_borrow           => 1 );
 170             $template->param( CAN_user_editcatalogue    => 1 );
 171             $template->param( CAN_user_updatecharge     => 1 );
 172             $template->param( CAN_user_acquisition      => 1 );
 173             $template->param( CAN_user_management       => 1 );
 174             $template->param( CAN_user_tools            => 1 );
 175             $template->param( CAN_user_editauthorities  => 1 );
 176             $template->param( CAN_user_serials          => 1 );
 177             $template->param( CAN_user_reports          => 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_updatecharge => 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     }
 237     if ( $in->{'type'} eq "intranet" ) {
 238         $template->param(
 239             intranetcolorstylesheet => C4::Context->preference("intranetcolorstylesheet"),
 240             intranetstylesheet => C4::Context->preference("intranetstylesheet"),
 241             IntranetNav        => C4::Context->preference("IntranetNav"),
 242             intranetuserjs     => C4::Context->preference("intranetuserjs"),
 243             TemplateEncoding   => C4::Context->preference("TemplateEncoding"),
 244             AmazonContent      => C4::Context->preference("AmazonContent"),
 245             LibraryName        => C4::Context->preference("LibraryName"),
 246             LoginBranchcode    => (C4::Context->userenv?C4::Context->userenv->{"branch"}:"insecure"),
 247             LoginBranchname    => (C4::Context->userenv?C4::Context->userenv->{"branchname"}:"insecure"),
 248             LoginFirstname     => (C4::Context->userenv?C4::Context->userenv->{"firstname"}:"Bel"),
 249             LoginSurname       => C4::Context->userenv?C4::Context->userenv->{"surname"}:"Inconnu",
 250             AutoLocation       => C4::Context->preference("AutoLocation"),
 251             hide_marc          => C4::Context->preference("hide_marc"),
 252             patronimages       => C4::Context->preference("patronimages"),
 253             "BiblioDefaultView".C4::Context->preference("IntranetBiblioDefaultView") => 1,
 254             advancedMARCEditor      => C4::Context->preference("advancedMARCEditor"),
 255             suggestion              => C4::Context->preference("suggestion"),
 256             virtualshelves          => C4::Context->preference("virtualshelves"),
 257             LibraryName             => C4::Context->preference("LibraryName"),
 258             KohaAdminEmailAddress   => "" . C4::Context->preference("KohaAdminEmailAddress"),
 259                         IntranetmainUserblock   => C4::Context->preference("IntranetmainUserblock"),
 260         );
 261     }
 262     else {
 263         warn "template type should be OPAC, here it is=[" . $in->{'type'} . "]" unless ( $in->{'type'} eq 'opac' );
 264         my $LibraryNameTitle = C4::Context->preference("LibraryName");
 265         $LibraryNameTitle =~ s/<(?:\/?)(?:br|p)\s*(?:\/?)>/ /sgi;
 266         $LibraryNameTitle =~ s/<(?:[^<>'"]|'(?:[^']*)'|"(?:[^"]*)")*>//sg;
 267   $template->param(
 268             KohaAdminEmailAddress  => "" . C4::Context->preference("KohaAdminEmailAddress"),
 269             suggestion             => "" . C4::Context->preference("suggestion"),
 270             virtualshelves         => "" . C4::Context->preference("virtualshelves"),
 271             OpacNav                => "" . C4::Context->preference("OpacNav"),
 272             opacheader             => "" . C4::Context->preference("opacheader"),
 273             opaccredits            => "" . C4::Context->preference("opaccredits"),
 274             opacsmallimage         => "" . C4::Context->preference("opacsmallimage"),
 275             opaclargeimage         => "" . C4::Context->preference("opaclargeimage"),
 276             opaclayoutstylesheet   => "". C4::Context->preference("opaclayoutstylesheet"),
 277             opaccolorstylesheet    => "". C4::Context->preference("opaccolorstylesheet"),
 278             opaclanguagesdisplay   => "". C4::Context->preference("opaclanguagesdisplay"),
 279             opacuserlogin          => "" . C4::Context->preference("opacuserlogin"),
 280             opacbookbag            => "" . C4::Context->preference("opacbookbag"),
 281             TemplateEncoding       => "". C4::Context->preference("TemplateEncoding"),
 282             AmazonContent          => "" . C4::Context->preference("AmazonContent"),
 283             LibraryName            => "" . C4::Context->preference("LibraryName"),
 284             LibraryNameTitle       => "" . $LibraryNameTitle,
 285             LoginBranchcode        => (C4::Context->userenv?C4::Context->userenv->{"branch"}:"insecure"),
 286             LoginBranchname        => C4::Context->userenv?C4::Context->userenv->{"branchname"}:"",
 287             LoginFirstname        => (C4::Context->userenv?C4::Context->userenv->{"firstname"}:"Bel"),
 288             LoginSurname        => C4::Context->userenv?C4::Context->userenv->{"surname"}:"Inconnu",
 289             OpacPasswordChange     => C4::Context->preference("OpacPasswordChange"),
 290             opacreadinghistory     => C4::Context->preference("opacreadinghistory"),
 291             opacuserjs             => C4::Context->preference("opacuserjs"),
 292             OpacCloud              => C4::Context->preference("OpacCloud"),
 293             OpacTopissue           => C4::Context->preference("OpacTopissue"),
 294             OpacAuthorities        => C4::Context->preference("OpacAuthorities"),
 295             OpacBrowser            => C4::Context->preference("OpacBrowser"),
 296             RequestOnOpac          => C4::Context->preference("RequestOnOpac"),
 297             reviewson              => C4::Context->preference("reviewson"),
 298             hide_marc              => C4::Context->preference("hide_marc"),
 299             patronimages           => C4::Context->preference("patronimages"),
 300             mylibraryfirst   => C4::Context->preference("SearchMyLibraryFirst"),
 301             "BiblioDefaultView".C4::Context->preference("BiblioDefaultView") => 1,
 302         );
 303     }
 304     return ( $template, $borrowernumber, $cookie );
 305 }
 306
 307 =item checkauth
 308
 309   ($userid, $cookie, $sessionID) = &checkauth($query, $noauth, $flagsrequired, $type);
 310
 311 Verifies that the user is authorized to run this script.  If
 312 the user is authorized, a (userid, cookie, session-id, flags)
 313 quadruple is returned.  If the user is not authorized but does
 314 not have the required privilege (see $flagsrequired below), it
 315 displays an error page and exits.  Otherwise, it displays the
 316 login page and exits.
 317
 318 Note that C<&checkauth> will return if and only if the user
 319 is authorized, so it should be called early on, before any
 320 unfinished operations (e.g., if you've opened a file, then
 321 C<&checkauth> won't close it for you).
 322
 323 C<$query> is the CGI object for the script calling C<&checkauth>.
 324
 325 The C<$noauth> argument is optional. If it is set, then no
 326 authorization is required for the script.
 327
 328 C<&checkauth> fetches user and session information from C<$query> and
 329 ensures that the user is authorized to run scripts that require
 330 authorization.
 331
 332 The C<$flagsrequired> argument specifies the required privileges
 333 the user must have if the username and password are correct.
 334 It should be specified as a reference-to-hash; keys in the hash
 335 should be the "flags" for the user, as specified in the Members
 336 intranet module. Any key specified must correspond to a "flag"
 337 in the userflags table. E.g., { circulate => 1 } would specify
 338 that the user must have the "circulate" privilege in order to
 339 proceed. To make sure that access control is correct, the
 340 C<$flagsrequired> parameter must be specified correctly.
 341
 342 The C<$type> argument specifies whether the template should be
 343 retrieved from the opac or intranet directory tree.  "opac" is
 344 assumed if it is not specified; however, if C<$type> is specified,
 345 "intranet" is assumed if it is not "opac".
 346
 347 If C<$query> does not have a valid session ID associated with it
 348 (i.e., the user has not logged in) or if the session has expired,
 349 C<&checkauth> presents the user with a login page (from the point of
 350 view of the original script, C<&checkauth> does not return). Once the
 351 user has authenticated, C<&checkauth> restarts the original script
 352 (this time, C<&checkauth> returns).
 353
 354 The login page is provided using a HTML::Template, which is set in the
 355 systempreferences table or at the top of this file. The variable C<$type>
 356 selects which template to use, either the opac or the intranet
 357 authentification template.
 358
 359 C<&checkauth> returns a user ID, a cookie, and a session ID. The
 360 cookie should be sent back to the browser; it verifies that the user
 361 has authenticated.
 362
 363 =cut
 364
 365 sub checkauth {
 366     my $query = shift;
 367   # warn "Checking Auth";
 368     # $authnotrequired will be set for scripts which will run without authentication
 369     my $authnotrequired = shift;
 370     my $flagsrequired   = shift;
 371     my $type            = shift;
 372     $type = 'opac' unless $type;
 373
 374     my $dbh     = C4::Context->dbh;
 375     my $timeout = C4::Context->preference('timeout');
 376     $timeout = 600 unless $timeout;
 377
 378
 379     # If Version syspref is unavailable, it means Koha is beeing installed,
 380     # and so we must redirect to OPAC maintenance page or to the WebInstaller
 381     unless (C4::Context->preference('Version')) {
 382       if ($type ne 'opac') {
 383         warn "Install required, redirecting to Installer";
 384         print $query->redirect("/cgi-bin/koha/installer/install.pl");
 385       }
 386       else {
 387         warn "OPAC Install required, redirecting to maintenance";
 388         print $query->redirect("/cgi-bin/koha/maintenance.pl");
 389       }
 390       exit;
 391     }
 392
 393
 394     # state variables
 395     my $loggedin = 0;
 396     my %info;
 397     my ( $userid, $cookie, $sessionID, $flags );
 398     my $logout = $query->param('logout.x');
 399     if ( $userid = $ENV{'REMOTE_USER'} ) {
 400         # Using Basic Authentication, no cookies required
 401         $cookie = $query->cookie(
 402             -name    => 'CGISESSID',
 403             -value   => '',
 404             -expires => ''
 405         );
 406         $loggedin = 1;
 407     }
 408     elsif ( $sessionID = $query->cookie("CGISESSID")) {
 409                 my $storage_method = C4::Context->preference('SessionStorage');
 410                 my $session;
 411                 if ($storage_method eq 'mysql'){
 412                     $session = new CGI::Session("driver:MySQL", $sessionID, {Handle=>$dbh});
 413                 }
 414                 else {
 415                         # catch all defaults to tmp should work on all systems
 416                         $session = new CGI::Session("driver:File", $sessionID, {Directory=>'/tmp'});
 417                 }
 418         C4::Context->_new_userenv($sessionID);
 419         if ($session){
 420             C4::Context::set_userenv(
 421                 $session->param('number'),       $session->param('id'),
 422                 $session->param('cardnumber'),   $session->param('firstname'),
 423                 $session->param('surname'),      $session->param('branch'),
 424                 $session->param('branchname'),   $session->param('flags'),
 425                 $session->param('emailaddress'), $session->param('branchprinter')
 426             );
 427 #             warn       "".$session->param('cardnumber').",   ".$session->param('firstname').",
 428 #                 ".$session->param('surname').",      ".$session->param('branch');
 429         }
 430         my $ip;
 431         my $lasttime;
 432         if ($session) {
 433           $ip = $session->param('ip');
 434           $lasttime = $session->param('lasttime');
 435                 $userid = $session->param('id');
 436         }
 437
 438
 439         if ($logout) {
 440
 441             # voluntary logout the user
 442
 443             $session->flush;
 444                         $session->delete();
 445             C4::Context->_unset_userenv($sessionID);
 446             $sessionID = undef;
 447             $userid    = undef;
 448             open L, ">>/tmp/sessionlog";
 449             my $time = localtime( time() );
 450             printf L "%20s from %16s logged out at %30s (manually).\n", $userid,
 451               $ip, $time;
 452             close L;
 453         }
 454         if ($userid) {
 455             if ( $lasttime < time() - $timeout ) {
 456                 # timed logout
 457                 $info{'timed_out'} = 1;
 458                 $session->delete();
 459                 C4::Context->_unset_userenv($sessionID);
 460                 $userid    = undef;
 461                 $sessionID = undef;
 462                 open L, ">>/tmp/sessionlog";
 463                 my $time = localtime( time() );
 464                 printf L "%20s from %16s logged out at %30s (inactivity).\n",
 465                   $userid, $ip, $time;
 466                 close L;
 467             }
 468             elsif ( $ip ne $ENV{'REMOTE_ADDR'} ) {
 469                 # Different ip than originally logged in from
 470                 $info{'oldip'}        = $ip;
 471                 $info{'newip'}        = $ENV{'REMOTE_ADDR'};
 472                 $info{'different_ip'} = 1;
 473         $session->delete();
 474                 C4::Context->_unset_userenv($sessionID);
 475                 $sessionID = undef;
 476                 $userid    = undef;
 477                 open L, ">>/tmp/sessionlog";
 478                 my $time = localtime( time() );
 479                 printf L
 480 "%20s from logged out at %30s (ip changed from %16s to %16s).\n",
 481                   $userid, $time, $ip, $info{'newip'};
 482                 close L;
 483             }
 484             else {
 485                 $cookie = $query->cookie( CGISESSID => $session->id );
 486                 $session->param('lasttime',time());
 487                 $flags = haspermission( $dbh, $userid, $flagsrequired );
 488                 if ($flags) {
 489                     $loggedin = 1;
 490                 }
 491                 else {
 492                     $info{'nopermission'} = 1;
 493                 }
 494             }
 495         }
 496     }
 497     unless ($userid) {
 498                 my $storage_method = C4::Context->preference('SessionStorage');
 499                 my $session;
 500                 if ($storage_method eq 'mysql'){
 501                     $session = new CGI::Session("driver:MySQL", $sessionID, {Handle=>$dbh});
 502                 }
 503                 else {
 504                         # catch all defaults to tmp should work on all systems
 505                         $session = new CGI::Session("driver:File", $sessionID, {Directory=>'/tmp'});
 506                 }
 507
 508         my $sessionID;
 509                 if ($session) {
 510                         $sessionID = $session->id;
 511                 }
 512         $userid    = $query->param('userid');
 513         C4::Context->_new_userenv($sessionID);
 514         my $password = $query->param('password');
 515         C4::Context->_new_userenv($sessionID);
 516         my ( $return, $cardnumber ) = checkpw( $dbh, $userid, $password );
 517         if ($return) {
 518             open L, ">>/tmp/sessionlog";
 519             my $time = localtime( time() );
 520             printf L "%20s from %16s logged in  at %30s.\n", $userid,
 521               $ENV{'REMOTE_ADDR'}, $time;
 522             close L;
 523             $cookie = $query->cookie(CGISESSID => $sessionID);
 524             if ( $flags = haspermission( $dbh, $userid, $flagsrequired ) ) {
 525                 $loggedin = 1;
 526             }
 527             else {
 528                 $info{'nopermission'} = 1;
 529                 C4::Context->_unset_userenv($sessionID);
 530             }
 531             if ( $return == 1 ) {
 532                 my (
 533                     $borrowernumber, $firstname,  $surname,
 534                     $userflags,      $branchcode, $branchname,
 535                     $branchprinter,  $emailaddress
 536                 );
 537                 my $sth =
 538                   $dbh->prepare(
 539 "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=?"
 540                   );
 541                 $sth->execute($userid);
 542                 (
 543                     $borrowernumber, $firstname,  $surname,
 544                     $userflags,      $branchcode, $branchname,
 545                     $branchprinter,  $emailaddress
 546                   )
 547                   = $sth->fetchrow
 548                   if ( $sth->rows );
 549
 550 #         warn "$cardnumber,$borrowernumber,$userid,$firstname,$surname,$userflags,$branchcode,$emailaddress";
 551                 unless ( $sth->rows ) {
 552                     my $sth =
 553                       $dbh->prepare(
 554 "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=?"
 555                       );
 556                     $sth->execute($cardnumber);
 557                     (
 558                         $borrowernumber, $firstname,  $surname,
 559                         $userflags,      $branchcode, $branchname,
 560                         $branchprinter,  $emailaddress
 561                       )
 562                       = $sth->fetchrow
 563                       if ( $sth->rows );
 564
 565 #           warn "$cardnumber,$borrowernumber,$userid,$firstname,$surname,$userflags,$branchcode,$emailaddress";
 566                     unless ( $sth->rows ) {
 567                         $sth->execute($userid);
 568                         (
 569                             $borrowernumber, $firstname, $surname, $userflags,
 570                             $branchcode, $branchname, $branchprinter, $emailaddress
 571                           )
 572                           = $sth->fetchrow
 573                           if ( $sth->rows );
 574                     }
 575                 }
 576
 577 # launch a sequence to check if we have a ip for the branch, if we have one we replace the branchcode of the userenv by the branch bound in the ip.
 578                 my $ip       = $ENV{'REMOTE_ADDR'};
 579                 # if they specify at login, use that
 580                 if ($query->param('branch')) {
 581                     $branchcode  = $query->param('branch');
 582                     $branchname = GetBranchName($branchcode);
 583                 }
 584                 my $branches = GetBranches();
 585                 my @branchesloop;
 586                 foreach my $br ( keys %$branches ) {
 587                     #     now we work with the treatment of ip
 588                     my $domain = $branches->{$br}->{'branchip'};
 589                     if ( $domain && $ip =~ /^$domain/ ) {
 590                         $branchcode = $branches->{$br}->{'branchcode'};
 591
 592                         # new op dev : add the branchprinter and branchname in the cookie
 593                         $branchprinter = $branches->{$br}->{'branchprinter'};
 594                         $branchname    = $branches->{$br}->{'branchname'};
 595                     }
 596                 }
 597                 $session->param('number',$borrowernumber);
 598                 $session->param('id',$userid);
 599                 $session->param('cardnumber',$cardnumber);
 600                 $session->param('firstname',$firstname);
 601                 $session->param('surname',$surname);
 602                 $session->param('branch',$branchcode);
 603                 $session->param('branchname',$branchname);
 604                 $session->param('flags',$userflags);
 605                 $session->param('emailaddress',$emailaddress);
 606                 $session->param('ip',$session->remote_addr());
 607                 $session->param('lasttime',time());
 608 #            warn       "".$session->param('cardnumber').",   ".$session->param('firstname').",
 609 #                 ".$session->param('surname').",      ".$session->param('branch');
 610             }
 611             elsif ( $return == 2 ) {
 612                 #We suppose the user is the superlibrarian
 613                         $session->param('number',0);
 614                         $session->param('id',C4::Context->config('user'));
 615                         $session->param('cardnumber',C4::Context->config('user'));
 616                         $session->param('firstname',C4::Context->config('user'));
 617                         $session->param('surname',C4::Context->config('user'));
 618                         $session->param('branch','NO_LIBRARY_SET');
 619                         $session->param('branchname','NO_LIBRARY_SET');
 620                         $session->param('flags',1);
 621                         $session->param('emailaddress', C4::Context->preference('KohaAdminEmailAddress'));
 622                         $session->param('ip',$session->remote_addr());
 623                         $session->param('lasttime',time());
 624                 }
 625                 if ($session){
 626                     C4::Context::set_userenv(
 627                         $session->param('number'),       $session->param('id'),
 628                         $session->param('cardnumber'),   $session->param('firstname'),
 629                         $session->param('surname'),      $session->param('branch'),
 630                         $session->param('branchname'),   $session->param('flags'),
 631                         $session->param('emailaddress'), $session->param('branchprinter')
 632                     );
 633                 }
 634         }
 635
 636         else {
 637             if ($userid) {
 638                 $info{'invalid_username_or_password'} = 1;
 639                 C4::Context->_unset_userenv($sessionID);
 640             }
 641         }
 642     }
 643     my $insecure = C4::Context->boolean_preference('insecure');
 644
 645     # finished authentification, now respond
 646     if ( $loggedin || $authnotrequired || ( defined($insecure) && $insecure ) )
 647     {
 648         # successful login
 649         unless ($cookie) {
 650             $cookie = $query->cookie( CGISESSID => ''
 651             );
 652         }
 653     return ( $userid, $cookie, $sessionID, $flags );
 654
 655     }
 656
 657 #
 658 #
 659 # AUTH rejected, show the login/password template, after checking the DB.
 660 #
 661 #
 662
 663     # get the inputs from the incoming query
 664     my @inputs = ();
 665     foreach my $name ( param $query) {
 666         (next) if ( $name eq 'userid' || $name eq 'password' );
 667         my $value = $query->param($name);
 668         push @inputs, { name => $name, value => $value };
 669     }
 670     # get the branchloop, which we need for authentication
 671     my $branches = GetBranches();
 672     my @branch_loop;
 673     for my $branch_hash (keys %$branches) {
 674                 push @branch_loop, {branchcode => "$branch_hash", branchname => $branches->{$branch_hash}->{'branchname'}, };
 675     }
 676
 677     # check that database and koha version are the same
 678     # there is no DB version, it's a fresh install,
 679     # go to web installer
 680     # there is a DB version, compare it to the code version
 681     my $kohaversion=C4::Context::KOHAVERSION;
 682     # remove the 3 last . to have a Perl number
 683     $kohaversion =~ s/(.*\..*)\.(.*)\.(.*)/$1$2$3/;
 684 #     warn "kohaversion : $kohaversion";
 685     if (C4::Context->preference('Version') < $kohaversion){
 686       if ($type ne 'opac'){
 687       warn "Database update needed, redirecting to Installer. Database is ".C4::Context->preference('Version')." and Koha is : ".C4::Context->config("kohaversion");
 688         print $query->redirect("/cgi-bin/koha/installer/install.pl?step=3");
 689       } else {
 690       warn "OPAC :Database update needed, redirecting to maintenance. Database is ".C4::Context->preference('Version')." and Koha is : ".C4::Context->config("kohaversion");
 691         print $query->redirect("/cgi-bin/koha/maintenance.pl");
 692       }
 693       exit;
 694     }
 695     my $template_name;
 696     if ( $type eq 'opac' ) {
 697         $template_name = "opac-auth.tmpl";
 698     }
 699     else {
 700         $template_name = "auth.tmpl";
 701     }
 702     my $template = gettemplate( $template_name, $type, $query );
 703     $template->param(branchloop => \@branch_loop,);
 704     $template->param(
 705     login        => 1,
 706         INPUTS               => \@inputs,
 707         suggestion           => C4::Context->preference("suggestion"),
 708         virtualshelves       => C4::Context->preference("virtualshelves"),
 709         opaclargeimage       => C4::Context->preference("opaclargeimage"),
 710         LibraryName          => C4::Context->preference("LibraryName"),
 711         OpacNav              => C4::Context->preference("OpacNav"),
 712         opaccredits          => C4::Context->preference("opaccredits"),
 713         opacreadinghistory   => C4::Context->preference("opacreadinghistory"),
 714         opacsmallimage       => C4::Context->preference("opacsmallimage"),
 715         opaclayoutstylesheet => C4::Context->preference("opaclayoutstylesheet"),
 716         opaccolorstylesheet  => C4::Context->preference("opaccolorstylesheet"),
 717         opaclanguagesdisplay => C4::Context->preference("opaclanguagesdisplay"),
 718         opacuserjs           => C4::Context->preference("opacuserjs"),
 719
 720         intranetcolorstylesheet =>
 721           C4::Context->preference("intranetcolorstylesheet"),
 722         intranetstylesheet => C4::Context->preference("intranetstylesheet"),
 723         IntranetNav        => C4::Context->preference("IntranetNav"),
 724         intranetuserjs     => C4::Context->preference("intranetuserjs"),
 725         TemplateEncoding   => C4::Context->preference("TemplateEncoding"),
 726
 727     );
 728     $template->param( loginprompt => 1 ) unless $info{'nopermission'};
 729
 730     my $self_url = $query->url( -absolute => 1 );
 731     $template->param(
 732         url         => $self_url,
 733         LibraryName => => C4::Context->preference("LibraryName"),
 734     );
 735     $template->param( \%info );
 736 #    $cookie = $query->cookie(CGISESSID => $session->id
 737 #   );
 738     print $query->header(
 739                 -type   => 'text/html',
 740         -charset => 'utf-8',
 741         -cookie => $cookie
 742       ),
 743       $template->output;
 744     exit;
 745 }
 746
 747 sub checkpw {
 748
 749     my ( $dbh, $userid, $password ) = @_;
 750
 751     # INTERNAL AUTH
 752     my $sth =
 753       $dbh->prepare(
 754 "select password,cardnumber,borrowernumber,userid,firstname,surname,branchcode,flags from borrowers where userid=?"
 755       );
 756     $sth->execute($userid);
 757     if ( $sth->rows ) {
 758         my ( $md5password, $cardnumber, $borrowernumber, $userid, $firstname,
 759             $surname, $branchcode, $flags )
 760           = $sth->fetchrow;
 761         if ( md5_base64($password) eq $md5password ) {
 762
 763             C4::Context->set_userenv( "$borrowernumber", $userid, $cardnumber,
 764                 $firstname, $surname, $branchcode, $flags );
 765             return 1, $cardnumber;
 766         }
 767     }
 768     $sth =
 769       $dbh->prepare(
 770 "select password,cardnumber,borrowernumber,userid, firstname,surname,branchcode,flags from borrowers where cardnumber=?"
 771       );
 772     $sth->execute($userid);
 773     if ( $sth->rows ) {
 774         my ( $md5password, $cardnumber, $borrowernumber, $userid, $firstname,
 775             $surname, $branchcode, $flags )
 776           = $sth->fetchrow;
 777         if ( md5_base64($password) eq $md5password ) {
 778
 779             C4::Context->set_userenv( $borrowernumber, $userid, $cardnumber,
 780                 $firstname, $surname, $branchcode, $flags );
 781             return 1, $userid;
 782         }
 783     }
 784     if (   $userid && $userid eq C4::Context->config('user')
 785         && "$password" eq C4::Context->config('pass') )
 786     {
 787
 788 # Koha superuser account
 789 #     C4::Context->set_userenv(0,0,C4::Context->config('user'),C4::Context->config('user'),C4::Context->config('user'),"",1);
 790         return 2;
 791     }
 792     if (   $userid && $userid eq 'demo'
 793         && "$password" eq 'demo'
 794         && C4::Context->config('demo') )
 795     {
 796
 797 # DEMO => the demo user is allowed to do everything (if demo set to 1 in koha.conf
 798 # some features won't be effective : modify systempref, modify MARC structure,
 799         return 2;
 800     }
 801     return 0;
 802 }
 803
 804 sub getuserflags {
 805     my $cardnumber = shift;
 806     my $dbh        = shift;
 807     my $userflags;
 808     my $sth = $dbh->prepare("SELECT flags FROM borrowers WHERE cardnumber=?");
 809     $sth->execute($cardnumber);
 810     my ($flags) = $sth->fetchrow;
 811     $flags = 0 unless $flags;
 812     $sth = $dbh->prepare("SELECT bit, flag, defaulton FROM userflags");
 813     $sth->execute;
 814
 815     while ( my ( $bit, $flag, $defaulton ) = $sth->fetchrow ) {
 816         if ( ( $flags & ( 2**$bit ) ) || $defaulton ) {
 817             $userflags->{$flag} = 1;
 818         }
 819         else {
 820             $userflags->{$flag} = 0;
 821         }
 822     }
 823     return $userflags;
 824 }
 825
 826 sub haspermission {
 827     my ( $dbh, $userid, $flagsrequired ) = @_;
 828     my $sth = $dbh->prepare("SELECT cardnumber FROM borrowers WHERE userid=?");
 829     $sth->execute($userid);
 830     my ($cardnumber) = $sth->fetchrow;
 831     ($cardnumber) || ( $cardnumber = $userid );
 832     my $flags = getuserflags( $cardnumber, $dbh );
 833     my $configfile;
 834     if ( $userid eq C4::Context->config('user') ) {
 835
 836         # Super User Account from /etc/koha.conf
 837         $flags->{'superlibrarian'} = 1;
 838     }
 839     if ( $userid eq 'demo' && C4::Context->config('demo') ) {
 840
 841         # Demo user that can do "anything" (demo=1 in /etc/koha.conf)
 842         $flags->{'superlibrarian'} = 1;
 843     }
 844     return $flags if $flags->{superlibrarian};
 845     foreach ( keys %$flagsrequired ) {
 846         return $flags if $flags->{$_};
 847     }
 848     return 0;
 849 }
 850
 851 sub getborrowernumber {
 852     my ($userid) = @_;
 853     my $dbh = C4::Context->dbh;
 854     for my $field ( 'userid', 'cardnumber' ) {
 855         my $sth =
 856           $dbh->prepare("select borrowernumber from borrowers where $field=?");
 857         $sth->execute($userid);
 858         if ( $sth->rows ) {
 859             my ($bnumber) = $sth->fetchrow;
 860             return $bnumber;
 861         }
 862     }
 863     return 0;
 864 }
 865
 866 END { }    # module clean-up code here (global destructor)
 867 1;
 868 __END__
 869
 870 =back
 871
 872 =head1 SEE ALSO
 873
 874 CGI(3)
 875
 876 C4::Output(3)
 877
 878 Digest::MD5(3)
 879
 880 =cut