1 files changed, 188 insertions, 0 deletions
diff --git a/server/src/com/vaadin/terminal/AbstractErrorMessage.java b/server/src/com/vaadin/terminal/AbstractErrorMessage.java
new file mode 100644
index 0000000000..808791158a
--- /dev/null
+++ b/server/src/com/vaadin/terminal/AbstractErrorMessage.java
@@ -0,0 +1,188 @@
+/* 
+ * Copyright 2011 Vaadin Ltd.
+ * 
+ * Licensed under the Apache License, Version 2.0 (the "License"); you may not
+ * use this file except in compliance with the License. You may obtain a copy of
+ * the License at
+ * 
+ * http://www.apache.org/licenses/LICENSE-2.0
+ * 
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+ * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+ * License for the specific language governing permissions and limitations under
+ * the License.
+ */
+
+package com.vaadin.terminal;
+
+import java.io.PrintWriter;
+import java.io.StringWriter;
+import java.util.ArrayList;
+import java.util.List;
+
+import com.vaadin.data.Buffered;
+import com.vaadin.data.Validator;
+import com.vaadin.terminal.gwt.server.AbstractApplicationServlet;
+
+/**
+ * Base class for component error messages.
+ * 
+ * This class is used on the server side to construct the error messages to send
+ * to the client.
+ * 
+ * @since 7.0
+ */
+public abstract class AbstractErrorMessage implements ErrorMessage {
+
+    public enum ContentMode {
+        /**
+         * Content mode, where the error contains only plain text.
+         */
+        TEXT,
+        /**
+         * Content mode, where the error contains preformatted text.
+         */
+        PREFORMATTED,
+        /**
+         * Content mode, where the error contains XHTML.
+         */
+        XHTML;
+    }
+
+    /**
+     * Content mode.
+     */
+    private ContentMode mode = ContentMode.TEXT;
+
+    /**
+     * Message in content mode.
+     */
+    private String message;
+
+    /**
+     * Error level.
+     */
+    private ErrorLevel level = ErrorLevel.ERROR;
+
+    private List<ErrorMessage> causes = new ArrayList<ErrorMessage>();
+
+    protected AbstractErrorMessage(String message) {
+        this.message = message;
+    }
+
+    public String getMessage() {
+        return message;
+    }
+
+    protected void setMessage(String message) {
+        this.message = message;
+    }
+
+    /* Documented in interface */
+    @Override
+    public ErrorLevel getErrorLevel() {
+        return level;
+    }
+
+    protected void setErrorLevel(ErrorLevel level) {
+        this.level = level;
+    }
+
+    protected ContentMode getMode() {
+        return mode;
+    }
+
+    protected void setMode(ContentMode mode) {
+        this.mode = mode;
+    }
+
+    protected List<ErrorMessage> getCauses() {
+        return causes;
+    }
+
+    protected void addCause(ErrorMessage cause) {
+        causes.add(cause);
+    }
+
+    @Override
+    public String getFormattedHtmlMessage() {
+        String result = null;
+        switch (getMode()) {
+        case TEXT:
+            result = AbstractApplicationServlet.safeEscapeForHtml(getMessage());
+            break;
+        case PREFORMATTED:
+            result = "<pre>"
+                    + AbstractApplicationServlet
+                            .safeEscapeForHtml(getMessage()) + "</pre>";
+            break;
+        case XHTML:
+            result = getMessage();
+            break;
+        }
+        // if no message, combine the messages of all children
+        if (null == result && null != getCauses() && getCauses().size() > 0) {
+            StringBuilder sb = new StringBuilder();
+            for (ErrorMessage cause : getCauses()) {
+                String childMessage = cause.getFormattedHtmlMessage();
+                if (null != childMessage) {
+                    sb.append("<div>");
+                    sb.append(childMessage);
+                    sb.append("</div>\n");
+                }
+            }
+            if (sb.length() > 0) {
+                result = sb.toString();
+            }
+        }
+        // still no message? use an empty string for backwards compatibility
+        if (null == result) {
+            result = "";
+        }
+        return result;
+    }
+
+    // TODO replace this with a helper method elsewhere?
+    public static ErrorMessage getErrorMessageForException(Throwable t) {
+        if (null == t) {
+            return null;
+        } else if (t instanceof ErrorMessage) {
+            // legacy case for custom error messages
+            return (ErrorMessage) t;
+        } else if (t instanceof Validator.InvalidValueException) {
+            UserError error = new UserError(
+                    ((Validator.InvalidValueException) t).getHtmlMessage(),
+                    ContentMode.XHTML, ErrorLevel.ERROR);
+            for (Validator.InvalidValueException nestedException : ((Validator.InvalidValueException) t)
+                    .getCauses()) {
+                error.addCause(getErrorMessageForException(nestedException));
+            }
+            return error;
+        } else if (t instanceof Buffered.SourceException) {
+            // no message, only the causes to be painted
+            UserError error = new UserError(null);
+            // in practice, this was always ERROR in Vaadin 6 unless tweaked in
+            // custom exceptions implementing ErrorMessage
+            error.setErrorLevel(ErrorLevel.ERROR);
+            // causes
+            for (Throwable nestedException : ((Buffered.SourceException) t)
+                    .getCauses()) {
+                error.addCause(getErrorMessageForException(nestedException));
+            }
+            return error;
+        } else {
+            StringWriter sw = new StringWriter();
+            PrintWriter pw = new PrintWriter(sw);
+            t.printStackTrace(pw);
+            return new SystemError(sw.toString());
+        }
+    }
+
+    /* Documented in superclass */
+    @Override
+    public String toString() {
+        return getMessage();
+    }
+
+}