package OpenILS::WWW::EGCatLoader;
use strict; use warnings;
-use CGI;
use XML::LibXML;
use URI::Escape;
use Digest::MD5 qw(md5_hex);
use OpenILS::Utils::CStoreEditor qw/:funcs/;
use OpenILS::Utils::Fieldmapper;
use DateTime::Format::ISO8601;
+use CGI qw(:all -utf8);
+use Time::HiRes;
# EGCatLoader sub-modules
use OpenILS::WWW::EGCatLoader::Util;
use OpenILS::WWW::EGCatLoader::Search;
use OpenILS::WWW::EGCatLoader::Record;
use OpenILS::WWW::EGCatLoader::Container;
+use OpenILS::WWW::EGCatLoader::SMS;
my $U = 'OpenILS::Application::AppUtils';
use constant COOKIE_SES => 'ses';
+use constant COOKIE_LOGGEDIN => 'eg_loggedin';
+use constant COOKIE_PHYSICAL_LOC => 'eg_physical_loc';
+use constant COOKIE_SSS_EXPAND => 'eg_sss_expand';
+
+use constant COOKIE_ANON_CACHE => 'anoncache';
+use constant ANON_CACHE_MYLIST => 'mylist';
+use constant ANON_CACHE_STAFF_SEARCH => 'staffsearch';
+
+use constant DEBUG_TIMING => 0;
sub new {
my($class, $apache, $ctx) = @_;
$self->apache($apache);
$self->ctx($ctx);
- $self->cgi(CGI->new);
+ $self->cgi(new CGI);
+ $self->timelog("New page");
OpenILS::Utils::CStoreEditor->init; # just in case
$self->editor(new_editor());
return $self->{cgi};
}
+sub timelog {
+ my($self, $description) = @_;
+
+ return unless DEBUG_TIMING;
+ return unless $description;
+ $self->ctx->{timing} ||= [];
+
+ my $timer = [Time::HiRes::gettimeofday()];
+ $self->ctx->{time_begin} ||= $timer;
+
+ push @{$self->ctx->{timing}}, [
+ Time::HiRes::tv_interval($self->ctx->{time_begin}, $timer), $description
+ ];
+}
# -----------------------------------------------------------------------------
# Perform initial setup, load common data, then load page data
my $self = shift;
$self->init_ro_object_cache;
+ $self->timelog("Initial load");
my $stat = $self->load_common;
return $stat unless $stat == Apache2::Const::OK;
my $path = $self->apache->path_info;
- return $self->load_simple("home") if $path =~ /opac\/home/;
- return $self->load_simple("advanced") if $path =~ /opac\/advanced/;
- return $self->load_rresults if $path =~ /opac\/results/;
- return $self->load_record if $path =~ /opac\/record/;
- return $self->load_mylist_add if $path =~ /opac\/mylist\/add/;
- return $self->load_mylist_del if $path =~ /opac\/mylist\/del/;
- return $self->load_cache_clear if $path =~ /opac\/cache\/clear/;
+ (undef, $self->ctx->{mylist}) = $self->fetch_mylist unless
+ $path =~ /opac\/my(opac\/lists|list)/;
+
+ return $self->load_simple("home") if $path =~ m|opac/home|;
+ return $self->load_simple("css") if $path =~ m|opac/css|;
+ return $self->load_simple("advanced") if
+ $path =~ m:opac/(advanced|numeric|expert):;
+
+ return $self->load_rresults if $path =~ m|opac/results|;
+ return $self->load_print_record if $path =~ m|opac/record/print|;
+ return $self->load_record if $path =~ m|opac/record/\d|;
+ return $self->load_cnbrowse if $path =~ m|opac/cnbrowse|;
+
+ return $self->load_mylist_add if $path =~ m|opac/mylist/add|;
+ return $self->load_mylist_delete if $path =~ m|opac/mylist/delete|;
+ return $self->load_mylist_move if $path =~ m|opac/mylist/move|;
+ return $self->load_mylist if $path =~ m|opac/mylist|;
+ return $self->load_cache_clear if $path =~ m|opac/cache/clear|;
+ return $self->load_temp_warn_post if $path =~ m|opac/temp_warn/post|;
+ return $self->load_temp_warn if $path =~ m|opac/temp_warn|;
# ----------------------------------------------------------------
- # Logout and login require SSL
+ # Everything below here requires SSL
# ----------------------------------------------------------------
- if($path =~ /opac\/login/) {
- return $self->redirect_ssl unless $self->cgi->https;
- return $self->load_login;
+ return $self->redirect_ssl unless $self->cgi->https;
+ return $self->load_password_reset if $path =~ m|opac/password_reset|;
+ return $self->load_logout if $path =~ m|opac/logout|;
+
+ if($path =~ m|opac/login|) {
+ return $self->load_login unless $self->editor->requestor; # already logged in?
+
+ # This will be less confusing to users than to be shown a login form
+ # when they're already logged in.
+ return $self->generic_redirect(
+ sprintf(
+ "https://%s%s/myopac/main",
+ $self->apache->hostname, $self->ctx->{opac_root}
+ )
+ );
}
- if($path =~ /opac\/logout/) {
- #return Apache2::Const::FORBIDDEN unless $self->cgi->https;
- $self->apache->log->warn("catloader: logout called in non-secure context from " .
- ($self->ctx->{referer} || '<no referer>')) unless $self->cgi->https;
- return $self->load_logout;
+ if ($path =~ m|opac/sms_cn| and !$self->editor->requestor) {
+ my $org_unit = $self->ctx->{physical_loc} || $self->cgi->param('loc') || $self->ctx->{aou_tree}->()->id;
+ my $skip_sms_auth = $self->ctx->{get_org_setting}->($org_unit, 'sms.disable_authentication_requirement.callnumbers');
+ return $self->load_sms_cn if $skip_sms_auth;
}
# ----------------------------------------------------------------
- # Everything below here requires SSL + authentication
+ # Everything below here requires authentication
# ----------------------------------------------------------------
- return $self->redirect_auth
- unless $self->cgi->https and $self->editor->requestor;
-
- return $self->load_place_hold if $path =~ /opac\/place_hold/;
- return $self->load_myopac_holds if $path =~ /opac\/myopac\/holds/;
- return $self->load_myopac_circs if $path =~ /opac\/myopac\/circs/;
- return $self->load_myopac_fines if $path =~ /opac\/myopac\/main/;
- return $self->load_myopac_update_email if $path =~ /opac\/myopac\/update_email/;
- return $self->load_myopac_bookbags if $path =~ /opac\/myopac\/bookbags/;
- return $self->load_myopac if $path =~ /opac\/myopac/;
+ return $self->redirect_auth unless $self->editor->requestor;
+
+ # Don't cache anything requiring auth for security reasons
+ $self->apache->headers_out->add("cache-control" => "no-store, no-cache, must-revalidate");
+ $self->apache->headers_out->add("expires" => "-1");
+
+ return $self->load_email_record if $path =~ m|opac/record/email|;
+
+ return $self->load_place_hold if $path =~ m|opac/place_hold|;
+ return $self->load_myopac_holds if $path =~ m|opac/myopac/holds|;
+ return $self->load_myopac_circs if $path =~ m|opac/myopac/circs|;
+ return $self->load_myopac_payment_form if $path =~ m|opac/myopac/main_payment_form|;
+ return $self->load_myopac_payments if $path =~ m|opac/myopac/main_payments|;
+ return $self->load_myopac_pay_init if $path =~ m|opac/myopac/main_pay_init|;
+ return $self->load_myopac_pay if $path =~ m|opac/myopac/main_pay|;
+ return $self->load_myopac_main if $path =~ m|opac/myopac/main|;
+ return $self->load_myopac_receipt_email if $path =~ m|opac/myopac/receipt_email|;
+ return $self->load_myopac_receipt_print if $path =~ m|opac/myopac/receipt_print|;
+ return $self->load_myopac_update_email if $path =~ m|opac/myopac/update_email|;
+ return $self->load_myopac_update_password if $path =~ m|opac/myopac/update_password|;
+ return $self->load_myopac_update_username if $path =~ m|opac/myopac/update_username|;
+ return $self->load_myopac_bookbags if $path =~ m|opac/myopac/lists|;
+ return $self->load_myopac_bookbag_print if $path =~ m|opac/myopac/list/print|;
+ return $self->load_myopac_bookbag_update if $path =~ m|opac/myopac/list/update|;
+ return $self->load_myopac_circ_history_export if $path =~ m|opac/myopac/circ_history/export|;
+ return $self->load_myopac_circ_history if $path =~ m|opac/myopac/circ_history|;
+ return $self->load_myopac_hold_history if $path =~ m|opac/myopac/hold_history|;
+ return $self->load_myopac_prefs_notify if $path =~ m|opac/myopac/prefs_notify|;
+ return $self->load_myopac_prefs_settings if $path =~ m|opac/myopac/prefs_settings|;
+ return $self->load_myopac_prefs if $path =~ m|opac/myopac/prefs|;
+ return $self->load_sms_cn if $path =~ m|opac/sms_cn|;
return Apache2::Const::OK;
}
sub redirect_ssl {
my $self = shift;
my $new_page = sprintf('https://%s%s', $self->apache->hostname, $self->apache->unparsed_uri);
- $self->apache->print($self->cgi->redirect(-url => $new_page));
- return Apache2::Const::REDIRECT;
+ return $self->generic_redirect($new_page);
}
# -----------------------------------------------------------------------------
my $self = shift;
my $login_page = sprintf('https://%s%s/login', $self->apache->hostname, $self->ctx->{opac_root});
my $redirect_to = uri_escape($self->apache->unparsed_uri);
- $self->apache->print($self->cgi->redirect(-url => "$login_page?redirect_to=$redirect_to"));
- return Apache2::Const::REDIRECT;
+ return $self->generic_redirect("$login_page?redirect_to=$redirect_to");
}
# -----------------------------------------------------------------------------
sub load_simple {
my ($self, $page) = @_;
$self->ctx->{page} = $page;
+ $self->ctx->{search_ou} = $self->_get_search_lib();
+
return Apache2::Const::OK;
}
my $e = $self->editor;
my $ctx = $self->ctx;
+ # redirect non-https to https if we think we are already logged in
+ if ($self->cgi->cookie(COOKIE_LOGGEDIN)) {
+ return $self->redirect_ssl unless $self->cgi->https;
+ }
+
$ctx->{referer} = $self->cgi->referer;
$ctx->{path_info} = $self->cgi->path_info;
+ $ctx->{full_path} = $ctx->{base_path} . $self->cgi->path_info;
+ $ctx->{unparsed_uri} = $self->apache->unparsed_uri;
$ctx->{opac_root} = $ctx->{base_path} . "/opac"; # absolute base url
- $ctx->{is_staff} = ($self->apache->headers_in->get('User-Agent') =~ 'oils_xulrunner');
+ $ctx->{is_staff} = ($self->apache->headers_in->get('OILS-Wrapper') =~ /true/);
+ $ctx->{proto} = 'oils' if $ctx->{is_staff};
+ $ctx->{physical_loc} = $self->get_physical_loc;
# capture some commonly accessed pages
$ctx->{home_page} = 'http://' . $self->apache->hostname . $self->ctx->{opac_root} . "/home";
$ctx->{authtoken} = $e->authtoken;
$ctx->{authtime} = $e->authtime;
$ctx->{user} = $e->requestor;
+ $ctx->{place_unfillable} = 1 if $e->requestor->wsid && $e->allowed('PLACE_UNFILLABLE_HOLD', $e->requestor->ws_ou);
$ctx->{user_stats} = $U->simplereq(
'open-ils.actor',
} else {
- # For now, keep an eye out for any pages being unceremoniously redirected to logout...
- $self->apache->log->info("catloader: loading " . $ctx->{path_info} .
- "; auth session " . $e->authtoken . " no longer valid; redirecting to logout");
-
- return $self->load_logout;
+ # if we encounter a stale authtoken, call load_logout
+ # to clean up the cookie, then redirect the user to the
+ # originally requested page
+ return $self->load_logout($self->apache->unparsed_uri);
}
}
+ $self->extract_copy_location_group_info;
+ $ctx->{search_ou} = $self->_get_search_lib();
+ $self->staff_saved_searches_set_expansion_state if $ctx->{is_staff};
+ $self->load_eg_cache_hash;
+ $self->load_copy_location_groups;
+ $self->staff_saved_searches_set_expansion_state if $ctx->{is_staff};
+ $self->load_search_filter_groups($ctx->{search_ou});
+
return Apache2::Const::OK;
}
+sub staff_saved_searches_set_expansion_state {
+ my $self = shift;
+
+ my $param = $self->cgi->param('sss_expand');
+ my $value;
+
+ if (defined $param) {
+ $value = ($param ? 1 : 0);
+ $self->apache->headers_out->add(
+ "Set-Cookie" => $self->cgi->cookie(
+ -name => COOKIE_SSS_EXPAND,
+ -path => $self->ctx->{base_path},
+ -secure => 1, # not strictly necessary, but this feature is staff-only, so may as well
+ -value => $value,
+ -expires => undef
+ )
+ );
+ } else {
+ $value = $self->cgi->cookie(COOKIE_SSS_EXPAND);
+ }
+
+ $self->ctx->{saved_searches_expanded} = $value;
+}
+
+# physical_loc (i.e. "original location") passed in as a URL
+# param will replace any existing physical_loc stored as a cookie.
+# If specified via ENV that rules over all and we don't set cookies.
+sub get_physical_loc {
+ my $self = shift;
+
+ return $ENV{physical_loc} if($ENV{physical_loc});
+
+ if(my $physical_loc = $self->cgi->param('physical_loc')) {
+ $self->apache->headers_out->add(
+ "Set-Cookie" => $self->cgi->cookie(
+ -name => COOKIE_PHYSICAL_LOC,
+ -path => $self->ctx->{base_path},
+ -value => $physical_loc,
+ -expires => undef
+ )
+ );
+ return $physical_loc;
+ }
+
+ return $self->cgi->cookie(COOKIE_PHYSICAL_LOC);
+}
# -----------------------------------------------------------------------------
# Log in and redirect to the redirect_to URL (or home)
my $cgi = $self->cgi;
my $ctx = $self->ctx;
+ $self->timelog("Load login begins");
+
$ctx->{page} = 'login';
my $username = $cgi->param('username');
my $password = $cgi->param('password');
- my $org_unit = $cgi->param('loc') || $ctx->{aou_tree}->()->id;
+ my $org_unit = $ctx->{physical_loc} || $ctx->{aou_tree}->()->id;
my $persist = $cgi->param('persist');
# initial log form only
return Apache2::Const::OK unless $username and $password;
- my $seed = $U->simplereq(
- 'open-ils.auth',
- 'open-ils.auth.authenticate.init', $username);
+ my $auth_proxy_enabled = 0; # default false
+ try { # if the service is not running, just let this fail silently
+ $auth_proxy_enabled = $U->simplereq(
+ 'open-ils.auth_proxy',
+ 'open-ils.auth_proxy.enabled');
+ } catch Error with {};
+
+ $self->timelog("Checked for auth proxy: $auth_proxy_enabled; org = $org_unit; username = $username");
- my $args = {
- username => $username,
- password => md5_hex($seed . md5_hex($password)),
- type => ($persist) ? 'persist' : 'opac'
+ my $args = {
+ type => ($persist) ? 'persist' : 'opac',
+ org => $org_unit,
+ agent => 'opac'
};
my $bc_regex = $ctx->{get_org_setting}->($org_unit, 'opac.barcode_regex');
- $args->{barcode} = delete $args->{username}
- if $bc_regex and $username =~ /$bc_regex/;
+ # To avoid surprises, default to "Barcodes start with digits"
+ $bc_regex = '^\d' unless $bc_regex;
- my $response = $U->simplereq(
- 'open-ils.auth', 'open-ils.auth.authenticate.complete', $args);
+ if ($bc_regex and ($username =~ /$bc_regex/)) {
+ $args->{barcode} = $username;
+ } else {
+ $args->{username} = $username;
+ }
+
+ my $response;
+ if (!$auth_proxy_enabled) {
+ my $seed = $U->simplereq(
+ 'open-ils.auth',
+ 'open-ils.auth.authenticate.init', $username);
+ $args->{password} = md5_hex($seed . md5_hex($password));
+ $response = $U->simplereq(
+ 'open-ils.auth', 'open-ils.auth.authenticate.complete', $args);
+ } else {
+ $args->{password} = $password;
+ $response = $U->simplereq(
+ 'open-ils.auth_proxy',
+ 'open-ils.auth_proxy.login', $args);
+ }
+ $self->timelog("Checked password");
if($U->event_code($response)) {
# login failed, report the reason to the template
# login succeeded, redirect as necessary
my $acct = $self->apache->unparsed_uri;
- $acct =~ s#/login#/myopac/main#;
+ $acct =~ s|/login|/myopac/main|;
- $self->apache->print(
- $cgi->redirect(
- -url => $cgi->param('redirect_to') || $acct,
- -cookie => $cgi->cookie(
+ # both login-related cookies should expire at the same time
+ my $login_cookie_expires = ($persist) ? CORE::time + $response->{payload}->{authtime} : undef;
+
+ return $self->generic_redirect(
+ $cgi->param('redirect_to') || $acct,
+ [
+ # contains the actual auth token and should be sent only over https
+ $cgi->cookie(
-name => COOKIE_SES,
-path => '/',
-secure => 1,
-value => $response->{payload}->{authtoken},
- -expires => ($persist) ? CORE::time + $response->{payload}->{authtime} : undef
+ -expires => $login_cookie_expires
+ ),
+ # contains only a hint that we are logged in, and is used to
+ # trigger a redirect to https
+ $cgi->cookie(
+ -name => COOKIE_LOGGEDIN,
+ -path => '/',
+ -secure => 0,
+ -value => '1',
+ -expires => $login_cookie_expires
)
- )
+ ]
);
-
- return Apache2::Const::REDIRECT;
}
# -----------------------------------------------------------------------------
# -----------------------------------------------------------------------------
sub load_logout {
my $self = shift;
+ my $redirect_to = shift || $self->cgi->param('redirect_to');
# If the user was adding anyting to an anonymous cache
# while logged in, go ahead and clear it out.
$self->clear_anon_cache;
- $self->apache->print(
- $self->cgi->redirect(
- -url => $self->ctx->{home_page},
- -cookie => $self->cgi->cookie(
+ return $self->generic_redirect(
+ $redirect_to || $self->ctx->{home_page},
+ [
+ # clear value of and expire both of these login-related cookies
+ $self->cgi->cookie(
-name => COOKIE_SES,
-path => '/',
-value => '',
-expires => '-1h'
+ ),
+ $self->cgi->cookie(
+ -name => COOKIE_LOGGEDIN,
+ -path => '/',
+ -value => '',
+ -expires => '-1h'
)
- )
+ ]
);
-
- return Apache2::Const::REDIRECT;
}
1;
projects / transitory.git / blobdiff