Bug 17050: Do not kick the session out when accessing the REST API
[koha.git] / C4 / Auth.pm
1 package C4::Auth;
2
3 # Copyright 2000-2002 Katipo Communications
4 #
5 # This file is part of Koha.
6 #
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.
11 #
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.
16 #
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>.
19
20 use strict;
21 use warnings;
22 use Digest::MD5 qw(md5_base64);
23 use File::Spec;
24 use JSON qw/encode_json/;
25 use URI::Escape;
26 use CGI::Session;
27
28 require Exporter;
29 use C4::Context;
30 use C4::Templates;    # to get the template
31 use C4::Languages;
32 use C4::Branch;       # GetBranches
33 use C4::Search::History;
34 use Koha;
35 use Koha::AuthUtils qw(get_script_name hash_password);
36 use Koha::LibraryCategories;
37 use Koha::Libraries;
38 use POSIX qw/strftime/;
39 use List::MoreUtils qw/ any /;
40 use Encode qw( encode is_utf8);
41
42 # use utf8;
43 use vars qw(@ISA @EXPORT @EXPORT_OK %EXPORT_TAGS $debug $ldap $cas $caslogout $shib $shib_login);
44
45 BEGIN {
46     sub psgi_env { any { /^psgi\./ } keys %ENV }
47
48     sub safe_exit {
49         if   (psgi_env) { die 'psgi:exit' }
50         else            { exit }
51     }
52
53     $debug     = $ENV{DEBUG};
54     @ISA       = qw(Exporter);
55     @EXPORT    = qw(&checkauth &get_template_and_user &haspermission &get_user_subpermissions);
56     @EXPORT_OK = qw(&check_api_auth &get_session &check_cookie_auth &checkpw &checkpw_internal &checkpw_hash
57       &get_all_subpermissions &get_user_subpermissions
58     );
59     %EXPORT_TAGS = ( EditPermissions => [qw(get_all_subpermissions get_user_subpermissions)] );
60     $ldap      = C4::Context->config('useldapserver') || 0;
61     $cas       = C4::Context->preference('casAuthentication');
62     $shib      = C4::Context->config('useshibboleth') || 0;
63     $caslogout = C4::Context->preference('casLogout');
64     require C4::Auth_with_cas;    # no import
65
66     if ($ldap) {
67         require C4::Auth_with_ldap;
68         import C4::Auth_with_ldap qw(checkpw_ldap);
69     }
70     if ($shib) {
71         require C4::Auth_with_shibboleth;
72         import C4::Auth_with_shibboleth
73           qw(shib_ok checkpw_shib logout_shib login_shib_url get_login_shib);
74
75         # Check for good config
76         if ( shib_ok() ) {
77
78             # Get shibboleth login attribute
79             $shib_login = get_login_shib();
80         }
81
82         # Bad config, disable shibboleth
83         else {
84             $shib = 0;
85         }
86     }
87     if ($cas) {
88         import C4::Auth_with_cas qw(check_api_auth_cas checkpw_cas login_cas logout_cas login_cas_url);
89     }
90
91 }
92
93 =head1 NAME
94
95 C4::Auth - Authenticates Koha users
96
97 =head1 SYNOPSIS
98
99   use CGI qw ( -utf8 );
100   use C4::Auth;
101   use C4::Output;
102
103   my $query = new CGI;
104
105   my ($template, $borrowernumber, $cookie)
106     = get_template_and_user(
107         {
108             template_name   => "opac-main.tt",
109             query           => $query,
110       type            => "opac",
111       authnotrequired => 0,
112       flagsrequired   => { catalogue => '*', tools => 'import_patrons' },
113   }
114     );
115
116   output_html_with_http_headers $query, $cookie, $template->output;
117
118 =head1 DESCRIPTION
119
120 The main function of this module is to provide
121 authentification. However the get_template_and_user function has
122 been provided so that a users login information is passed along
123 automatically. This gets loaded into the template.
124
125 =head1 FUNCTIONS
126
127 =head2 get_template_and_user
128
129  my ($template, $borrowernumber, $cookie)
130      = get_template_and_user(
131        {
132          template_name   => "opac-main.tt",
133          query           => $query,
134          type            => "opac",
135          authnotrequired => 0,
136          flagsrequired   => { catalogue => '*', tools => 'import_patrons' },
137        }
138      );
139
140 This call passes the C<query>, C<flagsrequired> and C<authnotrequired>
141 to C<&checkauth> (in this module) to perform authentification.
142 See C<&checkauth> for an explanation of these parameters.
143
144 The C<template_name> is then used to find the correct template for
145 the page. The authenticated users details are loaded onto the
146 template in the HTML::Template LOOP variable C<USER_INFO>. Also the
147 C<sessionID> is passed to the template. This can be used in templates
148 if cookies are disabled. It needs to be put as and input to every
149 authenticated page.
150
151 More information on the C<gettemplate> sub can be found in the
152 Output.pm module.
153
154 =cut
155
156 sub get_template_and_user {
157
158     my $in = shift;
159     my ( $user, $cookie, $sessionID, $flags );
160
161     C4::Context->interface( $in->{type} );
162
163     my $safe_chars = 'a-zA-Z0-9_\-\/';
164     die "bad template path" unless $in->{'template_name'} =~ m/^[$safe_chars]+\.tt$/ig; #sanitize input
165
166     $in->{'authnotrequired'} ||= 0;
167     my $template = C4::Templates::gettemplate(
168         $in->{'template_name'},
169         $in->{'type'},
170         $in->{'query'},
171         $in->{'is_plugin'}
172     );
173
174     if ( $in->{'template_name'} !~ m/maintenance/ ) {
175         ( $user, $cookie, $sessionID, $flags ) = checkauth(
176             $in->{'query'},
177             $in->{'authnotrequired'},
178             $in->{'flagsrequired'},
179             $in->{'type'}
180         );
181     }
182
183
184     # If the user logged in is the SCO user and he tries to go out the SCO module, log the user out removing the CGISESSID cookie
185     if ( $in->{type} eq 'opac' and $in->{template_name} !~ m|sco/| ) {
186         if (  C4::Context->preference('AutoSelfCheckID') && $user eq C4::Context->preference('AutoSelfCheckID') ) {
187             $template = C4::Templates::gettemplate( 'opac-auth.tt', 'opac', $in->{query} );
188             my $cookie = $in->{query}->cookie(
189                 -name     => 'CGISESSID',
190                 -value    => '',
191                 -expires  => '',
192                 -HttpOnly => 1,
193             );
194
195             $template->param(
196                 loginprompt => 1,
197                 script_name => get_script_name(),
198             );
199             print $in->{query}->header(
200                 {   type              => 'text/html',
201                     charset           => 'utf-8',
202                     cookie            => $cookie,
203                     'X-Frame-Options' => 'SAMEORIGIN'
204                 }
205               ),
206             $template->output;
207             safe_exit;
208         }
209     }
210
211     my $borrowernumber;
212     if ($user) {
213         require C4::Members;
214
215         # It's possible for $user to be the borrowernumber if they don't have a
216         # userid defined (and are logging in through some other method, such
217         # as SSL certs against an email address)
218         my $borrower;
219         $borrowernumber = getborrowernumber($user) if defined($user);
220         if ( !defined($borrowernumber) && defined($user) ) {
221             $borrower = C4::Members::GetMember( borrowernumber => $user );
222             if ($borrower) {
223                 $borrowernumber = $user;
224
225                 # A bit of a hack, but I don't know there's a nicer way
226                 # to do it.
227                 $user = $borrower->{firstname} . ' ' . $borrower->{surname};
228             }
229         } else {
230             $borrower = C4::Members::GetMember( borrowernumber => $borrowernumber );
231         }
232
233         # user info
234         $template->param( loggedinusername   => $user );
235         $template->param( loggedinusernumber => $borrowernumber );
236         $template->param( sessionID          => $sessionID );
237
238         if ( $in->{'type'} eq 'opac' ) {
239             require Koha::Virtualshelves;
240             my $some_private_shelves = Koha::Virtualshelves->get_some_shelves(
241                 {
242                     borrowernumber => $borrowernumber,
243                     category       => 1,
244                 }
245             );
246             my $some_public_shelves = Koha::Virtualshelves->get_some_shelves(
247                 {
248                     category       => 2,
249                 }
250             );
251             $template->param(
252                 some_private_shelves => $some_private_shelves,
253                 some_public_shelves  => $some_public_shelves,
254             );
255         }
256
257         $template->param( "USER_INFO" => $borrower );
258
259         my $all_perms = get_all_subpermissions();
260
261         my @flagroots = qw(circulate catalogue parameters borrowers permissions reserveforothers borrow
262           editcatalogue updatecharges management tools editauthorities serials reports acquisition);
263
264         # We are going to use the $flags returned by checkauth
265         # to create the template's parameters that will indicate
266         # which menus the user can access.
267         if ( $flags && $flags->{superlibrarian} == 1 ) {
268             $template->param( CAN_user_circulate        => 1 );
269             $template->param( CAN_user_catalogue        => 1 );
270             $template->param( CAN_user_parameters       => 1 );
271             $template->param( CAN_user_borrowers        => 1 );
272             $template->param( CAN_user_permissions      => 1 );
273             $template->param( CAN_user_reserveforothers => 1 );
274             $template->param( CAN_user_editcatalogue    => 1 );
275             $template->param( CAN_user_updatecharges    => 1 );
276             $template->param( CAN_user_acquisition      => 1 );
277             $template->param( CAN_user_management       => 1 );
278             $template->param( CAN_user_tools            => 1 );
279             $template->param( CAN_user_editauthorities  => 1 );
280             $template->param( CAN_user_serials          => 1 );
281             $template->param( CAN_user_reports          => 1 );
282             $template->param( CAN_user_staffaccess      => 1 );
283             $template->param( CAN_user_plugins          => 1 );
284             $template->param( CAN_user_coursereserves   => 1 );
285             foreach my $module ( keys %$all_perms ) {
286
287                 foreach my $subperm ( keys %{ $all_perms->{$module} } ) {
288                     $template->param( "CAN_user_${module}_${subperm}" => 1 );
289                 }
290             }
291         }
292
293         if ($flags) {
294             foreach my $module ( keys %$all_perms ) {
295                 if ( defined($flags->{$module}) && $flags->{$module} == 1 ) {
296                     foreach my $subperm ( keys %{ $all_perms->{$module} } ) {
297                         $template->param( "CAN_user_${module}_${subperm}" => 1 );
298                     }
299                 } elsif ( ref( $flags->{$module} ) ) {
300                     foreach my $subperm ( keys %{ $flags->{$module} } ) {
301                         $template->param( "CAN_user_${module}_${subperm}" => 1 );
302                     }
303                 }
304             }
305         }
306
307         if ($flags) {
308             foreach my $module ( keys %$flags ) {
309                 if ( $flags->{$module} == 1 or ref( $flags->{$module} ) ) {
310                     $template->param( "CAN_user_$module" => 1 );
311                     if ( $module eq "parameters" ) {
312                         $template->param( CAN_user_management => 1 );
313                     }
314                 }
315             }
316         }
317
318         # Logged-in opac search history
319         # If the requested template is an opac one and opac search history is enabled
320         if ( $in->{type} eq 'opac' && C4::Context->preference('EnableOpacSearchHistory') ) {
321             my $dbh   = C4::Context->dbh;
322             my $query = "SELECT COUNT(*) FROM search_history WHERE userid=?";
323             my $sth   = $dbh->prepare($query);
324             $sth->execute($borrowernumber);
325
326             # If at least one search has already been performed
327             if ( $sth->fetchrow_array > 0 ) {
328
329                 # We show the link in opac
330                 $template->param( EnableOpacSearchHistory => 1 );
331             }
332
333             # And if there are searches performed when the user was not logged in,
334             # we add them to the logged-in search history
335             my @recentSearches = C4::Search::History::get_from_session( { cgi => $in->{'query'} } );
336             if (@recentSearches) {
337                 my $dbh   = C4::Context->dbh;
338                 my $query = q{
339                     INSERT INTO search_history(userid, sessionid, query_desc, query_cgi, type,  total, time )
340                     VALUES (?, ?, ?, ?, ?, ?, ?)
341                 };
342
343                 my $sth = $dbh->prepare($query);
344                 $sth->execute( $borrowernumber,
345                     $in->{query}->cookie("CGISESSID"),
346                     $_->{query_desc},
347                     $_->{query_cgi},
348                     $_->{type} || 'biblio',
349                     $_->{total},
350                     $_->{time},
351                 ) foreach @recentSearches;
352
353                 # clear out the search history from the session now that
354                 # we've saved it to the database
355                 C4::Search::History::set_to_session( { cgi => $in->{'query'}, search_history => [] } );
356             }
357         } elsif ( $in->{type} eq 'intranet' and C4::Context->preference('EnableSearchHistory') ) {
358             $template->param( EnableSearchHistory => 1 );
359         }
360     }
361     else {    # if this is an anonymous session, setup to display public lists...
362
363         # If shibboleth is enabled, and we're in an anonymous session, we should allow
364         # the user to attempt login via shibboleth.
365         if ($shib) {
366             $template->param( shibbolethAuthentication => $shib,
367                 shibbolethLoginUrl => login_shib_url( $in->{'query'} ),
368             );
369
370             # If shibboleth is enabled and we have a shibboleth login attribute,
371             # but we are in an anonymous session, then we clearly have an invalid
372             # shibboleth koha account.
373             if ($shib_login) {
374                 $template->param( invalidShibLogin => '1' );
375             }
376         }
377
378         $template->param( sessionID => $sessionID );
379
380         if ( $in->{'type'} eq 'opac' ){
381             require Koha::Virtualshelves;
382             my $some_public_shelves = Koha::Virtualshelves->get_some_shelves(
383                 {
384                     category       => 2,
385                 }
386             );
387             $template->param(
388                 some_public_shelves  => $some_public_shelves,
389             );
390         }
391     }
392
393     # Anonymous opac search history
394     # If opac search history is enabled and at least one search has already been performed
395     if ( C4::Context->preference('EnableOpacSearchHistory') ) {
396         my @recentSearches = C4::Search::History::get_from_session( { cgi => $in->{'query'} } );
397         if (@recentSearches) {
398             $template->param( EnableOpacSearchHistory => 1 );
399         }
400     }
401
402     if ( C4::Context->preference('dateformat') ) {
403         $template->param( dateformat => C4::Context->preference('dateformat') );
404     }
405
406     $template->param(auth_forwarded_hash => scalar $in->{'query'}->param('auth_forwarded_hash'));
407
408     # these template parameters are set the same regardless of $in->{'type'}
409
410     # Set the using_https variable for templates
411     # FIXME Under Plack the CGI->https method always returns 'OFF'
412     my $https = $in->{query}->https();
413     my $using_https = ( defined $https and $https ne 'OFF' ) ? 1 : 0;
414
415     $template->param(
416         "BiblioDefaultView" . C4::Context->preference("BiblioDefaultView") => 1,
417         EnhancedMessagingPreferences                                       => C4::Context->preference('EnhancedMessagingPreferences'),
418         GoogleJackets                                                      => C4::Context->preference("GoogleJackets"),
419         OpenLibraryCovers                                                  => C4::Context->preference("OpenLibraryCovers"),
420         KohaAdminEmailAddress                                              => "" . C4::Context->preference("KohaAdminEmailAddress"),
421         LoginBranchcode => ( C4::Context->userenv ? C4::Context->userenv->{"branch"}    : undef ),
422         LoginFirstname  => ( C4::Context->userenv ? C4::Context->userenv->{"firstname"} : "Bel" ),
423         LoginSurname    => C4::Context->userenv ? C4::Context->userenv->{"surname"}      : "Inconnu",
424         emailaddress    => C4::Context->userenv ? C4::Context->userenv->{"emailaddress"} : undef,
425         loggedinpersona => C4::Context->userenv ? C4::Context->userenv->{"persona"}      : undef,
426         TagsEnabled     => C4::Context->preference("TagsEnabled"),
427         hide_marc       => C4::Context->preference("hide_marc"),
428         item_level_itypes  => C4::Context->preference('item-level_itypes'),
429         patronimages       => C4::Context->preference("patronimages"),
430         singleBranchMode   => ( Koha::Libraries->search->count == 1 ),
431         XSLTDetailsDisplay => C4::Context->preference("XSLTDetailsDisplay"),
432         XSLTResultsDisplay => C4::Context->preference("XSLTResultsDisplay"),
433         using_https        => $using_https,
434         noItemTypeImages   => C4::Context->preference("noItemTypeImages"),
435         marcflavour        => C4::Context->preference("marcflavour"),
436         persona            => C4::Context->preference("persona"),
437         OPACBaseURL        => C4::Context->preference('OPACBaseURL'),
438     );
439     if ( $in->{'type'} eq "intranet" ) {
440         $template->param(
441             AmazonCoverImages                                                          => C4::Context->preference("AmazonCoverImages"),
442             AutoLocation                                                               => C4::Context->preference("AutoLocation"),
443             "BiblioDefaultView" . C4::Context->preference("IntranetBiblioDefaultView") => 1,
444             CircAutocompl                                                              => C4::Context->preference("CircAutocompl"),
445             FRBRizeEditions                                                            => C4::Context->preference("FRBRizeEditions"),
446             IndependentBranches                                                        => C4::Context->preference("IndependentBranches"),
447             IntranetNav                                                                => C4::Context->preference("IntranetNav"),
448             IntranetmainUserblock                                                      => C4::Context->preference("IntranetmainUserblock"),
449             LibraryName                                                                => C4::Context->preference("LibraryName"),
450             LoginBranchname                                                            => ( C4::Context->userenv ? C4::Context->userenv->{"branchname"} : undef ),
451             advancedMARCEditor                                                         => C4::Context->preference("advancedMARCEditor"),
452             canreservefromotherbranches                                                => C4::Context->preference('canreservefromotherbranches'),
453             intranetcolorstylesheet                                                    => C4::Context->preference("intranetcolorstylesheet"),
454             IntranetFavicon                                                            => C4::Context->preference("IntranetFavicon"),
455             intranetreadinghistory                                                     => C4::Context->preference("intranetreadinghistory"),
456             intranetstylesheet                                                         => C4::Context->preference("intranetstylesheet"),
457             IntranetUserCSS                                                            => C4::Context->preference("IntranetUserCSS"),
458             IntranetUserJS                                                             => C4::Context->preference("IntranetUserJS"),
459             intranetbookbag                                                            => C4::Context->preference("intranetbookbag"),
460             suggestion                                                                 => C4::Context->preference("suggestion"),
461             virtualshelves                                                             => C4::Context->preference("virtualshelves"),
462             StaffSerialIssueDisplayCount                                               => C4::Context->preference("StaffSerialIssueDisplayCount"),
463             EasyAnalyticalRecords                                                      => C4::Context->preference('EasyAnalyticalRecords'),
464             LocalCoverImages                                                           => C4::Context->preference('LocalCoverImages'),
465             OPACLocalCoverImages                                                       => C4::Context->preference('OPACLocalCoverImages'),
466             AllowMultipleCovers                                                        => C4::Context->preference('AllowMultipleCovers'),
467             EnableBorrowerFiles                                                        => C4::Context->preference('EnableBorrowerFiles'),
468             UseKohaPlugins                                                             => C4::Context->preference('UseKohaPlugins'),
469             UseCourseReserves                                                          => C4::Context->preference("UseCourseReserves"),
470             useDischarge                                                               => C4::Context->preference('useDischarge'),
471         );
472     }
473     else {
474         warn "template type should be OPAC, here it is=[" . $in->{'type'} . "]" unless ( $in->{'type'} eq 'opac' );
475
476         #TODO : replace LibraryName syspref with 'system name', and remove this html processing
477         my $LibraryNameTitle = C4::Context->preference("LibraryName");
478         $LibraryNameTitle =~ s/<(?:\/?)(?:br|p)\s*(?:\/?)>/ /sgi;
479         $LibraryNameTitle =~ s/<(?:[^<>'"]|'(?:[^']*)'|"(?:[^"]*)")*>//sg;
480
481         # clean up the busc param in the session
482         # if the page is not opac-detail and not the "add to list" page
483         # and not the "edit comments" page
484         if ( C4::Context->preference("OpacBrowseResults")
485             && $in->{'template_name'} =~ /opac-(.+)\.(?:tt|tmpl)$/ ) {
486             my $pagename = $1;
487             unless ( $pagename =~ /^(?:MARC|ISBD)?detail$/
488                 or $pagename =~ /^addbybiblionumber$/
489                 or $pagename =~ /^review$/ ) {
490                 my $sessionSearch = get_session( $sessionID || $in->{'query'}->cookie("CGISESSID") );
491                 $sessionSearch->clear( ["busc"] ) if ( $sessionSearch->param("busc") );
492             }
493         }
494
495         # variables passed from CGI: opac_css_override and opac_search_limits.
496         my $opac_search_limit   = $ENV{'OPAC_SEARCH_LIMIT'};
497         my $opac_limit_override = $ENV{'OPAC_LIMIT_OVERRIDE'};
498         my $opac_name           = '';
499         if (
500             ( $opac_limit_override && $opac_search_limit && $opac_search_limit =~ /branch:(\w+)/ ) ||
501             ( $in->{'query'}->param('limit') && $in->{'query'}->param('limit') =~ /branch:(\w+)/ ) ||
502             ( $in->{'query'}->param('multibranchlimit') && $in->{'query'}->param('multibranchlimit') =~ /multibranchlimit-(\w+)/ )
503           ) {
504             $opac_name = $1;    # opac_search_limit is a branch, so we use it.
505         } elsif ( $in->{'query'}->param('multibranchlimit') ) {
506             $opac_name = $in->{'query'}->param('multibranchlimit');
507         } elsif ( C4::Context->preference("SearchMyLibraryFirst") && C4::Context->userenv && C4::Context->userenv->{'branch'} ) {
508             $opac_name = C4::Context->userenv->{'branch'};
509         }
510
511         my $library_categories = Koha::LibraryCategories->search({categorytype => 'searchdomain', show_in_pulldown => 1}, { order_by => ['categorytype', 'categorycode']});
512         $template->param(
513             OpacAdditionalStylesheet                   => C4::Context->preference("OpacAdditionalStylesheet"),
514             AnonSuggestions                       => "" . C4::Context->preference("AnonSuggestions"),
515             BranchesLoop                          => GetBranchesLoop($opac_name),
516             BranchCategoriesLoop                  => $library_categories,
517             opac_name                             => $opac_name,
518             LibraryName                           => "" . C4::Context->preference("LibraryName"),
519             LibraryNameTitle                      => "" . $LibraryNameTitle,
520             LoginBranchname                       => C4::Context->userenv ? C4::Context->userenv->{"branchname"} : "",
521             OPACAmazonCoverImages                 => C4::Context->preference("OPACAmazonCoverImages"),
522             OPACFRBRizeEditions                   => C4::Context->preference("OPACFRBRizeEditions"),
523             OpacHighlightedWords                  => C4::Context->preference("OpacHighlightedWords"),
524             OPACShelfBrowser                      => "" . C4::Context->preference("OPACShelfBrowser"),
525             OPACURLOpenInNewWindow                => "" . C4::Context->preference("OPACURLOpenInNewWindow"),
526             OPACUserCSS                           => "" . C4::Context->preference("OPACUserCSS"),
527             OpacAuthorities                       => C4::Context->preference("OpacAuthorities"),
528             opac_css_override                     => $ENV{'OPAC_CSS_OVERRIDE'},
529             opac_search_limit                     => $opac_search_limit,
530             opac_limit_override                   => $opac_limit_override,
531             OpacBrowser                           => C4::Context->preference("OpacBrowser"),
532             OpacCloud                             => C4::Context->preference("OpacCloud"),
533             OpacKohaUrl                           => C4::Context->preference("OpacKohaUrl"),
534             OpacMainUserBlock                     => "" . C4::Context->preference("OpacMainUserBlock"),
535             OpacNav                               => "" . C4::Context->preference("OpacNav"),
536             OpacNavRight                          => "" . C4::Context->preference("OpacNavRight"),
537             OpacNavBottom                         => "" . C4::Context->preference("OpacNavBottom"),
538             OpacPasswordChange                    => C4::Context->preference("OpacPasswordChange"),
539             OPACPatronDetails                     => C4::Context->preference("OPACPatronDetails"),
540             OPACPrivacy                           => C4::Context->preference("OPACPrivacy"),
541             OPACFinesTab                          => C4::Context->preference("OPACFinesTab"),
542             OpacTopissue                          => C4::Context->preference("OpacTopissue"),
543             RequestOnOpac                         => C4::Context->preference("RequestOnOpac"),
544             'Version'                             => C4::Context->preference('Version'),
545             hidelostitems                         => C4::Context->preference("hidelostitems"),
546             mylibraryfirst                        => ( C4::Context->preference("SearchMyLibraryFirst") && C4::Context->userenv ) ? C4::Context->userenv->{'branch'} : '',
547             opaclayoutstylesheet                  => "" . C4::Context->preference("opaclayoutstylesheet"),
548             opacbookbag                           => "" . C4::Context->preference("opacbookbag"),
549             opaccredits                           => "" . C4::Context->preference("opaccredits"),
550             OpacFavicon                           => C4::Context->preference("OpacFavicon"),
551             opacheader                            => "" . C4::Context->preference("opacheader"),
552             opaclanguagesdisplay                  => "" . C4::Context->preference("opaclanguagesdisplay"),
553             opacreadinghistory                    => C4::Context->preference("opacreadinghistory"),
554             OPACUserJS                            => C4::Context->preference("OPACUserJS"),
555             opacuserlogin                         => "" . C4::Context->preference("opacuserlogin"),
556             OpenLibrarySearch                     => C4::Context->preference("OpenLibrarySearch"),
557             ShowReviewer                          => C4::Context->preference("ShowReviewer"),
558             ShowReviewerPhoto                     => C4::Context->preference("ShowReviewerPhoto"),
559             suggestion                            => "" . C4::Context->preference("suggestion"),
560             virtualshelves                        => "" . C4::Context->preference("virtualshelves"),
561             OPACSerialIssueDisplayCount           => C4::Context->preference("OPACSerialIssueDisplayCount"),
562             OPACXSLTDetailsDisplay                => C4::Context->preference("OPACXSLTDetailsDisplay"),
563             OPACXSLTResultsDisplay                => C4::Context->preference("OPACXSLTResultsDisplay"),
564             SyndeticsClientCode                   => C4::Context->preference("SyndeticsClientCode"),
565             SyndeticsEnabled                      => C4::Context->preference("SyndeticsEnabled"),
566             SyndeticsCoverImages                  => C4::Context->preference("SyndeticsCoverImages"),
567             SyndeticsTOC                          => C4::Context->preference("SyndeticsTOC"),
568             SyndeticsSummary                      => C4::Context->preference("SyndeticsSummary"),
569             SyndeticsEditions                     => C4::Context->preference("SyndeticsEditions"),
570             SyndeticsExcerpt                      => C4::Context->preference("SyndeticsExcerpt"),
571             SyndeticsReviews                      => C4::Context->preference("SyndeticsReviews"),
572             SyndeticsAuthorNotes                  => C4::Context->preference("SyndeticsAuthorNotes"),
573             SyndeticsAwards                       => C4::Context->preference("SyndeticsAwards"),
574             SyndeticsSeries                       => C4::Context->preference("SyndeticsSeries"),
575             SyndeticsCoverImageSize               => C4::Context->preference("SyndeticsCoverImageSize"),
576             OPACLocalCoverImages                  => C4::Context->preference("OPACLocalCoverImages"),
577             PatronSelfRegistration                => C4::Context->preference("PatronSelfRegistration"),
578             PatronSelfRegistrationDefaultCategory => C4::Context->preference("PatronSelfRegistrationDefaultCategory"),
579             useDischarge                 => C4::Context->preference('useDischarge'),
580         );
581
582         $template->param( OpacPublic => '1' ) if ( $user || C4::Context->preference("OpacPublic") );
583     }
584
585     # Check if we were asked using parameters to force a specific language
586     if ( defined $in->{'query'}->param('language') ) {
587
588         # Extract the language, let C4::Languages::getlanguage choose
589         # what to do
590         my $language = C4::Languages::getlanguage( $in->{'query'} );
591         my $languagecookie = C4::Templates::getlanguagecookie( $in->{'query'}, $language );
592         if ( ref $cookie eq 'ARRAY' ) {
593             push @{$cookie}, $languagecookie;
594         } else {
595             $cookie = [ $cookie, $languagecookie ];
596         }
597     }
598
599     return ( $template, $borrowernumber, $cookie, $flags );
600 }
601
602 =head2 checkauth
603
604   ($userid, $cookie, $sessionID) = &checkauth($query, $noauth, $flagsrequired, $type);
605
606 Verifies that the user is authorized to run this script.  If
607 the user is authorized, a (userid, cookie, session-id, flags)
608 quadruple is returned.  If the user is not authorized but does
609 not have the required privilege (see $flagsrequired below), it
610 displays an error page and exits.  Otherwise, it displays the
611 login page and exits.
612
613 Note that C<&checkauth> will return if and only if the user
614 is authorized, so it should be called early on, before any
615 unfinished operations (e.g., if you've opened a file, then
616 C<&checkauth> won't close it for you).
617
618 C<$query> is the CGI object for the script calling C<&checkauth>.
619
620 The C<$noauth> argument is optional. If it is set, then no
621 authorization is required for the script.
622
623 C<&checkauth> fetches user and session information from C<$query> and
624 ensures that the user is authorized to run scripts that require
625 authorization.
626
627 The C<$flagsrequired> argument specifies the required privileges
628 the user must have if the username and password are correct.
629 It should be specified as a reference-to-hash; keys in the hash
630 should be the "flags" for the user, as specified in the Members
631 intranet module. Any key specified must correspond to a "flag"
632 in the userflags table. E.g., { circulate => 1 } would specify
633 that the user must have the "circulate" privilege in order to
634 proceed. To make sure that access control is correct, the
635 C<$flagsrequired> parameter must be specified correctly.
636
637 Koha also has a concept of sub-permissions, also known as
638 granular permissions.  This makes the value of each key
639 in the C<flagsrequired> hash take on an additional
640 meaning, i.e.,
641
642  1
643
644 The user must have access to all subfunctions of the module
645 specified by the hash key.
646
647  *
648
649 The user must have access to at least one subfunction of the module
650 specified by the hash key.
651
652  specific permission, e.g., 'export_catalog'
653
654 The user must have access to the specific subfunction list, which
655 must correspond to a row in the permissions table.
656
657 The C<$type> argument specifies whether the template should be
658 retrieved from the opac or intranet directory tree.  "opac" is
659 assumed if it is not specified; however, if C<$type> is specified,
660 "intranet" is assumed if it is not "opac".
661
662 If C<$query> does not have a valid session ID associated with it
663 (i.e., the user has not logged in) or if the session has expired,
664 C<&checkauth> presents the user with a login page (from the point of
665 view of the original script, C<&checkauth> does not return). Once the
666 user has authenticated, C<&checkauth> restarts the original script
667 (this time, C<&checkauth> returns).
668
669 The login page is provided using a HTML::Template, which is set in the
670 systempreferences table or at the top of this file. The variable C<$type>
671 selects which template to use, either the opac or the intranet
672 authentification template.
673
674 C<&checkauth> returns a user ID, a cookie, and a session ID. The
675 cookie should be sent back to the browser; it verifies that the user
676 has authenticated.
677
678 =cut
679
680 sub _version_check {
681     my $type  = shift;
682     my $query = shift;
683     my $version;
684
685     # If version syspref is unavailable, it means Koha is being installed,
686     # and so we must redirect to OPAC maintenance page or to the WebInstaller
687     # also, if OpacMaintenance is ON, OPAC should redirect to maintenance
688     if ( C4::Context->preference('OpacMaintenance') && $type eq 'opac' ) {
689         warn "OPAC Install required, redirecting to maintenance";
690         print $query->redirect("/cgi-bin/koha/maintenance.pl");
691         safe_exit;
692     }
693     unless ( $version = C4::Context->preference('Version') ) {    # assignment, not comparison
694         if ( $type ne 'opac' ) {
695             warn "Install required, redirecting to Installer";
696             print $query->redirect("/cgi-bin/koha/installer/install.pl");
697         } else {
698             warn "OPAC Install required, redirecting to maintenance";
699             print $query->redirect("/cgi-bin/koha/maintenance.pl");
700         }
701         safe_exit;
702     }
703
704     # check that database and koha version are the same
705     # there is no DB version, it's a fresh install,
706     # go to web installer
707     # there is a DB version, compare it to the code version
708     my $kohaversion = Koha::version();
709
710     # remove the 3 last . to have a Perl number
711     $kohaversion =~ s/(.*\..*)\.(.*)\.(.*)/$1$2$3/;
712     $debug and print STDERR "kohaversion : $kohaversion\n";
713     if ( $version < $kohaversion ) {
714         my $warning = "Database update needed, redirecting to %s. Database is $version and Koha is $kohaversion";
715         if ( $type ne 'opac' ) {
716             warn sprintf( $warning, 'Installer' );
717             print $query->redirect("/cgi-bin/koha/installer/install.pl?step=1&op=updatestructure");
718         } else {
719             warn sprintf( "OPAC: " . $warning, 'maintenance' );
720             print $query->redirect("/cgi-bin/koha/maintenance.pl");
721         }
722         safe_exit;
723     }
724 }
725
726 sub _session_log {
727     (@_) or return 0;
728     open my $fh, '>>', "/tmp/sessionlog" or warn "ERROR: Cannot append to /tmp/sessionlog";
729     printf $fh join( "\n", @_ );
730     close $fh;
731 }
732
733 sub _timeout_syspref {
734     my $timeout = C4::Context->preference('timeout') || 600;
735
736     # value in days, convert in seconds
737     if ( $timeout =~ /(\d+)[dD]/ ) {
738         $timeout = $1 * 86400;
739     }
740     return $timeout;
741 }
742
743 sub checkauth {
744     my $query = shift;
745     $debug and warn "Checking Auth";
746
747     # $authnotrequired will be set for scripts which will run without authentication
748     my $authnotrequired = shift;
749     my $flagsrequired   = shift;
750     my $type            = shift;
751     my $persona         = shift;
752     $type = 'opac' unless $type;
753
754     my $dbh     = C4::Context->dbh;
755     my $timeout = _timeout_syspref();
756
757     _version_check( $type, $query );
758
759     # state variables
760     my $loggedin = 0;
761     my %info;
762     my ( $userid, $cookie, $sessionID, $flags );
763     my $logout = $query->param('logout.x');
764
765     my $anon_search_history;
766
767     # This parameter is the name of the CAS server we want to authenticate against,
768     # when using authentication against multiple CAS servers, as configured in Auth_cas_servers.yaml
769     my $casparam = $query->param('cas');
770     my $q_userid = $query->param('userid') // '';
771
772     # Basic authentication is incompatible with the use of Shibboleth,
773     # as Shibboleth may return REMOTE_USER as a Shibboleth attribute,
774     # and it may not be the attribute we want to use to match the koha login.
775     #
776     # Also, do not consider an empty REMOTE_USER.
777     #
778     # Finally, after those tests, we can assume (although if it would be better with
779     # a syspref) that if we get a REMOTE_USER, that's from basic authentication,
780     # and we can affect it to $userid.
781     if ( !$shib and defined( $ENV{'REMOTE_USER'} ) and $ENV{'REMOTE_USER'} ne '' and $userid = $ENV{'REMOTE_USER'} ) {
782
783         # Using Basic Authentication, no cookies required
784         $cookie = $query->cookie(
785             -name     => 'CGISESSID',
786             -value    => '',
787             -expires  => '',
788             -HttpOnly => 1,
789         );
790         $loggedin = 1;
791     }
792     elsif ($persona) {
793
794         # we don't want to set a session because we are being called by a persona callback
795     }
796     elsif ( $sessionID = $query->cookie("CGISESSID") )
797     {    # assignment, not comparison
798         my $session = get_session($sessionID);
799         C4::Context->_new_userenv($sessionID);
800         my ( $ip, $lasttime, $sessiontype );
801         my $s_userid = '';
802         if ($session) {
803             $s_userid = $session->param('id') // '';
804             C4::Context->set_userenv(
805                 $session->param('number'),       $s_userid,
806                 $session->param('cardnumber'),   $session->param('firstname'),
807                 $session->param('surname'),      $session->param('branch'),
808                 $session->param('branchname'),   $session->param('flags'),
809                 $session->param('emailaddress'), $session->param('branchprinter'),
810                 $session->param('persona'),      $session->param('shibboleth')
811             );
812             C4::Context::set_shelves_userenv( 'bar', $session->param('barshelves') );
813             C4::Context::set_shelves_userenv( 'pub', $session->param('pubshelves') );
814             C4::Context::set_shelves_userenv( 'tot', $session->param('totshelves') );
815             $debug and printf STDERR "AUTH_SESSION: (%s)\t%s %s - %s\n", map { $session->param($_) } qw(cardnumber firstname surname branch);
816             $ip          = $session->param('ip');
817             $lasttime    = $session->param('lasttime');
818             $userid      = $s_userid;
819             $sessiontype = $session->param('sessiontype') || '';
820         }
821         if ( ( $query->param('koha_login_context') && ( $q_userid ne $s_userid ) )
822             || ( $cas && $query->param('ticket') && !C4::Context->userenv->{'id'} )
823             || ( $shib && $shib_login && !$logout && !C4::Context->userenv->{'id'} )
824         ) {
825
826             #if a user enters an id ne to the id in the current session, we need to log them in...
827             #first we need to clear the anonymous session...
828             $debug and warn "query id = $q_userid but session id = $s_userid";
829             $anon_search_history = $session->param('search_history');
830             $session->delete();
831             $session->flush;
832             C4::Context->_unset_userenv($sessionID);
833             $sessionID = undef;
834             $userid    = undef;
835         }
836         elsif ($logout) {
837
838             # voluntary logout the user
839             # check wether the user was using their shibboleth session or a local one
840             my $shibSuccess = C4::Context->userenv->{'shibboleth'};
841             $session->delete();
842             $session->flush;
843             C4::Context->_unset_userenv($sessionID);
844
845             #_session_log(sprintf "%20s from %16s logged out at %30s (manually).\n", $userid,$ip,(strftime "%c",localtime));
846             $sessionID = undef;
847             $userid    = undef;
848
849             if ($cas and $caslogout) {
850                 logout_cas($query, $type);
851             }
852
853             # If we are in a shibboleth session (shibboleth is enabled, a shibboleth match attribute is set and matches koha matchpoint)
854             if ( $shib and $shib_login and $shibSuccess and $type eq 'opac' ) {
855
856                 # (Note: $type eq 'opac' condition should be removed when shibboleth authentication for intranet will be implemented)
857                 logout_shib($query);
858             }
859         }
860         elsif ( !$lasttime || ( $lasttime < time() - $timeout ) ) {
861
862             # timed logout
863             $info{'timed_out'} = 1;
864             if ($session) {
865                 $session->delete();
866                 $session->flush;
867             }
868             C4::Context->_unset_userenv($sessionID);
869
870             #_session_log(sprintf "%20s from %16s logged out at %30s (inactivity).\n", $userid,$ip,(strftime "%c",localtime));
871             $userid    = undef;
872             $sessionID = undef;
873         }
874         elsif ( C4::Context->preference('SessionRestrictionByIP') && $ip ne $ENV{'REMOTE_ADDR'} ) {
875
876             # Different ip than originally logged in from
877             $info{'oldip'}        = $ip;
878             $info{'newip'}        = $ENV{'REMOTE_ADDR'};
879             $info{'different_ip'} = 1;
880             $session->delete();
881             $session->flush;
882             C4::Context->_unset_userenv($sessionID);
883
884             #_session_log(sprintf "%20s from %16s logged out at %30s (ip changed to %16s).\n", $userid,$ip,(strftime "%c",localtime), $info{'newip'});
885             $sessionID = undef;
886             $userid    = undef;
887         }
888         else {
889             $cookie = $query->cookie(
890                 -name     => 'CGISESSID',
891                 -value    => $session->id,
892                 -HttpOnly => 1
893             );
894             $session->param( 'lasttime', time() );
895             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...
896                 $flags = haspermission( $userid, $flagsrequired );
897                 if ($flags) {
898                     $loggedin = 1;
899                 } else {
900                     $info{'nopermission'} = 1;
901                 }
902             }
903         }
904     }
905     unless ( $userid || $sessionID ) {
906
907         #we initiate a session prior to checking for a username to allow for anonymous sessions...
908         my $session = get_session("") or die "Auth ERROR: Cannot get_session()";
909
910         # Save anonymous search history in new session so it can be retrieved
911         # by get_template_and_user to store it in user's search history after
912         # a successful login.
913         if ($anon_search_history) {
914             $session->param( 'search_history', $anon_search_history );
915         }
916
917         my $sessionID = $session->id;
918         C4::Context->_new_userenv($sessionID);
919         $cookie = $query->cookie(
920             -name     => 'CGISESSID',
921             -value    => $session->id,
922             -HttpOnly => 1
923         );
924         $userid = $q_userid;
925         my $pki_field = C4::Context->preference('AllowPKIAuth');
926         if ( !defined($pki_field) ) {
927             print STDERR "ERROR: Missing system preference AllowPKIAuth.\n";
928             $pki_field = 'None';
929         }
930         if ( ( $cas && $query->param('ticket') )
931             || $userid
932             || ( $shib && $shib_login )
933             || $pki_field ne 'None'
934             || $persona )
935         {
936             my $password    = $query->param('password');
937             my $shibSuccess = 0;
938
939             my ( $return, $cardnumber );
940
941             # If shib is enabled and we have a shib login, does the login match a valid koha user
942             if ( $shib && $shib_login && $type eq 'opac' ) {
943                 my $retuserid;
944
945                 # Do not pass password here, else shib will not be checked in checkpw.
946                 ( $return, $cardnumber, $retuserid ) = checkpw( $dbh, $userid, undef, $query );
947                 $userid      = $retuserid;
948                 $shibSuccess = $return;
949                 $info{'invalidShibLogin'} = 1 unless ($return);
950             }
951
952             # If shib login and match were successful, skip further login methods
953             unless ($shibSuccess) {
954                 if ( $cas && $query->param('ticket') ) {
955                     my $retuserid;
956                     ( $return, $cardnumber, $retuserid ) =
957                       checkpw( $dbh, $userid, $password, $query, $type );
958                     $userid = $retuserid;
959                     $info{'invalidCasLogin'} = 1 unless ($return);
960                 }
961
962                 elsif ($persona) {
963                     my $value = $persona;
964
965                     # If we're looking up the email, there's a chance that the person
966                     # doesn't have a userid. So if there is none, we pass along the
967                     # borrower number, and the bits of code that need to know the user
968                     # ID will have to be smart enough to handle that.
969                     require C4::Members;
970                     my @users_info = C4::Members::GetBorrowersWithEmail($value);
971                     if (@users_info) {
972
973                         # First the userid, then the borrowernum
974                         $value = $users_info[0][1] || $users_info[0][0];
975                     }
976                     else {
977                         undef $value;
978                     }
979                     $return = $value ? 1 : 0;
980                     $userid = $value;
981                 }
982
983                 elsif (
984                     ( $pki_field eq 'Common Name' && $ENV{'SSL_CLIENT_S_DN_CN'} )
985                     || ( $pki_field eq 'emailAddress'
986                         && $ENV{'SSL_CLIENT_S_DN_Email'} )
987                   )
988                 {
989                     my $value;
990                     if ( $pki_field eq 'Common Name' ) {
991                         $value = $ENV{'SSL_CLIENT_S_DN_CN'};
992                     }
993                     elsif ( $pki_field eq 'emailAddress' ) {
994                         $value = $ENV{'SSL_CLIENT_S_DN_Email'};
995
996                         # If we're looking up the email, there's a chance that the person
997                         # doesn't have a userid. So if there is none, we pass along the
998                         # borrower number, and the bits of code that need to know the user
999                         # ID will have to be smart enough to handle that.
1000                         require C4::Members;
1001                         my @users_info = C4::Members::GetBorrowersWithEmail($value);
1002                         if (@users_info) {
1003
1004                             # First the userid, then the borrowernum
1005                             $value = $users_info[0][1] || $users_info[0][0];
1006                         } else {
1007                             undef $value;
1008                         }
1009                     }
1010
1011                     $return = $value ? 1 : 0;
1012                     $userid = $value;
1013
1014                 }
1015                 else {
1016                     my $retuserid;
1017                     ( $return, $cardnumber, $retuserid ) =
1018                       checkpw( $dbh, $userid, $password, $query, $type );
1019                     $userid = $retuserid if ($retuserid);
1020                     $info{'invalid_username_or_password'} = 1 unless ($return);
1021                 }
1022             }
1023
1024             # $return: 1 = valid user, 2 = superlibrarian
1025             if ($return) {
1026
1027                 #_session_log(sprintf "%20s from %16s logged in  at %30s.\n", $userid,$ENV{'REMOTE_ADDR'},(strftime '%c', localtime));
1028                 if ( $flags = haspermission( $userid, $flagsrequired ) ) {
1029                     $loggedin = 1;
1030                 }
1031                 else {
1032                     $info{'nopermission'} = 1;
1033                     C4::Context->_unset_userenv($sessionID);
1034                 }
1035                 my ( $borrowernumber, $firstname, $surname, $userflags,
1036                     $branchcode, $branchname, $branchprinter, $emailaddress );
1037
1038                 if ( $return == 1 ) {
1039                     my $select = "
1040                     SELECT borrowernumber, firstname, surname, flags, borrowers.branchcode,
1041                     branches.branchname    as branchname,
1042                     branches.branchprinter as branchprinter,
1043                     email
1044                     FROM borrowers
1045                     LEFT JOIN branches on borrowers.branchcode=branches.branchcode
1046                     ";
1047                     my $sth = $dbh->prepare("$select where userid=?");
1048                     $sth->execute($userid);
1049                     unless ( $sth->rows ) {
1050                         $debug and print STDERR "AUTH_1: no rows for userid='$userid'\n";
1051                         $sth = $dbh->prepare("$select where cardnumber=?");
1052                         $sth->execute($cardnumber);
1053
1054                         unless ( $sth->rows ) {
1055                             $debug and print STDERR "AUTH_2a: no rows for cardnumber='$cardnumber'\n";
1056                             $sth->execute($userid);
1057                             unless ( $sth->rows ) {
1058                                 $debug and print STDERR "AUTH_2b: no rows for userid='$userid' AS cardnumber\n";
1059                             }
1060                         }
1061                     }
1062                     if ( $sth->rows ) {
1063                         ( $borrowernumber, $firstname, $surname, $userflags,
1064                             $branchcode, $branchname, $branchprinter, $emailaddress ) = $sth->fetchrow;
1065                         $debug and print STDERR "AUTH_3 results: " .
1066                           "$cardnumber,$borrowernumber,$userid,$firstname,$surname,$userflags,$branchcode,$emailaddress\n";
1067                     } else {
1068                         print STDERR "AUTH_3: no results for userid='$userid', cardnumber='$cardnumber'.\n";
1069                     }
1070
1071                     # launch a sequence to check if we have a ip for the branch, i
1072                     # if we have one we replace the branchcode of the userenv by the branch bound in the ip.
1073
1074                     my $ip = $ENV{'REMOTE_ADDR'};
1075
1076                     # if they specify at login, use that
1077                     if ( $query->param('branch') ) {
1078                         $branchcode = $query->param('branch');
1079                         $branchname = GetBranchName($branchcode);
1080                     }
1081                     my $branches = GetBranches();
1082                     if ( C4::Context->boolean_preference('IndependentBranches') && C4::Context->boolean_preference('Autolocation') ) {
1083
1084                         # we have to check they are coming from the right ip range
1085                         my $domain = $branches->{$branchcode}->{'branchip'};
1086                         if ( $ip !~ /^$domain/ ) {
1087                             $loggedin = 0;
1088                             $info{'wrongip'} = 1;
1089                         }
1090                     }
1091
1092                     my @branchesloop;
1093                     foreach my $br ( keys %$branches ) {
1094
1095                         #     now we work with the treatment of ip
1096                         my $domain = $branches->{$br}->{'branchip'};
1097                         if ( $domain && $ip =~ /^$domain/ ) {
1098                             $branchcode = $branches->{$br}->{'branchcode'};
1099
1100                             # new op dev : add the branchprinter and branchname in the cookie
1101                             $branchprinter = $branches->{$br}->{'branchprinter'};
1102                             $branchname    = $branches->{$br}->{'branchname'};
1103                         }
1104                     }
1105                     $session->param( 'number',       $borrowernumber );
1106                     $session->param( 'id',           $userid );
1107                     $session->param( 'cardnumber',   $cardnumber );
1108                     $session->param( 'firstname',    $firstname );
1109                     $session->param( 'surname',      $surname );
1110                     $session->param( 'branch',       $branchcode );
1111                     $session->param( 'branchname',   $branchname );
1112                     $session->param( 'flags',        $userflags );
1113                     $session->param( 'emailaddress', $emailaddress );
1114                     $session->param( 'ip',           $session->remote_addr() );
1115                     $session->param( 'lasttime',     time() );
1116                     $session->param( 'shibboleth',   $shibSuccess );
1117                     $debug and printf STDERR "AUTH_4: (%s)\t%s %s - %s\n", map { $session->param($_) } qw(cardnumber firstname surname branch);
1118                 }
1119                 elsif ( $return == 2 ) {
1120
1121                     #We suppose the user is the superlibrarian
1122                     $borrowernumber = 0;
1123                     $session->param( 'number',       0 );
1124                     $session->param( 'id',           C4::Context->config('user') );
1125                     $session->param( 'cardnumber',   C4::Context->config('user') );
1126                     $session->param( 'firstname',    C4::Context->config('user') );
1127                     $session->param( 'surname',      C4::Context->config('user') );
1128                     $session->param( 'branch',       'NO_LIBRARY_SET' );
1129                     $session->param( 'branchname',   'NO_LIBRARY_SET' );
1130                     $session->param( 'flags',        1 );
1131                     $session->param( 'emailaddress', C4::Context->preference('KohaAdminEmailAddress') );
1132                     $session->param( 'ip',           $session->remote_addr() );
1133                     $session->param( 'lasttime',     time() );
1134                 }
1135                 if ($persona) {
1136                     $session->param( 'persona', 1 );
1137                 }
1138                 C4::Context->set_userenv(
1139                     $session->param('number'),       $session->param('id'),
1140                     $session->param('cardnumber'),   $session->param('firstname'),
1141                     $session->param('surname'),      $session->param('branch'),
1142                     $session->param('branchname'),   $session->param('flags'),
1143                     $session->param('emailaddress'), $session->param('branchprinter'),
1144                     $session->param('persona'),      $session->param('shibboleth')
1145                 );
1146
1147             }
1148             # $return: 0 = invalid user
1149             # reset to anonymous session
1150             else {
1151                 $debug and warn "Login failed, resetting anonymous session...";
1152                 if ($userid) {
1153                     $info{'invalid_username_or_password'} = 1;
1154                     C4::Context->_unset_userenv($sessionID);
1155                 }
1156                 $session->param( 'lasttime', time() );
1157                 $session->param( 'ip',       $session->remote_addr() );
1158                 $session->param( 'sessiontype', 'anon' );
1159             }
1160         }    # END if ( $userid    = $query->param('userid') )
1161         elsif ( $type eq "opac" ) {
1162
1163             # if we are here this is an anonymous session; add public lists to it and a few other items...
1164             # anonymous sessions are created only for the OPAC
1165             $debug and warn "Initiating an anonymous session...";
1166
1167             # setting a couple of other session vars...
1168             $session->param( 'ip',          $session->remote_addr() );
1169             $session->param( 'lasttime',    time() );
1170             $session->param( 'sessiontype', 'anon' );
1171         }
1172     }    # END unless ($userid)
1173
1174     # finished authentification, now respond
1175     if ( $loggedin || $authnotrequired )
1176     {
1177         # successful login
1178         unless ($cookie) {
1179             $cookie = $query->cookie(
1180                 -name     => 'CGISESSID',
1181                 -value    => '',
1182                 -HttpOnly => 1
1183             );
1184         }
1185         return ( $userid, $cookie, $sessionID, $flags );
1186     }
1187
1188     #
1189     #
1190     # AUTH rejected, show the login/password template, after checking the DB.
1191     #
1192     #
1193
1194     # get the inputs from the incoming query
1195     my @inputs = ();
1196     foreach my $name ( param $query) {
1197         (next) if ( $name eq 'userid' || $name eq 'password' || $name eq 'ticket' );
1198         my $value = $query->param($name);
1199         push @inputs, { name => $name, value => $value };
1200     }
1201
1202     my $LibraryNameTitle = C4::Context->preference("LibraryName");
1203     $LibraryNameTitle =~ s/<(?:\/?)(?:br|p)\s*(?:\/?)>/ /sgi;
1204     $LibraryNameTitle =~ s/<(?:[^<>'"]|'(?:[^']*)'|"(?:[^"]*)")*>//sg;
1205
1206     my $template_name = ( $type eq 'opac' ) ? 'opac-auth.tt' : 'auth.tt';
1207     my $template = C4::Templates::gettemplate( $template_name, $type, $query );
1208     $template->param(
1209         branchloop                            => GetBranchesLoop(),
1210         OpacAdditionalStylesheet                   => C4::Context->preference("OpacAdditionalStylesheet"),
1211         opaclayoutstylesheet                  => C4::Context->preference("opaclayoutstylesheet"),
1212         login                                 => 1,
1213         INPUTS                                => \@inputs,
1214         script_name                           => get_script_name(),
1215         casAuthentication                     => C4::Context->preference("casAuthentication"),
1216         shibbolethAuthentication              => $shib,
1217         SessionRestrictionByIP                => C4::Context->preference("SessionRestrictionByIP"),
1218         suggestion                            => C4::Context->preference("suggestion"),
1219         virtualshelves                        => C4::Context->preference("virtualshelves"),
1220         LibraryName                           => "" . C4::Context->preference("LibraryName"),
1221         LibraryNameTitle                      => "" . $LibraryNameTitle,
1222         opacuserlogin                         => C4::Context->preference("opacuserlogin"),
1223         OpacNav                               => C4::Context->preference("OpacNav"),
1224         OpacNavRight                          => C4::Context->preference("OpacNavRight"),
1225         OpacNavBottom                         => C4::Context->preference("OpacNavBottom"),
1226         opaccredits                           => C4::Context->preference("opaccredits"),
1227         OpacFavicon                           => C4::Context->preference("OpacFavicon"),
1228         opacreadinghistory                    => C4::Context->preference("opacreadinghistory"),
1229         opaclanguagesdisplay                  => C4::Context->preference("opaclanguagesdisplay"),
1230         OPACUserJS                            => C4::Context->preference("OPACUserJS"),
1231         opacbookbag                           => "" . C4::Context->preference("opacbookbag"),
1232         OpacCloud                             => C4::Context->preference("OpacCloud"),
1233         OpacTopissue                          => C4::Context->preference("OpacTopissue"),
1234         OpacAuthorities                       => C4::Context->preference("OpacAuthorities"),
1235         OpacBrowser                           => C4::Context->preference("OpacBrowser"),
1236         opacheader                            => C4::Context->preference("opacheader"),
1237         TagsEnabled                           => C4::Context->preference("TagsEnabled"),
1238         OPACUserCSS                           => C4::Context->preference("OPACUserCSS"),
1239         intranetcolorstylesheet               => C4::Context->preference("intranetcolorstylesheet"),
1240         intranetstylesheet                    => C4::Context->preference("intranetstylesheet"),
1241         intranetbookbag                       => C4::Context->preference("intranetbookbag"),
1242         IntranetNav                           => C4::Context->preference("IntranetNav"),
1243         IntranetFavicon                       => C4::Context->preference("IntranetFavicon"),
1244         IntranetUserCSS                       => C4::Context->preference("IntranetUserCSS"),
1245         IntranetUserJS                        => C4::Context->preference("IntranetUserJS"),
1246         IndependentBranches                   => C4::Context->preference("IndependentBranches"),
1247         AutoLocation                          => C4::Context->preference("AutoLocation"),
1248         wrongip                               => $info{'wrongip'},
1249         PatronSelfRegistration                => C4::Context->preference("PatronSelfRegistration"),
1250         PatronSelfRegistrationDefaultCategory => C4::Context->preference("PatronSelfRegistrationDefaultCategory"),
1251         persona                               => C4::Context->preference("Persona"),
1252         opac_css_override                     => $ENV{'OPAC_CSS_OVERRIDE'},
1253     );
1254
1255     $template->param( SCO_login => 1 ) if ( $query->param('sco_user_login') );
1256     $template->param( OpacPublic => C4::Context->preference("OpacPublic") );
1257     $template->param( loginprompt => 1 ) unless $info{'nopermission'};
1258
1259     if ( $type eq 'opac' ) {
1260         require Koha::Virtualshelves;
1261         my $some_public_shelves = Koha::Virtualshelves->get_some_shelves(
1262             {
1263                 category       => 2,
1264             }
1265         );
1266         $template->param(
1267             some_public_shelves  => $some_public_shelves,
1268         );
1269     }
1270
1271     if ($cas) {
1272
1273         # Is authentication against multiple CAS servers enabled?
1274         if ( C4::Auth_with_cas::multipleAuth && !$casparam ) {
1275             my $casservers = C4::Auth_with_cas::getMultipleAuth();
1276             my @tmplservers;
1277             foreach my $key ( keys %$casservers ) {
1278                 push @tmplservers, { name => $key, value => login_cas_url( $query, $key, $type ) . "?cas=$key" };
1279             }
1280             $template->param(
1281                 casServersLoop => \@tmplservers
1282             );
1283         } else {
1284             $template->param(
1285                 casServerUrl => login_cas_url($query, undef, $type),
1286             );
1287         }
1288
1289         $template->param(
1290             invalidCasLogin => $info{'invalidCasLogin'}
1291         );
1292     }
1293
1294     if ($shib) {
1295         $template->param(
1296             shibbolethAuthentication => $shib,
1297             shibbolethLoginUrl       => login_shib_url($query),
1298         );
1299     }
1300
1301     if (C4::Context->preference('GoogleOpenIDConnect')) {
1302         if ($query->param("OpenIDConnectFailed")) {
1303             my $reason = $query->param('OpenIDConnectFailed');
1304             $template->param(invalidGoogleOpenIDConnectLogin => $reason);
1305         }
1306     }
1307
1308     $template->param(
1309         LibraryName => C4::Context->preference("LibraryName"),
1310     );
1311     $template->param(%info);
1312
1313     #    $cookie = $query->cookie(CGISESSID => $session->id
1314     #   );
1315     print $query->header(
1316         {   type              => 'text/html',
1317             charset           => 'utf-8',
1318             cookie            => $cookie,
1319             'X-Frame-Options' => 'SAMEORIGIN'
1320         }
1321       ),
1322       $template->output;
1323     safe_exit;
1324 }
1325
1326 =head2 check_api_auth
1327
1328   ($status, $cookie, $sessionId) = check_api_auth($query, $userflags);
1329
1330 Given a CGI query containing the parameters 'userid' and 'password' and/or a session
1331 cookie, determine if the user has the privileges specified by C<$userflags>.
1332
1333 C<check_api_auth> is is meant for authenticating users of web services, and
1334 consequently will always return and will not attempt to redirect the user
1335 agent.
1336
1337 If a valid session cookie is already present, check_api_auth will return a status
1338 of "ok", the cookie, and the Koha session ID.
1339
1340 If no session cookie is present, check_api_auth will check the 'userid' and 'password
1341 parameters and create a session cookie and Koha session if the supplied credentials
1342 are OK.
1343
1344 Possible return values in C<$status> are:
1345
1346 =over
1347
1348 =item "ok" -- user authenticated; C<$cookie> and C<$sessionid> have valid values.
1349
1350 =item "failed" -- credentials are not correct; C<$cookie> and C<$sessionid> are undef
1351
1352 =item "maintenance" -- DB is in maintenance mode; no login possible at the moment
1353
1354 =item "expired -- session cookie has expired; API user should resubmit userid and password
1355
1356 =back
1357
1358 =cut
1359
1360 sub check_api_auth {
1361     my $query         = shift;
1362     my $flagsrequired = shift;
1363
1364     my $dbh     = C4::Context->dbh;
1365     my $timeout = _timeout_syspref();
1366
1367     unless ( C4::Context->preference('Version') ) {
1368
1369         # database has not been installed yet
1370         return ( "maintenance", undef, undef );
1371     }
1372     my $kohaversion = Koha::version();
1373     $kohaversion =~ s/(.*\..*)\.(.*)\.(.*)/$1$2$3/;
1374     if ( C4::Context->preference('Version') < $kohaversion ) {
1375
1376         # database in need of version update; assume that
1377         # no API should be called while databsae is in
1378         # this condition.
1379         return ( "maintenance", undef, undef );
1380     }
1381
1382     # FIXME -- most of what follows is a copy-and-paste
1383     # of code from checkauth.  There is an obvious need
1384     # for refactoring to separate the various parts of
1385     # the authentication code, but as of 2007-11-19 this
1386     # is deferred so as to not introduce bugs into the
1387     # regular authentication code for Koha 3.0.
1388
1389     # see if we have a valid session cookie already
1390     # however, if a userid parameter is present (i.e., from
1391     # a form submission, assume that any current cookie
1392     # is to be ignored
1393     my $sessionID = undef;
1394     unless ( $query->param('userid') ) {
1395         $sessionID = $query->cookie("CGISESSID");
1396     }
1397     if ( $sessionID && not( $cas && $query->param('PT') ) ) {
1398         my $session = get_session($sessionID);
1399         C4::Context->_new_userenv($sessionID);
1400         if ($session) {
1401             C4::Context->set_userenv(
1402                 $session->param('number'),       $session->param('id'),
1403                 $session->param('cardnumber'),   $session->param('firstname'),
1404                 $session->param('surname'),      $session->param('branch'),
1405                 $session->param('branchname'),   $session->param('flags'),
1406                 $session->param('emailaddress'), $session->param('branchprinter')
1407             );
1408
1409             my $ip       = $session->param('ip');
1410             my $lasttime = $session->param('lasttime');
1411             my $userid   = $session->param('id');
1412             if ( $lasttime < time() - $timeout ) {
1413
1414                 # time out
1415                 $session->delete();
1416                 $session->flush;
1417                 C4::Context->_unset_userenv($sessionID);
1418                 $userid    = undef;
1419                 $sessionID = undef;
1420                 return ( "expired", undef, undef );
1421             } elsif ( C4::Context->preference('SessionRestrictionByIP') && $ip ne $ENV{'REMOTE_ADDR'} ) {
1422
1423                 # IP address changed
1424                 $session->delete();
1425                 $session->flush;
1426                 C4::Context->_unset_userenv($sessionID);
1427                 $userid    = undef;
1428                 $sessionID = undef;
1429                 return ( "expired", undef, undef );
1430             } else {
1431                 my $cookie = $query->cookie(
1432                     -name     => 'CGISESSID',
1433                     -value    => $session->id,
1434                     -HttpOnly => 1,
1435                 );
1436                 $session->param( 'lasttime', time() );
1437                 my $flags = haspermission( $userid, $flagsrequired );
1438                 if ($flags) {
1439                     return ( "ok", $cookie, $sessionID );
1440                 } else {
1441                     $session->delete();
1442                     $session->flush;
1443                     C4::Context->_unset_userenv($sessionID);
1444                     $userid    = undef;
1445                     $sessionID = undef;
1446                     return ( "failed", undef, undef );
1447                 }
1448             }
1449         } else {
1450             return ( "expired", undef, undef );
1451         }
1452     } else {
1453
1454         # new login
1455         my $userid   = $query->param('userid');
1456         my $password = $query->param('password');
1457         my ( $return, $cardnumber );
1458
1459         # Proxy CAS auth
1460         if ( $cas && $query->param('PT') ) {
1461             my $retuserid;
1462             $debug and print STDERR "## check_api_auth - checking CAS\n";
1463
1464             # In case of a CAS authentication, we use the ticket instead of the password
1465             my $PT = $query->param('PT');
1466             ( $return, $cardnumber, $userid ) = check_api_auth_cas( $dbh, $PT, $query );    # EXTERNAL AUTH
1467         } else {
1468
1469             # User / password auth
1470             unless ( $userid and $password ) {
1471
1472                 # caller did something wrong, fail the authenticateion
1473                 return ( "failed", undef, undef );
1474             }
1475             ( $return, $cardnumber ) = checkpw( $dbh, $userid, $password, $query );
1476         }
1477
1478         if ( $return and haspermission( $userid, $flagsrequired ) ) {
1479             my $session = get_session("");
1480             return ( "failed", undef, undef ) unless $session;
1481
1482             my $sessionID = $session->id;
1483             C4::Context->_new_userenv($sessionID);
1484             my $cookie = $query->cookie(
1485                 -name     => 'CGISESSID',
1486                 -value    => $sessionID,
1487                 -HttpOnly => 1,
1488             );
1489             if ( $return == 1 ) {
1490                 my (
1491                     $borrowernumber, $firstname,  $surname,
1492                     $userflags,      $branchcode, $branchname,
1493                     $branchprinter,  $emailaddress
1494                 );
1495                 my $sth =
1496                   $dbh->prepare(
1497 "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=?"
1498                   );
1499                 $sth->execute($userid);
1500                 (
1501                     $borrowernumber, $firstname,  $surname,
1502                     $userflags,      $branchcode, $branchname,
1503                     $branchprinter,  $emailaddress
1504                 ) = $sth->fetchrow if ( $sth->rows );
1505
1506                 unless ( $sth->rows ) {
1507                     my $sth = $dbh->prepare(
1508 "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=?"
1509                     );
1510                     $sth->execute($cardnumber);
1511                     (
1512                         $borrowernumber, $firstname,  $surname,
1513                         $userflags,      $branchcode, $branchname,
1514                         $branchprinter,  $emailaddress
1515                     ) = $sth->fetchrow if ( $sth->rows );
1516
1517                     unless ( $sth->rows ) {
1518                         $sth->execute($userid);
1519                         (
1520                             $borrowernumber, $firstname,  $surname,       $userflags,
1521                             $branchcode,     $branchname, $branchprinter, $emailaddress
1522                         ) = $sth->fetchrow if ( $sth->rows );
1523                     }
1524                 }
1525
1526                 my $ip = $ENV{'REMOTE_ADDR'};
1527
1528                 # if they specify at login, use that
1529                 if ( $query->param('branch') ) {
1530                     $branchcode = $query->param('branch');
1531                     $branchname = GetBranchName($branchcode);
1532                 }
1533                 my $branches = GetBranches();
1534                 my @branchesloop;
1535                 foreach my $br ( keys %$branches ) {
1536
1537                     #     now we work with the treatment of ip
1538                     my $domain = $branches->{$br}->{'branchip'};
1539                     if ( $domain && $ip =~ /^$domain/ ) {
1540                         $branchcode = $branches->{$br}->{'branchcode'};
1541
1542                         # new op dev : add the branchprinter and branchname in the cookie
1543                         $branchprinter = $branches->{$br}->{'branchprinter'};
1544                         $branchname    = $branches->{$br}->{'branchname'};
1545                     }
1546                 }
1547                 $session->param( 'number',       $borrowernumber );
1548                 $session->param( 'id',           $userid );
1549                 $session->param( 'cardnumber',   $cardnumber );
1550                 $session->param( 'firstname',    $firstname );
1551                 $session->param( 'surname',      $surname );
1552                 $session->param( 'branch',       $branchcode );
1553                 $session->param( 'branchname',   $branchname );
1554                 $session->param( 'flags',        $userflags );
1555                 $session->param( 'emailaddress', $emailaddress );
1556                 $session->param( 'ip',           $session->remote_addr() );
1557                 $session->param( 'lasttime',     time() );
1558             } elsif ( $return == 2 ) {
1559
1560                 #We suppose the user is the superlibrarian
1561                 $session->param( 'number',       0 );
1562                 $session->param( 'id',           C4::Context->config('user') );
1563                 $session->param( 'cardnumber',   C4::Context->config('user') );
1564                 $session->param( 'firstname',    C4::Context->config('user') );
1565                 $session->param( 'surname',      C4::Context->config('user') );
1566                 $session->param( 'branch',       'NO_LIBRARY_SET' );
1567                 $session->param( 'branchname',   'NO_LIBRARY_SET' );
1568                 $session->param( 'flags',        1 );
1569                 $session->param( 'emailaddress', C4::Context->preference('KohaAdminEmailAddress') );
1570                 $session->param( 'ip',           $session->remote_addr() );
1571                 $session->param( 'lasttime',     time() );
1572             }
1573             C4::Context->set_userenv(
1574                 $session->param('number'),       $session->param('id'),
1575                 $session->param('cardnumber'),   $session->param('firstname'),
1576                 $session->param('surname'),      $session->param('branch'),
1577                 $session->param('branchname'),   $session->param('flags'),
1578                 $session->param('emailaddress'), $session->param('branchprinter')
1579             );
1580             return ( "ok", $cookie, $sessionID );
1581         } else {
1582             return ( "failed", undef, undef );
1583         }
1584     }
1585 }
1586
1587 =head2 check_cookie_auth
1588
1589   ($status, $sessionId) = check_api_auth($cookie, $userflags);
1590
1591 Given a CGISESSID cookie set during a previous login to Koha, determine
1592 if the user has the privileges specified by C<$userflags>.
1593
1594 C<check_cookie_auth> is meant for authenticating special services
1595 such as tools/upload-file.pl that are invoked by other pages that
1596 have been authenticated in the usual way.
1597
1598 Possible return values in C<$status> are:
1599
1600 =over
1601
1602 =item "ok" -- user authenticated; C<$sessionID> have valid values.
1603
1604 =item "failed" -- credentials are not correct; C<$sessionid> are undef
1605
1606 =item "maintenance" -- DB is in maintenance mode; no login possible at the moment
1607
1608 =item "expired -- session cookie has expired; API user should resubmit userid and password
1609
1610 =back
1611
1612 =cut
1613
1614 sub check_cookie_auth {
1615     my $cookie        = shift;
1616     my $flagsrequired = shift;
1617     my $params        = shift;
1618
1619     my $remote_addr = $params->{remote_addr} || $ENV{REMOTE_ADDR};
1620     my $dbh     = C4::Context->dbh;
1621     my $timeout = _timeout_syspref();
1622
1623     unless ( C4::Context->preference('Version') ) {
1624
1625         # database has not been installed yet
1626         return ( "maintenance", undef );
1627     }
1628     my $kohaversion = Koha::version();
1629     $kohaversion =~ s/(.*\..*)\.(.*)\.(.*)/$1$2$3/;
1630     if ( C4::Context->preference('Version') < $kohaversion ) {
1631
1632         # database in need of version update; assume that
1633         # no API should be called while databsae is in
1634         # this condition.
1635         return ( "maintenance", undef );
1636     }
1637
1638     # FIXME -- most of what follows is a copy-and-paste
1639     # of code from checkauth.  There is an obvious need
1640     # for refactoring to separate the various parts of
1641     # the authentication code, but as of 2007-11-23 this
1642     # is deferred so as to not introduce bugs into the
1643     # regular authentication code for Koha 3.0.
1644
1645     # see if we have a valid session cookie already
1646     # however, if a userid parameter is present (i.e., from
1647     # a form submission, assume that any current cookie
1648     # is to be ignored
1649     unless ( defined $cookie and $cookie ) {
1650         return ( "failed", undef );
1651     }
1652     my $sessionID = $cookie;
1653     my $session   = get_session($sessionID);
1654     C4::Context->_new_userenv($sessionID);
1655     if ($session) {
1656         C4::Context->set_userenv(
1657             $session->param('number'),       $session->param('id'),
1658             $session->param('cardnumber'),   $session->param('firstname'),
1659             $session->param('surname'),      $session->param('branch'),
1660             $session->param('branchname'),   $session->param('flags'),
1661             $session->param('emailaddress'), $session->param('branchprinter')
1662         );
1663
1664         my $ip       = $session->param('ip');
1665         my $lasttime = $session->param('lasttime');
1666         my $userid   = $session->param('id');
1667         if ( $lasttime < time() - $timeout ) {
1668
1669             # time out
1670             $session->delete();
1671             $session->flush;
1672             C4::Context->_unset_userenv($sessionID);
1673             $userid    = undef;
1674             $sessionID = undef;
1675             return ("expired", undef);
1676         } elsif ( C4::Context->preference('SessionRestrictionByIP') && $ip ne $remote_addr ) {
1677
1678             # IP address changed
1679             $session->delete();
1680             $session->flush;
1681             C4::Context->_unset_userenv($sessionID);
1682             $userid    = undef;
1683             $sessionID = undef;
1684             return ( "expired", undef );
1685         } else {
1686             $session->param( 'lasttime', time() );
1687             my $flags = haspermission( $userid, $flagsrequired );
1688             if ($flags) {
1689                 return ( "ok", $sessionID );
1690             } else {
1691                 $session->delete();
1692                 $session->flush;
1693                 C4::Context->_unset_userenv($sessionID);
1694                 $userid    = undef;
1695                 $sessionID = undef;
1696                 return ( "failed", undef );
1697             }
1698         }
1699     } else {
1700         return ( "expired", undef );
1701     }
1702 }
1703
1704 =head2 get_session
1705
1706   use CGI::Session;
1707   my $session = get_session($sessionID);
1708
1709 Given a session ID, retrieve the CGI::Session object used to store
1710 the session's state.  The session object can be used to store
1711 data that needs to be accessed by different scripts during a
1712 user's session.
1713
1714 If the C<$sessionID> parameter is an empty string, a new session
1715 will be created.
1716
1717 =cut
1718
1719 sub get_session {
1720     my $sessionID      = shift;
1721     my $storage_method = C4::Context->preference('SessionStorage');
1722     my $dbh            = C4::Context->dbh;
1723     my $session;
1724     if ( $storage_method eq 'mysql' ) {
1725         $session = new CGI::Session( "driver:MySQL;serializer:yaml;id:md5", $sessionID, { Handle => $dbh } );
1726     }
1727     elsif ( $storage_method eq 'Pg' ) {
1728         $session = new CGI::Session( "driver:PostgreSQL;serializer:yaml;id:md5", $sessionID, { Handle => $dbh } );
1729     }
1730     elsif ( $storage_method eq 'memcached' && C4::Context->ismemcached ) {
1731         $session = new CGI::Session( "driver:memcached;serializer:yaml;id:md5", $sessionID, { Memcached => C4::Context->memcached } );
1732     }
1733     else {
1734         # catch all defaults to tmp should work on all systems
1735         my $dir = File::Spec->tmpdir;
1736         my $instance = C4::Context->config( 'database' ); #actually for packages not exactly the instance name, but generally safer to leave it as it is
1737         $session = new CGI::Session( "driver:File;serializer:yaml;id:md5", $sessionID, { Directory => "$dir/cgisess_$instance" } );
1738     }
1739     return $session;
1740 }
1741
1742
1743 # FIXME no_set_userenv may be replaced with force_branchcode_for_userenv
1744 # (or something similar)
1745 # Currently it's only passed from C4::SIP::ILS::Patron::check_password, but
1746 # not having a userenv defined could cause a crash.
1747 sub checkpw {
1748     my ( $dbh, $userid, $password, $query, $type, $no_set_userenv ) = @_;
1749     $type = 'opac' unless $type;
1750     if ($ldap) {
1751         $debug and print STDERR "## checkpw - checking LDAP\n";
1752         my ( $retval, $retcard, $retuserid ) = checkpw_ldap(@_);    # EXTERNAL AUTH
1753         return 0 if $retval == -1;                                  # Incorrect password for LDAP login attempt
1754         ($retval) and return ( $retval, $retcard, $retuserid );
1755     }
1756
1757     if ( $cas && $query && $query->param('ticket') ) {
1758         $debug and print STDERR "## checkpw - checking CAS\n";
1759
1760         # In case of a CAS authentication, we use the ticket instead of the password
1761         my $ticket = $query->param('ticket');
1762         $query->delete('ticket');                                   # remove ticket to come back to original URL
1763         my ( $retval, $retcard, $retuserid ) = checkpw_cas( $dbh, $ticket, $query, $type );    # EXTERNAL AUTH
1764         ($retval) and return ( $retval, $retcard, $retuserid );
1765         return 0;
1766     }
1767
1768     # If we are in a shibboleth session (shibboleth is enabled, and a shibboleth match attribute is present)
1769     # Check for password to asertain whether we want to be testing against shibboleth or another method this
1770     # time around.
1771     if ( $shib && $shib_login && !$password ) {
1772
1773         $debug and print STDERR "## checkpw - checking Shibboleth\n";
1774
1775         # In case of a Shibboleth authentication, we expect a shibboleth user attribute
1776         # (defined under shibboleth mapping in koha-conf.xml) to contain the login of the
1777         # shibboleth-authenticated user
1778
1779         # Then, we check if it matches a valid koha user
1780         if ($shib_login) {
1781             my ( $retval, $retcard, $retuserid ) = C4::Auth_with_shibboleth::checkpw_shib($shib_login);    # EXTERNAL AUTH
1782             ($retval) and return ( $retval, $retcard, $retuserid );
1783             return 0;
1784         }
1785     }
1786
1787     # INTERNAL AUTH
1788     return checkpw_internal( $dbh, $userid, $password, $no_set_userenv);
1789 }
1790
1791 sub checkpw_internal {
1792     my ( $dbh, $userid, $password, $no_set_userenv ) = @_;
1793
1794     $password = Encode::encode( 'UTF-8', $password )
1795       if Encode::is_utf8($password);
1796
1797     if ( $userid && $userid eq C4::Context->config('user') ) {
1798         if ( $password && $password eq C4::Context->config('pass') ) {
1799
1800             # Koha superuser account
1801             #     C4::Context->set_userenv(0,0,C4::Context->config('user'),C4::Context->config('user'),C4::Context->config('user'),"",1);
1802             return 2;
1803         }
1804         else {
1805             return 0;
1806         }
1807     }
1808
1809     my $sth =
1810       $dbh->prepare(
1811         "select password,cardnumber,borrowernumber,userid,firstname,surname,borrowers.branchcode,branches.branchname,flags from borrowers join branches on borrowers.branchcode=branches.branchcode where userid=?"
1812       );
1813     $sth->execute($userid);
1814     if ( $sth->rows ) {
1815         my ( $stored_hash, $cardnumber, $borrowernumber, $userid, $firstname,
1816             $surname, $branchcode, $branchname, $flags )
1817           = $sth->fetchrow;
1818
1819         if ( checkpw_hash( $password, $stored_hash ) ) {
1820
1821             C4::Context->set_userenv( "$borrowernumber", $userid, $cardnumber,
1822                 $firstname, $surname, $branchcode, $branchname, $flags ) unless $no_set_userenv;
1823             return 1, $cardnumber, $userid;
1824         }
1825     }
1826     $sth =
1827       $dbh->prepare(
1828         "select password,cardnumber,borrowernumber,userid,firstname,surname,borrowers.branchcode,branches.branchname,flags from borrowers join branches on borrowers.branchcode=branches.branchcode where cardnumber=?"
1829       );
1830     $sth->execute($userid);
1831     if ( $sth->rows ) {
1832         my ( $stored_hash, $cardnumber, $borrowernumber, $userid, $firstname,
1833             $surname, $branchcode, $branchname, $flags )
1834           = $sth->fetchrow;
1835
1836         if ( checkpw_hash( $password, $stored_hash ) ) {
1837
1838             C4::Context->set_userenv( $borrowernumber, $userid, $cardnumber,
1839                 $firstname, $surname, $branchcode, $branchname, $flags ) unless $no_set_userenv;
1840             return 1, $cardnumber, $userid;
1841         }
1842     }
1843     if ( $userid && $userid eq 'demo'
1844         && "$password" eq 'demo'
1845         && C4::Context->config('demo') )
1846     {
1847
1848         # DEMO => the demo user is allowed to do everything (if demo set to 1 in koha.conf
1849         # some features won't be effective : modify systempref, modify MARC structure,
1850         return 2;
1851     }
1852     return 0;
1853 }
1854
1855 sub checkpw_hash {
1856     my ( $password, $stored_hash ) = @_;
1857
1858     return if $stored_hash eq '!';
1859
1860     # check what encryption algorithm was implemented: Bcrypt - if the hash starts with '$2' it is Bcrypt else md5
1861     my $hash;
1862     if ( substr( $stored_hash, 0, 2 ) eq '$2' ) {
1863         $hash = hash_password( $password, $stored_hash );
1864     } else {
1865         $hash = md5_base64($password);
1866     }
1867     return $hash eq $stored_hash;
1868 }
1869
1870 =head2 getuserflags
1871
1872     my $authflags = getuserflags($flags, $userid, [$dbh]);
1873
1874 Translates integer flags into permissions strings hash.
1875
1876 C<$flags> is the integer userflags value ( borrowers.userflags )
1877 C<$userid> is the members.userid, used for building subpermissions
1878 C<$authflags> is a hashref of permissions
1879
1880 =cut
1881
1882 sub getuserflags {
1883     my $flags  = shift;
1884     my $userid = shift;
1885     my $dbh    = @_ ? shift : C4::Context->dbh;
1886     my $userflags;
1887     {
1888         # I don't want to do this, but if someone logs in as the database
1889         # user, it would be preferable not to spam them to death with
1890         # numeric warnings. So, we make $flags numeric.
1891         no warnings 'numeric';
1892         $flags += 0;
1893     }
1894     my $sth = $dbh->prepare("SELECT bit, flag, defaulton FROM userflags");
1895     $sth->execute;
1896
1897     while ( my ( $bit, $flag, $defaulton ) = $sth->fetchrow ) {
1898         if ( ( $flags & ( 2**$bit ) ) || $defaulton ) {
1899             $userflags->{$flag} = 1;
1900         }
1901         else {
1902             $userflags->{$flag} = 0;
1903         }
1904     }
1905
1906     # get subpermissions and merge with top-level permissions
1907     my $user_subperms = get_user_subpermissions($userid);
1908     foreach my $module ( keys %$user_subperms ) {
1909         next if $userflags->{$module} == 1;    # user already has permission for everything in this module
1910         $userflags->{$module} = $user_subperms->{$module};
1911     }
1912
1913     return $userflags;
1914 }
1915
1916 =head2 get_user_subpermissions
1917
1918   $user_perm_hashref = get_user_subpermissions($userid);
1919
1920 Given the userid (note, not the borrowernumber) of a staff user,
1921 return a hashref of hashrefs of the specific subpermissions
1922 accorded to the user.  An example return is
1923
1924  {
1925     tools => {
1926         export_catalog => 1,
1927         import_patrons => 1,
1928     }
1929  }
1930
1931 The top-level hash-key is a module or function code from
1932 userflags.flag, while the second-level key is a code
1933 from permissions.
1934
1935 The results of this function do not give a complete picture
1936 of the functions that a staff user can access; it is also
1937 necessary to check borrowers.flags.
1938
1939 =cut
1940
1941 sub get_user_subpermissions {
1942     my $userid = shift;
1943
1944     my $dbh = C4::Context->dbh;
1945     my $sth = $dbh->prepare( "SELECT flag, user_permissions.code
1946                              FROM user_permissions
1947                              JOIN permissions USING (module_bit, code)
1948                              JOIN userflags ON (module_bit = bit)
1949                              JOIN borrowers USING (borrowernumber)
1950                              WHERE userid = ?" );
1951     $sth->execute($userid);
1952
1953     my $user_perms = {};
1954     while ( my $perm = $sth->fetchrow_hashref ) {
1955         $user_perms->{ $perm->{'flag'} }->{ $perm->{'code'} } = 1;
1956     }
1957     return $user_perms;
1958 }
1959
1960 =head2 get_all_subpermissions
1961
1962   my $perm_hashref = get_all_subpermissions();
1963
1964 Returns a hashref of hashrefs defining all specific
1965 permissions currently defined.  The return value
1966 has the same structure as that of C<get_user_subpermissions>,
1967 except that the innermost hash value is the description
1968 of the subpermission.
1969
1970 =cut
1971
1972 sub get_all_subpermissions {
1973     my $dbh = C4::Context->dbh;
1974     my $sth = $dbh->prepare( "SELECT flag, code
1975                              FROM permissions
1976                              JOIN userflags ON (module_bit = bit)" );
1977     $sth->execute();
1978
1979     my $all_perms = {};
1980     while ( my $perm = $sth->fetchrow_hashref ) {
1981         $all_perms->{ $perm->{'flag'} }->{ $perm->{'code'} } = 1;
1982     }
1983     return $all_perms;
1984 }
1985
1986 =head2 haspermission
1987
1988   $flags = ($userid, $flagsrequired);
1989
1990 C<$userid> the userid of the member
1991 C<$flags> is a hashref of required flags like C<$borrower-&lt;{authflags}> 
1992
1993 Returns member's flags or 0 if a permission is not met.
1994
1995 =cut
1996
1997 sub haspermission {
1998     my ( $userid, $flagsrequired ) = @_;
1999     my $sth = C4::Context->dbh->prepare("SELECT flags FROM borrowers WHERE userid=?");
2000     $sth->execute($userid);
2001     my $row = $sth->fetchrow();
2002     my $flags = getuserflags( $row, $userid );
2003     if ( $userid eq C4::Context->config('user') ) {
2004
2005         # Super User Account from /etc/koha.conf
2006         $flags->{'superlibrarian'} = 1;
2007     }
2008     elsif ( $userid eq 'demo' && C4::Context->config('demo') ) {
2009
2010         # Demo user that can do "anything" (demo=1 in /etc/koha.conf)
2011         $flags->{'superlibrarian'} = 1;
2012     }
2013
2014     return $flags if $flags->{superlibrarian};
2015
2016     foreach my $module ( keys %$flagsrequired ) {
2017         my $subperm = $flagsrequired->{$module};
2018         if ( $subperm eq '*' ) {
2019             return 0 unless ( $flags->{$module} == 1 or ref( $flags->{$module} ) );
2020         } else {
2021             return 0 unless (
2022                 ( defined $flags->{$module} and
2023                     $flags->{$module} == 1 )
2024                 or
2025                 ( ref( $flags->{$module} ) and
2026                     exists $flags->{$module}->{$subperm} and
2027                     $flags->{$module}->{$subperm} == 1 )
2028             );
2029         }
2030     }
2031     return $flags;
2032
2033     #FIXME - This fcn should return the failed permission so a suitable error msg can be delivered.
2034 }
2035
2036 sub getborrowernumber {
2037     my ($userid) = @_;
2038     my $userenv = C4::Context->userenv;
2039     if ( defined($userenv) && ref($userenv) eq 'HASH' && $userenv->{number} ) {
2040         return $userenv->{number};
2041     }
2042     my $dbh = C4::Context->dbh;
2043     for my $field ( 'userid', 'cardnumber' ) {
2044         my $sth =
2045           $dbh->prepare("select borrowernumber from borrowers where $field=?");
2046         $sth->execute($userid);
2047         if ( $sth->rows ) {
2048             my ($bnumber) = $sth->fetchrow;
2049             return $bnumber;
2050         }
2051     }
2052     return 0;
2053 }
2054
2055 END { }    # module clean-up code here (global destructor)
2056 1;
2057 __END__
2058
2059 =head1 SEE ALSO
2060
2061 CGI(3)
2062
2063 C4::Output(3)
2064
2065 Crypt::Eksblowfish::Bcrypt(3)
2066
2067 Digest::MD5(3)
2068
2069 =cut