0838a29eb506050c96049fff604a3df1811d4e11
[working/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 OpenSRF::Utils 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::Search;
23 use OpenILS::WWW::EGCatLoader::Record;
24 use OpenILS::WWW::EGCatLoader::Container;
25 use OpenILS::WWW::EGCatLoader::SMS;
26
27 my $U = 'OpenILS::Application::AppUtils';
28
29 use constant COOKIE_SES => 'ses';
30 use constant COOKIE_LOGGEDIN => 'eg_loggedin';
31 use constant COOKIE_PHYSICAL_LOC => 'eg_physical_loc';
32 use constant COOKIE_SSS_EXPAND => 'eg_sss_expand';
33
34 use constant COOKIE_ANON_CACHE => 'anoncache';
35 use constant ANON_CACHE_MYLIST => 'mylist';
36 use constant ANON_CACHE_STAFF_SEARCH => 'staffsearch';
37
38 use constant DEBUG_TIMING => 0;
39
40 sub new {
41     my($class, $apache, $ctx) = @_;
42
43     my $self = bless({}, ref($class) || $class);
44
45     $self->apache($apache);
46     $self->ctx($ctx);
47     $self->cgi(new CGI);
48     $self->timelog("New page");
49
50     OpenILS::Utils::CStoreEditor->init; # just in case
51     $self->editor(new_editor());
52
53     return $self;
54 }
55
56
57 # current Apache2::RequestRec;
58 sub apache {
59     my($self, $apache) = @_;
60     $self->{apache} = $apache if $apache;
61     return $self->{apache};
62 }
63
64 # runtime / template context
65 sub ctx {
66     my($self, $ctx) = @_;
67     $self->{ctx} = $ctx if $ctx;
68     return $self->{ctx};
69 }
70
71 # cstore editor
72 sub editor {
73     my($self, $editor) = @_;
74     $self->{editor} = $editor if $editor;
75     return $self->{editor};
76 }
77
78 # CGI handle
79 sub cgi {
80     my($self, $cgi) = @_;
81     $self->{cgi} = $cgi if $cgi;
82     return $self->{cgi};
83 }
84
85 sub timelog {
86     my($self, $description) = @_;
87
88     return unless DEBUG_TIMING;
89     return unless $description;
90     $self->ctx->{timing} ||= [];
91     
92     my $timer = [Time::HiRes::gettimeofday()];
93     $self->ctx->{time_begin} ||= $timer;
94
95     push @{$self->ctx->{timing}}, [
96         Time::HiRes::tv_interval($self->ctx->{time_begin}, $timer), $description
97     ];
98 }
99
100 # -----------------------------------------------------------------------------
101 # Perform initial setup, load common data, then load page data
102 # -----------------------------------------------------------------------------
103 sub load {
104     my $self = shift;
105
106     $self->init_ro_object_cache;
107     $self->timelog("Initial load");
108
109     my $stat = $self->load_common;
110     return $stat unless $stat == Apache2::Const::OK;
111
112     my $path = $self->apache->path_info;
113
114     (undef, $self->ctx->{mylist}) = $self->fetch_mylist unless
115         $path =~ /opac\/my(opac\/lists|list)/;
116
117     return $self->load_simple("home") if $path =~ m|opac/home|;
118     return $self->load_simple("css") if $path =~ m|opac/css|;
119     return $self->load_simple("advanced") if
120         $path =~ m:opac/(advanced|numeric|expert):;
121
122     return $self->load_rresults if $path =~ m|opac/results|;
123     return $self->load_print_record if $path =~ m|opac/record/print|;
124     return $self->load_record if $path =~ m|opac/record/\d|;
125     return $self->load_cnbrowse if $path =~ m|opac/cnbrowse|;
126
127     return $self->load_mylist_add if $path =~ m|opac/mylist/add|;
128     return $self->load_mylist_delete if $path =~ m|opac/mylist/delete|;
129     return $self->load_mylist_move if $path =~ m|opac/mylist/move|;
130     return $self->load_mylist if $path =~ m|opac/mylist|;
131     return $self->load_cache_clear if $path =~ m|opac/cache/clear|;
132     return $self->load_temp_warn_post if $path =~ m|opac/temp_warn/post|;
133     return $self->load_temp_warn if $path =~ m|opac/temp_warn|;
134
135     # ----------------------------------------------------------------
136     #  Everything below here requires SSL
137     # ----------------------------------------------------------------
138     return $self->redirect_ssl unless $self->cgi->https;
139     return $self->load_password_reset if $path =~ m|opac/password_reset|;
140     return $self->load_logout if $path =~ m|opac/logout|;
141
142     if($path =~ m|opac/login|) {
143         return $self->load_login unless $self->editor->requestor; # already logged in?
144
145         # This will be less confusing to users than to be shown a login form
146         # when they're already logged in.
147         return $self->generic_redirect(
148             sprintf(
149                 "%s://%s%s/myopac/main",
150                 $self->ctx->{proto},
151                 $self->ctx->{hostname}, $self->ctx->{opac_root}
152             )
153         );
154     }
155
156     if ($path =~ m|opac/sms_cn| and !$self->editor->requestor) {
157         my $org_unit = $self->ctx->{physical_loc} || $self->cgi->param('loc') || $self->ctx->{aou_tree}->()->id;
158         my $skip_sms_auth = $self->ctx->{get_org_setting}->($org_unit, 'sms.disable_authentication_requirement.callnumbers');
159         return $self->load_sms_cn if $skip_sms_auth;
160     }
161
162     # ----------------------------------------------------------------
163     #  Everything below here requires authentication
164     # ----------------------------------------------------------------
165     return $self->redirect_auth unless $self->editor->requestor;
166
167     # Don't cache anything requiring auth for security reasons
168     $self->apache->headers_out->add("cache-control" => "no-store, no-cache, must-revalidate");
169     $self->apache->headers_out->add("expires" => "-1");
170
171     return $self->load_email_record if $path =~ m|opac/record/email|;
172
173     return $self->load_place_hold if $path =~ m|opac/place_hold|;
174     return $self->load_myopac_holds if $path =~ m|opac/myopac/holds|;
175     return $self->load_myopac_circs if $path =~ m|opac/myopac/circs|;
176     return $self->load_myopac_payment_form if $path =~ m|opac/myopac/main_payment_form|;
177     return $self->load_myopac_payments if $path =~ m|opac/myopac/main_payments|;
178     return $self->load_myopac_pay_init if $path =~ m|opac/myopac/main_pay_init|;
179     return $self->load_myopac_pay if $path =~ m|opac/myopac/main_pay|;
180     return $self->load_myopac_main if $path =~ m|opac/myopac/main|;
181     return $self->load_myopac_receipt_email if $path =~ m|opac/myopac/receipt_email|;
182     return $self->load_myopac_receipt_print if $path =~ m|opac/myopac/receipt_print|;
183     return $self->load_myopac_update_email if $path =~ m|opac/myopac/update_email|;
184     return $self->load_myopac_update_password if $path =~ m|opac/myopac/update_password|;
185     return $self->load_myopac_update_username if $path =~ m|opac/myopac/update_username|;
186     return $self->load_myopac_bookbags if $path =~ m|opac/myopac/lists|;
187     return $self->load_myopac_bookbag_print if $path =~ m|opac/myopac/list/print|;
188     return $self->load_myopac_bookbag_update if $path =~ m|opac/myopac/list/update|;
189     return $self->load_myopac_circ_history_export if $path =~ m|opac/myopac/circ_history/export|;
190     return $self->load_myopac_circ_history if $path =~ m|opac/myopac/circ_history|;
191     return $self->load_myopac_hold_history if $path =~ m|opac/myopac/hold_history|;
192     return $self->load_myopac_prefs_notify if $path =~ m|opac/myopac/prefs_notify|;
193     return $self->load_myopac_prefs_settings if $path =~ m|opac/myopac/prefs_settings|;
194     return $self->load_myopac_prefs if $path =~ m|opac/myopac/prefs|;
195     return $self->load_sms_cn if $path =~ m|opac/sms_cn|;
196
197     return Apache2::Const::OK;
198 }
199
200
201 # -----------------------------------------------------------------------------
202 # Redirect to SSL equivalent of a given page
203 # -----------------------------------------------------------------------------
204 sub redirect_ssl {
205     my $self = shift;
206     my $new_page = sprintf('%s://%s%s', ($self->ctx->{is_staff} ? 'oils' : 'https'), $self->ctx->{hostname}, $self->apache->unparsed_uri);
207     return $self->generic_redirect($new_page);
208 }
209
210 # -----------------------------------------------------------------------------
211 # If an authnticated resource is requested w/o auth, redirect to the login page,
212 # then return to the originally requrested resource upon successful login.
213 # -----------------------------------------------------------------------------
214 sub redirect_auth {
215     my $self = shift;
216     my $login_page = sprintf('%s://%s%s/login',($self->ctx->{is_staff} ? 'oils' : 'https'), $self->ctx->{hostname}, $self->ctx->{opac_root});
217     my $redirect_to = uri_escape($self->apache->unparsed_uri);
218     return $self->generic_redirect("$login_page?redirect_to=$redirect_to");
219 }
220
221 # -----------------------------------------------------------------------------
222 # Fall-through for loading a basic page
223 # -----------------------------------------------------------------------------
224 sub load_simple {
225     my ($self, $page) = @_;
226     $self->ctx->{page} = $page;
227     $self->ctx->{search_ou} = $self->_get_search_lib();
228
229     return Apache2::Const::OK;
230 }
231
232 # -----------------------------------------------------------------------------
233 # Tests to see if the user is authenticated and sets some common context values
234 # -----------------------------------------------------------------------------
235 sub load_common {
236     my $self = shift;
237
238     my $e = $self->editor;
239     my $ctx = $self->ctx;
240
241     # redirect non-https to https if we think we are already logged in
242     if ($self->cgi->cookie(COOKIE_LOGGEDIN)) {
243         return $self->redirect_ssl unless $self->cgi->https;
244     }
245
246     $ctx->{referer} = $self->cgi->referer;
247     $ctx->{path_info} = $self->cgi->path_info;
248     $ctx->{full_path} = $ctx->{base_path} . $self->cgi->path_info;
249     $ctx->{unparsed_uri} = $self->apache->unparsed_uri;
250     $ctx->{opac_root} = $ctx->{base_path} . "/opac"; # absolute base url
251     my $oils_wrapper = $self->apache->headers_in->get('OILS-Wrapper') || '';
252     $ctx->{is_staff} = ($oils_wrapper =~ /true/);
253     $ctx->{proto} = 'oils' if $ctx->{is_staff};
254     $ctx->{hostname} = 'remote' if $ctx->{is_staff};
255     $ctx->{physical_loc} = $self->get_physical_loc;
256
257     # capture some commonly accessed pages
258     $ctx->{home_page} = $ctx->{proto} . '://' . $ctx->{hostname} . $self->ctx->{opac_root} . "/home";
259     $ctx->{logout_page} = ($ctx->{proto} eq 'http' ? 'https' : $ctx->{proto} ) . '://' . $ctx->{hostname} . $self->ctx->{opac_root} . "/logout";
260
261     if($e->authtoken($self->cgi->cookie(COOKIE_SES))) {
262
263         if($e->checkauth) {
264
265             $ctx->{authtoken} = $e->authtoken;
266             $ctx->{authtime} = $e->authtime;
267             $ctx->{user} = $e->requestor;
268             $ctx->{place_unfillable} = 1 if $e->requestor->wsid && $e->allowed('PLACE_UNFILLABLE_HOLD', $e->requestor->ws_ou);
269
270             $ctx->{user_stats} = $U->simplereq(
271                 'open-ils.actor', 
272                 'open-ils.actor.user.opac.vital_stats', 
273                 $e->authtoken, $e->requestor->id);
274
275         } else {
276
277             # if we encounter a stale authtoken, call load_logout 
278             # to clean up the cookie, then redirect the user to the
279             # originally requested page
280             return $self->load_logout($self->apache->unparsed_uri);
281         }
282     }
283
284     $self->extract_copy_location_group_info;
285     $ctx->{search_ou} = $self->_get_search_lib();
286     $self->staff_saved_searches_set_expansion_state if $ctx->{is_staff};
287     $self->load_eg_cache_hash;
288     $self->load_copy_location_groups;
289     $self->staff_saved_searches_set_expansion_state if $ctx->{is_staff};
290     $self->load_search_filter_groups($ctx->{search_ou});
291     $self->load_org_util_funcs;
292
293     return Apache2::Const::OK;
294 }
295
296 sub staff_saved_searches_set_expansion_state {
297     my $self = shift;
298
299     my $param = $self->cgi->param('sss_expand');
300     my $value;
301     
302     if (defined $param) {
303         $value = ($param ? 1 : 0);
304         $self->apache->headers_out->add(
305             "Set-Cookie" => $self->cgi->cookie(
306                 -name => COOKIE_SSS_EXPAND,
307                 -path => $self->ctx->{base_path},
308                 -secure => 1,   # not strictly necessary, but this feature is staff-only, so may as well
309                 -value => $value,
310                 -expires => undef
311             )
312         );
313     } else {
314         $value = $self->cgi->cookie(COOKIE_SSS_EXPAND);
315     }
316
317     $self->ctx->{saved_searches_expanded} = $value;
318 }
319
320 # physical_loc (i.e. "original location") passed in as a URL 
321 # param will replace any existing physical_loc stored as a cookie.
322 # If specified via ENV that rules over all and we don't set cookies.
323 sub get_physical_loc {
324     my $self = shift;
325
326     return $ENV{physical_loc} if($ENV{physical_loc});
327
328     if(my $physical_loc = $self->cgi->param('physical_loc')) {
329         $self->apache->headers_out->add(
330             "Set-Cookie" => $self->cgi->cookie(
331                 -name => COOKIE_PHYSICAL_LOC,
332                 -path => $self->ctx->{base_path},
333                 -value => $physical_loc,
334                 -expires => undef
335             )
336         );
337         return $physical_loc;
338     }
339
340     return $self->cgi->cookie(COOKIE_PHYSICAL_LOC);
341 }
342
343 # -----------------------------------------------------------------------------
344 # Log in and redirect to the redirect_to URL (or home)
345 # -----------------------------------------------------------------------------
346 sub load_login {
347     my $self = shift;
348     my $cgi = $self->cgi;
349     my $ctx = $self->ctx;
350
351     $self->timelog("Load login begins");
352
353     $ctx->{page} = 'login';
354
355     my $username = $cgi->param('username');
356     $username =~ s/\s//g;  # Remove blanks
357     my $password = $cgi->param('password');
358     my $org_unit = $ctx->{physical_loc} || $ctx->{aou_tree}->()->id;
359     my $persist = $cgi->param('persist');
360
361     # initial log form only
362     return Apache2::Const::OK unless $username and $password;
363
364     my $auth_proxy_enabled = 0; # default false
365     try { # if the service is not running, just let this fail silently
366         $auth_proxy_enabled = $U->simplereq(
367             'open-ils.auth_proxy',
368             'open-ils.auth_proxy.enabled');
369     } catch Error with {};
370
371     $self->timelog("Checked for auth proxy: $auth_proxy_enabled; org = $org_unit; username = $username");
372
373     my $args = {
374         type => ($persist) ? 'persist' : 'opac',
375         org => $org_unit,
376         agent => 'opac'
377     };
378
379     my $bc_regex = $ctx->{get_org_setting}->($org_unit, 'opac.barcode_regex');
380
381     # To avoid surprises, default to "Barcodes start with digits"
382     $bc_regex = '^\d' unless $bc_regex;
383
384     if ($bc_regex and ($username =~ /$bc_regex/)) {
385         $args->{barcode} = $username;
386     } else {
387         $args->{username} = $username;
388     }
389
390     my $response;
391     if (!$auth_proxy_enabled) {
392         my $seed = $U->simplereq(
393             'open-ils.auth',
394             'open-ils.auth.authenticate.init', $username);
395         $args->{password} = md5_hex($seed . md5_hex($password));
396         $response = $U->simplereq(
397             'open-ils.auth', 'open-ils.auth.authenticate.complete', $args);
398     } else {
399         $args->{password} = $password;
400         $response = $U->simplereq(
401             'open-ils.auth_proxy',
402             'open-ils.auth_proxy.login', $args);
403     }
404     $self->timelog("Checked password");
405
406     if($U->event_code($response)) { 
407         # login failed, report the reason to the template
408         $ctx->{login_failed_event} = $response;
409         return Apache2::Const::OK;
410     }
411
412     # login succeeded, redirect as necessary
413
414     my $acct = $self->apache->unparsed_uri;
415     $acct =~ s|/login|/myopac/main|;
416
417     # both login-related cookies should expire at the same time
418     my $login_cookie_expires = ($persist) ? CORE::time + $response->{payload}->{authtime} : undef;
419
420     return $self->generic_redirect(
421         $cgi->param('redirect_to') || $acct,
422         [
423             # contains the actual auth token and should be sent only over https
424             $cgi->cookie(
425                 -name => COOKIE_SES,
426                 -path => '/',
427                 -secure => 1,
428                 -value => $response->{payload}->{authtoken},
429                 -expires => $login_cookie_expires
430             ),
431             # contains only a hint that we are logged in, and is used to
432             # trigger a redirect to https
433             $cgi->cookie(
434                 -name => COOKIE_LOGGEDIN,
435                 -path => '/',
436                 -secure => 0,
437                 -value => '1',
438                 -expires => $login_cookie_expires
439             )
440         ]
441     );
442 }
443
444 # -----------------------------------------------------------------------------
445 # Log out and redirect to the home page
446 # -----------------------------------------------------------------------------
447 sub load_logout {
448     my $self = shift;
449     my $redirect_to = shift || $self->cgi->param('redirect_to');
450
451     # If the user was adding anyting to an anonymous cache 
452     # while logged in, go ahead and clear it out.
453     $self->clear_anon_cache;
454
455     return $self->generic_redirect(
456         $redirect_to || $self->ctx->{home_page},
457         [
458             # clear value of and expire both of these login-related cookies
459             $self->cgi->cookie(
460                 -name => COOKIE_SES,
461                 -path => '/',
462                 -value => '',
463                 -expires => '-1h'
464             ),
465             $self->cgi->cookie(
466                 -name => COOKIE_LOGGEDIN,
467                 -path => '/',
468                 -value => '',
469                 -expires => '-1h'
470             )
471         ]
472     );
473 }
474
475 1;
476