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