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.
22 use Digest::MD5 qw(md5_base64);
23 use Storable qw(thaw freeze);
29 use C4::Templates; # to get the template
30 use C4::Branch; # GetBranches
31 use C4::VirtualShelves;
32 use POSIX qw/strftime/;
33 use List::MoreUtils qw/ any /;
36 use vars qw($VERSION @ISA @EXPORT @EXPORT_OK %EXPORT_TAGS $debug $ldap $cas $caslogout);
39 sub psgi_env { any { /^psgi\./ } keys %ENV }
41 if ( psgi_env ) { die 'psgi:exit' }
44 $VERSION = 3.07.00.049; # set version for version checking
48 @EXPORT = qw(&checkauth &get_template_and_user &haspermission &get_user_subpermissions);
49 @EXPORT_OK = qw(&check_api_auth &get_session &check_cookie_auth &checkpw &get_all_subpermissions &get_user_subpermissions);
50 %EXPORT_TAGS = ( EditPermissions => [qw(get_all_subpermissions get_user_subpermissions)] );
51 $ldap = C4::Context->config('useldapserver') || 0;
52 $cas = C4::Context->preference('casAuthentication');
53 $caslogout = C4::Context->preference('casLogout');
54 require C4::Auth_with_cas; # no import
56 require C4::Auth_with_ldap;
57 import C4::Auth_with_ldap qw(checkpw_ldap);
60 import C4::Auth_with_cas qw(check_api_auth_cas checkpw_cas login_cas logout_cas login_cas_url);
67 C4::Auth - Authenticates Koha users
77 my ($template, $borrowernumber, $cookie)
78 = get_template_and_user(
80 template_name => "opac-main.tmpl",
84 flagsrequired => {borrow => 1, catalogue => '*', tools => 'import_patrons' },
88 output_html_with_http_headers $query, $cookie, $template->output;
92 The main function of this module is to provide
93 authentification. However the get_template_and_user function has
94 been provided so that a users login information is passed along
95 automatically. This gets loaded into the template.
99 =head2 get_template_and_user
101 my ($template, $borrowernumber, $cookie)
102 = get_template_and_user(
104 template_name => "opac-main.tmpl",
107 authnotrequired => 1,
108 flagsrequired => {borrow => 1, catalogue => '*', tools => 'import_patrons' },
112 This call passes the C<query>, C<flagsrequired> and C<authnotrequired>
113 to C<&checkauth> (in this module) to perform authentification.
114 See C<&checkauth> for an explanation of these parameters.
116 The C<template_name> is then used to find the correct template for
117 the page. The authenticated users details are loaded onto the
118 template in the HTML::Template LOOP variable C<USER_INFO>. Also the
119 C<sessionID> is passed to the template. This can be used in templates
120 if cookies are disabled. It needs to be put as and input to every
123 More information on the C<gettemplate> sub can be found in the
128 my $SEARCH_HISTORY_INSERT_SQL =<<EOQ;
129 INSERT INTO search_history(userid, sessionid, query_desc, query_cgi, total, time )
130 VALUES ( ?, ?, ?, ?, ?, FROM_UNIXTIME(?))
133 sub get_template_and_user {
136 C4::Templates::gettemplate( $in->{'template_name'}, $in->{'type'}, $in->{'query'} );
137 my ( $user, $cookie, $sessionID, $flags );
138 if ( $in->{'template_name'} !~m/maintenance/ ) {
139 ( $user, $cookie, $sessionID, $flags ) = checkauth(
141 $in->{'authnotrequired'},
142 $in->{'flagsrequired'},
148 my $insecure = C4::Context->preference('insecure');
149 if ($user or $insecure) {
151 # It's possible for $user to be the borrowernumber if they don't have a
152 # userid defined (and are logging in through some other method, such
153 # as SSL certs against an email address)
154 $borrowernumber = getborrowernumber($user) if defined($user);
155 if (!defined($borrowernumber) && defined($user)) {
156 my $borrower = C4::Members::GetMember(borrowernumber => $user);
158 $borrowernumber = $user;
159 # A bit of a hack, but I don't know there's a nicer way
161 $user = $borrower->{firstname} . ' ' . $borrower->{surname};
166 $template->param( loggedinusername => $user );
167 $template->param( sessionID => $sessionID );
169 my ($total, $pubshelves, $barshelves) = C4::VirtualShelves::GetSomeShelfNames($borrowernumber, 'MASTHEAD');
171 pubshelves => $total->{pubtotal},
172 pubshelvesloop => $pubshelves,
173 barshelves => $total->{bartotal},
174 barshelvesloop => $barshelves,
177 my ( $borr ) = C4::Members::GetMemberDetails( $borrowernumber );
180 $template->param( "USER_INFO" => \@bordat );
182 my $all_perms = get_all_subpermissions();
184 my @flagroots = qw(circulate catalogue parameters borrowers permissions reserveforothers borrow
185 editcatalogue updatecharges management tools editauthorities serials reports acquisition);
186 # We are going to use the $flags returned by checkauth
187 # to create the template's parameters that will indicate
188 # which menus the user can access.
189 if (( $flags && $flags->{superlibrarian}==1) or $insecure==1) {
190 $template->param( CAN_user_circulate => 1 );
191 $template->param( CAN_user_catalogue => 1 );
192 $template->param( CAN_user_parameters => 1 );
193 $template->param( CAN_user_borrowers => 1 );
194 $template->param( CAN_user_permissions => 1 );
195 $template->param( CAN_user_reserveforothers => 1 );
196 $template->param( CAN_user_borrow => 1 );
197 $template->param( CAN_user_editcatalogue => 1 );
198 $template->param( CAN_user_updatecharges => 1 );
199 $template->param( CAN_user_acquisition => 1 );
200 $template->param( CAN_user_management => 1 );
201 $template->param( CAN_user_tools => 1 );
202 $template->param( CAN_user_editauthorities => 1 );
203 $template->param( CAN_user_serials => 1 );
204 $template->param( CAN_user_reports => 1 );
205 $template->param( CAN_user_staffaccess => 1 );
206 foreach my $module (keys %$all_perms) {
207 foreach my $subperm (keys %{ $all_perms->{$module} }) {
208 $template->param( "CAN_user_${module}_${subperm}" => 1 );
214 foreach my $module (keys %$all_perms) {
215 if ( $flags->{$module} == 1) {
216 foreach my $subperm (keys %{ $all_perms->{$module} }) {
217 $template->param( "CAN_user_${module}_${subperm}" => 1 );
219 } elsif ( ref($flags->{$module}) ) {
220 foreach my $subperm (keys %{ $flags->{$module} } ) {
221 $template->param( "CAN_user_${module}_${subperm}" => 1 );
228 foreach my $module (keys %$flags) {
229 if ( $flags->{$module} == 1 or ref($flags->{$module}) ) {
230 $template->param( "CAN_user_$module" => 1 );
231 if ($module eq "parameters") {
232 $template->param( CAN_user_management => 1 );
237 # Logged-in opac search history
238 # If the requested template is an opac one and opac search history is enabled
239 if ($in->{type} eq 'opac' && C4::Context->preference('EnableOpacSearchHistory')) {
240 my $dbh = C4::Context->dbh;
241 my $query = "SELECT COUNT(*) FROM search_history WHERE userid=?";
242 my $sth = $dbh->prepare($query);
243 $sth->execute($borrowernumber);
245 # If at least one search has already been performed
246 if ($sth->fetchrow_array > 0) {
247 # We show the link in opac
248 $template->param(ShowOpacRecentSearchLink => 1);
251 # And if there's a cookie with searches performed when the user was not logged in,
252 # we add them to the logged-in search history
253 my $searchcookie = $in->{'query'}->cookie('KohaOpacRecentSearches');
255 $searchcookie = uri_unescape($searchcookie);
256 my @recentSearches = @{thaw($searchcookie) || []};
257 if (@recentSearches) {
258 my $sth = $dbh->prepare($SEARCH_HISTORY_INSERT_SQL);
259 $sth->execute( $borrowernumber,
260 $in->{'query'}->cookie("CGISESSID"),
265 ) foreach @recentSearches;
267 # And then, delete the cookie's content
268 my $newsearchcookie = $in->{'query'}->cookie(
269 -name => 'KohaOpacRecentSearches',
270 -value => freeze([]),
274 $cookie = [$cookie, $newsearchcookie];
279 else { # if this is an anonymous session, setup to display public lists...
281 $template->param( sessionID => $sessionID );
283 my ($total, $pubshelves) = C4::VirtualShelves::GetSomeShelfNames(undef, 'MASTHEAD');
285 pubshelves => $total->{pubtotal},
286 pubshelvesloop => $pubshelves,
289 # Anonymous opac search history
290 # If opac search history is enabled and at least one search has already been performed
291 if (C4::Context->preference('EnableOpacSearchHistory')) {
292 my $searchcookie = $in->{'query'}->cookie('KohaOpacRecentSearches');
294 $searchcookie = uri_unescape($searchcookie);
295 my @recentSearches = @{thaw($searchcookie) || []};
296 # We show the link in opac
297 if (@recentSearches) {
298 $template->param(ShowOpacRecentSearchLink => 1);
303 if(C4::Context->preference('dateformat')){
304 $template->param( dateformat => C4::Context->preference('dateformat') );
305 if(C4::Context->preference('dateformat') eq "metric"){
306 $template->param(dateformat_metric => 1);
307 } elsif(C4::Context->preference('dateformat') eq "us"){
308 $template->param(dateformat_us => 1);
310 $template->param(dateformat_iso => 1);
313 $template->param(dateformat_iso => 1);
316 # these template parameters are set the same regardless of $in->{'type'}
318 "BiblioDefaultView".C4::Context->preference("BiblioDefaultView") => 1,
319 EnhancedMessagingPreferences => C4::Context->preference('EnhancedMessagingPreferences'),
320 GoogleJackets => C4::Context->preference("GoogleJackets"),
321 OpenLibraryCovers => C4::Context->preference("OpenLibraryCovers"),
322 KohaAdminEmailAddress => "" . C4::Context->preference("KohaAdminEmailAddress"),
323 LoginBranchcode => (C4::Context->userenv?C4::Context->userenv->{"branch"}:"insecure"),
324 LoginFirstname => (C4::Context->userenv?C4::Context->userenv->{"firstname"}:"Bel"),
325 LoginSurname => C4::Context->userenv?C4::Context->userenv->{"surname"}:"Inconnu",
326 emailaddress => C4::Context->userenv?C4::Context->userenv->{"emailaddress"}:undef,
327 loggedinpersona => C4::Context->userenv?C4::Context->userenv->{"persona"}:undef,
328 TagsEnabled => C4::Context->preference("TagsEnabled"),
329 hide_marc => C4::Context->preference("hide_marc"),
330 item_level_itypes => C4::Context->preference('item-level_itypes'),
331 patronimages => C4::Context->preference("patronimages"),
332 singleBranchMode => C4::Context->preference("singleBranchMode"),
333 XSLTDetailsDisplay => C4::Context->preference("XSLTDetailsDisplay"),
334 XSLTResultsDisplay => C4::Context->preference("XSLTResultsDisplay"),
335 using_https => $in->{'query'}->https() ? 1 : 0,
336 noItemTypeImages => C4::Context->preference("noItemTypeImages"),
337 marcflavour => C4::Context->preference("marcflavour"),
338 persona => C4::Context->preference("persona"),
340 if ( $in->{'type'} eq "intranet" ) {
342 AmazonCoverImages => C4::Context->preference("AmazonCoverImages"),
343 AutoLocation => C4::Context->preference("AutoLocation"),
344 "BiblioDefaultView".C4::Context->preference("IntranetBiblioDefaultView") => 1,
345 CalendarFirstDayOfWeek => (C4::Context->preference("CalendarFirstDayOfWeek") eq "Sunday")?0:1,
346 CircAutocompl => C4::Context->preference("CircAutocompl"),
347 FRBRizeEditions => C4::Context->preference("FRBRizeEditions"),
348 IndependantBranches => C4::Context->preference("IndependantBranches"),
349 IntranetNav => C4::Context->preference("IntranetNav"),
350 IntranetmainUserblock => C4::Context->preference("IntranetmainUserblock"),
351 LibraryName => C4::Context->preference("LibraryName"),
352 LoginBranchname => (C4::Context->userenv?C4::Context->userenv->{"branchname"}:"insecure"),
353 advancedMARCEditor => C4::Context->preference("advancedMARCEditor"),
354 canreservefromotherbranches => C4::Context->preference('canreservefromotherbranches'),
355 intranetcolorstylesheet => C4::Context->preference("intranetcolorstylesheet"),
356 IntranetFavicon => C4::Context->preference("IntranetFavicon"),
357 intranetreadinghistory => C4::Context->preference("intranetreadinghistory"),
358 intranetstylesheet => C4::Context->preference("intranetstylesheet"),
359 IntranetUserCSS => C4::Context->preference("IntranetUserCSS"),
360 intranetuserjs => C4::Context->preference("intranetuserjs"),
361 intranetbookbag => C4::Context->preference("intranetbookbag"),
362 suggestion => C4::Context->preference("suggestion"),
363 virtualshelves => C4::Context->preference("virtualshelves"),
364 StaffSerialIssueDisplayCount => C4::Context->preference("StaffSerialIssueDisplayCount"),
365 NoZebra => C4::Context->preference('NoZebra'),
366 EasyAnalyticalRecords => C4::Context->preference('EasyAnalyticalRecords'),
367 LocalCoverImages => C4::Context->preference('LocalCoverImages'),
368 OPACLocalCoverImages => C4::Context->preference('OPACLocalCoverImages'),
369 AllowMultipleCovers => C4::Context->preference('AllowMultipleCovers'),
370 EnableBorrowerFiles => C4::Context->preference('EnableBorrowerFiles'),
374 warn "template type should be OPAC, here it is=[" . $in->{'type'} . "]" unless ( $in->{'type'} eq 'opac' );
375 #TODO : replace LibraryName syspref with 'system name', and remove this html processing
376 my $LibraryNameTitle = C4::Context->preference("LibraryName");
377 $LibraryNameTitle =~ s/<(?:\/?)(?:br|p)\s*(?:\/?)>/ /sgi;
378 $LibraryNameTitle =~ s/<(?:[^<>'"]|'(?:[^']*)'|"(?:[^"]*)")*>//sg;
379 # clean up the busc param in the session if the page is not opac-detail
380 if (C4::Context->preference("OpacBrowseResults") && $in->{'template_name'} =~ /opac-(.+)\.(?:tt|tmpl)$/ && $1 !~ /^(?:MARC|ISBD)?detail$/) {
381 my $sessionSearch = get_session($sessionID || $in->{'query'}->cookie("CGISESSID"));
382 $sessionSearch->clear(["busc"]) if ($sessionSearch->param("busc"));
384 # variables passed from CGI: opac_css_override and opac_search_limits.
385 my $opac_search_limit = $ENV{'OPAC_SEARCH_LIMIT'};
386 my $opac_limit_override = $ENV{'OPAC_LIMIT_OVERRIDE'};
388 if (($opac_search_limit && $opac_search_limit =~ /branch:(\w+)/ && $opac_limit_override) || ($in->{'query'}->param('limit') && $in->{'query'}->param('limit') =~ /branch:(\w+)/)){
389 $opac_name = $1; # opac_search_limit is a branch, so we use it.
390 } elsif (C4::Context->preference("SearchMyLibraryFirst") && C4::Context->userenv && C4::Context->userenv->{'branch'}) {
391 $opac_name = C4::Context->userenv->{'branch'};
394 opaccolorstylesheet => C4::Context->preference("opaccolorstylesheet"),
395 AnonSuggestions => "" . C4::Context->preference("AnonSuggestions"),
396 AuthorisedValueImages => C4::Context->preference("AuthorisedValueImages"),
397 BranchesLoop => GetBranchesLoop($opac_name),
398 CalendarFirstDayOfWeek => (C4::Context->preference("CalendarFirstDayOfWeek") eq "Sunday")?0:1,
399 LibraryName => "" . C4::Context->preference("LibraryName"),
400 LibraryNameTitle => "" . $LibraryNameTitle,
401 LoginBranchname => C4::Context->userenv?C4::Context->userenv->{"branchname"}:"",
402 OPACAmazonCoverImages => C4::Context->preference("OPACAmazonCoverImages"),
403 OPACFRBRizeEditions => C4::Context->preference("OPACFRBRizeEditions"),
404 OpacHighlightedWords => C4::Context->preference("OpacHighlightedWords"),
405 OPACItemHolds => C4::Context->preference("OPACItemHolds"),
406 OPACShelfBrowser => "". C4::Context->preference("OPACShelfBrowser"),
407 OpacShowRecentComments => C4::Context->preference("OpacShowRecentComments"),
408 OPACURLOpenInNewWindow => "" . C4::Context->preference("OPACURLOpenInNewWindow"),
409 OPACUserCSS => "". C4::Context->preference("OPACUserCSS"),
410 OPACMobileUserCSS => "". C4::Context->preference("OPACMobileUserCSS"),
411 OPACViewOthersSuggestions => "" . C4::Context->preference("OPACViewOthersSuggestions"),
412 OpacAuthorities => C4::Context->preference("OpacAuthorities"),
413 OPACBaseURL => ($in->{'query'}->https() ? "https://" : "http://") . $ENV{'SERVER_NAME'} .
414 ($ENV{'SERVER_PORT'} eq ($in->{'query'}->https() ? "443" : "80") ? '' : ":$ENV{'SERVER_PORT'}"),
415 opac_css_override => $ENV{'OPAC_CSS_OVERRIDE'},
416 opac_search_limit => $opac_search_limit,
417 opac_limit_override => $opac_limit_override,
418 OpacBrowser => C4::Context->preference("OpacBrowser"),
419 OpacCloud => C4::Context->preference("OpacCloud"),
420 OpacKohaUrl => C4::Context->preference("OpacKohaUrl"),
421 OpacMainUserBlock => "" . C4::Context->preference("OpacMainUserBlock"),
422 OpacMainUserBlockMobile => "" . C4::Context->preference("OpacMainUserBlockMobile"),
423 OpacShowFiltersPulldownMobile => C4::Context->preference("OpacShowFiltersPulldownMobile"),
424 OpacShowLibrariesPulldownMobile => C4::Context->preference("OpacShowLibrariesPulldownMobile"),
425 OpacNav => "" . C4::Context->preference("OpacNav"),
426 OpacNavRight => "" . C4::Context->preference("OpacNavRight"),
427 OpacNavBottom => "" . C4::Context->preference("OpacNavBottom"),
428 OpacPasswordChange => C4::Context->preference("OpacPasswordChange"),
429 OPACPatronDetails => C4::Context->preference("OPACPatronDetails"),
430 OPACPrivacy => C4::Context->preference("OPACPrivacy"),
431 OPACFinesTab => C4::Context->preference("OPACFinesTab"),
432 OpacTopissue => C4::Context->preference("OpacTopissue"),
433 RequestOnOpac => C4::Context->preference("RequestOnOpac"),
434 'Version' => C4::Context->preference('Version'),
435 hidelostitems => C4::Context->preference("hidelostitems"),
436 mylibraryfirst => (C4::Context->preference("SearchMyLibraryFirst") && C4::Context->userenv) ? C4::Context->userenv->{'branch'} : '',
437 opaclayoutstylesheet => "" . C4::Context->preference("opaclayoutstylesheet"),
438 opacbookbag => "" . C4::Context->preference("opacbookbag"),
439 opaccredits => "" . C4::Context->preference("opaccredits"),
440 OpacFavicon => C4::Context->preference("OpacFavicon"),
441 opacheader => "" . C4::Context->preference("opacheader"),
442 opaclanguagesdisplay => "" . C4::Context->preference("opaclanguagesdisplay"),
443 opacreadinghistory => C4::Context->preference("opacreadinghistory"),
444 opacsmallimage => "" . C4::Context->preference("opacsmallimage"),
445 opacuserjs => C4::Context->preference("opacuserjs"),
446 opacuserlogin => "" . C4::Context->preference("opacuserlogin"),
447 reviewson => C4::Context->preference("reviewson"),
448 ShowReviewer => C4::Context->preference("ShowReviewer"),
449 ShowReviewerPhoto => C4::Context->preference("ShowReviewerPhoto"),
450 suggestion => "" . C4::Context->preference("suggestion"),
451 virtualshelves => "" . C4::Context->preference("virtualshelves"),
452 OPACSerialIssueDisplayCount => C4::Context->preference("OPACSerialIssueDisplayCount"),
453 OpacAddMastheadLibraryPulldown => C4::Context->preference("OpacAddMastheadLibraryPulldown"),
454 OPACXSLTDetailsDisplay => C4::Context->preference("OPACXSLTDetailsDisplay"),
455 OPACXSLTResultsDisplay => C4::Context->preference("OPACXSLTResultsDisplay"),
456 SyndeticsClientCode => C4::Context->preference("SyndeticsClientCode"),
457 SyndeticsEnabled => C4::Context->preference("SyndeticsEnabled"),
458 SyndeticsCoverImages => C4::Context->preference("SyndeticsCoverImages"),
459 SyndeticsTOC => C4::Context->preference("SyndeticsTOC"),
460 SyndeticsSummary => C4::Context->preference("SyndeticsSummary"),
461 SyndeticsEditions => C4::Context->preference("SyndeticsEditions"),
462 SyndeticsExcerpt => C4::Context->preference("SyndeticsExcerpt"),
463 SyndeticsReviews => C4::Context->preference("SyndeticsReviews"),
464 SyndeticsAuthorNotes => C4::Context->preference("SyndeticsAuthorNotes"),
465 SyndeticsAwards => C4::Context->preference("SyndeticsAwards"),
466 SyndeticsSeries => C4::Context->preference("SyndeticsSeries"),
467 SyndeticsCoverImageSize => C4::Context->preference("SyndeticsCoverImageSize"),
468 OPACLocalCoverImages => C4::Context->preference("OPACLocalCoverImages"),
469 PatronSelfRegistration => C4::Context->preference("PatronSelfRegistration"),
470 PatronSelfRegistrationDefaultCategory => C4::Context->preference("PatronSelfRegistrationDefaultCategory"),
473 $template->param(OpacPublic => '1') if ($user || C4::Context->preference("OpacPublic"));
475 return ( $template, $borrowernumber, $cookie, $flags);
480 ($userid, $cookie, $sessionID) = &checkauth($query, $noauth, $flagsrequired, $type);
482 Verifies that the user is authorized to run this script. If
483 the user is authorized, a (userid, cookie, session-id, flags)
484 quadruple is returned. If the user is not authorized but does
485 not have the required privilege (see $flagsrequired below), it
486 displays an error page and exits. Otherwise, it displays the
487 login page and exits.
489 Note that C<&checkauth> will return if and only if the user
490 is authorized, so it should be called early on, before any
491 unfinished operations (e.g., if you've opened a file, then
492 C<&checkauth> won't close it for you).
494 C<$query> is the CGI object for the script calling C<&checkauth>.
496 The C<$noauth> argument is optional. If it is set, then no
497 authorization is required for the script.
499 C<&checkauth> fetches user and session information from C<$query> and
500 ensures that the user is authorized to run scripts that require
503 The C<$flagsrequired> argument specifies the required privileges
504 the user must have if the username and password are correct.
505 It should be specified as a reference-to-hash; keys in the hash
506 should be the "flags" for the user, as specified in the Members
507 intranet module. Any key specified must correspond to a "flag"
508 in the userflags table. E.g., { circulate => 1 } would specify
509 that the user must have the "circulate" privilege in order to
510 proceed. To make sure that access control is correct, the
511 C<$flagsrequired> parameter must be specified correctly.
513 Koha also has a concept of sub-permissions, also known as
514 granular permissions. This makes the value of each key
515 in the C<flagsrequired> hash take on an additional
520 The user must have access to all subfunctions of the module
521 specified by the hash key.
525 The user must have access to at least one subfunction of the module
526 specified by the hash key.
528 specific permission, e.g., 'export_catalog'
530 The user must have access to the specific subfunction list, which
531 must correspond to a row in the permissions table.
533 The C<$type> argument specifies whether the template should be
534 retrieved from the opac or intranet directory tree. "opac" is
535 assumed if it is not specified; however, if C<$type> is specified,
536 "intranet" is assumed if it is not "opac".
538 If C<$query> does not have a valid session ID associated with it
539 (i.e., the user has not logged in) or if the session has expired,
540 C<&checkauth> presents the user with a login page (from the point of
541 view of the original script, C<&checkauth> does not return). Once the
542 user has authenticated, C<&checkauth> restarts the original script
543 (this time, C<&checkauth> returns).
545 The login page is provided using a HTML::Template, which is set in the
546 systempreferences table or at the top of this file. The variable C<$type>
547 selects which template to use, either the opac or the intranet
548 authentification template.
550 C<&checkauth> returns a user ID, a cookie, and a session ID. The
551 cookie should be sent back to the browser; it verifies that the user
560 # If Version syspref is unavailable, it means Koha is beeing installed,
561 # and so we must redirect to OPAC maintenance page or to the WebInstaller
562 # also, if OpacMaintenance is ON, OPAC should redirect to maintenance
563 if (C4::Context->preference('OpacMaintenance') && $type eq 'opac') {
564 warn "OPAC Install required, redirecting to maintenance";
565 print $query->redirect("/cgi-bin/koha/maintenance.pl");
568 unless ( $version = C4::Context->preference('Version') ) { # assignment, not comparison
569 if ( $type ne 'opac' ) {
570 warn "Install required, redirecting to Installer";
571 print $query->redirect("/cgi-bin/koha/installer/install.pl");
573 warn "OPAC Install required, redirecting to maintenance";
574 print $query->redirect("/cgi-bin/koha/maintenance.pl");
579 # check that database and koha version are the same
580 # there is no DB version, it's a fresh install,
581 # go to web installer
582 # there is a DB version, compare it to the code version
583 my $kohaversion=C4::Context::KOHAVERSION;
584 # remove the 3 last . to have a Perl number
585 $kohaversion =~ s/(.*\..*)\.(.*)\.(.*)/$1$2$3/;
586 $debug and print STDERR "kohaversion : $kohaversion\n";
587 if ($version < $kohaversion){
588 my $warning = "Database update needed, redirecting to %s. Database is $version and Koha is $kohaversion";
589 if ($type ne 'opac'){
590 warn sprintf($warning, 'Installer');
591 print $query->redirect("/cgi-bin/koha/installer/install.pl?step=3");
593 warn sprintf("OPAC: " . $warning, 'maintenance');
594 print $query->redirect("/cgi-bin/koha/maintenance.pl");
602 open my $fh, '>>', "/tmp/sessionlog" or warn "ERROR: Cannot append to /tmp/sessionlog";
603 printf $fh join("\n",@_);
607 sub _timeout_syspref {
608 my $timeout = C4::Context->preference('timeout') || 600;
609 # value in days, convert in seconds
610 if ($timeout =~ /(\d+)[dD]/) {
611 $timeout = $1 * 86400;
618 $debug and warn "Checking Auth";
619 # $authnotrequired will be set for scripts which will run without authentication
620 my $authnotrequired = shift;
621 my $flagsrequired = shift;
624 $type = 'opac' unless $type;
626 my $dbh = C4::Context->dbh;
627 my $timeout = _timeout_syspref();
629 _version_check($type,$query);
633 my ( $userid, $cookie, $sessionID, $flags, $barshelves, $pubshelves );
634 my $logout = $query->param('logout.x');
636 # This parameter is the name of the CAS server we want to authenticate against,
637 # when using authentication against multiple CAS servers, as configured in Auth_cas_servers.yaml
638 my $casparam = $query->param('cas');
640 if ( $userid = $ENV{'REMOTE_USER'} ) {
641 # Using Basic Authentication, no cookies required
642 $cookie = $query->cookie(
643 -name => 'CGISESSID',
651 # we dont want to set a session because we are being called by a persona callback
653 elsif ( $sessionID = $query->cookie("CGISESSID") )
654 { # assignment, not comparison
655 my $session = get_session($sessionID);
656 C4::Context->_new_userenv($sessionID);
657 my ($ip, $lasttime, $sessiontype);
659 C4::Context::set_userenv(
660 $session->param('number'), $session->param('id'),
661 $session->param('cardnumber'), $session->param('firstname'),
662 $session->param('surname'), $session->param('branch'),
663 $session->param('branchname'), $session->param('flags'),
664 $session->param('emailaddress'), $session->param('branchprinter'),
665 $session->param('persona')
667 C4::Context::set_shelves_userenv('bar',$session->param('barshelves'));
668 C4::Context::set_shelves_userenv('pub',$session->param('pubshelves'));
669 C4::Context::set_shelves_userenv('tot',$session->param('totshelves'));
670 $debug and printf STDERR "AUTH_SESSION: (%s)\t%s %s - %s\n", map {$session->param($_)} qw(cardnumber firstname surname branch) ;
671 $ip = $session->param('ip');
672 $lasttime = $session->param('lasttime');
673 $userid = $session->param('id');
674 $sessiontype = $session->param('sessiontype') || '';
676 if ( ( ($query->param('koha_login_context')) && ($query->param('userid') ne $session->param('id')) )
677 || ( $cas && $query->param('ticket') ) ) {
678 #if a user enters an id ne to the id in the current session, we need to log them in...
679 #first we need to clear the anonymous session...
680 $debug and warn "query id = " . $query->param('userid') . " but session id = " . $session->param('id');
683 C4::Context->_unset_userenv($sessionID);
688 # voluntary logout the user
691 C4::Context->_unset_userenv($sessionID);
692 #_session_log(sprintf "%20s from %16s logged out at %30s (manually).\n", $userid,$ip,(strftime "%c",localtime));
696 if ($cas and $caslogout) {
700 elsif ( $lasttime < time() - $timeout ) {
702 $info{'timed_out'} = 1;
703 $session->delete() if $session;
704 C4::Context->_unset_userenv($sessionID);
705 #_session_log(sprintf "%20s from %16s logged out at %30s (inactivity).\n", $userid,$ip,(strftime "%c",localtime));
709 elsif ( $ip ne $ENV{'REMOTE_ADDR'} ) {
710 # Different ip than originally logged in from
711 $info{'oldip'} = $ip;
712 $info{'newip'} = $ENV{'REMOTE_ADDR'};
713 $info{'different_ip'} = 1;
715 C4::Context->_unset_userenv($sessionID);
716 #_session_log(sprintf "%20s from %16s logged out at %30s (ip changed to %16s).\n", $userid,$ip,(strftime "%c",localtime), $info{'newip'});
721 $cookie = $query->cookie(
722 -name => 'CGISESSID',
723 -value => $session->id,
726 $session->param( 'lasttime', time() );
727 unless ( $sessiontype && $sessiontype eq 'anon' ) { #if this is an anonymous session, we want to update the session, but not behave as if they are logged in...
728 $flags = haspermission($userid, $flagsrequired);
732 $info{'nopermission'} = 1;
737 unless ($userid || $sessionID) {
739 #we initiate a session prior to checking for a username to allow for anonymous sessions...
740 my $session = get_session("") or die "Auth ERROR: Cannot get_session()";
741 my $sessionID = $session->id;
742 C4::Context->_new_userenv($sessionID);
743 $cookie = $query->cookie(
744 -name => 'CGISESSID',
745 -value => $session->id,
748 $userid = $query->param('userid');
749 if ( ( $cas && $query->param('ticket') )
751 || ( my $pki_field = C4::Context->preference('AllowPKIAuth') ) ne
754 my $password = $query->param('password');
756 my ( $return, $cardnumber );
757 if ( $cas && $query->param('ticket') ) {
759 ( $return, $cardnumber, $retuserid ) =
760 checkpw( $dbh, $userid, $password, $query );
761 $userid = $retuserid;
762 $info{'invalidCasLogin'} = 1 unless ($return);
766 my $value = $persona;
768 # If we're looking up the email, there's a chance that the person
769 # doesn't have a userid. So if there is none, we pass along the
770 # borrower number, and the bits of code that need to know the user
771 # ID will have to be smart enough to handle that.
773 my @users_info = C4::Members::GetBorrowersWithEmail($value);
776 # First the userid, then the borrowernum
777 $value = $users_info[0][1] || $users_info[0][0];
782 $return = $value ? 1 : 0;
787 ( $pki_field eq 'Common Name' && $ENV{'SSL_CLIENT_S_DN_CN'} )
788 || ( $pki_field eq 'emailAddress'
789 && $ENV{'SSL_CLIENT_S_DN_Email'} )
793 if ( $pki_field eq 'Common Name' ) {
794 $value = $ENV{'SSL_CLIENT_S_DN_CN'};
796 elsif ( $pki_field eq 'emailAddress' ) {
797 $value = $ENV{'SSL_CLIENT_S_DN_Email'};
799 # If we're looking up the email, there's a chance that the person
800 # doesn't have a userid. So if there is none, we pass along the
801 # borrower number, and the bits of code that need to know the user
802 # ID will have to be smart enough to handle that.
804 my @users_info = C4::Members::GetBorrowersWithEmail($value);
807 # First the userid, then the borrowernum
808 $value = $users_info[0][1] || $users_info[0][0];
815 $return = $value ? 1 : 0;
821 ( $return, $cardnumber, $retuserid ) =
822 checkpw( $dbh, $userid, $password, $query );
823 $userid = $retuserid if ( $retuserid ne '' );
826 #_session_log(sprintf "%20s from %16s logged in at %30s.\n", $userid,$ENV{'REMOTE_ADDR'},(strftime '%c', localtime));
827 if ( $flags = haspermission( $userid, $flagsrequired ) ) {
831 $info{'nopermission'} = 1;
832 C4::Context->_unset_userenv($sessionID);
834 my ($borrowernumber, $firstname, $surname, $userflags,
835 $branchcode, $branchname, $branchprinter, $emailaddress);
837 if ( $return == 1 ) {
839 SELECT borrowernumber, firstname, surname, flags, borrowers.branchcode,
840 branches.branchname as branchname,
841 branches.branchprinter as branchprinter,
844 LEFT JOIN branches on borrowers.branchcode=branches.branchcode
846 my $sth = $dbh->prepare("$select where userid=?");
847 $sth->execute($userid);
848 unless ($sth->rows) {
849 $debug and print STDERR "AUTH_1: no rows for userid='$userid'\n";
850 $sth = $dbh->prepare("$select where cardnumber=?");
851 $sth->execute($cardnumber);
853 unless ($sth->rows) {
854 $debug and print STDERR "AUTH_2a: no rows for cardnumber='$cardnumber'\n";
855 $sth->execute($userid);
856 unless ($sth->rows) {
857 $debug and print STDERR "AUTH_2b: no rows for userid='$userid' AS cardnumber\n";
862 ($borrowernumber, $firstname, $surname, $userflags,
863 $branchcode, $branchname, $branchprinter, $emailaddress) = $sth->fetchrow;
864 $debug and print STDERR "AUTH_3 results: " .
865 "$cardnumber,$borrowernumber,$userid,$firstname,$surname,$userflags,$branchcode,$emailaddress\n";
867 print STDERR "AUTH_3: no results for userid='$userid', cardnumber='$cardnumber'.\n";
870 # launch a sequence to check if we have a ip for the branch, i
871 # if we have one we replace the branchcode of the userenv by the branch bound in the ip.
873 my $ip = $ENV{'REMOTE_ADDR'};
874 # if they specify at login, use that
875 if ($query->param('branch')) {
876 $branchcode = $query->param('branch');
877 $branchname = GetBranchName($branchcode);
879 my $branches = GetBranches();
880 if (C4::Context->boolean_preference('IndependantBranches') && C4::Context->boolean_preference('Autolocation')){
881 # we have to check they are coming from the right ip range
882 my $domain = $branches->{$branchcode}->{'branchip'};
883 if ($ip !~ /^$domain/){
885 $info{'wrongip'} = 1;
890 foreach my $br ( keys %$branches ) {
891 # now we work with the treatment of ip
892 my $domain = $branches->{$br}->{'branchip'};
893 if ( $domain && $ip =~ /^$domain/ ) {
894 $branchcode = $branches->{$br}->{'branchcode'};
896 # new op dev : add the branchprinter and branchname in the cookie
897 $branchprinter = $branches->{$br}->{'branchprinter'};
898 $branchname = $branches->{$br}->{'branchname'};
901 $session->param('number',$borrowernumber);
902 $session->param('id',$userid);
903 $session->param('cardnumber',$cardnumber);
904 $session->param('firstname',$firstname);
905 $session->param('surname',$surname);
906 $session->param('branch',$branchcode);
907 $session->param('branchname',$branchname);
908 $session->param('flags',$userflags);
909 $session->param('emailaddress',$emailaddress);
910 $session->param('ip',$session->remote_addr());
911 $session->param('lasttime',time());
912 $debug and printf STDERR "AUTH_4: (%s)\t%s %s - %s\n", map {$session->param($_)} qw(cardnumber firstname surname branch) ;
914 elsif ( $return == 2 ) {
915 #We suppose the user is the superlibrarian
917 $session->param('number',0);
918 $session->param('id',C4::Context->config('user'));
919 $session->param('cardnumber',C4::Context->config('user'));
920 $session->param('firstname',C4::Context->config('user'));
921 $session->param('surname',C4::Context->config('user'));
922 $session->param('branch','NO_LIBRARY_SET');
923 $session->param('branchname','NO_LIBRARY_SET');
924 $session->param('flags',1);
925 $session->param('emailaddress', C4::Context->preference('KohaAdminEmailAddress'));
926 $session->param('ip',$session->remote_addr());
927 $session->param('lasttime',time());
930 $session->param('persona',1);
932 C4::Context::set_userenv(
933 $session->param('number'), $session->param('id'),
934 $session->param('cardnumber'), $session->param('firstname'),
935 $session->param('surname'), $session->param('branch'),
936 $session->param('branchname'), $session->param('flags'),
937 $session->param('emailaddress'), $session->param('branchprinter'),
938 $session->param('persona')
944 $info{'invalid_username_or_password'} = 1;
945 C4::Context->_unset_userenv($sessionID);
948 } # END if ( $userid = $query->param('userid') )
949 elsif ($type eq "opac") {
950 # if we are here this is an anonymous session; add public lists to it and a few other items...
951 # anonymous sessions are created only for the OPAC
952 $debug and warn "Initiating an anonymous session...";
954 # setting a couple of other session vars...
955 $session->param('ip',$session->remote_addr());
956 $session->param('lasttime',time());
957 $session->param('sessiontype','anon');
959 } # END unless ($userid)
960 my $insecure = C4::Context->boolean_preference('insecure');
962 # finished authentification, now respond
963 if ( $loggedin || $authnotrequired || ( defined($insecure) && $insecure ) )
967 $cookie = $query->cookie(
968 -name => 'CGISESSID',
973 return ( $userid, $cookie, $sessionID, $flags );
978 # AUTH rejected, show the login/password template, after checking the DB.
982 # get the inputs from the incoming query
984 foreach my $name ( param $query) {
985 (next) if ( $name eq 'userid' || $name eq 'password' || $name eq 'ticket' );
986 my $value = $query->param($name);
987 push @inputs, { name => $name, value => $value };
990 my $template_name = ( $type eq 'opac' ) ? 'opac-auth.tmpl' : 'auth.tmpl';
991 my $template = C4::Templates::gettemplate($template_name, $type, $query );
993 branchloop => GetBranchesLoop(),
994 opaccolorstylesheet => C4::Context->preference("opaccolorstylesheet"),
995 opaclayoutstylesheet => C4::Context->preference("opaclayoutstylesheet"),
998 casAuthentication => C4::Context->preference("casAuthentication"),
999 suggestion => C4::Context->preference("suggestion"),
1000 virtualshelves => C4::Context->preference("virtualshelves"),
1001 LibraryName => C4::Context->preference("LibraryName"),
1002 opacuserlogin => C4::Context->preference("opacuserlogin"),
1003 OpacNav => C4::Context->preference("OpacNav"),
1004 OpacNavRight => C4::Context->preference("OpacNavRight"),
1005 OpacNavBottom => C4::Context->preference("OpacNavBottom"),
1006 opaccredits => C4::Context->preference("opaccredits"),
1007 OpacFavicon => C4::Context->preference("OpacFavicon"),
1008 opacreadinghistory => C4::Context->preference("opacreadinghistory"),
1009 opacsmallimage => C4::Context->preference("opacsmallimage"),
1010 opaclanguagesdisplay => C4::Context->preference("opaclanguagesdisplay"),
1011 opacuserjs => C4::Context->preference("opacuserjs"),
1012 opacbookbag => "" . C4::Context->preference("opacbookbag"),
1013 OpacCloud => C4::Context->preference("OpacCloud"),
1014 OpacTopissue => C4::Context->preference("OpacTopissue"),
1015 OpacAuthorities => C4::Context->preference("OpacAuthorities"),
1016 OpacBrowser => C4::Context->preference("OpacBrowser"),
1017 opacheader => C4::Context->preference("opacheader"),
1018 TagsEnabled => C4::Context->preference("TagsEnabled"),
1019 OPACUserCSS => C4::Context->preference("OPACUserCSS"),
1020 intranetcolorstylesheet => C4::Context->preference("intranetcolorstylesheet"),
1021 intranetstylesheet => C4::Context->preference("intranetstylesheet"),
1022 intranetbookbag => C4::Context->preference("intranetbookbag"),
1023 IntranetNav => C4::Context->preference("IntranetNav"),
1024 IntranetFavicon => C4::Context->preference("IntranetFavicon"),
1025 intranetuserjs => C4::Context->preference("intranetuserjs"),
1026 IndependantBranches=> C4::Context->preference("IndependantBranches"),
1027 AutoLocation => C4::Context->preference("AutoLocation"),
1028 wrongip => $info{'wrongip'},
1029 PatronSelfRegistration => C4::Context->preference("PatronSelfRegistration"),
1030 PatronSelfRegistrationDefaultCategory => C4::Context->preference("PatronSelfRegistrationDefaultCategory"),
1031 persona => C4::Context->preference("Persona"),
1034 $template->param( OpacPublic => C4::Context->preference("OpacPublic"));
1035 $template->param( loginprompt => 1 ) unless $info{'nopermission'};
1039 # Is authentication against multiple CAS servers enabled?
1040 if (C4::Auth_with_cas::multipleAuth && !$casparam) {
1041 my $casservers = C4::Auth_with_cas::getMultipleAuth();
1043 foreach my $key (keys %$casservers) {
1044 push @tmplservers, {name => $key, value => login_cas_url($query, $key) . "?cas=$key" };
1047 casServersLoop => \@tmplservers
1051 casServerUrl => login_cas_url($query),
1056 invalidCasLogin => $info{'invalidCasLogin'}
1060 my $self_url = $query->url( -absolute => 1 );
1063 LibraryName => C4::Context->preference("LibraryName"),
1065 $template->param( %info );
1066 # $cookie = $query->cookie(CGISESSID => $session->id
1068 print $query->header(
1069 -type => 'text/html',
1070 -charset => 'utf-8',
1077 =head2 check_api_auth
1079 ($status, $cookie, $sessionId) = check_api_auth($query, $userflags);
1081 Given a CGI query containing the parameters 'userid' and 'password' and/or a session
1082 cookie, determine if the user has the privileges specified by C<$userflags>.
1084 C<check_api_auth> is is meant for authenticating users of web services, and
1085 consequently will always return and will not attempt to redirect the user
1088 If a valid session cookie is already present, check_api_auth will return a status
1089 of "ok", the cookie, and the Koha session ID.
1091 If no session cookie is present, check_api_auth will check the 'userid' and 'password
1092 parameters and create a session cookie and Koha session if the supplied credentials
1095 Possible return values in C<$status> are:
1099 =item "ok" -- user authenticated; C<$cookie> and C<$sessionid> have valid values.
1101 =item "failed" -- credentials are not correct; C<$cookie> and C<$sessionid> are undef
1103 =item "maintenance" -- DB is in maintenance mode; no login possible at the moment
1105 =item "expired -- session cookie has expired; API user should resubmit userid and password
1111 sub check_api_auth {
1113 my $flagsrequired = shift;
1115 my $dbh = C4::Context->dbh;
1116 my $timeout = _timeout_syspref();
1118 unless (C4::Context->preference('Version')) {
1119 # database has not been installed yet
1120 return ("maintenance", undef, undef);
1122 my $kohaversion=C4::Context::KOHAVERSION;
1123 $kohaversion =~ s/(.*\..*)\.(.*)\.(.*)/$1$2$3/;
1124 if (C4::Context->preference('Version') < $kohaversion) {
1125 # database in need of version update; assume that
1126 # no API should be called while databsae is in
1128 return ("maintenance", undef, undef);
1131 # FIXME -- most of what follows is a copy-and-paste
1132 # of code from checkauth. There is an obvious need
1133 # for refactoring to separate the various parts of
1134 # the authentication code, but as of 2007-11-19 this
1135 # is deferred so as to not introduce bugs into the
1136 # regular authentication code for Koha 3.0.
1138 # see if we have a valid session cookie already
1139 # however, if a userid parameter is present (i.e., from
1140 # a form submission, assume that any current cookie
1142 my $sessionID = undef;
1143 unless ($query->param('userid')) {
1144 $sessionID = $query->cookie("CGISESSID");
1146 if ($sessionID && not ($cas && $query->param('PT')) ) {
1147 my $session = get_session($sessionID);
1148 C4::Context->_new_userenv($sessionID);
1150 C4::Context::set_userenv(
1151 $session->param('number'), $session->param('id'),
1152 $session->param('cardnumber'), $session->param('firstname'),
1153 $session->param('surname'), $session->param('branch'),
1154 $session->param('branchname'), $session->param('flags'),
1155 $session->param('emailaddress'), $session->param('branchprinter')
1158 my $ip = $session->param('ip');
1159 my $lasttime = $session->param('lasttime');
1160 my $userid = $session->param('id');
1161 if ( $lasttime < time() - $timeout ) {
1164 C4::Context->_unset_userenv($sessionID);
1167 return ("expired", undef, undef);
1168 } elsif ( $ip ne $ENV{'REMOTE_ADDR'} ) {
1169 # IP address changed
1171 C4::Context->_unset_userenv($sessionID);
1174 return ("expired", undef, undef);
1176 my $cookie = $query->cookie(
1177 -name => 'CGISESSID',
1178 -value => $session->id,
1181 $session->param('lasttime',time());
1182 my $flags = haspermission($userid, $flagsrequired);
1184 return ("ok", $cookie, $sessionID);
1187 C4::Context->_unset_userenv($sessionID);
1190 return ("failed", undef, undef);
1194 return ("expired", undef, undef);
1198 my $userid = $query->param('userid');
1199 my $password = $query->param('password');
1200 my ($return, $cardnumber);
1203 if ($cas && $query->param('PT')) {
1205 $debug and print STDERR "## check_api_auth - checking CAS\n";
1206 # In case of a CAS authentication, we use the ticket instead of the password
1207 my $PT = $query->param('PT');
1208 ($return,$cardnumber,$userid) = check_api_auth_cas($dbh, $PT, $query); # EXTERNAL AUTH
1210 # User / password auth
1211 unless ($userid and $password) {
1212 # caller did something wrong, fail the authenticateion
1213 return ("failed", undef, undef);
1215 ( $return, $cardnumber ) = checkpw( $dbh, $userid, $password, $query );
1218 if ($return and haspermission( $userid, $flagsrequired)) {
1219 my $session = get_session("");
1220 return ("failed", undef, undef) unless $session;
1222 my $sessionID = $session->id;
1223 C4::Context->_new_userenv($sessionID);
1224 my $cookie = $query->cookie(
1225 -name => 'CGISESSID',
1226 -value => $sessionID,
1229 if ( $return == 1 ) {
1231 $borrowernumber, $firstname, $surname,
1232 $userflags, $branchcode, $branchname,
1233 $branchprinter, $emailaddress
1237 "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=?"
1239 $sth->execute($userid);
1241 $borrowernumber, $firstname, $surname,
1242 $userflags, $branchcode, $branchname,
1243 $branchprinter, $emailaddress
1244 ) = $sth->fetchrow if ( $sth->rows );
1246 unless ($sth->rows ) {
1247 my $sth = $dbh->prepare(
1248 "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=?"
1250 $sth->execute($cardnumber);
1252 $borrowernumber, $firstname, $surname,
1253 $userflags, $branchcode, $branchname,
1254 $branchprinter, $emailaddress
1255 ) = $sth->fetchrow if ( $sth->rows );
1257 unless ( $sth->rows ) {
1258 $sth->execute($userid);
1260 $borrowernumber, $firstname, $surname, $userflags,
1261 $branchcode, $branchname, $branchprinter, $emailaddress
1262 ) = $sth->fetchrow if ( $sth->rows );
1266 my $ip = $ENV{'REMOTE_ADDR'};
1267 # if they specify at login, use that
1268 if ($query->param('branch')) {
1269 $branchcode = $query->param('branch');
1270 $branchname = GetBranchName($branchcode);
1272 my $branches = GetBranches();
1274 foreach my $br ( keys %$branches ) {
1275 # now we work with the treatment of ip
1276 my $domain = $branches->{$br}->{'branchip'};
1277 if ( $domain && $ip =~ /^$domain/ ) {
1278 $branchcode = $branches->{$br}->{'branchcode'};
1280 # new op dev : add the branchprinter and branchname in the cookie
1281 $branchprinter = $branches->{$br}->{'branchprinter'};
1282 $branchname = $branches->{$br}->{'branchname'};
1285 $session->param('number',$borrowernumber);
1286 $session->param('id',$userid);
1287 $session->param('cardnumber',$cardnumber);
1288 $session->param('firstname',$firstname);
1289 $session->param('surname',$surname);
1290 $session->param('branch',$branchcode);
1291 $session->param('branchname',$branchname);
1292 $session->param('flags',$userflags);
1293 $session->param('emailaddress',$emailaddress);
1294 $session->param('ip',$session->remote_addr());
1295 $session->param('lasttime',time());
1296 } elsif ( $return == 2 ) {
1297 #We suppose the user is the superlibrarian
1298 $session->param('number',0);
1299 $session->param('id',C4::Context->config('user'));
1300 $session->param('cardnumber',C4::Context->config('user'));
1301 $session->param('firstname',C4::Context->config('user'));
1302 $session->param('surname',C4::Context->config('user'));
1303 $session->param('branch','NO_LIBRARY_SET');
1304 $session->param('branchname','NO_LIBRARY_SET');
1305 $session->param('flags',1);
1306 $session->param('emailaddress', C4::Context->preference('KohaAdminEmailAddress'));
1307 $session->param('ip',$session->remote_addr());
1308 $session->param('lasttime',time());
1310 C4::Context::set_userenv(
1311 $session->param('number'), $session->param('id'),
1312 $session->param('cardnumber'), $session->param('firstname'),
1313 $session->param('surname'), $session->param('branch'),
1314 $session->param('branchname'), $session->param('flags'),
1315 $session->param('emailaddress'), $session->param('branchprinter')
1317 return ("ok", $cookie, $sessionID);
1319 return ("failed", undef, undef);
1324 =head2 check_cookie_auth
1326 ($status, $sessionId) = check_api_auth($cookie, $userflags);
1328 Given a CGISESSID cookie set during a previous login to Koha, determine
1329 if the user has the privileges specified by C<$userflags>.
1331 C<check_cookie_auth> is meant for authenticating special services
1332 such as tools/upload-file.pl that are invoked by other pages that
1333 have been authenticated in the usual way.
1335 Possible return values in C<$status> are:
1339 =item "ok" -- user authenticated; C<$sessionID> have valid values.
1341 =item "failed" -- credentials are not correct; C<$sessionid> are undef
1343 =item "maintenance" -- DB is in maintenance mode; no login possible at the moment
1345 =item "expired -- session cookie has expired; API user should resubmit userid and password
1351 sub check_cookie_auth {
1353 my $flagsrequired = shift;
1355 my $dbh = C4::Context->dbh;
1356 my $timeout = _timeout_syspref();
1358 unless (C4::Context->preference('Version')) {
1359 # database has not been installed yet
1360 return ("maintenance", undef);
1362 my $kohaversion=C4::Context::KOHAVERSION;
1363 $kohaversion =~ s/(.*\..*)\.(.*)\.(.*)/$1$2$3/;
1364 if (C4::Context->preference('Version') < $kohaversion) {
1365 # database in need of version update; assume that
1366 # no API should be called while databsae is in
1368 return ("maintenance", undef);
1371 # FIXME -- most of what follows is a copy-and-paste
1372 # of code from checkauth. There is an obvious need
1373 # for refactoring to separate the various parts of
1374 # the authentication code, but as of 2007-11-23 this
1375 # is deferred so as to not introduce bugs into the
1376 # regular authentication code for Koha 3.0.
1378 # see if we have a valid session cookie already
1379 # however, if a userid parameter is present (i.e., from
1380 # a form submission, assume that any current cookie
1382 unless (defined $cookie and $cookie) {
1383 return ("failed", undef);
1385 my $sessionID = $cookie;
1386 my $session = get_session($sessionID);
1387 C4::Context->_new_userenv($sessionID);
1389 C4::Context::set_userenv(
1390 $session->param('number'), $session->param('id'),
1391 $session->param('cardnumber'), $session->param('firstname'),
1392 $session->param('surname'), $session->param('branch'),
1393 $session->param('branchname'), $session->param('flags'),
1394 $session->param('emailaddress'), $session->param('branchprinter')
1397 my $ip = $session->param('ip');
1398 my $lasttime = $session->param('lasttime');
1399 my $userid = $session->param('id');
1400 if ( $lasttime < time() - $timeout ) {
1403 C4::Context->_unset_userenv($sessionID);
1406 return ("expired", undef);
1407 } elsif ( $ip ne $ENV{'REMOTE_ADDR'} ) {
1408 # IP address changed
1410 C4::Context->_unset_userenv($sessionID);
1413 return ("expired", undef);
1415 $session->param('lasttime',time());
1416 my $flags = haspermission($userid, $flagsrequired);
1418 return ("ok", $sessionID);
1421 C4::Context->_unset_userenv($sessionID);
1424 return ("failed", undef);
1428 return ("expired", undef);
1435 my $session = get_session($sessionID);
1437 Given a session ID, retrieve the CGI::Session object used to store
1438 the session's state. The session object can be used to store
1439 data that needs to be accessed by different scripts during a
1442 If the C<$sessionID> parameter is an empty string, a new session
1448 my $sessionID = shift;
1449 my $storage_method = C4::Context->preference('SessionStorage');
1450 my $dbh = C4::Context->dbh;
1452 if ($storage_method eq 'mysql'){
1453 $session = new CGI::Session("driver:MySQL;serializer:yaml;id:md5", $sessionID, {Handle=>$dbh});
1455 elsif ($storage_method eq 'Pg') {
1456 $session = new CGI::Session("driver:PostgreSQL;serializer:yaml;id:md5", $sessionID, {Handle=>$dbh});
1458 elsif ($storage_method eq 'memcached' && C4::Context->ismemcached){
1459 $session = new CGI::Session("driver:memcached;serializer:yaml;id:md5", $sessionID, { Memcached => C4::Context->memcached } );
1462 # catch all defaults to tmp should work on all systems
1463 $session = new CGI::Session("driver:File;serializer:yaml;id:md5", $sessionID, {Directory=>'/tmp'});
1470 my ( $dbh, $userid, $password, $query ) = @_;
1472 $debug and print STDERR "## checkpw - checking LDAP\n";
1473 my ($retval,$retcard,$retuserid) = checkpw_ldap(@_); # EXTERNAL AUTH
1474 ($retval) and return ($retval,$retcard,$retuserid);
1477 if ($cas && $query && $query->param('ticket')) {
1478 $debug and print STDERR "## checkpw - checking CAS\n";
1479 # In case of a CAS authentication, we use the ticket instead of the password
1480 my $ticket = $query->param('ticket');
1481 my ($retval,$retcard,$retuserid) = checkpw_cas($dbh, $ticket, $query); # EXTERNAL AUTH
1482 ($retval) and return ($retval,$retcard,$retuserid);
1489 "select password,cardnumber,borrowernumber,userid,firstname,surname,branchcode,flags from borrowers where userid=?"
1491 $sth->execute($userid);
1493 my ( $md5password, $cardnumber, $borrowernumber, $userid, $firstname,
1494 $surname, $branchcode, $flags )
1496 if ( md5_base64($password) eq $md5password and $md5password ne "!") {
1498 C4::Context->set_userenv( "$borrowernumber", $userid, $cardnumber,
1499 $firstname, $surname, $branchcode, $flags );
1500 return 1, $cardnumber, $userid;
1505 "select password,cardnumber,borrowernumber,userid, firstname,surname,branchcode,flags from borrowers where cardnumber=?"
1507 $sth->execute($userid);
1509 my ( $md5password, $cardnumber, $borrowernumber, $userid, $firstname,
1510 $surname, $branchcode, $flags )
1512 if ( md5_base64($password) eq $md5password ) {
1514 C4::Context->set_userenv( $borrowernumber, $userid, $cardnumber,
1515 $firstname, $surname, $branchcode, $flags );
1516 return 1, $cardnumber, $userid;
1519 if ( $userid && $userid eq C4::Context->config('user')
1520 && "$password" eq C4::Context->config('pass') )
1523 # Koha superuser account
1524 # C4::Context->set_userenv(0,0,C4::Context->config('user'),C4::Context->config('user'),C4::Context->config('user'),"",1);
1527 if ( $userid && $userid eq 'demo'
1528 && "$password" eq 'demo'
1529 && C4::Context->config('demo') )
1532 # DEMO => the demo user is allowed to do everything (if demo set to 1 in koha.conf
1533 # some features won't be effective : modify systempref, modify MARC structure,
1541 my $authflags = getuserflags($flags, $userid, [$dbh]);
1543 Translates integer flags into permissions strings hash.
1545 C<$flags> is the integer userflags value ( borrowers.userflags )
1546 C<$userid> is the members.userid, used for building subpermissions
1547 C<$authflags> is a hashref of permissions
1554 my $dbh = @_ ? shift : C4::Context->dbh;
1557 # I don't want to do this, but if someone logs in as the database
1558 # user, it would be preferable not to spam them to death with
1559 # numeric warnings. So, we make $flags numeric.
1560 no warnings 'numeric';
1563 my $sth = $dbh->prepare("SELECT bit, flag, defaulton FROM userflags");
1566 while ( my ( $bit, $flag, $defaulton ) = $sth->fetchrow ) {
1567 if ( ( $flags & ( 2**$bit ) ) || $defaulton ) {
1568 $userflags->{$flag} = 1;
1571 $userflags->{$flag} = 0;
1575 # get subpermissions and merge with top-level permissions
1576 my $user_subperms = get_user_subpermissions($userid);
1577 foreach my $module (keys %$user_subperms) {
1578 next if $userflags->{$module} == 1; # user already has permission for everything in this module
1579 $userflags->{$module} = $user_subperms->{$module};
1585 =head2 get_user_subpermissions
1587 $user_perm_hashref = get_user_subpermissions($userid);
1589 Given the userid (note, not the borrowernumber) of a staff user,
1590 return a hashref of hashrefs of the specific subpermissions
1591 accorded to the user. An example return is
1595 export_catalog => 1,
1596 import_patrons => 1,
1600 The top-level hash-key is a module or function code from
1601 userflags.flag, while the second-level key is a code
1604 The results of this function do not give a complete picture
1605 of the functions that a staff user can access; it is also
1606 necessary to check borrowers.flags.
1610 sub get_user_subpermissions {
1613 my $dbh = C4::Context->dbh;
1614 my $sth = $dbh->prepare("SELECT flag, user_permissions.code
1615 FROM user_permissions
1616 JOIN permissions USING (module_bit, code)
1617 JOIN userflags ON (module_bit = bit)
1618 JOIN borrowers USING (borrowernumber)
1620 $sth->execute($userid);
1622 my $user_perms = {};
1623 while (my $perm = $sth->fetchrow_hashref) {
1624 $user_perms->{$perm->{'flag'}}->{$perm->{'code'}} = 1;
1629 =head2 get_all_subpermissions
1631 my $perm_hashref = get_all_subpermissions();
1633 Returns a hashref of hashrefs defining all specific
1634 permissions currently defined. The return value
1635 has the same structure as that of C<get_user_subpermissions>,
1636 except that the innermost hash value is the description
1637 of the subpermission.
1641 sub get_all_subpermissions {
1642 my $dbh = C4::Context->dbh;
1643 my $sth = $dbh->prepare("SELECT flag, code, description
1645 JOIN userflags ON (module_bit = bit)");
1649 while (my $perm = $sth->fetchrow_hashref) {
1650 $all_perms->{$perm->{'flag'}}->{$perm->{'code'}} = $perm->{'description'};
1655 =head2 haspermission
1657 $flags = ($userid, $flagsrequired);
1659 C<$userid> the userid of the member
1660 C<$flags> is a hashref of required flags like C<$borrower-<{authflags}>
1662 Returns member's flags or 0 if a permission is not met.
1667 my ($userid, $flagsrequired) = @_;
1668 my $sth = C4::Context->dbh->prepare("SELECT flags FROM borrowers WHERE userid=?");
1669 $sth->execute($userid);
1670 my $flags = getuserflags($sth->fetchrow(), $userid);
1671 if ( $userid eq C4::Context->config('user') ) {
1672 # Super User Account from /etc/koha.conf
1673 $flags->{'superlibrarian'} = 1;
1675 elsif ( $userid eq 'demo' && C4::Context->config('demo') ) {
1676 # Demo user that can do "anything" (demo=1 in /etc/koha.conf)
1677 $flags->{'superlibrarian'} = 1;
1680 return $flags if $flags->{superlibrarian};
1682 foreach my $module ( keys %$flagsrequired ) {
1683 my $subperm = $flagsrequired->{$module};
1684 if ($subperm eq '*') {
1685 return 0 unless ( $flags->{$module} == 1 or ref($flags->{$module}) );
1687 return 0 unless ( $flags->{$module} == 1 or
1688 ( ref($flags->{$module}) and
1689 exists $flags->{$module}->{$subperm} and
1690 $flags->{$module}->{$subperm} == 1
1696 #FIXME - This fcn should return the failed permission so a suitable error msg can be delivered.
1700 sub getborrowernumber {
1702 my $userenv = C4::Context->userenv;
1703 if ( defined( $userenv ) && ref( $userenv ) eq 'HASH' && $userenv->{number} ) {
1704 return $userenv->{number};
1706 my $dbh = C4::Context->dbh;
1707 for my $field ( 'userid', 'cardnumber' ) {
1709 $dbh->prepare("select borrowernumber from borrowers where $field=?");
1710 $sth->execute($userid);
1712 my ($bnumber) = $sth->fetchrow;
1720 END { } # module clean-up code here (global destructor)