Files
alfresco-community-repo/source/java/org/alfresco/web/bean/content/BaseContentWizard.java
Raluca Munteanu dead3c3825 Merged 5.1.N (5.1.2) to 5.2.N (5.2.1)
125605 rmunteanu: Merged 5.1.1 (5.1.1) to 5.1.N (5.1.2)
      125498 slanglois: MNT-16155 Update source headers - remove svn:eol-style property on Java and JSP source files


git-svn-id: https://svn.alfresco.com/repos/alfresco-enterprise/alfresco/BRANCHES/DEV/5.2.N/root@125783 c4b6b30b-aa2e-2d43-bbcb-ca4b014f7261
2016-04-26 13:03:25 +00:00

599 lines
20 KiB
Java

package org.alfresco.web.bean.content;
import java.io.File;
import java.io.Serializable;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import javax.faces.context.FacesContext;
import javax.faces.model.SelectItem;
import org.alfresco.model.ApplicationModel;
import org.alfresco.model.ContentModel;
import org.alfresco.repo.transaction.RetryingTransactionHelper.RetryingTransactionCallback;
import org.alfresco.service.ServiceRegistry;
import org.alfresco.service.cmr.dictionary.TypeDefinition;
import org.alfresco.service.cmr.repository.ContentService;
import org.alfresco.service.cmr.repository.ContentWriter;
import org.alfresco.service.cmr.repository.MimetypeService;
import org.alfresco.service.cmr.repository.NodeRef;
import org.alfresco.service.namespace.NamespaceService;
import org.alfresco.service.namespace.QName;
import org.alfresco.service.transaction.TransactionService;
import org.alfresco.web.app.Application;
import org.alfresco.web.bean.repository.Repository;
import org.alfresco.web.bean.wizard.BaseWizardBean;
import org.alfresco.web.data.IDataContainer;
import org.alfresco.web.data.QuickSort;
import org.alfresco.web.ui.common.Utils;
import org.alfresco.web.ui.repo.component.UICharsetSelector;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.springframework.extensions.config.Config;
import org.springframework.extensions.config.ConfigElement;
import org.springframework.extensions.config.ConfigService;
/**
* Base class for the content related wizards and dialogs
*
* @author gavinc
*/
@SuppressWarnings("serial")
public abstract class BaseContentWizard extends BaseWizardBean
{
protected String fileName;
protected String author;
protected String title;
protected String description;
protected String mimeType;
protected String encoding;
protected String objectType;
protected boolean inlineEdit;
protected boolean otherPropertiesChoiceVisible = true;
protected boolean showOtherProperties = true;
// the NodeRef of the node created during finish
protected NodeRef createdNode;
protected List<SelectItem> objectTypes;
transient private ContentService contentService;
transient private TransactionService transactionService;
protected static final String MSG_NODE_LOCKED = "node_locked_dialog_closed";
protected static Log logger = LogFactory.getLog(BaseContentWizard.class);
// ------------------------------------------------------------------------------
// Wizard implementation
@Override
public void init(Map<String, String> parameters)
{
super.init(parameters);
this.fileName = null;
this.author = null;
this.title = null;
this.description = null;
this.mimeType = null;
this.inlineEdit = false;
this.objectType = null;
initOtherProperties();
}
@Override
public boolean getFinishButtonDisabled()
{
return (this.fileName == null ||
this.fileName.length() == 0 ||
this.mimeType == null);
}
// ------------------------------------------------------------------------------
// Bean Getters and Setters
/**
* @return Returns the name of the file
*/
public String getFileName()
{
return this.fileName;
}
/**
* @param fileName The name of the file
*/
public void setFileName(String fileName)
{
this.fileName = fileName;
}
/**
* @return Returns the author
*/
public String getAuthor()
{
return this.author;
}
/**
* @param author Sets the author
*/
public void setAuthor(String author)
{
this.author = author;
}
/**
* @return Returns the mime type currenty selected
*/
public String getMimeType()
{
return this.mimeType;
}
/**
* @param mimeType Sets the currently selected mime type
*/
public void setMimeType(String mimeType)
{
this.mimeType = mimeType;
}
/**
* @return Returns the encoding currently selected
*/
public String getEncoding()
{
if (encoding == null)
{
ConfigService configSvc = Application.getConfigService(FacesContext.getCurrentInstance());
Config config = configSvc.getConfig("Content Wizards");
if (config != null)
{
ConfigElement defaultEncCfg = config.getConfigElement("default-encoding");
if (defaultEncCfg != null)
{
String value = defaultEncCfg.getValue();
if (value != null)
{
encoding = value.trim();
}
}
}
if (encoding == null || encoding.length() == 0)
{
// if not configured, set to a sensible default for most character sets
encoding = "UTF-8";
}
}
return encoding;
}
/**
* @param encoding the document's encoding
*/
public void setEncoding(String encoding)
{
this.encoding = encoding;
}
/**
* @return Returns the object type currenty selected
*/
public String getObjectType()
{
return this.objectType;
}
/**
* @param objectType Sets the currently selected object type
*/
public void setObjectType(String objectType)
{
this.objectType = objectType;
}
/**
* @return Returns the description
*/
public String getDescription()
{
return this.description;
}
/**
* @param description Sets the description
*/
public void setDescription(String description)
{
this.description = description;
}
/**
* @return Returns the title
*/
public String getTitle()
{
return this.title;
}
/**
* @param title Sets the title
*/
public void setTitle(String title)
{
this.title = title;
}
/**
* @return Returns the inline edit flag.
*/
public boolean isInlineEdit()
{
return this.inlineEdit;
}
/**
* @param inlineEdit The inline edit flag to set.
*/
public void setInlineEdit(boolean inlineEdit)
{
this.inlineEdit = inlineEdit;
}
/**
* @return Determines whether the choice to modify all properties
* is shown
*/
public boolean getOtherPropertiesChoiceVisible()
{
return this.otherPropertiesChoiceVisible;
}
/**
* @return Determines whether the edit properties dialog should be
* shown when this one ends
*/
public boolean getShowOtherProperties()
{
return this.showOtherProperties;
}
/**
* @param showOthers Sets whether the edit properties dialog is shown
*/
public void setShowOtherProperties(boolean showOthers)
{
this.showOtherProperties = showOthers;
}
public List<SelectItem> getEncodings()
{
return UICharsetSelector.getCharsetEncodingList();
}
/**
* @return Returns a list of object types to allow the user to select from
*/
public List<SelectItem> getObjectTypes()
{
return getTransactionService().getRetryingTransactionHelper().doInTransaction(new RetryingTransactionCallback<List<SelectItem>>()
{
@Override
public List<SelectItem> execute() throws Throwable
{
return getObjectTypesImpl();
}
}, true);
}
private List<SelectItem> getObjectTypesImpl()
{
if ((this.objectTypes == null) || (Application.isDynamicConfig(FacesContext.getCurrentInstance())))
{
FacesContext context = FacesContext.getCurrentInstance();
// add the well known object type to start with
this.objectTypes = new ArrayList<SelectItem>(5);
ConfigService svc = Application.getConfigService(FacesContext.getCurrentInstance());
Config wizardCfg = svc.getConfig("Content Wizards");
if (wizardCfg != null)
{
ConfigElement defaultTypesCfg = wizardCfg.getConfigElement("default-content-type");
String parentLabel = "";
if (defaultTypesCfg != null)
{
// Get the default content-type to apply
ConfigElement typeElement = defaultTypesCfg.getChildren().get(0);
QName parentQName = Repository.resolveToQName(typeElement.getAttribute("name"));
TypeDefinition parentType = null;
if (parentQName != null)
{
parentType = this.getDictionaryService().getType(parentQName);
if (parentType == null)
{
// If no default content type is defined default to content
parentQName = ContentModel.TYPE_CONTENT;
parentType = this.getDictionaryService().getType(ContentModel.TYPE_CONTENT);
this.objectTypes.add(new SelectItem(ContentModel.TYPE_CONTENT.toString(),
Application.getMessage(context, "content")));
logger.warn("Configured default content type not found in dictionary: " + parentQName);
}
else
{
// try and get the display label from config
parentLabel = Utils.getDisplayLabel(context, typeElement);
// if there wasn't a client based label try and get it from the dictionary
if (parentLabel == null)
{
parentLabel = parentType.getTitle(this.getDictionaryService());
}
// finally, just use the localname
if (parentLabel == null)
{
parentLabel = parentQName.getLocalName();
}
}
}
// Get all content types defined
ConfigElement typesCfg = wizardCfg.getConfigElement("content-types");
if (typesCfg != null)
{
for (ConfigElement child : typesCfg.getChildren())
{
QName idQName = Repository.resolveToQName(child.getAttribute("name"));
if (idQName != null)
{
TypeDefinition typeDef = this.getDictionaryService().getType(idQName);
if (typeDef != null)
{
// for each type check if it is a subtype of the default content type
if (this.getDictionaryService().isSubClass(typeDef.getName(), parentType.getName()))
{
// try and get the display label from config
String label = Utils.getDisplayLabel(context, child);
// if there wasn't a client based label try and get it from the dictionary
if (label == null)
{
label = typeDef.getTitle(this.getDictionaryService());
}
// finally, just use the localname
if (label == null)
{
label = idQName.getLocalName();
}
this.objectTypes.add(new SelectItem(idQName.toString(), label));
}
else
{
logger.warn("Failed to add '" + child.getAttribute("name") +
"' to the list of content types - it is not a subtype of " + parentQName);
}
}
}
else
{
logger.warn("Failed to add '" + child.getAttribute("name") +
"' to the list of content types as the type is not recognised");
}
}
}
// Case when no type is defined - we add the default content type to the list of available types
if (this.objectTypes.isEmpty())
{
// add default content type to the list of available types
this.objectTypes.add(new SelectItem(parentQName.toString(), parentLabel));
}
// make sure the list is sorted by the label
QuickSort sorter = new QuickSort(this.objectTypes, "label", true, IDataContainer.SORT_CASEINSENSITIVE);
sorter.sort();
}
else
{
logger.warn("Could not find 'content-types' configuration element");
}
}
else
{
logger.warn("Could not find 'Content Wizards' configuration section");
}
}
return this.objectTypes;
}
// ------------------------------------------------------------------------------
// Service Injection
/**
* @param contentService The contentService to set.
*/
public void setContentService(ContentService contentService)
{
this.contentService = contentService;
}
protected ContentService getContentService()
{
if (contentService == null)
{
contentService = Repository.getServiceRegistry(FacesContext.getCurrentInstance()).getContentService();
}
return contentService;
}
protected TransactionService getTransactionService()
{
if (null == transactionService)
{
transactionService = Repository.getServiceRegistry(FacesContext.getCurrentInstance()).getTransactionService();
}
return transactionService;
}
// ------------------------------------------------------------------------------
// Helper methods
/**
* Save the specified content using the currently set wizard attributes
*
* @param fileContent File content to save
* @param strContent String content to save
*/
protected void saveContent(File fileContent, String strContent) throws Exception
{
// get the node ref of the node that will contain the content
NodeRef containerNodeRef;
String nodeId = this.navigator.getCurrentNodeId();
if (nodeId == null)
{
containerNodeRef = this.getNodeService().getRootNode(Repository.getStoreRef());
}
else
{
containerNodeRef = new NodeRef(Repository.getStoreRef(), nodeId);
}
// apply the inline editable aspect (by adding the property at create time)
Map<QName, Serializable> editProps = new HashMap<QName, Serializable>(6);
if (this.inlineEdit == true)
{
editProps.put(ApplicationModel.PROP_EDITINLINE, this.inlineEdit);
if (logger.isDebugEnabled())
logger.debug("Added inlineeditable aspect with properties: " + editProps);
}
// set the name
editProps.put(ContentModel.PROP_NAME, this.fileName);
// set the author property
editProps.put(ContentModel.PROP_AUTHOR, this.author);
// apply the titled aspect - title and description
editProps.put(ContentModel.PROP_TITLE, this.title);
editProps.put(ContentModel.PROP_DESCRIPTION, this.description);
if (logger.isDebugEnabled())
logger.debug("Added titled aspect with properties: " + this.title + ", " + this.description);
// create the node
NodeRef fileNodeRef = this.getNodeService().createNode(
containerNodeRef,
ContentModel.ASSOC_CONTAINS,
QName.createQNameWithValidLocalName(NamespaceService.CONTENT_MODEL_1_0_URI, this.fileName),
Repository.resolveToQName(this.objectType),
editProps).getChildRef();
if (logger.isDebugEnabled())
logger.debug("Created file node for file: " + this.fileName);
// get a writer for the content and put the file
ContentWriter writer = getContentService().getWriter(fileNodeRef, ContentModel.PROP_CONTENT, true);
// set the mimetype and encoding
writer.setMimetype(this.mimeType);
writer.setEncoding(getEncoding());
if (fileContent != null)
{
writer.putContent(fileContent);
}
else
{
writer.putContent(strContent == null ? "" : strContent);
}
// remember the created node now
this.createdNode = fileNodeRef;
}
/**
* Returns the display label for the mime type currently chosen
*
* @param mimeType The mime type to get the display label of
* @return The human readable version of the content type
*/
protected String getSummaryMimeType(String mimeType)
{
ServiceRegistry registry = Repository.getServiceRegistry(FacesContext.getCurrentInstance());
MimetypeService mimetypeService = registry.getMimetypeService();
// get the mime type display name
Map<String, String> mimeTypes = mimetypeService.getDisplaysByMimetype();
return mimeTypes.get(mimeType);
}
/**
* Returns the display label for the currently selected object type
*
* @return The objevt type label
*/
protected String getSummaryObjectType()
{
String objType = null;
for (SelectItem item : this.getObjectTypes())
{
if (item.getValue().equals(this.objectType))
{
objType = item.getLabel();
break;
}
}
return objType;
}
/**
* Initialises the other properties flags from config
*/
protected void initOtherProperties()
{
// TODO - review implications of these default values for dynamic/MT client
ConfigService configSvc = Application.getConfigService(FacesContext.getCurrentInstance());
if (configSvc != null)
{
Config config = configSvc.getConfig("Content Wizards");
if (config != null)
{
ConfigElement otherPropsCfg = config.getConfigElement("other-properties");
if (otherPropsCfg != null)
{
// get the attributes
String userChoiceVisible = otherPropsCfg.getAttribute("user-choice-visible");
String userChoiceDefault = otherPropsCfg.getAttribute("user-choice-default");
// set the defaults
if (userChoiceVisible != null)
{
this.otherPropertiesChoiceVisible = Boolean.parseBoolean(userChoiceVisible);
}
if (userChoiceDefault != null)
{
this.showOtherProperties = Boolean.parseBoolean(userChoiceDefault);
}
}
}
}
}
}