ProfileLinkLogicImpl.java

/**
 * Copyright (c) 2008-2012 The Sakai Foundation
 *
 * Licensed under the Educational Community License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *             http://www.osedu.org/licenses/ECL-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.sakaiproject.profile2.logic;

import java.util.HashMap;
import java.util.Map;

import lombok.Setter;

import org.apache.commons.lang.StringUtils;
import org.sakaiproject.profile2.util.ProfileConstants;

/**
 * Implementation of ProfileLinkLogic API
 * 
 * @author Steve Swinsburg (steve.swinsburg@gmail.com)
 *
 */
public class ProfileLinkLogicImpl implements ProfileLinkLogic {
	
	/**
 	* {@inheritDoc}
 	*/
	public String getInternalDirectUrlToUserProfile() {
		String currentUserUuid = sakaiProxy.getCurrentUserId();
		if(currentUserUuid == null) {
			throw new SecurityException("Must be logged in.");
		}
		// TODO do we want to set ProfileConstants.WICKET_PARAM_TAB here?
		return sakaiProxy.getDirectUrlToUserProfile(currentUserUuid, null);
	}
	
	
	/**
 	* {@inheritDoc}
 	*/
	public String getInternalDirectUrlToUserProfile(final String userUuid) {
		String currentUserUuid = sakaiProxy.getCurrentUserId();
		if(currentUserUuid == null) {
			throw new SecurityException("Must be logged in.");
		}
		
		//link direct to ViewProfile page and add in the user param
		String extraParams = null;
		if(sakaiProxy.isUsingNormalPortal()){
			Map<String,String> vars = new HashMap<String,String>();
			vars.put(ProfileConstants.WICKET_PARAM_USERID, userUuid);
			vars.put(ProfileConstants.WICKET_PARAM_TAB, "" + ProfileConstants.TAB_INDEX_PROFILE);
			extraParams = getFormattedStateParamForWicketTool(ProfileConstants.WICKET_PAGE_PROFILE_VIEW, vars);
		}
		
		return sakaiProxy.getDirectUrlToUserProfile(currentUserUuid, extraParams);
	}

	/**
	 * {@inheritDoc}
	 */
	public String getInternalDirectUrlToUserWall(String userUuid, String wallItemId) {
		String currentUserUuid = sakaiProxy.getCurrentUserId();
		if(currentUserUuid == null) {
			throw new SecurityException("Must be logged in.");
		}
		
		//link direct to ViewProfile page and add in the user param
		String extraParams = null;
		if(sakaiProxy.isUsingNormalPortal()){
			Map<String,String> vars = new HashMap<String,String>();
			vars.put(ProfileConstants.WICKET_PARAM_USERID, userUuid);
			vars.put(ProfileConstants.WICKET_PARAM_WALL_ITEM, wallItemId);
			vars.put(ProfileConstants.WICKET_PARAM_TAB, "" + ProfileConstants.TAB_INDEX_WALL);
			extraParams = getFormattedStateParamForWicketTool(ProfileConstants.WICKET_PAGE_PROFILE_VIEW, vars);
		}
		
		return sakaiProxy.getDirectUrlToUserProfile(currentUserUuid, extraParams);
	}
	
	/**
 	* {@inheritDoc}
 	*/
	public String getInternalDirectUrlToUserMessages(final String threadId) {
		String currentUserUuid = sakaiProxy.getCurrentUserId();
		if(currentUserUuid == null) {
			throw new SecurityException("Must be logged in.");
		}
		
		//link direct to messages page, if we have a threadId, add the appropriate params in
		String extraParams = null;
		if(sakaiProxy.isUsingNormalPortal()){
			Map<String,String> vars = null;
			if(StringUtils.isNotBlank(threadId)) {
				vars = new HashMap<String,String>();
				vars.put(ProfileConstants.WICKET_PARAM_THREAD, threadId);
			}
			extraParams = getFormattedStateParamForWicketTool(ProfileConstants.WICKET_PAGE_MESSAGES, vars);
		}
		
		return sakaiProxy.getDirectUrlToUserProfile(currentUserUuid, extraParams);
	}

