/* * Copyright (C) 2005 Alfresco, Inc. * * Licensed under the Mozilla Public License version 1.1 * with a permitted attribution clause. You may obtain a * copy of the License at * * http://www.alfresco.org/legal/license.txt * * 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.alfresco.web.bean.wcm; import java.io.File; import java.text.MessageFormat; import javax.faces.context.FacesContext; import javax.faces.event.ActionEvent; import javax.transaction.UserTransaction; import org.alfresco.model.ContentModel; import org.alfresco.model.WCMAppModel; import org.alfresco.repo.avm.AVMNodeConverter; import org.alfresco.repo.content.MimetypeMap; import org.alfresco.service.cmr.avm.AVMService; import org.alfresco.service.cmr.repository.ContentReader; import org.alfresco.service.cmr.repository.ContentService; import org.alfresco.service.cmr.repository.ContentWriter; import org.alfresco.service.cmr.repository.NodeRef; import org.alfresco.service.cmr.repository.NodeService; import org.alfresco.util.Pair; import org.alfresco.web.app.AlfrescoNavigationHandler; import org.alfresco.web.app.Application; import org.alfresco.web.app.servlet.DownloadContentServlet; import org.alfresco.web.bean.CheckinCheckoutBean; import org.alfresco.web.bean.FileUploadBean; import org.alfresco.web.bean.repository.Repository; import org.alfresco.web.forms.Form; import org.alfresco.web.forms.FormProcessor; import org.alfresco.web.forms.FormsService; import org.alfresco.web.forms.Rendition; import org.alfresco.web.forms.RenditionImpl; import org.alfresco.web.ui.common.Utils; import org.apache.commons.logging.Log; import org.apache.commons.logging.LogFactory; import org.w3c.dom.Document; /** * Bean backing the edit pages for a AVM node content. * * @author Kevin Roast */ public class AVMEditBean { private static final Log LOGGER = LogFactory.getLog(AVMEditBean.class); private static final String MSG_ERROR_UPDATE = "error_update"; private static final String MSG_UPLOAD_SUCCESS = "file_upload_success"; private String documentContent = null; private String editorOutput = null; private File file; private String fileName; /** AVM service bean reference */ protected AVMService avmService; /** AVM Browse Bean reference */ protected AVMBrowseBean avmBrowseBean; /** The ContentService bean reference */ protected ContentService contentService; /** The NodeService bean reference */ protected NodeService nodeService; // ------------------------------------------------------------------------------ // Bean property getters and setters /** * @param avmService The AVMService to set. */ public void setAvmService(AVMService avmService) { this.avmService = avmService; } /** * @param avmBrowseBean The AVMBrowseBean to set. */ public void setAvmBrowseBean(AVMBrowseBean avmBrowseBean) { this.avmBrowseBean = avmBrowseBean; } /** * @param contentService The ContentService to set. */ public void setContentService(ContentService contentService) { this.contentService = contentService; } /** * @param nodeService The nodeService to set. */ public void setNodeService(NodeService nodeService) { this.nodeService = nodeService; } /** * @return Returns the current AVM node context. */ public AVMNode getAvmNode() { return this.avmBrowseBean.getAvmActionNode(); } /** * @return Large file icon for current AVM node */ public String getFileType32() { return Utils.getFileTypeImage(getAvmNode().getName(), false); } /** * @return Small file icon for current AVM node */ public String getFileType16() { return Utils.getFileTypeImage(getAvmNode().getName(), true); } /** * @return Content URL for current AVM node */ public String getUrl() { return DownloadContentServlet.generateDownloadURL(AVMNodeConverter.ToNodeRef(-1, getAvmNode().getPath()), getAvmNode().getName()); } /** * @return Returns the document content used for HTML in-line editing. */ public String getDocumentContent() { return this.documentContent; } /** * @param documentContent The document content for HTML in-line editing. */ public void setDocumentContent(String documentContent) { this.documentContent = documentContent; } /** * @return Returns output from the in-line editor page. */ public String getEditorOutput() { return this.editorOutput; } /** * @param editorOutput The output from the in-line editor page */ public void setEditorOutput(String editorOutput) { this.editorOutput = editorOutput; } /** * @return Returns the name of the file */ public String getFileName() { // try and retrieve the file and filename from the file upload bean // representing the file we previously uploaded. FacesContext ctx = FacesContext.getCurrentInstance(); FileUploadBean fileBean = (FileUploadBean)ctx.getExternalContext().getSessionMap(). get(FileUploadBean.FILE_UPLOAD_BEAN_NAME); if (fileBean != null) { this.file = fileBean.getFile(); this.fileName = fileBean.getFileName(); } return this.fileName; } /** * @return Returns the message to display when a file has been uploaded */ public String getFileUploadSuccessMsg() { String msg = Application.getMessage(FacesContext.getCurrentInstance(), MSG_UPLOAD_SUCCESS); return MessageFormat.format(msg, new Object[] {getFileName()}); } /** * @return Returns the form when in the context of editing an xml asset. */ public Form getForm() { final NodeRef ttNodeRef = (NodeRef) this.nodeService.getProperty(this.getAvmNode().getNodeRef(), WCMAppModel.PROP_PARENT_FORM); final FormsService ts = FormsService.getInstance(); return ts.getForm(ttNodeRef); } /** * @return Returns the wrapper instance data for feeding the xml * content to the form processor. */ public FormProcessor.InstanceData getInstanceData() { final Form tt = this.getForm(); final FormProcessor tim = tt.getFormProcessors().get(0); return new FormProcessor.InstanceData() { private final FormsService ts = FormsService.getInstance(); public Document load() { try { final String content = AVMEditBean.this.getEditorOutput(); return content != null ? this.ts.parseXML(content) : null; } catch (Exception e) { e.printStackTrace(); return null; } } public void save(final Document d, final String[] uploadedFilePaths) { AVMEditBean.this.setEditorOutput(this.ts.writeXMLToString(d)); } }; } // ------------------------------------------------------------------------------ // Action event handlers /** * Action handler called to calculate which editing screen to display based on the mimetype * of a document. If appropriate, the in-line editing screen will be shown. */ public void setupEditAction(ActionEvent event) { this.avmBrowseBean.setupContentAction(event); // retrieve the content reader for this node NodeRef avmRef = AVMNodeConverter.ToNodeRef(-1, getAvmNode().getPath()); if (this.nodeService.hasAspect(avmRef, WCMAppModel.ASPECT_RENDITION)) { if (LOGGER.isDebugEnabled()) LOGGER.debug(avmRef + " is a rendition, editing primary rendition instead"); avmRef = new RenditionImpl(avmRef).getPrimaryFormInstanceData().getNodeRef(); final Pair p = AVMNodeConverter.ToAVMVersionPath(avmRef); if (LOGGER.isDebugEnabled()) LOGGER.debug("Editing primary form instance data " + p.getSecond() + " version " + p.getFirst()); final AVMNode avmNode = new AVMNode(this.avmService.lookup(p.getFirst(), p.getSecond())); this.avmBrowseBean.setAvmActionNode(avmNode); } if (LOGGER.isDebugEnabled()) LOGGER.debug("Editing AVM node: " + avmRef.toString()); ContentReader reader = contentService.getReader(avmRef, ContentModel.PROP_CONTENT); if (reader != null) { String mimetype = reader.getMimetype(); String outcome = null; // calculate which editor screen to display if (MimetypeMap.MIMETYPE_TEXT_PLAIN.equals(mimetype) || MimetypeMap.MIMETYPE_XML.equals(mimetype) || MimetypeMap.MIMETYPE_TEXT_CSS.equals(mimetype) || MimetypeMap.MIMETYPE_JAVASCRIPT.equals(mimetype)) { // make content available to the editing screen setEditorOutput(reader.getContentString()); // navigate to appropriate screen outcome = ((MimetypeMap.MIMETYPE_XML.equals(mimetype) && this.nodeService.hasAspect(avmRef, WCMAppModel.ASPECT_FORM_INSTANCE_DATA)) ? "dialog:editAvmXmlInline" : "dialog:editAvmTextInline"); } else if (MimetypeMap.MIMETYPE_HTML.equals(mimetype)) { // make content available to the editing screen setDocumentContent(reader.getContentString()); setEditorOutput(null); // navigate to appropriate screen outcome = "dialog:editAvmHtmlInline"; } else { // normal downloadable document outcome = "dialog:editAvmFile"; } final FacesContext fc = FacesContext.getCurrentInstance(); fc.getApplication().getNavigationHandler().handleNavigation(fc, null, outcome); } } /** * Action called upon completion of the Edit File download page */ public String editFileOK() { String outcome = null; AVMNode node = getAvmNode(); if (node != null) { resetState(); outcome = AlfrescoNavigationHandler.CLOSE_DIALOG_OUTCOME; } return outcome; } /** * Action handler called to set the content of a node from an inline editing page. */ public String editInlineOK() { String outcome = null; UserTransaction tx = null; AVMNode avmNode = getAvmNode(); if (avmNode != null) { NodeRef avmRef = AVMNodeConverter.ToNodeRef(-1, getAvmNode().getPath()); try { tx = Repository.getUserTransaction(FacesContext.getCurrentInstance()); tx.begin(); // get an updating writer that we can use to modify the content on the current node ContentWriter writer = this.contentService.getWriter(avmRef, ContentModel.PROP_CONTENT, true); writer.putContent(this.editorOutput); // commit the transaction tx.commit(); // regenerate form content if (nodeService.hasAspect(avmRef, WCMAppModel.ASPECT_FORM_INSTANCE_DATA)) { final FormsService fs = FormsService.getInstance(); fs.regenerateRenditions(avmRef); } resetState(); outcome = AlfrescoNavigationHandler.CLOSE_DIALOG_OUTCOME; } catch (Throwable err) { // rollback the transaction try { if (tx != null) {tx.rollback();} } catch (Exception tex) {} Utils.addErrorMessage(Application.getMessage( FacesContext.getCurrentInstance(), CheckinCheckoutBean.MSG_ERROR_UPDATE) + err.getMessage()); } } return outcome; } /** * Action called upon completion of the Update File page */ public String updateFileOK() { String outcome = null; UserTransaction tx = null; AVMNode node = getAvmNode(); if (node != null && this.getFileName() != null) { try { FacesContext context = FacesContext.getCurrentInstance(); tx = Repository.getUserTransaction(context); tx.begin(); // get an updating writer that we can use to modify the content on the current node ContentWriter writer = this.contentService.getWriter(node.getNodeRef(), ContentModel.PROP_CONTENT, true); // also update the mime type in case a different type of file is uploaded String mimeType = Repository.getMimeTypeForFileName(context, this.fileName); writer.setMimetype(mimeType); writer.putContent(this.file); // commit the transaction tx.commit(); // clear action context resetState(); outcome = AlfrescoNavigationHandler.CLOSE_DIALOG_OUTCOME; } catch (Throwable err) { // rollback the transaction try { if (tx != null) {tx.rollback();} } catch (Exception tex) {} Utils.addErrorMessage(Application.getMessage( FacesContext.getCurrentInstance(), MSG_ERROR_UPDATE) + err.getMessage(), err); } } return outcome; } /** * Deals with the cancel button being pressed on the upload file page */ public String cancel() { // reset the state resetState(); return AlfrescoNavigationHandler.CLOSE_DIALOG_OUTCOME; } private void resetState() { // clean up and clear action context clearUpload(); setDocumentContent(null); setEditorOutput(null); } /** * Clear form state and upload file bean */ private void clearUpload() { // delete the temporary file we uploaded earlier if (this.file != null) { this.file.delete(); } this.file = null; this.fileName = null; // remove the file upload bean from the session FacesContext ctx = FacesContext.getCurrentInstance(); ctx.getExternalContext().getSessionMap().remove(FileUploadBean.FILE_UPLOAD_BEAN_NAME); } }