3 # Copyright 2000-2002 Katipo Communications
5 # This file is part of Koha.
7 # Koha is free software; you can redistribute it and/or modify it under the
8 # terms of the GNU General Public License as published by the Free Software
9 # Foundation; either version 2 of the License, or (at your option) any later
12 # Koha is distributed in the hope that it will be useful, but WITHOUT ANY
13 # WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
14 # A PARTICULAR PURPOSE. See the GNU General Public License for more details.
16 # You should have received a copy of the GNU General Public License along with
17 # Koha; if not, write to the Free Software Foundation, Inc., 59 Temple Place,
18 # Suite 330, Boston, MA 02111-1307 USA
21 use Digest::MD5 qw(md5_base64);
22 use Storable qw(thaw freeze);
28 use C4::Output; # to get the template
31 use C4::Branch; # GetBranches
32 use C4::VirtualShelves;
33 use POSIX qw/strftime/;
36 use vars qw($VERSION @ISA @EXPORT @EXPORT_OK %EXPORT_TAGS $debug $ldap $cas $caslogout);
39 $VERSION = 3.02; # set version for version checking
42 @EXPORT = qw(&checkauth &get_template_and_user &haspermission &get_user_subpermissions);
43 @EXPORT_OK = qw(&check_api_auth &get_session &check_cookie_auth &checkpw &get_all_subpermissions &get_user_subpermissions);
44 %EXPORT_TAGS = (EditPermissions => [qw(get_all_subpermissions get_user_subpermissions)]);
45 $ldap = C4::Context->config('useldapserver') || 0;
46 $cas = C4::Context->preference('casAuthentication');
47 $caslogout = C4::Context->preference('casLogout');
49 require C4::Auth_with_ldap; # no import
50 import C4::Auth_with_ldap qw(checkpw_ldap);
53 require C4::Auth_with_cas; # no import
54 import C4::Auth_with_cas qw(checkpw_cas login_cas logout_cas login_cas_url);
61 C4::Auth - Authenticates Koha users
71 my ($template, $borrowernumber, $cookie)
72 = get_template_and_user(
74 template_name => "opac-main.tmpl",
78 flagsrequired => {borrow => 1, catalogue => '*', tools => 'import_patrons' },
82 output_html_with_http_headers $query, $cookie, $template->output;
86 The main function of this module is to provide
87 authentification. However the get_template_and_user function has
88 been provided so that a users login information is passed along
89 automatically. This gets loaded into the template.
95 =item get_template_and_user
97 my ($template, $borrowernumber, $cookie)
98 = get_template_and_user(
100 template_name => "opac-main.tmpl",
103 authnotrequired => 1,
104 flagsrequired => {borrow => 1, catalogue => '*', tools => 'import_patrons' },
108 This call passes the C<query>, C<flagsrequired> and C<authnotrequired>
109 to C<&checkauth> (in this module) to perform authentification.
110 See C<&checkauth> for an explanation of these parameters.
112 The C<template_name> is then used to find the correct template for
113 the page. The authenticated users details are loaded onto the
114 template in the HTML::Template LOOP variable C<USER_INFO>. Also the
115 C<sessionID> is passed to the template. This can be used in templates
116 if cookies are disabled. It needs to be put as and input to every
119 More information on the C<gettemplate> sub can be found in the
124 sub get_template_and_user {
127 gettemplate( $in->{'template_name'}, $in->{'type'}, $in->{'query'} );
128 my ( $user, $cookie, $sessionID, $flags ) = checkauth(
130 $in->{'authnotrequired'},
131 $in->{'flagsrequired'},
133 ) unless ($in->{'template_name'}=~/maintenance/);
136 my $insecure = C4::Context->preference('insecure');
137 if ($user or $insecure) {
139 # load the template variables for stylesheets and JavaScript
140 $template->param( css_libs => $in->{'css_libs'} );
141 $template->param( css_module => $in->{'css_module'} );
142 $template->param( css_page => $in->{'css_page'} );
143 $template->param( css_widgets => $in->{'css_widgets'} );
145 $template->param( js_libs => $in->{'js_libs'} );
146 $template->param( js_module => $in->{'js_module'} );
147 $template->param( js_page => $in->{'js_page'} );
148 $template->param( js_widgets => $in->{'js_widgets'} );
151 $template->param( loggedinusername => $user );
152 $template->param( sessionID => $sessionID );
154 my ($total, $pubshelves, $barshelves) = C4::Context->get_shelves_userenv();
155 if (defined($pubshelves)) {
156 $template->param( pubshelves => scalar (@$pubshelves),
157 pubshelvesloop => $pubshelves,
159 $template->param( pubtotal => $total->{'pubtotal'}, ) if ($total->{'pubtotal'} > scalar (@$pubshelves));
161 if (defined($barshelves)) {
162 $template->param( barshelves => scalar (@$barshelves),
163 barshelvesloop => $barshelves,
165 $template->param( bartotal => $total->{'bartotal'}, ) if ($total->{'bartotal'} > scalar (@$barshelves));
168 $borrowernumber = getborrowernumber($user) if defined($user);
170 my ( $borr ) = GetMemberDetails( $borrowernumber );
173 $template->param( "USER_INFO" => \@bordat );
175 my $all_perms = get_all_subpermissions();
177 my @flagroots = qw(circulate catalogue parameters borrowers permissions reserveforothers borrow
178 editcatalogue updatecharges management tools editauthorities serials reports acquisition);
179 # We are going to use the $flags returned by checkauth
180 # to create the template's parameters that will indicate
181 # which menus the user can access.
182 if (( $flags && $flags->{superlibrarian}==1) or $insecure==1) {
183 $template->param( CAN_user_circulate => 1 );
184 $template->param( CAN_user_catalogue => 1 );
185 $template->param( CAN_user_parameters => 1 );
186 $template->param( CAN_user_borrowers => 1 );
187 $template->param( CAN_user_permissions => 1 );
188 $template->param( CAN_user_reserveforothers => 1 );
189 $template->param( CAN_user_borrow => 1 );
190 $template->param( CAN_user_editcatalogue => 1 );
191 $template->param( CAN_user_updatecharges => 1 );
192 $template->param( CAN_user_acquisition => 1 );
193 $template->param( CAN_user_management => 1 );
194 $template->param( CAN_user_tools => 1 );
195 $template->param( CAN_user_editauthorities => 1 );
196 $template->param( CAN_user_serials => 1 );
197 $template->param( CAN_user_reports => 1 );
198 $template->param( CAN_user_staffaccess => 1 );
199 foreach my $module (keys %$all_perms) {
200 foreach my $subperm (keys %{ $all_perms->{$module} }) {
201 $template->param( "CAN_user_${module}_${subperm}" => 1 );
206 if (C4::Context->preference('GranularPermissions')) {
208 foreach my $module (keys %$all_perms) {
209 if ( $flags->{$module} == 1) {
210 foreach my $subperm (keys %{ $all_perms->{$module} }) {
211 $template->param( "CAN_user_${module}_${subperm}" => 1 );
213 } elsif ( ref($flags->{$module}) ) {
214 foreach my $subperm (keys %{ $flags->{$module} } ) {
215 $template->param( "CAN_user_${module}_${subperm}" => 1 );
221 foreach my $module (keys %$all_perms) {
222 foreach my $subperm (keys %{ $all_perms->{$module} }) {
223 $template->param( "CAN_user_${module}_${subperm}" => 1 );
229 foreach my $module (keys %$flags) {
230 if ( $flags->{$module} == 1 or ref($flags->{$module}) ) {
231 $template->param( "CAN_user_$module" => 1 );
232 if ($module eq "parameters") {
233 $template->param( CAN_user_management => 1 );
238 # Logged-in opac search history
239 # If the requested template is an opac one and opac search history is enabled
240 if ($in->{'type'} == "opac" && C4::Context->preference('EnableOpacSearchHistory')) {
241 my $dbh = C4::Context->dbh;
242 my $query = "SELECT COUNT(*) FROM search_history WHERE userid=?";
243 my $sth = $dbh->prepare($query);
244 $sth->execute($borrowernumber);
246 # If at least one search has already been performed
247 if ($sth->fetchrow_array > 0) {
248 # We show the link in opac
249 $template->param(ShowOpacRecentSearchLink => 1);
252 # And if there's a cookie with searches performed when the user was not logged in,
253 # we add them to the logged-in search history
255 my $searchcookie = $in->{'query'}->cookie('KohaOpacRecentSearches');
257 $searchcookie = uri_unescape($searchcookie);
258 if (thaw($searchcookie)) {
259 @recentSearches = @{thaw($searchcookie)};
262 if (@recentSearches > 0) {
263 my $query = "INSERT INTO search_history(userid, sessionid, query_desc, query_cgi, total, time) VALUES";
265 foreach my $asearch (@recentSearches) {
267 $query .= $borrowernumber . ", ";
268 $query .= '"' . $in->{'query'}->cookie("CGISESSID") . "\", ";
269 $query .= '"' . $asearch->{'query_desc'} . "\", ";
270 $query .= '"' . $asearch->{'query_cgi'} . "\", ";
271 $query .= $asearch->{'total'} . ", ";
272 $query .= 'FROM_UNIXTIME(' . $asearch->{'time'} . "))";
273 if ($icount < @recentSearches) { $query .= ", ";}
277 my $sth = $dbh->prepare($query);
280 # And then, delete the cookie's content
281 my $newsearchcookie = $in->{'query'}->cookie(
282 -name => 'KohaOpacRecentSearches',
283 -value => freeze([]),
286 $cookie = [$cookie, $newsearchcookie];
291 else { # if this is an anonymous session, setup to display public lists...
293 # load the template variables for stylesheets and JavaScript
294 $template->param( css_libs => $in->{'css_libs'} );
295 $template->param( css_module => $in->{'css_module'} );
296 $template->param( css_page => $in->{'css_page'} );
297 $template->param( css_widgets => $in->{'css_widgets'} );
299 $template->param( js_libs => $in->{'js_libs'} );
300 $template->param( js_module => $in->{'js_module'} );
301 $template->param( js_page => $in->{'js_page'} );
302 $template->param( js_widgets => $in->{'js_widgets'} );
304 $template->param( sessionID => $sessionID );
306 my ($total, $pubshelves) = C4::Context->get_shelves_userenv(); # an anonymous user has no 'barshelves'...
307 if (defined(($pubshelves))) {
308 $template->param( pubshelves => scalar (@$pubshelves),
309 pubshelvesloop => $pubshelves,
311 $template->param( pubtotal => $total->{'pubtotal'}, ) if ($total->{'pubtotal'} > scalar (@$pubshelves));
315 # Anonymous opac search history
316 # If opac search history is enabled and at least one search has already been performed
317 if (C4::Context->preference('EnableOpacSearchHistory') && $in->{'query'}->cookie('KohaOpacRecentSearches')) {
318 # We show the link in opac
319 if (thaw(uri_unescape($in->{'query'}->cookie('KohaOpacRecentSearches')))) {
320 my @recentSearches = @{thaw(uri_unescape($in->{'query'}->cookie('KohaOpacRecentSearches')))};
321 if (@recentSearches > 0) {
322 $template->param(ShowOpacRecentSearchLink => 1);
327 if(C4::Context->preference('dateformat')){
328 if(C4::Context->preference('dateformat') eq "metric"){
329 $template->param(dateformat_metric => 1);
330 } elsif(C4::Context->preference('dateformat') eq "us"){
331 $template->param(dateformat_us => 1);
333 $template->param(dateformat_iso => 1);
336 $template->param(dateformat_iso => 1);
339 # these template parameters are set the same regardless of $in->{'type'}
341 "BiblioDefaultView".C4::Context->preference("BiblioDefaultView") => 1,
342 EnhancedMessagingPreferences => C4::Context->preference('EnhancedMessagingPreferences'),
343 GoogleJackets => C4::Context->preference("GoogleJackets"),
344 KohaAdminEmailAddress => "" . C4::Context->preference("KohaAdminEmailAddress"),
345 LoginBranchcode => (C4::Context->userenv?C4::Context->userenv->{"branch"}:"insecure"),
346 LoginFirstname => (C4::Context->userenv?C4::Context->userenv->{"firstname"}:"Bel"),
347 LoginSurname => C4::Context->userenv?C4::Context->userenv->{"surname"}:"Inconnu",
348 TagsEnabled => C4::Context->preference("TagsEnabled"),
349 hide_marc => C4::Context->preference("hide_marc"),
350 'item-level_itypes' => C4::Context->preference('item-level_itypes'),
351 patronimages => C4::Context->preference("patronimages"),
352 singleBranchMode => C4::Context->preference("singleBranchMode"),
353 OPACXSLTDetailsDisplay => C4::Context->preference("XSLTDetailsDisplay"),
354 OPACXSLTResultsDisplay => C4::Context->preference("XSLTResultsDisplay"),
355 BranchesLoop => GetBranchesLoop(),
358 if ( $in->{'type'} eq "intranet" ) {
360 AmazonContent => C4::Context->preference("AmazonContent"),
361 AmazonSimilarItems => C4::Context->preference("AmazonSimilarItems"),
362 AutoLocation => C4::Context->preference("AutoLocation"),
363 "BiblioDefaultView".C4::Context->preference("IntranetBiblioDefaultView") => 1,
364 CircAutocompl => C4::Context->preference("CircAutocompl"),
365 FRBRizeEditions => C4::Context->preference("FRBRizeEditions"),
366 IndependantBranches => C4::Context->preference("IndependantBranches"),
367 IntranetNav => C4::Context->preference("IntranetNav"),
368 IntranetmainUserblock => C4::Context->preference("IntranetmainUserblock"),
369 LibraryName => C4::Context->preference("LibraryName"),
370 LoginBranchname => (C4::Context->userenv?C4::Context->userenv->{"branchname"}:"insecure"),
371 TemplateEncoding => C4::Context->preference("TemplateEncoding"),
372 advancedMARCEditor => C4::Context->preference("advancedMARCEditor"),
373 canreservefromotherbranches => C4::Context->preference('canreservefromotherbranches'),
374 intranetcolorstylesheet => C4::Context->preference("intranetcolorstylesheet"),
375 intranetreadinghistory => C4::Context->preference("intranetreadinghistory"),
376 intranetstylesheet => C4::Context->preference("intranetstylesheet"),
377 intranetuserjs => C4::Context->preference("intranetuserjs"),
378 intranetbookbag => C4::Context->preference("intranetbookbag"),
379 noItemTypeImages => C4::Context->preference("noItemTypeImages"),
380 suggestion => C4::Context->preference("suggestion"),
381 virtualshelves => C4::Context->preference("virtualshelves"),
382 StaffSerialIssueDisplayCount => C4::Context->preference("StaffSerialIssueDisplayCount"),
383 NoZebra => C4::Context->preference('NoZebra'),
387 warn "template type should be OPAC, here it is=[" . $in->{'type'} . "]" unless ( $in->{'type'} eq 'opac' );
388 #TODO : replace LibraryName syspref with 'system name', and remove this html processing
389 my $LibraryNameTitle = C4::Context->preference("LibraryName");
390 $LibraryNameTitle =~ s/<(?:\/?)(?:br|p)\s*(?:\/?)>/ /sgi;
391 $LibraryNameTitle =~ s/<(?:[^<>'"]|'(?:[^']*)'|"(?:[^"]*)")*>//sg;
392 # variables passed from CGI: opac_css_override and opac_search_limits.
393 my $opac_search_limit = $ENV{'OPAC_SEARCH_LIMIT'};
394 my $opac_limit_override = $ENV{'OPAC_LIMIT_OVERRIDE'};
395 my $mylibraryfirst = C4::Context->preference("SearchMyLibraryFirst");
397 if($opac_limit_override && ($opac_search_limit =~ /branch:(\w+)/) ){
398 $opac_name = C4::Branch::GetBranchName($1) # opac_search_limit is a branch, so we use it.
399 } elsif($mylibraryfirst){
400 $opac_name = C4::Branch::GetBranchName($mylibraryfirst);
403 AmazonContent => "" . C4::Context->preference("AmazonContent"),
404 AnonSuggestions => "" . C4::Context->preference("AnonSuggestions"),
405 AuthorisedValueImages => C4::Context->preference("AuthorisedValueImages"),
406 LibraryName => "" . C4::Context->preference("LibraryName"),
407 LibraryNameTitle => "" . $LibraryNameTitle,
408 LoginBranchname => C4::Context->userenv?C4::Context->userenv->{"branchname"}:"",
409 OPACAmazonEnabled => C4::Context->preference("OPACAmazonEnabled"),
410 OPACAmazonSimilarItems => C4::Context->preference("OPACAmazonSimilarItems"),
411 OPACAmazonCoverImages => C4::Context->preference("OPACAmazonCoverImages"),
412 OPACAmazonReviews => C4::Context->preference("OPACAmazonReviews"),
413 OPACFRBRizeEditions => C4::Context->preference("OPACFRBRizeEditions"),
414 OpacHighlightedWords => C4::Context->preference("OpacHighlightedWords"),
415 OPACItemHolds => C4::Context->preference("OPACItemHolds"),
416 OPACShelfBrowser => "". C4::Context->preference("OPACShelfBrowser"),
417 OPACURLOpenInNewWindow => "" . C4::Context->preference("OPACURLOpenInNewWindow"),
418 OPACUserCSS => "". C4::Context->preference("OPACUserCSS"),
419 OPACViewOthersSuggestions => "" . C4::Context->preference("OPACViewOthersSuggestions"),
420 OpacAuthorities => C4::Context->preference("OpacAuthorities"),
421 OPACBaseURL => ($in->{'query'}->https() ? "https://" : "http://") . $ENV{'SERVER_NAME'} .
422 ($ENV{'SERVER_PORT'} eq ($in->{'query'}->https() ? "443" : "80") ? '' : ":$ENV{'SERVER_PORT'}"),
423 opac_name => $opac_name,
424 opac_css_override => $ENV{'OPAC_CSS_OVERRIDE'},
425 opac_search_limit => $opac_search_limit,
426 opac_limit_override => $opac_limit_override,
427 OpacBrowser => C4::Context->preference("OpacBrowser"),
428 OpacCloud => C4::Context->preference("OpacCloud"),
429 OpacMainUserBlock => "" . C4::Context->preference("OpacMainUserBlock"),
430 OpacNav => "" . C4::Context->preference("OpacNav"),
431 OpacPasswordChange => C4::Context->preference("OpacPasswordChange"),
432 OPACPatronDetails => C4::Context->preference("OPACPatronDetails"),
433 OPACFinesTab => C4::Context->preference("OPACFinesTab"),
434 OpacTopissue => C4::Context->preference("OpacTopissue"),
435 RequestOnOpac => C4::Context->preference("RequestOnOpac"),
436 TemplateEncoding => "". C4::Context->preference("TemplateEncoding"),
437 'Version' => C4::Context->preference('Version'),
438 hidelostitems => C4::Context->preference("hidelostitems"),
439 mylibraryfirst => (C4::Context->preference("SearchMyLibraryFirst") && C4::Context->userenv) ? C4::Context->userenv->{'branch'} : '',
440 opaclayoutstylesheet => "" . C4::Context->preference("opaclayoutstylesheet"),
441 opaccolorstylesheet => "" . C4::Context->preference("opaccolorstylesheet"),
442 opacstylesheet => "" . C4::Context->preference("opacstylesheet"),
443 opacbookbag => "" . C4::Context->preference("opacbookbag"),
444 opaccredits => "" . C4::Context->preference("opaccredits"),
445 opacheader => "" . C4::Context->preference("opacheader"),
446 opaclanguagesdisplay => "" . C4::Context->preference("opaclanguagesdisplay"),
447 opacreadinghistory => C4::Context->preference("opacreadinghistory"),
448 opacsmallimage => "" . C4::Context->preference("opacsmallimage"),
449 opacuserjs => C4::Context->preference("opacuserjs"),
450 opacuserlogin => "" . C4::Context->preference("opacuserlogin"),
451 reviewson => C4::Context->preference("reviewson"),
452 suggestion => "" . C4::Context->preference("suggestion"),
453 virtualshelves => "" . C4::Context->preference("virtualshelves"),
454 OPACSerialIssueDisplayCount => C4::Context->preference("OPACSerialIssueDisplayCount"),
455 OpacAddMastheadLibraryPulldown => C4::Context->preference("OpacAddMastheadLibraryPulldown"),
458 $template->param(listloop=>[{shelfname=>"Freelist", shelfnumber=>110}]);
459 return ( $template, $borrowernumber, $cookie, $flags);
464 ($userid, $cookie, $sessionID) = &checkauth($query, $noauth, $flagsrequired, $type);
466 Verifies that the user is authorized to run this script. If
467 the user is authorized, a (userid, cookie, session-id, flags)
468 quadruple is returned. If the user is not authorized but does
469 not have the required privilege (see $flagsrequired below), it
470 displays an error page and exits. Otherwise, it displays the
471 login page and exits.
473 Note that C<&checkauth> will return if and only if the user
474 is authorized, so it should be called early on, before any
475 unfinished operations (e.g., if you've opened a file, then
476 C<&checkauth> won't close it for you).
478 C<$query> is the CGI object for the script calling C<&checkauth>.
480 The C<$noauth> argument is optional. If it is set, then no
481 authorization is required for the script.
483 C<&checkauth> fetches user and session information from C<$query> and
484 ensures that the user is authorized to run scripts that require
487 The C<$flagsrequired> argument specifies the required privileges
488 the user must have if the username and password are correct.
489 It should be specified as a reference-to-hash; keys in the hash
490 should be the "flags" for the user, as specified in the Members
491 intranet module. Any key specified must correspond to a "flag"
492 in the userflags table. E.g., { circulate => 1 } would specify
493 that the user must have the "circulate" privilege in order to
494 proceed. To make sure that access control is correct, the
495 C<$flagsrequired> parameter must be specified correctly.
497 If the GranularPermissions system preference is ON, the
498 value of each key in the C<flagsrequired> hash takes on an additional
503 The user must have access to all subfunctions of the module
504 specified by the hash key.
508 The user must have access to at least one subfunction of the module
509 specified by the hash key.
511 =item specific permission, e.g., 'export_catalog'
513 The user must have access to the specific subfunction list, which
514 must correspond to a row in the permissions table.
516 The C<$type> argument specifies whether the template should be
517 retrieved from the opac or intranet directory tree. "opac" is
518 assumed if it is not specified; however, if C<$type> is specified,
519 "intranet" is assumed if it is not "opac".
521 If C<$query> does not have a valid session ID associated with it
522 (i.e., the user has not logged in) or if the session has expired,
523 C<&checkauth> presents the user with a login page (from the point of
524 view of the original script, C<&checkauth> does not return). Once the
525 user has authenticated, C<&checkauth> restarts the original script
526 (this time, C<&checkauth> returns).
528 The login page is provided using a HTML::Template, which is set in the
529 systempreferences table or at the top of this file. The variable C<$type>
530 selects which template to use, either the opac or the intranet
531 authentification template.
533 C<&checkauth> returns a user ID, a cookie, and a session ID. The
534 cookie should be sent back to the browser; it verifies that the user
539 sub _version_check ($$) {
543 # If Version syspref is unavailable, it means Koha is beeing installed,
544 # and so we must redirect to OPAC maintenance page or to the WebInstaller
545 # also, if OpacMaintenance is ON, OPAC should redirect to maintenance
546 if (C4::Context->preference('OpacMaintenance') && $type eq 'opac') {
547 warn "OPAC Install required, redirecting to maintenance";
548 print $query->redirect("/cgi-bin/koha/maintenance.pl");
550 unless ($version = C4::Context->preference('Version')) { # assignment, not comparison
551 if ($type ne 'opac') {
552 warn "Install required, redirecting to Installer";
553 print $query->redirect("/cgi-bin/koha/installer/install.pl");
556 warn "OPAC Install required, redirecting to maintenance";
557 print $query->redirect("/cgi-bin/koha/maintenance.pl");
562 # check that database and koha version are the same
563 # there is no DB version, it's a fresh install,
564 # go to web installer
565 # there is a DB version, compare it to the code version
566 my $kohaversion=C4::Context::KOHAVERSION;
567 # remove the 3 last . to have a Perl number
568 $kohaversion =~ s/(.*\..*)\.(.*)\.(.*)/$1$2$3/;
569 $debug and print STDERR "kohaversion : $kohaversion\n";
570 if ($version < $kohaversion){
571 my $warning = "Database update needed, redirecting to %s. Database is $version and Koha is $kohaversion";
572 if ($type ne 'opac'){
573 warn sprintf($warning, 'Installer');
574 print $query->redirect("/cgi-bin/koha/installer/install.pl?step=3");
576 warn sprintf("OPAC: " . $warning, 'maintenance');
577 print $query->redirect("/cgi-bin/koha/maintenance.pl");
585 open L, ">>/tmp/sessionlog" or warn "ERROR: Cannot append to /tmp/sessionlog";
586 printf L join("\n",@_);
592 $debug and warn "Checking Auth";
593 # $authnotrequired will be set for scripts which will run without authentication
594 my $authnotrequired = shift;
595 my $flagsrequired = shift;
597 $type = 'opac' unless $type;
599 my $dbh = C4::Context->dbh;
600 my $timeout = C4::Context->preference('timeout');
602 if ($timeout =~ /(\d+)[dD]/) {
603 $timeout = $1 * 86400;
605 $timeout = 600 unless $timeout;
607 _version_check($type,$query);
611 my ( $userid, $cookie, $sessionID, $flags, $barshelves, $pubshelves );
612 my $logout = $query->param('logout.x');
614 if ( $userid = $ENV{'REMOTE_USER'} ) {
615 # Using Basic Authentication, no cookies required
616 $cookie = $query->cookie(
617 -name => 'CGISESSID',
623 elsif ( $sessionID = $query->cookie("CGISESSID")) { # assignment, not comparison
624 my $session = get_session($sessionID);
625 C4::Context->_new_userenv($sessionID);
626 my ($ip, $lasttime, $sessiontype);
628 C4::Context::set_userenv(
629 $session->param('number'), $session->param('id'),
630 $session->param('cardnumber'), $session->param('firstname'),
631 $session->param('surname'), $session->param('branch'),
632 $session->param('branchname'), $session->param('flags'),
633 $session->param('emailaddress'), $session->param('branchprinter')
635 C4::Context::set_shelves_userenv('bar',$session->param('barshelves'));
636 C4::Context::set_shelves_userenv('pub',$session->param('pubshelves'));
637 C4::Context::set_shelves_userenv('tot',$session->param('totshelves'));
638 $debug and printf STDERR "AUTH_SESSION: (%s)\t%s %s - %s\n", map {$session->param($_)} qw(cardnumber firstname surname branch) ;
639 $ip = $session->param('ip');
640 $lasttime = $session->param('lasttime');
641 $userid = $session->param('id');
642 $sessiontype = $session->param('sessiontype');
644 if ( ($query->param('koha_login_context')) && ($query->param('userid') ne $session->param('id')) ) {
645 #if a user enters an id ne to the id in the current session, we need to log them in...
646 #first we need to clear the anonymous session...
647 $debug and warn "query id = " . $query->param('userid') . " but session id = " . $session->param('id');
650 C4::Context->_unset_userenv($sessionID);
655 # voluntary logout the user
658 C4::Context->_unset_userenv($sessionID);
659 _session_log(sprintf "%20s from %16s logged out at %30s (manually).\n", $userid,$ip,(strftime "%c",localtime));
663 if ($cas and $caslogout) {
667 elsif ( $lasttime < time() - $timeout ) {
669 $info{'timed_out'} = 1;
671 C4::Context->_unset_userenv($sessionID);
672 _session_log(sprintf "%20s from %16s logged out at %30s (inactivity).\n", $userid,$ip,(strftime "%c",localtime));
676 elsif ( $ip ne $ENV{'REMOTE_ADDR'} ) {
677 # Different ip than originally logged in from
678 $info{'oldip'} = $ip;
679 $info{'newip'} = $ENV{'REMOTE_ADDR'};
680 $info{'different_ip'} = 1;
682 C4::Context->_unset_userenv($sessionID);
683 _session_log(sprintf "%20s from %16s logged out at %30s (ip changed to %16s).\n", $userid,$ip,(strftime "%c",localtime), $info{'newip'});
688 $cookie = $query->cookie( CGISESSID => $session->id );
689 $session->param('lasttime',time());
690 unless ( $sessiontype eq 'anon' ) { #if this is an anonymous session, we want to update the session, but not behave as if they are logged in...
691 $flags = haspermission($userid, $flagsrequired);
695 $info{'nopermission'} = 1;
700 unless ($userid || $sessionID) {
701 #we initiate a session prior to checking for a username to allow for anonymous sessions...
702 my $session = get_session("") or die "Auth ERROR: Cannot get_session()";
703 my $sessionID = $session->id;
704 C4::Context->_new_userenv($sessionID);
705 $cookie = $query->cookie(CGISESSID => $sessionID);
706 $userid = $query->param('userid');
707 if ($cas || $userid) {
708 my $password = $query->param('password');
709 my ($return, $cardnumber);
710 if ($cas && $query->param('ticket')) {
712 ( $return, $cardnumber, $retuserid ) = checkpw( $dbh, $userid, $password, $query );
713 $userid = $retuserid;
714 $info{'invalidCasLogin'} = 1 unless ($return);
716 ( $return, $cardnumber ) = checkpw( $dbh, $userid, $password, $query );
719 _session_log(sprintf "%20s from %16s logged in at %30s.\n", $userid,$ENV{'REMOTE_ADDR'},localtime);
720 if ( $flags = haspermission( $userid, $flagsrequired ) ) {
724 $info{'nopermission'} = 1;
725 C4::Context->_unset_userenv($sessionID);
728 my ($borrowernumber, $firstname, $surname, $userflags,
729 $branchcode, $branchname, $branchprinter, $emailaddress);
731 if ( $return == 1 ) {
733 SELECT borrowernumber, firstname, surname, flags, borrowers.branchcode,
734 branches.branchname as branchname,
735 branches.branchprinter as branchprinter,
738 LEFT JOIN branches on borrowers.branchcode=branches.branchcode
740 my $sth = $dbh->prepare("$select where userid=?");
741 $sth->execute($userid);
742 unless ($sth->rows) {
743 $debug and print STDERR "AUTH_1: no rows for userid='$userid'\n";
744 $sth = $dbh->prepare("$select where cardnumber=?");
745 $sth->execute($cardnumber);
746 unless ($sth->rows) {
747 $debug and print STDERR "AUTH_2a: no rows for cardnumber='$cardnumber'\n";
748 $sth->execute($userid);
749 unless ($sth->rows) {
750 $debug and print STDERR "AUTH_2b: no rows for userid='$userid' AS cardnumber\n";
755 ($borrowernumber, $firstname, $surname, $userflags,
756 $branchcode, $branchname, $branchprinter, $emailaddress) = $sth->fetchrow;
757 $debug and print STDERR "AUTH_3 results: " .
758 "$cardnumber,$borrowernumber,$userid,$firstname,$surname,$userflags,$branchcode,$emailaddress\n";
760 print STDERR "AUTH_3: no results for userid='$userid', cardnumber='$cardnumber'.\n";
763 # launch a sequence to check if we have a ip for the branch, i
764 # if we have one we replace the branchcode of the userenv by the branch bound in the ip.
766 my $ip = $ENV{'REMOTE_ADDR'};
767 # if they specify at login, use that
768 if ($query->param('branch')) {
769 $branchcode = $query->param('branch');
770 $branchname = GetBranchName($branchcode);
772 my $branches = GetBranches();
773 if (C4::Context->boolean_preference('IndependantBranches') && C4::Context->boolean_preference('Autolocation')){
774 # we have to check they are coming from the right ip range
775 my $domain = $branches->{$branchcode}->{'branchip'};
776 if ($ip !~ /^$domain/){
778 $info{'wrongip'} = 1;
783 foreach my $br ( keys %$branches ) {
784 # now we work with the treatment of ip
785 my $domain = $branches->{$br}->{'branchip'};
786 if ( $domain && $ip =~ /^$domain/ ) {
787 $branchcode = $branches->{$br}->{'branchcode'};
789 # new op dev : add the branchprinter and branchname in the cookie
790 $branchprinter = $branches->{$br}->{'branchprinter'};
791 $branchname = $branches->{$br}->{'branchname'};
794 $session->param('number',$borrowernumber);
795 $session->param('id',$userid);
796 $session->param('cardnumber',$cardnumber);
797 $session->param('firstname',$firstname);
798 $session->param('surname',$surname);
799 $session->param('branch',$branchcode);
800 $session->param('branchname',$branchname);
801 $session->param('flags',$userflags);
802 $session->param('emailaddress',$emailaddress);
803 $session->param('ip',$session->remote_addr());
804 $session->param('lasttime',time());
805 $debug and printf STDERR "AUTH_4: (%s)\t%s %s - %s\n", map {$session->param($_)} qw(cardnumber firstname surname branch) ;
807 elsif ( $return == 2 ) {
808 #We suppose the user is the superlibrarian
810 $session->param('number',0);
811 $session->param('id',C4::Context->config('user'));
812 $session->param('cardnumber',C4::Context->config('user'));
813 $session->param('firstname',C4::Context->config('user'));
814 $session->param('surname',C4::Context->config('user'));
815 $session->param('branch','NO_LIBRARY_SET');
816 $session->param('branchname','NO_LIBRARY_SET');
817 $session->param('flags',1);
818 $session->param('emailaddress', C4::Context->preference('KohaAdminEmailAddress'));
819 $session->param('ip',$session->remote_addr());
820 $session->param('lasttime',time());
822 C4::Context::set_userenv(
823 $session->param('number'), $session->param('id'),
824 $session->param('cardnumber'), $session->param('firstname'),
825 $session->param('surname'), $session->param('branch'),
826 $session->param('branchname'), $session->param('flags'),
827 $session->param('emailaddress'), $session->param('branchprinter')
830 # Grab borrower's shelves and public shelves and add them to the session
831 # $row_count determines how many records are returned from the db query
832 # and the number of lists to be displayed of each type in the 'Lists' button drop down
833 my $row_count = 10; # FIXME:This probably should be a syspref
834 my ($total, $totshelves, $barshelves, $pubshelves);
835 ($barshelves, $totshelves) = C4::VirtualShelves::GetRecentShelves(1, $row_count, $borrowernumber);
836 $total->{'bartotal'} = $totshelves;
837 ($pubshelves, $totshelves) = C4::VirtualShelves::GetRecentShelves(2, $row_count, undef);
838 $total->{'pubtotal'} = $totshelves;
839 $session->param('barshelves', $barshelves->[0]);
840 $session->param('pubshelves', $pubshelves->[0]);
841 $session->param('totshelves', $total);
843 C4::Context::set_shelves_userenv('bar',$barshelves->[0]);
844 C4::Context::set_shelves_userenv('pub',$pubshelves->[0]);
845 C4::Context::set_shelves_userenv('tot',$total);
849 $info{'invalid_username_or_password'} = 1;
850 C4::Context->_unset_userenv($sessionID);
853 } # END if ( $userid = $query->param('userid') )
854 elsif ($type eq "opac") {
855 # if we are here this is an anonymous session; add public lists to it and a few other items...
856 # anonymous sessions are created only for the OPAC
857 $debug and warn "Initiating an anonymous session...";
859 # Grab the public shelves and add to the session...
860 my $row_count = 20; # FIXME:This probably should be a syspref
861 my ($total, $totshelves, $pubshelves);
862 ($pubshelves, $totshelves) = C4::VirtualShelves::GetRecentShelves(2, $row_count, undef);
863 $total->{'pubtotal'} = $totshelves;
864 $session->param('pubshelves', $pubshelves->[0]);
865 $session->param('totshelves', $total);
866 C4::Context::set_shelves_userenv('pub',$pubshelves->[0]);
867 C4::Context::set_shelves_userenv('tot',$total);
869 # setting a couple of other session vars...
870 $session->param('ip',$session->remote_addr());
871 $session->param('lasttime',time());
872 $session->param('sessiontype','anon');
874 } # END unless ($userid)
875 my $insecure = C4::Context->boolean_preference('insecure');
877 # finished authentification, now respond
878 if ( $loggedin || $authnotrequired || ( defined($insecure) && $insecure ) )
882 $cookie = $query->cookie( CGISESSID => '' );
884 return ( $userid, $cookie, $sessionID, $flags );
889 # AUTH rejected, show the login/password template, after checking the DB.
893 # get the inputs from the incoming query
895 foreach my $name ( param $query) {
896 (next) if ( $name eq 'userid' || $name eq 'password' || $name eq 'ticket' );
897 my $value = $query->param($name);
898 push @inputs, { name => $name, value => $value };
900 # get the branchloop, which we need for authentication
901 my $branches = GetBranches();
903 for my $branch_hash (sort keys %$branches) {
904 push @branch_loop, {branchcode => "$branch_hash", branchname => $branches->{$branch_hash}->{'branchname'}, };
907 my $template_name = ( $type eq 'opac' ) ? 'opac-auth.tmpl' : 'auth.tmpl';
908 my $template = gettemplate( $template_name, $type, $query );
909 $template->param(branchloop => \@branch_loop,);
913 casAuthentication => C4::Context->preference("casAuthentication"),
914 suggestion => C4::Context->preference("suggestion"),
915 virtualshelves => C4::Context->preference("virtualshelves"),
916 LibraryName => C4::Context->preference("LibraryName"),
917 opacuserlogin => C4::Context->preference("opacuserlogin"),
918 OpacNav => C4::Context->preference("OpacNav"),
919 opaccredits => C4::Context->preference("opaccredits"),
920 opacreadinghistory => C4::Context->preference("opacreadinghistory"),
921 opacsmallimage => C4::Context->preference("opacsmallimage"),
922 opaclayoutstylesheet => C4::Context->preference("opaclayoutstylesheet"),
923 opaccolorstylesheet => C4::Context->preference("opaccolorstylesheet"),
924 opaclanguagesdisplay => C4::Context->preference("opaclanguagesdisplay"),
925 opacuserjs => C4::Context->preference("opacuserjs"),
926 opacbookbag => "" . C4::Context->preference("opacbookbag"),
927 OpacCloud => C4::Context->preference("OpacCloud"),
928 OpacTopissue => C4::Context->preference("OpacTopissue"),
929 OpacAuthorities => C4::Context->preference("OpacAuthorities"),
930 OpacBrowser => C4::Context->preference("OpacBrowser"),
931 opacheader => C4::Context->preference("opacheader"),
932 TagsEnabled => C4::Context->preference("TagsEnabled"),
933 OPACUserCSS => C4::Context->preference("OPACUserCSS"),
934 intranetcolorstylesheet =>
935 C4::Context->preference("intranetcolorstylesheet"),
936 intranetstylesheet => C4::Context->preference("intranetstylesheet"),
937 intranetbookbag => C4::Context->preference("intranetbookbag"),
938 IntranetNav => C4::Context->preference("IntranetNav"),
939 intranetuserjs => C4::Context->preference("intranetuserjs"),
940 TemplateEncoding => C4::Context->preference("TemplateEncoding"),
941 IndependantBranches=> C4::Context->preference("IndependantBranches"),
942 AutoLocation => C4::Context->preference("AutoLocation"),
943 wrongip => $info{'wrongip'}
945 $template->param( loginprompt => 1 ) unless $info{'nopermission'};
949 casServerUrl => login_cas_url(),
950 invalidCasLogin => $info{'invalidCasLogin'}
954 my $self_url = $query->url( -absolute => 1 );
957 LibraryName => C4::Context->preference("LibraryName"),
959 $template->param( \%info );
960 # $cookie = $query->cookie(CGISESSID => $session->id
962 print $query->header(
963 -type => 'text/html',
973 ($status, $cookie, $sessionId) = check_api_auth($query, $userflags);
975 Given a CGI query containing the parameters 'userid' and 'password' and/or a session
976 cookie, determine if the user has the privileges specified by C<$userflags>.
978 C<check_api_auth> is is meant for authenticating users of web services, and
979 consequently will always return and will not attempt to redirect the user
982 If a valid session cookie is already present, check_api_auth will return a status
983 of "ok", the cookie, and the Koha session ID.
985 If no session cookie is present, check_api_auth will check the 'userid' and 'password
986 parameters and create a session cookie and Koha session if the supplied credentials
989 Possible return values in C<$status> are:
993 =item "ok" -- user authenticated; C<$cookie> and C<$sessionid> have valid values.
995 =item "failed" -- credentials are not correct; C<$cookie> and C<$sessionid> are undef
997 =item "maintenance" -- DB is in maintenance mode; no login possible at the moment
999 =item "expired -- session cookie has expired; API user should resubmit userid and password
1005 sub check_api_auth {
1007 my $flagsrequired = shift;
1009 my $dbh = C4::Context->dbh;
1010 my $timeout = C4::Context->preference('timeout');
1011 $timeout = 600 unless $timeout;
1013 unless (C4::Context->preference('Version')) {
1014 # database has not been installed yet
1015 return ("maintenance", undef, undef);
1017 my $kohaversion=C4::Context::KOHAVERSION;
1018 $kohaversion =~ s/(.*\..*)\.(.*)\.(.*)/$1$2$3/;
1019 if (C4::Context->preference('Version') < $kohaversion) {
1020 # database in need of version update; assume that
1021 # no API should be called while databsae is in
1023 return ("maintenance", undef, undef);
1026 # FIXME -- most of what follows is a copy-and-paste
1027 # of code from checkauth. There is an obvious need
1028 # for refactoring to separate the various parts of
1029 # the authentication code, but as of 2007-11-19 this
1030 # is deferred so as to not introduce bugs into the
1031 # regular authentication code for Koha 3.0.
1033 # see if we have a valid session cookie already
1034 # however, if a userid parameter is present (i.e., from
1035 # a form submission, assume that any current cookie
1037 my $sessionID = undef;
1038 unless ($query->param('userid')) {
1039 $sessionID = $query->cookie("CGISESSID");
1042 my $session = get_session($sessionID);
1043 C4::Context->_new_userenv($sessionID);
1045 C4::Context::set_userenv(
1046 $session->param('number'), $session->param('id'),
1047 $session->param('cardnumber'), $session->param('firstname'),
1048 $session->param('surname'), $session->param('branch'),
1049 $session->param('branchname'), $session->param('flags'),
1050 $session->param('emailaddress'), $session->param('branchprinter')
1053 my $ip = $session->param('ip');
1054 my $lasttime = $session->param('lasttime');
1055 my $userid = $session->param('id');
1056 if ( $lasttime < time() - $timeout ) {
1059 C4::Context->_unset_userenv($sessionID);
1062 return ("expired", undef, undef);
1063 } elsif ( $ip ne $ENV{'REMOTE_ADDR'} ) {
1064 # IP address changed
1066 C4::Context->_unset_userenv($sessionID);
1069 return ("expired", undef, undef);
1071 my $cookie = $query->cookie( CGISESSID => $session->id );
1072 $session->param('lasttime',time());
1073 my $flags = haspermission($userid, $flagsrequired);
1075 return ("ok", $cookie, $sessionID);
1078 C4::Context->_unset_userenv($sessionID);
1081 return ("failed", undef, undef);
1085 return ("expired", undef, undef);
1089 my $userid = $query->param('userid');
1090 my $password = $query->param('password');
1091 unless ($userid and $password) {
1092 # caller did something wrong, fail the authenticateion
1093 return ("failed", undef, undef);
1095 my ($return, $cardnumber);
1096 if ($cas && $query->param('ticket')) {
1098 ( $return, $cardnumber, $retuserid ) = checkpw( $dbh, $userid, $password, $query );
1099 $userid = $retuserid;
1101 ( $return, $cardnumber ) = checkpw( $dbh, $userid, $password, $query );
1103 if ($return and haspermission( $userid, $flagsrequired)) {
1104 my $session = get_session("");
1105 return ("failed", undef, undef) unless $session;
1107 my $sessionID = $session->id;
1108 C4::Context->_new_userenv($sessionID);
1109 my $cookie = $query->cookie(CGISESSID => $sessionID);
1110 if ( $return == 1 ) {
1112 $borrowernumber, $firstname, $surname,
1113 $userflags, $branchcode, $branchname,
1114 $branchprinter, $emailaddress
1118 "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=?"
1120 $sth->execute($userid);
1122 $borrowernumber, $firstname, $surname,
1123 $userflags, $branchcode, $branchname,
1124 $branchprinter, $emailaddress
1125 ) = $sth->fetchrow if ( $sth->rows );
1127 unless ($sth->rows ) {
1128 my $sth = $dbh->prepare(
1129 "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=?"
1131 $sth->execute($cardnumber);
1133 $borrowernumber, $firstname, $surname,
1134 $userflags, $branchcode, $branchname,
1135 $branchprinter, $emailaddress
1136 ) = $sth->fetchrow if ( $sth->rows );
1138 unless ( $sth->rows ) {
1139 $sth->execute($userid);
1141 $borrowernumber, $firstname, $surname, $userflags,
1142 $branchcode, $branchname, $branchprinter, $emailaddress
1143 ) = $sth->fetchrow if ( $sth->rows );
1147 my $ip = $ENV{'REMOTE_ADDR'};
1148 # if they specify at login, use that
1149 if ($query->param('branch')) {
1150 $branchcode = $query->param('branch');
1151 $branchname = GetBranchName($branchcode);
1153 my $branches = GetBranches();
1155 foreach my $br ( keys %$branches ) {
1156 # now we work with the treatment of ip
1157 my $domain = $branches->{$br}->{'branchip'};
1158 if ( $domain && $ip =~ /^$domain/ ) {
1159 $branchcode = $branches->{$br}->{'branchcode'};
1161 # new op dev : add the branchprinter and branchname in the cookie
1162 $branchprinter = $branches->{$br}->{'branchprinter'};
1163 $branchname = $branches->{$br}->{'branchname'};
1166 $session->param('number',$borrowernumber);
1167 $session->param('id',$userid);
1168 $session->param('cardnumber',$cardnumber);
1169 $session->param('firstname',$firstname);
1170 $session->param('surname',$surname);
1171 $session->param('branch',$branchcode);
1172 $session->param('branchname',$branchname);
1173 $session->param('flags',$userflags);
1174 $session->param('emailaddress',$emailaddress);
1175 $session->param('ip',$session->remote_addr());
1176 $session->param('lasttime',time());
1177 } elsif ( $return == 2 ) {
1178 #We suppose the user is the superlibrarian
1179 $session->param('number',0);
1180 $session->param('id',C4::Context->config('user'));
1181 $session->param('cardnumber',C4::Context->config('user'));
1182 $session->param('firstname',C4::Context->config('user'));
1183 $session->param('surname',C4::Context->config('user'));
1184 $session->param('branch','NO_LIBRARY_SET');
1185 $session->param('branchname','NO_LIBRARY_SET');
1186 $session->param('flags',1);
1187 $session->param('emailaddress', C4::Context->preference('KohaAdminEmailAddress'));
1188 $session->param('ip',$session->remote_addr());
1189 $session->param('lasttime',time());
1191 C4::Context::set_userenv(
1192 $session->param('number'), $session->param('id'),
1193 $session->param('cardnumber'), $session->param('firstname'),
1194 $session->param('surname'), $session->param('branch'),
1195 $session->param('branchname'), $session->param('flags'),
1196 $session->param('emailaddress'), $session->param('branchprinter')
1198 return ("ok", $cookie, $sessionID);
1200 return ("failed", undef, undef);
1205 =item check_cookie_auth
1207 ($status, $sessionId) = check_api_auth($cookie, $userflags);
1209 Given a CGISESSID cookie set during a previous login to Koha, determine
1210 if the user has the privileges specified by C<$userflags>.
1212 C<check_cookie_auth> is meant for authenticating special services
1213 such as tools/upload-file.pl that are invoked by other pages that
1214 have been authenticated in the usual way.
1216 Possible return values in C<$status> are:
1220 =item "ok" -- user authenticated; C<$sessionID> have valid values.
1222 =item "failed" -- credentials are not correct; C<$sessionid> are undef
1224 =item "maintenance" -- DB is in maintenance mode; no login possible at the moment
1226 =item "expired -- session cookie has expired; API user should resubmit userid and password
1232 sub check_cookie_auth {
1234 my $flagsrequired = shift;
1236 my $dbh = C4::Context->dbh;
1237 my $timeout = C4::Context->preference('timeout');
1238 $timeout = 600 unless $timeout;
1240 unless (C4::Context->preference('Version')) {
1241 # database has not been installed yet
1242 return ("maintenance", undef);
1244 my $kohaversion=C4::Context::KOHAVERSION;
1245 $kohaversion =~ s/(.*\..*)\.(.*)\.(.*)/$1$2$3/;
1246 if (C4::Context->preference('Version') < $kohaversion) {
1247 # database in need of version update; assume that
1248 # no API should be called while databsae is in
1250 return ("maintenance", undef);
1253 # FIXME -- most of what follows is a copy-and-paste
1254 # of code from checkauth. There is an obvious need
1255 # for refactoring to separate the various parts of
1256 # the authentication code, but as of 2007-11-23 this
1257 # is deferred so as to not introduce bugs into the
1258 # regular authentication code for Koha 3.0.
1260 # see if we have a valid session cookie already
1261 # however, if a userid parameter is present (i.e., from
1262 # a form submission, assume that any current cookie
1264 unless (defined $cookie and $cookie) {
1265 return ("failed", undef);
1267 my $sessionID = $cookie;
1268 my $session = get_session($sessionID);
1269 C4::Context->_new_userenv($sessionID);
1271 C4::Context::set_userenv(
1272 $session->param('number'), $session->param('id'),
1273 $session->param('cardnumber'), $session->param('firstname'),
1274 $session->param('surname'), $session->param('branch'),
1275 $session->param('branchname'), $session->param('flags'),
1276 $session->param('emailaddress'), $session->param('branchprinter')
1279 my $ip = $session->param('ip');
1280 my $lasttime = $session->param('lasttime');
1281 my $userid = $session->param('id');
1282 if ( $lasttime < time() - $timeout ) {
1285 C4::Context->_unset_userenv($sessionID);
1288 return ("expired", undef);
1289 } elsif ( $ip ne $ENV{'REMOTE_ADDR'} ) {
1290 # IP address changed
1292 C4::Context->_unset_userenv($sessionID);
1295 return ("expired", undef);
1297 $session->param('lasttime',time());
1298 my $flags = haspermission($userid, $flagsrequired);
1300 return ("ok", $sessionID);
1303 C4::Context->_unset_userenv($sessionID);
1306 return ("failed", undef);
1310 return ("expired", undef);
1317 my $session = get_session($sessionID);
1319 Given a session ID, retrieve the CGI::Session object used to store
1320 the session's state. The session object can be used to store
1321 data that needs to be accessed by different scripts during a
1324 If the C<$sessionID> parameter is an empty string, a new session
1330 my $sessionID = shift;
1331 my $storage_method = C4::Context->preference('SessionStorage');
1332 my $dbh = C4::Context->dbh;
1334 if ($storage_method eq 'mysql'){
1335 $session = new CGI::Session("driver:MySQL;serializer:yaml;id:md5", $sessionID, {Handle=>$dbh});
1337 elsif ($storage_method eq 'Pg') {
1338 $session = new CGI::Session("driver:PostgreSQL;serializer:yaml;id:md5", $sessionID, {Handle=>$dbh});
1341 # catch all defaults to tmp should work on all systems
1342 $session = new CGI::Session("driver:File;serializer:yaml;id:md5", $sessionID, {Directory=>'/tmp'});
1349 my ( $dbh, $userid, $password, $query ) = @_;
1351 $debug and print "## checkpw - checking LDAP\n";
1352 my ($retval,$retcard) = checkpw_ldap(@_); # EXTERNAL AUTH
1353 ($retval) and return ($retval,$retcard);
1356 if ($cas && $query->param('ticket')) {
1357 $debug and print STDERR "## checkpw - checking CAS\n";
1358 # In case of a CAS authentication, we use the ticket instead of the password
1359 my $ticket = $query->param('ticket');
1360 my ($retval,$retcard,$retuserid) = checkpw_cas($dbh, $ticket, $query); # EXTERNAL AUTH
1361 ($retval) and return ($retval,$retcard,$retuserid);
1368 "select password,cardnumber,borrowernumber,userid,firstname,surname,branchcode,flags from borrowers where userid=?"
1370 $sth->execute($userid);
1372 my ( $md5password, $cardnumber, $borrowernumber, $userid, $firstname,
1373 $surname, $branchcode, $flags )
1375 if ( md5_base64($password) eq $md5password and $md5password ne "!") {
1377 C4::Context->set_userenv( "$borrowernumber", $userid, $cardnumber,
1378 $firstname, $surname, $branchcode, $flags );
1379 return 1, $cardnumber;
1384 "select password,cardnumber,borrowernumber,userid, firstname,surname,branchcode,flags from borrowers where cardnumber=?"
1386 $sth->execute($userid);
1388 my ( $md5password, $cardnumber, $borrowernumber, $userid, $firstname,
1389 $surname, $branchcode, $flags )
1391 if ( md5_base64($password) eq $md5password ) {
1393 C4::Context->set_userenv( $borrowernumber, $userid, $cardnumber,
1394 $firstname, $surname, $branchcode, $flags );
1398 if ( $userid && $userid eq C4::Context->config('user')
1399 && "$password" eq C4::Context->config('pass') )
1402 # Koha superuser account
1403 # C4::Context->set_userenv(0,0,C4::Context->config('user'),C4::Context->config('user'),C4::Context->config('user'),"",1);
1406 if ( $userid && $userid eq 'demo'
1407 && "$password" eq 'demo'
1408 && C4::Context->config('demo') )
1411 # DEMO => the demo user is allowed to do everything (if demo set to 1 in koha.conf
1412 # some features won't be effective : modify systempref, modify MARC structure,
1420 my $authflags = getuserflags($flags, $userid, [$dbh]);
1422 Translates integer flags into permissions strings hash.
1424 C<$flags> is the integer userflags value ( borrowers.userflags )
1425 C<$userid> is the members.userid, used for building subpermissions
1426 C<$authflags> is a hashref of permissions
1433 my $dbh = @_ ? shift : C4::Context->dbh;
1435 $flags = 0 unless $flags;
1436 my $sth = $dbh->prepare("SELECT bit, flag, defaulton FROM userflags");
1439 while ( my ( $bit, $flag, $defaulton ) = $sth->fetchrow ) {
1440 if ( ( $flags & ( 2**$bit ) ) || $defaulton ) {
1441 $userflags->{$flag} = 1;
1444 $userflags->{$flag} = 0;
1448 # get subpermissions and merge with top-level permissions
1449 my $user_subperms = get_user_subpermissions($userid);
1450 foreach my $module (keys %$user_subperms) {
1451 next if $userflags->{$module} == 1; # user already has permission for everything in this module
1452 $userflags->{$module} = $user_subperms->{$module};
1458 =item get_user_subpermissions
1462 my $user_perm_hashref = get_user_subpermissions($userid);
1466 Given the userid (note, not the borrowernumber) of a staff user,
1467 return a hashref of hashrefs of the specific subpermissions
1468 accorded to the user. An example return is
1472 export_catalog => 1,
1473 import_patrons => 1,
1477 The top-level hash-key is a module or function code from
1478 userflags.flag, while the second-level key is a code
1481 The results of this function do not give a complete picture
1482 of the functions that a staff user can access; it is also
1483 necessary to check borrowers.flags.
1487 sub get_user_subpermissions {
1490 my $dbh = C4::Context->dbh;
1491 my $sth = $dbh->prepare("SELECT flag, user_permissions.code
1492 FROM user_permissions
1493 JOIN permissions USING (module_bit, code)
1494 JOIN userflags ON (module_bit = bit)
1495 JOIN borrowers USING (borrowernumber)
1497 $sth->execute($userid);
1499 my $user_perms = {};
1500 while (my $perm = $sth->fetchrow_hashref) {
1501 $user_perms->{$perm->{'flag'}}->{$perm->{'code'}} = 1;
1506 =item get_all_subpermissions
1510 my $perm_hashref = get_all_subpermissions();
1514 Returns a hashref of hashrefs defining all specific
1515 permissions currently defined. The return value
1516 has the same structure as that of C<get_user_subpermissions>,
1517 except that the innermost hash value is the description
1518 of the subpermission.
1522 sub get_all_subpermissions {
1523 my $dbh = C4::Context->dbh;
1524 my $sth = $dbh->prepare("SELECT flag, code, description
1526 JOIN userflags ON (module_bit = bit)");
1530 while (my $perm = $sth->fetchrow_hashref) {
1531 $all_perms->{$perm->{'flag'}}->{$perm->{'code'}} = $perm->{'description'};
1538 $flags = ($userid, $flagsrequired);
1540 C<$userid> the userid of the member
1541 C<$flags> is a hashref of required flags like C<$borrower-<{authflags}>
1543 Returns member's flags or 0 if a permission is not met.
1548 my ($userid, $flagsrequired) = @_;
1549 my $sth = C4::Context->dbh->prepare("SELECT flags FROM borrowers WHERE userid=?");
1550 $sth->execute($userid);
1551 my $flags = getuserflags( $sth->fetchrow(), $userid );
1552 if ( $userid eq C4::Context->config('user') ) {
1553 # Super User Account from /etc/koha.conf
1554 $flags->{'superlibrarian'} = 1;
1556 elsif ( $userid eq 'demo' && C4::Context->config('demo') ) {
1557 # Demo user that can do "anything" (demo=1 in /etc/koha.conf)
1558 $flags->{'superlibrarian'} = 1;
1560 return $flags if $flags->{superlibrarian};
1561 foreach my $module ( keys %$flagsrequired ) {
1562 if (C4::Context->preference('GranularPermissions')) {
1563 my $subperm = $flagsrequired->{$module};
1564 if ($subperm eq '*') {
1565 return 0 unless ( $flags->{$module} == 1 or ref($flags->{$module}) );
1567 return 0 unless ( $flags->{$module} == 1 or
1568 ( ref($flags->{$module}) and
1569 exists $flags->{$module}->{$subperm} and
1570 $flags->{$module}->{$subperm} == 1
1575 return 0 unless ( $flags->{$module} );
1579 #FIXME - This fcn should return the failed permission so a suitable error msg can be delivered.
1583 sub getborrowernumber {
1585 my $userenv = C4::Context->userenv;
1586 if ( defined( $userenv ) && ref( $userenv ) eq 'HASH' && $userenv->{number} ) {
1587 return $userenv->{number};
1589 my $dbh = C4::Context->dbh;
1590 for my $field ( 'userid', 'cardnumber' ) {
1592 $dbh->prepare("select borrowernumber from borrowers where $field=?");
1593 $sth->execute($userid);
1595 my ($bnumber) = $sth->fetchrow;
1602 END { } # module clean-up code here (global destructor)