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 JSON qw/encode_json decode_json/;
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 ParseSearchHistoryCookie
52 %EXPORT_TAGS = ( EditPermissions => [qw(get_all_subpermissions get_user_subpermissions)] );
53 $ldap = C4::Context->config('useldapserver') || 0;
54 $cas = C4::Context->preference('casAuthentication');
55 $caslogout = C4::Context->preference('casLogout');
56 require C4::Auth_with_cas; # no import
58 require C4::Auth_with_ldap;
59 import C4::Auth_with_ldap qw(checkpw_ldap);
62 import C4::Auth_with_cas qw(check_api_auth_cas checkpw_cas login_cas logout_cas login_cas_url);
69 C4::Auth - Authenticates Koha users
79 my ($template, $borrowernumber, $cookie)
80 = get_template_and_user(
82 template_name => "opac-main.tmpl",
86 flagsrequired => {borrow => 1, catalogue => '*', tools => 'import_patrons' },
90 output_html_with_http_headers $query, $cookie, $template->output;
94 The main function of this module is to provide
95 authentification. However the get_template_and_user function has
96 been provided so that a users login information is passed along
97 automatically. This gets loaded into the template.
101 =head2 get_template_and_user
103 my ($template, $borrowernumber, $cookie)
104 = get_template_and_user(
106 template_name => "opac-main.tmpl",
109 authnotrequired => 1,
110 flagsrequired => {borrow => 1, catalogue => '*', tools => 'import_patrons' },
114 This call passes the C<query>, C<flagsrequired> and C<authnotrequired>
115 to C<&checkauth> (in this module) to perform authentification.
116 See C<&checkauth> for an explanation of these parameters.
118 The C<template_name> is then used to find the correct template for
119 the page. The authenticated users details are loaded onto the
120 template in the HTML::Template LOOP variable C<USER_INFO>. Also the
121 C<sessionID> is passed to the template. This can be used in templates
122 if cookies are disabled. It needs to be put as and input to every
125 More information on the C<gettemplate> sub can be found in the
130 my $SEARCH_HISTORY_INSERT_SQL =<<EOQ;
131 INSERT INTO search_history(userid, sessionid, query_desc, query_cgi, total, time )
132 VALUES ( ?, ?, ?, ?, ?, FROM_UNIXTIME(?))
135 sub get_template_and_user {
138 C4::Templates::gettemplate( $in->{'template_name'}, $in->{'type'}, $in->{'query'}, $in->{'is_plugin'} );
139 my ( $user, $cookie, $sessionID, $flags );
140 if ( $in->{'template_name'} !~m/maintenance/ ) {
141 ( $user, $cookie, $sessionID, $flags ) = checkauth(
143 $in->{'authnotrequired'},
144 $in->{'flagsrequired'},
152 # It's possible for $user to be the borrowernumber if they don't have a
153 # userid defined (and are logging in through some other method, such
154 # as SSL certs against an email address)
155 $borrowernumber = getborrowernumber($user) if defined($user);
156 if (!defined($borrowernumber) && defined($user)) {
157 my $borrower = C4::Members::GetMember(borrowernumber => $user);
159 $borrowernumber = $user;
160 # A bit of a hack, but I don't know there's a nicer way
162 $user = $borrower->{firstname} . ' ' . $borrower->{surname};
167 $template->param( loggedinusername => $user );
168 $template->param( sessionID => $sessionID );
170 my ($total, $pubshelves, $barshelves) = C4::VirtualShelves::GetSomeShelfNames($borrowernumber, 'MASTHEAD');
172 pubshelves => $total->{pubtotal},
173 pubshelvesloop => $pubshelves,
174 barshelves => $total->{bartotal},
175 barshelvesloop => $barshelves,
178 my ( $borr ) = C4::Members::GetMemberDetails( $borrowernumber );
181 $template->param( "USER_INFO" => \@bordat );
183 my $all_perms = get_all_subpermissions();
185 my @flagroots = qw(circulate catalogue parameters borrowers permissions reserveforothers borrow
186 editcatalogue updatecharges management tools editauthorities serials reports acquisition);
187 # We are going to use the $flags returned by checkauth
188 # to create the template's parameters that will indicate
189 # which menus the user can access.
190 if ( $flags && $flags->{superlibrarian}==1 ) {
191 $template->param( CAN_user_circulate => 1 );
192 $template->param( CAN_user_catalogue => 1 );
193 $template->param( CAN_user_parameters => 1 );
194 $template->param( CAN_user_borrowers => 1 );
195 $template->param( CAN_user_permissions => 1 );
196 $template->param( CAN_user_reserveforothers => 1 );
197 $template->param( CAN_user_borrow => 1 );
198 $template->param( CAN_user_editcatalogue => 1 );
199 $template->param( CAN_user_updatecharges => 1 );
200 $template->param( CAN_user_acquisition => 1 );
201 $template->param( CAN_user_management => 1 );
202 $template->param( CAN_user_tools => 1 );
203 $template->param( CAN_user_editauthorities => 1 );
204 $template->param( CAN_user_serials => 1 );
205 $template->param( CAN_user_reports => 1 );
206 $template->param( CAN_user_staffaccess => 1 );
207 $template->param( CAN_user_plugins => 1 );
208 $template->param( CAN_user_coursereserves => 1 );
209 foreach my $module (keys %$all_perms) {
210 foreach my $subperm (keys %{ $all_perms->{$module} }) {
211 $template->param( "CAN_user_${module}_${subperm}" => 1 );
217 foreach my $module (keys %$all_perms) {
218 if ( $flags->{$module} == 1) {
219 foreach my $subperm (keys %{ $all_perms->{$module} }) {
220 $template->param( "CAN_user_${module}_${subperm}" => 1 );
222 } elsif ( ref($flags->{$module}) ) {
223 foreach my $subperm (keys %{ $flags->{$module} } ) {
224 $template->param( "CAN_user_${module}_${subperm}" => 1 );
231 foreach my $module (keys %$flags) {
232 if ( $flags->{$module} == 1 or ref($flags->{$module}) ) {
233 $template->param( "CAN_user_$module" => 1 );
234 if ($module eq "parameters") {
235 $template->param( CAN_user_management => 1 );
240 # Logged-in opac search history
241 # If the requested template is an opac one and opac search history is enabled
242 if ($in->{type} eq 'opac' && C4::Context->preference('EnableOpacSearchHistory')) {
243 my $dbh = C4::Context->dbh;
244 my $query = "SELECT COUNT(*) FROM search_history WHERE userid=?";
245 my $sth = $dbh->prepare($query);
246 $sth->execute($borrowernumber);
248 # If at least one search has already been performed
249 if ($sth->fetchrow_array > 0) {
250 # We show the link in opac
251 $template->param(ShowOpacRecentSearchLink => 1);
254 # And if there's a cookie with searches performed when the user was not logged in,
255 # we add them to the logged-in search history
256 my @recentSearches = ParseSearchHistoryCookie($in->{'query'});
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 => encode_json([]),
274 $cookie = [$cookie, $newsearchcookie];
278 else { # if this is an anonymous session, setup to display public lists...
280 $template->param( sessionID => $sessionID );
282 my ($total, $pubshelves) = C4::VirtualShelves::GetSomeShelfNames(undef, 'MASTHEAD');
284 pubshelves => $total->{pubtotal},
285 pubshelvesloop => $pubshelves,
288 # Anonymous opac search history
289 # If opac search history is enabled and at least one search has already been performed
290 if (C4::Context->preference('EnableOpacSearchHistory')) {
291 my @recentSearches = ParseSearchHistoryCookie($in->{'query'});
292 if (@recentSearches) {
293 $template->param(ShowOpacRecentSearchLink => 1);
297 if(C4::Context->preference('dateformat')){
298 $template->param(dateformat => C4::Context->preference('dateformat'))
301 # these template parameters are set the same regardless of $in->{'type'}
303 "BiblioDefaultView".C4::Context->preference("BiblioDefaultView") => 1,
304 EnhancedMessagingPreferences => C4::Context->preference('EnhancedMessagingPreferences'),
305 GoogleJackets => C4::Context->preference("GoogleJackets"),
306 OpenLibraryCovers => C4::Context->preference("OpenLibraryCovers"),
307 KohaAdminEmailAddress => "" . C4::Context->preference("KohaAdminEmailAddress"),
308 LoginBranchcode => (C4::Context->userenv?C4::Context->userenv->{"branch"}:undef),
309 LoginFirstname => (C4::Context->userenv?C4::Context->userenv->{"firstname"}:"Bel"),
310 LoginSurname => C4::Context->userenv?C4::Context->userenv->{"surname"}:"Inconnu",
311 emailaddress => C4::Context->userenv?C4::Context->userenv->{"emailaddress"}:undef,
312 loggedinpersona => C4::Context->userenv?C4::Context->userenv->{"persona"}:undef,
313 TagsEnabled => C4::Context->preference("TagsEnabled"),
314 hide_marc => C4::Context->preference("hide_marc"),
315 item_level_itypes => C4::Context->preference('item-level_itypes'),
316 patronimages => C4::Context->preference("patronimages"),
317 singleBranchMode => C4::Context->preference("singleBranchMode"),
318 XSLTDetailsDisplay => C4::Context->preference("XSLTDetailsDisplay"),
319 XSLTResultsDisplay => C4::Context->preference("XSLTResultsDisplay"),
320 using_https => $in->{'query'}->https() ? 1 : 0,
321 noItemTypeImages => C4::Context->preference("noItemTypeImages"),
322 marcflavour => C4::Context->preference("marcflavour"),
323 persona => C4::Context->preference("persona"),
325 if ( $in->{'type'} eq "intranet" ) {
327 AmazonCoverImages => C4::Context->preference("AmazonCoverImages"),
328 AutoLocation => C4::Context->preference("AutoLocation"),
329 "BiblioDefaultView".C4::Context->preference("IntranetBiblioDefaultView") => 1,
330 CalendarFirstDayOfWeek => (C4::Context->preference("CalendarFirstDayOfWeek") eq "Sunday")?0:1,
331 CircAutocompl => C4::Context->preference("CircAutocompl"),
332 FRBRizeEditions => C4::Context->preference("FRBRizeEditions"),
333 IndependentBranches => C4::Context->preference("IndependentBranches"),
334 IntranetNav => C4::Context->preference("IntranetNav"),
335 IntranetmainUserblock => C4::Context->preference("IntranetmainUserblock"),
336 LibraryName => C4::Context->preference("LibraryName"),
337 LoginBranchname => (C4::Context->userenv?C4::Context->userenv->{"branchname"}:undef),
338 advancedMARCEditor => C4::Context->preference("advancedMARCEditor"),
339 canreservefromotherbranches => C4::Context->preference('canreservefromotherbranches'),
340 intranetcolorstylesheet => C4::Context->preference("intranetcolorstylesheet"),
341 IntranetFavicon => C4::Context->preference("IntranetFavicon"),
342 intranetreadinghistory => C4::Context->preference("intranetreadinghistory"),
343 intranetstylesheet => C4::Context->preference("intranetstylesheet"),
344 IntranetUserCSS => C4::Context->preference("IntranetUserCSS"),
345 intranetuserjs => C4::Context->preference("intranetuserjs"),
346 intranetbookbag => C4::Context->preference("intranetbookbag"),
347 suggestion => C4::Context->preference("suggestion"),
348 virtualshelves => C4::Context->preference("virtualshelves"),
349 StaffSerialIssueDisplayCount => C4::Context->preference("StaffSerialIssueDisplayCount"),
350 EasyAnalyticalRecords => C4::Context->preference('EasyAnalyticalRecords'),
351 LocalCoverImages => C4::Context->preference('LocalCoverImages'),
352 OPACLocalCoverImages => C4::Context->preference('OPACLocalCoverImages'),
353 AllowMultipleCovers => C4::Context->preference('AllowMultipleCovers'),
354 EnableBorrowerFiles => C4::Context->preference('EnableBorrowerFiles'),
355 UseKohaPlugins => C4::Context->preference('UseKohaPlugins'),
356 UseCourseReserves => C4::Context->preference("UseCourseReserves"),
360 warn "template type should be OPAC, here it is=[" . $in->{'type'} . "]" unless ( $in->{'type'} eq 'opac' );
361 #TODO : replace LibraryName syspref with 'system name', and remove this html processing
362 my $LibraryNameTitle = C4::Context->preference("LibraryName");
363 $LibraryNameTitle =~ s/<(?:\/?)(?:br|p)\s*(?:\/?)>/ /sgi;
364 $LibraryNameTitle =~ s/<(?:[^<>'"]|'(?:[^']*)'|"(?:[^"]*)")*>//sg;
365 # clean up the busc param in the session if the page is not opac-detail
366 if (C4::Context->preference("OpacBrowseResults") && $in->{'template_name'} =~ /opac-(.+)\.(?:tt|tmpl)$/ && $1 !~ /^(?:MARC|ISBD)?detail$/) {
367 my $sessionSearch = get_session($sessionID || $in->{'query'}->cookie("CGISESSID"));
368 $sessionSearch->clear(["busc"]) if ($sessionSearch->param("busc"));
370 # variables passed from CGI: opac_css_override and opac_search_limits.
371 my $opac_search_limit = $ENV{'OPAC_SEARCH_LIMIT'};
372 my $opac_limit_override = $ENV{'OPAC_LIMIT_OVERRIDE'};
374 if (($opac_search_limit && $opac_search_limit =~ /branch:(\w+)/ && $opac_limit_override) || ($in->{'query'}->param('limit') && $in->{'query'}->param('limit') =~ /branch:(\w+)/)){
375 $opac_name = $1; # opac_search_limit is a branch, so we use it.
376 } elsif ( $in->{'query'}->param('multibranchlimit') ) {
377 $opac_name = $in->{'query'}->param('multibranchlimit');
378 } elsif (C4::Context->preference("SearchMyLibraryFirst") && C4::Context->userenv && C4::Context->userenv->{'branch'}) {
379 $opac_name = C4::Context->userenv->{'branch'};
382 opaccolorstylesheet => C4::Context->preference("opaccolorstylesheet"),
383 AnonSuggestions => "" . C4::Context->preference("AnonSuggestions"),
384 AuthorisedValueImages => C4::Context->preference("AuthorisedValueImages"),
385 BranchesLoop => GetBranchesLoop($opac_name),
386 BranchCategoriesLoop => GetBranchCategories( 'searchdomain', 1, $opac_name ),
387 CalendarFirstDayOfWeek => (C4::Context->preference("CalendarFirstDayOfWeek") eq "Sunday")?0:1,
388 LibraryName => "" . C4::Context->preference("LibraryName"),
389 LibraryNameTitle => "" . $LibraryNameTitle,
390 LoginBranchname => C4::Context->userenv?C4::Context->userenv->{"branchname"}:"",
391 OPACAmazonCoverImages => C4::Context->preference("OPACAmazonCoverImages"),
392 OPACFRBRizeEditions => C4::Context->preference("OPACFRBRizeEditions"),
393 OpacHighlightedWords => C4::Context->preference("OpacHighlightedWords"),
394 OPACItemHolds => C4::Context->preference("OPACItemHolds"),
395 OPACShelfBrowser => "". C4::Context->preference("OPACShelfBrowser"),
396 OPACURLOpenInNewWindow => "" . C4::Context->preference("OPACURLOpenInNewWindow"),
397 OPACUserCSS => "". C4::Context->preference("OPACUserCSS"),
398 OPACMobileUserCSS => "". C4::Context->preference("OPACMobileUserCSS"),
399 OPACViewOthersSuggestions => "" . C4::Context->preference("OPACViewOthersSuggestions"),
400 OpacAuthorities => C4::Context->preference("OpacAuthorities"),
401 OPACBaseURL => ($in->{'query'}->https() ? "https://" : "http://") . $ENV{'SERVER_NAME'} .
402 ($ENV{'SERVER_PORT'} eq ($in->{'query'}->https() ? "443" : "80") ? '' : ":$ENV{'SERVER_PORT'}"),
403 opac_css_override => $ENV{'OPAC_CSS_OVERRIDE'},
404 opac_search_limit => $opac_search_limit,
405 opac_limit_override => $opac_limit_override,
406 OpacBrowser => C4::Context->preference("OpacBrowser"),
407 OpacCloud => C4::Context->preference("OpacCloud"),
408 OpacKohaUrl => C4::Context->preference("OpacKohaUrl"),
409 OpacMainUserBlock => "" . C4::Context->preference("OpacMainUserBlock"),
410 OpacMainUserBlockMobile => "" . C4::Context->preference("OpacMainUserBlockMobile"),
411 OpacShowFiltersPulldownMobile => C4::Context->preference("OpacShowFiltersPulldownMobile"),
412 OpacShowLibrariesPulldownMobile => C4::Context->preference("OpacShowLibrariesPulldownMobile"),
413 OpacNav => "" . C4::Context->preference("OpacNav"),
414 OpacNavRight => "" . C4::Context->preference("OpacNavRight"),
415 OpacNavBottom => "" . C4::Context->preference("OpacNavBottom"),
416 OpacPasswordChange => C4::Context->preference("OpacPasswordChange"),
417 OPACPatronDetails => C4::Context->preference("OPACPatronDetails"),
418 OPACPrivacy => C4::Context->preference("OPACPrivacy"),
419 OPACFinesTab => C4::Context->preference("OPACFinesTab"),
420 OpacTopissue => C4::Context->preference("OpacTopissue"),
421 RequestOnOpac => C4::Context->preference("RequestOnOpac"),
422 'Version' => C4::Context->preference('Version'),
423 hidelostitems => C4::Context->preference("hidelostitems"),
424 mylibraryfirst => (C4::Context->preference("SearchMyLibraryFirst") && C4::Context->userenv) ? C4::Context->userenv->{'branch'} : '',
425 opaclayoutstylesheet => "" . C4::Context->preference("opaclayoutstylesheet"),
426 opacbookbag => "" . C4::Context->preference("opacbookbag"),
427 opaccredits => "" . C4::Context->preference("opaccredits"),
428 OpacFavicon => C4::Context->preference("OpacFavicon"),
429 opacheader => "" . C4::Context->preference("opacheader"),
430 opaclanguagesdisplay => "" . C4::Context->preference("opaclanguagesdisplay"),
431 opacreadinghistory => C4::Context->preference("opacreadinghistory"),
432 opacsmallimage => "" . C4::Context->preference("opacsmallimage"),
433 opacuserjs => C4::Context->preference("opacuserjs"),
434 opacuserlogin => "" . C4::Context->preference("opacuserlogin"),
435 ShowReviewer => C4::Context->preference("ShowReviewer"),
436 ShowReviewerPhoto => C4::Context->preference("ShowReviewerPhoto"),
437 suggestion => "" . C4::Context->preference("suggestion"),
438 virtualshelves => "" . C4::Context->preference("virtualshelves"),
439 OPACSerialIssueDisplayCount => C4::Context->preference("OPACSerialIssueDisplayCount"),
440 OPACXSLTDetailsDisplay => C4::Context->preference("OPACXSLTDetailsDisplay"),
441 OPACXSLTResultsDisplay => C4::Context->preference("OPACXSLTResultsDisplay"),
442 SyndeticsClientCode => C4::Context->preference("SyndeticsClientCode"),
443 SyndeticsEnabled => C4::Context->preference("SyndeticsEnabled"),
444 SyndeticsCoverImages => C4::Context->preference("SyndeticsCoverImages"),
445 SyndeticsTOC => C4::Context->preference("SyndeticsTOC"),
446 SyndeticsSummary => C4::Context->preference("SyndeticsSummary"),
447 SyndeticsEditions => C4::Context->preference("SyndeticsEditions"),
448 SyndeticsExcerpt => C4::Context->preference("SyndeticsExcerpt"),
449 SyndeticsReviews => C4::Context->preference("SyndeticsReviews"),
450 SyndeticsAuthorNotes => C4::Context->preference("SyndeticsAuthorNotes"),
451 SyndeticsAwards => C4::Context->preference("SyndeticsAwards"),
452 SyndeticsSeries => C4::Context->preference("SyndeticsSeries"),
453 SyndeticsCoverImageSize => C4::Context->preference("SyndeticsCoverImageSize"),
454 OPACLocalCoverImages => C4::Context->preference("OPACLocalCoverImages"),
455 PatronSelfRegistration => C4::Context->preference("PatronSelfRegistration"),
456 PatronSelfRegistrationDefaultCategory => C4::Context->preference("PatronSelfRegistrationDefaultCategory"),
459 $template->param(OpacPublic => '1') if ($user || C4::Context->preference("OpacPublic"));
461 return ( $template, $borrowernumber, $cookie, $flags);
466 ($userid, $cookie, $sessionID) = &checkauth($query, $noauth, $flagsrequired, $type);
468 Verifies that the user is authorized to run this script. If
469 the user is authorized, a (userid, cookie, session-id, flags)
470 quadruple is returned. If the user is not authorized but does
471 not have the required privilege (see $flagsrequired below), it
472 displays an error page and exits. Otherwise, it displays the
473 login page and exits.
475 Note that C<&checkauth> will return if and only if the user
476 is authorized, so it should be called early on, before any
477 unfinished operations (e.g., if you've opened a file, then
478 C<&checkauth> won't close it for you).
480 C<$query> is the CGI object for the script calling C<&checkauth>.
482 The C<$noauth> argument is optional. If it is set, then no
483 authorization is required for the script.
485 C<&checkauth> fetches user and session information from C<$query> and
486 ensures that the user is authorized to run scripts that require
489 The C<$flagsrequired> argument specifies the required privileges
490 the user must have if the username and password are correct.
491 It should be specified as a reference-to-hash; keys in the hash
492 should be the "flags" for the user, as specified in the Members
493 intranet module. Any key specified must correspond to a "flag"
494 in the userflags table. E.g., { circulate => 1 } would specify
495 that the user must have the "circulate" privilege in order to
496 proceed. To make sure that access control is correct, the
497 C<$flagsrequired> parameter must be specified correctly.
499 Koha also has a concept of sub-permissions, also known as
500 granular permissions. This makes the value of each key
501 in the C<flagsrequired> hash take on an additional
506 The user must have access to all subfunctions of the module
507 specified by the hash key.
511 The user must have access to at least one subfunction of the module
512 specified by the hash key.
514 specific permission, e.g., 'export_catalog'
516 The user must have access to the specific subfunction list, which
517 must correspond to a row in the permissions table.
519 The C<$type> argument specifies whether the template should be
520 retrieved from the opac or intranet directory tree. "opac" is
521 assumed if it is not specified; however, if C<$type> is specified,
522 "intranet" is assumed if it is not "opac".
524 If C<$query> does not have a valid session ID associated with it
525 (i.e., the user has not logged in) or if the session has expired,
526 C<&checkauth> presents the user with a login page (from the point of
527 view of the original script, C<&checkauth> does not return). Once the
528 user has authenticated, C<&checkauth> restarts the original script
529 (this time, C<&checkauth> returns).
531 The login page is provided using a HTML::Template, which is set in the
532 systempreferences table or at the top of this file. The variable C<$type>
533 selects which template to use, either the opac or the intranet
534 authentification template.
536 C<&checkauth> returns a user ID, a cookie, and a session ID. The
537 cookie should be sent back to the browser; it verifies that the user
546 # If Version syspref is unavailable, it means Koha is beeing installed,
547 # and so we must redirect to OPAC maintenance page or to the WebInstaller
548 # also, if OpacMaintenance is ON, OPAC should redirect to maintenance
549 if (C4::Context->preference('OpacMaintenance') && $type eq 'opac') {
550 warn "OPAC Install required, redirecting to maintenance";
551 print $query->redirect("/cgi-bin/koha/maintenance.pl");
554 unless ( $version = C4::Context->preference('Version') ) { # assignment, not comparison
555 if ( $type ne 'opac' ) {
556 warn "Install required, redirecting to Installer";
557 print $query->redirect("/cgi-bin/koha/installer/install.pl");
559 warn "OPAC Install required, redirecting to maintenance";
560 print $query->redirect("/cgi-bin/koha/maintenance.pl");
565 # check that database and koha version are the same
566 # there is no DB version, it's a fresh install,
567 # go to web installer
568 # there is a DB version, compare it to the code version
569 my $kohaversion=C4::Context::KOHAVERSION;
570 # remove the 3 last . to have a Perl number
571 $kohaversion =~ s/(.*\..*)\.(.*)\.(.*)/$1$2$3/;
572 $debug and print STDERR "kohaversion : $kohaversion\n";
573 if ($version < $kohaversion){
574 my $warning = "Database update needed, redirecting to %s. Database is $version and Koha is $kohaversion";
575 if ($type ne 'opac'){
576 warn sprintf($warning, 'Installer');
577 print $query->redirect("/cgi-bin/koha/installer/install.pl?step=3");
579 warn sprintf("OPAC: " . $warning, 'maintenance');
580 print $query->redirect("/cgi-bin/koha/maintenance.pl");
588 open my $fh, '>>', "/tmp/sessionlog" or warn "ERROR: Cannot append to /tmp/sessionlog";
589 printf $fh join("\n",@_);
593 sub _timeout_syspref {
594 my $timeout = C4::Context->preference('timeout') || 600;
595 # value in days, convert in seconds
596 if ($timeout =~ /(\d+)[dD]/) {
597 $timeout = $1 * 86400;
604 $debug and warn "Checking Auth";
605 # $authnotrequired will be set for scripts which will run without authentication
606 my $authnotrequired = shift;
607 my $flagsrequired = shift;
610 $type = 'opac' unless $type;
612 my $dbh = C4::Context->dbh;
613 my $timeout = _timeout_syspref();
615 _version_check($type,$query);
619 my ( $userid, $cookie, $sessionID, $flags, $barshelves, $pubshelves );
620 my $logout = $query->param('logout.x');
622 # This parameter is the name of the CAS server we want to authenticate against,
623 # when using authentication against multiple CAS servers, as configured in Auth_cas_servers.yaml
624 my $casparam = $query->param('cas');
626 if ( $userid = $ENV{'REMOTE_USER'} ) {
627 # Using Basic Authentication, no cookies required
628 $cookie = $query->cookie(
629 -name => 'CGISESSID',
637 # we dont want to set a session because we are being called by a persona callback
639 elsif ( $sessionID = $query->cookie("CGISESSID") )
640 { # assignment, not comparison
641 my $session = get_session($sessionID);
642 C4::Context->_new_userenv($sessionID);
643 my ($ip, $lasttime, $sessiontype);
645 C4::Context::set_userenv(
646 $session->param('number'), $session->param('id'),
647 $session->param('cardnumber'), $session->param('firstname'),
648 $session->param('surname'), $session->param('branch'),
649 $session->param('branchname'), $session->param('flags'),
650 $session->param('emailaddress'), $session->param('branchprinter'),
651 $session->param('persona')
653 C4::Context::set_shelves_userenv('bar',$session->param('barshelves'));
654 C4::Context::set_shelves_userenv('pub',$session->param('pubshelves'));
655 C4::Context::set_shelves_userenv('tot',$session->param('totshelves'));
656 $debug and printf STDERR "AUTH_SESSION: (%s)\t%s %s - %s\n", map {$session->param($_)} qw(cardnumber firstname surname branch) ;
657 $ip = $session->param('ip');
658 $lasttime = $session->param('lasttime');
659 $userid = $session->param('id');
660 $sessiontype = $session->param('sessiontype') || '';
662 if ( ( ($query->param('koha_login_context')) && ($query->param('userid') ne $session->param('id')) )
663 || ( $cas && $query->param('ticket') ) ) {
664 #if a user enters an id ne to the id in the current session, we need to log them in...
665 #first we need to clear the anonymous session...
666 $debug and warn "query id = " . $query->param('userid') . " but session id = " . $session->param('id');
669 C4::Context->_unset_userenv($sessionID);
674 # voluntary logout the user
677 C4::Context->_unset_userenv($sessionID);
678 #_session_log(sprintf "%20s from %16s logged out at %30s (manually).\n", $userid,$ip,(strftime "%c",localtime));
682 if ($cas and $caslogout) {
686 elsif ( $lasttime < time() - $timeout ) {
688 $info{'timed_out'} = 1;
689 $session->delete() if $session;
690 C4::Context->_unset_userenv($sessionID);
691 #_session_log(sprintf "%20s from %16s logged out at %30s (inactivity).\n", $userid,$ip,(strftime "%c",localtime));
695 elsif ( $ip ne $ENV{'REMOTE_ADDR'} ) {
696 # Different ip than originally logged in from
697 $info{'oldip'} = $ip;
698 $info{'newip'} = $ENV{'REMOTE_ADDR'};
699 $info{'different_ip'} = 1;
701 C4::Context->_unset_userenv($sessionID);
702 #_session_log(sprintf "%20s from %16s logged out at %30s (ip changed to %16s).\n", $userid,$ip,(strftime "%c",localtime), $info{'newip'});
707 $cookie = $query->cookie(
708 -name => 'CGISESSID',
709 -value => $session->id,
712 $session->param( 'lasttime', time() );
713 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...
714 $flags = haspermission($userid, $flagsrequired);
718 $info{'nopermission'} = 1;
723 unless ($userid || $sessionID) {
725 #we initiate a session prior to checking for a username to allow for anonymous sessions...
726 my $session = get_session("") or die "Auth ERROR: Cannot get_session()";
727 my $sessionID = $session->id;
728 C4::Context->_new_userenv($sessionID);
729 $cookie = $query->cookie(
730 -name => 'CGISESSID',
731 -value => $session->id,
734 $userid = $query->param('userid');
735 if ( ( $cas && $query->param('ticket') )
737 || ( my $pki_field = C4::Context->preference('AllowPKIAuth') ) ne
740 my $password = $query->param('password');
742 my ( $return, $cardnumber );
743 if ( $cas && $query->param('ticket') ) {
745 ( $return, $cardnumber, $retuserid ) =
746 checkpw( $dbh, $userid, $password, $query );
747 $userid = $retuserid;
748 $info{'invalidCasLogin'} = 1 unless ($return);
752 my $value = $persona;
754 # If we're looking up the email, there's a chance that the person
755 # doesn't have a userid. So if there is none, we pass along the
756 # borrower number, and the bits of code that need to know the user
757 # ID will have to be smart enough to handle that.
759 my @users_info = C4::Members::GetBorrowersWithEmail($value);
762 # First the userid, then the borrowernum
763 $value = $users_info[0][1] || $users_info[0][0];
768 $return = $value ? 1 : 0;
773 ( $pki_field eq 'Common Name' && $ENV{'SSL_CLIENT_S_DN_CN'} )
774 || ( $pki_field eq 'emailAddress'
775 && $ENV{'SSL_CLIENT_S_DN_Email'} )
779 if ( $pki_field eq 'Common Name' ) {
780 $value = $ENV{'SSL_CLIENT_S_DN_CN'};
782 elsif ( $pki_field eq 'emailAddress' ) {
783 $value = $ENV{'SSL_CLIENT_S_DN_Email'};
785 # If we're looking up the email, there's a chance that the person
786 # doesn't have a userid. So if there is none, we pass along the
787 # borrower number, and the bits of code that need to know the user
788 # ID will have to be smart enough to handle that.
790 my @users_info = C4::Members::GetBorrowersWithEmail($value);
793 # First the userid, then the borrowernum
794 $value = $users_info[0][1] || $users_info[0][0];
801 $return = $value ? 1 : 0;
807 ( $return, $cardnumber, $retuserid ) =
808 checkpw( $dbh, $userid, $password, $query );
809 $userid = $retuserid if ( $retuserid ne '' );
812 #_session_log(sprintf "%20s from %16s logged in at %30s.\n", $userid,$ENV{'REMOTE_ADDR'},(strftime '%c', localtime));
813 if ( $flags = haspermission( $userid, $flagsrequired ) ) {
817 $info{'nopermission'} = 1;
818 C4::Context->_unset_userenv($sessionID);
820 my ($borrowernumber, $firstname, $surname, $userflags,
821 $branchcode, $branchname, $branchprinter, $emailaddress);
823 if ( $return == 1 ) {
825 SELECT borrowernumber, firstname, surname, flags, borrowers.branchcode,
826 branches.branchname as branchname,
827 branches.branchprinter as branchprinter,
830 LEFT JOIN branches on borrowers.branchcode=branches.branchcode
832 my $sth = $dbh->prepare("$select where userid=?");
833 $sth->execute($userid);
834 unless ($sth->rows) {
835 $debug and print STDERR "AUTH_1: no rows for userid='$userid'\n";
836 $sth = $dbh->prepare("$select where cardnumber=?");
837 $sth->execute($cardnumber);
839 unless ($sth->rows) {
840 $debug and print STDERR "AUTH_2a: no rows for cardnumber='$cardnumber'\n";
841 $sth->execute($userid);
842 unless ($sth->rows) {
843 $debug and print STDERR "AUTH_2b: no rows for userid='$userid' AS cardnumber\n";
848 ($borrowernumber, $firstname, $surname, $userflags,
849 $branchcode, $branchname, $branchprinter, $emailaddress) = $sth->fetchrow;
850 $debug and print STDERR "AUTH_3 results: " .
851 "$cardnumber,$borrowernumber,$userid,$firstname,$surname,$userflags,$branchcode,$emailaddress\n";
853 print STDERR "AUTH_3: no results for userid='$userid', cardnumber='$cardnumber'.\n";
856 # launch a sequence to check if we have a ip for the branch, i
857 # if we have one we replace the branchcode of the userenv by the branch bound in the ip.
859 my $ip = $ENV{'REMOTE_ADDR'};
860 # if they specify at login, use that
861 if ($query->param('branch')) {
862 $branchcode = $query->param('branch');
863 $branchname = GetBranchName($branchcode);
865 my $branches = GetBranches();
866 if (C4::Context->boolean_preference('IndependentBranches') && C4::Context->boolean_preference('Autolocation')){
867 # we have to check they are coming from the right ip range
868 my $domain = $branches->{$branchcode}->{'branchip'};
869 if ($ip !~ /^$domain/){
871 $info{'wrongip'} = 1;
876 foreach my $br ( keys %$branches ) {
877 # now we work with the treatment of ip
878 my $domain = $branches->{$br}->{'branchip'};
879 if ( $domain && $ip =~ /^$domain/ ) {
880 $branchcode = $branches->{$br}->{'branchcode'};
882 # new op dev : add the branchprinter and branchname in the cookie
883 $branchprinter = $branches->{$br}->{'branchprinter'};
884 $branchname = $branches->{$br}->{'branchname'};
887 $session->param('number',$borrowernumber);
888 $session->param('id',$userid);
889 $session->param('cardnumber',$cardnumber);
890 $session->param('firstname',$firstname);
891 $session->param('surname',$surname);
892 $session->param('branch',$branchcode);
893 $session->param('branchname',$branchname);
894 $session->param('flags',$userflags);
895 $session->param('emailaddress',$emailaddress);
896 $session->param('ip',$session->remote_addr());
897 $session->param('lasttime',time());
898 $debug and printf STDERR "AUTH_4: (%s)\t%s %s - %s\n", map {$session->param($_)} qw(cardnumber firstname surname branch) ;
900 elsif ( $return == 2 ) {
901 #We suppose the user is the superlibrarian
903 $session->param('number',0);
904 $session->param('id',C4::Context->config('user'));
905 $session->param('cardnumber',C4::Context->config('user'));
906 $session->param('firstname',C4::Context->config('user'));
907 $session->param('surname',C4::Context->config('user'));
908 $session->param('branch','NO_LIBRARY_SET');
909 $session->param('branchname','NO_LIBRARY_SET');
910 $session->param('flags',1);
911 $session->param('emailaddress', C4::Context->preference('KohaAdminEmailAddress'));
912 $session->param('ip',$session->remote_addr());
913 $session->param('lasttime',time());
916 $session->param('persona',1);
918 C4::Context::set_userenv(
919 $session->param('number'), $session->param('id'),
920 $session->param('cardnumber'), $session->param('firstname'),
921 $session->param('surname'), $session->param('branch'),
922 $session->param('branchname'), $session->param('flags'),
923 $session->param('emailaddress'), $session->param('branchprinter'),
924 $session->param('persona')
930 $info{'invalid_username_or_password'} = 1;
931 C4::Context->_unset_userenv($sessionID);
934 } # END if ( $userid = $query->param('userid') )
935 elsif ($type eq "opac") {
936 # if we are here this is an anonymous session; add public lists to it and a few other items...
937 # anonymous sessions are created only for the OPAC
938 $debug and warn "Initiating an anonymous session...";
940 # setting a couple of other session vars...
941 $session->param('ip',$session->remote_addr());
942 $session->param('lasttime',time());
943 $session->param('sessiontype','anon');
945 } # END unless ($userid)
947 # finished authentification, now respond
948 if ( $loggedin || $authnotrequired )
952 $cookie = $query->cookie(
953 -name => 'CGISESSID',
958 return ( $userid, $cookie, $sessionID, $flags );
963 # AUTH rejected, show the login/password template, after checking the DB.
967 # get the inputs from the incoming query
969 foreach my $name ( param $query) {
970 (next) if ( $name eq 'userid' || $name eq 'password' || $name eq 'ticket' );
971 my $value = $query->param($name);
972 push @inputs, { name => $name, value => $value };
975 my $LibraryNameTitle = C4::Context->preference("LibraryName");
976 $LibraryNameTitle =~ s/<(?:\/?)(?:br|p)\s*(?:\/?)>/ /sgi;
977 $LibraryNameTitle =~ s/<(?:[^<>'"]|'(?:[^']*)'|"(?:[^"]*)")*>//sg;
979 my $template_name = ( $type eq 'opac' ) ? 'opac-auth.tmpl' : 'auth.tmpl';
980 my $template = C4::Templates::gettemplate($template_name, $type, $query );
982 branchloop => GetBranchesLoop(),
983 opaccolorstylesheet => C4::Context->preference("opaccolorstylesheet"),
984 opaclayoutstylesheet => C4::Context->preference("opaclayoutstylesheet"),
987 casAuthentication => C4::Context->preference("casAuthentication"),
988 suggestion => C4::Context->preference("suggestion"),
989 virtualshelves => C4::Context->preference("virtualshelves"),
990 LibraryName => "" . C4::Context->preference("LibraryName"),
991 LibraryNameTitle => "" . $LibraryNameTitle,
992 opacuserlogin => C4::Context->preference("opacuserlogin"),
993 OpacNav => C4::Context->preference("OpacNav"),
994 OpacNavRight => C4::Context->preference("OpacNavRight"),
995 OpacNavBottom => C4::Context->preference("OpacNavBottom"),
996 opaccredits => C4::Context->preference("opaccredits"),
997 OpacFavicon => C4::Context->preference("OpacFavicon"),
998 opacreadinghistory => C4::Context->preference("opacreadinghistory"),
999 opacsmallimage => C4::Context->preference("opacsmallimage"),
1000 opaclanguagesdisplay => C4::Context->preference("opaclanguagesdisplay"),
1001 opacuserjs => C4::Context->preference("opacuserjs"),
1002 opacbookbag => "" . C4::Context->preference("opacbookbag"),
1003 OpacCloud => C4::Context->preference("OpacCloud"),
1004 OpacTopissue => C4::Context->preference("OpacTopissue"),
1005 OpacAuthorities => C4::Context->preference("OpacAuthorities"),
1006 OpacBrowser => C4::Context->preference("OpacBrowser"),
1007 opacheader => C4::Context->preference("opacheader"),
1008 TagsEnabled => C4::Context->preference("TagsEnabled"),
1009 OPACUserCSS => C4::Context->preference("OPACUserCSS"),
1010 intranetcolorstylesheet => C4::Context->preference("intranetcolorstylesheet"),
1011 intranetstylesheet => C4::Context->preference("intranetstylesheet"),
1012 intranetbookbag => C4::Context->preference("intranetbookbag"),
1013 IntranetNav => C4::Context->preference("IntranetNav"),
1014 IntranetFavicon => C4::Context->preference("IntranetFavicon"),
1015 intranetuserjs => C4::Context->preference("intranetuserjs"),
1016 IndependentBranches=> C4::Context->preference("IndependentBranches"),
1017 AutoLocation => C4::Context->preference("AutoLocation"),
1018 wrongip => $info{'wrongip'},
1019 PatronSelfRegistration => C4::Context->preference("PatronSelfRegistration"),
1020 PatronSelfRegistrationDefaultCategory => C4::Context->preference("PatronSelfRegistrationDefaultCategory"),
1021 persona => C4::Context->preference("Persona"),
1022 opac_css_override => $ENV{'OPAC_CSS_OVERRIDE'},
1025 $template->param( OpacPublic => C4::Context->preference("OpacPublic"));
1026 $template->param( loginprompt => 1 ) unless $info{'nopermission'};
1028 if($type eq 'opac'){
1029 my ($total, $pubshelves) = C4::VirtualShelves::GetSomeShelfNames(undef, 'MASTHEAD');
1031 pubshelves => $total->{pubtotal},
1032 pubshelvesloop => $pubshelves,
1038 # Is authentication against multiple CAS servers enabled?
1039 if (C4::Auth_with_cas::multipleAuth && !$casparam) {
1040 my $casservers = C4::Auth_with_cas::getMultipleAuth();
1042 foreach my $key (keys %$casservers) {
1043 push @tmplservers, {name => $key, value => login_cas_url($query, $key) . "?cas=$key" };
1046 casServersLoop => \@tmplservers
1050 casServerUrl => login_cas_url($query),
1055 invalidCasLogin => $info{'invalidCasLogin'}
1059 my $self_url = $query->url( -absolute => 1 );
1062 LibraryName => C4::Context->preference("LibraryName"),
1064 $template->param( %info );
1065 # $cookie = $query->cookie(CGISESSID => $session->id
1067 print $query->header(
1068 -type => 'text/html',
1069 -charset => 'utf-8',
1076 =head2 check_api_auth
1078 ($status, $cookie, $sessionId) = check_api_auth($query, $userflags);
1080 Given a CGI query containing the parameters 'userid' and 'password' and/or a session
1081 cookie, determine if the user has the privileges specified by C<$userflags>.
1083 C<check_api_auth> is is meant for authenticating users of web services, and
1084 consequently will always return and will not attempt to redirect the user
1087 If a valid session cookie is already present, check_api_auth will return a status
1088 of "ok", the cookie, and the Koha session ID.
1090 If no session cookie is present, check_api_auth will check the 'userid' and 'password
1091 parameters and create a session cookie and Koha session if the supplied credentials
1094 Possible return values in C<$status> are:
1098 =item "ok" -- user authenticated; C<$cookie> and C<$sessionid> have valid values.
1100 =item "failed" -- credentials are not correct; C<$cookie> and C<$sessionid> are undef
1102 =item "maintenance" -- DB is in maintenance mode; no login possible at the moment
1104 =item "expired -- session cookie has expired; API user should resubmit userid and password
1110 sub check_api_auth {
1112 my $flagsrequired = shift;
1114 my $dbh = C4::Context->dbh;
1115 my $timeout = _timeout_syspref();
1117 unless (C4::Context->preference('Version')) {
1118 # database has not been installed yet
1119 return ("maintenance", undef, undef);
1121 my $kohaversion=C4::Context::KOHAVERSION;
1122 $kohaversion =~ s/(.*\..*)\.(.*)\.(.*)/$1$2$3/;
1123 if (C4::Context->preference('Version') < $kohaversion) {
1124 # database in need of version update; assume that
1125 # no API should be called while databsae is in
1127 return ("maintenance", undef, undef);
1130 # FIXME -- most of what follows is a copy-and-paste
1131 # of code from checkauth. There is an obvious need
1132 # for refactoring to separate the various parts of
1133 # the authentication code, but as of 2007-11-19 this
1134 # is deferred so as to not introduce bugs into the
1135 # regular authentication code for Koha 3.0.
1137 # see if we have a valid session cookie already
1138 # however, if a userid parameter is present (i.e., from
1139 # a form submission, assume that any current cookie
1141 my $sessionID = undef;
1142 unless ($query->param('userid')) {
1143 $sessionID = $query->cookie("CGISESSID");
1145 if ($sessionID && not ($cas && $query->param('PT')) ) {
1146 my $session = get_session($sessionID);
1147 C4::Context->_new_userenv($sessionID);
1149 C4::Context::set_userenv(
1150 $session->param('number'), $session->param('id'),
1151 $session->param('cardnumber'), $session->param('firstname'),
1152 $session->param('surname'), $session->param('branch'),
1153 $session->param('branchname'), $session->param('flags'),
1154 $session->param('emailaddress'), $session->param('branchprinter')
1157 my $ip = $session->param('ip');
1158 my $lasttime = $session->param('lasttime');
1159 my $userid = $session->param('id');
1160 if ( $lasttime < time() - $timeout ) {
1163 C4::Context->_unset_userenv($sessionID);
1166 return ("expired", undef, undef);
1167 } elsif ( $ip ne $ENV{'REMOTE_ADDR'} ) {
1168 # IP address changed
1170 C4::Context->_unset_userenv($sessionID);
1173 return ("expired", undef, undef);
1175 my $cookie = $query->cookie(
1176 -name => 'CGISESSID',
1177 -value => $session->id,
1180 $session->param('lasttime',time());
1181 my $flags = haspermission($userid, $flagsrequired);
1183 return ("ok", $cookie, $sessionID);
1186 C4::Context->_unset_userenv($sessionID);
1189 return ("failed", undef, undef);
1193 return ("expired", undef, undef);
1197 my $userid = $query->param('userid');
1198 my $password = $query->param('password');
1199 my ($return, $cardnumber);
1202 if ($cas && $query->param('PT')) {
1204 $debug and print STDERR "## check_api_auth - checking CAS\n";
1205 # In case of a CAS authentication, we use the ticket instead of the password
1206 my $PT = $query->param('PT');
1207 ($return,$cardnumber,$userid) = check_api_auth_cas($dbh, $PT, $query); # EXTERNAL AUTH
1209 # User / password auth
1210 unless ($userid and $password) {
1211 # caller did something wrong, fail the authenticateion
1212 return ("failed", undef, undef);
1214 ( $return, $cardnumber ) = checkpw( $dbh, $userid, $password, $query );
1217 if ($return and haspermission( $userid, $flagsrequired)) {
1218 my $session = get_session("");
1219 return ("failed", undef, undef) unless $session;
1221 my $sessionID = $session->id;
1222 C4::Context->_new_userenv($sessionID);
1223 my $cookie = $query->cookie(
1224 -name => 'CGISESSID',
1225 -value => $sessionID,
1228 if ( $return == 1 ) {
1230 $borrowernumber, $firstname, $surname,
1231 $userflags, $branchcode, $branchname,
1232 $branchprinter, $emailaddress
1236 "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=?"
1238 $sth->execute($userid);
1240 $borrowernumber, $firstname, $surname,
1241 $userflags, $branchcode, $branchname,
1242 $branchprinter, $emailaddress
1243 ) = $sth->fetchrow if ( $sth->rows );
1245 unless ($sth->rows ) {
1246 my $sth = $dbh->prepare(
1247 "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=?"
1249 $sth->execute($cardnumber);
1251 $borrowernumber, $firstname, $surname,
1252 $userflags, $branchcode, $branchname,
1253 $branchprinter, $emailaddress
1254 ) = $sth->fetchrow if ( $sth->rows );
1256 unless ( $sth->rows ) {
1257 $sth->execute($userid);
1259 $borrowernumber, $firstname, $surname, $userflags,
1260 $branchcode, $branchname, $branchprinter, $emailaddress
1261 ) = $sth->fetchrow if ( $sth->rows );
1265 my $ip = $ENV{'REMOTE_ADDR'};
1266 # if they specify at login, use that
1267 if ($query->param('branch')) {
1268 $branchcode = $query->param('branch');
1269 $branchname = GetBranchName($branchcode);
1271 my $branches = GetBranches();
1273 foreach my $br ( keys %$branches ) {
1274 # now we work with the treatment of ip
1275 my $domain = $branches->{$br}->{'branchip'};
1276 if ( $domain && $ip =~ /^$domain/ ) {
1277 $branchcode = $branches->{$br}->{'branchcode'};
1279 # new op dev : add the branchprinter and branchname in the cookie
1280 $branchprinter = $branches->{$br}->{'branchprinter'};
1281 $branchname = $branches->{$br}->{'branchname'};
1284 $session->param('number',$borrowernumber);
1285 $session->param('id',$userid);
1286 $session->param('cardnumber',$cardnumber);
1287 $session->param('firstname',$firstname);
1288 $session->param('surname',$surname);
1289 $session->param('branch',$branchcode);
1290 $session->param('branchname',$branchname);
1291 $session->param('flags',$userflags);
1292 $session->param('emailaddress',$emailaddress);
1293 $session->param('ip',$session->remote_addr());
1294 $session->param('lasttime',time());
1295 } elsif ( $return == 2 ) {
1296 #We suppose the user is the superlibrarian
1297 $session->param('number',0);
1298 $session->param('id',C4::Context->config('user'));
1299 $session->param('cardnumber',C4::Context->config('user'));
1300 $session->param('firstname',C4::Context->config('user'));
1301 $session->param('surname',C4::Context->config('user'));
1302 $session->param('branch','NO_LIBRARY_SET');
1303 $session->param('branchname','NO_LIBRARY_SET');
1304 $session->param('flags',1);
1305 $session->param('emailaddress', C4::Context->preference('KohaAdminEmailAddress'));
1306 $session->param('ip',$session->remote_addr());
1307 $session->param('lasttime',time());
1309 C4::Context::set_userenv(
1310 $session->param('number'), $session->param('id'),
1311 $session->param('cardnumber'), $session->param('firstname'),
1312 $session->param('surname'), $session->param('branch'),
1313 $session->param('branchname'), $session->param('flags'),
1314 $session->param('emailaddress'), $session->param('branchprinter')
1316 return ("ok", $cookie, $sessionID);
1318 return ("failed", undef, undef);
1323 =head2 check_cookie_auth
1325 ($status, $sessionId) = check_api_auth($cookie, $userflags);
1327 Given a CGISESSID cookie set during a previous login to Koha, determine
1328 if the user has the privileges specified by C<$userflags>.
1330 C<check_cookie_auth> is meant for authenticating special services
1331 such as tools/upload-file.pl that are invoked by other pages that
1332 have been authenticated in the usual way.
1334 Possible return values in C<$status> are:
1338 =item "ok" -- user authenticated; C<$sessionID> have valid values.
1340 =item "failed" -- credentials are not correct; C<$sessionid> are undef
1342 =item "maintenance" -- DB is in maintenance mode; no login possible at the moment
1344 =item "expired -- session cookie has expired; API user should resubmit userid and password
1350 sub check_cookie_auth {
1352 my $flagsrequired = shift;
1354 my $dbh = C4::Context->dbh;
1355 my $timeout = _timeout_syspref();
1357 unless (C4::Context->preference('Version')) {
1358 # database has not been installed yet
1359 return ("maintenance", undef);
1361 my $kohaversion=C4::Context::KOHAVERSION;
1362 $kohaversion =~ s/(.*\..*)\.(.*)\.(.*)/$1$2$3/;
1363 if (C4::Context->preference('Version') < $kohaversion) {
1364 # database in need of version update; assume that
1365 # no API should be called while databsae is in
1367 return ("maintenance", undef);
1370 # FIXME -- most of what follows is a copy-and-paste
1371 # of code from checkauth. There is an obvious need
1372 # for refactoring to separate the various parts of
1373 # the authentication code, but as of 2007-11-23 this
1374 # is deferred so as to not introduce bugs into the
1375 # regular authentication code for Koha 3.0.
1377 # see if we have a valid session cookie already
1378 # however, if a userid parameter is present (i.e., from
1379 # a form submission, assume that any current cookie
1381 unless (defined $cookie and $cookie) {
1382 return ("failed", undef);
1384 my $sessionID = $cookie;
1385 my $session = get_session($sessionID);
1386 C4::Context->_new_userenv($sessionID);
1388 C4::Context::set_userenv(
1389 $session->param('number'), $session->param('id'),
1390 $session->param('cardnumber'), $session->param('firstname'),
1391 $session->param('surname'), $session->param('branch'),
1392 $session->param('branchname'), $session->param('flags'),
1393 $session->param('emailaddress'), $session->param('branchprinter')
1396 my $ip = $session->param('ip');
1397 my $lasttime = $session->param('lasttime');
1398 my $userid = $session->param('id');
1399 if ( $lasttime < time() - $timeout ) {
1402 C4::Context->_unset_userenv($sessionID);
1405 return ("expired", undef);
1406 } elsif ( $ip ne $ENV{'REMOTE_ADDR'} ) {
1407 # IP address changed
1409 C4::Context->_unset_userenv($sessionID);
1412 return ("expired", undef);
1414 $session->param('lasttime',time());
1415 my $flags = haspermission($userid, $flagsrequired);
1417 return ("ok", $sessionID);
1420 C4::Context->_unset_userenv($sessionID);
1423 return ("failed", undef);
1427 return ("expired", undef);
1434 my $session = get_session($sessionID);
1436 Given a session ID, retrieve the CGI::Session object used to store
1437 the session's state. The session object can be used to store
1438 data that needs to be accessed by different scripts during a
1441 If the C<$sessionID> parameter is an empty string, a new session
1447 my $sessionID = shift;
1448 my $storage_method = C4::Context->preference('SessionStorage');
1449 my $dbh = C4::Context->dbh;
1451 if ($storage_method eq 'mysql'){
1452 $session = new CGI::Session("driver:MySQL;serializer:yaml;id:md5", $sessionID, {Handle=>$dbh});
1454 elsif ($storage_method eq 'Pg') {
1455 $session = new CGI::Session("driver:PostgreSQL;serializer:yaml;id:md5", $sessionID, {Handle=>$dbh});
1457 elsif ($storage_method eq 'memcached' && C4::Context->ismemcached){
1458 $session = new CGI::Session("driver:memcached;serializer:yaml;id:md5", $sessionID, { Memcached => C4::Context->memcached } );
1461 # catch all defaults to tmp should work on all systems
1462 $session = new CGI::Session("driver:File;serializer:yaml;id:md5", $sessionID, {Directory=>'/tmp'});
1469 my ( $dbh, $userid, $password, $query ) = @_;
1471 $debug and print STDERR "## checkpw - checking LDAP\n";
1472 my ($retval,$retcard,$retuserid) = checkpw_ldap(@_); # EXTERNAL AUTH
1473 ($retval) and return ($retval,$retcard,$retuserid);
1476 if ($cas && $query && $query->param('ticket')) {
1477 $debug and print STDERR "## checkpw - checking CAS\n";
1478 # In case of a CAS authentication, we use the ticket instead of the password
1479 my $ticket = $query->param('ticket');
1480 my ($retval,$retcard,$retuserid) = checkpw_cas($dbh, $ticket, $query); # EXTERNAL AUTH
1481 ($retval) and return ($retval,$retcard,$retuserid);
1488 "select password,cardnumber,borrowernumber,userid,firstname,surname,branchcode,flags from borrowers where userid=?"
1490 $sth->execute($userid);
1492 my ( $md5password, $cardnumber, $borrowernumber, $userid, $firstname,
1493 $surname, $branchcode, $flags )
1495 if ( md5_base64($password) eq $md5password and $md5password ne "!") {
1497 C4::Context->set_userenv( "$borrowernumber", $userid, $cardnumber,
1498 $firstname, $surname, $branchcode, $flags );
1499 return 1, $cardnumber, $userid;
1504 "select password,cardnumber,borrowernumber,userid, firstname,surname,branchcode,flags from borrowers where cardnumber=?"
1506 $sth->execute($userid);
1508 my ( $md5password, $cardnumber, $borrowernumber, $userid, $firstname,
1509 $surname, $branchcode, $flags )
1511 if ( md5_base64($password) eq $md5password ) {
1513 C4::Context->set_userenv( $borrowernumber, $userid, $cardnumber,
1514 $firstname, $surname, $branchcode, $flags );
1515 return 1, $cardnumber, $userid;
1518 if ( $userid && $userid eq C4::Context->config('user')
1519 && "$password" eq C4::Context->config('pass') )
1522 # Koha superuser account
1523 # C4::Context->set_userenv(0,0,C4::Context->config('user'),C4::Context->config('user'),C4::Context->config('user'),"",1);
1526 if ( $userid && $userid eq 'demo'
1527 && "$password" eq 'demo'
1528 && C4::Context->config('demo') )
1531 # DEMO => the demo user is allowed to do everything (if demo set to 1 in koha.conf
1532 # some features won't be effective : modify systempref, modify MARC structure,
1540 my $authflags = getuserflags($flags, $userid, [$dbh]);
1542 Translates integer flags into permissions strings hash.
1544 C<$flags> is the integer userflags value ( borrowers.userflags )
1545 C<$userid> is the members.userid, used for building subpermissions
1546 C<$authflags> is a hashref of permissions
1553 my $dbh = @_ ? shift : C4::Context->dbh;
1556 # I don't want to do this, but if someone logs in as the database
1557 # user, it would be preferable not to spam them to death with
1558 # numeric warnings. So, we make $flags numeric.
1559 no warnings 'numeric';
1562 my $sth = $dbh->prepare("SELECT bit, flag, defaulton FROM userflags");
1565 while ( my ( $bit, $flag, $defaulton ) = $sth->fetchrow ) {
1566 if ( ( $flags & ( 2**$bit ) ) || $defaulton ) {
1567 $userflags->{$flag} = 1;
1570 $userflags->{$flag} = 0;
1574 # get subpermissions and merge with top-level permissions
1575 my $user_subperms = get_user_subpermissions($userid);
1576 foreach my $module (keys %$user_subperms) {
1577 next if $userflags->{$module} == 1; # user already has permission for everything in this module
1578 $userflags->{$module} = $user_subperms->{$module};
1584 =head2 get_user_subpermissions
1586 $user_perm_hashref = get_user_subpermissions($userid);
1588 Given the userid (note, not the borrowernumber) of a staff user,
1589 return a hashref of hashrefs of the specific subpermissions
1590 accorded to the user. An example return is
1594 export_catalog => 1,
1595 import_patrons => 1,
1599 The top-level hash-key is a module or function code from
1600 userflags.flag, while the second-level key is a code
1603 The results of this function do not give a complete picture
1604 of the functions that a staff user can access; it is also
1605 necessary to check borrowers.flags.
1609 sub get_user_subpermissions {
1612 my $dbh = C4::Context->dbh;
1613 my $sth = $dbh->prepare("SELECT flag, user_permissions.code
1614 FROM user_permissions
1615 JOIN permissions USING (module_bit, code)
1616 JOIN userflags ON (module_bit = bit)
1617 JOIN borrowers USING (borrowernumber)
1619 $sth->execute($userid);
1621 my $user_perms = {};
1622 while (my $perm = $sth->fetchrow_hashref) {
1623 $user_perms->{$perm->{'flag'}}->{$perm->{'code'}} = 1;
1628 =head2 get_all_subpermissions
1630 my $perm_hashref = get_all_subpermissions();
1632 Returns a hashref of hashrefs defining all specific
1633 permissions currently defined. The return value
1634 has the same structure as that of C<get_user_subpermissions>,
1635 except that the innermost hash value is the description
1636 of the subpermission.
1640 sub get_all_subpermissions {
1641 my $dbh = C4::Context->dbh;
1642 my $sth = $dbh->prepare("SELECT flag, code, description
1644 JOIN userflags ON (module_bit = bit)");
1648 while (my $perm = $sth->fetchrow_hashref) {
1649 $all_perms->{$perm->{'flag'}}->{$perm->{'code'}} = $perm->{'description'};
1654 =head2 haspermission
1656 $flags = ($userid, $flagsrequired);
1658 C<$userid> the userid of the member
1659 C<$flags> is a hashref of required flags like C<$borrower-<{authflags}>
1661 Returns member's flags or 0 if a permission is not met.
1666 my ($userid, $flagsrequired) = @_;
1667 my $sth = C4::Context->dbh->prepare("SELECT flags FROM borrowers WHERE userid=?");
1668 $sth->execute($userid);
1669 my $flags = getuserflags($sth->fetchrow(), $userid);
1670 if ( $userid eq C4::Context->config('user') ) {
1671 # Super User Account from /etc/koha.conf
1672 $flags->{'superlibrarian'} = 1;
1674 elsif ( $userid eq 'demo' && C4::Context->config('demo') ) {
1675 # Demo user that can do "anything" (demo=1 in /etc/koha.conf)
1676 $flags->{'superlibrarian'} = 1;
1679 return $flags if $flags->{superlibrarian};
1681 foreach my $module ( keys %$flagsrequired ) {
1682 my $subperm = $flagsrequired->{$module};
1683 if ($subperm eq '*') {
1684 return 0 unless ( $flags->{$module} == 1 or ref($flags->{$module}) );
1686 return 0 unless ( $flags->{$module} == 1 or
1687 ( ref($flags->{$module}) and
1688 exists $flags->{$module}->{$subperm} and
1689 $flags->{$module}->{$subperm} == 1
1695 #FIXME - This fcn should return the failed permission so a suitable error msg can be delivered.
1699 sub getborrowernumber {
1701 my $userenv = C4::Context->userenv;
1702 if ( defined( $userenv ) && ref( $userenv ) eq 'HASH' && $userenv->{number} ) {
1703 return $userenv->{number};
1705 my $dbh = C4::Context->dbh;
1706 for my $field ( 'userid', 'cardnumber' ) {
1708 $dbh->prepare("select borrowernumber from borrowers where $field=?");
1709 $sth->execute($userid);
1711 my ($bnumber) = $sth->fetchrow;
1718 sub ParseSearchHistoryCookie {
1720 my $search_cookie = $input->cookie('KohaOpacRecentSearches');
1721 return () unless $search_cookie;
1722 my $obj = eval { decode_json(uri_unescape($search_cookie)) };
1723 return () unless defined $obj;
1724 return () unless ref $obj eq 'ARRAY';
1728 END { } # module clean-up code here (global destructor)