3 # NOTE: This file uses 8-character tabs; do not change the tab size!
7 # Copyright 2000-2002 Katipo Communications
9 # This file is part of Koha.
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
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.
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
25 use Digest::MD5 qw(md5_base64);
30 use C4::Output; # to get the template
33 use C4::Branch; # GetBranches
37 # use Net::LDAP qw(:all);
39 use vars qw($VERSION @ISA @EXPORT @EXPORT_OK %EXPORT_TAGS);
41 # set the version for version checking
46 C4::Auth - Authenticates Koha users
55 my ($template, $borrowernumber, $cookie)
56 = get_template_and_user(
58 template_name => "opac-main.tmpl",
62 flagsrequired => {borrow => 1},
74 The main function of this module is to provide
75 authentification. However the get_template_and_user function has
76 been provided so that a users login information is passed along
77 automatically. This gets loaded into the template.
88 &get_template_and_user
96 =item get_template_and_user
98 my ($template, $borrowernumber, $cookie)
99 = get_template_and_user(
101 template_name => "opac-main.tmpl",
104 authnotrequired => 1,
105 flagsrequired => {borrow => 1},
109 This call passes the C<query>, C<flagsrequired> and C<authnotrequired>
110 to C<&checkauth> (in this module) to perform authentification.
111 See C<&checkauth> for an explanation of these parameters.
113 The C<template_name> is then used to find the correct template for
114 the page. The authenticated users details are loaded onto the
115 template in the HTML::Template LOOP variable C<USER_INFO>. Also the
116 C<sessionID> is passed to the template. This can be used in templates
117 if cookies are disabled. It needs to be put as and input to every
120 More information on the C<gettemplate> sub can be found in the
125 sub get_template_and_user {
128 gettemplate( $in->{'template_name'}, $in->{'type'}, $in->{'query'} );
129 my ( $user, $cookie, $sessionID, $flags ) = checkauth(
131 $in->{'authnotrequired'},
132 $in->{'flagsrequired'},
134 ) unless ($in->{'template_name'}=~/maintenance/);
137 my $insecure = C4::Context->preference('insecure');
138 if ($user or $insecure) {
140 # load the template variables for stylesheets and JavaScript
141 $template->param( css_libs => $in->{'css_libs'} );
142 $template->param( css_module => $in->{'css_module'} );
143 $template->param( css_page => $in->{'css_page'} );
144 $template->param( css_widgets => $in->{'css_widgets'} );
146 $template->param( js_libs => $in->{'js_libs'} );
147 $template->param( js_module => $in->{'js_module'} );
148 $template->param( js_page => $in->{'js_page'} );
149 $template->param( js_widgets => $in->{'js_widgets'} );
152 $template->param( loggedinusername => $user );
153 $template->param( sessionID => $sessionID );
155 $borrowernumber = getborrowernumber($user);
156 my ( $borr, $alternativeflags ) =
157 GetMemberDetails( $borrowernumber );
160 $template->param( "USER_INFO" => \@bordat );
162 # We are going to use the $flags returned by checkauth
163 # to create the template's parameters that will indicate
164 # which menus the user can access.
165 if (( $flags && $flags->{superlibrarian}==1) or $insecure==1) {
166 $template->param( CAN_user_circulate => 1 );
167 $template->param( CAN_user_catalogue => 1 );
168 $template->param( CAN_user_parameters => 1 );
169 $template->param( CAN_user_borrowers => 1 );
170 $template->param( CAN_user_permission => 1 );
171 $template->param( CAN_user_reserveforothers => 1 );
172 $template->param( CAN_user_borrow => 1 );
173 $template->param( CAN_user_editcatalogue => 1 );
174 $template->param( CAN_user_updatecharge => 1 );
175 $template->param( CAN_user_acquisition => 1 );
176 $template->param( CAN_user_management => 1 );
177 $template->param( CAN_user_tools => 1 );
178 $template->param( CAN_user_editauthorities => 1 );
179 $template->param( CAN_user_serials => 1 );
180 $template->param( CAN_user_reports => 1 );
183 if ( $flags && $flags->{circulate} == 1 ) {
184 $template->param( CAN_user_circulate => 1 );
187 if ( $flags && $flags->{catalogue} == 1 ) {
188 $template->param( CAN_user_catalogue => 1 );
191 if ( $flags && $flags->{parameters} == 1 ) {
192 $template->param( CAN_user_parameters => 1 );
193 $template->param( CAN_user_management => 1 );
196 if ( $flags && $flags->{borrowers} == 1 ) {
197 $template->param( CAN_user_borrowers => 1 );
200 if ( $flags && $flags->{permissions} == 1 ) {
201 $template->param( CAN_user_permission => 1 );
204 if ( $flags && $flags->{reserveforothers} == 1 ) {
205 $template->param( CAN_user_reserveforothers => 1 );
208 if ( $flags && $flags->{borrow} == 1 ) {
209 $template->param( CAN_user_borrow => 1 );
212 if ( $flags && $flags->{editcatalogue} == 1 ) {
213 $template->param( CAN_user_editcatalogue => 1 );
216 if ( $flags && $flags->{updatecharges} == 1 ) {
217 $template->param( CAN_user_updatecharge => 1 );
220 if ( $flags && $flags->{acquisition} == 1 ) {
221 $template->param( CAN_user_acquisition => 1 );
224 if ( $flags && $flags->{tools} == 1 ) {
225 $template->param( CAN_user_tools => 1 );
228 if ( $flags && $flags->{editauthorities} == 1 ) {
229 $template->param( CAN_user_editauthorities => 1 );
232 if ( $flags && $flags->{serials} == 1 ) {
233 $template->param( CAN_user_serials => 1 );
236 if ( $flags && $flags->{reports} == 1 ) {
237 $template->param( CAN_user_reports => 1 );
240 if ( $in->{'type'} eq "intranet" ) {
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"),
269 warn "template type should be OPAC, here it is=[" . $in->{'type'} . "]" unless ( $in->{'type'} eq 'opac' );
270 my $LibraryNameTitle = C4::Context->preference("LibraryName");
271 $LibraryNameTitle =~ s/<(?:\/?)(?:br|p)\s*(?:\/?)>/ /sgi;
272 $LibraryNameTitle =~ s/<(?:[^<>'"]|'(?:[^']*)'|"(?:[^"]*)")*>//sg;
274 KohaAdminEmailAddress => "" . C4::Context->preference("KohaAdminEmailAddress"),
275 AnonSuggestions => "" . C4::Context->preference("AnonSuggestions"),
276 suggestion => "" . C4::Context->preference("suggestion"),
277 virtualshelves => "" . C4::Context->preference("virtualshelves"),
278 OpacNav => "" . C4::Context->preference("OpacNav"),
279 opacheader => "" . C4::Context->preference("opacheader"),
280 opaccredits => "" . C4::Context->preference("opaccredits"),
281 opacsmallimage => "" . C4::Context->preference("opacsmallimage"),
282 opaclargeimage => "" . C4::Context->preference("opaclargeimage"),
283 opaclayoutstylesheet => "". C4::Context->preference("opaclayoutstylesheet"),
284 opaccolorstylesheet => "". C4::Context->preference("opaccolorstylesheet"),
285 opaclanguagesdisplay => "". C4::Context->preference("opaclanguagesdisplay"),
286 opacuserlogin => "" . C4::Context->preference("opacuserlogin"),
287 opacbookbag => "" . C4::Context->preference("opacbookbag"),
288 TemplateEncoding => "". C4::Context->preference("TemplateEncoding"),
289 AmazonContent => "" . C4::Context->preference("AmazonContent"),
290 LibraryName => "" . C4::Context->preference("LibraryName"),
291 LibraryNameTitle => "" . $LibraryNameTitle,
292 LoginBranchcode => (C4::Context->userenv?C4::Context->userenv->{"branch"}:"insecure"),
293 LoginBranchname => C4::Context->userenv?C4::Context->userenv->{"branchname"}:"",
294 LoginFirstname => (C4::Context->userenv?C4::Context->userenv->{"firstname"}:"Bel"),
295 LoginSurname => C4::Context->userenv?C4::Context->userenv->{"surname"}:"Inconnu",
296 OpacPasswordChange => C4::Context->preference("OpacPasswordChange"),
297 opacreadinghistory => C4::Context->preference("opacreadinghistory"),
298 opacuserjs => C4::Context->preference("opacuserjs"),
299 OpacCloud => C4::Context->preference("OpacCloud"),
300 OpacTopissue => C4::Context->preference("OpacTopissue"),
301 OpacAuthorities => C4::Context->preference("OpacAuthorities"),
302 OpacBrowser => C4::Context->preference("OpacBrowser"),
303 RequestOnOpac => C4::Context->preference("RequestOnOpac"),
304 reviewson => C4::Context->preference("reviewson"),
305 hide_marc => C4::Context->preference("hide_marc"),
306 patronimages => C4::Context->preference("patronimages"),
307 mylibraryfirst => C4::Context->preference("SearchMyLibraryFirst"),
308 "BiblioDefaultView".C4::Context->preference("BiblioDefaultView") => 1,
311 return ( $template, $borrowernumber, $cookie );
316 ($userid, $cookie, $sessionID) = &checkauth($query, $noauth, $flagsrequired, $type);
318 Verifies that the user is authorized to run this script. If
319 the user is authorized, a (userid, cookie, session-id, flags)
320 quadruple is returned. If the user is not authorized but does
321 not have the required privilege (see $flagsrequired below), it
322 displays an error page and exits. Otherwise, it displays the
323 login page and exits.
325 Note that C<&checkauth> will return if and only if the user
326 is authorized, so it should be called early on, before any
327 unfinished operations (e.g., if you've opened a file, then
328 C<&checkauth> won't close it for you).
330 C<$query> is the CGI object for the script calling C<&checkauth>.
332 The C<$noauth> argument is optional. If it is set, then no
333 authorization is required for the script.
335 C<&checkauth> fetches user and session information from C<$query> and
336 ensures that the user is authorized to run scripts that require
339 The C<$flagsrequired> argument specifies the required privileges
340 the user must have if the username and password are correct.
341 It should be specified as a reference-to-hash; keys in the hash
342 should be the "flags" for the user, as specified in the Members
343 intranet module. Any key specified must correspond to a "flag"
344 in the userflags table. E.g., { circulate => 1 } would specify
345 that the user must have the "circulate" privilege in order to
346 proceed. To make sure that access control is correct, the
347 C<$flagsrequired> parameter must be specified correctly.
349 The C<$type> argument specifies whether the template should be
350 retrieved from the opac or intranet directory tree. "opac" is
351 assumed if it is not specified; however, if C<$type> is specified,
352 "intranet" is assumed if it is not "opac".
354 If C<$query> does not have a valid session ID associated with it
355 (i.e., the user has not logged in) or if the session has expired,
356 C<&checkauth> presents the user with a login page (from the point of
357 view of the original script, C<&checkauth> does not return). Once the
358 user has authenticated, C<&checkauth> restarts the original script
359 (this time, C<&checkauth> returns).
361 The login page is provided using a HTML::Template, which is set in the
362 systempreferences table or at the top of this file. The variable C<$type>
363 selects which template to use, either the opac or the intranet
364 authentification template.
366 C<&checkauth> returns a user ID, a cookie, and a session ID. The
367 cookie should be sent back to the browser; it verifies that the user
374 # warn "Checking Auth";
375 # $authnotrequired will be set for scripts which will run without authentication
376 my $authnotrequired = shift;
377 my $flagsrequired = shift;
379 $type = 'opac' unless $type;
381 my $dbh = C4::Context->dbh;
382 my $timeout = C4::Context->preference('timeout');
383 $timeout = 600 unless $timeout;
386 # If Version syspref is unavailable, it means Koha is beeing installed,
387 # and so we must redirect to OPAC maintenance page or to the WebInstaller
388 #warn "about to check version";
389 unless (C4::Context->preference('Version')) {
390 if ($type ne 'opac') {
391 warn "Install required, redirecting to Installer";
392 print $query->redirect("/cgi-bin/koha/installer/install.pl");
395 warn "OPAC Install required, redirecting to maintenance";
396 print $query->redirect("/cgi-bin/koha/maintenance.pl");
405 my ( $userid, $cookie, $sessionID, $flags );
406 my $logout = $query->param('logout.x');
407 if ( $userid = $ENV{'REMOTE_USER'} ) {
408 # Using Basic Authentication, no cookies required
409 $cookie = $query->cookie(
410 -name => 'CGISESSID',
416 elsif ( $sessionID = $query->cookie("CGISESSID")) {
417 my $session = get_session($sessionID);
418 C4::Context->_new_userenv($sessionID);
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')
427 # warn "".$session->param('cardnumber').", ".$session->param('firstname').",
428 # ".$session->param('surname').", ".$session->param('branch');
433 $ip = $session->param('ip');
434 $lasttime = $session->param('lasttime');
435 $userid = $session->param('id');
441 # voluntary logout the user
445 C4::Context->_unset_userenv($sessionID);
448 open L, ">>/tmp/sessionlog";
449 my $time = localtime( time() );
450 printf L "%20s from %16s logged out at %30s (manually).\n", $userid,
455 if ( $lasttime < time() - $timeout ) {
457 $info{'timed_out'} = 1;
459 C4::Context->_unset_userenv($sessionID);
462 open L, ">>/tmp/sessionlog";
463 my $time = localtime( time() );
464 printf L "%20s from %16s logged out at %30s (inactivity).\n",
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;
474 C4::Context->_unset_userenv($sessionID);
477 open L, ">>/tmp/sessionlog";
478 my $time = localtime( time() );
480 "%20s from logged out at %30s (ip changed from %16s to %16s).\n",
481 $userid, $time, $ip, $info{'newip'};
485 $cookie = $query->cookie( CGISESSID => $session->id );
486 $session->param('lasttime',time());
487 $flags = haspermission( $dbh, $userid, $flagsrequired );
492 $info{'nopermission'} = 1;
498 my $session = get_session("");
502 $sessionID = $session->id;
504 $userid = $query->param('userid');
505 C4::Context->_new_userenv($sessionID);
506 my $password = $query->param('password');
507 C4::Context->_new_userenv($sessionID);
508 my ( $return, $cardnumber ) = checkpw( $dbh, $userid, $password );
510 open L, ">>/tmp/sessionlog";
511 my $time = localtime( time() );
512 printf L "%20s from %16s logged in at %30s.\n", $userid,
513 $ENV{'REMOTE_ADDR'}, $time;
515 $cookie = $query->cookie(CGISESSID => $sessionID);
516 if ( $flags = haspermission( $dbh, $userid, $flagsrequired ) ) {
520 $info{'nopermission'} = 1;
521 C4::Context->_unset_userenv($sessionID);
523 if ( $return == 1 ) {
525 $borrowernumber, $firstname, $surname,
526 $userflags, $branchcode, $branchname,
527 $branchprinter, $emailaddress
531 "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=?"
533 $sth->execute($userid);
535 $borrowernumber, $firstname, $surname,
536 $userflags, $branchcode, $branchname,
537 $branchprinter, $emailaddress
542 # warn "$cardnumber,$borrowernumber,$userid,$firstname,$surname,$userflags,$branchcode,$emailaddress";
543 unless ( $sth->rows ) {
546 "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=?"
548 $sth->execute($cardnumber);
550 $borrowernumber, $firstname, $surname,
551 $userflags, $branchcode, $branchname,
552 $branchprinter, $emailaddress
557 # warn "$cardnumber,$borrowernumber,$userid,$firstname,$surname,$userflags,$branchcode,$emailaddress";
558 unless ( $sth->rows ) {
559 $sth->execute($userid);
561 $borrowernumber, $firstname, $surname, $userflags,
562 $branchcode, $branchname, $branchprinter, $emailaddress
569 # 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.
570 my $ip = $ENV{'REMOTE_ADDR'};
571 # if they specify at login, use that
572 if ($query->param('branch')) {
573 $branchcode = $query->param('branch');
574 $branchname = GetBranchName($branchcode);
576 my $branches = GetBranches();
578 foreach my $br ( keys %$branches ) {
579 # now we work with the treatment of ip
580 my $domain = $branches->{$br}->{'branchip'};
581 if ( $domain && $ip =~ /^$domain/ ) {
582 $branchcode = $branches->{$br}->{'branchcode'};
584 # new op dev : add the branchprinter and branchname in the cookie
585 $branchprinter = $branches->{$br}->{'branchprinter'};
586 $branchname = $branches->{$br}->{'branchname'};
589 $session->param('number',$borrowernumber);
590 $session->param('id',$userid);
591 $session->param('cardnumber',$cardnumber);
592 $session->param('firstname',$firstname);
593 $session->param('surname',$surname);
594 $session->param('branch',$branchcode);
595 $session->param('branchname',$branchname);
596 $session->param('flags',$userflags);
597 $session->param('emailaddress',$emailaddress);
598 $session->param('ip',$session->remote_addr());
599 $session->param('lasttime',time());
600 # warn "".$session->param('cardnumber').", ".$session->param('firstname').",
601 # ".$session->param('surname').", ".$session->param('branch');
603 elsif ( $return == 2 ) {
604 #We suppose the user is the superlibrarian
605 $session->param('number',0);
606 $session->param('id',C4::Context->config('user'));
607 $session->param('cardnumber',C4::Context->config('user'));
608 $session->param('firstname',C4::Context->config('user'));
609 $session->param('surname',C4::Context->config('user'));
610 $session->param('branch','NO_LIBRARY_SET');
611 $session->param('branchname','NO_LIBRARY_SET');
612 $session->param('flags',1);
613 $session->param('emailaddress', C4::Context->preference('KohaAdminEmailAddress'));
614 $session->param('ip',$session->remote_addr());
615 $session->param('lasttime',time());
618 C4::Context::set_userenv(
619 $session->param('number'), $session->param('id'),
620 $session->param('cardnumber'), $session->param('firstname'),
621 $session->param('surname'), $session->param('branch'),
622 $session->param('branchname'), $session->param('flags'),
623 $session->param('emailaddress'), $session->param('branchprinter')
630 $info{'invalid_username_or_password'} = 1;
631 C4::Context->_unset_userenv($sessionID);
635 my $insecure = C4::Context->boolean_preference('insecure');
637 # finished authentification, now respond
638 if ( $loggedin || $authnotrequired || ( defined($insecure) && $insecure ) )
642 $cookie = $query->cookie( CGISESSID => ''
645 return ( $userid, $cookie, $sessionID, $flags );
651 # AUTH rejected, show the login/password template, after checking the DB.
655 # get the inputs from the incoming query
657 foreach my $name ( param $query) {
658 (next) if ( $name eq 'userid' || $name eq 'password' );
659 my $value = $query->param($name);
660 push @inputs, { name => $name, value => $value };
662 # get the branchloop, which we need for authentication
663 my $branches = GetBranches();
665 for my $branch_hash (keys %$branches) {
666 push @branch_loop, {branchcode => "$branch_hash", branchname => $branches->{$branch_hash}->{'branchname'}, };
669 # check that database and koha version are the same
670 # there is no DB version, it's a fresh install,
671 # go to web installer
672 # there is a DB version, compare it to the code version
673 my $kohaversion=C4::Context::KOHAVERSION;
674 # remove the 3 last . to have a Perl number
675 $kohaversion =~ s/(.*\..*)\.(.*)\.(.*)/$1$2$3/;
676 # warn "kohaversion : $kohaversion";
677 if (C4::Context->preference('Version') < $kohaversion){
678 if ($type ne 'opac'){
679 warn "Database update needed, redirecting to Installer. Database is ".C4::Context->preference('Version')." and Koha is : ".C4::Context->config("kohaversion");
680 print $query->redirect("/cgi-bin/koha/installer/install.pl?step=3");
682 warn "OPAC :Database update needed, redirecting to maintenance. Database is ".C4::Context->preference('Version')." and Koha is : ".C4::Context->config("kohaversion");
683 print $query->redirect("/cgi-bin/koha/maintenance.pl");
688 if ( $type eq 'opac' ) {
689 $template_name = "opac-auth.tmpl";
692 $template_name = "auth.tmpl";
694 my $template = gettemplate( $template_name, $type, $query );
695 $template->param(branchloop => \@branch_loop,);
699 suggestion => C4::Context->preference("suggestion"),
700 virtualshelves => C4::Context->preference("virtualshelves"),
701 opaclargeimage => C4::Context->preference("opaclargeimage"),
702 LibraryName => C4::Context->preference("LibraryName"),
703 OpacNav => C4::Context->preference("OpacNav"),
704 opaccredits => C4::Context->preference("opaccredits"),
705 opacreadinghistory => C4::Context->preference("opacreadinghistory"),
706 opacsmallimage => C4::Context->preference("opacsmallimage"),
707 opaclayoutstylesheet => C4::Context->preference("opaclayoutstylesheet"),
708 opaccolorstylesheet => C4::Context->preference("opaccolorstylesheet"),
709 opaclanguagesdisplay => C4::Context->preference("opaclanguagesdisplay"),
710 opacuserjs => C4::Context->preference("opacuserjs"),
712 intranetcolorstylesheet =>
713 C4::Context->preference("intranetcolorstylesheet"),
714 intranetstylesheet => C4::Context->preference("intranetstylesheet"),
715 IntranetNav => C4::Context->preference("IntranetNav"),
716 intranetuserjs => C4::Context->preference("intranetuserjs"),
717 TemplateEncoding => C4::Context->preference("TemplateEncoding"),
718 IndependantBranches => C4::Context->preference("IndependantBranches"),
719 AutoLocation => C4::Context->preference("AutoLocation"),
721 $template->param( loginprompt => 1 ) unless $info{'nopermission'};
723 my $self_url = $query->url( -absolute => 1 );
726 LibraryName => => C4::Context->preference("LibraryName"),
728 $template->param( \%info );
729 # $cookie = $query->cookie(CGISESSID => $session->id
731 print $query->header(
732 -type => 'text/html',
742 ($status, $cookie, $sessionId) = check_api_auth($query, $userflags);
744 Given a CGI query containing the parameters 'userid' and 'password' and/or a session
745 cookie, determine if the user has the privileges specified by C<$userflags>.
747 C<check_api_auth> is is meant for authenticating users of web services, and
748 consequently will always return and will not attempt to redirect the user
751 If a valid session cookie is already present, check_api_auth will return a status
752 of "ok", the cookie, and the Koha session ID.
754 If no session cookie is present, check_api_auth will check the 'userid' and 'password
755 parameters and create a session cookie and Koha session if the supplied credentials
758 Possible return values in C<$status> are:
762 =item "ok" -- user authenticated; C<$cookie> and C<$sessionid> have valid values.
764 =item "failed" -- credentials are not correct; C<$cookie> and C<$sessionid> are undef
766 =item "maintenance" -- DB is in maintenance mode; no login possible at the moment
768 =item "expired -- session cookie has expired; API user should resubmit userid and password
776 my $flagsrequired = shift;
778 my $dbh = C4::Context->dbh;
779 my $timeout = C4::Context->preference('timeout');
780 $timeout = 600 unless $timeout;
782 unless (C4::Context->preference('Version')) {
783 # database has not been installed yet
784 return ("maintenance", undef, undef);
786 my $kohaversion=C4::Context::KOHAVERSION;
787 $kohaversion =~ s/(.*\..*)\.(.*)\.(.*)/$1$2$3/;
788 if (C4::Context->preference('Version') < $kohaversion) {
789 # database in need of version update; assume that
790 # no API should be called while databsae is in
792 return ("maintenance", undef, undef);
795 # FIXME -- most of what follows is a copy-and-paste
796 # of code from checkauth. There is an obvious need
797 # for refactoring to separate the various parts of
798 # the authentication code, but as of 2007-11-19 this
799 # is deferred so as to not introduce bugs into the
800 # regular authentication code for Koha 3.0.
802 # see if we have a valid session cookie already
803 # however, if a userid parameter is present (i.e., from
804 # a form submission, assume that any current cookie
806 my $sessionID = undef;
807 unless ($query->param('userid')) {
808 $sessionID = $query->cookie("CGISESSID");
811 my $session = get_session($sessionID);
812 C4::Context->_new_userenv($sessionID);
814 C4::Context::set_userenv(
815 $session->param('number'), $session->param('id'),
816 $session->param('cardnumber'), $session->param('firstname'),
817 $session->param('surname'), $session->param('branch'),
818 $session->param('branchname'), $session->param('flags'),
819 $session->param('emailaddress'), $session->param('branchprinter')
822 my $ip = $session->param('ip');
823 my $lasttime = $session->param('lasttime');
824 my $userid = $session->param('id');
825 if ( $lasttime < time() - $timeout ) {
828 C4::Context->_unset_userenv($sessionID);
831 return ("expired", undef, undef);
832 } elsif ( $ip ne $ENV{'REMOTE_ADDR'} ) {
835 C4::Context->_unset_userenv($sessionID);
838 return ("expired", undef, undef);
840 my $cookie = $query->cookie( CGISESSID => $session->id );
841 $session->param('lasttime',time());
842 my $flags = haspermission( $dbh, $userid, $flagsrequired );
844 return ("ok", $cookie, $sessionID);
847 C4::Context->_unset_userenv($sessionID);
850 return ("failed", undef, undef);
854 return ("expired", undef, undef);
858 my $userid = $query->param('userid');
859 my $password = $query->param('password');
860 unless ($userid and $password) {
861 # caller did something wrong, fail the authenticateion
862 return ("failed", undef, undef);
864 my ( $return, $cardnumber ) = checkpw( $dbh, $userid, $password );
865 if ($return and haspermission( $dbh, $userid, $flagsrequired)) {
866 my $session = get_session("");
867 return ("failed", undef, undef) unless $session;
869 my $sessionID = $session->id;
870 C4::Context->_new_userenv($sessionID);
871 my $cookie = $query->cookie(CGISESSID => $sessionID);
872 if ( $return == 1 ) {
874 $borrowernumber, $firstname, $surname,
875 $userflags, $branchcode, $branchname,
876 $branchprinter, $emailaddress
880 "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=?"
882 $sth->execute($userid);
884 $borrowernumber, $firstname, $surname,
885 $userflags, $branchcode, $branchname,
886 $branchprinter, $emailaddress
887 ) = $sth->fetchrow if ( $sth->rows );
889 unless ($sth->rows ) {
890 my $sth = $dbh->prepare(
891 "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=?"
893 $sth->execute($cardnumber);
895 $borrowernumber, $firstname, $surname,
896 $userflags, $branchcode, $branchname,
897 $branchprinter, $emailaddress
898 ) = $sth->fetchrow if ( $sth->rows );
900 unless ( $sth->rows ) {
901 $sth->execute($userid);
903 $borrowernumber, $firstname, $surname, $userflags,
904 $branchcode, $branchname, $branchprinter, $emailaddress
905 ) = $sth->fetchrow if ( $sth->rows );
909 my $ip = $ENV{'REMOTE_ADDR'};
910 # if they specify at login, use that
911 if ($query->param('branch')) {
912 $branchcode = $query->param('branch');
913 $branchname = GetBranchName($branchcode);
915 my $branches = GetBranches();
917 foreach my $br ( keys %$branches ) {
918 # now we work with the treatment of ip
919 my $domain = $branches->{$br}->{'branchip'};
920 if ( $domain && $ip =~ /^$domain/ ) {
921 $branchcode = $branches->{$br}->{'branchcode'};
923 # new op dev : add the branchprinter and branchname in the cookie
924 $branchprinter = $branches->{$br}->{'branchprinter'};
925 $branchname = $branches->{$br}->{'branchname'};
928 $session->param('number',$borrowernumber);
929 $session->param('id',$userid);
930 $session->param('cardnumber',$cardnumber);
931 $session->param('firstname',$firstname);
932 $session->param('surname',$surname);
933 $session->param('branch',$branchcode);
934 $session->param('branchname',$branchname);
935 $session->param('flags',$userflags);
936 $session->param('emailaddress',$emailaddress);
937 $session->param('ip',$session->remote_addr());
938 $session->param('lasttime',time());
939 } elsif ( $return == 2 ) {
940 #We suppose the user is the superlibrarian
941 $session->param('number',0);
942 $session->param('id',C4::Context->config('user'));
943 $session->param('cardnumber',C4::Context->config('user'));
944 $session->param('firstname',C4::Context->config('user'));
945 $session->param('surname',C4::Context->config('user'));
946 $session->param('branch','NO_LIBRARY_SET');
947 $session->param('branchname','NO_LIBRARY_SET');
948 $session->param('flags',1);
949 $session->param('emailaddress', C4::Context->preference('KohaAdminEmailAddress'));
950 $session->param('ip',$session->remote_addr());
951 $session->param('lasttime',time());
953 C4::Context::set_userenv(
954 $session->param('number'), $session->param('id'),
955 $session->param('cardnumber'), $session->param('firstname'),
956 $session->param('surname'), $session->param('branch'),
957 $session->param('branchname'), $session->param('flags'),
958 $session->param('emailaddress'), $session->param('branchprinter')
960 return ("ok", $cookie, $sessionID);
962 return ("failed", undef, undef);
967 =item check_cookie_auth
969 ($status, $sessionId) = check_api_auth($cookie, $userflags);
971 Given a CGISESSID cookie set during a previous login to Koha, determine
972 if the user has the privileges specified by C<$userflags>.
974 C<check_cookie_auth> is meant for authenticating special services
975 such as tools/upload-file.pl that are invoked by other pages that
976 have been authenticated in the usual way.
978 Possible return values in C<$status> are:
982 =item "ok" -- user authenticated; C<$sessionID> have valid values.
984 =item "failed" -- credentials are not correct; C<$sessionid> are undef
986 =item "maintenance" -- DB is in maintenance mode; no login possible at the moment
988 =item "expired -- session cookie has expired; API user should resubmit userid and password
994 sub check_cookie_auth {
996 my $flagsrequired = shift;
998 my $dbh = C4::Context->dbh;
999 my $timeout = C4::Context->preference('timeout');
1000 $timeout = 600 unless $timeout;
1002 unless (C4::Context->preference('Version')) {
1003 # database has not been installed yet
1004 return ("maintenance", undef);
1006 my $kohaversion=C4::Context::KOHAVERSION;
1007 $kohaversion =~ s/(.*\..*)\.(.*)\.(.*)/$1$2$3/;
1008 if (C4::Context->preference('Version') < $kohaversion) {
1009 # database in need of version update; assume that
1010 # no API should be called while databsae is in
1012 return ("maintenance", undef);
1015 # FIXME -- most of what follows is a copy-and-paste
1016 # of code from checkauth. There is an obvious need
1017 # for refactoring to separate the various parts of
1018 # the authentication code, but as of 2007-11-23 this
1019 # is deferred so as to not introduce bugs into the
1020 # regular authentication code for Koha 3.0.
1022 # see if we have a valid session cookie already
1023 # however, if a userid parameter is present (i.e., from
1024 # a form submission, assume that any current cookie
1026 unless (defined $cookie and $cookie) {
1027 return ("failed", undef);
1029 my $sessionID = $cookie;
1030 my $session = get_session($sessionID);
1031 C4::Context->_new_userenv($sessionID);
1033 C4::Context::set_userenv(
1034 $session->param('number'), $session->param('id'),
1035 $session->param('cardnumber'), $session->param('firstname'),
1036 $session->param('surname'), $session->param('branch'),
1037 $session->param('branchname'), $session->param('flags'),
1038 $session->param('emailaddress'), $session->param('branchprinter')
1041 my $ip = $session->param('ip');
1042 my $lasttime = $session->param('lasttime');
1043 my $userid = $session->param('id');
1044 if ( $lasttime < time() - $timeout ) {
1047 C4::Context->_unset_userenv($sessionID);
1050 return ("expired", undef);
1051 } elsif ( $ip ne $ENV{'REMOTE_ADDR'} ) {
1052 # IP address changed
1054 C4::Context->_unset_userenv($sessionID);
1057 return ("expired", undef);
1059 $session->param('lasttime',time());
1060 my $flags = haspermission( $dbh, $userid, $flagsrequired );
1062 return ("ok", $sessionID);
1065 C4::Context->_unset_userenv($sessionID);
1068 return ("failed", undef);
1072 return ("expired", undef);
1079 my $session = get_session($sessionID);
1081 Given a session ID, retrieve the CGI::Session object used to store
1082 the session's state. The session object can be used to store
1083 data that needs to be accessed by different scripts during a
1086 If the C<$sessionID> parameter is an empty string, a new session
1092 my $sessionID = shift;
1093 my $storage_method = C4::Context->preference('SessionStorage');
1094 my $dbh = C4::Context->dbh;
1096 if ($storage_method eq 'mysql'){
1097 $session = new CGI::Session("driver:MySQL", $sessionID, {Handle=>$dbh});
1099 elsif ($storage_method eq 'Pg') {
1100 $session = new CGI::Session("driver:PostgreSQL", $sessionID, {Handle=>$dbh});
1103 # catch all defaults to tmp should work on all systems
1104 $session = new CGI::Session("driver:File", $sessionID, {Directory=>'/tmp'});
1111 my ( $dbh, $userid, $password ) = @_;
1116 "select password,cardnumber,borrowernumber,userid,firstname,surname,branchcode,flags from borrowers where userid=?"
1118 $sth->execute($userid);
1120 my ( $md5password, $cardnumber, $borrowernumber, $userid, $firstname,
1121 $surname, $branchcode, $flags )
1123 if ( md5_base64($password) eq $md5password ) {
1125 C4::Context->set_userenv( "$borrowernumber", $userid, $cardnumber,
1126 $firstname, $surname, $branchcode, $flags );
1127 return 1, $cardnumber;
1132 "select password,cardnumber,borrowernumber,userid, firstname,surname,branchcode,flags from borrowers where cardnumber=?"
1134 $sth->execute($userid);
1136 my ( $md5password, $cardnumber, $borrowernumber, $userid, $firstname,
1137 $surname, $branchcode, $flags )
1139 if ( md5_base64($password) eq $md5password ) {
1141 C4::Context->set_userenv( $borrowernumber, $userid, $cardnumber,
1142 $firstname, $surname, $branchcode, $flags );
1146 if ( $userid && $userid eq C4::Context->config('user')
1147 && "$password" eq C4::Context->config('pass') )
1150 # Koha superuser account
1151 # C4::Context->set_userenv(0,0,C4::Context->config('user'),C4::Context->config('user'),C4::Context->config('user'),"",1);
1154 if ( $userid && $userid eq 'demo'
1155 && "$password" eq 'demo'
1156 && C4::Context->config('demo') )
1159 # DEMO => the demo user is allowed to do everything (if demo set to 1 in koha.conf
1160 # some features won't be effective : modify systempref, modify MARC structure,
1167 my $cardnumber = shift;
1170 my $sth = $dbh->prepare("SELECT flags FROM borrowers WHERE cardnumber=?");
1171 $sth->execute($cardnumber);
1172 my ($flags) = $sth->fetchrow;
1173 $flags = 0 unless $flags;
1174 $sth = $dbh->prepare("SELECT bit, flag, defaulton FROM userflags");
1177 while ( my ( $bit, $flag, $defaulton ) = $sth->fetchrow ) {
1178 if ( ( $flags & ( 2**$bit ) ) || $defaulton ) {
1179 $userflags->{$flag} = 1;
1182 $userflags->{$flag} = 0;
1189 my ( $dbh, $userid, $flagsrequired ) = @_;
1190 my $sth = $dbh->prepare("SELECT cardnumber FROM borrowers WHERE userid=?");
1191 $sth->execute($userid);
1192 my ($cardnumber) = $sth->fetchrow;
1193 ($cardnumber) || ( $cardnumber = $userid );
1194 my $flags = getuserflags( $cardnumber, $dbh );
1196 if ( $userid eq C4::Context->config('user') ) {
1198 # Super User Account from /etc/koha.conf
1199 $flags->{'superlibrarian'} = 1;
1201 if ( $userid eq 'demo' && C4::Context->config('demo') ) {
1203 # Demo user that can do "anything" (demo=1 in /etc/koha.conf)
1204 $flags->{'superlibrarian'} = 1;
1206 return $flags if $flags->{superlibrarian};
1207 foreach ( keys %$flagsrequired ) {
1208 return $flags if $flags->{$_};
1213 sub getborrowernumber {
1215 my $dbh = C4::Context->dbh;
1216 for my $field ( 'userid', 'cardnumber' ) {
1218 $dbh->prepare("select borrowernumber from borrowers where $field=?");
1219 $sth->execute($userid);
1221 my ($bnumber) = $sth->fetchrow;
1228 END { } # module clean-up code here (global destructor)