mirror of
https://github.com/Alfresco/alfresco-community-repo.git
synced 2025-10-29 15:21:53 +00:00
cefda8c965
git-svn-id: https://svn.alfresco.com/repos/alfresco-enterprise/alfresco/HEAD/root@18931 c4b6b30b-aa2e-2d43-bbcb-ca4b014f7261
246 lines
8.0 KiB
Java
246 lines
8.0 KiB
Java
/*
|
|
* Copyright (C) 2005-2010 Alfresco Software Limited.
|
|
*
|
|
* This file is part of Alfresco
|
|
*
|
|
* 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/>.
|
|
*/
|
|
package org.alfresco.repo.jscript;
|
|
|
|
import java.util.ArrayList;
|
|
import java.util.List;
|
|
|
|
import org.alfresco.config.JNDIConstants;
|
|
import org.alfresco.repo.avm.AVMNodeConverter;
|
|
import org.alfresco.service.ServiceRegistry;
|
|
import org.alfresco.service.cmr.avm.AVMNodeDescriptor;
|
|
import org.alfresco.service.cmr.avm.AVMStoreDescriptor;
|
|
import org.springframework.extensions.surf.util.ParameterCheck;
|
|
import org.alfresco.wcm.asset.AssetInfo;
|
|
import org.alfresco.wcm.sandbox.SandboxService;
|
|
import org.alfresco.wcm.util.WCMUtil;
|
|
import org.mozilla.javascript.Context;
|
|
import org.mozilla.javascript.Scriptable;
|
|
|
|
/**
|
|
* Helper to access AVM nodes from a script context.
|
|
*
|
|
* @author Kevin Roast
|
|
*/
|
|
public final class AVM extends BaseScopableProcessorExtension
|
|
{
|
|
/** Repository Service Registry */
|
|
private ServiceRegistry services;
|
|
|
|
/**
|
|
* Set the service registry
|
|
*
|
|
* @param serviceRegistry the service registry
|
|
*/
|
|
public void setServiceRegistry(ServiceRegistry serviceRegistry)
|
|
{
|
|
this.services = serviceRegistry;
|
|
}
|
|
|
|
/**
|
|
* @return a array of all AVM stores in the system
|
|
*/
|
|
public Scriptable getStores()
|
|
{
|
|
List<AVMStoreDescriptor> stores = this.services.getAVMService().getStores();
|
|
Object[] results = new Object[stores.size()];
|
|
int i=0;
|
|
for (AVMStoreDescriptor store : stores)
|
|
{
|
|
results[i++] = new AVMScriptStore(this.services, store, getScope());
|
|
}
|
|
return Context.getCurrentContext().newArray(getScope(), results);
|
|
}
|
|
|
|
/**
|
|
* Return an AVM store object for the specified store name
|
|
*
|
|
* @param store Store name to lookup
|
|
*
|
|
* @return the AVM store object for the specified store or null if not found
|
|
*/
|
|
public AVMScriptStore lookupStore(String store)
|
|
{
|
|
ParameterCheck.mandatoryString("Store", store);
|
|
AVMScriptStore avmStore = null;
|
|
AVMStoreDescriptor descriptor = this.services.getAVMService().getStore(store);
|
|
if (descriptor != null)
|
|
{
|
|
avmStore = new AVMScriptStore(this.services, descriptor, getScope());
|
|
}
|
|
return avmStore;
|
|
}
|
|
|
|
/**
|
|
* Return an AVM Node representing the public store root folder.
|
|
*
|
|
* @param store Store name to lookup root folder for
|
|
*
|
|
* @return AVM Node representing the public store root folder, or null if not found.
|
|
*/
|
|
public AVMNode lookupStoreRoot(String store)
|
|
{
|
|
AVMNode rootNode = null;
|
|
if (store != null && store.length() != 0)
|
|
{
|
|
String rootPath = store + ':' + getWebappsFolderPath();
|
|
AVMNodeDescriptor nodeDesc = this.services.getAVMService().lookup(-1, rootPath);
|
|
if (nodeDesc != null)
|
|
{
|
|
rootNode = new AVMNode(AVMNodeConverter.ToNodeRef(-1, rootPath), this.services, getScope());
|
|
}
|
|
}
|
|
return rootNode;
|
|
}
|
|
|
|
/**
|
|
* Return an AVM Node for the fully qualified path.
|
|
*
|
|
* @param path Fully qualified path to node to lookup
|
|
*
|
|
* @return AVM Node for the fully qualified path, or null if not found.
|
|
*/
|
|
public AVMNode lookupNode(String path)
|
|
{
|
|
AVMNode node = null;
|
|
if (path != null && path.length() != 0)
|
|
{
|
|
AVMNodeDescriptor nodeDesc = this.services.getAVMService().lookup(-1, path);
|
|
if (nodeDesc != null)
|
|
{
|
|
node = new AVMNode(AVMNodeConverter.ToNodeRef(-1, path), this.services, getScope());
|
|
}
|
|
}
|
|
return node;
|
|
}
|
|
|
|
/**
|
|
* Return the list of modified items for the specified user sandbox against staging store id
|
|
* for a specific webapp.
|
|
*
|
|
* @param storeId Root Store ID
|
|
* @param username Username to get modified items for
|
|
* @param webapp Webapp name to filter by
|
|
*
|
|
* @return List of AVMNode objects representing the modified items
|
|
*/
|
|
public List<AVMNode> getModifiedItems(String storeId, String username, String webapp)
|
|
{
|
|
ParameterCheck.mandatoryString("Store ID", storeId);
|
|
ParameterCheck.mandatoryString("Username", username);
|
|
ParameterCheck.mandatoryString("Webapp", webapp);
|
|
|
|
SandboxService sbService = this.services.getSandboxService();
|
|
|
|
String userStoreId = userSandboxStore(storeId, username);
|
|
|
|
// get modified items - not including deleted
|
|
List<AssetInfo> assets = sbService.listChangedWebApp(userStoreId, webapp, false);
|
|
|
|
List<AVMNode> items = new ArrayList<AVMNode>(assets.size());
|
|
|
|
for (AssetInfo asset : assets)
|
|
{
|
|
// convert each diff/node record into an AVM Node wrapper
|
|
items.add(new AVMNode(asset.getAvmPath(), -1, this.services, getScope()));
|
|
}
|
|
|
|
return items;
|
|
}
|
|
|
|
/**
|
|
* @param storeId Store ID to build staging store name for
|
|
*
|
|
* @return the Staging Store name for the given store ID
|
|
*/
|
|
public static String stagingStore(String storeId)
|
|
{
|
|
return WCMUtil.buildStagingStoreName(storeId);
|
|
}
|
|
|
|
/**
|
|
* @param storeId Store ID to build sandbox store name for
|
|
* @param username Username of the sandbox user
|
|
*
|
|
* @return the Sandbox Store name for the given store ID and username
|
|
*/
|
|
public static String userSandboxStore(String storeId, String username)
|
|
{
|
|
return WCMUtil.buildUserMainStoreName(storeId, username);
|
|
}
|
|
|
|
/**
|
|
* @param storeId Store ID to build preview URL for
|
|
*
|
|
* @return the preview URL to the staging store for the specified store ID
|
|
*/
|
|
public String websiteStagingUrl(String storeId)
|
|
{
|
|
return this.services.getPreviewURIService().getPreviewURI(storeId, null);
|
|
}
|
|
|
|
/**
|
|
* @param storeId Store ID to build preview URL for
|
|
* @param username Username to build sandbox preview URL for
|
|
*
|
|
* @return the preview URL to the user sandbox for the specified store ID and username
|
|
*/
|
|
public String websiteUserSandboxUrl(String storeId, String username)
|
|
{
|
|
ParameterCheck.mandatoryString("Store ID", storeId);
|
|
ParameterCheck.mandatoryString("Username", username);
|
|
return websiteStagingUrl(userSandboxStore(storeId, username));
|
|
}
|
|
|
|
/**
|
|
* @param store Store ID of the asset
|
|
* @param assetPath Store relative path to the asset
|
|
*
|
|
* @return the preview URL to the specified store asset
|
|
*/
|
|
public String assetUrl(String storeId, String assetPath)
|
|
{
|
|
return this.services.getPreviewURIService().getPreviewURI(storeId, assetPath);
|
|
}
|
|
|
|
/**
|
|
* @param avmPath Fully qualified AVM path of the asset
|
|
*
|
|
* @return the preview URL to the specified asset
|
|
*/
|
|
public String assetUrl(String avmPath)
|
|
{
|
|
ParameterCheck.mandatoryString("AVM Path", avmPath);
|
|
String[] s = avmPath.split(":");
|
|
if (s.length != 2)
|
|
{
|
|
throw new IllegalArgumentException("Expected exactly one ':' in " + avmPath);
|
|
}
|
|
return assetUrl(s[0], s[1]);
|
|
}
|
|
|
|
/**
|
|
* @return the path to the webapps folder in a standard web store.
|
|
*/
|
|
public static String getWebappsFolderPath()
|
|
{
|
|
return JNDIConstants.DIR_DEFAULT_WWW_APPBASE;
|
|
}
|
|
}
|