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