+#---------- request object methods ----------
+
+sub new_request {
+ my ($classbase, $cgi, @extra) = @_;
+ if (!ref $classbase) {
+ $classbase = $classbase->new_verifier(@extra);
+ } else {
+ die if @extra;
+ }
+ my $r = {
+ V => $classbase,
+ S => $classbase->{S},
+ Dbh => $classbase->{Dbh},
+ Cgi => $cgi,
+ };
+ bless $r, ref $classbase;
+}
+
+sub _ch ($$@) { # calls an application hook
+ my ($r,$methname, @args) = @_;
+ my $methfunc = $r->{S}{$methname};
+ return $methfunc->($r->{Cgi}, $r, @args);
+}
+
+sub _rp ($$@) {
+ my ($r,$pnvb) = @_;
+ my $pn = $r->{S}{$pnvb};
+ my $p = scalar $r->_ch('get_param',$pn)
+}
+
+sub _gt ($$) { my ($r, $t) = @_; return $r->_ch('gettext')($t); }
+sub _print ($$) { my ($r, @t) = @_; return $r->_ch('print')(join '', @t); }
+
+# pages/param-sets are
+# n normal non-mutating page
+# r retrieval of information for JS, non-mutating
+# m mutating page
+# u update of information by JS, mutating
+# i login
+# o logout
+# O "you have just logged out" page load
+
+# in cook and par,
+# a, aN anything including -
+# t, tN temporary value (in our db, no logged in user yet)
+# y, yN value corresponds to logged-in user
+# n, nN value not in our db
+# x, xN t or y
+# - no value supplied
+# if N differs the case applies only when the two values differ
+# (eg, a1 y2 does not apply when the logged-in value is supplied twice)
+
+# "stale session" means request originates from a page from a login
+# session which has been revoked (eg by logout); "cleared session"
+# means request originates from a browser which has a different (or
+# no) cookie.
+
+ # Case analysis, cookie mode, app promises re mutate:
+ # cook parm meth form
+ #
+ # any - POST nrmuoi bug or attack, fail
+ # any - GET rmuoi bug or attack, fail
+ # any any GET muoi bug or attack, fail
+ # any t any nrmu bug or attack, fail
+ #
+ # - - GET O "just logged out" page
+ # (any other) O bug or attack, fail
+ #
+ # a1 a2 POST o logout
+ # if a1 is valid, revoke it
+ # if a2 is valid, revoke it
+ # delete cookie
+ # redirect to "just logged out" page
+ # (which contains link to login form)
+ #
+ # - t POST i complain about cookies being disabled
+ # (with link to login form)
+ #
+ # any n POST i complain about stale login form
+ # show new login form
+ #
+ # x1 t2 POST i login (or switch user)
+ # if bad
+ # show new login form
+ # if good
+ # revoke x1 if it was valid and !=t2
+ # upgrade t2 to y2 in our db (setting username)
+ # set cookie to t2
+ # redirect to GET of remaining params
+ #
+ # t1 a2 ANY nrmu treat as - a2 ANY
+ #
+ # y - GET n cross-site link
+ # show data
+ #
+ # y y GET nr fine, show page or send data
+ # y y POST nrmu mutation is OK, do operation
+ #
+ # y1 y2 GET nr request from stale page
+ # do not revoke y2 as not RESTful
+ # treat as y1 n GET
+ #
+ # y1 y2 POST nrmu request from stale page
+ # revoke y2
+ # treat as y1 n POST
+ #
+ # y n GET n intra-site link from stale page,
+ # treat as cross-site link, show data
+ #
+ # y n POST n m intra-site form submission from stale page
+ # show "session interrupted"
+ # with link to main data page
+ #
+ # y n GET r intra-site request from stale page
+ # fail
+ #
+ # y n POST r u intra-site request from stale page
+ # fail
+ #
+ # -/n y2 GET nr intra-site link from cleared session
+ # do not revoke y2 as not RESTful
+ # treat as -/n n GET
+ #
+ # -/n y2 POST nrmu request from cleared session
+ # revoke y2
+ # treat as -/n n POST
+ #
+ # -/n n GET n cross-site link but user not logged in
+ # show login form with redirect to orig params
+ #
+ # -/n n GET rmu user not logged in
+ # fail
+ #
+ # -/n n POST n m user not logged in
+ # show login form
+ #
+ # -/n n POST r u user not logged in
+ # fail
+
+sub _check_divert_core ($) {
+fixme needs wrapping with something to make and commit a transaction
+wrapper should also store answers in the $r object for later retrieval
+ my ($r) = @_;
+
+ my $meth = $r->_ch('get_method');
+ my $cookv = $r->_ch('get_cookie');
+ my $parmv = $r->_rp('assoc_param_name');
+
+ my ($cookt,$cooku) = $r->_db_lookup($cookv);
+ my $parmt = $r->_db_lookup($parmv);
+
+ if ($r->_ch('is_logout')) {
+ $r->_must_be_post();
+ die unless $parmt;
+ $r->_db_revoke($cookv);
+ $r->_db_revoke($parmv);
+ return ({ Kind => 'REDIRECT-LOGGEDOUT',
+ Message => "Logging out...",
+ CookieVal => '',
+ Params => { } });
+ }
+ if ($r->_ch('is_loggedout')) {
+ die unless $meth eq 'GET';
+ die unless $cookt;
+ die unless $parmt;
+ return ({ Kind => 'SMALLPAGE-LOGGEDOUT',
+ Message => "You have been logged out.",
+ CookieVal => '',
+ Params => { } });
+ }
+ if ($r->_ch('is_login')) {
+ $r->_must_be_post();
+ return ({ Kind => 'LOGIN-STALE',
+ Message => "Stale session; you need to log in again.",
+ CookieVal => $r->_fresh_cookie(),
+ Params => { } })
+ if $parmt eq 'n';
+ die unless $parmt eq 't' || $parmt eq 'y';
+ return ({ Kind => 'SMALLPAGE-NOCOOKIE',
+ Message => "You do not seem to have cookies enabled. ".
+ "You must enable cookies as we use them for login.",
+ CookieVal => $r->_fresh_cookie(),
+ Params => $r->_chain_params() })
+ if !$cookt && $parmt eq 't';
+ my $username = $r->_ch('login_ok');
+ return ({ Kind => 'LOGIN-BAD',
+ Message => "Incorrect username/password.",
+ CookieVal => $cookv,
+ Params => $r->_chain_params() })
+ unless defined $username && length $username;
+ $r->_db_revoke($cookv)
+ if defined $cookv && !(defined $parmv && $cookv eq $parmv);
+ $r->_db_record_login_ok($parmv,$username);
+ return ({ Kind => 'REDIRECT-LOGGEDIN',
+ Message => "Logging in...",
+ CookieVal => $parmv,
+ Params => $r->_chain_params() });
+ }
+ if ($cookt eq 't') {
+ $cookt = '';
+ }
+ die if $parmt eq 't';
+
+ if ($cookt eq 'y' && $parmt eq 'y' && $cookv ne $parmv) {
+ $r->_db_revoke($parmv) if $meth eq 'POST';
+ $parmt = 'n';
+ }
+
+ if ($cookt ne 'y') {
+ die unless !$cookt || $cookt eq 'n';
+ die unless !$parmt || $parmt eq 'n' || $parmt eq 'y';
+ if ($meth eq 'GET') {
+ return ({ Kind => 'LOGIN-INCOMINGLINK',
+ Message => "You need to log in again.",
+ CookieVal => $parmv,
+ Params => $r->_chain_params() });
+ } else {
+ return ((Kind => 'LOGIN-FRESH',
+ Message => "You need to log in again.",
+ CookieVal => $parmv,
+ Params => { });
+ }
+ }
+
+ if (!$r->{S}{promise_check_mutate}) {
+ if ($meth ne 'POST') {
+ return ({ Kind => 'MAINPAGEONLY',
+ Message => 'Entering via cross-site link.',
+ CookieVal => $cookv,
+ Params => { } });
+ # NB caller must then ignore params & path!
+ # if this is too hard they can spit out a small form
+ # with a "click to continue"
+ }
+ }
+
+ die unless $cookt eq 'y';
+ die unless $parmt eq 'y';
+ die unless $cookv eq $parmv;
+ $r->{Assoc} = $cookv;
+ $r->{UserOK} = $cooku;
+ return undef;
+}
+
+sub _chain_params ($) {
+ my ($r) = @_;
+ my %p = %{ $r->_ch('get_params') };
+ foreach my $pncn (keys %{ $r->{S} }) {
+ if ($pncn =~ m/_param_name$/) {
+ my $name = $r->{S}{$pncn};
+ die "$pncn ?" if ref $name;
+ $names = [ $name ];
+ } elsif ($pncn =~ m/_param_names$/) {
+ $names = $r->{S}{$pncn};
+ } else {
+ next;
+ }
+ foreach my $param (@$names) {
+ delete $p{$name};
+ }
+ }
+ return \%p;
+}
+
+sub _db_lookup ($$) {
+ # returns ($t,$username)
+ # where $t is one of "t" "y" "n", or "" (for -)
+ my ($r,$v) = @_;
+
+ my $dbh = $r->{Dbh};
+
+ my ($nusername, $nlast) =
+ $dbh->selectrow_array("SELECT username, last".
+ " FROM $r->{S}{assocdb_table}".
+ " WHERE associd = ?", {}, $nassoc);
+ return ('') unless defined $nusername;
+
+ my $timeout = $r->{S}{login_timeout};
+ return ('n') unless !defined $timeout || time <= $nlast + $timeout;
+
+ return ('t') unless defined $nusername;
+
+ # hooray
+ return ('y', $nusername);
+}
+
+sub _db_revoke ($$) {
+ # revokes $v if it's valid; no-op if it's not
+ my ($r,$v) = @_;
+
+ my $dbh = $r->{Dbh};
+
+ $dbh->do("DELETE FROM $r->{S}{assocdb_table}".
+ " WHERE associd = ?", {}, $v);
+}
+
+sub _db_record_login_ok ($$$) {
+ my ($r,$v,$user) = @_;
+ $r->_db_revoke($v);
+ $dbh->do("INSERT INTO $r->{S}{assocdb_table}".
+ " (associd, username, last) VALUES (?,?,?)", {},
+ $v, $user, time);
+}
+
+sub check_divert ($) {
+ my ($r) = @_;
+ my $divert;
+ if (exists $r->{Divert}) {
+ return $r->{Divert};
+ }
+ $dbh->do("BEGIN");
+ if (!eval {
+ $divert = $r->_check_divert_core();
+ 1;
+ }) {
+ $dbh->do("ABORT");
+ die $@;
+ }
+ $r->{Divert} = $divert;