543 lines
19 KiB
Java
543 lines
19 KiB
Java
package org.gcube.portlets.widgets.ckandatapublisherwidget.server;
|
|
|
|
import java.util.ArrayList;
|
|
import java.util.Arrays;
|
|
import java.util.Calendar;
|
|
import java.util.List;
|
|
import java.util.Map;
|
|
import java.util.concurrent.ConcurrentHashMap;
|
|
|
|
import javax.servlet.http.HttpSession;
|
|
|
|
import org.gcube.datacatalogue.ckanutillibrary.DataCatalogue;
|
|
import org.gcube.datacatalogue.ckanutillibrary.DataCatalogueFactory;
|
|
import org.gcube.datacatalogue.ckanutillibrary.models.ResourceBean;
|
|
import org.gcube.datacatalogue.ckanutillibrary.utils.SessionCatalogueAttributes;
|
|
import org.gcube.datacatalogue.ckanutillibrary.utils.UtilMethods;
|
|
import org.gcube.portlets.widgets.ckandatapublisherwidget.client.CKanPublisherService;
|
|
import org.gcube.portlets.widgets.ckandatapublisherwidget.server.threads.AssociationToGroupAndNotifyThread;
|
|
import org.gcube.portlets.widgets.ckandatapublisherwidget.server.threads.WritePostCatalogueManagerThread;
|
|
import org.gcube.portlets.widgets.ckandatapublisherwidget.server.utils.Utils;
|
|
import org.gcube.portlets.widgets.ckandatapublisherwidget.server.utils.WorkspaceUtils;
|
|
import org.gcube.portlets.widgets.ckandatapublisherwidget.shared.DatasetMetadataBean;
|
|
import org.gcube.portlets.widgets.ckandatapublisherwidget.shared.GroupBean;
|
|
import org.gcube.portlets.widgets.ckandatapublisherwidget.shared.LicensesBean;
|
|
import org.gcube.portlets.widgets.ckandatapublisherwidget.shared.MetaDataProfileBean;
|
|
import org.gcube.portlets.widgets.ckandatapublisherwidget.shared.OrganizationBean;
|
|
import org.gcube.portlets.widgets.ckandatapublisherwidget.shared.ResourceElementBean;
|
|
import org.gcube.vomanagement.usermanagement.UserManager;
|
|
import org.gcube.vomanagement.usermanagement.exception.GroupRetrievalFault;
|
|
import org.gcube.vomanagement.usermanagement.exception.UserManagementSystemException;
|
|
import org.gcube.vomanagement.usermanagement.impl.LiferayUserManager;
|
|
import org.gcube.vomanagement.usermanagement.model.GCubeUser;
|
|
import org.slf4j.LoggerFactory;
|
|
|
|
import com.google.gwt.user.server.rpc.RemoteServiceServlet;
|
|
import com.liferay.portal.service.UserLocalServiceUtil;
|
|
|
|
import eu.trentorise.opendata.jackan.model.CkanGroup;
|
|
import eu.trentorise.opendata.jackan.model.CkanLicense;
|
|
|
|
/**
|
|
* Server side of the data publisher.
|
|
* @author Costantino Perciante at ISTI-CNR (costantino.perciante@isti.cnr.it)
|
|
*/
|
|
public class CKANPublisherServicesImpl extends RemoteServiceServlet implements CKanPublisherService{
|
|
|
|
private static final long serialVersionUID = 7252248774050361697L;
|
|
|
|
// Logger
|
|
private static final org.slf4j.Logger logger = LoggerFactory.getLogger(CKANPublisherServicesImpl.class);
|
|
|
|
// map <orgName, scope>
|
|
private ConcurrentHashMap<String, String> mapOrganizationScope = new ConcurrentHashMap<String, String>();
|
|
|
|
/**
|
|
* Retrieve an instance of the library for the scope
|
|
* @param scope if it is null it is evaluated from the session
|
|
* @return
|
|
*/
|
|
public DataCatalogue getCatalogue(String scope){
|
|
|
|
DataCatalogue instance = null;
|
|
String scopeInWhichDiscover = null;
|
|
try{
|
|
scopeInWhichDiscover = (scope != null && !scope.isEmpty()) ? scope : Utils.getCurrentContext(getThreadLocalRequest(), false);
|
|
logger.debug("Discovering ckan instance into scope " + scopeInWhichDiscover);
|
|
instance = DataCatalogueFactory.getFactory().getUtilsPerScope(scopeInWhichDiscover);
|
|
}catch(Exception e){
|
|
logger.warn("Unable to retrieve ckan utils in scope " + scopeInWhichDiscover + ". Error is " + e.getLocalizedMessage());
|
|
}
|
|
return instance;
|
|
}
|
|
|
|
/**
|
|
* Retrieve the list of organizations in which the user can publish (roles ADMIN)
|
|
* @param username
|
|
* @return the list of organizations
|
|
* @throws GroupRetrievalFault
|
|
* @throws UserManagementSystemException
|
|
*/
|
|
private List<OrganizationBean> getUserOrganizationsListAdmin(String username, String scope) throws UserManagementSystemException, GroupRetrievalFault {
|
|
|
|
logger.debug("Request for user " + username + " organizations list");
|
|
List<OrganizationBean> orgsName = new ArrayList<OrganizationBean>();
|
|
|
|
HttpSession httpSession = getThreadLocalRequest().getSession();
|
|
String keyPerScope = UtilMethods.concatenateSessionKeyScope(SessionCatalogueAttributes.CKAN_ORGANIZATIONS_PUBLISH_KEY, scope);
|
|
|
|
if(httpSession.getAttribute(keyPerScope) != null){
|
|
orgsName = (List<OrganizationBean>)httpSession.getAttribute(keyPerScope);
|
|
logger.info("List of organizations was into session " + orgsName);
|
|
}
|
|
else{
|
|
orgsName = Utils.getUserOrganizationsListAdminEditor(scope, username, Utils.getGroupFromScope(scope).getGroupName(), this);
|
|
httpSession.setAttribute(keyPerScope, orgsName);
|
|
logger.info("Organizations name for user " + username + " has been saved into session " + orgsName);
|
|
}
|
|
|
|
return orgsName;
|
|
}
|
|
|
|
/**
|
|
* Online or in development mode?
|
|
* @return true if you're running into the portal, false if in development
|
|
*/
|
|
private boolean isWithinPortal() {
|
|
try {
|
|
UserLocalServiceUtil.getService();
|
|
return true;
|
|
}
|
|
catch (com.liferay.portal.kernel.bean.BeanLocatorException ex) {
|
|
logger.trace("Development Mode ON");
|
|
return false;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Find a license id given the license text.
|
|
* @param chosenLicense
|
|
* @return
|
|
*/
|
|
private String findLicenseIdByLicense(String chosenLicense) {
|
|
|
|
// get scope from client url
|
|
String scope = Utils.getScopeFromClientUrl(getThreadLocalRequest());
|
|
return getCatalogue(scope).findLicenseIdByLicenseTitle(chosenLicense);
|
|
|
|
}
|
|
|
|
@Override
|
|
public LicensesBean getLicenses() {
|
|
|
|
// get http session
|
|
HttpSession httpSession = getThreadLocalRequest().getSession();
|
|
String scope = Utils.getScopeFromClientUrl(getThreadLocalRequest());
|
|
logger.info("Request for CKAN licenses for scope " + scope);
|
|
String keyPerScope = UtilMethods.concatenateSessionKeyScope(SessionCatalogueAttributes.CKAN_LICENSES_KEY, scope);
|
|
|
|
LicensesBean licensesBean = null;
|
|
if(httpSession.getAttribute(keyPerScope) != null){
|
|
licensesBean = (LicensesBean)httpSession.getAttribute(keyPerScope);
|
|
logger.info("List of licenses was into session");
|
|
}
|
|
else{
|
|
List<CkanLicense> titlesLicenses = getCatalogue(scope).getLicenses();
|
|
List<String> titles = new ArrayList<String>();
|
|
List<String> urls = new ArrayList<String>();
|
|
for (CkanLicense license : titlesLicenses) {
|
|
titles.add(license.getTitle());
|
|
String url = (license.getUrl() != null && !license.getUrl().isEmpty()) ? license.getUrl() : "";
|
|
urls.add(url);
|
|
}
|
|
licensesBean = new LicensesBean(titles, urls);
|
|
httpSession.setAttribute(keyPerScope, licensesBean);
|
|
logger.info("List of licenses has been saved into session");
|
|
}
|
|
|
|
return licensesBean;
|
|
|
|
}
|
|
|
|
@Override
|
|
public DatasetMetadataBean getDatasetBean(String folderId){
|
|
|
|
DatasetMetadataBean bean = null;
|
|
String userName = Utils.getCurrentUser(getThreadLocalRequest()).getUsername();
|
|
|
|
logger.info("DatasetBean request for " + folderId + " and " + userName);
|
|
|
|
if(isWithinPortal()){
|
|
try{
|
|
|
|
String scope = Utils.getScopeFromClientUrl(getThreadLocalRequest());
|
|
|
|
logger.debug("Scope recovered from session is " + scope);
|
|
|
|
logger.debug("Request dataset metadata bean for folder with id " + folderId
|
|
+ " whose owner is " + userName);
|
|
|
|
UserManager liferUserManager = new LiferayUserManager();
|
|
GCubeUser userOwner = liferUserManager.getUserByUsername(userName);
|
|
|
|
// build bean
|
|
logger.debug("Building bean");
|
|
bean = new DatasetMetadataBean();
|
|
|
|
bean.setId(folderId);
|
|
bean.setOwnerIdentifier(userName);
|
|
bean.setVersion(1);
|
|
bean.setAuthorName(userOwner.getFirstName());
|
|
bean.setAuthorSurname(userOwner.getLastName());
|
|
bean.setAuthorEmail(userOwner.getEmail());
|
|
bean.setMaintainer(userOwner.getFullname());
|
|
bean.setMaintainerEmail(userOwner.getEmail());
|
|
bean.setOrganizationList(getUserOrganizationsListAdmin(userName, scope));
|
|
|
|
// if the request comes from the workspace
|
|
if(folderId != null && !folderId.isEmpty()){
|
|
WorkspaceUtils.handleWorkspaceResources(folderId, userName, bean);
|
|
}
|
|
|
|
}catch(Exception e){
|
|
logger.error("Error while retrieving folder information", e);
|
|
}
|
|
}else{
|
|
|
|
try{
|
|
bean = new DatasetMetadataBean();
|
|
bean.setId(folderId);
|
|
bean.setDescription("This is a fantastic description");
|
|
bean.setVersion(1);
|
|
String onlyAlphanumeric = "test-creation-blablabla".replaceAll("[^A-Za-z0-9]", "");
|
|
bean.setTitle(onlyAlphanumeric + Calendar.getInstance().getTimeInMillis());
|
|
bean.setAuthorName("Costantino");
|
|
bean.setAuthorSurname("Perciante");
|
|
bean.setAuthorEmail("costantino.perciante@isti.cnr.it");
|
|
bean.setMaintainer("Costantino Perciante");
|
|
bean.setMaintainerEmail("costantino.perciante@isti.cnr.it");
|
|
bean.setOrganizationList(getUserOrganizationsListAdmin(userName, Utils.getCurrentContext(getThreadLocalRequest(), true)));
|
|
bean.setOwnerIdentifier(userName);
|
|
|
|
if(folderId != null && !folderId.isEmpty()){
|
|
WorkspaceUtils.handleWorkspaceResources(folderId, userName, bean);
|
|
}
|
|
}catch(Exception e){
|
|
logger.error("Error while building bean into dev mode", e);
|
|
}
|
|
}
|
|
|
|
return bean;
|
|
}
|
|
|
|
@Override
|
|
public DatasetMetadataBean createCKanDataset(DatasetMetadataBean toCreate) {
|
|
|
|
logger.debug("Request for creating a dataset with these information " + toCreate);
|
|
|
|
String userName = Utils.getCurrentUser(getThreadLocalRequest()).getUsername();
|
|
|
|
try{
|
|
|
|
String title = toCreate.getTitle();
|
|
String organizationNameOrId = toCreate.getSelectedOrganization();
|
|
String author = toCreate.getAuthorFullName();
|
|
String authorMail = toCreate.getAuthorEmail();
|
|
String maintainer = toCreate.getMaintainer();
|
|
String maintainerMail = toCreate.getMaintainerEmail();
|
|
long version = toCreate.getVersion();
|
|
String description = toCreate.getDescription();
|
|
String chosenLicense = toCreate.getLicense();
|
|
String licenseId = findLicenseIdByLicense(chosenLicense);
|
|
List<String> listOfTags = toCreate.getTags();
|
|
Map<String, String> customFields = toCreate.getCustomFields();
|
|
boolean setPublic = toCreate.getVisibility();
|
|
|
|
// get the list of resources and convert to ResourceBean
|
|
List<ResourceBean> resources = null;
|
|
List<ResourceElementBean> resourcesToAdd = toCreate.getResources();
|
|
|
|
// we need to copy such resource in the .catalogue area of the user's ws
|
|
if(resourcesToAdd != null && !resourcesToAdd.isEmpty()){
|
|
resources = WorkspaceUtils.copyResourcesToUserCatalogueArea(toCreate.getId(), userName, toCreate);
|
|
}
|
|
|
|
logger.debug("The user wants to publish in organization with name " + organizationNameOrId);
|
|
String scope = getScopeFromOrgName(organizationNameOrId);
|
|
DataCatalogue utils = getCatalogue(scope);
|
|
String userApiKey = utils.getApiKeyFromUsername(userName);
|
|
|
|
String datasetId = utils.createCKanDataset(userApiKey, title, null, organizationNameOrId, author,
|
|
authorMail, maintainer, maintainerMail, version, description, licenseId,
|
|
listOfTags, customFields, resources, setPublic);
|
|
|
|
if(datasetId != null){
|
|
|
|
logger.info("Dataset created!");
|
|
toCreate.setId(datasetId);
|
|
|
|
// retrieve the url
|
|
String datasetUrl = utils.getUrlFromDatasetIdOrName(datasetId);
|
|
toCreate.setSource(datasetUrl);
|
|
|
|
// start a thread that will associate this dataset with the group
|
|
if(toCreate.getChosenProfile() != null || toCreate.getGroups() != null){
|
|
|
|
AssociationToGroupAndNotifyThread threadAssociationToGroup =
|
|
new AssociationToGroupAndNotifyThread(
|
|
toCreate.getGroups(),
|
|
toCreate.getChosenProfile(),
|
|
datasetUrl,
|
|
datasetId,
|
|
toCreate.getTitle(),
|
|
Utils.getCurrentUser(getThreadLocalRequest()).getFullname(),
|
|
userName,
|
|
utils,
|
|
organizationNameOrId,
|
|
getThreadLocalRequest()
|
|
);
|
|
threadAssociationToGroup.start();
|
|
|
|
}
|
|
|
|
// launch notification thread
|
|
WritePostCatalogueManagerThread threadWritePost =
|
|
new WritePostCatalogueManagerThread(
|
|
userName,
|
|
scope,
|
|
toCreate.getTitle(),
|
|
datasetUrl,
|
|
false, // send notification to other people
|
|
toCreate.getTags(),
|
|
Utils.getCurrentUser(getThreadLocalRequest()).getFullname()
|
|
);
|
|
threadWritePost.start();
|
|
|
|
return toCreate;
|
|
}else{
|
|
logger.error("Failed to create the dataset");
|
|
}
|
|
}catch(Exception e){
|
|
logger.error("Unable to create the dataset", e);
|
|
}
|
|
return null;
|
|
}
|
|
|
|
@Override
|
|
public ResourceElementBean addResourceToDataset(ResourceElementBean resource, String datasetId) {
|
|
String username = Utils.getCurrentUser(getThreadLocalRequest()).getUsername();
|
|
|
|
logger.debug("Incoming request for creating new resource for dataset with id " + datasetId + " and organization name of the dataset is " + resource.getOrganizationNameDatasetParent());
|
|
logger.debug("Owner is " + username + " and resource is " + resource);
|
|
|
|
if(!isWithinPortal()){
|
|
|
|
logger.warn("Running outside the portal");
|
|
return resource;
|
|
|
|
}else{
|
|
|
|
try{
|
|
ResourceBean resourceBean = new ResourceBean(
|
|
resource.getUrl(),
|
|
resource.getName(),
|
|
resource.getDescription(),
|
|
null,
|
|
username,
|
|
datasetId,
|
|
null);
|
|
|
|
// get the scope in which we should discover the ckan instance given the organization name in which the dataset was created
|
|
String scope = getScopeFromOrgName(resource.getOrganizationNameDatasetParent());
|
|
DataCatalogue catalogue = getCatalogue(scope);
|
|
String resourceId = catalogue.addResourceToDataset(resourceBean, catalogue.getApiKeyFromUsername(username));
|
|
|
|
if(resourceId != null){
|
|
logger.debug("Resource " + resource.getName() + " is now available");
|
|
// set its id and turn it to the client
|
|
resource.setOriginalIdInWorkspace(resourceId);
|
|
return resource;
|
|
}
|
|
}catch(Exception e){
|
|
logger.error("Unable to create new resource", e);
|
|
}
|
|
|
|
logger.debug("No resource created");
|
|
return null;
|
|
}
|
|
}
|
|
|
|
@Override
|
|
public boolean deleteResourceFromDataset(ResourceElementBean resource) {
|
|
|
|
logger.debug("Request for deleting resource " + resource);
|
|
boolean deleted = false;
|
|
|
|
if(!isWithinPortal()){
|
|
logger.warn("Running outside the portal");
|
|
return deleted;
|
|
}else{
|
|
|
|
String username = Utils.getCurrentUser(getThreadLocalRequest()).getUsername();
|
|
try{
|
|
// get the scope in which we should discover the ckan instance given the organization name in which the dataset was created
|
|
String scope = getScopeFromOrgName(resource.getOrganizationNameDatasetParent());
|
|
DataCatalogue catalogue = getCatalogue(scope);
|
|
deleted = catalogue.
|
|
deleteResourceFromDataset(resource.getOriginalIdInWorkspace(), catalogue.getApiKeyFromUsername(username));
|
|
if(deleted){
|
|
logger.info("Resource described by " + resource + " deleted");
|
|
}else
|
|
logger.error("Resource described by " + resource + " NOT deleted");
|
|
}catch(Exception e){
|
|
logger.error("Error while trying to delete resource described by " + resource, e);
|
|
}
|
|
return deleted;
|
|
|
|
}
|
|
}
|
|
|
|
@Override
|
|
public List<MetaDataProfileBean> getProfiles(String orgName) {
|
|
|
|
logger.debug("Requested profiles for products into orgName " + orgName);
|
|
List<MetaDataProfileBean> toReturn = new ArrayList<MetaDataProfileBean>();
|
|
try{
|
|
String evaluatedScope = getScopeFromOrgName(orgName);
|
|
logger.debug("Evaluated scope is " + evaluatedScope);
|
|
toReturn = Utils.getMetadataProfilesList(evaluatedScope, getThreadLocalRequest());
|
|
}catch(Exception e){
|
|
logger.error("Failed to retrieve profiles for scope coming from organization name " + orgName, e);
|
|
}
|
|
|
|
return toReturn;
|
|
}
|
|
|
|
@Override
|
|
public boolean datasetIdAlreadyExists(String title) {
|
|
|
|
if(title == null || title.isEmpty())
|
|
return true; // it's an error somehow
|
|
try{
|
|
String scope = Utils.getScopeFromClientUrl(getThreadLocalRequest());
|
|
String idFromTitle = org.gcube.datacatalogue.ckanutillibrary.utils.UtilMethods.fromProductTitleToName(title);
|
|
return getCatalogue(scope).existProductWithNameOrId(idFromTitle);
|
|
}catch(Exception e){
|
|
logger.error("Unable to check if such a dataset id already exists", e);
|
|
}
|
|
return false;
|
|
}
|
|
|
|
/**
|
|
* The method tries to retrieve the scope related to the organization using the map first,
|
|
* if no match is found, it retrieves such information by using liferay
|
|
*/
|
|
private String getScopeFromOrgName(String orgName){
|
|
|
|
logger.debug("Request for scope related to orgName " + orgName + "[ map that will be used is " + mapOrganizationScope.toString() + " ]");
|
|
if(orgName == null || orgName.isEmpty())
|
|
throw new IllegalArgumentException("orgName cannot be empty or null!");
|
|
|
|
String toReturn = null;
|
|
|
|
if(mapOrganizationScope.containsKey(orgName))
|
|
toReturn = mapOrganizationScope.get(orgName);
|
|
else{
|
|
try{
|
|
String evaluatedScope = Utils.retrieveScopeFromOrganizationName(orgName);
|
|
mapOrganizationScope.put(orgName, evaluatedScope);
|
|
toReturn = evaluatedScope;
|
|
}catch(Exception e){
|
|
logger.error("Failed to retrieve scope from OrgName for organization " + orgName, e);
|
|
}
|
|
}
|
|
logger.debug("Returning scope " + toReturn);
|
|
return toReturn;
|
|
}
|
|
|
|
// @Override
|
|
// public ResourceElementBean getTreeFolder(String folderId) {
|
|
//
|
|
// if(folderId == null || folderId.isEmpty()){
|
|
// logger.warn("Empty folder id or null, returning");
|
|
// return null;
|
|
// }
|
|
// ASLSession session = getASLSession();
|
|
// try{
|
|
// if(!isWithinPortal()){
|
|
// logger.warn("Running outside the portal");
|
|
// Workspace ws = getFakeWS();
|
|
// ResourceElementBean toReturn = WorkspaceUtils.getTreeFromFolder(folderId, ws);
|
|
// logger.debug("Returning " + toReturn);
|
|
// return toReturn;
|
|
// }else{
|
|
// if(session.getUsername().equals(TEST_USER)){
|
|
// return null;
|
|
// }else{
|
|
// // TODO
|
|
// return null;
|
|
// }
|
|
// }
|
|
// }catch(Exception e){
|
|
// logger.error("Failed to build the tree", e);
|
|
// }
|
|
// return null;
|
|
// }
|
|
//
|
|
// /**
|
|
// * Retrieve the workspace for the development user
|
|
// * @return
|
|
// * @throws Exception
|
|
// */
|
|
// private Workspace getFakeWS() throws Exception{
|
|
// return HomeLibrary
|
|
// .getHomeManagerFactory()
|
|
// .getHomeManager()
|
|
// .getHome(getDevelopmentUser()).getWorkspace();
|
|
// }
|
|
|
|
@Override
|
|
public List<GroupBean> getUserGroups() {
|
|
|
|
List<GroupBean> toReturn = new ArrayList<GroupBean>();
|
|
|
|
if(isWithinPortal()){
|
|
String username = Utils.getCurrentUser(getThreadLocalRequest()).getUsername();
|
|
|
|
logger.debug("Request for user " + username + " groups");
|
|
|
|
// get http session
|
|
HttpSession httpSession = getThreadLocalRequest().getSession();
|
|
String scope = Utils.getScopeFromClientUrl(getThreadLocalRequest());
|
|
|
|
// check if they are in session
|
|
String keyPerScopeGroups = UtilMethods.concatenateSessionKeyScope(SessionCatalogueAttributes.CKAN_GROUPS_MEMBER, scope);
|
|
|
|
if(httpSession.getAttribute(keyPerScopeGroups) != null){
|
|
toReturn = (List<GroupBean>)httpSession.getAttribute(keyPerScopeGroups);
|
|
logger.info("Found user's groups in session " + toReturn);
|
|
}else{
|
|
|
|
DataCatalogue catalogue = getCatalogue(scope);
|
|
List<CkanGroup> ckanGroups = catalogue.getGroups();
|
|
|
|
String apiKey = catalogue.getApiKeyFromUsername(username);
|
|
|
|
// Members/Admin of the group
|
|
for (CkanGroup ckanGroup : ckanGroups) {
|
|
String role = catalogue.getRoleOfUserInGroup(username, ckanGroup.getName(), apiKey);
|
|
if(role == null)
|
|
continue;
|
|
|
|
toReturn.add(new GroupBean(ckanGroup.getTitle(), ckanGroup.getName()));
|
|
}
|
|
|
|
httpSession.setAttribute(keyPerScopeGroups, toReturn);
|
|
}
|
|
}else{
|
|
logger.warn("Dev mode detected");
|
|
toReturn = Arrays.asList(new GroupBean("Group title", "aaa"));
|
|
}
|
|
return toReturn;
|
|
}
|
|
} |