2016-10-07 10:44:31 +02:00
|
|
|
package org.gcube.portlets.widgets.ckandatapublisherwidget.server.utils;
|
|
|
|
|
|
|
|
import java.util.ArrayList;
|
2016-11-11 19:31:05 +01:00
|
|
|
import java.util.Arrays;
|
2016-10-07 10:44:31 +02:00
|
|
|
import java.util.List;
|
|
|
|
import java.util.Map;
|
|
|
|
|
|
|
|
import org.gcube.common.homelibrary.home.HomeLibrary;
|
2016-11-09 19:13:39 +01:00
|
|
|
import org.gcube.common.homelibrary.home.exceptions.InternalErrorException;
|
2016-10-07 10:44:31 +02:00
|
|
|
import org.gcube.common.homelibrary.home.workspace.Workspace;
|
|
|
|
import org.gcube.common.homelibrary.home.workspace.WorkspaceFolder;
|
|
|
|
import org.gcube.common.homelibrary.home.workspace.WorkspaceItem;
|
|
|
|
import org.gcube.common.homelibrary.home.workspace.catalogue.WorkspaceCatalogue;
|
|
|
|
import org.gcube.common.homelibrary.home.workspace.folder.FolderItem;
|
|
|
|
import org.gcube.datacatalogue.ckanutillibrary.models.ResourceBean;
|
|
|
|
import org.gcube.portlets.widgets.ckandatapublisherwidget.shared.DatasetMetadataBean;
|
2016-11-09 19:13:39 +01:00
|
|
|
import org.gcube.portlets.widgets.ckandatapublisherwidget.shared.ResourceElementBean;
|
2016-10-07 10:44:31 +02:00
|
|
|
import org.slf4j.LoggerFactory;
|
|
|
|
|
|
|
|
public class WorkspaceUtils {
|
|
|
|
|
2016-11-11 19:31:05 +01:00
|
|
|
|
2016-10-07 10:44:31 +02:00
|
|
|
private static final org.slf4j.Logger logger = LoggerFactory.getLogger(WorkspaceUtils.class);
|
2016-11-11 19:31:05 +01:00
|
|
|
private static final String RESOURCES_NAME_SEPARATOR = "_";
|
2016-10-07 10:44:31 +02:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Copy into the .catalogue area folder the checked resources
|
|
|
|
* @param folderId
|
|
|
|
* @param userName
|
|
|
|
* @param bean
|
|
|
|
* @return
|
|
|
|
*/
|
2016-11-11 19:31:05 +01:00
|
|
|
public static List<ResourceBean> copyResourcesToUserCatalogueArea(String folderId, String userName, DatasetMetadataBean bean) throws Exception{
|
2016-10-07 10:44:31 +02:00
|
|
|
|
|
|
|
logger.debug("Request to copy onto catalogue area....");
|
|
|
|
List<ResourceBean> resources = new ArrayList<ResourceBean>();
|
|
|
|
WorkspaceItem copiedFolder = null;
|
|
|
|
WorkspaceCatalogue userCatalogue = null;
|
2016-11-11 19:31:05 +01:00
|
|
|
List<ResourceElementBean> resourcesToAdd = bean.getResources();
|
2016-10-07 10:44:31 +02:00
|
|
|
|
|
|
|
// in to the .catalogue area of the user's workspace
|
|
|
|
Workspace ws = HomeLibrary
|
|
|
|
.getHomeManagerFactory()
|
|
|
|
.getHomeManager()
|
2016-11-09 19:13:39 +01:00
|
|
|
.getHome()
|
2016-10-07 10:44:31 +02:00
|
|
|
.getWorkspace();
|
|
|
|
|
|
|
|
// Retrieve the catalogue of the user
|
|
|
|
userCatalogue = ws.getCatalogue();
|
|
|
|
|
|
|
|
// Create the folder in the catalogue
|
|
|
|
copiedFolder = userCatalogue.addWorkspaceItem(folderId, userCatalogue.getId()); // add to .catalogue root area
|
|
|
|
|
|
|
|
// change description for the folder
|
|
|
|
copiedFolder.setDescription(bean.getDescription());
|
|
|
|
|
|
|
|
// change name of the copied folder to match the title (append the timestamp to avoid ties)
|
|
|
|
((WorkspaceFolder)copiedFolder).rename(org.gcube.datacatalogue.ckanutillibrary.utils.UtilMethods.fromProductTitleToName(bean.getTitle()) + "_" + System.currentTimeMillis());
|
|
|
|
|
|
|
|
// copy only the selected ones
|
2016-11-11 19:31:05 +01:00
|
|
|
for(ResourceElementBean resource : resourcesToAdd){
|
2016-10-07 10:44:31 +02:00
|
|
|
|
2016-11-11 19:31:05 +01:00
|
|
|
if (resource.isToBeAdded()) {
|
2016-10-07 10:44:31 +02:00
|
|
|
|
|
|
|
// ok it is a file, so copy it into the copiedFolder
|
2016-11-11 19:31:05 +01:00
|
|
|
WorkspaceItem copiedFile = userCatalogue.addWorkspaceItem(resource.getOriginalIdInWorkspace(), copiedFolder.getId());
|
2016-10-07 10:44:31 +02:00
|
|
|
|
|
|
|
// name and description could have been edited
|
2016-11-11 19:31:05 +01:00
|
|
|
copiedFile.setDescription(resource.getDescription());
|
2016-10-07 10:44:31 +02:00
|
|
|
|
|
|
|
resources.add(new ResourceBean(
|
|
|
|
copiedFile.getPublicLink(true),
|
2016-11-11 19:31:05 +01:00
|
|
|
resource.getName(),
|
2016-10-07 10:44:31 +02:00
|
|
|
copiedFile.getDescription(),
|
|
|
|
copiedFile.getId(),
|
|
|
|
userName,
|
|
|
|
null, // to be set
|
|
|
|
((FolderItem)copiedFile).getMimeType()));
|
|
|
|
|
|
|
|
// postpone rename operation
|
2016-11-11 19:31:05 +01:00
|
|
|
copiedFile.rename(resource.getName() + "_" + System.currentTimeMillis());
|
2016-10-07 10:44:31 +02:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
// return
|
|
|
|
return resources;
|
|
|
|
}
|
2016-10-07 12:49:37 +02:00
|
|
|
|
2016-10-07 10:44:31 +02:00
|
|
|
/**
|
|
|
|
* This method receives a folder id within the user's workspace and set the list of resources in the dataset bean to be returned
|
|
|
|
* @param folderId
|
|
|
|
* @param owner
|
|
|
|
* @param bean
|
|
|
|
* @param userName
|
|
|
|
* @throws Exception
|
|
|
|
*/
|
|
|
|
public static void handleWorkspaceResources(String folderId, String userName,
|
|
|
|
DatasetMetadataBean bean) throws Exception {
|
|
|
|
|
|
|
|
// get workspace
|
|
|
|
Workspace ws = HomeLibrary
|
|
|
|
.getHomeManagerFactory()
|
|
|
|
.getHomeManager()
|
2016-11-08 15:17:41 +01:00
|
|
|
.getHome().getWorkspace();
|
2016-10-07 10:44:31 +02:00
|
|
|
|
|
|
|
WorkspaceItem originalFolder = ws.getItem(folderId);
|
|
|
|
|
|
|
|
// set some info
|
2016-11-08 15:17:41 +01:00
|
|
|
String onlyAlphanumericTitle = originalFolder.getName().replaceAll("[^A-Za-z0-9.-_]", " "); // that is, remove characters different than the ones inside
|
2016-11-09 19:13:39 +01:00
|
|
|
// since it will (likely) be the name of the product
|
2016-11-08 15:17:41 +01:00
|
|
|
bean.setTitle(onlyAlphanumericTitle);
|
2016-10-07 10:44:31 +02:00
|
|
|
bean.setDescription(originalFolder.getDescription());
|
|
|
|
|
|
|
|
// Create the folder in the catalogue
|
|
|
|
Map<String, String> folderItems = Utils.getGcubeItemProperties(originalFolder);
|
|
|
|
bean.setCustomFields(folderItems);
|
|
|
|
|
2016-10-07 12:49:37 +02:00
|
|
|
// set them into the bean
|
2016-11-11 19:31:05 +01:00
|
|
|
bean.setResources(Arrays.asList(WorkspaceUtils.getTreeFromFolder(folderId, ws)));
|
2016-10-07 10:44:31 +02:00
|
|
|
|
|
|
|
}
|
2016-10-07 12:49:37 +02:00
|
|
|
|
2016-10-07 12:21:04 +02:00
|
|
|
/**
|
2016-11-09 19:13:39 +01:00
|
|
|
* Returns a tree object
|
|
|
|
* @param workspaceFolderId
|
2016-10-07 12:21:04 +02:00
|
|
|
* @param ws
|
2016-11-09 19:13:39 +01:00
|
|
|
* @return ResourceElementBean a tree object
|
|
|
|
* @throws Exception
|
2016-10-07 12:21:04 +02:00
|
|
|
*/
|
2016-11-09 19:13:39 +01:00
|
|
|
public static ResourceElementBean getTreeFromFolder(String workspaceFolderId, Workspace ws) throws Exception{
|
|
|
|
|
|
|
|
// start tree construction
|
|
|
|
ResourceElementBean rootElem = new ResourceElementBean();
|
2016-11-11 19:31:05 +01:00
|
|
|
String pathSeparator = ws.getPathSeparator();
|
2016-11-09 19:13:39 +01:00
|
|
|
try{
|
|
|
|
WorkspaceItem initialItemWS = ws.getItem(workspaceFolderId);
|
|
|
|
String fullPathBase = initialItemWS.getPath();
|
2016-11-11 19:31:05 +01:00
|
|
|
fullPathBase = fullPathBase.endsWith(ws.getPathSeparator()) ? fullPathBase : fullPathBase + ws.getPathSeparator();
|
|
|
|
rootElem.setFolder(initialItemWS.isFolder());
|
|
|
|
rootElem.setFullPath(initialItemWS.getPath().replace(fullPathBase, ""));
|
|
|
|
rootElem.setParent(null);
|
|
|
|
rootElem.setName(initialItemWS.getName());
|
|
|
|
rootElem.setOriginalIdInWorkspace(initialItemWS.getId());
|
|
|
|
replaceFullPath(rootElem, pathSeparator);
|
2016-11-09 19:13:39 +01:00
|
|
|
// start visiting
|
2016-11-11 19:31:05 +01:00
|
|
|
visit(rootElem, initialItemWS, fullPathBase, pathSeparator);
|
2016-11-09 19:13:39 +01:00
|
|
|
}catch(Exception e){
|
|
|
|
logger.error("Failed to build the resource tree", e);
|
|
|
|
return null;
|
2016-10-07 12:49:37 +02:00
|
|
|
}
|
2016-11-11 19:31:05 +01:00
|
|
|
return rootElem;
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Replaces the "/" char with a custom one
|
|
|
|
* @param rootElem
|
|
|
|
* @param pathSeparatorInWs
|
|
|
|
*/
|
|
|
|
private static void replaceFullPath(ResourceElementBean rootElem, String pathSeparatorInWs) {
|
|
|
|
|
|
|
|
if(rootElem == null)
|
|
|
|
return;
|
|
|
|
|
|
|
|
String elemName = rootElem.getName();
|
|
|
|
int lastIndex = rootElem.getFullPath().lastIndexOf(elemName);
|
|
|
|
String fullPath = rootElem.getFullPath().substring(0, lastIndex);
|
|
|
|
fullPath = fullPath.replaceAll(pathSeparatorInWs, RESOURCES_NAME_SEPARATOR) + elemName;
|
|
|
|
rootElem.setFullPath(fullPath);
|
2016-10-07 12:21:04 +02:00
|
|
|
}
|
|
|
|
|
2016-11-09 19:13:39 +01:00
|
|
|
/**
|
|
|
|
* Recursive visit of a workspace item
|
|
|
|
* @param rootElem
|
|
|
|
* @param initialItemWS
|
|
|
|
* @throws InternalErrorException
|
|
|
|
*/
|
2016-11-11 19:31:05 +01:00
|
|
|
private static void visit(ResourceElementBean rootElem, WorkspaceItem initialItemWS, String fullPathBase, String pathSeparator) throws InternalErrorException {
|
2016-11-09 19:13:39 +01:00
|
|
|
List<? extends WorkspaceItem> children = initialItemWS.getChildren();
|
|
|
|
ArrayList<ResourceElementBean> childrenInTree = new ArrayList<ResourceElementBean>(children.size());
|
|
|
|
for (WorkspaceItem workspaceItem : children) {
|
|
|
|
ResourceElementBean elem = new ResourceElementBean();
|
|
|
|
elem.setFolder(workspaceItem.isFolder());
|
|
|
|
elem.setOriginalIdInWorkspace(workspaceItem.getId());
|
2016-11-11 19:31:05 +01:00
|
|
|
elem.setFullPath(workspaceItem.getPath().replace(fullPathBase, ""));
|
2016-11-09 19:13:39 +01:00
|
|
|
elem.setParent(rootElem);
|
|
|
|
elem.setName(workspaceItem.getName());
|
2016-11-11 19:31:05 +01:00
|
|
|
replaceFullPath(elem, pathSeparator);
|
2016-11-09 19:13:39 +01:00
|
|
|
childrenInTree.add(elem);
|
2016-11-11 19:31:05 +01:00
|
|
|
visit(elem, workspaceItem, fullPathBase, pathSeparator);
|
2016-11-09 19:13:39 +01:00
|
|
|
}
|
|
|
|
rootElem.setChildren(childrenInTree);
|
|
|
|
}
|
2016-10-07 10:44:31 +02:00
|
|
|
|
|
|
|
}
|