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