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 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;
  16 use OpenILS::Event;
  17 use DateTime::Format::ISO8601;
  18 use CGI qw(:all -utf8);
  19 use Time::HiRes;
  20
  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;
  32
  33 my $U = 'OpenILS::Application::AppUtils';
  34
  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';
  42
  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';
  47
  48 use constant DEBUG_TIMING => 0;
  49
  50 sub new {
  51     my($class, $apache, $ctx) = @_;
  52
  53     my $self = bless({}, ref($class) || $class);
  54
  55     $self->apache($apache);
  56     $self->ctx($ctx);
  57     $self->cgi(new CGI);
  58     $self->timelog("New page");
  59
  60     # Add a timelog helper to the context
  61     $self->ctx->{timelog} = sub { return $self->timelog(@_) };
  62
  63     OpenILS::Utils::CStoreEditor->init; # just in case
  64     $self->editor(new_editor());
  65
  66     return $self;
  67 }
  68
  69 sub DESTROY {
  70     my $self = shift;
  71     $ENV{TZ} = $self->ctx->{original_tz}
  72         if ($self->ctx && exists $self->ctx->{original_tz});
  73 }
  74
  75 # current Apache2::RequestRec;
  76 sub apache {
  77     my($self, $apache) = @_;
  78     $self->{apache} = $apache if $apache;
  79     return $self->{apache};
  80 }
  81
  82 # runtime / template context
  83 sub ctx {
  84     my($self, $ctx) = @_;
  85     $self->{ctx} = $ctx if $ctx;
  86     return $self->{ctx};
  87 }
  88
  89 # cstore editor
  90 sub editor {
  91     my($self, $editor) = @_;
  92     $self->{editor} = $editor if $editor;
  93     return $self->{editor};
  94 }
  95
  96 # CGI handle
  97 sub cgi {
  98     my($self, $cgi) = @_;
  99     $self->{cgi} = $cgi if $cgi;
 100     return $self->{cgi};
 101 }
 102
 103 sub timelog {
 104     my($self, $description) = @_;
 105
 106     return unless DEBUG_TIMING;
 107     return unless $description;
 108     $self->ctx->{timing} ||= [];
 109
 110     my $timer = [Time::HiRes::gettimeofday()];
 111     $self->ctx->{time_begin} ||= $timer;
 112
 113     push @{$self->ctx->{timing}}, [
 114         Time::HiRes::tv_interval($self->ctx->{time_begin}, $timer), $description
 115     ];
 116 }
 117
 118 # -----------------------------------------------------------------------------
 119 # Perform initial setup, load common data, then load page data
 120 # -----------------------------------------------------------------------------
 121 sub load {
 122     my $self = shift;
 123
 124     $self->init_ro_object_cache;
 125     $self->timelog("Initial load");
 126
 127     my $stat = $self->load_common;
 128     return $stat unless $stat == Apache2::Const::OK;
 129
 130     my $path = $self->apache->path_info;
 131
 132     if ($path =~ m|opac/?$|) {
 133         # nowhere specified, just go home
 134         return $self->generic_redirect($self->ctx->{home_page});
 135     }
 136
 137     (undef, $self->ctx->{mylist}) = $self->fetch_mylist unless
 138         $path =~ /opac\/my(opac\/lists|list)/ ||
 139         $path =~ m!opac/api/mylist!;
 140
 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;
 143
 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|;
 148
 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):;
 155
 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|;
 165
 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|;
 174
 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|;
 182
 183     $self->load_simple("myopac") if $path =~ m:opac/myopac:; # A default page for myopac parts
 184
 185     if($path =~ m|opac/login|) {
 186         return $self->load_login unless $self->editor->requestor; # already logged in?
 187
 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(
 191             sprintf(
 192                 "%s://%s%s/myopac/main",
 193                 $self->ctx->{proto},
 194                 $self->ctx->{hostname}, $self->ctx->{opac_root}
 195             )
 196         );
 197     }
 198
 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;
 202     }
 203
 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');
 207
 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");
 212                 if ($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 );
 217                 }
 218             }
 219
 220             my $captcha = {};
 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|;
 227         }
 228     }
 229
 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;
 235
 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");
 239
 240     if ($path =~ m|opac/mylist/email|) {
 241         (undef, $self->ctx->{mylist}) = $self->fetch_mylist;
 242     }
 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|;
 249
 250     return $self->load_place_hold if $path =~ m|opac/place_hold|;
 251
 252     # centralize check for curbside tab display
 253     $self->load_current_curbside_libs;
 254
 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|;
 282
 283     return Apache2::Const::OK;
 284 }
 285
 286
 287 # -----------------------------------------------------------------------------
 288 # Redirect to SSL equivalent of a given page
 289 # -----------------------------------------------------------------------------
 290 sub redirect_ssl {
 291     my $self = shift;
 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);
 294 }
 295
 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 # -----------------------------------------------------------------------------
 300 sub redirect_auth {
 301     my $self = shift;
 302
 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');
 306
 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";
 311
 312     return $self->generic_redirect($redirect_url);
 313 }
 314
 315 # -----------------------------------------------------------------------------
 316 # Fall-through for loading a basic page
 317 # -----------------------------------------------------------------------------
 318 sub load_simple {
 319     my ($self, $page) = @_;
 320     $self->ctx->{page} = $page;
 321     $self->ctx->{search_ou} = $self->_get_search_lib();
 322
 323     return Apache2::Const::OK;
 324 }
 325
 326 # -----------------------------------------------------------------------------
 327 # Tests to see if the user is authenticated and sets some common context values
 328 # -----------------------------------------------------------------------------
 329 sub load_common {
 330     my $self = shift;
 331
 332     my $e = $self->editor;
 333     my $ctx = $self->ctx;
 334
 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;
 338     }
 339
 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 : '';
 344
 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
 351
 352     $ctx->{original_tz} = $ENV{TZ};
 353     $ENV{TZ} = $ctx->{client_tz};
 354
 355     my $xul_wrapper =
 356         ($self->apache->headers_in->get('OILS-Wrapper') || '') =~ /true/;
 357
 358     if ($xul_wrapper) {
 359         # XUL client
 360         $ctx->{is_staff} = 1;
 361         $ctx->{proto} = 'oils';
 362         $ctx->{hostname} = 'remote';
 363     }
 364
 365     $ctx->{carousel_loc} = $self->get_carousel_loc;
 366     $ctx->{physical_loc} = $self->get_physical_loc;
 367
 368     # capture some commonly accessed pages
 369     $ctx->{home_page} = $ctx->{proto} . '://' . $ctx->{hostname} . $self->ctx->{opac_root} . "/home";
 370     $ctx->{logout_page} = ($ctx->{proto} eq 'http' ? 'https' : $ctx->{proto} ) . '://' . $ctx->{hostname} . $self->ctx->{opac_root} . "/logout";
 371
 372     if($e->authtoken($self->cgi->cookie(COOKIE_SES))) {
 373
 374         if($e->checkauth) {
 375
 376             $ctx->{authtoken} = $e->authtoken;
 377             $ctx->{authtime} = $e->authtime;
 378             $ctx->{user} = $e->requestor;
 379             my $card = $self->editor->retrieve_actor_card($ctx->{user}->card);
 380             $ctx->{active_card} = (ref $card) ? $card->barcode : undef;
 381             $ctx->{place_unfillable} = 1 if $e->requestor->wsid && $e->allowed('PLACE_UNFILLABLE_HOLD', $e->requestor->ws_ou);
 382
 383             # The browser client does not set an OILS-Wrapper header (above).
 384             # The presence of a workstation and no header indicates staff mode.
 385             # FIXME: this approach leaves un-wrapped TPAC's within the same
 386             # browser (and hence same ses cookie) in an unnatural is_staff
 387             # state.  Consider alternatives for determining is_staff /
 388             # is_browser_staff when $xul_wrapper is false.
 389             if (!$xul_wrapper and $e->requestor->wsid) {
 390                 $ctx->{is_staff} = 1;
 391                 $ctx->{is_browser_staff} = 1;
 392             }
 393
 394             $self->update_dashboard_stats();
 395
 396         } else {
 397
 398             # if we encounter a stale authtoken, call load_logout
 399             # to clean up the cookie, then redirect the user to the
 400             # originally requested page
 401             return $self->load_logout($self->apache->unparsed_uri);
 402         }
 403     }
 404
 405     # List of <meta> and <link> elements to populate
 406     $ctx->{metalinks} = [];
 407
 408     $self->extract_copy_location_group_info;
 409     $ctx->{search_ou} = $self->_get_search_lib();
 410     $self->staff_saved_searches_set_expansion_state if $ctx->{is_staff};
 411     $self->load_eg_cache_hash;
 412     $self->load_copy_location_groups;
 413     $self->load_my_hold_subscriptions;
 414     $self->load_hold_subscriptions if $ctx->{is_staff};
 415     $self->staff_saved_searches_set_expansion_state if $ctx->{is_staff};
 416     $self->load_search_filter_groups($ctx->{search_ou});
 417     $self->load_org_util_funcs;
 418     $self->load_perm_funcs;
 419
 420     # FIXME - move carousel helpers to a separate file
 421     $ctx->{get_visible_carousels} = sub {
 422         my $org_unit = $self->ctx->{carousel_loc} || $self->ctx->{physical_loc} || $self->cgi->param('loc') || $self->ctx->{aou_tree}->()->id;
 423         return $U->simplereq(
 424             'open-ils.actor',
 425             'open-ils.actor.carousel.retrieve_by_org',
 426             $org_unit
 427         );
 428     };
 429     $ctx->{get_carousel} = sub {
 430         my $id = shift;
 431
 432         my $carousel = $e->retrieve_container_carousel($id);
 433         my $ret = {
 434             id   => $id,
 435             name => $carousel->name
 436         };
 437         my $q = {
 438             select => { bre => ['id'], mfde => [{ column => 'value', alias => 'title' }] },
 439             from   => {
 440                 bre => {
 441                     cbrebi => {
 442                         join => {
 443                             cbreb => {
 444                                 join => { cc => {} }
 445                             }
 446                         }
 447                     },
 448                     mfde => {}
 449                 }
 450             },
 451             where  => {
 452                 '+cc' => { id => $id },
 453                 '+bre' => { deleted => 'f' },
 454                 '+mfde' => { name => 'title' }
 455             },
 456             order_by => {cbrebi => ['pos','create_time']}
 457         };
 458         my $r = $e->json_query($q);
 459         $ret->{bibs} = $r;
 460         return $ret;
 461     };
 462
 463     $ctx->{fetch_display_fields} = sub {
 464         my $id = shift;
 465
 466         if (@$id == 1) {
 467             return $ctx->{_hl_data}{''.$$id[0]}
 468                 if ($ctx->{_hl_data}{''.$$id[0]});
 469         }
 470
 471         $self->timelog("HL data not cached, fetching from server.");
 472
 473         my $rows = $U->simplereq(
 474             'open-ils.search',
 475             'open-ils.search.fetch.metabib.display_field.highlight',
 476             $ctx->{query_struct}{additional_data}{highlight_map},
 477             map {int($_)} @$id
 478         );
 479
 480         $ctx->{_hl_data}{''.$$id[0]} = $rows if (@$id == 1);
 481
 482         return $rows;
 483     };
 484
 485     $ctx->{course_ou} = int($self->cgi->param('locg')) || $self->ctx->{physical_loc} || $self->ctx->{aou_tree}->()->id;
 486     $ctx->{use_courses} = $ctx->{get_org_setting}->($ctx->{course_ou}, 'circ.course_materials_opt_in') ? 1 : 0;
 487
 488     return Apache2::Const::OK;
 489 }
 490
 491 sub update_dashboard_stats {
 492     my $self = shift;
 493
 494     my $e = $self->editor;
 495     my $ctx = $self->ctx;
 496
 497     $ctx->{user_stats} = $U->simplereq(
 498         'open-ils.actor',
 499         'open-ils.actor.user.opac.vital_stats',
 500         $e->authtoken, $e->requestor->id);
 501 }
 502
 503 sub staff_saved_searches_set_expansion_state {
 504     my $self = shift;
 505
 506     my $param = $self->cgi->param('sss_expand');
 507     my $value;
 508
 509     if (defined $param) {
 510         $value = ($param ? 1 : 0);
 511         $self->apache->headers_out->add(
 512             "Set-Cookie" => $self->cgi->cookie(
 513                 -name => COOKIE_SSS_EXPAND,
 514                 -path => $self->ctx->{base_path},
 515                 -secure => 1,   # not strictly necessary, but this feature is staff-only, so may as well
 516                 -value => $value,
 517                 -expires => undef
 518             )
 519         );
 520     } else {
 521         $value = $self->cgi->cookie(COOKIE_SSS_EXPAND);
 522     }
 523
 524     $self->ctx->{saved_searches_expanded} = $value;
 525 }
 526
 527 # physical_loc (i.e. "original location") passed in as a URL
 528 # param will replace any existing physical_loc stored as a cookie.
 529 # If specified via ENV that rules over all and we don't set cookies.
 530 sub get_physical_loc {
 531     my $self = shift;
 532
 533     return $ENV{physical_loc} if($ENV{physical_loc});
 534
 535     if(my $physical_loc = $self->cgi->param('physical_loc')) {
 536         $self->apache->headers_out->add(
 537             "Set-Cookie" => $self->cgi->cookie(
 538                 -name => COOKIE_PHYSICAL_LOC,
 539                 -path => $self->ctx->{base_path},
 540                 -value => $physical_loc,
 541                 -expires => undef
 542             )
 543         );
 544         return $physical_loc;
 545     }
 546
 547     return $self->cgi->cookie(COOKIE_PHYSICAL_LOC);
 548 }
 549
 550 sub get_carousel_loc {
 551     my $self = shift;
 552     return $self->cgi->param('carousel_loc') || $ENV{carousel_loc};
 553 }
 554
 555 # -----------------------------------------------------------------------------
 556 # Log in and redirect to the redirect_to URL (or home)
 557 # -----------------------------------------------------------------------------
 558 sub load_login {
 559     my $self = shift;
 560     my $cgi = $self->cgi;
 561     my $ctx = $self->ctx;
 562
 563     $self->timelog("Load login begins");
 564
 565     my $sso_org = $ENV{sso_loc} || $self->get_physical_loc || $self->_get_search_lib();
 566     $ctx->{sso_org} = $sso_org;
 567     my $sso_enabled = $ctx->{get_org_setting}->($sso_org, 'opac.login.shib_sso.enable');
 568     my $sso_native = $ctx->{get_org_setting}->($sso_org, 'opac.login.shib_sso.allow_native');
 569     my $sso_eg_match = $ctx->{get_org_setting}->($sso_org, 'opac.login.shib_sso.evergreen_matchpoint') || 'usrname';
 570     my $sso_shib_match = $ctx->{get_org_setting}->($sso_org, 'opac.login.shib_sso.shib_matchpoint') || 'uid';
 571
 572     $ctx->{page} = 'login';
 573
 574     my $username = $cgi->param('username') || '';
 575     $username =~ s/\s//g;  # Remove blanks
 576     my $password = $cgi->param('password');
 577     my $org_unit = $ctx->{physical_loc} || $ctx->{aou_tree}->()->id;
 578     my $persist = $cgi->param('persist');
 579     my $client_tz = $cgi->param('client_tz');
 580
 581     my $sso_user_match_value;
 582     my $response;
 583     my $sso_logged_in;
 584     $self->timelog("SSO is enabled") if ($sso_enabled);
 585     if ($sso_enabled
 586         and $sso_user_match_value = $ENV{$sso_shib_match}
 587         and !$self->cgi->cookie(COOKIE_SHIB_LOGGEDOUT)
 588     ) { # we have a shib session, and have not cleared a previous shib-login cookie
 589         $self->timelog("Have an SSO user match value: $sso_user_match_value");
 590
 591         if ($sso_eg_match eq 'barcode') { # barcode is special
 592             my $card = $self->editor->search_actor_card({barcode => $sso_user_match_value})->[0];
 593             $sso_user_match_value = $card ? $card->usr : undef;
 594             $sso_eg_match = 'id';
 595         }
 596
 597         if ($sso_user_match_value && $sso_eg_match) {
 598             my $user = $self->editor->search_actor_user({ $sso_eg_match => $sso_user_match_value })->[0];
 599             if ($user) { # create a session
 600                 $response = $U->simplereq(
 601                     'open-ils.auth_internal',
 602                     'open-ils.auth_internal.session.create',
 603                     { user_id => $user->id, login_type => 'opac' }
 604                 );
 605                 $sso_logged_in = $response ? 1 : 0;
 606             }
 607         }
 608
 609         $self->timelog("Checked for SSO login");
 610     }
 611
 612     if (!$sso_enabled || (!$response && $sso_native)) {
 613         # initial log form only
 614         return Apache2::Const::OK unless $username and $password;
 615
 616         my $auth_proxy_enabled = 0; # default false
 617         try { # if the service is not running, just let this fail silently
 618             $auth_proxy_enabled = $U->simplereq(
 619                 'open-ils.auth_proxy',
 620                 'open-ils.auth_proxy.enabled');
 621         } catch Error with {};
 622
 623         $self->timelog("Checked for auth proxy: $auth_proxy_enabled; org = $org_unit; username = $username");
 624
 625         my $args = {
 626             type => ($persist) ? 'persist' : 'opac',
 627             org => $org_unit,
 628             agent => 'opac'
 629         };
 630
 631         my $bc_regex = $ctx->{get_org_setting}->($org_unit, 'opac.barcode_regex');
 632
 633         # To avoid surprises, default to "Barcodes start with digits"
 634         $bc_regex = '^\d' unless $bc_regex;
 635
 636         if ($bc_regex and ($username =~ /$bc_regex/)) {
 637             $args->{barcode} = $username;
 638         } else {
 639             $args->{username} = $username;
 640         }
 641
 642         if (!$auth_proxy_enabled) {
 643             my $seed = $U->simplereq(
 644                 'open-ils.auth',
 645                 'open-ils.auth.authenticate.init', $username);
 646             $args->{password} = md5_hex($seed . md5_hex($password));
 647             $response = $U->simplereq(
 648                 'open-ils.auth', 'open-ils.auth.authenticate.complete', $args);
 649         } else {
 650             $args->{password} = $password;
 651             $response = $U->simplereq(
 652                 'open-ils.auth_proxy',
 653                 'open-ils.auth_proxy.login', $args);
 654         }
 655         $self->timelog("Checked password");
 656     } else {
 657         $response ||= OpenILS::Event->new( 'LOGIN_FAILED' ); # assume failure
 658     }
 659
 660     if($U->event_code($response)) {
 661         # login failed, report the reason to the template
 662         $ctx->{login_failed_event} = $response;
 663         return Apache2::Const::OK;
 664     }
 665
 666     # login succeeded, redirect as necessary
 667
 668     my $acct = $self->apache->unparsed_uri;
 669     $acct =~ s|/login|/myopac/main|;
 670
 671     # both login-related cookies should expire at the same time
 672     my $login_cookie_expires = ($persist) ? CORE::time + $response->{payload}->{authtime} : undef;
 673
 674     my $cookie_list = [
 675         # contains the actual auth token and should be sent only over https
 676         $cgi->cookie(
 677             -name => COOKIE_SES,
 678             -path => '/',
 679             -secure => 1,
 680             -value => $response->{payload}->{authtoken},
 681             -expires => $login_cookie_expires
 682         ),
 683         # contains only a hint that we are logged in, and is used to
 684         # trigger a redirect to https
 685         $cgi->cookie(
 686             -name => COOKIE_LOGGEDIN,
 687             -path => '/',
 688             -secure => 0,
 689             -value => '1',
 690             -expires => $login_cookie_expires
 691         )
 692     ];
 693
 694     if ($client_tz) {
 695         # contains the client's tz, as passed by the client
 696         # trigger a redirect to https
 697         push @$cookie_list, $cgi->cookie(
 698             -name => COOKIE_TZ,
 699             -path => '/',
 700             -secure => 0,
 701             -value => $client_tz,
 702             -expires => $login_cookie_expires
 703         );
 704     }
 705
 706     if ($sso_logged_in) {
 707         # tells us if we're logged in via shib, so we can decide whether to try logging in again.
 708         push @$cookie_list, $cgi->cookie(
 709             -name => COOKIE_SHIB_LOGGEDOUT,
 710             -path => '/',
 711             -secure => 0,
 712             -value => '0',
 713             -expires => '-1h'
 714         );
 715         push @$cookie_list, $cgi->cookie(
 716             -name => COOKIE_SHIB_LOGGEDIN,
 717             -path => '/',
 718             -secure => 0,
 719             -value => '1',
 720             -expires => $login_cookie_expires
 721         );
 722     }
 723
 724     return $self->generic_redirect(
 725         $cgi->param('redirect_to') || $acct,
 726         $cookie_list
 727     );
 728 }
 729
 730 sub load_manual_shib_login {
 731     my $self = shift;
 732     my $redirect_to = shift || $self->cgi->param('redirect_to');
 733
 734     my $sso_org = $ENV{sso_loc} || $self->get_physical_loc || $self->_get_search_lib();
 735     my $sso_entity_id = $self->ctx->{get_org_setting}->($sso_org, 'opac.login.shib_sso.entityId');
 736     my $sso_shib_match = $self->ctx->{get_org_setting}->($sso_org, 'opac.login.shib_sso.shib_matchpoint') || 'uid';
 737
 738     return $self->load_login if ($ENV{$sso_shib_match});
 739
 740     my $url = '/Shibboleth.sso/Login?target=' . ($redirect_to || $self->ctx->{home_page});
 741     if ($sso_entity_id) {
 742         $url .= '&entityID=' . $sso_entity_id;
 743     }
 744
 745     return $self->generic_redirect( $url,
 746         [
 747             $self->cgi->cookie(
 748                 -name => COOKIE_SHIB_LOGGEDOUT,
 749                 -path => '/',
 750                 -value => '0',
 751                 -expires => '-1h'
 752             )
 753         ]
 754     );
 755 }
 756
 757 # -----------------------------------------------------------------------------
 758 # Log out and redirect to the home page
 759 # -----------------------------------------------------------------------------
 760 sub load_logout {
 761     my $self = shift;
 762     my $redirect_to = shift || $self->cgi->param('redirect_to');
 763     my $active_logout = $self->cgi->param('active_logout');
 764
 765     my $sso_org = $ENV{sso_loc} || $self->get_physical_loc || $self->_get_search_lib();
 766     $self->ctx->{sso_org} = $sso_org;
 767     my $sso_enabled = $self->ctx->{get_org_setting}->($sso_org, 'opac.login.shib_sso.enable');
 768     my $sso_entity_id = $self->ctx->{get_org_setting}->($sso_org, 'opac.login.shib_sso.entityId');
 769     my $sso_logout = $self->ctx->{get_org_setting}->($sso_org, 'opac.login.shib_sso.logout');
 770     if ($sso_enabled && $sso_logout) {
 771         $redirect_to = '/Shibboleth.sso/Logout?return=' . ($redirect_to || $self->ctx->{home_page});
 772         if ($sso_entity_id) {
 773             $redirect_to .= '&entityID=' . $sso_entity_id;
 774         }
 775     }
 776
 777     # If the user was adding anyting to an anonymous cache
 778     # while logged in, go ahead and clear it out.
 779     $self->clear_anon_cache;
 780
 781     try { # a missing auth token will cause an ugly explosion
 782         $U->simplereq(
 783             'open-ils.auth',
 784             'open-ils.auth.session.delete',
 785             $self->cgi->cookie(COOKIE_SES)
 786         );
 787     } catch Error with {};
 788
 789     return $self->generic_redirect(
 790         $redirect_to || $self->ctx->{home_page},
 791         [
 792             # clear value of and expire both of these login-related cookies
 793             $self->cgi->cookie(
 794                 -name => COOKIE_SES,
 795                 -path => '/',
 796                 -value => '',
 797                 -expires => '-1h'
 798             ),
 799             $self->cgi->cookie(
 800                 -name => COOKIE_LOGGEDIN,
 801                 -path => '/',
 802                 -value => '',
 803                 -expires => '-1h'
 804             ),
 805             ($active_logout ? ($self->cgi->cookie(
 806                 -name => COOKIE_SHIB_LOGGEDOUT,
 807                 -path => '/',
 808                 -value => '1',
 809                 -expires => '2147483647'
 810             )) : ()),
 811             $self->cgi->cookie(
 812                 -name => COOKIE_SHIB_LOGGEDIN,
 813                 -path => '/',
 814                 -value => '0',
 815                 -expires => '-1h'
 816             )
 817         ]
 818     );
 819 }
 820
 821 1;
 822