mirror of
https://github.com/Alfresco/alfresco-community-repo.git
synced 2025-08-07 17:49:17 +00:00
24a483f73d
5457: Merge error on copy web project action 5459: AR-1278 5461: 5462: A few deployment fixes 5469: Dictionary messages 5470: L2 cache checks 5478: WCM-374 git-svn-id: https://svn.alfresco.com/repos/alfresco-enterprise/alfresco/HEAD/root@5485 c4b6b30b-aa2e-2d43-bbcb-ca4b014f7261
1028 lines
34 KiB
Java
1028 lines
34 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.text.MessageFormat;
|
|
import java.util.Map;
|
|
import java.util.Stack;
|
|
import java.util.regex.Matcher;
|
|
import java.util.regex.Pattern;
|
|
|
|
import javax.faces.context.FacesContext;
|
|
|
|
import org.alfresco.config.ConfigElement;
|
|
import org.alfresco.config.ConfigService;
|
|
import org.alfresco.config.JNDIConstants;
|
|
import org.alfresco.mbeans.VirtServerRegistry;
|
|
import org.alfresco.repo.avm.AVMNodeConverter;
|
|
import org.alfresco.repo.domain.PropertyValue;
|
|
import org.alfresco.service.ServiceRegistry;
|
|
import org.alfresco.service.cmr.avm.AVMNotFoundException;
|
|
import org.alfresco.service.cmr.avm.AVMService;
|
|
import org.alfresco.service.cmr.repository.NodeRef;
|
|
import org.alfresco.service.cmr.search.ResultSet;
|
|
import org.alfresco.service.cmr.search.SearchService;
|
|
import org.alfresco.service.namespace.QName;
|
|
import org.alfresco.util.VirtServerUtils;
|
|
import org.alfresco.web.app.Application;
|
|
import org.alfresco.web.bean.repository.Repository;
|
|
import org.alfresco.web.config.ClientConfigElement;
|
|
import org.springframework.web.context.WebApplicationContext;
|
|
import org.springframework.web.jsf.FacesContextUtils;
|
|
|
|
|
|
/**
|
|
* Helper methods and constants related to AVM directories, paths and store name manipulation.
|
|
*
|
|
* @author Ariel Backenroth
|
|
* @author Kevin Roast
|
|
*/
|
|
public final class AVMConstants
|
|
{
|
|
/////////////////////////////////////////////////////////////////////////////
|
|
|
|
public static enum PathRelation
|
|
{
|
|
SANDBOX_RELATIVE
|
|
{
|
|
@Override
|
|
protected Pattern pattern()
|
|
{
|
|
return AVMConstants.SANDBOX_RELATIVE_PATH_PATTERN;
|
|
}
|
|
},
|
|
WEBAPP_RELATIVE
|
|
{
|
|
@Override
|
|
protected Pattern pattern()
|
|
{
|
|
return AVMConstants.WEBAPP_RELATIVE_PATH_PATTERN;
|
|
}
|
|
};
|
|
|
|
protected abstract Pattern pattern();
|
|
}
|
|
|
|
/////////////////////////////////////////////////////////////////////////////
|
|
|
|
/**
|
|
* Private constructor
|
|
*/
|
|
private AVMConstants()
|
|
{
|
|
}
|
|
|
|
/**
|
|
* Extracts the store name from the avmpath
|
|
*
|
|
* @param avmPath an absolute avm path
|
|
*
|
|
* @return the store name
|
|
*/
|
|
public static String getStoreName(final String avmPath)
|
|
{
|
|
final int i = avmPath.indexOf(':');
|
|
if (i == -1)
|
|
{
|
|
throw new IllegalArgumentException("path " + avmPath + " does not contain a store");
|
|
}
|
|
return avmPath.substring(0, i);
|
|
}
|
|
|
|
/**
|
|
* Indicates whether the store name describes a preview store.
|
|
*
|
|
* @param storeName the store name
|
|
*
|
|
* @return <tt>true</tt> if the store is a preview store, <tt>false</tt> otherwise.
|
|
*/
|
|
public static boolean isPreviewStore(final String storeName)
|
|
{
|
|
return storeName.endsWith(AVMConstants.STORE_SEPARATOR + AVMConstants.STORE_PREVIEW);
|
|
}
|
|
|
|
/**
|
|
* Indicates whether the store name describes a workflow store.
|
|
*
|
|
* @param storeName the store name
|
|
*
|
|
* @return <tt>true</tt> if the store is a workflow store, <tt>false</tt> otherwise.
|
|
*/
|
|
public static boolean isWorkflowStore(String storeName)
|
|
{
|
|
if (AVMConstants.isPreviewStore(storeName))
|
|
{
|
|
storeName = AVMConstants.getCorrespondingMainStoreName(storeName);
|
|
}
|
|
|
|
return storeName.indexOf(STORE_SEPARATOR + STORE_WORKFLOW) != -1;
|
|
}
|
|
|
|
/**
|
|
* Indicates whether the store name describes a user store.
|
|
*
|
|
* @param storeName the store name
|
|
*
|
|
* @return <tt>true</tt> if the store is a user store, <tt>false</tt> otherwise.
|
|
*/
|
|
public static boolean isUserStore(String storeName)
|
|
{
|
|
if (AVMConstants.isPreviewStore(storeName))
|
|
{
|
|
storeName = AVMConstants.getCorrespondingMainStoreName(storeName);
|
|
}
|
|
return storeName.indexOf(AVMConstants.STORE_SEPARATOR) != -1;
|
|
}
|
|
|
|
/**
|
|
* Extracts the username from the store name.
|
|
*
|
|
* @param storeName the store name
|
|
*
|
|
* @return the username associated or <tt>null</tt> if this is a staging store.
|
|
*/
|
|
public static String getUserName(String storeName)
|
|
{
|
|
if (AVMConstants.isPreviewStore(storeName))
|
|
{
|
|
storeName = AVMConstants.getCorrespondingMainStoreName(storeName);
|
|
}
|
|
final int index = storeName.indexOf(AVMConstants.STORE_SEPARATOR);
|
|
return (index == -1
|
|
? null
|
|
: storeName.substring(index + AVMConstants.STORE_SEPARATOR.length()));
|
|
}
|
|
|
|
/**
|
|
* Extracts the store id from the store name.
|
|
*
|
|
* @param storeName the store name.
|
|
*
|
|
* @return the store id.
|
|
*/
|
|
public static String getStoreId(final String storeName)
|
|
{
|
|
final int index = storeName.indexOf(AVMConstants.STORE_SEPARATOR);
|
|
return (index == -1
|
|
? storeName
|
|
: storeName.substring(0, index));
|
|
}
|
|
|
|
/**
|
|
* Returns the corresponding main store name if this is a preview store name.
|
|
*
|
|
* @param storeName the preview store name.
|
|
*
|
|
* @return the corresponding main store name.
|
|
*
|
|
* @exception IllegalArgumentException if this is not a preview store name.
|
|
*/
|
|
public static String getCorrespondingMainStoreName(final String storeName)
|
|
{
|
|
if (!AVMConstants.isPreviewStore(storeName))
|
|
{
|
|
throw new IllegalArgumentException("store " + storeName + " is not a preview store");
|
|
}
|
|
return storeName.substring(0,
|
|
(storeName.length() -
|
|
(AVMConstants.STORE_SEPARATOR + AVMConstants.STORE_PREVIEW).length()));
|
|
}
|
|
|
|
/**
|
|
* Returns the corresponding preview store name if this is a main store name.
|
|
*
|
|
* @param storeName the main store name.
|
|
*
|
|
* @return the corresponding preview store name.
|
|
*
|
|
* @exception IllegalArgumentException if this is not a main store name.
|
|
*/
|
|
public static String getCorrespondingPreviewStoreName(final String storeName)
|
|
{
|
|
if (AVMConstants.isPreviewStore(storeName))
|
|
{
|
|
throw new IllegalArgumentException("store " + storeName + " is already a preview store");
|
|
}
|
|
return storeName + AVMConstants.STORE_SEPARATOR + AVMConstants.STORE_PREVIEW;
|
|
}
|
|
|
|
/**
|
|
* Returns the corresponding path in the main store name if this is a path in
|
|
* a preview store.
|
|
*
|
|
* @param avmPath an avm path within the main store.
|
|
*
|
|
* @return the corresponding path within the preview store.
|
|
*
|
|
* @exception IllegalArgumentException if this is not a path within the preview store.
|
|
*/
|
|
public static String getCorrespondingPathInMainStore(final String avmPath)
|
|
{
|
|
String storeName = AVMConstants.getStoreName(avmPath);
|
|
storeName = AVMConstants.getCorrespondingMainStoreName(storeName);
|
|
return AVMConstants.getCorrespondingPath(avmPath, storeName);
|
|
}
|
|
|
|
/**
|
|
* Returns the corresponding path in the preview store name if this is a path in
|
|
* a main store.
|
|
*
|
|
* @param avmPath an avm path within the main store.
|
|
*
|
|
* @return the corresponding path within the preview store.
|
|
*
|
|
* @exception IllegalArgumentException if this is not a path within the preview store.
|
|
*/
|
|
public static String getCorrespondingPathInPreviewStore(final String avmPath)
|
|
{
|
|
String storeName = AVMConstants.getStoreName(avmPath);
|
|
storeName = AVMConstants.getCorrespondingPreviewStoreName(storeName);
|
|
return AVMConstants.getCorrespondingPath(avmPath, storeName);
|
|
}
|
|
|
|
/**
|
|
* Returns the corresponding path in the store provided.
|
|
*
|
|
* @param avmPath an avm path
|
|
* @param otherStore the other store to return the corresponding path for
|
|
*
|
|
* @return the corresponding path within the supplied store
|
|
*/
|
|
public static String getCorrespondingPath(final String avmPath, final String otherStore)
|
|
{
|
|
return (otherStore + ':' + AVMConstants.getStoreRelativePath(avmPath));
|
|
}
|
|
|
|
/**
|
|
* Returns the username to connect as on the remote machine being deployed to
|
|
* <p>
|
|
* This value is read from the <wcm> config section in
|
|
* web-client-config-wcm.xml
|
|
* </p>
|
|
*
|
|
* @return Username for remote machine
|
|
*/
|
|
public static String getRemoteDeploymentUsername()
|
|
{
|
|
String username = "admin";
|
|
|
|
ConfigElement deploymentConfig = getDeploymentConfig();
|
|
if (deploymentConfig != null)
|
|
{
|
|
ConfigElement elem = deploymentConfig.getChild("remote-username");
|
|
if (elem != null)
|
|
{
|
|
username = elem.getValue();
|
|
}
|
|
}
|
|
|
|
return username;
|
|
}
|
|
|
|
/**
|
|
* Returns the password to use on the remote machine being deployed to
|
|
* <p>
|
|
* This value is read from the <wcm> config section in
|
|
* web-client-config-wcm.xml
|
|
* </p>
|
|
*
|
|
* @return Password for remote machine
|
|
*/
|
|
public static String getRemoteDeploymentPassword()
|
|
{
|
|
String password = "admin";
|
|
|
|
ConfigElement deploymentConfig = getDeploymentConfig();
|
|
if (deploymentConfig != null)
|
|
{
|
|
ConfigElement elem = deploymentConfig.getChild("remote-password");
|
|
if (elem != null)
|
|
{
|
|
password = elem.getValue();
|
|
}
|
|
}
|
|
|
|
return password;
|
|
}
|
|
|
|
/**
|
|
* Returns the number of seconds between each call back to the server to
|
|
* obtain the latest status of an in progress deployment.
|
|
* <p>
|
|
* This value is read from the <wcm> config section in
|
|
* web-client-config-wcm.xml
|
|
* </p>
|
|
*
|
|
* @return Number of seconds between each call to the server (in seconds).
|
|
* The default is 5.
|
|
*/
|
|
public static int getRemoteDeploymentPollingFrequency()
|
|
{
|
|
int pollFreq = 5;
|
|
|
|
ConfigElement deploymentConfig = getDeploymentConfig();
|
|
if (deploymentConfig != null)
|
|
{
|
|
ConfigElement elem = deploymentConfig.getChild("progress-polling-frequency");
|
|
if (elem != null)
|
|
{
|
|
try
|
|
{
|
|
int value = Integer.parseInt(elem.getValue());
|
|
if (value > 0)
|
|
{
|
|
pollFreq = value;
|
|
}
|
|
}
|
|
catch (NumberFormatException nfe)
|
|
{
|
|
// do nothing, just use the default
|
|
}
|
|
}
|
|
}
|
|
|
|
return pollFreq;
|
|
}
|
|
|
|
/**
|
|
* Returns the default RMI registry port to use when one is not supplied
|
|
* for target deployment servers.
|
|
* <p>
|
|
* This value is read from the <wcm> config section in
|
|
* web-client-config-wcm.xml
|
|
* </p>
|
|
*
|
|
* @return The remote RMI registry port to use for deployments.
|
|
* The default is 50500.
|
|
*/
|
|
public static int getRemoteRMIRegistryPort()
|
|
{
|
|
int rmiPort = 50500;
|
|
|
|
ConfigElement deploymentConfig = getDeploymentConfig();
|
|
if (deploymentConfig != null)
|
|
{
|
|
ConfigElement elem = deploymentConfig.getChild("remote-rmi-port");
|
|
if (elem != null)
|
|
{
|
|
try
|
|
{
|
|
int value = Integer.parseInt(elem.getValue());
|
|
if (value > 0)
|
|
{
|
|
rmiPort = value;
|
|
}
|
|
}
|
|
catch (NumberFormatException nfe)
|
|
{
|
|
// do nothing, just use the default
|
|
}
|
|
}
|
|
}
|
|
|
|
return rmiPort;
|
|
}
|
|
|
|
/**
|
|
* Returns the delay (in seconds) to apply to the start of a deployment
|
|
* operation (mainly for demo and testing purposes).
|
|
* <p>
|
|
* This value is read from the <wcm> config section in
|
|
* web-client-config-wcm.xml
|
|
* </p>
|
|
*
|
|
* @return The delay to use at the start of a deployment.
|
|
* The default is 30.
|
|
*/
|
|
public static int getRemoteDeploymentDelay()
|
|
{
|
|
int delay = 30;
|
|
|
|
ConfigElement deploymentConfig = getDeploymentConfig();
|
|
if (deploymentConfig != null)
|
|
{
|
|
ConfigElement elem = deploymentConfig.getChild("delay");
|
|
if (elem != null)
|
|
{
|
|
try
|
|
{
|
|
int value = Integer.parseInt(elem.getValue());
|
|
if (value > 0)
|
|
{
|
|
delay = value;
|
|
}
|
|
}
|
|
catch (NumberFormatException nfe)
|
|
{
|
|
// do nothing, just use the default
|
|
}
|
|
}
|
|
}
|
|
|
|
return delay;
|
|
}
|
|
|
|
/**
|
|
* Returns the main staging store name for the specified store id.
|
|
*
|
|
* @param storeId store id to build staging store name for
|
|
*
|
|
* @return main staging store name for the specified store id
|
|
*/
|
|
public static String buildStagingStoreName(final String storeId)
|
|
{
|
|
if (storeId == null || storeId.length() == 0)
|
|
{
|
|
throw new IllegalArgumentException("Store id is mandatory.");
|
|
}
|
|
return storeId;
|
|
}
|
|
|
|
/**
|
|
* Returns the preview store name for the specified store id.
|
|
*
|
|
* @param storeId store id to build preview store name for
|
|
*
|
|
* @return preview store name for the specified store id
|
|
*/
|
|
public static String buildStagingPreviewStoreName(final String storeId)
|
|
{
|
|
return (AVMConstants.buildStagingStoreName(storeId) +
|
|
AVMConstants.STORE_SEPARATOR + AVMConstants.STORE_PREVIEW);
|
|
}
|
|
|
|
/**
|
|
* Returns the main store name for a specific username.
|
|
*
|
|
* @param storeId store id to build user store name for
|
|
* @param username of the user to build store name for
|
|
*
|
|
* @return the main store for the specified user and store id
|
|
*/
|
|
public static String buildUserMainStoreName(final String storeId,
|
|
final String username)
|
|
{
|
|
if (username == null || username.length() == 0)
|
|
{
|
|
throw new IllegalArgumentException("Username is mandatory.");
|
|
}
|
|
return (AVMConstants.buildStagingStoreName(storeId) + AVMConstants.STORE_SEPARATOR +
|
|
username);
|
|
}
|
|
|
|
/**
|
|
* Returns the preview store name for a specific username.
|
|
*
|
|
* @param storeId store id to build user preview store name for
|
|
* @param username of the user to build preview store name for
|
|
*
|
|
* @return the preview store for the specified user and store id
|
|
*/
|
|
public static String buildUserPreviewStoreName(final String storeId,
|
|
final String username)
|
|
{
|
|
return (AVMConstants.buildUserMainStoreName(storeId, username) +
|
|
AVMConstants.STORE_SEPARATOR + AVMConstants.STORE_PREVIEW);
|
|
}
|
|
|
|
/**
|
|
* Returns the store name for a specific workflow Id.
|
|
*
|
|
* @param storeId store id to build workflow store name for
|
|
* @param workflowId of the user to build workflow store name for
|
|
*
|
|
* @return the store for the specified workflow and store ids
|
|
*/
|
|
public static String buildWorkflowMainStoreName(final String storeId,
|
|
final String workflowId)
|
|
{
|
|
if (workflowId == null || workflowId.length() == 0)
|
|
{
|
|
throw new IllegalArgumentException("workflowId is mandatory.");
|
|
}
|
|
return (AVMConstants.buildStagingStoreName(storeId) + AVMConstants.STORE_SEPARATOR +
|
|
workflowId);
|
|
}
|
|
|
|
/**
|
|
* Returns the preview store name for a specific workflow Id.
|
|
*
|
|
* @param storeId store id to build preview workflow store name for
|
|
* @param workflowId of the user to build preview workflow store name for
|
|
*
|
|
* @return the store for the specified preview workflow and store ids
|
|
*/
|
|
public static String buildWorkflowPreviewStoreName(final String storeId,
|
|
final String workflowId)
|
|
{
|
|
return (AVMConstants.buildWorkflowMainStoreName(storeId, workflowId) +
|
|
AVMConstants.STORE_SEPARATOR + AVMConstants.STORE_PREVIEW);
|
|
}
|
|
|
|
/**
|
|
* Returns the root path for the specified store name
|
|
*
|
|
* @param storeName store to build root path for
|
|
*
|
|
* @return root path for the specified store name
|
|
*/
|
|
public static String buildStoreRootPath(final String storeName)
|
|
{
|
|
if (storeName == null || storeName.length() == 0)
|
|
{
|
|
throw new IllegalArgumentException("Store name is mandatory.");
|
|
}
|
|
return storeName + ":/" + JNDIConstants.DIR_DEFAULT_WWW;
|
|
}
|
|
|
|
/**
|
|
* Returns the root path for the specified sandbox name
|
|
*
|
|
* @param storeName store to build root sandbox path for
|
|
*
|
|
* @return root sandbox path for the specified store name
|
|
*/
|
|
public static String buildSandboxRootPath(final String storeName)
|
|
{
|
|
return AVMConstants.buildStoreRootPath(storeName) + '/' + JNDIConstants.DIR_DEFAULT_APPBASE;
|
|
}
|
|
|
|
/**
|
|
* Returns the root webapp path for the specified store and webapp name
|
|
*
|
|
* @param storeName store to build root webapp path for
|
|
* @param webapp webapp folder name
|
|
*
|
|
* @return the root webapp path for the specified store and webapp name
|
|
*/
|
|
public static String buildStoreWebappPath(final String storeName, String webapp)
|
|
{
|
|
if (webapp == null || webapp.length() == 0)
|
|
{
|
|
throw new IllegalArgumentException("Webapp name is mandatory.");
|
|
}
|
|
return AVMConstants.buildSandboxRootPath(storeName) + '/' + webapp;
|
|
}
|
|
|
|
public static String buildStoreUrl(String store)
|
|
{
|
|
if (store == null || store.length() == 0)
|
|
{
|
|
throw new IllegalArgumentException("Store name is mandatory.");
|
|
}
|
|
if (store.indexOf(':') != -1)
|
|
{
|
|
store = store.substring(0, store.indexOf(':'));
|
|
}
|
|
ClientConfigElement config = Application.getClientConfig(FacesContext.getCurrentInstance());
|
|
return MessageFormat.format(PREVIEW_SANDBOX_URL,
|
|
lookupStoreDNS(store),
|
|
config.getWCMDomain(),
|
|
config.getWCMPort());
|
|
}
|
|
|
|
public static String buildWebappUrl(final String avmPath)
|
|
{
|
|
if (avmPath == null || avmPath.length() == 0)
|
|
{
|
|
throw new IllegalArgumentException("AVM path is mandatory.");
|
|
}
|
|
return AVMConstants.buildWebappUrl(AVMConstants.getStoreName(avmPath),
|
|
AVMConstants.getWebapp(avmPath));
|
|
}
|
|
|
|
public static String buildWebappUrl(final String store, final String webapp)
|
|
{
|
|
if (webapp == null || webapp.length() == 0)
|
|
{
|
|
throw new IllegalArgumentException("Webapp name is mandatory.");
|
|
}
|
|
return (webapp.equals(DIR_ROOT)
|
|
? buildStoreUrl(store)
|
|
: buildStoreUrl(store) + '/' + webapp);
|
|
}
|
|
|
|
public static String buildAssetUrl(final String avmPath)
|
|
{
|
|
if (avmPath == null || avmPath.length() == 0)
|
|
{
|
|
throw new IllegalArgumentException("AVM path is mandatory.");
|
|
}
|
|
final String[] s = avmPath.split(":");
|
|
if (s.length != 2)
|
|
{
|
|
throw new IllegalArgumentException("expected exactly one ':' in " + avmPath);
|
|
}
|
|
return AVMConstants.buildAssetUrl(s[0], s[1]);
|
|
}
|
|
|
|
public static String buildAssetUrl(String store, String assetPath)
|
|
{
|
|
if (store == null || store.length() == 0)
|
|
{
|
|
throw new IllegalArgumentException("Store name is mandatory.");
|
|
}
|
|
if (assetPath == null || assetPath.length() == 0)
|
|
{
|
|
throw new IllegalArgumentException("Asset path is mandatory.");
|
|
}
|
|
ClientConfigElement config = Application.getClientConfig(FacesContext.getCurrentInstance());
|
|
return buildAssetUrl(assetPath, config.getWCMDomain(), config.getWCMPort(), lookupStoreDNS(store));
|
|
}
|
|
|
|
public static String buildAssetUrl(String assetPath, String domain, String port, String dns)
|
|
{
|
|
if (domain == null || port == null || dns == null)
|
|
{
|
|
throw new IllegalArgumentException("Domain, port and dns name are mandatory.");
|
|
}
|
|
if (assetPath == null || assetPath.length() == 0)
|
|
{
|
|
throw new IllegalArgumentException("Asset path is mandatory.");
|
|
}
|
|
if (assetPath.startsWith('/' + JNDIConstants.DIR_DEFAULT_WWW +
|
|
'/' + JNDIConstants.DIR_DEFAULT_APPBASE))
|
|
{
|
|
assetPath = assetPath.substring(('/' + JNDIConstants.DIR_DEFAULT_WWW +
|
|
'/' + JNDIConstants.DIR_DEFAULT_APPBASE).length());
|
|
}
|
|
if (assetPath.startsWith('/' + DIR_ROOT))
|
|
{
|
|
assetPath = assetPath.substring(('/' + DIR_ROOT).length());
|
|
}
|
|
if (assetPath.length() == 0 || assetPath.charAt(0) != '/')
|
|
{
|
|
assetPath = '/' + assetPath;
|
|
}
|
|
|
|
return MessageFormat.format(PREVIEW_ASSET_URL, dns, domain, port, assetPath);
|
|
}
|
|
|
|
public static String lookupStoreDNS(String store)
|
|
{
|
|
if (store == null || store.length() == 0)
|
|
{
|
|
throw new IllegalArgumentException("Store name is mandatory.");
|
|
}
|
|
|
|
final ServiceRegistry serviceRegistry =
|
|
Repository.getServiceRegistry(FacesContext.getCurrentInstance());
|
|
final AVMService avmService = serviceRegistry.getAVMService();
|
|
final Map<QName, PropertyValue> props =
|
|
avmService.queryStorePropertyKey(store, QName.createQName(null, PROP_DNS + '%'));
|
|
return (props.size() == 1
|
|
? props.keySet().iterator().next().getLocalName().substring(PROP_DNS.length())
|
|
: null);
|
|
}
|
|
|
|
/**
|
|
* Converts the provided path to an absolute path within the avm.
|
|
*
|
|
* @param parentAVMPath used as the parent path if the provided path
|
|
* is relative, otherwise used to extract the parent path portion up until
|
|
* the webapp directory.
|
|
* @param path a path relative to the parentAVMPath path, or if it is
|
|
* absolute, it is relative to the sandbox used in the parentAVMPath.
|
|
*
|
|
* @return an absolute path within the avm using the paths provided.
|
|
*/
|
|
public static String buildPath(final String parentAVMPath,
|
|
final String path,
|
|
final PathRelation relation)
|
|
{
|
|
String parent = parentAVMPath;
|
|
if (path == null || path.length() == 0 || ".".equals(path) || "./".equals(path))
|
|
{
|
|
return parent;
|
|
}
|
|
|
|
if (path.charAt(0) == '/')
|
|
{
|
|
final Matcher m = relation.pattern().matcher(parent);
|
|
if (m.matches())
|
|
{
|
|
parent = m.group(1);
|
|
}
|
|
}
|
|
else if (parent.charAt(parent.length() - 1) != '/')
|
|
{
|
|
parent = parent + '/';
|
|
}
|
|
|
|
return parent + path;
|
|
}
|
|
|
|
/**
|
|
* Returns a path relative to the store portion of the avm path.
|
|
*
|
|
* @param absoluteAVMPath an absolute path within the avm
|
|
* @return the path without the store prefix.
|
|
*/
|
|
public static String getStoreRelativePath(final String absoluteAVMPath)
|
|
{
|
|
final Matcher m = STORE_RELATIVE_PATH_PATTERN.matcher(absoluteAVMPath);
|
|
return m.matches() && m.group(1).length() != 0 ? m.group(1) : null;
|
|
}
|
|
|
|
/**
|
|
* Returns a path relative to the webapp portion of the avm path.
|
|
*
|
|
* @param absoluteAVMPath an absolute path within the avm
|
|
* @return a relative path within the webapp.
|
|
*/
|
|
public static String getWebappRelativePath(final String absoluteAVMPath)
|
|
{
|
|
final Matcher m = WEBAPP_RELATIVE_PATH_PATTERN.matcher(absoluteAVMPath);
|
|
return m.matches() && m.group(3).length() != 0 ? m.group(3) : "/";
|
|
}
|
|
|
|
/**
|
|
* Returns the webapp within the path
|
|
*
|
|
* @param absoluteAVMPath the path from which to extract the webapp name
|
|
*
|
|
* @return an the webapp name contained within the path or <tt>null</tt>.
|
|
*/
|
|
public static String getWebapp(final String absoluteAVMPath)
|
|
{
|
|
final Matcher m = WEBAPP_RELATIVE_PATH_PATTERN.matcher(absoluteAVMPath);
|
|
return m.matches() && m.group(2).length() != 0 ? m.group(2) : null;
|
|
}
|
|
|
|
/**
|
|
* Returns the path portion up the webapp
|
|
*
|
|
* @param absoluteAVMPath the path from which to extract the webapp path
|
|
*
|
|
* @return an absolute avm path to the webapp contained within
|
|
* the path or <tt>null</tt>.
|
|
*/
|
|
public static String getWebappPath(final String absoluteAVMPath)
|
|
{
|
|
final Matcher m = WEBAPP_RELATIVE_PATH_PATTERN.matcher(absoluteAVMPath);
|
|
return m.matches() && m.group(1).length() != 0 ? m.group(1) : null;
|
|
}
|
|
|
|
/**
|
|
* Returns a path relative to the sandbox porition of the avm path.
|
|
*
|
|
* @param absoluteAVMPath an absolute path within the avm
|
|
* @return a relative path within the sandbox.
|
|
*/
|
|
public static String getSandboxRelativePath(final String absoluteAVMPath)
|
|
{
|
|
final Matcher m = SANDBOX_RELATIVE_PATH_PATTERN.matcher(absoluteAVMPath);
|
|
return m.matches() && m.group(2).length() != 0 ? m.group(2) : "/";
|
|
}
|
|
|
|
/**
|
|
* Returns the path portion up the sandbox
|
|
*
|
|
* @param absoluteAVMPath the path from which to extract the sandbox path
|
|
*
|
|
* @return an absolute avm path to the sandbox contained within
|
|
* the path or <tt>null</tt>.
|
|
*/
|
|
public static String getSandboxPath(final String absoluteAVMPath)
|
|
{
|
|
final Matcher m = SANDBOX_RELATIVE_PATH_PATTERN.matcher(absoluteAVMPath);
|
|
return m.matches() && m.group(1).length() != 0 ? m.group(1) : null;
|
|
}
|
|
|
|
/**
|
|
* Returns the NodeRef that represents the given avm path
|
|
*
|
|
* @param absoluteAVMPath The path from which to determine the Web Project
|
|
* @return The NodeRef representing the Web Project the path is from or null
|
|
* if it could not be determined
|
|
*/
|
|
public static NodeRef getWebProjectNodeFromPath(final String absoluteAVMPath)
|
|
{
|
|
String storeName = AVMConstants.getStoreName(absoluteAVMPath);
|
|
String storeId = AVMConstants.getStoreId(storeName);
|
|
return getWebProjectNodeFromStore(storeId);
|
|
}
|
|
|
|
/**
|
|
* Returns the NodeRef that represents the given avm store
|
|
*
|
|
* @param storeName The store name from which to determine the Web Project
|
|
* @return The NodeRef representing the Web Project the store is from or null
|
|
* if it could not be determined
|
|
*/
|
|
public static NodeRef getWebProjectNodeFromStore(final String storeName)
|
|
{
|
|
// get services
|
|
FacesContext fc = FacesContext.getCurrentInstance();
|
|
SearchService searchService = Repository.getServiceRegistry(fc).getSearchService();
|
|
|
|
// construct the query
|
|
String path = Application.getRootPath(fc) + "/" + Application.getWebsitesFolderName(fc) + "/*";
|
|
String query = "PATH:\"/" + path + "\" AND @wca\\:avmstore:\"" + storeName + "\"";
|
|
|
|
NodeRef webProjectNode = null;
|
|
ResultSet results = null;
|
|
try
|
|
{
|
|
// execute the query
|
|
results = searchService.query(Repository.getStoreRef(),
|
|
SearchService.LANGUAGE_LUCENE, query);
|
|
|
|
if (results.length() == 1)
|
|
{
|
|
webProjectNode = results.getNodeRef(0);
|
|
}
|
|
}
|
|
finally
|
|
{
|
|
if (results != null)
|
|
{
|
|
results.close();
|
|
}
|
|
}
|
|
|
|
return webProjectNode;
|
|
}
|
|
|
|
/**
|
|
* Creates all directories for a path if they do not already exist.
|
|
*/
|
|
public static void makeAllDirectories(final String avmDirectoryPath)
|
|
{
|
|
final ServiceRegistry serviceRegistry =
|
|
Repository.getServiceRegistry(FacesContext.getCurrentInstance());
|
|
final AVMService avmService = serviceRegistry.getAVMService();
|
|
// LOGGER.debug("mkdir -p " + avmDirectoryPath);
|
|
String s = avmDirectoryPath;
|
|
final Stack<String[]> dirNames = new Stack<String[]>();
|
|
while (s != null)
|
|
{
|
|
try
|
|
{
|
|
if (avmService.lookup(-1, s) != null)
|
|
{
|
|
// LOGGER.debug("path " + s + " exists");
|
|
break;
|
|
}
|
|
}
|
|
catch (AVMNotFoundException avmfe)
|
|
{
|
|
}
|
|
final String[] sb = AVMNodeConverter.SplitBase(s);
|
|
s = sb[0];
|
|
// LOGGER.debug("pushing " + sb[1]);
|
|
dirNames.push(sb);
|
|
}
|
|
|
|
while (!dirNames.isEmpty())
|
|
{
|
|
final String[] sb = dirNames.pop();
|
|
// LOGGER.debug("creating " + sb[1] + " in " + sb[0]);
|
|
avmService.createDirectory(sb[0], sb[1]);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Update notification on the virtualisation server webapp as required for the specified path
|
|
*
|
|
* @param path Path to match against
|
|
* @param force True to force update of server even if path does not match
|
|
*/
|
|
public static void updateVServerWebapp(String path, boolean force)
|
|
{
|
|
if (force || VirtServerUtils.requiresUpdateNotification(path))
|
|
{
|
|
final int webappIndex = path.indexOf('/',
|
|
path.indexOf(JNDIConstants.DIR_DEFAULT_APPBASE) +
|
|
JNDIConstants.DIR_DEFAULT_APPBASE.length() + 1);
|
|
|
|
if (webappIndex != -1)
|
|
{
|
|
path = path.substring(0, webappIndex);
|
|
}
|
|
final VirtServerRegistry vServerRegistry = AVMConstants.getVirtServerRegistry();
|
|
vServerRegistry.updateAllWebapps(-1, path, true);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Removal notification on the virtualisation server webapp as required for the specified path
|
|
*
|
|
* @param path Path to match against
|
|
* @param force True to force update of server even if path does not match
|
|
*/
|
|
public static void removeVServerWebapp(String path, boolean force)
|
|
{
|
|
if (force || VirtServerUtils.requiresUpdateNotification(path))
|
|
{
|
|
final int webappIndex = path.indexOf('/',
|
|
path.indexOf(JNDIConstants.DIR_DEFAULT_APPBASE) +
|
|
JNDIConstants.DIR_DEFAULT_APPBASE.length() + 1);
|
|
|
|
if (webappIndex != -1)
|
|
{
|
|
path = path.substring(0, webappIndex);
|
|
}
|
|
final VirtServerRegistry vServerRegistry = AVMConstants.getVirtServerRegistry();
|
|
vServerRegistry.removeAllWebapps(-1, path, true);
|
|
}
|
|
}
|
|
|
|
private static VirtServerRegistry getVirtServerRegistry()
|
|
{
|
|
final FacesContext fc = FacesContext.getCurrentInstance();
|
|
final WebApplicationContext ac = FacesContextUtils.getRequiredWebApplicationContext(fc);
|
|
return (VirtServerRegistry)ac.getBean(BEAN_VIRT_SERVER_REGISTRY);
|
|
}
|
|
|
|
private static ConfigElement getDeploymentConfig()
|
|
{
|
|
if (deploymentConfig == null)
|
|
{
|
|
ConfigService cfgService = Application.getConfigService(FacesContext.getCurrentInstance());
|
|
ConfigElement wcmCfg = cfgService.getGlobalConfig().getConfigElement("wcm");
|
|
if (wcmCfg != null)
|
|
{
|
|
deploymentConfig = wcmCfg.getChild("deployment");
|
|
}
|
|
}
|
|
|
|
return deploymentConfig;
|
|
}
|
|
|
|
// Component Separator.
|
|
private static final String STORE_SEPARATOR = "--";
|
|
|
|
// names of the stores representing the layers for an AVM website
|
|
//XXXarielb this should be private
|
|
/*package*/ final static String STORE_WORKFLOW = "workflow";
|
|
private final static String STORE_PREVIEW = "preview";
|
|
|
|
// servlet default webapp
|
|
// Note: this webapp is mapped to the URL path ""
|
|
public final static String DIR_ROOT = "ROOT";
|
|
|
|
// system property keys for sandbox identification and DNS virtualisation mapping
|
|
public final static String PROP_BACKGROUND_LAYER = ".background-layer.";
|
|
public final static String PROP_SANDBOXID = ".sandbox-id.";
|
|
public final static String PROP_DNS = ".dns.";
|
|
public final static String PROP_SANDBOX_STORE_PREFIX = ".sandbox.store.";
|
|
public final static QName PROP_WEB_PROJECT_NODE_REF = QName.createQName(null, ".web_project.noderef");
|
|
public final static QName PROP_SANDBOX_STAGING_MAIN = QName.createQName(null, ".sandbox.staging.main");
|
|
public final static QName PROP_SANDBOX_STAGING_PREVIEW = QName.createQName(null, ".sandbox.staging.preview");
|
|
public final static QName PROP_SANDBOX_AUTHOR_MAIN = QName.createQName(null, ".sandbox.author.main");
|
|
public final static QName PROP_SANDBOX_AUTHOR_PREVIEW = QName.createQName(null, ".sandbox.author.preview");
|
|
public final static QName PROP_SANDBOX_WORKFLOW_MAIN = QName.createQName(null, ".sandbox.workflow.main");
|
|
public final static QName PROP_SANDBOX_WORKFLOW_PREVIEW = QName.createQName(null, ".sandbox.workflow.preview");
|
|
public final static QName PROP_WEBSITE_NAME = QName.createQName(null, ".website.name");
|
|
|
|
public final static String SPACE_ICON_WEBSITE = "space-icon-website";
|
|
|
|
// web user role permissions
|
|
public final static String ROLE_CONTENT_MANAGER = "ContentManager";
|
|
public final static String ROLE_CONTENT_PUBLISHER = "ContentPublisher";
|
|
|
|
// virtualisation server MBean registry
|
|
private static final String BEAN_VIRT_SERVER_REGISTRY = "VirtServerRegistry";
|
|
|
|
// URLs for preview of sandboxes and assets
|
|
private final static String PREVIEW_SANDBOX_URL = "http://{0}.www--sandbox.{1}:{2}";
|
|
private final static String PREVIEW_ASSET_URL = "http://{0}.www--sandbox.{1}:{2}{3}";
|
|
|
|
// pattern for absolute AVM Path
|
|
private final static Pattern STORE_RELATIVE_PATH_PATTERN =
|
|
Pattern.compile("[^:]+:(.+)");
|
|
|
|
private final static Pattern WEBAPP_RELATIVE_PATH_PATTERN =
|
|
Pattern.compile("([^:]+:/" + JNDIConstants.DIR_DEFAULT_WWW +
|
|
"/" + JNDIConstants.DIR_DEFAULT_APPBASE + "/([^/]+))(.*)");
|
|
|
|
private final static Pattern SANDBOX_RELATIVE_PATH_PATTERN =
|
|
Pattern.compile("([^:]+:/" + JNDIConstants.DIR_DEFAULT_WWW +
|
|
"/" + JNDIConstants.DIR_DEFAULT_APPBASE + ")(.*)");
|
|
|
|
private static ConfigElement deploymentConfig = null;
|
|
}
|