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.
23 use Digest::MD5 qw(md5_base64);
24 use Storable qw(thaw freeze);
30 use C4::Templates; # to get the template
31 use C4::Branch; # GetBranches
32 use C4::VirtualShelves;
33 use POSIX qw/strftime/;
34 use List::MoreUtils qw/ any /;
37 use vars qw($VERSION @ISA @EXPORT @EXPORT_OK %EXPORT_TAGS $debug $ldap $cas $caslogout);
40 sub psgi_env { any { /^psgi\./ } keys %ENV }
42 if ( psgi_env ) { die 'psgi:exit' }
45 $VERSION = 3.07.00.049; # set version for version checking
49 @EXPORT = qw(&checkauth &get_template_and_user &haspermission &get_user_subpermissions);
50 @EXPORT_OK = qw(&check_api_auth &get_session &check_cookie_auth &checkpw &get_all_subpermissions &get_user_subpermissions);
51 %EXPORT_TAGS = ( EditPermissions => [qw(get_all_subpermissions get_user_subpermissions)] );
52 $ldap = C4::Context->config('useldapserver') || 0;
53 $cas = C4::Context->preference('casAuthentication');
54 $caslogout = C4::Context->preference('casLogout');
55 require C4::Auth_with_cas; # no import
57 require C4::Auth_with_ldap;
58 import C4::Auth_with_ldap qw(checkpw_ldap);
61 import C4::Auth_with_cas qw(check_api_auth_cas checkpw_cas login_cas logout_cas login_cas_url);
68 C4::Auth - Authenticates Koha users
78 my ($template, $borrowernumber, $cookie)
79 = get_template_and_user(
81 template_name => "opac-main.tmpl",
85 flagsrequired => {borrow => 1, catalogue => '*', tools => 'import_patrons' },
89 output_html_with_http_headers $query, $cookie, $template->output;
93 The main function of this module is to provide
94 authentification. However the get_template_and_user function has
95 been provided so that a users login information is passed along
96 automatically. This gets loaded into the template.
100 =head2 get_template_and_user
102 my ($template, $borrowernumber, $cookie)
103 = get_template_and_user(
105 template_name => "opac-main.tmpl",
108 authnotrequired => 1,
109 flagsrequired => {borrow => 1, catalogue => '*', tools => 'import_patrons' },
113 This call passes the C<query>, C<flagsrequired> and C<authnotrequired>
114 to C<&checkauth> (in this module) to perform authentification.
115 See C<&checkauth> for an explanation of these parameters.
117 The C<template_name> is then used to find the correct template for
118 the page. The authenticated users details are loaded onto the
119 template in the HTML::Template LOOP variable C<USER_INFO>. Also the
120 C<sessionID> is passed to the template. This can be used in templates
121 if cookies are disabled. It needs to be put as and input to every
124 More information on the C<gettemplate> sub can be found in the
129 my $SEARCH_HISTORY_INSERT_SQL =<<EOQ;
130 INSERT INTO search_history(userid, sessionid, query_desc, query_cgi, total, time )
131 VALUES ( ?, ?, ?, ?, ?, FROM_UNIXTIME(?))
134 sub get_template_and_user {
137 C4::Templates::gettemplate( $in->{'template_name'}, $in->{'type'}, $in->{'query'}, $in->{'is_plugin'} );
138 my ( $user, $cookie, $sessionID, $flags );
139 if ( $in->{'template_name'} !~m/maintenance/ ) {
140 ( $user, $cookie, $sessionID, $flags ) = checkauth(
142 $in->{'authnotrequired'},
143 $in->{'flagsrequired'},
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 ) {
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 $template->param( CAN_user_plugins => 1 );
207 foreach my $module (keys %$all_perms) {
208 foreach my $subperm (keys %{ $all_perms->{$module} }) {
209 $template->param( "CAN_user_${module}_${subperm}" => 1 );
215 foreach my $module (keys %$all_perms) {
216 if ( $flags->{$module} == 1) {
217 foreach my $subperm (keys %{ $all_perms->{$module} }) {
218 $template->param( "CAN_user_${module}_${subperm}" => 1 );
220 } elsif ( ref($flags->{$module}) ) {
221 foreach my $subperm (keys %{ $flags->{$module} } ) {
222 $template->param( "CAN_user_${module}_${subperm}" => 1 );
229 foreach my $module (keys %$flags) {
230 if ( $flags->{$module} == 1 or ref($flags->{$module}) ) {
231 $template->param( "CAN_user_$module" => 1 );
232 if ($module eq "parameters") {
233 $template->param( CAN_user_management => 1 );
238 # Logged-in opac search history
239 # If the requested template is an opac one and opac search history is enabled
240 if ($in->{type} eq 'opac' && C4::Context->preference('EnableOpacSearchHistory')) {
241 my $dbh = C4::Context->dbh;
242 my $query = "SELECT COUNT(*) FROM search_history WHERE userid=?";
243 my $sth = $dbh->prepare($query);
244 $sth->execute($borrowernumber);
246 # If at least one search has already been performed
247 if ($sth->fetchrow_array > 0) {
248 # We show the link in opac
249 $template->param(ShowOpacRecentSearchLink => 1);
252 # And if there's a cookie with searches performed when the user was not logged in,
253 # we add them to the logged-in search history
254 my $searchcookie = $in->{'query'}->cookie('KohaOpacRecentSearches');
256 $searchcookie = uri_unescape($searchcookie);
257 my @recentSearches = @{thaw($searchcookie) || []};
258 if (@recentSearches) {
259 my $sth = $dbh->prepare($SEARCH_HISTORY_INSERT_SQL);
260 $sth->execute( $borrowernumber,
261 $in->{'query'}->cookie("CGISESSID"),
266 ) foreach @recentSearches;
268 # And then, delete the cookie's content
269 my $newsearchcookie = $in->{'query'}->cookie(
270 -name => 'KohaOpacRecentSearches',
271 -value => freeze([]),
275 $cookie = [$cookie, $newsearchcookie];
280 else { # if this is an anonymous session, setup to display public lists...
282 $template->param( sessionID => $sessionID );
284 my ($total, $pubshelves) = C4::VirtualShelves::GetSomeShelfNames(undef, 'MASTHEAD');
286 pubshelves => $total->{pubtotal},
287 pubshelvesloop => $pubshelves,
290 # Anonymous opac search history
291 # If opac search history is enabled and at least one search has already been performed
292 if (C4::Context->preference('EnableOpacSearchHistory')) {
293 my $searchcookie = $in->{'query'}->cookie('KohaOpacRecentSearches');
295 $searchcookie = uri_unescape($searchcookie);
296 my @recentSearches = @{thaw($searchcookie) || []};
297 # We show the link in opac
298 if (@recentSearches) {
299 $template->param(ShowOpacRecentSearchLink => 1);
304 if(C4::Context->preference('dateformat')){
305 $template->param( dateformat => C4::Context->preference('dateformat') );
306 if(C4::Context->preference('dateformat') eq "metric"){
307 $template->param(dateformat_metric => 1);
308 } elsif(C4::Context->preference('dateformat') eq "us"){
309 $template->param(dateformat_us => 1);
311 $template->param(dateformat_iso => 1);
314 $template->param(dateformat_iso => 1);
317 # these template parameters are set the same regardless of $in->{'type'}
319 "BiblioDefaultView".C4::Context->preference("BiblioDefaultView") => 1,
320 EnhancedMessagingPreferences => C4::Context->preference('EnhancedMessagingPreferences'),
321 GoogleJackets => C4::Context->preference("GoogleJackets"),
322 OpenLibraryCovers => C4::Context->preference("OpenLibraryCovers"),
323 KohaAdminEmailAddress => "" . C4::Context->preference("KohaAdminEmailAddress"),
324 LoginBranchcode => (C4::Context->userenv?C4::Context->userenv->{"branch"}:undef),
325 LoginFirstname => (C4::Context->userenv?C4::Context->userenv->{"firstname"}:"Bel"),
326 LoginSurname => C4::Context->userenv?C4::Context->userenv->{"surname"}:"Inconnu",
327 emailaddress => C4::Context->userenv?C4::Context->userenv->{"emailaddress"}:undef,
328 loggedinpersona => C4::Context->userenv?C4::Context->userenv->{"persona"}:undef,
329 TagsEnabled => C4::Context->preference("TagsEnabled"),
330 hide_marc => C4::Context->preference("hide_marc"),
331 item_level_itypes => C4::Context->preference('item-level_itypes'),
332 patronimages => C4::Context->preference("patronimages"),
333 singleBranchMode => C4::Context->preference("singleBranchMode"),
334 XSLTDetailsDisplay => C4::Context->preference("XSLTDetailsDisplay"),
335 XSLTResultsDisplay => C4::Context->preference("XSLTResultsDisplay"),
336 using_https => $in->{'query'}->https() ? 1 : 0,
337 noItemTypeImages => C4::Context->preference("noItemTypeImages"),
338 marcflavour => C4::Context->preference("marcflavour"),
339 persona => C4::Context->preference("persona"),
341 if ( $in->{'type'} eq "intranet" ) {
343 AmazonCoverImages => C4::Context->preference("AmazonCoverImages"),
344 AutoLocation => C4::Context->preference("AutoLocation"),
345 "BiblioDefaultView".C4::Context->preference("IntranetBiblioDefaultView") => 1,
346 CalendarFirstDayOfWeek => (C4::Context->preference("CalendarFirstDayOfWeek") eq "Sunday")?0:1,
347 CircAutocompl => C4::Context->preference("CircAutocompl"),
348 FRBRizeEditions => C4::Context->preference("FRBRizeEditions"),
349 IndependantBranches => C4::Context->preference("IndependantBranches"),
350 IntranetNav => C4::Context->preference("IntranetNav"),
351 IntranetmainUserblock => C4::Context->preference("IntranetmainUserblock"),
352 LibraryName => C4::Context->preference("LibraryName"),
353 LoginBranchname => (C4::Context->userenv?C4::Context->userenv->{"branchname"}:undef),
354 advancedMARCEditor => C4::Context->preference("advancedMARCEditor"),
355 canreservefromotherbranches => C4::Context->preference('canreservefromotherbranches'),
356 intranetcolorstylesheet => C4::Context->preference("intranetcolorstylesheet"),
357 IntranetFavicon => C4::Context->preference("IntranetFavicon"),
358 intranetreadinghistory => C4::Context->preference("intranetreadinghistory"),
359 intranetstylesheet => C4::Context->preference("intranetstylesheet"),
360 IntranetUserCSS => C4::Context->preference("IntranetUserCSS"),
361 intranetuserjs => C4::Context->preference("intranetuserjs"),
362 intranetbookbag => C4::Context->preference("intranetbookbag"),
363 suggestion => C4::Context->preference("suggestion"),
364 virtualshelves => C4::Context->preference("virtualshelves"),
365 StaffSerialIssueDisplayCount => C4::Context->preference("StaffSerialIssueDisplayCount"),
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'),
371 UseKohaPlugins => C4::Context->preference('UseKohaPlugins'),
375 warn "template type should be OPAC, here it is=[" . $in->{'type'} . "]" unless ( $in->{'type'} eq 'opac' );
376 #TODO : replace LibraryName syspref with 'system name', and remove this html processing
377 my $LibraryNameTitle = C4::Context->preference("LibraryName");
378 $LibraryNameTitle =~ s/<(?:\/?)(?:br|p)\s*(?:\/?)>/ /sgi;
379 $LibraryNameTitle =~ s/<(?:[^<>'"]|'(?:[^']*)'|"(?:[^"]*)")*>//sg;
380 # clean up the busc param in the session if the page is not opac-detail
381 if (C4::Context->preference("OpacBrowseResults") && $in->{'template_name'} =~ /opac-(.+)\.(?:tt|tmpl)$/ && $1 !~ /^(?:MARC|ISBD)?detail$/) {
382 my $sessionSearch = get_session($sessionID || $in->{'query'}->cookie("CGISESSID"));
383 $sessionSearch->clear(["busc"]) if ($sessionSearch->param("busc"));
385 # variables passed from CGI: opac_css_override and opac_search_limits.
386 my $opac_search_limit = $ENV{'OPAC_SEARCH_LIMIT'};
387 my $opac_limit_override = $ENV{'OPAC_LIMIT_OVERRIDE'};
389 if (($opac_search_limit && $opac_search_limit =~ /branch:(\w+)/ && $opac_limit_override) || ($in->{'query'}->param('limit') && $in->{'query'}->param('limit') =~ /branch:(\w+)/)){
390 $opac_name = $1; # opac_search_limit is a branch, so we use it.
391 } elsif ( $in->{'query'}->param('multibranchlimit') ) {
392 $opac_name = $in->{'query'}->param('multibranchlimit');
393 } elsif (C4::Context->preference("SearchMyLibraryFirst") && C4::Context->userenv && C4::Context->userenv->{'branch'}) {
394 $opac_name = C4::Context->userenv->{'branch'};
397 opaccolorstylesheet => C4::Context->preference("opaccolorstylesheet"),
398 AnonSuggestions => "" . C4::Context->preference("AnonSuggestions"),
399 AuthorisedValueImages => C4::Context->preference("AuthorisedValueImages"),
400 BranchesLoop => GetBranchesLoop($opac_name),
401 BranchCategoriesLoop => GetBranchCategories( undef, undef, 1, $opac_name ),
402 CalendarFirstDayOfWeek => (C4::Context->preference("CalendarFirstDayOfWeek") eq "Sunday")?0:1,
403 LibraryName => "" . C4::Context->preference("LibraryName"),
404 LibraryNameTitle => "" . $LibraryNameTitle,
405 LoginBranchname => C4::Context->userenv?C4::Context->userenv->{"branchname"}:"",
406 OPACAmazonCoverImages => C4::Context->preference("OPACAmazonCoverImages"),
407 OPACFRBRizeEditions => C4::Context->preference("OPACFRBRizeEditions"),
408 OpacHighlightedWords => C4::Context->preference("OpacHighlightedWords"),
409 OPACItemHolds => C4::Context->preference("OPACItemHolds"),
410 OPACShelfBrowser => "". C4::Context->preference("OPACShelfBrowser"),
411 OpacShowRecentComments => C4::Context->preference("OpacShowRecentComments"),
412 OPACURLOpenInNewWindow => "" . C4::Context->preference("OPACURLOpenInNewWindow"),
413 OPACUserCSS => "". C4::Context->preference("OPACUserCSS"),
414 OPACMobileUserCSS => "". C4::Context->preference("OPACMobileUserCSS"),
415 OPACViewOthersSuggestions => "" . C4::Context->preference("OPACViewOthersSuggestions"),
416 OpacAuthorities => C4::Context->preference("OpacAuthorities"),
417 OPACBaseURL => ($in->{'query'}->https() ? "https://" : "http://") . $ENV{'SERVER_NAME'} .
418 ($ENV{'SERVER_PORT'} eq ($in->{'query'}->https() ? "443" : "80") ? '' : ":$ENV{'SERVER_PORT'}"),
419 opac_css_override => $ENV{'OPAC_CSS_OVERRIDE'},
420 opac_search_limit => $opac_search_limit,
421 opac_limit_override => $opac_limit_override,
422 OpacBrowser => C4::Context->preference("OpacBrowser"),
423 OpacCloud => C4::Context->preference("OpacCloud"),
424 OpacKohaUrl => C4::Context->preference("OpacKohaUrl"),
425 OpacMainUserBlock => "" . C4::Context->preference("OpacMainUserBlock"),
426 OpacMainUserBlockMobile => "" . C4::Context->preference("OpacMainUserBlockMobile"),
427 OpacShowFiltersPulldownMobile => C4::Context->preference("OpacShowFiltersPulldownMobile"),
428 OpacShowLibrariesPulldownMobile => C4::Context->preference("OpacShowLibrariesPulldownMobile"),
429 OpacNav => "" . C4::Context->preference("OpacNav"),
430 OpacNavRight => "" . C4::Context->preference("OpacNavRight"),
431 OpacNavBottom => "" . C4::Context->preference("OpacNavBottom"),
432 OpacPasswordChange => C4::Context->preference("OpacPasswordChange"),
433 OPACPatronDetails => C4::Context->preference("OPACPatronDetails"),
434 OPACPrivacy => C4::Context->preference("OPACPrivacy"),
435 OPACFinesTab => C4::Context->preference("OPACFinesTab"),
436 OpacTopissue => C4::Context->preference("OpacTopissue"),
437 RequestOnOpac => C4::Context->preference("RequestOnOpac"),
438 'Version' => C4::Context->preference('Version'),
439 hidelostitems => C4::Context->preference("hidelostitems"),
440 mylibraryfirst => (C4::Context->preference("SearchMyLibraryFirst") && C4::Context->userenv) ? C4::Context->userenv->{'branch'} : '',
441 opaclayoutstylesheet => "" . C4::Context->preference("opaclayoutstylesheet"),
442 opacbookbag => "" . C4::Context->preference("opacbookbag"),
443 opaccredits => "" . C4::Context->preference("opaccredits"),
444 OpacFavicon => C4::Context->preference("OpacFavicon"),
445 opacheader => "" . C4::Context->preference("opacheader"),
446 opaclanguagesdisplay => "" . C4::Context->preference("opaclanguagesdisplay"),
447 opacreadinghistory => C4::Context->preference("opacreadinghistory"),
448 opacsmallimage => "" . C4::Context->preference("opacsmallimage"),
449 opacuserjs => C4::Context->preference("opacuserjs"),
450 opacuserlogin => "" . C4::Context->preference("opacuserlogin"),
451 reviewson => C4::Context->preference("reviewson"),
452 ShowReviewer => C4::Context->preference("ShowReviewer"),
453 ShowReviewerPhoto => C4::Context->preference("ShowReviewerPhoto"),
454 suggestion => "" . C4::Context->preference("suggestion"),
455 virtualshelves => "" . C4::Context->preference("virtualshelves"),
456 OPACSerialIssueDisplayCount => C4::Context->preference("OPACSerialIssueDisplayCount"),
457 OpacAddMastheadLibraryPulldown => C4::Context->preference("OpacAddMastheadLibraryPulldown"),
458 OPACXSLTDetailsDisplay => C4::Context->preference("OPACXSLTDetailsDisplay"),
459 OPACXSLTResultsDisplay => C4::Context->preference("OPACXSLTResultsDisplay"),
460 SyndeticsClientCode => C4::Context->preference("SyndeticsClientCode"),
461 SyndeticsEnabled => C4::Context->preference("SyndeticsEnabled"),
462 SyndeticsCoverImages => C4::Context->preference("SyndeticsCoverImages"),
463 SyndeticsTOC => C4::Context->preference("SyndeticsTOC"),
464 SyndeticsSummary => C4::Context->preference("SyndeticsSummary"),
465 SyndeticsEditions => C4::Context->preference("SyndeticsEditions"),
466 SyndeticsExcerpt => C4::Context->preference("SyndeticsExcerpt"),
467 SyndeticsReviews => C4::Context->preference("SyndeticsReviews"),
468 SyndeticsAuthorNotes => C4::Context->preference("SyndeticsAuthorNotes"),
469 SyndeticsAwards => C4::Context->preference("SyndeticsAwards"),
470 SyndeticsSeries => C4::Context->preference("SyndeticsSeries"),
471 SyndeticsCoverImageSize => C4::Context->preference("SyndeticsCoverImageSize"),
472 OPACLocalCoverImages => C4::Context->preference("OPACLocalCoverImages"),
473 PatronSelfRegistration => C4::Context->preference("PatronSelfRegistration"),
474 PatronSelfRegistrationDefaultCategory => C4::Context->preference("PatronSelfRegistrationDefaultCategory"),
477 $template->param(OpacPublic => '1') if ($user || C4::Context->preference("OpacPublic"));
479 return ( $template, $borrowernumber, $cookie, $flags);
484 ($userid, $cookie, $sessionID) = &checkauth($query, $noauth, $flagsrequired, $type);
486 Verifies that the user is authorized to run this script. If
487 the user is authorized, a (userid, cookie, session-id, flags)
488 quadruple is returned. If the user is not authorized but does
489 not have the required privilege (see $flagsrequired below), it
490 displays an error page and exits. Otherwise, it displays the
491 login page and exits.
493 Note that C<&checkauth> will return if and only if the user
494 is authorized, so it should be called early on, before any
495 unfinished operations (e.g., if you've opened a file, then
496 C<&checkauth> won't close it for you).
498 C<$query> is the CGI object for the script calling C<&checkauth>.
500 The C<$noauth> argument is optional. If it is set, then no
501 authorization is required for the script.
503 C<&checkauth> fetches user and session information from C<$query> and
504 ensures that the user is authorized to run scripts that require
507 The C<$flagsrequired> argument specifies the required privileges
508 the user must have if the username and password are correct.
509 It should be specified as a reference-to-hash; keys in the hash
510 should be the "flags" for the user, as specified in the Members
511 intranet module. Any key specified must correspond to a "flag"
512 in the userflags table. E.g., { circulate => 1 } would specify
513 that the user must have the "circulate" privilege in order to
514 proceed. To make sure that access control is correct, the
515 C<$flagsrequired> parameter must be specified correctly.
517 Koha also has a concept of sub-permissions, also known as
518 granular permissions. This makes the value of each key
519 in the C<flagsrequired> hash take on an additional
524 The user must have access to all subfunctions of the module
525 specified by the hash key.
529 The user must have access to at least one subfunction of the module
530 specified by the hash key.
532 specific permission, e.g., 'export_catalog'
534 The user must have access to the specific subfunction list, which
535 must correspond to a row in the permissions table.
537 The C<$type> argument specifies whether the template should be
538 retrieved from the opac or intranet directory tree. "opac" is
539 assumed if it is not specified; however, if C<$type> is specified,
540 "intranet" is assumed if it is not "opac".
542 If C<$query> does not have a valid session ID associated with it
543 (i.e., the user has not logged in) or if the session has expired,
544 C<&checkauth> presents the user with a login page (from the point of
545 view of the original script, C<&checkauth> does not return). Once the
546 user has authenticated, C<&checkauth> restarts the original script
547 (this time, C<&checkauth> returns).
549 The login page is provided using a HTML::Template, which is set in the
550 systempreferences table or at the top of this file. The variable C<$type>
551 selects which template to use, either the opac or the intranet
552 authentification template.
554 C<&checkauth> returns a user ID, a cookie, and a session ID. The
555 cookie should be sent back to the browser; it verifies that the user
564 # If Version syspref is unavailable, it means Koha is beeing installed,
565 # and so we must redirect to OPAC maintenance page or to the WebInstaller
566 # also, if OpacMaintenance is ON, OPAC should redirect to maintenance
567 if (C4::Context->preference('OpacMaintenance') && $type eq 'opac') {
568 warn "OPAC Install required, redirecting to maintenance";
569 print $query->redirect("/cgi-bin/koha/maintenance.pl");
572 unless ( $version = C4::Context->preference('Version') ) { # assignment, not comparison
573 if ( $type ne 'opac' ) {
574 warn "Install required, redirecting to Installer";
575 print $query->redirect("/cgi-bin/koha/installer/install.pl");
577 warn "OPAC Install required, redirecting to maintenance";
578 print $query->redirect("/cgi-bin/koha/maintenance.pl");
583 # check that database and koha version are the same
584 # there is no DB version, it's a fresh install,
585 # go to web installer
586 # there is a DB version, compare it to the code version
587 my $kohaversion=C4::Context::KOHAVERSION;
588 # remove the 3 last . to have a Perl number
589 $kohaversion =~ s/(.*\..*)\.(.*)\.(.*)/$1$2$3/;
590 $debug and print STDERR "kohaversion : $kohaversion\n";
591 if ($version < $kohaversion){
592 my $warning = "Database update needed, redirecting to %s. Database is $version and Koha is $kohaversion";
593 if ($type ne 'opac'){
594 warn sprintf($warning, 'Installer');
595 print $query->redirect("/cgi-bin/koha/installer/install.pl?step=3");
597 warn sprintf("OPAC: " . $warning, 'maintenance');
598 print $query->redirect("/cgi-bin/koha/maintenance.pl");
606 open my $fh, '>>', "/tmp/sessionlog" or warn "ERROR: Cannot append to /tmp/sessionlog";
607 printf $fh join("\n",@_);
611 sub _timeout_syspref {
612 my $timeout = C4::Context->preference('timeout') || 600;
613 # value in days, convert in seconds
614 if ($timeout =~ /(\d+)[dD]/) {
615 $timeout = $1 * 86400;
622 $debug and warn "Checking Auth";
623 # $authnotrequired will be set for scripts which will run without authentication
624 my $authnotrequired = shift;
625 my $flagsrequired = shift;
628 $type = 'opac' unless $type;
630 my $dbh = C4::Context->dbh;
631 my $timeout = _timeout_syspref();
633 _version_check($type,$query);
637 my ( $userid, $cookie, $sessionID, $flags, $barshelves, $pubshelves );
638 my $logout = $query->param('logout.x');
640 # This parameter is the name of the CAS server we want to authenticate against,
641 # when using authentication against multiple CAS servers, as configured in Auth_cas_servers.yaml
642 my $casparam = $query->param('cas');
644 if ( $userid = $ENV{'REMOTE_USER'} ) {
645 # Using Basic Authentication, no cookies required
646 $cookie = $query->cookie(
647 -name => 'CGISESSID',
655 # we dont want to set a session because we are being called by a persona callback
657 elsif ( $sessionID = $query->cookie("CGISESSID") )
658 { # assignment, not comparison
659 my $session = get_session($sessionID);
660 C4::Context->_new_userenv($sessionID);
661 my ($ip, $lasttime, $sessiontype);
663 C4::Context::set_userenv(
664 $session->param('number'), $session->param('id'),
665 $session->param('cardnumber'), $session->param('firstname'),
666 $session->param('surname'), $session->param('branch'),
667 $session->param('branchname'), $session->param('flags'),
668 $session->param('emailaddress'), $session->param('branchprinter'),
669 $session->param('persona')
671 C4::Context::set_shelves_userenv('bar',$session->param('barshelves'));
672 C4::Context::set_shelves_userenv('pub',$session->param('pubshelves'));
673 C4::Context::set_shelves_userenv('tot',$session->param('totshelves'));
674 $debug and printf STDERR "AUTH_SESSION: (%s)\t%s %s - %s\n", map {$session->param($_)} qw(cardnumber firstname surname branch) ;
675 $ip = $session->param('ip');
676 $lasttime = $session->param('lasttime');
677 $userid = $session->param('id');
678 utf8::decode($userid);
679 $sessiontype = $session->param('sessiontype') || '';
681 if ( ( ($query->param('koha_login_context')) && ($query->param('userid') ne $session->param('id')) )
682 || ( $cas && $query->param('ticket') ) ) {
683 #if a user enters an id ne to the id in the current session, we need to log them in...
684 #first we need to clear the anonymous session...
685 $debug and warn "query id = " . $query->param('userid') . " but session id = " . $session->param('id');
688 C4::Context->_unset_userenv($sessionID);
693 # voluntary logout the user
696 C4::Context->_unset_userenv($sessionID);
697 #_session_log(sprintf "%20s from %16s logged out at %30s (manually).\n", $userid,$ip,(strftime "%c",localtime));
701 if ($cas and $caslogout) {
705 elsif ( $lasttime < time() - $timeout ) {
707 $info{'timed_out'} = 1;
708 $session->delete() if $session;
709 C4::Context->_unset_userenv($sessionID);
710 #_session_log(sprintf "%20s from %16s logged out at %30s (inactivity).\n", $userid,$ip,(strftime "%c",localtime));
714 elsif ( $ip ne $ENV{'REMOTE_ADDR'} ) {
715 # Different ip than originally logged in from
716 $info{'oldip'} = $ip;
717 $info{'newip'} = $ENV{'REMOTE_ADDR'};
718 $info{'different_ip'} = 1;
720 C4::Context->_unset_userenv($sessionID);
721 #_session_log(sprintf "%20s from %16s logged out at %30s (ip changed to %16s).\n", $userid,$ip,(strftime "%c",localtime), $info{'newip'});
726 $cookie = $query->cookie(
727 -name => 'CGISESSID',
728 -value => $session->id,
731 $session->param( 'lasttime', time() );
732 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...
733 $flags = haspermission($userid, $flagsrequired);
737 $info{'nopermission'} = 1;
742 unless ($userid || $sessionID) {
744 #we initiate a session prior to checking for a username to allow for anonymous sessions...
745 my $session = get_session("") or die "Auth ERROR: Cannot get_session()";
746 my $sessionID = $session->id;
747 C4::Context->_new_userenv($sessionID);
748 $cookie = $query->cookie(
749 -name => 'CGISESSID',
750 -value => $session->id,
753 $userid = $query->param('userid');
754 utf8::decode($userid);
755 if ( ( $cas && $query->param('ticket') )
757 || ( my $pki_field = C4::Context->preference('AllowPKIAuth') ) ne
760 my $password = $query->param('password');
762 my ( $return, $cardnumber );
763 if ( $cas && $query->param('ticket') ) {
765 ( $return, $cardnumber, $retuserid ) =
766 checkpw( $dbh, $userid, $password, $query );
767 $userid = $retuserid;
768 $info{'invalidCasLogin'} = 1 unless ($return);
772 my $value = $persona;
774 # If we're looking up the email, there's a chance that the person
775 # doesn't have a userid. So if there is none, we pass along the
776 # borrower number, and the bits of code that need to know the user
777 # ID will have to be smart enough to handle that.
779 my @users_info = C4::Members::GetBorrowersWithEmail($value);
782 # First the userid, then the borrowernum
783 $value = $users_info[0][1] || $users_info[0][0];
788 $return = $value ? 1 : 0;
793 ( $pki_field eq 'Common Name' && $ENV{'SSL_CLIENT_S_DN_CN'} )
794 || ( $pki_field eq 'emailAddress'
795 && $ENV{'SSL_CLIENT_S_DN_Email'} )
799 if ( $pki_field eq 'Common Name' ) {
800 $value = $ENV{'SSL_CLIENT_S_DN_CN'};
802 elsif ( $pki_field eq 'emailAddress' ) {
803 $value = $ENV{'SSL_CLIENT_S_DN_Email'};
805 # If we're looking up the email, there's a chance that the person
806 # doesn't have a userid. So if there is none, we pass along the
807 # borrower number, and the bits of code that need to know the user
808 # ID will have to be smart enough to handle that.
810 my @users_info = C4::Members::GetBorrowersWithEmail($value);
813 # First the userid, then the borrowernum
814 $value = $users_info[0][1] || $users_info[0][0];
821 $return = $value ? 1 : 0;
827 ( $return, $cardnumber, $retuserid ) =
828 checkpw( $dbh, $userid, $password, $query );
829 $userid = $retuserid if ( $retuserid ne '' );
832 #_session_log(sprintf "%20s from %16s logged in at %30s.\n", $userid,$ENV{'REMOTE_ADDR'},(strftime '%c', localtime));
833 if ( $flags = haspermission( $userid, $flagsrequired ) ) {
837 $info{'nopermission'} = 1;
838 C4::Context->_unset_userenv($sessionID);
840 my ($borrowernumber, $firstname, $surname, $userflags,
841 $branchcode, $branchname, $branchprinter, $emailaddress);
843 if ( $return == 1 ) {
845 SELECT borrowernumber, firstname, surname, flags, borrowers.branchcode,
846 branches.branchname as branchname,
847 branches.branchprinter as branchprinter,
850 LEFT JOIN branches on borrowers.branchcode=branches.branchcode
852 my $sth = $dbh->prepare("$select where userid=?");
853 $sth->execute($userid);
854 unless ($sth->rows) {
855 $debug and print STDERR "AUTH_1: no rows for userid='$userid'\n";
856 $sth = $dbh->prepare("$select where cardnumber=?");
857 $sth->execute($cardnumber);
859 unless ($sth->rows) {
860 $debug and print STDERR "AUTH_2a: no rows for cardnumber='$cardnumber'\n";
861 $sth->execute($userid);
862 unless ($sth->rows) {
863 $debug and print STDERR "AUTH_2b: no rows for userid='$userid' AS cardnumber\n";
868 ($borrowernumber, $firstname, $surname, $userflags,
869 $branchcode, $branchname, $branchprinter, $emailaddress) = $sth->fetchrow;
870 $debug and print STDERR "AUTH_3 results: " .
871 "$cardnumber,$borrowernumber,$userid,$firstname,$surname,$userflags,$branchcode,$emailaddress\n";
873 print STDERR "AUTH_3: no results for userid='$userid', cardnumber='$cardnumber'.\n";
876 # launch a sequence to check if we have a ip for the branch, i
877 # if we have one we replace the branchcode of the userenv by the branch bound in the ip.
879 my $ip = $ENV{'REMOTE_ADDR'};
880 # if they specify at login, use that
881 if ($query->param('branch')) {
882 $branchcode = $query->param('branch');
883 $branchname = GetBranchName($branchcode);
885 my $branches = GetBranches();
886 if (C4::Context->boolean_preference('IndependantBranches') && C4::Context->boolean_preference('Autolocation')){
887 # we have to check they are coming from the right ip range
888 my $domain = $branches->{$branchcode}->{'branchip'};
889 if ($ip !~ /^$domain/){
891 $info{'wrongip'} = 1;
896 foreach my $br ( keys %$branches ) {
897 # now we work with the treatment of ip
898 my $domain = $branches->{$br}->{'branchip'};
899 if ( $domain && $ip =~ /^$domain/ ) {
900 $branchcode = $branches->{$br}->{'branchcode'};
902 # new op dev : add the branchprinter and branchname in the cookie
903 $branchprinter = $branches->{$br}->{'branchprinter'};
904 $branchname = $branches->{$br}->{'branchname'};
907 $session->param('number',$borrowernumber);
908 $session->param('id',$userid);
909 $session->param('cardnumber',$cardnumber);
910 $session->param('firstname',$firstname);
911 $session->param('surname',$surname);
912 $session->param('branch',$branchcode);
913 $session->param('branchname',$branchname);
914 $session->param('flags',$userflags);
915 $session->param('emailaddress',$emailaddress);
916 $session->param('ip',$session->remote_addr());
917 $session->param('lasttime',time());
918 $debug and printf STDERR "AUTH_4: (%s)\t%s %s - %s\n", map {$session->param($_)} qw(cardnumber firstname surname branch) ;
920 elsif ( $return == 2 ) {
921 #We suppose the user is the superlibrarian
923 $session->param('number',0);
924 $session->param('id',C4::Context->config('user'));
925 $session->param('cardnumber',C4::Context->config('user'));
926 $session->param('firstname',C4::Context->config('user'));
927 $session->param('surname',C4::Context->config('user'));
928 $session->param('branch','NO_LIBRARY_SET');
929 $session->param('branchname','NO_LIBRARY_SET');
930 $session->param('flags',1);
931 $session->param('emailaddress', C4::Context->preference('KohaAdminEmailAddress'));
932 $session->param('ip',$session->remote_addr());
933 $session->param('lasttime',time());
936 $session->param('persona',1);
938 C4::Context::set_userenv(
939 $session->param('number'), $session->param('id'),
940 $session->param('cardnumber'), $session->param('firstname'),
941 $session->param('surname'), $session->param('branch'),
942 $session->param('branchname'), $session->param('flags'),
943 $session->param('emailaddress'), $session->param('branchprinter'),
944 $session->param('persona')
950 $info{'invalid_username_or_password'} = 1;
951 C4::Context->_unset_userenv($sessionID);
954 } # END if ( $userid = $query->param('userid') )
955 elsif ($type eq "opac") {
956 # if we are here this is an anonymous session; add public lists to it and a few other items...
957 # anonymous sessions are created only for the OPAC
958 $debug and warn "Initiating an anonymous session...";
960 # setting a couple of other session vars...
961 $session->param('ip',$session->remote_addr());
962 $session->param('lasttime',time());
963 $session->param('sessiontype','anon');
965 } # END unless ($userid)
967 # finished authentification, now respond
968 if ( $loggedin || $authnotrequired )
972 $cookie = $query->cookie(
973 -name => 'CGISESSID',
978 return ( $userid, $cookie, $sessionID, $flags );
983 # AUTH rejected, show the login/password template, after checking the DB.
987 # get the inputs from the incoming query
989 foreach my $name ( param $query) {
990 (next) if ( $name eq 'userid' || $name eq 'password' || $name eq 'ticket' );
991 my $value = $query->param($name);
992 push @inputs, { name => $name, value => $value };
995 my $template_name = ( $type eq 'opac' ) ? 'opac-auth.tmpl' : 'auth.tmpl';
996 my $template = C4::Templates::gettemplate($template_name, $type, $query );
998 branchloop => GetBranchesLoop(),
999 opaccolorstylesheet => C4::Context->preference("opaccolorstylesheet"),
1000 opaclayoutstylesheet => C4::Context->preference("opaclayoutstylesheet"),
1003 casAuthentication => C4::Context->preference("casAuthentication"),
1004 suggestion => C4::Context->preference("suggestion"),
1005 virtualshelves => C4::Context->preference("virtualshelves"),
1006 LibraryName => C4::Context->preference("LibraryName"),
1007 opacuserlogin => C4::Context->preference("opacuserlogin"),
1008 OpacNav => C4::Context->preference("OpacNav"),
1009 OpacNavRight => C4::Context->preference("OpacNavRight"),
1010 OpacNavBottom => C4::Context->preference("OpacNavBottom"),
1011 opaccredits => C4::Context->preference("opaccredits"),
1012 OpacFavicon => C4::Context->preference("OpacFavicon"),
1013 opacreadinghistory => C4::Context->preference("opacreadinghistory"),
1014 opacsmallimage => C4::Context->preference("opacsmallimage"),
1015 opaclanguagesdisplay => C4::Context->preference("opaclanguagesdisplay"),
1016 opacuserjs => C4::Context->preference("opacuserjs"),
1017 opacbookbag => "" . C4::Context->preference("opacbookbag"),
1018 OpacCloud => C4::Context->preference("OpacCloud"),
1019 OpacTopissue => C4::Context->preference("OpacTopissue"),
1020 OpacAuthorities => C4::Context->preference("OpacAuthorities"),
1021 OpacBrowser => C4::Context->preference("OpacBrowser"),
1022 opacheader => C4::Context->preference("opacheader"),
1023 TagsEnabled => C4::Context->preference("TagsEnabled"),
1024 OPACUserCSS => C4::Context->preference("OPACUserCSS"),
1025 intranetcolorstylesheet => C4::Context->preference("intranetcolorstylesheet"),
1026 intranetstylesheet => C4::Context->preference("intranetstylesheet"),
1027 intranetbookbag => C4::Context->preference("intranetbookbag"),
1028 IntranetNav => C4::Context->preference("IntranetNav"),
1029 IntranetFavicon => C4::Context->preference("IntranetFavicon"),
1030 intranetuserjs => C4::Context->preference("intranetuserjs"),
1031 IndependantBranches=> C4::Context->preference("IndependantBranches"),
1032 AutoLocation => C4::Context->preference("AutoLocation"),
1033 wrongip => $info{'wrongip'},
1034 PatronSelfRegistration => C4::Context->preference("PatronSelfRegistration"),
1035 PatronSelfRegistrationDefaultCategory => C4::Context->preference("PatronSelfRegistrationDefaultCategory"),
1036 persona => C4::Context->preference("Persona"),
1039 $template->param( OpacPublic => C4::Context->preference("OpacPublic"));
1040 $template->param( loginprompt => 1 ) unless $info{'nopermission'};
1044 # Is authentication against multiple CAS servers enabled?
1045 if (C4::Auth_with_cas::multipleAuth && !$casparam) {
1046 my $casservers = C4::Auth_with_cas::getMultipleAuth();
1048 foreach my $key (keys %$casservers) {
1049 push @tmplservers, {name => $key, value => login_cas_url($query, $key) . "?cas=$key" };
1052 casServersLoop => \@tmplservers
1056 casServerUrl => login_cas_url($query),
1061 invalidCasLogin => $info{'invalidCasLogin'}
1065 my $self_url = $query->url( -absolute => 1 );
1068 LibraryName => C4::Context->preference("LibraryName"),
1070 $template->param( %info );
1073 C4::Output::output_html_with_http_headers( $query, $cookie,
1078 =head2 check_api_auth
1080 ($status, $cookie, $sessionId) = check_api_auth($query, $userflags);
1082 Given a CGI query containing the parameters 'userid' and 'password' and/or a session
1083 cookie, determine if the user has the privileges specified by C<$userflags>.
1085 C<check_api_auth> is is meant for authenticating users of web services, and
1086 consequently will always return and will not attempt to redirect the user
1089 If a valid session cookie is already present, check_api_auth will return a status
1090 of "ok", the cookie, and the Koha session ID.
1092 If no session cookie is present, check_api_auth will check the 'userid' and 'password
1093 parameters and create a session cookie and Koha session if the supplied credentials
1096 Possible return values in C<$status> are:
1100 =item "ok" -- user authenticated; C<$cookie> and C<$sessionid> have valid values.
1102 =item "failed" -- credentials are not correct; C<$cookie> and C<$sessionid> are undef
1104 =item "maintenance" -- DB is in maintenance mode; no login possible at the moment
1106 =item "expired -- session cookie has expired; API user should resubmit userid and password
1112 sub check_api_auth {
1114 my $flagsrequired = shift;
1116 my $dbh = C4::Context->dbh;
1117 my $timeout = _timeout_syspref();
1119 unless (C4::Context->preference('Version')) {
1120 # database has not been installed yet
1121 return ("maintenance", undef, undef);
1123 my $kohaversion=C4::Context::KOHAVERSION;
1124 $kohaversion =~ s/(.*\..*)\.(.*)\.(.*)/$1$2$3/;
1125 if (C4::Context->preference('Version') < $kohaversion) {
1126 # database in need of version update; assume that
1127 # no API should be called while databsae is in
1129 return ("maintenance", undef, undef);
1132 # FIXME -- most of what follows is a copy-and-paste
1133 # of code from checkauth. There is an obvious need
1134 # for refactoring to separate the various parts of
1135 # the authentication code, but as of 2007-11-19 this
1136 # is deferred so as to not introduce bugs into the
1137 # regular authentication code for Koha 3.0.
1139 # see if we have a valid session cookie already
1140 # however, if a userid parameter is present (i.e., from
1141 # a form submission, assume that any current cookie
1143 my $sessionID = undef;
1144 unless ($query->param('userid')) {
1145 $sessionID = $query->cookie("CGISESSID");
1147 if ($sessionID && not ($cas && $query->param('PT')) ) {
1148 my $session = get_session($sessionID);
1149 C4::Context->_new_userenv($sessionID);
1151 C4::Context::set_userenv(
1152 $session->param('number'), $session->param('id'),
1153 $session->param('cardnumber'), $session->param('firstname'),
1154 $session->param('surname'), $session->param('branch'),
1155 $session->param('branchname'), $session->param('flags'),
1156 $session->param('emailaddress'), $session->param('branchprinter')
1159 my $ip = $session->param('ip');
1160 my $lasttime = $session->param('lasttime');
1161 my $userid = $session->param('id');
1162 if ( $lasttime < time() - $timeout ) {
1165 C4::Context->_unset_userenv($sessionID);
1168 return ("expired", undef, undef);
1169 } elsif ( $ip ne $ENV{'REMOTE_ADDR'} ) {
1170 # IP address changed
1172 C4::Context->_unset_userenv($sessionID);
1175 return ("expired", undef, undef);
1177 my $cookie = $query->cookie(
1178 -name => 'CGISESSID',
1179 -value => $session->id,
1182 $session->param('lasttime',time());
1183 my $flags = haspermission($userid, $flagsrequired);
1185 return ("ok", $cookie, $sessionID);
1188 C4::Context->_unset_userenv($sessionID);
1191 return ("failed", undef, undef);
1195 return ("expired", undef, undef);
1199 my $userid = $query->param('userid');
1200 my $password = $query->param('password');
1201 my ($return, $cardnumber);
1204 if ($cas && $query->param('PT')) {
1206 $debug and print STDERR "## check_api_auth - checking CAS\n";
1207 # In case of a CAS authentication, we use the ticket instead of the password
1208 my $PT = $query->param('PT');
1209 ($return,$cardnumber,$userid) = check_api_auth_cas($dbh, $PT, $query); # EXTERNAL AUTH
1211 # User / password auth
1212 unless ($userid and $password) {
1213 # caller did something wrong, fail the authenticateion
1214 return ("failed", undef, undef);
1216 ( $return, $cardnumber ) = checkpw( $dbh, $userid, $password, $query );
1219 if ($return and haspermission( $userid, $flagsrequired)) {
1220 my $session = get_session("");
1221 return ("failed", undef, undef) unless $session;
1223 my $sessionID = $session->id;
1224 C4::Context->_new_userenv($sessionID);
1225 my $cookie = $query->cookie(
1226 -name => 'CGISESSID',
1227 -value => $sessionID,
1230 if ( $return == 1 ) {
1232 $borrowernumber, $firstname, $surname,
1233 $userflags, $branchcode, $branchname,
1234 $branchprinter, $emailaddress
1238 "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=?"
1240 $sth->execute($userid);
1242 $borrowernumber, $firstname, $surname,
1243 $userflags, $branchcode, $branchname,
1244 $branchprinter, $emailaddress
1245 ) = $sth->fetchrow if ( $sth->rows );
1247 unless ($sth->rows ) {
1248 my $sth = $dbh->prepare(
1249 "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=?"
1251 $sth->execute($cardnumber);
1253 $borrowernumber, $firstname, $surname,
1254 $userflags, $branchcode, $branchname,
1255 $branchprinter, $emailaddress
1256 ) = $sth->fetchrow if ( $sth->rows );
1258 unless ( $sth->rows ) {
1259 $sth->execute($userid);
1261 $borrowernumber, $firstname, $surname, $userflags,
1262 $branchcode, $branchname, $branchprinter, $emailaddress
1263 ) = $sth->fetchrow if ( $sth->rows );
1267 my $ip = $ENV{'REMOTE_ADDR'};
1268 # if they specify at login, use that
1269 if ($query->param('branch')) {
1270 $branchcode = $query->param('branch');
1271 $branchname = GetBranchName($branchcode);
1273 my $branches = GetBranches();
1275 foreach my $br ( keys %$branches ) {
1276 # now we work with the treatment of ip
1277 my $domain = $branches->{$br}->{'branchip'};
1278 if ( $domain && $ip =~ /^$domain/ ) {
1279 $branchcode = $branches->{$br}->{'branchcode'};
1281 # new op dev : add the branchprinter and branchname in the cookie
1282 $branchprinter = $branches->{$br}->{'branchprinter'};
1283 $branchname = $branches->{$br}->{'branchname'};
1286 $session->param('number',$borrowernumber);
1287 $session->param('id',$userid);
1288 $session->param('cardnumber',$cardnumber);
1289 $session->param('firstname',$firstname);
1290 $session->param('surname',$surname);
1291 $session->param('branch',$branchcode);
1292 $session->param('branchname',$branchname);
1293 $session->param('flags',$userflags);
1294 $session->param('emailaddress',$emailaddress);
1295 $session->param('ip',$session->remote_addr());
1296 $session->param('lasttime',time());
1297 } elsif ( $return == 2 ) {
1298 #We suppose the user is the superlibrarian
1299 $session->param('number',0);
1300 $session->param('id',C4::Context->config('user'));
1301 $session->param('cardnumber',C4::Context->config('user'));
1302 $session->param('firstname',C4::Context->config('user'));
1303 $session->param('surname',C4::Context->config('user'));
1304 $session->param('branch','NO_LIBRARY_SET');
1305 $session->param('branchname','NO_LIBRARY_SET');
1306 $session->param('flags',1);
1307 $session->param('emailaddress', C4::Context->preference('KohaAdminEmailAddress'));
1308 $session->param('ip',$session->remote_addr());
1309 $session->param('lasttime',time());
1311 C4::Context::set_userenv(
1312 $session->param('number'), $session->param('id'),
1313 $session->param('cardnumber'), $session->param('firstname'),
1314 $session->param('surname'), $session->param('branch'),
1315 $session->param('branchname'), $session->param('flags'),
1316 $session->param('emailaddress'), $session->param('branchprinter')
1318 return ("ok", $cookie, $sessionID);
1320 return ("failed", undef, undef);
1325 =head2 check_cookie_auth
1327 ($status, $sessionId) = check_api_auth($cookie, $userflags);
1329 Given a CGISESSID cookie set during a previous login to Koha, determine
1330 if the user has the privileges specified by C<$userflags>.
1332 C<check_cookie_auth> is meant for authenticating special services
1333 such as tools/upload-file.pl that are invoked by other pages that
1334 have been authenticated in the usual way.
1336 Possible return values in C<$status> are:
1340 =item "ok" -- user authenticated; C<$sessionID> have valid values.
1342 =item "failed" -- credentials are not correct; C<$sessionid> are undef
1344 =item "maintenance" -- DB is in maintenance mode; no login possible at the moment
1346 =item "expired -- session cookie has expired; API user should resubmit userid and password
1352 sub check_cookie_auth {
1354 my $flagsrequired = shift;
1356 my $dbh = C4::Context->dbh;
1357 my $timeout = _timeout_syspref();
1359 unless (C4::Context->preference('Version')) {
1360 # database has not been installed yet
1361 return ("maintenance", undef);
1363 my $kohaversion=C4::Context::KOHAVERSION;
1364 $kohaversion =~ s/(.*\..*)\.(.*)\.(.*)/$1$2$3/;
1365 if (C4::Context->preference('Version') < $kohaversion) {
1366 # database in need of version update; assume that
1367 # no API should be called while databsae is in
1369 return ("maintenance", undef);
1372 # FIXME -- most of what follows is a copy-and-paste
1373 # of code from checkauth. There is an obvious need
1374 # for refactoring to separate the various parts of
1375 # the authentication code, but as of 2007-11-23 this
1376 # is deferred so as to not introduce bugs into the
1377 # regular authentication code for Koha 3.0.
1379 # see if we have a valid session cookie already
1380 # however, if a userid parameter is present (i.e., from
1381 # a form submission, assume that any current cookie
1383 unless (defined $cookie and $cookie) {
1384 return ("failed", undef);
1386 my $sessionID = $cookie;
1387 my $session = get_session($sessionID);
1388 C4::Context->_new_userenv($sessionID);
1390 C4::Context::set_userenv(
1391 $session->param('number'), $session->param('id'),
1392 $session->param('cardnumber'), $session->param('firstname'),
1393 $session->param('surname'), $session->param('branch'),
1394 $session->param('branchname'), $session->param('flags'),
1395 $session->param('emailaddress'), $session->param('branchprinter')
1398 my $ip = $session->param('ip');
1399 my $lasttime = $session->param('lasttime');
1400 my $userid = $session->param('id');
1401 if ( $lasttime < time() - $timeout ) {
1404 C4::Context->_unset_userenv($sessionID);
1407 return ("expired", undef);
1408 } elsif ( $ip ne $ENV{'REMOTE_ADDR'} ) {
1409 # IP address changed
1411 C4::Context->_unset_userenv($sessionID);
1414 return ("expired", undef);
1416 $session->param('lasttime',time());
1417 my $flags = haspermission($userid, $flagsrequired);
1419 return ("ok", $sessionID);
1422 C4::Context->_unset_userenv($sessionID);
1425 return ("failed", undef);
1429 return ("expired", undef);
1436 my $session = get_session($sessionID);
1438 Given a session ID, retrieve the CGI::Session object used to store
1439 the session's state. The session object can be used to store
1440 data that needs to be accessed by different scripts during a
1443 If the C<$sessionID> parameter is an empty string, a new session
1449 my $sessionID = shift;
1450 my $storage_method = C4::Context->preference('SessionStorage');
1451 my $dbh = C4::Context->dbh;
1453 if ($storage_method eq 'mysql'){
1454 $session = new CGI::Session("driver:MySQL;serializer:yaml;id:md5", $sessionID, {Handle=>$dbh});
1456 elsif ($storage_method eq 'Pg') {
1457 $session = new CGI::Session("driver:PostgreSQL;serializer:yaml;id:md5", $sessionID, {Handle=>$dbh});
1459 elsif ($storage_method eq 'memcached' && C4::Context->ismemcached){
1460 $session = new CGI::Session("driver:memcached;serializer:yaml;id:md5", $sessionID, { Memcached => C4::Context->memcached } );
1463 # catch all defaults to tmp should work on all systems
1464 $session = new CGI::Session("driver:File;serializer:yaml;id:md5", $sessionID, {Directory=>'/tmp'});
1471 my ( $dbh, $userid, $password, $query ) = @_;
1473 $debug and print STDERR "## checkpw - checking LDAP\n";
1474 my ($retval,$retcard,$retuserid) = checkpw_ldap(@_); # EXTERNAL AUTH
1475 ($retval) and return ($retval,$retcard,$retuserid);
1478 if ($cas && $query && $query->param('ticket')) {
1479 $debug and print STDERR "## checkpw - checking CAS\n";
1480 # In case of a CAS authentication, we use the ticket instead of the password
1481 my $ticket = $query->param('ticket');
1482 my ($retval,$retcard,$retuserid) = checkpw_cas($dbh, $ticket, $query); # EXTERNAL AUTH
1483 ($retval) and return ($retval,$retcard,$retuserid);
1490 "select password,cardnumber,borrowernumber,userid,firstname,surname,branchcode,flags from borrowers where userid=?"
1492 $sth->execute($userid);
1494 my ( $md5password, $cardnumber, $borrowernumber, $userid, $firstname,
1495 $surname, $branchcode, $flags )
1497 if ( md5_base64($password) eq $md5password and $md5password ne "!") {
1499 C4::Context->set_userenv( "$borrowernumber", $userid, $cardnumber,
1500 $firstname, $surname, $branchcode, $flags );
1501 return 1, $cardnumber, $userid;
1506 "select password,cardnumber,borrowernumber,userid, firstname,surname,branchcode,flags from borrowers where cardnumber=?"
1508 $sth->execute($userid);
1510 my ( $md5password, $cardnumber, $borrowernumber, $userid, $firstname,
1511 $surname, $branchcode, $flags )
1513 if ( md5_base64($password) eq $md5password ) {
1515 C4::Context->set_userenv( $borrowernumber, $userid, $cardnumber,
1516 $firstname, $surname, $branchcode, $flags );
1517 return 1, $cardnumber, $userid;
1520 if ( $userid && $userid eq C4::Context->config('user')
1521 && "$password" eq C4::Context->config('pass') )
1524 # Koha superuser account
1525 # C4::Context->set_userenv(0,0,C4::Context->config('user'),C4::Context->config('user'),C4::Context->config('user'),"",1);
1528 if ( $userid && $userid eq 'demo'
1529 && "$password" eq 'demo'
1530 && C4::Context->config('demo') )
1533 # DEMO => the demo user is allowed to do everything (if demo set to 1 in koha.conf
1534 # some features won't be effective : modify systempref, modify MARC structure,
1542 my $authflags = getuserflags($flags, $userid, [$dbh]);
1544 Translates integer flags into permissions strings hash.
1546 C<$flags> is the integer userflags value ( borrowers.userflags )
1547 C<$userid> is the members.userid, used for building subpermissions
1548 C<$authflags> is a hashref of permissions
1555 my $dbh = @_ ? shift : C4::Context->dbh;
1558 # I don't want to do this, but if someone logs in as the database
1559 # user, it would be preferable not to spam them to death with
1560 # numeric warnings. So, we make $flags numeric.
1561 no warnings 'numeric';
1564 my $sth = $dbh->prepare("SELECT bit, flag, defaulton FROM userflags");
1567 while ( my ( $bit, $flag, $defaulton ) = $sth->fetchrow ) {
1568 if ( ( $flags & ( 2**$bit ) ) || $defaulton ) {
1569 $userflags->{$flag} = 1;
1572 $userflags->{$flag} = 0;
1576 # get subpermissions and merge with top-level permissions
1577 my $user_subperms = get_user_subpermissions($userid);
1578 foreach my $module (keys %$user_subperms) {
1579 next if $userflags->{$module} == 1; # user already has permission for everything in this module
1580 $userflags->{$module} = $user_subperms->{$module};
1586 =head2 get_user_subpermissions
1588 $user_perm_hashref = get_user_subpermissions($userid);
1590 Given the userid (note, not the borrowernumber) of a staff user,
1591 return a hashref of hashrefs of the specific subpermissions
1592 accorded to the user. An example return is
1596 export_catalog => 1,
1597 import_patrons => 1,
1601 The top-level hash-key is a module or function code from
1602 userflags.flag, while the second-level key is a code
1605 The results of this function do not give a complete picture
1606 of the functions that a staff user can access; it is also
1607 necessary to check borrowers.flags.
1611 sub get_user_subpermissions {
1614 my $dbh = C4::Context->dbh;
1615 my $sth = $dbh->prepare("SELECT flag, user_permissions.code
1616 FROM user_permissions
1617 JOIN permissions USING (module_bit, code)
1618 JOIN userflags ON (module_bit = bit)
1619 JOIN borrowers USING (borrowernumber)
1621 $sth->execute($userid);
1623 my $user_perms = {};
1624 while (my $perm = $sth->fetchrow_hashref) {
1625 $user_perms->{$perm->{'flag'}}->{$perm->{'code'}} = 1;
1630 =head2 get_all_subpermissions
1632 my $perm_hashref = get_all_subpermissions();
1634 Returns a hashref of hashrefs defining all specific
1635 permissions currently defined. The return value
1636 has the same structure as that of C<get_user_subpermissions>,
1637 except that the innermost hash value is the description
1638 of the subpermission.
1642 sub get_all_subpermissions {
1643 my $dbh = C4::Context->dbh;
1644 my $sth = $dbh->prepare("SELECT flag, code, description
1646 JOIN userflags ON (module_bit = bit)");
1650 while (my $perm = $sth->fetchrow_hashref) {
1651 $all_perms->{$perm->{'flag'}}->{$perm->{'code'}} = $perm->{'description'};
1656 =head2 haspermission
1658 $flags = ($userid, $flagsrequired);
1660 C<$userid> the userid of the member
1661 C<$flags> is a hashref of required flags like C<$borrower-<{authflags}>
1663 Returns member's flags or 0 if a permission is not met.
1668 my ($userid, $flagsrequired) = @_;
1669 my $sth = C4::Context->dbh->prepare("SELECT flags FROM borrowers WHERE userid=?");
1670 $sth->execute($userid);
1671 my $flags = getuserflags($sth->fetchrow(), $userid);
1672 if ( $userid eq C4::Context->config('user') ) {
1673 # Super User Account from /etc/koha.conf
1674 $flags->{'superlibrarian'} = 1;
1676 elsif ( $userid eq 'demo' && C4::Context->config('demo') ) {
1677 # Demo user that can do "anything" (demo=1 in /etc/koha.conf)
1678 $flags->{'superlibrarian'} = 1;
1681 return $flags if $flags->{superlibrarian};
1683 foreach my $module ( keys %$flagsrequired ) {
1684 my $subperm = $flagsrequired->{$module};
1685 if ($subperm eq '*') {
1686 return 0 unless ( $flags->{$module} == 1 or ref($flags->{$module}) );
1688 return 0 unless ( $flags->{$module} == 1 or
1689 ( ref($flags->{$module}) and
1690 exists $flags->{$module}->{$subperm} and
1691 $flags->{$module}->{$subperm} == 1
1697 #FIXME - This fcn should return the failed permission so a suitable error msg can be delivered.
1701 sub getborrowernumber {
1703 my $userenv = C4::Context->userenv;
1704 if ( defined( $userenv ) && ref( $userenv ) eq 'HASH' && $userenv->{number} ) {
1705 return $userenv->{number};
1707 my $dbh = C4::Context->dbh;
1708 for my $field ( 'userid', 'cardnumber' ) {
1710 $dbh->prepare("select borrowernumber from borrowers where $field=?");
1711 $sth->execute($userid);
1713 my ($bnumber) = $sth->fetchrow;
1721 END { } # module clean-up code here (global destructor)