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 use constant COOKIE_PHYSICAL_LOC => 'eg_physical_loc';
  29 use constant COOKIE_SSS_EXPAND => 'eg_sss_expand';
  30
  31 use constant COOKIE_ANON_CACHE => 'anoncache';
  32 use constant ANON_CACHE_MYLIST => 'mylist';
  33 use constant ANON_CACHE_STAFF_SEARCH => 'staffsearch';
  34
  35 sub new {
  36     my($class, $apache, $ctx) = @_;
  37
  38     my $self = bless({}, ref($class) || $class);
  39
  40     $self->apache($apache);
  41     $self->ctx($ctx);
  42     $self->cgi(new CGI);
  43
  44     OpenILS::Utils::CStoreEditor->init; # just in case
  45     $self->editor(new_editor());
  46
  47     return $self;
  48 }
  49
  50
  51 # current Apache2::RequestRec;
  52 sub apache {
  53     my($self, $apache) = @_;
  54     $self->{apache} = $apache if $apache;
  55     return $self->{apache};
  56 }
  57
  58 # runtime / template context
  59 sub ctx {
  60     my($self, $ctx) = @_;
  61     $self->{ctx} = $ctx if $ctx;
  62     return $self->{ctx};
  63 }
  64
  65 # cstore editor
  66 sub editor {
  67     my($self, $editor) = @_;
  68     $self->{editor} = $editor if $editor;
  69     return $self->{editor};
  70 }
  71
  72 # CGI handle
  73 sub cgi {
  74     my($self, $cgi) = @_;
  75     $self->{cgi} = $cgi if $cgi;
  76     return $self->{cgi};
  77 }
  78
  79
  80 # -----------------------------------------------------------------------------
  81 # Perform initial setup, load common data, then load page data
  82 # -----------------------------------------------------------------------------
  83 sub load {
  84     my $self = shift;
  85
  86     $self->init_ro_object_cache;
  87
  88     my $stat = $self->load_common;
  89     return $stat unless $stat == Apache2::Const::OK;
  90
  91     my $path = $self->apache->path_info;
  92
  93     (undef, $self->ctx->{mylist}) = $self->fetch_mylist unless
  94         $path =~ /opac\/my(opac\/lists|list)/;
  95
  96     return $self->load_simple("home") if $path =~ m|opac/home|;
  97     return $self->load_simple("advanced") if
  98         $path =~ m:opac/(advanced|numeric|expert):;
  99
 100     return $self->load_rresults if $path =~ m|opac/results|;
 101     return $self->load_record if $path =~ m|opac/record|;
 102     return $self->load_cnbrowse if $path =~ m|opac/cnbrowse|;
 103
 104     return $self->load_mylist_add if $path =~ m|opac/mylist/add|;
 105     return $self->load_mylist_delete if $path =~ m|opac/mylist/delete|;
 106     return $self->load_mylist_move if $path =~ m|opac/mylist/move|;
 107     return $self->load_mylist if $path =~ m|opac/mylist|;
 108     return $self->load_cache_clear if $path =~ m|opac/cache/clear|;
 109
 110     # ----------------------------------------------------------------
 111     #  Everything below here requires SSL
 112     # ----------------------------------------------------------------
 113     return $self->redirect_ssl unless $self->cgi->https;
 114     return $self->load_password_reset if $path =~ m|opac/password_reset|;
 115     return $self->load_logout if $path =~ m|opac/logout|;
 116
 117     if($path =~ m|opac/login|) {
 118         return $self->load_login unless $self->editor->requestor; # already logged in?
 119
 120         # This will be less confusing to users than to be shown a login form
 121         # when they're already logged in.
 122         return $self->generic_redirect(
 123             sprintf(
 124                 "https://%s%s/myopac/main",
 125                 $self->apache->hostname, $self->ctx->{opac_root}
 126             )
 127         );
 128     }
 129
 130     # ----------------------------------------------------------------
 131     #  Everything below here requires authentication
 132     # ----------------------------------------------------------------
 133     return $self->redirect_auth unless $self->editor->requestor;
 134
 135     return $self->load_place_hold if $path =~ m|opac/place_hold|;
 136     return $self->load_myopac_holds if $path =~ m|opac/myopac/holds|;
 137     return $self->load_myopac_circs if $path =~ m|opac/myopac/circs|;
 138     return $self->load_myopac_payment_form if $path =~ m|opac/myopac/main_payment_form|;
 139     return $self->load_myopac_payments if $path =~ m|opac/myopac/main_payments|;
 140     return $self->load_myopac_pay if $path =~ m|opac/myopac/main_pay|;
 141     return $self->load_myopac_main if $path =~ m|opac/myopac/main|;
 142     return $self->load_myopac_receipt_email if $path =~ m|opac/myopac/receipt_email|;
 143     return $self->load_myopac_receipt_print if $path =~ m|opac/myopac/receipt_print|;
 144     return $self->load_myopac_update_email if $path =~ m|opac/myopac/update_email|;
 145     return $self->load_myopac_update_password if $path =~ m|opac/myopac/update_password|;
 146     return $self->load_myopac_update_username if $path =~ m|opac/myopac/update_username|;
 147     return $self->load_myopac_bookbags if $path =~ m|opac/myopac/lists|;
 148     return $self->load_myopac_bookbag_print if $path =~ m|opac/myopac/list/print|;
 149     return $self->load_myopac_bookbag_update if $path =~ m|opac/myopac/list/update|;
 150     return $self->load_myopac_circ_history if $path =~ m|opac/myopac/circ_history|;
 151     return $self->load_myopac_hold_history if $path =~ m|opac/myopac/hold_history|;
 152     return $self->load_myopac_prefs_notify if $path =~ m|opac/myopac/prefs_notify|;
 153     return $self->load_myopac_prefs_settings if $path =~ m|opac/myopac/prefs_settings|;
 154     return $self->load_myopac_prefs if $path =~ m|opac/myopac/prefs|;
 155
 156     return Apache2::Const::OK;
 157 }
 158
 159
 160 # -----------------------------------------------------------------------------
 161 # Redirect to SSL equivalent of a given page
 162 # -----------------------------------------------------------------------------
 163 sub redirect_ssl {
 164     my $self = shift;
 165     my $new_page = sprintf('https://%s%s', $self->apache->hostname, $self->apache->unparsed_uri);
 166     return $self->generic_redirect($new_page);
 167 }
 168
 169 # -----------------------------------------------------------------------------
 170 # If an authnticated resource is requested w/o auth, redirect to the login page,
 171 # then return to the originally requrested resource upon successful login.
 172 # -----------------------------------------------------------------------------
 173 sub redirect_auth {
 174     my $self = shift;
 175     my $login_page = sprintf('https://%s%s/login', $self->apache->hostname, $self->ctx->{opac_root});
 176     my $redirect_to = uri_escape($self->apache->unparsed_uri);
 177     return $self->generic_redirect("$login_page?redirect_to=$redirect_to");
 178 }
 179
 180 # -----------------------------------------------------------------------------
 181 # Fall-through for loading a basic page
 182 # -----------------------------------------------------------------------------
 183 sub load_simple {
 184     my ($self, $page) = @_;
 185     $self->ctx->{page} = $page;
 186
 187     if (my $patron_barcode = $self->cgi->param("patron_barcode")) {
 188         # Special CGI variable from staff client; propagate henceforth as cookie
 189         $self->apache->headers_out->add(
 190             "Set-Cookie" => $self->cgi->cookie(
 191                 -name => "patron_barcode",
 192                 -path => "/",
 193                 -secure => 1,
 194                 -value => $patron_barcode,
 195                 -expires => undef
 196             )
 197         );
 198     }
 199     return Apache2::Const::OK;
 200 }
 201
 202 # -----------------------------------------------------------------------------
 203 # Tests to see if the user is authenticated and sets some common context values
 204 # -----------------------------------------------------------------------------
 205 sub load_common {
 206     my $self = shift;
 207
 208     my $e = $self->editor;
 209     my $ctx = $self->ctx;
 210
 211     $ctx->{referer} = $self->cgi->referer;
 212     $ctx->{path_info} = $self->cgi->path_info;
 213     $ctx->{full_path} = $ctx->{base_path} . $self->cgi->path_info;
 214     $ctx->{unparsed_uri} = $self->apache->unparsed_uri;
 215     $ctx->{opac_root} = $ctx->{base_path} . "/opac"; # absolute base url
 216     $ctx->{is_staff} = 0; # Assume false, check for workstation id later.  Was: ($self->apache->headers_in->get('User-Agent') =~ /oils_xulrunner/);
 217     $ctx->{physical_loc} = $self->get_physical_loc;
 218
 219     # capture some commonly accessed pages
 220     $ctx->{home_page} = 'http://' . $self->apache->hostname . $self->ctx->{opac_root} . "/home";
 221     $ctx->{logout_page} = 'https://' . $self->apache->hostname . $self->ctx->{opac_root} . "/logout";
 222
 223     if($e->authtoken($self->cgi->cookie(COOKIE_SES))) {
 224
 225         if($e->checkauth) {
 226
 227             $ctx->{authtoken} = $e->authtoken;
 228             $ctx->{authtime} = $e->authtime;
 229             $ctx->{user} = $e->requestor;
 230
 231             $ctx->{user_stats} = $U->simplereq(
 232                 'open-ils.actor',
 233                 'open-ils.actor.user.opac.vital_stats',
 234                 $e->authtoken, $e->requestor->id);
 235             $ctx->{is_staff} = 1 if $e->requestor->wsid;
 236
 237         } else {
 238
 239             # if we encounter a stale authtoken, call load_logout
 240             # to clean up the cookie, then redirect the user to the
 241             # originally requested page
 242             return $self->load_logout($self->apache->unparsed_uri);
 243         }
 244     }
 245
 246     $self->staff_saved_searches_set_expansion_state if $ctx->{is_staff};
 247
 248     return Apache2::Const::OK;
 249 }
 250
 251 sub staff_saved_searches_set_expansion_state {
 252     my $self = shift;
 253
 254     my $param = $self->cgi->param('sss_expand');
 255     my $value;
 256
 257     if (defined $param) {
 258         $value = ($param ? 1 : 0);
 259         $self->apache->headers_out->add(
 260             "Set-Cookie" => $self->cgi->cookie(
 261                 -name => COOKIE_SSS_EXPAND,
 262                 -path => $self->ctx->{base_path},
 263                 -secure => 1,   # not strictly necessary, but this feature is staff-only, so may as well
 264                 -value => $value,
 265                 -expires => undef
 266             )
 267         );
 268     } else {
 269         $value = $self->cgi->cookie(COOKIE_SSS_EXPAND);
 270     }
 271
 272     $self->ctx->{saved_searches_expanded} = $value;
 273 }
 274
 275 # physical_loc (i.e. "original location") passed in as a URL
 276 # param will replace any existing physical_loc stored as a cookie.
 277 sub get_physical_loc {
 278     my $self = shift;
 279
 280     if(my $physical_loc = $self->cgi->param('physical_loc')) {
 281         $self->apache->headers_out->add(
 282             "Set-Cookie" => $self->cgi->cookie(
 283                 -name => COOKIE_PHYSICAL_LOC,
 284                 -path => $self->ctx->{base_path},
 285                 -value => $physical_loc,
 286                 -expires => undef
 287             )
 288         );
 289         return $physical_loc;
 290     }
 291
 292     return $self->cgi->cookie(COOKIE_PHYSICAL_LOC);
 293 }
 294
 295
 296
 297 # -----------------------------------------------------------------------------
 298 # Log in and redirect to the redirect_to URL (or home)
 299 # -----------------------------------------------------------------------------
 300 sub load_login {
 301     my $self = shift;
 302     my $cgi = $self->cgi;
 303     my $ctx = $self->ctx;
 304
 305     $ctx->{page} = 'login';
 306
 307     my $username = $cgi->param('username');
 308     my $password = $cgi->param('password');
 309     my $org_unit = $cgi->param('loc') || $ctx->{aou_tree}->()->id;
 310     my $persist = $cgi->param('persist');
 311
 312     # initial log form only
 313     return Apache2::Const::OK unless $username and $password;
 314
 315         my $seed = $U->simplereq(
 316         'open-ils.auth',
 317                 'open-ils.auth.authenticate.init', $username);
 318
 319     my $args = {
 320         username => $username,
 321         password => md5_hex($seed . md5_hex($password)),
 322         type => ($persist) ? 'persist' : 'opac'
 323     };
 324
 325     my $bc_regex = $ctx->{get_org_setting}->($org_unit, 'opac.barcode_regex');
 326
 327     $args->{barcode} = delete $args->{username}
 328         if $bc_regex and ($username =~ /$bc_regex/);
 329
 330         my $response = $U->simplereq(
 331         'open-ils.auth', 'open-ils.auth.authenticate.complete', $args);
 332
 333     if($U->event_code($response)) {
 334         # login failed, report the reason to the template
 335         $ctx->{login_failed_event} = $response;
 336         return Apache2::Const::OK;
 337     }
 338
 339     # login succeeded, redirect as necessary
 340
 341     my $acct = $self->apache->unparsed_uri;
 342     $acct =~ s|/login|/myopac/main|;
 343
 344     return $self->generic_redirect(
 345         $cgi->param('redirect_to') || $acct,
 346         $cgi->cookie(
 347             -name => COOKIE_SES,
 348             -path => '/',
 349             -secure => 1,
 350             -value => $response->{payload}->{authtoken},
 351             -expires => ($persist) ? CORE::time + $response->{payload}->{authtime} : undef
 352         )
 353     );
 354 }
 355
 356 # -----------------------------------------------------------------------------
 357 # Log out and redirect to the home page
 358 # -----------------------------------------------------------------------------
 359 sub load_logout {
 360     my $self = shift;
 361     my $redirect_to = shift;
 362
 363     # If the user was adding anyting to an anonymous cache
 364     # while logged in, go ahead and clear it out.
 365     $self->clear_anon_cache;
 366
 367     return $self->generic_redirect(
 368         $redirect_to || $self->ctx->{home_page},
 369         $self->cgi->cookie(
 370             -name => COOKIE_SES,
 371             -path => '/',
 372             -value => '',
 373             -expires => '-1h'
 374         )
 375     );
 376 }
 377
 378 1;
 379