package OpenILS::WWW::EGCatLoader; use strict; use warnings; use XML::LibXML; use URI::Escape; use Digest::MD5 qw(md5_hex); use Apache2::Const -compile => qw(OK DECLINED FORBIDDEN HTTP_INTERNAL_SERVER_ERROR REDIRECT HTTP_BAD_REQUEST); use OpenSRF::AppSession; use OpenSRF::EX qw/:try/; use OpenSRF::Utils qw/:datetime/; use OpenSRF::Utils::JSON; use OpenSRF::Utils::Logger qw/$logger/; use OpenILS::Application::AppUtils; use OpenILS::Utils::CStoreEditor qw/:funcs/; use OpenILS::Utils::Fieldmapper; use DateTime::Format::ISO8601; use CGI qw(:all -utf8); # EGCatLoader sub-modules use OpenILS::WWW::EGCatLoader::Util; use OpenILS::WWW::EGCatLoader::Account; 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_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'; sub new { my($class, $apache, $ctx) = @_; my $self = bless({}, ref($class) || $class); $self->apache($apache); $self->ctx($ctx); $self->cgi(new CGI); OpenILS::Utils::CStoreEditor->init; # just in case $self->editor(new_editor()); return $self; } # current Apache2::RequestRec; sub apache { my($self, $apache) = @_; $self->{apache} = $apache if $apache; return $self->{apache}; } # runtime / template context sub ctx { my($self, $ctx) = @_; $self->{ctx} = $ctx if $ctx; return $self->{ctx}; } # cstore editor sub editor { my($self, $editor) = @_; $self->{editor} = $editor if $editor; return $self->{editor}; } # CGI handle sub cgi { my($self, $cgi) = @_; $self->{cgi} = $cgi if $cgi; return $self->{cgi}; } # ----------------------------------------------------------------------------- # Perform initial setup, load common data, then load page data # ----------------------------------------------------------------------------- sub load { my $self = shift; $self->init_ro_object_cache; my $stat = $self->load_common; return $stat unless $stat == Apache2::Const::OK; my $path = $self->apache->path_info; (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("advanced") if $path =~ m:opac/(advanced|numeric|expert):; return $self->load_rresults if $path =~ m|opac/results|; return $self->load_record if $path =~ m|opac/record|; 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|; # ---------------------------------------------------------------- # Everything below here requires SSL # ---------------------------------------------------------------- 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 =~ 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 authentication # ---------------------------------------------------------------- return $self->redirect_auth unless $self->editor->requestor; 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 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 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; } # ----------------------------------------------------------------------------- # Redirect to SSL equivalent of a given page # ----------------------------------------------------------------------------- sub redirect_ssl { my $self = shift; my $new_page = sprintf('https://%s%s', $self->apache->hostname, $self->apache->unparsed_uri); return $self->generic_redirect($new_page); } # ----------------------------------------------------------------------------- # If an authnticated resource is requested w/o auth, redirect to the login page, # then return to the originally requrested resource upon successful login. # ----------------------------------------------------------------------------- sub redirect_auth { 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); return $self->generic_redirect("$login_page?redirect_to=$redirect_to"); } # ----------------------------------------------------------------------------- # Fall-through for loading a basic page # ----------------------------------------------------------------------------- sub load_simple { my ($self, $page) = @_; $self->ctx->{page} = $page; $self->ctx->{search_ou} = $self->_get_search_lib(); if (my $patron_barcode = $self->cgi->param("patron_barcode")) { # Special CGI variable from staff client; propagate henceforth as cookie $self->apache->headers_out->add( "Set-Cookie" => $self->cgi->cookie( -name => "patron_barcode", -path => "/", -secure => 1, -value => $patron_barcode, -expires => undef ) ); } return Apache2::Const::OK; } # ----------------------------------------------------------------------------- # Tests to see if the user is authenticated and sets some common context values # ----------------------------------------------------------------------------- sub load_common { my $self = shift; my $e = $self->editor; my $ctx = $self->ctx; $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} = 0; # Assume false, check for workstation id later. Was: ($self->apache->headers_in->get('User-Agent') =~ /oils_xulrunner/); $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->{logout_page} = 'https://' . $self->apache->hostname . $self->ctx->{opac_root} . "/logout"; if($e->authtoken($self->cgi->cookie(COOKIE_SES))) { if($e->checkauth) { $ctx->{authtoken} = $e->authtoken; $ctx->{authtime} = $e->authtime; $ctx->{user} = $e->requestor; $ctx->{user_stats} = $U->simplereq( 'open-ils.actor', 'open-ils.actor.user.opac.vital_stats', $e->authtoken, $e->requestor->id); $ctx->{is_staff} = 1 if $e->requestor->wsid; } else { # 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); } } $ctx->{search_ou} = $self->_get_search_lib(); $self->staff_saved_searches_set_expansion_state if $ctx->{is_staff}; $self->load_eg_cache_hash; 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. sub get_physical_loc { my $self = shift; 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) # ----------------------------------------------------------------------------- sub load_login { my $self = shift; my $cgi = $self->cgi; my $ctx = $self->ctx; $ctx->{page} = 'login'; my $username = $cgi->param('username'); my $password = $cgi->param('password'); my $org_unit = $cgi->param('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 $args = { username => $username, password => md5_hex($seed . md5_hex($password)), type => ($persist) ? 'persist' : 'opac', 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/); my $response = $U->simplereq( 'open-ils.auth', 'open-ils.auth.authenticate.complete', $args); if($U->event_code($response)) { # login failed, report the reason to the template $ctx->{login_failed_event} = $response; return Apache2::Const::OK; } # login succeeded, redirect as necessary my $acct = $self->apache->unparsed_uri; $acct =~ s|/login|/myopac/main|; return $self->generic_redirect( $cgi->param('redirect_to') || $acct, $cgi->cookie( -name => COOKIE_SES, -path => '/', -secure => 1, -value => $response->{payload}->{authtoken}, -expires => ($persist) ? CORE::time + $response->{payload}->{authtime} : undef ) ); } # ----------------------------------------------------------------------------- # Log out and redirect to the home page # ----------------------------------------------------------------------------- sub load_logout { my $self = shift; my $redirect_to = shift; # If the user was adding anyting to an anonymous cache # while logged in, go ahead and clear it out. $self->clear_anon_cache; return $self->generic_redirect( $redirect_to || $self->ctx->{home_page}, $self->cgi->cookie( -name => COOKIE_SES, -path => '/', -value => '', -expires => '-1h' ) ); } 1;