gCubeSystem
/
social-networking-library-ws
14
1
Fork 0
Code Issues Pull Requests Releases 3 Wiki Activity

code format and organize imports

This commit is contained in:
Alfredo Oliviero 2024-09-02 16:46:48 +02:00
parent 97eae29a93
commit 858eb45b27
48 changed files with 1781 additions and 1739 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
src/main/java/org/gcube/portal/social/networking/caches/CachesManager.java
View File

@ -5,6 +5,7 @@ import net.sf.ehcache.Ehcache;
/**
* Handle caches via Ehcache
*
* @author Costantino Perciante at ISTI-CNR (costantino.perciante@isti.cnr.it)
*/
public class CachesManager {
@ -12,16 +13,17 @@ public class CachesManager {
private static CacheManager cacheManager;
public static final CachesManager singleton = new CachesManager();
// the following caches are declared within the ehcache.xml (no default is available)
// the following caches are declared within the ehcache.xml (no default is
// available)
public static final String SOCIAL_NETWORKING_SITES_CACHE = "social_networking_site_cache";
public static final String USERS_CACHE = "users_cache";
public static final String GROUPS_CACHE = "groups_cache";
private CachesManager(){
private CachesManager() {
cacheManager = CacheManager.newInstance();
}
public static Ehcache getCache(String name){
public static Ehcache getCache(String name) {
return cacheManager.getEhcache(name);
}

11
src/main/java/org/gcube/portal/social/networking/caches/GroupsCache.java
View File

@ -12,9 +12,10 @@ public class GroupsCache {
/**
* Private constructor: build the cache
*
* @return
*/
private GroupsCache(){
private GroupsCache() {
logger.debug("Building cache");
CachesManager.getCache(CachesManager.GROUPS_CACHE);
@ -30,12 +31,13 @@ public class GroupsCache {
/**
* Retrieve an entry
*
* @param groupId
* @return user associated to the user
*/
public GCubeGroup getGroup(long groupId){
public GCubeGroup getGroup(long groupId) {
Ehcache groupsCache = CachesManager.getCache(CachesManager.GROUPS_CACHE);
if(groupsCache.get(groupId) != null)
if (groupsCache.get(groupId) != null)
return (GCubeGroup) groupsCache.get(groupId).getObjectValue();
else
return null;
@ -43,10 +45,11 @@ public class GroupsCache {
/**
* Save an entry into the cache
*
* @param id
* @param group
*/
public void pushEntry(long id, GCubeGroup group){
public void pushEntry(long id, GCubeGroup group) {
Ehcache groupsCache = CachesManager.getCache(CachesManager.GROUPS_CACHE);
groupsCache.put(new Element(id, group));
}

97
src/main/java/org/gcube/portal/social/networking/caches/SocialNetworkingSiteFinder.java
View File

@ -25,9 +25,12 @@ import org.gcube.vomanagement.usermanagement.model.VirtualGroup;
import org.slf4j.LoggerFactory;
/**
* When a notification needs to be sent, this class offers utility to discover (starting from the scope)
* the site information needed to build up the SocialNetworkingSite object (which, for instance, contains the
* When a notification needs to be sent, this class offers utility to discover
* (starting from the scope)
* the site information needed to build up the SocialNetworkingSite object
* (which, for instance, contains the
* portal email).
*
* @author Costantino Perciante at ISTI-CNR (costantino.perciante@isti.cnr.it)
*/
public class SocialNetworkingSiteFinder {
@ -51,10 +54,10 @@ public class SocialNetworkingSiteFinder {
/**
* Build the singleton instance
*/
private SocialNetworkingSiteFinder(){
private SocialNetworkingSiteFinder() {
// read fallback properties
try{
try {
logger.debug("Trying to read config.properties");
ClassLoader classLoader = Thread.currentThread().getContextClassLoader();
InputStream input = classLoader.getResourceAsStream("config.properties");
@ -63,7 +66,7 @@ public class SocialNetworkingSiteFinder {
PROD_FALLBACK_GATEWAY = properties.getProperty("PROD_FALLBACK_GATEWAY");
DEV_FALLBACK_GATEWAY = properties.getProperty("DEV_FALLBACK_GATEWAY");
PREPROD_FALLBACK_GATEWAY = properties.getProperty("PREPROD_FALLBACK_GATEWAY");
}catch(Exception e){
} catch (Exception e) {
logger.warn("Failed to read config.properties...", e);
}
@ -72,7 +75,7 @@ public class SocialNetworkingSiteFinder {
/**
* Retrieve the singleton instance
*/
public static SocialNetworkingSiteFinder getInstance(){
public static SocialNetworkingSiteFinder getInstance() {
return singleton;
@ -80,21 +83,22 @@ public class SocialNetworkingSiteFinder {
/**
* Retrieve the SocialNetworkingSite given the scope
*
* @param scope
* @return
* @return
*/
public static SocialNetworkingSite getSocialNetworkingSiteFromScope(String scope){
Ehcache socialSitesCache = CachesManager.getCache(CachesManager.SOCIAL_NETWORKING_SITES_CACHE);
public static SocialNetworkingSite getSocialNetworkingSiteFromScope(String scope) {
if(scope == null || scope.isEmpty())
Ehcache socialSitesCache = CachesManager.getCache(CachesManager.SOCIAL_NETWORKING_SITES_CACHE);
if (scope == null || scope.isEmpty())
throw new IllegalArgumentException("Scope cannot be null/empty");
if(socialSitesCache != null && socialSitesCache.get(scope) != null)
if (socialSitesCache != null && socialSitesCache.get(scope) != null)
return (SocialNetworkingSite) socialSitesCache.get(scope).getObjectValue();
else{
else {
SocialNetworkingSite site = discoverSite(scope);
if(socialSitesCache != null && site != null)
if (socialSitesCache != null && site != null)
socialSitesCache.put(new Element(scope, site));
return site;
}
@ -103,12 +107,13 @@ public class SocialNetworkingSiteFinder {
/**
* Discover the site for this scope
*
* @param scope
* @return
*/
private static SocialNetworkingSite discoverSite(String scope) {
try{
try {
logger.info("Requested site for scope " + scope);
GroupManager groupManager = GroupManagerWSBuilder.getInstance().getGroupManager();
@ -116,30 +121,31 @@ public class SocialNetworkingSiteFinder {
GCubeGroup matchingGateway = null;
if(groupManager.isVRE(groupId)){
if (groupManager.isVRE(groupId)) {
// get the Virtual groups for the groupid related to the scope
List<VirtualGroup> virtualGroupsOfGroup = groupManager.getVirtualGroups(groupId);
if(virtualGroupsOfGroup == null || virtualGroupsOfGroup.isEmpty())
if (virtualGroupsOfGroup == null || virtualGroupsOfGroup.isEmpty())
throw new Exception("It seems that the VRE is not linked to any VirtualGroups");
// get the gateways
List<GCubeGroup> gateways = groupManager.getGateways();
if(gateways == null || gateways.isEmpty())
if (gateways == null || gateways.isEmpty())
throw new Exception("It seems there is no gateway here!");
logger.info("Retrieved Gateways are " + gateways);
// now, retrieve the virtual groups for each gateway and stop when a VG matches with one of the group
// now, retrieve the virtual groups for each gateway and stop when a VG matches
// with one of the group
// then, it is the gateway of interest
ext_loop: for (GCubeGroup gateway : gateways) {
List<VirtualGroup> gatewayVirtualGroups = groupManager.getVirtualGroups(gateway.getGroupId());
if(gatewayVirtualGroups != null && !gatewayVirtualGroups.isEmpty()){
if (gatewayVirtualGroups != null && !gatewayVirtualGroups.isEmpty()) {
for (VirtualGroup gatewayVirtualGroup : gatewayVirtualGroups) {
if(virtualGroupsOfGroup.contains(gatewayVirtualGroup)){
if (virtualGroupsOfGroup.contains(gatewayVirtualGroup)) {
logger.debug("Matching gateway for scope " + scope + " is " + gateway);
matchingGateway = gateway;
break ext_loop;
@ -148,36 +154,37 @@ public class SocialNetworkingSiteFinder {
}
}
}else{
} else {
List<GCubeGroup> gateways = groupManager.getGateways();
// vo and root vo cases are treated separately: in production environment services.d4science.org is used, instead
// vo and root vo cases are treated separately: in production environment
// services.d4science.org is used, instead
// in dev next.d4science.org is used TODO better way...
ApplicationContext ctx = ContextProvider.get(); // get this info from SmartGears
String rootContext = "/"+ctx.container().configuration().infrastructure();
String rootContext = "/" + ctx.container().configuration().infrastructure();
String matchingGatewayName = null;
if(isDevOrPreprod(rootContext)){
if (isDevOrPreprod(rootContext)) {
matchingGatewayName = DEV_FALLBACK_GATEWAY;
}else{
} else {
matchingGatewayName = PROD_FALLBACK_GATEWAY;
}
// find the matching one among the gateways
for (GCubeGroup gateway : gateways) {
if(gateway.getGroupName().equals(matchingGatewayName)){
if (gateway.getGroupName().equals(matchingGatewayName)) {
matchingGateway = gateway;
break;
}
}
if(matchingGateway == null && isDevOrPreprod(rootContext)){
if (matchingGateway == null && isDevOrPreprod(rootContext)) {
logger.warn("Checking if it is the preprod environment");
matchingGatewayName = PREPROD_FALLBACK_GATEWAY;
// find the matching one among the gateways
for (GCubeGroup gateway : gateways) {
if(gateway.getGroupName().equals(matchingGatewayName)){
if (gateway.getGroupName().equals(matchingGatewayName)) {
matchingGateway = gateway;
break;
}
@ -187,21 +194,26 @@ public class SocialNetworkingSiteFinder {
}
if(matchingGateway == null){
if (matchingGateway == null) {
logger.warn("There is no gateway for such scope. Returning null");
return null;
}else{
} else {
String siteName = matchingGateway.getGroupName();
String emailSender = (String)groupManager.readCustomAttr(matchingGateway.getGroupId(), EMAIL_SENDER_SITE_CUSTOM_FIELD);
emailSender = emailSender.replace("\"", ""); //this is because otherwise it would contains double quotes and postfix would use it as first part before @ e.g. senderEmail="aginfra@d4science.org"@d4science.org
String emailSender = (String) groupManager.readCustomAttr(matchingGateway.getGroupId(),
EMAIL_SENDER_SITE_CUSTOM_FIELD);
emailSender = emailSender.replace("\"", ""); // this is because otherwise it would contains double
// quotes and postfix would use it as first part before
// @ e.g.
// senderEmail="aginfra@d4science.org"@d4science.org
String siteLandingPagePath = GCubePortalConstants.PREFIX_GROUP_URL + matchingGateway.getFriendlyURL();
String siteUrl = discoverHostOfServiceEndpoint(siteName);
SocialNetworkingSite site = new SocialNetworkingSite(siteName, emailSender, siteUrl, siteLandingPagePath);
SocialNetworkingSite site = new SocialNetworkingSite(siteName, emailSender, siteUrl,
siteLandingPagePath);
logger.info("Site is " + site);
return site;
}
}catch(Exception e){
} catch (Exception e) {
logger.error("Failed to determine the SocialNetworkingSite for scope " + scope, e);
}
@ -214,20 +226,21 @@ public class SocialNetworkingSiteFinder {
/**
* Retrieve endpoint host from IS for this gateway
*
* @return the host for the gateway
* @throws Exception
*/
private static String discoverHostOfServiceEndpoint(String gatewayName){
private static String discoverHostOfServiceEndpoint(String gatewayName) {
String currentScope = ScopeProvider.instance.get();
ApplicationContext ctx = ContextProvider.get(); // get this info from SmartGears
ScopeProvider.instance.set("/"+ctx.container().configuration().infrastructure());
ScopeProvider.instance.set("/" + ctx.container().configuration().infrastructure());
String host = null;
try{
try {
SimpleQuery query = queryFor(ServiceEndpoint.class);
query.addCondition("$resource/Profile/Name/text() eq '"+ gatewayName +"'");
query.addCondition("$resource/Profile/Category/text() eq '"+ CATEGORY +"'");
query.addCondition("$resource/Profile/Name/text() eq '" + gatewayName + "'");
query.addCondition("$resource/Profile/Category/text() eq '" + CATEGORY + "'");
DiscoveryClient<ServiceEndpoint> client = clientFor(ServiceEndpoint.class);
List<ServiceEndpoint> toReturn = client.submit(query);
for (ServiceEndpoint serviceEndpoint : toReturn) {
@ -236,9 +249,9 @@ public class SocialNetworkingSiteFinder {
break;
}
}catch(Exception e){
} catch (Exception e) {
logger.error("Error while retrieving host for the gateway " + gatewayName);
}finally{
} finally {
ScopeProvider.instance.set(currentScope);
}

32
src/main/java/org/gcube/portal/social/networking/caches/UsersCache.java
View File

@ -2,9 +2,6 @@ package org.gcube.portal.social.networking.caches;
import java.util.List;
import net.sf.ehcache.Ehcache;
import net.sf.ehcache.Element;
import org.gcube.portal.social.networking.liferay.ws.GroupManagerWSBuilder;
import org.gcube.portal.social.networking.liferay.ws.UserManagerWSBuilder;
import org.gcube.smartgears.ContextProvider;
@ -14,35 +11,42 @@ import org.gcube.vomanagement.usermanagement.UserManager;
import org.gcube.vomanagement.usermanagement.model.GCubeUser;
import org.slf4j.LoggerFactory;
import net.sf.ehcache.Ehcache;
import net.sf.ehcache.Element;
/**
* This cache will store GCubeUser of the users of the infrastructure as couples {user-id, user screename}
* This cache will store GCubeUser of the users of the infrastructure as couples
* {user-id, user screename}
*
* @author Costantino Perciante at ISTI-CNR (costantino.perciante@isti.cnr.it)
*/
public class UsersCache{
public class UsersCache {
private static final org.slf4j.Logger logger = LoggerFactory.getLogger(UsersCache.class);
private static UsersCache singleton = new UsersCache();
/**
* Private constructor: build the cache
*
* @return
*/
private UsersCache(){
private UsersCache() {
// create a thread to build the cache
new Thread(){
new Thread() {
public void run() {
try{
try {
logger.debug("Fetching users and putting them into cache");
Ehcache usersCache = CachesManager.getCache(CachesManager.USERS_CACHE);
GroupManager groupManager = GroupManagerWSBuilder.getInstance().getGroupManager();
UserManager userManager = UserManagerWSBuilder.getInstance().getUserManager();
ApplicationContext ctx = ContextProvider.get(); // get this info from SmartGears
List<GCubeUser> users = userManager.listUsersByGroup(groupManager.getGroupIdFromInfrastructureScope("/"+ctx.container().configuration().infrastructure()));
List<GCubeUser> users = userManager.listUsersByGroup(groupManager
.getGroupIdFromInfrastructureScope("/" + ctx.container().configuration().infrastructure()));
for (GCubeUser gCubeUser : users) {
usersCache.put(new Element(gCubeUser.getUserId(), gCubeUser));
}
}catch(Exception e){
} catch (Exception e) {
logger.error("Unable to retrieve user's usernames. Other users will be discovered later on", e);
}
}
@ -59,12 +63,13 @@ public class UsersCache{
/**
* Retrieve an entry
*
* @param userId
* @return user associated to the user
*/
public GCubeUser getUser(long userId){
public GCubeUser getUser(long userId) {
Ehcache usersCache = CachesManager.getCache(CachesManager.USERS_CACHE);
if(usersCache.get(userId) != null)
if (usersCache.get(userId) != null)
return (GCubeUser) usersCache.get(userId).getObjectValue();
else
return null;
@ -72,10 +77,11 @@ public class UsersCache{
/**
* Save an entry into the cache
*
* @param id
* @param user
*/
public void pushEntry(long id, GCubeUser user){
public void pushEntry(long id, GCubeUser user) {
Ehcache usersCache = CachesManager.getCache(CachesManager.USERS_CACHE);
usersCache.put(new Element(id, user));
}

26
src/main/java/org/gcube/portal/social/networking/liferay/ws/GroupManagerWSBuilder.java
View File

@ -7,26 +7,27 @@ import org.slf4j.LoggerFactory;
/**
* Class that builds a (singleton) GroupManagerWS object.
*
* @author Costantino Perciante at ISTI-CNR (costantino.perciante@isti.cnr.it)
*/
public class GroupManagerWSBuilder {
private static final Logger logger = LoggerFactory.getLogger(GroupManagerWSBuilder.class);
private static GroupManagerWSBuilder singleton = new GroupManagerWSBuilder();
private static GroupManager groupManagerWs;
private GroupManagerWSBuilder(){
private GroupManagerWSBuilder() {
logger.debug("Building GroupManager please wait");
try{
try {
groupManagerWs = new LiferayWSGroupManager(
LiferayJSONWsCredentials.getSingleton().getUser(),
LiferayJSONWsCredentials.getSingleton().getPassword(),
LiferayJSONWsCredentials.getSingleton().getHost(),
LiferayJSONWsCredentials.getSingleton().getSchema(),
LiferayJSONWsCredentials.getSingleton().getUser(),
LiferayJSONWsCredentials.getSingleton().getPassword(),
LiferayJSONWsCredentials.getSingleton().getHost(),
LiferayJSONWsCredentials.getSingleton().getSchema(),
LiferayJSONWsCredentials.getSingleton().getPort());
}catch(Exception e){
} catch (Exception e) {
logger.error("Failed to build the GroupManager. ", e);
return;
}
@ -34,16 +35,17 @@ public class GroupManagerWSBuilder {
logger.debug("GroupManager instance built");
}
/**
* Get the user manager instance
*
* @return
*/
public GroupManager getGroupManager(){
public GroupManager getGroupManager() {
return groupManagerWs;
}
public static GroupManagerWSBuilder getInstance(){
public static GroupManagerWSBuilder getInstance() {
return singleton;
}

51
src/main/java/org/gcube/portal/social/networking/liferay/ws/KeycloakAPICredentials.java
View File

@ -5,12 +5,10 @@ import static org.gcube.resources.discovery.icclient.ICFactory.queryFor;
import java.util.Iterator;
import java.util.List;
import java.util.Map;
import org.gcube.common.encryption.encrypter.StringEncrypter;
import org.gcube.common.resources.gcore.ServiceEndpoint;
import org.gcube.common.resources.gcore.ServiceEndpoint.AccessPoint;
import org.gcube.common.resources.gcore.ServiceEndpoint.Property;
import org.gcube.common.scope.api.ScopeProvider;
import org.gcube.resources.discovery.client.api.DiscoveryClient;
import org.gcube.resources.discovery.client.queries.api.SimpleQuery;
@ -19,8 +17,6 @@ import org.gcube.smartgears.context.application.ApplicationContext;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
public class KeycloakAPICredentials {
private static final Logger logger = LoggerFactory.getLogger(KeycloakAPICredentials.class);
@ -34,7 +30,6 @@ public class KeycloakAPICredentials {
private String clientid;
private String password;
// Service endpoint properties
private final static String RUNTIME_RESOURCE_NAME = "IAM";
private final static String CATEGORY = "Service";
@ -58,37 +53,39 @@ public class KeycloakAPICredentials {
String oldContext = ScopeProvider.instance.get();
ApplicationContext ctx = ContextProvider.get(); // get this info from SmartGears
ScopeProvider.instance.set("/"+ctx.container().configuration().infrastructure());
logger.debug("Discovering liferay user's credentials in context " + ctx.container().configuration().infrastructure());
ScopeProvider.instance.set("/" + ctx.container().configuration().infrastructure());
logger.debug("Discovering liferay user's credentials in context "
+ ctx.container().configuration().infrastructure());
try{
try {
List<ServiceEndpoint> resources = getConfigurationFromIS();
if (resources.size() == 0){
logger.error("There is no Runtime Resource having name " + RUNTIME_RESOURCE_NAME +" and Category " + CATEGORY + " in this scope.");
throw new Exception("There is no Runtime Resource having name " + RUNTIME_RESOURCE_NAME +" and Category " + CATEGORY + " in this scope.");
}
else {
if (resources.size() == 0) {
logger.error("There is no Runtime Resource having name " + RUNTIME_RESOURCE_NAME + " and Category "
+ CATEGORY + " in this scope.");
throw new Exception("There is no Runtime Resource having name " + RUNTIME_RESOURCE_NAME
+ " and Category " + CATEGORY + " in this scope.");
} else {
for (ServiceEndpoint res : resources) {
Iterator<AccessPoint> accessPointIterator = res.profile().accessPoints().iterator();
while (accessPointIterator.hasNext()) {
ServiceEndpoint.AccessPoint accessPoint = (ServiceEndpoint.AccessPoint) accessPointIterator
.next();
if(accessPoint.name().equals("d4science")){
if (accessPoint.name().equals("d4science")) {
keycloakURL = accessPoint.address();
realm = accessPoint.name();
clientid = accessPoint.username();
clientid = accessPoint.username();
password = StringEncrypter.getEncrypter().decrypt(accessPoint.password());
logger.info("Found accesspoint URL = " + keycloakURL);
}
}
}
}
}catch(Exception e){
} catch (Exception e) {
logger.error("Unable to retrieve such service endpoint information!", e);
return;
}finally{
if(oldContext != null)
} finally {
if (oldContext != null)
ScopeProvider.instance.set(oldContext);
}
@ -97,39 +94,40 @@ public class KeycloakAPICredentials {
/**
* Retrieve endpoints information from IS for DB
*
* @return list of endpoints for ckan database
* @throws Exception
*/
private List<ServiceEndpoint> getConfigurationFromIS() throws Exception{
private List<ServiceEndpoint> getConfigurationFromIS() throws Exception {
SimpleQuery query = queryFor(ServiceEndpoint.class);
query.addCondition("$resource/Profile/Name/text() eq '"+ RUNTIME_RESOURCE_NAME +"'");
query.addCondition("$resource/Profile/Category/text() eq '"+ CATEGORY +"'");
query.addCondition("$resource/Profile/Name/text() eq '" + RUNTIME_RESOURCE_NAME + "'");
query.addCondition("$resource/Profile/Category/text() eq '" + CATEGORY + "'");
DiscoveryClient<ServiceEndpoint> client = clientFor(ServiceEndpoint.class);
List<ServiceEndpoint> toReturn = client.submit(query);
return toReturn;
}
public static KeycloakAPICredentials getSingleton() {
public static KeycloakAPICredentials getSingleton() {
if (singleton == null)
singleton = new KeycloakAPICredentials();
return singleton;
}
public String getServerURL() {
public String getServerURL() {
return keycloakURL;
}
public String getClientid() {
public String getClientid() {
return clientid;
}
public String getPassword() {
public String getPassword() {
return password;
}
public String getRealm() {
public String getRealm() {
return realm;
}
@ -138,6 +136,5 @@ public class KeycloakAPICredentials {
return "KeycloakAPICredentials [keycloakURL=" + keycloakURL + ", realm=" + realm + ", clientid=" + clientid
+ ", password=**************]";
}
}

66
src/main/java/org/gcube/portal/social/networking/liferay/ws/LiferayJSONWsCredentials.java
View File

@ -19,12 +19,11 @@ import org.gcube.smartgears.context.application.ApplicationContext;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
* This is a singleton bean instantiated at service start up. It contains
* the credentials of the user who is allowed to perform calls to Liferay.
* Its credentials are looked up from the infrastructure.
*
* @author Costantino Perciante at ISTI-CNR (costantino.perciante@isti.cnr.it)
*/
public class LiferayJSONWsCredentials {
@ -41,8 +40,9 @@ public class LiferayJSONWsCredentials {
private String password;
private int port;
// The token of the user used to send notifications/messages when an application token is provided. (will be read from web.xml)
private String notifierUserToken;
// The token of the user used to send notifications/messages when an application
// token is provided. (will be read from web.xml)
private String notifierUserToken;
// Service endpoint properties
private final static String RUNTIME_RESOURCE_NAME = "D4Science Infrastructure Gateway";
@ -62,10 +62,10 @@ public class LiferayJSONWsCredentials {
* Load the token of the notifier user
*/
private void loadNotifierToken() {
try{
try {
notifierUserToken = ServletContextClass.getNotifierToken();
logger.debug("Token read " + notifierUserToken.substring(0, 5)+ "*********************");
}catch(Exception e){
logger.debug("Token read " + notifierUserToken.substring(0, 5) + "*********************");
} catch (Exception e) {
logger.error("Failed to read notifier user token!", e);
}
}
@ -79,29 +79,32 @@ public class LiferayJSONWsCredentials {
String oldContext = ScopeProvider.instance.get();
ApplicationContext ctx = ContextProvider.get(); // get this info from SmartGears
ScopeProvider.instance.set("/"+ctx.container().configuration().infrastructure());
logger.info("Discovering liferay user's credentials in context " + ctx.container().configuration().infrastructure());
ScopeProvider.instance.set("/" + ctx.container().configuration().infrastructure());
logger.info("Discovering liferay user's credentials in context "
+ ctx.container().configuration().infrastructure());
try{
try {
List<ServiceEndpoint> resources = getConfigurationFromIS();
if (resources.size() == 0){
logger.error("There is no Runtime Resource having name " + RUNTIME_RESOURCE_NAME +" and Category " + CATEGORY + " in this scope.");
throw new Exception("There is no Runtime Resource having name " + RUNTIME_RESOURCE_NAME +" and Category " + CATEGORY + " in this scope.");
}
else {
if (resources.size() == 0) {
logger.error("There is no Runtime Resource having name " + RUNTIME_RESOURCE_NAME + " and Category "
+ CATEGORY + " in this scope.");
throw new Exception("There is no Runtime Resource having name " + RUNTIME_RESOURCE_NAME
+ " and Category " + CATEGORY + " in this scope.");
} else {
for (ServiceEndpoint res : resources) {
Iterator<AccessPoint> accessPointIterator = res.profile().accessPoints().iterator();
while (accessPointIterator.hasNext()) {
ServiceEndpoint.AccessPoint accessPoint = (ServiceEndpoint.AccessPoint) accessPointIterator
.next();
if(accessPoint.name().equals("JSONWSUser")){
if (accessPoint.name().equals("JSONWSUser")) {
// get base path
Map<String, Property> properties = accessPoint.propertyMap();
host = accessPoint.address();
schema = (String)properties.get("schema").value();
user = StringEncrypter.getEncrypter().decrypt((String)properties.get("username").value());
password = StringEncrypter.getEncrypter().decrypt((String)properties.get("password").value());
schema = (String) properties.get("schema").value();
user = StringEncrypter.getEncrypter().decrypt((String) properties.get("username").value());
password = StringEncrypter.getEncrypter()
.decrypt((String) properties.get("password").value());
port = Integer.valueOf(properties.get("port").value());
// break
@ -110,11 +113,11 @@ public class LiferayJSONWsCredentials {
}
}
}
}catch(Exception e){
} catch (Exception e) {
logger.error("Unable to retrieve such service endpoint information!", e);
return;
}finally{
if(oldContext != null)
} finally {
if (oldContext != null)
ScopeProvider.instance.set(oldContext);
}
@ -123,41 +126,42 @@ public class LiferayJSONWsCredentials {
/**
* Retrieve endpoints information from IS for DB
*
* @return list of endpoints for ckan database
* @throws Exception
*/
private List<ServiceEndpoint> getConfigurationFromIS() throws Exception{
private List<ServiceEndpoint> getConfigurationFromIS() throws Exception {
SimpleQuery query = queryFor(ServiceEndpoint.class);
query.addCondition("$resource/Profile/Name/text() eq '"+ RUNTIME_RESOURCE_NAME +"'");
query.addCondition("$resource/Profile/Category/text() eq '"+ CATEGORY +"'");
query.addCondition("$resource/Profile/Name/text() eq '" + RUNTIME_RESOURCE_NAME + "'");
query.addCondition("$resource/Profile/Category/text() eq '" + CATEGORY + "'");
DiscoveryClient<ServiceEndpoint> client = clientFor(ServiceEndpoint.class);
List<ServiceEndpoint> toReturn = client.submit(query);
return toReturn;
}
public static LiferayJSONWsCredentials getSingleton() {
public static LiferayJSONWsCredentials getSingleton() {
return singleton;
}
public String getHost() {
public String getHost() {
return host;
}
public String getSchema() {
public String getSchema() {
return schema;
}
public String getUser() {
public String getUser() {
return user;
}
public String getPassword() {
public String getPassword() {
return password;
}
public int getPort() {
public int getPort() {
return port;
}

26
src/main/java/org/gcube/portal/social/networking/liferay/ws/RoleManagerWSBuilder.java
View File

@ -7,26 +7,27 @@ import org.slf4j.LoggerFactory;
/**
* Class that builds a (singleton) UserManagerWS object.
*
* @author Costantino Perciante at ISTI-CNR (costantino.perciante@isti.cnr.it)
*/
public class RoleManagerWSBuilder {
private static final Logger logger = LoggerFactory.getLogger(UserManagerWSBuilder.class);
private static RoleManagerWSBuilder singleton = new RoleManagerWSBuilder();
private RoleManager roleManagerWs;
private RoleManagerWSBuilder(){
private RoleManagerWSBuilder() {
logger.debug("Building UserManager please wait");
try{
try {
roleManagerWs = new LiferayWSRoleManager(
LiferayJSONWsCredentials.getSingleton().getUser(),
LiferayJSONWsCredentials.getSingleton().getPassword(),
LiferayJSONWsCredentials.getSingleton().getHost(),
LiferayJSONWsCredentials.getSingleton().getSchema(),
LiferayJSONWsCredentials.getSingleton().getUser(),
LiferayJSONWsCredentials.getSingleton().getPassword(),
LiferayJSONWsCredentials.getSingleton().getHost(),
LiferayJSONWsCredentials.getSingleton().getSchema(),
LiferayJSONWsCredentials.getSingleton().getPort());
}catch(Exception e){
} catch (Exception e) {
logger.error("Failed to build the UserManager. ", e);
return;
}
@ -34,16 +35,17 @@ public class RoleManagerWSBuilder {
logger.debug("UserManager instance built");
}
/**
* Get the role manager instance
*
* @return
*/
public RoleManager getRoleManager(){
public RoleManager getRoleManager() {
return roleManagerWs;
}
public static RoleManagerWSBuilder getInstance(){
public static RoleManagerWSBuilder getInstance() {
return singleton;
}

27
src/main/java/org/gcube/portal/social/networking/liferay/ws/ServletContextClass.java
View File

@ -3,34 +3,35 @@ package org.gcube.portal.social.networking.liferay.ws;
import javax.servlet.ServletContextEvent;
import javax.servlet.ServletContextListener;
import org.gcube.portal.social.networking.caches.UsersCache;
/**
* Loaded at start up. This class performs some init - to be done once - operations.
* Loaded at start up. This class performs some init - to be done once -
* operations.
*
* @author Costantino Perciante at ISTI-CNR (costantino.perciante@isti.cnr.it)
*/
public class ServletContextClass implements ServletContextListener
{
public class ServletContextClass implements ServletContextListener {
private static String notifierToken;
public void contextInitialized(ServletContextEvent arg0) {
// get the token and save it
notifierToken = arg0.getServletContext().getInitParameter("NOTIFIER_TOKEN");
// start the thread to retrieve infrastructure users (which is, build up the singleton)
//UsersCache.getSingleton();
// start the thread to retrieve infrastructure users (which is, build up the
// singleton)
// UsersCache.getSingleton();
}
@Override
public void contextDestroyed(ServletContextEvent arg0){
public void contextDestroyed(ServletContextEvent arg0) {
// on shutdown
}
/**
* Returns the token of the Liferay's User.
*
* @return
*/
public static String getNotifierToken() {

24
src/main/java/org/gcube/portal/social/networking/liferay/ws/UserManagerWSBuilder.java
View File

@ -7,6 +7,7 @@ import org.slf4j.LoggerFactory;
/**
* Class that builds a (singleton) UserManagerWS object.
*
* @author Costantino Perciante at ISTI-CNR (costantino.perciante@isti.cnr.it)
*/
public class UserManagerWSBuilder {
@ -15,18 +16,18 @@ public class UserManagerWSBuilder {
private static UserManagerWSBuilder singleton = new UserManagerWSBuilder();
private UserManager userManagerWs;
private UserManagerWSBuilder(){
private UserManagerWSBuilder() {
logger.debug("Building UserManager please wait");
try{
try {
userManagerWs = new LiferayWSUserManager(
LiferayJSONWsCredentials.getSingleton().getUser(),
LiferayJSONWsCredentials.getSingleton().getPassword(),
LiferayJSONWsCredentials.getSingleton().getHost(),
LiferayJSONWsCredentials.getSingleton().getSchema(),
LiferayJSONWsCredentials.getSingleton().getUser(),
LiferayJSONWsCredentials.getSingleton().getPassword(),
LiferayJSONWsCredentials.getSingleton().getHost(),
LiferayJSONWsCredentials.getSingleton().getSchema(),
LiferayJSONWsCredentials.getSingleton().getPort());
}catch(Exception e){
} catch (Exception e) {
logger.error("Failed to build the UserManager. ", e);
return;
}
@ -34,16 +35,17 @@ public class UserManagerWSBuilder {
logger.debug("UserManager instance built");
}
/**
* Get the user manager instance
*
* @return
*/
public UserManager getUserManager(){
public UserManager getUserManager() {
return userManagerWs;
}
public static UserManagerWSBuilder getInstance(){
public static UserManagerWSBuilder getInstance() {
return singleton;
}

3
src/main/java/org/gcube/portal/social/networking/ws/WelcomeService.java
View File

@ -14,6 +14,7 @@ public class WelcomeService {
@GET
@Produces(MediaType.TEXT_HTML)
public Response sayHtmlHello() {
return Response.ok("<html><body><h2>The social networking web service is up and running!</h2></body></html>").build();
return Response.ok("<html><body><h2>The social networking web service is up and running!</h2></body></html>")
.build();
}
}

19
src/main/java/org/gcube/portal/social/networking/ws/docs/DocsGenerator.java
View File

@ -27,14 +27,13 @@ public class DocsGenerator {
logger.debug("pathInfo {}", pathInfo);
try {
if (pathInfo.endsWith("/api-docs")) {
pathInfo += "index.html";
}
if (pathInfo.endsWith("/api-docs/")) {
pathInfo += "index.html";
}
if (pathInfo.endsWith("/api-docs")) {
pathInfo += "index.html";
}
if (pathInfo.endsWith("/api-docs/")) {
pathInfo += "index.html";
}
logger.info("going to {}", pathInfo);
@ -42,9 +41,9 @@ public class DocsGenerator {
return new FileInputStream(new File(realPath));
} catch (Exception e) {
e.printStackTrace();
//MANAGE THE EXCEPTION
e.printStackTrace();
// MANAGE THE EXCEPTION
}
return null;
return null;
}
}

1
src/main/java/org/gcube/portal/social/networking/ws/ex/ApplicationException.java
View File

@ -8,7 +8,6 @@ import javax.ws.rs.ext.Provider;
import org.gcube.portal.social.networking.ws.outputs.ResponseBean;
import org.slf4j.LoggerFactory;
/**
* Exception gets thrown when @Valid fail
*/

8
src/main/java/org/gcube/portal/social/networking/ws/ex/AuthException.java
View File

@ -3,10 +3,10 @@ package org.gcube.portal.social.networking.ws.ex;
import javax.ws.rs.WebApplicationException;
import javax.ws.rs.core.Response.Status;
public class AuthException extends WebApplicationException {
/**
*
*/
public class AuthException extends WebApplicationException {
/**
*
*/
private static final long serialVersionUID = 1L;
public AuthException(Throwable cause) {

2
src/main/java/org/gcube/portal/social/networking/ws/ex/ValidationException.java
View File

@ -12,12 +12,14 @@ import org.slf4j.LoggerFactory;
/**
* Exception thrown on fail
*
* @author Costantino Perciante at ISTI-CNR
*/
@Provider
public class ValidationException implements ExceptionMapper<javax.validation.ValidationException> {
private static final org.slf4j.Logger logger = LoggerFactory.getLogger(ValidationException.class);
@Override
public Response toResponse(javax.validation.ValidationException e) {
final StringBuilder strBuilder = new StringBuilder();

9
src/main/java/org/gcube/portal/social/networking/ws/inputs/ApplicationId.java
View File

@ -5,17 +5,18 @@ import javax.validation.constraints.Size;
import com.fasterxml.jackson.annotation.JsonProperty;
/**
* Application id object
*
* @author Costantino Perciante at ISTI-CNR
*/
//@ApiModel(description="An object containing the app_id field", value="Application")
// @ApiModel(description="An object containing the app_id field",
// value="Application")
public class ApplicationId {
@JsonProperty("app_id")
@NotNull(message="app_id cannot be null")
@Size(message="app_id cannot be empty", min=1)
@NotNull(message = "app_id cannot be null")
@Size(message = "app_id cannot be empty", min = 1)
private String appId;
public ApplicationId() {

19
src/main/java/org/gcube/portal/social/networking/ws/inputs/CommentInputBean.java
View File

@ -8,29 +8,30 @@ import javax.validation.constraints.Size;
import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.webcohesion.enunciate.metadata.DocumentationExample;
/**
* Generic input bean for methods that allow to comment posts
*/
@JsonIgnoreProperties(ignoreUnknown = true) // ignore in serialization/deserialization
public class CommentInputBean implements Serializable{
public class CommentInputBean implements Serializable {
private static final long serialVersionUID = 5274608088828232980L;
@JsonProperty("text")
@NotNull(message="text cannot be null")
@Size(min=1, message="text cannot be empty")
@NotNull(message = "text cannot be null")
@Size(min = 1, message = "text cannot be empty")
@DocumentationExample("I would like to comment that ...")
/**
* text the text of the comment
*/
private String text;
@NotNull(message="postid cannot be null")
@NotNull(message = "postid cannot be null")
@JsonProperty("postid")
/**
* postid the postid of the post where you attach the comment
*/
private String postid;
private String postid;
public CommentInputBean() {
super();
@ -39,7 +40,7 @@ public class CommentInputBean implements Serializable{
/**
* @param text
* @param postid
*/
*/
public CommentInputBean(String text, String postid) {
super();
this.text = text;
@ -66,7 +67,5 @@ public class CommentInputBean implements Serializable{
public String toString() {
return "CommentInputBean [text=" + text + ", postid=" + postid + "]";
}
}

12
src/main/java/org/gcube/portal/social/networking/ws/inputs/LikeInputBean.java
View File

@ -5,20 +5,19 @@ import javax.validation.constraints.Size;
import com.fasterxml.jackson.annotation.JsonProperty;
/**
* Like Bean object
*/
public class LikeInputBean {
@JsonProperty("likeid")
@NotNull(message="likeid cannot be null")
@Size(message="likeid cannot be empty", min=1)
@NotNull(message = "likeid cannot be null")
@Size(message = "likeid cannot be empty", min = 1)
private String likeid;
@JsonProperty("postid")
@NotNull(message="postid cannot be null")
@Size(message="postid cannot be empty", min=1)
@NotNull(message = "postid cannot be null")
@Size(message = "postid cannot be empty", min = 1)
private String postid;
public LikeInputBean() {
@ -56,5 +55,4 @@ public class LikeInputBean {
return "LikeInputBean [likeid=" + likeid + ", postid=" + postid + "]";
}
}

8
src/main/java/org/gcube/portal/social/networking/ws/inputs/PostId.java
View File

@ -5,16 +5,15 @@ import javax.validation.constraints.Size;
import com.fasterxml.jackson.annotation.JsonProperty;
/**
* Application id object
*
*/
public class PostId {
@JsonProperty("postid")
@NotNull(message="postid cannot be null")
@Size(message="postid cannot be empty", min=1)
@NotNull(message = "postid cannot be null")
@Size(message = "postid cannot be empty", min = 1)
private String postId;
public PostId() {
@ -39,5 +38,4 @@ public class PostId {
return "PostId [postid=" + postId + "]";
}
}

17
src/main/java/org/gcube/portal/social/networking/ws/inputs/PostInputBean.java
View File

@ -8,31 +8,33 @@ import javax.validation.constraints.Size;
import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.webcohesion.enunciate.metadata.DocumentationExample;
/**
* Generic input bean for methods that allow to write posts
*
* @author Costantino Perciante at ISTI-CNR
*/
@JsonIgnoreProperties(ignoreUnknown = true) // ignore in serialization/deserialization
public class PostInputBean implements Serializable{
public class PostInputBean implements Serializable {
private static final long serialVersionUID = 5274608088828232980L;
@JsonProperty("text")
@NotNull(message="text cannot be null")
@Size(min=1, message="text cannot be empty")
@NotNull(message = "text cannot be null")
@Size(min = 1, message = "text cannot be empty")
@DocumentationExample("Dear vre members, ...")
/**
* text the text of the post
*/
private String text;
private String previewtitle;
private String previewtitle;
@JsonProperty("preview_description")
private String previewdescription;
private String previewdescription;
@JsonProperty("preview_host")
private String previewhost;
private String previewhost;
@JsonProperty("preview_url")
private String previewurl;
@ -44,7 +46,8 @@ public class PostInputBean implements Serializable{
private String httpimageurl;
/**
* enablenotification If true send a notification to the other vre members about this post
* enablenotification If true send a notification to the other vre members about
* this post
*/
@JsonProperty("enable_notification")
private boolean enablenotification;

11
src/main/java/org/gcube/portal/social/networking/ws/inputs/UserSetNotificationBean.java
View File

@ -5,7 +5,6 @@ import javax.validation.constraints.Size;
import com.fasterxml.jackson.annotation.JsonProperty;
/**
*
*
@ -13,19 +12,18 @@ import com.fasterxml.jackson.annotation.JsonProperty;
public class UserSetNotificationBean {
@JsonProperty("username")
@NotNull(message="username cannot be null")
@Size(message="username cannot be empty", min=1)
@NotNull(message = "username cannot be null")
@Size(message = "username cannot be empty", min = 1)
private String username;
@JsonProperty("disableNotification")
@NotNull(message="disableNotification cannot be null")
@NotNull(message = "disableNotification cannot be null")
private Boolean disableNotification;
public UserSetNotificationBean() {
super();
}
/**
* @param username
* @param disableNotification
@ -36,7 +34,6 @@ public class UserSetNotificationBean {
this.disableNotification = disableNotification;
}
public String getUsername() {
return username;
}
@ -53,11 +50,9 @@ public class UserSetNotificationBean {
this.disableNotification = disableNotification;
}
@Override
public String toString() {
return "UserSetNotificationBean [username=" + username + ", disableNotification=" + disableNotification + "]";
}
}

24
src/main/java/org/gcube/portal/social/networking/ws/mappers/CatalogueEventTypeMapper.java
View File

@ -11,18 +11,18 @@ public class CatalogueEventTypeMapper {
public static NotificationType getType(CatalogueEventType type) throws NotificationTypeNotFoundException {
switch (type) {
case ITEM_PUBLISHED:
return NotificationType.CAT_ITEM_PUBLISHED;
case ITEM_REJECTED:
return NotificationType.CAT_ITEM_REJECTED;
case ITEM_REMOVED:
return NotificationType.CAT_ITEM_DELETE;
case ITEM_SUBMITTED:
return NotificationType.CAT_ITEM_SUBMITTED;
case ITEM_UPDATED:
return NotificationType.CAT_ITEM_UPDATED;
default:
throw new NotificationTypeNotFoundException("The Catalogue event could not be mapped");
case ITEM_PUBLISHED:
return NotificationType.CAT_ITEM_PUBLISHED;
case ITEM_REJECTED:
return NotificationType.CAT_ITEM_REJECTED;
case ITEM_REMOVED:
return NotificationType.CAT_ITEM_DELETE;
case ITEM_SUBMITTED:
return NotificationType.CAT_ITEM_SUBMITTED;
case ITEM_UPDATED:
return NotificationType.CAT_ITEM_UPDATED;
default:
throw new NotificationTypeNotFoundException("The Catalogue event could not be mapped");
}
}
}

53
src/main/java/org/gcube/portal/social/networking/ws/mappers/JobMapper.java
View File

@ -9,14 +9,14 @@ public class JobMapper {
public JobMapper() {
}
public static RunningJob getJob(JobNotificationBean item) {
String jobId = null;
String jobName = null;
JobStatusType status = null;
String message = null;
String serviceName = null; // i.e., Dataminer, SmartExecutor..
try {
jobId = item.getJobId();
jobName = item.getJobName();
@ -32,33 +32,32 @@ public class JobMapper {
public static JobStatusType getType(JobStatusModelType type) {
JobStatusType toReturn = null;
switch (type) {
case CANCELLED:
return JobStatusType.CANCELLED;
case DELETED:
return JobStatusType.DELETED;
case FAILED:
return JobStatusType.FAILED;
case CANCELLING:
return JobStatusType.CANCELLING;
case DELETING:
return JobStatusType.DELETING;
case EXECUTING:
return JobStatusType.EXECUTING;
case NEW:
return JobStatusType.NEW;
case SUBMITTED:
return JobStatusType.SUBMITTED;
case SUCCEEDED:
return JobStatusType.SUCCEEDED;
case TIMED_OUT:
return JobStatusType.TIMED_OUT;
case WAITING:
return JobStatusType.WAITING;
default:
break;
case CANCELLED:
return JobStatusType.CANCELLED;
case DELETED:
return JobStatusType.DELETED;
case FAILED:
return JobStatusType.FAILED;
case CANCELLING:
return JobStatusType.CANCELLING;
case DELETING:
return JobStatusType.DELETING;
case EXECUTING:
return JobStatusType.EXECUTING;
case NEW:
return JobStatusType.NEW;
case SUBMITTED:
return JobStatusType.SUBMITTED;
case SUCCEEDED:
return JobStatusType.SUCCEEDED;
case TIMED_OUT:
return JobStatusType.TIMED_OUT;
case WAITING:
return JobStatusType.WAITING;
default:
break;
}
return toReturn;
}
}

18
src/main/java/org/gcube/portal/social/networking/ws/mappers/WorkspaceItemMapper.java
View File

@ -13,9 +13,9 @@ public class WorkspaceItemMapper {
public static SocialFileItem getFileItem(FileItemBean item) {
String id = null;
String name= null;
String title= null;
String path= null;
String name = null;
String title = null;
String path = null;
SocialSharedFolder parent = null;
try {
@ -34,12 +34,12 @@ public class WorkspaceItemMapper {
public static SocialSharedFolder getSharedFolder(FolderBean item) {
String id = null;
String name= null;
String title= null;
String displayName= null;
String path= null;
String parentId= null;
boolean vreFolder = false;
String name = null;
String title = null;
String displayName = null;
String path = null;
String parentId = null;
boolean vreFolder = false;
try {
id = item.getId();
name = item.getName();

94
src/main/java/org/gcube/portal/social/networking/ws/methods/v2/Comments.java
View File

@ -1,9 +1,7 @@
package org.gcube.portal.social.networking.ws.methods.v2;
import java.util.Date;
import java.util.List;
import java.util.UUID;
import javax.validation.Valid;
import javax.validation.ValidationException;
@ -23,22 +21,15 @@ import org.gcube.common.authorization.library.provider.AuthorizationProvider;
import org.gcube.common.authorization.library.utils.Caller;
import org.gcube.common.scope.api.ScopeProvider;
import org.gcube.portal.databook.shared.Comment;
import org.gcube.portal.databook.shared.Feed;
import org.gcube.portal.databook.shared.ex.FeedIDNotFoundException;
import org.gcube.portal.social.networking.liferay.ws.UserManagerWSBuilder;
import org.gcube.portal.social.networking.ws.inputs.CommentInputBean;
import org.gcube.portal.social.networking.ws.inputs.PostInputBean;
import org.gcube.portal.social.networking.ws.outputs.ResponseBean;
import org.gcube.portal.social.networking.ws.utils.CassandraConnection;
import org.gcube.portal.social.networking.ws.utils.ErrorMessages;
import org.gcube.portal.social.networking.ws.utils.Filters;
import org.gcube.portal.social.networking.ws.utils.SocialUtils;
import org.gcube.socialnetworking.socialtoken.SocialMessageParser;
import org.gcube.vomanagement.usermanagement.UserManager;
import org.gcube.vomanagement.usermanagement.model.GCubeUser;
import org.slf4j.LoggerFactory;
import com.liferay.portlet.journal.FeedIdException;
import com.webcohesion.enunciate.metadata.rs.RequestHeader;
import com.webcohesion.enunciate.metadata.rs.RequestHeaders;
import com.webcohesion.enunciate.metadata.rs.ResponseCode;
@ -46,12 +37,13 @@ import com.webcohesion.enunciate.metadata.rs.StatusCodes;
/**
* REST interface for the social networking library (comments).
*
* @author Ahmed Ibrahim ISTI-CNR
*/
@Path("2/comments")
@RequestHeaders ({
@RequestHeader( name = "Authorization", description = "Bearer token, see https://dev.d4science.org/how-to-access-resources"),
@RequestHeader( name = "Content-Type", description = "application/json")
@RequestHeaders({
@RequestHeader(name = "Authorization", description = "Bearer token, see https://dev.d4science.org/how-to-access-resources"),
@RequestHeader(name = "Content-Type", description = "application/json")
})
public class Comments {
@ -59,22 +51,26 @@ public class Comments {
private static final org.slf4j.Logger logger = LoggerFactory.getLogger(Comments.class);
/*
* Retrieve the list of comments belonging to the post id (key) of the token in the related context
* Retrieve the list of comments belonging to the post id (key) of the token in
* the related context
*
* @param key the key as in the POST JSON representation
* @pathExample /get-comments-by-post-id?key=9ea137e9-6606-45ff-a1a2-94d4e8760583
* @return the list of comments belonging to the post identified by the key in the context identified by the token
*
* @pathExample
* /get-comments-by-post-id?key=9ea137e9-6606-45ff-a1a2-94d4e8760583
*
* @return the list of comments belonging to the post identified by the key in
* the context identified by the token
*/
@GET
@Produces(MediaType.APPLICATION_JSON)
@Path("get-comments-by-post-id")
@StatusCodes ({
@ResponseCode ( code = 200, condition = "The list of comments is put into the 'result' field"),
@ResponseCode ( code = 500, condition = ErrorMessages.ERROR_IN_API_RESULT)
@StatusCodes({
@ResponseCode(code = 200, condition = "The list of comments is put into the 'result' field"),
@ResponseCode(code = 500, condition = ErrorMessages.ERROR_IN_API_RESULT)
})
public Response getAllCommentsByPostId(
@NotNull
@QueryParam("key")
String key) {
@NotNull @QueryParam("key") String key) {
ResponseBean responseBean = new ResponseBean();
Status status = Status.OK;
@ -83,13 +79,13 @@ public class Comments {
String username = caller.getClient().getId();
List<Comment> comments = null;
try{
try {
logger.debug("Retrieving comments for user id " + username);
comments = CassandraConnection.getInstance().getDatabookStore().getAllCommentByPost(key);
Filters.filterCommentsPerContext(comments, context);
responseBean.setResult(comments);
responseBean.setSuccess(true);
}catch(Exception e){
} catch (Exception e) {
logger.error("Unable to retrieve such comments.", e);
responseBean.setMessage(e.getMessage());
responseBean.setSuccess(false);
@ -98,16 +94,20 @@ public class Comments {
return Response.status(status).entity(responseBean).build();
}
/*
* Retrieve the list of comments belonging to the owner of the token in the related context
* @return the list of comments belonging to the owner of the token in the related context.
* Retrieve the list of comments belonging to the owner of the token in the
* related context
*
* @return the list of comments belonging to the owner of the token in the
* related context.
*/
@GET
@Produces(MediaType.APPLICATION_JSON)
@Path("get-comments-user")
@StatusCodes ({
@ResponseCode ( code = 200, condition = "The list of comments is put into the 'result' field"),
@ResponseCode ( code = 500, condition = ErrorMessages.ERROR_IN_API_RESULT)
@StatusCodes({
@ResponseCode(code = 200, condition = "The list of comments is put into the 'result' field"),
@ResponseCode(code = 500, condition = ErrorMessages.ERROR_IN_API_RESULT)
})
public Response getCommentsUser() {
@ -118,13 +118,13 @@ public class Comments {
String username = caller.getClient().getId();
List<Comment> comments = null;
try{
try {
logger.debug("Retrieving comments for user id " + username);
comments = CassandraConnection.getInstance().getDatabookStore().getRecentCommentsByUserAndDate(username, 0);
Filters.filterCommentsPerContext(comments, context);
responseBean.setResult(comments);
responseBean.setSuccess(true);
}catch(Exception e){
} catch (Exception e) {
logger.error("Unable to retrieve such comments.", e);
responseBean.setMessage(e.getMessage());
responseBean.setSuccess(false);
@ -135,16 +135,15 @@ public class Comments {
}
/*
* Retrieve comments of the token owner in the context bound to the token itself and filter them by date
* Retrieve comments of the token owner in the context bound to the token itself
* and filter them by date
*/
@GET
@Produces(MediaType.APPLICATION_JSON)
@Path("get-comments-user-by-time")
public Response getCommentsUserByTime(
@QueryParam("time")
@Min(value = 0, message="time cannot be negative")
long timeInMillis
) throws ValidationException{
@QueryParam("time") @Min(value = 0, message = "time cannot be negative") long timeInMillis)
throws ValidationException {
ResponseBean responseBean = new ResponseBean();
Status status = Status.OK;
@ -153,14 +152,15 @@ public class Comments {
String username = caller.getClient().getId();
List<Comment> comments = null;
try{
try {
logger.debug("Retrieving comments for user id " + username);
comments = CassandraConnection.getInstance().getDatabookStore().getRecentCommentsByUserAndDate(username, timeInMillis);
comments = CassandraConnection.getInstance().getDatabookStore().getRecentCommentsByUserAndDate(username,
timeInMillis);
Filters.filterCommentsPerContext(comments, context);
responseBean.setResult(comments);
responseBean.setMessage("");
responseBean.setSuccess(true);
}catch(Exception e){
} catch (Exception e) {
logger.error("Unable to retrieve such comments.", e);
responseBean.setMessage(e.getMessage());
responseBean.setSuccess(false);
@ -169,8 +169,10 @@ public class Comments {
return Response.status(status).entity(responseBean).build();
}
/**
* Create a new comment to a post having as owner the auth token's owner
*
* @param comment The CommentInputBean object
* @return
* @throws ValidationException
@ -179,14 +181,13 @@ public class Comments {
@Path("comment-post")
@Consumes(MediaType.APPLICATION_JSON)
@Produces(MediaType.APPLICATION_JSON)
@StatusCodes ({
@ResponseCode ( code = 201, condition = "Successfull created, the new comment is reported in the 'result' field of the returned object"),
@ResponseCode ( code = 500, condition = ErrorMessages.ERROR_IN_API_RESULT)
@StatusCodes({
@ResponseCode(code = 201, condition = "Successfull created, the new comment is reported in the 'result' field of the returned object"),
@ResponseCode(code = 500, condition = ErrorMessages.ERROR_IN_API_RESULT)
})
public Response writeComment(
@NotNull(message="Comment to write is missing")
@Valid
CommentInputBean comment) throws ValidationException {
@NotNull(message = "Comment to write is missing") @Valid CommentInputBean comment)
throws ValidationException {
Caller caller = AuthorizationProvider.instance.get();
String username = caller.getClient().getId();
logger.debug("Request of writing a comment coming from user " + username);
@ -215,14 +216,13 @@ public class Comments {
responseBean.setResult(theComment);
responseBean.setSuccess(true);
return Response.status(status).entity(responseBean).build();
} catch(FeedIDNotFoundException ex) {
} catch (FeedIDNotFoundException ex) {
logger.error("Unable to find a post comment", ex);
responseBean.setMessage("Could not reach the DB to write the comment, something went wrong");
responseBean.setSuccess(false);
status = Status.INTERNAL_SERVER_ERROR;
return Response.status(status).entity(responseBean).build();
}
catch(Exception e) {
} catch (Exception e) {
logger.error("Unable to write comment", e);
responseBean.setMessage("Could not reach the DB to write the comment, something went wrong");
responseBean.setSuccess(false);

80
src/main/java/org/gcube/portal/social/networking/ws/methods/v2/FullTextSearch.java
View File

@ -49,10 +49,10 @@ import com.webcohesion.enunciate.metadata.rs.StatusCodes;
* REST interface for the social networking library (post and its comments).
*/
@Path("2/full-text-search")
@RequestHeaders ({
@RequestHeader( name = "Authorization", description = "Bearer token, see https://dev.d4science.org/how-to-access-resources"),
@RequestHeader( name = "Content-Type", description = "application/json")
})
@RequestHeaders({
@RequestHeader(name = "Authorization", description = "Bearer token, see https://dev.d4science.org/how-to-access-resources"),
@RequestHeader(name = "Content-Type", description = "application/json")
})
public class FullTextSearch {
// Logger
@ -60,29 +60,30 @@ public class FullTextSearch {
/**
* Retrieve posts/comments that match the given query
*
* @param httpServletRequest
* @param query A string to search for
* @param from the index of the base result to be returned, range[0, infinity], defaults from = 0
* @param quantity defines how many results are most are to be returned, range[1, infinity], defaults from = 0,
* @return The posts/comments returned belong to the context bound to the AUTH Token
* @param query A string to search for
* @param from the index of the base result to be returned,
* range[0, infinity], defaults from = 0
* @param quantity defines how many results are most are to be
* returned, range[1, infinity], defaults from = 0,
* @return The posts/comments returned belong to the context bound to the AUTH
* Token
* @throws ValidationException
*/
@GET
@Path("search-by-query")
@Produces(MediaType.APPLICATION_JSON)
@StatusCodes ({
@ResponseCode ( code = 200, condition = "Successful retrieval of posts/comments that match the query, reported in the 'result' field of the returned object"),
@ResponseCode ( code = 500, condition = ErrorMessages.ERROR_IN_API_RESULT)
@StatusCodes({
@ResponseCode(code = 200, condition = "Successful retrieval of posts/comments that match the query, reported in the 'result' field of the returned object"),
@ResponseCode(code = 500, condition = ErrorMessages.ERROR_IN_API_RESULT)
})
public Response searchByQuery(
@Context HttpServletRequest httpServletRequest,
@QueryParam("query") @NotNull(message="query cannot be null") @Size(min=1, message="query cannot be empty")
String query,
@DefaultValue("0") @QueryParam("from") @Min(value=0, message="from cannot be negative")
int from,
@DefaultValue("10") @QueryParam("quantity") @Min(value=0, message="quantity cannot be negative")
int quantity
) throws ValidationException{
@QueryParam("query") @NotNull(message = "query cannot be null") @Size(min = 1, message = "query cannot be empty") String query,
@DefaultValue("0") @QueryParam("from") @Min(value = 0, message = "from cannot be negative") int from,
@DefaultValue("10") @QueryParam("quantity") @Min(value = 0, message = "quantity cannot be negative") int quantity)
throws ValidationException {
Caller caller = AuthorizationProvider.instance.get();
String username = caller.getClient().getId();
@ -90,45 +91,45 @@ public class FullTextSearch {
ResponseBean responseBean = new ResponseBean();
Status status = Status.BAD_REQUEST;
responseBean.setMessage("This method can be only invoked by using a user token.");
if(!TokensUtils.isUserToken(caller))
if (!TokensUtils.isUserToken(caller))
return Response.status(status).entity(responseBean).build();
status = Status.OK;
responseBean.setMessage(null);
status = Status.OK;
responseBean.setMessage(null);
GroupManager groupManager = GroupManagerWSBuilder.getInstance().getGroupManager();
UserManager userManager = UserManagerWSBuilder.getInstance().getUserManager();
try{
try {
// Retrieve user's vres in which we must search
Set<String> vres = new HashSet<String>();
// get the group id from the current context
long currentGroupId = groupManager.getGroupIdFromInfrastructureScope(context);
GCubeUser currUser = userManager.getUserByUsername(username);
List<GCubeGroup> userContexts = groupManager.listGroupsByUser(currUser.getUserId());
if (groupManager.isRootVO(currentGroupId)) {
for (GCubeGroup group : groupManager.listGroupsByUser(currUser.getUserId())) {
for (GCubeGroup group : groupManager.listGroupsByUser(currUser.getUserId())) {
if (groupManager.isVRE(group.getGroupId()) && userContexts.contains(group)) {
vres.add(groupManager.getInfrastructureScope(group.getGroupId()));
}
}
}
else if(groupManager.isVO(currentGroupId)){
for (GCubeGroup group : groupManager.listGroupsByUser(currUser.getUserId())) {
if (groupManager.isVRE(group.getGroupId()) && group.getParentGroupId() == currentGroupId && userContexts.contains(group)) {
}
} else if (groupManager.isVO(currentGroupId)) {
for (GCubeGroup group : groupManager.listGroupsByUser(currUser.getUserId())) {
if (groupManager.isVRE(group.getGroupId()) && group.getParentGroupId() == currentGroupId
&& userContexts.contains(group)) {
vres.add(groupManager.getInfrastructureScope(group.getGroupId()));
}
}
}
else {
} else {
vres.add(context);
}
}
// query elastic search
List<EnhancedFeed> enhancedFeeds = ElasticSearchConnection.getSingleton().getElasticSearchClient().search(query, vres, from, quantity);
List<EnhancedFeed> enhancedFeeds = ElasticSearchConnection.getSingleton().getElasticSearchClient()
.search(query, vres, from, quantity);
Filters.hideSensitiveInformation(enhancedFeeds, caller.getClient().getId());
DatabookStore store = CassandraConnection.getInstance().getDatabookStore();
@ -137,14 +138,14 @@ public class FullTextSearch {
// update fields "liked" and "isuser"
for (EnhancedFeed enhancedFeed : enhancedFeeds) {
if(isUsers(enhancedFeed.getFeed(), username))
if (isUsers(enhancedFeed.getFeed(), username))
enhancedFeed.setUsers(true);
if(likedFeeds.contains(enhancedFeed.getFeed().getKey()))
if (likedFeeds.contains(enhancedFeed.getFeed().getKey()))
enhancedFeed.setLiked(true);
}
responseBean.setResult((ArrayList<EnhancedFeed>) enhancedFeeds);
responseBean.setSuccess(true);
}catch(Exception e){
} catch (Exception e) {
logger.error("Something went wrong while searching", e);
responseBean.setMessage(e.getMessage());
responseBean.setSuccess(false);
@ -156,6 +157,7 @@ public class FullTextSearch {
/**
* tell if a feed belongs to the current user or not
*
* @param tocheck
* @param username
* @return true if this feed is of the current user

40
src/main/java/org/gcube/portal/social/networking/ws/methods/v2/HashTags.java
View File

@ -1,13 +1,10 @@
package org.gcube.portal.social.networking.ws.methods.v2;
import java.util.List;
import java.util.Map;
import javax.validation.Valid;
import javax.validation.ValidationException;
import javax.validation.constraints.Min;
import javax.validation.constraints.NotNull;
import javax.ws.rs.*;
import javax.ws.rs.GET;
import javax.ws.rs.Path;
import javax.ws.rs.Produces;
import javax.ws.rs.core.MediaType;
import javax.ws.rs.core.Response;
import javax.ws.rs.core.Response.Status;
@ -16,7 +13,6 @@ import org.gcube.common.authorization.library.provider.AuthorizationProvider;
import org.gcube.common.authorization.library.utils.Caller;
import org.gcube.common.scope.api.ScopeProvider;
import org.gcube.portal.databook.server.DatabookStore;
import org.gcube.portal.databook.shared.Post;
import org.gcube.portal.social.networking.liferay.ws.GroupManagerWSBuilder;
import org.gcube.portal.social.networking.ws.outputs.ResponseBean;
import org.gcube.portal.social.networking.ws.utils.CassandraConnection;
@ -30,12 +26,13 @@ import com.webcohesion.enunciate.metadata.rs.StatusCodes;
/**
* REST interface for the social networking library (hash tags).
*
* @author Ahmed Ibrahim ISTI-CNR
*/
@Path("2/hashtags")
@RequestHeaders ({
@RequestHeader( name = "Authorization", description = "Bearer token, see https://dev.d4science.org/how-to-access-resources"),
@RequestHeader( name = "Content-Type", description = "application/json")
@RequestHeaders({
@RequestHeader(name = "Authorization", description = "Bearer token, see https://dev.d4science.org/how-to-access-resources"),
@RequestHeader(name = "Content-Type", description = "application/json")
})
public class HashTags {
@ -44,15 +41,15 @@ public class HashTags {
@GET
@Path("get-hashtags-and-occurrences/")
@Produces({MediaType.APPLICATION_JSON})
@StatusCodes ({
@ResponseCode ( code = 200, condition = "Hashtags and occurrences retrieved, reported in the 'result' field of the returned object"),
@ResponseCode ( code = 500, condition = ErrorMessages.ERROR_IN_API_RESULT)
@Produces({ MediaType.APPLICATION_JSON })
@StatusCodes({
@ResponseCode(code = 200, condition = "Hashtags and occurrences retrieved, reported in the 'result' field of the returned object"),
@ResponseCode(code = 500, condition = ErrorMessages.ERROR_IN_API_RESULT)
})
/**
* @return hashtags in the context bound to the auth token
* @return hashtags in the context bound to the auth token
*/
public Response getHashTagsAndOccurrences(){
public Response getHashTagsAndOccurrences() {
Caller caller = AuthorizationProvider.instance.get();
String username = caller.getClient().getId();
@ -62,19 +59,20 @@ public class HashTags {
logger.debug("User " + username + " has requested hashtags of context " + context);
try{
try {
DatabookStore datastore = CassandraConnection.getInstance().getDatabookStore();
// TODO handle the case of VO and ROOT
boolean isVRE = GroupManagerWSBuilder.getInstance().getGroupManager().isVRE(GroupManagerWSBuilder.getInstance().getGroupManager().getGroupIdFromInfrastructureScope(context));
if(isVRE){
boolean isVRE = GroupManagerWSBuilder.getInstance().getGroupManager().isVRE(
GroupManagerWSBuilder.getInstance().getGroupManager().getGroupIdFromInfrastructureScope(context));
if (isVRE) {
Map<String, Integer> map = datastore.getVREHashtagsWithOccurrence(context);
responseBean.setResult(map);
responseBean.setSuccess(true);
}else{
} else {
responseBean.setMessage("Please provide a VRE token. VO and ROOT VO cases are not yet managed.");
responseBean.setResult(false);
}
}catch(Exception e){
} catch (Exception e) {
logger.error("Failed to retrieve hashtags", e);
status = Status.INTERNAL_SERVER_ERROR;
}

685
src/main/java/org/gcube/portal/social/networking/ws/methods/v2/Lib.java
View File

File diff suppressed because it is too large Load Diff

61
src/main/java/org/gcube/portal/social/networking/ws/methods/v2/Likes.java
View File

@ -1,6 +1,5 @@
package org.gcube.portal.social.networking.ws.methods.v2;
import java.util.List;
import javax.validation.Valid;
@ -35,12 +34,13 @@ import com.webcohesion.enunciate.metadata.rs.StatusCodes;
/**
* REST interface for the social networking library (likes).
*
* @author Ahmed Ibrahim ISTI-CNR
*/
@Path("2/likes")
@RequestHeaders ({
@RequestHeader( name = "Authorization", description = "Bearer token, see https://dev.d4science.org/how-to-access-resources"),
@RequestHeader( name = "Content-Type", description = "application/json")
@RequestHeaders({
@RequestHeader(name = "Authorization", description = "Bearer token, see https://dev.d4science.org/how-to-access-resources"),
@RequestHeader(name = "Content-Type", description = "application/json")
})
public class Likes {
@ -48,22 +48,25 @@ public class Likes {
private static final org.slf4j.Logger logger = LoggerFactory.getLogger(Likes.class);
/*
* Retrieve the list of likes belonging to the post id (key) of the token in the related context
* Retrieve the list of likes belonging to the post id (key) of the token in the
* related context
*
* @param key the key as in the POST JSON representation
*
* @pathExample /get-likes-by-post-id?key=9ea137e9-6606-45ff-a1a2-94d4e8760583
* @return the list of likes belonging to the post identified by the key in the context identified by the token
*
* @return the list of likes belonging to the post identified by the key in the
* context identified by the token
*/
@GET
@Produces(MediaType.APPLICATION_JSON)
@Path("get-likes-by-post-id")
@StatusCodes ({
@ResponseCode ( code = 200, condition = "The list of likes is put into the 'result' field"),
@ResponseCode ( code = 500, condition = ErrorMessages.ERROR_IN_API_RESULT)
@StatusCodes({
@ResponseCode(code = 200, condition = "The list of likes is put into the 'result' field"),
@ResponseCode(code = 500, condition = ErrorMessages.ERROR_IN_API_RESULT)
})
public Response getAllLikesByPostId(
@NotNull
@QueryParam("key")
String key) {
@NotNull @QueryParam("key") String key) {
ResponseBean responseBean = new ResponseBean();
Status status = Status.OK;
@ -72,12 +75,12 @@ public class Likes {
String username = caller.getClient().getId();
List<Like> likes = null;
try{
try {
logger.debug("Retrieving likes for user id " + username);
likes = CassandraConnection.getInstance().getDatabookStore().getAllLikesByPost(key);
responseBean.setResult(likes);
responseBean.setSuccess(true);
}catch(Exception e){
} catch (Exception e) {
logger.error("Unable to retrieve such likes.", e);
responseBean.setMessage(e.getMessage());
responseBean.setSuccess(false);
@ -89,6 +92,7 @@ public class Likes {
/**
* Create a new like to a post in the context of the token
*
* @param postid The post id to be liked
* @return true if everything is OK
* @throws ValidationException
@ -97,14 +101,12 @@ public class Likes {
@Path("like-post")
@Consumes(MediaType.APPLICATION_JSON)
@Produces(MediaType.APPLICATION_JSON)
@StatusCodes ({
@ResponseCode ( code = 201, condition = "Successful created, the like operation result is reported in the 'result' field of the returned object"),
@ResponseCode ( code = 500, condition = ErrorMessages.ERROR_IN_API_RESULT)
@StatusCodes({
@ResponseCode(code = 201, condition = "Successful created, the like operation result is reported in the 'result' field of the returned object"),
@ResponseCode(code = 500, condition = ErrorMessages.ERROR_IN_API_RESULT)
})
public Response like(
@NotNull(message="Post to like is missing")
@Valid
PostId post) throws ValidationException {
@NotNull(message = "Post to like is missing") @Valid PostId post) throws ValidationException {
Caller caller = AuthorizationProvider.instance.get();
String username = caller.getClient().getId();
logger.debug("Request of like coming from user " + username);
@ -115,7 +117,7 @@ public class Likes {
if (likeResultOperation)
logger.debug("Added like OK to postId " + post.getPostId());
else {
logger.error("Unable to like this post"+ post.getPostId());
logger.error("Unable to like this post" + post.getPostId());
responseBean.setMessage("Unable to like, something went wrong please see server log");
responseBean.setSuccess(false);
status = Status.INTERNAL_SERVER_ERROR;
@ -129,6 +131,7 @@ public class Likes {
/**
* Unlike to a post in the context of the token
*
* @param postid The post id to be liked
* @return true if everything is OK
* @throws ValidationException
@ -137,24 +140,24 @@ public class Likes {
@Path("unlike-post")
@Consumes(MediaType.APPLICATION_JSON)
@Produces(MediaType.APPLICATION_JSON)
@StatusCodes ({
@ResponseCode ( code = 201, condition = "The unlike operation result is reported in the 'result' field of the returned object"),
@ResponseCode ( code = 500, condition = ErrorMessages.ERROR_IN_API_RESULT)
@StatusCodes({
@ResponseCode(code = 201, condition = "The unlike operation result is reported in the 'result' field of the returned object"),
@ResponseCode(code = 500, condition = ErrorMessages.ERROR_IN_API_RESULT)
})
public Response unlike(
@NotNull(message="Post to unlike is missing")
@Valid
LikeInputBean likeInputBean) throws ValidationException {
@NotNull(message = "Post to unlike is missing") @Valid LikeInputBean likeInputBean)
throws ValidationException {
Caller caller = AuthorizationProvider.instance.get();
String username = caller.getClient().getId();
logger.debug("Request of unlike coming from user " + username);
ResponseBean responseBean = new ResponseBean();
Status status = Status.OK;
boolean likeResultOperation = SocialUtils.unlike(username, likeInputBean.getLikeid(), likeInputBean.getPostid());
boolean likeResultOperation = SocialUtils.unlike(username, likeInputBean.getLikeid(),
likeInputBean.getPostid());
if (likeResultOperation)
logger.debug("Unlike OK to postId " + likeInputBean.getPostid());
else {
logger.error("Unable to unlike this post"+ likeInputBean.getPostid());
logger.error("Unable to unlike this post" + likeInputBean.getPostid());
responseBean.setMessage("Unable to unlike, something went wrong please see server log");
responseBean.setSuccess(false);
status = Status.INTERNAL_SERVER_ERROR;

140
src/main/java/org/gcube/portal/social/networking/ws/methods/v2/Messages.java
View File

@ -23,7 +23,6 @@ import org.gcube.applicationsupportlayer.social.ApplicationNotificationsManager;
import org.gcube.applicationsupportlayer.social.NotificationsManager;
import org.gcube.applicationsupportlayer.social.shared.SocialNetworkingSite;
import org.gcube.applicationsupportlayer.social.shared.SocialNetworkingUser;
import org.gcube.common.authorization.control.annotations.AuthorizationControl;
import org.gcube.common.authorization.library.provider.AuthorizationProvider;
import org.gcube.common.authorization.library.provider.SecurityTokenProvider;
import org.gcube.common.authorization.library.utils.Caller;
@ -36,8 +35,6 @@ import org.gcube.portal.notifications.thread.MessageNotificationsThread;
import org.gcube.portal.social.networking.caches.SocialNetworkingSiteFinder;
import org.gcube.portal.social.networking.liferay.ws.LiferayJSONWsCredentials;
import org.gcube.portal.social.networking.liferay.ws.UserManagerWSBuilder;
import org.gcube.portal.social.networking.ws.ex.AuthException;
import org.gcube.portal.social.networking.ws.inputs.UserSetNotificationBean;
import org.gcube.portal.social.networking.ws.outputs.ResponseBean;
import org.gcube.portal.social.networking.ws.utils.ErrorMessages;
import org.gcube.portal.social.networking.ws.utils.TokensUtils;
@ -56,14 +53,15 @@ import com.webcohesion.enunciate.metadata.rs.StatusCodes;
/**
* Messages services REST interface
* @author Costantino Perciante at ISTI-CNR
* (costantino.perciante@isti.cnr.it)
*
* @author Costantino Perciante at ISTI-CNR
* (costantino.perciante@isti.cnr.it)
*/
@Path("2/messages")
@RequestHeaders ({
@RequestHeader( name = "Authorization", description = "Bearer token, see https://dev.d4science.org/how-to-access-resources"),
@RequestHeader( name = "Content-Type", description = "application/json")
})
@RequestHeaders({
@RequestHeader(name = "Authorization", description = "Bearer token, see https://dev.d4science.org/how-to-access-resources"),
@RequestHeader(name = "Content-Type", description = "application/json")
})
public class Messages {
// Logger
@ -71,8 +69,10 @@ public class Messages {
/**
* Write a message to another user. The sender is the token's owner by default
* @responseExample application/json {"success": true, "message": null, "result": "556142e3-d6f5-4550-b2fa-abe5626625d3"}
* @param input The message to write"
*
* @responseExample application/json {"success": true, "message": null,
* "result": "556142e3-d6f5-4550-b2fa-abe5626625d3"}
* @param input The message to write"
* @param httpServletRequest
* @return see response example
* @throws ValidationException
@ -83,15 +83,14 @@ public class Messages {
@Path("write-message/")
@Consumes(MediaType.APPLICATION_JSON)
@Produces(MediaType.APPLICATION_JSON)
@StatusCodes ({
@ResponseCode ( code = 200, condition = "Successful write a message. Its id is reported in the 'result' field of the returned object"),
@ResponseCode ( code = 500, condition = ErrorMessages.ERROR_IN_API_RESULT)
@StatusCodes({
@ResponseCode(code = 200, condition = "Successful write a message. Its id is reported in the 'result' field of the returned object"),
@ResponseCode(code = 500, condition = ErrorMessages.ERROR_IN_API_RESULT)
})
public Response writeMessage(
@NotNull(message="Message to send is missing")
@Valid
MessageInputBean input,
@Context HttpServletRequest httpServletRequest) throws ValidationException, UserManagementSystemException, UserRetrievalFault{
@NotNull(message = "Message to send is missing") @Valid MessageInputBean input,
@Context HttpServletRequest httpServletRequest)
throws ValidationException, UserManagementSystemException, UserRetrievalFault {
logger.debug("Incoming message bean is " + input);
@ -99,62 +98,69 @@ public class Messages {
UserManager um = UserManagerWSBuilder.getInstance().getUserManager();
GCubeUser senderUser = null;
SocialNetworkingUser user = null;
// check if the token belongs to an application token. In this case use J.A.R.V.I.S (the username used to communicate with Liferay)
// check if the token belongs to an application token. In this case use
// J.A.R.V.I.S (the username used to communicate with Liferay)
String username = null;
String fullName = "";
logger.debug("Catalogue Notification called by " + caller.getClient().getId() + " isUser?"+TokensUtils.isUserToken(caller));
if(!TokensUtils.isUserToken(caller)){
GCubeUser jarvis = UserManagerWSBuilder.getInstance().getUserManager().getUserByEmail(LiferayJSONWsCredentials.getSingleton().getUser());
logger.debug("Catalogue Notification called by " + caller.getClient().getId() + " isUser?"
+ TokensUtils.isUserToken(caller));
if (!TokensUtils.isUserToken(caller)) {
GCubeUser jarvis = UserManagerWSBuilder.getInstance().getUserManager()
.getUserByEmail(LiferayJSONWsCredentials.getSingleton().getUser());
SecurityTokenProvider.instance.set(LiferayJSONWsCredentials.getSingleton().getNotifierUserToken());
username = jarvis.getUsername();
fullName = caller.getClient().getId().replace("service-account-", ""); // the actual name of the IAM Client
senderUser = um.getUserByUsername(username);
user = new SocialNetworkingUser(senderUser.getUsername(), senderUser.getEmail(), fullName, senderUser.getUserAvatarURL());
}else{
senderUser = um.getUserByUsername(username);
user = new SocialNetworkingUser(senderUser.getUsername(), senderUser.getEmail(), fullName,
senderUser.getUserAvatarURL());
} else {
username = caller.getClient().getId();
senderUser = um.getUserByUsername(username);
senderUser = um.getUserByUsername(username);
fullName = senderUser.getFullname();
user = new SocialNetworkingUser(senderUser.getUsername(), senderUser.getEmail(), fullName, senderUser.getUserAvatarURL());
}
user = new SocialNetworkingUser(senderUser.getUsername(), senderUser.getEmail(), fullName,
senderUser.getUserAvatarURL());
}
String scope = ScopeProvider.instance.get();
ResponseBean responseBean = new ResponseBean();
Status status = Status.CREATED;
String body = input.getBody();
String subject = input.getSubject();
List<Recipient> recipientsIds = input.getRecipients(); // "recipients":[{"recipient":"id recipient"}, ......]
logger.debug("Sender is going to be [" + fullName + "]");
logger.debug("Sender is going to be [" + fullName + "]");
// get the recipients ids (simple check, trim)
List<String> recipientsListFiltered = new ArrayList<String>();
List<GenericItemBean> recipientsBeans = new ArrayList<GenericItemBean>();
for (Recipient recipientId : recipientsIds) {
try{
try {
String tempId = recipientId.getId().trim();
if(tempId.isEmpty())
if (tempId.isEmpty())
continue;
GCubeUser userRecipient = UserManagerWSBuilder.getInstance().getUserManager().getUserByUsername(tempId);
if(userRecipient == null)
GCubeUser userRecipient = UserManagerWSBuilder.getInstance().getUserManager().getUserByUsername(tempId);
if (userRecipient == null)
userRecipient = UserManagerWSBuilder.getInstance().getUserManager().getUserByEmail(tempId);
if(userRecipient != null){
GenericItemBean beanUser = new GenericItemBean(userRecipient.getUsername(), userRecipient.getUsername(), userRecipient.getFullname(), userRecipient.getUserAvatarURL());
if (userRecipient != null) {
GenericItemBean beanUser = new GenericItemBean(userRecipient.getUsername(),
userRecipient.getUsername(), userRecipient.getFullname(), userRecipient.getUserAvatarURL());
recipientsBeans.add(beanUser);
recipientsListFiltered.add(userRecipient.getUsername());
}
}catch(Exception e){
} catch (Exception e) {
logger.error("Unable to retrieve recipient information for recipient with id " + recipientId, e);
}
}
if(recipientsListFiltered.isEmpty()){
if (recipientsListFiltered.isEmpty()) {
logger.error("Missing/wrong request parameters");
status = Status.BAD_REQUEST;
responseBean.setMessage(ErrorMessages.MISSING_PARAMETERS);
return Response.status(status).entity(responseBean).build();
}
try{
try {
logger.debug("Trying to send message with body " + body + " subject " + subject + " to users " + recipientsIds + " from " + username);
logger.debug("Trying to send message with body " + body + " subject " + subject + " to users "
+ recipientsIds + " from " + username);
// send message
MessageManagerClient client = AbstractPlugin.messages().build();
@ -164,12 +170,13 @@ public class Messages {
// send notification
logger.debug("Message sent to " + recipientsIds + ". Sending message notification to: " + recipientsIds);
SocialNetworkingSite site = SocialNetworkingSiteFinder.getSocialNetworkingSiteFromScope(scope);
NotificationsManager nm = new ApplicationNotificationsManager(UserManagerWSBuilder.getInstance().getUserManager(), site, ScopeProvider.instance.get(), user);
NotificationsManager nm = new ApplicationNotificationsManager(
UserManagerWSBuilder.getInstance().getUserManager(), site, ScopeProvider.instance.get(), user);
new Thread(new MessageNotificationsThread(recipientsBeans, messageId, subject, body, nm)).start();
responseBean.setSuccess(true);
responseBean.setResult(messageId);
}catch(Exception e){
} catch (Exception e) {
logger.error("Unable to send message.", e);
status = Status.INTERNAL_SERVER_ERROR;
responseBean.setMessage(e.toString());
@ -180,15 +187,15 @@ public class Messages {
@GET
@Path("get-sent-messages")
@Produces(MediaType.APPLICATION_JSON)
@StatusCodes ({
@ResponseCode ( code = 200, condition = "Successful read of the sent messages, reported in the 'result' field of the returned object"),
@ResponseCode ( code = 500, condition = ErrorMessages.ERROR_IN_API_RESULT)
@StatusCodes({
@ResponseCode(code = 200, condition = "Successful read of the sent messages, reported in the 'result' field of the returned object"),
@ResponseCode(code = 500, condition = ErrorMessages.ERROR_IN_API_RESULT)
})
/**
*
* @return the list of sent messages of the user (the token's owner)
*/
public Response getSentMessages(){
public Response getSentMessages() {
Caller caller = AuthorizationProvider.instance.get();
String username = caller.getClient().getId();
@ -197,14 +204,14 @@ public class Messages {
logger.debug("Request for retrieving sent messages by " + username);
try{
try {
MessageManagerClient client = AbstractPlugin.messages().build();
List<Message> sentMessages = client.getSentMessages();
Collections.reverse(sentMessages);
responseBean.setSuccess(true);
logger.debug("Result is " + sentMessages);
responseBean.setResult(sentMessages);
}catch(Exception e){
} catch (Exception e) {
logger.error("Unable to retrieve sent messages", e);
responseBean.setMessage(e.getMessage());
status = Status.INTERNAL_SERVER_ERROR;
@ -216,15 +223,15 @@ public class Messages {
@GET
@Path("get-received-messages")
@Produces(MediaType.APPLICATION_JSON)
@StatusCodes ({
@ResponseCode ( code = 200, condition = "Successful read of the received messages, reported in the 'result' field of the returned object"),
@ResponseCode ( code = 500, condition = ErrorMessages.ERROR_IN_API_RESULT)
@StatusCodes({
@ResponseCode(code = 200, condition = "Successful read of the received messages, reported in the 'result' field of the returned object"),
@ResponseCode(code = 500, condition = ErrorMessages.ERROR_IN_API_RESULT)
})
/**
*
* @return the list of received messages of the user (the token's owner)
*/
public Response getReceivedMessages(){
public Response getReceivedMessages() {
Caller caller = AuthorizationProvider.instance.get();
String username = caller.getClient().getId();
@ -232,14 +239,14 @@ public class Messages {
Status status = Status.OK;
logger.debug("Request for retrieving received messages by " + username);
try{
try {
MessageManagerClient client = AbstractPlugin.messages().build();
List<Message> getMessages =client.getReceivedMessages();
List<Message> getMessages = client.getReceivedMessages();
Collections.reverse(getMessages);
responseBean.setSuccess(true);
responseBean.setResult(getMessages);
}catch(Exception e){
} catch (Exception e) {
logger.error("Unable to retrieve sent messages", e);
responseBean.setMessage(e.getMessage());
status = Status.INTERNAL_SERVER_ERROR;
@ -247,49 +254,48 @@ public class Messages {
return Response.status(status).entity(responseBean).build();
}
/**
* Set message read or unread
*
* @param messageId the message identifier
* @param read true to set read, false to set unread
* @param read true to set read, false to set unread
* @return the result of the operation
* @throws ValidationException
*/
@POST
@Path("set-message-read/")
@Produces(MediaType.APPLICATION_JSON)
@StatusCodes ({
@ResponseCode ( code = 200, condition = "Message set Read or Unread is correctly executed"),
@ResponseCode ( code = 500, condition = ErrorMessages.ERROR_IN_API_RESULT)
@StatusCodes({
@ResponseCode(code = 200, condition = "Message set Read or Unread is correctly executed"),
@ResponseCode(code = 500, condition = ErrorMessages.ERROR_IN_API_RESULT)
})
public Response setMessageRead(
@NotNull(message="input is missing")
@FormParam("messageId") String messageId,
@FormParam("read") Boolean read) throws ValidationException{
@NotNull(message = "input is missing") @FormParam("messageId") String messageId,
@FormParam("read") Boolean read) throws ValidationException {
Caller caller = AuthorizationProvider.instance.get();
ResponseBean responseBean = new ResponseBean();
Status status = Status.OK;
String opExecutor = "";
try{
try {
opExecutor = caller.getClient().getId();
MessageManagerClient client = AbstractPlugin.messages().build();
client.setRead(messageId, read);
String toReturn = "set Message id:" + messageId + (read ? " read" : " unread");
logger.debug("set Message id:" + messageId + " read?" + read + " for " + opExecutor);
logger.debug("set Message id:" + messageId + " read?" + read + " for " + opExecutor);
responseBean.setSuccess(true);
responseBean.setResult(toReturn);
} catch(Exception e){
} catch (Exception e) {
logger.error("Unable to set message read / unread property for user " + opExecutor, e);
responseBean.setSuccess(false);
responseBean.setMessage(e.getMessage());
status = Status.INTERNAL_SERVER_ERROR;
}
return Response.status(status).entity(responseBean).build();
}
}

483
src/main/java/org/gcube/portal/social/networking/ws/methods/v2/Notifications.java
View File

@ -4,7 +4,6 @@ import java.io.IOException;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;
import java.util.Map;
import javax.validation.Valid;
import javax.validation.ValidationException;
@ -32,8 +31,6 @@ import org.gcube.common.authorization.library.utils.Caller;
import org.gcube.common.scope.api.ScopeProvider;
import org.gcube.common.scope.impl.ScopeBean;
import org.gcube.portal.databook.shared.Notification;
import org.gcube.portal.databook.shared.NotificationChannelType;
import org.gcube.portal.databook.shared.NotificationType;
import org.gcube.portal.databook.shared.RunningJob;
import org.gcube.portal.notifications.bean.GenericItemBean;
import org.gcube.portal.notifications.thread.JobStatusNotificationThread;
@ -78,12 +75,13 @@ import com.webcohesion.enunciate.metadata.rs.StatusCodes;
/**
* REST interface for the social networking library (notifications).
*
* @author Ahmed Ibrahim ISTI-CNR
*/
@Path("2/notifications")
@RequestHeaders ({
@RequestHeader( name = "Authorization", description = "Bearer token, see https://dev.d4science.org/how-to-access-resources"),
@RequestHeader( name = "Content-Type", description = "application/json")
@RequestHeaders({
@RequestHeader(name = "Authorization", description = "Bearer token, see https://dev.d4science.org/how-to-access-resources"),
@RequestHeader(name = "Content-Type", description = "application/json")
})
public class Notifications {
@ -93,7 +91,8 @@ public class Notifications {
/**
* Retrieve notifications of the token's owner
* @param from must be greater or equal to 1, range[0, infinity]
*
* @param from must be greater or equal to 1, range[0, infinity]
* @param quantity quantity must be greater or equal to 0
* @return notifications up to quantity
* @throws ValidationException
@ -101,32 +100,31 @@ public class Notifications {
@GET
@Path("get-range-notifications/")
@Produces(MediaType.APPLICATION_JSON)
@StatusCodes ({
@ResponseCode ( code = 200, condition = "Notifications retrieved and reported in the 'result' field of the returned object"),
@ResponseCode ( code = 500, condition = ErrorMessages.ERROR_IN_API_RESULT)
@StatusCodes({
@ResponseCode(code = 200, condition = "Notifications retrieved and reported in the 'result' field of the returned object"),
@ResponseCode(code = 500, condition = ErrorMessages.ERROR_IN_API_RESULT)
})
public Response getRangeNotifications(
@DefaultValue("1") @QueryParam("from") @Min(value=1, message="from must be greater or equal to 1")
int from,
@DefaultValue("10") @QueryParam("quantity") @Min(value=0, message="quantity must be greater or equal to 0")
int quantity
) throws ValidationException{
@DefaultValue("1") @QueryParam("from") @Min(value = 1, message = "from must be greater or equal to 1") int from,
@DefaultValue("10") @QueryParam("quantity") @Min(value = 0, message = "quantity must be greater or equal to 0") int quantity)
throws ValidationException {
Caller caller = AuthorizationProvider.instance.get();
String username = caller.getClient().getId();
logger.debug("Retrieving " + quantity + " notifications of user = " + username + " from " + from);
logger.debug("Retrieving " + quantity + " notifications of user = " + username + " from " + from);
ResponseBean responseBean = new ResponseBean();
Status status = Status.OK;
List<Notification> notifications = null;
try{
notifications = CassandraConnection.getInstance().getDatabookStore().getRangeNotificationsByUser(username, from, quantity);
try {
notifications = CassandraConnection.getInstance().getDatabookStore().getRangeNotificationsByUser(username,
from, quantity);
responseBean.setResult(notifications);
responseBean.setSuccess(true);
logger.debug("List of notifications retrieved");
}catch(Exception e){
} catch (Exception e) {
logger.error("Unable to retrieve such notifications.", e);
responseBean.setMessage(e.getMessage());
responseBean.setSuccess(false);
@ -136,35 +134,37 @@ public class Notifications {
return Response.status(status).entity(responseBean).build();
}
/**
* Return whether the notifications for this user are enabled or not
*
* @pathExample /is-user-disabled?username=john.smith
* @responseExample application/json { "success": true, "message": null "result": true }
* @responseExample application/json { "success": true, "message": null
* "result": true }
* @param username the username you want to check
* @return true if the notification for the user are disabled (Catalogue and Workspace ones)
* @return true if the notification for the user are disabled (Catalogue and
* Workspace ones)
*
*/
@GET
@Path("is-user-disabled/")
@Produces(MediaType.APPLICATION_JSON)
@StatusCodes ({
@ResponseCode ( code = 200, condition = "true if the notification for the username given as query param are disabled (Catalogue and Workspace ones), false otherwise"),
@ResponseCode ( code = 500, condition = ErrorMessages.ERROR_IN_API_RESULT)
@StatusCodes({
@ResponseCode(code = 200, condition = "true if the notification for the username given as query param are disabled (Catalogue and Workspace ones), false otherwise"),
@ResponseCode(code = 500, condition = ErrorMessages.ERROR_IN_API_RESULT)
})
@AuthorizationControl(allowedRoles={INFRASTRUCTURE_MANAGER_ROLE}, exception=AuthException.class)
@AuthorizationControl(allowedRoles = { INFRASTRUCTURE_MANAGER_ROLE }, exception = AuthException.class)
public Response isUserDisabled(
@QueryParam("username") @NotNull(message="username cannot be null")
String username) throws ValidationException{
@QueryParam("username") @NotNull(message = "username cannot be null") String username)
throws ValidationException {
ResponseBean responseBean = new ResponseBean();
Status status = Status.OK;
try{
Boolean userDisabled= !isNotificationEnabled(username);
try {
Boolean userDisabled = !isNotificationEnabled(username);
responseBean.setResult(userDisabled);
responseBean.setSuccess(true);
logger.debug("are User " + username + " Notifications Disabled?"+userDisabled);
}catch(Exception e){
logger.debug("are User " + username + " Notifications Disabled?" + userDisabled);
} catch (Exception e) {
logger.error("Unable to read whether the notifications for this user are enabled or not.", e);
responseBean.setMessage(e.getMessage());
responseBean.setSuccess(false);
@ -174,54 +174,59 @@ public class Notifications {
return Response.status(status).entity(responseBean).build();
}
// /**
// * Set user notification enabled or disabled
// * @param disable true if you want to disable the notifications for this user, false if you want to enable them
// * @return the result of the operation
// * @throws ValidationException
// */
// @POST
// @Path("set-user-notifications/")
// @Consumes(MediaType.APPLICATION_JSON)
// @Produces(MediaType.APPLICATION_JSON)
// @StatusCodes ({
// @ResponseCode ( code = 200, condition = "Notification set Off or On correctly executed"),
// @ResponseCode ( code = 500, condition = ErrorMessages.ERROR_IN_API_RESULT)
// })
// @AuthorizationControl(allowedRoles={INFRASTRUCTURE_MANAGER_ROLE}, exception=AuthException.class)
// public Response setUserNotifications(
// @NotNull(message="input is missing")
// @Valid
// UserSetNotificationBean setting) throws ValidationException{
//
// Caller caller = AuthorizationProvider.instance.get();
// String context = ScopeProvider.instance.get();
// ResponseBean responseBean = new ResponseBean();
// Status status = Status.OK;
//
//
// try{
// String opExecutor = caller.getClient().getId();
// Boolean result = setUserNotificationsOnOff(setting.getUsername(), setting.isDisableNotification(), opExecutor);
// String toReturn = "Could not set notifications";
// if (result) {
// toReturn = "Notifications have been set";
// toReturn += setting.isDisableNotification() ? " OFF (for 29 days unless re-enabled manually) ": " ON ";
// toReturn += "for username=" + setting.getUsername();
// }
// responseBean.setSuccess(true);
// responseBean.setResult(toReturn);
//
// } catch(Exception e){
// logger.error("Unable to set user notification", e);
// responseBean.setSuccess(false);
// responseBean.setMessage(e.getMessage());
// status = Status.INTERNAL_SERVER_ERROR;
// }
//
//
// return Response.status(status).entity(responseBean).build();
// }
// /**
// * Set user notification enabled or disabled
// * @param disable true if you want to disable the notifications for this user,
// false if you want to enable them
// * @return the result of the operation
// * @throws ValidationException
// */
// @POST
// @Path("set-user-notifications/")
// @Consumes(MediaType.APPLICATION_JSON)
// @Produces(MediaType.APPLICATION_JSON)
// @StatusCodes ({
// @ResponseCode ( code = 200, condition = "Notification set Off or On correctly
// executed"),
// @ResponseCode ( code = 500, condition = ErrorMessages.ERROR_IN_API_RESULT)
// })
// @AuthorizationControl(allowedRoles={INFRASTRUCTURE_MANAGER_ROLE},
// exception=AuthException.class)
// public Response setUserNotifications(
// @NotNull(message="input is missing")
// @Valid
// UserSetNotificationBean setting) throws ValidationException{
//
// Caller caller = AuthorizationProvider.instance.get();
// String context = ScopeProvider.instance.get();
// ResponseBean responseBean = new ResponseBean();
// Status status = Status.OK;
//
//
// try{
// String opExecutor = caller.getClient().getId();
// Boolean result = setUserNotificationsOnOff(setting.getUsername(),
// setting.isDisableNotification(), opExecutor);
// String toReturn = "Could not set notifications";
// if (result) {
// toReturn = "Notifications have been set";
// toReturn += setting.isDisableNotification() ? " OFF (for 29 days unless
// re-enabled manually) ": " ON ";
// toReturn += "for username=" + setting.getUsername();
// }
// responseBean.setSuccess(true);
// responseBean.setResult(toReturn);
//
// } catch(Exception e){
// logger.error("Unable to set user notification", e);
// responseBean.setSuccess(false);
// responseBean.setMessage(e.getMessage());
// status = Status.INTERNAL_SERVER_ERROR;
// }
//
//
// return Response.status(status).entity(responseBean).build();
// }
/**
* @deprecated
@ -230,45 +235,50 @@ public class Notifications {
* @throws IOException
*/
private boolean isNotificationEnabled(String usernameToCheck) throws IOException {
// MemcachedClient entries = new DistributedCacheClient().getMemcachedClient();
// String key = SocialUtils.DISABLED_USERS_NOTIFICATIONS_NAMESPACE+usernameToCheck;
// Boolean userEnabled = false;
// if(entries.get(key) == null)
// userEnabled = true;
// entries.getConnection().shutdown();
// return userEnabled;
// MemcachedClient entries = new DistributedCacheClient().getMemcachedClient();
// String key =
// SocialUtils.DISABLED_USERS_NOTIFICATIONS_NAMESPACE+usernameToCheck;
// Boolean userEnabled = false;
// if(entries.get(key) == null)
// userEnabled = true;
// entries.getConnection().shutdown();
// return userEnabled;
return true;
}
// /**
// *
// * @param username the user you want to disable or enable notifications (max 29 days)
// * @param callerId the username or clientid of the operation executor
// * @param disable true if you want to disable the notifications for this user
// * @return true if the operation was performed
// * @throws IOException
// */
// private Boolean setUserNotificationsOnOff(String username, boolean disable, String callerId) throws IOException {
// MemcachedClient entries = new DistributedCacheClient().getMemcachedClient();
// String key = SocialUtils.DISABLED_USERS_NOTIFICATIONS_NAMESPACE+username;
// OperationFuture<Boolean> result = null;
// if (disable) {
// result = entries.set(key, SocialUtils.CACHING_TIME_TO_EXPIRATION, "op.ex:" + callerId); //operator executor is who silenced the user
// } else {
// result = entries.delete(key);
// }
// try {
// boolean res = result.getStatus().isSuccess();
// entries.getConnection().shutdown();
// return res;
// } catch (Exception e) {
// entries.getConnection().shutdown();
// e.printStackTrace();
// }
// return null;
// }
// /**
// *
// * @param username the user you want to disable or enable notifications (max
// 29 days)
// * @param callerId the username or clientid of the operation executor
// * @param disable true if you want to disable the notifications for this user
// * @return true if the operation was performed
// * @throws IOException
// */
// private Boolean setUserNotificationsOnOff(String username, boolean disable,
// String callerId) throws IOException {
// MemcachedClient entries = new DistributedCacheClient().getMemcachedClient();
// String key = SocialUtils.DISABLED_USERS_NOTIFICATIONS_NAMESPACE+username;
// OperationFuture<Boolean> result = null;
// if (disable) {
// result = entries.set(key, SocialUtils.CACHING_TIME_TO_EXPIRATION, "op.ex:" +
// callerId); //operator executor is who silenced the user
// } else {
// result = entries.delete(key);
// }
// try {
// boolean res = result.getStatus().isSuccess();
// entries.getConnection().shutdown();
// return res;
// } catch (Exception e) {
// entries.getConnection().shutdown();
// e.printStackTrace();
// }
// return null;
// }
/**
* Send a JOB notification to a given recipient
*
* @param job The job bean
* @return
* @throws ValidationException
@ -277,34 +287,36 @@ public class Notifications {
@Path("notify-job-status/")
@Consumes(MediaType.APPLICATION_JSON)
@Produces(MediaType.APPLICATION_JSON)
@StatusCodes ({
@ResponseCode ( code = 200, condition = "Notification is sent correctly"),
@ResponseCode ( code = 500, condition = ErrorMessages.ERROR_IN_API_RESULT)
@StatusCodes({
@ResponseCode(code = 200, condition = "Notification is sent correctly"),
@ResponseCode(code = 500, condition = ErrorMessages.ERROR_IN_API_RESULT)
})
public Response notifyJobStatus(
@NotNull(message="input is missing")
@Valid
JobNotificationBean job) throws ValidationException{
@NotNull(message = "input is missing") @Valid JobNotificationBean job) throws ValidationException {
Caller caller = AuthorizationProvider.instance.get();
String context = ScopeProvider.instance.get();
String context = ScopeProvider.instance.get();
ResponseBean responseBean = new ResponseBean();
Status status = Status.OK;
String appQualifier = caller.getClient().getId();
logger.debug("Received request from app " + appQualifier + " to notify job status described by bean " + job);
try{
try {
String recipient = job.getRecipient();
GCubeUser userRecipient = UserManagerWSBuilder.getInstance().getUserManager().getUserByUsername(recipient);
GenericItemBean recipientBean = new GenericItemBean(userRecipient.getUsername(), userRecipient.getUsername(), userRecipient.getFullname(), userRecipient.getUserAvatarURL());
GenericItemBean recipientBean = new GenericItemBean(userRecipient.getUsername(),
userRecipient.getUsername(), userRecipient.getFullname(), userRecipient.getUserAvatarURL());
// notifications are sent by using the user allowed to use liferay's json apis
SocialNetworkingSite site = SocialNetworkingSiteFinder.getSocialNetworkingSiteFromScope(context);
GCubeUser senderUser = UserManagerWSBuilder.getInstance().getUserManager().getUserByEmail(LiferayJSONWsCredentials.getSingleton().getUser());
SocialNetworkingUser user = new SocialNetworkingUser(senderUser.getUsername(), senderUser.getEmail(), senderUser.getFullname(), senderUser.getUserAvatarURL());
NotificationsManager nm = new ApplicationNotificationsManager(UserManagerWSBuilder.getInstance().getUserManager(), site, context, user);
GCubeUser senderUser = UserManagerWSBuilder.getInstance().getUserManager()
.getUserByEmail(LiferayJSONWsCredentials.getSingleton().getUser());
SocialNetworkingUser user = new SocialNetworkingUser(senderUser.getUsername(), senderUser.getEmail(),
senderUser.getFullname(), senderUser.getUserAvatarURL());
NotificationsManager nm = new ApplicationNotificationsManager(
UserManagerWSBuilder.getInstance().getUserManager(), site, context, user);
RunningJob theJob = JobMapper.getJob(job);
@ -312,19 +324,19 @@ public class Notifications {
responseBean.setSuccess(true);
responseBean.setResult("Notification thread started");
}catch(Exception e){
} catch (Exception e) {
logger.error("Unable to send job notification", e);
responseBean.setSuccess(false);
responseBean.setMessage(e.getMessage());
status = Status.INTERNAL_SERVER_ERROR;
}
return Response.status(status).entity(responseBean).build();
}
/**
* Send a Catalogue notification to a given user
*
* @param event
* @return
* @throws ValidationException
@ -333,87 +345,89 @@ public class Notifications {
@Path("catalogue/")
@Consumes(MediaType.APPLICATION_JSON)
@Produces(MediaType.APPLICATION_JSON)
@StatusCodes ({
@ResponseCode ( code = 200, condition = "Catalogue Notification is sent correctly"),
@ResponseCode ( code = 500, condition = ErrorMessages.ERROR_IN_API_RESULT)
@StatusCodes({
@ResponseCode(code = 200, condition = "Catalogue Notification is sent correctly"),
@ResponseCode(code = 500, condition = ErrorMessages.ERROR_IN_API_RESULT)
})
public Response catalogue(
@NotNull(message="input is missing")
@Valid
CatalogueEvent event) throws ValidationException, UserManagementSystemException, UserRetrievalFault{
@NotNull(message = "input is missing") @Valid CatalogueEvent event)
throws ValidationException, UserManagementSystemException, UserRetrievalFault {
Caller caller = AuthorizationProvider.instance.get();
UserManager um = UserManagerWSBuilder.getInstance().getUserManager();
GCubeUser senderUser = null;
SocialNetworkingUser user = null;
// check if the token belongs to an application token. In this case use J.A.R.V.I.S (the username used to communicate with Liferay)
// check if the token belongs to an application token. In this case use
// J.A.R.V.I.S (the username used to communicate with Liferay)
String username = null;
String fullName = "";
logger.debug("Catalogue Notification called by " + caller.getClient().getId() + " isUser?"+TokensUtils.isUserToken(caller));
if(!TokensUtils.isUserToken(caller)){
GCubeUser jarvis = UserManagerWSBuilder.getInstance().getUserManager().getUserByEmail(LiferayJSONWsCredentials.getSingleton().getUser());
logger.debug("Catalogue Notification called by " + caller.getClient().getId() + " isUser?"
+ TokensUtils.isUserToken(caller));
if (!TokensUtils.isUserToken(caller)) {
GCubeUser jarvis = UserManagerWSBuilder.getInstance().getUserManager()
.getUserByEmail(LiferayJSONWsCredentials.getSingleton().getUser());
SecurityTokenProvider.instance.set(LiferayJSONWsCredentials.getSingleton().getNotifierUserToken());
username = jarvis.getUsername();
fullName = caller.getClient().getId().replace("service-account-", ""); // the actual name of the IAM Client
senderUser = um.getUserByUsername(username);
user = new SocialNetworkingUser(senderUser.getUsername(), senderUser.getEmail(), fullName, senderUser.getUserAvatarURL());
}else{
user = new SocialNetworkingUser(senderUser.getUsername(), senderUser.getEmail(), fullName,
senderUser.getUserAvatarURL());
} else {
username = caller.getClient().getId();
senderUser = um.getUserByUsername(username);
user = new SocialNetworkingUser(senderUser.getUsername(), senderUser.getEmail(), senderUser.getFullname(), senderUser.getUserAvatarURL());
user = new SocialNetworkingUser(senderUser.getUsername(), senderUser.getEmail(), senderUser.getFullname(),
senderUser.getUserAvatarURL());
}
String context = ScopeProvider.instance.get();
String context = ScopeProvider.instance.get();
logger.debug("catalogue notifications from user = " + username);
ResponseBean responseBean = new ResponseBean();
Status status = Status.OK;
boolean deliveryResult = false;
try {
//logger.debug("catalogue notifications type is " + event.getType());
// logger.debug("catalogue notifications type is " + event.getType());
SocialNetworkingSite site = SocialNetworkingSiteFinder.getSocialNetworkingSiteFromScope(context);
//logger.debug("social networking site is " + site.getName());
//logger.debug("context is " + context);
//logger.debug("user is " + user.getUsername());
// logger.debug("social networking site is " + site.getName());
// logger.debug("context is " + context);
// logger.debug("user is " + user.getUsername());
NotificationsManager nm = new ApplicationNotificationsManager(UserManagerWSBuilder.getInstance().getUserManager(), site, context, user);
NotificationsManager nm = new ApplicationNotificationsManager(
UserManagerWSBuilder.getInstance().getUserManager(), site, context, user);
String[] idsToNotify = event.getIdsToNotify();
if (! event.idsAsGroup()) {
if (!event.idsAsGroup()) {
for (int i = 0; i < idsToNotify.length; i++) {
String userIdToNotify = idsToNotify[i];
if (isNotificationEnabled(userIdToNotify)) {
String username2Notify = null;
try {
username2Notify = um.getUserByUsername(userIdToNotify).getUsername();
}
catch (Exception e) {
} catch (Exception e) {
status = Status.BAD_REQUEST;
logger.error("Username not found", e);
responseBean.setSuccess(false);
responseBean.setMessage("Username not found, got: " + userIdToNotify);
return Response.status(status).entity(responseBean).build();
}
//logger.debug("username2notify " + username2Notify);
//logger.debug("type is " + CatalogueEventTypeMapper.getType(event.getType()));
//logger.debug("item id is " + event.getItemId());
//logger.debug("item text is " + event.getNotifyText());
//logger.debug("item url is " + event.getItemURL());
deliveryResult =
nm.notifyCatalogueEvent(
CatalogueEventTypeMapper.getType(event.getType()),
username2Notify,
event.getItemId(),
event.getNotifyText(),
event.getItemURL());
}
else {
Log.info("Notification disabled (admin) for user "+userIdToNotify + " will not notify");
// logger.debug("username2notify " + username2Notify);
// logger.debug("type is " + CatalogueEventTypeMapper.getType(event.getType()));
// logger.debug("item id is " + event.getItemId());
// logger.debug("item text is " + event.getNotifyText());
// logger.debug("item url is " + event.getItemURL());
deliveryResult = nm.notifyCatalogueEvent(
CatalogueEventTypeMapper.getType(event.getType()),
username2Notify,
event.getItemId(),
event.getNotifyText(),
event.getItemURL());
} else {
Log.info("Notification disabled (admin) for user " + userIdToNotify + " will not notify");
}
}
} else { //the ids are contexts
} else { // the ids are contexts
for (int i = 0; i < idsToNotify.length; i++) {
String contextId = idsToNotify[i];
try {
@ -425,24 +439,25 @@ public class Notifications {
responseBean.setMessage("Not a VRE Context, only VREs are supported");
return Response.status(status).entity(responseBean).build();
} else { // it is a context and it is a valid VRE
String[] userIdsToNotify = getUsernamesByContext(scope).toArray(new String[0]); //resolve the members
String[] userIdsToNotify = getUsernamesByContext(scope).toArray(new String[0]); // resolve
// the
// members
for (int j = 0; j < userIdsToNotify.length; j++) {
String userIdToNotify = userIdsToNotify[j];
if (isNotificationEnabled(userIdToNotify)) {
deliveryResult =
nm.notifyCatalogueEvent(
CatalogueEventTypeMapper.getType(event.getType()),
userIdToNotify,
event.getItemId(),
event.getNotifyText(),
event.getItemURL());
deliveryResult = nm.notifyCatalogueEvent(
CatalogueEventTypeMapper.getType(event.getType()),
userIdToNotify,
event.getItemId(),
event.getNotifyText(),
event.getItemURL());
} else {
Log.info("Notification disabled (admin) for user "+userIdToNotify + " will not notify");
Log.info("Notification disabled (admin) for user " + userIdToNotify
+ " will not notify");
}
}
}
}
catch(IllegalArgumentException e) {
} catch (IllegalArgumentException e) {
status = Status.BAD_REQUEST;
logger.error("Context not valid", e);
responseBean.setSuccess(false);
@ -451,7 +466,7 @@ public class Notifications {
}
}
}
} catch(Exception e){
} catch (Exception e) {
logger.error("Unable to send job notification", e);
responseBean.setSuccess(false);
responseBean.setMessage(e.getMessage());
@ -464,7 +479,8 @@ public class Notifications {
responseBean.setResult(new Boolean(true));
} else {
responseBean.setSuccess(false);
responseBean.setMessage("An error occurred between this service and Cassandra DB, notification not delivered correctly");
responseBean.setMessage(
"An error occurred between this service and Cassandra DB, notification not delivered correctly");
responseBean.setResult(new Boolean(false));
}
return Response.status(status).entity(responseBean).build();
@ -472,6 +488,7 @@ public class Notifications {
/**
* Send a Workspace notification to a given user
*
* @param event
* @return
* @throws ValidationException
@ -480,17 +497,15 @@ public class Notifications {
@Path("workspace/")
@Consumes(MediaType.APPLICATION_JSON)
@Produces(MediaType.APPLICATION_JSON)
@StatusCodes ({
@ResponseCode ( code = 200, condition = "Workspace Notification is sent correctly"),
@ResponseCode ( code = 500, condition = ErrorMessages.ERROR_IN_API_RESULT)
@StatusCodes({
@ResponseCode(code = 200, condition = "Workspace Notification is sent correctly"),
@ResponseCode(code = 500, condition = ErrorMessages.ERROR_IN_API_RESULT)
})
public Response workspace(
@NotNull(message="input is missing")
@Valid
WorkspaceEvent event) throws ValidationException{
@NotNull(message = "input is missing") @Valid WorkspaceEvent event) throws ValidationException {
Caller caller = AuthorizationProvider.instance.get();
String context = ScopeProvider.instance.get();
String context = ScopeProvider.instance.get();
String username = caller.getClient().getId();
logger.debug("workspace notifications from = " + username);
@ -504,44 +519,48 @@ public class Notifications {
logger.debug("workspace notifications type is " + event.getType());
SocialNetworkingSite site = SocialNetworkingSiteFinder.getSocialNetworkingSiteFromScope(context);
UserManager um = UserManagerWSBuilder.getInstance().getUserManager();
logger.debug("Workspace Notification called by " + caller.getClient().getId() + " isUser?"+TokensUtils.isUserToken(caller));
if(!TokensUtils.isUserToken(caller)){
GCubeUser jarvis = UserManagerWSBuilder.getInstance().getUserManager().getUserByEmail(LiferayJSONWsCredentials.getSingleton().getUser());
logger.debug("Workspace Notification called by " + caller.getClient().getId() + " isUser?"
+ TokensUtils.isUserToken(caller));
if (!TokensUtils.isUserToken(caller)) {
GCubeUser jarvis = UserManagerWSBuilder.getInstance().getUserManager()
.getUserByEmail(LiferayJSONWsCredentials.getSingleton().getUser());
SecurityTokenProvider.instance.set(LiferayJSONWsCredentials.getSingleton().getNotifierUserToken());
username = jarvis.getUsername();
fullName = caller.getClient().getId().replace("service-account-", ""); // the actual name of the IAM Client
fullName = caller.getClient().getId().replace("service-account-", ""); // the actual name of the IAM
// Client
senderUser = um.getUserByUsername(username);
user = new SocialNetworkingUser(senderUser.getUsername(), senderUser.getEmail(), fullName, senderUser.getUserAvatarURL());
}else{
user = new SocialNetworkingUser(senderUser.getUsername(), senderUser.getEmail(), fullName,
senderUser.getUserAvatarURL());
} else {
username = caller.getClient().getId();
senderUser = um.getUserByUsername(username);
user = new SocialNetworkingUser(senderUser.getUsername(), senderUser.getEmail(), senderUser.getFullname(), senderUser.getUserAvatarURL());
user = new SocialNetworkingUser(senderUser.getUsername(), senderUser.getEmail(),
senderUser.getFullname(), senderUser.getUserAvatarURL());
}
NotificationsManager nm = new ApplicationNotificationsManager(UserManagerWSBuilder.getInstance().getUserManager(), site, context, user);
NotificationsManager nm = new ApplicationNotificationsManager(
UserManagerWSBuilder.getInstance().getUserManager(), site, context, user);
String[] idsToNotify = event.getIdsToNotify();
if (! event.idsAsGroup()) {
if (!event.idsAsGroup()) {
for (int i = 0; i < idsToNotify.length; i++) {
String userIdToNotify = idsToNotify[i];
if (isNotificationEnabled(userIdToNotify)) {
String username2Notify = "";
try {
username2Notify = um.getUserByUsername(userIdToNotify).getUsername();
}
catch (Exception e) {
} catch (Exception e) {
status = Status.NOT_ACCEPTABLE;
logger.error("Username not found", e);
responseBean.setSuccess(false);
responseBean.setMessage("Username not found, received: " + userIdToNotify);
return Response.status(status).entity(responseBean).build();
}
deliveryResult = notifyWorkspaceEvent(event, nm, username2Notify);
}
else {
Log.info("Notification disabled (admin) for user "+userIdToNotify + " will not notify");
deliveryResult = notifyWorkspaceEvent(event, nm, username2Notify);
} else {
Log.info("Notification disabled (admin) for user " + userIdToNotify + " will not notify");
}
}
} else { //the ids are contexts
} else { // the ids are contexts
for (int i = 0; i < idsToNotify.length; i++) {
String contextId = idsToNotify[i];
try {
@ -553,18 +572,20 @@ public class Notifications {
responseBean.setMessage("Not a VRE Context, only VREs are supported");
return Response.status(status).entity(responseBean).build();
} else { // it is a context and it is a valid VRE
String[] userIdsToNotify = getUsernamesByContext(scope).toArray(new String[0]); //resolve the members
String[] userIdsToNotify = getUsernamesByContext(scope).toArray(new String[0]); // resolve
// the
// members
for (int j = 0; j < userIdsToNotify.length; j++) {
String userIdToNotify = userIdsToNotify[j];
if (isNotificationEnabled(userIdToNotify))
deliveryResult = notifyWorkspaceEvent(event, nm, userIdToNotify);
deliveryResult = notifyWorkspaceEvent(event, nm, userIdToNotify);
else {
Log.info("Notification disabled (admin) for user "+userIdToNotify + " will not notify");
Log.info("Notification disabled (admin) for user " + userIdToNotify
+ " will not notify");
}
}
}
}
catch(IllegalArgumentException e) {
} catch (IllegalArgumentException e) {
status = Status.BAD_REQUEST;
logger.error("Context not valid", e);
responseBean.setSuccess(false);
@ -573,7 +594,7 @@ public class Notifications {
}
}
}
} catch(Exception e){
} catch (Exception e) {
logger.error("Unable to send job notification", e);
responseBean.setSuccess(false);
responseBean.setMessage(e.getMessage());
@ -586,11 +607,13 @@ public class Notifications {
responseBean.setResult(new Boolean(true));
} else {
responseBean.setSuccess(false);
responseBean.setMessage("An error occurred between this service and Cassandra DB, notification not delivered correctly");
responseBean.setMessage(
"An error occurred between this service and Cassandra DB, notification not delivered correctly");
responseBean.setResult(new Boolean(false));
}
return Response.status(status).entity(responseBean).build();
}
/**
*
* @param event
@ -603,54 +626,66 @@ public class Notifications {
switch (event.getType()) {
case ITEM_NEW: {
AddedItemEvent itemBean = (AddedItemEvent) event;
return nm.notifyAddedItem(idToNotify, WorkspaceItemMapper.getFileItem(itemBean.getItem()), WorkspaceItemMapper.getSharedFolder(itemBean.getItem().getParent()));
return nm.notifyAddedItem(idToNotify, WorkspaceItemMapper.getFileItem(itemBean.getItem()),
WorkspaceItemMapper.getSharedFolder(itemBean.getItem().getParent()));
}
case ITEM_UPDATE: {
UpdatedItemEvent itemBean = (UpdatedItemEvent) event;
return nm.notifyUpdatedItem(idToNotify, WorkspaceItemMapper.getFileItem(itemBean.getItem()), WorkspaceItemMapper.getSharedFolder(itemBean.getItem().getParent()));
return nm.notifyUpdatedItem(idToNotify, WorkspaceItemMapper.getFileItem(itemBean.getItem()),
WorkspaceItemMapper.getSharedFolder(itemBean.getItem().getParent()));
}
case ITEM_DELETE: {
DeletedItemEvent itemBean = (DeletedItemEvent) event;
return nm.notifyRemovedItem(idToNotify, itemBean.getItemName(), WorkspaceItemMapper.getSharedFolder(itemBean.getFolder()));
return nm.notifyRemovedItem(idToNotify, itemBean.getItemName(),
WorkspaceItemMapper.getSharedFolder(itemBean.getFolder()));
}
case FOLDER_SHARE: {
SharedFolderEvent itemBean = (SharedFolderEvent) event;
return nm.notifyFolderSharing(idToNotify, WorkspaceItemMapper.getSharedFolder(itemBean.getFolder()));
return nm.notifyFolderSharing(idToNotify,
WorkspaceItemMapper.getSharedFolder(itemBean.getFolder()));
}
case FOLDER_UNSHARE: {
UnsharedFolderEvent itemBean = (UnsharedFolderEvent) event;
return nm.notifyFolderUnsharing(idToNotify, itemBean.getUnsharedFolderId(), itemBean.getUnsharedFolderName());
return nm.notifyFolderUnsharing(idToNotify, itemBean.getUnsharedFolderId(),
itemBean.getUnsharedFolderName());
}
case FOLDER_RENAME: {
RenamedFolderEvent itemBean = (RenamedFolderEvent) event;
return nm.notifyFolderRenaming(idToNotify, itemBean.getPreviousName(), itemBean.getNewName(), itemBean.getRenamedFolderId());
return nm.notifyFolderRenaming(idToNotify, itemBean.getPreviousName(), itemBean.getNewName(),
itemBean.getRenamedFolderId());
}
case FOLDER_ADMIN_UPGRADE: {
FolderAdminUpgradeEvent itemBean = (FolderAdminUpgradeEvent) event;
return nm.notifyAdministratorUpgrade(idToNotify, WorkspaceItemMapper.getSharedFolder(itemBean.getFolder()));
return nm.notifyAdministratorUpgrade(idToNotify,
WorkspaceItemMapper.getSharedFolder(itemBean.getFolder()));
}
case FOLDER_ADMIN_DOWNGRADE: {
FolderAdminDowngradeEvent itemBean = (FolderAdminDowngradeEvent) event;
return nm.notifyAdministratorDowngrade(idToNotify, WorkspaceItemMapper.getSharedFolder(itemBean.getFolder()));
return nm.notifyAdministratorDowngrade(idToNotify,
WorkspaceItemMapper.getSharedFolder(itemBean.getFolder()));
}
case FOLDER_ADDEDUSER: {
FolderAddedUserEvent itemBean = (FolderAddedUserEvent) event;
UserManager userManager = UserManagerWSBuilder.getInstance().getUserManager();
return nm.notifyFolderAddedUsers(idToNotify, WorkspaceItemMapper.getSharedFolder(itemBean.getFolder()), itemBean.getNewAddedUserIds(), userManager);
return nm.notifyFolderAddedUsers(idToNotify,
WorkspaceItemMapper.getSharedFolder(itemBean.getFolder()), itemBean.getNewAddedUserIds(),
userManager);
}
case FOLDER_REMOVEDUSER: {
FolderRemovedUserEvent itemBean = (FolderRemovedUserEvent) event;
return nm.notifyFolderRemovedUser(idToNotify, WorkspaceItemMapper.getSharedFolder(itemBean.getFolder()));
return nm.notifyFolderRemovedUser(idToNotify,
WorkspaceItemMapper.getSharedFolder(itemBean.getFolder()));
}
default:
break;
}
} catch(Exception e){
} catch (Exception e) {
logger.error("Unable to send job notification", e);
return false;
}
return false;
}
/**
*
* @param context
@ -670,13 +705,13 @@ public class Notifications {
UsersCache cache = UsersCache.getSingleton();
for (Long userId : userIds) {
if(cache.getUser(userId) == null){
if (cache.getUser(userId) == null) {
GCubeUser theUser = userManager.getUserById(userId);
if(theUser != null){
if (theUser != null) {
usernames.add(theUser.getUsername());
cache.pushEntry(userId, theUser);
}
}else
} else
usernames.add(cache.getUser(userId).getUsername());
}
return usernames;

36
src/main/java/org/gcube/portal/social/networking/ws/methods/v2/People.java
View File

@ -33,31 +33,34 @@ import com.webcohesion.enunciate.metadata.rs.RequestHeaders;
import com.webcohesion.enunciate.metadata.rs.ResponseCode;
import com.webcohesion.enunciate.metadata.rs.StatusCodes;
/**
* REST interface for the social service (people). Used by OAUTH 2.0 apps/users.
*/
@RequestHeaders ({
@RequestHeader( name = "Authorization", description = "Bearer token, see https://dev.d4science.org/how-to-access-resources"),
@RequestHeader( name = "Content-Type", description = "application/json")
})
@RequestHeaders({
@RequestHeader(name = "Authorization", description = "Bearer token, see https://dev.d4science.org/how-to-access-resources"),
@RequestHeader(name = "Content-Type", description = "application/json")
})
@Path("2/people")
public class People {
private static final org.slf4j.Logger logger = LoggerFactory.getLogger(People.class);
/**
* @responseExample application/json { "success" : true, "message" : null, "result" : { "roles" : [ ], "context" : "***", "avatar" : "https://*****3D", "fullname" : "John Smith", "username" : "john.smith" } }
* @return the user's profile. The user in this case is the one bound to the token
* @responseExample application/json { "success" : true, "message" : null,
* "result" : { "roles" : [ ], "context" : "***", "avatar" :
* "https://*****3D", "fullname" : "John Smith", "username" :
* "john.smith" } }
* @return the user's profile. The user in this case is the one bound to the
* token
*/
@Produces(MediaType.APPLICATION_JSON)
@GET
@Path("profile")
@StatusCodes ({
@ResponseCode ( code = 200, condition = "Successful retrieval of user's profile, reported in the 'result' field of the returned object"),
@ResponseCode ( code = 500, condition = ErrorMessages.ERROR_IN_API_RESULT)
@StatusCodes({
@ResponseCode(code = 200, condition = "Successful retrieval of user's profile, reported in the 'result' field of the returned object"),
@ResponseCode(code = 500, condition = ErrorMessages.ERROR_IN_API_RESULT)
})
public Response getProfile(){
public Response getProfile() {
Caller caller = AuthorizationProvider.instance.get();
String username = caller.getClient().getId();
@ -66,13 +69,13 @@ public class People {
ResponseBean responseBean = new ResponseBean();
Status status = Status.OK;
if(!TokensUtils.isUserToken(caller)){
if (!TokensUtils.isUserToken(caller)) {
status = Status.FORBIDDEN;
responseBean.setMessage("User's information can only be retrieved through a user token");
logger.warn("Trying to access users method via a token different than 'user-token' is not allowed");
}else{
} else {
try{
try {
UserManager userManager = UserManagerWSBuilder.getInstance().getUserManager();
RoleManager roleManager = RoleManagerWSBuilder.getInstance().getRoleManager();
GroupManager groupManager = GroupManagerWSBuilder.getInstance().getGroupManager();
@ -83,7 +86,8 @@ public class People {
toReturn.put("avatar", user.getUserAvatarURL());
toReturn.put("fullname", user.getFullname());
toReturn.put("context", scope);
List<GCubeRole> roles = roleManager.listRolesByUserAndGroup(user.getUserId(), groupManager.getGroupIdFromInfrastructureScope(scope));
List<GCubeRole> roles = roleManager.listRolesByUserAndGroup(user.getUserId(),
groupManager.getGroupIdFromInfrastructureScope(scope));
List<String> rolesNames = new ArrayList<String>();
for (GCubeRole gCubeRole : roles) {
rolesNames.add(gCubeRole.getRoleName());
@ -92,7 +96,7 @@ public class People {
responseBean.setResult(toReturn);
responseBean.setSuccess(true);
}catch(Exception e){
} catch (Exception e) {
logger.error("Unable to retrieve user's profile", e);
responseBean.setMessage(e.getMessage());
status = Status.INTERNAL_SERVER_ERROR;

292
src/main/java/org/gcube/portal/social/networking/ws/methods/v2/Posts.java
View File

@ -1,9 +1,7 @@
package org.gcube.portal.social.networking.ws.methods.v2;
import java.util.ArrayList;
import java.util.List;
import java.util.Map;
import javax.validation.Valid;
import javax.validation.ValidationException;
@ -19,13 +17,16 @@ import javax.ws.rs.QueryParam;
import javax.ws.rs.core.MediaType;
import javax.ws.rs.core.Response;
import javax.ws.rs.core.Response.Status;
import org.gcube.portal.databook.shared.PostWithAttachment;
import org.gcube.common.authorization.library.provider.AuthorizationProvider;
import org.gcube.common.authorization.library.utils.Caller;
import org.gcube.common.scope.api.ScopeProvider;
import org.gcube.portal.databook.server.DatabookStore;
import org.gcube.portal.databook.shared.*;
import org.gcube.portal.databook.shared.ApplicationProfile;
import org.gcube.portal.databook.shared.Attachment;
import org.gcube.portal.databook.shared.Post;
import org.gcube.portal.databook.shared.PostWithAttachment;
import org.gcube.portal.databook.shared.RangePosts;
import org.gcube.portal.databook.shared.ex.ColumnNameNotFoundException;
import org.gcube.portal.databook.shared.ex.FeedIDNotFoundException;
import org.gcube.portal.databook.shared.ex.FeedTypeNotFoundException;
@ -45,12 +46,13 @@ import com.webcohesion.enunciate.metadata.rs.StatusCodes;
/**
* REST interface for the social networking library (posts).
*
* @author Ahmed Ibrahim ISTI-CNR
*/
@Path("2/posts")
@RequestHeaders ({
@RequestHeader( name = "Authorization", description = "Bearer token, see https://dev.d4science.org/how-to-access-resources"),
@RequestHeader( name = "Content-Type", description = "application/json")
@RequestHeaders({
@RequestHeader(name = "Authorization", description = "Bearer token, see https://dev.d4science.org/how-to-access-resources"),
@RequestHeader(name = "Content-Type", description = "application/json")
})
public class Posts {
@ -58,7 +60,8 @@ public class Posts {
private static final org.slf4j.Logger logger = LoggerFactory.getLogger(Posts.class);
/**
* Retrieve posts of the auth token's owner, and allow to filter them by time"
* Retrieve posts of the auth token's owner, and allow to filter them by time"
*
* @param timeInMillis The reference time since when retrieving posts
* @return the posts
* @throws ValidationException
@ -66,14 +69,13 @@ public class Posts {
@GET
@Path("get-posts-user-since/")
@Produces(MediaType.APPLICATION_JSON)
@StatusCodes ({
@ResponseCode ( code = 200, condition = "Successful retrieval of posts, reported in the 'result' field of the returned object"),
@ResponseCode ( code = 500, condition = ErrorMessages.ERROR_IN_API_RESULT)
@StatusCodes({
@ResponseCode(code = 200, condition = "Successful retrieval of posts, reported in the 'result' field of the returned object"),
@ResponseCode(code = 500, condition = ErrorMessages.ERROR_IN_API_RESULT)
})
public Response getRecentPostsByUserAndDate(
@QueryParam("time") @Min(value = 0, message="time cannot be negative")
long timeInMillis
) throws ValidationException{
@QueryParam("time") @Min(value = 0, message = "time cannot be negative") long timeInMillis)
throws ValidationException {
ResponseBean responseBean = new ResponseBean();
Status status = Status.OK;
@ -82,16 +84,17 @@ public class Posts {
String username = caller.getClient().getId();
List<Post> posts = null;
try{
try {
logger.debug("Retrieving post for user id " + username + " and reference time " + timeInMillis);
posts = CassandraConnection.getInstance().getDatabookStore().getRecentPostsByUserAndDate(username, timeInMillis);
posts = CassandraConnection.getInstance().getDatabookStore().getRecentPostsByUserAndDate(username,
timeInMillis);
Filters.filterPostsPerContext(posts, context);
Filters.hideSensitiveInformation(posts, caller.getClient().getId());
responseBean.setResult(posts);
responseBean.setMessage("");
responseBean.setSuccess(true);
}catch(Exception e){
} catch (Exception e) {
logger.error("Unable to retrieve such posts.", e);
responseBean.setMessage(e.getMessage());
responseBean.setSuccess(false);
@ -101,17 +104,18 @@ public class Posts {
return Response.status(status).entity(responseBean).build();
}
/**
* Retrieve all user's posts
* @return all posts of the auth token's owner in the context identified by the token
*
* @return all posts of the auth token's owner in the context identified by the
* token
*/
@GET
@Path("get-posts-user/")
@Produces(MediaType.APPLICATION_JSON)
@StatusCodes ({
@ResponseCode ( code = 200, condition = "Successful retrieval of posts, reported in the 'result' field of the returned object"),
@ResponseCode ( code = 500, condition = ErrorMessages.ERROR_IN_API_RESULT)
@StatusCodes({
@ResponseCode(code = 200, condition = "Successful retrieval of posts, reported in the 'result' field of the returned object"),
@ResponseCode(code = 500, condition = ErrorMessages.ERROR_IN_API_RESULT)
})
public Response getAllPostsByUser() {
@ -121,7 +125,7 @@ public class Posts {
ResponseBean responseBean = new ResponseBean();
Status status = Status.OK;
List<Post> posts = null;
try{
try {
logger.debug("Retrieving posts for user with id " + username);
posts = CassandraConnection.getInstance().getDatabookStore().getAllPostsByUser(username);
Filters.filterPostsPerContext(posts, context);
@ -129,7 +133,7 @@ public class Posts {
responseBean.setResult(posts);
responseBean.setMessage("");
responseBean.setSuccess(true);
}catch(Exception e){
} catch (Exception e) {
logger.error("Unable to retrieve such feeds.", e);
responseBean.setMessage(e.getMessage());
responseBean.setSuccess(false);
@ -141,14 +145,16 @@ public class Posts {
/**
* Retrieve a post by id
* @return the post if the post id belongs to a post in the context identified by the token
*
* @return the post if the post id belongs to a post in the context identified
* by the token
*/
@GET
@Path("get-post/")
@Produces(MediaType.APPLICATION_JSON)
@StatusCodes ({
@ResponseCode ( code = 200, condition = "Successful retrieval of posts, reported in the 'result' field of the returned object"),
@ResponseCode ( code = 500, condition = ErrorMessages.ERROR_IN_API_RESULT)
@StatusCodes({
@ResponseCode(code = 200, condition = "Successful retrieval of posts, reported in the 'result' field of the returned object"),
@ResponseCode(code = 500, condition = ErrorMessages.ERROR_IN_API_RESULT)
})
public Response getPost(@QueryParam("id") String id) {
String context = ScopeProvider.instance.get();
@ -156,11 +162,11 @@ public class Posts {
ResponseBean responseBean = new ResponseBean();
Status status = Status.OK;
List<Post> posts = new ArrayList<>();
try{
try {
logger.debug("Retrieving post with id " + id);
try {
posts.add(CassandraConnection.getInstance().getDatabookStore().readPost(id));
} catch(FeedIDNotFoundException e){
} catch (FeedIDNotFoundException e) {
responseBean.setMessage("The post with id " + id + " does not exist in context " + context);
responseBean.setSuccess(false);
return Response.status(status).entity(responseBean).build();
@ -176,7 +182,7 @@ public class Posts {
responseBean.setResult(posts.get(0));
responseBean.setMessage("");
responseBean.setSuccess(true);
}catch(Exception e){
} catch (Exception e) {
logger.error("Unable to retrieve such post.", e);
responseBean.setMessage(e.getMessage());
responseBean.setSuccess(false);
@ -188,23 +194,23 @@ public class Posts {
/**
* Retrieve a given quantity of latest user's posts
*
* @param quantity the number of latest post to get
* @pathExample /get-posts-user-quantity?quantity=10
* @return all posts of the auth token's owner in the context identified by the token, in reverse chronological order up to quantity (at most)
* @return all posts of the auth token's owner in the context identified by the
* token, in reverse chronological order up to quantity (at most)
* @throws ValidationException
*/
@GET
@Path("get-posts-user-quantity/")
@Produces(MediaType.APPLICATION_JSON)
@StatusCodes ({
@ResponseCode ( code = 200, condition = "Successful retrieval of posts, reported in the 'result' field of the returned object"),
@ResponseCode ( code = 500, condition = ErrorMessages.ERROR_IN_API_RESULT)
@StatusCodes({
@ResponseCode(code = 200, condition = "Successful retrieval of posts, reported in the 'result' field of the returned object"),
@ResponseCode(code = 500, condition = ErrorMessages.ERROR_IN_API_RESULT)
})
public Response getQuantityPostsByUser(
@DefaultValue("10")
@QueryParam("quantity")
@Min(value=0, message="quantity cannot be negative")
int quantity) throws ValidationException{
@DefaultValue("10") @QueryParam("quantity") @Min(value = 0, message = "quantity cannot be negative") int quantity)
throws ValidationException {
Caller caller = AuthorizationProvider.instance.get();
String username = caller.getClient().getId();
@ -215,23 +221,24 @@ public class Posts {
List<Post> posts = new ArrayList<>();
// if quantity is zero, just return an empty list
if(quantity == 0){
if (quantity == 0) {
responseBean.setSuccess(true);
return Response.status(status).entity(responseBean).build();
}
try{
try {
logger.debug("getRecentPostsByUser first, posts made by user " + username);
posts = CassandraConnection.getInstance().getDatabookStore().getAllPostsByUser(username);
if (posts != null)
logger.debug("got " + posts.size() + " posts");
logger.debug("Retrieving last " + quantity + " posts made by user " + username + " in context = "+context);
logger.debug(
"Retrieving last " + quantity + " posts made by user " + username + " in context = " + context);
Filters.filterPostsPerContext(posts, context);
quantity = (quantity > posts.size()) ? posts.size() : quantity;
posts = posts.subList(0, quantity);
Filters.hideSensitiveInformation(posts, caller.getClient().getId());
responseBean.setResult(posts);
responseBean.setSuccess(true);
}catch(Exception e){
} catch (Exception e) {
logger.error("Unable to retrieve such posts.", e);
responseBean.setMessage(e.getMessage());
responseBean.setSuccess(false);
@ -242,6 +249,7 @@ public class Posts {
/**
* Create a new user post having as owner the auth token's owner
*
* @param post The post to be written
* @return
* @throws ValidationException
@ -250,14 +258,12 @@ public class Posts {
@Path("write-post-user")
@Consumes(MediaType.APPLICATION_JSON)
@Produces(MediaType.APPLICATION_JSON)
@StatusCodes ({
@ResponseCode ( code = 201, condition = "Successfull created, the new post is reported in the 'result' field of the returned object"),
@ResponseCode ( code = 500, condition = ErrorMessages.ERROR_IN_API_RESULT)
@StatusCodes({
@ResponseCode(code = 201, condition = "Successfull created, the new post is reported in the 'result' field of the returned object"),
@ResponseCode(code = 500, condition = ErrorMessages.ERROR_IN_API_RESULT)
})
public Response writePostUser(
@NotNull(message="Post to write is missing")
@Valid
PostInputBean post) throws ValidationException{
@NotNull(message = "Post to write is missing") @Valid PostInputBean post) throws ValidationException {
logger.debug("Request of writing a feed coming from user " + post);
Caller caller = AuthorizationProvider.instance.get();
@ -276,12 +282,11 @@ public class Posts {
boolean enableNotification = post.isEnablenotification();
// convert enablenotification parameter
if(enableNotification)
if (enableNotification)
logger.debug("Enable notification for this user post.");
else
logger.debug("Disable notification for this user post.");
// try to share
logger.debug("Trying to share user post...");
Post res = SocialUtils.shareUserUpdate(
@ -293,10 +298,9 @@ public class Posts {
previewHost,
previewUrl,
httpImageUrl,
enableNotification
);
enableNotification);
if(res != null){
if (res != null) {
logger.debug("Post correctly written by user " + username);
responseBean.setResult(res);
responseBean.setSuccess(true);
@ -314,15 +318,17 @@ public class Posts {
/**
* Retrieve the application's posts
* @return the application (IAM Client) posts belonging to the token's owner (i.e., an application)"
*
* @return the application (IAM Client) posts belonging to the token's owner
* (i.e., an application)"
*/
@GET
@Path("get-posts-app/")
@Produces(MediaType.APPLICATION_JSON)
@StatusCodes ({
@ResponseCode ( code = 200, condition = "Successfull created, the new post is reported in the 'result' field of the returned object"),
@ResponseCode ( code = 403, condition = "\"There is no application profile with such token"),
@ResponseCode ( code = 500, condition = ErrorMessages.ERROR_IN_API_RESULT)
@StatusCodes({
@ResponseCode(code = 200, condition = "Successfull created, the new post is reported in the 'result' field of the returned object"),
@ResponseCode(code = 403, condition = "\"There is no application profile with such token"),
@ResponseCode(code = 500, condition = ErrorMessages.ERROR_IN_API_RESULT)
})
public Response getAllPostsByApp() {
@ -334,7 +340,7 @@ public class Posts {
// check if the token actually matches an application
ApplicationProfile appProfile = SocialUtils.getProfileFromInfrastrucure(appId, context);
if(appProfile == null){
if (appProfile == null) {
logger.error("The given token is not belonging to an application!!!");
status = Status.FORBIDDEN;
@ -343,7 +349,7 @@ public class Posts {
return Response.status(status).entity(responseBean).build();
}
try{
try {
logger.debug("Retrieving posts for app with id " + appId);
List<Post> feeds = CassandraConnection.getInstance().getDatabookStore().getAllPostsByApp(appId);
@ -351,7 +357,7 @@ public class Posts {
responseBean.setSuccess(true);
responseBean.setResult(feeds);
}catch(Exception e){
} catch (Exception e) {
logger.error("Unable to retrieve such feeds.", e);
responseBean.setMessage(e.getMessage());
@ -364,7 +370,10 @@ public class Posts {
}
/**
* Create a new application post having as owner-application the token's owner (the IAM Client), note that the application must be registered on the Information System
* Create a new application post having as owner-application the token's owner
* (the IAM Client), note that the application must be registered on the
* Information System
*
* @param post The post to be written
* @return
*/
@ -372,15 +381,13 @@ public class Posts {
@Path("write-post-app")
@Consumes(MediaType.APPLICATION_JSON)
@Produces(MediaType.APPLICATION_JSON)
@StatusCodes ({
@ResponseCode ( code = 200, condition = "Successfull created, the new post is reported in the 'result' field of the returned object"),
@ResponseCode ( code = 403, condition = "\"There is no application profile with such token"),
@ResponseCode ( code = 500, condition = ErrorMessages.ERROR_IN_API_RESULT)
@StatusCodes({
@ResponseCode(code = 200, condition = "Successfull created, the new post is reported in the 'result' field of the returned object"),
@ResponseCode(code = 403, condition = "\"There is no application profile with such token"),
@ResponseCode(code = 500, condition = ErrorMessages.ERROR_IN_API_RESULT)
})
public Response writePostApp(
@NotNull(message="Post to write is null")
@Valid
PostInputBean post){
@NotNull(message = "Post to write is null") @Valid PostInputBean post) {
Caller caller = AuthorizationProvider.instance.get();
String appId = caller.getClient().getId();
@ -393,7 +400,7 @@ public class Posts {
// check if the token actually matches an application profile
ApplicationProfile appProfile = SocialUtils.getProfileFromInfrastrucure(appId, context);
if(appProfile == null){
if (appProfile == null) {
logger.error("The given token doesn't belong to an application!!!");
responseBean.setSuccess(false);
responseBean.setMessage(ErrorMessages.NOT_APP_TOKEN);
@ -410,7 +417,7 @@ public class Posts {
String params = post.getParams();
// convert enablenotification parameter
if(enableNotification)
if (enableNotification)
logger.debug("Enable notification for this application post.");
else
logger.debug("Disable notification for this application post.");
@ -424,10 +431,9 @@ public class Posts {
httpImageUrl,
appProfile,
caller,
enableNotification
);
enableNotification);
if(written != null){
if (written != null) {
responseBean.setResult(written);
responseBean.setSuccess(true);
return Response.status(status).entity(responseBean).build();
@ -447,9 +453,9 @@ public class Posts {
@GET
@Path("get-posts-vre/")
@Produces(MediaType.APPLICATION_JSON)
@StatusCodes ({
@ResponseCode ( code = 201, condition = "Sccessfull retrieved posts, they are reported in the 'result' field of the returned object"),
@ResponseCode ( code = 500, condition = ErrorMessages.ERROR_IN_API_RESULT)
@StatusCodes({
@ResponseCode(code = 201, condition = "Sccessfull retrieved posts, they are reported in the 'result' field of the returned object"),
@ResponseCode(code = 500, condition = ErrorMessages.ERROR_IN_API_RESULT)
})
public Response getAllPostsByVRE() {
@ -458,12 +464,12 @@ public class Posts {
logger.debug("Retrieving all posts coming from vre = " + context);
ResponseBean responseBean = new ResponseBean();
Status status = Status.OK;
try{
try {
List<Post> posts = CassandraConnection.getInstance().getDatabookStore().getAllPostsByVRE(context);
Filters.hideSensitiveInformation(posts, caller.getClient().getId());
responseBean.setResult(posts);
responseBean.setSuccess(true);
}catch(Exception e){
} catch (Exception e) {
logger.error("Unable to retrieve posts for vre = " + context, e);
status = Status.INTERNAL_SERVER_ERROR;
responseBean.setMessage(e.toString());
@ -474,13 +480,18 @@ public class Posts {
}
/**
* return the most recent posts for this vre up to quantity param and the last index of the posts in the timeline
* lastReturnedPostTimelineIndex is useful to know from where to start the range the next time you ask, because there are deletions
* return the most recent posts for this vre up to quantity param and the last
* index of the posts in the timeline
* lastReturnedPostTimelineIndex is useful to know from where to start the range
* the next time you ask, because there are deletions
*
* @param from the range start (most recent feeds for this vre) has to be greater than 0
* @param quantity the number of most recent feeds for this vre starting from "from" param
* @param from the range start (most recent feeds for this vre) has to be
* greater than 0
* @param quantity the number of most recent feeds for this vre starting from
* "from" param
* @pathExample /get-recent-posts-vre-by-range?from=1&quantity=10
* @return a <class>RangePosts</class> containing of most recent feeds for this vre
* @return a <class>RangePosts</class> containing of most recent feeds for this
* vre
* @throws FeedTypeNotFoundException
* @throws PrivacyLevelTypeNotFoundException
* @throws ColumnNameNotFoundException
@ -488,29 +499,27 @@ public class Posts {
@GET
@Path("get-recent-posts-vre-by-range/")
@Produces(MediaType.APPLICATION_JSON)
@StatusCodes ({
@ResponseCode ( code = 201, condition = "Sccessfull retrieved posts, they are reported in the 'result' field of the returned object"),
@ResponseCode ( code = 500, condition = ErrorMessages.ERROR_IN_API_RESULT)
@StatusCodes({
@ResponseCode(code = 201, condition = "Sccessfull retrieved posts, they are reported in the 'result' field of the returned object"),
@ResponseCode(code = 500, condition = ErrorMessages.ERROR_IN_API_RESULT)
})
public Response getRecentPostsByVREAndRange(
@QueryParam("from")
@Min(value=1, message="from cannot be negative")
int from,
@QueryParam("quantity")
@Min(value=1, message="quantity cannot be negative")
int quantity) throws ValidationException {
@QueryParam("from") @Min(value = 1, message = "from cannot be negative") int from,
@QueryParam("quantity") @Min(value = 1, message = "quantity cannot be negative") int quantity)
throws ValidationException {
String context = ScopeProvider.instance.get();
Caller caller = AuthorizationProvider.instance.get();
logger.debug("Retrieving all posts coming from vre = " + context);
ResponseBean responseBean = new ResponseBean();
Status status = Status.OK;
try{
RangePosts rangePosts = CassandraConnection.getInstance().getDatabookStore().getRecentPostsByVREAndRange(context, from, quantity);
try {
RangePosts rangePosts = CassandraConnection.getInstance().getDatabookStore()
.getRecentPostsByVREAndRange(context, from, quantity);
Filters.hideSensitiveInformation(rangePosts.getPosts(), caller.getClient().getId());
responseBean.setResult(rangePosts);
responseBean.setSuccess(true);
}catch(Exception e){
} catch (Exception e) {
logger.error("Unable to retrieve posts for vre = " + context, e);
status = Status.INTERNAL_SERVER_ERROR;
responseBean.setMessage(e.toString());
@ -522,6 +531,7 @@ public class Posts {
/**
* Retrieve posts containing the hashtag in the context bound to the auth token
*
* @param hashtag he hashtag to be contained within the posts
* @pathExample /get-posts-by-hashtag?hashtag=#thehashtag
* @return the posts in the context bound to the auth token matching the hashtag
@ -529,30 +539,30 @@ public class Posts {
*/
@GET
@Path("get-posts-by-hashtag/")
@Produces({MediaType.APPLICATION_JSON})
@StatusCodes ({
@ResponseCode ( code = 201, condition = "Sccessfull retrieved posts, they are reported in the 'result' field of the returned object"),
@ResponseCode ( code = 500, condition = ErrorMessages.ERROR_IN_API_RESULT)
@Produces({ MediaType.APPLICATION_JSON })
@StatusCodes({
@ResponseCode(code = 201, condition = "Sccessfull retrieved posts, they are reported in the 'result' field of the returned object"),
@ResponseCode(code = 500, condition = ErrorMessages.ERROR_IN_API_RESULT)
})
public Response getPostsByHashTags(
@QueryParam("hashtag")
@NotNull(message="hashtag cannot be missing")
String hashtag) throws ValidationException {
@QueryParam("hashtag") @NotNull(message = "hashtag cannot be missing") String hashtag)
throws ValidationException {
Caller caller = AuthorizationProvider.instance.get();
String username = caller.getClient().getId();
String context = ScopeProvider.instance.get();
ResponseBean responseBean = new ResponseBean();
Status status = Status.OK;
logger.debug("User " + username + " has requested posts containing hashtag " + hashtag + " in context " + context);
try{
logger.debug(
"User " + username + " has requested posts containing hashtag " + hashtag + " in context " + context);
try {
DatabookStore datastore = CassandraConnection.getInstance().getDatabookStore();
List<Post> posts = datastore.getVREPostsByHashtag(context, hashtag);
Filters.hideSensitiveInformation(posts, caller.getClient().getId());
responseBean.setResult(posts);
responseBean.setSuccess(true);
}catch(Exception e){
} catch (Exception e) {
logger.error("Failed to retrieve hashtags", e);
status = Status.INTERNAL_SERVER_ERROR;
}
@ -561,14 +571,16 @@ public class Posts {
/**
* Retrieve ids (UUID) of the liked posts by the user
* @return ids (UUID) of the liked posts by the user in the context bound to the auth token
*
* @return ids (UUID) of the liked posts by the user in the context bound to the
* auth token
*/
@GET
@Path("get-id-liked-posts/")
@Produces({MediaType.APPLICATION_JSON})
@StatusCodes ({
@ResponseCode ( code = 201, condition = "Sccessfull retrieved ids, they are reported in the 'result' field of the returned object"),
@ResponseCode ( code = 500, condition = ErrorMessages.ERROR_IN_API_RESULT)
@Produces({ MediaType.APPLICATION_JSON })
@StatusCodes({
@ResponseCode(code = 201, condition = "Sccessfull retrieved ids, they are reported in the 'result' field of the returned object"),
@ResponseCode(code = 500, condition = ErrorMessages.ERROR_IN_API_RESULT)
})
public Response getAllLikedPostIdsByUser() {
@ -580,7 +592,7 @@ public class Posts {
List<String> retrievedLikedPostsIds = null;
ResponseBean responseBean = new ResponseBean();
Status status = Status.OK;
try{
try {
DatabookStore datastore = CassandraConnection.getInstance().getDatabookStore();
retrievedLikedPostsIds = datastore.getAllLikedPostIdsByUser(username);
@ -588,7 +600,7 @@ public class Posts {
responseBean.setResult(retrievedLikedPostsIds);
responseBean.setSuccess(true);
logger.debug("Ids of liked posts by " + username + " retrieved");
}catch(Exception e){
} catch (Exception e) {
logger.error("Unable to read such ids of liked Posts.", e);
responseBean.setMessage(e.getMessage());
responseBean.setSuccess(false);
@ -600,22 +612,22 @@ public class Posts {
/**
* Retrieve posts liked by the user
*
* @param limit The maximum number of posts to be retrieved
* @return posts liked by the user (up to a given quantity) in the context bound to the auth token
* @return posts liked by the user (up to a given quantity) in the context bound
* to the auth token
* @throws ValidationException
*/
@GET
@Path("get-liked-posts/")
@Produces(MediaType.APPLICATION_JSON)
@StatusCodes ({
@ResponseCode ( code = 200, condition = "Successfull retrieved posts, they are reported in the 'result' field of the returned object"),
@ResponseCode ( code = 500, condition = ErrorMessages.ERROR_IN_API_RESULT)
@StatusCodes({
@ResponseCode(code = 200, condition = "Successfull retrieved posts, they are reported in the 'result' field of the returned object"),
@ResponseCode(code = 500, condition = ErrorMessages.ERROR_IN_API_RESULT)
})
public Response getAllLikedPostsByUser(
@DefaultValue("10")
@QueryParam("limit")
@Min(message="limit cannot be negative", value = 0)
int limit) throws ValidationException{
@DefaultValue("10") @QueryParam("limit") @Min(message = "limit cannot be negative", value = 0) int limit)
throws ValidationException {
Caller caller = AuthorizationProvider.instance.get();
String username = caller.getClient().getId();
@ -624,15 +636,17 @@ public class Posts {
ResponseBean responseBean = new ResponseBean();
Status status = Status.OK;
try{
logger.debug("Retrieving " + limit + " liked posts for user with id " + username + " in context " + context);
retrievedLikedPosts = CassandraConnection.getInstance().getDatabookStore().getAllLikedPostsByUser(username, limit);
try {
logger.debug(
"Retrieving " + limit + " liked posts for user with id " + username + " in context " + context);
retrievedLikedPosts = CassandraConnection.getInstance().getDatabookStore().getAllLikedPostsByUser(username,
limit);
Filters.filterPostsPerContext(retrievedLikedPosts, context);
Filters.hideSensitiveInformation(retrievedLikedPosts, caller.getClient().getId());
responseBean.setResult(retrievedLikedPosts);
responseBean.setSuccess(true);
logger.debug("Liked posts by " + username + " retrieved");
}catch(Exception e){
} catch (Exception e) {
logger.error("Unable to read such liked posts.", e);
responseBean.setMessage(e.getMessage());
responseBean.setSuccess(false);
@ -641,29 +655,27 @@ public class Posts {
return Response.status(status).entity(responseBean).build();
}
//libapi
// libapi
@POST
@Consumes(MediaType.APPLICATION_JSON)
@Produces(MediaType.APPLICATION_JSON)
@Path("save-user-post-attachments-lib")
public Response saveUserPostLib(
@NotNull(message="post to add is missing")
@Valid
PostWithAttachment postWithAttachment
) throws ValidationException{
@NotNull(message = "post to add is missing") @Valid PostWithAttachment postWithAttachment)
throws ValidationException {
ResponseBean responseBean = new ResponseBean();
Status status = Status.OK;
try{
try {
Post post = postWithAttachment.getPost();
logger.debug("Post is " + post);
List<Attachment> attachments = postWithAttachment.getAttachments();
logger.debug("Attachments are " + attachments);
boolean result = CassandraConnection.getInstance().getDatabookStore().saveUserPost(post,attachments);
boolean result = CassandraConnection.getInstance().getDatabookStore().saveUserPost(post, attachments);
responseBean.setResult(result);
responseBean.setMessage("");
responseBean.setSuccess(result);
}catch(Exception e){
} catch (Exception e) {
logger.error("Unable to write comment.", e);
responseBean.setMessage(e.getMessage());
responseBean.setSuccess(false);
@ -677,20 +689,18 @@ public class Posts {
@Produces(MediaType.APPLICATION_JSON)
@Path("save-app-post-attachments-lib")
public Response saveAppPostLib(
@NotNull(message="post to add is missing")
@Valid
PostWithAttachment postWithAttachment
) throws ValidationException{
@NotNull(message = "post to add is missing") @Valid PostWithAttachment postWithAttachment)
throws ValidationException {
ResponseBean responseBean = new ResponseBean();
Status status = Status.OK;
try{
try {
Post post = postWithAttachment.getPost();
List<Attachment> attachments = postWithAttachment.getAttachments();
boolean result = CassandraConnection.getInstance().getDatabookStore().saveAppPost(post,attachments);
boolean result = CassandraConnection.getInstance().getDatabookStore().saveAppPost(post, attachments);
responseBean.setResult(result);
responseBean.setMessage("");
responseBean.setSuccess(result);
}catch(Exception e){
} catch (Exception e) {
logger.error("Unable to write comment.", e);
responseBean.setMessage(e.getMessage());
responseBean.setSuccess(false);

16
src/main/java/org/gcube/portal/social/networking/ws/methods/v2/Tokens.java
View File

@ -24,7 +24,6 @@ import org.slf4j.LoggerFactory;
import com.webcohesion.enunciate.metadata.rs.ResponseCode;
import com.webcohesion.enunciate.metadata.rs.StatusCodes;
/**
* REST interface for the social networking library (tokens).
*/
@ -39,21 +38,20 @@ public class Tokens {
@Path("generate-application-token/")
@Produces(MediaType.APPLICATION_JSON)
@Consumes(MediaType.APPLICATION_JSON)
@StatusCodes ({
@ResponseCode ( code = 201, condition = "Successful creation of the token, reported in the 'result' field of the returned object"),
@ResponseCode ( code = 403, condition = "There is no application profile with such id"),
@ResponseCode ( code = 500, condition = ErrorMessages.ERROR_IN_API_RESULT)
@StatusCodes({
@ResponseCode(code = 201, condition = "Successful creation of the token, reported in the 'result' field of the returned object"),
@ResponseCode(code = 403, condition = "There is no application profile with such id"),
@ResponseCode(code = 500, condition = ErrorMessages.ERROR_IN_API_RESULT)
})
/**
* Generate a legacy application auth token for the application with id app_id
*
* @param input The bean containing the app_id field
* @return the legacy application token
* @throws ValidationException
*/
public Response generateApplicationToken(
@NotNull(message="Missing input parameter")
@Valid
ApplicationId input) throws ValidationException{
@NotNull(message = "Missing input parameter") @Valid ApplicationId input) throws ValidationException {
logger.debug("Incoming request for app token generation.");
String context = ScopeProvider.instance.get();
@ -63,7 +61,7 @@ public class Tokens {
try {
// check if the token actually matches an application profile
ApplicationProfile appProfile = SocialUtils.getProfileFromInfrastrucure(appId, context);
if(appProfile == null){
if (appProfile == null) {
logger.error("The given id doesn't belong to an application!!!");
responseBean.setSuccess(false);
responseBean.setMessage(ErrorMessages.NOT_APP_ID);

300
src/main/java/org/gcube/portal/social/networking/ws/methods/v2/Users.java
View File

@ -52,19 +52,21 @@ import com.webcohesion.enunciate.metadata.rs.StatusCodes;
* REST interface for the social networking library (users).
*/
@Path("2/users")
@RequestHeaders ({
@RequestHeader( name = "Authorization", description = "Bearer token, see https://dev.d4science.org/how-to-access-resources"),
@RequestHeader( name = "Content-Type", description = "application/json")
@RequestHeaders({
@RequestHeader(name = "Authorization", description = "Bearer token, see https://dev.d4science.org/how-to-access-resources"),
@RequestHeader(name = "Content-Type", description = "application/json")
})
public class Users {
// Logger
private static final org.slf4j.Logger logger = LoggerFactory.getLogger(Users.class);
private static final String NOT_USER_TOKEN_CONTEXT_USED = "User's information can only be retrieved through a user token (not qualified)";
private static final List<String> GLOBAL_ROLES_ALLOWED_BY_LOCAL_CALL_METHOD = Arrays.asList("DataMiner-Manager","Quota-Manager");
private static final List<String> GLOBAL_ROLES_ALLOWED_BY_LOCAL_CALL_METHOD = Arrays.asList("DataMiner-Manager",
"Quota-Manager");
/**
* Read a user's custom attribute. The user is the one owning the token
*
* @param attributeKey The key of the attribute to be read
* @return the user's custom attribute
* @throws ValidationException
@ -72,35 +74,33 @@ public class Users {
@GET
@Path("get-custom-attribute/")
@Produces(MediaType.APPLICATION_JSON)
@StatusCodes ({
@ResponseCode ( code = 200, condition = "Successful read of the attribute, reported in the 'result' field of the returned object"),
@ResponseCode ( code = 404, condition = "Such an attribute doesn't exist"),
@ResponseCode ( code = 500, condition = ErrorMessages.ERROR_IN_API_RESULT)
@StatusCodes({
@ResponseCode(code = 200, condition = "Successful read of the attribute, reported in the 'result' field of the returned object"),
@ResponseCode(code = 404, condition = "Such an attribute doesn't exist"),
@ResponseCode(code = 500, condition = ErrorMessages.ERROR_IN_API_RESULT)
})
public Response readCustomAttr(
@QueryParam("attribute")
@NotNull(message="attribute name is missing")
String attributeKey
) throws ValidationException {
@QueryParam("attribute") @NotNull(message = "attribute name is missing") String attributeKey)
throws ValidationException {
Caller caller = AuthorizationProvider.instance.get();
String username = caller.getClient().getId();
ResponseBean responseBean = new ResponseBean();
Status status = Status.OK;
if(!TokensUtils.isUserTokenDefault(caller)){
if (!TokensUtils.isUserTokenDefault(caller)) {
status = Status.FORBIDDEN;
responseBean.setMessage(NOT_USER_TOKEN_CONTEXT_USED);
logger.warn("Trying to access users method via a token different than USER is not allowed");
}else{
} else {
UserManager userManager = UserManagerWSBuilder.getInstance().getUserManager();
try{
try {
GCubeUser user = userManager.getUserByUsername(username);
String toReturn = (String)userManager.readCustomAttr(user.getUserId(), attributeKey);
String toReturn = (String) userManager.readCustomAttr(user.getUserId(), attributeKey);
responseBean.setSuccess(true);
responseBean.setResult(toReturn);
}catch(Exception e){
} catch (Exception e) {
logger.error("Unable to retrieve attribute for user.", e);
responseBean.setMessage(e.toString());
@ -114,16 +114,17 @@ public class Users {
/**
* Read the user's fullname. The user is the one owning the token
*
* @return the user's fullname
*/
@GET
@Path("get-fullname")
@Produces(MediaType.APPLICATION_JSON)
@StatusCodes ({
@ResponseCode ( code = 200, condition = "The user's fullname is reported in the 'result' field of the returned object"),
@ResponseCode ( code = 500, condition = ErrorMessages.ERROR_IN_API_RESULT)
@StatusCodes({
@ResponseCode(code = 200, condition = "The user's fullname is reported in the 'result' field of the returned object"),
@ResponseCode(code = 500, condition = ErrorMessages.ERROR_IN_API_RESULT)
})
public Response getUserFullname(){
public Response getUserFullname() {
Caller caller = AuthorizationProvider.instance.get();
String username = caller.getClient().getId();
@ -131,21 +132,21 @@ public class Users {
ResponseBean responseBean = new ResponseBean();
Status status = Status.OK;
if(!TokensUtils.isUserTokenDefault(caller)){
if (!TokensUtils.isUserTokenDefault(caller)) {
status = Status.FORBIDDEN;
responseBean.setMessage(NOT_USER_TOKEN_CONTEXT_USED);
logger.warn("Trying to access users method via a token different than USER is not allowed");
}else{
} else {
UserManager userManager = UserManagerWSBuilder.getInstance().getUserManager();
try{
try {
GCubeUser user = userManager.getUserByUsername(username);
fullName = user.getFullname();
logger.debug("Found fullname " + fullName + " for user " + username);
logger.debug("Found fullname " + fullName + " for user " + username);
responseBean.setResult(fullName);
responseBean.setSuccess(true);
}catch(Exception e){
} catch (Exception e) {
logger.error("Unable to retrieve attribute for user.", e);
status = Status.INTERNAL_SERVER_ERROR;
@ -157,36 +158,37 @@ public class Users {
/**
* Read the user's email address. The user is the one owning the token
*
* @return rhe user's email address
*/
@GET
@Path("get-email")
@Produces(MediaType.APPLICATION_JSON)
@StatusCodes ({
@ResponseCode ( code = 200, condition = "The user's email is reported in the 'result' field of the returned object"),
@ResponseCode ( code = 500, condition = ErrorMessages.ERROR_IN_API_RESULT)
@StatusCodes({
@ResponseCode(code = 200, condition = "The user's email is reported in the 'result' field of the returned object"),
@ResponseCode(code = 500, condition = ErrorMessages.ERROR_IN_API_RESULT)
})
public Response getUserEmail(){
public Response getUserEmail() {
Caller caller = AuthorizationProvider.instance.get();
String username = caller.getClient().getId();
String email = null;
ResponseBean responseBean = new ResponseBean();
Status status = Status.OK;
if(!TokensUtils.isUserTokenDefault(caller)){
if (!TokensUtils.isUserTokenDefault(caller)) {
status = Status.FORBIDDEN;
responseBean.setMessage(NOT_USER_TOKEN_CONTEXT_USED);
logger.warn("Trying to access users method via a token different than USER is not allowed");
}else{
try{
} else {
try {
UserManager userManager = UserManagerWSBuilder.getInstance().getUserManager();
GCubeUser user = userManager.getUserByUsername(username);
email = user.getEmail();
logger.debug("Found email " + email + " for user " + username);
logger.debug("Found email " + email + " for user " + username);
responseBean.setResult(email);
responseBean.setSuccess(true);
}catch(Exception e){
} catch (Exception e) {
logger.error("Unable to retrieve attribute for user.", e);
status = Status.INTERNAL_SERVER_ERROR;
@ -198,17 +200,27 @@ public class Users {
/**
* Get the profile associated to the token
* @responseExample application/json { "success" : true, "message" : null, "result" : { "user_id" : 23769487, "username" : "john.smith", "email" : "********", "first_name" : "John", "middle_name" : "", "last_name" : "Smith", "fullname" : "John Smith", "registration_date" : 1475151491415, "user_avatar_url" : "https://******D", "male" : true, "job_title" : "", "location_industry" : "no", "custom_attrs_map" : null, "email_addresses" : [ ], "screen_name" : "john.smith", "user_avatar_id" : "https://****sY%3D" } }
*
* @responseExample application/json { "success" : true, "message" : null,
* "result" : { "user_id" : 23769487, "username" :
* "john.smith", "email" : "********", "first_name" : "John",
* "middle_name" : "", "last_name" : "Smith", "fullname" :
* "John Smith", "registration_date" : 1475151491415,
* "user_avatar_url" : "https://******D", "male" : true,
* "job_title" : "", "location_industry" : "no",
* "custom_attrs_map" : null, "email_addresses" : [ ],
* "screen_name" : "john.smith", "user_avatar_id" :
* "https://****sY%3D" } }
* @return the user's profile. The user is the one owning the token
*/
@GET
@Path("get-profile")
@Produces(MediaType.APPLICATION_JSON)
@StatusCodes ({
@ResponseCode ( code = 200, condition = "The user's profile is reported in the 'result' field of the returned object"),
@ResponseCode ( code = 500, condition = ErrorMessages.ERROR_IN_API_RESULT)
@StatusCodes({
@ResponseCode(code = 200, condition = "The user's profile is reported in the 'result' field of the returned object"),
@ResponseCode(code = 500, condition = ErrorMessages.ERROR_IN_API_RESULT)
})
public Response getUserProfile(){
public Response getUserProfile() {
Caller caller = AuthorizationProvider.instance.get();
String username = caller.getClient().getId();
@ -216,17 +228,17 @@ public class Users {
ResponseBean responseBean = new ResponseBean();
Status status = Status.OK;
if(!TokensUtils.isUserToken(caller)){
if (!TokensUtils.isUserToken(caller)) {
status = Status.FORBIDDEN;
responseBean.setMessage("User's information can only be retrieved through a user Jtoken");
logger.warn("Trying to access users method via a token different than 'user-token' is not allowed");
}else{
try{
} else {
try {
UserManager userManager = UserManagerWSBuilder.getInstance().getUserManager();
user = userManager.getUserByUsername(username);
responseBean.setResult(user);
responseBean.setSuccess(true);
}catch(Exception e){
} catch (Exception e) {
logger.error("Unable to retrieve user's profile", e);
responseBean.setMessage(e.getMessage());
status = Status.INTERNAL_SERVER_ERROR;
@ -235,16 +247,16 @@ public class Users {
return Response.status(status).entity(responseBean).build();
}
private static final Function<GCubeUser, UserProfileExtendedWithVerifiedEmail> GCUBE_TO_EXTENDED_PROFILE_MAP_WITH_VERIFIED_EMAIL
= new Function<GCubeUser, UserProfileExtendedWithVerifiedEmail>() {
private static final Function<GCubeUser, UserProfileExtendedWithVerifiedEmail> GCUBE_TO_EXTENDED_PROFILE_MAP_WITH_VERIFIED_EMAIL = new Function<GCubeUser, UserProfileExtendedWithVerifiedEmail>() {
@Override
public UserProfileExtendedWithVerifiedEmail apply(GCubeUser t) {
if(t == null)
if (t == null)
return null;
UserProfileExtendedWithVerifiedEmail profile = new UserProfileExtendedWithVerifiedEmail(t.getUsername(), null, t.getUserAvatarURL(), t.getFullname());
UserProfileExtendedWithVerifiedEmail profile = new UserProfileExtendedWithVerifiedEmail(t.getUsername(),
null, t.getUserAvatarURL(), t.getFullname());
profile.setEmail(t.getEmail());
profile.setFirstName(t.getFirstName());
profile.setJobTitle(t.getJobTitle());
@ -259,25 +271,25 @@ public class Users {
/**
* @responseExample application/json {
"id": "john.smith",
"roles": [],
"picture": "https://***gAJ4uVWTA74xwQ6%2FCA72RRinysY%3D",
"name": "John Smith",
"middle_name": "",
"male": true,
"location_industry": "no",
"given_name": "John",
"email": "******",
"job_title": "",
"family_name": "Smith",
"verified_email": true
}
* "id": "john.smith",
* "roles": [],
* "picture": "https://***gAJ4uVWTA74xwQ6%2FCA72RRinysY%3D",
* "name": "John Smith",
* "middle_name": "",
* "male": true,
* "location_industry": "no",
* "given_name": "John",
* "email": "******",
* "job_title": "",
* "family_name": "Smith",
* "verified_email": true
* }
* @return the user's profile compliant with oauth
*/
@GET
@Path("get-oauth-profile")
@Produces(MediaType.APPLICATION_JSON)
public Response getUserOAuthProfile(){
public Response getUserOAuthProfile() {
Caller caller = AuthorizationProvider.instance.get();
String username = caller.getClient().getId();
String scope = ScopeProvider.instance.get();
@ -285,62 +297,64 @@ public class Users {
ResponseBean responseBean = new ResponseBean();
Status status = Status.OK;
UserProfileExtendedWithVerifiedEmail userWithEmailVerified = null;
if(!TokensUtils.isUserToken(caller)){
if (!TokensUtils.isUserToken(caller)) {
status = Status.FORBIDDEN;
responseBean.setMessage(NOT_USER_TOKEN_CONTEXT_USED);
logger.warn("Trying to access users method via a token different than USER is not allowed");
}else{
try{
} else {
try {
UserManager userManager = UserManagerWSBuilder.getInstance().getUserManager();
RoleManager roleManager = RoleManagerWSBuilder.getInstance().getRoleManager();
GroupManager groupManager = GroupManagerWSBuilder.getInstance().getGroupManager();
user = userManager.getUserByUsername(username);
userWithEmailVerified = GCUBE_TO_EXTENDED_PROFILE_MAP_WITH_VERIFIED_EMAIL.apply(user);
List<GCubeRole> roles = roleManager.listRolesByUserAndGroup(user.getUserId(), groupManager.getGroupIdFromInfrastructureScope(scope));
List<GCubeRole> roles = roleManager.listRolesByUserAndGroup(user.getUserId(),
groupManager.getGroupIdFromInfrastructureScope(scope));
List<String> rolesNames = new ArrayList<String>();
for (GCubeRole gCubeRole : roles) {
rolesNames.add(gCubeRole.getRoleName());
}
userWithEmailVerified.setRoles(rolesNames);
//responseBean.setResult(userWithEmailVerified);
// responseBean.setResult(userWithEmailVerified);
responseBean.setSuccess(true);
}catch(Exception e){
} catch (Exception e) {
logger.error("Unable to retrieve user's profile", e);
responseBean.setMessage(e.getMessage());
status = Status.INTERNAL_SERVER_ERROR;
}
}
logger.debug("returning: "+userWithEmailVerified.toString());
logger.debug("returning: " + userWithEmailVerified.toString());
return Response.status(status).entity(userWithEmailVerified).build();
}
/**
* @responseExample application/json {
"success": true,
"message": null,
"result": [
"john.smith",
"marco.polo"
]
}
* Get the list of usernames belonging to a given context
* @return the list of usernames for the user belonging to the context linked to the provided auth token
* @responseExample application/json {
* "success": true,
* "message": null,
* "result": [
* "john.smith",
* "marco.polo"
* ]
* }
* Get the list of usernames belonging to a given context
* @return the list of usernames for the user belonging to the context linked to
* the provided auth token
*/
@GET
@Path("get-all-usernames")
@Produces(MediaType.APPLICATION_JSON)
@StatusCodes ({
@ResponseCode ( code = 200, condition = "The list of usernames is put into the 'result' field of the returned object"),
@ResponseCode ( code = 500, condition = ErrorMessages.ERROR_IN_API_RESULT)
@StatusCodes({
@ResponseCode(code = 200, condition = "The list of usernames is put into the 'result' field of the returned object"),
@ResponseCode(code = 500, condition = ErrorMessages.ERROR_IN_API_RESULT)
})
public Response getAllUserNames(){
public Response getAllUserNames() {
ResponseBean responseBean = new ResponseBean();
Status status = Status.OK;
List<String> usernames = new ArrayList<String>();
try{
try {
GroupManager groupManager = GroupManagerWSBuilder.getInstance().getGroupManager();
UserManager userManager = UserManagerWSBuilder.getInstance().getUserManager();
@ -353,21 +367,21 @@ public class Users {
UsersCache cache = UsersCache.getSingleton();
for (Long userId : userIds) {
if(cache.getUser(userId) == null){
if (cache.getUser(userId) == null) {
GCubeUser user = userManager.getUserById(userId);
if(user != null){
if (user != null) {
usernames.add(user.getUsername());
cache.pushEntry(userId, user);
}
}else
} else
usernames.add(cache.getUser(userId).getUsername());
}
responseBean.setResult(usernames);
responseBean.setSuccess(true);
}catch(Exception e){
} catch (Exception e) {
logger.error("Unable to retrieve user's usernames", e);
responseBean.setMessage(e.getMessage());
responseBean.setMessage(e.getMessage());
status = Status.INTERNAL_SERVER_ERROR;
}
@ -375,23 +389,26 @@ public class Users {
}
/**
* Get the map of couples username/fullname of the users belonging to a given context
* @return the map of couples username/fullname of the users belonging to the context linked to the provided token.
* Get the map of couples username/fullname of the users belonging to a given
* context
*
* @return the map of couples username/fullname of the users belonging to the
* context linked to the provided token.
*/
@GET
@Path("get-all-fullnames-and-usernames")
@StatusCodes ({
@ResponseCode ( code = 200, condition = "The map is put into the 'result' field of the returned object"),
@ResponseCode ( code = 500, condition = ErrorMessages.ERROR_IN_API_RESULT)
@StatusCodes({
@ResponseCode(code = 200, condition = "The map is put into the 'result' field of the returned object"),
@ResponseCode(code = 500, condition = ErrorMessages.ERROR_IN_API_RESULT)
})
@Produces(MediaType.APPLICATION_JSON)
public Response getFullnamesAndUsernames(){
public Response getFullnamesAndUsernames() {
ResponseBean responseBean = new ResponseBean();
Status status = Status.OK;
Map<String, String> usernamesAndFullnames = new HashMap<String, String>();
try{
try {
GroupManager groupManager = GroupManagerWSBuilder.getInstance().getGroupManager();
UserManager userManager = UserManagerWSBuilder.getInstance().getUserManager();
@ -404,21 +421,21 @@ public class Users {
UsersCache cache = UsersCache.getSingleton();
for (Long userId : userIds) {
if(cache.getUser(userId) == null){
if (cache.getUser(userId) == null) {
GCubeUser user = userManager.getUserById(userId);
if(user != null){
if (user != null) {
usernamesAndFullnames.put(user.getUsername(), user.getFullname());
cache.pushEntry(userId, user);
}
}else
} else
usernamesAndFullnames.put(cache.getUser(userId).getUsername(), cache.getUser(userId).getFullname());
}
responseBean.setResult(usernamesAndFullnames);
responseBean.setSuccess(true);
}catch(Exception e){
} catch (Exception e) {
logger.error("Unable to retrieve user's usernames", e);
responseBean.setMessage(e.getMessage());
responseBean.setMessage(e.getMessage());
status = Status.INTERNAL_SERVER_ERROR;
}
@ -426,52 +443,55 @@ public class Users {
}
/**
* Get the list of users having a given global-role, e.g. 'Administrator'. (Legacy)
* Get the list of users having a given global-role, e.g. 'Administrator'.
* (Legacy)
*
* @param roleName the name of the role to be checked (e.g. Administrator)
* @return the list of users having a given global-role
*/
@GET
@Path("get-usernames-by-global-role")
@Produces(MediaType.APPLICATION_JSON)
@StatusCodes ({
@ResponseCode ( code = 200, condition = "The list is put into the 'result' field of the returned object"),
@ResponseCode ( code = 500, condition = ErrorMessages.ERROR_IN_API_RESULT)
@StatusCodes({
@ResponseCode(code = 200, condition = "The list is put into the 'result' field of the returned object"),
@ResponseCode(code = 500, condition = ErrorMessages.ERROR_IN_API_RESULT)
})
public Response getUsernamesByGlobalRole(
@QueryParam("role-name") String roleName){
@QueryParam("role-name") String roleName) {
ResponseBean responseBean = new ResponseBean();
Status status = Status.OK;
// this method can only be called from IS scope (except for roles in GLOBAL_ROLES_ALLOWED_BY_LOCAL)
// this method can only be called from IS scope (except for roles in
// GLOBAL_ROLES_ALLOWED_BY_LOCAL)
ScopeBean scopeInfo = new ScopeBean(ScopeProvider.instance.get());
if(!scopeInfo.is(Type.INFRASTRUCTURE)){
if (!scopeInfo.is(Type.INFRASTRUCTURE)) {
status = Status.BAD_REQUEST;
responseBean.setMessage("This method can only be called with an infrastructure token");
}else{
} else {
List<String> usernames = new ArrayList<String>();
try{
try {
RoleManager roleManager = RoleManagerWSBuilder.getInstance().getRoleManager();
long globalRoleId = roleManager.getRoleIdByName(roleName);
if(globalRoleId > 0){
if (globalRoleId > 0) {
UserManager userManager = UserManagerWSBuilder.getInstance().getUserManager();
List<GCubeUser> users = userManager.listUsersByGlobalRole(globalRoleId);
if(users != null){
if (users != null) {
for (GCubeUser gCubeUser : users) {
usernames.add(gCubeUser.getUsername());
}
}
responseBean.setResult(usernames);
responseBean.setSuccess(true);
}else{
} else {
responseBean.setMessage("No global role exists whit such a name");
status = Status.BAD_REQUEST;
}
}catch(Exception e){
} catch (Exception e) {
logger.error("Unable to retrieve user's usernames", e);
responseBean.setMessage(e.getMessage());
responseBean.setMessage(e.getMessage());
status = Status.INTERNAL_SERVER_ERROR;
}
}
@ -483,28 +503,27 @@ public class Users {
* @param roleName the role name
* @return the usernames having the role in the VRE
* @responseExample application/json {
"success": true,
"message": null,
"result": [
"john.smith",
"marco.polo"
]
}
* "success": true,
* "message": null,
* "result": [
* "john.smith",
* "marco.polo"
* ]
* }
*/
@GET
@Path("get-usernames-by-role")
@Produces(MediaType.APPLICATION_JSON)
public Response getUsernamesByRole(
@QueryParam("role-name") String roleName){
@QueryParam("role-name") String roleName) {
ResponseBean responseBean = new ResponseBean();
Status status = Status.OK;
String context = ScopeProvider.instance.get();
KeycloakAPICredentials apiService = KeycloakAPICredentials.getSingleton();
Keycloak keycloak;
keycloak = KeycloakBuilder.builder()
.serverUrl(apiService.getServerURL())
.realm(apiService.getRealm())
@ -512,38 +531,38 @@ public class Users {
.clientId(apiService.getClientid()) //
.clientSecret(apiService.getPassword()).build();
List<String> usernames = new ArrayList<String>();
try {
List<UserRepresentation> users = searchByRole(keycloak, apiService.getRealm(), context, roleName);
if(users != null){
if (users != null) {
for (UserRepresentation user : users) {
usernames.add(user.getUsername());
}
}
responseBean.setResult(usernames);
responseBean.setSuccess(true);
} catch(Exception e){
} catch (Exception e) {
logger.error("Unable to retrieve user with the requested role", e);
responseBean.setMessage(e.getMessage());
responseBean.setMessage(e.getMessage());
status = Status.INTERNAL_SERVER_ERROR;
}
return Response.status(status).entity(responseBean).build();
}
private static List<UserRepresentation> searchByRole(Keycloak keycloak, String realmName, String context, String roleName) {
private static List<UserRepresentation> searchByRole(Keycloak keycloak, String realmName, String context,
String roleName) {
logger.debug("Searching by role: {}", roleName);
String clientIdContext = context.replace("/", "%2F") ;
String clientIdContext = context.replace("/", "%2F");
List<ClientRepresentation> clients = keycloak.realm(realmName)
.clients().findByClientId(clientIdContext);
String id = "";
for (ClientRepresentation client : clients) {
logger.debug("found client ="+client.getClientId());
logger.debug("found client id="+client.getId());
id =client.getId();
logger.debug("found client =" + client.getClientId());
logger.debug("found client id=" + client.getId());
id = client.getId();
}
List<UserRepresentation> users = keycloak.realm(realmName)
@ -553,12 +572,11 @@ public class Users {
return users;
}
@GET
@Path("user-exists")
@Produces(MediaType.APPLICATION_JSON)
@Deprecated
public Response existUser(@QueryParam("username") String username){
public Response existUser(@QueryParam("username") String username) {
ResponseBean responseBean = new ResponseBean();
String messageOnError = "This method can be invoked only by using an application token bound to the root context";
@ -567,15 +585,15 @@ public class Users {
responseBean.setSuccess(false);
Caller caller = AuthorizationProvider.instance.get();
if(!TokensUtils.isApplicationToken(caller))
if (!TokensUtils.isApplicationToken(caller))
return Response.status(status).entity(responseBean).build();
ScopeBean scopeInfo = new ScopeBean(ScopeProvider.instance.get());
if(!scopeInfo.is(Type.INFRASTRUCTURE))
if (!scopeInfo.is(Type.INFRASTRUCTURE))
return Response.status(status).entity(responseBean).build();
try{
try {
UserManager userManager = UserManagerWSBuilder.getInstance().getUserManager();
GCubeUser user = userManager.getUserByUsername(username);
@ -584,9 +602,9 @@ public class Users {
responseBean.setResult(user != null);
status = Status.OK;
}catch(Exception e){
} catch (Exception e) {
logger.error("Unable to retrieve such information", e);
responseBean.setMessage(e.getMessage());
responseBean.setMessage(e.getMessage());
status = Status.INTERNAL_SERVER_ERROR;
}

52
src/main/java/org/gcube/portal/social/networking/ws/methods/v2/VREs.java
View File

@ -32,15 +32,14 @@ import org.slf4j.LoggerFactory;
import com.webcohesion.enunciate.metadata.rs.RequestHeader;
import com.webcohesion.enunciate.metadata.rs.RequestHeaders;
/**
* REST interface for the social networking library (vres).
*/
@Path("2/vres")
@RequestHeaders ({
@RequestHeader( name = "Authorization", description = "Bearer token, see https://dev.d4science.org/how-to-access-resources"),
@RequestHeader( name = "Content-Type", description = "application/json")
})
@RequestHeaders({
@RequestHeader(name = "Authorization", description = "Bearer token, see https://dev.d4science.org/how-to-access-resources"),
@RequestHeader(name = "Content-Type", description = "application/json")
})
public class VREs {
// Logger
@ -48,18 +47,18 @@ public class VREs {
/**
* @responseExample application/json {
"success" : true,
"message" : null,
"result" : [ {
"name" : "NextNext",
"context" : "/gcube/devNext/NextNext",
"description" : "NextNext description AAA"
}, {
"name" : "devVRE",
"context" : "/gcube/devsec/devVRE",
"description" : "devVRE description BBB"
} ]
}
* "success" : true,
* "message" : null,
* "result" : [ {
* "name" : "NextNext",
* "context" : "/gcube/devNext/NextNext",
* "description" : "NextNext description AAA"
* }, {
* "name" : "devVRE",
* "context" : "/gcube/devsec/devVRE",
* "description" : "devVRE description BBB"
* } ]
* }
* @pathExample /get-my-vres?getManagers=false
* @param getManagers set true if you also want to know the VRE-Managers
* @return the list of vres along with some metadata
@ -70,23 +69,22 @@ public class VREs {
@Path("get-my-vres/")
@Produces(MediaType.APPLICATION_JSON)
public Response getMyVres(
@DefaultValue("false") @QueryParam("getManagers") boolean getManagers
) throws ValidationException {
@DefaultValue("false") @QueryParam("getManagers") boolean getManagers) throws ValidationException {
Caller caller = AuthorizationProvider.instance.get();
String username = caller.getClient().getId();
ResponseBean responseBean = new ResponseBean();
Status status = Status.OK;
if(!TokensUtils.isUserToken(caller)){
if (!TokensUtils.isUserToken(caller)) {
status = Status.FORBIDDEN;
responseBean.setMessage("This method can only be invoked with a user token!");
logger.warn("Trying to access get-my-vres method via a token different than USER is not allowed");
}else{
} else {
GroupManager gmManager = GroupManagerWSBuilder.getInstance().getGroupManager();
UserManager userManager = UserManagerWSBuilder.getInstance().getUserManager();
RoleManager roleManager = RoleManagerWSBuilder.getInstance().getRoleManager();
try{
try {
GCubeUser user = userManager.getUserByUsername(username);
List<GCubeGroup> vres = gmManager.listVresByUser(user.getUserId());
@ -99,11 +97,11 @@ public class VREs {
obj.put("name", group.getGroupName());
obj.put("context", gmManager.getInfrastructureScope(group.getGroupId()));
obj.put("description", group.getDescription());
//obj.put("thumbnail_url", ...); // TODO
// obj.put("thumbnail_url", ...); // TODO
JSONArray managers = new JSONArray();
if(getManagers){
List<GCubeUser> vreManagers = userManager.listUsersByGroupAndRole(group.getGroupId(),
if (getManagers) {
List<GCubeUser> vreManagers = userManager.listUsersByGroupAndRole(group.getGroupId(),
roleManager.getRoleIdByName(GatewayRolesNames.VRE_MANAGER.getRoleName()));
for (GCubeUser vreManager : vreManagers) {
@ -121,7 +119,7 @@ public class VREs {
responseBean.setSuccess(true);
responseBean.setResult(toReturn);
}catch(Exception e){
} catch (Exception e) {
logger.error("Unable to retrieve vres for user.", e);
responseBean.setMessage(e.toString());
@ -131,5 +129,5 @@ public class VREs {
}
}
return Response.status(status).entity(responseBean).build();
}
}
}

8
src/main/java/org/gcube/portal/social/networking/ws/outputs/ResponseBean.java
View File

@ -31,7 +31,7 @@ public class ResponseBean implements Serializable {
* @param success
* @param message
* @param result
*/
*/
public ResponseBean(boolean success, String message, Object result) {
super();
this.success = success;
@ -39,32 +39,26 @@ public class ResponseBean implements Serializable {
this.result = result;
}
public boolean isSuccess() {
return success;
}
public void setSuccess(boolean success) {
this.success = success;
}
public String getMessage() {
return message;
}
public void setMessage(String message) {
this.message = message;
}
public Object getResult() {
return result;
}
public void setResult(Object result) {
this.result = result;
}

12
src/main/java/org/gcube/portal/social/networking/ws/providers/CustomObjectMapper.java
View File

@ -11,10 +11,14 @@ import com.fasterxml.jackson.databind.SerializationFeature;
@Provider
/**
* Custom mapper with property CAMEL_CASE_TO_LOWER_CASE_WITH_UNDERSCORES to perform serialization/deserialization
* with snake case over camel case for json beans.
* TODO check https://github.com/FasterXML/jackson-docs/wiki/JacksonMixInAnnotations for applying such transformation
* only to some classes.
* Custom mapper with property CAMEL_CASE_TO_LOWER_CASE_WITH_UNDERSCORES to
* perform serialization/deserialization
* with snake case over camel case for json beans.
* TODO check
* https://github.com/FasterXML/jackson-docs/wiki/JacksonMixInAnnotations for
* applying such transformation
* only to some classes.
*
* @author Costantino Perciante at ISTI-CNR (costantino.perciante@isti.cnr.it)
*/
public class CustomObjectMapper implements ContextResolver<ObjectMapper> {

27
src/main/java/org/gcube/portal/social/networking/ws/utils/CassandraConnection.java
View File

@ -8,6 +8,7 @@ import org.slf4j.LoggerFactory;
/**
* Cassandra connection class.
*
* @author Costantino Perciante at ISTI-CNR
*/
public class CassandraConnection {
@ -16,35 +17,37 @@ public class CassandraConnection {
private static final org.slf4j.Logger logger = LoggerFactory.getLogger(CassandraConnection.class);
// databook store (singleton)
private static DatabookStore store;
private static DatabookStore store;
private static CassandraConnection singleton = new CassandraConnection();
private CassandraConnection(){
private CassandraConnection() {
ApplicationContext ctx = ContextProvider.get(); // get this info from SmartGears
logger.debug("Getting connection to cassandra");
store = new DBCassandraAstyanaxImpl(ctx.container().configuration().infrastructure());
logger.debug("Connection to cassandra created");
}
/**
* Returns the object to query the cassandra cluster.
*
* @return connection pool to cassandra cluster
*/
public DatabookStore getDatabookStore(){
public DatabookStore getDatabookStore() {
return store;
}
/**
* Get the instance
*
* @return
*/
public static CassandraConnection getInstance(){
public static CassandraConnection getInstance() {
return singleton;
}
}

12
src/main/java/org/gcube/portal/social/networking/ws/utils/ElasticSearchConnection.java
View File

@ -8,6 +8,7 @@ import org.slf4j.LoggerFactory;
/**
* The class discovers and offer connections to the elastic search cluster.
*
* @author Costantino Perciante at ISTI-CNR (costantino.perciante@isti.cnr.it)
*/
public class ElasticSearchConnection {
@ -16,12 +17,12 @@ public class ElasticSearchConnection {
private static final org.slf4j.Logger logger = LoggerFactory.getLogger(ElasticSearchConnection.class);
// databook store (singleton)
private ElasticSearchClient es;
private ElasticSearchClient es;
// singleton
private static ElasticSearchConnection singleton = new ElasticSearchConnection();
private ElasticSearchConnection(){
private ElasticSearchConnection() {
try {
ApplicationContext ctx = ContextProvider.get(); // get this info from SmartGears
logger.debug("Creating connection to Elasticsearch");
@ -32,7 +33,7 @@ public class ElasticSearchConnection {
}
}
public static ElasticSearchConnection getSingleton(){
public static ElasticSearchConnection getSingleton() {
return singleton;
@ -40,10 +41,11 @@ public class ElasticSearchConnection {
/**
* Returns the object to connect to cassandra cluster.
*
* @return connection pool to cassandra cluster
* @throws Exception
* @throws Exception
*/
public ElasticSearchClient getElasticSearchClient(){
public ElasticSearchClient getElasticSearchClient() {
return es;

4
src/main/java/org/gcube/portal/social/networking/ws/utils/ErrorMessages.java
View File

@ -1,8 +1,8 @@
package org.gcube.portal.social.networking.ws.utils;
/**
* Class that contains error messages to be returned in the HTTP responses.
*
* @author Costantino Perciante at ISTI-CNR
*/
public class ErrorMessages {
@ -11,7 +11,7 @@ public class ErrorMessages {
public static final String MISSING_PARAMETERS = "Missing request parameters.";
public static final String INVALID_TOKEN = "Invalid token.";
public static final String TOKEN_GENERATION_APP_FAILED = "Token generation failed.";
public static final String NOT_APP_TOKEN = "Invalid token: not belonging to an application.";
public static final String NOT_APP_TOKEN = "Invalid token: not belonging to an application.";
public static final String NOT_APP_ID = "Invalid application id: it doesn't belong to an application.";
public static final String NO_APP_PROFILE_FOUND = "There is no application profile for this app id/scope.";
public static final String BAD_REQUEST = "Please check the parameter you passed, it seems a bad request";

83
src/main/java/org/gcube/portal/social/networking/ws/utils/Filters.java
View File

@ -18,6 +18,7 @@ import org.slf4j.LoggerFactory;
/**
* Filters to apply to feeds/comments etc
*
* @author Costantino Perciante at ISTI-CNR (costantino.perciante@isti.cnr.it)
*/
public class Filters {
@ -25,39 +26,41 @@ public class Filters {
// Logger
private static final org.slf4j.Logger logger = LoggerFactory.getLogger(Filters.class);
private static List<String> getContexts(String context) throws IllegalArgumentException, UserManagementSystemException, GroupRetrievalFault{
private static List<String> getContexts(String context)
throws IllegalArgumentException, UserManagementSystemException, GroupRetrievalFault {
// retrieve group information
GroupManager gm = GroupManagerWSBuilder.getInstance().getGroupManager();
GCubeGroup group = gm.getGroup(gm.getGroupIdFromInfrastructureScope(context));
List<String> contexts = new ArrayList<String>();
if(gm.isRootVO(group.getGroupId())){
}
else if(gm.isVO(group.getGroupId())){
if (gm.isRootVO(group.getGroupId())) {
} else if (gm.isVO(group.getGroupId())) {
List<GCubeGroup> vres = group.getChildren();
for (GCubeGroup gCubeGroup : vres) {
contexts.add(gm.getInfrastructureScope(gCubeGroup.getGroupId()));
}
}else{
} else {
contexts.add(gm.getInfrastructureScope(group.getGroupId()));
}
return contexts;
}
/**
* Given a list of not filtered feeds, the methods remove feeds unaccessible in this scope.
* Given a list of not filtered feeds, the methods remove feeds unaccessible in
* this scope.
* If the initial context is the root: all feeds are returned;
* If the initial context is a VO: feeds for vres within the vo are returned;
* If the initial context is a vre: feeds of the vre are returned;
*
* @param feedsIds
* @param context
* @throws Exception
* @throws Exception
*/
public static void filterFeedsPerContextById(
List<String> feedsIds, String context) throws Exception {
@ -66,10 +69,10 @@ public class Filters {
List<Feed> feeds = new ArrayList<Feed>();
for (String feedId : feedsIds) {
try{
try {
feeds.add(datastore.readFeed(feedId));
}catch(Exception e){
logger.error("Unable to read feed with id " + feedId, e);
} catch (Exception e) {
logger.error("Unable to read feed with id " + feedId, e);
}
}
@ -85,45 +88,50 @@ public class Filters {
}
/**
* Given a list of not filtered feeds, the methods remove feeds unaccessible in this scope.
* Given a list of not filtered feeds, the methods remove feeds unaccessible in
* this scope.
* If the initial context is the root: all feeds are returned;
* If the initial context is a VO: feeds for vres within the vo are returned;
* If the initial context is a vre: feeds of the vre are returned;
*
* @param feeds
* @param context
* @throws Exception
* @throws Exception
*/
@Deprecated
public static void filterFeedsPerContext(List<Feed> feeds, String context) throws Exception {
List<String> contexts = getContexts(context);
// filter
Iterator<Feed> iterator = feeds.iterator();
while (iterator.hasNext()) {
Feed feed = (Feed) iterator.next();
if(!contexts.contains(feed.getVreid()))
if (!contexts.contains(feed.getVreid()))
iterator.remove();
}
}
/**
* Given a list of not filtered posts, the methods remove posts unaccessible in this scope.
* Given a list of not filtered posts, the methods remove posts unaccessible in
* this scope.
* If the initial context is the root: all posts are returned;
* If the initial context is a VO: posts for vres within the vo are returned;
* If the initial context is a vre: posts of the vre are returned;
*
* @param context
* @throws Exception
* @throws Exception
*/
public static void filterPostsPerContext(List<Post> posts, String context) throws Exception {
List<String> contexts = getContexts(context);
// filter
Iterator<Post> iterator = posts.iterator();
while (iterator.hasNext()) {
Post post = (Post) iterator.next();
if(!contexts.contains(post.getVreid()))
if (!contexts.contains(post.getVreid()))
iterator.remove();
}
@ -131,9 +139,10 @@ public class Filters {
/**
* Filter comments per context
*
* @param comments
* @param context
* @throws Exception
* @throws Exception
*/
public static void filterCommentsPerContext(List<Comment> comments, String context) throws Exception {
@ -145,12 +154,12 @@ public class Filters {
// filter
Iterator<Comment> iterator = comments.iterator();
while (iterator.hasNext()) {
try{
try {
Comment comment = (Comment) iterator.next();
Feed parent = datastore.readFeed(comment.getFeedid());
if(!contexts.contains(parent.getVreid()))
if (!contexts.contains(parent.getVreid()))
iterator.remove();
}catch(Exception e){
} catch (Exception e) {
logger.warn("Failed to analyze this comment", e);
iterator.remove(); // remove it anyway
}
@ -159,29 +168,31 @@ public class Filters {
}
/**
* Depending on the type of object provided (e.g. Feed, Comment etc), some information are removed
* Depending on the type of object provided (e.g. Feed, Comment etc), some
* information are removed
*
* @param toClear
* @throws Exception
*/
public static <T> void hideSensitiveInformation(List<T> toClear, String usernameCaller){
public static <T> void hideSensitiveInformation(List<T> toClear, String usernameCaller) {
if(toClear == null || toClear.isEmpty() || usernameCaller == null || usernameCaller.isEmpty())
if (toClear == null || toClear.isEmpty() || usernameCaller == null || usernameCaller.isEmpty())
return;
else{
else {
// for feeds
if(toClear.get(0).getClass().equals(Feed.class)){
if (toClear.get(0).getClass().equals(Feed.class)) {
for (T feed : toClear) {
Feed feeded = ((Feed)feed);
if(!usernameCaller.equals(feeded.getEntityId()))
Feed feeded = ((Feed) feed);
if (!usernameCaller.equals(feeded.getEntityId()))
feeded.setEmail(""); // remove the email field
}
}else if(toClear.get(0).getClass().equals(EnhancedFeed.class)){
} else if (toClear.get(0).getClass().equals(EnhancedFeed.class)) {
for (T enhancedFeed : toClear) {
Feed feeded = ((EnhancedFeed)enhancedFeed).getFeed();
if(!usernameCaller.equals(feeded.getEntityId()))
Feed feeded = ((EnhancedFeed) enhancedFeed).getFeed();
if (!usernameCaller.equals(feeded.getEntityId()))
feeded.setEmail(""); // remove the email field
}
}

414
src/main/java/org/gcube/portal/social/networking/ws/utils/SocialUtils.java
View File

@ -69,7 +69,7 @@ public class SocialUtils {
private static final org.slf4j.Logger logger = LoggerFactory.getLogger(SocialUtils.class);
public final static String NO_TEXT_FILE_SHARE = "_N0_73X7_SH4R3_";
public final static int CACHING_TIME_TO_EXPIRATION = 2506000;//29 days 6 minutes 40 seconds
public final static int CACHING_TIME_TO_EXPIRATION = 2506000;// 29 days 6 minutes 40 seconds
public final static String DISABLED_USERS_NOTIFICATIONS_NAMESPACE = "dun:";
// name of the portlet for vre notification
@ -81,18 +81,18 @@ public class SocialUtils {
* @return a list of existing usernames associated with their fullnames
*/
private static ArrayList<GenericItemBean> getUsersFromUsernames(Set<String> mentions) {
if (mentions.isEmpty())
if (mentions.isEmpty())
return new ArrayList<>();
ArrayList<GenericItemBean> toReturn = new ArrayList<>();
UserManager uManager = UserManagerWSBuilder.getInstance().getUserManager();
for (String username : mentions) {
try{
try {
GCubeUser user = uManager.getUserByUsername(username);
String fullName = user.getFirstName() + " " + user.getLastName();
toReturn.add(new GenericItemBean(""+user.getUserId(), username, fullName, ""));
}catch(Exception e){
toReturn.add(new GenericItemBean("" + user.getUserId(), username, fullName, ""));
} catch (Exception e) {
logger.error("Unable to get user informations for username=" + username);
}
}
}
return toReturn;
}
@ -108,6 +108,7 @@ public class SocialUtils {
/**
* Method used when an application needs to publish something.
*
* @param postText
* @param uriParams
* @param previewTitle
@ -116,15 +117,14 @@ public class SocialUtils {
* @return true upon success, false on failure
*/
public static Post shareApplicationUpdate(
String postText,
String uriParams,
String previewTitle,
String previewDescription,
String postText,
String uriParams,
String previewTitle,
String previewDescription,
String httpImageUrl,
ApplicationProfile applicationProfile,
Caller caller,
boolean notifyGroup
){
boolean notifyGroup) {
SocialMessageParser messageParser = new SocialMessageParser(postText);
String escapedPostText = messageParser.getParsedMessage();
@ -132,60 +132,63 @@ public class SocialUtils {
ArrayList<GenericItemBean> mentionedUsers = getUsersFromUsernames(Utils.getMentionedUsernames(postText));
ArrayList<ItemBean> mentionedUsersToConvertInHTML = convertToItemBean(mentionedUsers);
SocialNetworkingSite site = SocialNetworkingSiteFinder.getSocialNetworkingSiteFromScope(ScopeProvider.instance.get());
SocialNetworkingSite site = SocialNetworkingSiteFinder
.getSocialNetworkingSiteFromScope(ScopeProvider.instance.get());
escapedPostText = Utils.convertMentionUsernamesAnchorHTML(escapedPostText, mentionedUsersToConvertInHTML, site.getSiteURL(), site.getSiteLandingPagePath());
escapedPostText = Utils.convertMentionUsernamesAnchorHTML(escapedPostText, mentionedUsersToConvertInHTML,
site.getSiteURL(), site.getSiteLandingPagePath());
logger.debug("*** Escaped post text is " + escapedPostText);
String scope = ScopeProvider.instance.get();
String appId = caller.getClient().getId();
String appId = caller.getClient().getId();
Post toWrite =
buildPost(
escapedPostText,
uriParams == null ? "" : uriParams,
previewTitle == null ? "" : previewTitle,
previewDescription == null ? "" : previewDescription,
httpImageUrl == null ? "" : httpImageUrl,
applicationProfile,
scope);
Post toWrite = buildPost(
escapedPostText,
uriParams == null ? "" : uriParams,
previewTitle == null ? "" : previewTitle,
previewDescription == null ? "" : previewDescription,
httpImageUrl == null ? "" : httpImageUrl,
applicationProfile,
scope);
// try to save it
boolean res = CassandraConnection.getInstance().getDatabookStore().saveAppPost(toWrite);
if(res){
if (res) {
logger.debug("Feed correctly written by application " + appId);
// wait a bit before saving hashtags
if(hashtags != null && !hashtags.isEmpty())
new Thread(()->{
if (hashtags != null && !hashtags.isEmpty())
new Thread(() -> {
try {
Thread.sleep(1000);
CassandraConnection.getInstance().getDatabookStore().saveHashTags(toWrite.getKey(), scope, hashtags);
CassandraConnection.getInstance().getDatabookStore().saveHashTags(toWrite.getKey(), scope,
hashtags);
} catch (Exception e1) {
logger.error("Failed to save hashtags in Cassandra", e1);
}
}).start();
// build the notification manager
// build the notification manager
SocialNetworkingUser user = new SocialNetworkingUser(appId, "", applicationProfile.getName(), applicationProfile.getImageUrl());
SocialNetworkingUser user = new SocialNetworkingUser(appId, "", applicationProfile.getName(),
applicationProfile.getImageUrl());
NotificationsManager nm = new ApplicationNotificationsManager(
UserManagerWSBuilder.getInstance().getUserManager(),
site,
scope,
user,
site,
scope,
user,
NEWS_FEED_PORTLET_CLASSNAME);
if (!mentionedUsers.isEmpty())
new Thread(new MentionNotificationsThread(toWrite.getKey(), toWrite.getDescription(), nm, null, mentionedUsers)).start();
new Thread(new MentionNotificationsThread(toWrite.getKey(), toWrite.getDescription(), nm, null,
mentionedUsers)).start();
if(notifyGroup){
if (notifyGroup) {
logger.debug("Sending notifications for " + appId + " " + scope);
try{
try {
String name = new ScopeBean(scope).name(); // scope such as devVRE
@ -193,28 +196,26 @@ public class SocialUtils {
GroupManager gManager = GroupManagerWSBuilder.getInstance().getGroupManager();
long groupId = gManager.getGroupId(name);
String groupName = gManager.getGroup(groupId).getGroupName();
String groupName = gManager.getGroup(groupId).getGroupName();
logger.debug("Company id and name " + groupId + " " + groupName);
// start notification thread
new Thread(new PostNotificationsThread(
UserManagerWSBuilder.getInstance().getUserManager(),
toWrite.getKey(),
toWrite.getDescription(),
""+groupId,
nm,
toWrite.getKey(),
toWrite.getDescription(),
"" + groupId,
nm,
new HashSet<String>(hashtags),
new HashSet<String>())
).start();
}catch (Exception e) {
new HashSet<String>())).start();
} catch (Exception e) {
logger.debug("Feed succesfully created but unable to send notifications.");
}
}
return toWrite;
}
else
} else
return null;
}
@ -222,82 +223,88 @@ public class SocialUtils {
/**
* Build an ApplicationProfile Feed.
*
* @param description add a description for the update you are sharing
* @param uriParams the additional parameters your applicationProfile needs to open the subject of this update e.g. id=12345&type=foo
* @param previewTitle the title to show in the preview
* @param previewDescription the description to show in the preview
* @param description add a description for the update you are sharing
* @param uriParams the additional parameters your applicationProfile
* needs to open the subject of this update e.g.
* id=12345&type=foo
* @param previewTitle the title to show in the preview
* @param previewDescription the description to show in the preview
* @param previewThumbnailUrl the image url to show in the preview
* @return a feed instance ready to be written
*/
private static Post buildPost(
String description,
String uriParams,
String previewTitle,
String previewDescription,
String description,
String uriParams,
String previewTitle,
String previewDescription,
String previewThumbnailUrl,
ApplicationProfile applicationProfile,
String scopeApp) {
String uri = applicationProfile.getUrl();
//add the GET params if necessary
// add the GET params if necessary
if (uriParams != null && uriParams.compareTo("") != 0)
uri += "?"+uriParams;
uri += "?" + uriParams;
Post toReturn = new Post(
UUID.randomUUID().toString(),
PostType.PUBLISH,
applicationProfile.getKey(),
new Date(),
scopeApp,
uri,
previewThumbnailUrl,
description,
PrivacyLevel.SINGLE_VRE,
applicationProfile.getName(),
"no-email",
applicationProfile.getImageUrl(),
previewTitle,
previewDescription,
"",
Post toReturn = new Post(
UUID.randomUUID().toString(),
PostType.PUBLISH,
applicationProfile.getKey(),
new Date(),
scopeApp,
uri,
previewThumbnailUrl,
description,
PrivacyLevel.SINGLE_VRE,
applicationProfile.getName(),
"no-email",
applicationProfile.getImageUrl(),
previewTitle,
previewDescription,
"",
true);
return toReturn;
}
}
/**
* This method looks up the applicationProfile profile among the ones available in the infrastructure
* @param idApp as identifier of your application (as reported in the ApplicationProfile)
* This method looks up the applicationProfile profile among the ones available
* in the infrastructure
*
* @param idApp as identifier of your application (as reported in the
* ApplicationProfile)
* @param scopeApp the scope of the application
*/
public static ApplicationProfile getProfileFromInfrastrucure(String idApp, String scopeApp) {
ScopeBean scope = new ScopeBean(scopeApp);
ScopeBean scope = new ScopeBean(scopeApp);
logger.debug("Trying to fetch applicationProfile profile from the infrastructure for " + idApp + " scope: " + scope);
logger.debug(
"Trying to fetch applicationProfile profile from the infrastructure for " + idApp + " scope: " + scope);
// set the scope of the root infrastructure
String rootInfrastructure = scopeApp.split("/")[1];
ScopeProvider.instance.set("/"+rootInfrastructure);
ScopeProvider.instance.set("/" + rootInfrastructure);
try {
ApplicationProfile toReturn = new ApplicationProfile();
Query q = new QueryBox("for $profile in collection('/db/Profiles/GenericResource')//Resource " +
"where $profile/Profile/SecondaryType/string() eq 'ApplicationProfile' and $profile/Profile/Body/AppId/string() " +
"where $profile/Profile/SecondaryType/string() eq 'ApplicationProfile' and $profile/Profile/Body/AppId/string() "
+
" eq '" + idApp + "'" +
"return $profile");
DiscoveryClient<String> client = client();
List<String> appProfile = client.submit(q);
if (appProfile == null || appProfile.size() == 0)
if (appProfile == null || appProfile.size() == 0)
throw new Exception("Your applicationProfile is not registered in the infrastructure");
else {
String elem = appProfile.get(0);
DocumentBuilder docBuilder = DocumentBuilderFactory.newInstance().newDocumentBuilder();
DocumentBuilder docBuilder = DocumentBuilderFactory.newInstance().newDocumentBuilder();
Node node = docBuilder.parse(new InputSource(new StringReader(elem))).getDocumentElement();
XPathHelper helper = new XPathHelper(node);
@ -307,16 +314,17 @@ public class SocialUtils {
toReturn.setName(currValue.get(0));
}
else throw new ApplicationProfileNotFoundException("Your applicationProfile NAME was not found in the profile");
} else
throw new ApplicationProfileNotFoundException(
"Your applicationProfile NAME was not found in the profile");
currValue = helper.evaluate("/Resource/Profile/Description/text()");
if (currValue != null && currValue.size() > 0) {
toReturn.setDescription(currValue.get(0));
}
else logger.warn("No Description exists for " + toReturn.getName());
} else
logger.warn("No Description exists for " + toReturn.getName());
currValue = helper.evaluate("/Resource/Profile/Body/AppId/text()");
@ -324,35 +332,41 @@ public class SocialUtils {
toReturn.setKey(currValue.get(0));
}
else throw new ApplicationProfileNotFoundException("Your applicationProfile ID n was not found in the profile, consider adding <AppId> element in <Body>");
} else
throw new ApplicationProfileNotFoundException(
"Your applicationProfile ID n was not found in the profile, consider adding <AppId> element in <Body>");
currValue = helper.evaluate("/Resource/Profile/Body/ThumbnailURL/text()");
if (currValue != null && currValue.size() > 0) {
toReturn.setImageUrl(currValue.get(0));
}
else throw new Exception("Your applicationProfile Image Url was not found in the profile, consider adding <ThumbnailURL> element in <Body>");
} else
throw new Exception(
"Your applicationProfile Image Url was not found in the profile, consider adding <ThumbnailURL> element in <Body>");
currValue = helper.evaluate("/Resource/Profile/Body/EndPoint/Scope/text()");
if (currValue != null && currValue.size() > 0) {
List<String> scopes = currValue;
boolean foundUrl = false;
for (int i = 0; i < scopes.size(); i++) {
if (currValue.get(i).trim().compareTo(scope.toString()) == 0) {
if (currValue.get(i).trim().compareTo(scope.toString()) == 0) {
toReturn.setUrl(helper.evaluate("/Resource/Profile/Body/EndPoint/URL/text()").get(i));
toReturn.setScope(scope.toString());
foundUrl = true;
break;
}
}
}
if (! foundUrl)
throw new ApplicationProfileNotFoundException("Your applicationProfile URL was not found in the profile for Scope: " + scope.toString());
if (!foundUrl)
throw new ApplicationProfileNotFoundException(
"Your applicationProfile URL was not found in the profile for Scope: "
+ scope.toString());
}
else throw new ApplicationProfileNotFoundException("Your applicationProfile EndPoint was not found in the profile, consider adding <EndPoint><Scope> element in <Body>");
else
throw new ApplicationProfileNotFoundException(
"Your applicationProfile EndPoint was not found in the profile, consider adding <EndPoint><Scope> element in <Body>");
logger.debug("Returning " + toReturn);
return toReturn;
}
@ -361,7 +375,7 @@ public class SocialUtils {
logger.error("Error while trying to fetch applicationProfile profile from the infrastructure", e);
} finally{
} finally {
// set the scope back
ScopeProvider.instance.set(scopeApp);
@ -374,6 +388,7 @@ public class SocialUtils {
/**
* Allows user to post a feed in a certain vre.
*
* @param userId
* @param postText
* @param vreId
@ -388,24 +403,26 @@ public class SocialUtils {
public static Post shareUserUpdate(
String userId,
String postText,
String vreId,
String previewTitle,
String previewDescription,
String vreId,
String previewTitle,
String previewDescription,
String previewHost,
String previewUrl,
String urlThumbnail,
String urlThumbnail,
boolean notifyGroup) {
SocialMessageParser messageParser = new SocialMessageParser(postText);
String escapedPostText = messageParser.getParsedMessage();
List<String> hashtags = messageParser.getHashtags();
//check if any mention exists
// check if any mention exists
ArrayList<GenericItemBean> mentionedUsers = getUsersFromUsernames(Utils.getMentionedUsernames(postText));
ArrayList<ItemBean> mentionedUsersToConvertInHTML = convertToItemBean(mentionedUsers);
SocialNetworkingSite site = SocialNetworkingSiteFinder.getSocialNetworkingSiteFromScope(ScopeProvider.instance.get());
SocialNetworkingSite site = SocialNetworkingSiteFinder
.getSocialNetworkingSiteFromScope(ScopeProvider.instance.get());
escapedPostText = Utils.convertMentionUsernamesAnchorHTML(escapedPostText, mentionedUsersToConvertInHTML, site.getSiteURL(), site.getSiteLandingPagePath());
escapedPostText = Utils.convertMentionUsernamesAnchorHTML(escapedPostText, mentionedUsersToConvertInHTML,
site.getSiteURL(), site.getSiteLandingPagePath());
GCubeUser user;
@ -413,7 +430,7 @@ public class SocialUtils {
UserManager uManager = UserManagerWSBuilder.getInstance().getUserManager();
try {
user = uManager.getUserByUsername(userId);
} catch(Exception e){
} catch (Exception e) {
logger.error("Unable to get user informations, post write fails.", e);
return null;
}
@ -428,7 +445,7 @@ public class SocialUtils {
if (urlThumbnail == null)
urlThumbnail = "null";
//this means the user has shared a file without text in it.
// this means the user has shared a file without text in it.
String textToPost = "";
if (escapedPostText.trim().compareTo(NO_TEXT_FILE_SHARE) == 0) {
textToPost = org.gcube.social_networking.socialutillibrary.Utils.convertFileNameAnchorHTML(url);
@ -437,23 +454,25 @@ public class SocialUtils {
}
Post toShare = new Post(UUID.randomUUID().toString(), PostType.PUBLISH, userId, new Date(),
vreId, url, urlThumbnail, textToPost, PrivacyLevel.SINGLE_VRE, fullName, email, thumbnailURL, linkTitle, linkDesc, host);
vreId, url, urlThumbnail, textToPost, PrivacyLevel.SINGLE_VRE, fullName, email, thumbnailURL, linkTitle,
linkDesc, host);
logger.debug("Attempting to save Post with text: " + textToPost + " Level = " + PrivacyLevel.SINGLE_VRE + " Timeline = " + vreId);
logger.debug("Attempting to save Post with text: " + textToPost + " Level = " + PrivacyLevel.SINGLE_VRE
+ " Timeline = " + vreId);
boolean result = CassandraConnection.getInstance().getDatabookStore().saveUserPost(toShare);
if(vreId != null && vreId.compareTo("") != 0 && result) {
if (vreId != null && vreId.compareTo("") != 0 && result) {
logger.trace("Attempting to write onto " + vreId);
try {
try{
try {
logger.debug("Sleeping waiting for cassandra's update");
Thread.sleep(1000);
}catch(Exception e){
} catch (Exception e) {
logger.error(e.toString());
@ -461,27 +480,31 @@ public class SocialUtils {
CassandraConnection.getInstance().getDatabookStore().saveFeedToVRETimeline(toShare.getKey(), vreId);
if (hashtags != null && !hashtags.isEmpty())
CassandraConnection.getInstance().getDatabookStore().saveHashTags(toShare.getKey(), vreId, hashtags);
CassandraConnection.getInstance().getDatabookStore().saveHashTags(toShare.getKey(), vreId,
hashtags);
} catch (FeedIDNotFoundException e) {
logger.error("Error writing onto VRES Time Line" + vreId);
}
logger.trace("Success writing onto " + vreId);
}
logger.trace("Success writing onto " + vreId);
}
if (!result)
if (!result)
return null;
SocialNetworkingUser socialUser =
new SocialNetworkingUser(userId, email, fullName, thumbnailURL);
NotificationsManager nm = new ApplicationNotificationsManager(UserManagerWSBuilder.getInstance().getUserManager(), site, vreId, socialUser, NEWS_FEED_PORTLET_CLASSNAME);
SocialNetworkingUser socialUser = new SocialNetworkingUser(userId, email, fullName, thumbnailURL);
NotificationsManager nm = new ApplicationNotificationsManager(
UserManagerWSBuilder.getInstance().getUserManager(), site, vreId, socialUser,
NEWS_FEED_PORTLET_CLASSNAME);
if (!mentionedUsers.isEmpty())
new Thread(new MentionNotificationsThread(toShare.getKey(), toShare.getDescription(), nm, null, mentionedUsers)).start();
new Thread(new MentionNotificationsThread(toShare.getKey(), toShare.getDescription(), nm, null,
mentionedUsers)).start();
//send the notification about this posts to everyone in the group if notifyGroup is true
// send the notification about this posts to everyone in the group if
// notifyGroup is true
if (vreId != null && vreId.compareTo("") != 0 && notifyGroup) {
try{
try {
// retrieve group information
GroupManager gManager = GroupManagerWSBuilder.getInstance().getGroupManager();
// handle the scope
@ -493,51 +516,56 @@ public class SocialUtils {
new Thread(
new PostNotificationsThread(
UserManagerWSBuilder.getInstance().getUserManager(),
toShare.getKey(),
toShare.getDescription(),
""+groupId,
nm,
toShare.getKey(),
toShare.getDescription(),
"" + groupId,
nm,
new HashSet<String>(),
new HashSet<String>(hashtags))
).start();
new HashSet<String>(hashtags)))
.start();
logger.debug("Start sending notifications for post written by " + userId);
}catch(Exception e){
} catch (Exception e) {
logger.error("Unable to notify users", e);
}
}
return toShare;
}
/**
* Allows to comment post in a certain vre.
* @param userid the username
* @param time the date and time of the comment
* @param postId the key of the post that was commented
*
* @param userid the username
* @param time the date and time of the comment
* @param postId the key of the post that was commented
* @param commentText the text as it is, it will be parsed
* @param postOwnerId the username of the user who created the post that was commented
* @param context the VRE context
* @param postOwnerId the username of the user who created the post that was
* commented
* @param context the VRE context
*
* @return the Comment instance if ok, null if somwthign went KO
* @throws FeedIDNotFoundException
* @throws FeedIDNotFoundException
*/
public static Comment commentPost(String userid, Date time, String postId, String commentText, String postOwnerId, String context) throws FeedIDNotFoundException {
public static Comment commentPost(String userid, Date time, String postId, String commentText, String postOwnerId,
String context) throws FeedIDNotFoundException {
SocialMessageParser messageParser = new SocialMessageParser(commentText);
String escapedCommentText = messageParser.getParsedMessage();
//check if any mention exists
// check if any mention exists
ArrayList<GenericItemBean> mentionedUsers = getUsersFromUsernames(Utils.getMentionedUsernames(commentText));
ArrayList<ItemBean> mentionedUsersToConvertInHTML = convertToItemBean(mentionedUsers);
SocialNetworkingSite site = SocialNetworkingSiteFinder.getSocialNetworkingSiteFromScope(ScopeProvider.instance.get());
SocialNetworkingSite site = SocialNetworkingSiteFinder
.getSocialNetworkingSiteFromScope(ScopeProvider.instance.get());
escapedCommentText = Utils.convertMentionUsernamesAnchorHTML(escapedCommentText, mentionedUsersToConvertInHTML, site.getSiteURL(), site.getSiteLandingPagePath());
escapedCommentText = Utils.convertMentionUsernamesAnchorHTML(escapedCommentText, mentionedUsersToConvertInHTML,
site.getSiteURL(), site.getSiteLandingPagePath());
// retrieve user information
GCubeUser user;
UserManager uManager = UserManagerWSBuilder.getInstance().getUserManager();
try {
user = uManager.getUserByUsername(userid);
} catch(Exception e){
} catch (Exception e) {
logger.error("Unable to get user informations, comment write fails.", e);
return null;
}
@ -546,57 +574,62 @@ public class SocialUtils {
String fullName = user.getFirstName() + " " + user.getLastName();
String thumbnailURL = user.getUserAvatarURL();
Comment theComment = new Comment(commentKey, userid, time, postId, escapedCommentText, fullName, thumbnailURL);
logger.debug("Attempting to save Comment with text: " + commentText + " postid="+postId);
Comment theComment = new Comment(commentKey, userid, time, postId, escapedCommentText, fullName, thumbnailURL);
logger.debug("Attempting to save Comment with text: " + commentText + " postid=" + postId);
boolean result = CassandraConnection.getInstance().getDatabookStore().addComment(theComment);
logger.debug("Added comment? " + theComment.toString() + " Result is " +result);
logger.debug("Added comment? " + theComment.toString() + " Result is " + result);
if (!result)
if (!result)
return null;
//if the comment was correctly delivered notify users involved
// if the comment was correctly delivered notify users involved
SocialNetworkingUser socialUser = new SocialNetworkingUser(userid, email, fullName, thumbnailURL);
NotificationsManager nm = new ApplicationNotificationsManager(uManager, site, context, socialUser, NEWS_FEED_PORTLET_CLASSNAME);
NotificationsManager nm = new ApplicationNotificationsManager(uManager, site, context, socialUser,
NEWS_FEED_PORTLET_CLASSNAME);
//if the user who commented this post is not the user who posted it notify the poster user (Post owner)
// if the user who commented this post is not the user who posted it notify the
// poster user (Post owner)
logger.debug("The post creator is " + postOwnerId);
if (! user.getUsername().equals(postOwnerId)) {
boolean resultNotifyOwnComment = nm.notifyOwnCommentReply(postOwnerId, postId, escapedCommentText, theComment.getKey());
if (!user.getUsername().equals(postOwnerId)) {
boolean resultNotifyOwnComment = nm.notifyOwnCommentReply(postOwnerId, postId, escapedCommentText,
theComment.getKey());
logger.debug("Comment Notification to post creator added? " + resultNotifyOwnComment);
}
//if there are users who liked this post they get notified, asynchronously with this thread
}
// if there are users who liked this post they get notified, asynchronously with
// this thread
ArrayList<Like> likes = getAllLikesByPost(postId);
Thread likesThread = new Thread(new LikeNotificationsThread(escapedCommentText, nm, likes, postOwnerId, theComment.getKey()));
Thread likesThread = new Thread(
new LikeNotificationsThread(escapedCommentText, nm, likes, postOwnerId, theComment.getKey()));
likesThread.start();
//notify the other users who commented this post (excluding the ones above)
// notify the other users who commented this post (excluding the ones above)
Thread commentsNotificationthread = new Thread(new CommentNotificationsThread(
CassandraConnection.getInstance().getDatabookStore(),
uManager, user.getUsername(), theComment.getFeedid(), escapedCommentText, nm, postOwnerId, theComment.getKey(), likes));
commentsNotificationthread.start();
uManager, user.getUsername(), theComment.getFeedid(), escapedCommentText, nm, postOwnerId,
theComment.getKey(), likes));
commentsNotificationthread.start();
//send the notification to the mentioned users, if any
// send the notification to the mentioned users, if any
if (mentionedUsers != null && mentionedUsers.size() > 0) {
ArrayList<GenericItemBean> toPass = new ArrayList<GenericItemBean>();
// among the mentionedUsers there could be groups of people
Map<String, ItemBean> uniqueUsersToNotify = new HashMap<>();
UserManager um = new LiferayUserManager();
for (ItemBean bean : mentionedUsersToConvertInHTML) {
if(bean.isItemGroup()){
if (bean.isItemGroup()) {
// retrieve the users of this group
try {
List<GCubeUser> teamUsers = um.listUsersByTeam(Long.parseLong(bean.getId()));
for (GCubeUser userTeam : teamUsers) {
if(!uniqueUsersToNotify.containsKey(userTeam.getUsername()))
uniqueUsersToNotify.put(userTeam.getUsername(), new ItemBean(userTeam.getUserId()+"",
if (!uniqueUsersToNotify.containsKey(userTeam.getUsername()))
uniqueUsersToNotify.put(userTeam.getUsername(), new ItemBean(userTeam.getUserId() + "",
userTeam.getUsername(), userTeam.getFullname(), userTeam.getUserAvatarURL()));
}
@ -606,9 +639,9 @@ public class SocialUtils {
logger.error("Unable to retrieve team information", e);
}
}else{
} else {
// it is a user, just add to the hashmap
if(!uniqueUsersToNotify.containsKey(bean.getName()))
if (!uniqueUsersToNotify.containsKey(bean.getName()))
uniqueUsersToNotify.put(bean.getName(), bean);
}
@ -620,17 +653,20 @@ public class SocialUtils {
Map.Entry<String, ItemBean> userEntry = (Map.Entry<String, ItemBean>) userMapIterator
.next();
ItemBean userBean = userEntry.getValue();
toPass.add(new GenericItemBean(userBean.getId(), userBean.getName(), userBean.getAlternativeName(), userBean.getThumbnailURL()));
toPass.add(new GenericItemBean(userBean.getId(), userBean.getName(), userBean.getAlternativeName(),
userBean.getThumbnailURL()));
}
Thread thread = new Thread(new MentionNotificationsThread(theComment.getFeedid(), escapedCommentText, nm, null, toPass));
Thread thread = new Thread(
new MentionNotificationsThread(theComment.getFeedid(), escapedCommentText, nm, null, toPass));
thread.start();
}
return theComment;
}
private static ArrayList<Like> getAllLikesByPost(String postid) {
ArrayList<Like> toReturn = (ArrayList<Like>) CassandraConnection.getInstance().getDatabookStore().getAllLikesByPost(postid);
ArrayList<Like> toReturn = (ArrayList<Like>) CassandraConnection.getInstance().getDatabookStore()
.getAllLikesByPost(postid);
logger.debug("Asking likes for " + postid);
for (Like like : toReturn) {
// retrieve user information
@ -638,7 +674,7 @@ public class SocialUtils {
UserManager uManager = UserManagerWSBuilder.getInstance().getUserManager();
try {
user = uManager.getUserByUsername(like.getUserid());
} catch(Exception e){
} catch (Exception e) {
logger.error("Unable to get user informations, comment write fails.", e);
return null;
}
@ -656,7 +692,7 @@ public class SocialUtils {
UserManager uManager = UserManagerWSBuilder.getInstance().getUserManager();
try {
user = uManager.getUserByUsername(username);
} catch(Exception e){
} catch (Exception e) {
logger.error("Unable to get user informations, like write fails.", e);
return false;
}
@ -664,40 +700,44 @@ public class SocialUtils {
String fullName = user.getFirstName() + " " + user.getLastName();
String thumbnailURL = user.getUserAvatarURL();
SocialNetworkingUser socialUser = new SocialNetworkingUser(user.getUsername(), email, fullName, thumbnailURL);
Like toLike = new Like(UUID.randomUUID().toString(), user.getUsername(),
Like toLike = new Like(UUID.randomUUID().toString(), user.getUsername(),
new Date(), postid, user.getFullname(), user.getUserAvatarURL());
Post thePost = null;
try {
logger.debug("Attempting to read post with id: " +postid);
logger.debug("Attempting to read post with id: " + postid);
thePost = CassandraConnection.getInstance().getDatabookStore().readPost(postid);
likeCommitResult = CassandraConnection.getInstance().getDatabookStore().like(toLike);
likeCommitResult = CassandraConnection.getInstance().getDatabookStore().like(toLike);
} catch (Exception e) {
logger.error("Post not found for this like ot could not like the post " + e.getMessage());
return false;
}
//if the like was correctly delivered notify the user who made the post
boolean resultNotifyLike =false;
// if the like was correctly delivered notify the user who made the post
boolean resultNotifyLike = false;
if (likeCommitResult) {
SocialNetworkingSite site = SocialNetworkingSiteFinder.getSocialNetworkingSiteFromScope(ScopeProvider.instance.get());
NotificationsManager nm = new ApplicationNotificationsManager(UserManagerWSBuilder.getInstance().getUserManager(), site, context, socialUser, NEWS_FEED_PORTLET_CLASSNAME);
SocialNetworkingSite site = SocialNetworkingSiteFinder
.getSocialNetworkingSiteFromScope(ScopeProvider.instance.get());
NotificationsManager nm = new ApplicationNotificationsManager(
UserManagerWSBuilder.getInstance().getUserManager(), site, context, socialUser,
NEWS_FEED_PORTLET_CLASSNAME);
String postText = thePost.getDescription();
String postOwnerId = thePost.getEntityId();
SocialMessageParser messageParser = new SocialMessageParser(postText);
String escapedPostText = messageParser.getParsedMessage();
//if the user who liked this post is not the user who posted it notify the poster user (Post owner)
logger.debug("The post creator is " + postOwnerId);
if (! user.getUsername().equals(postOwnerId)) {
// if the user who liked this post is not the user who posted it notify the
// poster user (Post owner)
logger.debug("The post creator is " + postOwnerId);
if (!user.getUsername().equals(postOwnerId)) {
resultNotifyLike = nm.notifyLikedPost(postOwnerId, postid, escapedPostText);
logger.debug("Like Notification to post creator added? " + resultNotifyLike);
}
}
}
return likeCommitResult && resultNotifyLike;
}
public static boolean unlike(String username, String likeid, String postid) {
boolean unlikeCommitResult = false;
// retrieve user information
@ -705,20 +745,20 @@ public class SocialUtils {
UserManager uManager = UserManagerWSBuilder.getInstance().getUserManager();
try {
user = uManager.getUserByUsername(username);
} catch(Exception e){
} catch (Exception e) {
logger.error("Unable to get user informations, unlike write fails.", e);
return false;
}
String fullName = user.getFirstName() + " " + user.getLastName();
String thumbnailURL = user.getUserAvatarURL();
try {
unlikeCommitResult = CassandraConnection.getInstance().getDatabookStore().unlike(username, likeid, postid);
unlikeCommitResult = CassandraConnection.getInstance().getDatabookStore().unlike(username, likeid, postid);
} catch (Exception e) {
logger.error("Post not Found for this like ot could not unlike the post " + e.getMessage());
return false;
}
return unlikeCommitResult;
}

26
src/main/java/org/gcube/portal/social/networking/ws/utils/TokensUtils.java
View File

@ -4,21 +4,22 @@ import org.gcube.common.authorization.library.ClientType;
import org.gcube.common.authorization.library.utils.Caller;
import org.slf4j.LoggerFactory;
/**
* Tokens utils methods
*/
public class TokensUtils {
// a user context token (not qualified) has as qualifier the word "TOKEN"
private static final String DEFAULT_QUALIFIER_USER_TOKEN = "TOKEN";
// Logger
private static final org.slf4j.Logger logger = LoggerFactory.getLogger(TokensUtils.class);
/**
* Check if it is a service token
*
* @return a boolean value
*/
public static boolean isServiceToken(Caller caller){
public static boolean isServiceToken(Caller caller) {
return caller.getClient().getType().equals(ClientType.SERVICE);
@ -26,9 +27,10 @@ public class TokensUtils {
/**
* Check if it is an application token
*
* @return a boolean value
*/
public static boolean isApplicationToken(Caller caller){
public static boolean isApplicationToken(Caller caller) {
String username = caller.getClient().getId();
if (username.startsWith("service-account-")) {
return true;
@ -39,9 +41,10 @@ public class TokensUtils {
/**
* Check if it is a container token
*
* @return a boolean value
*/
public static boolean isContainerToken(Caller caller){
public static boolean isContainerToken(Caller caller) {
return caller.getClient().getType().equals(ClientType.CONTAINER);
@ -49,10 +52,12 @@ public class TokensUtils {
/**
* Check if it is a user token
*
* @return a boolean value
*/
public static boolean isUserToken(Caller caller) {
logger.debug("\n ****** \n isUserToken: caller.getClient().getType().equals(ClientType.USER) => " + caller.getClient().getType().equals(ClientType.USER));
logger.debug("\n ****** \n isUserToken: caller.getClient().getType().equals(ClientType.USER) => "
+ caller.getClient().getType().equals(ClientType.USER));
String username = caller.getClient().getId();
if (username.startsWith("service-account-")) {
return false;
@ -63,19 +68,22 @@ public class TokensUtils {
/**
* Check if it is a user token (not qualified)
*
* @return a boolean value
*/
public static boolean isUserTokenDefault(Caller caller){
public static boolean isUserTokenDefault(Caller caller) {
return isUserToken(caller);
}
/**
* Check if it is a user token (qualified)
*
* @return a boolean value
*/
public static boolean isUserTokenQualified(Caller caller){
public static boolean isUserTokenQualified(Caller caller) {
return caller.getClient().getType().equals(ClientType.USER) && !caller.getTokenQualifier().equals(DEFAULT_QUALIFIER_USER_TOKEN);
return caller.getClient().getType().equals(ClientType.USER)
&& !caller.getTokenQualifier().equals(DEFAULT_QUALIFIER_USER_TOKEN);
}

5
src/main/java/org/gcube/portal/social/networking/ws/utils/UserProfileExtendedWithVerifiedEmail.java
View File

@ -19,7 +19,7 @@ public class UserProfileExtendedWithVerifiedEmail {
@JsonProperty("name")
private String fullname;
@JsonProperty("middle_name")
private String middleName;
@ -188,7 +188,4 @@ public class UserProfileExtendedWithVerifiedEmail {
return builder.toString();
}
}

8
src/main/webapp/WEB-INF/web.xml
View File

@ -1,7 +1,7 @@
<?xml version="1.0" encoding="UTF-8"?>
<web-app xmlns="http://java.sun.com/xml/ns/javaee" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://java.sun.com/xml/ns/javaee
http://java.sun.com/xml/ns/javaee/web-app_3_0.xsd"
<web-app xmlns="http://java.sun.com/xml/ns/javaee"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/web-app_3_0.xsd"
version="3.0">
<display-name>Restful Web Application</display-name>
@ -39,4 +39,4 @@
<welcome-file-list>
<welcome-file>index.jsp</welcome-file>
</welcome-file-list>
</web-app>
</web-app>

35
src/test/java/org/gcube/portal/test/GcoreEndpointReader.java
View File

@ -34,36 +34,41 @@ public class GcoreEndpointReader {
String currentScope = ScopeProvider.instance.get();
try{
try {
logger.info("set scope "+scope);
logger.info("set scope " + scope);
ScopeProvider.instance.set(scope);
SimpleQuery query = queryFor(GCoreEndpoint.class);
query.addCondition(String.format("$resource/Profile/ServiceClass/text() eq '%s'",serviceClass));
query.addCondition(String.format("$resource/Profile/ServiceClass/text() eq '%s'", serviceClass));
query.addCondition("$resource/Profile/DeploymentData/Status/text() eq 'ready'");
query.addCondition(String.format("$resource/Profile/ServiceName/text() eq '%s'",serviceName));
query.setResult("$resource/Profile/AccessPoint/RunningInstanceInterfaces//Endpoint[@EntryName/string() eq \""+resource+"\"]/text()");
query.addCondition(String.format("$resource/Profile/ServiceName/text() eq '%s'", serviceName));
query.setResult(
"$resource/Profile/AccessPoint/RunningInstanceInterfaces//Endpoint[@EntryName/string() eq \""
+ resource + "\"]/text()");
logger.debug("submitting quey "+query.toString());
logger.debug("submitting quey " + query.toString());
DiscoveryClient<String> client = client();
List<String> endpoints = client.submit(query);
if (endpoints == null || endpoints.isEmpty()) throw new Exception("Cannot retrieve the GCoreEndpoint serviceName: "+serviceName +", serviceClass: " +serviceClass +", in scope: "+scope);
if (endpoints == null || endpoints.isEmpty())
throw new Exception("Cannot retrieve the GCoreEndpoint serviceName: " + serviceName + ", serviceClass: "
+ serviceClass + ", in scope: " + scope);
this.resourceEntyName = endpoints.get(0);
if(resourceEntyName==null)
throw new Exception("Endpoint:"+resource+", is null for serviceName: "+serviceName +", serviceClass: " +serviceClass +", in scope: "+scope);
if (resourceEntyName == null)
throw new Exception("Endpoint:" + resource + ", is null for serviceName: " + serviceName
+ ", serviceClass: " + serviceClass + ", in scope: " + scope);
logger.info("found entyname "+resourceEntyName+" for ckanResource: "+resource);
logger.info("found entyname " + resourceEntyName + " for ckanResource: " + resource);
}catch(Exception e){
String error = "An error occurred during GCoreEndpoint discovery, serviceName: "+serviceName +", serviceClass: " +serviceClass +", in scope: "+scope +".";
} catch (Exception e) {
String error = "An error occurred during GCoreEndpoint discovery, serviceName: " + serviceName
+ ", serviceClass: " + serviceClass + ", in scope: " + scope + ".";
logger.error(error, e);
throw new Exception(error);
}finally{
if(currentScope != null)
} finally {
if (currentScope != null)
ScopeProvider.instance.set(currentScope);
}
}

33
src/test/java/org/gcube/portal/test/ServiceEndPointReaderSocial.java
View File

@ -16,6 +16,7 @@ import org.slf4j.LoggerFactory;
/**
* Retrieves the base url of the social-networking service in the scope provided
*
* @author Costantino Perciante at ISTI-CNR (costantino.perciante@isti.cnr.it)
*/
public class ServiceEndPointReaderSocial {
@ -26,23 +27,23 @@ public class ServiceEndPointReaderSocial {
private final static String RUNTIME_RESOURCE_NAME = "SocialNetworking";
private final static String CATEGORY = "Portal";
public ServiceEndPointReaderSocial(String context){
public ServiceEndPointReaderSocial(String context) {
if(context == null || context.isEmpty())
if (context == null || context.isEmpty())
throw new IllegalArgumentException("A valid context is needed to discover the service");
String oldContext = ScopeProvider.instance.get();
ScopeProvider.instance.set(context);
try{
try {
List<ServiceEndpoint> resources = getConfigurationFromIS();
if (resources.size() == 0){
logger.error("There is no Runtime Resource having name " + RUNTIME_RESOURCE_NAME +" and Category " + CATEGORY + " in this scope.");
throw new Exception("There is no Runtime Resource having name " + RUNTIME_RESOURCE_NAME +" and Category " + CATEGORY + " in this scope.");
}
else {
if (resources.size() == 0) {
logger.error("There is no Runtime Resource having name " + RUNTIME_RESOURCE_NAME + " and Category "
+ CATEGORY + " in this scope.");
throw new Exception("There is no Runtime Resource having name " + RUNTIME_RESOURCE_NAME
+ " and Category " + CATEGORY + " in this scope.");
} else {
for (ServiceEndpoint res : resources) {
@ -62,13 +63,13 @@ public class ServiceEndPointReaderSocial {
}
}catch(Exception e){
} catch (Exception e) {
logger.error("Unable to retrieve such service endpoint information!", e);
}finally{
} finally {
if(oldContext != null && !oldContext.equals(context))
if (oldContext != null && !oldContext.equals(context))
ScopeProvider.instance.set(oldContext);
}
@ -79,14 +80,15 @@ public class ServiceEndPointReaderSocial {
/**
* Retrieve endpoints information from IS for DB
*
* @return list of endpoints for ckan database
* @throws Exception
*/
private List<ServiceEndpoint> getConfigurationFromIS() throws Exception{
private List<ServiceEndpoint> getConfigurationFromIS() throws Exception {
SimpleQuery query = queryFor(ServiceEndpoint.class);
query.addCondition("$resource/Profile/Name/text() eq '"+ RUNTIME_RESOURCE_NAME +"'");
query.addCondition("$resource/Profile/Category/text() eq '"+ CATEGORY +"'");
query.addCondition("$resource/Profile/Name/text() eq '" + RUNTIME_RESOURCE_NAME + "'");
query.addCondition("$resource/Profile/Category/text() eq '" + CATEGORY + "'");
DiscoveryClient<ServiceEndpoint> client = clientFor(ServiceEndpoint.class);
List<ServiceEndpoint> toReturn = client.submit(query);
return toReturn;
@ -95,6 +97,7 @@ public class ServiceEndPointReaderSocial {
/**
* Get the base path of the social networking service
*
* @return
*/
public String getBasePath() {