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_ORIG_LOC => 'eg_orig_loc';
31 my($class, $apache, $ctx) = @_;
33 my $self = bless({}, ref($class) || $class);
35 $self->apache($apache);
39 OpenILS::Utils::CStoreEditor->init; # just in case
40 $self->editor(new_editor());
46 # current Apache2::RequestRec;
48 my($self, $apache) = @_;
49 $self->{apache} = $apache if $apache;
50 return $self->{apache};
53 # runtime / template context
56 $self->{ctx} = $ctx if $ctx;
62 my($self, $editor) = @_;
63 $self->{editor} = $editor if $editor;
64 return $self->{editor};
70 $self->{cgi} = $cgi if $cgi;
75 # -----------------------------------------------------------------------------
76 # Perform initial setup, load common data, then load page data
77 # -----------------------------------------------------------------------------
81 $self->init_ro_object_cache;
83 my $stat = $self->load_common;
84 return $stat unless $stat == Apache2::Const::OK;
86 my $path = $self->apache->path_info;
88 (undef, $self->ctx->{mylist}) = $self->fetch_mylist unless
89 $path =~ /opac\/my(opac\/lists|list)/;
91 return $self->load_simple("home") if $path =~ m|opac/home|;
92 return $self->load_simple("advanced") if
93 $path =~ m:opac/(advanced|numeric|expert):;
95 return $self->load_rresults if $path =~ m|opac/results|;
96 return $self->load_record if $path =~ m|opac/record|;
97 return $self->load_cnbrowse if $path =~ m|opac/cnbrowse|;
99 return $self->load_mylist_add if $path =~ m|opac/mylist/add|;
100 return $self->load_mylist_move if $path =~ m|opac/mylist/move|;
101 return $self->load_mylist if $path =~ m|opac/mylist|;
102 return $self->load_cache_clear if $path =~ m|opac/cache/clear|;
104 # ----------------------------------------------------------------
105 # Logout and login require SSL
106 # ----------------------------------------------------------------
107 if($path =~ m|opac/login|) {
108 return $self->redirect_ssl unless $self->cgi->https;
109 return $self->load_login unless $self->editor->requestor; # already logged in?
111 # This will be less confusing to users than to be shown a login form
112 # when they're already logged in.
113 return $self->generic_redirect(
115 "https://%s%s/myopac/main",
116 $self->apache->hostname, $self->ctx->{opac_root}
121 if($path =~ m|opac/logout|) {
122 #return Apache2::Const::FORBIDDEN unless $self->cgi->https;
123 $self->apache->log->warn("catloader: logout called in non-secure context from " .
124 ($self->ctx->{referer} || '<no referer>')) unless $self->cgi->https;
125 return $self->load_logout;
128 # ----------------------------------------------------------------
129 # Everything below here requires SSL + authentication
130 # ----------------------------------------------------------------
131 return $self->redirect_auth
132 unless $self->cgi->https and $self->editor->requestor;
134 return $self->load_place_hold if $path =~ m|opac/place_hold|;
135 return $self->load_myopac_holds if $path =~ m|opac/myopac/holds|;
136 return $self->load_myopac_circs if $path =~ m|opac/myopac/circs|;
137 return $self->load_myopac_payment_form if $path =~ m|opac/myopac/main_payment_form|;
138 return $self->load_myopac_payments if $path =~ m|opac/myopac/main_payments|;
139 return $self->load_myopac_pay if $path =~ m|opac/myopac/main_pay|;
140 return $self->load_myopac_main if $path =~ m|opac/myopac/main|;
141 return $self->load_myopac_receipt_email if $path =~ m|opac/myopac/receipt_email|;
142 return $self->load_myopac_receipt_print if $path =~ m|opac/myopac/receipt_print|;
143 return $self->load_myopac_update_email if $path =~ m|opac/myopac/update_email|;
144 return $self->load_myopac_update_password if $path =~ m|opac/myopac/update_password|;
145 return $self->load_myopac_update_username if $path =~ m|opac/myopac/update_username|;
146 return $self->load_myopac_bookbags if $path =~ m|opac/myopac/lists|;
147 return $self->load_myopac_bookbag_update if $path =~ m|opac/myopac/list/update|;
148 return $self->load_myopac_circ_history if $path =~ m|opac/myopac/circ_history|;
149 return $self->load_myopac_hold_history if $path =~ m|opac/myopac/hold_history|;
150 return $self->load_myopac_prefs_notify if $path =~ m|opac/myopac/prefs_notify|;
151 return $self->load_myopac_prefs_settings if $path =~ m|opac/myopac/prefs_settings|;
152 return $self->load_myopac_prefs if $path =~ m|opac/myopac/prefs|;
154 return Apache2::Const::OK;
158 # -----------------------------------------------------------------------------
159 # Redirect to SSL equivalent of a given page
160 # -----------------------------------------------------------------------------
163 my $new_page = sprintf('https://%s%s', $self->apache->hostname, $self->apache->unparsed_uri);
164 return $self->generic_redirect($new_page);
167 # -----------------------------------------------------------------------------
168 # If an authnticated resource is requested w/o auth, redirect to the login page,
169 # then return to the originally requrested resource upon successful login.
170 # -----------------------------------------------------------------------------
173 my $login_page = sprintf('https://%s%s/login', $self->apache->hostname, $self->ctx->{opac_root});
174 my $redirect_to = uri_escape($self->apache->unparsed_uri);
175 return $self->generic_redirect("$login_page?redirect_to=$redirect_to");
178 # -----------------------------------------------------------------------------
179 # Fall-through for loading a basic page
180 # -----------------------------------------------------------------------------
182 my ($self, $page) = @_;
183 $self->ctx->{page} = $page;
185 if (my $patron_barcode = $self->cgi->param("patron_barcode")) {
186 # Special CGI variable from staff client; propagate henceforth as cookie
187 $self->apache->headers_out->add(
188 "Set-Cookie" => $self->cgi->cookie(
189 -name => "patron_barcode",
192 -value => $patron_barcode,
197 return Apache2::Const::OK;
200 # -----------------------------------------------------------------------------
201 # Tests to see if the user is authenticated and sets some common context values
202 # -----------------------------------------------------------------------------
206 my $e = $self->editor;
207 my $ctx = $self->ctx;
209 $ctx->{referer} = $self->cgi->referer;
210 $ctx->{path_info} = $self->cgi->path_info;
211 $ctx->{full_path} = $ctx->{base_path} . $self->cgi->path_info;
212 $ctx->{unparsed_uri} = $self->apache->unparsed_uri;
213 $ctx->{opac_root} = $ctx->{base_path} . "/opac"; # absolute base url
214 $ctx->{is_staff} = ($self->apache->headers_in->get('User-Agent') =~ /oils_xulrunner/);
215 $ctx->{orig_loc} = $self->get_orig_loc;
217 # capture some commonly accessed pages
218 $ctx->{home_page} = 'http://' . $self->apache->hostname . $self->ctx->{opac_root} . "/home";
219 $ctx->{logout_page} = 'https://' . $self->apache->hostname . $self->ctx->{opac_root} . "/logout";
221 if($e->authtoken($self->cgi->cookie(COOKIE_SES))) {
225 $ctx->{authtoken} = $e->authtoken;
226 $ctx->{authtime} = $e->authtime;
227 $ctx->{user} = $e->requestor;
229 $ctx->{user_stats} = $U->simplereq(
231 'open-ils.actor.user.opac.vital_stats',
232 $e->authtoken, $e->requestor->id);
236 # if we encounter a stale authtoken, call load_logout
237 # to clean up the cookie, then redirect the user to the
238 # originally requested page
239 return $self->load_logout($self->apache->unparsed_uri);
243 return Apache2::Const::OK;
246 # orig_loc (i.e. "original location") passed in as a URL
247 # param will replace any existing orig_loc stored as a cookie.
251 if(my $orig_loc = $self->cgi->param('orig_loc')) {
252 $self->apache->headers_out->add(
253 "Set-Cookie" => $self->cgi->cookie(
254 -name => COOKIE_ORIG_LOC,
255 -path => $self->ctx->{base_path},
263 return $self->cgi->cookie(COOKIE_ORIG_LOC);
268 # -----------------------------------------------------------------------------
269 # Log in and redirect to the redirect_to URL (or home)
270 # -----------------------------------------------------------------------------
273 my $cgi = $self->cgi;
274 my $ctx = $self->ctx;
276 $ctx->{page} = 'login';
278 my $username = $cgi->param('username');
279 my $password = $cgi->param('password');
280 my $org_unit = $cgi->param('loc') || $ctx->{aou_tree}->()->id;
281 my $persist = $cgi->param('persist');
283 # initial log form only
284 return Apache2::Const::OK unless $username and $password;
286 my $seed = $U->simplereq(
288 'open-ils.auth.authenticate.init', $username);
291 username => $username,
292 password => md5_hex($seed . md5_hex($password)),
293 type => ($persist) ? 'persist' : 'opac'
296 my $bc_regex = $ctx->{get_org_setting}->($org_unit, 'opac.barcode_regex');
298 $args->{barcode} = delete $args->{username}
299 if $bc_regex and ($username =~ /$bc_regex/);
301 my $response = $U->simplereq(
302 'open-ils.auth', 'open-ils.auth.authenticate.complete', $args);
304 if($U->event_code($response)) {
305 # login failed, report the reason to the template
306 $ctx->{login_failed_event} = $response;
307 return Apache2::Const::OK;
310 # login succeeded, redirect as necessary
312 my $acct = $self->apache->unparsed_uri;
313 $acct =~ s|/login|/myopac/main|;
315 return $self->generic_redirect(
316 $cgi->param('redirect_to') || $acct,
321 -value => $response->{payload}->{authtoken},
322 -expires => ($persist) ? CORE::time + $response->{payload}->{authtime} : undef
327 # -----------------------------------------------------------------------------
328 # Log out and redirect to the home page
329 # -----------------------------------------------------------------------------
332 my $redirect_to = shift;
334 # If the user was adding anyting to an anonymous cache
335 # while logged in, go ahead and clear it out.
336 $self->clear_anon_cache;
338 return $self->generic_redirect(
339 $redirect_to || $self->ctx->{home_page},