/**
* The contents of this file are subject to the license and copyright
* detailed in the LICENSE and NOTICE files at the root of the source
* tree and available online at
*
* http://www.dspace.org/license/
*/
package org.dspace.app.xmlui.aspect.xmltest;
import java.io.IOException;
import java.sql.SQLException;
import org.apache.cocoon.environment.ObjectModelHelper;
import org.apache.cocoon.environment.Request;
import org.dspace.app.xmlui.cocoon.AbstractDSpaceTransformer;
import org.dspace.app.xmlui.utils.UIException;
import org.dspace.app.xmlui.wing.WingException;
import org.dspace.app.xmlui.wing.element.Body;
import org.dspace.app.xmlui.wing.element.Button;
import org.dspace.app.xmlui.wing.element.CheckBox;
import org.dspace.app.xmlui.wing.element.Division;
import org.dspace.app.xmlui.wing.element.List;
import org.dspace.app.xmlui.wing.element.PageMeta;
import org.dspace.app.xmlui.wing.element.TextArea;
import org.dspace.authorize.AuthorizeException;
import org.xml.sax.SAXException;
/**
* This is a class to test the capabilities of including HTML inside
* a DRI document. This can be useful for resources outside of
* developer's control such as text files on disk or user-supplied data.
*
* This class is not internationalized because it is never intended
* to be used in production. It is merely a tool to aid developers of
* aspects and themes.
*
* @author Scott Phillips
*/
public class HTMLTest extends AbstractDSpaceTransformer
{
// The default string to include in test, may be overridden by the user.
private static final String DEFAULT_HTML_STRING = "<p>This is a test of manakin's ability to render HTML fragments.</p>\n\n<p>Only a few tags are allowed such as: <b>bold</b>, <i>italic</i>, <u>underline</u>, and <a href=\"http://di.tamu.edu/\">link</a>.</p>\n\n<h2>This is a heading</h2>\n\nInvalid tags are treated as plain text: <invalid attribute=\"a\">this is invalid</invalid>\n\nAlso line breaks may be treated as a paragraphs when that action is specified.";
public void addPageMeta(PageMeta pageMeta) throws SAXException,
WingException, UIException, SQLException, IOException,
AuthorizeException
{
pageMeta.addMetadata("title").addContent("HTML Test");
pageMeta.addTrailLink(contextPath + "/","DSpace Home");
pageMeta.addTrail().addContent("HTML Test");
}
public void addBody(Body body) throws SAXException, WingException,
UIException, SQLException, IOException, AuthorizeException
{
Request request = ObjectModelHelper.getRequest(objectModel);
String fragment = request.getParameter("fragment");
String[] options = request.getParameterValues("options");
// If none present set the default HTML string
if (fragment == null || fragment.length() <= 0)
{
fragment = DEFAULT_HTML_STRING;
}
boolean blankLines = false;
if (options != null && options[0].equals("blankLines"))
{
blankLines = true;
}
Division div = body.addInteractiveDivision("html-test", "", Division.METHOD_GET, "primary");
div.setHead("HTML Test");
div.addPara("This page tests Manakin's ability to handle HTML fragments, this ability is normally used to handle user-inputed text. There are two reasons for using this ability of including user supplied HTML fragments 1) it doesn't break the abstraction between themes and aspects, 2) it provides a safety mechanism preventing security vulnerabilities such as cross site scripting.");
List form = div.addList("html-test",List.TYPE_FORM);
TextArea fragmentField = form.addItem().addTextArea("fragment");
fragmentField.setLabel("Fragment");
fragmentField.setHelp("Enter free formed text, you may use <p>,<a>,<b>,<i>, or <img> tags.");
fragmentField.setSize(15, 50);
fragmentField.setValue(fragment);
CheckBox optionsField = form.addItem().addCheckBox("options");
optionsField.setLabel("Options");
optionsField.addOption("blankLines", "Treat blank lines as paragraph breaks.");
if (blankLines)
{
optionsField.setOptionSelected("blankLines");
}
Button submit = form.addItem().addButton("submit");
submit.setValue("Test HTML Rendering");
Division test = div.addDivision("html-test-sample");
test.setHead("Rendered Sample");
test.addSimpleHTMLFragment(blankLines, fragment);
}
}