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 IntranetFavicon => C4::Context->preference("IntranetFavicon"),
363 intranetreadinghistory => C4::Context->preference("intranetreadinghistory"),
364 intranetstylesheet => C4::Context->preference("intranetstylesheet"),
365 IntranetUserCSS => C4::Context->preference("IntranetUserCSS"),
366 intranetuserjs => C4::Context->preference("intranetuserjs"),
367 intranetbookbag => C4::Context->preference("intranetbookbag"),
368 suggestion => C4::Context->preference("suggestion"),
369 virtualshelves => C4::Context->preference("virtualshelves"),
370 StaffSerialIssueDisplayCount => C4::Context->preference("StaffSerialIssueDisplayCount"),
371 NoZebra => C4::Context->preference('NoZebra'),
375 warn "template type should be OPAC, here it is=[" . $in->{'type'} . "]" unless ( $in->{'type'} eq 'opac' );
376 #TODO : replace LibraryName syspref with 'system name', and remove this html processing
377 my $LibraryNameTitle = C4::Context->preference("LibraryName");
378 $LibraryNameTitle =~ s/<(?:\/?)(?:br|p)\s*(?:\/?)>/ /sgi;
379 $LibraryNameTitle =~ s/<(?:[^<>'"]|'(?:[^']*)'|"(?:[^"]*)")*>//sg;
380 # variables passed from CGI: opac_css_override and opac_search_limits.
381 my $opac_search_limit = $ENV{'OPAC_SEARCH_LIMIT'};
382 my $opac_limit_override = $ENV{'OPAC_LIMIT_OVERRIDE'};
384 if (($opac_search_limit =~ /branch:(\w+)/ && $opac_limit_override) || $in->{'query'}->param('limit') =~ /branch:(\w+)/){
385 $opac_name = $1; # opac_search_limit is a branch, so we use it.
386 } elsif (C4::Context->preference("SearchMyLibraryFirst") && C4::Context->userenv && C4::Context->userenv->{'branch'}) {
387 $opac_name = C4::Context->userenv->{'branch'};
390 AmazonContent => "" . C4::Context->preference("AmazonContent"),
391 AnonSuggestions => "" . C4::Context->preference("AnonSuggestions"),
392 AuthorisedValueImages => C4::Context->preference("AuthorisedValueImages"),
393 BranchesLoop => GetBranchesLoop($opac_name),
394 LibraryName => "" . C4::Context->preference("LibraryName"),
395 LibraryNameTitle => "" . $LibraryNameTitle,
396 LoginBranchname => C4::Context->userenv?C4::Context->userenv->{"branchname"}:"",
397 OPACAmazonEnabled => C4::Context->preference("OPACAmazonEnabled"),
398 OPACAmazonSimilarItems => C4::Context->preference("OPACAmazonSimilarItems"),
399 OPACAmazonCoverImages => C4::Context->preference("OPACAmazonCoverImages"),
400 OPACAmazonReviews => C4::Context->preference("OPACAmazonReviews"),
401 OPACFRBRizeEditions => C4::Context->preference("OPACFRBRizeEditions"),
402 OpacHighlightedWords => C4::Context->preference("OpacHighlightedWords"),
403 OPACItemHolds => C4::Context->preference("OPACItemHolds"),
404 OPACShelfBrowser => "". C4::Context->preference("OPACShelfBrowser"),
405 OPACURLOpenInNewWindow => "" . C4::Context->preference("OPACURLOpenInNewWindow"),
406 OPACUserCSS => "". C4::Context->preference("OPACUserCSS"),
407 OPACViewOthersSuggestions => "" . C4::Context->preference("OPACViewOthersSuggestions"),
408 OpacAuthorities => C4::Context->preference("OpacAuthorities"),
409 OPACBaseURL => ($in->{'query'}->https() ? "https://" : "http://") . $ENV{'SERVER_NAME'} .
410 ($ENV{'SERVER_PORT'} eq ($in->{'query'}->https() ? "443" : "80") ? '' : ":$ENV{'SERVER_PORT'}"),
411 opac_css_override => $ENV{'OPAC_CSS_OVERRIDE'},
412 opac_search_limit => $opac_search_limit,
413 opac_limit_override => $opac_limit_override,
414 OpacBrowser => C4::Context->preference("OpacBrowser"),
415 OpacCloud => C4::Context->preference("OpacCloud"),
416 OpacMainUserBlock => "" . C4::Context->preference("OpacMainUserBlock"),
417 OpacNav => "" . C4::Context->preference("OpacNav"),
418 OpacPasswordChange => C4::Context->preference("OpacPasswordChange"),
419 OPACPatronDetails => C4::Context->preference("OPACPatronDetails"),
420 OPACPrivacy => C4::Context->preference("OPACPrivacy"),
421 OPACFinesTab => C4::Context->preference("OPACFinesTab"),
422 OpacTopissue => C4::Context->preference("OpacTopissue"),
423 RequestOnOpac => C4::Context->preference("RequestOnOpac"),
424 'Version' => C4::Context->preference('Version'),
425 hidelostitems => C4::Context->preference("hidelostitems"),
426 mylibraryfirst => (C4::Context->preference("SearchMyLibraryFirst") && C4::Context->userenv) ? C4::Context->userenv->{'branch'} : '',
427 opaclayoutstylesheet => "" . C4::Context->preference("opaclayoutstylesheet"),
428 opaccolorstylesheet => "" . C4::Context->preference("opaccolorstylesheet"),
429 opacstylesheet => "" . C4::Context->preference("opacstylesheet"),
430 opacbookbag => "" . C4::Context->preference("opacbookbag"),
431 opaccredits => "" . C4::Context->preference("opaccredits"),
432 OpacFavicon => C4::Context->preference("OpacFavicon"),
433 opacheader => "" . C4::Context->preference("opacheader"),
434 opaclanguagesdisplay => "" . C4::Context->preference("opaclanguagesdisplay"),
435 opacreadinghistory => C4::Context->preference("opacreadinghistory"),
436 opacsmallimage => "" . C4::Context->preference("opacsmallimage"),
437 opacuserjs => C4::Context->preference("opacuserjs"),
438 opacuserlogin => "" . C4::Context->preference("opacuserlogin"),
439 reviewson => C4::Context->preference("reviewson"),
440 suggestion => "" . C4::Context->preference("suggestion"),
441 virtualshelves => "" . C4::Context->preference("virtualshelves"),
442 OPACSerialIssueDisplayCount => C4::Context->preference("OPACSerialIssueDisplayCount"),
443 OpacAddMastheadLibraryPulldown => C4::Context->preference("OpacAddMastheadLibraryPulldown"),
444 OPACXSLTDetailsDisplay => C4::Context->preference("OPACXSLTDetailsDisplay"),
445 OPACXSLTResultsDisplay => C4::Context->preference("OPACXSLTResultsDisplay"),
446 SyndeticsClientCode => C4::Context->preference("SyndeticsClientCode"),
447 SyndeticsEnabled => C4::Context->preference("SyndeticsEnabled"),
448 SyndeticsCoverImages => C4::Context->preference("SyndeticsCoverImages"),
449 SyndeticsTOC => C4::Context->preference("SyndeticsTOC"),
450 SyndeticsSummary => C4::Context->preference("SyndeticsSummary"),
451 SyndeticsEditions => C4::Context->preference("SyndeticsEditions"),
452 SyndeticsExcerpt => C4::Context->preference("SyndeticsExcerpt"),
453 SyndeticsReviews => C4::Context->preference("SyndeticsReviews"),
454 SyndeticsAuthorNotes => C4::Context->preference("SyndeticsAuthorNotes"),
455 SyndeticsAwards => C4::Context->preference("SyndeticsAwards"),
456 SyndeticsSeries => C4::Context->preference("SyndeticsSeries"),
457 SyndeticsCoverImageSize => C4::Context->preference("SyndeticsCoverImageSize"),
460 $template->param(OpacPublic => '1') if ($template->param( 'loggedinusername') || C4::Context->preference("OpacPublic"));
462 $template->param(listloop=>[{shelfname=>"Freelist", shelfnumber=>110}]);
463 return ( $template, $borrowernumber, $cookie, $flags);
468 ($userid, $cookie, $sessionID) = &checkauth($query, $noauth, $flagsrequired, $type);
470 Verifies that the user is authorized to run this script. If
471 the user is authorized, a (userid, cookie, session-id, flags)
472 quadruple is returned. If the user is not authorized but does
473 not have the required privilege (see $flagsrequired below), it
474 displays an error page and exits. Otherwise, it displays the
475 login page and exits.
477 Note that C<&checkauth> will return if and only if the user
478 is authorized, so it should be called early on, before any
479 unfinished operations (e.g., if you've opened a file, then
480 C<&checkauth> won't close it for you).
482 C<$query> is the CGI object for the script calling C<&checkauth>.
484 The C<$noauth> argument is optional. If it is set, then no
485 authorization is required for the script.
487 C<&checkauth> fetches user and session information from C<$query> and
488 ensures that the user is authorized to run scripts that require
491 The C<$flagsrequired> argument specifies the required privileges
492 the user must have if the username and password are correct.
493 It should be specified as a reference-to-hash; keys in the hash
494 should be the "flags" for the user, as specified in the Members
495 intranet module. Any key specified must correspond to a "flag"
496 in the userflags table. E.g., { circulate => 1 } would specify
497 that the user must have the "circulate" privilege in order to
498 proceed. To make sure that access control is correct, the
499 C<$flagsrequired> parameter must be specified correctly.
501 Koha also has a concept of sub-permissions, also known as
502 granular permissions. This makes the value of each key
503 in the C<flagsrequired> hash take on an additional
508 The user must have access to all subfunctions of the module
509 specified by the hash key.
513 The user must have access to at least one subfunction of the module
514 specified by the hash key.
516 specific permission, e.g., 'export_catalog'
518 The user must have access to the specific subfunction list, which
519 must correspond to a row in the permissions table.
521 The C<$type> argument specifies whether the template should be
522 retrieved from the opac or intranet directory tree. "opac" is
523 assumed if it is not specified; however, if C<$type> is specified,
524 "intranet" is assumed if it is not "opac".
526 If C<$query> does not have a valid session ID associated with it
527 (i.e., the user has not logged in) or if the session has expired,
528 C<&checkauth> presents the user with a login page (from the point of
529 view of the original script, C<&checkauth> does not return). Once the
530 user has authenticated, C<&checkauth> restarts the original script
531 (this time, C<&checkauth> returns).
533 The login page is provided using a HTML::Template, which is set in the
534 systempreferences table or at the top of this file. The variable C<$type>
535 selects which template to use, either the opac or the intranet
536 authentification template.
538 C<&checkauth> returns a user ID, a cookie, and a session ID. The
539 cookie should be sent back to the browser; it verifies that the user
544 sub _version_check ($$) {
548 # If Version syspref is unavailable, it means Koha is beeing installed,
549 # and so we must redirect to OPAC maintenance page or to the WebInstaller
550 # also, if OpacMaintenance is ON, OPAC should redirect to maintenance
551 if (C4::Context->preference('OpacMaintenance') && $type eq 'opac') {
552 warn "OPAC Install required, redirecting to maintenance";
553 print $query->redirect("/cgi-bin/koha/maintenance.pl");
555 unless ($version = C4::Context->preference('Version')) { # assignment, not comparison
556 if ($type ne 'opac') {
557 warn "Install required, redirecting to Installer";
558 print $query->redirect("/cgi-bin/koha/installer/install.pl");
561 warn "OPAC Install required, redirecting to maintenance";
562 print $query->redirect("/cgi-bin/koha/maintenance.pl");
567 # check that database and koha version are the same
568 # there is no DB version, it's a fresh install,
569 # go to web installer
570 # there is a DB version, compare it to the code version
571 my $kohaversion=C4::Context::KOHAVERSION;
572 # remove the 3 last . to have a Perl number
573 $kohaversion =~ s/(.*\..*)\.(.*)\.(.*)/$1$2$3/;
574 $debug and print STDERR "kohaversion : $kohaversion\n";
575 if ($version < $kohaversion){
576 my $warning = "Database update needed, redirecting to %s. Database is $version and Koha is $kohaversion";
577 if ($type ne 'opac'){
578 warn sprintf($warning, 'Installer');
579 print $query->redirect("/cgi-bin/koha/installer/install.pl?step=3");
581 warn sprintf("OPAC: " . $warning, 'maintenance');
582 print $query->redirect("/cgi-bin/koha/maintenance.pl");
590 open L, ">>/tmp/sessionlog" or warn "ERROR: Cannot append to /tmp/sessionlog";
591 printf L join("\n",@_);
597 $debug and warn "Checking Auth";
598 # $authnotrequired will be set for scripts which will run without authentication
599 my $authnotrequired = shift;
600 my $flagsrequired = shift;
602 $type = 'opac' unless $type;
604 my $dbh = C4::Context->dbh;
605 my $timeout = C4::Context->preference('timeout');
607 if ($timeout =~ /(\d+)[dD]/) {
608 $timeout = $1 * 86400;
610 $timeout = 600 unless $timeout;
612 _version_check($type,$query);
616 my ( $userid, $cookie, $sessionID, $flags, $barshelves, $pubshelves );
617 my $logout = $query->param('logout.x');
619 if ( $userid = $ENV{'REMOTE_USER'} ) {
620 # Using Basic Authentication, no cookies required
621 $cookie = $query->cookie(
622 -name => 'CGISESSID',
628 elsif ( $sessionID = $query->cookie("CGISESSID")) { # assignment, not comparison
629 my $session = get_session($sessionID);
630 C4::Context->_new_userenv($sessionID);
631 my ($ip, $lasttime, $sessiontype);
633 C4::Context::set_userenv(
634 $session->param('number'), $session->param('id'),
635 $session->param('cardnumber'), $session->param('firstname'),
636 $session->param('surname'), $session->param('branch'),
637 $session->param('branchname'), $session->param('flags'),
638 $session->param('emailaddress'), $session->param('branchprinter')
640 C4::Context::set_shelves_userenv('bar',$session->param('barshelves'));
641 C4::Context::set_shelves_userenv('pub',$session->param('pubshelves'));
642 C4::Context::set_shelves_userenv('tot',$session->param('totshelves'));
643 $debug and printf STDERR "AUTH_SESSION: (%s)\t%s %s - %s\n", map {$session->param($_)} qw(cardnumber firstname surname branch) ;
644 $ip = $session->param('ip');
645 $lasttime = $session->param('lasttime');
646 $userid = $session->param('id');
647 $sessiontype = $session->param('sessiontype');
649 if ( ($query->param('koha_login_context')) && ($query->param('userid') ne $session->param('id')) ) {
650 #if a user enters an id ne to the id in the current session, we need to log them in...
651 #first we need to clear the anonymous session...
652 $debug and warn "query id = " . $query->param('userid') . " but session id = " . $session->param('id');
655 C4::Context->_unset_userenv($sessionID);
660 # voluntary logout the user
663 C4::Context->_unset_userenv($sessionID);
664 _session_log(sprintf "%20s from %16s logged out at %30s (manually).\n", $userid,$ip,(strftime "%c",localtime));
668 if ($cas and $caslogout) {
672 elsif ( $lasttime < time() - $timeout ) {
674 $info{'timed_out'} = 1;
676 C4::Context->_unset_userenv($sessionID);
677 _session_log(sprintf "%20s from %16s logged out at %30s (inactivity).\n", $userid,$ip,(strftime "%c",localtime));
681 elsif ( $ip ne $ENV{'REMOTE_ADDR'} ) {
682 # Different ip than originally logged in from
683 $info{'oldip'} = $ip;
684 $info{'newip'} = $ENV{'REMOTE_ADDR'};
685 $info{'different_ip'} = 1;
687 C4::Context->_unset_userenv($sessionID);
688 _session_log(sprintf "%20s from %16s logged out at %30s (ip changed to %16s).\n", $userid,$ip,(strftime "%c",localtime), $info{'newip'});
693 $cookie = $query->cookie( CGISESSID => $session->id );
694 $session->param('lasttime',time());
695 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...
696 $flags = haspermission($userid, $flagsrequired);
700 $info{'nopermission'} = 1;
705 unless ($userid || $sessionID) {
706 #we initiate a session prior to checking for a username to allow for anonymous sessions...
707 my $session = get_session("") or die "Auth ERROR: Cannot get_session()";
708 my $sessionID = $session->id;
709 C4::Context->_new_userenv($sessionID);
710 $cookie = $query->cookie(CGISESSID => $sessionID);
711 $userid = $query->param('userid');
712 if ($cas || $userid) {
713 my $password = $query->param('password');
714 my ($return, $cardnumber);
715 if ($cas && $query->param('ticket')) {
717 ( $return, $cardnumber, $retuserid ) = checkpw( $dbh, $userid, $password, $query );
718 $userid = $retuserid;
719 $info{'invalidCasLogin'} = 1 unless ($return);
721 ( $return, $cardnumber ) = checkpw( $dbh, $userid, $password, $query );
724 _session_log(sprintf "%20s from %16s logged in at %30s.\n", $userid,$ENV{'REMOTE_ADDR'},(strftime '%c', localtime));
725 if ( $flags = haspermission( $userid, $flagsrequired ) ) {
729 $info{'nopermission'} = 1;
730 C4::Context->_unset_userenv($sessionID);
733 my ($borrowernumber, $firstname, $surname, $userflags,
734 $branchcode, $branchname, $branchprinter, $emailaddress);
736 if ( $return == 1 ) {
738 SELECT borrowernumber, firstname, surname, flags, borrowers.branchcode,
739 branches.branchname as branchname,
740 branches.branchprinter as branchprinter,
743 LEFT JOIN branches on borrowers.branchcode=branches.branchcode
745 my $sth = $dbh->prepare("$select where userid=?");
746 $sth->execute($userid);
747 unless ($sth->rows) {
748 $debug and print STDERR "AUTH_1: no rows for userid='$userid'\n";
749 $sth = $dbh->prepare("$select where cardnumber=?");
750 $sth->execute($cardnumber);
751 unless ($sth->rows) {
752 $debug and print STDERR "AUTH_2a: no rows for cardnumber='$cardnumber'\n";
753 $sth->execute($userid);
754 unless ($sth->rows) {
755 $debug and print STDERR "AUTH_2b: no rows for userid='$userid' AS cardnumber\n";
760 ($borrowernumber, $firstname, $surname, $userflags,
761 $branchcode, $branchname, $branchprinter, $emailaddress) = $sth->fetchrow;
762 $debug and print STDERR "AUTH_3 results: " .
763 "$cardnumber,$borrowernumber,$userid,$firstname,$surname,$userflags,$branchcode,$emailaddress\n";
765 print STDERR "AUTH_3: no results for userid='$userid', cardnumber='$cardnumber'.\n";
768 # launch a sequence to check if we have a ip for the branch, i
769 # if we have one we replace the branchcode of the userenv by the branch bound in the ip.
771 my $ip = $ENV{'REMOTE_ADDR'};
772 # if they specify at login, use that
773 if ($query->param('branch')) {
774 $branchcode = $query->param('branch');
775 $branchname = GetBranchName($branchcode);
777 my $branches = GetBranches();
778 if (C4::Context->boolean_preference('IndependantBranches') && C4::Context->boolean_preference('Autolocation')){
779 # we have to check they are coming from the right ip range
780 my $domain = $branches->{$branchcode}->{'branchip'};
781 if ($ip !~ /^$domain/){
783 $info{'wrongip'} = 1;
788 foreach my $br ( keys %$branches ) {
789 # now we work with the treatment of ip
790 my $domain = $branches->{$br}->{'branchip'};
791 if ( $domain && $ip =~ /^$domain/ ) {
792 $branchcode = $branches->{$br}->{'branchcode'};
794 # new op dev : add the branchprinter and branchname in the cookie
795 $branchprinter = $branches->{$br}->{'branchprinter'};
796 $branchname = $branches->{$br}->{'branchname'};
799 $session->param('number',$borrowernumber);
800 $session->param('id',$userid);
801 $session->param('cardnumber',$cardnumber);
802 $session->param('firstname',$firstname);
803 $session->param('surname',$surname);
804 $session->param('branch',$branchcode);
805 $session->param('branchname',$branchname);
806 $session->param('flags',$userflags);
807 $session->param('emailaddress',$emailaddress);
808 $session->param('ip',$session->remote_addr());
809 $session->param('lasttime',time());
810 $debug and printf STDERR "AUTH_4: (%s)\t%s %s - %s\n", map {$session->param($_)} qw(cardnumber firstname surname branch) ;
812 elsif ( $return == 2 ) {
813 #We suppose the user is the superlibrarian
815 $session->param('number',0);
816 $session->param('id',C4::Context->config('user'));
817 $session->param('cardnumber',C4::Context->config('user'));
818 $session->param('firstname',C4::Context->config('user'));
819 $session->param('surname',C4::Context->config('user'));
820 $session->param('branch','NO_LIBRARY_SET');
821 $session->param('branchname','NO_LIBRARY_SET');
822 $session->param('flags',1);
823 $session->param('emailaddress', C4::Context->preference('KohaAdminEmailAddress'));
824 $session->param('ip',$session->remote_addr());
825 $session->param('lasttime',time());
827 C4::Context::set_userenv(
828 $session->param('number'), $session->param('id'),
829 $session->param('cardnumber'), $session->param('firstname'),
830 $session->param('surname'), $session->param('branch'),
831 $session->param('branchname'), $session->param('flags'),
832 $session->param('emailaddress'), $session->param('branchprinter')
835 # Grab borrower's shelves and public shelves and add them to the session
836 # $row_count determines how many records are returned from the db query
837 # and the number of lists to be displayed of each type in the 'Lists' button drop down
838 my $row_count = 10; # FIXME:This probably should be a syspref
839 my ($total, $totshelves, $barshelves, $pubshelves);
840 ($barshelves, $totshelves) = C4::VirtualShelves::GetRecentShelves(1, $row_count, $borrowernumber);
841 $total->{'bartotal'} = $totshelves;
842 ($pubshelves, $totshelves) = C4::VirtualShelves::GetRecentShelves(2, $row_count, undef);
843 $total->{'pubtotal'} = $totshelves;
844 $session->param('barshelves', $barshelves->[0]);
845 $session->param('pubshelves', $pubshelves->[0]);
846 $session->param('totshelves', $total);
848 C4::Context::set_shelves_userenv('bar',$barshelves->[0]);
849 C4::Context::set_shelves_userenv('pub',$pubshelves->[0]);
850 C4::Context::set_shelves_userenv('tot',$total);
854 $info{'invalid_username_or_password'} = 1;
855 C4::Context->_unset_userenv($sessionID);
858 } # END if ( $userid = $query->param('userid') )
859 elsif ($type eq "opac") {
860 # if we are here this is an anonymous session; add public lists to it and a few other items...
861 # anonymous sessions are created only for the OPAC
862 $debug and warn "Initiating an anonymous session...";
864 # Grab the public shelves and add to the session...
865 my $row_count = 20; # FIXME:This probably should be a syspref
866 my ($total, $totshelves, $pubshelves);
867 ($pubshelves, $totshelves) = C4::VirtualShelves::GetRecentShelves(2, $row_count, undef);
868 $total->{'pubtotal'} = $totshelves;
869 $session->param('pubshelves', $pubshelves->[0]);
870 $session->param('totshelves', $total);
871 C4::Context::set_shelves_userenv('pub',$pubshelves->[0]);
872 C4::Context::set_shelves_userenv('tot',$total);
874 # setting a couple of other session vars...
875 $session->param('ip',$session->remote_addr());
876 $session->param('lasttime',time());
877 $session->param('sessiontype','anon');
879 } # END unless ($userid)
880 my $insecure = C4::Context->boolean_preference('insecure');
882 # finished authentification, now respond
883 if ( $loggedin || $authnotrequired || ( defined($insecure) && $insecure ) )
887 $cookie = $query->cookie( CGISESSID => '' );
889 return ( $userid, $cookie, $sessionID, $flags );
894 # AUTH rejected, show the login/password template, after checking the DB.
898 # get the inputs from the incoming query
900 foreach my $name ( param $query) {
901 (next) if ( $name eq 'userid' || $name eq 'password' || $name eq 'ticket' );
902 my $value = $query->param($name);
903 push @inputs, { name => $name, value => $value };
905 # get the branchloop, which we need for authentication
906 my $branches = GetBranches();
908 for my $branch_hash (sort keys %$branches) {
909 push @branch_loop, {branchcode => "$branch_hash", branchname => $branches->{$branch_hash}->{'branchname'}, };
912 my $template_name = ( $type eq 'opac' ) ? 'opac-auth.tmpl' : 'auth.tmpl';
913 my $template = gettemplate( $template_name, $type, $query );
914 $template->param(branchloop => \@branch_loop,);
918 casAuthentication => C4::Context->preference("casAuthentication"),
919 suggestion => C4::Context->preference("suggestion"),
920 virtualshelves => C4::Context->preference("virtualshelves"),
921 LibraryName => C4::Context->preference("LibraryName"),
922 opacuserlogin => C4::Context->preference("opacuserlogin"),
923 OpacNav => C4::Context->preference("OpacNav"),
924 opaccredits => C4::Context->preference("opaccredits"),
925 OpacFavicon => C4::Context->preference("OpacFavicon"),
926 opacreadinghistory => C4::Context->preference("opacreadinghistory"),
927 opacsmallimage => C4::Context->preference("opacsmallimage"),
928 opaclayoutstylesheet => C4::Context->preference("opaclayoutstylesheet"),
929 opaccolorstylesheet => C4::Context->preference("opaccolorstylesheet"),
930 opaclanguagesdisplay => C4::Context->preference("opaclanguagesdisplay"),
931 opacuserjs => C4::Context->preference("opacuserjs"),
932 opacbookbag => "" . C4::Context->preference("opacbookbag"),
933 OpacCloud => C4::Context->preference("OpacCloud"),
934 OpacTopissue => C4::Context->preference("OpacTopissue"),
935 OpacAuthorities => C4::Context->preference("OpacAuthorities"),
936 OpacBrowser => C4::Context->preference("OpacBrowser"),
937 opacheader => C4::Context->preference("opacheader"),
938 TagsEnabled => C4::Context->preference("TagsEnabled"),
939 OPACUserCSS => C4::Context->preference("OPACUserCSS"),
940 opacstylesheet => C4::Context->preference("opacstylesheet"),
941 intranetcolorstylesheet =>
942 C4::Context->preference("intranetcolorstylesheet"),
943 intranetstylesheet => C4::Context->preference("intranetstylesheet"),
944 intranetbookbag => C4::Context->preference("intranetbookbag"),
945 IntranetNav => C4::Context->preference("IntranetNav"),
946 intranetuserjs => C4::Context->preference("intranetuserjs"),
947 IndependantBranches=> C4::Context->preference("IndependantBranches"),
948 AutoLocation => C4::Context->preference("AutoLocation"),
949 wrongip => $info{'wrongip'},
952 $template->param( OpacPublic => C4::Context->preference("OpacPublic"));
953 $template->param( loginprompt => 1 ) unless $info{'nopermission'};
957 casServerUrl => login_cas_url(),
958 invalidCasLogin => $info{'invalidCasLogin'}
962 my $self_url = $query->url( -absolute => 1 );
965 LibraryName => C4::Context->preference("LibraryName"),
967 $template->param( \%info );
968 # $cookie = $query->cookie(CGISESSID => $session->id
970 print $query->header(
971 -type => 'text/html',
979 =head2 check_api_auth
981 ($status, $cookie, $sessionId) = check_api_auth($query, $userflags);
983 Given a CGI query containing the parameters 'userid' and 'password' and/or a session
984 cookie, determine if the user has the privileges specified by C<$userflags>.
986 C<check_api_auth> is is meant for authenticating users of web services, and
987 consequently will always return and will not attempt to redirect the user
990 If a valid session cookie is already present, check_api_auth will return a status
991 of "ok", the cookie, and the Koha session ID.
993 If no session cookie is present, check_api_auth will check the 'userid' and 'password
994 parameters and create a session cookie and Koha session if the supplied credentials
997 Possible return values in C<$status> are:
1001 =item "ok" -- user authenticated; C<$cookie> and C<$sessionid> have valid values.
1003 =item "failed" -- credentials are not correct; C<$cookie> and C<$sessionid> are undef
1005 =item "maintenance" -- DB is in maintenance mode; no login possible at the moment
1007 =item "expired -- session cookie has expired; API user should resubmit userid and password
1013 sub check_api_auth {
1015 my $flagsrequired = shift;
1017 my $dbh = C4::Context->dbh;
1018 my $timeout = C4::Context->preference('timeout');
1019 $timeout = 600 unless $timeout;
1021 unless (C4::Context->preference('Version')) {
1022 # database has not been installed yet
1023 return ("maintenance", undef, undef);
1025 my $kohaversion=C4::Context::KOHAVERSION;
1026 $kohaversion =~ s/(.*\..*)\.(.*)\.(.*)/$1$2$3/;
1027 if (C4::Context->preference('Version') < $kohaversion) {
1028 # database in need of version update; assume that
1029 # no API should be called while databsae is in
1031 return ("maintenance", undef, undef);
1034 # FIXME -- most of what follows is a copy-and-paste
1035 # of code from checkauth. There is an obvious need
1036 # for refactoring to separate the various parts of
1037 # the authentication code, but as of 2007-11-19 this
1038 # is deferred so as to not introduce bugs into the
1039 # regular authentication code for Koha 3.0.
1041 # see if we have a valid session cookie already
1042 # however, if a userid parameter is present (i.e., from
1043 # a form submission, assume that any current cookie
1045 my $sessionID = undef;
1046 unless ($query->param('userid')) {
1047 $sessionID = $query->cookie("CGISESSID");
1050 my $session = get_session($sessionID);
1051 C4::Context->_new_userenv($sessionID);
1053 C4::Context::set_userenv(
1054 $session->param('number'), $session->param('id'),
1055 $session->param('cardnumber'), $session->param('firstname'),
1056 $session->param('surname'), $session->param('branch'),
1057 $session->param('branchname'), $session->param('flags'),
1058 $session->param('emailaddress'), $session->param('branchprinter')
1061 my $ip = $session->param('ip');
1062 my $lasttime = $session->param('lasttime');
1063 my $userid = $session->param('id');
1064 if ( $lasttime < time() - $timeout ) {
1067 C4::Context->_unset_userenv($sessionID);
1070 return ("expired", undef, undef);
1071 } elsif ( $ip ne $ENV{'REMOTE_ADDR'} ) {
1072 # IP address changed
1074 C4::Context->_unset_userenv($sessionID);
1077 return ("expired", undef, undef);
1079 my $cookie = $query->cookie( CGISESSID => $session->id );
1080 $session->param('lasttime',time());
1081 my $flags = haspermission($userid, $flagsrequired);
1083 return ("ok", $cookie, $sessionID);
1086 C4::Context->_unset_userenv($sessionID);
1089 return ("failed", undef, undef);
1093 return ("expired", undef, undef);
1097 my $userid = $query->param('userid');
1098 my $password = $query->param('password');
1099 unless ($userid and $password) {
1100 # caller did something wrong, fail the authenticateion
1101 return ("failed", undef, undef);
1103 my ($return, $cardnumber);
1104 if ($cas && $query->param('ticket')) {
1106 ( $return, $cardnumber, $retuserid ) = checkpw( $dbh, $userid, $password, $query );
1107 $userid = $retuserid;
1109 ( $return, $cardnumber ) = checkpw( $dbh, $userid, $password, $query );
1111 if ($return and haspermission( $userid, $flagsrequired)) {
1112 my $session = get_session("");
1113 return ("failed", undef, undef) unless $session;
1115 my $sessionID = $session->id;
1116 C4::Context->_new_userenv($sessionID);
1117 my $cookie = $query->cookie(CGISESSID => $sessionID);
1118 if ( $return == 1 ) {
1120 $borrowernumber, $firstname, $surname,
1121 $userflags, $branchcode, $branchname,
1122 $branchprinter, $emailaddress
1126 "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=?"
1128 $sth->execute($userid);
1130 $borrowernumber, $firstname, $surname,
1131 $userflags, $branchcode, $branchname,
1132 $branchprinter, $emailaddress
1133 ) = $sth->fetchrow if ( $sth->rows );
1135 unless ($sth->rows ) {
1136 my $sth = $dbh->prepare(
1137 "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=?"
1139 $sth->execute($cardnumber);
1141 $borrowernumber, $firstname, $surname,
1142 $userflags, $branchcode, $branchname,
1143 $branchprinter, $emailaddress
1144 ) = $sth->fetchrow if ( $sth->rows );
1146 unless ( $sth->rows ) {
1147 $sth->execute($userid);
1149 $borrowernumber, $firstname, $surname, $userflags,
1150 $branchcode, $branchname, $branchprinter, $emailaddress
1151 ) = $sth->fetchrow if ( $sth->rows );
1155 my $ip = $ENV{'REMOTE_ADDR'};
1156 # if they specify at login, use that
1157 if ($query->param('branch')) {
1158 $branchcode = $query->param('branch');
1159 $branchname = GetBranchName($branchcode);
1161 my $branches = GetBranches();
1163 foreach my $br ( keys %$branches ) {
1164 # now we work with the treatment of ip
1165 my $domain = $branches->{$br}->{'branchip'};
1166 if ( $domain && $ip =~ /^$domain/ ) {
1167 $branchcode = $branches->{$br}->{'branchcode'};
1169 # new op dev : add the branchprinter and branchname in the cookie
1170 $branchprinter = $branches->{$br}->{'branchprinter'};
1171 $branchname = $branches->{$br}->{'branchname'};
1174 $session->param('number',$borrowernumber);
1175 $session->param('id',$userid);
1176 $session->param('cardnumber',$cardnumber);
1177 $session->param('firstname',$firstname);
1178 $session->param('surname',$surname);
1179 $session->param('branch',$branchcode);
1180 $session->param('branchname',$branchname);
1181 $session->param('flags',$userflags);
1182 $session->param('emailaddress',$emailaddress);
1183 $session->param('ip',$session->remote_addr());
1184 $session->param('lasttime',time());
1185 } elsif ( $return == 2 ) {
1186 #We suppose the user is the superlibrarian
1187 $session->param('number',0);
1188 $session->param('id',C4::Context->config('user'));
1189 $session->param('cardnumber',C4::Context->config('user'));
1190 $session->param('firstname',C4::Context->config('user'));
1191 $session->param('surname',C4::Context->config('user'));
1192 $session->param('branch','NO_LIBRARY_SET');
1193 $session->param('branchname','NO_LIBRARY_SET');
1194 $session->param('flags',1);
1195 $session->param('emailaddress', C4::Context->preference('KohaAdminEmailAddress'));
1196 $session->param('ip',$session->remote_addr());
1197 $session->param('lasttime',time());
1199 C4::Context::set_userenv(
1200 $session->param('number'), $session->param('id'),
1201 $session->param('cardnumber'), $session->param('firstname'),
1202 $session->param('surname'), $session->param('branch'),
1203 $session->param('branchname'), $session->param('flags'),
1204 $session->param('emailaddress'), $session->param('branchprinter')
1206 return ("ok", $cookie, $sessionID);
1208 return ("failed", undef, undef);
1213 =head2 check_cookie_auth
1215 ($status, $sessionId) = check_api_auth($cookie, $userflags);
1217 Given a CGISESSID cookie set during a previous login to Koha, determine
1218 if the user has the privileges specified by C<$userflags>.
1220 C<check_cookie_auth> is meant for authenticating special services
1221 such as tools/upload-file.pl that are invoked by other pages that
1222 have been authenticated in the usual way.
1224 Possible return values in C<$status> are:
1228 =item "ok" -- user authenticated; C<$sessionID> have valid values.
1230 =item "failed" -- credentials are not correct; C<$sessionid> are undef
1232 =item "maintenance" -- DB is in maintenance mode; no login possible at the moment
1234 =item "expired -- session cookie has expired; API user should resubmit userid and password
1240 sub check_cookie_auth {
1242 my $flagsrequired = shift;
1244 my $dbh = C4::Context->dbh;
1245 my $timeout = C4::Context->preference('timeout');
1246 $timeout = 600 unless $timeout;
1248 unless (C4::Context->preference('Version')) {
1249 # database has not been installed yet
1250 return ("maintenance", undef);
1252 my $kohaversion=C4::Context::KOHAVERSION;
1253 $kohaversion =~ s/(.*\..*)\.(.*)\.(.*)/$1$2$3/;
1254 if (C4::Context->preference('Version') < $kohaversion) {
1255 # database in need of version update; assume that
1256 # no API should be called while databsae is in
1258 return ("maintenance", undef);
1261 # FIXME -- most of what follows is a copy-and-paste
1262 # of code from checkauth. There is an obvious need
1263 # for refactoring to separate the various parts of
1264 # the authentication code, but as of 2007-11-23 this
1265 # is deferred so as to not introduce bugs into the
1266 # regular authentication code for Koha 3.0.
1268 # see if we have a valid session cookie already
1269 # however, if a userid parameter is present (i.e., from
1270 # a form submission, assume that any current cookie
1272 unless (defined $cookie and $cookie) {
1273 return ("failed", undef);
1275 my $sessionID = $cookie;
1276 my $session = get_session($sessionID);
1277 C4::Context->_new_userenv($sessionID);
1279 C4::Context::set_userenv(
1280 $session->param('number'), $session->param('id'),
1281 $session->param('cardnumber'), $session->param('firstname'),
1282 $session->param('surname'), $session->param('branch'),
1283 $session->param('branchname'), $session->param('flags'),
1284 $session->param('emailaddress'), $session->param('branchprinter')
1287 my $ip = $session->param('ip');
1288 my $lasttime = $session->param('lasttime');
1289 my $userid = $session->param('id');
1290 if ( $lasttime < time() - $timeout ) {
1293 C4::Context->_unset_userenv($sessionID);
1296 return ("expired", undef);
1297 } elsif ( $ip ne $ENV{'REMOTE_ADDR'} ) {
1298 # IP address changed
1300 C4::Context->_unset_userenv($sessionID);
1303 return ("expired", undef);
1305 $session->param('lasttime',time());
1306 my $flags = haspermission($userid, $flagsrequired);
1308 return ("ok", $sessionID);
1311 C4::Context->_unset_userenv($sessionID);
1314 return ("failed", undef);
1318 return ("expired", undef);
1325 my $session = get_session($sessionID);
1327 Given a session ID, retrieve the CGI::Session object used to store
1328 the session's state. The session object can be used to store
1329 data that needs to be accessed by different scripts during a
1332 If the C<$sessionID> parameter is an empty string, a new session
1338 my $sessionID = shift;
1339 my $storage_method = C4::Context->preference('SessionStorage');
1340 my $dbh = C4::Context->dbh;
1342 if ($storage_method eq 'mysql'){
1343 $session = new CGI::Session("driver:MySQL;serializer:yaml;id:md5", $sessionID, {Handle=>$dbh});
1345 elsif ($storage_method eq 'Pg') {
1346 $session = new CGI::Session("driver:PostgreSQL;serializer:yaml;id:md5", $sessionID, {Handle=>$dbh});
1349 # catch all defaults to tmp should work on all systems
1350 $session = new CGI::Session("driver:File;serializer:yaml;id:md5", $sessionID, {Directory=>'/tmp'});
1357 my ( $dbh, $userid, $password, $query ) = @_;
1359 $debug and print "## checkpw - checking LDAP\n";
1360 my ($retval,$retcard) = checkpw_ldap(@_); # EXTERNAL AUTH
1361 ($retval) and return ($retval,$retcard);
1364 if ($cas && $query->param('ticket')) {
1365 $debug and print STDERR "## checkpw - checking CAS\n";
1366 # In case of a CAS authentication, we use the ticket instead of the password
1367 my $ticket = $query->param('ticket');
1368 my ($retval,$retcard,$retuserid) = checkpw_cas($dbh, $ticket, $query); # EXTERNAL AUTH
1369 ($retval) and return ($retval,$retcard,$retuserid);
1376 "select password,cardnumber,borrowernumber,userid,firstname,surname,branchcode,flags from borrowers where userid=?"
1378 $sth->execute($userid);
1380 my ( $md5password, $cardnumber, $borrowernumber, $userid, $firstname,
1381 $surname, $branchcode, $flags )
1383 if ( md5_base64($password) eq $md5password and $md5password ne "!") {
1385 C4::Context->set_userenv( "$borrowernumber", $userid, $cardnumber,
1386 $firstname, $surname, $branchcode, $flags );
1387 return 1, $cardnumber;
1392 "select password,cardnumber,borrowernumber,userid, firstname,surname,branchcode,flags from borrowers where cardnumber=?"
1394 $sth->execute($userid);
1396 my ( $md5password, $cardnumber, $borrowernumber, $userid, $firstname,
1397 $surname, $branchcode, $flags )
1399 if ( md5_base64($password) eq $md5password ) {
1401 C4::Context->set_userenv( $borrowernumber, $userid, $cardnumber,
1402 $firstname, $surname, $branchcode, $flags );
1406 if ( $userid && $userid eq C4::Context->config('user')
1407 && "$password" eq C4::Context->config('pass') )
1410 # Koha superuser account
1411 # C4::Context->set_userenv(0,0,C4::Context->config('user'),C4::Context->config('user'),C4::Context->config('user'),"",1);
1414 if ( $userid && $userid eq 'demo'
1415 && "$password" eq 'demo'
1416 && C4::Context->config('demo') )
1419 # DEMO => the demo user is allowed to do everything (if demo set to 1 in koha.conf
1420 # some features won't be effective : modify systempref, modify MARC structure,
1428 my $authflags = getuserflags($flags, $userid, [$dbh]);
1430 Translates integer flags into permissions strings hash.
1432 C<$flags> is the integer userflags value ( borrowers.userflags )
1433 C<$userid> is the members.userid, used for building subpermissions
1434 C<$authflags> is a hashref of permissions
1441 my $dbh = @_ ? shift : C4::Context->dbh;
1443 $flags = 0 unless $flags;
1444 my $sth = $dbh->prepare("SELECT bit, flag, defaulton FROM userflags");
1447 while ( my ( $bit, $flag, $defaulton ) = $sth->fetchrow ) {
1448 if ( ( $flags & ( 2**$bit ) ) || $defaulton ) {
1449 $userflags->{$flag} = 1;
1452 $userflags->{$flag} = 0;
1456 # get subpermissions and merge with top-level permissions
1457 my $user_subperms = get_user_subpermissions($userid);
1458 foreach my $module (keys %$user_subperms) {
1459 next if $userflags->{$module} == 1; # user already has permission for everything in this module
1460 $userflags->{$module} = $user_subperms->{$module};
1466 =head2 get_user_subpermissions
1468 $user_perm_hashref = get_user_subpermissions($userid);
1470 Given the userid (note, not the borrowernumber) of a staff user,
1471 return a hashref of hashrefs of the specific subpermissions
1472 accorded to the user. An example return is
1476 export_catalog => 1,
1477 import_patrons => 1,
1481 The top-level hash-key is a module or function code from
1482 userflags.flag, while the second-level key is a code
1485 The results of this function do not give a complete picture
1486 of the functions that a staff user can access; it is also
1487 necessary to check borrowers.flags.
1491 sub get_user_subpermissions {
1494 my $dbh = C4::Context->dbh;
1495 my $sth = $dbh->prepare("SELECT flag, user_permissions.code
1496 FROM user_permissions
1497 JOIN permissions USING (module_bit, code)
1498 JOIN userflags ON (module_bit = bit)
1499 JOIN borrowers USING (borrowernumber)
1501 $sth->execute($userid);
1503 my $user_perms = {};
1504 while (my $perm = $sth->fetchrow_hashref) {
1505 $user_perms->{$perm->{'flag'}}->{$perm->{'code'}} = 1;
1510 =head2 get_all_subpermissions
1512 my $perm_hashref = get_all_subpermissions();
1514 Returns a hashref of hashrefs defining all specific
1515 permissions currently defined. The return value
1516 has the same structure as that of C<get_user_subpermissions>,
1517 except that the innermost hash value is the description
1518 of the subpermission.
1522 sub get_all_subpermissions {
1523 my $dbh = C4::Context->dbh;
1524 my $sth = $dbh->prepare("SELECT flag, code, description
1526 JOIN userflags ON (module_bit = bit)");
1530 while (my $perm = $sth->fetchrow_hashref) {
1531 $all_perms->{$perm->{'flag'}}->{$perm->{'code'}} = $perm->{'description'};
1536 =head2 haspermission
1538 $flags = ($userid, $flagsrequired);
1540 C<$userid> the userid of the member
1541 C<$flags> is a hashref of required flags like C<$borrower-<{authflags}>
1543 Returns member's flags or 0 if a permission is not met.
1548 my ($userid, $flagsrequired) = @_;
1549 my $sth = C4::Context->dbh->prepare("SELECT flags FROM borrowers WHERE userid=?");
1550 $sth->execute($userid);
1551 my $flags = getuserflags( $sth->fetchrow(), $userid );
1552 if ( $userid eq C4::Context->config('user') ) {
1553 # Super User Account from /etc/koha.conf
1554 $flags->{'superlibrarian'} = 1;
1556 elsif ( $userid eq 'demo' && C4::Context->config('demo') ) {
1557 # Demo user that can do "anything" (demo=1 in /etc/koha.conf)
1558 $flags->{'superlibrarian'} = 1;
1560 return $flags if $flags->{superlibrarian};
1561 foreach my $module ( keys %$flagsrequired ) {
1562 my $subperm = $flagsrequired->{$module};
1563 if ($subperm eq '*') {
1564 return 0 unless ( $flags->{$module} == 1 or ref($flags->{$module}) );
1566 return 0 unless ( $flags->{$module} == 1 or
1567 ( ref($flags->{$module}) and
1568 exists $flags->{$module}->{$subperm} and
1569 $flags->{$module}->{$subperm} == 1
1575 #FIXME - This fcn should return the failed permission so a suitable error msg can be delivered.
1579 sub getborrowernumber {
1581 my $userenv = C4::Context->userenv;
1582 if ( defined( $userenv ) && ref( $userenv ) eq 'HASH' && $userenv->{number} ) {
1583 return $userenv->{number};
1585 my $dbh = C4::Context->dbh;
1586 for my $field ( 'userid', 'cardnumber' ) {
1588 $dbh->prepare("select borrowernumber from borrowers where $field=?");
1589 $sth->execute($userid);
1591 my ($bnumber) = $sth->fetchrow;
1598 END { } # module clean-up code here (global destructor)