X-Git-Url: https://code.wpia.club/?a=blobdiff_plain;ds=sidebyside;f=src%2Forg%2Fcacert%2Fgigi%2Foutput%2Ftemplate%2FForm.java;h=9e58a3cdf2fa44c9a2f3f360ade984c582f0a84d;hb=17a15662212d973d12ed4cea3f5eaa9c0d1169ed;hp=3f7ab6d1d06750fdeb7789e7a77149df39ec43c6;hpb=557a8a2e5f395400467459f003956bf7660cc044;p=gigi.git diff --git a/src/org/cacert/gigi/output/template/Form.java b/src/org/cacert/gigi/output/template/Form.java index 3f7ab6d1..9e58a3cd 100644 --- a/src/org/cacert/gigi/output/template/Form.java +++ b/src/org/cacert/gigi/output/template/Form.java @@ -2,6 +2,7 @@ package org.cacert.gigi.output.template; import java.io.IOException; import java.io.PrintWriter; +import java.util.HashMap; import java.util.Map; import javax.servlet.http.HttpServletRequest; @@ -9,6 +10,8 @@ import javax.servlet.http.HttpSession; import org.cacert.gigi.GigiApiException; import org.cacert.gigi.localisation.Language; +import org.cacert.gigi.pages.LoginPage; +import org.cacert.gigi.pages.Page; import org.cacert.gigi.util.RandomToken; /** @@ -16,8 +19,22 @@ import org.cacert.gigi.util.RandomToken; */ public abstract class Form implements Outputable { + public static class PermamentFormException extends RuntimeException { + + public PermamentFormException(GigiApiException cause) { + super(cause); + } + + @Override + public synchronized GigiApiException getCause() { + return (GigiApiException) super.getCause(); + } + } + public static final String CSRF_FIELD = "csrf"; + private static final String SUBMIT_EXCEPTION = "form-submit-exception"; + private final String csrf; private final String action; @@ -50,15 +67,80 @@ public abstract class Form implements Outputable { /** * Update the forms internal state based on submitted data. * - * @param out - * the stream to the user. * @param req * the request to take the initial data from. * @return true, iff the form succeeded and the user should be redirected. * @throws GigiApiException - * if internal operations went wrong. + * if form data had problems or operations went wrong. + */ + public abstract boolean submit(HttpServletRequest req) throws GigiApiException; + + /** + * Calls {@link #submit(PrintWriter, HttpServletRequest)} while catching and + * displaying errors ({@link GigiApiException}), and re-outputing the form + * via {@link #output(PrintWriter, Language, Map)}. + * + * @param out + * the target to write the form and errors to + * @param req + * the request that this submit originated (for submit and for + * language) + * @return as {@link #submit(PrintWriter, HttpServletRequest)}: true, iff + * the form succeeded and the user should be redirected. */ - public abstract boolean submit(PrintWriter out, HttpServletRequest req) throws GigiApiException; + public boolean submitProtected(PrintWriter out, HttpServletRequest req) { + try { + boolean succeeded = submit(req); + if (succeeded) { + HttpSession hs = req.getSession(); + hs.removeAttribute("form/" + getClass().getName() + "/" + csrf); + return true; + } + } catch (GigiApiException e) { + e.format(out, LoginPage.getLanguage(req)); + } + output(out, LoginPage.getLanguage(req), new HashMap()); + return false; + } + + public boolean submitExceptionProtected(HttpServletRequest req) { + try { + if (submit(req)) { + HttpSession hs = req.getSession(); + hs.removeAttribute("form/" + getClass().getName() + "/" + csrf); + return true; + } + return false; + } catch (PermamentFormException e) { + req.setAttribute(SUBMIT_EXCEPTION, e); + return false; + } catch (GigiApiException e) { + req.setAttribute(SUBMIT_EXCEPTION, e); + return false; + } + } + + /** + * Prints any errors in any form submits on this request. + * + * @param req + * The request to extract the errors from. + * @param out + * the output stream to the user to write the errors to. + * @return true if no permanent errors occurred and the form should be + * reprinted. + */ + public static boolean printFormErrors(HttpServletRequest req, PrintWriter out) { + Object o = req.getAttribute(SUBMIT_EXCEPTION); + if (o != null && (o instanceof PermamentFormException)) { + ((PermamentFormException) o).getCause().format(out, Page.getLanguage(req)); + return false; + } + if (o != null && (o instanceof GigiApiException)) { + ((GigiApiException) o).format(out, Page.getLanguage(req)); + } + return true; + } protected String getCsrfFieldName() { return CSRF_FIELD;