[Yanel-commits] rev 41410 - in
public/yanel/contributions/resources/tinymce: htdocs
src/java/org/wyona/yanel/impl/resources/tinymce
simon at wyona.com
simon at wyona.com
Mon Feb 9 00:01:27 CET 2009
Author: simon
Date: 2009-02-09 00:01:27 +0100 (Mon, 09 Feb 2009)
New Revision: 41410
Modified:
public/yanel/contributions/resources/tinymce/htdocs/tinymce-fix.jelly
public/yanel/contributions/resources/tinymce/htdocs/tinymce.jelly
public/yanel/contributions/resources/tinymce/src/java/org/wyona/yanel/impl/resources/tinymce/TinyMCEResource.java
Log:
migrated improvements made within xinha into tinyMCE resource-type.
Modified: public/yanel/contributions/resources/tinymce/htdocs/tinymce-fix.jelly
===================================================================
--- public/yanel/contributions/resources/tinymce/htdocs/tinymce-fix.jelly 2009-02-08 22:39:09 UTC (rev 41409)
+++ public/yanel/contributions/resources/tinymce/htdocs/tinymce-fix.jelly 2009-02-08 23:01:27 UTC (rev 41410)
@@ -14,11 +14,12 @@
<form method="post" action="">
<input type="hidden" name="edit-path" value="${resource.getEditPath()}"/>
<textarea id="${resource.getEditPath()}" name="${resource.getEditPath()}" rows="15" cols="80" style="width: 100%">
- ${resource.getEscapedContent()}
+ ${resource.escapeXML(resource.getContentToEdit())}
</textarea>
<br />
<input type="submit" id="submit" name="submit" value="Save" />
<input type="submit" id="submit-tidy" name="submit-tidy" value="Tidy" />
+ <input type="submit" id="submit-tidy-save" name="submit-tidy-save" value="Tidy Save" />
<input type="submit" id="submit" name="cancel" value="Cancel" />
</form>
</div>
Modified: public/yanel/contributions/resources/tinymce/htdocs/tinymce.jelly
===================================================================
--- public/yanel/contributions/resources/tinymce/htdocs/tinymce.jelly 2009-02-08 22:39:09 UTC (rev 41409)
+++ public/yanel/contributions/resources/tinymce/htdocs/tinymce.jelly 2009-02-08 23:01:27 UTC (rev 41410)
@@ -15,11 +15,11 @@
<form method="post" action="">
<input type="hidden" name="edit-path" value="${resource.getEditPath()}"/>
<textarea id="${resource.getEditPath()}" name="${resource.getEditPath()}" rows="15" cols="80" style="width: 100%">
- ${resource.getEditorFormContent()}
+ ${resource.escapeXML(resource.getContentToEdit())}
</textarea>
<br />
<input type="submit" id="submit" name="submit" value="Save" />
- <input type="submit" id="submit" name="cancel" value="Cancel" />
+ <input type="submit" id="cancel" name="cancel" value="Cancel" />
</form>
</j:when>
<j:otherwise>
Modified: public/yanel/contributions/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-08 22:39:09 UTC (rev 41409)
+++ public/yanel/contributions/resources/tinymce/src/java/org/wyona/yanel/impl/resources/tinymce/TinyMCEResource.java 2009-02-08 23:01:27 UTC (rev 41410)
@@ -12,6 +12,7 @@
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;
@@ -25,6 +26,7 @@
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;
@@ -56,72 +58,230 @@
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 content;
+ 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 {
- if (getParameter(PARAM_SUBMIT) != null) {
- if (!isWellformed()) {
+ 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);
- } else if (getParameter(PARAM_SUBMIT_TIDY) != null) {
- tidy();
+ }
+ if (editorContent != null && !isWellformed(IOUtils.toInputStream(editorContent))) {
+ contentToEdit = getEditorContent();
return generateView(VIEW_FIX_WELLFORMNESS);
- } else if (getParameter(PARAM_CANCEL) != null) {
- cancel();
- return generateView(VIEW_CANCEL);
+ }
+ 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 {
- return generateView(viewID); // this will show the default view if the param is not set
+ 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 editPath = getEditPath();
- final String content = getContent();
-
- if (log.isDebugEnabled()) log.debug("Content while exectuing: " + content);
-
- try {
- Resource resToEdit = getYanel().getResourceManager().getResource(getEnvironment(), getRealm(), editPath);
+ final String content = getEditorContent();
+ final Resource resToEdit = getResToEdit();
+ if (log.isDebugEnabled()) log.debug("saving content: " + content);
if (ResourceAttributeHelper.hasAttributeImplemented(resToEdit, "Modifiable", "2")) {
- OutputStream os = ((ModifiableV2) resToEdit).getOutputStream();
- IOUtils.write(content, os);
- addInfoMessage("Successfully saved.");
- setParameter(PARAMETER_CONTINUE_PATH, PathUtil.backToRealm(getPath()) + editPath.substring(1)); // allow jelly template to show link to new event
+ 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("The resource you wanted to edit does not implement VieableV2 and is therefor not editable with this editor.");
+ addError("Could not save the document. ");
}
- } catch (Exception e) {
- log.error("Exception: " + e);
- throw new UsecaseException(e.getMessage(), e);
+ 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
}
- private void tidy() throws UsecaseException {
+ /**
+ * 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(getContent()), os);
+ tidy.parse(IOUtils.toInputStream(content), os);
try {
- content = os.toString("utf-8");
+ out = os.toString("utf-8");
} catch (Exception e) {
throw new UsecaseException(e.getMessage(), e);
}
+ addInfoMessage("Content cleaned with tidy. ");
+ return out;
}
-
- public void cancel() throws UsecaseException {
- addInfoMessage("Cancled.");
- setParameter(PARAMETER_CONTINUE_PATH, PathUtil.backToRealm(getPath()) + getEditPath().substring(1)); // allow jelly template to show link to new event
- }
- public boolean isWellformed() throws UsecaseException {
+ /**
+ * 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();
@@ -133,11 +293,10 @@
// resp. http://xml.apache.org/commons/components/resolver/
// TODO: What about a resolver factory?
parser.setEntityResolver(new CatalogResolver());
- String content = getContent();
- parser.parse(IOUtils.toInputStream(content));
+ parser.parse(is);
return true;
} catch (org.xml.sax.SAXException e) {
- addError(e.getMessage());
+ addError("Document is not wellformed: " + e.getMessage() + " ");
return false;
} catch (Exception e) {
addError(e.getMessage());
@@ -145,57 +304,104 @@
}
}
- public String getEditorFormContent() throws UsecaseException {
- try {
- if(log.isDebugEnabled()) log.debug(getEditPath());
- Resource resToEdit = getYanel().getResourceManager().getResource(getEnvironment(), getRealm(), getEditPath());
+ /**
+ * 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")) {
- InputStream is = ((ModifiableV2) resToEdit).getInputStream();
- return StringEscapeUtils.escapeXml(IOUtils.toString(is));
+ try {
+ InputStream is = ((ModifiableV2) resToEdit).getInputStream();
+ resourceContent = IOUtils.toString(is);
+ } catch (Exception e) {
+ log.error("Exception: " + e);
+ throw new UsecaseException(e.getMessage(), e);
+ }
} else {
- return"The resource you wanted to edit does not implement VieableV2 and is therefor not editable with this editor.";
+ addError("This resource can not be edited. ");
}
- } catch (Exception e) {
- log.error("Exception: " + e);
- throw new UsecaseException(e.getMessage(), e);
}
+ if(log.isDebugEnabled()) log.debug("content set to: " + resourceContent);
+ return resourceContent;
}
-
+
/**
- * TODO: no lookup resource-type yet
- * @return
- * @throws UsecaseException
+ * Get the String with the content of the editor
+ * @return String
*/
- public String getLookup() throws UsecaseException {
+ 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 {
- SourceResolver resolver = new SourceResolver(this);
- Source source = resolver.resolve("yanelresource:/usecases/lookup.html", null);
- InputStream htodoc = ((StreamSource) source).getInputStream();
- return IOUtils.toString(htodoc);
+ if (ResourceAttributeHelper.hasAttributeImplemented(getResToEdit(), "Versionable", "2")) {
+ return true;
+ }
} catch (Exception e) {
- return "no parameter edit-path found in the request. don't know what to edit";
+ return false;
}
+ return false;
}
- public String getEditPath() {
- return request.getParameter(PARAMETER_EDIT_PATH);
+ private boolean isResToEditCheckedOut() {
+ try {
+ if (isResToEditVersionableV2()) {
+ VersionableV2 versionable = (VersionableV2) getResToEdit();
+ if (versionable.isCheckedOut()) {
+ return true;
+ }
+ }
+ } catch (Exception e) {
+ return false;
+ }
+ return false;
}
+
/**
- * @return
+ * 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 getContent() {
- if(log.isDebugEnabled()) log.debug("Member field content: " + content);
- if (content != null) {
- if(log.isDebugEnabled()) log.debug("content is allready set.");
- return content;
- } else {
- content = getEnvironment().getRequest().getParameter(getEditPath());
+ 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 content;
+ return null;
}
- public String getEscapedContent() {
- return StringEscapeUtils.escapeXml(getContent());
- }
-}
+}
\ No newline at end of file
More information about the Yanel-commits
mailing list