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/;
35 use List::MoreUtils qw/ any /;
38 use vars qw($VERSION @ISA @EXPORT @EXPORT_OK %EXPORT_TAGS $debug $ldap $cas $caslogout $servers $memcached);
41 sub psgi_env { any { /^psgi\./ } keys %ENV }
43 if ( psgi_env ) { die 'psgi:exit' }
47 $VERSION = 3.02; # set version for version checking
50 @EXPORT = qw(&checkauth &get_template_and_user &haspermission &get_user_subpermissions);
51 @EXPORT_OK = qw(&check_api_auth &get_session &check_cookie_auth &checkpw &get_all_subpermissions &get_user_subpermissions);
52 %EXPORT_TAGS = ( EditPermissions => [qw(get_all_subpermissions get_user_subpermissions)] );
53 $ldap = C4::Context->config('useldapserver') || 0;
54 $cas = C4::Context->preference('casAuthentication');
55 $caslogout = C4::Context->preference('casLogout');
56 require C4::Auth_with_cas; # no import
58 require C4::Auth_with_ldap;
59 # no import import C4::Auth_with_ldap qw(checkpw_ldap);
62 import C4::Auth_with_cas qw(check_api_auth_cas checkpw_cas login_cas logout_cas login_cas_url);
64 $servers = C4::Context->config('memcached_servers');
66 require Cache::Memcached;
67 $memcached = Cache::Memcached->new({
68 servers => [ $servers ],
70 compress_threshold => 10_000,
71 namespace => C4::Context->config('memcached_namespace') || 'koha',
78 C4::Auth - Authenticates Koha users
88 my ($template, $borrowernumber, $cookie)
89 = get_template_and_user(
91 template_name => "opac-main.tmpl",
95 flagsrequired => {borrow => 1, catalogue => '*', tools => 'import_patrons' },
99 output_html_with_http_headers $query, $cookie, $template->output;
103 The main function of this module is to provide
104 authentification. However the get_template_and_user function has
105 been provided so that a users login information is passed along
106 automatically. This gets loaded into the template.
110 =head2 get_template_and_user
112 my ($template, $borrowernumber, $cookie)
113 = get_template_and_user(
115 template_name => "opac-main.tmpl",
118 authnotrequired => 1,
119 flagsrequired => {borrow => 1, catalogue => '*', tools => 'import_patrons' },
123 This call passes the C<query>, C<flagsrequired> and C<authnotrequired>
124 to C<&checkauth> (in this module) to perform authentification.
125 See C<&checkauth> for an explanation of these parameters.
127 The C<template_name> is then used to find the correct template for
128 the page. The authenticated users details are loaded onto the
129 template in the HTML::Template LOOP variable C<USER_INFO>. Also the
130 C<sessionID> is passed to the template. This can be used in templates
131 if cookies are disabled. It needs to be put as and input to every
134 More information on the C<gettemplate> sub can be found in the
139 my $SEARCH_HISTORY_INSERT_SQL =<<EOQ;
140 INSERT INTO search_history(userid, sessionid, query_desc, query_cgi, limit_desc, limit_cgi, total, time )
141 VALUES ( ?, ?, ?, ?, ?, ?, ?, FROM_UNIXTIME(?))
143 sub get_template_and_user {
146 gettemplate( $in->{'template_name'}, $in->{'type'}, $in->{'query'} );
147 my ( $user, $cookie, $sessionID, $flags );
148 if ( $in->{'template_name'} !~m/maintenance/ ) {
149 ( $user, $cookie, $sessionID, $flags ) = checkauth(
151 $in->{'authnotrequired'},
152 $in->{'flagsrequired'},
158 my $insecure = C4::Context->preference('insecure');
159 if ($user or $insecure) {
161 # load the template variables for stylesheets and JavaScript
162 $template->param( css_libs => $in->{'css_libs'} );
163 $template->param( css_module => $in->{'css_module'} );
164 $template->param( css_page => $in->{'css_page'} );
165 $template->param( css_widgets => $in->{'css_widgets'} );
167 $template->param( js_libs => $in->{'js_libs'} );
168 $template->param( js_module => $in->{'js_module'} );
169 $template->param( js_page => $in->{'js_page'} );
170 $template->param( js_widgets => $in->{'js_widgets'} );
173 $template->param( loggedinusername => $user );
174 $template->param( sessionID => $sessionID );
176 my ($total, $pubshelves, $barshelves) = C4::Context->get_shelves_userenv();
177 if (defined($pubshelves)) {
178 $template->param( pubshelves => scalar @{$pubshelves},
179 pubshelvesloop => $pubshelves,
181 $template->param( pubtotal => $total->{'pubtotal'}, ) if ($total->{'pubtotal'} > scalar @{$pubshelves});
183 if (defined($barshelves)) {
184 $template->param( barshelves => scalar @{$barshelves},
185 barshelvesloop => $barshelves,
187 $template->param( bartotal => $total->{'bartotal'}, ) if ($total->{'bartotal'} > scalar @{$barshelves});
190 $borrowernumber = getborrowernumber($user) if defined($user);
192 my ( $borr ) = GetMemberDetails( $borrowernumber );
195 $template->param( "USER_INFO" => \@bordat );
197 my $all_perms = get_all_subpermissions();
199 my @flagroots = qw(circulate catalogue parameters borrowers permissions reserveforothers borrow
200 editcatalogue updatecharges management tools editauthorities serials reports acquisition);
201 # We are going to use the $flags returned by checkauth
202 # to create the template's parameters that will indicate
203 # which menus the user can access.
204 if (( $flags && $flags->{superlibrarian}==1) or $insecure==1) {
205 $template->param( CAN_user_circulate => 1 );
206 $template->param( CAN_user_catalogue => 1 );
207 $template->param( CAN_user_parameters => 1 );
208 $template->param( CAN_user_borrowers => 1 );
209 $template->param( CAN_user_permissions => 1 );
210 $template->param( CAN_user_reserveforothers => 1 );
211 $template->param( CAN_user_borrow => 1 );
212 $template->param( CAN_user_editcatalogue => 1 );
213 $template->param( CAN_user_updatecharges => 1 );
214 $template->param( CAN_user_acquisition => 1 );
215 $template->param( CAN_user_management => 1 );
216 $template->param( CAN_user_tools => 1 );
217 $template->param( CAN_user_editauthorities => 1 );
218 $template->param( CAN_user_serials => 1 );
219 $template->param( CAN_user_reports => 1 );
220 $template->param( CAN_user_staffaccess => 1 );
221 foreach my $module (keys %$all_perms) {
222 foreach my $subperm (keys %{ $all_perms->{$module} }) {
223 $template->param( "CAN_user_${module}_${subperm}" => 1 );
229 foreach my $module (keys %$all_perms) {
230 if ( $flags->{$module} == 1) {
231 foreach my $subperm (keys %{ $all_perms->{$module} }) {
232 $template->param( "CAN_user_${module}_${subperm}" => 1 );
234 } elsif ( ref($flags->{$module}) ) {
235 foreach my $subperm (keys %{ $flags->{$module} } ) {
236 $template->param( "CAN_user_${module}_${subperm}" => 1 );
243 foreach my $module (keys %$flags) {
244 if ( $flags->{$module} == 1 or ref($flags->{$module}) ) {
245 $template->param( "CAN_user_$module" => 1 );
246 if ($module eq "parameters") {
247 $template->param( CAN_user_management => 1 );
252 # Logged-in opac search history
253 # If the requested template is an opac one and opac search history is enabled
254 if ($in->{type} eq 'opac' && C4::Context->preference('EnableOpacSearchHistory')) {
255 my $dbh = C4::Context->dbh;
256 my $query = "SELECT COUNT(*) FROM search_history WHERE userid=?";
257 my $sth = $dbh->prepare($query);
258 $sth->execute($borrowernumber);
260 # If at least one search has already been performed
261 if ($sth->fetchrow_array > 0) {
262 # We show the link in opac
263 $template->param(ShowOpacRecentSearchLink => 1);
266 # And if there's a cookie with searches performed when the user was not logged in,
267 # we add them to the logged-in search history
268 my $searchcookie = $in->{'query'}->cookie('KohaOpacRecentSearches');
270 $searchcookie = uri_unescape($searchcookie);
271 my @recentSearches = @{thaw($searchcookie) || []};
272 if (@recentSearches) {
273 my $sth = $dbh->prepare($SEARCH_HISTORY_INSERT_SQL);
275 $sth->execute( $borrowernumber, $in->{'query'}->cookie("CGISESSID"), $_->{'query_desc'}, $_->{'query_cgi'}, $_->{'limit_desc'}, $_->{'limit_cgi'}, $_->{'total'}, $_->{'time'}, )
276 foreach @recentSearches;
278 # And then, delete the cookie's content
279 my $newsearchcookie = $in->{'query'}->cookie(
280 -name => 'KohaOpacRecentSearches',
281 -value => freeze([]),
284 $cookie = [$cookie, $newsearchcookie];
289 else { # if this is an anonymous session, setup to display public lists...
291 # load the template variables for stylesheets and JavaScript
292 $template->param( css_libs => $in->{'css_libs'} );
293 $template->param( css_module => $in->{'css_module'} );
294 $template->param( css_page => $in->{'css_page'} );
295 $template->param( css_widgets => $in->{'css_widgets'} );
297 $template->param( js_libs => $in->{'js_libs'} );
298 $template->param( js_module => $in->{'js_module'} );
299 $template->param( js_page => $in->{'js_page'} );
300 $template->param( js_widgets => $in->{'js_widgets'} );
302 $template->param( sessionID => $sessionID );
304 my ($total, $pubshelves) = C4::Context->get_shelves_userenv(); # an anonymous user has no 'barshelves'...
305 if (defined $pubshelves) {
306 $template->param( pubshelves => scalar @{$pubshelves},
307 pubshelvesloop => $pubshelves,
309 $template->param( pubtotal => $total->{'pubtotal'}, ) if ($total->{'pubtotal'} > scalar @{$pubshelves});
313 # Anonymous opac search history
314 # If opac search history is enabled and at least one search has already been performed
315 if (C4::Context->preference('EnableOpacSearchHistory')) {
316 my $searchcookie = $in->{'query'}->cookie('KohaOpacRecentSearches');
318 $searchcookie = uri_unescape($searchcookie);
319 my @recentSearches = @{thaw($searchcookie) || []};
320 # We show the link in opac
321 if (@recentSearches) {
322 $template->param(ShowOpacRecentSearchLink => 1);
327 if(C4::Context->preference('dateformat')){
328 if(C4::Context->preference('dateformat') eq "metric"){
329 $template->param(dateformat_metric => 1);
330 } elsif(C4::Context->preference('dateformat') eq "us"){
331 $template->param(dateformat_us => 1);
333 $template->param(dateformat_iso => 1);
336 $template->param(dateformat_iso => 1);
339 # these template parameters are set the same regardless of $in->{'type'}
341 "BiblioDefaultView".C4::Context->preference("BiblioDefaultView") => 1,
342 EnhancedMessagingPreferences => C4::Context->preference('EnhancedMessagingPreferences'),
343 GoogleJackets => C4::Context->preference("GoogleJackets"),
344 OpenLibraryCovers => C4::Context->preference("OpenLibraryCovers"),
345 KohaAdminEmailAddress => "" . C4::Context->preference("KohaAdminEmailAddress"),
346 LoginBranchcode => (C4::Context->userenv?C4::Context->userenv->{"branch"}:"insecure"),
347 LoginFirstname => (C4::Context->userenv?C4::Context->userenv->{"firstname"}:"Bel"),
348 LoginSurname => C4::Context->userenv?C4::Context->userenv->{"surname"}:"Inconnu",
349 TagsEnabled => C4::Context->preference("TagsEnabled"),
350 hide_marc => C4::Context->preference("hide_marc"),
351 item_level_itypes => C4::Context->preference('item-level_itypes'),
352 patronimages => C4::Context->preference("patronimages"),
353 singleBranchMode => C4::Context->preference("singleBranchMode"),
354 XSLTDetailsDisplay => C4::Context->preference("XSLTDetailsDisplay"),
355 XSLTResultsDisplay => C4::Context->preference("XSLTResultsDisplay"),
356 using_https => $in->{'query'}->https() ? 1 : 0,
357 noItemTypeImages => C4::Context->preference("noItemTypeImages"),
360 if ( $in->{'type'} eq "intranet" ) {
362 AmazonContent => C4::Context->preference("AmazonContent"),
363 AmazonCoverImages => C4::Context->preference("AmazonCoverImages"),
364 AmazonEnabled => C4::Context->preference("AmazonEnabled"),
365 AmazonSimilarItems => C4::Context->preference("AmazonSimilarItems"),
366 AutoLocation => C4::Context->preference("AutoLocation"),
367 "BiblioDefaultView".C4::Context->preference("IntranetBiblioDefaultView") => 1,
368 CircAutocompl => C4::Context->preference("CircAutocompl"),
369 FRBRizeEditions => C4::Context->preference("FRBRizeEditions"),
370 IndependantBranches => C4::Context->preference("IndependantBranches"),
371 IntranetNav => C4::Context->preference("IntranetNav"),
372 IntranetmainUserblock => C4::Context->preference("IntranetmainUserblock"),
373 LibraryName => C4::Context->preference("LibraryName"),
374 LoginBranchname => (C4::Context->userenv?C4::Context->userenv->{"branchname"}:"insecure"),
375 advancedMARCEditor => C4::Context->preference("advancedMARCEditor"),
376 canreservefromotherbranches => C4::Context->preference('canreservefromotherbranches'),
377 intranetcolorstylesheet => C4::Context->preference("intranetcolorstylesheet"),
378 IntranetFavicon => C4::Context->preference("IntranetFavicon"),
379 intranetreadinghistory => C4::Context->preference("intranetreadinghistory"),
380 intranetstylesheet => C4::Context->preference("intranetstylesheet"),
381 IntranetUserCSS => C4::Context->preference("IntranetUserCSS"),
382 intranetuserjs => C4::Context->preference("intranetuserjs"),
383 intranetbookbag => C4::Context->preference("intranetbookbag"),
384 suggestion => C4::Context->preference("suggestion"),
385 virtualshelves => C4::Context->preference("virtualshelves"),
386 StaffSerialIssueDisplayCount => C4::Context->preference("StaffSerialIssueDisplayCount"),
387 NoZebra => C4::Context->preference('NoZebra'),
391 warn "template type should be OPAC, here it is=[" . $in->{'type'} . "]" unless ( $in->{'type'} eq 'opac' );
392 #TODO : replace LibraryName syspref with 'system name', and remove this html processing
393 my $LibraryNameTitle = C4::Context->preference("LibraryName");
394 $LibraryNameTitle =~ s/<(?:\/?)(?:br|p)\s*(?:\/?)>/ /sgi;
395 $LibraryNameTitle =~ s/<(?:[^<>'"]|'(?:[^']*)'|"(?:[^"]*)")*>//sg;
396 # variables passed from CGI: opac_css_override and opac_search_limits.
397 my $opac_search_limit = $ENV{'OPAC_SEARCH_LIMIT'};
398 my $opac_limit_override = $ENV{'OPAC_LIMIT_OVERRIDE'};
400 if (($opac_search_limit =~ /branch:(\w+)/ && $opac_limit_override) || $in->{'query'}->param('limit') =~ /branch:(\w+)/){
401 $opac_name = $1; # opac_search_limit is a branch, so we use it.
402 } elsif (C4::Context->preference("SearchMyLibraryFirst") && C4::Context->userenv && C4::Context->userenv->{'branch'}) {
403 $opac_name = C4::Context->userenv->{'branch'};
405 my $checkstyle = C4::Context->preference("opaccolorstylesheet");
406 if ($checkstyle =~ /http/)
408 $template->param( opacexternalsheet => $checkstyle);
411 my $opaccolorstylesheet = C4::Context->preference("opaccolorstylesheet");
412 $template->param( opaccolorstylesheet => $opaccolorstylesheet);
415 AmazonContent => "" . C4::Context->preference("AmazonContent"),
416 AnonSuggestions => "" . C4::Context->preference("AnonSuggestions"),
417 AuthorisedValueImages => C4::Context->preference("AuthorisedValueImages"),
418 BranchesLoop => GetBranchesLoop($opac_name),
419 LibraryName => "" . C4::Context->preference("LibraryName"),
420 LibraryNameTitle => "" . $LibraryNameTitle,
421 LoginBranchname => C4::Context->userenv?C4::Context->userenv->{"branchname"}:"",
422 OPACAmazonEnabled => C4::Context->preference("OPACAmazonEnabled"),
423 OPACAmazonSimilarItems => C4::Context->preference("OPACAmazonSimilarItems"),
424 OPACAmazonCoverImages => C4::Context->preference("OPACAmazonCoverImages"),
425 OPACAmazonReviews => C4::Context->preference("OPACAmazonReviews"),
426 OPACFRBRizeEditions => C4::Context->preference("OPACFRBRizeEditions"),
427 OpacHighlightedWords => C4::Context->preference("OpacHighlightedWords"),
428 OPACItemHolds => C4::Context->preference("OPACItemHolds"),
429 OPACShelfBrowser => "". C4::Context->preference("OPACShelfBrowser"),
430 OPACURLOpenInNewWindow => "" . C4::Context->preference("OPACURLOpenInNewWindow"),
431 OPACUserCSS => "". C4::Context->preference("OPACUserCSS"),
432 OPACViewOthersSuggestions => "" . C4::Context->preference("OPACViewOthersSuggestions"),
433 OpacAuthorities => C4::Context->preference("OpacAuthorities"),
434 OPACBaseURL => ($in->{'query'}->https() ? "https://" : "http://") . $ENV{'SERVER_NAME'} .
435 ($ENV{'SERVER_PORT'} eq ($in->{'query'}->https() ? "443" : "80") ? '' : ":$ENV{'SERVER_PORT'}"),
436 opac_css_override => $ENV{'OPAC_CSS_OVERRIDE'},
437 opac_search_limit => $opac_search_limit,
438 opac_limit_override => $opac_limit_override,
439 OpacBrowser => C4::Context->preference("OpacBrowser"),
440 OpacCloud => C4::Context->preference("OpacCloud"),
441 OpacMainUserBlock => "" . C4::Context->preference("OpacMainUserBlock"),
442 OpacNav => "" . C4::Context->preference("OpacNav"),
443 OpacPasswordChange => C4::Context->preference("OpacPasswordChange"),
444 OPACPatronDetails => C4::Context->preference("OPACPatronDetails"),
445 OPACPrivacy => C4::Context->preference("OPACPrivacy"),
446 OPACFinesTab => C4::Context->preference("OPACFinesTab"),
447 OpacTopissue => C4::Context->preference("OpacTopissue"),
448 RequestOnOpac => C4::Context->preference("RequestOnOpac"),
449 'Version' => C4::Context->preference('Version'),
450 hidelostitems => C4::Context->preference("hidelostitems"),
451 mylibraryfirst => (C4::Context->preference("SearchMyLibraryFirst") && C4::Context->userenv) ? C4::Context->userenv->{'branch'} : '',
452 opaclayoutstylesheet => "" . C4::Context->preference("opaclayoutstylesheet"),
453 opacstylesheet => "" . C4::Context->preference("opacstylesheet"),
454 opacbookbag => "" . C4::Context->preference("opacbookbag"),
455 opaccredits => "" . C4::Context->preference("opaccredits"),
456 OpacFavicon => C4::Context->preference("OpacFavicon"),
457 opacheader => "" . C4::Context->preference("opacheader"),
458 opaclanguagesdisplay => "" . C4::Context->preference("opaclanguagesdisplay"),
459 opacreadinghistory => C4::Context->preference("opacreadinghistory"),
460 opacsmallimage => "" . C4::Context->preference("opacsmallimage"),
461 opacuserjs => C4::Context->preference("opacuserjs"),
462 opacuserlogin => "" . C4::Context->preference("opacuserlogin"),
463 reviewson => C4::Context->preference("reviewson"),
464 ShowReviewer => C4::Context->preference("ShowReviewer"),
465 ShowReviewerPhoto => C4::Context->preference("ShowReviewerPhoto"),
466 suggestion => "" . C4::Context->preference("suggestion"),
467 virtualshelves => "" . C4::Context->preference("virtualshelves"),
468 OPACSerialIssueDisplayCount => C4::Context->preference("OPACSerialIssueDisplayCount"),
469 OpacAddMastheadLibraryPulldown => C4::Context->preference("OpacAddMastheadLibraryPulldown"),
470 OPACXSLTDetailsDisplay => C4::Context->preference("OPACXSLTDetailsDisplay"),
471 OPACXSLTResultsDisplay => C4::Context->preference("OPACXSLTResultsDisplay"),
472 SyndeticsClientCode => C4::Context->preference("SyndeticsClientCode"),
473 SyndeticsEnabled => C4::Context->preference("SyndeticsEnabled"),
474 SyndeticsCoverImages => C4::Context->preference("SyndeticsCoverImages"),
475 SyndeticsTOC => C4::Context->preference("SyndeticsTOC"),
476 SyndeticsSummary => C4::Context->preference("SyndeticsSummary"),
477 SyndeticsEditions => C4::Context->preference("SyndeticsEditions"),
478 SyndeticsExcerpt => C4::Context->preference("SyndeticsExcerpt"),
479 SyndeticsReviews => C4::Context->preference("SyndeticsReviews"),
480 SyndeticsAuthorNotes => C4::Context->preference("SyndeticsAuthorNotes"),
481 SyndeticsAwards => C4::Context->preference("SyndeticsAwards"),
482 SyndeticsSeries => C4::Context->preference("SyndeticsSeries"),
483 SyndeticsCoverImageSize => C4::Context->preference("SyndeticsCoverImageSize"),
486 $template->param(OpacPublic => '1') if ($user || C4::Context->preference("OpacPublic"));
488 $template->param(listloop=>[{shelfname=>"Freelist", shelfnumber=>110}]);
489 return ( $template, $borrowernumber, $cookie, $flags);
494 ($userid, $cookie, $sessionID) = &checkauth($query, $noauth, $flagsrequired, $type);
496 Verifies that the user is authorized to run this script. If
497 the user is authorized, a (userid, cookie, session-id, flags)
498 quadruple is returned. If the user is not authorized but does
499 not have the required privilege (see $flagsrequired below), it
500 displays an error page and exits. Otherwise, it displays the
501 login page and exits.
503 Note that C<&checkauth> will return if and only if the user
504 is authorized, so it should be called early on, before any
505 unfinished operations (e.g., if you've opened a file, then
506 C<&checkauth> won't close it for you).
508 C<$query> is the CGI object for the script calling C<&checkauth>.
510 The C<$noauth> argument is optional. If it is set, then no
511 authorization is required for the script.
513 C<&checkauth> fetches user and session information from C<$query> and
514 ensures that the user is authorized to run scripts that require
517 The C<$flagsrequired> argument specifies the required privileges
518 the user must have if the username and password are correct.
519 It should be specified as a reference-to-hash; keys in the hash
520 should be the "flags" for the user, as specified in the Members
521 intranet module. Any key specified must correspond to a "flag"
522 in the userflags table. E.g., { circulate => 1 } would specify
523 that the user must have the "circulate" privilege in order to
524 proceed. To make sure that access control is correct, the
525 C<$flagsrequired> parameter must be specified correctly.
527 Koha also has a concept of sub-permissions, also known as
528 granular permissions. This makes the value of each key
529 in the C<flagsrequired> hash take on an additional
534 The user must have access to all subfunctions of the module
535 specified by the hash key.
539 The user must have access to at least one subfunction of the module
540 specified by the hash key.
542 specific permission, e.g., 'export_catalog'
544 The user must have access to the specific subfunction list, which
545 must correspond to a row in the permissions table.
547 The C<$type> argument specifies whether the template should be
548 retrieved from the opac or intranet directory tree. "opac" is
549 assumed if it is not specified; however, if C<$type> is specified,
550 "intranet" is assumed if it is not "opac".
552 If C<$query> does not have a valid session ID associated with it
553 (i.e., the user has not logged in) or if the session has expired,
554 C<&checkauth> presents the user with a login page (from the point of
555 view of the original script, C<&checkauth> does not return). Once the
556 user has authenticated, C<&checkauth> restarts the original script
557 (this time, C<&checkauth> returns).
559 The login page is provided using a HTML::Template, which is set in the
560 systempreferences table or at the top of this file. The variable C<$type>
561 selects which template to use, either the opac or the intranet
562 authentification template.
564 C<&checkauth> returns a user ID, a cookie, and a session ID. The
565 cookie should be sent back to the browser; it verifies that the user
570 sub _version_check ($$) {
574 # If Version syspref is unavailable, it means Koha is beeing installed,
575 # and so we must redirect to OPAC maintenance page or to the WebInstaller
576 # also, if OpacMaintenance is ON, OPAC should redirect to maintenance
577 if (C4::Context->preference('OpacMaintenance') && $type eq 'opac') {
578 warn "OPAC Install required, redirecting to maintenance";
579 print $query->redirect("/cgi-bin/koha/maintenance.pl");
581 unless ( $version = C4::Context->preference('Version') ) { # assignment, not comparison
582 if ( $type ne 'opac' ) {
583 warn "Install required, redirecting to Installer";
584 print $query->redirect("/cgi-bin/koha/installer/install.pl");
586 warn "OPAC Install required, redirecting to maintenance";
587 print $query->redirect("/cgi-bin/koha/maintenance.pl");
592 # check that database and koha version are the same
593 # there is no DB version, it's a fresh install,
594 # go to web installer
595 # there is a DB version, compare it to the code version
596 my $kohaversion=C4::Context::KOHAVERSION;
597 # remove the 3 last . to have a Perl number
598 $kohaversion =~ s/(.*\..*)\.(.*)\.(.*)/$1$2$3/;
599 $debug and print STDERR "kohaversion : $kohaversion\n";
600 if ($version < $kohaversion){
601 my $warning = "Database update needed, redirecting to %s. Database is $version and Koha is $kohaversion";
602 if ($type ne 'opac'){
603 warn sprintf($warning, 'Installer');
604 print $query->redirect("/cgi-bin/koha/installer/install.pl?step=3");
606 warn sprintf("OPAC: " . $warning, 'maintenance');
607 print $query->redirect("/cgi-bin/koha/maintenance.pl");
615 open L, ">>/tmp/sessionlog" or warn "ERROR: Cannot append to /tmp/sessionlog";
616 printf L join("\n",@_);
622 $debug and warn "Checking Auth";
623 # $authnotrequired will be set for scripts which will run without authentication
624 my $authnotrequired = shift;
625 my $flagsrequired = shift;
627 $type = 'opac' unless $type;
629 my $dbh = C4::Context->dbh;
630 my $timeout = C4::Context->preference('timeout');
632 if ($timeout =~ /(\d+)[dD]/) {
633 $timeout = $1 * 86400;
635 $timeout = 600 unless $timeout;
637 _version_check($type,$query);
641 my ( $userid, $cookie, $sessionID, $flags, $barshelves, $pubshelves );
642 my $logout = $query->param('logout.x');
644 # This parameter is the name of the CAS server we want to authenticate against,
645 # when using authentication against multiple CAS servers, as configured in Auth_cas_servers.yaml
646 my $casparam = $query->param('cas');
648 if ( $userid = $ENV{'REMOTE_USER'} ) {
649 # Using Basic Authentication, no cookies required
650 $cookie = $query->cookie(
651 -name => 'CGISESSID',
657 elsif ( $sessionID = $query->cookie("CGISESSID")) { # assignment, not comparison
658 my $session = get_session($sessionID);
659 C4::Context->_new_userenv($sessionID);
660 my ($ip, $lasttime, $sessiontype);
662 C4::Context::set_userenv(
663 $session->param('number'), $session->param('id'),
664 $session->param('cardnumber'), $session->param('firstname'),
665 $session->param('surname'), $session->param('branch'),
666 $session->param('branchname'), $session->param('flags'),
667 $session->param('emailaddress'), $session->param('branchprinter')
669 C4::Context::set_shelves_userenv('bar',$session->param('barshelves'));
670 C4::Context::set_shelves_userenv('pub',$session->param('pubshelves'));
671 C4::Context::set_shelves_userenv('tot',$session->param('totshelves'));
672 $debug and printf STDERR "AUTH_SESSION: (%s)\t%s %s - %s\n", map {$session->param($_)} qw(cardnumber firstname surname branch) ;
673 $ip = $session->param('ip');
674 $lasttime = $session->param('lasttime');
675 $userid = $session->param('id');
676 $sessiontype = $session->param('sessiontype');
678 if ( ($query->param('koha_login_context')) && ($query->param('userid') ne $session->param('id')) ) {
679 #if a user enters an id ne to the id in the current session, we need to log them in...
680 #first we need to clear the anonymous session...
681 $debug and warn "query id = " . $query->param('userid') . " but session id = " . $session->param('id');
684 C4::Context->_unset_userenv($sessionID);
689 # voluntary logout the user
692 C4::Context->_unset_userenv($sessionID);
693 _session_log(sprintf "%20s from %16s logged out at %30s (manually).\n", $userid,$ip,(strftime "%c",localtime));
697 if ($cas and $caslogout) {
701 elsif ( $lasttime < time() - $timeout ) {
703 $info{'timed_out'} = 1;
705 C4::Context->_unset_userenv($sessionID);
706 _session_log(sprintf "%20s from %16s logged out at %30s (inactivity).\n", $userid,$ip,(strftime "%c",localtime));
710 elsif ( $ip ne $ENV{'REMOTE_ADDR'} ) {
711 # Different ip than originally logged in from
712 $info{'oldip'} = $ip;
713 $info{'newip'} = $ENV{'REMOTE_ADDR'};
714 $info{'different_ip'} = 1;
716 C4::Context->_unset_userenv($sessionID);
717 _session_log(sprintf "%20s from %16s logged out at %30s (ip changed to %16s).\n", $userid,$ip,(strftime "%c",localtime), $info{'newip'});
722 $cookie = $query->cookie( CGISESSID => $session->id );
723 $session->param('lasttime',time());
724 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...
725 $flags = haspermission($userid, $flagsrequired);
729 $info{'nopermission'} = 1;
734 unless ($userid || $sessionID) {
735 #we initiate a session prior to checking for a username to allow for anonymous sessions...
736 my $session = get_session("") or die "Auth ERROR: Cannot get_session()";
737 my $sessionID = $session->id;
738 C4::Context->_new_userenv($sessionID);
739 $cookie = $query->cookie(CGISESSID => $sessionID);
740 $userid = $query->param('userid');
741 if ($cas || $userid) {
742 my $password = $query->param('password');
743 my ($return, $cardnumber);
744 if ($cas && $query->param('ticket')) {
746 ( $return, $cardnumber, $retuserid ) = checkpw( $dbh, $userid, $password, $query );
747 $userid = $retuserid;
748 $info{'invalidCasLogin'} = 1 unless ($return);
751 ( $return, $retuserid ) = checkpw( $dbh, $userid, $password, $query );
752 $userid = $retuserid if ($retuserid ne '');
755 _session_log(sprintf "%20s from %16s logged in at %30s.\n", $userid,$ENV{'REMOTE_ADDR'},(strftime '%c', localtime));
756 if ( $flags = haspermission( $userid, $flagsrequired ) ) {
760 $info{'nopermission'} = 1;
761 C4::Context->_unset_userenv($sessionID);
764 my ($borrowernumber, $firstname, $surname, $userflags,
765 $branchcode, $branchname, $branchprinter, $emailaddress);
767 if ( $return == 1 ) {
769 SELECT borrowernumber, firstname, surname, flags, borrowers.branchcode,
770 branches.branchname as branchname,
771 branches.branchprinter as branchprinter,
774 LEFT JOIN branches on borrowers.branchcode=branches.branchcode
776 my $sth = $dbh->prepare("$select where userid=?");
777 $sth->execute($userid);
778 unless ($sth->rows) {
779 $debug and print STDERR "AUTH_1: no rows for userid='$userid'\n";
780 $sth = $dbh->prepare("$select where cardnumber=?");
781 $sth->execute($cardnumber);
783 unless ($sth->rows) {
784 $debug and print STDERR "AUTH_2a: no rows for cardnumber='$cardnumber'\n";
785 $sth->execute($userid);
786 unless ($sth->rows) {
787 $debug and print STDERR "AUTH_2b: no rows for userid='$userid' AS cardnumber\n";
792 ($borrowernumber, $firstname, $surname, $userflags,
793 $branchcode, $branchname, $branchprinter, $emailaddress) = $sth->fetchrow;
794 $debug and print STDERR "AUTH_3 results: " .
795 "$cardnumber,$borrowernumber,$userid,$firstname,$surname,$userflags,$branchcode,$emailaddress\n";
797 print STDERR "AUTH_3: no results for userid='$userid', cardnumber='$cardnumber'.\n";
800 # launch a sequence to check if we have a ip for the branch, i
801 # if we have one we replace the branchcode of the userenv by the branch bound in the ip.
803 my $ip = $ENV{'REMOTE_ADDR'};
804 # if they specify at login, use that
805 if ($query->param('branch')) {
806 $branchcode = $query->param('branch');
807 $branchname = GetBranchName($branchcode);
809 my $branches = GetBranches();
810 if (C4::Context->boolean_preference('IndependantBranches') && C4::Context->boolean_preference('Autolocation')){
811 # we have to check they are coming from the right ip range
812 my $domain = $branches->{$branchcode}->{'branchip'};
813 if ($ip !~ /^$domain/){
815 $info{'wrongip'} = 1;
820 foreach my $br ( keys %$branches ) {
821 # now we work with the treatment of ip
822 my $domain = $branches->{$br}->{'branchip'};
823 if ( $domain && $ip =~ /^$domain/ ) {
824 $branchcode = $branches->{$br}->{'branchcode'};
826 # new op dev : add the branchprinter and branchname in the cookie
827 $branchprinter = $branches->{$br}->{'branchprinter'};
828 $branchname = $branches->{$br}->{'branchname'};
831 $session->param('number',$borrowernumber);
832 $session->param('id',$userid);
833 $session->param('cardnumber',$cardnumber);
834 $session->param('firstname',$firstname);
835 $session->param('surname',$surname);
836 $session->param('branch',$branchcode);
837 $session->param('branchname',$branchname);
838 $session->param('flags',$userflags);
839 $session->param('emailaddress',$emailaddress);
840 $session->param('ip',$session->remote_addr());
841 $session->param('lasttime',time());
842 $debug and printf STDERR "AUTH_4: (%s)\t%s %s - %s\n", map {$session->param($_)} qw(cardnumber firstname surname branch) ;
844 elsif ( $return == 2 ) {
845 #We suppose the user is the superlibrarian
847 $session->param('number',0);
848 $session->param('id',C4::Context->config('user'));
849 $session->param('cardnumber',C4::Context->config('user'));
850 $session->param('firstname',C4::Context->config('user'));
851 $session->param('surname',C4::Context->config('user'));
852 $session->param('branch','NO_LIBRARY_SET');
853 $session->param('branchname','NO_LIBRARY_SET');
854 $session->param('flags',1);
855 $session->param('emailaddress', C4::Context->preference('KohaAdminEmailAddress'));
856 $session->param('ip',$session->remote_addr());
857 $session->param('lasttime',time());
859 C4::Context::set_userenv(
860 $session->param('number'), $session->param('id'),
861 $session->param('cardnumber'), $session->param('firstname'),
862 $session->param('surname'), $session->param('branch'),
863 $session->param('branchname'), $session->param('flags'),
864 $session->param('emailaddress'), $session->param('branchprinter')
867 # Grab borrower's shelves and public shelves and add them to the session
868 # $row_count determines how many records are returned from the db query
869 # and the number of lists to be displayed of each type in the 'Lists' button drop down
870 my $row_count = 10; # FIXME:This probably should be a syspref
871 my ($total, $totshelves, $barshelves, $pubshelves);
872 ($barshelves, $totshelves) = C4::VirtualShelves::GetRecentShelves(1, $row_count, $borrowernumber);
873 $total->{'bartotal'} = $totshelves;
874 ($pubshelves, $totshelves) = C4::VirtualShelves::GetRecentShelves(2, $row_count, undef);
875 $total->{'pubtotal'} = $totshelves;
876 $session->param('barshelves', $barshelves);
877 $session->param('pubshelves', $pubshelves);
878 $session->param('totshelves', $total);
880 C4::Context::set_shelves_userenv('bar',$barshelves);
881 C4::Context::set_shelves_userenv('pub',$pubshelves);
882 C4::Context::set_shelves_userenv('tot',$total);
886 $info{'invalid_username_or_password'} = 1;
887 C4::Context->_unset_userenv($sessionID);
890 } # END if ( $userid = $query->param('userid') )
891 elsif ($type eq "opac") {
892 # if we are here this is an anonymous session; add public lists to it and a few other items...
893 # anonymous sessions are created only for the OPAC
894 $debug and warn "Initiating an anonymous session...";
896 # Grab the public shelves and add to the session...
897 my $row_count = 20; # FIXME:This probably should be a syspref
898 my ($total, $totshelves, $pubshelves);
899 ($pubshelves, $totshelves) = C4::VirtualShelves::GetRecentShelves(2, $row_count, undef);
900 $total->{'pubtotal'} = $totshelves;
901 $session->param('pubshelves', $pubshelves);
902 $session->param('totshelves', $total);
903 C4::Context::set_shelves_userenv('pub',$pubshelves);
904 C4::Context::set_shelves_userenv('tot',$total);
906 # setting a couple of other session vars...
907 $session->param('ip',$session->remote_addr());
908 $session->param('lasttime',time());
909 $session->param('sessiontype','anon');
911 } # END unless ($userid)
912 my $insecure = C4::Context->boolean_preference('insecure');
914 # finished authentification, now respond
915 if ( $loggedin || $authnotrequired || ( defined($insecure) && $insecure ) )
919 $cookie = $query->cookie( CGISESSID => '' );
921 return ( $userid, $cookie, $sessionID, $flags );
926 # AUTH rejected, show the login/password template, after checking the DB.
930 # get the inputs from the incoming query
932 foreach my $name ( param $query) {
933 (next) if ( $name eq 'userid' || $name eq 'password' || $name eq 'ticket' );
934 my $value = $query->param($name);
935 push @inputs, { name => $name, value => $value };
937 # get the branchloop, which we need for authentication
938 my $branches = GetBranches();
940 for my $branch_hash (sort keys %$branches) {
941 push @branch_loop, {branchcode => "$branch_hash", branchname => $branches->{$branch_hash}->{'branchname'}, };
944 my $template_name = ( $type eq 'opac' ) ? 'opac-auth.tmpl' : 'auth.tmpl';
945 my $template = gettemplate( $template_name, $type, $query );
946 $template->param(branchloop => \@branch_loop,);
947 my $checkstyle = C4::Context->preference("opaccolorstylesheet");
948 if ($checkstyle =~ /\//)
950 $template->param( opacexternalsheet => $checkstyle);
953 my $opaccolorstylesheet = C4::Context->preference("opaccolorstylesheet");
954 $template->param( opaccolorstylesheet => $opaccolorstylesheet);
959 casAuthentication => C4::Context->preference("casAuthentication"),
960 suggestion => C4::Context->preference("suggestion"),
961 virtualshelves => C4::Context->preference("virtualshelves"),
962 LibraryName => C4::Context->preference("LibraryName"),
963 opacuserlogin => C4::Context->preference("opacuserlogin"),
964 OpacNav => C4::Context->preference("OpacNav"),
965 opaccredits => C4::Context->preference("opaccredits"),
966 OpacFavicon => C4::Context->preference("OpacFavicon"),
967 opacreadinghistory => C4::Context->preference("opacreadinghistory"),
968 opacsmallimage => C4::Context->preference("opacsmallimage"),
969 opaclayoutstylesheet => C4::Context->preference("opaclayoutstylesheet"),
970 opaclanguagesdisplay => C4::Context->preference("opaclanguagesdisplay"),
971 opacuserjs => C4::Context->preference("opacuserjs"),
972 opacbookbag => "" . C4::Context->preference("opacbookbag"),
973 OpacCloud => C4::Context->preference("OpacCloud"),
974 OpacTopissue => C4::Context->preference("OpacTopissue"),
975 OpacAuthorities => C4::Context->preference("OpacAuthorities"),
976 OpacBrowser => C4::Context->preference("OpacBrowser"),
977 opacheader => C4::Context->preference("opacheader"),
978 TagsEnabled => C4::Context->preference("TagsEnabled"),
979 OPACUserCSS => C4::Context->preference("OPACUserCSS"),
980 opacstylesheet => C4::Context->preference("opacstylesheet"),
981 intranetcolorstylesheet =>
982 C4::Context->preference("intranetcolorstylesheet"),
983 intranetstylesheet => C4::Context->preference("intranetstylesheet"),
984 intranetbookbag => C4::Context->preference("intranetbookbag"),
985 IntranetNav => C4::Context->preference("IntranetNav"),
986 intranetuserjs => C4::Context->preference("intranetuserjs"),
987 IndependantBranches=> C4::Context->preference("IndependantBranches"),
988 AutoLocation => C4::Context->preference("AutoLocation"),
989 wrongip => $info{'wrongip'},
992 $template->param( OpacPublic => C4::Context->preference("OpacPublic"));
993 $template->param( loginprompt => 1 ) unless $info{'nopermission'};
997 # Is authentication against multiple CAS servers enabled?
998 if (C4::Auth_with_cas::multipleAuth && !$casparam) {
999 my $casservers = C4::Auth_with_cas::getMultipleAuth();
1001 foreach my $key (keys %$casservers) {
1002 push @tmplservers, {name => $key, value => login_cas_url($query, $key) . "?cas=$key" };
1004 #warn Data::Dumper::Dumper(\@tmplservers);
1006 casServersLoop => \@tmplservers
1010 casServerUrl => login_cas_url($query),
1015 invalidCasLogin => $info{'invalidCasLogin'}
1019 my $self_url = $query->url( -absolute => 1 );
1022 LibraryName => C4::Context->preference("LibraryName"),
1024 $template->param( %info );
1025 # $cookie = $query->cookie(CGISESSID => $session->id
1027 print $query->header(
1028 -type => 'text/html',
1029 -charset => 'utf-8',
1036 =head2 check_api_auth
1038 ($status, $cookie, $sessionId) = check_api_auth($query, $userflags);
1040 Given a CGI query containing the parameters 'userid' and 'password' and/or a session
1041 cookie, determine if the user has the privileges specified by C<$userflags>.
1043 C<check_api_auth> is is meant for authenticating users of web services, and
1044 consequently will always return and will not attempt to redirect the user
1047 If a valid session cookie is already present, check_api_auth will return a status
1048 of "ok", the cookie, and the Koha session ID.
1050 If no session cookie is present, check_api_auth will check the 'userid' and 'password
1051 parameters and create a session cookie and Koha session if the supplied credentials
1054 Possible return values in C<$status> are:
1058 =item "ok" -- user authenticated; C<$cookie> and C<$sessionid> have valid values.
1060 =item "failed" -- credentials are not correct; C<$cookie> and C<$sessionid> are undef
1062 =item "maintenance" -- DB is in maintenance mode; no login possible at the moment
1064 =item "expired -- session cookie has expired; API user should resubmit userid and password
1070 sub check_api_auth {
1072 my $flagsrequired = shift;
1074 my $dbh = C4::Context->dbh;
1075 my $timeout = C4::Context->preference('timeout');
1076 $timeout = 600 unless $timeout;
1078 unless (C4::Context->preference('Version')) {
1079 # database has not been installed yet
1080 return ("maintenance", undef, undef);
1082 my $kohaversion=C4::Context::KOHAVERSION;
1083 $kohaversion =~ s/(.*\..*)\.(.*)\.(.*)/$1$2$3/;
1084 if (C4::Context->preference('Version') < $kohaversion) {
1085 # database in need of version update; assume that
1086 # no API should be called while databsae is in
1088 return ("maintenance", undef, undef);
1091 # FIXME -- most of what follows is a copy-and-paste
1092 # of code from checkauth. There is an obvious need
1093 # for refactoring to separate the various parts of
1094 # the authentication code, but as of 2007-11-19 this
1095 # is deferred so as to not introduce bugs into the
1096 # regular authentication code for Koha 3.0.
1098 # see if we have a valid session cookie already
1099 # however, if a userid parameter is present (i.e., from
1100 # a form submission, assume that any current cookie
1102 my $sessionID = undef;
1103 unless ($query->param('userid')) {
1104 $sessionID = $query->cookie("CGISESSID");
1106 if ($sessionID && not $cas) {
1107 my $session = get_session($sessionID);
1108 C4::Context->_new_userenv($sessionID);
1110 C4::Context::set_userenv(
1111 $session->param('number'), $session->param('id'),
1112 $session->param('cardnumber'), $session->param('firstname'),
1113 $session->param('surname'), $session->param('branch'),
1114 $session->param('branchname'), $session->param('flags'),
1115 $session->param('emailaddress'), $session->param('branchprinter')
1118 my $ip = $session->param('ip');
1119 my $lasttime = $session->param('lasttime');
1120 my $userid = $session->param('id');
1121 if ( $lasttime < time() - $timeout ) {
1124 C4::Context->_unset_userenv($sessionID);
1127 return ("expired", undef, undef);
1128 } elsif ( $ip ne $ENV{'REMOTE_ADDR'} ) {
1129 # IP address changed
1131 C4::Context->_unset_userenv($sessionID);
1134 return ("expired", undef, undef);
1136 my $cookie = $query->cookie( CGISESSID => $session->id );
1137 $session->param('lasttime',time());
1138 my $flags = haspermission($userid, $flagsrequired);
1140 return ("ok", $cookie, $sessionID);
1143 C4::Context->_unset_userenv($sessionID);
1146 return ("failed", undef, undef);
1150 return ("expired", undef, undef);
1154 my $userid = $query->param('userid');
1155 my $password = $query->param('password');
1156 my ($return, $cardnumber);
1159 if ($cas && $query->param('PT')) {
1161 $debug and print STDERR "## check_api_auth - checking CAS\n";
1162 # In case of a CAS authentication, we use the ticket instead of the password
1163 my $PT = $query->param('PT');
1164 ($return,$cardnumber,$userid) = check_api_auth_cas($dbh, $PT, $query); # EXTERNAL AUTH
1166 # User / password auth
1167 unless ($userid and $password) {
1168 # caller did something wrong, fail the authenticateion
1169 return ("failed", undef, undef);
1171 ( $return, $cardnumber ) = checkpw( $dbh, $userid, $password, $query );
1174 if ($return and haspermission( $userid, $flagsrequired)) {
1175 my $session = get_session("");
1176 return ("failed", undef, undef) unless $session;
1178 my $sessionID = $session->id;
1179 C4::Context->_new_userenv($sessionID);
1180 my $cookie = $query->cookie(CGISESSID => $sessionID);
1181 if ( $return == 1 ) {
1183 $borrowernumber, $firstname, $surname,
1184 $userflags, $branchcode, $branchname,
1185 $branchprinter, $emailaddress
1189 "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=?"
1191 $sth->execute($userid);
1193 $borrowernumber, $firstname, $surname,
1194 $userflags, $branchcode, $branchname,
1195 $branchprinter, $emailaddress
1196 ) = $sth->fetchrow if ( $sth->rows );
1198 unless ($sth->rows ) {
1199 my $sth = $dbh->prepare(
1200 "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=?"
1202 $sth->execute($cardnumber);
1204 $borrowernumber, $firstname, $surname,
1205 $userflags, $branchcode, $branchname,
1206 $branchprinter, $emailaddress
1207 ) = $sth->fetchrow if ( $sth->rows );
1209 unless ( $sth->rows ) {
1210 $sth->execute($userid);
1212 $borrowernumber, $firstname, $surname, $userflags,
1213 $branchcode, $branchname, $branchprinter, $emailaddress
1214 ) = $sth->fetchrow if ( $sth->rows );
1218 my $ip = $ENV{'REMOTE_ADDR'};
1219 # if they specify at login, use that
1220 if ($query->param('branch')) {
1221 $branchcode = $query->param('branch');
1222 $branchname = GetBranchName($branchcode);
1224 my $branches = GetBranches();
1226 foreach my $br ( keys %$branches ) {
1227 # now we work with the treatment of ip
1228 my $domain = $branches->{$br}->{'branchip'};
1229 if ( $domain && $ip =~ /^$domain/ ) {
1230 $branchcode = $branches->{$br}->{'branchcode'};
1232 # new op dev : add the branchprinter and branchname in the cookie
1233 $branchprinter = $branches->{$br}->{'branchprinter'};
1234 $branchname = $branches->{$br}->{'branchname'};
1237 $session->param('number',$borrowernumber);
1238 $session->param('id',$userid);
1239 $session->param('cardnumber',$cardnumber);
1240 $session->param('firstname',$firstname);
1241 $session->param('surname',$surname);
1242 $session->param('branch',$branchcode);
1243 $session->param('branchname',$branchname);
1244 $session->param('flags',$userflags);
1245 $session->param('emailaddress',$emailaddress);
1246 $session->param('ip',$session->remote_addr());
1247 $session->param('lasttime',time());
1248 } elsif ( $return == 2 ) {
1249 #We suppose the user is the superlibrarian
1250 $session->param('number',0);
1251 $session->param('id',C4::Context->config('user'));
1252 $session->param('cardnumber',C4::Context->config('user'));
1253 $session->param('firstname',C4::Context->config('user'));
1254 $session->param('surname',C4::Context->config('user'));
1255 $session->param('branch','NO_LIBRARY_SET');
1256 $session->param('branchname','NO_LIBRARY_SET');
1257 $session->param('flags',1);
1258 $session->param('emailaddress', C4::Context->preference('KohaAdminEmailAddress'));
1259 $session->param('ip',$session->remote_addr());
1260 $session->param('lasttime',time());
1262 C4::Context::set_userenv(
1263 $session->param('number'), $session->param('id'),
1264 $session->param('cardnumber'), $session->param('firstname'),
1265 $session->param('surname'), $session->param('branch'),
1266 $session->param('branchname'), $session->param('flags'),
1267 $session->param('emailaddress'), $session->param('branchprinter')
1269 return ("ok", $cookie, $sessionID);
1271 return ("failed", undef, undef);
1276 =head2 check_cookie_auth
1278 ($status, $sessionId) = check_api_auth($cookie, $userflags);
1280 Given a CGISESSID cookie set during a previous login to Koha, determine
1281 if the user has the privileges specified by C<$userflags>.
1283 C<check_cookie_auth> is meant for authenticating special services
1284 such as tools/upload-file.pl that are invoked by other pages that
1285 have been authenticated in the usual way.
1287 Possible return values in C<$status> are:
1291 =item "ok" -- user authenticated; C<$sessionID> have valid values.
1293 =item "failed" -- credentials are not correct; C<$sessionid> are undef
1295 =item "maintenance" -- DB is in maintenance mode; no login possible at the moment
1297 =item "expired -- session cookie has expired; API user should resubmit userid and password
1303 sub check_cookie_auth {
1305 my $flagsrequired = shift;
1307 my $dbh = C4::Context->dbh;
1308 my $timeout = C4::Context->preference('timeout');
1309 $timeout = 600 unless $timeout;
1311 unless (C4::Context->preference('Version')) {
1312 # database has not been installed yet
1313 return ("maintenance", undef);
1315 my $kohaversion=C4::Context::KOHAVERSION;
1316 $kohaversion =~ s/(.*\..*)\.(.*)\.(.*)/$1$2$3/;
1317 if (C4::Context->preference('Version') < $kohaversion) {
1318 # database in need of version update; assume that
1319 # no API should be called while databsae is in
1321 return ("maintenance", undef);
1324 # FIXME -- most of what follows is a copy-and-paste
1325 # of code from checkauth. There is an obvious need
1326 # for refactoring to separate the various parts of
1327 # the authentication code, but as of 2007-11-23 this
1328 # is deferred so as to not introduce bugs into the
1329 # regular authentication code for Koha 3.0.
1331 # see if we have a valid session cookie already
1332 # however, if a userid parameter is present (i.e., from
1333 # a form submission, assume that any current cookie
1335 unless (defined $cookie and $cookie) {
1336 return ("failed", undef);
1338 my $sessionID = $cookie;
1339 my $session = get_session($sessionID);
1340 C4::Context->_new_userenv($sessionID);
1342 C4::Context::set_userenv(
1343 $session->param('number'), $session->param('id'),
1344 $session->param('cardnumber'), $session->param('firstname'),
1345 $session->param('surname'), $session->param('branch'),
1346 $session->param('branchname'), $session->param('flags'),
1347 $session->param('emailaddress'), $session->param('branchprinter')
1350 my $ip = $session->param('ip');
1351 my $lasttime = $session->param('lasttime');
1352 my $userid = $session->param('id');
1353 if ( $lasttime < time() - $timeout ) {
1356 C4::Context->_unset_userenv($sessionID);
1359 return ("expired", undef);
1360 } elsif ( $ip ne $ENV{'REMOTE_ADDR'} ) {
1361 # IP address changed
1363 C4::Context->_unset_userenv($sessionID);
1366 return ("expired", undef);
1368 $session->param('lasttime',time());
1369 my $flags = haspermission($userid, $flagsrequired);
1371 return ("ok", $sessionID);
1374 C4::Context->_unset_userenv($sessionID);
1377 return ("failed", undef);
1381 return ("expired", undef);
1388 my $session = get_session($sessionID);
1390 Given a session ID, retrieve the CGI::Session object used to store
1391 the session's state. The session object can be used to store
1392 data that needs to be accessed by different scripts during a
1395 If the C<$sessionID> parameter is an empty string, a new session
1401 my $sessionID = shift;
1402 my $storage_method = C4::Context->preference('SessionStorage');
1403 my $dbh = C4::Context->dbh;
1405 if ($storage_method eq 'mysql'){
1406 $session = new CGI::Session("driver:MySQL;serializer:yaml;id:md5", $sessionID, {Handle=>$dbh});
1408 elsif ($storage_method eq 'Pg') {
1409 $session = new CGI::Session("driver:PostgreSQL;serializer:yaml;id:md5", $sessionID, {Handle=>$dbh});
1411 elsif ($storage_method eq 'memcached' && $servers){
1412 $session = new CGI::Session("driver:memcached;serializer:yaml;id:md5", $sessionID, { Memcached => $memcached } );
1415 # catch all defaults to tmp should work on all systems
1416 $session = new CGI::Session("driver:File;serializer:yaml;id:md5", $sessionID, {Directory=>'/tmp'});
1423 my ( $dbh, $userid, $password, $query ) = @_;
1425 $debug and print "## checkpw - checking LDAP\n";
1426 my ($retval,$retcard) = checkpw_ldap(@_); # EXTERNAL AUTH
1427 ($retval) and return ($retval,$retcard);
1430 if ($cas && $query && $query->param('ticket')) {
1431 $debug and print STDERR "## checkpw - checking CAS\n";
1432 # In case of a CAS authentication, we use the ticket instead of the password
1433 my $ticket = $query->param('ticket');
1434 my ($retval,$retcard,$retuserid) = checkpw_cas($dbh, $ticket, $query); # EXTERNAL AUTH
1435 ($retval) and return ($retval,$retcard,$retuserid);
1442 "select password,cardnumber,borrowernumber,userid,firstname,surname,branchcode,flags from borrowers where userid=?"
1444 $sth->execute($userid);
1446 my ( $md5password, $cardnumber, $borrowernumber, $userid, $firstname,
1447 $surname, $branchcode, $flags )
1449 if ( md5_base64($password) eq $md5password and $md5password ne "!") {
1451 C4::Context->set_userenv( "$borrowernumber", $userid, $cardnumber,
1452 $firstname, $surname, $branchcode, $flags );
1458 "select password,cardnumber,borrowernumber,userid, firstname,surname,branchcode,flags from borrowers where cardnumber=?"
1460 $sth->execute($userid);
1462 my ( $md5password, $cardnumber, $borrowernumber, $userid, $firstname,
1463 $surname, $branchcode, $flags )
1465 if ( md5_base64($password) eq $md5password ) {
1467 C4::Context->set_userenv( $borrowernumber, $userid, $cardnumber,
1468 $firstname, $surname, $branchcode, $flags );
1472 if ( $userid && $userid eq C4::Context->config('user')
1473 && "$password" eq C4::Context->config('pass') )
1476 # Koha superuser account
1477 # C4::Context->set_userenv(0,0,C4::Context->config('user'),C4::Context->config('user'),C4::Context->config('user'),"",1);
1480 if ( $userid && $userid eq 'demo'
1481 && "$password" eq 'demo'
1482 && C4::Context->config('demo') )
1485 # DEMO => the demo user is allowed to do everything (if demo set to 1 in koha.conf
1486 # some features won't be effective : modify systempref, modify MARC structure,
1494 my $authflags = getuserflags($flags, $userid, [$dbh]);
1496 Translates integer flags into permissions strings hash.
1498 C<$flags> is the integer userflags value ( borrowers.userflags )
1499 C<$userid> is the members.userid, used for building subpermissions
1500 C<$authflags> is a hashref of permissions
1507 my $dbh = @_ ? shift : C4::Context->dbh;
1509 $flags = 0 unless $flags;
1510 my $sth = $dbh->prepare("SELECT bit, flag, defaulton FROM userflags");
1513 while ( my ( $bit, $flag, $defaulton ) = $sth->fetchrow ) {
1514 if ( ( $flags & ( 2**$bit ) ) || $defaulton ) {
1515 $userflags->{$flag} = 1;
1518 $userflags->{$flag} = 0;
1522 # get subpermissions and merge with top-level permissions
1523 my $user_subperms = get_user_subpermissions($userid);
1524 foreach my $module (keys %$user_subperms) {
1525 next if $userflags->{$module} == 1; # user already has permission for everything in this module
1526 $userflags->{$module} = $user_subperms->{$module};
1532 =head2 get_user_subpermissions
1534 $user_perm_hashref = get_user_subpermissions($userid);
1536 Given the userid (note, not the borrowernumber) of a staff user,
1537 return a hashref of hashrefs of the specific subpermissions
1538 accorded to the user. An example return is
1542 export_catalog => 1,
1543 import_patrons => 1,
1547 The top-level hash-key is a module or function code from
1548 userflags.flag, while the second-level key is a code
1551 The results of this function do not give a complete picture
1552 of the functions that a staff user can access; it is also
1553 necessary to check borrowers.flags.
1557 sub get_user_subpermissions {
1560 my $dbh = C4::Context->dbh;
1561 my $sth = $dbh->prepare("SELECT flag, user_permissions.code
1562 FROM user_permissions
1563 JOIN permissions USING (module_bit, code)
1564 JOIN userflags ON (module_bit = bit)
1565 JOIN borrowers USING (borrowernumber)
1567 $sth->execute($userid);
1569 my $user_perms = {};
1570 while (my $perm = $sth->fetchrow_hashref) {
1571 $user_perms->{$perm->{'flag'}}->{$perm->{'code'}} = 1;
1576 =head2 get_all_subpermissions
1578 my $perm_hashref = get_all_subpermissions();
1580 Returns a hashref of hashrefs defining all specific
1581 permissions currently defined. The return value
1582 has the same structure as that of C<get_user_subpermissions>,
1583 except that the innermost hash value is the description
1584 of the subpermission.
1588 sub get_all_subpermissions {
1589 my $dbh = C4::Context->dbh;
1590 my $sth = $dbh->prepare("SELECT flag, code, description
1592 JOIN userflags ON (module_bit = bit)");
1596 while (my $perm = $sth->fetchrow_hashref) {
1597 $all_perms->{$perm->{'flag'}}->{$perm->{'code'}} = $perm->{'description'};
1602 =head2 haspermission
1604 $flags = ($userid, $flagsrequired);
1606 C<$userid> the userid of the member
1607 C<$flags> is a hashref of required flags like C<$borrower-<{authflags}>
1609 Returns member's flags or 0 if a permission is not met.
1614 my ($userid, $flagsrequired) = @_;
1615 my $sth = C4::Context->dbh->prepare("SELECT flags FROM borrowers WHERE userid=?");
1616 $sth->execute($userid);
1617 my $flags = getuserflags($sth->fetchrow(), $userid);
1618 if ( $userid eq C4::Context->config('user') ) {
1619 # Super User Account from /etc/koha.conf
1620 $flags->{'superlibrarian'} = 1;
1622 elsif ( $userid eq 'demo' && C4::Context->config('demo') ) {
1623 # Demo user that can do "anything" (demo=1 in /etc/koha.conf)
1624 $flags->{'superlibrarian'} = 1;
1627 return $flags if $flags->{superlibrarian};
1629 foreach my $module ( keys %$flagsrequired ) {
1630 my $subperm = $flagsrequired->{$module};
1631 if ($subperm eq '*') {
1632 return 0 unless ( $flags->{$module} == 1 or ref($flags->{$module}) );
1634 return 0 unless ( $flags->{$module} == 1 or
1635 ( ref($flags->{$module}) and
1636 exists $flags->{$module}->{$subperm} and
1637 $flags->{$module}->{$subperm} == 1
1643 #FIXME - This fcn should return the failed permission so a suitable error msg can be delivered.
1647 sub getborrowernumber {
1649 my $userenv = C4::Context->userenv;
1650 if ( defined( $userenv ) && ref( $userenv ) eq 'HASH' && $userenv->{number} ) {
1651 return $userenv->{number};
1653 my $dbh = C4::Context->dbh;
1654 for my $field ( 'userid', 'cardnumber' ) {
1656 $dbh->prepare("select borrowernumber from borrowers where $field=?");
1657 $sth->execute($userid);
1659 my ($bnumber) = $sth->fetchrow;
1666 END { } # module clean-up code here (global destructor)