[Yanel-commits] rev 41424 - in public/yanel:
contributions/resources trunk/src/resources
trunk/src/resources/tinymce
trunk/src/resources/tinymce/src/java/org/wyona/yanel/impl/resources/tinymce
michi at wyona.com
michi at wyona.com
Mon Feb 9 12:18:21 CET 2009
Author: michi
Date: 2009-02-09 12:18:20 +0100 (Mon, 09 Feb 2009)
New Revision: 41424
Added:
public/yanel/trunk/src/resources/tinymce/
public/yanel/trunk/src/resources/tinymce/build.xml
public/yanel/trunk/src/resources/tinymce/src/java/org/wyona/yanel/impl/resources/tinymce/TinyMCEResource.java
Removed:
public/yanel/contributions/resources/tinymce/
public/yanel/trunk/src/resources/tinymce/build.xml
public/yanel/trunk/src/resources/tinymce/src/java/org/wyona/yanel/impl/resources/tinymce/TinyMCEResource.java
Log:
moved
Copied: public/yanel/trunk/src/resources/tinymce (from rev 41421, public/yanel/contributions/resources/tinymce)
Deleted: public/yanel/trunk/src/resources/tinymce/build.xml
===================================================================
--- public/yanel/contributions/resources/tinymce/build.xml 2009-02-09 10:59:21 UTC (rev 41421)
+++ public/yanel/trunk/src/resources/tinymce/build.xml 2009-02-09 11:18:20 UTC (rev 41424)
@@ -1,80 +0,0 @@
-<?xml version="1.0"?>
-
-<project name="yanel-resource" default="compile">
-
- <taskdef resource="net/sf/antcontrib/antlib.xml"/>
-
- <!-- <property name="yanel.home" value="${yanel.source.home}"/> -->
- <property file="${user.home}/.ant-global.properties"/>
- <echo>YANEL_HOME is set to: ${yanel.home}</echo>
-
- <property file="${yanel.home}/src/build/local.build.properties"/>
- <property file="${yanel.home}/src/build/build.properties"/>
-
- <import file="src/build/dependencies.xml"/>
-
- <target name="init" description="Initialize build" depends="dependencies">
- <echo>Initialize build</echo>
-
- <dirname property="resource.home.dir" file="${ant.file}"/>
- <echo>Resource Home Directory: ${resource.home.dir}</echo>
-
- <property file="${resource.home.dir}/src/build/local.build.properties"/>
- <property file="${resource.home.dir}/src/build/build.properties"/>
-
- <path id="classpath">
- <pathelement path="${maven2.cp}"/>
- <pathelement path="${maven2.resource.cp}"/>
- </path>
- <property name="resource.build.dir" value="${resource.home.dir}/build"/>
- <property name="resource.classes.dir" value="${resource.build.dir}/classes"/>
- <property name="resource.lib.dir" value="${resource.build.dir}/lib"/>
- <property name="resource.java.dir" value="${resource.home.dir}/src/java"/>
- <property name="resource.resource.xml" value="${resource.home.dir}/resource.xml"/>
- <xmlproperty prefix="resource.resource.xml" file="${resource.resource.xml}"/>
-
- </target>
-
- <target name="compile" description="Compile Java classes" depends="init">
-
- <mkdir dir="${resource.classes.dir}"/>
- <javac srcdir="${resource.java.dir}" destdir="${resource.classes.dir}"
- classpathref="classpath"
- debug="true"
- />
-
- <propertyregex property="new.resource.java.classname.fs.path"
- input="${resource.resource.xml.resource(class)}"
- regexp="[.]"
- replace="/"
- global="true"
- casesensitive="false" />
- <echo>${new.resource.java.classname.fs.path}</echo>
- <propertyregex property="new.resource.java.class.fs.path"
- input="${new.resource.java.classname.fs.path}"
- regexp="\/[^/]*$"
- replace=""
- global="true"
- casesensitive="false" />
- <echo>hilfes${resource.classes.dir}/${new.resource.java.class.fs.path}</echo>
- <copy todir="${resource.classes.dir}/${new.resource.java.class.fs.path}">
- <fileset dir="${resource.home.dir}" includes="resource**,htdocs/**,yanel-htdocs/**"/>
- </copy>
- <mkdir dir="${resource.lib.dir}"/>
- <jar destfile="${resource.lib.dir}/yanel-resource-${resource.name}-${resource.version}.jar"
- basedir="${resource.classes.dir}">
- <fileset dir="${resource.classes.dir}"/>
- </jar>
- </target>
-
- <target name="clean" depends="init">
- <delete dir="${resource.build.dir}"/>
- </target>
-
- <target name="copy-dependencies" depends="init">
- <copy todir="${build.dir}/webapps/${servlet.context.prefix}/WEB-INF/lib">
- <fileset refid="maven2.resource.fileset"/>
- <mapper type="flatten"/>
- </copy>
- </target>
-</project>
Copied: public/yanel/trunk/src/resources/tinymce/build.xml (from rev 41422, public/yanel/contributions/resources/tinymce/build.xml)
===================================================================
--- public/yanel/trunk/src/resources/tinymce/build.xml (rev 0)
+++ public/yanel/trunk/src/resources/tinymce/build.xml 2009-02-09 11:18:20 UTC (rev 41424)
@@ -0,0 +1,80 @@
+<?xml version="1.0"?>
+
+<project name="yanel-resource" default="compile">
+
+ <taskdef resource="net/sf/antcontrib/antlib.xml"/>
+
+ <property name="yanel.home" value="${yanel.source.home}"/>
+ <property file="${user.home}/.ant-global.properties"/>
+ <echo>YANEL_HOME is set to: ${yanel.home}</echo>
+
+ <property file="${yanel.home}/src/build/local.build.properties"/>
+ <property file="${yanel.home}/src/build/build.properties"/>
+
+ <import file="src/build/dependencies.xml"/>
+
+ <target name="init" description="Initialize build" depends="dependencies">
+ <echo>Initialize build</echo>
+
+ <dirname property="resource.home.dir" file="${ant.file}"/>
+ <echo>Resource Home Directory: ${resource.home.dir}</echo>
+
+ <property file="${resource.home.dir}/src/build/local.build.properties"/>
+ <property file="${resource.home.dir}/src/build/build.properties"/>
+
+ <path id="classpath">
+ <pathelement path="${maven2.cp}"/>
+ <pathelement path="${maven2.resource.cp}"/>
+ </path>
+ <property name="resource.build.dir" value="${resource.home.dir}/build"/>
+ <property name="resource.classes.dir" value="${resource.build.dir}/classes"/>
+ <property name="resource.lib.dir" value="${resource.build.dir}/lib"/>
+ <property name="resource.java.dir" value="${resource.home.dir}/src/java"/>
+ <property name="resource.resource.xml" value="${resource.home.dir}/resource.xml"/>
+ <xmlproperty prefix="resource.resource.xml" file="${resource.resource.xml}"/>
+
+ </target>
+
+ <target name="compile" description="Compile Java classes" depends="init">
+
+ <mkdir dir="${resource.classes.dir}"/>
+ <javac srcdir="${resource.java.dir}" destdir="${resource.classes.dir}"
+ classpathref="classpath"
+ debug="true"
+ />
+
+ <propertyregex property="new.resource.java.classname.fs.path"
+ input="${resource.resource.xml.resource(class)}"
+ regexp="[.]"
+ replace="/"
+ global="true"
+ casesensitive="false" />
+ <echo>${new.resource.java.classname.fs.path}</echo>
+ <propertyregex property="new.resource.java.class.fs.path"
+ input="${new.resource.java.classname.fs.path}"
+ regexp="\/[^/]*$"
+ replace=""
+ global="true"
+ casesensitive="false" />
+ <echo>hilfes${resource.classes.dir}/${new.resource.java.class.fs.path}</echo>
+ <copy todir="${resource.classes.dir}/${new.resource.java.class.fs.path}">
+ <fileset dir="${resource.home.dir}" includes="resource**,htdocs/**,yanel-htdocs/**"/>
+ </copy>
+ <mkdir dir="${resource.lib.dir}"/>
+ <jar destfile="${resource.lib.dir}/yanel-resource-${resource.name}-${resource.version}.jar"
+ basedir="${resource.classes.dir}">
+ <fileset dir="${resource.classes.dir}"/>
+ </jar>
+ </target>
+
+ <target name="clean" depends="init">
+ <delete dir="${resource.build.dir}"/>
+ </target>
+
+ <target name="copy-dependencies" depends="init">
+ <copy todir="${build.dir}/webapps/${servlet.context.prefix}/WEB-INF/lib">
+ <fileset refid="maven2.resource.fileset"/>
+ <mapper type="flatten"/>
+ </copy>
+ </target>
+</project>
Deleted: public/yanel/trunk/src/resources/tinymce/src/java/org/wyona/yanel/impl/resources/tinymce/TinyMCEResource.java
===================================================================
--- public/yanel/contributions/resources/tinymce/src/java/org/wyona/yanel/impl/resources/tinymce/TinyMCEResource.java 2009-02-09 10:59:21 UTC (rev 41421)
+++ public/yanel/trunk/src/resources/tinymce/src/java/org/wyona/yanel/impl/resources/tinymce/TinyMCEResource.java 2009-02-09 11:18:20 UTC (rev 41424)
@@ -1,407 +0,0 @@
-/*
- * Copyright 2006 Wyona
- */
-
-package org.wyona.yanel.impl.resources.tinymce;
-
-import java.io.BufferedInputStream;
-import java.io.BufferedReader;
-import java.io.ByteArrayInputStream;
-import java.io.ByteArrayOutputStream;
-import java.io.InputStream;
-import java.io.InputStreamReader;
-import java.io.OutputStream;
-import java.util.Enumeration;
-
-import javax.servlet.http.HttpServletRequest;
-import javax.xml.transform.Source;
-import javax.xml.transform.stream.StreamSource;
-
-import org.apache.log4j.Category;
-import org.apache.log4j.Logger;
-import org.w3c.dom.Document;
-import org.w3c.tidy.Tidy;
-import org.wyona.yanel.core.Environment;
-import org.wyona.yanel.core.Resource;
-import org.wyona.yanel.core.ResourceConfiguration;
-import org.wyona.yanel.core.api.attributes.CreatableV2;
-import org.wyona.yanel.core.api.attributes.ModifiableV2;
-import org.wyona.yanel.core.api.attributes.VersionableV2;
-import org.wyona.yanel.core.api.attributes.ViewableV2;
-import org.wyona.yanel.core.attributes.viewable.View;
-import org.wyona.yanel.core.map.Realm;
-import org.wyona.yanel.core.navigation.Node;
-import org.wyona.yanel.core.navigation.Sitetree;
-import org.wyona.yanel.core.source.SourceResolver;
-import org.wyona.yanel.core.util.PathUtil;
-import org.wyona.yanel.core.util.ResourceAttributeHelper;
-
-import org.wyona.yanel.core.attributes.viewable.ViewDescriptor;
-import org.wyona.yanel.impl.resources.BasicXMLResource;
-import org.wyona.yanel.impl.resources.usecase.ExecutableUsecaseResource;
-import org.wyona.yanel.impl.resources.usecase.UsecaseException;
-import org.wyona.yanel.impl.resources.xml.ConfigurableViewDescriptor;
-import org.apache.commons.lang.StringEscapeUtils;
-import org.apache.commons.io.IOUtils;
-import org.apache.xml.resolver.tools.CatalogResolver;
-
-
-import sun.util.logging.resources.logging;
-
-/**
- *
- */
-public class TinyMCEResource extends ExecutableUsecaseResource {
-
- private static Logger log = Logger.getLogger(TinyMCEResource.class);
-
- private static final String PARAMETER_EDIT_PATH = "edit-path";
- private static final String PARAMETER_CONTINUE_PATH = "continue-path";
- private static final String PARAM_SUBMIT_TIDY = "submit-tidy";
- private static final String PARAM_SUBMIT_TIDY_SAVE = "submit-tidy-save";
- private static final String VIEW_FIX_WELLFORMNESS = "fix-wellformness";
-
- private String editorContent;
- private String resourceContent;
- private String editPath;
- private String contentToEdit;
- private Resource resToEdit;
-
- /* (non-Javadoc)
- * @see org.wyona.yanel.impl.resources.usecase.ExecutableUsecaseResource#processUsecase(java.lang.String)
- */
- protected View processUsecase(String viewID) throws UsecaseException {
- String userID = getEnvironment().getIdentity().getUsername();
- String editorContent = getEditorContent();
- String checkoutUserID = getResToEditCheckoutUserID();
- String resourceContent = getResourceContent();
-
- if (getParameter(PARAM_CANCEL) != null) {
- cancel();
- return generateView(VIEW_CANCEL);
- }
- if (!checkPreconditions() || hasErrors()) {
- setParameter(PARAMETER_CONTINUE_PATH, PathUtil.backToRealm(getPath()) + getEditPath().substring(1));
- return generateView(VIEW_CANCEL);
- }
- if (isResToEditCheckedOut()) {
- addError("Resource is checked out. ");
- if (checkoutUserID != null) {
- if(checkoutUserID.equals(userID)) {
- addError("by YOU! ");
- } else if (!checkoutUserID.equals("null")) {
- addError("by user: " + checkoutUserID + " ");
- return generateView(VIEW_CANCEL);
- } else if (checkoutUserID.equals("null")) {
- addError("by a not loged in user. ");
- }
- }
- }
- if (getParameter(PARAM_SUBMIT_TIDY) != null) {
- contentToEdit = tidy(editorContent);
- if(!isWellformed(IOUtils.toInputStream(contentToEdit))) {
- addError("Tidy seems to have a problem to make the content wellformed. Please fix it manually!");
- return generateView(VIEW_FIX_WELLFORMNESS);
- }
- return generateView(DEFAULT_VIEW_ID);
- }
- if (getParameter(PARAM_SUBMIT_TIDY_SAVE) != null) {
- this.editorContent = tidy(editorContent);
- if(!isWellformed(IOUtils.toInputStream(this.editorContent))) {
- contentToEdit = this.editorContent;
- addError("Tidy seems to have a problem to make to content wellformed. Please fix it manually!");
- return generateView(VIEW_FIX_WELLFORMNESS);
- }
- execute();
- return generateView(VIEW_DONE);
- }
- if (editorContent != null && !isWellformed(IOUtils.toInputStream(editorContent))) {
- contentToEdit = getEditorContent();
- return generateView(VIEW_FIX_WELLFORMNESS);
- }
- if (getParameter(PARAM_SUBMIT) != null) {
- execute();
- return generateView(VIEW_DONE);
- }
- contentToEdit = resourceContent;
- try {
- if (isResToEditVersionableV2() && !isResToEditCheckedOut()) {
- VersionableV2 versionable = (VersionableV2) getResToEdit();
- if (!versionable.isCheckedOut()) {
- versionable.checkout(userID);
- }
- }
- } catch (Exception e) {
- log.warn("Could not checkout resource: " + getResToEdit().getPath() + " " + e.getMessage());
- }
- return generateView(viewID); // this will show the default view if the param is not set
- }
-
- /* (non-Javadoc)
- * @see org.wyona.yanel.impl.resources.usecase.ExecutableUsecaseResource#checkPreconditions()
- */
- public boolean checkPreconditions() throws UsecaseException {
- Resource resToEdit = getResToEdit();
- if (!ResourceAttributeHelper.hasAttributeImplemented(resToEdit, "Modifiable", "2")) {
- addError("The resource you wanted to edit does not implement ModifiableV2 and is therefor not editable with this editor. ");
- return false;
- }
- if (ResourceAttributeHelper.hasAttributeImplemented(resToEdit, "Viewable", "2")) {
- try {
- View view = ((ViewableV2)resToEdit).getView(DEFAULT_VIEW_ID);
- if (!view.getMimeType().contains("html")) {
- addError("Mime-Type not supported: " + view.getMimeType() + ". Only edit html documents with tinyMCE. ");
- return false;
- }
- } catch (Exception e) {
- addError("Could not find out mime-type. " + e.getMessage() + " ");
- return false;
- }
- } else {
- addError("Could not find out mime-type. ");
- return false;
- }
- return true;
- }
-
- /* (non-Javadoc)
- * @see org.wyona.yanel.impl.resources.usecase.ExecutableUsecaseResource#execute()
- */
- public void execute() throws UsecaseException {
- final String content = getEditorContent();
- final Resource resToEdit = getResToEdit();
- if (log.isDebugEnabled()) log.debug("saving content: " + content);
- if (ResourceAttributeHelper.hasAttributeImplemented(resToEdit, "Modifiable", "2")) {
- try {
- OutputStream os = ((ModifiableV2) resToEdit).getOutputStream();
- IOUtils.write(content, os);
- addInfoMessage("Succesfully saved resource " + resToEdit.getPath() + ". ");
- if (isResToEditVersionableV2()) {
- VersionableV2 versionable = (VersionableV2)resToEdit;
- try {
- versionable.checkin("Updated with tinyMCE");
- addInfoMessage("Succesfully checked in resource " + resToEdit.getPath() + ". ");
- } catch (Exception e) {
- String msg = "Could not check in resource: " + resToEdit.getPath() + " " + e.getMessage() + ". ";
- log.error(msg, e);
- addError(msg);
- throw new UsecaseException(msg, e);
- }
- }
- } catch (Exception e) {
- log.error("Exception: " + e);
- throw new UsecaseException(e.getMessage(), e);
- }
- } else {
- addError("Could not save the document. ");
- }
- setParameter(PARAMETER_CONTINUE_PATH, PathUtil.backToRealm(getPath()) + getEditPath().substring(1)); // allow jelly template to show link to new event
- }
-
- /* (non-Javadoc)
- * @see org.wyona.yanel.impl.resources.usecase.ExecutableUsecaseResource#cancel()
- */
- public void cancel() throws UsecaseException {
- addInfoMessage("Canceled. ");
- final Resource resToEdit = getResToEdit();
- if (isResToEditVersionableV2()) {
- VersionableV2 versionable = (VersionableV2)resToEdit;
- try {
- versionable.cancelCheckout();
- addInfoMessage("Released lock for: " + resToEdit.getPath() + ". ");
- } catch (Exception e) {
- log.error(e.getMessage(), e);
- addInfoMessage("Releasing of lock failed because of: " + resToEdit.getPath()
- + " " + e.getMessage() + ". ");
- }
- }
- setParameter(PARAMETER_CONTINUE_PATH, PathUtil.backToRealm(getPath()) + getEditPath().substring(1)); // allow jelly template to show link to new event
- }
-
- /**
- * Get the String containing the path to the resource which is going to be edited
- * @return String
- */
- public String getEditPath() {
- if (editPath == null) {
- if(log.isDebugEnabled()) log.debug("editPath not set yet.");
- editPath = getEnvironment().getRequest().getParameter(PARAMETER_EDIT_PATH);
- }
- if(log.isDebugEnabled()) log.debug("editPath set to: " + editPath);
- return editPath;
- }
-
- /**
- * Get the content proposed to edit
- * used by tinyMCE.jelly
- * @return String
- */
- public String getContentToEdit() {
- return contentToEdit;
- }
-
- /**
- * escape xml
- * @param String to escape
- * @return String escaped
- */
- public String escapeXML(String string) {
- return StringEscapeUtils.escapeXml(string);
- }
-
- /**
- * Tidy content
- * @return String wellformed by tidy
- * @param String to be cleaned
- * @throws UsecaseException
- */
- private String tidy(String content) throws UsecaseException {
- //TODO: tidy should be configured via an external file (e.g. in htdocs)
- ByteArrayOutputStream os = new ByteArrayOutputStream();
- String out = "";
- Tidy tidy = new Tidy();
- tidy.setXHTML(true);
- tidy.setNumEntities(true);
- tidy.setTidyMark(false);
- tidy.setInputEncoding("utf-8");
- tidy.setOutputEncoding("utf-8");
- tidy.parse(IOUtils.toInputStream(content), os);
- try {
- out = os.toString("utf-8");
- } catch (Exception e) {
- throw new UsecaseException(e.getMessage(), e);
- }
- addInfoMessage("Content cleaned with tidy. ");
- return out;
- }
-
- /**
- * Checks if InputStream is wellformed
- * @return boolean true if wellformed, false if not
- * @param InputStream which is checked if wellformed
- * @throws UsecaseException
- */
- private boolean isWellformed(InputStream is) throws UsecaseException {
- try {
- //TODO: code borrowed from YanelServlet.java r40436. see line 902. 1. maybe there is a better way to do so. 2. this code could maybe be refactored into a some xml.util lib.
- javax.xml.parsers.DocumentBuilderFactory dbf= javax.xml.parsers.DocumentBuilderFactory.newInstance();
- javax.xml.parsers.DocumentBuilder parser = dbf.newDocumentBuilder();
- // NOTE: DOCTYPE is being resolved/retrieved (e.g. xhtml schema from w3.org) also
- // if isValidating is set to false.
- // Hence, for performance and network reasons we use a local catalog ...
- // Also see http://www.xml.com/pub/a/2004/03/03/catalogs.html
- // resp. http://xml.apache.org/commons/components/resolver/
- // TODO: What about a resolver factory?
- parser.setEntityResolver(new CatalogResolver());
- parser.parse(is);
- return true;
- } catch (org.xml.sax.SAXException e) {
- addError("Document is not wellformed: " + e.getMessage() + " ");
- return false;
- } catch (Exception e) {
- addError(e.getMessage());
- return false;
- }
- }
-
- /**
- * Get the String with the content of the resource which is going to be edited
- * @return String
- */
- private String getResourceContent() throws UsecaseException {
- if (resourceContent == null) {
- if(log.isDebugEnabled()) log.debug("resourceContent not set yet. Path: " + getEditPath());
- Resource resToEdit = getResToEdit();
- if (ResourceAttributeHelper.hasAttributeImplemented(resToEdit, "Modifiable", "2")) {
- try {
- InputStream is = ((ModifiableV2) resToEdit).getInputStream();
- resourceContent = IOUtils.toString(is);
- } catch (Exception e) {
- log.error("Exception: " + e);
- throw new UsecaseException(e.getMessage(), e);
- }
- } else {
- addError("This resource can not be edited. ");
- }
- }
- if(log.isDebugEnabled()) log.debug("content set to: " + resourceContent);
- return resourceContent;
- }
-
- /**
- * Get the String with the content of the editor
- * @return String
- */
- private String getEditorContent() {
- if (editorContent == null) {
- if(log.isDebugEnabled()) log.debug("content not set yet.");
- editorContent = getParameterAsString(getEditPath());
- }
- if(log.isDebugEnabled()) log.debug("content set to: " + editorContent);
- return editorContent;
- }
-
- /**
- * Get the Resource which is going to be edited
- * @return Resource
- */
- private Resource getResToEdit() throws UsecaseException {
- if (resToEdit == null) {
- if(log.isDebugEnabled()) log.debug("resToEdit not set yet.");
- try {
- resToEdit = getYanel().getResourceManager().getResource(getEnvironment(), getRealm(), getEditPath());
- } catch (Exception e) {
- log.error("Exception: " + e);
- throw new UsecaseException(e.getMessage(), e);
- }
- }
- if(log.isDebugEnabled()) log.debug("resToEdit set to: " + resToEdit.getResourceTypeLocalName());
- return resToEdit;
- }
-
- private boolean isResToEditVersionableV2() {
- try {
- if (ResourceAttributeHelper.hasAttributeImplemented(getResToEdit(), "Versionable", "2")) {
- return true;
- }
- } catch (Exception e) {
- return false;
- }
- return false;
- }
-
- private boolean isResToEditCheckedOut() {
- try {
- if (isResToEditVersionableV2()) {
- VersionableV2 versionable = (VersionableV2) getResToEdit();
- if (versionable.isCheckedOut()) {
- return true;
- }
- }
- } catch (Exception e) {
- return false;
- }
- return false;
- }
-
-
- /**
- * Returns the user id which was supplied when calling checkout(). can be null if not known, or the resource doesn't implement VersionableV2, or resource is not checked out yet. or no way to find out.
- * @return String
- */
- private String getResToEditCheckoutUserID() {
- try {
- if (isResToEditVersionableV2() && isResToEditCheckedOut()) {
- final Resource resToEdit = getResToEdit();
- VersionableV2 versionable = (VersionableV2)resToEdit;
- if (versionable.isCheckedOut()) {
- return versionable.getCheckoutUserID();
- }
- }
- } catch (Exception e) {
- return null;
- }
- return null;
- }
-
-}
\ No newline at end of file
Copied: public/yanel/trunk/src/resources/tinymce/src/java/org/wyona/yanel/impl/resources/tinymce/TinyMCEResource.java (from rev 41423, public/yanel/contributions/resources/tinymce/src/java/org/wyona/yanel/impl/resources/tinymce/TinyMCEResource.java)
===================================================================
--- public/yanel/trunk/src/resources/tinymce/src/java/org/wyona/yanel/impl/resources/tinymce/TinyMCEResource.java (rev 0)
+++ public/yanel/trunk/src/resources/tinymce/src/java/org/wyona/yanel/impl/resources/tinymce/TinyMCEResource.java 2009-02-09 11:18:20 UTC (rev 41424)
@@ -0,0 +1,407 @@
+/*
+ * Copyright 2006 Wyona
+ */
+
+package org.wyona.yanel.impl.resources.tinymce;
+
+import java.io.BufferedInputStream;
+import java.io.BufferedReader;
+import java.io.ByteArrayInputStream;
+import java.io.ByteArrayOutputStream;
+import java.io.InputStream;
+import java.io.InputStreamReader;
+import java.io.OutputStream;
+import java.util.Enumeration;
+
+import javax.servlet.http.HttpServletRequest;
+import javax.xml.transform.Source;
+import javax.xml.transform.stream.StreamSource;
+
+import org.apache.log4j.Category;
+import org.apache.log4j.Logger;
+import org.w3c.dom.Document;
+import org.w3c.tidy.Tidy;
+import org.wyona.yanel.core.Environment;
+import org.wyona.yanel.core.Resource;
+import org.wyona.yanel.core.ResourceConfiguration;
+import org.wyona.yanel.core.api.attributes.CreatableV2;
+import org.wyona.yanel.core.api.attributes.ModifiableV2;
+import org.wyona.yanel.core.api.attributes.VersionableV2;
+import org.wyona.yanel.core.api.attributes.ViewableV2;
+import org.wyona.yanel.core.attributes.viewable.View;
+import org.wyona.yanel.core.map.Realm;
+import org.wyona.yanel.core.navigation.Node;
+import org.wyona.yanel.core.navigation.Sitetree;
+import org.wyona.yanel.core.source.SourceResolver;
+import org.wyona.yanel.core.util.PathUtil;
+import org.wyona.yanel.core.util.ResourceAttributeHelper;
+
+import org.wyona.yanel.core.attributes.viewable.ViewDescriptor;
+import org.wyona.yanel.impl.resources.BasicXMLResource;
+import org.wyona.yanel.impl.resources.usecase.ExecutableUsecaseResource;
+import org.wyona.yanel.impl.resources.usecase.UsecaseException;
+import org.wyona.yanel.impl.resources.xml.ConfigurableViewDescriptor;
+import org.apache.commons.lang.StringEscapeUtils;
+import org.apache.commons.io.IOUtils;
+import org.apache.xml.resolver.tools.CatalogResolver;
+
+
+import sun.util.logging.resources.logging;
+
+/**
+ *
+ */
+public class TinyMCEResource extends ExecutableUsecaseResource {
+
+ private static Logger log = Logger.getLogger(TinyMCEResource.class);
+
+ private static final String PARAMETER_EDIT_PATH = "edit-path";
+ private static final String PARAMETER_CONTINUE_PATH = "continue-path";
+ private static final String PARAM_SUBMIT_TIDY = "submit-tidy";
+ private static final String PARAM_SUBMIT_TIDY_SAVE = "submit-tidy-save";
+ private static final String VIEW_FIX_WELLFORMNESS = "fix-wellformness";
+
+ private String editorContent;
+ private String resourceContent;
+ private String editPath;
+ private String contentToEdit;
+ private Resource resToEdit;
+
+ /* (non-Javadoc)
+ * @see org.wyona.yanel.impl.resources.usecase.ExecutableUsecaseResource#processUsecase(java.lang.String)
+ */
+ protected View processUsecase(String viewID) throws UsecaseException {
+ String userID = getEnvironment().getIdentity().getUsername();
+ String editorContent = getEditorContent();
+ String checkoutUserID = getResToEditCheckoutUserID();
+ String resourceContent = getResourceContent();
+
+ if (getParameter(PARAM_CANCEL) != null) {
+ cancel();
+ return generateView(VIEW_CANCEL);
+ }
+ if (!checkPreconditions() || hasErrors()) {
+ setParameter(PARAMETER_CONTINUE_PATH, PathUtil.backToRealm(getPath()) + getEditPath().substring(1));
+ return generateView(VIEW_CANCEL);
+ }
+ if (isResToEditCheckedOut()) {
+ addError("Resource is checked out ");
+ if (checkoutUserID != null) {
+ if(checkoutUserID.equals(userID)) {
+ addError("by you (User: " + userID + ")! ");
+ } else if (!checkoutUserID.equals("null")) {
+ addError("by user: " + checkoutUserID + " ");
+ return generateView(VIEW_CANCEL);
+ } else if (checkoutUserID.equals("null")) {
+ addError("by a not loged in user. ");
+ }
+ }
+ }
+ if (getParameter(PARAM_SUBMIT_TIDY) != null) {
+ contentToEdit = tidy(editorContent);
+ if(!isWellformed(IOUtils.toInputStream(contentToEdit))) {
+ addError("Tidy seems to have a problem to make the content wellformed. Please fix it manually!");
+ return generateView(VIEW_FIX_WELLFORMNESS);
+ }
+ return generateView(DEFAULT_VIEW_ID);
+ }
+ if (getParameter(PARAM_SUBMIT_TIDY_SAVE) != null) {
+ this.editorContent = tidy(editorContent);
+ if(!isWellformed(IOUtils.toInputStream(this.editorContent))) {
+ contentToEdit = this.editorContent;
+ addError("Tidy seems to have a problem to make to content wellformed. Please fix it manually!");
+ return generateView(VIEW_FIX_WELLFORMNESS);
+ }
+ execute();
+ return generateView(VIEW_DONE);
+ }
+ if (editorContent != null && !isWellformed(IOUtils.toInputStream(editorContent))) {
+ contentToEdit = getEditorContent();
+ return generateView(VIEW_FIX_WELLFORMNESS);
+ }
+ if (getParameter(PARAM_SUBMIT) != null) {
+ execute();
+ return generateView(VIEW_DONE);
+ }
+ contentToEdit = resourceContent;
+ try {
+ if (isResToEditVersionableV2() && !isResToEditCheckedOut()) {
+ VersionableV2 versionable = (VersionableV2) getResToEdit();
+ if (!versionable.isCheckedOut()) {
+ versionable.checkout(userID);
+ }
+ }
+ } catch (Exception e) {
+ log.warn("Could not checkout resource: " + getResToEdit().getPath() + " " + e.getMessage());
+ }
+ return generateView(viewID); // this will show the default view if the param is not set
+ }
+
+ /* (non-Javadoc)
+ * @see org.wyona.yanel.impl.resources.usecase.ExecutableUsecaseResource#checkPreconditions()
+ */
+ public boolean checkPreconditions() throws UsecaseException {
+ Resource resToEdit = getResToEdit();
+ if (!ResourceAttributeHelper.hasAttributeImplemented(resToEdit, "Modifiable", "2")) {
+ addError("The resource you wanted to edit does not implement ModifiableV2 and is therefor not editable with this editor. ");
+ return false;
+ }
+ if (ResourceAttributeHelper.hasAttributeImplemented(resToEdit, "Viewable", "2")) {
+ try {
+ View view = ((ViewableV2)resToEdit).getView(DEFAULT_VIEW_ID);
+ if (!view.getMimeType().contains("html")) {
+ addError("Mime-Type not supported: " + view.getMimeType() + ". Only edit html documents with tinyMCE. ");
+ return false;
+ }
+ } catch (Exception e) {
+ addError("Could not find out mime-type. " + e.getMessage() + " ");
+ return false;
+ }
+ } else {
+ addError("Could not find out mime-type. ");
+ return false;
+ }
+ return true;
+ }
+
+ /* (non-Javadoc)
+ * @see org.wyona.yanel.impl.resources.usecase.ExecutableUsecaseResource#execute()
+ */
+ public void execute() throws UsecaseException {
+ final String content = getEditorContent();
+ final Resource resToEdit = getResToEdit();
+ if (log.isDebugEnabled()) log.debug("saving content: " + content);
+ if (ResourceAttributeHelper.hasAttributeImplemented(resToEdit, "Modifiable", "2")) {
+ try {
+ OutputStream os = ((ModifiableV2) resToEdit).getOutputStream();
+ IOUtils.write(content, os);
+ addInfoMessage("Succesfully saved resource " + resToEdit.getPath() + ". ");
+ if (isResToEditVersionableV2()) {
+ VersionableV2 versionable = (VersionableV2)resToEdit;
+ try {
+ versionable.checkin("Updated with tinyMCE");
+ addInfoMessage("Succesfully checked in resource " + resToEdit.getPath() + ". ");
+ } catch (Exception e) {
+ String msg = "Could not check in resource: " + resToEdit.getPath() + " " + e.getMessage() + ". ";
+ log.error(msg, e);
+ addError(msg);
+ throw new UsecaseException(msg, e);
+ }
+ }
+ } catch (Exception e) {
+ log.error("Exception: " + e);
+ throw new UsecaseException(e.getMessage(), e);
+ }
+ } else {
+ addError("Could not save the document. ");
+ }
+ setParameter(PARAMETER_CONTINUE_PATH, PathUtil.backToRealm(getPath()) + getEditPath().substring(1)); // allow jelly template to show link to new event
+ }
+
+ /* (non-Javadoc)
+ * @see org.wyona.yanel.impl.resources.usecase.ExecutableUsecaseResource#cancel()
+ */
+ public void cancel() throws UsecaseException {
+ addInfoMessage("Canceled. ");
+ final Resource resToEdit = getResToEdit();
+ if (isResToEditVersionableV2()) {
+ VersionableV2 versionable = (VersionableV2)resToEdit;
+ try {
+ versionable.cancelCheckout();
+ addInfoMessage("Released lock for: " + resToEdit.getPath() + ". ");
+ } catch (Exception e) {
+ log.error(e.getMessage(), e);
+ addInfoMessage("Releasing of lock failed because of: " + resToEdit.getPath()
+ + " " + e.getMessage() + ". ");
+ }
+ }
+ setParameter(PARAMETER_CONTINUE_PATH, PathUtil.backToRealm(getPath()) + getEditPath().substring(1)); // allow jelly template to show link to new event
+ }
+
+ /**
+ * Get the String containing the path to the resource which is going to be edited
+ * @return String
+ */
+ public String getEditPath() {
+ if (editPath == null) {
+ if(log.isDebugEnabled()) log.debug("editPath not set yet.");
+ editPath = getEnvironment().getRequest().getParameter(PARAMETER_EDIT_PATH);
+ }
+ if(log.isDebugEnabled()) log.debug("editPath set to: " + editPath);
+ return editPath;
+ }
+
+ /**
+ * Get the content proposed to edit
+ * used by tinyMCE.jelly
+ * @return String
+ */
+ public String getContentToEdit() {
+ return contentToEdit;
+ }
+
+ /**
+ * escape xml
+ * @param String to escape
+ * @return String escaped
+ */
+ public String escapeXML(String string) {
+ return StringEscapeUtils.escapeXml(string);
+ }
+
+ /**
+ * Tidy content
+ * @return String wellformed by tidy
+ * @param String to be cleaned
+ * @throws UsecaseException
+ */
+ private String tidy(String content) throws UsecaseException {
+ //TODO: tidy should be configured via an external file (e.g. in htdocs)
+ ByteArrayOutputStream os = new ByteArrayOutputStream();
+ String out = "";
+ Tidy tidy = new Tidy();
+ tidy.setXHTML(true);
+ tidy.setNumEntities(true);
+ tidy.setTidyMark(false);
+ tidy.setInputEncoding("utf-8");
+ tidy.setOutputEncoding("utf-8");
+ tidy.parse(IOUtils.toInputStream(content), os);
+ try {
+ out = os.toString("utf-8");
+ } catch (Exception e) {
+ throw new UsecaseException(e.getMessage(), e);
+ }
+ addInfoMessage("Content cleaned with tidy. ");
+ return out;
+ }
+
+ /**
+ * Checks if InputStream is wellformed
+ * @return boolean true if wellformed, false if not
+ * @param InputStream which is checked if wellformed
+ * @throws UsecaseException
+ */
+ private boolean isWellformed(InputStream is) throws UsecaseException {
+ try {
+ //TODO: code borrowed from YanelServlet.java r40436. see line 902. 1. maybe there is a better way to do so. 2. this code could maybe be refactored into a some xml.util lib.
+ javax.xml.parsers.DocumentBuilderFactory dbf= javax.xml.parsers.DocumentBuilderFactory.newInstance();
+ javax.xml.parsers.DocumentBuilder parser = dbf.newDocumentBuilder();
+ // NOTE: DOCTYPE is being resolved/retrieved (e.g. xhtml schema from w3.org) also
+ // if isValidating is set to false.
+ // Hence, for performance and network reasons we use a local catalog ...
+ // Also see http://www.xml.com/pub/a/2004/03/03/catalogs.html
+ // resp. http://xml.apache.org/commons/components/resolver/
+ // TODO: What about a resolver factory?
+ parser.setEntityResolver(new CatalogResolver());
+ parser.parse(is);
+ return true;
+ } catch (org.xml.sax.SAXException e) {
+ addError("Document is not wellformed: " + e.getMessage() + " ");
+ return false;
+ } catch (Exception e) {
+ addError(e.getMessage());
+ return false;
+ }
+ }
+
+ /**
+ * Get the String with the content of the resource which is going to be edited
+ * @return String
+ */
+ private String getResourceContent() throws UsecaseException {
+ if (resourceContent == null) {
+ if(log.isDebugEnabled()) log.debug("resourceContent not set yet. Path: " + getEditPath());
+ Resource resToEdit = getResToEdit();
+ if (ResourceAttributeHelper.hasAttributeImplemented(resToEdit, "Modifiable", "2")) {
+ try {
+ InputStream is = ((ModifiableV2) resToEdit).getInputStream();
+ resourceContent = IOUtils.toString(is);
+ } catch (Exception e) {
+ log.error("Exception: " + e);
+ throw new UsecaseException(e.getMessage(), e);
+ }
+ } else {
+ addError("This resource can not be edited. ");
+ }
+ }
+ if(log.isDebugEnabled()) log.debug("content set to: " + resourceContent);
+ return resourceContent;
+ }
+
+ /**
+ * Get the String with the content of the editor
+ * @return String
+ */
+ private String getEditorContent() {
+ if (editorContent == null) {
+ if(log.isDebugEnabled()) log.debug("content not set yet.");
+ editorContent = getParameterAsString(getEditPath());
+ }
+ if(log.isDebugEnabled()) log.debug("content set to: " + editorContent);
+ return editorContent;
+ }
+
+ /**
+ * Get the Resource which is going to be edited
+ * @return Resource
+ */
+ private Resource getResToEdit() throws UsecaseException {
+ if (resToEdit == null) {
+ if(log.isDebugEnabled()) log.debug("resToEdit not set yet.");
+ try {
+ resToEdit = getYanel().getResourceManager().getResource(getEnvironment(), getRealm(), getEditPath());
+ } catch (Exception e) {
+ log.error("Exception: " + e);
+ throw new UsecaseException(e.getMessage(), e);
+ }
+ }
+ if(log.isDebugEnabled()) log.debug("resToEdit set to: " + resToEdit.getResourceTypeLocalName());
+ return resToEdit;
+ }
+
+ private boolean isResToEditVersionableV2() {
+ try {
+ if (ResourceAttributeHelper.hasAttributeImplemented(getResToEdit(), "Versionable", "2")) {
+ return true;
+ }
+ } catch (Exception e) {
+ return false;
+ }
+ return false;
+ }
+
+ private boolean isResToEditCheckedOut() {
+ try {
+ if (isResToEditVersionableV2()) {
+ VersionableV2 versionable = (VersionableV2) getResToEdit();
+ if (versionable.isCheckedOut()) {
+ return true;
+ }
+ }
+ } catch (Exception e) {
+ return false;
+ }
+ return false;
+ }
+
+
+ /**
+ * Returns the user id which was supplied when calling checkout(). can be null if not known, or the resource doesn't implement VersionableV2, or resource is not checked out yet. or no way to find out.
+ * @return String
+ */
+ private String getResToEditCheckoutUserID() {
+ try {
+ if (isResToEditVersionableV2() && isResToEditCheckedOut()) {
+ final Resource resToEdit = getResToEdit();
+ VersionableV2 versionable = (VersionableV2)resToEdit;
+ if (versionable.isCheckedOut()) {
+ return versionable.getCheckoutUserID();
+ }
+ }
+ } catch (Exception e) {
+ return null;
+ }
+ return null;
+ }
+
+}
More information about the Yanel-commits
mailing list