usermanagement-core/src/main/java/org/gcube/vomanagement/usermanagement/impl/ws/LiferayWSUserManager.java

package org.gcube.vomanagement.usermanagement.impl.ws;

import java.io.Serializable;
import java.util.ArrayList;
import java.util.List;
import java.util.Map;
import java.util.Set;

import org.apache.http.HttpHost;
import org.apache.http.auth.AuthScope;
import org.apache.http.auth.UsernamePasswordCredentials;
import org.apache.http.client.AuthCache;
import org.apache.http.client.CredentialsProvider;
import org.apache.http.client.methods.CloseableHttpResponse;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.client.protocol.HttpClientContext;
import org.apache.http.impl.auth.BasicScheme;
import org.apache.http.impl.client.BasicAuthCache;
import org.apache.http.impl.client.BasicCredentialsProvider;
import org.apache.http.impl.client.CloseableHttpClient;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.util.EntityUtils;
import org.gcube.vomanagement.usermanagement.UserManager;
import org.gcube.vomanagement.usermanagement.exception.GroupRetrievalFault;
import org.gcube.vomanagement.usermanagement.exception.RoleRetrievalFault;
import org.gcube.vomanagement.usermanagement.exception.TeamRetrievalFault;
import org.gcube.vomanagement.usermanagement.exception.UserManagementPortalException;
import org.gcube.vomanagement.usermanagement.exception.UserManagementSystemException;
import org.gcube.vomanagement.usermanagement.exception.UserRetrievalFault;
import org.gcube.vomanagement.usermanagement.model.Email;
import org.gcube.vomanagement.usermanagement.model.GCubeMembershipRequest;
import org.gcube.vomanagement.usermanagement.model.GCubeRole;
import org.gcube.vomanagement.usermanagement.model.GCubeUser;
import org.gcube.vomanagement.usermanagement.model.MembershipRequestStatus;
import org.json.simple.JSONArray;
import org.json.simple.JSONObject;
import org.json.simple.parser.JSONParser;
import org.slf4j.LoggerFactory;

import com.liferay.portal.kernel.exception.PortalException;
import com.liferay.portal.kernel.exception.SystemException;

/**
 * Exploit Liferay JSON Web Service to perform UserManager's operations.
 * @author Costantino Perciante at ISTI-CNR (costantino.perciante@isti.cnr.it)
 */
public class LiferayWSUserManager implements UserManager{

	// These properties are needed to save authentication credentials once.
	private HttpClientContext localContext;
	private CredentialsProvider credsProvider;
	private HttpHost target;

	// Several JSON calls use this property, so it will be discovered once (at init)
	private Long companyId;

	// the base path of the JSONWS apis
	private static final String API_BASE_URL = "/api/jsonws";

	// get methods paths
	private static final String GET_COMPANY_ID = "/company/get-company-by-web-id/web-id/liferay.com";
	private static final String GET_USER_BY_USERNAME = "/user/get-user-by-screen-name/company-id/$COMPANY_ID/screen-name/$USER_ID";
	private static final String GET_USER_BY_EMAIL= "/user/get-user-by-email-address/company-id/$COMPANY_ID/email-address/$EMAIL";
	private static final String GET_USERS_BY_GROUP = "/user/get-group-users/group-id/$GROUP_ID";
	private static final String GET_USER_CUSTOM_FIELD_BY_KEY = "/expandovalue/get-json-data/company-id/$COMPANY_ID/class-name/com.liferay.portal.model.User/table-name/CUSTOM_FIELDS/column-name/$CUSTOM_FIELD_KEY/class-pk/$USER_ID";
	//private static final String UPDATE_USER_CUSTOM_FIELD_BY_KEY = "/expandovalue/add-value/company-id/$COMPANY_ID/class-name/com.liferay.portal.model.User/table-name/CUSTOM_FIELDS/column-name/$CUSTOM_FIELD_KEY/class-pk/$USER_ID/data/$VALUE";
	private static final String GET_CONTACT_BY_USER_ID = "/contact/get-contact/contact-id/$CONTACT_ID";

	// logger
	private static final org.slf4j.Logger logger = LoggerFactory.getLogger(LiferayWSUserManager.class);

