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';
30 my($class, $apache, $ctx) = @_;
32 my $self = bless({}, ref($class) || $class);
34 $self->apache($apache);
38 OpenILS::Utils::CStoreEditor->init; # just in case
39 $self->editor(new_editor());
45 # current Apache2::RequestRec;
47 my($self, $apache) = @_;
48 $self->{apache} = $apache if $apache;
49 return $self->{apache};
52 # runtime / template context
55 $self->{ctx} = $ctx if $ctx;
61 my($self, $editor) = @_;
62 $self->{editor} = $editor if $editor;
63 return $self->{editor};
69 $self->{cgi} = $cgi if $cgi;
74 # -----------------------------------------------------------------------------
75 # Perform initial setup, load common data, then load page data
76 # -----------------------------------------------------------------------------
80 $self->init_ro_object_cache;
82 my $stat = $self->load_common;
83 return $stat unless $stat == Apache2::Const::OK;
85 my $path = $self->apache->path_info;
87 (undef, $self->ctx->{mylist}) = $self->fetch_mylist unless
88 $path =~ /opac\/my(opac\/lists|list)/;
90 return $self->load_simple("home") if $path =~ m|opac/home|;
91 return $self->load_simple("advanced") if $path =~ m|opac/advanced|;
92 return $self->load_rresults if $path =~ m|opac/results|;
93 return $self->load_record if $path =~ m|opac/record|;
95 return $self->load_mylist_add if $path =~ m|opac/mylist/add|;
96 return $self->load_mylist_move if $path =~ m|opac/mylist/move|;
97 return $self->load_mylist if $path =~ m|opac/mylist|;
98 return $self->load_cache_clear if $path =~ m|opac/cache/clear|;
100 # ----------------------------------------------------------------
101 # Logout and login require SSL
102 # ----------------------------------------------------------------
103 if($path =~ m|opac/login|) {
104 return $self->redirect_ssl unless $self->cgi->https;
105 return $self->load_login;
108 if($path =~ m|opac/logout|) {
109 #return Apache2::Const::FORBIDDEN unless $self->cgi->https;
110 $self->apache->log->warn("catloader: logout called in non-secure context from " .
111 ($self->ctx->{referer} || '<no referer>')) unless $self->cgi->https;
112 return $self->load_logout;
115 # ----------------------------------------------------------------
116 # Everything below here requires SSL + authentication
117 # ----------------------------------------------------------------
118 return $self->redirect_auth
119 unless $self->cgi->https and $self->editor->requestor;
121 return $self->load_place_hold if $path =~ m|opac/place_hold|;
122 return $self->load_myopac_holds if $path =~ m|opac/myopac/holds|;
123 return $self->load_myopac_circs if $path =~ m|opac/myopac/circs|;
124 return $self->load_myopac_payment_form if $path =~ m|opac/myopac/main_payment_form|;
125 return $self->load_myopac_payments if $path =~ m|opac/myopac/main_payments|;
126 return $self->load_myopac_pay if $path =~ m|opac/myopac/main_pay|;
127 return $self->load_myopac_main if $path =~ m|opac/myopac/main|;
128 return $self->load_myopac_receipt_email if $path =~ m|opac/myopac/receipt_email|;
129 return $self->load_myopac_receipt_print if $path =~ m|opac/myopac/receipt_print|;
130 return $self->load_myopac_update_email if $path =~ m|opac/myopac/update_email|;
131 return $self->load_myopac_update_password if $path =~ m|opac/myopac/update_password|;
132 return $self->load_myopac_update_username if $path =~ m|opac/myopac/update_username|;
133 return $self->load_myopac_bookbags if $path =~ m|opac/myopac/lists|;
134 return $self->load_myopac_bookbag_update if $path =~ m|opac/myopac/list/update|;
135 return $self->load_myopac_circ_history if $path =~ m|opac/myopac/circ_history|;
136 return $self->load_myopac_hold_history if $path =~ m|opac/myopac/hold_history|;
137 return $self->load_myopac_prefs_notify if $path =~ m|opac/myopac/prefs_notify|;
138 return $self->load_myopac_prefs_settings if $path =~ m|opac/myopac/prefs_settings|;
139 return $self->load_myopac_prefs if $path =~ m|opac/myopac/prefs|;
141 return Apache2::Const::OK;
145 # -----------------------------------------------------------------------------
146 # Redirect to SSL equivalent of a given page
147 # -----------------------------------------------------------------------------
150 my $new_page = sprintf('https://%s%s', $self->apache->hostname, $self->apache->unparsed_uri);
151 return $self->generic_redirect($new_page);
154 # -----------------------------------------------------------------------------
155 # If an authnticated resource is requested w/o auth, redirect to the login page,
156 # then return to the originally requrested resource upon successful login.
157 # -----------------------------------------------------------------------------
160 my $login_page = sprintf('https://%s%s/login', $self->apache->hostname, $self->ctx->{opac_root});
161 my $redirect_to = uri_escape($self->apache->unparsed_uri);
162 return $self->generic_redirect("$login_page?redirect_to=$redirect_to");
165 # -----------------------------------------------------------------------------
166 # Fall-through for loading a basic page
167 # -----------------------------------------------------------------------------
169 my ($self, $page) = @_;
170 $self->ctx->{page} = $page;
172 if (my $patron_barcode = $self->cgi->param("patron_barcode")) {
173 # Special CGI variable from staff client; propagate henceforth as cookie
174 $self->apache->headers_out->add(
175 "Set-Cookie" => $self->cgi->cookie(
176 -name => "patron_barcode",
179 -value => $patron_barcode,
184 return Apache2::Const::OK;
187 # -----------------------------------------------------------------------------
188 # Tests to see if the user is authenticated and sets some common context values
189 # -----------------------------------------------------------------------------
193 my $e = $self->editor;
194 my $ctx = $self->ctx;
196 $ctx->{referer} = $self->cgi->referer;
197 $ctx->{path_info} = $self->cgi->path_info;
198 $ctx->{full_path} = $ctx->{base_path} . $self->cgi->path_info;
199 $ctx->{unparsed_uri} = $self->apache->unparsed_uri;
200 $ctx->{opac_root} = $ctx->{base_path} . "/opac"; # absolute base url
201 $ctx->{is_staff} = ($self->apache->headers_in->get('User-Agent') =~ /oils_xulrunner/);
203 # capture some commonly accessed pages
204 $ctx->{home_page} = 'http://' . $self->apache->hostname . $self->ctx->{opac_root} . "/home";
205 $ctx->{logout_page} = 'https://' . $self->apache->hostname . $self->ctx->{opac_root} . "/logout";
207 if($e->authtoken($self->cgi->cookie(COOKIE_SES))) {
211 $ctx->{authtoken} = $e->authtoken;
212 $ctx->{authtime} = $e->authtime;
213 $ctx->{user} = $e->requestor;
215 $ctx->{user_stats} = $U->simplereq(
217 'open-ils.actor.user.opac.vital_stats',
218 $e->authtoken, $e->requestor->id);
222 # if we encounter a stale authtoken, call load_logout
223 # to clean up the cookie, then redirect the user to the
224 # originally requested page
225 return $self->load_logout($self->apache->unparsed_uri);
229 return Apache2::Const::OK;
233 # -----------------------------------------------------------------------------
234 # Log in and redirect to the redirect_to URL (or home)
235 # -----------------------------------------------------------------------------
238 my $cgi = $self->cgi;
239 my $ctx = $self->ctx;
241 $ctx->{page} = 'login';
243 my $username = $cgi->param('username');
244 my $password = $cgi->param('password');
245 my $org_unit = $cgi->param('loc') || $ctx->{aou_tree}->()->id;
246 my $persist = $cgi->param('persist');
248 # initial log form only
249 return Apache2::Const::OK unless $username and $password;
251 my $seed = $U->simplereq(
253 'open-ils.auth.authenticate.init', $username);
256 barcode => $username,
257 password => md5_hex($seed . md5_hex($password)),
258 type => ($persist) ? 'persist' : 'opac'
261 my $bc_regex = $ctx->{get_org_setting}->($org_unit, 'opac.barcode_regex');
263 $args->{username} = delete $args->{barcode}
264 if $bc_regex and !($username =~ /$bc_regex/);
266 my $response = $U->simplereq(
267 'open-ils.auth', 'open-ils.auth.authenticate.complete', $args);
269 if($U->event_code($response)) {
270 # login failed, report the reason to the template
271 $ctx->{login_failed_event} = $response;
272 return Apache2::Const::OK;
275 # login succeeded, redirect as necessary
277 my $acct = $self->apache->unparsed_uri;
278 $acct =~ s|/login|/myopac/main|;
280 return $self->generic_redirect(
281 $cgi->param('redirect_to') || $acct,
286 -value => $response->{payload}->{authtoken},
287 -expires => ($persist) ? CORE::time + $response->{payload}->{authtime} : undef
292 # -----------------------------------------------------------------------------
293 # Log out and redirect to the home page
294 # -----------------------------------------------------------------------------
297 my $redirect_to = shift;
299 # If the user was adding anyting to an anonymous cache
300 # while logged in, go ahead and clear it out.
301 $self->clear_anon_cache;
303 return $self->generic_redirect(
304 $redirect_to || $self->ctx->{home_page},