mirror of
https://github.com/Alfresco/alfresco-community-repo.git
synced 2025-08-07 17:49:17 +00:00
4fef0c0ef4
125788 rmunteanu: Merged 5.1.N (5.1.2) to 5.2.N (5.2.1)
125606 rmunteanu: Merged 5.1.1 (5.1.1) to 5.1.N (5.1.2)
125515 slanglois: MNT-16155 Update source headers - add new Copyrights for Java and JSP source files + automatic check in the build
git-svn-id: https://svn.alfresco.com/repos/alfresco-enterprise/alfresco/HEAD/root@127810 c4b6b30b-aa2e-2d43-bbcb-ca4b014f7261
298 lines
11 KiB
Java
298 lines
11 KiB
Java
/*
|
|
* #%L
|
|
* Alfresco Repository WAR Community
|
|
* %%
|
|
* Copyright (C) 2005 - 2016 Alfresco Software Limited
|
|
* %%
|
|
* This file is part of the Alfresco software.
|
|
* If the software was purchased under a paid Alfresco license, the terms of
|
|
* the paid license agreement will prevail. Otherwise, the software is
|
|
* provided under the following open source license terms:
|
|
*
|
|
* Alfresco is free software: you can redistribute it and/or modify
|
|
* it under the terms of the GNU Lesser General Public License as published by
|
|
* the Free Software Foundation, either version 3 of the License, or
|
|
* (at your option) any later version.
|
|
*
|
|
* Alfresco is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU Lesser General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU Lesser General Public License
|
|
* along with Alfresco. If not, see <http://www.gnu.org/licenses/>.
|
|
* #L%
|
|
*/
|
|
package org.alfresco.web.bean;
|
|
|
|
import java.io.Serializable;
|
|
import java.util.ArrayList;
|
|
import java.util.List;
|
|
|
|
import javax.faces.context.FacesContext;
|
|
import javax.faces.model.SelectItem;
|
|
|
|
import org.alfresco.model.ContentModel;
|
|
import org.alfresco.repo.content.MimetypeMap;
|
|
import org.alfresco.repo.security.permissions.AccessDeniedException;
|
|
import org.alfresco.service.cmr.dictionary.DictionaryService;
|
|
import org.alfresco.service.cmr.repository.ContentData;
|
|
import org.alfresco.service.cmr.repository.NodeRef;
|
|
import org.alfresco.service.cmr.repository.NodeService;
|
|
import org.alfresco.service.cmr.search.SearchService;
|
|
import org.alfresco.service.namespace.NamespaceService;
|
|
import org.alfresco.util.ExpiringValueCache;
|
|
import org.alfresco.web.app.Application;
|
|
import org.alfresco.web.bean.repository.Node;
|
|
import org.alfresco.web.bean.repository.Repository;
|
|
import org.alfresco.web.data.IDataContainer;
|
|
import org.alfresco.web.data.QuickSort;
|
|
|
|
/**
|
|
* Provide access to commonly used lists of templates and script files.
|
|
* <p>
|
|
* The lists are cached for a small period of time to help performance in the client,
|
|
* as generally the contents of the template folders are not changed frequently.
|
|
*
|
|
* @author Kevin Roast
|
|
*/
|
|
public class TemplateSupportBean implements Serializable
|
|
{
|
|
private static final long serialVersionUID = 6698338879903536081L;
|
|
|
|
private static final String MSG_SELECT_TEMPLATE = "select_a_template";
|
|
private static final String MSG_SELECT_SCRIPT = "select_a_script";
|
|
|
|
/** "no selection" marker for SelectItem lists */
|
|
public static final String NO_SELECTION = "none";
|
|
|
|
/** NodeService instance */
|
|
transient private NodeService nodeService;
|
|
|
|
/** The SearchService instance */
|
|
transient private SearchService searchService;
|
|
|
|
/** cache of content templates that lasts 30 seconds - enough for a couple of page refreshes */
|
|
private ExpiringValueCache<List<SelectItem>> contentTemplates = new ExpiringValueCache<List<SelectItem>>(1000*30);
|
|
|
|
/** cache of email templates that lasts 30 seconds - enough for a few page refreshes */
|
|
private ExpiringValueCache<List<SelectItem>> emailTemplates = new ExpiringValueCache<List<SelectItem>>(1000*30);
|
|
|
|
/** cache of RSS templates that lasts 30 seconds - enough for a few page refreshes */
|
|
private ExpiringValueCache<List<SelectItem>> rssTemplates = new ExpiringValueCache<List<SelectItem>>(1000*30);
|
|
|
|
/** cache of JavaScript files that lasts 30 seconds - enough for a few page refreshes */
|
|
private ExpiringValueCache<List<SelectItem>> scriptFiles = new ExpiringValueCache<List<SelectItem>>(1000*30);
|
|
|
|
|
|
/**
|
|
* @param nodeService The NodeService to set.
|
|
*/
|
|
public void setNodeService(NodeService nodeService)
|
|
{
|
|
this.nodeService = nodeService;
|
|
}
|
|
|
|
private NodeService getNodeService()
|
|
{
|
|
if (nodeService == null)
|
|
{
|
|
nodeService = Repository.getServiceRegistry(FacesContext.getCurrentInstance()).getNodeService();
|
|
}
|
|
return nodeService;
|
|
}
|
|
|
|
/**
|
|
* @param searchService The SearchService to set.
|
|
*/
|
|
public void setSearchService(SearchService searchService)
|
|
{
|
|
this.searchService = searchService;
|
|
}
|
|
|
|
private SearchService getSearchService()
|
|
{
|
|
if (searchService == null)
|
|
{
|
|
searchService = Repository.getServiceRegistry(FacesContext.getCurrentInstance()).getSearchService();
|
|
}
|
|
return searchService;
|
|
}
|
|
|
|
/**
|
|
* @return the list of available Content Templates that can be applied to the current document.
|
|
*/
|
|
public List<SelectItem> getContentTemplates()
|
|
{
|
|
List<SelectItem> templates = contentTemplates.get();
|
|
if (templates == null)
|
|
{
|
|
// get the template from the special Content Templates folder
|
|
FacesContext fc = FacesContext.getCurrentInstance();
|
|
String xpath = Application.getRootPath(fc) + "/" +
|
|
Application.getGlossaryFolderName(fc) + "/" +
|
|
Application.getContentTemplatesFolderName(fc) + "//*";
|
|
|
|
templates = selectDictionaryNodes(fc, xpath, MSG_SELECT_TEMPLATE, MimetypeMap.MIMETYPE_TEXT_PLAIN);
|
|
|
|
contentTemplates.put(templates);
|
|
}
|
|
|
|
return templates;
|
|
}
|
|
|
|
/**
|
|
* @return the list of available Email Templates.
|
|
*/
|
|
public List<SelectItem> getEmailTemplates()
|
|
{
|
|
List<SelectItem> templates = emailTemplates.get();
|
|
if (templates == null)
|
|
{
|
|
// get the template from the special Email Templates folder
|
|
FacesContext fc = FacesContext.getCurrentInstance();
|
|
String xpath = Application.getRootPath(fc) + "/" +
|
|
Application.getGlossaryFolderName(fc) + "/" +
|
|
Application.getEmailTemplatesFolderName(fc) + "//*";
|
|
|
|
templates = selectDictionaryNodes(fc, xpath, MSG_SELECT_TEMPLATE, MimetypeMap.MIMETYPE_TEXT_PLAIN);
|
|
|
|
emailTemplates.put(templates);
|
|
}
|
|
|
|
return templates;
|
|
}
|
|
|
|
/**
|
|
* @return the list of available Notify Email Templates.
|
|
*/
|
|
public List<SelectItem> getNotifyEmailTemplates()
|
|
{
|
|
List<SelectItem> templates = null;
|
|
|
|
// get the template from the special Email Templates folder
|
|
FacesContext fc = FacesContext.getCurrentInstance();
|
|
String xpath = Application.getRootPath(fc) + "/" +
|
|
Application.getGlossaryFolderName(fc) + "/" +
|
|
Application.getEmailTemplatesFolderName(fc) + "/" +
|
|
Application.getNotifyEmailTemplatesFolderName(fc) + "//*";
|
|
|
|
templates = selectDictionaryNodes(fc, xpath, MSG_SELECT_TEMPLATE, MimetypeMap.MIMETYPE_TEXT_PLAIN);
|
|
|
|
return templates;
|
|
}
|
|
|
|
/**
|
|
* @return the list of available RSS Templates.
|
|
*/
|
|
public List<SelectItem> getRSSTemplates()
|
|
{
|
|
List<SelectItem> templates = rssTemplates.get();
|
|
if (templates == null)
|
|
{
|
|
// get the template from the special Email Templates folder
|
|
FacesContext fc = FacesContext.getCurrentInstance();
|
|
String xpath = Application.getRootPath(fc) + "/" +
|
|
Application.getGlossaryFolderName(fc) + "/" +
|
|
Application.getRSSTemplatesFolderName(fc) + "//*";
|
|
|
|
templates = selectDictionaryNodes(fc, xpath, MSG_SELECT_TEMPLATE, MimetypeMap.MIMETYPE_TEXT_PLAIN);
|
|
|
|
rssTemplates.put(templates);
|
|
}
|
|
|
|
return templates;
|
|
}
|
|
|
|
/**
|
|
* @return the list of available JavaScript files that can be applied to the current document.
|
|
*/
|
|
public List<SelectItem> getScriptFiles()
|
|
{
|
|
List<SelectItem> scripts = this.scriptFiles.get();
|
|
if (scripts == null)
|
|
{
|
|
// get the scripts from the special Scripts folder
|
|
FacesContext fc = FacesContext.getCurrentInstance();
|
|
String xpath = Application.getRootPath(fc) + "/" +
|
|
Application.getGlossaryFolderName(fc) + "/" +
|
|
Application.getScriptsFolderName(fc) + "//*";
|
|
|
|
scripts = selectDictionaryNodes(fc, xpath, MSG_SELECT_SCRIPT, MimetypeMap.MIMETYPE_JAVASCRIPT);
|
|
|
|
scriptFiles.put(scripts);
|
|
}
|
|
|
|
return scripts;
|
|
}
|
|
|
|
/**
|
|
* @param fc FacesContext
|
|
* @param xpath XPath to the nodes to select
|
|
* @param noSelectionLabel Label to add to the list if no items are found in the search
|
|
*
|
|
* @return List of SelectItem wrapper objects for the nodes found at the XPath
|
|
*/
|
|
private List<SelectItem> selectDictionaryNodes(FacesContext fc, String xpath, String noSelectionLabel)
|
|
{
|
|
return selectDictionaryNodes(fc, xpath, noSelectionLabel, null);
|
|
}
|
|
|
|
/**
|
|
* @param fc FacesContext
|
|
* @param xpath XPath to the nodes to select
|
|
* @param noSelectionLabel Label to add to the list if no items are found in the search
|
|
* @param mimetype Optional mimetype of items to add, will not add to list if mimetype does not match
|
|
*
|
|
* @return List of SelectItem wrapper objects for the nodes found at the XPath
|
|
*/
|
|
private List<SelectItem> selectDictionaryNodes(FacesContext fc, String xpath, String noSelectionLabel, String mimetype)
|
|
{
|
|
List<SelectItem> wrappers = null;
|
|
|
|
try
|
|
{
|
|
NodeRef rootNodeRef = this.getNodeService().getRootNode(Repository.getStoreRef());
|
|
NamespaceService resolver = Repository.getServiceRegistry(fc).getNamespaceService();
|
|
List<NodeRef> results = this.getSearchService().selectNodes(rootNodeRef, xpath, null, resolver, false);
|
|
|
|
wrappers = new ArrayList<SelectItem>(results.size() + 1);
|
|
if (results.size() != 0)
|
|
{
|
|
DictionaryService dd = Repository.getServiceRegistry(fc).getDictionaryService();
|
|
for (NodeRef ref : results)
|
|
{
|
|
if (this.getNodeService().exists(ref) == true)
|
|
{
|
|
Node childNode = new Node(ref);
|
|
ContentData content = (ContentData)childNode.getProperties().get(ContentModel.PROP_CONTENT);
|
|
if (dd.isSubClass(childNode.getType(), ContentModel.TYPE_CONTENT) &&
|
|
(mimetype == null || mimetype.equals(content.getMimetype())))
|
|
{
|
|
wrappers.add(new SelectItem(childNode.getId(), childNode.getName()));
|
|
}
|
|
}
|
|
}
|
|
|
|
// make sure the list is sorted by the label
|
|
QuickSort sorter = new QuickSort(wrappers, "label", true, IDataContainer.SORT_CASEINSENSITIVE);
|
|
sorter.sort();
|
|
}
|
|
}
|
|
catch (AccessDeniedException accessErr)
|
|
{
|
|
// ignore the result if we cannot access the root
|
|
}
|
|
|
|
// add an entry (at the start) to instruct the user to select an item
|
|
if (wrappers == null)
|
|
{
|
|
wrappers = new ArrayList<SelectItem>(1);
|
|
}
|
|
wrappers.add(0, new SelectItem(NO_SELECTION, Application.getMessage(FacesContext.getCurrentInstance(), noSelectionLabel)));
|
|
|
|
return wrappers;
|
|
}
|
|
|
|
}
|