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_PHYSICAL_LOC => 'eg_physical_loc';
31 use constant COOKIE_SSS_EXPAND => 'eg_sss_expand';
33 use constant COOKIE_ANON_CACHE => 'anoncache';
34 use constant ANON_CACHE_MYLIST => 'mylist';
35 use constant ANON_CACHE_STAFF_SEARCH => 'staffsearch';
37 use constant DEBUG_TIMING => 0;
40 my($class, $apache, $ctx) = @_;
42 my $self = bless({}, ref($class) || $class);
44 $self->apache($apache);
47 $self->timelog("New page");
49 OpenILS::Utils::CStoreEditor->init; # just in case
50 $self->editor(new_editor());
56 # current Apache2::RequestRec;
58 my($self, $apache) = @_;
59 $self->{apache} = $apache if $apache;
60 return $self->{apache};
63 # runtime / template context
66 $self->{ctx} = $ctx if $ctx;
72 my($self, $editor) = @_;
73 $self->{editor} = $editor if $editor;
74 return $self->{editor};
80 $self->{cgi} = $cgi if $cgi;
85 my($self, $description) = @_;
87 return unless DEBUG_TIMING;
88 return unless $description;
89 $self->ctx->{timing} ||= [];
91 my $timer = [Time::HiRes::gettimeofday()];
92 $self->ctx->{time_begin} ||= $timer;
94 push @{$self->ctx->{timing}}, [
95 Time::HiRes::tv_interval($self->ctx->{time_begin}, $timer), $description
99 # -----------------------------------------------------------------------------
100 # Perform initial setup, load common data, then load page data
101 # -----------------------------------------------------------------------------
105 $self->init_ro_object_cache;
106 $self->timelog("Initial load");
108 my $stat = $self->load_common;
109 return $stat unless $stat == Apache2::Const::OK;
111 my $path = $self->apache->path_info;
113 (undef, $self->ctx->{mylist}) = $self->fetch_mylist unless
114 $path =~ /opac\/my(opac\/lists|list)/;
116 return $self->load_simple("home") if $path =~ m|opac/home|;
117 return $self->load_simple("advanced") if
118 $path =~ m:opac/(advanced|numeric|expert):;
120 return $self->load_rresults if $path =~ m|opac/results|;
121 return $self->load_print_record if $path =~ m|opac/record/print|;
122 return $self->load_record if $path =~ m|opac/record/\d|;
123 return $self->load_cnbrowse if $path =~ m|opac/cnbrowse|;
125 return $self->load_mylist_add if $path =~ m|opac/mylist/add|;
126 return $self->load_mylist_delete if $path =~ m|opac/mylist/delete|;
127 return $self->load_mylist_move if $path =~ m|opac/mylist/move|;
128 return $self->load_mylist if $path =~ m|opac/mylist|;
129 return $self->load_cache_clear if $path =~ m|opac/cache/clear|;
131 # ----------------------------------------------------------------
132 # Everything below here requires SSL
133 # ----------------------------------------------------------------
134 return $self->redirect_ssl unless $self->cgi->https;
135 return $self->load_password_reset if $path =~ m|opac/password_reset|;
136 return $self->load_logout if $path =~ m|opac/logout|;
138 if($path =~ m|opac/login|) {
139 return $self->load_login unless $self->editor->requestor; # already logged in?
141 # This will be less confusing to users than to be shown a login form
142 # when they're already logged in.
143 return $self->generic_redirect(
145 "https://%s%s/myopac/main",
146 $self->apache->hostname, $self->ctx->{opac_root}
151 if ($path =~ m|opac/sms_cn| and !$self->editor->requestor) {
152 my $org_unit = $self->ctx->{physical_loc} || $self->cgi->param('loc') || $self->ctx->{aou_tree}->()->id;
153 my $skip_sms_auth = $self->ctx->{get_org_setting}->($org_unit, 'sms.disable_authentication_requirement.callnumbers');
154 return $self->load_sms_cn if $skip_sms_auth;
157 # ----------------------------------------------------------------
158 # Everything below here requires authentication
159 # ----------------------------------------------------------------
160 return $self->redirect_auth unless $self->editor->requestor;
162 # Don't cache anything requiring auth for security reasons
163 $self->apache->headers_out->add("cache-control" => "no-store, no-cache, must-revalidate");
164 $self->apache->headers_out->add("expires" => "-1");
166 return $self->load_email_record if $path =~ m|opac/record/email|;
168 return $self->load_place_hold if $path =~ m|opac/place_hold|;
169 return $self->load_myopac_holds if $path =~ m|opac/myopac/holds|;
170 return $self->load_myopac_circs if $path =~ m|opac/myopac/circs|;
171 return $self->load_myopac_payment_form if $path =~ m|opac/myopac/main_payment_form|;
172 return $self->load_myopac_payments if $path =~ m|opac/myopac/main_payments|;
173 return $self->load_myopac_pay_init if $path =~ m|opac/myopac/main_pay_init|;
174 return $self->load_myopac_pay if $path =~ m|opac/myopac/main_pay|;
175 return $self->load_myopac_main if $path =~ m|opac/myopac/main|;
176 return $self->load_myopac_receipt_email if $path =~ m|opac/myopac/receipt_email|;
177 return $self->load_myopac_receipt_print if $path =~ m|opac/myopac/receipt_print|;
178 return $self->load_myopac_update_email if $path =~ m|opac/myopac/update_email|;
179 return $self->load_myopac_update_password if $path =~ m|opac/myopac/update_password|;
180 return $self->load_myopac_update_username if $path =~ m|opac/myopac/update_username|;
181 return $self->load_myopac_bookbags if $path =~ m|opac/myopac/lists|;
182 return $self->load_myopac_bookbag_print if $path =~ m|opac/myopac/list/print|;
183 return $self->load_myopac_bookbag_update if $path =~ m|opac/myopac/list/update|;
184 return $self->load_myopac_circ_history_export if $path =~ m|opac/myopac/circ_history/export|;
185 return $self->load_myopac_circ_history if $path =~ m|opac/myopac/circ_history|;
186 return $self->load_myopac_hold_history if $path =~ m|opac/myopac/hold_history|;
187 return $self->load_myopac_prefs_notify if $path =~ m|opac/myopac/prefs_notify|;
188 return $self->load_myopac_prefs_settings if $path =~ m|opac/myopac/prefs_settings|;
189 return $self->load_myopac_prefs if $path =~ m|opac/myopac/prefs|;
190 return $self->load_sms_cn if $path =~ m|opac/sms_cn|;
192 return Apache2::Const::OK;
196 # -----------------------------------------------------------------------------
197 # Redirect to SSL equivalent of a given page
198 # -----------------------------------------------------------------------------
201 my $new_page = sprintf('https://%s%s', $self->apache->hostname, $self->apache->unparsed_uri);
202 return $self->generic_redirect($new_page);
205 # -----------------------------------------------------------------------------
206 # If an authnticated resource is requested w/o auth, redirect to the login page,
207 # then return to the originally requrested resource upon successful login.
208 # -----------------------------------------------------------------------------
211 my $login_page = sprintf('https://%s%s/login', $self->apache->hostname, $self->ctx->{opac_root});
212 my $redirect_to = uri_escape($self->apache->unparsed_uri);
213 return $self->generic_redirect("$login_page?redirect_to=$redirect_to");
216 # -----------------------------------------------------------------------------
217 # Fall-through for loading a basic page
218 # -----------------------------------------------------------------------------
220 my ($self, $page) = @_;
221 $self->ctx->{page} = $page;
222 $self->ctx->{search_ou} = $self->_get_search_lib();
224 return Apache2::Const::OK;
227 # -----------------------------------------------------------------------------
228 # Tests to see if the user is authenticated and sets some common context values
229 # -----------------------------------------------------------------------------
233 my $e = $self->editor;
234 my $ctx = $self->ctx;
236 $ctx->{referer} = $self->cgi->referer;
237 $ctx->{path_info} = $self->cgi->path_info;
238 $ctx->{full_path} = $ctx->{base_path} . $self->cgi->path_info;
239 $ctx->{unparsed_uri} = $self->apache->unparsed_uri;
240 $ctx->{opac_root} = $ctx->{base_path} . "/opac"; # absolute base url
241 $ctx->{is_staff} = 0; # Assume false, check for workstation id later. Was: ($self->apache->headers_in->get('User-Agent') =~ /oils_xulrunner/);
242 $ctx->{physical_loc} = $self->get_physical_loc;
244 # capture some commonly accessed pages
245 $ctx->{home_page} = 'http://' . $self->apache->hostname . $self->ctx->{opac_root} . "/home";
246 $ctx->{logout_page} = 'https://' . $self->apache->hostname . $self->ctx->{opac_root} . "/logout";
248 if($e->authtoken($self->cgi->cookie(COOKIE_SES))) {
252 $ctx->{authtoken} = $e->authtoken;
253 $ctx->{authtime} = $e->authtime;
254 $ctx->{user} = $e->requestor;
256 $ctx->{user_stats} = $U->simplereq(
258 'open-ils.actor.user.opac.vital_stats',
259 $e->authtoken, $e->requestor->id);
260 $ctx->{is_staff} = 1 if $e->requestor->wsid;
264 # if we encounter a stale authtoken, call load_logout
265 # to clean up the cookie, then redirect the user to the
266 # originally requested page
267 return $self->load_logout($self->apache->unparsed_uri);
271 $self->extract_copy_location_group_info;
272 $ctx->{search_ou} = $self->_get_search_lib();
273 $self->staff_saved_searches_set_expansion_state if $ctx->{is_staff};
274 $self->load_eg_cache_hash;
275 $self->load_copy_location_groups;
276 $self->staff_saved_searches_set_expansion_state if $ctx->{is_staff};
277 $self->load_search_filter_groups($ctx->{search_ou});
279 return Apache2::Const::OK;
282 sub staff_saved_searches_set_expansion_state {
285 my $param = $self->cgi->param('sss_expand');
288 if (defined $param) {
289 $value = ($param ? 1 : 0);
290 $self->apache->headers_out->add(
291 "Set-Cookie" => $self->cgi->cookie(
292 -name => COOKIE_SSS_EXPAND,
293 -path => $self->ctx->{base_path},
294 -secure => 1, # not strictly necessary, but this feature is staff-only, so may as well
300 $value = $self->cgi->cookie(COOKIE_SSS_EXPAND);
303 $self->ctx->{saved_searches_expanded} = $value;
306 # physical_loc (i.e. "original location") passed in as a URL
307 # param will replace any existing physical_loc stored as a cookie.
308 sub get_physical_loc {
311 if(my $physical_loc = $self->cgi->param('physical_loc')) {
312 $self->apache->headers_out->add(
313 "Set-Cookie" => $self->cgi->cookie(
314 -name => COOKIE_PHYSICAL_LOC,
315 -path => $self->ctx->{base_path},
316 -value => $physical_loc,
320 return $physical_loc;
323 return $self->cgi->cookie(COOKIE_PHYSICAL_LOC);
326 # -----------------------------------------------------------------------------
327 # Log in and redirect to the redirect_to URL (or home)
328 # -----------------------------------------------------------------------------
331 my $cgi = $self->cgi;
332 my $ctx = $self->ctx;
334 $ctx->{page} = 'login';
336 my $username = $cgi->param('username');
337 my $password = $cgi->param('password');
338 my $org_unit = $cgi->param('loc') || $ctx->{aou_tree}->()->id;
339 my $persist = $cgi->param('persist');
341 # initial log form only
342 return Apache2::Const::OK unless $username and $password;
344 my $seed = $U->simplereq(
346 'open-ils.auth.authenticate.init', $username);
349 username => $username,
350 password => md5_hex($seed . md5_hex($password)),
351 type => ($persist) ? 'persist' : 'opac',
355 my $bc_regex = $ctx->{get_org_setting}->($org_unit, 'opac.barcode_regex');
357 # To avoid surprises, default to "Barcodes start with digits"
358 $bc_regex = '^\d' unless $bc_regex;
360 $args->{barcode} = delete $args->{username}
361 if $bc_regex and ($username =~ /$bc_regex/);
363 my $response = $U->simplereq(
364 'open-ils.auth', 'open-ils.auth.authenticate.complete', $args);
366 if($U->event_code($response)) {
367 # login failed, report the reason to the template
368 $ctx->{login_failed_event} = $response;
369 return Apache2::Const::OK;
372 # login succeeded, redirect as necessary
374 my $acct = $self->apache->unparsed_uri;
375 $acct =~ s|/login|/myopac/main|;
377 return $self->generic_redirect(
378 $cgi->param('redirect_to') || $acct,
383 -value => $response->{payload}->{authtoken},
384 -expires => ($persist) ? CORE::time + $response->{payload}->{authtime} : undef
389 # -----------------------------------------------------------------------------
390 # Log out and redirect to the home page
391 # -----------------------------------------------------------------------------
394 my $redirect_to = shift;
396 # If the user was adding anyting to an anonymous cache
397 # while logged in, go ahead and clear it out.
398 $self->clear_anon_cache;
400 return $self->generic_redirect(
401 $redirect_to || $self->ctx->{home_page},