	/**
 	* {@inheritDoc}
 	*/
	public String getInternalDirectUrlToUserConnections() {
		String currentUserUuid = sakaiProxy.getCurrentUserId();
		if(currentUserUuid == null) {
			throw new SecurityException("Must be logged in.");
		}
		
		//link direct to connections page, no extra params needed
		String extraParams = null;
		if(sakaiProxy.isUsingNormalPortal()){
			extraParams = getFormattedStateParamForWicketTool(ProfileConstants.WICKET_PAGE_CONNECTIONS, null);
		}
		return sakaiProxy.getDirectUrlToUserProfile(currentUserUuid, extraParams);
	}

	/**
 	 * {@inheritDoc}
 	 */
	public String getEntityLinkToProfileHome(final String userUuid) {
		StringBuilder url = new StringBuilder();
		url.append(getEntityLinkBase());
		url.append(ProfileConstants.LINK_ENTITY_PROFILE);
		if(StringUtils.isNotBlank(userUuid)) {
			url.append("/");
			url.append(userUuid);
		}
		return url.toString();
	}
	
	
	/**
 	 * {@inheritDoc}
 	 */
	public String getEntityLinkToProfileMessages(final String threadId) {
		StringBuilder url = new StringBuilder();
		url.append(getEntityLinkBase());
		url.append(ProfileConstants.LINK_ENTITY_MESSAGES);
		if(StringUtils.isNotBlank(threadId)) {
			url.append("/");
			url.append(threadId);
		}
		return url.toString();
	}
	
	/**
 	 * {@inheritDoc}
 	 */
	public String getEntityLinkToProfileConnections() {
		StringBuilder url = new StringBuilder();
		url.append(getEntityLinkBase());
		url.append(ProfileConstants.LINK_ENTITY_CONNECTIONS);
		return url.toString();
	}
	
	/**
 	 * {@inheritDoc}
 	 */
	public String getEntityLinkToProfileWall(String userUuid) {
		StringBuilder url = new StringBuilder();
		url.append(getEntityLinkBase());
		url.append(ProfileConstants.LINK_ENTITY_WALL);
		if(StringUtils.isNotBlank(userUuid)) {
			url.append("/");
			url.append(userUuid);
		}
		return url.toString();
	}
	
	/**
 	 * {@inheritDoc}
 	 */
	/*
	public String generateTinyUrl(final String url) {
		return tinyUrlService.generateTinyUrl(url);
	}
	*/
	
	
	

	/**
	 * Special method that mimics the urlFor method from Wicket for a class.
	 * Since we can't use that outside of Wicket, we need to copy it's behaviour here. This must be tested in Wicket upgrades 
	 * but should be stable since the idea is that they are bookmarkable links and shouldn't change.
	 * 
	 * <p>The return is not URL encoded as it is encoded in SakaiProxy</p>
	 * 
	 * @param pageClass	page class to be used, see ProfileConstants.WICKET_PAGE_PROFILE for example
	 * @param params	key,value pair of any additional params required for the URL
	 * @return
	 */
	private String getFormattedStateParamForWicketTool(final String pageClass, final Map<String,String> vars) {
		

		//%3Fwicket%3AbookmarkablePage%3D%3Aorg.sakaiproject.profile2.tool.pages.MyFriends
		//?wicket:bookmarkablePage=:org.sakaiproject.profile2.tool.pages.MyFriends
		//%3Fwicket%3AbookmarkablePage%3D%3Aorg.sakaiproject.profile2.tool.pages.MyMessageView%26thread%3D99eb8904-e4a5-4569-bbda-bef4be6803aa
		//&thread=99eb8904-e4a5-4569-bbda-bef4be6803aa
		
		StringBuilder params = new StringBuilder();
		params.append("?wicket:bookmarkablePage=:");
		params.append(pageClass);
		
		if(vars != null) {
			for(Map.Entry<String,String> var : vars.entrySet()) {
				params.append("&");
				params.append(var.getKey());
				params.append("=");
				params.append(var.getValue());
			}
		}

		return params.toString();
	}
	
	/**
	 * Helper method to create the link base. We then append more onto it to get the full link.
	 * @return
	 */
	private String getEntityLinkBase() {
		StringBuilder base = new StringBuilder();
		base.append(sakaiProxy.getServerUrl());
		base.append(ProfileConstants.ENTITY_BROKER_PREFIX);
		base.append(ProfileConstants.LINK_ENTITY_PREFIX);
		return base.toString();
	}
	
	@Setter
	private SakaiProxy sakaiProxy;
	
}