Files
alfresco-community-repo/source/java/org/alfresco/web/bean/wcm/AVMBrowseBean.java
2007-11-16 18:50:07 +00:00

1589 lines
50 KiB
Java

/*
* Copyright (C) 2005-2007 Alfresco Software Limited.
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* as published by the Free Software Foundation; either version 2
* of the License, or (at your option) any later version.
* This program 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 General Public License for more details.
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
* As a special exception to the terms and conditions of version 2.0 of
* the GPL, you may redistribute this Program in connection with Free/Libre
* and Open Source Software ("FLOSS") applications as described in Alfresco's
* FLOSS exception. You should have recieved a copy of the text describing
* the FLOSS exception, and it is also available here:
* http://www.alfresco.com/legal/licensing"
*/
package org.alfresco.web.bean.wcm;
import java.io.FileNotFoundException;
import java.io.Serializable;
import java.text.MessageFormat;
import java.util.ArrayList;
import java.util.Collections;
import java.util.Date;
import java.util.HashMap;
import java.util.LinkedList;
import java.util.List;
import java.util.Map;
import java.util.ResourceBundle;
import javax.faces.application.FacesMessage;
import javax.faces.context.FacesContext;
import javax.faces.event.ActionEvent;
import javax.faces.model.SelectItem;
import javax.transaction.UserTransaction;
import org.alfresco.config.ConfigElement;
import org.alfresco.config.ConfigService;
import org.alfresco.linkvalidation.HrefValidationProgress;
import org.alfresco.model.WCMAppModel;
import org.alfresco.repo.avm.AVMNodeConverter;
import org.alfresco.repo.avm.actions.AVMRevertStoreAction;
import org.alfresco.repo.avm.actions.AVMUndoSandboxListAction;
import org.alfresco.repo.domain.PropertyValue;
import org.alfresco.sandbox.SandboxConstants;
import org.alfresco.service.cmr.action.Action;
import org.alfresco.service.cmr.action.ActionService;
import org.alfresco.service.cmr.avm.AVMNodeDescriptor;
import org.alfresco.service.cmr.avm.AVMService;
import org.alfresco.service.cmr.avm.AVMStoreDescriptor;
import org.alfresco.service.cmr.avmsync.AVMDifference;
import org.alfresco.service.cmr.avmsync.AVMSyncService;
import org.alfresco.service.cmr.repository.ChildAssociationRef;
import org.alfresco.service.cmr.repository.NodeRef;
import org.alfresco.service.cmr.repository.NodeService;
import org.alfresco.service.cmr.workflow.WorkflowService;
import org.alfresco.service.namespace.QName;
import org.alfresco.service.namespace.RegexQNamePattern;
import org.alfresco.util.Pair;
import org.alfresco.util.VirtServerUtils;
import org.alfresco.web.app.Application;
import org.alfresco.web.app.context.IContextListener;
import org.alfresco.web.app.context.UIContextService;
import org.alfresco.web.app.servlet.DownloadContentServlet;
import org.alfresco.web.bean.BrowseBean;
import org.alfresco.web.bean.NavigationBean;
import org.alfresco.web.bean.repository.Node;
import org.alfresco.web.bean.repository.Repository;
import org.alfresco.web.bean.repository.User;
import org.alfresco.web.forms.FormInstanceData;
import org.alfresco.web.forms.FormNotFoundException;
import org.alfresco.web.forms.FormsService;
import org.alfresco.web.forms.Rendition;
import org.alfresco.web.ui.common.Utils;
import org.alfresco.web.ui.common.component.IBreadcrumbHandler;
import org.alfresco.web.ui.common.component.UIActionLink;
import org.alfresco.web.ui.common.component.UIBreadcrumb;
import org.alfresco.web.ui.common.component.UIModeList;
import org.alfresco.web.ui.common.component.data.UIRichList;
import org.alfresco.web.ui.wcm.WebResources;
import org.alfresco.web.ui.wcm.component.UISandboxSnapshots;
import org.alfresco.web.ui.wcm.component.UIUserSandboxes;
import org.apache.commons.lang.StringUtils;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
/**
* Bean backing up the AVM specific browse screens
*
* @author Kevin Roast
*/
public class AVMBrowseBean implements IContextListener
{
public static final String BEAN_NAME = "AVMBrowseBean";
private static final Log logger = LogFactory.getLog(AVMBrowseBean.class);
private static final String REQUEST_BEEN_DEPLOYED_KEY = "_alfBeenDeployedEvaluated";
private static final String REQUEST_BEEN_DEPLOYED_RESULT = "_alfBeenDeployedResult";
private static final String MSG_REVERT_SUCCESS = "revert_success";
private static final String MSG_REVERT_SANDBOX = "revert_sandbox_success";
private static final String MSG_SANDBOXTITLE = "sandbox_title";
private static final String MSG_SANDBOXSTAGING = "sandbox_staging";
private static final String MSG_CREATED_ON = "store_created_on";
private static final String MSG_CREATED_BY = "store_created_by";
private static final String MSG_WORKING_USERS = "store_working_users";
/** Component id the status messages are tied too */
static final String COMPONENT_SANDBOXESPANEL = "sandboxes-panel";
/** Top-level JSF form ID */
static final String FORM_ID = "website";
/** Snapshot date filter selection */
private String snapshotDateFilter = UISandboxSnapshots.FILTER_DATE_TODAY;
/** Current sandbox store context for actions and sandbox view */
private String sandbox;
/** Current username context for actions and sandbox view */
private String username;
/** Current webapp context for actions and sandbox view */
private String webapp;
/** List of top-level webapp directories for the current web project */
private List<SelectItem> webapps;
/** Sandbox title message */
private String sandboxTitle = null;
/** Current AVM path and node representing the current path */
private String currentPath = null;
private AVMNode currentPathNode = null;
/** flag to indicate that all items in the sandbox are involved in the current action */
private boolean allItemsAction = false;
/** list of the deployment monitor ids currently executing */
private List<String> deploymentMonitorIds = new ArrayList<String>();
/** List of expired paths to submit */
private List<AVMNodeDescriptor> nodesForSubmit = Collections.<AVMNodeDescriptor>emptyList();
/** Object used by link validation service to monitor the status of a link check */
private HrefValidationProgress linkValidationMonitor;
/** Link validation state instance used by link validation dialogs */
private LinkValidationState linkValidationState;
/* component references */
private UIRichList foldersRichList;
private UIRichList filesRichList;
private UIUserSandboxes userSandboxes;
/** transient lists of files/folders for a directory */
private List<Map> files = null;
private List<Map> folders = null;
/** Current AVM Node action context */
private AVMNode avmNode = null;
/** The last displayed website node id */
private String lastWebsiteId = null;
/** The current webProject */
private WebProject webProject = null;
/** breadcrumb location */
private List<IBreadcrumbHandler> location = null;
/** The current view page sizes */
private int pageSizeFolders;
private int pageSizeFiles;
private String pageSizeFoldersStr;
private String pageSizeFilesStr;
/** The NodeService to be used by the bean */
protected NodeService nodeService;
/** The WorkflowService bean reference. */
protected WorkflowService workflowService;
/** The NavigationBean bean reference */
protected NavigationBean navigator;
/** AVM service bean reference */
protected AVMService avmService;
/** AVM sync service bean reference */
protected AVMSyncService avmSyncService;
/** Action service bean reference */
protected ActionService actionService;
/** The FormsService reference */
protected FormsService formsService;
/**
* Default Constructor
*/
public AVMBrowseBean()
{
UIContextService.getInstance(FacesContext.getCurrentInstance()).registerBean(this);
initFromClientConfig();
}
// ------------------------------------------------------------------------------
// Bean property getters and setters
/**
* @param avmService The AVMService to set.
*/
public void setAvmService(AVMService avmService)
{
this.avmService = avmService;
}
/**
* @param avmSyncService The AVMSyncService to set.
*/
public void setAvmSyncService(AVMSyncService avmSyncService)
{
this.avmSyncService = avmSyncService;
}
/**
* @param nodeService The NodeService to set.
*/
public void setNodeService(NodeService nodeService)
{
this.nodeService = nodeService;
}
/**
* Set the workflow service
* @param service The workflow service instance.
*/
public void setWorkflowService(WorkflowService service)
{
workflowService = service;
}
/**
* Getter used by the Inline Edit XML JSP
*
* @return The NodeService
*/
public NodeService getNodeService()
{
return this.nodeService;
}
/**
* @param navigator The NavigationBean to set.
*/
public void setNavigationBean(NavigationBean navigator)
{
this.navigator = navigator;
}
/**
* @param actionService The actionService to set.
*/
public void setActionService(ActionService actionService)
{
this.actionService = actionService;
}
/**
* @param formsService The FormsService to set.
*/
public void setFormsService(final FormsService formsService)
{
this.formsService = formsService;
}
public int getPageSizeFiles()
{
return this.pageSizeFiles;
}
public void setPageSizeFiles(int pageSizeContent)
{
this.pageSizeFiles = pageSizeContent;
this.pageSizeFilesStr = Integer.toString(pageSizeContent);
}
public int getPageSizeFolders()
{
return this.pageSizeFolders;
}
public void setPageSizeFolders(int pageSizeSpaces)
{
this.pageSizeFolders = pageSizeSpaces;
this.pageSizeFoldersStr = Integer.toString(pageSizeSpaces);
}
public String getPageSizeFilesStr()
{
return this.pageSizeFilesStr;
}
public void setPageSizeFilesStr(String pageSizeContentStr)
{
this.pageSizeFilesStr = pageSizeContentStr;
}
public String getPageSizeFoldersStr()
{
return this.pageSizeFoldersStr;
}
public void setPageSizeFoldersStr(String pageSizeSpacesStr)
{
this.pageSizeFoldersStr = pageSizeSpacesStr;
}
/**
* Summary text for the staging store:
* Created On: xx/yy/zz
* Created By: username
* There are N user(s) working on this website.
*
* @return summary text
*/
public String getStagingSummary()
{
final StringBuilder summary = new StringBuilder(128);
final FacesContext fc = FacesContext.getCurrentInstance();
final ResourceBundle msg = Application.getBundle(fc);
final String stagingStore = this.getStagingStore();
final AVMStoreDescriptor store = this.avmService.getStore(stagingStore);
final String storeId = (String)this.getWebProject().getStoreId();
if (store != null)
{
summary.append(msg.getString(MSG_CREATED_ON)).append(": ")
.append(Utils.getDateFormat(fc).format(new Date(store.getCreateDate())))
.append("<p>");
summary.append(msg.getString(MSG_CREATED_BY)).append(": ")
.append(store.getCreator())
.append("<p>");
final int numUsers = this.getRelatedStoreNames(storeId, SandboxConstants.PROP_SANDBOX_AUTHOR_MAIN).size();
summary.append(MessageFormat.format(msg.getString(MSG_WORKING_USERS), numUsers));
}
// reset the current path so the context for the Modified File list actions is cleared
this.currentPath = null;
return summary.toString();
}
/**
* Returns the list of store names related to the storeId provided that have
* any of the provided types as store properties.
*
* @return a list of related store names.
*/
private List<String> getRelatedStoreNames(final String storeId, final QName... types)
{
QName qn = QName.createQName(null, SandboxConstants.PROP_SANDBOX_STORE_PREFIX + storeId + "%");
final Map<String, Map<QName, PropertyValue>> relatedSandboxes =
avmService.queryStoresPropertyKeys(qn);
final List<String> result = new LinkedList<String>();
for (String storeName : relatedSandboxes.keySet())
{
for (final QName type : types)
{
if (this.avmService.getStoreProperty(storeName, type) != null)
{
result.add(storeName);
break;
}
}
}
return result;
}
/**
* @return the current staging store name
*/
public String getStagingStore()
{
return this.getWebProject().getStagingStore();
}
/**
* @return Preview URL for the current Staging store and current webapp
*/
public String getStagingPreviewUrl()
{
return AVMUtil.buildWebappUrl(getStagingStore(), getWebapp());
}
/**
* @return Preview URL for the current User Sandbox store and current webapp
*/
public String getSandboxPreviewUrl()
{
return AVMUtil.buildWebappUrl(getSandbox(), getWebapp());
}
/**
* @param foldersRichList The foldersRichList to set.
*/
public void setFoldersRichList(UIRichList foldersRichList)
{
this.foldersRichList = foldersRichList;
}
/**
* @return Returns the foldersRichList.
*/
public UIRichList getFoldersRichList()
{
return this.foldersRichList;
}
/**
* @return Returns the filesRichList.
*/
public UIRichList getFilesRichList()
{
return this.filesRichList;
}
/**
* @param filesRichList The filesRichList to set.
*/
public void setFilesRichList(UIRichList filesRichList)
{
this.filesRichList = filesRichList;
}
/**
* @return Returns the userSandboxes.
*/
public UIUserSandboxes getUserSandboxes()
{
return this.userSandboxes;
}
/**
* @param userSandboxes The userSandboxes to set.
*/
public void setUserSandboxes(UIUserSandboxes userSandboxes)
{
this.userSandboxes = userSandboxes;
}
/**
* @return Returns the current sandbox context.
*/
public String getSandbox()
{
return this.sandbox;
}
/**
* @param sandbox The sandbox to set.
*/
public void setSandbox(String sandbox)
{
this.sandbox = sandbox;
}
/**
* @return Returns the current username context.
*/
public String getUsername()
{
return this.username;
}
/**
* @param username The username to set.
*/
public void setUsername(String username)
{
this.username = username;
}
/**
* @return current webapp context
*/
public String getWebapp()
{
if (this.webapp == null)
{
// TODO - temporary, should only be called for WCM forms (not ECM forms)
this.webapp = this.getWebProject() != null ? this.getWebProject().getDefaultWebapp() : null;
}
return this.webapp;
}
/**
* @param webapp Webapp folder context
*/
public void setWebapp(String webapp)
{
this.webapp = webapp;
}
/**
* @return Returns the list of deployment monitor ids currently executing
*/
public List<String> getDeploymentMonitorIds()
{
return this.deploymentMonitorIds;
}
/**
* @param deploymentMonitorIds Sets the list of deployment monitor ids
*/
public void setDeploymentMonitorIds(List<String> deploymentMonitorIds)
{
this.deploymentMonitorIds = deploymentMonitorIds;
}
/**
* @return Returns the link validation monitor instance
*/
public HrefValidationProgress getLinkValidationMonitor()
{
return this.linkValidationMonitor;
}
/**
* @param monitor The link validation monitor instance to use
*/
public void setLinkValidationMonitor(HrefValidationProgress monitor)
{
this.linkValidationMonitor = monitor;
}
/**
* @return Returns the link validation state instance
*/
public LinkValidationState getLinkValidationState()
{
return this.linkValidationState;
}
/**
* @param monitor The link validation state instance to use
*/
public void setLinkValidationState(LinkValidationState state)
{
this.linkValidationState = state;
}
public List<AVMNodeDescriptor> getNodesForSubmit()
{
return this.nodesForSubmit;
}
public void setNodesForSubmit(final List<AVMNodeDescriptor> nodesForSubmit)
{
this.nodesForSubmit = nodesForSubmit;
}
/**
* @return list of available root webapp folders for this Web project
*/
public List<SelectItem> getWebapps()
{
if (this.webapps == null)
{
String path = AVMUtil.buildSandboxRootPath(getStagingStore());
Map<String, AVMNodeDescriptor> folders = this.avmService.getDirectoryListing(-1, path);
List<SelectItem> webapps = new ArrayList<SelectItem>(folders.size());
for (AVMNodeDescriptor node : folders.values())
{
webapps.add(new SelectItem(node.getName(), node.getName()));
}
this.webapps = webapps;
}
return this.webapps;
}
/**
* @return count of the root webapps in the current web project
*/
public int getWebappsSize()
{
return getWebapps().size();
}
/**
* @return Returns the sandboxTitle.
*/
public String getSandboxTitle()
{
if (this.sandboxTitle == null)
{
String forUser = username;
if (forUser == null)
{
forUser = Application.getMessage(FacesContext.getCurrentInstance(), MSG_SANDBOXSTAGING);
}
this.sandboxTitle = MessageFormat.format(Application.getMessage(
FacesContext.getCurrentInstance(), MSG_SANDBOXTITLE),
getWebsite().getName(),
forUser);
}
return this.sandboxTitle;
}
/**
* @param sandboxTitle The sandboxTitle to set.
*/
public void setSandboxTitle(String sandboxTitle)
{
this.sandboxTitle = sandboxTitle;
}
/**
* @return Returns the Snapshot Date Filter.
*/
public String getSnapshotDateFilter()
{
return this.snapshotDateFilter;
}
/**
* @param snapshotDateFilter The Snapshot Date Filter to set.
*/
public void setSnapshotDateFilter(String snapshotDateFilter)
{
this.snapshotDateFilter = snapshotDateFilter;
}
/**
* @return icon image for the appropriate sandbox type
*/
public String getIcon()
{
return this.username == null ? WebResources.IMAGE_SANDBOX_32 : WebResources.IMAGE_USERSANDBOX_32;
}
/**
* @return website node the view is currently within
*/
public Node getWebsite()
{
// check to see if the website we are browsing has changed since the last time
final Node currentNode = this.navigator.getCurrentNode();
if (!this.navigator.getCurrentNodeId().equals(this.lastWebsiteId) ||
!WCMAppModel.TYPE_AVMWEBFOLDER.equals(currentNode.getType()))
{
// clear context when we are browsing a new website
this.lastWebsiteId = this.navigator.getCurrentNodeId();
this.webapp = null;
this.webapps = null;
this.webProject = null;
}
return WCMAppModel.TYPE_AVMWEBFOLDER.equals(currentNode.getType()) ? currentNode : null;
}
/**
* @return the web project the view is currently within
*/
public WebProject getWebProject()
{
Node website = this.getWebsite();
if (this.webProject == null && website != null)
{
this.webProject = new WebProject(website.getNodeRef());
}
return this.webProject;
}
/**
* @return Returns the current AVM node action context.
*/
public AVMNode getAvmActionNode()
{
return this.avmNode;
}
/**
* @param avmNode The AVM node action context to set.
*/
public void setAvmActionNode(AVMNode avmNode)
{
this.avmNode = avmNode;
}
/**
* @param avmRef The AVMNodeDescriptor action context to set.
*/
public void setAVMActionNodeDescriptor(AVMNodeDescriptor avmRef)
{
if (avmRef == null)
{
throw new NullPointerException();
}
AVMNode avmNode = new AVMNode(avmRef);
this.avmNode = avmNode;
}
/**
* @return the internal AVM path to the current folder for browsing
*/
public String getCurrentPath()
{
if (this.currentPath == null)
{
// TODO - temporary, should only be called for WCM forms (not ECM forms)
String webApp = getWebapp();
if (webApp != null)
{
this.currentPath = AVMUtil.buildStoreWebappPath(getSandbox(), webApp);
}
}
return this.currentPath;
}
/**
* @param path the internal AVM path to the current folder for browsing
*/
public void setCurrentPath(String path)
{
this.currentPath = path;
if (path == null)
{
// clear dependant objects (recreated when the path is reinitialised)
this.currentPathNode = null;
}
// update UI state ready for screen refresh
UIContextService.getInstance(FacesContext.getCurrentInstance()).notifyBeans();
}
/**
* @return the AVMNode that represents the current browsing path
*/
public AVMNode getCurrentPathNode()
{
if (this.currentPathNode == null)
{
AVMNodeDescriptor node = this.avmService.lookup(-1, getCurrentPath(), true);
this.currentPathNode = new AVMNode(node);
}
return this.currentPathNode;
}
/**
* @return Breadcrumb location list
*/
public List<IBreadcrumbHandler> getLocation()
{
if (this.location == null)
{
List<IBreadcrumbHandler> loc = new ArrayList<IBreadcrumbHandler>(8);
loc.add(new AVMBreadcrumbHandler(getCurrentPath()));
this.location = loc;
}
return this.location;
}
/**
* @param location Breadcrumb location list
*/
public void setLocation(List<IBreadcrumbHandler> location)
{
this.location = location;
}
/**
* @return true if the current user has the manager role in the current website
*/
public boolean getIsManagerRole()
{
final User user = Application.getCurrentUser(FacesContext.getCurrentInstance());
return this.getWebProject().isManager(user);
}
/**
* @return true if the website has had a deployment attempt
*/
@SuppressWarnings("unchecked")
public boolean getHasDeployBeenAttempted()
{
// NOTE: This method is called a lot as it is referenced as a value binding
// expression in a 'rendered' attribute, we therefore cache the result
// on a per request basis
List<ChildAssociationRef> deployReportRefs = null;
FacesContext context = FacesContext.getCurrentInstance();
Map request = context.getExternalContext().getRequestMap();
if (request.get(REQUEST_BEEN_DEPLOYED_KEY) == null)
{
// see if there are any deployment reports for the site
NodeRef webProjectRef = this.getWebsite().getNodeRef();
deployReportRefs = this.nodeService.getChildAssocs(webProjectRef,
WCMAppModel.ASSOC_DEPLOYMENTREPORT, RegexQNamePattern.MATCH_ALL);
// add a placeholder object in the request so we don't evaluate this again for this request
request.put(REQUEST_BEEN_DEPLOYED_KEY, Boolean.TRUE);
request.put(REQUEST_BEEN_DEPLOYED_RESULT, deployReportRefs);
}
else
{
deployReportRefs = (List<ChildAssociationRef>)request.get(REQUEST_BEEN_DEPLOYED_RESULT);
}
return (deployReportRefs != null && deployReportRefs.size() > 0);
}
/**
* @return Map of avm node objects representing the folders with the current website space
*/
public List<Map> getFolders()
{
if (this.folders == null)
{
getNodes();
}
return this.folders;
}
/**
* @return Map of avm node objects representing the files with the current website space
*/
public List<Map> getFiles()
{
if (this.files == null)
{
getNodes();
}
return this.files;
}
/**
* Build the lists of files and folders within the current browsing path in a website space
*/
private void getNodes()
{
UserTransaction tx = null;
try
{
FacesContext context = FacesContext.getCurrentInstance();
tx = Repository.getUserTransaction(context, true);
tx.begin();
Map<String, AVMNodeDescriptor> nodes = this.avmService.getDirectoryListing(-1, getCurrentPath());
this.files = new ArrayList<Map>(nodes.size());
this.folders = new ArrayList<Map>(nodes.size());
for (String name : nodes.keySet())
{
AVMNodeDescriptor avmRef = nodes.get(name);
// build the client representation of the AVM node
AVMNode node = new AVMNode(avmRef);
String path = avmRef.getPath();
// properties specific to folders or files
if (avmRef.isDirectory())
{
node.getProperties().put("smallIcon", BrowseBean.SPACE_SMALL_DEFAULT);
this.folders.add(node);
}
else
{
node.getProperties().put("fileType16", Utils.getFileTypeImage(name, true));
node.getProperties().put("url", DownloadContentServlet.generateBrowserURL(
AVMNodeConverter.ToNodeRef(-1, path), name));
this.files.add(node);
}
// common properties
node.addPropertyResolver("previewUrl", AVMNode.RESOLVER_PREVIEW_URL);
}
// commit the transaction
tx.commit();
}
catch (Throwable err)
{
Utils.addErrorMessage(MessageFormat.format(Application.getMessage(
FacesContext.getCurrentInstance(), Repository.ERROR_GENERIC), err.getMessage()), err);
this.folders = Collections.<Map>emptyList();
this.files = Collections.<Map>emptyList();
try { if (tx != null) {tx.rollback();} } catch (Exception tex) {}
}
}
/**
* Return the list of selected items for the current user sandbox view
*
* @return List of AVMNodeDescriptor objects representing selected items
*/
public List<AVMNodeDescriptor> getSelectedSandboxItems()
{
return this.userSandboxes.getSelectedNodes(this.username);
}
/**
* @return true if a special All Items action has been initialised
*/
public boolean getAllItemsAction()
{
return this.allItemsAction;
}
// ------------------------------------------------------------------------------
// Action event handlers
/**
* Update the UI after a folder click action in the website browsing screens
*/
public void clickFolder(ActionEvent event)
{
UIActionLink link = (UIActionLink)event.getComponent();
Map<String, String> params = link.getParameterMap();
String path = params.get("id");
updateUILocation(path);
}
/**
* Action handler called when the Snapshot Date filter is changed by the user
*/
public void snapshotDateFilterChanged(ActionEvent event)
{
UIModeList filterComponent = (UIModeList)event.getComponent();
setSnapshotDateFilter(filterComponent.getValue().toString());
}
/**
* Setup the context for a sandbox browse action
*/
public void setupSandboxAction(final ActionEvent event)
{
final UIActionLink link = (UIActionLink)event.getComponent();
final Map<String, String> params = link.getParameterMap();
this.setupSandboxAction(params.get("store"), params.get("username"));
}
/**
* Setup the context for a sandbox browse action
*
* @param store The store name for the action
* @param username The authority pertinent to the action (null for staging store actions)
*/
public void setupSandboxAction(String store, String username)
{
this.setupSandboxActionImpl(store, null, username, true);
}
/**
* Setup the context for a sandbox browse action
*
* @param store The store name for the action
* @param username The authority pertinent to the action (null for staging store actions)
* @param reset True to reset the current path and AVM action node context
*/
private void setupSandboxActionImpl(final String store,
final String webapp,
final String username,
final boolean reset)
{
// can be null if it's the staging store - i.e. not a user specific store
setUsername(username);
// the store can be either a user store or the staging store if this is null
// get the staging store from the current website node
this.setSandbox(store != null ? store : this.getStagingStore());
if (webapp != null)
{
this.setWebapp(webapp);
}
// update UI state ready for return to the previous screen
if (reset == true)
{
this.sandboxTitle = null;
this.location = null;
setCurrentPath(null);
setAvmActionNode(null);
this.allItemsAction = false;
}
}
/**
* Action event called by all actions that need to setup a Content node context on the
* before an action page/wizard is called. The context will be an AVMNodeDescriptor in
* setAVMNode() which can be retrieved on action pages via getAVMNode().
*
* @param event ActionEvent
*/
public void setupContentAction(final ActionEvent event)
{
final UIActionLink link = (UIActionLink)event.getComponent();
final Map<String, String> params = link.getParameterMap();
this.setupContentAction(params.get("id"), true);
}
/*package*/ void setupContentAction(final String path, final boolean refresh)
{
if (logger.isDebugEnabled())
logger.debug("Setup content action for path: " + path);
if (path == null && path.length() == 0)
{
setAvmActionNode(null);
}
else
{
// calculate username and store name from specified path
String storeName = AVMUtil.getStoreName(path);
final String storeId = AVMUtil.getStoreId(storeName);
final String webapp = AVMUtil.getWebapp(path);
final String username = AVMUtil.getUserName(storeName);
if (username == null)
{
storeName = (AVMUtil.isPreviewStore(storeName)
? AVMUtil.buildStagingPreviewStoreName(storeId)
: AVMUtil.buildStagingStoreName(storeId));
this.setupSandboxActionImpl(storeName, webapp, null, false);
}
else
{
storeName = (AVMUtil.isPreviewStore(storeName)
? AVMUtil.buildUserPreviewStoreName(storeId, username)
: AVMUtil.buildUserMainStoreName(storeId, username));
this.setupSandboxActionImpl(storeName, webapp, username, false);
}
if (this.webProject == null)
{
this.webProject = new WebProject(path);
}
// setup the action node
this.setAVMActionNodeDescriptor(avmService.lookup(-1, path, true));
}
// update UI state ready for return after dialog close
if (refresh)
{
UIContextService.getInstance(FacesContext.getCurrentInstance()).notifyBeans();
}
}
/**
* 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(final ActionEvent event)
{
final UIActionLink link = (UIActionLink)event.getComponent();
final Map<String, String> params = link.getParameterMap();
this.setupEditAction(params.get("id"));
}
/**
* 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(final String path)
{
this.setupContentAction(path, true);
// retrieve the content reader for this node
String avmPath = this.getAvmActionNode().getPath();
if (this.avmService.hasAspect(-1, avmPath, WCMAppModel.ASPECT_RENDITION))
{
if (logger.isDebugEnabled())
logger.debug(avmPath + " is a rendition, editing primary rendition instead");
try
{
final FormInstanceData fid = this.formsService.getRendition(-1, avmPath).getPrimaryFormInstanceData();
avmPath = fid.getPath();
if (logger.isDebugEnabled())
logger.debug("Editing primary form instance data " + avmPath);
this.setAvmActionNode(new AVMNode(this.avmService.lookup(-1, avmPath)));
}
catch (FileNotFoundException fnfe)
{
this.avmService.removeAspect(avmPath, WCMAppModel.ASPECT_RENDITION);
this.avmService.removeAspect(avmPath, WCMAppModel.ASPECT_FORM_INSTANCE_DATA);
Utils.addErrorMessage(fnfe.getMessage(), fnfe);
}
}
if (logger.isDebugEnabled())
logger.debug("Editing AVM node: " + avmPath);
String outcome = null;
// calculate which editor screen to display
if (this.avmService.hasAspect(-1, avmPath, WCMAppModel.ASPECT_FORM_INSTANCE_DATA))
{
// make content available to the editing screen
try
{
// make sure the form association works before proceeding to the
// edit web content wizard
this.formsService.getFormInstanceData(-1, avmPath).getForm();
// navigate to appropriate screen
outcome = "wizard:editWebContent";
}
catch (FormNotFoundException fnfe)
{
logger.debug(fnfe.getMessage(), fnfe);
final Map<String, String> params = new HashMap<String, String>(2, 1.0f);
params.put("finishOutcome", "wizard:editWebContent");
params.put("cancelOutcome", "dialog:editAvmFile");
Application.getDialogManager().setupParameters(params);
outcome = "dialog:promptForWebForm";
}
}
else
{
// normal downloadable document
outcome = "dialog:editAvmFile";
}
logger.debug("outcome " + outcome + " for path " + path);
final FacesContext fc = FacesContext.getCurrentInstance();
fc.getApplication().getNavigationHandler().handleNavigation(fc, null, outcome);
}
/**
* Action handler for all nodes from user sandbox
*/
public void setupAllItemsAction(ActionEvent event)
{
setupSandboxAction(event);
this.allItemsAction = true;
}
/**
* Refresh Sandbox in the virtualisation server
*/
public void refreshSandbox(ActionEvent event)
{
UIActionLink link = (UIActionLink)event.getComponent();
Map<String, String> params = link.getParameterMap();
String store = params.get("store");
if (store == null)
{
store = getStagingStore();
}
// update the specified webapp in the store
String webappPath = AVMUtil.buildStoreWebappPath(store, getWebapp());
AVMUtil.updateVServerWebapp(webappPath, true);
}
/**
* Undo changes to a single node
*/
public void revertNode(ActionEvent event)
{
final String path = getPathFromEventArgs(event);
final List<String> namesForDisplayMsg = new LinkedList<String>();
UserTransaction tx = null;
final FacesContext context = FacesContext.getCurrentInstance();
try
{
tx = Repository.getUserTransaction(context, false);
tx.begin();
AVMNodeDescriptor node = this.avmService.lookup(-1, path, true);
if (node != null)
{
FormInstanceData fid = null;
if (this.avmService.hasAspect(-1, path, WCMAppModel.ASPECT_RENDITION))
{
fid = this.formsService.getRendition(-1, path).getPrimaryFormInstanceData();
}
else if (this.avmService.hasAspect(-1, path, WCMAppModel.ASPECT_FORM_INSTANCE_DATA))
{
fid = this.formsService.getFormInstanceData(-1, path);
}
List<Pair<Integer, String>> versionPaths = new ArrayList<Pair<Integer, String>>();
if (fid != null)
{
versionPaths.add(new Pair<Integer, String>(-1, fid.getPath()));
namesForDisplayMsg.add(fid.getName());
for (Rendition r : fid.getRenditions())
{
versionPaths.add(new Pair<Integer, String>(-1, r.getPath()));
namesForDisplayMsg.add(r.getName());
}
}
else
{
versionPaths.add(new Pair<Integer, String>(-1, path));
namesForDisplayMsg.add(node.getName());
}
final Map<String, Serializable> args = new HashMap<String, Serializable>(1, 1.0f);
args.put(AVMUndoSandboxListAction.PARAM_NODE_LIST, (Serializable)versionPaths);
Action action = this.actionService.createAction(AVMUndoSandboxListAction.NAME, args);
this.actionService.executeAction(action, null); // dummy action ref
}
// commit the transaction
tx.commit();
// possibly update webapp after commit
if (VirtServerUtils.requiresUpdateNotification(path))
{
AVMUtil.updateVServerWebapp(path, true);
}
// if we get here, all was well - output friendly status message to the user
this.displayStatusMessage(context,
MessageFormat.format(Application.getMessage(context, MSG_REVERT_SUCCESS),
StringUtils.join(namesForDisplayMsg.toArray(), ", "),
namesForDisplayMsg.size()));
}
catch (Throwable err)
{
err.printStackTrace(System.err);
Utils.addErrorMessage(MessageFormat.format(Application.getMessage(context, Repository.ERROR_GENERIC),
err.getMessage()),
err);
try { if (tx != null) {tx.rollback();} } catch (Exception tex) {}
}
}
/**
* Revert a sandbox to a specific snapshot version ID
*/
public void revertSnapshot(ActionEvent event)
{
UIActionLink link = (UIActionLink)event.getComponent();
Map<String, String> params = link.getParameterMap();
String sandbox = params.get("sandbox");
String strVersion = params.get("version");
if (sandbox != null && strVersion != null && strVersion.length() != 0)
{
UserTransaction tx = null;
try
{
FacesContext context = FacesContext.getCurrentInstance();
tx = Repository.getUserTransaction(context, false);
tx.begin();
String sandboxPath = AVMUtil.buildSandboxRootPath( sandbox );
List<AVMDifference> diffs =
this.avmSyncService.compare(
-1,sandboxPath,Integer.valueOf(strVersion),sandboxPath,null);
Map<String, Serializable> args = new HashMap<String, Serializable>(1, 1.0f);
args.put(AVMRevertStoreAction.PARAM_VERSION, Integer.valueOf(strVersion));
Action action = this.actionService.createAction(AVMRevertStoreAction.NAME, args);
this.actionService.executeAction(action, AVMNodeConverter.ToNodeRef(-1, sandbox + ":/"));
// commit the transaction
tx.commit();
// See if any of the files being reverted require
// notification of the virt server.
for (AVMDifference diff : diffs)
{
if ( VirtServerUtils.requiresUpdateNotification( diff.getSourcePath()) )
{
AVMUtil.updateVServerWebapp(diff.getSourcePath() , true);
break;
}
}
// if we get here, all was well - output friendly status message to the user
this.displayStatusMessage(context,
MessageFormat.format(Application.getMessage(context, MSG_REVERT_SANDBOX),
sandbox,
strVersion));
}
catch (Throwable err)
{
err.printStackTrace(System.err);
Utils.addErrorMessage(MessageFormat.format(Application.getMessage(
FacesContext.getCurrentInstance(), Repository.ERROR_GENERIC), err.getMessage()), err);
try { if (tx != null) {tx.rollback();} } catch (Exception tex) {}
}
}
}
/**
* Create web content from a specific Form via the User Sandbox 'Available Forms' panel
*/
public void createFormContent(final ActionEvent event)
{
// setup the correct sandbox for the create action
this.setupSandboxAction(event);
// pass form ID to the wizard - to be picked up in init()
Application.getWizardManager().setupParameters(event);
final FacesContext fc = FacesContext.getCurrentInstance();
fc.getApplication().getNavigationHandler().handleNavigation(fc, null, "wizard:createWebContent");
}
/**
* Event handler that transitions a 'submitpending' task to effectively
* bypass the lauch date and immediately submit the items.
*
* @param event The event
*/
public void promotePendingSubmission(ActionEvent event)
{
UIActionLink link = (UIActionLink)event.getComponent();
Map<String, String> params = link.getParameterMap();
String taskId = params.get("taskId");
UserTransaction tx = null;
try
{
FacesContext context = FacesContext.getCurrentInstance();
tx = Repository.getUserTransaction(context, false);
tx.begin();
// transition the task
this.workflowService.endTask(taskId, "launch");
// commit the transaction
tx.commit();
}
catch (Throwable err)
{
Utils.addErrorMessage(MessageFormat.format(Application.getMessage(
FacesContext.getCurrentInstance(), Repository.ERROR_GENERIC), err.getMessage()), err);
try { if (tx != null) {tx.rollback();} } catch (Exception tex) {}
}
}
/**
* Event handler that cancels a pending submission.
*
* @param event The event
*/
public void cancelPendingSubmission(ActionEvent event)
{
UIActionLink link = (UIActionLink)event.getComponent();
Map<String, String> params = link.getParameterMap();
String workflowId = params.get("workflowInstanceId");
UserTransaction tx = null;
try
{
FacesContext context = FacesContext.getCurrentInstance();
tx = Repository.getUserTransaction(context, false);
tx.begin();
// cancel the workflow
this.workflowService.cancelWorkflow(workflowId);
// commit the transaction
tx.commit();
}
catch (Throwable err)
{
Utils.addErrorMessage(MessageFormat.format(Application.getMessage(
FacesContext.getCurrentInstance(), Repository.ERROR_GENERIC), err.getMessage()), err);
try { if (tx != null) {tx.rollback();} } catch (Exception tex) {}
}
}
/**
* Update page size based on user selection
*/
public void updateFoldersPageSize(ActionEvent event)
{
try
{
int size = Integer.parseInt(this.pageSizeFoldersStr);
if (size >= 0)
{
this.pageSizeFolders = size;
}
else
{
// reset to known value if this occurs
this.pageSizeFoldersStr = Integer.toString(this.pageSizeFolders);
}
}
catch (NumberFormatException err)
{
// reset to known value if this occurs
this.pageSizeFoldersStr = Integer.toString(this.pageSizeFolders);
}
}
/**
* Update page size based on user selection
*/
public void updateFilesPageSize(ActionEvent event)
{
try
{
int size = Integer.parseInt(this.pageSizeFilesStr);
if (size >= 0)
{
this.pageSizeFiles = size;
}
else
{
// reset to known value if this occurs
this.pageSizeFilesStr = Integer.toString(this.pageSizeFiles);
}
}
catch (NumberFormatException err)
{
// reset to known value if this occurs
this.pageSizeFilesStr = Integer.toString(this.pageSizeFiles);
}
}
// ------------------------------------------------------------------------------
// Private helpers
/**
* Display a status message to the user
*
* @param context
* @param msg Text message to display
*/
/*package*/ void displayStatusMessage(FacesContext context, String msg)
{
FacesMessage facesMsg = new FacesMessage(FacesMessage.SEVERITY_INFO, msg, msg);
context.addMessage(FORM_ID + ':' + COMPONENT_SANDBOXESPANEL, facesMsg);
}
/*package*/ boolean isCurrentPathNull()
{
return (this.currentPath == null);
}
/**
* Initialise default values from client configuration
*/
private void initFromClientConfig()
{
ConfigService config = Application.getConfigService(FacesContext.getCurrentInstance());
ConfigElement wcmConfig = config.getGlobalConfig().getConfigElement("wcm");
if (wcmConfig != null)
{
ConfigElement viewsConfig = wcmConfig.getChild("views");
if (viewsConfig != null)
{
ConfigElement pageConfig = viewsConfig.getChild("browse-page-size");
if (pageConfig != null)
{
String strPageSize = pageConfig.getValue();
if (strPageSize != null)
{
int pageSize = Integer.valueOf(strPageSize.trim());
setPageSizeFiles(pageSize);
setPageSizeFolders(pageSize);
}
}
}
}
}
/**
* Update the breadcrumb with the clicked Group location
*/
private void updateUILocation(String path)
{
this.location.add(new AVMBreadcrumbHandler(path));
setCurrentPath(path);
}
/**
* @return the path from the 'id' argument in the specified UIActionLink event
*/
private String getPathFromEventArgs(ActionEvent event)
{
UIActionLink link = (UIActionLink)event.getComponent();
Map<String, String> params = link.getParameterMap();
return params.get("id");
}
// ------------------------------------------------------------------------------
// IContextListener implementation
/**
* @see org.alfresco.web.app.context.IContextListener#contextUpdated()
*/
public void contextUpdated()
{
if (this.foldersRichList != null)
{
this.foldersRichList.setValue(null);
}
if (this.filesRichList != null)
{
this.filesRichList.setValue(null);
}
this.files = null;
this.folders = null;
// clear webapp listing as we may have returned from the Create Webapp dialog
this.webapps = null;
}
/**
* @see org.alfresco.web.app.context.IContextListener#areaChanged()
*/
public void areaChanged()
{
// nothing to do
}
/**
* @see org.alfresco.web.app.context.IContextListener#spaceChanged()
*/
public void spaceChanged()
{
// nothing to do
}
// ------------------------------------------------------------------------------
// Inner classes
/**
* Class to handle breadcrumb interaction for AVM page
*/
@SuppressWarnings("serial")
private class AVMBreadcrumbHandler implements IBreadcrumbHandler
{
private String path;
AVMBreadcrumbHandler(String path)
{
this.path = path;
}
@SuppressWarnings("unchecked")
public String navigationOutcome(UIBreadcrumb breadcrumb)
{
setCurrentPath(path);
setLocation((List)breadcrumb.getValue());
return null;
}
@Override
public String toString()
{
if (AVMUtil.buildSandboxRootPath(getSandbox()).equals(path))
{
// don't display the 'root' webapps path as this will confuse users
// instead display which sandbox we are in
String label = username;
if (label == null)
{
label = Application.getMessage(FacesContext.getCurrentInstance(), MSG_SANDBOXSTAGING);
}
return label;
}
else
{
return path.substring(path.lastIndexOf('/') + 1);
}
}
}
}