	// some pre-defined constants
	private static final String USER_LOCATION_INDUSTRY_KEY = "industry";

	/**
	 * In order to contact the json ws of Liferay, user and password are needed. The host in which the current JVM
	 * machine runs needs to be authorized.
	 * @param user
	 * @param password
	 * @param host the host to contact
	 * @param port the port number
	 * @throws Exception 
	 * @schema the schema (http/https) https is suggested!
	 */
	public LiferayWSUserManager(String user, String password, String host, String schema, int port) throws Exception{

		target = new HttpHost(host, port, schema);
		credsProvider = new BasicCredentialsProvider();
		credsProvider.setCredentials(
				new AuthScope(target.getHostName(), target.getPort()),
				new UsernamePasswordCredentials(user, password));

		AuthCache authCache = new BasicAuthCache();
		BasicScheme basicAuth = new BasicScheme();
		authCache.put(target, basicAuth);

		// Add AuthCache to the execution context
		localContext = HttpClientContext.create();
		localContext.setAuthCache(authCache);

		// retrieve the company-id which will used later on
		retrieveCompanyId();
	}

	/**
	 * Retrieve the company id value, which will be used later on for the other calls
	 * @throws Exception 
	 */
	private void retrieveCompanyId() throws Exception {

		String json = executeHTTPGETRequest(API_BASE_URL + GET_COMPANY_ID, credsProvider, localContext, target);

		if(json != null){
			JSONParser parser = new JSONParser();
			JSONObject jsonObject = (JSONObject)parser.parse(json);
			companyId = (Long)jsonObject.get("companyId");
			logger.info("Company id retrieved is " + companyId);
		}else
			throw new Exception("Failed to retrieve the company-id. The following calls will fail!");

	}

	/**
	 * Execute an http GET request and returns the JSON response
	 * @param requestPath
	 * @return a JSON string on success, null otherwise
	 */
	private static String executeHTTPGETRequest(String requestPath, CredentialsProvider credsProvider, HttpClientContext localContext, HttpHost target){

		try{
			CloseableHttpClient httpclient = HttpClients.custom()
					.setDefaultCredentialsProvider(credsProvider).build();

			HttpGet httpget = new HttpGet(requestPath);

			logger.debug("Executing request " + httpget.getRequestLine() + " to target " + target);
			CloseableHttpResponse response = httpclient.execute(target, httpget, localContext);
			try {
				String result = EntityUtils.toString(response.getEntity());
				logger.debug("Request result is " + result);
				return result;
			} finally {
				response.close();
			}
		}catch(Exception e){
			logger.error("Exception while performing GET request with path " + requestPath, e);
		}

		return null;

	}


	/**
	 * Maps the JSON user to the GCubeUser.class object
	 * @param json
	 * @return
	 */
	private GCubeUser mapLRUser(String json){	
		try{
			if (json != null) {
				JSONParser parser = new JSONParser();
				JSONObject userJSON = (JSONObject)parser.parse(json);
				// TODO skip for now
				List<Email> emails = new ArrayList<Email>();
				//			for (EmailAddress e : u.getEmailAddresses()) {
				//				emails.add(new Email(e.getAddress(), e.getType().toString(), e.isPrimary()));
				//			}

				String locationIndustry = "";
				try {
					locationIndustry = (String) readCustomAttr((long)userJSON.get("userId"), USER_LOCATION_INDUSTRY_KEY);
				} catch (Exception e1) {
					logger.warn("Failed to retrieve property " + USER_LOCATION_INDUSTRY_KEY, e1);
				}

				// retrieve the contact id information (it is into the user json)
				long contactId = (long)userJSON.get("contactId");

				// retrieve contact json obj from contactId
				String jsonContact = getContactJson(contactId);
				JSONObject contactJSON = (JSONObject)parser.parse(jsonContact);

				return new GCubeUser(
						(long)userJSON.get("userId"), 
						(String)userJSON.get("screenName"), 
						(String)userJSON.get("emailAddress"), 
						(String)userJSON.get("firstName"),
						(String)userJSON.get("middleName"),
						(String)userJSON.get("lastName"),
						buildFullName(userJSON),
						(long)userJSON.get("createDate"),
						null, // skip for now TODO getUserAvatarAbsoluteURL(u)
						(boolean)contactJSON.get("male"),
						(String)userJSON.get("jobTitle"),
						locationIndustry, 
						emails);
			}
		}catch(Exception e){
			logger.error("Exception while mapping the json user object to the GCubeUser java object", e);
		}
		return null;
	}

