/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You 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 org.apache.cocoon.components.notification;
import org.apache.cocoon.Constants;
import org.apache.cocoon.xml.XMLUtils;
import org.apache.commons.lang.StringEscapeUtils;
import org.xml.sax.ContentHandler;
import org.xml.sax.SAXException;
import org.xml.sax.helpers.AttributesImpl;
import java.io.IOException;
import java.io.OutputStream;
import java.util.Iterator;
import java.util.Map;
/**
* Generates a representations of the specified Notifying Object.
*
* @author <a href="mailto:nicolaken@supereva.it">Nicola Ken Barozzi</a>
* @author <a href="mailto:stefano@apache.org">Stefano Mazzocchi</a>
* @version $Id$
*/
public class Notifier {
/**
* Generate notification information as a response.
* The notification is directly written to the OutputStream.
* @param n The <code>Notifying</code> object
* @param outputStream The output stream the notification is written to
* This could be <code>null</code>.
*/
public static void notify(Notifying n, OutputStream outputStream, String mimetype) throws IOException {
//(NKB) FIXME should use error page templates, one per mime-type
// currently uses hardcoded html, should be used only as last resort.
notifyHTML(n, outputStream);
}
/**
* Generate notification information as html.
* The notification is directly written to the OutputStream.
* @param n The <code>Notifying</code> object
* @param outputStream The output stream the notification is written to
* This could be <code>null</code>.
*/
private static void notifyHTML(Notifying n, OutputStream outputStream) throws IOException {
if (outputStream == null) {
return;
}
StringBuffer sb = new StringBuffer();
sb.append("<html><head><title>").append(n.getTitle()).append("</title>");
sb.append("<style><!--");
sb.append("body { background-color: white; color: black; font-family: verdana, helvetica, sanf serif;}");
sb.append("h1 {color: #336699; margin: 0px 0px 20px 0px; border-width: 0px 0px 1px 0px; border-style: solid; border-color: #336699;}");
sb.append("p.footer { color: #336699; border-width: 1px 0px 0px 0px; border-style: solid; border-color: #336699; }");
sb.append("span {color: #336699;}");
sb.append("pre {padding-left: 20px;}");
sb.append("a:link {font-weight: bold; color: #336699;}");
sb.append("a:visited {color: #336699; }");
sb.append("a:hover {color: #800000; background-color: #ffff80;}");
sb.append("a:active {color: #006666;}");
sb.append("--></style>");
sb.append("</head><body>");
sb.append("<h1>")
.append(StringEscapeUtils.escapeXml(n.getTitle())).append("</h1>");
sb.append("<p><span>Message:</span> ")
.append(StringEscapeUtils.escapeXml(n.getMessage())).append("</p>");
sb.append("<p><span>Description:</span> ")
.append(StringEscapeUtils.escapeXml(n.getDescription())).append("</p>");
sb.append("<p><span>Sender:</span> ")
.append(StringEscapeUtils.escapeXml(n.getSender())).append("</p>");
sb.append("<p><span>Source:</span> ")
.append(StringEscapeUtils.escapeXml(n.getSource())).append("</p>");
Map extras = n.getExtraDescriptions();
for (Iterator i = extras.entrySet().iterator(); i.hasNext(); ) {
Map.Entry me = (Map.Entry)i.next();
final String key = (String)me.getKey();
sb.append("<p><span>")
.append(key).append("</span><pre>")
.append(StringEscapeUtils.escapeXml(String.valueOf(me.getValue())))
.append("</pre></p>");
}
sb.append("<p class='footer'><a href='http://cocoon.apache.org/'>").append(Constants.COMPLETE_NAME).append("</p>");
sb.append("</body></html>");
outputStream.write(sb.toString().getBytes());
}
/**
* Generate notification information in XML format.
*/
public static void notify(Notifying n, ContentHandler ch, String mimetype) throws SAXException {
final String PREFIX = Constants.ERROR_NAMESPACE_PREFIX;
final String URI = Constants.ERROR_NAMESPACE_URI;
// Start the document
ch.startDocument();
ch.startPrefixMapping(PREFIX, URI);
// Root element.
AttributesImpl atts = new AttributesImpl();
atts.addAttribute(URI, "type", PREFIX + ":type", "CDATA", n.getType());
atts.addAttribute(URI, "sender", PREFIX + ":sender", "CDATA", n.getSender());
ch.startElement(URI, "notify", PREFIX + ":notify", atts);
ch.startElement(URI, "title", PREFIX + ":title", new AttributesImpl());
ch.characters(n.getTitle().toCharArray(), 0, n.getTitle().length());
ch.endElement(URI, "title", PREFIX + ":title");
ch.startElement(URI, "source", PREFIX + ":source", new AttributesImpl());
ch.characters(n.getSource().toCharArray(), 0, n.getSource().length());
ch.endElement(URI, "source", PREFIX + ":source");
ch.startElement(URI, "message", PREFIX + ":message", new AttributesImpl());
if (n.getMessage() != null) {
ch.characters(n.getMessage().toCharArray(), 0, n.getMessage().length());
}
ch.endElement(URI, "message", PREFIX + ":message");
ch.startElement(URI, "description", PREFIX + ":description", XMLUtils.EMPTY_ATTRIBUTES);
ch.characters(n.getDescription().toCharArray(), 0, n.getDescription().length());
ch.endElement(URI, "description", PREFIX + ":description");
Map extraDescriptions = n.getExtraDescriptions();
for (Iterator i = extraDescriptions.entrySet().iterator(); i.hasNext(); ) {
final Map.Entry me = (Map.Entry) i.next();
String key = (String) me.getKey();
String value = String.valueOf(me.getValue());
atts = new AttributesImpl();
atts.addAttribute(URI, "description", PREFIX + ":description", "CDATA", key);
ch.startElement(URI, "extra", PREFIX + ":extra", atts);
ch.characters(value.toCharArray(), 0, value.length());
ch.endElement(URI, "extra", PREFIX + ":extra");
}
// End root element.
ch.endElement(URI, "notify", PREFIX + ":notify");
// End the document.
ch.endPrefixMapping(PREFIX);
ch.endDocument();
}
}