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 OPACPrivacy => C4::Context->preference("OPACPrivacy"),
420 OPACFinesTab => C4::Context->preference("OPACFinesTab"),
421 OpacTopissue => C4::Context->preference("OpacTopissue"),
422 RequestOnOpac => C4::Context->preference("RequestOnOpac"),
423 'Version' => C4::Context->preference('Version'),
424 hidelostitems => C4::Context->preference("hidelostitems"),
425 mylibraryfirst => (C4::Context->preference("SearchMyLibraryFirst") && C4::Context->userenv) ? C4::Context->userenv->{'branch'} : '',
426 opaclayoutstylesheet => "" . C4::Context->preference("opaclayoutstylesheet"),
427 opaccolorstylesheet => "" . C4::Context->preference("opaccolorstylesheet"),
428 opacstylesheet => "" . C4::Context->preference("opacstylesheet"),
429 opacbookbag => "" . C4::Context->preference("opacbookbag"),
430 opaccredits => "" . C4::Context->preference("opaccredits"),
431 opacheader => "" . C4::Context->preference("opacheader"),
432 opaclanguagesdisplay => "" . C4::Context->preference("opaclanguagesdisplay"),
433 opacreadinghistory => C4::Context->preference("opacreadinghistory"),
434 opacsmallimage => "" . C4::Context->preference("opacsmallimage"),
435 opacuserjs => C4::Context->preference("opacuserjs"),
436 opacuserlogin => "" . C4::Context->preference("opacuserlogin"),
437 reviewson => C4::Context->preference("reviewson"),
438 suggestion => "" . C4::Context->preference("suggestion"),
439 virtualshelves => "" . C4::Context->preference("virtualshelves"),
440 OPACSerialIssueDisplayCount => C4::Context->preference("OPACSerialIssueDisplayCount"),
441 OpacAddMastheadLibraryPulldown => C4::Context->preference("OpacAddMastheadLibraryPulldown"),
442 OPACXSLTDetailsDisplay => C4::Context->preference("OPACXSLTDetailsDisplay"),
443 OPACXSLTResultsDisplay => C4::Context->preference("OPACXSLTResultsDisplay"),
444 SyndeticsClientCode => C4::Context->preference("SyndeticsClientCode"),
445 SyndeticsEnabled => C4::Context->preference("SyndeticsEnabled"),
446 SyndeticsCoverImages => C4::Context->preference("SyndeticsCoverImages"),
447 SyndeticsTOC => C4::Context->preference("SyndeticsTOC"),
448 SyndeticsSummary => C4::Context->preference("SyndeticsSummary"),
449 SyndeticsEditions => C4::Context->preference("SyndeticsEditions"),
450 SyndeticsExcerpt => C4::Context->preference("SyndeticsExcerpt"),
451 SyndeticsReviews => C4::Context->preference("SyndeticsReviews"),
452 SyndeticsAuthorNotes => C4::Context->preference("SyndeticsAuthorNotes"),
453 SyndeticsAwards => C4::Context->preference("SyndeticsAwards"),
454 SyndeticsSeries => C4::Context->preference("SyndeticsSeries"),
455 SyndeticsCoverImageSize => C4::Context->preference("SyndeticsCoverImageSize"),
458 $template->param(OpacPublic => '1') if ($template->param( 'loggedinusername') || C4::Context->preference("OpacPublic"));
460 $template->param(listloop=>[{shelfname=>"Freelist", shelfnumber=>110}]);
461 return ( $template, $borrowernumber, $cookie, $flags);
466 ($userid, $cookie, $sessionID) = &checkauth($query, $noauth, $flagsrequired, $type);
468 Verifies that the user is authorized to run this script. If
469 the user is authorized, a (userid, cookie, session-id, flags)
470 quadruple is returned. If the user is not authorized but does
471 not have the required privilege (see $flagsrequired below), it
472 displays an error page and exits. Otherwise, it displays the
473 login page and exits.
475 Note that C<&checkauth> will return if and only if the user
476 is authorized, so it should be called early on, before any
477 unfinished operations (e.g., if you've opened a file, then
478 C<&checkauth> won't close it for you).
480 C<$query> is the CGI object for the script calling C<&checkauth>.
482 The C<$noauth> argument is optional. If it is set, then no
483 authorization is required for the script.
485 C<&checkauth> fetches user and session information from C<$query> and
486 ensures that the user is authorized to run scripts that require
489 The C<$flagsrequired> argument specifies the required privileges
490 the user must have if the username and password are correct.
491 It should be specified as a reference-to-hash; keys in the hash
492 should be the "flags" for the user, as specified in the Members
493 intranet module. Any key specified must correspond to a "flag"
494 in the userflags table. E.g., { circulate => 1 } would specify
495 that the user must have the "circulate" privilege in order to
496 proceed. To make sure that access control is correct, the
497 C<$flagsrequired> parameter must be specified correctly.
499 Koha also has a concept of sub-permissions, also known as
500 granular permissions. This makes the value of each key
501 in the C<flagsrequired> hash take on an additional
506 The user must have access to all subfunctions of the module
507 specified by the hash key.
511 The user must have access to at least one subfunction of the module
512 specified by the hash key.
514 specific permission, e.g., 'export_catalog'
516 The user must have access to the specific subfunction list, which
517 must correspond to a row in the permissions table.
519 The C<$type> argument specifies whether the template should be
520 retrieved from the opac or intranet directory tree. "opac" is
521 assumed if it is not specified; however, if C<$type> is specified,
522 "intranet" is assumed if it is not "opac".
524 If C<$query> does not have a valid session ID associated with it
525 (i.e., the user has not logged in) or if the session has expired,
526 C<&checkauth> presents the user with a login page (from the point of
527 view of the original script, C<&checkauth> does not return). Once the
528 user has authenticated, C<&checkauth> restarts the original script
529 (this time, C<&checkauth> returns).
531 The login page is provided using a HTML::Template, which is set in the
532 systempreferences table or at the top of this file. The variable C<$type>
533 selects which template to use, either the opac or the intranet
534 authentification template.
536 C<&checkauth> returns a user ID, a cookie, and a session ID. The
537 cookie should be sent back to the browser; it verifies that the user
542 sub _version_check ($$) {
546 # If Version syspref is unavailable, it means Koha is beeing installed,
547 # and so we must redirect to OPAC maintenance page or to the WebInstaller
548 # also, if OpacMaintenance is ON, OPAC should redirect to maintenance
549 if (C4::Context->preference('OpacMaintenance') && $type eq 'opac') {
550 warn "OPAC Install required, redirecting to maintenance";
551 print $query->redirect("/cgi-bin/koha/maintenance.pl");
553 unless ($version = C4::Context->preference('Version')) { # assignment, not comparison
554 if ($type ne 'opac') {
555 warn "Install required, redirecting to Installer";
556 print $query->redirect("/cgi-bin/koha/installer/install.pl");
559 warn "OPAC Install required, redirecting to maintenance";
560 print $query->redirect("/cgi-bin/koha/maintenance.pl");
565 # check that database and koha version are the same
566 # there is no DB version, it's a fresh install,
567 # go to web installer
568 # there is a DB version, compare it to the code version
569 my $kohaversion=C4::Context::KOHAVERSION;
570 # remove the 3 last . to have a Perl number
571 $kohaversion =~ s/(.*\..*)\.(.*)\.(.*)/$1$2$3/;
572 $debug and print STDERR "kohaversion : $kohaversion\n";
573 if ($version < $kohaversion){
574 my $warning = "Database update needed, redirecting to %s. Database is $version and Koha is $kohaversion";
575 if ($type ne 'opac'){
576 warn sprintf($warning, 'Installer');
577 print $query->redirect("/cgi-bin/koha/installer/install.pl?step=3");
579 warn sprintf("OPAC: " . $warning, 'maintenance');
580 print $query->redirect("/cgi-bin/koha/maintenance.pl");
588 open L, ">>/tmp/sessionlog" or warn "ERROR: Cannot append to /tmp/sessionlog";
589 printf L join("\n",@_);
595 $debug and warn "Checking Auth";
596 # $authnotrequired will be set for scripts which will run without authentication
597 my $authnotrequired = shift;
598 my $flagsrequired = shift;
600 $type = 'opac' unless $type;
602 my $dbh = C4::Context->dbh;
603 my $timeout = C4::Context->preference('timeout');
605 if ($timeout =~ /(\d+)[dD]/) {
606 $timeout = $1 * 86400;
608 $timeout = 600 unless $timeout;
610 _version_check($type,$query);
614 my ( $userid, $cookie, $sessionID, $flags, $barshelves, $pubshelves );
615 my $logout = $query->param('logout.x');
617 if ( $userid = $ENV{'REMOTE_USER'} ) {
618 # Using Basic Authentication, no cookies required
619 $cookie = $query->cookie(
620 -name => 'CGISESSID',
626 elsif ( $sessionID = $query->cookie("CGISESSID")) { # assignment, not comparison
627 my $session = get_session($sessionID);
628 C4::Context->_new_userenv($sessionID);
629 my ($ip, $lasttime, $sessiontype);
631 C4::Context::set_userenv(
632 $session->param('number'), $session->param('id'),
633 $session->param('cardnumber'), $session->param('firstname'),
634 $session->param('surname'), $session->param('branch'),
635 $session->param('branchname'), $session->param('flags'),
636 $session->param('emailaddress'), $session->param('branchprinter')
638 C4::Context::set_shelves_userenv('bar',$session->param('barshelves'));
639 C4::Context::set_shelves_userenv('pub',$session->param('pubshelves'));
640 C4::Context::set_shelves_userenv('tot',$session->param('totshelves'));
641 $debug and printf STDERR "AUTH_SESSION: (%s)\t%s %s - %s\n", map {$session->param($_)} qw(cardnumber firstname surname branch) ;
642 $ip = $session->param('ip');
643 $lasttime = $session->param('lasttime');
644 $userid = $session->param('id');
645 $sessiontype = $session->param('sessiontype');
647 if ( ($query->param('koha_login_context')) && ($query->param('userid') ne $session->param('id')) ) {
648 #if a user enters an id ne to the id in the current session, we need to log them in...
649 #first we need to clear the anonymous session...
650 $debug and warn "query id = " . $query->param('userid') . " but session id = " . $session->param('id');
653 C4::Context->_unset_userenv($sessionID);
658 # voluntary logout the user
661 C4::Context->_unset_userenv($sessionID);
662 _session_log(sprintf "%20s from %16s logged out at %30s (manually).\n", $userid,$ip,(strftime "%c",localtime));
666 if ($cas and $caslogout) {
670 elsif ( $lasttime < time() - $timeout ) {
672 $info{'timed_out'} = 1;
674 C4::Context->_unset_userenv($sessionID);
675 _session_log(sprintf "%20s from %16s logged out at %30s (inactivity).\n", $userid,$ip,(strftime "%c",localtime));
679 elsif ( $ip ne $ENV{'REMOTE_ADDR'} ) {
680 # Different ip than originally logged in from
681 $info{'oldip'} = $ip;
682 $info{'newip'} = $ENV{'REMOTE_ADDR'};
683 $info{'different_ip'} = 1;
685 C4::Context->_unset_userenv($sessionID);
686 _session_log(sprintf "%20s from %16s logged out at %30s (ip changed to %16s).\n", $userid,$ip,(strftime "%c",localtime), $info{'newip'});
691 $cookie = $query->cookie( CGISESSID => $session->id );
692 $session->param('lasttime',time());
693 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...
694 $flags = haspermission($userid, $flagsrequired);
698 $info{'nopermission'} = 1;
703 unless ($userid || $sessionID) {
704 #we initiate a session prior to checking for a username to allow for anonymous sessions...
705 my $session = get_session("") or die "Auth ERROR: Cannot get_session()";
706 my $sessionID = $session->id;
707 C4::Context->_new_userenv($sessionID);
708 $cookie = $query->cookie(CGISESSID => $sessionID);
709 $userid = $query->param('userid');
710 if ($cas || $userid) {
711 my $password = $query->param('password');
712 my ($return, $cardnumber);
713 if ($cas && $query->param('ticket')) {
715 ( $return, $cardnumber, $retuserid ) = checkpw( $dbh, $userid, $password, $query );
716 $userid = $retuserid;
717 $info{'invalidCasLogin'} = 1 unless ($return);
719 ( $return, $cardnumber ) = checkpw( $dbh, $userid, $password, $query );
722 _session_log(sprintf "%20s from %16s logged in at %30s.\n", $userid,$ENV{'REMOTE_ADDR'},(strftime '%c', localtime));
723 if ( $flags = haspermission( $userid, $flagsrequired ) ) {
727 $info{'nopermission'} = 1;
728 C4::Context->_unset_userenv($sessionID);
731 my ($borrowernumber, $firstname, $surname, $userflags,
732 $branchcode, $branchname, $branchprinter, $emailaddress);
734 if ( $return == 1 ) {
736 SELECT borrowernumber, firstname, surname, flags, borrowers.branchcode,
737 branches.branchname as branchname,
738 branches.branchprinter as branchprinter,
741 LEFT JOIN branches on borrowers.branchcode=branches.branchcode
743 my $sth = $dbh->prepare("$select where userid=?");
744 $sth->execute($userid);
745 unless ($sth->rows) {
746 $debug and print STDERR "AUTH_1: no rows for userid='$userid'\n";
747 $sth = $dbh->prepare("$select where cardnumber=?");
748 $sth->execute($cardnumber);
749 unless ($sth->rows) {
750 $debug and print STDERR "AUTH_2a: no rows for cardnumber='$cardnumber'\n";
751 $sth->execute($userid);
752 unless ($sth->rows) {
753 $debug and print STDERR "AUTH_2b: no rows for userid='$userid' AS cardnumber\n";
758 ($borrowernumber, $firstname, $surname, $userflags,
759 $branchcode, $branchname, $branchprinter, $emailaddress) = $sth->fetchrow;
760 $debug and print STDERR "AUTH_3 results: " .
761 "$cardnumber,$borrowernumber,$userid,$firstname,$surname,$userflags,$branchcode,$emailaddress\n";
763 print STDERR "AUTH_3: no results for userid='$userid', cardnumber='$cardnumber'.\n";
766 # launch a sequence to check if we have a ip for the branch, i
767 # if we have one we replace the branchcode of the userenv by the branch bound in the ip.
769 my $ip = $ENV{'REMOTE_ADDR'};
770 # if they specify at login, use that
771 if ($query->param('branch')) {
772 $branchcode = $query->param('branch');
773 $branchname = GetBranchName($branchcode);
775 my $branches = GetBranches();
776 if (C4::Context->boolean_preference('IndependantBranches') && C4::Context->boolean_preference('Autolocation')){
777 # we have to check they are coming from the right ip range
778 my $domain = $branches->{$branchcode}->{'branchip'};
779 if ($ip !~ /^$domain/){
781 $info{'wrongip'} = 1;
786 foreach my $br ( keys %$branches ) {
787 # now we work with the treatment of ip
788 my $domain = $branches->{$br}->{'branchip'};
789 if ( $domain && $ip =~ /^$domain/ ) {
790 $branchcode = $branches->{$br}->{'branchcode'};
792 # new op dev : add the branchprinter and branchname in the cookie
793 $branchprinter = $branches->{$br}->{'branchprinter'};
794 $branchname = $branches->{$br}->{'branchname'};
797 $session->param('number',$borrowernumber);
798 $session->param('id',$userid);
799 $session->param('cardnumber',$cardnumber);
800 $session->param('firstname',$firstname);
801 $session->param('surname',$surname);
802 $session->param('branch',$branchcode);
803 $session->param('branchname',$branchname);
804 $session->param('flags',$userflags);
805 $session->param('emailaddress',$emailaddress);
806 $session->param('ip',$session->remote_addr());
807 $session->param('lasttime',time());
808 $debug and printf STDERR "AUTH_4: (%s)\t%s %s - %s\n", map {$session->param($_)} qw(cardnumber firstname surname branch) ;
810 elsif ( $return == 2 ) {
811 #We suppose the user is the superlibrarian
813 $session->param('number',0);
814 $session->param('id',C4::Context->config('user'));
815 $session->param('cardnumber',C4::Context->config('user'));
816 $session->param('firstname',C4::Context->config('user'));
817 $session->param('surname',C4::Context->config('user'));
818 $session->param('branch','NO_LIBRARY_SET');
819 $session->param('branchname','NO_LIBRARY_SET');
820 $session->param('flags',1);
821 $session->param('emailaddress', C4::Context->preference('KohaAdminEmailAddress'));
822 $session->param('ip',$session->remote_addr());
823 $session->param('lasttime',time());
825 C4::Context::set_userenv(
826 $session->param('number'), $session->param('id'),
827 $session->param('cardnumber'), $session->param('firstname'),
828 $session->param('surname'), $session->param('branch'),
829 $session->param('branchname'), $session->param('flags'),
830 $session->param('emailaddress'), $session->param('branchprinter')
833 # Grab borrower's shelves and public shelves and add them to the session
834 # $row_count determines how many records are returned from the db query
835 # and the number of lists to be displayed of each type in the 'Lists' button drop down
836 my $row_count = 10; # FIXME:This probably should be a syspref
837 my ($total, $totshelves, $barshelves, $pubshelves);
838 ($barshelves, $totshelves) = C4::VirtualShelves::GetRecentShelves(1, $row_count, $borrowernumber);
839 $total->{'bartotal'} = $totshelves;
840 ($pubshelves, $totshelves) = C4::VirtualShelves::GetRecentShelves(2, $row_count, undef);
841 $total->{'pubtotal'} = $totshelves;
842 $session->param('barshelves', $barshelves->[0]);
843 $session->param('pubshelves', $pubshelves->[0]);
844 $session->param('totshelves', $total);
846 C4::Context::set_shelves_userenv('bar',$barshelves->[0]);
847 C4::Context::set_shelves_userenv('pub',$pubshelves->[0]);
848 C4::Context::set_shelves_userenv('tot',$total);
852 $info{'invalid_username_or_password'} = 1;
853 C4::Context->_unset_userenv($sessionID);
856 } # END if ( $userid = $query->param('userid') )
857 elsif ($type eq "opac") {
858 # if we are here this is an anonymous session; add public lists to it and a few other items...
859 # anonymous sessions are created only for the OPAC
860 $debug and warn "Initiating an anonymous session...";
862 # Grab the public shelves and add to the session...
863 my $row_count = 20; # FIXME:This probably should be a syspref
864 my ($total, $totshelves, $pubshelves);
865 ($pubshelves, $totshelves) = C4::VirtualShelves::GetRecentShelves(2, $row_count, undef);
866 $total->{'pubtotal'} = $totshelves;
867 $session->param('pubshelves', $pubshelves->[0]);
868 $session->param('totshelves', $total);
869 C4::Context::set_shelves_userenv('pub',$pubshelves->[0]);
870 C4::Context::set_shelves_userenv('tot',$total);
872 # setting a couple of other session vars...
873 $session->param('ip',$session->remote_addr());
874 $session->param('lasttime',time());
875 $session->param('sessiontype','anon');
877 } # END unless ($userid)
878 my $insecure = C4::Context->boolean_preference('insecure');
880 # finished authentification, now respond
881 if ( $loggedin || $authnotrequired || ( defined($insecure) && $insecure ) )
885 $cookie = $query->cookie( CGISESSID => '' );
887 return ( $userid, $cookie, $sessionID, $flags );
892 # AUTH rejected, show the login/password template, after checking the DB.
896 # get the inputs from the incoming query
898 foreach my $name ( param $query) {
899 (next) if ( $name eq 'userid' || $name eq 'password' || $name eq 'ticket' );
900 my $value = $query->param($name);
901 push @inputs, { name => $name, value => $value };
903 # get the branchloop, which we need for authentication
904 my $branches = GetBranches();
906 for my $branch_hash (sort keys %$branches) {
907 push @branch_loop, {branchcode => "$branch_hash", branchname => $branches->{$branch_hash}->{'branchname'}, };
910 my $template_name = ( $type eq 'opac' ) ? 'opac-auth.tmpl' : 'auth.tmpl';
911 my $template = gettemplate( $template_name, $type, $query );
912 $template->param(branchloop => \@branch_loop,);
916 casAuthentication => C4::Context->preference("casAuthentication"),
917 suggestion => C4::Context->preference("suggestion"),
918 virtualshelves => C4::Context->preference("virtualshelves"),
919 LibraryName => C4::Context->preference("LibraryName"),
920 opacuserlogin => C4::Context->preference("opacuserlogin"),
921 OpacNav => C4::Context->preference("OpacNav"),
922 opaccredits => C4::Context->preference("opaccredits"),
923 opacreadinghistory => C4::Context->preference("opacreadinghistory"),
924 opacsmallimage => C4::Context->preference("opacsmallimage"),
925 opaclayoutstylesheet => C4::Context->preference("opaclayoutstylesheet"),
926 opaccolorstylesheet => C4::Context->preference("opaccolorstylesheet"),
927 opaclanguagesdisplay => C4::Context->preference("opaclanguagesdisplay"),
928 opacuserjs => C4::Context->preference("opacuserjs"),
929 opacbookbag => "" . C4::Context->preference("opacbookbag"),
930 OpacCloud => C4::Context->preference("OpacCloud"),
931 OpacTopissue => C4::Context->preference("OpacTopissue"),
932 OpacAuthorities => C4::Context->preference("OpacAuthorities"),
933 OpacBrowser => C4::Context->preference("OpacBrowser"),
934 opacheader => C4::Context->preference("opacheader"),
935 TagsEnabled => C4::Context->preference("TagsEnabled"),
936 OPACUserCSS => C4::Context->preference("OPACUserCSS"),
937 intranetcolorstylesheet =>
938 C4::Context->preference("intranetcolorstylesheet"),
939 intranetstylesheet => C4::Context->preference("intranetstylesheet"),
940 intranetbookbag => C4::Context->preference("intranetbookbag"),
941 IntranetNav => C4::Context->preference("IntranetNav"),
942 intranetuserjs => C4::Context->preference("intranetuserjs"),
943 IndependantBranches=> C4::Context->preference("IndependantBranches"),
944 AutoLocation => C4::Context->preference("AutoLocation"),
945 wrongip => $info{'wrongip'},
948 $template->param( OpacPublic => C4::Context->preference("OpacPublic"));
949 $template->param( loginprompt => 1 ) unless $info{'nopermission'};
953 casServerUrl => login_cas_url(),
954 invalidCasLogin => $info{'invalidCasLogin'}
958 my $self_url = $query->url( -absolute => 1 );
961 LibraryName => C4::Context->preference("LibraryName"),
963 $template->param( \%info );
964 # $cookie = $query->cookie(CGISESSID => $session->id
966 print $query->header(
967 -type => 'text/html',
975 =head2 check_api_auth
977 ($status, $cookie, $sessionId) = check_api_auth($query, $userflags);
979 Given a CGI query containing the parameters 'userid' and 'password' and/or a session
980 cookie, determine if the user has the privileges specified by C<$userflags>.
982 C<check_api_auth> is is meant for authenticating users of web services, and
983 consequently will always return and will not attempt to redirect the user
986 If a valid session cookie is already present, check_api_auth will return a status
987 of "ok", the cookie, and the Koha session ID.
989 If no session cookie is present, check_api_auth will check the 'userid' and 'password
990 parameters and create a session cookie and Koha session if the supplied credentials
993 Possible return values in C<$status> are:
997 =item "ok" -- user authenticated; C<$cookie> and C<$sessionid> have valid values.
999 =item "failed" -- credentials are not correct; C<$cookie> and C<$sessionid> are undef
1001 =item "maintenance" -- DB is in maintenance mode; no login possible at the moment
1003 =item "expired -- session cookie has expired; API user should resubmit userid and password
1009 sub check_api_auth {
1011 my $flagsrequired = shift;
1013 my $dbh = C4::Context->dbh;
1014 my $timeout = C4::Context->preference('timeout');
1015 $timeout = 600 unless $timeout;
1017 unless (C4::Context->preference('Version')) {
1018 # database has not been installed yet
1019 return ("maintenance", undef, undef);
1021 my $kohaversion=C4::Context::KOHAVERSION;
1022 $kohaversion =~ s/(.*\..*)\.(.*)\.(.*)/$1$2$3/;
1023 if (C4::Context->preference('Version') < $kohaversion) {
1024 # database in need of version update; assume that
1025 # no API should be called while databsae is in
1027 return ("maintenance", undef, undef);
1030 # FIXME -- most of what follows is a copy-and-paste
1031 # of code from checkauth. There is an obvious need
1032 # for refactoring to separate the various parts of
1033 # the authentication code, but as of 2007-11-19 this
1034 # is deferred so as to not introduce bugs into the
1035 # regular authentication code for Koha 3.0.
1037 # see if we have a valid session cookie already
1038 # however, if a userid parameter is present (i.e., from
1039 # a form submission, assume that any current cookie
1041 my $sessionID = undef;
1042 unless ($query->param('userid')) {
1043 $sessionID = $query->cookie("CGISESSID");
1046 my $session = get_session($sessionID);
1047 C4::Context->_new_userenv($sessionID);
1049 C4::Context::set_userenv(
1050 $session->param('number'), $session->param('id'),
1051 $session->param('cardnumber'), $session->param('firstname'),
1052 $session->param('surname'), $session->param('branch'),
1053 $session->param('branchname'), $session->param('flags'),
1054 $session->param('emailaddress'), $session->param('branchprinter')
1057 my $ip = $session->param('ip');
1058 my $lasttime = $session->param('lasttime');
1059 my $userid = $session->param('id');
1060 if ( $lasttime < time() - $timeout ) {
1063 C4::Context->_unset_userenv($sessionID);
1066 return ("expired", undef, undef);
1067 } elsif ( $ip ne $ENV{'REMOTE_ADDR'} ) {
1068 # IP address changed
1070 C4::Context->_unset_userenv($sessionID);
1073 return ("expired", undef, undef);
1075 my $cookie = $query->cookie( CGISESSID => $session->id );
1076 $session->param('lasttime',time());
1077 my $flags = haspermission($userid, $flagsrequired);
1079 return ("ok", $cookie, $sessionID);
1082 C4::Context->_unset_userenv($sessionID);
1085 return ("failed", undef, undef);
1089 return ("expired", undef, undef);
1093 my $userid = $query->param('userid');
1094 my $password = $query->param('password');
1095 unless ($userid and $password) {
1096 # caller did something wrong, fail the authenticateion
1097 return ("failed", undef, undef);
1099 my ($return, $cardnumber);
1100 if ($cas && $query->param('ticket')) {
1102 ( $return, $cardnumber, $retuserid ) = checkpw( $dbh, $userid, $password, $query );
1103 $userid = $retuserid;
1105 ( $return, $cardnumber ) = checkpw( $dbh, $userid, $password, $query );
1107 if ($return and haspermission( $userid, $flagsrequired)) {
1108 my $session = get_session("");
1109 return ("failed", undef, undef) unless $session;
1111 my $sessionID = $session->id;
1112 C4::Context->_new_userenv($sessionID);
1113 my $cookie = $query->cookie(CGISESSID => $sessionID);
1114 if ( $return == 1 ) {
1116 $borrowernumber, $firstname, $surname,
1117 $userflags, $branchcode, $branchname,
1118 $branchprinter, $emailaddress
1122 "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=?"
1124 $sth->execute($userid);
1126 $borrowernumber, $firstname, $surname,
1127 $userflags, $branchcode, $branchname,
1128 $branchprinter, $emailaddress
1129 ) = $sth->fetchrow if ( $sth->rows );
1131 unless ($sth->rows ) {
1132 my $sth = $dbh->prepare(
1133 "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=?"
1135 $sth->execute($cardnumber);
1137 $borrowernumber, $firstname, $surname,
1138 $userflags, $branchcode, $branchname,
1139 $branchprinter, $emailaddress
1140 ) = $sth->fetchrow if ( $sth->rows );
1142 unless ( $sth->rows ) {
1143 $sth->execute($userid);
1145 $borrowernumber, $firstname, $surname, $userflags,
1146 $branchcode, $branchname, $branchprinter, $emailaddress
1147 ) = $sth->fetchrow if ( $sth->rows );
1151 my $ip = $ENV{'REMOTE_ADDR'};
1152 # if they specify at login, use that
1153 if ($query->param('branch')) {
1154 $branchcode = $query->param('branch');
1155 $branchname = GetBranchName($branchcode);
1157 my $branches = GetBranches();
1159 foreach my $br ( keys %$branches ) {
1160 # now we work with the treatment of ip
1161 my $domain = $branches->{$br}->{'branchip'};
1162 if ( $domain && $ip =~ /^$domain/ ) {
1163 $branchcode = $branches->{$br}->{'branchcode'};
1165 # new op dev : add the branchprinter and branchname in the cookie
1166 $branchprinter = $branches->{$br}->{'branchprinter'};
1167 $branchname = $branches->{$br}->{'branchname'};
1170 $session->param('number',$borrowernumber);
1171 $session->param('id',$userid);
1172 $session->param('cardnumber',$cardnumber);
1173 $session->param('firstname',$firstname);
1174 $session->param('surname',$surname);
1175 $session->param('branch',$branchcode);
1176 $session->param('branchname',$branchname);
1177 $session->param('flags',$userflags);
1178 $session->param('emailaddress',$emailaddress);
1179 $session->param('ip',$session->remote_addr());
1180 $session->param('lasttime',time());
1181 } elsif ( $return == 2 ) {
1182 #We suppose the user is the superlibrarian
1183 $session->param('number',0);
1184 $session->param('id',C4::Context->config('user'));
1185 $session->param('cardnumber',C4::Context->config('user'));
1186 $session->param('firstname',C4::Context->config('user'));
1187 $session->param('surname',C4::Context->config('user'));
1188 $session->param('branch','NO_LIBRARY_SET');
1189 $session->param('branchname','NO_LIBRARY_SET');
1190 $session->param('flags',1);
1191 $session->param('emailaddress', C4::Context->preference('KohaAdminEmailAddress'));
1192 $session->param('ip',$session->remote_addr());
1193 $session->param('lasttime',time());
1195 C4::Context::set_userenv(
1196 $session->param('number'), $session->param('id'),
1197 $session->param('cardnumber'), $session->param('firstname'),
1198 $session->param('surname'), $session->param('branch'),
1199 $session->param('branchname'), $session->param('flags'),
1200 $session->param('emailaddress'), $session->param('branchprinter')
1202 return ("ok", $cookie, $sessionID);
1204 return ("failed", undef, undef);
1209 =head2 check_cookie_auth
1211 ($status, $sessionId) = check_api_auth($cookie, $userflags);
1213 Given a CGISESSID cookie set during a previous login to Koha, determine
1214 if the user has the privileges specified by C<$userflags>.
1216 C<check_cookie_auth> is meant for authenticating special services
1217 such as tools/upload-file.pl that are invoked by other pages that
1218 have been authenticated in the usual way.
1220 Possible return values in C<$status> are:
1224 =item "ok" -- user authenticated; C<$sessionID> have valid values.
1226 =item "failed" -- credentials are not correct; C<$sessionid> are undef
1228 =item "maintenance" -- DB is in maintenance mode; no login possible at the moment
1230 =item "expired -- session cookie has expired; API user should resubmit userid and password
1236 sub check_cookie_auth {
1238 my $flagsrequired = shift;
1240 my $dbh = C4::Context->dbh;
1241 my $timeout = C4::Context->preference('timeout');
1242 $timeout = 600 unless $timeout;
1244 unless (C4::Context->preference('Version')) {
1245 # database has not been installed yet
1246 return ("maintenance", undef);
1248 my $kohaversion=C4::Context::KOHAVERSION;
1249 $kohaversion =~ s/(.*\..*)\.(.*)\.(.*)/$1$2$3/;
1250 if (C4::Context->preference('Version') < $kohaversion) {
1251 # database in need of version update; assume that
1252 # no API should be called while databsae is in
1254 return ("maintenance", undef);
1257 # FIXME -- most of what follows is a copy-and-paste
1258 # of code from checkauth. There is an obvious need
1259 # for refactoring to separate the various parts of
1260 # the authentication code, but as of 2007-11-23 this
1261 # is deferred so as to not introduce bugs into the
1262 # regular authentication code for Koha 3.0.
1264 # see if we have a valid session cookie already
1265 # however, if a userid parameter is present (i.e., from
1266 # a form submission, assume that any current cookie
1268 unless (defined $cookie and $cookie) {
1269 return ("failed", undef);
1271 my $sessionID = $cookie;
1272 my $session = get_session($sessionID);
1273 C4::Context->_new_userenv($sessionID);
1275 C4::Context::set_userenv(
1276 $session->param('number'), $session->param('id'),
1277 $session->param('cardnumber'), $session->param('firstname'),
1278 $session->param('surname'), $session->param('branch'),
1279 $session->param('branchname'), $session->param('flags'),
1280 $session->param('emailaddress'), $session->param('branchprinter')
1283 my $ip = $session->param('ip');
1284 my $lasttime = $session->param('lasttime');
1285 my $userid = $session->param('id');
1286 if ( $lasttime < time() - $timeout ) {
1289 C4::Context->_unset_userenv($sessionID);
1292 return ("expired", undef);
1293 } elsif ( $ip ne $ENV{'REMOTE_ADDR'} ) {
1294 # IP address changed
1296 C4::Context->_unset_userenv($sessionID);
1299 return ("expired", undef);
1301 $session->param('lasttime',time());
1302 my $flags = haspermission($userid, $flagsrequired);
1304 return ("ok", $sessionID);
1307 C4::Context->_unset_userenv($sessionID);
1310 return ("failed", undef);
1314 return ("expired", undef);
1321 my $session = get_session($sessionID);
1323 Given a session ID, retrieve the CGI::Session object used to store
1324 the session's state. The session object can be used to store
1325 data that needs to be accessed by different scripts during a
1328 If the C<$sessionID> parameter is an empty string, a new session
1334 my $sessionID = shift;
1335 my $storage_method = C4::Context->preference('SessionStorage');
1336 my $dbh = C4::Context->dbh;
1338 if ($storage_method eq 'mysql'){
1339 $session = new CGI::Session("driver:MySQL;serializer:yaml;id:md5", $sessionID, {Handle=>$dbh});
1341 elsif ($storage_method eq 'Pg') {
1342 $session = new CGI::Session("driver:PostgreSQL;serializer:yaml;id:md5", $sessionID, {Handle=>$dbh});
1345 # catch all defaults to tmp should work on all systems
1346 $session = new CGI::Session("driver:File;serializer:yaml;id:md5", $sessionID, {Directory=>'/tmp'});
1353 my ( $dbh, $userid, $password, $query ) = @_;
1355 $debug and print "## checkpw - checking LDAP\n";
1356 my ($retval,$retcard) = checkpw_ldap(@_); # EXTERNAL AUTH
1357 ($retval) and return ($retval,$retcard);
1360 if ($cas && $query->param('ticket')) {
1361 $debug and print STDERR "## checkpw - checking CAS\n";
1362 # In case of a CAS authentication, we use the ticket instead of the password
1363 my $ticket = $query->param('ticket');
1364 my ($retval,$retcard,$retuserid) = checkpw_cas($dbh, $ticket, $query); # EXTERNAL AUTH
1365 ($retval) and return ($retval,$retcard,$retuserid);
1372 "select password,cardnumber,borrowernumber,userid,firstname,surname,branchcode,flags from borrowers where userid=?"
1374 $sth->execute($userid);
1376 my ( $md5password, $cardnumber, $borrowernumber, $userid, $firstname,
1377 $surname, $branchcode, $flags )
1379 if ( md5_base64($password) eq $md5password and $md5password ne "!") {
1381 C4::Context->set_userenv( "$borrowernumber", $userid, $cardnumber,
1382 $firstname, $surname, $branchcode, $flags );
1383 return 1, $cardnumber;
1388 "select password,cardnumber,borrowernumber,userid, firstname,surname,branchcode,flags from borrowers where cardnumber=?"
1390 $sth->execute($userid);
1392 my ( $md5password, $cardnumber, $borrowernumber, $userid, $firstname,
1393 $surname, $branchcode, $flags )
1395 if ( md5_base64($password) eq $md5password ) {
1397 C4::Context->set_userenv( $borrowernumber, $userid, $cardnumber,
1398 $firstname, $surname, $branchcode, $flags );
1402 if ( $userid && $userid eq C4::Context->config('user')
1403 && "$password" eq C4::Context->config('pass') )
1406 # Koha superuser account
1407 # C4::Context->set_userenv(0,0,C4::Context->config('user'),C4::Context->config('user'),C4::Context->config('user'),"",1);
1410 if ( $userid && $userid eq 'demo'
1411 && "$password" eq 'demo'
1412 && C4::Context->config('demo') )
1415 # DEMO => the demo user is allowed to do everything (if demo set to 1 in koha.conf
1416 # some features won't be effective : modify systempref, modify MARC structure,
1424 my $authflags = getuserflags($flags, $userid, [$dbh]);
1426 Translates integer flags into permissions strings hash.
1428 C<$flags> is the integer userflags value ( borrowers.userflags )
1429 C<$userid> is the members.userid, used for building subpermissions
1430 C<$authflags> is a hashref of permissions
1437 my $dbh = @_ ? shift : C4::Context->dbh;
1439 $flags = 0 unless $flags;
1440 my $sth = $dbh->prepare("SELECT bit, flag, defaulton FROM userflags");
1443 while ( my ( $bit, $flag, $defaulton ) = $sth->fetchrow ) {
1444 if ( ( $flags & ( 2**$bit ) ) || $defaulton ) {
1445 $userflags->{$flag} = 1;
1448 $userflags->{$flag} = 0;
1452 # get subpermissions and merge with top-level permissions
1453 my $user_subperms = get_user_subpermissions($userid);
1454 foreach my $module (keys %$user_subperms) {
1455 next if $userflags->{$module} == 1; # user already has permission for everything in this module
1456 $userflags->{$module} = $user_subperms->{$module};
1462 =head2 get_user_subpermissions
1464 $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 =head2 get_all_subpermissions
1508 my $perm_hashref = get_all_subpermissions();
1510 Returns a hashref of hashrefs defining all specific
1511 permissions currently defined. The return value
1512 has the same structure as that of C<get_user_subpermissions>,
1513 except that the innermost hash value is the description
1514 of the subpermission.
1518 sub get_all_subpermissions {
1519 my $dbh = C4::Context->dbh;
1520 my $sth = $dbh->prepare("SELECT flag, code, description
1522 JOIN userflags ON (module_bit = bit)");
1526 while (my $perm = $sth->fetchrow_hashref) {
1527 $all_perms->{$perm->{'flag'}}->{$perm->{'code'}} = $perm->{'description'};
1532 =head2 haspermission
1534 $flags = ($userid, $flagsrequired);
1536 C<$userid> the userid of the member
1537 C<$flags> is a hashref of required flags like C<$borrower-<{authflags}>
1539 Returns member's flags or 0 if a permission is not met.
1544 my ($userid, $flagsrequired) = @_;
1545 my $sth = C4::Context->dbh->prepare("SELECT flags FROM borrowers WHERE userid=?");
1546 $sth->execute($userid);
1547 my $flags = getuserflags( $sth->fetchrow(), $userid );
1548 if ( $userid eq C4::Context->config('user') ) {
1549 # Super User Account from /etc/koha.conf
1550 $flags->{'superlibrarian'} = 1;
1552 elsif ( $userid eq 'demo' && C4::Context->config('demo') ) {
1553 # Demo user that can do "anything" (demo=1 in /etc/koha.conf)
1554 $flags->{'superlibrarian'} = 1;
1556 return $flags if $flags->{superlibrarian};
1557 foreach my $module ( keys %$flagsrequired ) {
1558 my $subperm = $flagsrequired->{$module};
1559 if ($subperm eq '*') {
1560 return 0 unless ( $flags->{$module} == 1 or ref($flags->{$module}) );
1562 return 0 unless ( $flags->{$module} == 1 or
1563 ( ref($flags->{$module}) and
1564 exists $flags->{$module}->{$subperm} and
1565 $flags->{$module}->{$subperm} == 1
1571 #FIXME - This fcn should return the failed permission so a suitable error msg can be delivered.
1575 sub getborrowernumber {
1577 my $userenv = C4::Context->userenv;
1578 if ( defined( $userenv ) && ref( $userenv ) eq 'HASH' && $userenv->{number} ) {
1579 return $userenv->{number};
1581 my $dbh = C4::Context->dbh;
1582 for my $field ( 'userid', 'cardnumber' ) {
1584 $dbh->prepare("select borrowernumber from borrowers where $field=?");
1585 $sth->execute($userid);
1587 my ($bnumber) = $sth->fetchrow;
1594 END { } # module clean-up code here (global destructor)