	/**
	 * From the json representing the user builds the fullname (which is missing, so firstname, lastname and middlename will be used)
	 * @param userJSON
	 * @return String representing the fullname
	 */
	private String buildFullName(JSONObject userJSON) {
		String first = (String)userJSON.get("firstName");
		String middle = (String)userJSON.get("middleName");
		String last = (String)userJSON.get("lastName");
		String fullname =
				(first == null | first.isEmpty() ? "" : first + " ") +
				(middle == null | middle.isEmpty() ? "" : middle + " ") +
				(last == null | last.isEmpty() ? "" : last + " ");
		logger.info("Built fullname is " + fullname);
		return fullname;
	}

	/**
	 * Given the contactId value, retrieves the json object releted to this information
	 * @param contactId
	 * @return
	 */
	private String getContactJson(long contactId) {

		return executeHTTPGETRequest(API_BASE_URL + GET_CONTACT_BY_USER_ID.replace("$CONTACT_ID", String.valueOf(contactId)), 
				credsProvider, localContext, target);
	}

	@Override
	public GCubeUser createUser(boolean autoScreenName, String username,
			String email, String firstName, String middleName, String lastName,
			String jobTitle, String location_industry,
			String backgroundSummary, boolean male, String reminderQuestion,
			String reminderAnswer) throws UserManagementSystemException {
		// TODO Auto-generated method stub
		return null;
	}

	@Override
	public GCubeUser createUser(boolean autoScreenName, String username,
			String email, String firstName, String middleName, String lastName,
			String jobTitle, String location_industry,
			String backgroundSummary, boolean male, String reminderQuestion,
			String reminderAnswer, boolean sendEmail, boolean forcePasswordReset)
					throws UserManagementSystemException {
		// TODO Auto-generated method stub
		return null;
	}

	@Override
	public GCubeUser createUser(boolean autoScreenName, String username,
			String email, String firstName, String middleName, String lastName,
			String jobTitle, String location_industry,
			String backgroundSummary, boolean male, String reminderQuestion,
			String reminderAnswer, boolean sendEmail,
			boolean forcePasswordReset, byte[] portraitBytes)
					throws UserManagementSystemException {
		// TODO Auto-generated method stub
		return null;
	}

	@Override
	public GCubeUser createUser(boolean autoScreenName, String username,
			String email, String firstName, String middleName, String lastName,
			String jobTitle, String location_industry,
			String backgroundSummary, boolean male, String reminderQuestion,
			String reminderAnswer, boolean sendEmail,
			boolean forcePasswordReset, byte[] portraitBytes, String mySpacesn,
			String twittersn, String facebooksn, String skypesn,
			String jabbersn, String aimsn) throws UserManagementSystemException {
		// TODO Auto-generated method stub
		return null;
	}

	@Override
	public GCubeUser getUserByUsername(String username)
			throws UserManagementSystemException, UserRetrievalFault {

		String jsonUser = 
				executeHTTPGETRequest(API_BASE_URL + GET_USER_BY_USERNAME.replace("$COMPANY_ID", String.valueOf(companyId)).replace("$USER_ID", username), 
						credsProvider, localContext, target);

		if(jsonUser != null){
			logger.debug("Json user retrieved");
			return mapLRUser(jsonUser);
		}else
			return null;

	}

	@Override
	public GCubeUser getUserByScreenName(String username)
			throws UserManagementSystemException, UserRetrievalFault {
		return getUserByUsername(username);
	}

