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'}, $in->{'is_plugin'} );
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'},
150 # It's possible for $user to be the borrowernumber if they don't have a
151 # userid defined (and are logging in through some other method, such
152 # as SSL certs against an email address)
153 $borrowernumber = getborrowernumber($user) if defined($user);
154 if (!defined($borrowernumber) && defined($user)) {
155 my $borrower = C4::Members::GetMember(borrowernumber => $user);
157 $borrowernumber = $user;
158 # A bit of a hack, but I don't know there's a nicer way
160 $user = $borrower->{firstname} . ' ' . $borrower->{surname};
165 $template->param( loggedinusername => $user );
166 $template->param( sessionID => $sessionID );
168 my ($total, $pubshelves, $barshelves) = C4::VirtualShelves::GetSomeShelfNames($borrowernumber, 'MASTHEAD');
170 pubshelves => $total->{pubtotal},
171 pubshelvesloop => $pubshelves,
172 barshelves => $total->{bartotal},
173 barshelvesloop => $barshelves,
176 my ( $borr ) = C4::Members::GetMemberDetails( $borrowernumber );
179 $template->param( "USER_INFO" => \@bordat );
181 my $all_perms = get_all_subpermissions();
183 my @flagroots = qw(circulate catalogue parameters borrowers permissions reserveforothers borrow
184 editcatalogue updatecharges management tools editauthorities serials reports acquisition);
185 # We are going to use the $flags returned by checkauth
186 # to create the template's parameters that will indicate
187 # which menus the user can access.
188 if ( $flags && $flags->{superlibrarian}==1 ) {
189 $template->param( CAN_user_circulate => 1 );
190 $template->param( CAN_user_catalogue => 1 );
191 $template->param( CAN_user_parameters => 1 );
192 $template->param( CAN_user_borrowers => 1 );
193 $template->param( CAN_user_permissions => 1 );
194 $template->param( CAN_user_reserveforothers => 1 );
195 $template->param( CAN_user_borrow => 1 );
196 $template->param( CAN_user_editcatalogue => 1 );
197 $template->param( CAN_user_updatecharges => 1 );
198 $template->param( CAN_user_acquisition => 1 );
199 $template->param( CAN_user_management => 1 );
200 $template->param( CAN_user_tools => 1 );
201 $template->param( CAN_user_editauthorities => 1 );
202 $template->param( CAN_user_serials => 1 );
203 $template->param( CAN_user_reports => 1 );
204 $template->param( CAN_user_staffaccess => 1 );
205 $template->param( CAN_user_plugins => 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"}:undef),
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"}:undef),
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 EasyAnalyticalRecords => C4::Context->preference('EasyAnalyticalRecords'),
366 LocalCoverImages => C4::Context->preference('LocalCoverImages'),
367 OPACLocalCoverImages => C4::Context->preference('OPACLocalCoverImages'),
368 AllowMultipleCovers => C4::Context->preference('AllowMultipleCovers'),
369 EnableBorrowerFiles => C4::Context->preference('EnableBorrowerFiles'),
370 UseKohaPlugins => C4::Context->preference('UseKohaPlugins'),
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 ( $in->{'query'}->param('multibranchlimit') ) {
391 $opac_name = $in->{'query'}->param('multibranchlimit');
392 } elsif (C4::Context->preference("SearchMyLibraryFirst") && C4::Context->userenv && C4::Context->userenv->{'branch'}) {
393 $opac_name = C4::Context->userenv->{'branch'};
396 opaccolorstylesheet => C4::Context->preference("opaccolorstylesheet"),
397 AnonSuggestions => "" . C4::Context->preference("AnonSuggestions"),
398 AuthorisedValueImages => C4::Context->preference("AuthorisedValueImages"),
399 BranchesLoop => GetBranchesLoop($opac_name),
400 BranchCategoriesLoop => GetBranchCategories( undef, undef, 1, $opac_name ),
401 CalendarFirstDayOfWeek => (C4::Context->preference("CalendarFirstDayOfWeek") eq "Sunday")?0:1,
402 LibraryName => "" . C4::Context->preference("LibraryName"),
403 LibraryNameTitle => "" . $LibraryNameTitle,
404 LoginBranchname => C4::Context->userenv?C4::Context->userenv->{"branchname"}:"",
405 OPACAmazonCoverImages => C4::Context->preference("OPACAmazonCoverImages"),
406 OPACFRBRizeEditions => C4::Context->preference("OPACFRBRizeEditions"),
407 OpacHighlightedWords => C4::Context->preference("OpacHighlightedWords"),
408 OPACItemHolds => C4::Context->preference("OPACItemHolds"),
409 OPACShelfBrowser => "". C4::Context->preference("OPACShelfBrowser"),
410 OpacShowRecentComments => C4::Context->preference("OpacShowRecentComments"),
411 OPACURLOpenInNewWindow => "" . C4::Context->preference("OPACURLOpenInNewWindow"),
412 OPACUserCSS => "". C4::Context->preference("OPACUserCSS"),
413 OPACMobileUserCSS => "". C4::Context->preference("OPACMobileUserCSS"),
414 OPACViewOthersSuggestions => "" . C4::Context->preference("OPACViewOthersSuggestions"),
415 OpacAuthorities => C4::Context->preference("OpacAuthorities"),
416 OPACBaseURL => ($in->{'query'}->https() ? "https://" : "http://") . $ENV{'SERVER_NAME'} .
417 ($ENV{'SERVER_PORT'} eq ($in->{'query'}->https() ? "443" : "80") ? '' : ":$ENV{'SERVER_PORT'}"),
418 opac_css_override => $ENV{'OPAC_CSS_OVERRIDE'},
419 opac_search_limit => $opac_search_limit,
420 opac_limit_override => $opac_limit_override,
421 OpacBrowser => C4::Context->preference("OpacBrowser"),
422 OpacCloud => C4::Context->preference("OpacCloud"),
423 OpacKohaUrl => C4::Context->preference("OpacKohaUrl"),
424 OpacMainUserBlock => "" . C4::Context->preference("OpacMainUserBlock"),
425 OpacMainUserBlockMobile => "" . C4::Context->preference("OpacMainUserBlockMobile"),
426 OpacShowFiltersPulldownMobile => C4::Context->preference("OpacShowFiltersPulldownMobile"),
427 OpacShowLibrariesPulldownMobile => C4::Context->preference("OpacShowLibrariesPulldownMobile"),
428 OpacNav => "" . C4::Context->preference("OpacNav"),
429 OpacNavRight => "" . C4::Context->preference("OpacNavRight"),
430 OpacNavBottom => "" . C4::Context->preference("OpacNavBottom"),
431 OpacPasswordChange => C4::Context->preference("OpacPasswordChange"),
432 OPACPatronDetails => C4::Context->preference("OPACPatronDetails"),
433 OPACPrivacy => C4::Context->preference("OPACPrivacy"),
434 OPACFinesTab => C4::Context->preference("OPACFinesTab"),
435 OpacTopissue => C4::Context->preference("OpacTopissue"),
436 RequestOnOpac => C4::Context->preference("RequestOnOpac"),
437 'Version' => C4::Context->preference('Version'),
438 hidelostitems => C4::Context->preference("hidelostitems"),
439 mylibraryfirst => (C4::Context->preference("SearchMyLibraryFirst") && C4::Context->userenv) ? C4::Context->userenv->{'branch'} : '',
440 opaclayoutstylesheet => "" . C4::Context->preference("opaclayoutstylesheet"),
441 opacbookbag => "" . C4::Context->preference("opacbookbag"),
442 opaccredits => "" . C4::Context->preference("opaccredits"),
443 OpacFavicon => C4::Context->preference("OpacFavicon"),
444 opacheader => "" . C4::Context->preference("opacheader"),
445 opaclanguagesdisplay => "" . C4::Context->preference("opaclanguagesdisplay"),
446 opacreadinghistory => C4::Context->preference("opacreadinghistory"),
447 opacsmallimage => "" . C4::Context->preference("opacsmallimage"),
448 opacuserjs => C4::Context->preference("opacuserjs"),
449 opacuserlogin => "" . C4::Context->preference("opacuserlogin"),
450 reviewson => C4::Context->preference("reviewson"),
451 ShowReviewer => C4::Context->preference("ShowReviewer"),
452 ShowReviewerPhoto => C4::Context->preference("ShowReviewerPhoto"),
453 suggestion => "" . C4::Context->preference("suggestion"),
454 virtualshelves => "" . C4::Context->preference("virtualshelves"),
455 OPACSerialIssueDisplayCount => C4::Context->preference("OPACSerialIssueDisplayCount"),
456 OpacAddMastheadLibraryPulldown => C4::Context->preference("OpacAddMastheadLibraryPulldown"),
457 OPACXSLTDetailsDisplay => C4::Context->preference("OPACXSLTDetailsDisplay"),
458 OPACXSLTResultsDisplay => C4::Context->preference("OPACXSLTResultsDisplay"),
459 SyndeticsClientCode => C4::Context->preference("SyndeticsClientCode"),
460 SyndeticsEnabled => C4::Context->preference("SyndeticsEnabled"),
461 SyndeticsCoverImages => C4::Context->preference("SyndeticsCoverImages"),
462 SyndeticsTOC => C4::Context->preference("SyndeticsTOC"),
463 SyndeticsSummary => C4::Context->preference("SyndeticsSummary"),
464 SyndeticsEditions => C4::Context->preference("SyndeticsEditions"),
465 SyndeticsExcerpt => C4::Context->preference("SyndeticsExcerpt"),
466 SyndeticsReviews => C4::Context->preference("SyndeticsReviews"),
467 SyndeticsAuthorNotes => C4::Context->preference("SyndeticsAuthorNotes"),
468 SyndeticsAwards => C4::Context->preference("SyndeticsAwards"),
469 SyndeticsSeries => C4::Context->preference("SyndeticsSeries"),
470 SyndeticsCoverImageSize => C4::Context->preference("SyndeticsCoverImageSize"),
471 OPACLocalCoverImages => C4::Context->preference("OPACLocalCoverImages"),
472 PatronSelfRegistration => C4::Context->preference("PatronSelfRegistration"),
473 PatronSelfRegistrationDefaultCategory => C4::Context->preference("PatronSelfRegistrationDefaultCategory"),
476 $template->param(OpacPublic => '1') if ($user || C4::Context->preference("OpacPublic"));
478 return ( $template, $borrowernumber, $cookie, $flags);
483 ($userid, $cookie, $sessionID) = &checkauth($query, $noauth, $flagsrequired, $type);
485 Verifies that the user is authorized to run this script. If
486 the user is authorized, a (userid, cookie, session-id, flags)
487 quadruple is returned. If the user is not authorized but does
488 not have the required privilege (see $flagsrequired below), it
489 displays an error page and exits. Otherwise, it displays the
490 login page and exits.
492 Note that C<&checkauth> will return if and only if the user
493 is authorized, so it should be called early on, before any
494 unfinished operations (e.g., if you've opened a file, then
495 C<&checkauth> won't close it for you).
497 C<$query> is the CGI object for the script calling C<&checkauth>.
499 The C<$noauth> argument is optional. If it is set, then no
500 authorization is required for the script.
502 C<&checkauth> fetches user and session information from C<$query> and
503 ensures that the user is authorized to run scripts that require
506 The C<$flagsrequired> argument specifies the required privileges
507 the user must have if the username and password are correct.
508 It should be specified as a reference-to-hash; keys in the hash
509 should be the "flags" for the user, as specified in the Members
510 intranet module. Any key specified must correspond to a "flag"
511 in the userflags table. E.g., { circulate => 1 } would specify
512 that the user must have the "circulate" privilege in order to
513 proceed. To make sure that access control is correct, the
514 C<$flagsrequired> parameter must be specified correctly.
516 Koha also has a concept of sub-permissions, also known as
517 granular permissions. This makes the value of each key
518 in the C<flagsrequired> hash take on an additional
523 The user must have access to all subfunctions of the module
524 specified by the hash key.
528 The user must have access to at least one subfunction of the module
529 specified by the hash key.
531 specific permission, e.g., 'export_catalog'
533 The user must have access to the specific subfunction list, which
534 must correspond to a row in the permissions table.
536 The C<$type> argument specifies whether the template should be
537 retrieved from the opac or intranet directory tree. "opac" is
538 assumed if it is not specified; however, if C<$type> is specified,
539 "intranet" is assumed if it is not "opac".
541 If C<$query> does not have a valid session ID associated with it
542 (i.e., the user has not logged in) or if the session has expired,
543 C<&checkauth> presents the user with a login page (from the point of
544 view of the original script, C<&checkauth> does not return). Once the
545 user has authenticated, C<&checkauth> restarts the original script
546 (this time, C<&checkauth> returns).
548 The login page is provided using a HTML::Template, which is set in the
549 systempreferences table or at the top of this file. The variable C<$type>
550 selects which template to use, either the opac or the intranet
551 authentification template.
553 C<&checkauth> returns a user ID, a cookie, and a session ID. The
554 cookie should be sent back to the browser; it verifies that the user
563 # If Version syspref is unavailable, it means Koha is beeing installed,
564 # and so we must redirect to OPAC maintenance page or to the WebInstaller
565 # also, if OpacMaintenance is ON, OPAC should redirect to maintenance
566 if (C4::Context->preference('OpacMaintenance') && $type eq 'opac') {
567 warn "OPAC Install required, redirecting to maintenance";
568 print $query->redirect("/cgi-bin/koha/maintenance.pl");
571 unless ( $version = C4::Context->preference('Version') ) { # assignment, not comparison
572 if ( $type ne 'opac' ) {
573 warn "Install required, redirecting to Installer";
574 print $query->redirect("/cgi-bin/koha/installer/install.pl");
576 warn "OPAC Install required, redirecting to maintenance";
577 print $query->redirect("/cgi-bin/koha/maintenance.pl");
582 # check that database and koha version are the same
583 # there is no DB version, it's a fresh install,
584 # go to web installer
585 # there is a DB version, compare it to the code version
586 my $kohaversion=C4::Context::KOHAVERSION;
587 # remove the 3 last . to have a Perl number
588 $kohaversion =~ s/(.*\..*)\.(.*)\.(.*)/$1$2$3/;
589 $debug and print STDERR "kohaversion : $kohaversion\n";
590 if ($version < $kohaversion){
591 my $warning = "Database update needed, redirecting to %s. Database is $version and Koha is $kohaversion";
592 if ($type ne 'opac'){
593 warn sprintf($warning, 'Installer');
594 print $query->redirect("/cgi-bin/koha/installer/install.pl?step=3");
596 warn sprintf("OPAC: " . $warning, 'maintenance');
597 print $query->redirect("/cgi-bin/koha/maintenance.pl");
605 open my $fh, '>>', "/tmp/sessionlog" or warn "ERROR: Cannot append to /tmp/sessionlog";
606 printf $fh join("\n",@_);
610 sub _timeout_syspref {
611 my $timeout = C4::Context->preference('timeout') || 600;
612 # value in days, convert in seconds
613 if ($timeout =~ /(\d+)[dD]/) {
614 $timeout = $1 * 86400;
621 $debug and warn "Checking Auth";
622 # $authnotrequired will be set for scripts which will run without authentication
623 my $authnotrequired = shift;
624 my $flagsrequired = shift;
627 $type = 'opac' unless $type;
629 my $dbh = C4::Context->dbh;
630 my $timeout = _timeout_syspref();
632 _version_check($type,$query);
636 my ( $userid, $cookie, $sessionID, $flags, $barshelves, $pubshelves );
637 my $logout = $query->param('logout.x');
639 # This parameter is the name of the CAS server we want to authenticate against,
640 # when using authentication against multiple CAS servers, as configured in Auth_cas_servers.yaml
641 my $casparam = $query->param('cas');
643 if ( $userid = $ENV{'REMOTE_USER'} ) {
644 # Using Basic Authentication, no cookies required
645 $cookie = $query->cookie(
646 -name => 'CGISESSID',
654 # we dont want to set a session because we are being called by a persona callback
656 elsif ( $sessionID = $query->cookie("CGISESSID") )
657 { # 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'),
668 $session->param('persona')
670 C4::Context::set_shelves_userenv('bar',$session->param('barshelves'));
671 C4::Context::set_shelves_userenv('pub',$session->param('pubshelves'));
672 C4::Context::set_shelves_userenv('tot',$session->param('totshelves'));
673 $debug and printf STDERR "AUTH_SESSION: (%s)\t%s %s - %s\n", map {$session->param($_)} qw(cardnumber firstname surname branch) ;
674 $ip = $session->param('ip');
675 $lasttime = $session->param('lasttime');
676 $userid = $session->param('id');
677 $sessiontype = $session->param('sessiontype') || '';
679 if ( ( ($query->param('koha_login_context')) && ($query->param('userid') ne $session->param('id')) )
680 || ( $cas && $query->param('ticket') ) ) {
681 #if a user enters an id ne to the id in the current session, we need to log them in...
682 #first we need to clear the anonymous session...
683 $debug and warn "query id = " . $query->param('userid') . " but session id = " . $session->param('id');
686 C4::Context->_unset_userenv($sessionID);
691 # voluntary logout the user
694 C4::Context->_unset_userenv($sessionID);
695 #_session_log(sprintf "%20s from %16s logged out at %30s (manually).\n", $userid,$ip,(strftime "%c",localtime));
699 if ($cas and $caslogout) {
703 elsif ( $lasttime < time() - $timeout ) {
705 $info{'timed_out'} = 1;
706 $session->delete() if $session;
707 C4::Context->_unset_userenv($sessionID);
708 #_session_log(sprintf "%20s from %16s logged out at %30s (inactivity).\n", $userid,$ip,(strftime "%c",localtime));
712 elsif ( $ip ne $ENV{'REMOTE_ADDR'} ) {
713 # Different ip than originally logged in from
714 $info{'oldip'} = $ip;
715 $info{'newip'} = $ENV{'REMOTE_ADDR'};
716 $info{'different_ip'} = 1;
718 C4::Context->_unset_userenv($sessionID);
719 #_session_log(sprintf "%20s from %16s logged out at %30s (ip changed to %16s).\n", $userid,$ip,(strftime "%c",localtime), $info{'newip'});
724 $cookie = $query->cookie(
725 -name => 'CGISESSID',
726 -value => $session->id,
729 $session->param( 'lasttime', time() );
730 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...
731 $flags = haspermission($userid, $flagsrequired);
735 $info{'nopermission'} = 1;
740 unless ($userid || $sessionID) {
742 #we initiate a session prior to checking for a username to allow for anonymous sessions...
743 my $session = get_session("") or die "Auth ERROR: Cannot get_session()";
744 my $sessionID = $session->id;
745 C4::Context->_new_userenv($sessionID);
746 $cookie = $query->cookie(
747 -name => 'CGISESSID',
748 -value => $session->id,
751 $userid = $query->param('userid');
752 if ( ( $cas && $query->param('ticket') )
754 || ( my $pki_field = C4::Context->preference('AllowPKIAuth') ) ne
757 my $password = $query->param('password');
759 my ( $return, $cardnumber );
760 if ( $cas && $query->param('ticket') ) {
762 ( $return, $cardnumber, $retuserid ) =
763 checkpw( $dbh, $userid, $password, $query );
764 $userid = $retuserid;
765 $info{'invalidCasLogin'} = 1 unless ($return);
769 my $value = $persona;
771 # If we're looking up the email, there's a chance that the person
772 # doesn't have a userid. So if there is none, we pass along the
773 # borrower number, and the bits of code that need to know the user
774 # ID will have to be smart enough to handle that.
776 my @users_info = C4::Members::GetBorrowersWithEmail($value);
779 # First the userid, then the borrowernum
780 $value = $users_info[0][1] || $users_info[0][0];
785 $return = $value ? 1 : 0;
790 ( $pki_field eq 'Common Name' && $ENV{'SSL_CLIENT_S_DN_CN'} )
791 || ( $pki_field eq 'emailAddress'
792 && $ENV{'SSL_CLIENT_S_DN_Email'} )
796 if ( $pki_field eq 'Common Name' ) {
797 $value = $ENV{'SSL_CLIENT_S_DN_CN'};
799 elsif ( $pki_field eq 'emailAddress' ) {
800 $value = $ENV{'SSL_CLIENT_S_DN_Email'};
802 # If we're looking up the email, there's a chance that the person
803 # doesn't have a userid. So if there is none, we pass along the
804 # borrower number, and the bits of code that need to know the user
805 # ID will have to be smart enough to handle that.
807 my @users_info = C4::Members::GetBorrowersWithEmail($value);
810 # First the userid, then the borrowernum
811 $value = $users_info[0][1] || $users_info[0][0];
818 $return = $value ? 1 : 0;
824 ( $return, $cardnumber, $retuserid ) =
825 checkpw( $dbh, $userid, $password, $query );
826 $userid = $retuserid if ( $retuserid ne '' );
829 #_session_log(sprintf "%20s from %16s logged in at %30s.\n", $userid,$ENV{'REMOTE_ADDR'},(strftime '%c', localtime));
830 if ( $flags = haspermission( $userid, $flagsrequired ) ) {
834 $info{'nopermission'} = 1;
835 C4::Context->_unset_userenv($sessionID);
837 my ($borrowernumber, $firstname, $surname, $userflags,
838 $branchcode, $branchname, $branchprinter, $emailaddress);
840 if ( $return == 1 ) {
842 SELECT borrowernumber, firstname, surname, flags, borrowers.branchcode,
843 branches.branchname as branchname,
844 branches.branchprinter as branchprinter,
847 LEFT JOIN branches on borrowers.branchcode=branches.branchcode
849 my $sth = $dbh->prepare("$select where userid=?");
850 $sth->execute($userid);
851 unless ($sth->rows) {
852 $debug and print STDERR "AUTH_1: no rows for userid='$userid'\n";
853 $sth = $dbh->prepare("$select where cardnumber=?");
854 $sth->execute($cardnumber);
856 unless ($sth->rows) {
857 $debug and print STDERR "AUTH_2a: no rows for cardnumber='$cardnumber'\n";
858 $sth->execute($userid);
859 unless ($sth->rows) {
860 $debug and print STDERR "AUTH_2b: no rows for userid='$userid' AS cardnumber\n";
865 ($borrowernumber, $firstname, $surname, $userflags,
866 $branchcode, $branchname, $branchprinter, $emailaddress) = $sth->fetchrow;
867 $debug and print STDERR "AUTH_3 results: " .
868 "$cardnumber,$borrowernumber,$userid,$firstname,$surname,$userflags,$branchcode,$emailaddress\n";
870 print STDERR "AUTH_3: no results for userid='$userid', cardnumber='$cardnumber'.\n";
873 # launch a sequence to check if we have a ip for the branch, i
874 # if we have one we replace the branchcode of the userenv by the branch bound in the ip.
876 my $ip = $ENV{'REMOTE_ADDR'};
877 # if they specify at login, use that
878 if ($query->param('branch')) {
879 $branchcode = $query->param('branch');
880 $branchname = GetBranchName($branchcode);
882 my $branches = GetBranches();
883 if (C4::Context->boolean_preference('IndependantBranches') && C4::Context->boolean_preference('Autolocation')){
884 # we have to check they are coming from the right ip range
885 my $domain = $branches->{$branchcode}->{'branchip'};
886 if ($ip !~ /^$domain/){
888 $info{'wrongip'} = 1;
893 foreach my $br ( keys %$branches ) {
894 # now we work with the treatment of ip
895 my $domain = $branches->{$br}->{'branchip'};
896 if ( $domain && $ip =~ /^$domain/ ) {
897 $branchcode = $branches->{$br}->{'branchcode'};
899 # new op dev : add the branchprinter and branchname in the cookie
900 $branchprinter = $branches->{$br}->{'branchprinter'};
901 $branchname = $branches->{$br}->{'branchname'};
904 $session->param('number',$borrowernumber);
905 $session->param('id',$userid);
906 $session->param('cardnumber',$cardnumber);
907 $session->param('firstname',$firstname);
908 $session->param('surname',$surname);
909 $session->param('branch',$branchcode);
910 $session->param('branchname',$branchname);
911 $session->param('flags',$userflags);
912 $session->param('emailaddress',$emailaddress);
913 $session->param('ip',$session->remote_addr());
914 $session->param('lasttime',time());
915 $debug and printf STDERR "AUTH_4: (%s)\t%s %s - %s\n", map {$session->param($_)} qw(cardnumber firstname surname branch) ;
917 elsif ( $return == 2 ) {
918 #We suppose the user is the superlibrarian
920 $session->param('number',0);
921 $session->param('id',C4::Context->config('user'));
922 $session->param('cardnumber',C4::Context->config('user'));
923 $session->param('firstname',C4::Context->config('user'));
924 $session->param('surname',C4::Context->config('user'));
925 $session->param('branch','NO_LIBRARY_SET');
926 $session->param('branchname','NO_LIBRARY_SET');
927 $session->param('flags',1);
928 $session->param('emailaddress', C4::Context->preference('KohaAdminEmailAddress'));
929 $session->param('ip',$session->remote_addr());
930 $session->param('lasttime',time());
933 $session->param('persona',1);
935 C4::Context::set_userenv(
936 $session->param('number'), $session->param('id'),
937 $session->param('cardnumber'), $session->param('firstname'),
938 $session->param('surname'), $session->param('branch'),
939 $session->param('branchname'), $session->param('flags'),
940 $session->param('emailaddress'), $session->param('branchprinter'),
941 $session->param('persona')
947 $info{'invalid_username_or_password'} = 1;
948 C4::Context->_unset_userenv($sessionID);
951 } # END if ( $userid = $query->param('userid') )
952 elsif ($type eq "opac") {
953 # if we are here this is an anonymous session; add public lists to it and a few other items...
954 # anonymous sessions are created only for the OPAC
955 $debug and warn "Initiating an anonymous session...";
957 # setting a couple of other session vars...
958 $session->param('ip',$session->remote_addr());
959 $session->param('lasttime',time());
960 $session->param('sessiontype','anon');
962 } # END unless ($userid)
964 # finished authentification, now respond
965 if ( $loggedin || $authnotrequired )
969 $cookie = $query->cookie(
970 -name => 'CGISESSID',
975 return ( $userid, $cookie, $sessionID, $flags );
980 # AUTH rejected, show the login/password template, after checking the DB.
984 # get the inputs from the incoming query
986 foreach my $name ( param $query) {
987 (next) if ( $name eq 'userid' || $name eq 'password' || $name eq 'ticket' );
988 my $value = $query->param($name);
989 push @inputs, { name => $name, value => $value };
992 my $template_name = ( $type eq 'opac' ) ? 'opac-auth.tmpl' : 'auth.tmpl';
993 my $template = C4::Templates::gettemplate($template_name, $type, $query );
995 branchloop => GetBranchesLoop(),
996 opaccolorstylesheet => C4::Context->preference("opaccolorstylesheet"),
997 opaclayoutstylesheet => C4::Context->preference("opaclayoutstylesheet"),
1000 casAuthentication => C4::Context->preference("casAuthentication"),
1001 suggestion => C4::Context->preference("suggestion"),
1002 virtualshelves => C4::Context->preference("virtualshelves"),
1003 LibraryName => C4::Context->preference("LibraryName"),
1004 opacuserlogin => C4::Context->preference("opacuserlogin"),
1005 OpacNav => C4::Context->preference("OpacNav"),
1006 OpacNavRight => C4::Context->preference("OpacNavRight"),
1007 OpacNavBottom => C4::Context->preference("OpacNavBottom"),
1008 opaccredits => C4::Context->preference("opaccredits"),
1009 OpacFavicon => C4::Context->preference("OpacFavicon"),
1010 opacreadinghistory => C4::Context->preference("opacreadinghistory"),
1011 opacsmallimage => C4::Context->preference("opacsmallimage"),
1012 opaclanguagesdisplay => C4::Context->preference("opaclanguagesdisplay"),
1013 opacuserjs => C4::Context->preference("opacuserjs"),
1014 opacbookbag => "" . C4::Context->preference("opacbookbag"),
1015 OpacCloud => C4::Context->preference("OpacCloud"),
1016 OpacTopissue => C4::Context->preference("OpacTopissue"),
1017 OpacAuthorities => C4::Context->preference("OpacAuthorities"),
1018 OpacBrowser => C4::Context->preference("OpacBrowser"),
1019 opacheader => C4::Context->preference("opacheader"),
1020 TagsEnabled => C4::Context->preference("TagsEnabled"),
1021 OPACUserCSS => C4::Context->preference("OPACUserCSS"),
1022 intranetcolorstylesheet => C4::Context->preference("intranetcolorstylesheet"),
1023 intranetstylesheet => C4::Context->preference("intranetstylesheet"),
1024 intranetbookbag => C4::Context->preference("intranetbookbag"),
1025 IntranetNav => C4::Context->preference("IntranetNav"),
1026 IntranetFavicon => C4::Context->preference("IntranetFavicon"),
1027 intranetuserjs => C4::Context->preference("intranetuserjs"),
1028 IndependantBranches=> C4::Context->preference("IndependantBranches"),
1029 AutoLocation => C4::Context->preference("AutoLocation"),
1030 wrongip => $info{'wrongip'},
1031 PatronSelfRegistration => C4::Context->preference("PatronSelfRegistration"),
1032 PatronSelfRegistrationDefaultCategory => C4::Context->preference("PatronSelfRegistrationDefaultCategory"),
1033 persona => C4::Context->preference("Persona"),
1036 $template->param( OpacPublic => C4::Context->preference("OpacPublic"));
1037 $template->param( loginprompt => 1 ) unless $info{'nopermission'};
1041 # Is authentication against multiple CAS servers enabled?
1042 if (C4::Auth_with_cas::multipleAuth && !$casparam) {
1043 my $casservers = C4::Auth_with_cas::getMultipleAuth();
1045 foreach my $key (keys %$casservers) {
1046 push @tmplservers, {name => $key, value => login_cas_url($query, $key) . "?cas=$key" };
1049 casServersLoop => \@tmplservers
1053 casServerUrl => login_cas_url($query),
1058 invalidCasLogin => $info{'invalidCasLogin'}
1062 my $self_url = $query->url( -absolute => 1 );
1065 LibraryName => C4::Context->preference("LibraryName"),
1067 $template->param( %info );
1068 # $cookie = $query->cookie(CGISESSID => $session->id
1070 print $query->header(
1071 -type => 'text/html',
1072 -charset => 'utf-8',
1079 =head2 check_api_auth
1081 ($status, $cookie, $sessionId) = check_api_auth($query, $userflags);
1083 Given a CGI query containing the parameters 'userid' and 'password' and/or a session
1084 cookie, determine if the user has the privileges specified by C<$userflags>.
1086 C<check_api_auth> is is meant for authenticating users of web services, and
1087 consequently will always return and will not attempt to redirect the user
1090 If a valid session cookie is already present, check_api_auth will return a status
1091 of "ok", the cookie, and the Koha session ID.
1093 If no session cookie is present, check_api_auth will check the 'userid' and 'password
1094 parameters and create a session cookie and Koha session if the supplied credentials
1097 Possible return values in C<$status> are:
1101 =item "ok" -- user authenticated; C<$cookie> and C<$sessionid> have valid values.
1103 =item "failed" -- credentials are not correct; C<$cookie> and C<$sessionid> are undef
1105 =item "maintenance" -- DB is in maintenance mode; no login possible at the moment
1107 =item "expired -- session cookie has expired; API user should resubmit userid and password
1113 sub check_api_auth {
1115 my $flagsrequired = shift;
1117 my $dbh = C4::Context->dbh;
1118 my $timeout = _timeout_syspref();
1120 unless (C4::Context->preference('Version')) {
1121 # database has not been installed yet
1122 return ("maintenance", undef, undef);
1124 my $kohaversion=C4::Context::KOHAVERSION;
1125 $kohaversion =~ s/(.*\..*)\.(.*)\.(.*)/$1$2$3/;
1126 if (C4::Context->preference('Version') < $kohaversion) {
1127 # database in need of version update; assume that
1128 # no API should be called while databsae is in
1130 return ("maintenance", undef, undef);
1133 # FIXME -- most of what follows is a copy-and-paste
1134 # of code from checkauth. There is an obvious need
1135 # for refactoring to separate the various parts of
1136 # the authentication code, but as of 2007-11-19 this
1137 # is deferred so as to not introduce bugs into the
1138 # regular authentication code for Koha 3.0.
1140 # see if we have a valid session cookie already
1141 # however, if a userid parameter is present (i.e., from
1142 # a form submission, assume that any current cookie
1144 my $sessionID = undef;
1145 unless ($query->param('userid')) {
1146 $sessionID = $query->cookie("CGISESSID");
1148 if ($sessionID && not ($cas && $query->param('PT')) ) {
1149 my $session = get_session($sessionID);
1150 C4::Context->_new_userenv($sessionID);
1152 C4::Context::set_userenv(
1153 $session->param('number'), $session->param('id'),
1154 $session->param('cardnumber'), $session->param('firstname'),
1155 $session->param('surname'), $session->param('branch'),
1156 $session->param('branchname'), $session->param('flags'),
1157 $session->param('emailaddress'), $session->param('branchprinter')
1160 my $ip = $session->param('ip');
1161 my $lasttime = $session->param('lasttime');
1162 my $userid = $session->param('id');
1163 if ( $lasttime < time() - $timeout ) {
1166 C4::Context->_unset_userenv($sessionID);
1169 return ("expired", undef, undef);
1170 } elsif ( $ip ne $ENV{'REMOTE_ADDR'} ) {
1171 # IP address changed
1173 C4::Context->_unset_userenv($sessionID);
1176 return ("expired", undef, undef);
1178 my $cookie = $query->cookie(
1179 -name => 'CGISESSID',
1180 -value => $session->id,
1183 $session->param('lasttime',time());
1184 my $flags = haspermission($userid, $flagsrequired);
1186 return ("ok", $cookie, $sessionID);
1189 C4::Context->_unset_userenv($sessionID);
1192 return ("failed", undef, undef);
1196 return ("expired", undef, undef);
1200 my $userid = $query->param('userid');
1201 my $password = $query->param('password');
1202 my ($return, $cardnumber);
1205 if ($cas && $query->param('PT')) {
1207 $debug and print STDERR "## check_api_auth - checking CAS\n";
1208 # In case of a CAS authentication, we use the ticket instead of the password
1209 my $PT = $query->param('PT');
1210 ($return,$cardnumber,$userid) = check_api_auth_cas($dbh, $PT, $query); # EXTERNAL AUTH
1212 # User / password auth
1213 unless ($userid and $password) {
1214 # caller did something wrong, fail the authenticateion
1215 return ("failed", undef, undef);
1217 ( $return, $cardnumber ) = checkpw( $dbh, $userid, $password, $query );
1220 if ($return and haspermission( $userid, $flagsrequired)) {
1221 my $session = get_session("");
1222 return ("failed", undef, undef) unless $session;
1224 my $sessionID = $session->id;
1225 C4::Context->_new_userenv($sessionID);
1226 my $cookie = $query->cookie(
1227 -name => 'CGISESSID',
1228 -value => $sessionID,
1231 if ( $return == 1 ) {
1233 $borrowernumber, $firstname, $surname,
1234 $userflags, $branchcode, $branchname,
1235 $branchprinter, $emailaddress
1239 "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=?"
1241 $sth->execute($userid);
1243 $borrowernumber, $firstname, $surname,
1244 $userflags, $branchcode, $branchname,
1245 $branchprinter, $emailaddress
1246 ) = $sth->fetchrow if ( $sth->rows );
1248 unless ($sth->rows ) {
1249 my $sth = $dbh->prepare(
1250 "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=?"
1252 $sth->execute($cardnumber);
1254 $borrowernumber, $firstname, $surname,
1255 $userflags, $branchcode, $branchname,
1256 $branchprinter, $emailaddress
1257 ) = $sth->fetchrow if ( $sth->rows );
1259 unless ( $sth->rows ) {
1260 $sth->execute($userid);
1262 $borrowernumber, $firstname, $surname, $userflags,
1263 $branchcode, $branchname, $branchprinter, $emailaddress
1264 ) = $sth->fetchrow if ( $sth->rows );
1268 my $ip = $ENV{'REMOTE_ADDR'};
1269 # if they specify at login, use that
1270 if ($query->param('branch')) {
1271 $branchcode = $query->param('branch');
1272 $branchname = GetBranchName($branchcode);
1274 my $branches = GetBranches();
1276 foreach my $br ( keys %$branches ) {
1277 # now we work with the treatment of ip
1278 my $domain = $branches->{$br}->{'branchip'};
1279 if ( $domain && $ip =~ /^$domain/ ) {
1280 $branchcode = $branches->{$br}->{'branchcode'};
1282 # new op dev : add the branchprinter and branchname in the cookie
1283 $branchprinter = $branches->{$br}->{'branchprinter'};
1284 $branchname = $branches->{$br}->{'branchname'};
1287 $session->param('number',$borrowernumber);
1288 $session->param('id',$userid);
1289 $session->param('cardnumber',$cardnumber);
1290 $session->param('firstname',$firstname);
1291 $session->param('surname',$surname);
1292 $session->param('branch',$branchcode);
1293 $session->param('branchname',$branchname);
1294 $session->param('flags',$userflags);
1295 $session->param('emailaddress',$emailaddress);
1296 $session->param('ip',$session->remote_addr());
1297 $session->param('lasttime',time());
1298 } elsif ( $return == 2 ) {
1299 #We suppose the user is the superlibrarian
1300 $session->param('number',0);
1301 $session->param('id',C4::Context->config('user'));
1302 $session->param('cardnumber',C4::Context->config('user'));
1303 $session->param('firstname',C4::Context->config('user'));
1304 $session->param('surname',C4::Context->config('user'));
1305 $session->param('branch','NO_LIBRARY_SET');
1306 $session->param('branchname','NO_LIBRARY_SET');
1307 $session->param('flags',1);
1308 $session->param('emailaddress', C4::Context->preference('KohaAdminEmailAddress'));
1309 $session->param('ip',$session->remote_addr());
1310 $session->param('lasttime',time());
1312 C4::Context::set_userenv(
1313 $session->param('number'), $session->param('id'),
1314 $session->param('cardnumber'), $session->param('firstname'),
1315 $session->param('surname'), $session->param('branch'),
1316 $session->param('branchname'), $session->param('flags'),
1317 $session->param('emailaddress'), $session->param('branchprinter')
1319 return ("ok", $cookie, $sessionID);
1321 return ("failed", undef, undef);
1326 =head2 check_cookie_auth
1328 ($status, $sessionId) = check_api_auth($cookie, $userflags);
1330 Given a CGISESSID cookie set during a previous login to Koha, determine
1331 if the user has the privileges specified by C<$userflags>.
1333 C<check_cookie_auth> is meant for authenticating special services
1334 such as tools/upload-file.pl that are invoked by other pages that
1335 have been authenticated in the usual way.
1337 Possible return values in C<$status> are:
1341 =item "ok" -- user authenticated; C<$sessionID> have valid values.
1343 =item "failed" -- credentials are not correct; C<$sessionid> are undef
1345 =item "maintenance" -- DB is in maintenance mode; no login possible at the moment
1347 =item "expired -- session cookie has expired; API user should resubmit userid and password
1353 sub check_cookie_auth {
1355 my $flagsrequired = shift;
1357 my $dbh = C4::Context->dbh;
1358 my $timeout = _timeout_syspref();
1360 unless (C4::Context->preference('Version')) {
1361 # database has not been installed yet
1362 return ("maintenance", undef);
1364 my $kohaversion=C4::Context::KOHAVERSION;
1365 $kohaversion =~ s/(.*\..*)\.(.*)\.(.*)/$1$2$3/;
1366 if (C4::Context->preference('Version') < $kohaversion) {
1367 # database in need of version update; assume that
1368 # no API should be called while databsae is in
1370 return ("maintenance", undef);
1373 # FIXME -- most of what follows is a copy-and-paste
1374 # of code from checkauth. There is an obvious need
1375 # for refactoring to separate the various parts of
1376 # the authentication code, but as of 2007-11-23 this
1377 # is deferred so as to not introduce bugs into the
1378 # regular authentication code for Koha 3.0.
1380 # see if we have a valid session cookie already
1381 # however, if a userid parameter is present (i.e., from
1382 # a form submission, assume that any current cookie
1384 unless (defined $cookie and $cookie) {
1385 return ("failed", undef);
1387 my $sessionID = $cookie;
1388 my $session = get_session($sessionID);
1389 C4::Context->_new_userenv($sessionID);
1391 C4::Context::set_userenv(
1392 $session->param('number'), $session->param('id'),
1393 $session->param('cardnumber'), $session->param('firstname'),
1394 $session->param('surname'), $session->param('branch'),
1395 $session->param('branchname'), $session->param('flags'),
1396 $session->param('emailaddress'), $session->param('branchprinter')
1399 my $ip = $session->param('ip');
1400 my $lasttime = $session->param('lasttime');
1401 my $userid = $session->param('id');
1402 if ( $lasttime < time() - $timeout ) {
1405 C4::Context->_unset_userenv($sessionID);
1408 return ("expired", undef);
1409 } elsif ( $ip ne $ENV{'REMOTE_ADDR'} ) {
1410 # IP address changed
1412 C4::Context->_unset_userenv($sessionID);
1415 return ("expired", undef);
1417 $session->param('lasttime',time());
1418 my $flags = haspermission($userid, $flagsrequired);
1420 return ("ok", $sessionID);
1423 C4::Context->_unset_userenv($sessionID);
1426 return ("failed", undef);
1430 return ("expired", undef);
1437 my $session = get_session($sessionID);
1439 Given a session ID, retrieve the CGI::Session object used to store
1440 the session's state. The session object can be used to store
1441 data that needs to be accessed by different scripts during a
1444 If the C<$sessionID> parameter is an empty string, a new session
1450 my $sessionID = shift;
1451 my $storage_method = C4::Context->preference('SessionStorage');
1452 my $dbh = C4::Context->dbh;
1454 if ($storage_method eq 'mysql'){
1455 $session = new CGI::Session("driver:MySQL;serializer:yaml;id:md5", $sessionID, {Handle=>$dbh});
1457 elsif ($storage_method eq 'Pg') {
1458 $session = new CGI::Session("driver:PostgreSQL;serializer:yaml;id:md5", $sessionID, {Handle=>$dbh});
1460 elsif ($storage_method eq 'memcached' && C4::Context->ismemcached){
1461 $session = new CGI::Session("driver:memcached;serializer:yaml;id:md5", $sessionID, { Memcached => C4::Context->memcached } );
1464 # catch all defaults to tmp should work on all systems
1465 $session = new CGI::Session("driver:File;serializer:yaml;id:md5", $sessionID, {Directory=>'/tmp'});
1472 my ( $dbh, $userid, $password, $query ) = @_;
1474 $debug and print STDERR "## checkpw - checking LDAP\n";
1475 my ($retval,$retcard,$retuserid) = checkpw_ldap(@_); # EXTERNAL AUTH
1476 ($retval) and return ($retval,$retcard,$retuserid);
1479 if ($cas && $query && $query->param('ticket')) {
1480 $debug and print STDERR "## checkpw - checking CAS\n";
1481 # In case of a CAS authentication, we use the ticket instead of the password
1482 my $ticket = $query->param('ticket');
1483 my ($retval,$retcard,$retuserid) = checkpw_cas($dbh, $ticket, $query); # EXTERNAL AUTH
1484 ($retval) and return ($retval,$retcard,$retuserid);
1491 "select password,cardnumber,borrowernumber,userid,firstname,surname,branchcode,flags from borrowers where userid=?"
1493 $sth->execute($userid);
1495 my ( $md5password, $cardnumber, $borrowernumber, $userid, $firstname,
1496 $surname, $branchcode, $flags )
1498 if ( md5_base64($password) eq $md5password and $md5password ne "!") {
1500 C4::Context->set_userenv( "$borrowernumber", $userid, $cardnumber,
1501 $firstname, $surname, $branchcode, $flags );
1502 return 1, $cardnumber, $userid;
1507 "select password,cardnumber,borrowernumber,userid, firstname,surname,branchcode,flags from borrowers where cardnumber=?"
1509 $sth->execute($userid);
1511 my ( $md5password, $cardnumber, $borrowernumber, $userid, $firstname,
1512 $surname, $branchcode, $flags )
1514 if ( md5_base64($password) eq $md5password ) {
1516 C4::Context->set_userenv( $borrowernumber, $userid, $cardnumber,
1517 $firstname, $surname, $branchcode, $flags );
1518 return 1, $cardnumber, $userid;
1521 if ( $userid && $userid eq C4::Context->config('user')
1522 && "$password" eq C4::Context->config('pass') )
1525 # Koha superuser account
1526 # C4::Context->set_userenv(0,0,C4::Context->config('user'),C4::Context->config('user'),C4::Context->config('user'),"",1);
1529 if ( $userid && $userid eq 'demo'
1530 && "$password" eq 'demo'
1531 && C4::Context->config('demo') )
1534 # DEMO => the demo user is allowed to do everything (if demo set to 1 in koha.conf
1535 # some features won't be effective : modify systempref, modify MARC structure,
1543 my $authflags = getuserflags($flags, $userid, [$dbh]);
1545 Translates integer flags into permissions strings hash.
1547 C<$flags> is the integer userflags value ( borrowers.userflags )
1548 C<$userid> is the members.userid, used for building subpermissions
1549 C<$authflags> is a hashref of permissions
1556 my $dbh = @_ ? shift : C4::Context->dbh;
1559 # I don't want to do this, but if someone logs in as the database
1560 # user, it would be preferable not to spam them to death with
1561 # numeric warnings. So, we make $flags numeric.
1562 no warnings 'numeric';
1565 my $sth = $dbh->prepare("SELECT bit, flag, defaulton FROM userflags");
1568 while ( my ( $bit, $flag, $defaulton ) = $sth->fetchrow ) {
1569 if ( ( $flags & ( 2**$bit ) ) || $defaulton ) {
1570 $userflags->{$flag} = 1;
1573 $userflags->{$flag} = 0;
1577 # get subpermissions and merge with top-level permissions
1578 my $user_subperms = get_user_subpermissions($userid);
1579 foreach my $module (keys %$user_subperms) {
1580 next if $userflags->{$module} == 1; # user already has permission for everything in this module
1581 $userflags->{$module} = $user_subperms->{$module};
1587 =head2 get_user_subpermissions
1589 $user_perm_hashref = get_user_subpermissions($userid);
1591 Given the userid (note, not the borrowernumber) of a staff user,
1592 return a hashref of hashrefs of the specific subpermissions
1593 accorded to the user. An example return is
1597 export_catalog => 1,
1598 import_patrons => 1,
1602 The top-level hash-key is a module or function code from
1603 userflags.flag, while the second-level key is a code
1606 The results of this function do not give a complete picture
1607 of the functions that a staff user can access; it is also
1608 necessary to check borrowers.flags.
1612 sub get_user_subpermissions {
1615 my $dbh = C4::Context->dbh;
1616 my $sth = $dbh->prepare("SELECT flag, user_permissions.code
1617 FROM user_permissions
1618 JOIN permissions USING (module_bit, code)
1619 JOIN userflags ON (module_bit = bit)
1620 JOIN borrowers USING (borrowernumber)
1622 $sth->execute($userid);
1624 my $user_perms = {};
1625 while (my $perm = $sth->fetchrow_hashref) {
1626 $user_perms->{$perm->{'flag'}}->{$perm->{'code'}} = 1;
1631 =head2 get_all_subpermissions
1633 my $perm_hashref = get_all_subpermissions();
1635 Returns a hashref of hashrefs defining all specific
1636 permissions currently defined. The return value
1637 has the same structure as that of C<get_user_subpermissions>,
1638 except that the innermost hash value is the description
1639 of the subpermission.
1643 sub get_all_subpermissions {
1644 my $dbh = C4::Context->dbh;
1645 my $sth = $dbh->prepare("SELECT flag, code, description
1647 JOIN userflags ON (module_bit = bit)");
1651 while (my $perm = $sth->fetchrow_hashref) {
1652 $all_perms->{$perm->{'flag'}}->{$perm->{'code'}} = $perm->{'description'};
1657 =head2 haspermission
1659 $flags = ($userid, $flagsrequired);
1661 C<$userid> the userid of the member
1662 C<$flags> is a hashref of required flags like C<$borrower-<{authflags}>
1664 Returns member's flags or 0 if a permission is not met.
1669 my ($userid, $flagsrequired) = @_;
1670 my $sth = C4::Context->dbh->prepare("SELECT flags FROM borrowers WHERE userid=?");
1671 $sth->execute($userid);
1672 my $flags = getuserflags($sth->fetchrow(), $userid);
1673 if ( $userid eq C4::Context->config('user') ) {
1674 # Super User Account from /etc/koha.conf
1675 $flags->{'superlibrarian'} = 1;
1677 elsif ( $userid eq 'demo' && C4::Context->config('demo') ) {
1678 # Demo user that can do "anything" (demo=1 in /etc/koha.conf)
1679 $flags->{'superlibrarian'} = 1;
1682 return $flags if $flags->{superlibrarian};
1684 foreach my $module ( keys %$flagsrequired ) {
1685 my $subperm = $flagsrequired->{$module};
1686 if ($subperm eq '*') {
1687 return 0 unless ( $flags->{$module} == 1 or ref($flags->{$module}) );
1689 return 0 unless ( $flags->{$module} == 1 or
1690 ( ref($flags->{$module}) and
1691 exists $flags->{$module}->{$subperm} and
1692 $flags->{$module}->{$subperm} == 1
1698 #FIXME - This fcn should return the failed permission so a suitable error msg can be delivered.
1702 sub getborrowernumber {
1704 my $userenv = C4::Context->userenv;
1705 if ( defined( $userenv ) && ref( $userenv ) eq 'HASH' && $userenv->{number} ) {
1706 return $userenv->{number};
1708 my $dbh = C4::Context->dbh;
1709 for my $field ( 'userid', 'cardnumber' ) {
1711 $dbh->prepare("select borrowernumber from borrowers where $field=?");
1712 $sth->execute($userid);
1714 my ($bnumber) = $sth->fetchrow;
1722 END { } # module clean-up code here (global destructor)