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 OpenILS::Utils::DateTime 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 OpenSRF::Utils::Cache;
17 use DateTime::Format::ISO8601;
18 use CGI qw(:all -utf8);
21 # EGCatLoader sub-modules
22 use OpenILS::WWW::EGCatLoader::Util;
23 use OpenILS::WWW::EGCatLoader::Account;
24 use OpenILS::WWW::EGCatLoader::Browse;
25 use OpenILS::WWW::EGCatLoader::Library;
26 use OpenILS::WWW::EGCatLoader::Search;
27 use OpenILS::WWW::EGCatLoader::Record;
28 use OpenILS::WWW::EGCatLoader::Course;
29 use OpenILS::WWW::EGCatLoader::Container;
30 use OpenILS::WWW::EGCatLoader::SMS;
31 use OpenILS::WWW::EGCatLoader::Register;
33 my $U = 'OpenILS::Application::AppUtils';
35 use constant COOKIE_SES => 'ses';
36 use constant COOKIE_LOGGEDIN => 'eg_loggedin';
37 use constant COOKIE_SHIB_LOGGEDOUT => 'eg_shib_logged_out';
38 use constant COOKIE_SHIB_LOGGEDIN => 'eg_shib_logged_in';
39 use constant COOKIE_TZ => 'client_tz';
40 use constant COOKIE_PHYSICAL_LOC => 'eg_physical_loc';
41 use constant COOKIE_SSS_EXPAND => 'eg_sss_expand';
43 use constant COOKIE_ANON_CACHE => 'anoncache';
44 use constant COOKIE_CART_CACHE => 'cartcache';
45 use constant CART_CACHE_MYLIST => 'mylist';
46 use constant ANON_CACHE_STAFF_SEARCH => 'staffsearch';
48 use constant DEBUG_TIMING => 0;
51 my($class, $apache, $ctx) = @_;
53 my $self = bless({}, ref($class) || $class);
55 $self->apache($apache);
58 $self->timelog("New page");
60 # Add a timelog helper to the context
61 $self->ctx->{timelog} = sub { return $self->timelog(@_) };
63 OpenILS::Utils::CStoreEditor->init; # just in case
64 $self->editor(new_editor());
71 $ENV{TZ} = $self->ctx->{original_tz}
72 if ($self->ctx && exists $self->ctx->{original_tz});
75 # current Apache2::RequestRec;
77 my($self, $apache) = @_;
78 $self->{apache} = $apache if $apache;
79 return $self->{apache};
82 # runtime / template context
85 $self->{ctx} = $ctx if $ctx;
91 my($self, $editor) = @_;
92 $self->{editor} = $editor if $editor;
93 return $self->{editor};
99 $self->{cgi} = $cgi if $cgi;
104 my($self, $description) = @_;
106 return unless DEBUG_TIMING;
107 return unless $description;
108 $self->ctx->{timing} ||= [];
110 my $timer = [Time::HiRes::gettimeofday()];
111 $self->ctx->{time_begin} ||= $timer;
113 push @{$self->ctx->{timing}}, [
114 Time::HiRes::tv_interval($self->ctx->{time_begin}, $timer), $description
118 # -----------------------------------------------------------------------------
119 # Perform initial setup, load common data, then load page data
120 # -----------------------------------------------------------------------------
124 $self->init_ro_object_cache;
125 $self->timelog("Initial load");
127 my $stat = $self->load_common;
128 return $stat unless $stat == Apache2::Const::OK;
130 my $path = $self->apache->path_info;
132 if ($path =~ m|opac/?$|) {
133 # nowhere specified, just go home
134 return $self->generic_redirect($self->ctx->{home_page});
137 (undef, $self->ctx->{mylist}) = $self->fetch_mylist unless
138 $path =~ /opac\/my(opac\/lists|list)/ ||
139 $path =~ m!opac/api/mylist!;
141 my $org_unit = $self->ctx->{physical_loc} || $self->cgi->param('context_org') || $self->_get_search_lib;
142 $self->ctx->{selected_print_email_loc} = $org_unit;
144 return $self->load_api_mylist_retrieve if $path =~ m|opac/api/mylist/retrieve|;
145 return $self->load_api_mylist_add if $path =~ m|opac/api/mylist/add|;
146 return $self->load_api_mylist_delete if $path =~ m|opac/api/mylist/delete|;
147 return $self->load_api_mylist_clear if $path =~ m|opac/api/mylist/clear|;
149 return $self->load_simple("home") if $path =~ m|opac/home|;
150 return $self->load_simple("css") if $path =~ m|opac/css|;
151 return $self->load_cresults if $path =~ m|opac/course/results|;
152 return $self->load_simple("course_search") if $path =~ m|opac/course_search|;
153 return $self->load_simple("advanced") if
154 $path =~ m:opac/(advanced|numeric|expert):;
156 return $self->load_library if $path =~ m|opac/library|;
157 return $self->load_rresults if $path =~ m|opac/results|;
158 return $self->load_print_or_email_preview('print') if $path =~ m|opac/record/print_preview|;
159 return $self->load_print_record if $path =~ m|opac/record/print|;
160 return $self->load_record if $path =~ m|opac/record/\d|;
161 return $self->load_cnbrowse if $path =~ m|opac/cnbrowse|;
162 return $self->load_browse if $path =~ m|opac/browse|;
163 return $self->load_course_browse if $path =~ m|opac/course_browse|;
164 return $self->load_course if $path =~ m|opac/course|;
166 return $self->load_mylist_add if $path =~ m|opac/mylist/add|;
167 return $self->load_mylist_delete if $path =~ m|opac/mylist/delete|;
168 return $self->load_mylist_move if $path =~ m|opac/mylist/move|;
169 return $self->load_mylist_print if $path =~ m|opac/mylist/doprint|;
170 return $self->load_mylist if $path =~ m|opac/mylist| && $path !~ m|opac/mylist/email| && $path !~ m|opac/mylist/doemail|;
171 return $self->load_cache_clear if $path =~ m|opac/cache/clear|;
172 return $self->load_temp_warn_post if $path =~ m|opac/temp_warn/post|;
173 return $self->load_temp_warn if $path =~ m|opac/temp_warn|;
175 # ----------------------------------------------------------------
176 # Everything below here requires SSL
177 # ----------------------------------------------------------------
178 return $self->redirect_ssl unless $self->cgi->https;
179 return $self->load_password_reset if $path =~ m|opac/password_reset|;
180 return $self->load_logout if $path =~ m|opac/logout|;
181 return $self->load_patron_reg if $path =~ m|opac/register|;
183 $self->load_simple("myopac") if $path =~ m:opac/myopac:; # A default page for myopac parts
185 if($path =~ m|opac/login|) {
186 return $self->load_login unless $self->editor->requestor; # already logged in?
188 # This will be less confusing to users than to be shown a login form
189 # when they're already logged in.
190 return $self->generic_redirect(
192 "%s://%s%s/myopac/main",
194 $self->ctx->{hostname}, $self->ctx->{opac_root}
199 if ($path =~ m|opac/sms_cn| and !$self->editor->requestor) {
200 my $skip_sms_auth = $self->ctx->{get_org_setting}->($org_unit, 'sms.disable_authentication_requirement.callnumbers');
201 return $self->load_sms_cn if $skip_sms_auth;
204 if (!$self->editor->requestor && $path =~ m|opac/record/email|) {
205 if ($self->ctx->{get_org_setting}->($org_unit, 'opac.email_record.allow_without_login')) {
206 my $cache = OpenSRF::Utils::Cache->new('global');
208 if ($path !~ m|preview|) { # the real thing!
209 $logger->info("not preview");
210 my $cap_key = $self->ctx->{cap}->{key} = $self->cgi->param('capkey');
211 $logger->info("got cap_key $cap_key");
213 my $cap_answer = $self->ctx->{cap_answer} = $self->cgi->param('capanswer');
214 my $real_answer = $self->ctx->{real_answer} = $cache->get_cache(md5_hex($cap_key));
215 $logger->info("got answers $cap_answer $real_answer");
216 return $self->load_email_record(1) if ( $cap_answer eq $real_answer );
221 $$captcha{key} = time() . $$ . rand();
222 $$captcha{left} = int(rand(10));
223 $$captcha{right} = int(rand(10));
224 $cache->put_cache(md5_hex($$captcha{key}), $$captcha{left} + $$captcha{right});
225 $self->ctx->{captcha} = $captcha;
226 return $self->load_print_or_email_preview('email', 1) if $path =~ m|opac/record/email_preview|;
230 return $self->load_manual_shib_login if $path =~ m|opac/manual_shib_login|;
231 # ----------------------------------------------------------------
232 # Everything below here requires authentication
233 # ----------------------------------------------------------------
234 return $self->redirect_auth unless $self->editor->requestor;
236 # Don't cache anything requiring auth for security reasons
237 $self->apache->headers_out->add("cache-control" => "no-store, no-cache, must-revalidate");
238 $self->apache->headers_out->add("expires" => "-1");
240 if ($path =~ m|opac/mylist/email|) {
241 (undef, $self->ctx->{mylist}) = $self->fetch_mylist;
243 $self->load_simple("mylist/email") if $path =~ m|opac/mylist/email|;
244 return $self->load_print_or_email_preview('email') if $path =~ m|opac/mylist/doemail_preview|;
245 return $self->load_mylist_email if $path =~ m|opac/mylist/doemail|;
246 return $self->load_print_or_email_preview('email') if $path =~ m|opac/record/email_preview|;
247 return $self->load_email_record if $path =~ m|opac/record/email|;
248 return $self->load_sms_cn if $path =~ m|opac/sms_cn|;
250 return $self->load_place_hold if $path =~ m|opac/place_hold|;
252 # centralize check for curbside tab display
253 $self->load_current_curbside_libs;
255 return $self->load_myopac_holds if $path =~ m|opac/myopac/holds|;
256 return $self->load_myopac_hold_subscriptions if $path =~ m|opac/myopac/hold_subscriptions|;
257 return $self->load_myopac_circs if $path =~ m|opac/myopac/circs|;
258 return $self->load_myopac_messages if $path =~ m|opac/myopac/messages|;
259 return $self->load_myopac_payment_form if $path =~ m|opac/myopac/main_payment_form|;
260 return $self->load_myopac_payments if $path =~ m|opac/myopac/main_payments|;
261 return $self->load_myopac_pay_init if $path =~ m|opac/myopac/main_pay_init|;
262 return $self->load_myopac_pay if $path =~ m|opac/myopac/main_pay|;
263 return $self->load_myopac_main if $path =~ m|opac/myopac/charges|;
264 return $self->load_myopac_main if $path =~ m|opac/myopac/main|;
265 return $self->load_myopac_receipt_email if $path =~ m|opac/myopac/receipt_email|;
266 return $self->load_myopac_receipt_print if $path =~ m|opac/myopac/receipt_print|;
267 return $self->load_myopac_update_email if $path =~ m|opac/myopac/update_email|;
268 return $self->load_myopac_update_password if $path =~ m|opac/myopac/update_password|;
269 return $self->load_myopac_update_username if $path =~ m|opac/myopac/update_username|;
270 return $self->load_myopac_bookbags if $path =~ m|opac/myopac/lists|;
271 return $self->load_myopac_bookbag_print if $path =~ m|opac/myopac/list/print|;
272 return $self->load_myopac_bookbag_update if $path =~ m|opac/myopac/list/update|;
273 return $self->load_myopac_circ_history_export if $path =~ m|opac/myopac/circ_history/export|;
274 return $self->load_myopac_circ_history if $path =~ m|opac/myopac/circ_history|;
275 return $self->load_myopac_hold_history if $path =~ m|opac/myopac/hold_history|;
276 return $self->load_myopac_prefs_notify_changed_holds if $path =~ m|opac/myopac/prefs_notify_changed_holds|;
277 return $self->load_myopac_prefs_notify if $path =~ m|opac/myopac/prefs_notify|;
278 return $self->load_myopac_prefs_settings if $path =~ m|opac/myopac/prefs_settings|;
279 return $self->load_myopac_prefs_my_lists if $path =~ m|opac/myopac/prefs_my_lists|;
280 return $self->load_myopac_prefs if $path =~ m|opac/myopac/prefs|;
281 return $self->load_myopac_reservations if $path =~ m|opac/myopac/reservations|;
283 return Apache2::Const::OK;
287 # -----------------------------------------------------------------------------
288 # Redirect to SSL equivalent of a given page
289 # -----------------------------------------------------------------------------
292 my $new_page = sprintf('%s://%s%s', ($self->ctx->{is_staff} ? 'oils' : 'https'), $self->ctx->{hostname}, $self->apache->unparsed_uri);
293 return $self->generic_redirect($new_page);
296 # -----------------------------------------------------------------------------
297 # If an authnticated resource is requested w/o auth, redirect to the login page,
298 # then return to the originally requrested resource upon successful login.
299 # -----------------------------------------------------------------------------
303 my $sso_org = $ENV{sso_loc} || $self->get_physical_loc || $self->_get_search_lib();
304 my $sso_enabled = $self->ctx->{get_org_setting}->($sso_org, 'opac.login.shib_sso.enable');
305 my $sso_native = $self->ctx->{get_org_setting}->($sso_org, 'opac.login.shib_sso.allow_native');
307 my $login_type = ($sso_enabled and !$sso_native) ? 'manual_shib_login' : 'login';
308 my $login_page = sprintf('%s://%s%s/%s',($self->ctx->{is_staff} ? 'oils' : 'https'), $self->ctx->{hostname}, $self->ctx->{opac_root}, $login_type);
309 my $redirect_to = uri_escape_utf8($self->apache->unparsed_uri);
310 my $redirect_url = "$login_page?redirect_to=$redirect_to";
312 return $self->generic_redirect($redirect_url);
315 # -----------------------------------------------------------------------------
316 # Fall-through for loading a basic page
317 # -----------------------------------------------------------------------------
319 my ($self, $page) = @_;
320 $self->ctx->{page} = $page;
321 $self->ctx->{search_ou} = $self->_get_search_lib();
323 return Apache2::Const::OK;
326 # -----------------------------------------------------------------------------
327 # Tests to see if the user is authenticated and sets some common context values
328 # -----------------------------------------------------------------------------
332 my $e = $self->editor;
333 my $ctx = $self->ctx;
335 # redirect non-https to https if we think we are already logged in
336 if ($self->cgi->cookie(COOKIE_LOGGEDIN)) {
337 return $self->redirect_ssl unless $self->cgi->https;
340 # XXX Cache this? Makes testing difficult as apache needs a restart.
341 my $default_sort = $e->retrieve_config_global_flag('opac.default_sort');
342 $ctx->{default_sort} =
343 ($default_sort && $U->is_true($default_sort->enabled)) ? $default_sort->value : '';
345 $ctx->{client_tz} = $self->cgi->cookie(COOKIE_TZ) || $ENV{TZ};
346 $ctx->{referer} = $self->cgi->referer;
347 $ctx->{path_info} = $self->cgi->path_info;
348 $ctx->{full_path} = $ctx->{base_path} . $self->cgi->path_info;
349 $ctx->{unparsed_uri} = $self->apache->unparsed_uri;
350 $ctx->{opac_root} = $ctx->{base_path} . "/opac"; # absolute base url
352 $ctx->{original_tz} = $ENV{TZ};
353 $ENV{TZ} = $ctx->{client_tz};
356 ($self->apache->headers_in->get('OILS-Wrapper') || '') =~ /true/;
360 $ctx->{is_staff} = 1;
361 $ctx->{proto} = 'oils';
362 $ctx->{hostname} = 'remote';
365 $ctx->{carousel_loc} = $self->get_carousel_loc;
366 $ctx->{physical_loc} = $self->get_physical_loc;
367 my $geo_sort = $e->retrieve_config_global_flag('opac.use_geolocation');
368 $geo_sort = ($geo_sort && $U->is_true($geo_sort->enabled));
369 my $geo_org = $ctx->{physical_loc} || $self->cgi->param('loc') || $ctx->{aou_tree}->()->id;
370 my $geo_sort_for_org = $ctx->{get_org_setting}->($geo_org, 'opac.holdings_sort_by_geographic_proximity');
371 $ctx->{geo_sort} = $geo_sort && $U->is_true($geo_sort_for_org);
373 # capture some commonly accessed pages
374 $ctx->{home_page} = $ctx->{proto} . '://' . $ctx->{hostname} . $self->ctx->{opac_root} . "/home";
375 $ctx->{logout_page} = ($ctx->{proto} eq 'http' ? 'https' : $ctx->{proto} ) . '://' . $ctx->{hostname} . $self->ctx->{opac_root} . "/logout";
377 if($e->authtoken($self->cgi->cookie(COOKIE_SES))) {
381 $ctx->{authtoken} = $e->authtoken;
382 $ctx->{authtime} = $e->authtime;
383 $ctx->{user} = $e->requestor;
384 my $card = $self->editor->retrieve_actor_card($ctx->{user}->card);
385 $ctx->{active_card} = (ref $card) ? $card->barcode : undef;
386 $ctx->{place_unfillable} = 1 if $e->requestor->wsid && $e->allowed('PLACE_UNFILLABLE_HOLD', $e->requestor->ws_ou);
388 # The browser client does not set an OILS-Wrapper header (above).
389 # The presence of a workstation and no header indicates staff mode.
390 # FIXME: this approach leaves un-wrapped TPAC's within the same
391 # browser (and hence same ses cookie) in an unnatural is_staff
392 # state. Consider alternatives for determining is_staff /
393 # is_browser_staff when $xul_wrapper is false.
394 if (!$xul_wrapper and $e->requestor->wsid) {
395 $ctx->{is_staff} = 1;
396 $ctx->{is_browser_staff} = 1;
399 $self->update_dashboard_stats();
403 # if we encounter a stale authtoken, call load_logout
404 # to clean up the cookie, then redirect the user to the
405 # originally requested page
406 return $self->load_logout($self->apache->unparsed_uri);
410 # List of <meta> and <link> elements to populate
411 $ctx->{metalinks} = [];
413 $self->extract_copy_location_group_info;
414 $ctx->{search_ou} = $self->_get_search_lib();
415 if (!$ctx->{search_scope}) { # didn't get it from locg above in extract_...
416 $ctx->{search_scope} = $self->cgi->param('search_scope');
417 if ($ctx->{search_scope} =~ /^lasso\(([^)]+)\)/) {
418 $ctx->{search_lasso} = $1; # make it visible to basic search
421 $self->staff_saved_searches_set_expansion_state if $ctx->{is_staff};
422 $self->load_eg_cache_hash;
423 $self->load_copy_location_groups;
424 $self->load_my_hold_subscriptions;
425 $self->load_hold_subscriptions if $ctx->{is_staff};
427 $self->staff_saved_searches_set_expansion_state if $ctx->{is_staff};
428 $self->load_search_filter_groups($ctx->{search_ou});
429 $self->load_org_util_funcs;
430 $self->load_perm_funcs;
432 # FIXME - move carousel helpers to a separate file
433 $ctx->{get_visible_carousels} = sub {
434 my $org_unit = $self->ctx->{carousel_loc} || $self->ctx->{physical_loc} || $self->cgi->param('loc') || $self->ctx->{aou_tree}->()->id;
435 return $U->simplereq(
437 'open-ils.actor.carousel.retrieve_by_org',
441 $ctx->{get_carousel} = sub {
444 my $carousel = $e->retrieve_container_carousel($id);
447 name => $carousel->name
450 select => { bre => ['id'], mfde => [{ column => 'value', alias => 'title' }] },
464 '+cc' => { id => $id },
465 '+bre' => { deleted => 'f' },
466 '+mfde' => { name => 'title' }
468 order_by => {cbrebi => ['pos','create_time']}
470 my $r = $e->json_query($q);
475 $ctx->{fetch_display_fields} = sub {
479 return $ctx->{_hl_data}{''.$$id[0]}
480 if ($ctx->{_hl_data}{''.$$id[0]});
483 $self->timelog("HL data not cached, fetching from server.");
485 my $rows = $U->simplereq(
487 'open-ils.search.fetch.metabib.display_field.highlight',
488 $ctx->{query_struct}{additional_data}{highlight_map},
492 $ctx->{_hl_data}{''.$$id[0]} = $rows if (@$id == 1);
497 $ctx->{course_ou} = int($self->cgi->param('locg')) || $self->ctx->{physical_loc} || $self->ctx->{aou_tree}->()->id;
498 $ctx->{use_courses} = $ctx->{get_org_setting}->($ctx->{course_ou}, 'circ.course_materials_opt_in') ? 1 : 0;
500 return Apache2::Const::OK;
503 sub update_dashboard_stats {
506 my $e = $self->editor;
507 my $ctx = $self->ctx;
509 $ctx->{user_stats} = $U->simplereq(
511 'open-ils.actor.user.opac.vital_stats',
512 $e->authtoken, $e->requestor->id);
515 sub staff_saved_searches_set_expansion_state {
518 my $param = $self->cgi->param('sss_expand');
521 if (defined $param) {
522 $value = ($param ? 1 : 0);
523 $self->apache->headers_out->add(
524 "Set-Cookie" => $self->cgi->cookie(
525 -name => COOKIE_SSS_EXPAND,
526 -path => $self->ctx->{base_path},
527 -secure => 1, # not strictly necessary, but this feature is staff-only, so may as well
533 $value = $self->cgi->cookie(COOKIE_SSS_EXPAND);
536 $self->ctx->{saved_searches_expanded} = $value;
539 # physical_loc (i.e. "original location") passed in as a URL
540 # param will replace any existing physical_loc stored as a cookie.
541 # If specified via ENV that rules over all and we don't set cookies.
542 sub get_physical_loc {
545 return $ENV{physical_loc} if($ENV{physical_loc});
547 if(my $physical_loc = $self->cgi->param('physical_loc')) {
548 $self->apache->headers_out->add(
549 "Set-Cookie" => $self->cgi->cookie(
550 -name => COOKIE_PHYSICAL_LOC,
551 -path => $self->ctx->{base_path},
552 -value => $physical_loc,
556 return $physical_loc;
559 return $self->cgi->cookie(COOKIE_PHYSICAL_LOC);
562 sub get_carousel_loc {
564 return $self->cgi->param('carousel_loc') || $ENV{carousel_loc};
567 # -----------------------------------------------------------------------------
568 # Log in and redirect to the redirect_to URL (or home)
569 # -----------------------------------------------------------------------------
572 my $cgi = $self->cgi;
573 my $ctx = $self->ctx;
575 $self->timelog("Load login begins");
577 my $sso_org = $ENV{sso_loc} || $self->get_physical_loc || $self->_get_search_lib();
578 $ctx->{sso_org} = $sso_org;
579 my $sso_enabled = $ctx->{get_org_setting}->($sso_org, 'opac.login.shib_sso.enable');
580 my $sso_native = $ctx->{get_org_setting}->($sso_org, 'opac.login.shib_sso.allow_native');
581 my $sso_eg_match = $ctx->{get_org_setting}->($sso_org, 'opac.login.shib_sso.evergreen_matchpoint') || 'usrname';
582 my $sso_shib_match = $ctx->{get_org_setting}->($sso_org, 'opac.login.shib_sso.shib_matchpoint') || 'uid';
584 $ctx->{page} = 'login';
586 my $username = $cgi->param('username') || '';
587 $username =~ s/\s//g; # Remove blanks
588 my $password = $cgi->param('password');
589 my $org_unit = $ctx->{physical_loc} || $ctx->{aou_tree}->()->id;
590 my $persist = $cgi->param('persist');
591 my $client_tz = $cgi->param('client_tz');
593 my $sso_user_match_value;
596 $self->timelog("SSO is enabled") if ($sso_enabled);
598 and $sso_user_match_value = $ENV{$sso_shib_match}
599 and !$self->cgi->cookie(COOKIE_SHIB_LOGGEDOUT)
600 ) { # we have a shib session, and have not cleared a previous shib-login cookie
601 $self->timelog("Have an SSO user match value: $sso_user_match_value");
603 if ($sso_eg_match eq 'barcode') { # barcode is special
604 my $card = $self->editor->search_actor_card({barcode => $sso_user_match_value})->[0];
605 $sso_user_match_value = $card ? $card->usr : undef;
606 $sso_eg_match = 'id';
609 if ($sso_user_match_value && $sso_eg_match) {
610 my $user = $self->editor->search_actor_user({ $sso_eg_match => $sso_user_match_value })->[0];
611 if ($user) { # create a session
612 $response = $U->simplereq(
613 'open-ils.auth_internal',
614 'open-ils.auth_internal.session.create',
615 { user_id => $user->id, login_type => 'opac' }
617 $sso_logged_in = $response ? 1 : 0;
621 $self->timelog("Checked for SSO login");
624 if (!$sso_enabled || (!$response && $sso_native)) {
625 # initial log form only
626 return Apache2::Const::OK unless $username and $password;
628 my $auth_proxy_enabled = 0; # default false
629 try { # if the service is not running, just let this fail silently
630 $auth_proxy_enabled = $U->simplereq(
631 'open-ils.auth_proxy',
632 'open-ils.auth_proxy.enabled');
633 } catch Error with {};
635 $self->timelog("Checked for auth proxy: $auth_proxy_enabled; org = $org_unit; username = $username");
638 type => ($persist) ? 'persist' : 'opac',
643 my $bc_regex = $ctx->{get_org_setting}->($org_unit, 'opac.barcode_regex');
645 # To avoid surprises, default to "Barcodes start with digits"
646 $bc_regex = '^\d' unless $bc_regex;
648 if ($bc_regex and ($username =~ /$bc_regex/)) {
649 $args->{barcode} = $username;
651 $args->{username} = $username;
654 if (!$auth_proxy_enabled) {
655 my $seed = $U->simplereq(
657 'open-ils.auth.authenticate.init', $username);
658 $args->{password} = md5_hex($seed . md5_hex($password));
659 $response = $U->simplereq(
660 'open-ils.auth', 'open-ils.auth.authenticate.complete', $args);
662 $args->{password} = $password;
663 $response = $U->simplereq(
664 'open-ils.auth_proxy',
665 'open-ils.auth_proxy.login', $args);
667 $self->timelog("Checked password");
669 $response ||= OpenILS::Event->new( 'LOGIN_FAILED' ); # assume failure
672 if($U->event_code($response)) {
673 # login failed, report the reason to the template
674 $ctx->{login_failed_event} = $response;
675 return Apache2::Const::OK;
678 # login succeeded, redirect as necessary
680 my $acct = $self->apache->unparsed_uri;
681 $acct =~ s|/login|/myopac/main|;
683 # both login-related cookies should expire at the same time
684 my $login_cookie_expires = ($persist) ? CORE::time + $response->{payload}->{authtime} : undef;
687 # contains the actual auth token and should be sent only over https
692 -value => $response->{payload}->{authtoken},
693 -expires => $login_cookie_expires
695 # contains only a hint that we are logged in, and is used to
696 # trigger a redirect to https
698 -name => COOKIE_LOGGEDIN,
702 -expires => $login_cookie_expires
707 # contains the client's tz, as passed by the client
708 # trigger a redirect to https
709 push @$cookie_list, $cgi->cookie(
713 -value => $client_tz,
714 -expires => $login_cookie_expires
718 if ($sso_logged_in) {
719 # tells us if we're logged in via shib, so we can decide whether to try logging in again.
720 push @$cookie_list, $cgi->cookie(
721 -name => COOKIE_SHIB_LOGGEDOUT,
727 push @$cookie_list, $cgi->cookie(
728 -name => COOKIE_SHIB_LOGGEDIN,
732 -expires => $login_cookie_expires
736 return $self->generic_redirect(
737 $cgi->param('redirect_to') || $acct,
742 sub load_manual_shib_login {
744 my $redirect_to = shift || $self->cgi->param('redirect_to');
746 my $sso_org = $ENV{sso_loc} || $self->get_physical_loc || $self->_get_search_lib();
747 my $sso_entity_id = $self->ctx->{get_org_setting}->($sso_org, 'opac.login.shib_sso.entityId');
748 my $sso_shib_match = $self->ctx->{get_org_setting}->($sso_org, 'opac.login.shib_sso.shib_matchpoint') || 'uid';
750 return $self->load_login if ($ENV{$sso_shib_match});
752 my $url = '/Shibboleth.sso/Login?target=' . ($redirect_to || $self->ctx->{home_page});
753 if ($sso_entity_id) {
754 $url .= '&entityID=' . $sso_entity_id;
757 return $self->generic_redirect( $url,
760 -name => COOKIE_SHIB_LOGGEDOUT,
769 # -----------------------------------------------------------------------------
770 # Log out and redirect to the home page
771 # -----------------------------------------------------------------------------
774 my $redirect_to = shift || $self->cgi->param('redirect_to');
775 my $active_logout = $self->cgi->param('active_logout');
777 my $sso_org = $ENV{sso_loc} || $self->get_physical_loc || $self->_get_search_lib();
778 $self->ctx->{sso_org} = $sso_org;
779 my $sso_enabled = $self->ctx->{get_org_setting}->($sso_org, 'opac.login.shib_sso.enable');
780 my $sso_entity_id = $self->ctx->{get_org_setting}->($sso_org, 'opac.login.shib_sso.entityId');
781 my $sso_logout = $self->ctx->{get_org_setting}->($sso_org, 'opac.login.shib_sso.logout');
782 if ($sso_enabled && $sso_logout) {
783 $redirect_to = '/Shibboleth.sso/Logout?return=' . ($redirect_to || $self->ctx->{home_page});
784 if ($sso_entity_id) {
785 $redirect_to .= '&entityID=' . $sso_entity_id;
789 # If the user was adding anyting to an anonymous cache
790 # while logged in, go ahead and clear it out.
791 $self->clear_anon_cache;
793 try { # a missing auth token will cause an ugly explosion
796 'open-ils.auth.session.delete',
797 $self->cgi->cookie(COOKIE_SES)
799 } catch Error with {};
801 return $self->generic_redirect(
802 $redirect_to || $self->ctx->{home_page},
804 # clear value of and expire both of these login-related cookies
812 -name => COOKIE_LOGGEDIN,
817 ($active_logout ? ($self->cgi->cookie(
818 -name => COOKIE_SHIB_LOGGEDOUT,
821 -expires => '2147483647'
824 -name => COOKIE_SHIB_LOGGEDIN,