]> git.evergreen-ils.org Git - working/Evergreen.git/blob - Open-ILS/src/perlmods/lib/OpenILS/WWW/EGCatLoader.pm
Merge branch 'opac-tt-poc' of git+ssh://yeti.esilibrary.com/home/evergreen/evergreen...
[working/Evergreen.git] / Open-ILS / src / perlmods / lib / OpenILS / WWW / EGCatLoader.pm
1 package OpenILS::WWW::EGCatLoader;
2 use strict; use warnings;
3 use XML::LibXML;
4 use URI::Escape;
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);
17
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;
24
25 my $U = 'OpenILS::Application::AppUtils';
26
27 use constant COOKIE_SES => 'ses';
28
29 sub new {
30     my($class, $apache, $ctx) = @_;
31
32     my $self = bless({}, ref($class) || $class);
33
34     $self->apache($apache);
35     $self->ctx($ctx);
36     $self->cgi(new CGI);
37
38     OpenILS::Utils::CStoreEditor->init; # just in case
39     $self->editor(new_editor());
40
41     return $self;
42 }
43
44
45 # current Apache2::RequestRec;
46 sub apache {
47     my($self, $apache) = @_;
48     $self->{apache} = $apache if $apache;
49     return $self->{apache};
50 }
51
52 # runtime / template context
53 sub ctx {
54     my($self, $ctx) = @_;
55     $self->{ctx} = $ctx if $ctx;
56     return $self->{ctx};
57 }
58
59 # cstore editor
60 sub editor {
61     my($self, $editor) = @_;
62     $self->{editor} = $editor if $editor;
63     return $self->{editor};
64 }
65
66 # CGI handle
67 sub cgi {
68     my($self, $cgi) = @_;
69     $self->{cgi} = $cgi if $cgi;
70     return $self->{cgi};
71 }
72
73
74 # -----------------------------------------------------------------------------
75 # Perform initial setup, load common data, then load page data
76 # -----------------------------------------------------------------------------
77 sub load {
78     my $self = shift;
79
80     $self->init_ro_object_cache;
81
82     my $stat = $self->load_common;
83     return $stat unless $stat == Apache2::Const::OK;
84
85     my $path = $self->apache->path_info;
86
87     (undef, $self->ctx->{mylist}) = $self->fetch_mylist unless
88         $path =~ /opac\/my(opac\/lists|list)/;
89
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|;
94
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|;
99
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;
106     }
107
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;
113     }
114
115     # ----------------------------------------------------------------
116     #  Everything below here requires SSL + authentication
117     # ----------------------------------------------------------------
118     return $self->redirect_auth
119         unless $self->cgi->https and $self->editor->requestor;
120
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_main if $path =~ m|opac/myopac/main|;
125     return $self->load_myopac_update_email if $path =~ m|opac/myopac/update_email|;
126     return $self->load_myopac_bookbags if $path =~ m|opac/myopac/lists|;
127     return $self->load_myopac_bookbag_update if $path =~ m|opac/myopac/list/update|;
128     return $self->load_myopac_circ_history if $path =~ m|opac/myopac/circ_history|;
129     return $self->load_myopac_hold_history if $path =~ m|opac/myopac/hold_history|;
130     return $self->load_myopac if $path =~ m|opac/myopac|;
131
132     return Apache2::Const::OK;
133 }
134
135
136 # -----------------------------------------------------------------------------
137 # Redirect to SSL equivalent of a given page
138 # -----------------------------------------------------------------------------
139 sub redirect_ssl {
140     my $self = shift;
141     my $new_page = sprintf('https://%s%s', $self->apache->hostname, $self->apache->unparsed_uri);
142     return $self->generic_redirect($new_page);
143 }
144
145 # -----------------------------------------------------------------------------
146 # If an authnticated resource is requested w/o auth, redirect to the login page,
147 # then return to the originally requrested resource upon successful login.
148 # -----------------------------------------------------------------------------
149 sub redirect_auth {
150     my $self = shift;
151     my $login_page = sprintf('https://%s%s/login', $self->apache->hostname, $self->ctx->{opac_root});
152     my $redirect_to = uri_escape($self->apache->unparsed_uri);
153     return $self->generic_redirect("$login_page?redirect_to=$redirect_to");
154 }
155
156 # -----------------------------------------------------------------------------
157 # Fall-through for loading a basic page
158 # -----------------------------------------------------------------------------
159 sub load_simple {
160     my ($self, $page) = @_;
161     $self->ctx->{page} = $page;
162     return Apache2::Const::OK;
163 }
164
165 # -----------------------------------------------------------------------------
166 # Tests to see if the user is authenticated and sets some common context values
167 # -----------------------------------------------------------------------------
168 sub load_common {
169     my $self = shift;
170
171     my $e = $self->editor;
172     my $ctx = $self->ctx;
173
174     $ctx->{referer} = $self->cgi->referer;
175     $ctx->{path_info} = $self->cgi->path_info;
176     $ctx->{full_path} = $ctx->{base_path} . $self->cgi->path_info;
177     $ctx->{unparsed_uri} = $self->apache->unparsed_uri;
178     $ctx->{opac_root} = $ctx->{base_path} . "/opac"; # absolute base url
179     $ctx->{is_staff} = ($self->apache->headers_in->get('User-Agent') =~ 'oils_xulrunner');
180
181     # capture some commonly accessed pages
182     $ctx->{home_page} = 'http://' . $self->apache->hostname . $self->ctx->{opac_root} . "/home";
183     $ctx->{logout_page} = 'https://' . $self->apache->hostname . $self->ctx->{opac_root} . "/logout";
184
185     if($e->authtoken($self->cgi->cookie(COOKIE_SES))) {
186
187         if($e->checkauth) {
188
189             $ctx->{authtoken} = $e->authtoken;
190             $ctx->{authtime} = $e->authtime;
191             $ctx->{user} = $e->requestor;
192
193             $ctx->{user_stats} = $U->simplereq(
194                 'open-ils.actor', 
195                 'open-ils.actor.user.opac.vital_stats', 
196                 $e->authtoken, $e->requestor->id);
197
198         } else {
199
200             # For now, keep an eye out for any pages being unceremoniously redirected to logout...
201             $self->apache->log->info("catloader: loading " . $ctx->{path_info} . 
202                 "; auth session " .  $e->authtoken . " no longer valid; redirecting to logout");
203
204             return $self->load_logout;
205         }
206     }
207
208     return Apache2::Const::OK;
209 }
210
211
212 # -----------------------------------------------------------------------------
213 # Log in and redirect to the redirect_to URL (or home)
214 # -----------------------------------------------------------------------------
215 sub load_login {
216     my $self = shift;
217     my $cgi = $self->cgi;
218     my $ctx = $self->ctx;
219
220     $ctx->{page} = 'login';
221
222     my $username = $cgi->param('username');
223     my $password = $cgi->param('password');
224     my $org_unit = $cgi->param('loc') || $ctx->{aou_tree}->()->id;
225     my $persist = $cgi->param('persist');
226
227     # initial log form only
228     return Apache2::Const::OK unless $username and $password;
229
230         my $seed = $U->simplereq(
231         'open-ils.auth', 
232                 'open-ils.auth.authenticate.init', $username);
233
234     my $args = {        
235         username => $username, 
236         password => md5_hex($seed . md5_hex($password)), 
237         type => ($persist) ? 'persist' : 'opac' 
238     };
239
240     my $bc_regex = $ctx->{get_org_setting}->($org_unit, 'opac.barcode_regex');
241
242     $args->{barcode} = delete $args->{username} 
243         if $bc_regex and $username =~ /$bc_regex/;
244
245         my $response = $U->simplereq(
246         'open-ils.auth', 'open-ils.auth.authenticate.complete', $args);
247
248     if($U->event_code($response)) { 
249         # login failed, report the reason to the template
250         $ctx->{login_failed_event} = $response;
251         return Apache2::Const::OK;
252     }
253
254     # login succeeded, redirect as necessary
255
256     my $acct = $self->apache->unparsed_uri;
257     $acct =~ s|/login|/myopac/main|;
258
259     return $self->generic_redirect(
260         $cgi->param('redirect_to') || $acct,
261         $cgi->cookie(
262             -name => COOKIE_SES,
263             -path => '/',
264             -secure => 1,
265             -value => $response->{payload}->{authtoken},
266             -expires => ($persist) ? CORE::time + $response->{payload}->{authtime} : undef
267         )
268     );
269 }
270
271 # -----------------------------------------------------------------------------
272 # Log out and redirect to the home page
273 # -----------------------------------------------------------------------------
274 sub load_logout {
275     my $self = shift;
276
277     # If the user was adding anyting to an anonymous cache 
278     # while logged in, go ahead and clear it out.
279     $self->clear_anon_cache;
280
281     return $self->generic_redirect(
282         $self->ctx->{home_page},
283         $self->cgi->cookie(
284             -name => COOKIE_SES,
285             -path => '/',
286             -value => '',
287             -expires => '-1h'
288         )
289     );
290 }
291
292 1;
293