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
8 # under the terms of the GNU General Public License as published by
9 # the Free Software Foundation; either version 3 of the License, or
10 # (at your option) any later version.
12 # Koha is distributed in the hope that it will be useful, but
13 # WITHOUT ANY WARRANTY; without even the implied warranty of
14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 # GNU General Public License for more details.
17 # You should have received a copy of the GNU General Public License
18 # along with Koha; if not, see <http://www.gnu.org/licenses>.
24 use Digest::MD5 qw(md5_base64);
25 use JSON qw/encode_json/;
31 use C4::Templates; # to get the template
33 use C4::Search::History;
36 use Koha::AuthUtils qw(get_script_name hash_password);
38 use Koha::DateUtils qw(dt_from_string);
39 use Koha::Library::Groups;
41 use Koha::Cash::Registers;
44 use Koha::Patron::Consents;
45 use POSIX qw/strftime/;
46 use List::MoreUtils qw/ any /;
47 use Encode qw( encode is_utf8);
48 use C4::Auth_with_shibboleth;
50 use C4::Log qw/logaction/;
53 use vars qw(@ISA @EXPORT @EXPORT_OK %EXPORT_TAGS $debug $ldap $cas $caslogout);
56 sub psgi_env { any { /^psgi\./ } keys %ENV }
59 if (psgi_env) { die 'psgi:exit' }
63 C4::Context->set_remote_address;
67 @EXPORT = qw(&checkauth &get_template_and_user &haspermission &get_user_subpermissions);
68 @EXPORT_OK = qw(&check_api_auth &get_session &check_cookie_auth &checkpw &checkpw_internal &checkpw_hash
69 &get_all_subpermissions &get_user_subpermissions track_login_daily &in_iprange
71 %EXPORT_TAGS = ( EditPermissions => [qw(get_all_subpermissions get_user_subpermissions)] );
72 $ldap = C4::Context->config('useldapserver') || 0;
73 $cas = C4::Context->preference('casAuthentication');
74 $caslogout = C4::Context->preference('casLogout');
75 require C4::Auth_with_cas; # no import
78 require C4::Auth_with_ldap;
79 import C4::Auth_with_ldap qw(checkpw_ldap);
82 import C4::Auth_with_cas qw(check_api_auth_cas checkpw_cas login_cas logout_cas login_cas_url logout_if_required);
89 C4::Auth - Authenticates Koha users
99 my ($template, $borrowernumber, $cookie)
100 = get_template_and_user(
102 template_name => "opac-main.tt",
105 authnotrequired => 0,
106 flagsrequired => { catalogue => '*', tools => 'import_patrons' },
110 output_html_with_http_headers $query, $cookie, $template->output;
114 The main function of this module is to provide
115 authentification. However the get_template_and_user function has
116 been provided so that a users login information is passed along
117 automatically. This gets loaded into the template.
121 =head2 get_template_and_user
123 my ($template, $borrowernumber, $cookie)
124 = get_template_and_user(
126 template_name => "opac-main.tt",
129 authnotrequired => 0,
130 flagsrequired => { catalogue => '*', tools => 'import_patrons' },
134 This call passes the C<query>, C<flagsrequired> and C<authnotrequired>
135 to C<&checkauth> (in this module) to perform authentification.
136 See C<&checkauth> for an explanation of these parameters.
138 The C<template_name> is then used to find the correct template for
139 the page. The authenticated users details are loaded onto the
140 template in the logged_in_user variable (which is a Koha::Patron object). Also the
141 C<sessionID> is passed to the template. This can be used in templates
142 if cookies are disabled. It needs to be put as and input to every
145 More information on the C<gettemplate> sub can be found in the
150 sub get_template_and_user {
153 my ( $user, $cookie, $sessionID, $flags );
155 # Get shibboleth login attribute
156 my $shib = C4::Context->config('useshibboleth') && shib_ok();
157 my $shib_login = $shib ? get_login_shib() : undef;
159 C4::Context->interface( $in->{type} );
161 $in->{'authnotrequired'} ||= 0;
163 # the following call includes a bad template check; might croak
164 my $template = C4::Templates::gettemplate(
165 $in->{'template_name'},
170 if ( $in->{'template_name'} !~ m/maintenance/ ) {
171 ( $user, $cookie, $sessionID, $flags ) = checkauth(
173 $in->{'authnotrequired'},
174 $in->{'flagsrequired'},
177 $in->{template_name},
181 # If we enforce GDPR and the user did not consent, redirect
182 # Exceptions for consent page itself and SCI/SCO system
183 if( $in->{type} eq 'opac' && $user &&
184 $in->{'template_name'} !~ /^(opac-patron-consent|sc[io]\/)/ &&
185 C4::Context->preference('GDPR_Policy') eq 'Enforced' )
187 my $consent = Koha::Patron::Consents->search({
188 borrowernumber => getborrowernumber($user),
189 type => 'GDPR_PROCESSING',
190 given_on => { '!=', undef },
193 print $in->{query}->redirect(-uri => '/cgi-bin/koha/opac-patron-consent.pl', -cookie => $cookie);
198 if ( $in->{type} eq 'opac' && $user ) {
202 # If the user logged in is the SCO user and they try to go out of the SCO module,
203 # log the user out removing the CGISESSID cookie
204 $in->{template_name} !~ m|sco/| && $in->{template_name} !~ m|errors/errorpage.tt|
205 && C4::Context->preference('AutoSelfCheckID')
206 && $user eq C4::Context->preference('AutoSelfCheckID')
212 # If the user logged in is the SCI user and they try to go out of the SCI module,
213 # kick them out unless it is SCO with a valid permission
214 # or they are a superlibrarian
215 $in->{template_name} !~ m|sci/|
216 && haspermission( $user, { self_check => 'self_checkin_module' } )
218 $in->{template_name} =~ m|sco/| && haspermission(
219 $user, { self_check => 'self_checkout_module' }
222 && $flags && $flags->{superlibrarian} != 1
229 $template = C4::Templates::gettemplate( 'opac-auth.tt', 'opac',
231 $cookie = $in->{query}->cookie(
232 -name => 'CGISESSID',
236 -secure => ( C4::Context->https_enabled() ? 1 : 0 ),
241 script_name => get_script_name(),
244 print $in->{query}->header(
249 'X-Frame-Options' => 'SAMEORIGIN'
260 # It's possible for $user to be the borrowernumber if they don't have a
261 # userid defined (and are logging in through some other method, such
262 # as SSL certs against an email address)
264 $borrowernumber = getborrowernumber($user) if defined($user);
265 if ( !defined($borrowernumber) && defined($user) ) {
266 $patron = Koha::Patrons->find( $user );
268 $borrowernumber = $user;
270 # A bit of a hack, but I don't know there's a nicer way
272 $user = $patron->firstname . ' ' . $patron->surname;
275 $patron = Koha::Patrons->find( $borrowernumber );
276 # FIXME What to do if $patron does not exist?
280 $template->param( loggedinusername => $user ); # OBSOLETE - Do not reuse this in template, use logged_in_user.userid instead
281 $template->param( loggedinusernumber => $borrowernumber ); # FIXME Should be replaced with logged_in_user.borrowernumber
282 $template->param( logged_in_user => $patron );
283 $template->param( sessionID => $sessionID );
285 if ( $in->{'type'} eq 'opac' ) {
286 require Koha::Virtualshelves;
287 my $some_private_shelves = Koha::Virtualshelves->get_some_shelves(
289 borrowernumber => $borrowernumber,
293 my $some_public_shelves = Koha::Virtualshelves->get_some_shelves(
299 some_private_shelves => $some_private_shelves,
300 some_public_shelves => $some_public_shelves,
304 my $all_perms = get_all_subpermissions();
306 my @flagroots = qw(circulate catalogue parameters borrowers permissions reserveforothers borrow
307 editcatalogue updatecharges tools editauthorities serials reports acquisition clubs problem_reports);
309 # We are going to use the $flags returned by checkauth
310 # to create the template's parameters that will indicate
311 # which menus the user can access.
312 if ( $flags && $flags->{superlibrarian} == 1 ) {
313 $template->param( CAN_user_circulate => 1 );
314 $template->param( CAN_user_catalogue => 1 );
315 $template->param( CAN_user_parameters => 1 );
316 $template->param( CAN_user_borrowers => 1 );
317 $template->param( CAN_user_permissions => 1 );
318 $template->param( CAN_user_reserveforothers => 1 );
319 $template->param( CAN_user_editcatalogue => 1 );
320 $template->param( CAN_user_updatecharges => 1 );
321 $template->param( CAN_user_acquisition => 1 );
322 $template->param( CAN_user_tools => 1 );
323 $template->param( CAN_user_editauthorities => 1 );
324 $template->param( CAN_user_serials => 1 );
325 $template->param( CAN_user_reports => 1 );
326 $template->param( CAN_user_staffaccess => 1 );
327 $template->param( CAN_user_plugins => 1 );
328 $template->param( CAN_user_coursereserves => 1 );
329 $template->param( CAN_user_clubs => 1 );
330 $template->param( CAN_user_ill => 1 );
331 $template->param( CAN_user_stockrotation => 1 );
332 $template->param( CAN_user_problem_reports => 1 );
334 foreach my $module ( keys %$all_perms ) {
335 foreach my $subperm ( keys %{ $all_perms->{$module} } ) {
336 $template->param( "CAN_user_${module}_${subperm}" => 1 );
342 foreach my $module ( keys %$all_perms ) {
343 if ( defined($flags->{$module}) && $flags->{$module} == 1 ) {
344 foreach my $subperm ( keys %{ $all_perms->{$module} } ) {
345 $template->param( "CAN_user_${module}_${subperm}" => 1 );
347 } elsif ( ref( $flags->{$module} ) ) {
348 foreach my $subperm ( keys %{ $flags->{$module} } ) {
349 $template->param( "CAN_user_${module}_${subperm}" => 1 );
356 foreach my $module ( keys %$flags ) {
357 if ( $flags->{$module} == 1 or ref( $flags->{$module} ) ) {
358 $template->param( "CAN_user_$module" => 1 );
363 # Logged-in opac search history
364 # If the requested template is an opac one and opac search history is enabled
365 if ( $in->{type} eq 'opac' && C4::Context->preference('EnableOpacSearchHistory') ) {
366 my $dbh = C4::Context->dbh;
367 my $query = "SELECT COUNT(*) FROM search_history WHERE userid=?";
368 my $sth = $dbh->prepare($query);
369 $sth->execute($borrowernumber);
371 # If at least one search has already been performed
372 if ( $sth->fetchrow_array > 0 ) {
374 # We show the link in opac
375 $template->param( EnableOpacSearchHistory => 1 );
377 if (C4::Context->preference('LoadSearchHistoryToTheFirstLoggedUser'))
379 # And if there are searches performed when the user was not logged in,
380 # we add them to the logged-in search history
381 my @recentSearches = C4::Search::History::get_from_session( { cgi => $in->{'query'} } );
382 if (@recentSearches) {
383 my $dbh = C4::Context->dbh;
385 INSERT INTO search_history(userid, sessionid, query_desc, query_cgi, type, total, time )
386 VALUES (?, ?, ?, ?, ?, ?, ?)
388 my $sth = $dbh->prepare($query);
389 $sth->execute( $borrowernumber,
390 $in->{query}->cookie("CGISESSID"),
393 $_->{type} || 'biblio',
396 ) foreach @recentSearches;
398 # clear out the search history from the session now that
399 # we've saved it to the database
402 C4::Search::History::set_to_session( { cgi => $in->{'query'}, search_history => [] } );
404 } elsif ( $in->{type} eq 'intranet' and C4::Context->preference('EnableSearchHistory') ) {
405 $template->param( EnableSearchHistory => 1 );
408 else { # if this is an anonymous session, setup to display public lists...
410 # If shibboleth is enabled, and we're in an anonymous session, we should allow
411 # the user to attempt login via shibboleth.
413 $template->param( shibbolethAuthentication => $shib,
414 shibbolethLoginUrl => login_shib_url( $in->{'query'} ),
417 # If shibboleth is enabled and we have a shibboleth login attribute,
418 # but we are in an anonymous session, then we clearly have an invalid
419 # shibboleth koha account.
421 $template->param( invalidShibLogin => '1' );
425 $template->param( sessionID => $sessionID );
427 if ( $in->{'type'} eq 'opac' ){
428 require Koha::Virtualshelves;
429 my $some_public_shelves = Koha::Virtualshelves->get_some_shelves(
435 some_public_shelves => $some_public_shelves,
440 # Anonymous opac search history
441 # If opac search history is enabled and at least one search has already been performed
442 if ( C4::Context->preference('EnableOpacSearchHistory') ) {
443 my @recentSearches = C4::Search::History::get_from_session( { cgi => $in->{'query'} } );
444 if (@recentSearches) {
445 $template->param( EnableOpacSearchHistory => 1 );
449 if ( C4::Context->preference('dateformat') ) {
450 $template->param( dateformat => C4::Context->preference('dateformat') );
453 $template->param(auth_forwarded_hash => scalar $in->{'query'}->param('auth_forwarded_hash'));
455 # these template parameters are set the same regardless of $in->{'type'}
457 my $minPasswordLength = C4::Context->preference('minPasswordLength');
458 $minPasswordLength = 3 if not $minPasswordLength or $minPasswordLength < 3;
460 "BiblioDefaultView" . C4::Context->preference("BiblioDefaultView") => 1,
461 EnhancedMessagingPreferences => C4::Context->preference('EnhancedMessagingPreferences'),
462 GoogleJackets => C4::Context->preference("GoogleJackets"),
463 OpenLibraryCovers => C4::Context->preference("OpenLibraryCovers"),
464 KohaAdminEmailAddress => "" . C4::Context->preference("KohaAdminEmailAddress"),
465 LoginFirstname => ( C4::Context->userenv ? C4::Context->userenv->{"firstname"} : "Bel" ),
466 LoginSurname => C4::Context->userenv ? C4::Context->userenv->{"surname"} : "Inconnu",
467 emailaddress => C4::Context->userenv ? C4::Context->userenv->{"emailaddress"} : undef,
468 TagsEnabled => C4::Context->preference("TagsEnabled"),
469 hide_marc => C4::Context->preference("hide_marc"),
470 item_level_itypes => C4::Context->preference('item-level_itypes'),
471 patronimages => C4::Context->preference("patronimages"),
472 singleBranchMode => ( Koha::Libraries->search->count == 1 ),
473 XSLTDetailsDisplay => C4::Context->preference("XSLTDetailsDisplay"),
474 XSLTResultsDisplay => C4::Context->preference("XSLTResultsDisplay"),
475 noItemTypeImages => C4::Context->preference("noItemTypeImages"),
476 marcflavour => C4::Context->preference("marcflavour"),
477 OPACBaseURL => C4::Context->preference('OPACBaseURL'),
478 minPasswordLength => $minPasswordLength,
480 if ( $in->{'type'} eq "intranet" ) {
482 AmazonCoverImages => C4::Context->preference("AmazonCoverImages"),
483 AutoLocation => C4::Context->preference("AutoLocation"),
484 "BiblioDefaultView" . C4::Context->preference("IntranetBiblioDefaultView") => 1,
485 PatronAutoComplete => C4::Context->preference("PatronAutoComplete"),
486 FRBRizeEditions => C4::Context->preference("FRBRizeEditions"),
487 IndependentBranches => C4::Context->preference("IndependentBranches"),
488 IntranetNav => C4::Context->preference("IntranetNav"),
489 IntranetmainUserblock => C4::Context->preference("IntranetmainUserblock"),
490 LibraryName => C4::Context->preference("LibraryName"),
491 advancedMARCEditor => C4::Context->preference("advancedMARCEditor"),
492 canreservefromotherbranches => C4::Context->preference('canreservefromotherbranches'),
493 intranetcolorstylesheet => C4::Context->preference("intranetcolorstylesheet"),
494 IntranetFavicon => C4::Context->preference("IntranetFavicon"),
495 intranetreadinghistory => C4::Context->preference("intranetreadinghistory"),
496 intranetstylesheet => C4::Context->preference("intranetstylesheet"),
497 IntranetUserCSS => C4::Context->preference("IntranetUserCSS"),
498 IntranetUserJS => C4::Context->preference("IntranetUserJS"),
499 intranetbookbag => C4::Context->preference("intranetbookbag"),
500 suggestion => C4::Context->preference("suggestion"),
501 virtualshelves => C4::Context->preference("virtualshelves"),
502 StaffSerialIssueDisplayCount => C4::Context->preference("StaffSerialIssueDisplayCount"),
503 EasyAnalyticalRecords => C4::Context->preference('EasyAnalyticalRecords'),
504 LocalCoverImages => C4::Context->preference('LocalCoverImages'),
505 OPACLocalCoverImages => C4::Context->preference('OPACLocalCoverImages'),
506 AllowMultipleCovers => C4::Context->preference('AllowMultipleCovers'),
507 EnableBorrowerFiles => C4::Context->preference('EnableBorrowerFiles'),
508 UseCourseReserves => C4::Context->preference("UseCourseReserves"),
509 useDischarge => C4::Context->preference('useDischarge'),
510 pending_checkout_notes => scalar Koha::Checkouts->search({ noteseen => 0 }),
514 warn "template type should be OPAC, here it is=[" . $in->{'type'} . "]" unless ( $in->{'type'} eq 'opac' );
516 #TODO : replace LibraryName syspref with 'system name', and remove this html processing
517 my $LibraryNameTitle = C4::Context->preference("LibraryName");
518 $LibraryNameTitle =~ s/<(?:\/?)(?:br|p)\s*(?:\/?)>/ /sgi;
519 $LibraryNameTitle =~ s/<(?:[^<>'"]|'(?:[^']*)'|"(?:[^"]*)")*>//sg;
521 # clean up the busc param in the session
522 # if the page is not opac-detail and not the "add to list" page
523 # and not the "edit comments" page
524 if ( C4::Context->preference("OpacBrowseResults")
525 && $in->{'template_name'} =~ /opac-(.+)\.(?:tt|tmpl)$/ ) {
527 unless ( $pagename =~ /^(?:MARC|ISBD)?detail$/
528 or $pagename =~ /^addbybiblionumber$/
529 or $pagename =~ /^review$/ ) {
530 my $sessionSearch = get_session( $sessionID || $in->{'query'}->cookie("CGISESSID") );
531 $sessionSearch->clear( ["busc"] ) if ( $sessionSearch->param("busc") );
535 # variables passed from CGI: opac_css_override and opac_search_limits.
536 my $opac_search_limit = $ENV{'OPAC_SEARCH_LIMIT'};
537 my $opac_limit_override = $ENV{'OPAC_LIMIT_OVERRIDE'};
540 ( $opac_limit_override && $opac_search_limit && $opac_search_limit =~ /branch:([\w-]+)/ ) ||
541 ( $in->{'query'}->param('limit') && $in->{'query'}->param('limit') =~ /branch:([\w-]+)/ ) ||
542 ( $in->{'query'}->param('multibranchlimit') && $in->{'query'}->param('multibranchlimit') =~ /multibranchlimit-(\w+)/ )
544 $opac_name = $1; # opac_search_limit is a branch, so we use it.
545 } elsif ( $in->{'query'}->param('multibranchlimit') ) {
546 $opac_name = $in->{'query'}->param('multibranchlimit');
547 } elsif ( C4::Context->preference("SearchMyLibraryFirst") && C4::Context->userenv && C4::Context->userenv->{'branch'} ) {
548 $opac_name = C4::Context->userenv->{'branch'};
551 my @search_groups = Koha::Library::Groups->get_search_groups({ interface => 'opac' });
553 AnonSuggestions => "" . C4::Context->preference("AnonSuggestions"),
554 LibrarySearchGroups => \@search_groups,
555 opac_name => $opac_name,
556 LibraryName => "" . C4::Context->preference("LibraryName"),
557 LibraryNameTitle => "" . $LibraryNameTitle,
558 OPACAmazonCoverImages => C4::Context->preference("OPACAmazonCoverImages"),
559 OPACFRBRizeEditions => C4::Context->preference("OPACFRBRizeEditions"),
560 OpacHighlightedWords => C4::Context->preference("OpacHighlightedWords"),
561 OPACShelfBrowser => "" . C4::Context->preference("OPACShelfBrowser"),
562 OPACURLOpenInNewWindow => "" . C4::Context->preference("OPACURLOpenInNewWindow"),
563 OPACUserCSS => "" . C4::Context->preference("OPACUserCSS"),
564 OpacAuthorities => C4::Context->preference("OpacAuthorities"),
565 opac_css_override => $ENV{'OPAC_CSS_OVERRIDE'},
566 opac_search_limit => $opac_search_limit,
567 opac_limit_override => $opac_limit_override,
568 OpacBrowser => C4::Context->preference("OpacBrowser"),
569 OpacCloud => C4::Context->preference("OpacCloud"),
570 OpacKohaUrl => C4::Context->preference("OpacKohaUrl"),
571 OpacNav => "" . C4::Context->preference("OpacNav"),
572 OpacNavBottom => "" . C4::Context->preference("OpacNavBottom"),
573 OpacPasswordChange => C4::Context->preference("OpacPasswordChange"),
574 OPACPatronDetails => C4::Context->preference("OPACPatronDetails"),
575 OPACPrivacy => C4::Context->preference("OPACPrivacy"),
576 OPACFinesTab => C4::Context->preference("OPACFinesTab"),
577 OpacTopissue => C4::Context->preference("OpacTopissue"),
578 RequestOnOpac => C4::Context->preference("RequestOnOpac"),
579 'Version' => C4::Context->preference('Version'),
580 hidelostitems => C4::Context->preference("hidelostitems"),
581 mylibraryfirst => ( C4::Context->preference("SearchMyLibraryFirst") && C4::Context->userenv ) ? C4::Context->userenv->{'branch'} : '',
582 opacbookbag => "" . C4::Context->preference("opacbookbag"),
583 OpacFavicon => C4::Context->preference("OpacFavicon"),
584 opaclanguagesdisplay => "" . C4::Context->preference("opaclanguagesdisplay"),
585 opacreadinghistory => C4::Context->preference("opacreadinghistory"),
586 OPACUserJS => C4::Context->preference("OPACUserJS"),
587 opacuserlogin => "" . C4::Context->preference("opacuserlogin"),
588 OpenLibrarySearch => C4::Context->preference("OpenLibrarySearch"),
589 ShowReviewer => C4::Context->preference("ShowReviewer"),
590 ShowReviewerPhoto => C4::Context->preference("ShowReviewerPhoto"),
591 suggestion => "" . C4::Context->preference("suggestion"),
592 virtualshelves => "" . C4::Context->preference("virtualshelves"),
593 OPACSerialIssueDisplayCount => C4::Context->preference("OPACSerialIssueDisplayCount"),
594 OPACXSLTDetailsDisplay => C4::Context->preference("OPACXSLTDetailsDisplay"),
595 OPACXSLTResultsDisplay => C4::Context->preference("OPACXSLTResultsDisplay"),
596 SyndeticsClientCode => C4::Context->preference("SyndeticsClientCode"),
597 SyndeticsEnabled => C4::Context->preference("SyndeticsEnabled"),
598 SyndeticsCoverImages => C4::Context->preference("SyndeticsCoverImages"),
599 SyndeticsTOC => C4::Context->preference("SyndeticsTOC"),
600 SyndeticsSummary => C4::Context->preference("SyndeticsSummary"),
601 SyndeticsEditions => C4::Context->preference("SyndeticsEditions"),
602 SyndeticsExcerpt => C4::Context->preference("SyndeticsExcerpt"),
603 SyndeticsReviews => C4::Context->preference("SyndeticsReviews"),
604 SyndeticsAuthorNotes => C4::Context->preference("SyndeticsAuthorNotes"),
605 SyndeticsAwards => C4::Context->preference("SyndeticsAwards"),
606 SyndeticsSeries => C4::Context->preference("SyndeticsSeries"),
607 SyndeticsCoverImageSize => C4::Context->preference("SyndeticsCoverImageSize"),
608 OPACLocalCoverImages => C4::Context->preference("OPACLocalCoverImages"),
609 PatronSelfRegistration => C4::Context->preference("PatronSelfRegistration"),
610 PatronSelfRegistrationDefaultCategory => C4::Context->preference("PatronSelfRegistrationDefaultCategory"),
611 useDischarge => C4::Context->preference('useDischarge'),
614 $template->param( OpacPublic => '1' ) if ( $user || C4::Context->preference("OpacPublic") );
617 # Check if we were asked using parameters to force a specific language
618 if ( defined $in->{'query'}->param('language') ) {
620 # Extract the language, let C4::Languages::getlanguage choose
622 my $language = C4::Languages::getlanguage( $in->{'query'} );
623 my $languagecookie = C4::Templates::getlanguagecookie( $in->{'query'}, $language );
624 if ( ref $cookie eq 'ARRAY' ) {
625 push @{$cookie}, $languagecookie;
627 $cookie = [ $cookie, $languagecookie ];
631 return ( $template, $borrowernumber, $cookie, $flags );
636 ($userid, $cookie, $sessionID) = &checkauth($query, $noauth, $flagsrequired, $type);
638 Verifies that the user is authorized to run this script. If
639 the user is authorized, a (userid, cookie, session-id, flags)
640 quadruple is returned. If the user is not authorized but does
641 not have the required privilege (see $flagsrequired below), it
642 displays an error page and exits. Otherwise, it displays the
643 login page and exits.
645 Note that C<&checkauth> will return if and only if the user
646 is authorized, so it should be called early on, before any
647 unfinished operations (e.g., if you've opened a file, then
648 C<&checkauth> won't close it for you).
650 C<$query> is the CGI object for the script calling C<&checkauth>.
652 The C<$noauth> argument is optional. If it is set, then no
653 authorization is required for the script.
655 C<&checkauth> fetches user and session information from C<$query> and
656 ensures that the user is authorized to run scripts that require
659 The C<$flagsrequired> argument specifies the required privileges
660 the user must have if the username and password are correct.
661 It should be specified as a reference-to-hash; keys in the hash
662 should be the "flags" for the user, as specified in the Members
663 intranet module. Any key specified must correspond to a "flag"
664 in the userflags table. E.g., { circulate => 1 } would specify
665 that the user must have the "circulate" privilege in order to
666 proceed. To make sure that access control is correct, the
667 C<$flagsrequired> parameter must be specified correctly.
669 Koha also has a concept of sub-permissions, also known as
670 granular permissions. This makes the value of each key
671 in the C<flagsrequired> hash take on an additional
676 The user must have access to all subfunctions of the module
677 specified by the hash key.
681 The user must have access to at least one subfunction of the module
682 specified by the hash key.
684 specific permission, e.g., 'export_catalog'
686 The user must have access to the specific subfunction list, which
687 must correspond to a row in the permissions table.
689 The C<$type> argument specifies whether the template should be
690 retrieved from the opac or intranet directory tree. "opac" is
691 assumed if it is not specified; however, if C<$type> is specified,
692 "intranet" is assumed if it is not "opac".
694 If C<$query> does not have a valid session ID associated with it
695 (i.e., the user has not logged in) or if the session has expired,
696 C<&checkauth> presents the user with a login page (from the point of
697 view of the original script, C<&checkauth> does not return). Once the
698 user has authenticated, C<&checkauth> restarts the original script
699 (this time, C<&checkauth> returns).
701 The login page is provided using a HTML::Template, which is set in the
702 systempreferences table or at the top of this file. The variable C<$type>
703 selects which template to use, either the opac or the intranet
704 authentification template.
706 C<&checkauth> returns a user ID, a cookie, and a session ID. The
707 cookie should be sent back to the browser; it verifies that the user
717 # If version syspref is unavailable, it means Koha is being installed,
718 # and so we must redirect to OPAC maintenance page or to the WebInstaller
719 # also, if OpacMaintenance is ON, OPAC should redirect to maintenance
720 if ( C4::Context->preference('OpacMaintenance') && $type eq 'opac' ) {
721 warn "OPAC Install required, redirecting to maintenance";
722 print $query->redirect("/cgi-bin/koha/maintenance.pl");
725 unless ( $version = C4::Context->preference('Version') ) { # assignment, not comparison
726 if ( $type ne 'opac' ) {
727 warn "Install required, redirecting to Installer";
728 print $query->redirect("/cgi-bin/koha/installer/install.pl");
730 warn "OPAC Install required, redirecting to maintenance";
731 print $query->redirect("/cgi-bin/koha/maintenance.pl");
736 # check that database and koha version are the same
737 # there is no DB version, it's a fresh install,
738 # go to web installer
739 # there is a DB version, compare it to the code version
740 my $kohaversion = Koha::version();
742 # remove the 3 last . to have a Perl number
743 $kohaversion =~ s/(.*\..*)\.(.*)\.(.*)/$1$2$3/;
744 $debug and print STDERR "kohaversion : $kohaversion\n";
745 if ( $version < $kohaversion ) {
746 my $warning = "Database update needed, redirecting to %s. Database is $version and Koha is $kohaversion";
747 if ( $type ne 'opac' ) {
748 warn sprintf( $warning, 'Installer' );
749 print $query->redirect("/cgi-bin/koha/installer/install.pl?step=1&op=updatestructure");
751 warn sprintf( "OPAC: " . $warning, 'maintenance' );
752 print $query->redirect("/cgi-bin/koha/maintenance.pl");
760 open my $fh, '>>', "/tmp/sessionlog" or warn "ERROR: Cannot append to /tmp/sessionlog";
761 printf $fh join( "\n", @_ );
765 sub _timeout_syspref {
766 my $default_timeout = 600;
767 my $timeout = C4::Context->preference('timeout') || $default_timeout;
769 # value in days, convert in seconds
770 if ( $timeout =~ /^(\d+)[dD]$/ ) {
771 $timeout = $1 * 86400;
773 # value in hours, convert in seconds
774 elsif ( $timeout =~ /^(\d+)[hH]$/ ) {
775 $timeout = $1 * 3600;
777 elsif ( $timeout !~ m/^\d+$/ ) {
778 warn "The value of the system preference 'timeout' is not correct, defaulting to $default_timeout";
779 $timeout = $default_timeout;
787 $debug and warn "Checking Auth";
789 # Get shibboleth login attribute
790 my $shib = C4::Context->config('useshibboleth') && shib_ok();
791 my $shib_login = $shib ? get_login_shib() : undef;
793 # $authnotrequired will be set for scripts which will run without authentication
794 my $authnotrequired = shift;
795 my $flagsrequired = shift;
797 my $emailaddress = shift;
798 my $template_name = shift;
799 $type = 'opac' unless $type;
801 unless ( C4::Context->preference("OpacPublic") ) {
802 my @allowed_scripts_for_private_opac = qw(
804 opac-registration-email-sent.tt
805 opac-registration-confirmation.tt
806 opac-memberentry-update-submitted.tt
807 opac-password-recovery.tt
809 $authnotrequired = 0 unless grep { $_ eq $template_name }
810 @allowed_scripts_for_private_opac;
813 my $dbh = C4::Context->dbh;
814 my $timeout = _timeout_syspref();
816 _version_check( $type, $query );
821 my ( $userid, $cookie, $sessionID, $flags );
822 my $logout = $query->param('logout.x');
824 my $anon_search_history;
826 # This parameter is the name of the CAS server we want to authenticate against,
827 # when using authentication against multiple CAS servers, as configured in Auth_cas_servers.yaml
828 my $casparam = $query->param('cas');
829 my $q_userid = $query->param('userid') // '';
833 # Basic authentication is incompatible with the use of Shibboleth,
834 # as Shibboleth may return REMOTE_USER as a Shibboleth attribute,
835 # and it may not be the attribute we want to use to match the koha login.
837 # Also, do not consider an empty REMOTE_USER.
839 # Finally, after those tests, we can assume (although if it would be better with
840 # a syspref) that if we get a REMOTE_USER, that's from basic authentication,
841 # and we can affect it to $userid.
842 if ( !$shib and defined( $ENV{'REMOTE_USER'} ) and $ENV{'REMOTE_USER'} ne '' and $userid = $ENV{'REMOTE_USER'} ) {
844 # Using Basic Authentication, no cookies required
845 $cookie = $query->cookie(
846 -name => 'CGISESSID',
850 -secure => ( C4::Context->https_enabled() ? 1 : 0 ),
854 elsif ( $emailaddress) {
855 # the Google OpenID Connect passes an email address
857 elsif ( $sessionID = $query->cookie("CGISESSID") )
858 { # assignment, not comparison
859 $session = get_session($sessionID);
860 C4::Context->_new_userenv($sessionID);
861 my ( $ip, $lasttime, $sessiontype );
864 $s_userid = $session->param('id') // '';
865 C4::Context->set_userenv(
866 $session->param('number'), $s_userid,
867 $session->param('cardnumber'), $session->param('firstname'),
868 $session->param('surname'), $session->param('branch'),
869 $session->param('branchname'), $session->param('flags'),
870 $session->param('emailaddress'), $session->param('shibboleth'),
871 $session->param('desk_id'), $session->param('desk_name'),
872 $session->param('register_id'), $session->param('register_name')
874 C4::Context::set_shelves_userenv( 'bar', $session->param('barshelves') );
875 C4::Context::set_shelves_userenv( 'pub', $session->param('pubshelves') );
876 C4::Context::set_shelves_userenv( 'tot', $session->param('totshelves') );
877 $debug and printf STDERR "AUTH_SESSION: (%s)\t%s %s - %s\n", map { $session->param($_) } qw(cardnumber firstname surname branch);
878 $ip = $session->param('ip');
879 $lasttime = $session->param('lasttime');
881 $sessiontype = $session->param('sessiontype') || '';
883 if ( ( $query->param('koha_login_context') && ( $q_userid ne $s_userid ) )
884 || ( $cas && $query->param('ticket') && !C4::Context->userenv->{'id'} )
885 || ( $shib && $shib_login && !$logout && !C4::Context->userenv->{'id'} )
888 #if a user enters an id ne to the id in the current session, we need to log them in...
889 #first we need to clear the anonymous session...
890 $debug and warn "query id = $q_userid but session id = $s_userid";
891 $anon_search_history = $session->param('search_history');
894 C4::Context->_unset_userenv($sessionID);
900 # voluntary logout the user
901 # check wether the user was using their shibboleth session or a local one
902 my $shibSuccess = C4::Context->userenv->{'shibboleth'};
905 C4::Context->_unset_userenv($sessionID);
907 #_session_log(sprintf "%20s from %16s logged out at %30s (manually).\n", $userid,$ip,(strftime "%c",localtime));
911 if ($cas and $caslogout) {
912 logout_cas($query, $type);
915 # If we are in a shibboleth session (shibboleth is enabled, a shibboleth match attribute is set and matches koha matchpoint)
916 if ( $shib and $shib_login and $shibSuccess) {
920 elsif ( !$lasttime || ( $lasttime < time() - $timeout ) ) {
923 $info{'timed_out'} = 1;
928 C4::Context->_unset_userenv($sessionID);
930 #_session_log(sprintf "%20s from %16s logged out at %30s (inactivity).\n", $userid,$ip,(strftime "%c",localtime));
934 elsif ( C4::Context->preference('SessionRestrictionByIP') && $ip ne $ENV{'REMOTE_ADDR'} ) {
936 # Different ip than originally logged in from
937 $info{'oldip'} = $ip;
938 $info{'newip'} = $ENV{'REMOTE_ADDR'};
939 $info{'different_ip'} = 1;
942 C4::Context->_unset_userenv($sessionID);
944 #_session_log(sprintf "%20s from %16s logged out at %30s (ip changed to %16s).\n", $userid,$ip,(strftime "%c",localtime), $info{'newip'});
949 $cookie = $query->cookie(
950 -name => 'CGISESSID',
951 -value => $session->id,
953 -secure => ( C4::Context->https_enabled() ? 1 : 0 ),
955 $session->param( 'lasttime', time() );
956 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...
957 $flags = haspermission( $userid, $flagsrequired );
961 $info{'nopermission'} = 1;
966 unless ( $userid || $sessionID ) {
967 #we initiate a session prior to checking for a username to allow for anonymous sessions...
968 my $session = get_session("") or die "Auth ERROR: Cannot get_session()";
970 # Save anonymous search history in new session so it can be retrieved
971 # by get_template_and_user to store it in user's search history after
972 # a successful login.
973 if ($anon_search_history) {
974 $session->param( 'search_history', $anon_search_history );
977 $sessionID = $session->id;
978 C4::Context->_new_userenv($sessionID);
979 $cookie = $query->cookie(
980 -name => 'CGISESSID',
981 -value => $session->id,
983 -secure => ( C4::Context->https_enabled() ? 1 : 0 ),
985 my $pki_field = C4::Context->preference('AllowPKIAuth');
986 if ( !defined($pki_field) ) {
987 print STDERR "ERROR: Missing system preference AllowPKIAuth.\n";
990 if ( ( $cas && $query->param('ticket') )
992 || ( $shib && $shib_login )
993 || $pki_field ne 'None'
996 my $password = $query->param('password');
998 my ( $return, $cardnumber );
1000 # If shib is enabled and we have a shib login, does the login match a valid koha user
1001 if ( $shib && $shib_login ) {
1004 # Do not pass password here, else shib will not be checked in checkpw.
1005 ( $return, $cardnumber, $retuserid ) = checkpw( $dbh, $q_userid, undef, $query );
1006 $userid = $retuserid;
1007 $shibSuccess = $return;
1008 $info{'invalidShibLogin'} = 1 unless ($return);
1011 # If shib login and match were successful, skip further login methods
1012 unless ($shibSuccess) {
1013 if ( $cas && $query->param('ticket') ) {
1015 ( $return, $cardnumber, $retuserid, $cas_ticket ) =
1016 checkpw( $dbh, $userid, $password, $query, $type );
1017 $userid = $retuserid;
1018 $info{'invalidCasLogin'} = 1 unless ($return);
1021 elsif ( $emailaddress ) {
1022 my $value = $emailaddress;
1024 # If we're looking up the email, there's a chance that the person
1025 # doesn't have a userid. So if there is none, we pass along the
1026 # borrower number, and the bits of code that need to know the user
1027 # ID will have to be smart enough to handle that.
1028 my $patrons = Koha::Patrons->search({ email => $value });
1029 if ($patrons->count) {
1031 # First the userid, then the borrowernum
1032 my $patron = $patrons->next;
1033 $value = $patron->userid || $patron->borrowernumber;
1037 $return = $value ? 1 : 0;
1042 ( $pki_field eq 'Common Name' && $ENV{'SSL_CLIENT_S_DN_CN'} )
1043 || ( $pki_field eq 'emailAddress'
1044 && $ENV{'SSL_CLIENT_S_DN_Email'} )
1048 if ( $pki_field eq 'Common Name' ) {
1049 $value = $ENV{'SSL_CLIENT_S_DN_CN'};
1051 elsif ( $pki_field eq 'emailAddress' ) {
1052 $value = $ENV{'SSL_CLIENT_S_DN_Email'};
1054 # If we're looking up the email, there's a chance that the person
1055 # doesn't have a userid. So if there is none, we pass along the
1056 # borrower number, and the bits of code that need to know the user
1057 # ID will have to be smart enough to handle that.
1058 my $patrons = Koha::Patrons->search({ email => $value });
1059 if ($patrons->count) {
1061 # First the userid, then the borrowernum
1062 my $patron = $patrons->next;
1063 $value = $patron->userid || $patron->borrowernumber;
1069 $return = $value ? 1 : 0;
1075 ( $return, $cardnumber, $retuserid, $cas_ticket ) =
1076 checkpw( $dbh, $q_userid, $password, $query, $type );
1077 $userid = $retuserid if ($retuserid);
1078 $info{'invalid_username_or_password'} = 1 unless ($return);
1082 # $return: 1 = valid user
1085 #_session_log(sprintf "%20s from %16s logged in at %30s.\n", $userid,$ENV{'REMOTE_ADDR'},(strftime '%c', localtime));
1086 if ( $flags = haspermission( $userid, $flagsrequired ) ) {
1090 $info{'nopermission'} = 1;
1091 C4::Context->_unset_userenv($sessionID);
1093 my ( $borrowernumber, $firstname, $surname, $userflags,
1094 $branchcode, $branchname, $emailaddress, $desk_id,
1095 $desk_name, $register_id, $register_name );
1097 if ( $return == 1 ) {
1099 SELECT borrowernumber, firstname, surname, flags, borrowers.branchcode,
1100 branches.branchname as branchname, email
1102 LEFT JOIN branches on borrowers.branchcode=branches.branchcode
1104 my $sth = $dbh->prepare("$select where userid=?");
1105 $sth->execute($userid);
1106 unless ( $sth->rows ) {
1107 $debug and print STDERR "AUTH_1: no rows for userid='$userid'\n";
1108 $sth = $dbh->prepare("$select where cardnumber=?");
1109 $sth->execute($cardnumber);
1111 unless ( $sth->rows ) {
1112 $debug and print STDERR "AUTH_2a: no rows for cardnumber='$cardnumber'\n";
1113 $sth->execute($userid);
1114 unless ( $sth->rows ) {
1115 $debug and print STDERR "AUTH_2b: no rows for userid='$userid' AS cardnumber\n";
1120 ( $borrowernumber, $firstname, $surname, $userflags,
1121 $branchcode, $branchname, $emailaddress ) = $sth->fetchrow;
1122 $debug and print STDERR "AUTH_3 results: " .
1123 "$cardnumber,$borrowernumber,$userid,$firstname,$surname,$userflags,$branchcode,$emailaddress\n";
1125 print STDERR "AUTH_3: no results for userid='$userid', cardnumber='$cardnumber'.\n";
1128 # launch a sequence to check if we have a ip for the branch, i
1129 # if we have one we replace the branchcode of the userenv by the branch bound in the ip.
1131 my $ip = $ENV{'REMOTE_ADDR'};
1133 # if they specify at login, use that
1134 if ( $query->param('branch') ) {
1135 $branchcode = $query->param('branch');
1136 my $library = Koha::Libraries->find($branchcode);
1137 $branchname = $library? $library->branchname: '';
1139 if ( $query->param('desk_id') ) {
1140 $desk_id = $query->param('desk_id');
1141 my $desk = Koha::Desks->find($desk_id);
1142 $desk_name = $desk ? $desk->desk_name : '';
1144 if ( $query->param('register_id') ) {
1145 $register_id = $query->param('register_id');
1146 my $register = Koha::Cash::Registers->find($register_id);
1147 $register_name = $register ? $register->name : '';
1149 my $branches = { map { $_->branchcode => $_->unblessed } Koha::Libraries->search };
1150 if ( $type ne 'opac' and C4::Context->boolean_preference('AutoLocation') ) {
1152 # we have to check they are coming from the right ip range
1153 my $domain = $branches->{$branchcode}->{'branchip'};
1154 $domain =~ s|\.\*||g;
1155 if ( $ip !~ /^$domain/ ) {
1157 $cookie = $query->cookie(
1158 -name => 'CGISESSID',
1161 -secure => ( C4::Context->https_enabled() ? 1 : 0 ),
1163 $info{'wrongip'} = 1;
1167 foreach my $br ( keys %$branches ) {
1169 # now we work with the treatment of ip
1170 my $domain = $branches->{$br}->{'branchip'};
1171 if ( $domain && $ip =~ /^$domain/ ) {
1172 $branchcode = $branches->{$br}->{'branchcode'};
1174 # new op dev : add the branchname to the cookie
1175 $branchname = $branches->{$br}->{'branchname'};
1178 $session->param( 'number', $borrowernumber );
1179 $session->param( 'id', $userid );
1180 $session->param( 'cardnumber', $cardnumber );
1181 $session->param( 'firstname', $firstname );
1182 $session->param( 'surname', $surname );
1183 $session->param( 'branch', $branchcode );
1184 $session->param( 'branchname', $branchname );
1185 $session->param( 'desk_id', $desk_id);
1186 $session->param( 'desk_name', $desk_name);
1187 $session->param( 'flags', $userflags );
1188 $session->param( 'emailaddress', $emailaddress );
1189 $session->param( 'ip', $session->remote_addr() );
1190 $session->param( 'lasttime', time() );
1191 $session->param( 'interface', $type);
1192 $session->param( 'shibboleth', $shibSuccess );
1193 $session->param( 'register_id', $register_id );
1194 $session->param( 'register_name', $register_name );
1195 $debug and printf STDERR "AUTH_4: (%s)\t%s %s - %s\n", map { $session->param($_) } qw(cardnumber firstname surname branch);
1197 $session->param('cas_ticket', $cas_ticket) if $cas_ticket;
1198 C4::Context->set_userenv(
1199 $session->param('number'), $session->param('id'),
1200 $session->param('cardnumber'), $session->param('firstname'),
1201 $session->param('surname'), $session->param('branch'),
1202 $session->param('branchname'), $session->param('flags'),
1203 $session->param('emailaddress'), $session->param('shibboleth'),
1204 $session->param('desk_id'), $session->param('desk_name'),
1205 $session->param('register_id'), $session->param('register_name')
1209 # $return: 0 = invalid user
1210 # reset to anonymous session
1212 $debug and warn "Login failed, resetting anonymous session...";
1214 $info{'invalid_username_or_password'} = 1;
1215 C4::Context->_unset_userenv($sessionID);
1217 $session->param( 'lasttime', time() );
1218 $session->param( 'ip', $session->remote_addr() );
1219 $session->param( 'sessiontype', 'anon' );
1220 $session->param( 'interface', $type);
1222 } # END if ( $q_userid
1223 elsif ( $type eq "opac" ) {
1225 # if we are here this is an anonymous session; add public lists to it and a few other items...
1226 # anonymous sessions are created only for the OPAC
1227 $debug and warn "Initiating an anonymous session...";
1229 # setting a couple of other session vars...
1230 $session->param( 'ip', $session->remote_addr() );
1231 $session->param( 'lasttime', time() );
1232 $session->param( 'sessiontype', 'anon' );
1233 $session->param( 'interface', $type);
1235 } # END unless ($userid)
1237 # finished authentification, now respond
1238 if ( $loggedin || $authnotrequired )
1242 $cookie = $query->cookie(
1243 -name => 'CGISESSID',
1246 -secure => ( C4::Context->https_enabled() ? 1 : 0 ),
1250 track_login_daily( $userid );
1252 # In case, that this request was a login attempt, we want to prevent that users can repost the opac login
1253 # request. We therefore redirect the user to the requested page again without the login parameters.
1254 # See Post/Redirect/Get (PRG) design pattern: https://en.wikipedia.org/wiki/Post/Redirect/Get
1255 if ( $type eq "opac" && $query->param('koha_login_context') && $query->param('koha_login_context') ne 'sco' && $query->param('password') && $query->param('userid') ) {
1256 my $uri = URI->new($query->url(-relative=>1, -query_string=>1));
1257 $uri->query_param_delete('userid');
1258 $uri->query_param_delete('password');
1259 $uri->query_param_delete('koha_login_context');
1260 print $query->redirect(-uri => $uri->as_string, -cookie => $cookie, -status=>'303 See other');
1264 return ( $userid, $cookie, $sessionID, $flags );
1269 # AUTH rejected, show the login/password template, after checking the DB.
1273 # get the inputs from the incoming query
1275 foreach my $name ( param $query) {
1276 (next) if ( $name eq 'userid' || $name eq 'password' || $name eq 'ticket' );
1277 my @value = $query->multi_param($name);
1278 push @inputs, { name => $name, value => $_ } for @value;
1281 my $patron = Koha::Patrons->find({ userid => $q_userid }); # Not necessary logged in!
1283 my $LibraryNameTitle = C4::Context->preference("LibraryName");
1284 $LibraryNameTitle =~ s/<(?:\/?)(?:br|p)\s*(?:\/?)>/ /sgi;
1285 $LibraryNameTitle =~ s/<(?:[^<>'"]|'(?:[^']*)'|"(?:[^"]*)")*>//sg;
1287 my $auth_template_name = ( $type eq 'opac' ) ? 'opac-auth.tt' : 'auth.tt';
1288 my $template = C4::Templates::gettemplate( $auth_template_name, $type, $query );
1292 script_name => get_script_name(),
1293 casAuthentication => C4::Context->preference("casAuthentication"),
1294 shibbolethAuthentication => $shib,
1295 SessionRestrictionByIP => C4::Context->preference("SessionRestrictionByIP"),
1296 suggestion => C4::Context->preference("suggestion"),
1297 virtualshelves => C4::Context->preference("virtualshelves"),
1298 LibraryName => "" . C4::Context->preference("LibraryName"),
1299 LibraryNameTitle => "" . $LibraryNameTitle,
1300 opacuserlogin => C4::Context->preference("opacuserlogin"),
1301 OpacNav => C4::Context->preference("OpacNav"),
1302 OpacNavBottom => C4::Context->preference("OpacNavBottom"),
1303 OpacFavicon => C4::Context->preference("OpacFavicon"),
1304 opacreadinghistory => C4::Context->preference("opacreadinghistory"),
1305 opaclanguagesdisplay => C4::Context->preference("opaclanguagesdisplay"),
1306 OPACUserJS => C4::Context->preference("OPACUserJS"),
1307 opacbookbag => "" . C4::Context->preference("opacbookbag"),
1308 OpacCloud => C4::Context->preference("OpacCloud"),
1309 OpacTopissue => C4::Context->preference("OpacTopissue"),
1310 OpacAuthorities => C4::Context->preference("OpacAuthorities"),
1311 OpacBrowser => C4::Context->preference("OpacBrowser"),
1312 TagsEnabled => C4::Context->preference("TagsEnabled"),
1313 OPACUserCSS => C4::Context->preference("OPACUserCSS"),
1314 intranetcolorstylesheet => C4::Context->preference("intranetcolorstylesheet"),
1315 intranetstylesheet => C4::Context->preference("intranetstylesheet"),
1316 intranetbookbag => C4::Context->preference("intranetbookbag"),
1317 IntranetNav => C4::Context->preference("IntranetNav"),
1318 IntranetFavicon => C4::Context->preference("IntranetFavicon"),
1319 IntranetUserCSS => C4::Context->preference("IntranetUserCSS"),
1320 IntranetUserJS => C4::Context->preference("IntranetUserJS"),
1321 IndependentBranches => C4::Context->preference("IndependentBranches"),
1322 AutoLocation => C4::Context->preference("AutoLocation"),
1323 wrongip => $info{'wrongip'},
1324 PatronSelfRegistration => C4::Context->preference("PatronSelfRegistration"),
1325 PatronSelfRegistrationDefaultCategory => C4::Context->preference("PatronSelfRegistrationDefaultCategory"),
1326 opac_css_override => $ENV{'OPAC_CSS_OVERRIDE'},
1327 too_many_login_attempts => ( $patron and $patron->account_locked )
1330 $template->param( SCO_login => 1 ) if ( $query->param('sco_user_login') );
1331 $template->param( SCI_login => 1 ) if ( $query->param('sci_user_login') );
1332 $template->param( OpacPublic => C4::Context->preference("OpacPublic") );
1333 $template->param( loginprompt => 1 ) unless $info{'nopermission'};
1335 if ( $type eq 'opac' ) {
1336 require Koha::Virtualshelves;
1337 my $some_public_shelves = Koha::Virtualshelves->get_some_shelves(
1343 some_public_shelves => $some_public_shelves,
1349 # Is authentication against multiple CAS servers enabled?
1350 if ( C4::Auth_with_cas::multipleAuth && !$casparam ) {
1351 my $casservers = C4::Auth_with_cas::getMultipleAuth();
1353 foreach my $key ( keys %$casservers ) {
1354 push @tmplservers, { name => $key, value => login_cas_url( $query, $key, $type ) . "?cas=$key" };
1357 casServersLoop => \@tmplservers
1361 casServerUrl => login_cas_url($query, undef, $type),
1366 invalidCasLogin => $info{'invalidCasLogin'}
1372 shibbolethAuthentication => $shib,
1373 shibbolethLoginUrl => login_shib_url($query),
1377 if (C4::Context->preference('GoogleOpenIDConnect')) {
1378 if ($query->param("OpenIDConnectFailed")) {
1379 my $reason = $query->param('OpenIDConnectFailed');
1380 $template->param(invalidGoogleOpenIDConnectLogin => $reason);
1385 LibraryName => C4::Context->preference("LibraryName"),
1387 $template->param(%info);
1389 # $cookie = $query->cookie(CGISESSID => $session->id
1391 print $query->header(
1392 { type => 'text/html',
1395 'X-Frame-Options' => 'SAMEORIGIN'
1402 =head2 check_api_auth
1404 ($status, $cookie, $sessionId) = check_api_auth($query, $userflags);
1406 Given a CGI query containing the parameters 'userid' and 'password' and/or a session
1407 cookie, determine if the user has the privileges specified by C<$userflags>.
1409 C<check_api_auth> is is meant for authenticating users of web services, and
1410 consequently will always return and will not attempt to redirect the user
1413 If a valid session cookie is already present, check_api_auth will return a status
1414 of "ok", the cookie, and the Koha session ID.
1416 If no session cookie is present, check_api_auth will check the 'userid' and 'password
1417 parameters and create a session cookie and Koha session if the supplied credentials
1420 Possible return values in C<$status> are:
1424 =item "ok" -- user authenticated; C<$cookie> and C<$sessionid> have valid values.
1426 =item "failed" -- credentials are not correct; C<$cookie> and C<$sessionid> are undef
1428 =item "maintenance" -- DB is in maintenance mode; no login possible at the moment
1430 =item "expired -- session cookie has expired; API user should resubmit userid and password
1436 sub check_api_auth {
1439 my $flagsrequired = shift;
1440 my $dbh = C4::Context->dbh;
1441 my $timeout = _timeout_syspref();
1443 unless ( C4::Context->preference('Version') ) {
1445 # database has not been installed yet
1446 return ( "maintenance", undef, undef );
1448 my $kohaversion = Koha::version();
1449 $kohaversion =~ s/(.*\..*)\.(.*)\.(.*)/$1$2$3/;
1450 if ( C4::Context->preference('Version') < $kohaversion ) {
1452 # database in need of version update; assume that
1453 # no API should be called while databsae is in
1455 return ( "maintenance", undef, undef );
1458 # FIXME -- most of what follows is a copy-and-paste
1459 # of code from checkauth. There is an obvious need
1460 # for refactoring to separate the various parts of
1461 # the authentication code, but as of 2007-11-19 this
1462 # is deferred so as to not introduce bugs into the
1463 # regular authentication code for Koha 3.0.
1465 # see if we have a valid session cookie already
1466 # however, if a userid parameter is present (i.e., from
1467 # a form submission, assume that any current cookie
1469 my $sessionID = undef;
1470 unless ( $query->param('userid') ) {
1471 $sessionID = $query->cookie("CGISESSID");
1473 if ( $sessionID && not( $cas && $query->param('PT') ) ) {
1474 my $session = get_session($sessionID);
1475 C4::Context->_new_userenv($sessionID);
1477 C4::Context->interface($session->param('interface'));
1478 C4::Context->set_userenv(
1479 $session->param('number'), $session->param('id'),
1480 $session->param('cardnumber'), $session->param('firstname'),
1481 $session->param('surname'), $session->param('branch'),
1482 $session->param('branchname'), $session->param('flags'),
1483 $session->param('emailaddress'), $session->param('shibboleth'),
1484 $session->param('desk_id'), $session->param('desk_name'),
1485 $session->param('register_id'), $session->param('register_name')
1488 my $ip = $session->param('ip');
1489 my $lasttime = $session->param('lasttime');
1490 my $userid = $session->param('id');
1491 if ( $lasttime < time() - $timeout ) {
1496 C4::Context->_unset_userenv($sessionID);
1499 return ( "expired", undef, undef );
1500 } elsif ( C4::Context->preference('SessionRestrictionByIP') && $ip ne $ENV{'REMOTE_ADDR'} ) {
1502 # IP address changed
1505 C4::Context->_unset_userenv($sessionID);
1508 return ( "expired", undef, undef );
1510 my $cookie = $query->cookie(
1511 -name => 'CGISESSID',
1512 -value => $session->id,
1514 -secure => ( C4::Context->https_enabled() ? 1 : 0 ),
1516 $session->param( 'lasttime', time() );
1517 my $flags = haspermission( $userid, $flagsrequired );
1519 return ( "ok", $cookie, $sessionID );
1523 C4::Context->_unset_userenv($sessionID);
1526 return ( "failed", undef, undef );
1530 return ( "expired", undef, undef );
1535 my $userid = $query->param('userid');
1536 my $password = $query->param('password');
1537 my ( $return, $cardnumber, $cas_ticket );
1540 if ( $cas && $query->param('PT') ) {
1542 $debug and print STDERR "## check_api_auth - checking CAS\n";
1544 # In case of a CAS authentication, we use the ticket instead of the password
1545 my $PT = $query->param('PT');
1546 ( $return, $cardnumber, $userid, $cas_ticket ) = check_api_auth_cas( $dbh, $PT, $query ); # EXTERNAL AUTH
1549 # User / password auth
1550 unless ( $userid and $password ) {
1552 # caller did something wrong, fail the authenticateion
1553 return ( "failed", undef, undef );
1556 ( $return, $cardnumber, $newuserid, $cas_ticket ) = checkpw( $dbh, $userid, $password, $query );
1559 if ( $return and haspermission( $userid, $flagsrequired ) ) {
1560 my $session = get_session("");
1561 return ( "failed", undef, undef ) unless $session;
1563 my $sessionID = $session->id;
1564 C4::Context->_new_userenv($sessionID);
1565 my $cookie = $query->cookie(
1566 -name => 'CGISESSID',
1567 -value => $sessionID,
1569 -secure => ( C4::Context->https_enabled() ? 1 : 0 ),
1571 if ( $return == 1 ) {
1573 $borrowernumber, $firstname, $surname,
1574 $userflags, $branchcode, $branchname,
1579 "select borrowernumber, firstname, surname, flags, borrowers.branchcode, branches.branchname as branchname, email from borrowers left join branches on borrowers.branchcode=branches.branchcode where userid=?"
1581 $sth->execute($userid);
1583 $borrowernumber, $firstname, $surname,
1584 $userflags, $branchcode, $branchname,
1586 ) = $sth->fetchrow if ( $sth->rows );
1588 unless ( $sth->rows ) {
1589 my $sth = $dbh->prepare(
1590 "select borrowernumber, firstname, surname, flags, borrowers.branchcode, branches.branchname as branchname, email from borrowers left join branches on borrowers.branchcode=branches.branchcode where cardnumber=?"
1592 $sth->execute($cardnumber);
1594 $borrowernumber, $firstname, $surname,
1595 $userflags, $branchcode, $branchname,
1597 ) = $sth->fetchrow if ( $sth->rows );
1599 unless ( $sth->rows ) {
1600 $sth->execute($userid);
1602 $borrowernumber, $firstname, $surname, $userflags,
1603 $branchcode, $branchname, $emailaddress
1604 ) = $sth->fetchrow if ( $sth->rows );
1608 my $ip = $ENV{'REMOTE_ADDR'};
1610 # if they specify at login, use that
1611 if ( $query->param('branch') ) {
1612 $branchcode = $query->param('branch');
1613 my $library = Koha::Libraries->find($branchcode);
1614 $branchname = $library? $library->branchname: '';
1616 my $branches = { map { $_->branchcode => $_->unblessed } Koha::Libraries->search };
1617 foreach my $br ( keys %$branches ) {
1619 # now we work with the treatment of ip
1620 my $domain = $branches->{$br}->{'branchip'};
1621 if ( $domain && $ip =~ /^$domain/ ) {
1622 $branchcode = $branches->{$br}->{'branchcode'};
1624 # new op dev : add the branchname to the cookie
1625 $branchname = $branches->{$br}->{'branchname'};
1628 $session->param( 'number', $borrowernumber );
1629 $session->param( 'id', $userid );
1630 $session->param( 'cardnumber', $cardnumber );
1631 $session->param( 'firstname', $firstname );
1632 $session->param( 'surname', $surname );
1633 $session->param( 'branch', $branchcode );
1634 $session->param( 'branchname', $branchname );
1635 $session->param( 'flags', $userflags );
1636 $session->param( 'emailaddress', $emailaddress );
1637 $session->param( 'ip', $session->remote_addr() );
1638 $session->param( 'lasttime', time() );
1639 $session->param( 'interface', 'api' );
1641 $session->param( 'cas_ticket', $cas_ticket);
1642 C4::Context->set_userenv(
1643 $session->param('number'), $session->param('id'),
1644 $session->param('cardnumber'), $session->param('firstname'),
1645 $session->param('surname'), $session->param('branch'),
1646 $session->param('branchname'), $session->param('flags'),
1647 $session->param('emailaddress'), $session->param('shibboleth'),
1648 $session->param('desk_id'), $session->param('desk_name'),
1649 $session->param('register_id'), $session->param('register_name')
1651 return ( "ok", $cookie, $sessionID );
1653 return ( "failed", undef, undef );
1658 =head2 check_cookie_auth
1660 ($status, $sessionId) = check_api_auth($cookie, $userflags);
1662 Given a CGISESSID cookie set during a previous login to Koha, determine
1663 if the user has the privileges specified by C<$userflags>. C<$userflags>
1664 is passed unaltered into C<haspermission> and as such accepts all options
1665 avaiable to that routine with the one caveat that C<check_api_auth> will
1666 also allow 'undef' to be passed and in such a case the permissions check
1667 will be skipped altogether.
1669 C<check_cookie_auth> is meant for authenticating special services
1670 such as tools/upload-file.pl that are invoked by other pages that
1671 have been authenticated in the usual way.
1673 Possible return values in C<$status> are:
1677 =item "ok" -- user authenticated; C<$sessionID> have valid values.
1679 =item "failed" -- credentials are not correct; C<$sessionid> are undef
1681 =item "maintenance" -- DB is in maintenance mode; no login possible at the moment
1683 =item "expired -- session cookie has expired; API user should resubmit userid and password
1689 sub check_cookie_auth {
1691 my $flagsrequired = shift;
1694 my $remote_addr = $params->{remote_addr} || $ENV{REMOTE_ADDR};
1695 my $dbh = C4::Context->dbh;
1696 my $timeout = _timeout_syspref();
1698 unless ( C4::Context->preference('Version') ) {
1700 # database has not been installed yet
1701 return ( "maintenance", undef );
1703 my $kohaversion = Koha::version();
1704 $kohaversion =~ s/(.*\..*)\.(.*)\.(.*)/$1$2$3/;
1705 if ( C4::Context->preference('Version') < $kohaversion ) {
1707 # database in need of version update; assume that
1708 # no API should be called while databsae is in
1710 return ( "maintenance", undef );
1713 # FIXME -- most of what follows is a copy-and-paste
1714 # of code from checkauth. There is an obvious need
1715 # for refactoring to separate the various parts of
1716 # the authentication code, but as of 2007-11-23 this
1717 # is deferred so as to not introduce bugs into the
1718 # regular authentication code for Koha 3.0.
1720 # see if we have a valid session cookie already
1721 # however, if a userid parameter is present (i.e., from
1722 # a form submission, assume that any current cookie
1724 unless ( defined $cookie and $cookie ) {
1725 return ( "failed", undef );
1727 my $sessionID = $cookie;
1728 my $session = get_session($sessionID);
1729 C4::Context->_new_userenv($sessionID);
1731 C4::Context->interface($session->param('interface'));
1732 C4::Context->set_userenv(
1733 $session->param('number'), $session->param('id'),
1734 $session->param('cardnumber'), $session->param('firstname'),
1735 $session->param('surname'), $session->param('branch'),
1736 $session->param('branchname'), $session->param('flags'),
1737 $session->param('emailaddress'), $session->param('shibboleth'),
1738 $session->param('desk_id'), $session->param('desk_name'),
1739 $session->param('register_id'), $session->param('register_name')
1742 my $ip = $session->param('ip');
1743 my $lasttime = $session->param('lasttime');
1744 my $userid = $session->param('id');
1745 if ( $lasttime < time() - $timeout ) {
1750 C4::Context->_unset_userenv($sessionID);
1753 return ("expired", undef);
1754 } elsif ( C4::Context->preference('SessionRestrictionByIP') && $ip ne $remote_addr ) {
1756 # IP address changed
1759 C4::Context->_unset_userenv($sessionID);
1762 return ( "expired", undef );
1764 $session->param( 'lasttime', time() );
1765 my $flags = defined($flagsrequired) ? haspermission( $userid, $flagsrequired ) : 1;
1767 return ( "ok", $sessionID );
1771 C4::Context->_unset_userenv($sessionID);
1774 return ( "failed", undef );
1778 return ( "expired", undef );
1785 my $session = get_session($sessionID);
1787 Given a session ID, retrieve the CGI::Session object used to store
1788 the session's state. The session object can be used to store
1789 data that needs to be accessed by different scripts during a
1792 If the C<$sessionID> parameter is an empty string, a new session
1797 sub _get_session_params {
1798 my $storage_method = C4::Context->preference('SessionStorage');
1799 if ( $storage_method eq 'mysql' ) {
1800 my $dbh = C4::Context->dbh;
1801 return { dsn => "driver:MySQL;serializer:yaml;id:md5", dsn_args => { Handle => $dbh } };
1803 elsif ( $storage_method eq 'Pg' ) {
1804 my $dbh = C4::Context->dbh;
1805 return { dsn => "driver:PostgreSQL;serializer:yaml;id:md5", dsn_args => { Handle => $dbh } };
1807 elsif ( $storage_method eq 'memcached' && Koha::Caches->get_instance->memcached_cache ) {
1808 my $memcached = Koha::Caches->get_instance()->memcached_cache;
1809 return { dsn => "driver:memcached;serializer:yaml;id:md5", dsn_args => { Memcached => $memcached } };
1812 # catch all defaults to tmp should work on all systems
1813 my $dir = C4::Context::temporary_directory;
1814 my $instance = C4::Context->config( 'database' ); #actually for packages not exactly the instance name, but generally safer to leave it as it is
1815 return { dsn => "driver:File;serializer:yaml;id:md5", dsn_args => { Directory => "$dir/cgisess_$instance" } };
1820 my $sessionID = shift;
1821 my $params = _get_session_params();
1822 return CGI::Session->new( $params->{dsn}, $sessionID, $params->{dsn_args} );
1826 # FIXME no_set_userenv may be replaced with force_branchcode_for_userenv
1827 # (or something similar)
1828 # Currently it's only passed from C4::SIP::ILS::Patron::check_password, but
1829 # not having a userenv defined could cause a crash.
1831 my ( $dbh, $userid, $password, $query, $type, $no_set_userenv ) = @_;
1832 $type = 'opac' unless $type;
1834 # Get shibboleth login attribute
1835 my $shib = C4::Context->config('useshibboleth') && shib_ok();
1836 my $shib_login = $shib ? get_login_shib() : undef;
1840 if ( defined $userid ){
1841 $patron = Koha::Patrons->find({ userid => $userid });
1842 $patron = Koha::Patrons->find({ cardnumber => $userid }) unless $patron;
1844 my $check_internal_as_fallback = 0;
1846 # Note: checkpw_* routines returns:
1849 # -1 if user bind failed (LDAP only)
1851 if ( $patron and $patron->account_locked ) {
1852 # Nothing to check, account is locked
1853 } elsif ($ldap && defined($password)) {
1854 $debug and print STDERR "## checkpw - checking LDAP\n";
1855 my ( $retval, $retcard, $retuserid ) = checkpw_ldap(@_); # EXTERNAL AUTH
1856 if ( $retval == 1 ) {
1857 @return = ( $retval, $retcard, $retuserid );
1860 $check_internal_as_fallback = 1 if $retval == 0;
1862 } elsif ( $cas && $query && $query->param('ticket') ) {
1863 $debug and print STDERR "## checkpw - checking CAS\n";
1865 # In case of a CAS authentication, we use the ticket instead of the password
1866 my $ticket = $query->param('ticket');
1867 $query->delete('ticket'); # remove ticket to come back to original URL
1868 my ( $retval, $retcard, $retuserid, $cas_ticket ) = checkpw_cas( $dbh, $ticket, $query, $type ); # EXTERNAL AUTH
1870 @return = ( $retval, $retcard, $retuserid, $cas_ticket );
1874 $passwd_ok = $retval;
1877 # If we are in a shibboleth session (shibboleth is enabled, and a shibboleth match attribute is present)
1878 # Check for password to asertain whether we want to be testing against shibboleth or another method this
1880 elsif ( $shib && $shib_login && !$password ) {
1882 $debug and print STDERR "## checkpw - checking Shibboleth\n";
1884 # In case of a Shibboleth authentication, we expect a shibboleth user attribute
1885 # (defined under shibboleth mapping in koha-conf.xml) to contain the login of the
1886 # shibboleth-authenticated user
1888 # Then, we check if it matches a valid koha user
1890 my ( $retval, $retcard, $retuserid ) = C4::Auth_with_shibboleth::checkpw_shib($shib_login); # EXTERNAL AUTH
1892 @return = ( $retval, $retcard, $retuserid );
1894 $passwd_ok = $retval;
1897 $check_internal_as_fallback = 1;
1901 if ( $check_internal_as_fallback ) {
1902 @return = checkpw_internal( $dbh, $userid, $password, $no_set_userenv);
1903 $passwd_ok = 1 if $return[0] > 0; # 1 or 2
1908 $patron->update({ login_attempts => 0 });
1909 } elsif( !$patron->account_locked ) {
1910 $patron->update({ login_attempts => $patron->login_attempts + 1 });
1914 # Optionally log success or failure
1915 if( $patron && $passwd_ok && C4::Context->preference('AuthSuccessLog') ) {
1916 logaction( 'AUTH', 'SUCCESS', $patron->id, "Valid password for $userid", $type );
1917 } elsif( !$passwd_ok && C4::Context->preference('AuthFailureLog') ) {
1918 logaction( 'AUTH', 'FAILURE', $patron ? $patron->id : 0, "Wrong password for $userid", $type );
1924 sub checkpw_internal {
1925 my ( $dbh, $userid, $password, $no_set_userenv ) = @_;
1927 $password = Encode::encode( 'UTF-8', $password )
1928 if Encode::is_utf8($password);
1932 "select password,cardnumber,borrowernumber,userid,firstname,surname,borrowers.branchcode,branches.branchname,flags from borrowers join branches on borrowers.branchcode=branches.branchcode where userid=?"
1934 $sth->execute($userid);
1936 my ( $stored_hash, $cardnumber, $borrowernumber, $userid, $firstname,
1937 $surname, $branchcode, $branchname, $flags )
1940 if ( checkpw_hash( $password, $stored_hash ) ) {
1942 C4::Context->set_userenv( "$borrowernumber", $userid, $cardnumber,
1943 $firstname, $surname, $branchcode, $branchname, $flags ) unless $no_set_userenv;
1944 return 1, $cardnumber, $userid;
1949 "select password,cardnumber,borrowernumber,userid,firstname,surname,borrowers.branchcode,branches.branchname,flags from borrowers join branches on borrowers.branchcode=branches.branchcode where cardnumber=?"
1951 $sth->execute($userid);
1953 my ( $stored_hash, $cardnumber, $borrowernumber, $userid, $firstname,
1954 $surname, $branchcode, $branchname, $flags )
1957 if ( checkpw_hash( $password, $stored_hash ) ) {
1959 C4::Context->set_userenv( $borrowernumber, $userid, $cardnumber,
1960 $firstname, $surname, $branchcode, $branchname, $flags ) unless $no_set_userenv;
1961 return 1, $cardnumber, $userid;
1968 my ( $password, $stored_hash ) = @_;
1970 return if $stored_hash eq '!';
1972 # check what encryption algorithm was implemented: Bcrypt - if the hash starts with '$2' it is Bcrypt else md5
1974 if ( substr( $stored_hash, 0, 2 ) eq '$2' ) {
1975 $hash = hash_password( $password, $stored_hash );
1977 $hash = md5_base64($password);
1979 return $hash eq $stored_hash;
1984 my $authflags = getuserflags($flags, $userid, [$dbh]);
1986 Translates integer flags into permissions strings hash.
1988 C<$flags> is the integer userflags value ( borrowers.userflags )
1989 C<$userid> is the members.userid, used for building subpermissions
1990 C<$authflags> is a hashref of permissions
1997 my $dbh = @_ ? shift : C4::Context->dbh;
2000 # I don't want to do this, but if someone logs in as the database
2001 # user, it would be preferable not to spam them to death with
2002 # numeric warnings. So, we make $flags numeric.
2003 no warnings 'numeric';
2006 my $sth = $dbh->prepare("SELECT bit, flag, defaulton FROM userflags");
2009 while ( my ( $bit, $flag, $defaulton ) = $sth->fetchrow ) {
2010 if ( ( $flags & ( 2**$bit ) ) || $defaulton ) {
2011 $userflags->{$flag} = 1;
2014 $userflags->{$flag} = 0;
2018 # get subpermissions and merge with top-level permissions
2019 my $user_subperms = get_user_subpermissions($userid);
2020 foreach my $module ( keys %$user_subperms ) {
2021 next if $userflags->{$module} == 1; # user already has permission for everything in this module
2022 $userflags->{$module} = $user_subperms->{$module};
2028 =head2 get_user_subpermissions
2030 $user_perm_hashref = get_user_subpermissions($userid);
2032 Given the userid (note, not the borrowernumber) of a staff user,
2033 return a hashref of hashrefs of the specific subpermissions
2034 accorded to the user. An example return is
2038 export_catalog => 1,
2039 import_patrons => 1,
2043 The top-level hash-key is a module or function code from
2044 userflags.flag, while the second-level key is a code
2047 The results of this function do not give a complete picture
2048 of the functions that a staff user can access; it is also
2049 necessary to check borrowers.flags.
2053 sub get_user_subpermissions {
2056 my $dbh = C4::Context->dbh;
2057 my $sth = $dbh->prepare( "SELECT flag, user_permissions.code
2058 FROM user_permissions
2059 JOIN permissions USING (module_bit, code)
2060 JOIN userflags ON (module_bit = bit)
2061 JOIN borrowers USING (borrowernumber)
2062 WHERE userid = ?" );
2063 $sth->execute($userid);
2065 my $user_perms = {};
2066 while ( my $perm = $sth->fetchrow_hashref ) {
2067 $user_perms->{ $perm->{'flag'} }->{ $perm->{'code'} } = 1;
2072 =head2 get_all_subpermissions
2074 my $perm_hashref = get_all_subpermissions();
2076 Returns a hashref of hashrefs defining all specific
2077 permissions currently defined. The return value
2078 has the same structure as that of C<get_user_subpermissions>,
2079 except that the innermost hash value is the description
2080 of the subpermission.
2084 sub get_all_subpermissions {
2085 my $dbh = C4::Context->dbh;
2086 my $sth = $dbh->prepare( "SELECT flag, code
2088 JOIN userflags ON (module_bit = bit)" );
2092 while ( my $perm = $sth->fetchrow_hashref ) {
2093 $all_perms->{ $perm->{'flag'} }->{ $perm->{'code'} } = 1;
2098 =head2 haspermission
2100 $flagsrequired = '*'; # Any permission at all
2101 $flagsrequired = 'a_flag'; # a_flag must be satisfied (all subpermissions)
2102 $flagsrequired = [ 'a_flag', 'b_flag' ]; # a_flag OR b_flag must be satisfied
2103 $flagsrequired = { 'a_flag => 1, 'b_flag' => 1 }; # a_flag AND b_flag must be satisfied
2104 $flagsrequired = { 'a_flag' => 'sub_a' }; # sub_a of a_flag must be satisfied
2105 $flagsrequired = { 'a_flag' => [ 'sub_a, 'sub_b' ] }; # sub_a OR sub_b of a_flag must be satisfied
2107 $flags = ($userid, $flagsrequired);
2109 C<$userid> the userid of the member
2110 C<$flags> is a query structure similar to that used by SQL::Abstract that
2111 denotes the combination of flags required. It is a required parameter.
2113 The main logic of this method is that things in arrays are OR'ed, and things
2114 in hashes are AND'ed. The `*` character can be used, at any depth, to denote `ANY`
2116 Returns member's flags or 0 if a permission is not met.
2121 my ($required, $flags) = @_;
2123 my $ref = ref($required);
2125 if ($required eq '*') {
2126 return 0 unless ( $flags or ref( $flags ) );
2128 return 0 unless ( $flags and (!ref( $flags ) || $flags->{$required} ));
2130 } elsif ($ref eq 'HASH') {
2131 foreach my $key (keys %{$required}) {
2132 next if $flags == 1;
2133 my $require = $required->{$key};
2134 my $rflags = $flags->{$key};
2135 return 0 unless _dispatch($require, $rflags);
2137 } elsif ($ref eq 'ARRAY') {
2139 foreach my $require ( @{$required} ) {
2141 ( ref($flags) && !ref($require) && ( $require ne '*' ) )
2142 ? $flags->{$require}
2144 $satisfied++ if _dispatch( $require, $rflags );
2146 return 0 unless $satisfied;
2148 croak "Unexpected structure found: $ref";
2155 my ( $userid, $flagsrequired ) = @_;
2157 #Koha::Exceptions::WrongParameter->throw('$flagsrequired should not be undef')
2158 # unless defined($flagsrequired);
2160 my $sth = C4::Context->dbh->prepare("SELECT flags FROM borrowers WHERE userid=?");
2161 $sth->execute($userid);
2162 my $row = $sth->fetchrow();
2163 my $flags = getuserflags( $row, $userid );
2165 return $flags unless defined($flagsrequired);
2166 return $flags if $flags->{superlibrarian};
2167 return _dispatch($flagsrequired, $flags);
2169 #FIXME - This fcn should return the failed permission so a suitable error msg can be delivered.
2174 $flags = ($iprange);
2176 C<$iprange> A space separated string describing an IP range. Can include single IPs or ranges
2178 Returns 1 if the remote address is in the provided iprange, or 0 otherwise.
2185 my @allowedipranges = $iprange ? split(' ', $iprange) : ();
2186 if (scalar @allowedipranges > 0) {
2188 eval { @rangelist = Net::CIDR::range2cidr(@allowedipranges); }; return 0 if $@;
2189 eval { $result = Net::CIDR::cidrlookup($ENV{'REMOTE_ADDR'}, @rangelist) } || ( $ENV{DEBUG} && warn 'cidrlookup failed for ' . join(' ',@rangelist) );
2191 return $result ? 1 : 0;
2194 sub getborrowernumber {
2196 my $userenv = C4::Context->userenv;
2197 if ( defined($userenv) && ref($userenv) eq 'HASH' && $userenv->{number} ) {
2198 return $userenv->{number};
2200 my $dbh = C4::Context->dbh;
2201 for my $field ( 'userid', 'cardnumber' ) {
2203 $dbh->prepare("select borrowernumber from borrowers where $field=?");
2204 $sth->execute($userid);
2206 my ($bnumber) = $sth->fetchrow;
2213 =head2 track_login_daily
2215 track_login_daily( $userid );
2217 Wraps the call to $patron->track_login, the method used to update borrowers.lastseen. We only call track_login once a day.
2221 sub track_login_daily {
2223 return if !$userid || !C4::Context->preference('TrackLastPatronActivity');
2225 my $cache = Koha::Caches->get_instance();
2226 my $cache_key = "track_login_" . $userid;
2227 my $cached = $cache->get_from_cache($cache_key);
2228 my $today = dt_from_string()->ymd;
2229 return if $cached && $cached eq $today;
2231 my $patron = Koha::Patrons->find({ userid => $userid });
2232 return unless $patron;
2233 $patron->track_login;
2234 $cache->set_in_cache( $cache_key, $today );
2237 END { } # module clean-up code here (global destructor)
2247 Crypt::Eksblowfish::Bcrypt(3)