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 use Time::HiRes;
  18
  19 # EGCatLoader sub-modules
  20 use OpenILS::WWW::EGCatLoader::Util;
  21 use OpenILS::WWW::EGCatLoader::Account;
  22 use OpenILS::WWW::EGCatLoader::Browse;
  23 use OpenILS::WWW::EGCatLoader::Library;
  24 use OpenILS::WWW::EGCatLoader::Search;
  25 use OpenILS::WWW::EGCatLoader::Record;
  26 use OpenILS::WWW::EGCatLoader::Container;
  27 use OpenILS::WWW::EGCatLoader::SMS;
  28 use OpenILS::WWW::EGCatLoader::Register;
  29
  30 my $U = 'OpenILS::Application::AppUtils';
  31
  32 use constant COOKIE_SES => 'ses';
  33 use constant COOKIE_LOGGEDIN => 'eg_loggedin';
  34 use constant COOKIE_PHYSICAL_LOC => 'eg_physical_loc';
  35 use constant COOKIE_SSS_EXPAND => 'eg_sss_expand';
  36
  37 use constant COOKIE_ANON_CACHE => 'anoncache';
  38 use constant ANON_CACHE_MYLIST => 'mylist';
  39 use constant ANON_CACHE_STAFF_SEARCH => 'staffsearch';
  40
  41 use constant DEBUG_TIMING => 0;
  42
  43 sub new {
  44     my($class, $apache, $ctx) = @_;
  45
  46     my $self = bless({}, ref($class) || $class);
  47
  48     $self->apache($apache);
  49     $self->ctx($ctx);
  50     $self->cgi(new CGI);
  51     $self->timelog("New page");
  52
  53     OpenILS::Utils::CStoreEditor->init; # just in case
  54     $self->editor(new_editor());
  55
  56     return $self;
  57 }
  58
  59
  60 # current Apache2::RequestRec;
  61 sub apache {
  62     my($self, $apache) = @_;
  63     $self->{apache} = $apache if $apache;
  64     return $self->{apache};
  65 }
  66
  67 # runtime / template context
  68 sub ctx {
  69     my($self, $ctx) = @_;
  70     $self->{ctx} = $ctx if $ctx;
  71     return $self->{ctx};
  72 }
  73
  74 # cstore editor
  75 sub editor {
  76     my($self, $editor) = @_;
  77     $self->{editor} = $editor if $editor;
  78     return $self->{editor};
  79 }
  80
  81 # CGI handle
  82 sub cgi {
  83     my($self, $cgi) = @_;
  84     $self->{cgi} = $cgi if $cgi;
  85     return $self->{cgi};
  86 }
  87
  88 sub timelog {
  89     my($self, $description) = @_;
  90
  91     return unless DEBUG_TIMING;
  92     return unless $description;
  93     $self->ctx->{timing} ||= [];
  94
  95     my $timer = [Time::HiRes::gettimeofday()];
  96     $self->ctx->{time_begin} ||= $timer;
  97
  98     push @{$self->ctx->{timing}}, [
  99         Time::HiRes::tv_interval($self->ctx->{time_begin}, $timer), $description
 100     ];
 101 }
 102
 103 # -----------------------------------------------------------------------------
 104 # Perform initial setup, load common data, then load page data
 105 # -----------------------------------------------------------------------------
 106 sub load {
 107     my $self = shift;
 108
 109     $self->init_ro_object_cache;
 110     $self->timelog("Initial load");
 111
 112     my $stat = $self->load_common;
 113     return $stat unless $stat == Apache2::Const::OK;
 114
 115     my $path = $self->apache->path_info;
 116
 117     if ($path =~ m|opac/?$|) {
 118         # nowhere specified, just go home
 119         return $self->generic_redirect($self->ctx->{home_page});
 120     }
 121
 122     (undef, $self->ctx->{mylist}) = $self->fetch_mylist unless
 123         $path =~ /opac\/my(opac\/lists|list)/;
 124
 125     return $self->load_simple("home") if $path =~ m|opac/home|;
 126     return $self->load_simple("css") if $path =~ m|opac/css|;
 127     return $self->load_simple("advanced") if
 128         $path =~ m:opac/(advanced|numeric|expert):;
 129
 130     return $self->load_library if $path =~ m|opac/library|;
 131     return $self->load_rresults if $path =~ m|opac/results|;
 132     return $self->load_print_record if $path =~ m|opac/record/print|;
 133     return $self->load_record if $path =~ m|opac/record/\d|;
 134     return $self->load_cnbrowse if $path =~ m|opac/cnbrowse|;
 135     return $self->load_browse if $path =~ m|opac/browse|;
 136
 137     return $self->load_mylist_add if $path =~ m|opac/mylist/add|;
 138     return $self->load_mylist_delete if $path =~ m|opac/mylist/delete|;
 139     return $self->load_mylist_move if $path =~ m|opac/mylist/move|;
 140     return $self->load_mylist if $path =~ m|opac/mylist|;
 141     return $self->load_cache_clear if $path =~ m|opac/cache/clear|;
 142     return $self->load_temp_warn_post if $path =~ m|opac/temp_warn/post|;
 143     return $self->load_temp_warn if $path =~ m|opac/temp_warn|;
 144
 145     # ----------------------------------------------------------------
 146     #  Everything below here requires SSL
 147     # ----------------------------------------------------------------
 148     return $self->redirect_ssl unless $self->cgi->https;
 149     return $self->load_password_reset if $path =~ m|opac/password_reset|;
 150     return $self->load_logout if $path =~ m|opac/logout|;
 151     return $self->load_patron_reg if $path =~ m|opac/register|;
 152
 153     if($path =~ m|opac/login|) {
 154         return $self->load_login unless $self->editor->requestor; # already logged in?
 155
 156         # This will be less confusing to users than to be shown a login form
 157         # when they're already logged in.
 158         return $self->generic_redirect(
 159             sprintf(
 160                 "%s://%s%s/myopac/main",
 161                 $self->ctx->{proto},
 162                 $self->ctx->{hostname}, $self->ctx->{opac_root}
 163             )
 164         );
 165     }
 166
 167     if ($path =~ m|opac/sms_cn| and !$self->editor->requestor) {
 168         my $org_unit = $self->ctx->{physical_loc} || $self->cgi->param('loc') || $self->ctx->{aou_tree}->()->id;
 169         my $skip_sms_auth = $self->ctx->{get_org_setting}->($org_unit, 'sms.disable_authentication_requirement.callnumbers');
 170         return $self->load_sms_cn if $skip_sms_auth;
 171     }
 172
 173     # ----------------------------------------------------------------
 174     #  Everything below here requires authentication
 175     # ----------------------------------------------------------------
 176     return $self->redirect_auth unless $self->editor->requestor;
 177
 178     # Don't cache anything requiring auth for security reasons
 179     $self->apache->headers_out->add("cache-control" => "no-store, no-cache, must-revalidate");
 180     $self->apache->headers_out->add("expires" => "-1");
 181
 182     return $self->load_email_record if $path =~ m|opac/record/email|;
 183
 184     return $self->load_place_hold if $path =~ m|opac/place_hold|;
 185     return $self->load_myopac_holds if $path =~ m|opac/myopac/holds|;
 186     return $self->load_myopac_circs if $path =~ m|opac/myopac/circs|;
 187     return $self->load_myopac_payment_form if $path =~ m|opac/myopac/main_payment_form|;
 188     return $self->load_myopac_payments if $path =~ m|opac/myopac/main_payments|;
 189     return $self->load_myopac_pay_init if $path =~ m|opac/myopac/main_pay_init|;
 190     return $self->load_myopac_pay if $path =~ m|opac/myopac/main_pay|;
 191     return $self->load_myopac_main if $path =~ m|opac/myopac/main|;
 192     return $self->load_myopac_receipt_email if $path =~ m|opac/myopac/receipt_email|;
 193     return $self->load_myopac_receipt_print if $path =~ m|opac/myopac/receipt_print|;
 194     return $self->load_myopac_update_email if $path =~ m|opac/myopac/update_email|;
 195     return $self->load_myopac_update_password if $path =~ m|opac/myopac/update_password|;
 196     return $self->load_myopac_update_username if $path =~ m|opac/myopac/update_username|;
 197     return $self->load_myopac_bookbags if $path =~ m|opac/myopac/lists|;
 198     return $self->load_myopac_bookbag_print if $path =~ m|opac/myopac/list/print|;
 199     return $self->load_myopac_bookbag_update if $path =~ m|opac/myopac/list/update|;
 200     return $self->load_myopac_circ_history_export if $path =~ m|opac/myopac/circ_history/export|;
 201     return $self->load_myopac_circ_history if $path =~ m|opac/myopac/circ_history|;
 202     return $self->load_myopac_hold_history if $path =~ m|opac/myopac/hold_history|;
 203     return $self->load_myopac_prefs_notify if $path =~ m|opac/myopac/prefs_notify|;
 204     return $self->load_myopac_prefs_settings if $path =~ m|opac/myopac/prefs_settings|;
 205     return $self->load_myopac_prefs_my_lists if $path =~ m|opac/myopac/prefs_my_lists|;
 206     return $self->load_myopac_prefs if $path =~ m|opac/myopac/prefs|;
 207     return $self->load_sms_cn if $path =~ m|opac/sms_cn|;
 208
 209     return Apache2::Const::OK;
 210 }
 211
 212
 213 # -----------------------------------------------------------------------------
 214 # Redirect to SSL equivalent of a given page
 215 # -----------------------------------------------------------------------------
 216 sub redirect_ssl {
 217     my $self = shift;
 218     my $new_page = sprintf('%s://%s%s', ($self->ctx->{is_staff} ? 'oils' : 'https'), $self->ctx->{hostname}, $self->apache->unparsed_uri);
 219     return $self->generic_redirect($new_page);
 220 }
 221
 222 # -----------------------------------------------------------------------------
 223 # If an authnticated resource is requested w/o auth, redirect to the login page,
 224 # then return to the originally requrested resource upon successful login.
 225 # -----------------------------------------------------------------------------
 226 sub redirect_auth {
 227     my $self = shift;
 228     my $login_page = sprintf('%s://%s%s/login',($self->ctx->{is_staff} ? 'oils' : 'https'), $self->ctx->{hostname}, $self->ctx->{opac_root});
 229     my $redirect_to = uri_escape_utf8($self->apache->unparsed_uri);
 230     return $self->generic_redirect("$login_page?redirect_to=$redirect_to");
 231 }
 232
 233 # -----------------------------------------------------------------------------
 234 # Fall-through for loading a basic page
 235 # -----------------------------------------------------------------------------
 236 sub load_simple {
 237     my ($self, $page) = @_;
 238     $self->ctx->{page} = $page;
 239     $self->ctx->{search_ou} = $self->_get_search_lib();
 240
 241     return Apache2::Const::OK;
 242 }
 243
 244 # -----------------------------------------------------------------------------
 245 # Tests to see if the user is authenticated and sets some common context values
 246 # -----------------------------------------------------------------------------
 247 sub load_common {
 248     my $self = shift;
 249
 250     my $e = $self->editor;
 251     my $ctx = $self->ctx;
 252
 253     # redirect non-https to https if we think we are already logged in
 254     if ($self->cgi->cookie(COOKIE_LOGGEDIN)) {
 255         return $self->redirect_ssl unless $self->cgi->https;
 256     }
 257
 258     $ctx->{referer} = $self->cgi->referer;
 259     $ctx->{path_info} = $self->cgi->path_info;
 260     $ctx->{full_path} = $ctx->{base_path} . $self->cgi->path_info;
 261     $ctx->{unparsed_uri} = $self->apache->unparsed_uri;
 262     $ctx->{opac_root} = $ctx->{base_path} . "/opac"; # absolute base url
 263
 264     my $xul_wrapper =
 265         ($self->apache->headers_in->get('OILS-Wrapper') || '') =~ /true/;
 266
 267     if ($xul_wrapper) {
 268         # XUL client
 269         $ctx->{is_staff} = 1;
 270         $ctx->{proto} = 'oils';
 271         $ctx->{hostname} = 'remote';
 272     }
 273
 274     $ctx->{physical_loc} = $self->get_physical_loc;
 275
 276     # capture some commonly accessed pages
 277     $ctx->{home_page} = $ctx->{proto} . '://' . $ctx->{hostname} . $self->ctx->{opac_root} . "/home";
 278     $ctx->{logout_page} = ($ctx->{proto} eq 'http' ? 'https' : $ctx->{proto} ) . '://' . $ctx->{hostname} . $self->ctx->{opac_root} . "/logout";
 279
 280     if($e->authtoken($self->cgi->cookie(COOKIE_SES))) {
 281
 282         if($e->checkauth) {
 283
 284             $ctx->{authtoken} = $e->authtoken;
 285             $ctx->{authtime} = $e->authtime;
 286             $ctx->{user} = $e->requestor;
 287             $ctx->{place_unfillable} = 1 if $e->requestor->wsid && $e->allowed('PLACE_UNFILLABLE_HOLD', $e->requestor->ws_ou);
 288
 289             # The browser client does not set an OILS-Wrapper header (above).
 290             # The presence of a workstation and no header indicates staff mode.
 291             # FIXME: this approach leaves un-wrapped TPAC's within the same
 292             # browser (and hence same ses cookie) in an unnatural is_staff
 293             # state.  Consider alternatives for determining is_staff /
 294             # is_browser_staff when $xul_wrapper is false.
 295             if (!$xul_wrapper and $e->requestor->wsid) {
 296                 $ctx->{is_staff} = 1;
 297                 $ctx->{is_browser_staff} = 1;
 298             }
 299
 300             $ctx->{user_stats} = $U->simplereq(
 301                 'open-ils.actor',
 302                 'open-ils.actor.user.opac.vital_stats',
 303                 $e->authtoken, $e->requestor->id);
 304
 305         } else {
 306
 307             # if we encounter a stale authtoken, call load_logout
 308             # to clean up the cookie, then redirect the user to the
 309             # originally requested page
 310             return $self->load_logout($self->apache->unparsed_uri);
 311         }
 312     }
 313
 314     $self->extract_copy_location_group_info;
 315     $ctx->{search_ou} = $self->_get_search_lib();
 316     $self->staff_saved_searches_set_expansion_state if $ctx->{is_staff};
 317     $self->load_eg_cache_hash;
 318     $self->load_copy_location_groups;
 319     $self->staff_saved_searches_set_expansion_state if $ctx->{is_staff};
 320     $self->load_search_filter_groups($ctx->{search_ou});
 321     $self->load_org_util_funcs;
 322     $self->load_perm_funcs;
 323
 324     return Apache2::Const::OK;
 325 }
 326
 327 sub staff_saved_searches_set_expansion_state {
 328     my $self = shift;
 329
 330     my $param = $self->cgi->param('sss_expand');
 331     my $value;
 332
 333     if (defined $param) {
 334         $value = ($param ? 1 : 0);
 335         $self->apache->headers_out->add(
 336             "Set-Cookie" => $self->cgi->cookie(
 337                 -name => COOKIE_SSS_EXPAND,
 338                 -path => $self->ctx->{base_path},
 339                 -secure => 1,   # not strictly necessary, but this feature is staff-only, so may as well
 340                 -value => $value,
 341                 -expires => undef
 342             )
 343         );
 344     } else {
 345         $value = $self->cgi->cookie(COOKIE_SSS_EXPAND);
 346     }
 347
 348     $self->ctx->{saved_searches_expanded} = $value;
 349 }
 350
 351 # physical_loc (i.e. "original location") passed in as a URL
 352 # param will replace any existing physical_loc stored as a cookie.
 353 # If specified via ENV that rules over all and we don't set cookies.
 354 sub get_physical_loc {
 355     my $self = shift;
 356
 357     return $ENV{physical_loc} if($ENV{physical_loc});
 358
 359     if(my $physical_loc = $self->cgi->param('physical_loc')) {
 360         $self->apache->headers_out->add(
 361             "Set-Cookie" => $self->cgi->cookie(
 362                 -name => COOKIE_PHYSICAL_LOC,
 363                 -path => $self->ctx->{base_path},
 364                 -value => $physical_loc,
 365                 -expires => undef
 366             )
 367         );
 368         return $physical_loc;
 369     }
 370
 371     return $self->cgi->cookie(COOKIE_PHYSICAL_LOC);
 372 }
 373
 374 # -----------------------------------------------------------------------------
 375 # Log in and redirect to the redirect_to URL (or home)
 376 # -----------------------------------------------------------------------------
 377 sub load_login {
 378     my $self = shift;
 379     my $cgi = $self->cgi;
 380     my $ctx = $self->ctx;
 381
 382     $self->timelog("Load login begins");
 383
 384     $ctx->{page} = 'login';
 385
 386     my $username = $cgi->param('username');
 387     $username =~ s/\s//g;  # Remove blanks
 388     my $password = $cgi->param('password');
 389     my $org_unit = $ctx->{physical_loc} || $ctx->{aou_tree}->()->id;
 390     my $persist = $cgi->param('persist');
 391
 392     # initial log form only
 393     return Apache2::Const::OK unless $username and $password;
 394
 395     my $auth_proxy_enabled = 0; # default false
 396     try { # if the service is not running, just let this fail silently
 397         $auth_proxy_enabled = $U->simplereq(
 398             'open-ils.auth_proxy',
 399             'open-ils.auth_proxy.enabled');
 400     } catch Error with {};
 401
 402     $self->timelog("Checked for auth proxy: $auth_proxy_enabled; org = $org_unit; username = $username");
 403
 404     my $args = {
 405         type => ($persist) ? 'persist' : 'opac',
 406         org => $org_unit,
 407         agent => 'opac'
 408     };
 409
 410     my $bc_regex = $ctx->{get_org_setting}->($org_unit, 'opac.barcode_regex');
 411
 412     # To avoid surprises, default to "Barcodes start with digits"
 413     $bc_regex = '^\d' unless $bc_regex;
 414
 415     if ($bc_regex and ($username =~ /$bc_regex/)) {
 416         $args->{barcode} = $username;
 417     } else {
 418         $args->{username} = $username;
 419     }
 420
 421     my $response;
 422     if (!$auth_proxy_enabled) {
 423         my $seed = $U->simplereq(
 424             'open-ils.auth',
 425             'open-ils.auth.authenticate.init', $username);
 426         $args->{password} = md5_hex($seed . md5_hex($password));
 427         $response = $U->simplereq(
 428             'open-ils.auth', 'open-ils.auth.authenticate.complete', $args);
 429     } else {
 430         $args->{password} = $password;
 431         $response = $U->simplereq(
 432             'open-ils.auth_proxy',
 433             'open-ils.auth_proxy.login', $args);
 434     }
 435     $self->timelog("Checked password");
 436
 437     if($U->event_code($response)) {
 438         # login failed, report the reason to the template
 439         $ctx->{login_failed_event} = $response;
 440         return Apache2::Const::OK;
 441     }
 442
 443     # login succeeded, redirect as necessary
 444
 445     my $acct = $self->apache->unparsed_uri;
 446     $acct =~ s|/login|/myopac/main|;
 447
 448     # both login-related cookies should expire at the same time
 449     my $login_cookie_expires = ($persist) ? CORE::time + $response->{payload}->{authtime} : undef;
 450
 451     return $self->generic_redirect(
 452         $cgi->param('redirect_to') || $acct,
 453         [
 454             # contains the actual auth token and should be sent only over https
 455             $cgi->cookie(
 456                 -name => COOKIE_SES,
 457                 -path => '/',
 458                 -secure => 1,
 459                 -value => $response->{payload}->{authtoken},
 460                 -expires => $login_cookie_expires
 461             ),
 462             # contains only a hint that we are logged in, and is used to
 463             # trigger a redirect to https
 464             $cgi->cookie(
 465                 -name => COOKIE_LOGGEDIN,
 466                 -path => '/',
 467                 -secure => 0,
 468                 -value => '1',
 469                 -expires => $login_cookie_expires
 470             )
 471         ]
 472     );
 473 }
 474
 475 # -----------------------------------------------------------------------------
 476 # Log out and redirect to the home page
 477 # -----------------------------------------------------------------------------
 478 sub load_logout {
 479     my $self = shift;
 480     my $redirect_to = shift || $self->cgi->param('redirect_to');
 481
 482     # If the user was adding anyting to an anonymous cache
 483     # while logged in, go ahead and clear it out.
 484     $self->clear_anon_cache;
 485
 486     try { # a missing auth token will cause an ugly explosion
 487         $U->simplereq(
 488             'open-ils.auth',
 489             'open-ils.auth.session.delete',
 490             $self->cgi->cookie(COOKIE_SES)
 491         );
 492     } catch Error with {};
 493
 494     return $self->generic_redirect(
 495         $redirect_to || $self->ctx->{home_page},
 496         [
 497             # clear value of and expire both of these login-related cookies
 498             $self->cgi->cookie(
 499                 -name => COOKIE_SES,
 500                 -path => '/',
 501                 -value => '',
 502                 -expires => '-1h'
 503             ),
 504             $self->cgi->cookie(
 505                 -name => COOKIE_LOGGEDIN,
 506                 -path => '/',
 507                 -value => '',
 508                 -expires => '-1h'
 509             )
 510         ]
 511     );
 512 }
 513
 514 1;
 515