	@Override
	public GCubeUser getUserByEmail(String email)
			throws UserManagementSystemException, UserRetrievalFault {
		String jsonUser = 
				executeHTTPGETRequest(API_BASE_URL + GET_USER_BY_EMAIL.replace("$COMPANY_ID", String.valueOf(companyId)).replace("$EMAIL", email), 
						credsProvider, localContext, target);

		if(jsonUser != null){
			logger.debug("Json user retrieved");
			return mapLRUser(jsonUser);
		}else
			return null;
	}

	@Override
	public GCubeUser getUserById(long userId)
			throws UserManagementSystemException, UserRetrievalFault {
		// TODO Auto-generated method stub
		return null;
	}

	@Override
	public long getUserId(String username)
			throws UserManagementSystemException, UserRetrievalFault {
		// TODO Auto-generated method stub
		return 0;
	}

	@Override
	public String getUserProfessionalBackground(long userId)
			throws UserManagementSystemException, UserRetrievalFault {
		// TODO Auto-generated method stub
		return null;
	}

	@Override
	public void setUserProfessionalBackground(long userId, String summary)
			throws UserManagementSystemException, UserRetrievalFault {
		// TODO Auto-generated method stub

	}

	@Override
	public List<GCubeUser> listUsers() throws UserManagementSystemException {
		// TODO Auto-generated method stub
		return null;
	}

	@Override
	public List<GCubeUser> listUsers(boolean indexed)
			throws UserManagementSystemException {
		// TODO Auto-generated method stub
		return null;
	}

	@Override
	public List<GCubeUser> listUsersByGroup(long groupId)
			throws UserManagementSystemException, GroupRetrievalFault,
			UserRetrievalFault {

		try{
			List<GCubeUser> toReturn = new ArrayList<GCubeUser>();
			String jsonUsers = 
					executeHTTPGETRequest(API_BASE_URL + GET_USERS_BY_GROUP.replace("$GROUP_ID", String.valueOf(groupId)), 
							credsProvider, localContext, target);

			if(jsonUsers != null){
				logger.debug("Trying to parse json users array ");
				JSONParser parser = new JSONParser();
				JSONArray array = (JSONArray)parser.parse(jsonUsers);
				for (int i = 0; i < array.size(); i++) {
					toReturn.add(mapLRUser(((JSONObject)array.get(i)).toJSONString()));
				}
			}else
				return null;

			return toReturn;
		}catch(Exception e){
			logger.error("Something went wrong, sorry", e);
			return null;
		}
	}

	@Override
	public List<GCubeUser> listUsersByGroup(long groupId, boolean indexed)
			throws UserManagementSystemException, GroupRetrievalFault,
			UserRetrievalFault {
		// TODO Auto-generated method stub
		return null;
	}

	@Override
	public List<GCubeUser> listUsersByGroupName(String name)
			throws UserManagementSystemException, GroupRetrievalFault,
			UserRetrievalFault {
		// TODO Auto-generated method stub
		return null;
	}

	@Override
	public Set<GCubeUser> getUserContactsByGroup(long userId, long scopeGroupId)
			throws UserManagementSystemException, GroupRetrievalFault,
			UserRetrievalFault {
		// TODO Auto-generated method stub
		return null;
	}

	@Override
	public List<GCubeMembershipRequest> listMembershipRequestsByGroup(
			long groupId) throws UserManagementSystemException,
			GroupRetrievalFault, UserRetrievalFault {
		// TODO Auto-generated method stub
		return null;
	}

	@Override
	public GCubeMembershipRequest getMembershipRequestsById(
			long membershipRequestId) {
		// TODO Auto-generated method stub
		return null;
	}

	@Override
	public List<GCubeMembershipRequest> getMembershipRequests(long userId,
			long groupId, MembershipRequestStatus status)
					throws UserManagementSystemException, GroupRetrievalFault,
					UserRetrievalFault {
		// TODO Auto-generated method stub
		return null;
	}

	@Override
	public GCubeMembershipRequest requestMembership(long userId, long groupId,
			String comment) throws UserManagementSystemException,
			GroupRetrievalFault, UserRetrievalFault {
		// TODO Auto-generated method stub
		return null;
	}

	@Override
	public GCubeMembershipRequest acceptMembershipRequest(long requestUserId,
			long groupId, boolean addUserToGroup, String replyUsername,
			String replyComment) throws UserManagementSystemException,
			GroupRetrievalFault, UserManagementPortalException {
		// TODO Auto-generated method stub
		return null;
	}

