LP1797934: Add a patron's booking reservations to their OPAC account
[Evergreen.git] / Open-ILS / src / perlmods / lib / OpenILS / WWW / EGCatLoader.pm
1 package OpenILS::WWW::EGCatLoader;
2 use strict; use warnings;
3 use XML::LibXML;
4 use URI::Escape;
5 use Digest::MD5 qw(md5_hex);
6 use Apache2::Const -compile => qw(OK DECLINED FORBIDDEN HTTP_INTERNAL_SERVER_ERROR REDIRECT HTTP_BAD_REQUEST);
7 use OpenSRF::AppSession;
8 use OpenSRF::EX qw/:try/;
9 use OpenILS::Utils::DateTime qw/:datetime/;
10 use OpenSRF::Utils::JSON;
11 use OpenSRF::Utils::Logger qw/$logger/;
12 use OpenILS::Application::AppUtils;
13 use OpenILS::Utils::CStoreEditor qw/:funcs/;
14 use OpenILS::Utils::Fieldmapper;
15 use DateTime::Format::ISO8601;
16 use CGI qw(:all -utf8);
17 use Time::HiRes;
18
19 # EGCatLoader sub-modules 
20 use OpenILS::WWW::EGCatLoader::Util;
21 use OpenILS::WWW::EGCatLoader::Account;
22 use OpenILS::WWW::EGCatLoader::Browse;
23 use OpenILS::WWW::EGCatLoader::Library;
24 use OpenILS::WWW::EGCatLoader::Search;
25 use OpenILS::WWW::EGCatLoader::Record;
26 use OpenILS::WWW::EGCatLoader::Container;
27 use OpenILS::WWW::EGCatLoader::SMS;
28 use OpenILS::WWW::EGCatLoader::Register;
29
30 my $U = 'OpenILS::Application::AppUtils';
31
32 use constant COOKIE_SES => 'ses';
33 use constant COOKIE_LOGGEDIN => 'eg_loggedin';
34 use constant COOKIE_TZ => 'client_tz';
35 use constant COOKIE_PHYSICAL_LOC => 'eg_physical_loc';
36 use constant COOKIE_SSS_EXPAND => 'eg_sss_expand';
37
38 use constant COOKIE_ANON_CACHE => 'anoncache';
39 use constant COOKIE_CART_CACHE => 'cartcache';
40 use constant CART_CACHE_MYLIST => 'mylist';
41 use constant ANON_CACHE_STAFF_SEARCH => 'staffsearch';
42
43 use constant DEBUG_TIMING => 0;
44
45 sub new {
46     my($class, $apache, $ctx) = @_;
47
48     my $self = bless({}, ref($class) || $class);
49
50     $self->apache($apache);
51     $self->ctx($ctx);
52     $self->cgi(new CGI);
53     $self->timelog("New page");
54
55     # Add a timelog helper to the context
56     $self->ctx->{timelog} = sub { return $self->timelog(@_) };
57
58     OpenILS::Utils::CStoreEditor->init; # just in case
59     $self->editor(new_editor());
60
61     return $self;
62 }
63
64 sub DESTROY {
65     my $self = shift;
66     $ENV{TZ} = $self->ctx->{original_tz}
67         if ($self->ctx && exists $self->ctx->{original_tz});
68 }
69
70 # current Apache2::RequestRec;
71 sub apache {
72     my($self, $apache) = @_;
73     $self->{apache} = $apache if $apache;
74     return $self->{apache};
75 }
76
77 # runtime / template context
78 sub ctx {
79     my($self, $ctx) = @_;
80     $self->{ctx} = $ctx if $ctx;
81     return $self->{ctx};
82 }
83
84 # cstore editor
85 sub editor {
86     my($self, $editor) = @_;
87     $self->{editor} = $editor if $editor;
88     return $self->{editor};
89 }
90
91 # CGI handle
92 sub cgi {
93     my($self, $cgi) = @_;
94     $self->{cgi} = $cgi if $cgi;
95     return $self->{cgi};
96 }
97
98 sub timelog {
99     my($self, $description) = @_;
100
101     return unless DEBUG_TIMING;
102     return unless $description;
103     $self->ctx->{timing} ||= [];
104     
105     my $timer = [Time::HiRes::gettimeofday()];
106     $self->ctx->{time_begin} ||= $timer;
107
108     push @{$self->ctx->{timing}}, [
109         Time::HiRes::tv_interval($self->ctx->{time_begin}, $timer), $description
110     ];
111 }
112
113 # -----------------------------------------------------------------------------
114 # Perform initial setup, load common data, then load page data
115 # -----------------------------------------------------------------------------
116 sub load {
117     my $self = shift;
118
119     $self->init_ro_object_cache;
120     $self->timelog("Initial load");
121
122     my $stat = $self->load_common;
123     return $stat unless $stat == Apache2::Const::OK;
124
125     my $path = $self->apache->path_info;
126
127     if ($path =~ m|opac/?$|) {
128         # nowhere specified, just go home
129         return $self->generic_redirect($self->ctx->{home_page});
130     }
131
132     (undef, $self->ctx->{mylist}) = $self->fetch_mylist unless
133         $path =~ /opac\/my(opac\/lists|list)/ ||
134         $path =~ m!opac/api/mylist!;
135
136     return $self->load_api_mylist_retrieve if $path =~ m|opac/api/mylist/retrieve|;
137     return $self->load_api_mylist_add if $path =~ m|opac/api/mylist/add|;
138     return $self->load_api_mylist_delete if $path =~ m|opac/api/mylist/delete|;
139     return $self->load_api_mylist_clear if $path =~ m|opac/api/mylist/clear|;
140
141     return $self->load_simple("home") if $path =~ m|opac/home|;
142     return $self->load_simple("css") if $path =~ m|opac/css|;
143     return $self->load_simple("advanced") if
144         $path =~ m:opac/(advanced|numeric|expert):;
145
146     return $self->load_library if $path =~ m|opac/library|;
147     return $self->load_rresults if $path =~ m|opac/results|;
148     return $self->load_print_record if $path =~ m|opac/record/print|;
149     return $self->load_record if $path =~ m|opac/record/\d|;
150     return $self->load_cnbrowse if $path =~ m|opac/cnbrowse|;
151     return $self->load_browse if $path =~ m|opac/browse|;
152
153     return $self->load_mylist_add if $path =~ m|opac/mylist/add|;
154     return $self->load_mylist_delete if $path =~ m|opac/mylist/delete|;
155     return $self->load_mylist_move if $path =~ m|opac/mylist/move|;
156     return $self->load_mylist_print if $path =~ m|opac/mylist/doprint|;
157     return $self->load_mylist if $path =~ m|opac/mylist| && $path !~ m|opac/mylist/email| && $path !~ m|opac/mylist/doemail|;
158     return $self->load_cache_clear if $path =~ m|opac/cache/clear|;
159     return $self->load_temp_warn_post if $path =~ m|opac/temp_warn/post|;
160     return $self->load_temp_warn if $path =~ m|opac/temp_warn|;
161
162     # ----------------------------------------------------------------
163     #  Everything below here requires SSL
164     # ----------------------------------------------------------------
165     return $self->redirect_ssl unless $self->cgi->https;
166     return $self->load_password_reset if $path =~ m|opac/password_reset|;
167     return $self->load_logout if $path =~ m|opac/logout|;
168     return $self->load_patron_reg if $path =~ m|opac/register|;
169
170     $self->load_simple("myopac") if $path =~ m:opac/myopac:; # A default page for myopac parts
171
172     if($path =~ m|opac/login|) {
173         return $self->load_login unless $self->editor->requestor; # already logged in?
174
175         # This will be less confusing to users than to be shown a login form
176         # when they're already logged in.
177         return $self->generic_redirect(
178             sprintf(
179                 "%s://%s%s/myopac/main",
180                 $self->ctx->{proto},
181                 $self->ctx->{hostname}, $self->ctx->{opac_root}
182             )
183         );
184     }
185
186     if ($path =~ m|opac/sms_cn| and !$self->editor->requestor) {
187         my $org_unit = $self->ctx->{physical_loc} || $self->cgi->param('loc') || $self->ctx->{aou_tree}->()->id;
188         my $skip_sms_auth = $self->ctx->{get_org_setting}->($org_unit, 'sms.disable_authentication_requirement.callnumbers');
189         return $self->load_sms_cn if $skip_sms_auth;
190     }
191
192     # ----------------------------------------------------------------
193     #  Everything below here requires authentication
194     # ----------------------------------------------------------------
195     return $self->redirect_auth unless $self->editor->requestor;
196
197     # Don't cache anything requiring auth for security reasons
198     $self->apache->headers_out->add("cache-control" => "no-store, no-cache, must-revalidate");
199     $self->apache->headers_out->add("expires" => "-1");
200
201     if ($path =~ m|opac/mylist/email|) {
202         (undef, $self->ctx->{mylist}) = $self->fetch_mylist;
203     }
204     $self->load_simple("mylist/email") if $path =~ m|opac/mylist/email|;
205     return $self->load_mylist_email if $path =~ m|opac/mylist/doemail|;
206     return $self->load_email_record if $path =~ m|opac/record/email|;
207
208     return $self->load_place_hold if $path =~ m|opac/place_hold|;
209     return $self->load_myopac_holds if $path =~ m|opac/myopac/holds|;
210     return $self->load_myopac_circs if $path =~ m|opac/myopac/circs|;
211     return $self->load_myopac_messages if $path =~ m|opac/myopac/messages|;
212     return $self->load_myopac_payment_form if $path =~ m|opac/myopac/main_payment_form|;
213     return $self->load_myopac_payments if $path =~ m|opac/myopac/main_payments|;
214     return $self->load_myopac_pay_init if $path =~ m|opac/myopac/main_pay_init|;
215     return $self->load_myopac_pay if $path =~ m|opac/myopac/main_pay|;
216     return $self->load_myopac_main if $path =~ m|opac/myopac/main|;
217     return $self->load_myopac_receipt_email if $path =~ m|opac/myopac/receipt_email|;
218     return $self->load_myopac_receipt_print if $path =~ m|opac/myopac/receipt_print|;
219     return $self->load_myopac_update_email if $path =~ m|opac/myopac/update_email|;
220     return $self->load_myopac_update_password if $path =~ m|opac/myopac/update_password|;
221     return $self->load_myopac_update_username if $path =~ m|opac/myopac/update_username|;
222     return $self->load_myopac_bookbags if $path =~ m|opac/myopac/lists|;
223     return $self->load_myopac_bookbag_print if $path =~ m|opac/myopac/list/print|;
224     return $self->load_myopac_bookbag_update if $path =~ m|opac/myopac/list/update|;
225     return $self->load_myopac_circ_history_export if $path =~ m|opac/myopac/circ_history/export|;
226     return $self->load_myopac_circ_history if $path =~ m|opac/myopac/circ_history|;
227     return $self->load_myopac_hold_history if $path =~ m|opac/myopac/hold_history|;
228     return $self->load_myopac_prefs_notify if $path =~ m|opac/myopac/prefs_notify|;
229     return $self->load_myopac_prefs_settings if $path =~ m|opac/myopac/prefs_settings|;
230     return $self->load_myopac_prefs_my_lists if $path =~ m|opac/myopac/prefs_my_lists|;
231     return $self->load_myopac_prefs if $path =~ m|opac/myopac/prefs|;
232     return $self->load_myopac_reservations if $path =~ m|opac/myopac/reservations|;
233     return $self->load_sms_cn if $path =~ m|opac/sms_cn|;
234
235     return Apache2::Const::OK;
236 }
237
238
239 # -----------------------------------------------------------------------------
240 # Redirect to SSL equivalent of a given page
241 # -----------------------------------------------------------------------------
242 sub redirect_ssl {
243     my $self = shift;
244     my $new_page = sprintf('%s://%s%s', ($self->ctx->{is_staff} ? 'oils' : 'https'), $self->ctx->{hostname}, $self->apache->unparsed_uri);
245     return $self->generic_redirect($new_page);
246 }
247
248 # -----------------------------------------------------------------------------
249 # If an authnticated resource is requested w/o auth, redirect to the login page,
250 # then return to the originally requrested resource upon successful login.
251 # -----------------------------------------------------------------------------
252 sub redirect_auth {
253     my $self = shift;
254     my $login_page = sprintf('%s://%s%s/login',($self->ctx->{is_staff} ? 'oils' : 'https'), $self->ctx->{hostname}, $self->ctx->{opac_root});
255     my $redirect_to = uri_escape_utf8($self->apache->unparsed_uri);
256     return $self->generic_redirect("$login_page?redirect_to=$redirect_to");
257 }
258
259 # -----------------------------------------------------------------------------
260 # Fall-through for loading a basic page
261 # -----------------------------------------------------------------------------
262 sub load_simple {
263     my ($self, $page) = @_;
264     $self->ctx->{page} = $page;
265     $self->ctx->{search_ou} = $self->_get_search_lib();
266
267     return Apache2::Const::OK;
268 }
269
270 # -----------------------------------------------------------------------------
271 # Tests to see if the user is authenticated and sets some common context values
272 # -----------------------------------------------------------------------------
273 sub load_common {
274     my $self = shift;
275
276     my $e = $self->editor;
277     my $ctx = $self->ctx;
278
279     # redirect non-https to https if we think we are already logged in
280     if ($self->cgi->cookie(COOKIE_LOGGEDIN)) {
281         return $self->redirect_ssl unless $self->cgi->https;
282     }
283
284     # XXX Cache this? Makes testing difficult as apache needs a restart.
285     my $default_sort = $e->retrieve_config_global_flag('opac.default_sort');
286     $ctx->{default_sort} =
287         ($default_sort && $U->is_true($default_sort->enabled)) ? $default_sort->value : '';
288
289     $ctx->{client_tz} = $self->cgi->cookie(COOKIE_TZ) || $ENV{TZ};
290     $ctx->{referer} = $self->cgi->referer;
291     $ctx->{path_info} = $self->cgi->path_info;
292     $ctx->{full_path} = $ctx->{base_path} . $self->cgi->path_info;
293     $ctx->{unparsed_uri} = $self->apache->unparsed_uri;
294     $ctx->{opac_root} = $ctx->{base_path} . "/opac"; # absolute base url
295
296     $ctx->{original_tz} = $ENV{TZ};
297     $ENV{TZ} = $ctx->{client_tz};
298
299     my $xul_wrapper = 
300         ($self->apache->headers_in->get('OILS-Wrapper') || '') =~ /true/;
301
302     if ($xul_wrapper) {
303         # XUL client
304         $ctx->{is_staff} = 1;
305         $ctx->{proto} = 'oils';
306         $ctx->{hostname} = 'remote';
307     }
308
309     $ctx->{physical_loc} = $self->get_physical_loc;
310
311     # capture some commonly accessed pages
312     $ctx->{home_page} = $ctx->{proto} . '://' . $ctx->{hostname} . $self->ctx->{opac_root} . "/home";
313     $ctx->{logout_page} = ($ctx->{proto} eq 'http' ? 'https' : $ctx->{proto} ) . '://' . $ctx->{hostname} . $self->ctx->{opac_root} . "/logout";
314
315     if($e->authtoken($self->cgi->cookie(COOKIE_SES))) {
316
317         if($e->checkauth) {
318
319             $ctx->{authtoken} = $e->authtoken;
320             $ctx->{authtime} = $e->authtime;
321             $ctx->{user} = $e->requestor;
322             my $card = $self->editor->retrieve_actor_card($ctx->{user}->card);
323             $ctx->{active_card} = (ref $card) ? $card->barcode : undef;
324             $ctx->{place_unfillable} = 1 if $e->requestor->wsid && $e->allowed('PLACE_UNFILLABLE_HOLD', $e->requestor->ws_ou);
325
326             # The browser client does not set an OILS-Wrapper header (above).
327             # The presence of a workstation and no header indicates staff mode.
328             # FIXME: this approach leaves un-wrapped TPAC's within the same
329             # browser (and hence same ses cookie) in an unnatural is_staff
330             # state.  Consider alternatives for determining is_staff / 
331             # is_browser_staff when $xul_wrapper is false.
332             if (!$xul_wrapper and $e->requestor->wsid) {
333                 $ctx->{is_staff} = 1;
334                 $ctx->{is_browser_staff} = 1;
335             }
336
337             $self->update_dashboard_stats();
338
339         } else {
340
341             # if we encounter a stale authtoken, call load_logout 
342             # to clean up the cookie, then redirect the user to the
343             # originally requested page
344             return $self->load_logout($self->apache->unparsed_uri);
345         }
346     }
347
348     # List of <meta> and <link> elements to populate
349     $ctx->{metalinks} = [];
350
351     $self->extract_copy_location_group_info;
352     $ctx->{search_ou} = $self->_get_search_lib();
353     $self->staff_saved_searches_set_expansion_state if $ctx->{is_staff};
354     $self->load_eg_cache_hash;
355     $self->load_copy_location_groups;
356     $self->staff_saved_searches_set_expansion_state if $ctx->{is_staff};
357     $self->load_search_filter_groups($ctx->{search_ou});
358     $self->load_org_util_funcs;
359     $self->load_perm_funcs;
360
361     $ctx->{fetch_display_fields} = sub {
362         my $id = shift;
363
364         if (@$id == 1) {
365             return $ctx->{_hl_data}{''.$$id[0]}
366                 if ($ctx->{_hl_data}{''.$$id[0]});
367         }
368
369         $self->timelog("HL data not cached, fetching from server.");
370
371         my $rows = $U->simplereq(
372             'open-ils.search', 
373             'open-ils.search.fetch.metabib.display_field.highlight',
374             $ctx->{query_struct}{additional_data}{highlight_map},
375             map {int($_)} @$id
376         );
377
378         $ctx->{_hl_data}{''.$$id[0]} = $rows if (@$id == 1);
379
380         return $rows;
381     };
382
383     return Apache2::Const::OK;
384 }
385
386 sub update_dashboard_stats {
387     my $self = shift;
388
389     my $e = $self->editor;
390     my $ctx = $self->ctx;
391
392     $ctx->{user_stats} = $U->simplereq(
393         'open-ils.actor', 
394         'open-ils.actor.user.opac.vital_stats', 
395         $e->authtoken, $e->requestor->id);
396 }
397
398 sub staff_saved_searches_set_expansion_state {
399     my $self = shift;
400
401     my $param = $self->cgi->param('sss_expand');
402     my $value;
403     
404     if (defined $param) {
405         $value = ($param ? 1 : 0);
406         $self->apache->headers_out->add(
407             "Set-Cookie" => $self->cgi->cookie(
408                 -name => COOKIE_SSS_EXPAND,
409                 -path => $self->ctx->{base_path},
410                 -secure => 1,   # not strictly necessary, but this feature is staff-only, so may as well
411                 -value => $value,
412                 -expires => undef
413             )
414         );
415     } else {
416         $value = $self->cgi->cookie(COOKIE_SSS_EXPAND);
417     }
418
419     $self->ctx->{saved_searches_expanded} = $value;
420 }
421
422 # physical_loc (i.e. "original location") passed in as a URL 
423 # param will replace any existing physical_loc stored as a cookie.
424 # If specified via ENV that rules over all and we don't set cookies.
425 sub get_physical_loc {
426     my $self = shift;
427
428     return $ENV{physical_loc} if($ENV{physical_loc});
429
430     if(my $physical_loc = $self->cgi->param('physical_loc')) {
431         $self->apache->headers_out->add(
432             "Set-Cookie" => $self->cgi->cookie(
433                 -name => COOKIE_PHYSICAL_LOC,
434                 -path => $self->ctx->{base_path},
435                 -value => $physical_loc,
436                 -expires => undef
437             )
438         );
439         return $physical_loc;
440     }
441
442     return $self->cgi->cookie(COOKIE_PHYSICAL_LOC);
443 }
444
445 # -----------------------------------------------------------------------------
446 # Log in and redirect to the redirect_to URL (or home)
447 # -----------------------------------------------------------------------------
448 sub load_login {
449     my $self = shift;
450     my $cgi = $self->cgi;
451     my $ctx = $self->ctx;
452
453     $self->timelog("Load login begins");
454
455     $ctx->{page} = 'login';
456
457     my $username = $cgi->param('username') || '';
458     $username =~ s/\s//g;  # Remove blanks
459     my $password = $cgi->param('password');
460     my $org_unit = $ctx->{physical_loc} || $ctx->{aou_tree}->()->id;
461     my $persist = $cgi->param('persist');
462     my $client_tz = $cgi->param('client_tz');
463
464     # initial log form only
465     return Apache2::Const::OK unless $username and $password;
466
467     my $auth_proxy_enabled = 0; # default false
468     try { # if the service is not running, just let this fail silently
469         $auth_proxy_enabled = $U->simplereq(
470             'open-ils.auth_proxy',
471             'open-ils.auth_proxy.enabled');
472     } catch Error with {};
473
474     $self->timelog("Checked for auth proxy: $auth_proxy_enabled; org = $org_unit; username = $username");
475
476     my $args = {
477         type => ($persist) ? 'persist' : 'opac',
478         org => $org_unit,
479         agent => 'opac'
480     };
481
482     my $bc_regex = $ctx->{get_org_setting}->($org_unit, 'opac.barcode_regex');
483
484     # To avoid surprises, default to "Barcodes start with digits"
485     $bc_regex = '^\d' unless $bc_regex;
486
487     if ($bc_regex and ($username =~ /$bc_regex/)) {
488         $args->{barcode} = $username;
489     } else {
490         $args->{username} = $username;
491     }
492
493     my $response;
494     if (!$auth_proxy_enabled) {
495         my $seed = $U->simplereq(
496             'open-ils.auth',
497             'open-ils.auth.authenticate.init', $username);
498         $args->{password} = md5_hex($seed . md5_hex($password));
499         $response = $U->simplereq(
500             'open-ils.auth', 'open-ils.auth.authenticate.complete', $args);
501     } else {
502         $args->{password} = $password;
503         $response = $U->simplereq(
504             'open-ils.auth_proxy',
505             'open-ils.auth_proxy.login', $args);
506     }
507     $self->timelog("Checked password");
508
509     if($U->event_code($response)) { 
510         # login failed, report the reason to the template
511         $ctx->{login_failed_event} = $response;
512         return Apache2::Const::OK;
513     }
514
515     # login succeeded, redirect as necessary
516
517     my $acct = $self->apache->unparsed_uri;
518     $acct =~ s|/login|/myopac/main|;
519
520     # both login-related cookies should expire at the same time
521     my $login_cookie_expires = ($persist) ? CORE::time + $response->{payload}->{authtime} : undef;
522
523     my $cookie_list = [
524         # contains the actual auth token and should be sent only over https
525         $cgi->cookie(
526             -name => COOKIE_SES,
527             -path => '/',
528             -secure => 1,
529             -value => $response->{payload}->{authtoken},
530             -expires => $login_cookie_expires
531         ),
532         # contains only a hint that we are logged in, and is used to
533         # trigger a redirect to https
534         $cgi->cookie(
535             -name => COOKIE_LOGGEDIN,
536             -path => '/',
537             -secure => 0,
538             -value => '1',
539             -expires => $login_cookie_expires
540         )
541     ];
542
543     if ($client_tz) {
544         # contains the client's tz, as passed by the client
545         # trigger a redirect to https
546         push @$cookie_list, $cgi->cookie(
547             -name => COOKIE_TZ,
548             -path => '/',
549             -secure => 0,
550             -value => $client_tz,
551             -expires => $login_cookie_expires
552         );
553     }
554
555     return $self->generic_redirect(
556         $cgi->param('redirect_to') || $acct,
557         $cookie_list
558     );
559 }
560
561 # -----------------------------------------------------------------------------
562 # Log out and redirect to the home page
563 # -----------------------------------------------------------------------------
564 sub load_logout {
565     my $self = shift;
566     my $redirect_to = shift || $self->cgi->param('redirect_to');
567
568     # If the user was adding anyting to an anonymous cache 
569     # while logged in, go ahead and clear it out.
570     $self->clear_anon_cache;
571
572     try { # a missing auth token will cause an ugly explosion
573         $U->simplereq(
574             'open-ils.auth',
575             'open-ils.auth.session.delete',
576             $self->cgi->cookie(COOKIE_SES)
577         );
578     } catch Error with {};
579
580     return $self->generic_redirect(
581         $redirect_to || $self->ctx->{home_page},
582         [
583             # clear value of and expire both of these login-related cookies
584             $self->cgi->cookie(
585                 -name => COOKIE_SES,
586                 -path => '/',
587                 -value => '',
588                 -expires => '-1h'
589             ),
590             $self->cgi->cookie(
591                 -name => COOKIE_LOGGEDIN,
592                 -path => '/',
593                 -value => '',
594                 -expires => '-1h'
595             )
596         ]
597     );
598 }
599
600 1;
601