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);
18 # EGCatLoader sub-modules
19 use OpenILS::WWW::EGCatLoader::Util;
20 use OpenILS::WWW::EGCatLoader::Account;
21 use OpenILS::WWW::EGCatLoader::Search;
22 use OpenILS::WWW::EGCatLoader::Record;
23 use OpenILS::WWW::EGCatLoader::Container;
25 my $U = 'OpenILS::Application::AppUtils';
27 use constant COOKIE_SES => 'ses';
28 use constant COOKIE_PHYSICAL_LOC => 'eg_physical_loc';
29 use constant COOKIE_SSS_EXPAND => 'eg_sss_expand';
31 use constant COOKIE_ANON_CACHE => 'anoncache';
32 use constant ANON_CACHE_MYLIST => 'mylist';
33 use constant ANON_CACHE_STAFF_SEARCH => 'staffsearch';
36 my($class, $apache, $ctx) = @_;
38 my $self = bless({}, ref($class) || $class);
40 $self->apache($apache);
44 OpenILS::Utils::CStoreEditor->init; # just in case
45 $self->editor(new_editor());
51 # current Apache2::RequestRec;
53 my($self, $apache) = @_;
54 $self->{apache} = $apache if $apache;
55 return $self->{apache};
58 # runtime / template context
61 $self->{ctx} = $ctx if $ctx;
67 my($self, $editor) = @_;
68 $self->{editor} = $editor if $editor;
69 return $self->{editor};
75 $self->{cgi} = $cgi if $cgi;
80 # -----------------------------------------------------------------------------
81 # Perform initial setup, load common data, then load page data
82 # -----------------------------------------------------------------------------
86 $self->init_ro_object_cache;
88 my $stat = $self->load_common;
89 return $stat unless $stat == Apache2::Const::OK;
91 my $path = $self->apache->path_info;
93 (undef, $self->ctx->{mylist}) = $self->fetch_mylist unless
94 $path =~ /opac\/my(opac\/lists|list)/;
96 return $self->load_simple("home") if $path =~ m|opac/home|;
97 return $self->load_simple("advanced") if
98 $path =~ m:opac/(advanced|numeric|expert):;
100 return $self->load_rresults if $path =~ m|opac/results|;
101 return $self->load_record if $path =~ m|opac/record|;
102 return $self->load_cnbrowse if $path =~ m|opac/cnbrowse|;
104 return $self->load_mylist_add if $path =~ m|opac/mylist/add|;
105 return $self->load_mylist_delete if $path =~ m|opac/mylist/delete|;
106 return $self->load_mylist_move if $path =~ m|opac/mylist/move|;
107 return $self->load_mylist if $path =~ m|opac/mylist|;
108 return $self->load_cache_clear if $path =~ m|opac/cache/clear|;
110 # ----------------------------------------------------------------
111 # Everything below here requires SSL
112 # ----------------------------------------------------------------
113 return $self->redirect_ssl unless $self->cgi->https;
114 return $self->load_password_reset if $path =~ m|opac/password_reset|;
115 return $self->load_logout if $path =~ m|opac/logout|;
117 if($path =~ m|opac/login|) {
118 return $self->load_login unless $self->editor->requestor; # already logged in?
120 # This will be less confusing to users than to be shown a login form
121 # when they're already logged in.
122 return $self->generic_redirect(
124 "https://%s%s/myopac/main",
125 $self->apache->hostname, $self->ctx->{opac_root}
130 # ----------------------------------------------------------------
131 # Everything below here requires authentication
132 # ----------------------------------------------------------------
133 return $self->redirect_auth unless $self->editor->requestor;
135 return $self->load_place_hold if $path =~ m|opac/place_hold|;
136 return $self->load_myopac_holds if $path =~ m|opac/myopac/holds|;
137 return $self->load_myopac_circs if $path =~ m|opac/myopac/circs|;
138 return $self->load_myopac_payment_form if $path =~ m|opac/myopac/main_payment_form|;
139 return $self->load_myopac_payments if $path =~ m|opac/myopac/main_payments|;
140 return $self->load_myopac_pay if $path =~ m|opac/myopac/main_pay|;
141 return $self->load_myopac_main if $path =~ m|opac/myopac/main|;
142 return $self->load_myopac_receipt_email if $path =~ m|opac/myopac/receipt_email|;
143 return $self->load_myopac_receipt_print if $path =~ m|opac/myopac/receipt_print|;
144 return $self->load_myopac_update_email if $path =~ m|opac/myopac/update_email|;
145 return $self->load_myopac_update_password if $path =~ m|opac/myopac/update_password|;
146 return $self->load_myopac_update_username if $path =~ m|opac/myopac/update_username|;
147 return $self->load_myopac_bookbags if $path =~ m|opac/myopac/lists|;
148 return $self->load_myopac_bookbag_print if $path =~ m|opac/myopac/list/print|;
149 return $self->load_myopac_bookbag_update if $path =~ m|opac/myopac/list/update|;
150 return $self->load_myopac_circ_history if $path =~ m|opac/myopac/circ_history|;
151 return $self->load_myopac_hold_history if $path =~ m|opac/myopac/hold_history|;
152 return $self->load_myopac_prefs_notify if $path =~ m|opac/myopac/prefs_notify|;
153 return $self->load_myopac_prefs_settings if $path =~ m|opac/myopac/prefs_settings|;
154 return $self->load_myopac_prefs if $path =~ m|opac/myopac/prefs|;
156 return Apache2::Const::OK;
160 # -----------------------------------------------------------------------------
161 # Redirect to SSL equivalent of a given page
162 # -----------------------------------------------------------------------------
165 my $new_page = sprintf('https://%s%s', $self->apache->hostname, $self->apache->unparsed_uri);
166 return $self->generic_redirect($new_page);
169 # -----------------------------------------------------------------------------
170 # If an authnticated resource is requested w/o auth, redirect to the login page,
171 # then return to the originally requrested resource upon successful login.
172 # -----------------------------------------------------------------------------
175 my $login_page = sprintf('https://%s%s/login', $self->apache->hostname, $self->ctx->{opac_root});
176 my $redirect_to = uri_escape($self->apache->unparsed_uri);
177 return $self->generic_redirect("$login_page?redirect_to=$redirect_to");
180 # -----------------------------------------------------------------------------
181 # Fall-through for loading a basic page
182 # -----------------------------------------------------------------------------
184 my ($self, $page) = @_;
185 $self->ctx->{page} = $page;
186 $self->ctx->{search_ou} = $self->_get_search_lib();
188 if (my $patron_barcode = $self->cgi->param("patron_barcode")) {
189 # Special CGI variable from staff client; propagate henceforth as cookie
190 $self->apache->headers_out->add(
191 "Set-Cookie" => $self->cgi->cookie(
192 -name => "patron_barcode",
195 -value => $patron_barcode,
200 return Apache2::Const::OK;
203 # -----------------------------------------------------------------------------
204 # Tests to see if the user is authenticated and sets some common context values
205 # -----------------------------------------------------------------------------
209 my $e = $self->editor;
210 my $ctx = $self->ctx;
212 $ctx->{referer} = $self->cgi->referer;
213 $ctx->{path_info} = $self->cgi->path_info;
214 $ctx->{full_path} = $ctx->{base_path} . $self->cgi->path_info;
215 $ctx->{unparsed_uri} = $self->apache->unparsed_uri;
216 $ctx->{opac_root} = $ctx->{base_path} . "/opac"; # absolute base url
217 $ctx->{is_staff} = 0; # Assume false, check for workstation id later. Was: ($self->apache->headers_in->get('User-Agent') =~ /oils_xulrunner/);
218 $ctx->{physical_loc} = $self->get_physical_loc;
220 # capture some commonly accessed pages
221 $ctx->{home_page} = 'http://' . $self->apache->hostname . $self->ctx->{opac_root} . "/home";
222 $ctx->{logout_page} = 'https://' . $self->apache->hostname . $self->ctx->{opac_root} . "/logout";
224 if($e->authtoken($self->cgi->cookie(COOKIE_SES))) {
228 $ctx->{authtoken} = $e->authtoken;
229 $ctx->{authtime} = $e->authtime;
230 $ctx->{user} = $e->requestor;
232 $ctx->{user_stats} = $U->simplereq(
234 'open-ils.actor.user.opac.vital_stats',
235 $e->authtoken, $e->requestor->id);
236 $ctx->{is_staff} = 1 if $e->requestor->wsid;
240 # if we encounter a stale authtoken, call load_logout
241 # to clean up the cookie, then redirect the user to the
242 # originally requested page
243 return $self->load_logout($self->apache->unparsed_uri);
246 $ctx->{search_ou} = $self->_get_search_lib();
248 $self->staff_saved_searches_set_expansion_state if $ctx->{is_staff};
250 return Apache2::Const::OK;
253 sub staff_saved_searches_set_expansion_state {
256 my $param = $self->cgi->param('sss_expand');
259 if (defined $param) {
260 $value = ($param ? 1 : 0);
261 $self->apache->headers_out->add(
262 "Set-Cookie" => $self->cgi->cookie(
263 -name => COOKIE_SSS_EXPAND,
264 -path => $self->ctx->{base_path},
265 -secure => 1, # not strictly necessary, but this feature is staff-only, so may as well
271 $value = $self->cgi->cookie(COOKIE_SSS_EXPAND);
274 $self->ctx->{saved_searches_expanded} = $value;
277 # physical_loc (i.e. "original location") passed in as a URL
278 # param will replace any existing physical_loc stored as a cookie.
279 sub get_physical_loc {
282 if(my $physical_loc = $self->cgi->param('physical_loc')) {
283 $self->apache->headers_out->add(
284 "Set-Cookie" => $self->cgi->cookie(
285 -name => COOKIE_PHYSICAL_LOC,
286 -path => $self->ctx->{base_path},
287 -value => $physical_loc,
291 return $physical_loc;
294 return $self->cgi->cookie(COOKIE_PHYSICAL_LOC);
299 # -----------------------------------------------------------------------------
300 # Log in and redirect to the redirect_to URL (or home)
301 # -----------------------------------------------------------------------------
304 my $cgi = $self->cgi;
305 my $ctx = $self->ctx;
307 $ctx->{page} = 'login';
309 my $username = $cgi->param('username');
310 my $password = $cgi->param('password');
311 my $org_unit = $cgi->param('loc') || $ctx->{aou_tree}->()->id;
312 my $persist = $cgi->param('persist');
314 # initial log form only
315 return Apache2::Const::OK unless $username and $password;
317 my $seed = $U->simplereq(
319 'open-ils.auth.authenticate.init', $username);
322 username => $username,
323 password => md5_hex($seed . md5_hex($password)),
324 type => ($persist) ? 'persist' : 'opac'
327 my $bc_regex = $ctx->{get_org_setting}->($org_unit, 'opac.barcode_regex');
329 $args->{barcode} = delete $args->{username}
330 if $bc_regex and ($username =~ /$bc_regex/);
332 my $response = $U->simplereq(
333 'open-ils.auth', 'open-ils.auth.authenticate.complete', $args);
335 if($U->event_code($response)) {
336 # login failed, report the reason to the template
337 $ctx->{login_failed_event} = $response;
338 return Apache2::Const::OK;
341 # login succeeded, redirect as necessary
343 my $acct = $self->apache->unparsed_uri;
344 $acct =~ s|/login|/myopac/main|;
346 return $self->generic_redirect(
347 $cgi->param('redirect_to') || $acct,
352 -value => $response->{payload}->{authtoken},
353 -expires => ($persist) ? CORE::time + $response->{payload}->{authtime} : undef
358 # -----------------------------------------------------------------------------
359 # Log out and redirect to the home page
360 # -----------------------------------------------------------------------------
363 my $redirect_to = shift;
365 # If the user was adding anyting to an anonymous cache
366 # while logged in, go ahead and clear it out.
367 $self->clear_anon_cache;
369 return $self->generic_redirect(
370 $redirect_to || $self->ctx->{home_page},