	@Override
	public GCubeMembershipRequest rejectMembershipRequest(long userId,
			long groupId, String replyUsername, String replyComment)
					throws UserManagementSystemException, GroupRetrievalFault,
					UserManagementPortalException {
		// TODO Auto-generated method stub
		return null;
	}

	@Override
	public Map<GCubeUser, List<GCubeRole>> listUsersAndRolesByGroup(long groupId)
			throws GroupRetrievalFault, UserManagementSystemException,
			UserRetrievalFault {
		// TODO Auto-generated method stub
		return null;
	}

	@Override
	public List<GCubeUser> listUsersByGroupAndRole(long groupId, long roleId)
			throws UserManagementSystemException, RoleRetrievalFault,
			GroupRetrievalFault, UserRetrievalFault {
		// TODO Auto-generated method stub
		return null;
	}

	@Override
	public List<GCubeUser> listUsersByTeam(long teamId)
			throws UserManagementSystemException, TeamRetrievalFault,
			UserRetrievalFault {
		// TODO Auto-generated method stub
		return null;
	}

	@Override
	public void assignUserToGroup(long groupId, long userId)
			throws UserManagementSystemException, GroupRetrievalFault,
			UserRetrievalFault, UserManagementPortalException {
		// TODO Auto-generated method stub

	}

	@Override
	public void dismissUserFromGroup(long groupId, long userId)
			throws UserManagementSystemException, GroupRetrievalFault,
			UserRetrievalFault {
		// TODO Auto-generated method stub

	}

	@Override
	public List<GCubeUser> listUnregisteredUsersByGroup(long groupId)
			throws UserManagementSystemException, GroupRetrievalFault,
			UserRetrievalFault {
		// TODO Auto-generated method stub
		return null;
	}

	@Override
	public boolean isPasswordChanged(String email) {
		// TODO Auto-generated method stub
		return false;
	}

	@Override
	public boolean userExistsByEmail(String email) {
		// TODO Auto-generated method stub
		return false;
	}

	@Override
	public String getFullNameFromEmail(String email) {
		// TODO Auto-generated method stub
		return null;
	}

	@Override
	public void deleteUserByEMail(String email)
			throws UserManagementSystemException,
			UserManagementPortalException, PortalException, SystemException {
		// TODO Auto-generated method stub

	}

	@Override
	public byte[] getUserAvatarBytes(String screenName) {
		// TODO Auto-generated method stub
		return null;
	}

	@Override
	public String getUserOpenId(String screenName) {
		// TODO Auto-generated method stub
		return null;
	}

	@Override
	public boolean updateContactInformation(String screenName,
			String mySpacesn, String twittersn, String facebooksn,
			String skypesn, String jabbersn, String aimsn) {
		// TODO Auto-generated method stub
		return false;
	}

	@Override
	public boolean updateJobTitle(long userId, String theJob) {
		// TODO Auto-generated method stub
		return false;
	}

	@Override
	public Serializable readCustomAttr(long userId, String attributeKey)
			throws UserRetrievalFault {
		String toReturn = null;
		try{
			String jsonCustomField = 
					executeHTTPGETRequest(API_BASE_URL + GET_USER_CUSTOM_FIELD_BY_KEY.replace("$COMPANY_ID", String.valueOf(companyId)).replace("$CUSTOM_FIELD_KEY", attributeKey).replace("$USER_ID", String.valueOf(userId)), 
							credsProvider, localContext, target);
			if(jsonCustomField != null){
				logger.debug("Trying to parse custom field in json object");
				JSONParser parser = new JSONParser();
				JSONObject obj = (JSONObject)parser.parse(jsonCustomField);
				toReturn = (String)obj.get("data");
			}

		}catch(Exception e){
			logger.error("Something went wrong, sorry", e);
			return null;
		}

		return toReturn;
	}

	@Override
	public void saveCustomAttr(long userId, String attributeKey,
			Serializable value) throws UserRetrievalFault {
		// TODO Auto-generated method stub
	}

}