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
17 # with Koha; if not, write to the Free Software Foundation, Inc.,
18 # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
21 #use warnings; FIXME - Bug 2505
22 use Digest::MD5 qw(md5_base64);
23 use Storable qw(thaw freeze);
29 use C4::Output; # to get the template
32 use C4::Branch; # GetBranches
33 use C4::VirtualShelves;
34 use POSIX qw/strftime/;
37 use vars qw($VERSION @ISA @EXPORT @EXPORT_OK %EXPORT_TAGS $debug $ldap $cas $caslogout);
40 $VERSION = 3.02; # set version for version checking
43 @EXPORT = qw(&checkauth &get_template_and_user &haspermission &get_user_subpermissions);
44 @EXPORT_OK = qw(&check_api_auth &get_session &check_cookie_auth &checkpw &get_all_subpermissions &get_user_subpermissions);
45 %EXPORT_TAGS = (EditPermissions => [qw(get_all_subpermissions get_user_subpermissions)]);
46 $ldap = C4::Context->config('useldapserver') || 0;
47 $cas = C4::Context->preference('casAuthentication');
48 $caslogout = C4::Context->preference('casLogout');
50 require C4::Auth_with_ldap; # no import
51 import C4::Auth_with_ldap qw(checkpw_ldap);
54 require C4::Auth_with_cas; # no import
55 import C4::Auth_with_cas qw(checkpw_cas login_cas logout_cas login_cas_url);
62 C4::Auth - Authenticates Koha users
72 my ($template, $borrowernumber, $cookie)
73 = get_template_and_user(
75 template_name => "opac-main.tmpl",
79 flagsrequired => {borrow => 1, catalogue => '*', tools => 'import_patrons' },
83 output_html_with_http_headers $query, $cookie, $template->output;
87 The main function of this module is to provide
88 authentification. However the get_template_and_user function has
89 been provided so that a users login information is passed along
90 automatically. This gets loaded into the template.
94 =head2 get_template_and_user
96 my ($template, $borrowernumber, $cookie)
97 = get_template_and_user(
99 template_name => "opac-main.tmpl",
102 authnotrequired => 1,
103 flagsrequired => {borrow => 1, catalogue => '*', tools => 'import_patrons' },
107 This call passes the C<query>, C<flagsrequired> and C<authnotrequired>
108 to C<&checkauth> (in this module) to perform authentification.
109 See C<&checkauth> for an explanation of these parameters.
111 The C<template_name> is then used to find the correct template for
112 the page. The authenticated users details are loaded onto the
113 template in the HTML::Template LOOP variable C<USER_INFO>. Also the
114 C<sessionID> is passed to the template. This can be used in templates
115 if cookies are disabled. It needs to be put as and input to every
118 More information on the C<gettemplate> sub can be found in the
123 my $SEARCH_HISTORY_INSERT_SQL =<<EOQ;
124 INSERT INTO search_history(userid, sessionid, query_desc, query_cgi, total, time )
125 VALUES ( ?, ?, ?, ?, ?, FROM_UNIXTIME(?))
127 sub get_template_and_user {
130 gettemplate( $in->{'template_name'}, $in->{'type'}, $in->{'query'} );
131 my ( $user, $cookie, $sessionID, $flags ) = checkauth(
133 $in->{'authnotrequired'},
134 $in->{'flagsrequired'},
136 ) unless ($in->{'template_name'}=~/maintenance/);
139 my $insecure = C4::Context->preference('insecure');
140 if ($user or $insecure) {
142 # load the template variables for stylesheets and JavaScript
143 $template->param( css_libs => $in->{'css_libs'} );
144 $template->param( css_module => $in->{'css_module'} );
145 $template->param( css_page => $in->{'css_page'} );
146 $template->param( css_widgets => $in->{'css_widgets'} );
148 $template->param( js_libs => $in->{'js_libs'} );
149 $template->param( js_module => $in->{'js_module'} );
150 $template->param( js_page => $in->{'js_page'} );
151 $template->param( js_widgets => $in->{'js_widgets'} );
154 $template->param( loggedinusername => $user );
155 $template->param( sessionID => $sessionID );
157 my ($total, $pubshelves, $barshelves) = C4::Context->get_shelves_userenv();
158 if (defined($pubshelves)) {
159 $template->param( pubshelves => scalar @{$pubshelves},
160 pubshelvesloop => $pubshelves,
162 $template->param( pubtotal => $total->{'pubtotal'}, ) if ($total->{'pubtotal'} > scalar @{$pubshelves});
164 if (defined($barshelves)) {
165 $template->param( barshelves => scalar @{$barshelves},
166 barshelvesloop => $barshelves,
168 $template->param( bartotal => $total->{'bartotal'}, ) if ($total->{'bartotal'} > scalar @{$barshelves});
171 $borrowernumber = getborrowernumber($user) if defined($user);
173 my ( $borr ) = GetMemberDetails( $borrowernumber );
176 $template->param( "USER_INFO" => \@bordat );
178 my $all_perms = get_all_subpermissions();
180 my @flagroots = qw(circulate catalogue parameters borrowers permissions reserveforothers borrow
181 editcatalogue updatecharges management tools editauthorities serials reports acquisition);
182 # We are going to use the $flags returned by checkauth
183 # to create the template's parameters that will indicate
184 # which menus the user can access.
185 if (( $flags && $flags->{superlibrarian}==1) or $insecure==1) {
186 $template->param( CAN_user_circulate => 1 );
187 $template->param( CAN_user_catalogue => 1 );
188 $template->param( CAN_user_parameters => 1 );
189 $template->param( CAN_user_borrowers => 1 );
190 $template->param( CAN_user_permissions => 1 );
191 $template->param( CAN_user_reserveforothers => 1 );
192 $template->param( CAN_user_borrow => 1 );
193 $template->param( CAN_user_editcatalogue => 1 );
194 $template->param( CAN_user_updatecharges => 1 );
195 $template->param( CAN_user_acquisition => 1 );
196 $template->param( CAN_user_management => 1 );
197 $template->param( CAN_user_tools => 1 );
198 $template->param( CAN_user_editauthorities => 1 );
199 $template->param( CAN_user_serials => 1 );
200 $template->param( CAN_user_reports => 1 );
201 $template->param( CAN_user_staffaccess => 1 );
202 foreach my $module (keys %$all_perms) {
203 foreach my $subperm (keys %{ $all_perms->{$module} }) {
204 $template->param( "CAN_user_${module}_${subperm}" => 1 );
210 foreach my $module (keys %$all_perms) {
211 if ( $flags->{$module} == 1) {
212 foreach my $subperm (keys %{ $all_perms->{$module} }) {
213 $template->param( "CAN_user_${module}_${subperm}" => 1 );
215 } elsif ( ref($flags->{$module}) ) {
216 foreach my $subperm (keys %{ $flags->{$module} } ) {
217 $template->param( "CAN_user_${module}_${subperm}" => 1 );
224 foreach my $module (keys %$flags) {
225 if ( $flags->{$module} == 1 or ref($flags->{$module}) ) {
226 $template->param( "CAN_user_$module" => 1 );
227 if ($module eq "parameters") {
228 $template->param( CAN_user_management => 1 );
233 # Logged-in opac search history
234 # If the requested template is an opac one and opac search history is enabled
235 if ($in->{type} eq 'opac' && C4::Context->preference('EnableOpacSearchHistory')) {
236 my $dbh = C4::Context->dbh;
237 my $query = "SELECT COUNT(*) FROM search_history WHERE userid=?";
238 my $sth = $dbh->prepare($query);
239 $sth->execute($borrowernumber);
241 # If at least one search has already been performed
242 if ($sth->fetchrow_array > 0) {
243 # We show the link in opac
244 $template->param(ShowOpacRecentSearchLink => 1);
247 # And if there's a cookie with searches performed when the user was not logged in,
248 # we add them to the logged-in search history
249 my $searchcookie = $in->{'query'}->cookie('KohaOpacRecentSearches');
251 $searchcookie = uri_unescape($searchcookie);
252 my @recentSearches = @{thaw($searchcookie) || []};
253 if (@recentSearches) {
254 my $sth = $dbh->prepare($SEARCH_HISTORY_INSERT_SQL);
255 $sth->execute( $borrowernumber,
256 $in->{'query'}->cookie("CGISESSID"),
261 ) foreach @recentSearches;
263 # And then, delete the cookie's content
264 my $newsearchcookie = $in->{'query'}->cookie(
265 -name => 'KohaOpacRecentSearches',
266 -value => freeze([]),
269 $cookie = [$cookie, $newsearchcookie];
274 else { # if this is an anonymous session, setup to display public lists...
276 # load the template variables for stylesheets and JavaScript
277 $template->param( css_libs => $in->{'css_libs'} );
278 $template->param( css_module => $in->{'css_module'} );
279 $template->param( css_page => $in->{'css_page'} );
280 $template->param( css_widgets => $in->{'css_widgets'} );
282 $template->param( js_libs => $in->{'js_libs'} );
283 $template->param( js_module => $in->{'js_module'} );
284 $template->param( js_page => $in->{'js_page'} );
285 $template->param( js_widgets => $in->{'js_widgets'} );
287 $template->param( sessionID => $sessionID );
289 my ($total, $pubshelves) = C4::Context->get_shelves_userenv(); # an anonymous user has no 'barshelves'...
290 if (defined $pubshelves) {
291 $template->param( pubshelves => scalar @{$pubshelves},
292 pubshelvesloop => $pubshelves,
294 $template->param( pubtotal => $total->{'pubtotal'}, ) if ($total->{'pubtotal'} > scalar @{$pubshelves});
298 # Anonymous opac search history
299 # If opac search history is enabled and at least one search has already been performed
300 if (C4::Context->preference('EnableOpacSearchHistory')) {
301 my $searchcookie = $in->{'query'}->cookie('KohaOpacRecentSearches');
303 $searchcookie = uri_unescape($searchcookie);
304 my @recentSearches = @{thaw($searchcookie) || []};
305 # We show the link in opac
306 if (@recentSearches) {
307 $template->param(ShowOpacRecentSearchLink => 1);
312 if(C4::Context->preference('dateformat')){
313 if(C4::Context->preference('dateformat') eq "metric"){
314 $template->param(dateformat_metric => 1);
315 } elsif(C4::Context->preference('dateformat') eq "us"){
316 $template->param(dateformat_us => 1);
318 $template->param(dateformat_iso => 1);
321 $template->param(dateformat_iso => 1);
324 # these template parameters are set the same regardless of $in->{'type'}
326 "BiblioDefaultView".C4::Context->preference("BiblioDefaultView") => 1,
327 EnhancedMessagingPreferences => C4::Context->preference('EnhancedMessagingPreferences'),
328 GoogleJackets => C4::Context->preference("GoogleJackets"),
329 KohaAdminEmailAddress => "" . C4::Context->preference("KohaAdminEmailAddress"),
330 LoginBranchcode => (C4::Context->userenv?C4::Context->userenv->{"branch"}:"insecure"),
331 LoginFirstname => (C4::Context->userenv?C4::Context->userenv->{"firstname"}:"Bel"),
332 LoginSurname => C4::Context->userenv?C4::Context->userenv->{"surname"}:"Inconnu",
333 TagsEnabled => C4::Context->preference("TagsEnabled"),
334 hide_marc => C4::Context->preference("hide_marc"),
335 'item-level_itypes' => C4::Context->preference('item-level_itypes'),
336 patronimages => C4::Context->preference("patronimages"),
337 singleBranchMode => C4::Context->preference("singleBranchMode"),
338 XSLTDetailsDisplay => C4::Context->preference("XSLTDetailsDisplay"),
339 XSLTResultsDisplay => C4::Context->preference("XSLTResultsDisplay"),
340 using_https => $in->{'query'}->https() ? 1 : 0,
341 noItemTypeImages => C4::Context->preference("noItemTypeImages"),
344 if ( $in->{'type'} eq "intranet" ) {
346 AmazonContent => C4::Context->preference("AmazonContent"),
347 AmazonCoverImages => C4::Context->preference("AmazonCoverImages"),
348 AmazonEnabled => C4::Context->preference("AmazonEnabled"),
349 AmazonSimilarItems => C4::Context->preference("AmazonSimilarItems"),
350 AutoLocation => C4::Context->preference("AutoLocation"),
351 "BiblioDefaultView".C4::Context->preference("IntranetBiblioDefaultView") => 1,
352 CircAutocompl => C4::Context->preference("CircAutocompl"),
353 FRBRizeEditions => C4::Context->preference("FRBRizeEditions"),
354 IndependantBranches => C4::Context->preference("IndependantBranches"),
355 IntranetNav => C4::Context->preference("IntranetNav"),
356 IntranetmainUserblock => C4::Context->preference("IntranetmainUserblock"),
357 LibraryName => C4::Context->preference("LibraryName"),
358 LoginBranchname => (C4::Context->userenv?C4::Context->userenv->{"branchname"}:"insecure"),
359 advancedMARCEditor => C4::Context->preference("advancedMARCEditor"),
360 canreservefromotherbranches => C4::Context->preference('canreservefromotherbranches'),
361 intranetcolorstylesheet => C4::Context->preference("intranetcolorstylesheet"),
362 intranetreadinghistory => C4::Context->preference("intranetreadinghistory"),
363 intranetstylesheet => C4::Context->preference("intranetstylesheet"),
364 IntranetUserCSS => C4::Context->preference("IntranetUserCSS"),
365 intranetuserjs => C4::Context->preference("intranetuserjs"),
366 intranetbookbag => C4::Context->preference("intranetbookbag"),
367 suggestion => C4::Context->preference("suggestion"),
368 virtualshelves => C4::Context->preference("virtualshelves"),
369 StaffSerialIssueDisplayCount => C4::Context->preference("StaffSerialIssueDisplayCount"),
370 NoZebra => C4::Context->preference('NoZebra'),
374 warn "template type should be OPAC, here it is=[" . $in->{'type'} . "]" unless ( $in->{'type'} eq 'opac' );
375 #TODO : replace LibraryName syspref with 'system name', and remove this html processing
376 my $LibraryNameTitle = C4::Context->preference("LibraryName");
377 $LibraryNameTitle =~ s/<(?:\/?)(?:br|p)\s*(?:\/?)>/ /sgi;
378 $LibraryNameTitle =~ s/<(?:[^<>'"]|'(?:[^']*)'|"(?:[^"]*)")*>//sg;
379 # variables passed from CGI: opac_css_override and opac_search_limits.
380 my $opac_search_limit = $ENV{'OPAC_SEARCH_LIMIT'};
381 my $opac_limit_override = $ENV{'OPAC_LIMIT_OVERRIDE'};
383 if (($opac_search_limit =~ /branch:(\w+)/ && $opac_limit_override) || $in->{'query'}->param('limit') =~ /branch:(\w+)/){
384 $opac_name = $1; # opac_search_limit is a branch, so we use it.
385 } elsif (C4::Context->preference("SearchMyLibraryFirst") && C4::Context->userenv && C4::Context->userenv->{'branch'}) {
386 $opac_name = C4::Context->userenv->{'branch'};
389 AmazonContent => "" . C4::Context->preference("AmazonContent"),
390 AnonSuggestions => "" . C4::Context->preference("AnonSuggestions"),
391 AuthorisedValueImages => C4::Context->preference("AuthorisedValueImages"),
392 BranchesLoop => GetBranchesLoop($opac_name),
393 LibraryName => "" . C4::Context->preference("LibraryName"),
394 LibraryNameTitle => "" . $LibraryNameTitle,
395 LoginBranchname => C4::Context->userenv?C4::Context->userenv->{"branchname"}:"",
396 OPACAmazonEnabled => C4::Context->preference("OPACAmazonEnabled"),
397 OPACAmazonSimilarItems => C4::Context->preference("OPACAmazonSimilarItems"),
398 OPACAmazonCoverImages => C4::Context->preference("OPACAmazonCoverImages"),
399 OPACAmazonReviews => C4::Context->preference("OPACAmazonReviews"),
400 OPACFRBRizeEditions => C4::Context->preference("OPACFRBRizeEditions"),
401 OpacHighlightedWords => C4::Context->preference("OpacHighlightedWords"),
402 OPACItemHolds => C4::Context->preference("OPACItemHolds"),
403 OPACShelfBrowser => "". C4::Context->preference("OPACShelfBrowser"),
404 OPACURLOpenInNewWindow => "" . C4::Context->preference("OPACURLOpenInNewWindow"),
405 OPACUserCSS => "". C4::Context->preference("OPACUserCSS"),
406 OPACViewOthersSuggestions => "" . C4::Context->preference("OPACViewOthersSuggestions"),
407 OpacAuthorities => C4::Context->preference("OpacAuthorities"),
408 OPACBaseURL => ($in->{'query'}->https() ? "https://" : "http://") . $ENV{'SERVER_NAME'} .
409 ($ENV{'SERVER_PORT'} eq ($in->{'query'}->https() ? "443" : "80") ? '' : ":$ENV{'SERVER_PORT'}"),
410 opac_css_override => $ENV{'OPAC_CSS_OVERRIDE'},
411 opac_search_limit => $opac_search_limit,
412 opac_limit_override => $opac_limit_override,
413 OpacBrowser => C4::Context->preference("OpacBrowser"),
414 OpacCloud => C4::Context->preference("OpacCloud"),
415 OpacMainUserBlock => "" . C4::Context->preference("OpacMainUserBlock"),
416 OpacNav => "" . C4::Context->preference("OpacNav"),
417 OpacPasswordChange => C4::Context->preference("OpacPasswordChange"),
418 OPACPatronDetails => C4::Context->preference("OPACPatronDetails"),
419 OPACFinesTab => C4::Context->preference("OPACFinesTab"),
420 OpacTopissue => C4::Context->preference("OpacTopissue"),
421 RequestOnOpac => C4::Context->preference("RequestOnOpac"),
422 'Version' => C4::Context->preference('Version'),
423 hidelostitems => C4::Context->preference("hidelostitems"),
424 mylibraryfirst => (C4::Context->preference("SearchMyLibraryFirst") && C4::Context->userenv) ? C4::Context->userenv->{'branch'} : '',
425 opaclayoutstylesheet => "" . C4::Context->preference("opaclayoutstylesheet"),
426 opaccolorstylesheet => "" . C4::Context->preference("opaccolorstylesheet"),
427 opacstylesheet => "" . C4::Context->preference("opacstylesheet"),
428 opacbookbag => "" . C4::Context->preference("opacbookbag"),
429 opaccredits => "" . C4::Context->preference("opaccredits"),
430 opacheader => "" . C4::Context->preference("opacheader"),
431 opaclanguagesdisplay => "" . C4::Context->preference("opaclanguagesdisplay"),
432 opacreadinghistory => C4::Context->preference("opacreadinghistory"),
433 opacsmallimage => "" . C4::Context->preference("opacsmallimage"),
434 opacuserjs => C4::Context->preference("opacuserjs"),
435 opacuserlogin => "" . C4::Context->preference("opacuserlogin"),
436 reviewson => C4::Context->preference("reviewson"),
437 suggestion => "" . C4::Context->preference("suggestion"),
438 virtualshelves => "" . C4::Context->preference("virtualshelves"),
439 OPACSerialIssueDisplayCount => C4::Context->preference("OPACSerialIssueDisplayCount"),
440 OpacAddMastheadLibraryPulldown => C4::Context->preference("OpacAddMastheadLibraryPulldown"),
441 OPACXSLTDetailsDisplay => C4::Context->preference("OPACXSLTDetailsDisplay"),
442 OPACXSLTResultsDisplay => C4::Context->preference("OPACXSLTResultsDisplay"),
443 SyndeticsClientCode => C4::Context->preference("SyndeticsClientCode"),
444 SyndeticsEnabled => C4::Context->preference("SyndeticsEnabled"),
445 SyndeticsCoverImages => C4::Context->preference("SyndeticsCoverImages"),
446 SyndeticsTOC => C4::Context->preference("SyndeticsTOC"),
447 SyndeticsSummary => C4::Context->preference("SyndeticsSummary"),
448 SyndeticsEditions => C4::Context->preference("SyndeticsEditions"),
449 SyndeticsExcerpt => C4::Context->preference("SyndeticsExcerpt"),
450 SyndeticsReviews => C4::Context->preference("SyndeticsReviews"),
451 SyndeticsAuthorNotes => C4::Context->preference("SyndeticsAuthorNotes"),
452 SyndeticsAwards => C4::Context->preference("SyndeticsAwards"),
453 SyndeticsSeries => C4::Context->preference("SyndeticsSeries"),
454 SyndeticsCoverImageSize => C4::Context->preference("SyndeticsCoverImageSize"),
457 $template->param(listloop=>[{shelfname=>"Freelist", shelfnumber=>110}]);
458 return ( $template, $borrowernumber, $cookie, $flags);
463 ($userid, $cookie, $sessionID) = &checkauth($query, $noauth, $flagsrequired, $type);
465 Verifies that the user is authorized to run this script. If
466 the user is authorized, a (userid, cookie, session-id, flags)
467 quadruple is returned. If the user is not authorized but does
468 not have the required privilege (see $flagsrequired below), it
469 displays an error page and exits. Otherwise, it displays the
470 login page and exits.
472 Note that C<&checkauth> will return if and only if the user
473 is authorized, so it should be called early on, before any
474 unfinished operations (e.g., if you've opened a file, then
475 C<&checkauth> won't close it for you).
477 C<$query> is the CGI object for the script calling C<&checkauth>.
479 The C<$noauth> argument is optional. If it is set, then no
480 authorization is required for the script.
482 C<&checkauth> fetches user and session information from C<$query> and
483 ensures that the user is authorized to run scripts that require
486 The C<$flagsrequired> argument specifies the required privileges
487 the user must have if the username and password are correct.
488 It should be specified as a reference-to-hash; keys in the hash
489 should be the "flags" for the user, as specified in the Members
490 intranet module. Any key specified must correspond to a "flag"
491 in the userflags table. E.g., { circulate => 1 } would specify
492 that the user must have the "circulate" privilege in order to
493 proceed. To make sure that access control is correct, the
494 C<$flagsrequired> parameter must be specified correctly.
496 Koha also has a concept of sub-permissions, also known as
497 granular permissions. This makes the value of each key
498 in the C<flagsrequired> hash take 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 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'},(strftime '%c', 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);
840 $session->param('pubshelves', $pubshelves);
841 $session->param('totshelves', $total);
843 C4::Context::set_shelves_userenv('bar',$barshelves);
844 C4::Context::set_shelves_userenv('pub',$pubshelves);
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);
865 $session->param('totshelves', $total);
866 C4::Context::set_shelves_userenv('pub',$pubshelves);
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 opacstylesheet => C4::Context->preference("opacstylesheet"),
935 intranetcolorstylesheet =>
936 C4::Context->preference("intranetcolorstylesheet"),
937 intranetstylesheet => C4::Context->preference("intranetstylesheet"),
938 intranetbookbag => C4::Context->preference("intranetbookbag"),
939 IntranetNav => C4::Context->preference("IntranetNav"),
940 intranetuserjs => C4::Context->preference("intranetuserjs"),
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',
971 =head2 check_api_auth
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 =head2 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 =head2 get_user_subpermissions
1460 $user_perm_hashref = get_user_subpermissions($userid);
1462 Given the userid (note, not the borrowernumber) of a staff user,
1463 return a hashref of hashrefs of the specific subpermissions
1464 accorded to the user. An example return is
1468 export_catalog => 1,
1469 import_patrons => 1,
1473 The top-level hash-key is a module or function code from
1474 userflags.flag, while the second-level key is a code
1477 The results of this function do not give a complete picture
1478 of the functions that a staff user can access; it is also
1479 necessary to check borrowers.flags.
1483 sub get_user_subpermissions {
1486 my $dbh = C4::Context->dbh;
1487 my $sth = $dbh->prepare("SELECT flag, user_permissions.code
1488 FROM user_permissions
1489 JOIN permissions USING (module_bit, code)
1490 JOIN userflags ON (module_bit = bit)
1491 JOIN borrowers USING (borrowernumber)
1493 $sth->execute($userid);
1495 my $user_perms = {};
1496 while (my $perm = $sth->fetchrow_hashref) {
1497 $user_perms->{$perm->{'flag'}}->{$perm->{'code'}} = 1;
1502 =head2 get_all_subpermissions
1504 my $perm_hashref = get_all_subpermissions();
1506 Returns a hashref of hashrefs defining all specific
1507 permissions currently defined. The return value
1508 has the same structure as that of C<get_user_subpermissions>,
1509 except that the innermost hash value is the description
1510 of the subpermission.
1514 sub get_all_subpermissions {
1515 my $dbh = C4::Context->dbh;
1516 my $sth = $dbh->prepare("SELECT flag, code, description
1518 JOIN userflags ON (module_bit = bit)");
1522 while (my $perm = $sth->fetchrow_hashref) {
1523 $all_perms->{$perm->{'flag'}}->{$perm->{'code'}} = $perm->{'description'};
1528 =head2 haspermission
1530 $flags = ($userid, $flagsrequired);
1532 C<$userid> the userid of the member
1533 C<$flags> is a hashref of required flags like C<$borrower-<{authflags}>
1535 Returns member's flags or 0 if a permission is not met.
1540 my ($userid, $flagsrequired) = @_;
1541 my $sth = C4::Context->dbh->prepare("SELECT flags FROM borrowers WHERE userid=?");
1542 $sth->execute($userid);
1543 my $flags = getuserflags( $sth->fetchrow(), $userid );
1544 if ( $userid eq C4::Context->config('user') ) {
1545 # Super User Account from /etc/koha.conf
1546 $flags->{'superlibrarian'} = 1;
1548 elsif ( $userid eq 'demo' && C4::Context->config('demo') ) {
1549 # Demo user that can do "anything" (demo=1 in /etc/koha.conf)
1550 $flags->{'superlibrarian'} = 1;
1552 return $flags if $flags->{superlibrarian};
1553 foreach my $module ( keys %$flagsrequired ) {
1554 my $subperm = $flagsrequired->{$module};
1555 if ($subperm eq '*') {
1556 return 0 unless ( $flags->{$module} == 1 or ref($flags->{$module}) );
1558 return 0 unless ( $flags->{$module} == 1 or
1559 ( ref($flags->{$module}) and
1560 exists $flags->{$module}->{$subperm} and
1561 $flags->{$module}->{$subperm} == 1
1567 #FIXME - This fcn should return the failed permission so a suitable error msg can be delivered.
1571 sub getborrowernumber {
1573 my $userenv = C4::Context->userenv;
1574 if ( defined( $userenv ) && ref( $userenv ) eq 'HASH' && $userenv->{number} ) {
1575 return $userenv->{number};
1577 my $dbh = C4::Context->dbh;
1578 for my $field ( 'userid', 'cardnumber' ) {
1580 $dbh->prepare("select borrowernumber from borrowers where $field=?");
1581 $sth->execute($userid);
1583 my ($bnumber) = $sth->fetchrow;
1590 END { } # module clean-up code here (global destructor)