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::Search;
23 use OpenILS::WWW::EGCatLoader::Record;
24 use OpenILS::WWW::EGCatLoader::Container;
25 use OpenILS::WWW::EGCatLoader::SMS;
27 my $U = 'OpenILS::Application::AppUtils';
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';
34 use constant COOKIE_ANON_CACHE => 'anoncache';
35 use constant ANON_CACHE_MYLIST => 'mylist';
36 use constant ANON_CACHE_STAFF_SEARCH => 'staffsearch';
38 use constant DEBUG_TIMING => 0;
41 my($class, $apache, $ctx) = @_;
43 my $self = bless({}, ref($class) || $class);
45 $self->apache($apache);
48 $self->timelog("New page");
50 OpenILS::Utils::CStoreEditor->init; # just in case
51 $self->editor(new_editor());
57 # current Apache2::RequestRec;
59 my($self, $apache) = @_;
60 $self->{apache} = $apache if $apache;
61 return $self->{apache};
64 # runtime / template context
67 $self->{ctx} = $ctx if $ctx;
73 my($self, $editor) = @_;
74 $self->{editor} = $editor if $editor;
75 return $self->{editor};
81 $self->{cgi} = $cgi if $cgi;
86 my($self, $description) = @_;
88 return unless DEBUG_TIMING;
89 return unless $description;
90 $self->ctx->{timing} ||= [];
92 my $timer = [Time::HiRes::gettimeofday()];
93 $self->ctx->{time_begin} ||= $timer;
95 push @{$self->ctx->{timing}}, [
96 Time::HiRes::tv_interval($self->ctx->{time_begin}, $timer), $description
100 # -----------------------------------------------------------------------------
101 # Perform initial setup, load common data, then load page data
102 # -----------------------------------------------------------------------------
106 $self->init_ro_object_cache;
107 $self->timelog("Initial load");
109 my $stat = $self->load_common;
110 return $stat unless $stat == Apache2::Const::OK;
112 my $path = $self->apache->path_info;
114 (undef, $self->ctx->{mylist}) = $self->fetch_mylist unless
115 $path =~ /opac\/my(opac\/lists|list)/;
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):;
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|;
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|;
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|;
142 if($path =~ m|opac/login|) {
143 return $self->load_login unless $self->editor->requestor; # already logged in?
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(
149 "https://%s%s/myopac/main",
150 $self->apache->hostname, $self->ctx->{opac_root}
155 if ($path =~ m|opac/sms_cn| and !$self->editor->requestor) {
156 my $org_unit = $self->ctx->{physical_loc} || $self->cgi->param('loc') || $self->ctx->{aou_tree}->()->id;
157 my $skip_sms_auth = $self->ctx->{get_org_setting}->($org_unit, 'sms.disable_authentication_requirement.callnumbers');
158 return $self->load_sms_cn if $skip_sms_auth;
161 # ----------------------------------------------------------------
162 # Everything below here requires authentication
163 # ----------------------------------------------------------------
164 return $self->redirect_auth unless $self->editor->requestor;
166 # Don't cache anything requiring auth for security reasons
167 $self->apache->headers_out->add("cache-control" => "no-store, no-cache, must-revalidate");
168 $self->apache->headers_out->add("expires" => "-1");
170 return $self->load_email_record if $path =~ m|opac/record/email|;
172 return $self->load_place_hold if $path =~ m|opac/place_hold|;
173 return $self->load_myopac_holds if $path =~ m|opac/myopac/holds|;
174 return $self->load_myopac_circs if $path =~ m|opac/myopac/circs|;
175 return $self->load_myopac_payment_form if $path =~ m|opac/myopac/main_payment_form|;
176 return $self->load_myopac_payments if $path =~ m|opac/myopac/main_payments|;
177 return $self->load_myopac_pay_init if $path =~ m|opac/myopac/main_pay_init|;
178 return $self->load_myopac_pay if $path =~ m|opac/myopac/main_pay|;
179 return $self->load_myopac_main if $path =~ m|opac/myopac/main|;
180 return $self->load_myopac_receipt_email if $path =~ m|opac/myopac/receipt_email|;
181 return $self->load_myopac_receipt_print if $path =~ m|opac/myopac/receipt_print|;
182 return $self->load_myopac_update_email if $path =~ m|opac/myopac/update_email|;
183 return $self->load_myopac_update_password if $path =~ m|opac/myopac/update_password|;
184 return $self->load_myopac_update_username if $path =~ m|opac/myopac/update_username|;
185 return $self->load_myopac_bookbags if $path =~ m|opac/myopac/lists|;
186 return $self->load_myopac_bookbag_print if $path =~ m|opac/myopac/list/print|;
187 return $self->load_myopac_bookbag_update if $path =~ m|opac/myopac/list/update|;
188 return $self->load_myopac_circ_history_export if $path =~ m|opac/myopac/circ_history/export|;
189 return $self->load_myopac_circ_history if $path =~ m|opac/myopac/circ_history|;
190 return $self->load_myopac_hold_history if $path =~ m|opac/myopac/hold_history|;
191 return $self->load_myopac_prefs_notify if $path =~ m|opac/myopac/prefs_notify|;
192 return $self->load_myopac_prefs_settings if $path =~ m|opac/myopac/prefs_settings|;
193 return $self->load_myopac_prefs if $path =~ m|opac/myopac/prefs|;
194 return $self->load_sms_cn if $path =~ m|opac/sms_cn|;
196 return Apache2::Const::OK;
200 # -----------------------------------------------------------------------------
201 # Redirect to SSL equivalent of a given page
202 # -----------------------------------------------------------------------------
205 my $new_page = sprintf('https://%s%s', $self->apache->hostname, $self->apache->unparsed_uri);
206 return $self->generic_redirect($new_page);
209 # -----------------------------------------------------------------------------
210 # If an authnticated resource is requested w/o auth, redirect to the login page,
211 # then return to the originally requrested resource upon successful login.
212 # -----------------------------------------------------------------------------
215 my $login_page = sprintf('https://%s%s/login', $self->apache->hostname, $self->ctx->{opac_root});
216 my $redirect_to = uri_escape($self->apache->unparsed_uri);
217 return $self->generic_redirect("$login_page?redirect_to=$redirect_to");
220 # -----------------------------------------------------------------------------
221 # Fall-through for loading a basic page
222 # -----------------------------------------------------------------------------
224 my ($self, $page) = @_;
225 $self->ctx->{page} = $page;
226 $self->ctx->{search_ou} = $self->_get_search_lib();
228 return Apache2::Const::OK;
231 # -----------------------------------------------------------------------------
232 # Tests to see if the user is authenticated and sets some common context values
233 # -----------------------------------------------------------------------------
237 my $e = $self->editor;
238 my $ctx = $self->ctx;
240 # redirect non-https to https if we think we are already logged in
241 if ($self->cgi->cookie(COOKIE_LOGGEDIN)) {
242 return $self->redirect_ssl unless $self->cgi->https;
245 $ctx->{referer} = $self->cgi->referer;
246 $ctx->{path_info} = $self->cgi->path_info;
247 $ctx->{full_path} = $ctx->{base_path} . $self->cgi->path_info;
248 $ctx->{unparsed_uri} = $self->apache->unparsed_uri;
249 $ctx->{opac_root} = $ctx->{base_path} . "/opac"; # absolute base url
250 my $oils_wrapper = $self->apache->headers_in->get('OILS-Wrapper') || '';
251 $ctx->{is_staff} = ($oils_wrapper =~ /true/);
252 $ctx->{proto} = 'oils' if $ctx->{is_staff};
253 $ctx->{physical_loc} = $self->get_physical_loc;
255 # capture some commonly accessed pages
256 $ctx->{home_page} = 'http://' . $self->apache->hostname . $self->ctx->{opac_root} . "/home";
257 $ctx->{logout_page} = 'https://' . $self->apache->hostname . $self->ctx->{opac_root} . "/logout";
259 if($e->authtoken($self->cgi->cookie(COOKIE_SES))) {
263 $ctx->{authtoken} = $e->authtoken;
264 $ctx->{authtime} = $e->authtime;
265 $ctx->{user} = $e->requestor;
266 $ctx->{place_unfillable} = 1 if $e->requestor->wsid && $e->allowed('PLACE_UNFILLABLE_HOLD', $e->requestor->ws_ou);
268 $ctx->{user_stats} = $U->simplereq(
270 'open-ils.actor.user.opac.vital_stats',
271 $e->authtoken, $e->requestor->id);
275 # if we encounter a stale authtoken, call load_logout
276 # to clean up the cookie, then redirect the user to the
277 # originally requested page
278 return $self->load_logout($self->apache->unparsed_uri);
282 $self->extract_copy_location_group_info;
283 $ctx->{search_ou} = $self->_get_search_lib();
284 $self->staff_saved_searches_set_expansion_state if $ctx->{is_staff};
285 $self->load_eg_cache_hash;
286 $self->load_copy_location_groups;
287 $self->staff_saved_searches_set_expansion_state if $ctx->{is_staff};
288 $self->load_search_filter_groups($ctx->{search_ou});
290 return Apache2::Const::OK;
293 sub staff_saved_searches_set_expansion_state {
296 my $param = $self->cgi->param('sss_expand');
299 if (defined $param) {
300 $value = ($param ? 1 : 0);
301 $self->apache->headers_out->add(
302 "Set-Cookie" => $self->cgi->cookie(
303 -name => COOKIE_SSS_EXPAND,
304 -path => $self->ctx->{base_path},
305 -secure => 1, # not strictly necessary, but this feature is staff-only, so may as well
311 $value = $self->cgi->cookie(COOKIE_SSS_EXPAND);
314 $self->ctx->{saved_searches_expanded} = $value;
317 # physical_loc (i.e. "original location") passed in as a URL
318 # param will replace any existing physical_loc stored as a cookie.
319 # If specified via ENV that rules over all and we don't set cookies.
320 sub get_physical_loc {
323 return $ENV{physical_loc} if($ENV{physical_loc});
325 if(my $physical_loc = $self->cgi->param('physical_loc')) {
326 $self->apache->headers_out->add(
327 "Set-Cookie" => $self->cgi->cookie(
328 -name => COOKIE_PHYSICAL_LOC,
329 -path => $self->ctx->{base_path},
330 -value => $physical_loc,
334 return $physical_loc;
337 return $self->cgi->cookie(COOKIE_PHYSICAL_LOC);
340 # -----------------------------------------------------------------------------
341 # Log in and redirect to the redirect_to URL (or home)
342 # -----------------------------------------------------------------------------
345 my $cgi = $self->cgi;
346 my $ctx = $self->ctx;
348 $self->timelog("Load login begins");
350 $ctx->{page} = 'login';
352 my $username = $cgi->param('username');
353 my $password = $cgi->param('password');
354 my $org_unit = $ctx->{physical_loc} || $ctx->{aou_tree}->()->id;
355 my $persist = $cgi->param('persist');
357 # initial log form only
358 return Apache2::Const::OK unless $username and $password;
360 my $auth_proxy_enabled = 0; # default false
361 try { # if the service is not running, just let this fail silently
362 $auth_proxy_enabled = $U->simplereq(
363 'open-ils.auth_proxy',
364 'open-ils.auth_proxy.enabled');
365 } catch Error with {};
367 $self->timelog("Checked for auth proxy: $auth_proxy_enabled; org = $org_unit; username = $username");
370 type => ($persist) ? 'persist' : 'opac',
375 my $bc_regex = $ctx->{get_org_setting}->($org_unit, 'opac.barcode_regex');
377 # To avoid surprises, default to "Barcodes start with digits"
378 $bc_regex = '^\d' unless $bc_regex;
380 if ($bc_regex and ($username =~ /$bc_regex/)) {
381 $args->{barcode} = $username;
383 $args->{username} = $username;
387 if (!$auth_proxy_enabled) {
388 my $seed = $U->simplereq(
390 'open-ils.auth.authenticate.init', $username);
391 $args->{password} = md5_hex($seed . md5_hex($password));
392 $response = $U->simplereq(
393 'open-ils.auth', 'open-ils.auth.authenticate.complete', $args);
395 $args->{password} = $password;
396 $response = $U->simplereq(
397 'open-ils.auth_proxy',
398 'open-ils.auth_proxy.login', $args);
400 $self->timelog("Checked password");
402 if($U->event_code($response)) {
403 # login failed, report the reason to the template
404 $ctx->{login_failed_event} = $response;
405 return Apache2::Const::OK;
408 # login succeeded, redirect as necessary
410 my $acct = $self->apache->unparsed_uri;
411 $acct =~ s|/login|/myopac/main|;
413 # both login-related cookies should expire at the same time
414 my $login_cookie_expires = ($persist) ? CORE::time + $response->{payload}->{authtime} : undef;
416 return $self->generic_redirect(
417 $cgi->param('redirect_to') || $acct,
419 # contains the actual auth token and should be sent only over https
424 -value => $response->{payload}->{authtoken},
425 -expires => $login_cookie_expires
427 # contains only a hint that we are logged in, and is used to
428 # trigger a redirect to https
430 -name => COOKIE_LOGGEDIN,
434 -expires => $login_cookie_expires
440 # -----------------------------------------------------------------------------
441 # Log out and redirect to the home page
442 # -----------------------------------------------------------------------------
445 my $redirect_to = shift || $self->cgi->param('redirect_to');
447 # If the user was adding anyting to an anonymous cache
448 # while logged in, go ahead and clear it out.
449 $self->clear_anon_cache;
451 return $self->generic_redirect(
452 $redirect_to || $self->ctx->{home_page},
454 # clear value of and expire both of these login-related cookies
462 -name => COOKIE_LOGGEDIN,