src/org/cacert/gigi/output/Form.java

   1 package org.cacert.gigi.output;
   2
   3 import java.io.IOException;
   4 import java.io.PrintWriter;
   5 import java.util.Map;
   6
   7 import javax.servlet.ServletRequest;
   8 import javax.servlet.http.HttpServletRequest;
   9 import javax.servlet.http.HttpSession;
  10
  11 import org.cacert.gigi.GigiApiException;
  12 import org.cacert.gigi.localisation.Language;
  13 import org.cacert.gigi.pages.Page;
  14 import org.cacert.gigi.util.RandomToken;
  15
  16 public abstract class Form implements Outputable {
  17
  18     public static final String CSRF_FIELD = "csrf";
  19
  20     private String csrf;
  21
  22     public Form(HttpServletRequest hsr) {
  23         csrf = RandomToken.generateToken(32);
  24         HttpSession hs = hsr.getSession();
  25         hs.setAttribute("form/" + getClass().getName() + "/" + csrf, this);
  26
  27     }
  28
  29     public abstract boolean submit(PrintWriter out, HttpServletRequest req) throws GigiApiException;
  30
  31     protected String getCsrfFieldName() {
  32         return CSRF_FIELD;
  33     }
  34
  35     @Override
  36     public void output(PrintWriter out, Language l, Map<String, Object> vars) {
  37         out.println("<form method='POST'>");
  38         failed = false;
  39         outputContent(out, l, vars);
  40         out.print("<input type='hidden' name='" + CSRF_FIELD + "' value='");
  41         out.print(getCSRFToken());
  42         out.println("'></form>");
  43     }
  44
  45     protected abstract void outputContent(PrintWriter out, Language l, Map<String, Object> vars);
  46
  47     boolean failed;
  48
  49     protected void outputError(PrintWriter out, ServletRequest req, String text, Object... contents) {
  50         if ( !failed) {
  51             failed = true;
  52             out.println("<div class='formError'>");
  53         }
  54         out.print("<div>");
  55         if (contents.length == 0) {
  56             out.print(Page.translate(req, text));
  57         } else {
  58             out.print(String.format(Page.translate(req, text), contents));
  59         }
  60         out.println("</div>");
  61     }
  62
  63     protected void outputErrorPlain(PrintWriter out, String text) {
  64         if ( !failed) {
  65             failed = true;
  66             out.println("<div class='formError'>");
  67         }
  68         out.print("<div>");
  69         out.print(text);
  70         out.println("</div>");
  71     }
  72
  73     public boolean isFailed(PrintWriter out) {
  74         if (failed) {
  75             out.println("</div>");
  76         }
  77         return failed;
  78     }
  79
  80     protected String getCSRFToken() {
  81         return csrf;
  82     }
  83
  84     public static <T extends Form> T getForm(HttpServletRequest req, Class<T> target) throws CSRFException {
  85         String csrf = req.getParameter(CSRF_FIELD);
  86         if (csrf == null) {
  87             throw new CSRFException();
  88         }
  89         HttpSession hs = req.getSession();
  90         if (hs == null) {
  91             throw new CSRFException();
  92         }
  93         Form f = (Form) hs.getAttribute("form/" + target.getName() + "/" + csrf);
  94         if (f == null) {
  95             throw new CSRFException();
  96         }
  97         return (T) f;
  98     }
  99
 100     public static class CSRFException extends IOException {
 101
 102     }
 103 }