1 package OpenILS::WWW::EGCatLoader;
2 use strict; use warnings;
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);
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;
30 my $U = 'OpenILS::Application::AppUtils';
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';
38 use constant COOKIE_ANON_CACHE => 'anoncache';
39 use constant ANON_CACHE_MYLIST => 'mylist';
40 use constant ANON_CACHE_STAFF_SEARCH => 'staffsearch';
42 use constant DEBUG_TIMING => 0;
45 my($class, $apache, $ctx) = @_;
47 my $self = bless({}, ref($class) || $class);
49 $self->apache($apache);
52 $self->timelog("New page");
54 OpenILS::Utils::CStoreEditor->init; # just in case
55 $self->editor(new_editor());
62 $ENV{TZ} = $self->ctx->{original_tz}
63 if ($self->ctx && exists $self->ctx->{original_tz});
66 # current Apache2::RequestRec;
68 my($self, $apache) = @_;
69 $self->{apache} = $apache if $apache;
70 return $self->{apache};
73 # runtime / template context
76 $self->{ctx} = $ctx if $ctx;
82 my($self, $editor) = @_;
83 $self->{editor} = $editor if $editor;
84 return $self->{editor};
90 $self->{cgi} = $cgi if $cgi;
95 my($self, $description) = @_;
97 return unless DEBUG_TIMING;
98 return unless $description;
99 $self->ctx->{timing} ||= [];
101 my $timer = [Time::HiRes::gettimeofday()];
102 $self->ctx->{time_begin} ||= $timer;
104 push @{$self->ctx->{timing}}, [
105 Time::HiRes::tv_interval($self->ctx->{time_begin}, $timer), $description
109 # -----------------------------------------------------------------------------
110 # Perform initial setup, load common data, then load page data
111 # -----------------------------------------------------------------------------
115 $self->init_ro_object_cache;
116 $self->timelog("Initial load");
118 my $stat = $self->load_common;
119 return $stat unless $stat == Apache2::Const::OK;
121 my $path = $self->apache->path_info;
123 if ($path =~ m|opac/?$|) {
124 # nowhere specified, just go home
125 return $self->generic_redirect($self->ctx->{home_page});
128 (undef, $self->ctx->{mylist}) = $self->fetch_mylist unless
129 $path =~ /opac\/my(opac\/lists|list)/;
131 return $self->load_simple("home") if $path =~ m|opac/home|;
132 return $self->load_simple("css") if $path =~ m|opac/css|;
133 return $self->load_simple("advanced") if
134 $path =~ m:opac/(advanced|numeric|expert):;
136 return $self->load_library if $path =~ m|opac/library|;
137 return $self->load_rresults if $path =~ m|opac/results|;
138 return $self->load_print_record if $path =~ m|opac/record/print|;
139 return $self->load_record if $path =~ m|opac/record/\d|;
140 return $self->load_cnbrowse if $path =~ m|opac/cnbrowse|;
141 return $self->load_browse if $path =~ m|opac/browse|;
143 return $self->load_mylist_add if $path =~ m|opac/mylist/add|;
144 return $self->load_mylist_delete if $path =~ m|opac/mylist/delete|;
145 return $self->load_mylist_move if $path =~ m|opac/mylist/move|;
146 return $self->load_mylist if $path =~ m|opac/mylist|;
147 return $self->load_cache_clear if $path =~ m|opac/cache/clear|;
148 return $self->load_temp_warn_post if $path =~ m|opac/temp_warn/post|;
149 return $self->load_temp_warn if $path =~ m|opac/temp_warn|;
151 # ----------------------------------------------------------------
152 # Everything below here requires SSL
153 # ----------------------------------------------------------------
154 return $self->redirect_ssl unless $self->cgi->https;
155 return $self->load_password_reset if $path =~ m|opac/password_reset|;
156 return $self->load_logout if $path =~ m|opac/logout|;
157 return $self->load_patron_reg if $path =~ m|opac/register|;
159 $self->load_simple("myopac") if $path =~ m:opac/myopac:; # A default page for myopac parts
161 if($path =~ m|opac/login|) {
162 return $self->load_login unless $self->editor->requestor; # already logged in?
164 # This will be less confusing to users than to be shown a login form
165 # when they're already logged in.
166 return $self->generic_redirect(
168 "%s://%s%s/myopac/main",
170 $self->ctx->{hostname}, $self->ctx->{opac_root}
175 if ($path =~ m|opac/sms_cn| and !$self->editor->requestor) {
176 my $org_unit = $self->ctx->{physical_loc} || $self->cgi->param('loc') || $self->ctx->{aou_tree}->()->id;
177 my $skip_sms_auth = $self->ctx->{get_org_setting}->($org_unit, 'sms.disable_authentication_requirement.callnumbers');
178 return $self->load_sms_cn if $skip_sms_auth;
181 # ----------------------------------------------------------------
182 # Everything below here requires authentication
183 # ----------------------------------------------------------------
184 return $self->redirect_auth unless $self->editor->requestor;
186 # Don't cache anything requiring auth for security reasons
187 $self->apache->headers_out->add("cache-control" => "no-store, no-cache, must-revalidate");
188 $self->apache->headers_out->add("expires" => "-1");
190 return $self->load_email_record if $path =~ m|opac/record/email|;
192 return $self->load_place_hold if $path =~ m|opac/place_hold|;
193 return $self->load_myopac_holds if $path =~ m|opac/myopac/holds|;
194 return $self->load_myopac_circs if $path =~ m|opac/myopac/circs|;
195 return $self->load_myopac_messages if $path =~ m|opac/myopac/messages|;
196 return $self->load_myopac_payment_form if $path =~ m|opac/myopac/main_payment_form|;
197 return $self->load_myopac_payments if $path =~ m|opac/myopac/main_payments|;
198 return $self->load_myopac_pay_init if $path =~ m|opac/myopac/main_pay_init|;
199 return $self->load_myopac_pay if $path =~ m|opac/myopac/main_pay|;
200 return $self->load_myopac_main if $path =~ m|opac/myopac/main|;
201 return $self->load_myopac_receipt_email if $path =~ m|opac/myopac/receipt_email|;
202 return $self->load_myopac_receipt_print if $path =~ m|opac/myopac/receipt_print|;
203 return $self->load_myopac_update_email if $path =~ m|opac/myopac/update_email|;
204 return $self->load_myopac_update_password if $path =~ m|opac/myopac/update_password|;
205 return $self->load_myopac_update_username if $path =~ m|opac/myopac/update_username|;
206 return $self->load_myopac_bookbags if $path =~ m|opac/myopac/lists|;
207 return $self->load_myopac_bookbag_print if $path =~ m|opac/myopac/list/print|;
208 return $self->load_myopac_bookbag_update if $path =~ m|opac/myopac/list/update|;
209 return $self->load_myopac_circ_history_export if $path =~ m|opac/myopac/circ_history/export|;
210 return $self->load_myopac_circ_history if $path =~ m|opac/myopac/circ_history|;
211 return $self->load_myopac_hold_history if $path =~ m|opac/myopac/hold_history|;
212 return $self->load_myopac_prefs_notify if $path =~ m|opac/myopac/prefs_notify|;
213 return $self->load_myopac_prefs_settings if $path =~ m|opac/myopac/prefs_settings|;
214 return $self->load_myopac_prefs_my_lists if $path =~ m|opac/myopac/prefs_my_lists|;
215 return $self->load_myopac_prefs if $path =~ m|opac/myopac/prefs|;
216 return $self->load_sms_cn if $path =~ m|opac/sms_cn|;
218 return Apache2::Const::OK;
222 # -----------------------------------------------------------------------------
223 # Redirect to SSL equivalent of a given page
224 # -----------------------------------------------------------------------------
227 my $new_page = sprintf('%s://%s%s', ($self->ctx->{is_staff} ? 'oils' : 'https'), $self->ctx->{hostname}, $self->apache->unparsed_uri);
228 return $self->generic_redirect($new_page);
231 # -----------------------------------------------------------------------------
232 # If an authnticated resource is requested w/o auth, redirect to the login page,
233 # then return to the originally requrested resource upon successful login.
234 # -----------------------------------------------------------------------------
237 my $login_page = sprintf('%s://%s%s/login',($self->ctx->{is_staff} ? 'oils' : 'https'), $self->ctx->{hostname}, $self->ctx->{opac_root});
238 my $redirect_to = uri_escape_utf8($self->apache->unparsed_uri);
239 return $self->generic_redirect("$login_page?redirect_to=$redirect_to");
242 # -----------------------------------------------------------------------------
243 # Fall-through for loading a basic page
244 # -----------------------------------------------------------------------------
246 my ($self, $page) = @_;
247 $self->ctx->{page} = $page;
248 $self->ctx->{search_ou} = $self->_get_search_lib();
250 return Apache2::Const::OK;
253 # -----------------------------------------------------------------------------
254 # Tests to see if the user is authenticated and sets some common context values
255 # -----------------------------------------------------------------------------
259 my $e = $self->editor;
260 my $ctx = $self->ctx;
262 # redirect non-https to https if we think we are already logged in
263 if ($self->cgi->cookie(COOKIE_LOGGEDIN)) {
264 return $self->redirect_ssl unless $self->cgi->https;
267 # XXX Cache this? Makes testing difficult as apache needs a restart.
268 my $default_sort = $e->retrieve_config_global_flag('opac.default_sort');
269 $ctx->{default_sort} =
270 ($default_sort && $U->is_true($default_sort->enabled)) ? $default_sort->value : '';
272 $ctx->{client_tz} = $self->cgi->cookie(COOKIE_TZ) || $ENV{TZ};
273 $ctx->{referer} = $self->cgi->referer;
274 $ctx->{path_info} = $self->cgi->path_info;
275 $ctx->{full_path} = $ctx->{base_path} . $self->cgi->path_info;
276 $ctx->{unparsed_uri} = $self->apache->unparsed_uri;
277 $ctx->{opac_root} = $ctx->{base_path} . "/opac"; # absolute base url
279 $ctx->{original_tz} = $ENV{TZ};
280 $ENV{TZ} = $ctx->{client_tz};
283 ($self->apache->headers_in->get('OILS-Wrapper') || '') =~ /true/;
287 $ctx->{is_staff} = 1;
288 $ctx->{proto} = 'oils';
289 $ctx->{hostname} = 'remote';
292 $ctx->{physical_loc} = $self->get_physical_loc;
294 # capture some commonly accessed pages
295 $ctx->{home_page} = $ctx->{proto} . '://' . $ctx->{hostname} . $self->ctx->{opac_root} . "/home";
296 $ctx->{logout_page} = ($ctx->{proto} eq 'http' ? 'https' : $ctx->{proto} ) . '://' . $ctx->{hostname} . $self->ctx->{opac_root} . "/logout";
298 if($e->authtoken($self->cgi->cookie(COOKIE_SES))) {
302 $ctx->{authtoken} = $e->authtoken;
303 $ctx->{authtime} = $e->authtime;
304 $ctx->{user} = $e->requestor;
305 my $card = $self->editor->retrieve_actor_card($ctx->{user}->card);
306 $ctx->{active_card} = (ref $card) ? $card->barcode : undef;
307 $ctx->{place_unfillable} = 1 if $e->requestor->wsid && $e->allowed('PLACE_UNFILLABLE_HOLD', $e->requestor->ws_ou);
309 # The browser client does not set an OILS-Wrapper header (above).
310 # The presence of a workstation and no header indicates staff mode.
311 # FIXME: this approach leaves un-wrapped TPAC's within the same
312 # browser (and hence same ses cookie) in an unnatural is_staff
313 # state. Consider alternatives for determining is_staff /
314 # is_browser_staff when $xul_wrapper is false.
315 if (!$xul_wrapper and $e->requestor->wsid) {
316 $ctx->{is_staff} = 1;
317 $ctx->{is_browser_staff} = 1;
320 $self->update_dashboard_stats();
324 # if we encounter a stale authtoken, call load_logout
325 # to clean up the cookie, then redirect the user to the
326 # originally requested page
327 return $self->load_logout($self->apache->unparsed_uri);
331 # List of <meta> and <link> elements to populate
332 $ctx->{metalinks} = [];
334 $self->extract_copy_location_group_info;
335 $ctx->{search_ou} = $self->_get_search_lib();
336 $self->staff_saved_searches_set_expansion_state if $ctx->{is_staff};
337 $self->load_eg_cache_hash;
338 $self->load_copy_location_groups;
339 $self->staff_saved_searches_set_expansion_state if $ctx->{is_staff};
340 $self->load_search_filter_groups($ctx->{search_ou});
341 $self->load_org_util_funcs;
342 $self->load_perm_funcs;
344 return Apache2::Const::OK;
347 sub update_dashboard_stats {
350 my $e = $self->editor;
351 my $ctx = $self->ctx;
353 $ctx->{user_stats} = $U->simplereq(
355 'open-ils.actor.user.opac.vital_stats',
356 $e->authtoken, $e->requestor->id);
359 sub staff_saved_searches_set_expansion_state {
362 my $param = $self->cgi->param('sss_expand');
365 if (defined $param) {
366 $value = ($param ? 1 : 0);
367 $self->apache->headers_out->add(
368 "Set-Cookie" => $self->cgi->cookie(
369 -name => COOKIE_SSS_EXPAND,
370 -path => $self->ctx->{base_path},
371 -secure => 1, # not strictly necessary, but this feature is staff-only, so may as well
377 $value = $self->cgi->cookie(COOKIE_SSS_EXPAND);
380 $self->ctx->{saved_searches_expanded} = $value;
383 # physical_loc (i.e. "original location") passed in as a URL
384 # param will replace any existing physical_loc stored as a cookie.
385 # If specified via ENV that rules over all and we don't set cookies.
386 sub get_physical_loc {
389 return $ENV{physical_loc} if($ENV{physical_loc});
391 if(my $physical_loc = $self->cgi->param('physical_loc')) {
392 $self->apache->headers_out->add(
393 "Set-Cookie" => $self->cgi->cookie(
394 -name => COOKIE_PHYSICAL_LOC,
395 -path => $self->ctx->{base_path},
396 -value => $physical_loc,
400 return $physical_loc;
403 return $self->cgi->cookie(COOKIE_PHYSICAL_LOC);
406 # -----------------------------------------------------------------------------
407 # Log in and redirect to the redirect_to URL (or home)
408 # -----------------------------------------------------------------------------
411 my $cgi = $self->cgi;
412 my $ctx = $self->ctx;
414 $self->timelog("Load login begins");
416 $ctx->{page} = 'login';
418 my $username = $cgi->param('username') || '';
419 $username =~ s/\s//g; # Remove blanks
420 my $password = $cgi->param('password');
421 my $org_unit = $ctx->{physical_loc} || $ctx->{aou_tree}->()->id;
422 my $persist = $cgi->param('persist');
423 my $client_tz = $cgi->param('client_tz');
425 # initial log form only
426 return Apache2::Const::OK unless $username and $password;
428 my $auth_proxy_enabled = 0; # default false
429 try { # if the service is not running, just let this fail silently
430 $auth_proxy_enabled = $U->simplereq(
431 'open-ils.auth_proxy',
432 'open-ils.auth_proxy.enabled');
433 } catch Error with {};
435 $self->timelog("Checked for auth proxy: $auth_proxy_enabled; org = $org_unit; username = $username");
438 type => ($persist) ? 'persist' : 'opac',
443 my $bc_regex = $ctx->{get_org_setting}->($org_unit, 'opac.barcode_regex');
445 # To avoid surprises, default to "Barcodes start with digits"
446 $bc_regex = '^\d' unless $bc_regex;
448 if ($bc_regex and ($username =~ /$bc_regex/)) {
449 $args->{barcode} = $username;
451 $args->{username} = $username;
455 if (!$auth_proxy_enabled) {
456 my $seed = $U->simplereq(
458 'open-ils.auth.authenticate.init', $username);
459 $args->{password} = md5_hex($seed . md5_hex($password));
460 $response = $U->simplereq(
461 'open-ils.auth', 'open-ils.auth.authenticate.complete', $args);
463 $args->{password} = $password;
464 $response = $U->simplereq(
465 'open-ils.auth_proxy',
466 'open-ils.auth_proxy.login', $args);
468 $self->timelog("Checked password");
470 if($U->event_code($response)) {
471 # login failed, report the reason to the template
472 $ctx->{login_failed_event} = $response;
473 return Apache2::Const::OK;
476 # login succeeded, redirect as necessary
478 my $acct = $self->apache->unparsed_uri;
479 $acct =~ s|/login|/myopac/main|;
481 # both login-related cookies should expire at the same time
482 my $login_cookie_expires = ($persist) ? CORE::time + $response->{payload}->{authtime} : undef;
485 # contains the actual auth token and should be sent only over https
490 -value => $response->{payload}->{authtoken},
491 -expires => $login_cookie_expires
493 # contains only a hint that we are logged in, and is used to
494 # trigger a redirect to https
496 -name => COOKIE_LOGGEDIN,
500 -expires => $login_cookie_expires
505 # contains the client's tz, as passed by the client
506 # trigger a redirect to https
507 push @$cookie_list, $cgi->cookie(
511 -value => $client_tz,
512 -expires => $login_cookie_expires
516 return $self->generic_redirect(
517 $cgi->param('redirect_to') || $acct,
522 # -----------------------------------------------------------------------------
523 # Log out and redirect to the home page
524 # -----------------------------------------------------------------------------
527 my $redirect_to = shift || $self->cgi->param('redirect_to');
529 # If the user was adding anyting to an anonymous cache
530 # while logged in, go ahead and clear it out.
531 $self->clear_anon_cache;
533 try { # a missing auth token will cause an ugly explosion
536 'open-ils.auth.session.delete',
537 $self->cgi->cookie(COOKIE_SES)
539 } catch Error with {};
541 return $self->generic_redirect(
542 $redirect_to || $self->ctx->{home_page},
544 # clear value of and expire both of these login-related cookies
552 -name => COOKIE_LOGGEDIN,