content: /*
   ===========================================================================
   Copyright (c) 2013 3PillarGlobal
  
   Permission is hereby granted, free of charge, to any person obtaining a copy
   of this software and associated documentation files (the "Software"), to deal
   in the Software without restriction, including without limitation the rights
   to use, copy, modify, merge, publish, distribute, sub-license, and/or sell
   copies of the Software, and to permit persons to whom the Software is
   furnished to do so, subject to the following conditions:
  
   The above copyright notice and this permission notice shall be included in
   all copies or substantial portions of the Software.
  
   THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
   IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
   FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
   AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
   LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
   OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
   THE SOFTWARE.
   ===========================================================================
  
   */
  
  package org.brickred.socialauth.provider;
  
  import java.io.InputStream;
  import java.util.ArrayList;
  import java.util.Arrays;
  import java.util.HashMap;
  import java.util.List;
  import java.util.Map;
  
  import org.apache.commons.logging.Log;
  import org.apache.commons.logging.LogFactory;
  import org.brickred.socialauth.AbstractProvider;
  import org.brickred.socialauth.Contact;
  import org.brickred.socialauth.Permission;
  import org.brickred.socialauth.Profile;
  import org.brickred.socialauth.exception.AccessTokenExpireException;
  import org.brickred.socialauth.exception.ServerDataException;
  import org.brickred.socialauth.exception.SocialAuthException;
  import org.brickred.socialauth.exception.UserDeniedPermissionException;
  import org.brickred.socialauth.oauthstrategy.OAuth2;
  import org.brickred.socialauth.oauthstrategy.OAuthStrategyBase;
  import org.brickred.socialauth.util.AccessGrant;
  import org.brickred.socialauth.util.Constants;
  import org.brickred.socialauth.util.MethodType;
  import org.brickred.socialauth.util.OAuthConfig;
  import org.brickred.socialauth.util.Response;
  import org.json.JSONObject;
  
  /**
   * Provider implementation for GitHub
   * 
   * @author tarun.nagpal
   * 
   */
  public class GitHubImpl extends AbstractProvider {
  
  	private static final long serialVersionUID = -3529658778980357392L;
  	private static final Map<String, String> ENDPOINTS;
  	private final Log LOG = LogFactory.getLog(this.getClass());
  
  	private Permission scope;
  	private OAuthConfig config;
  	private Profile userProfile;
  	private AccessGrant accessGrant;
  	private OAuthStrategyBase authenticationStrategy;
  
  	private static final String[] AllPerms = new String[] { "user",
  			"user:email" };
  	private static final String[] AuthPerms = new String[] { "user",
  			"user:email" };
  
  	static {
  		ENDPOINTS = new HashMap<String, String>();
  		ENDPOINTS.put(Constants.OAUTH_AUTHORIZATION_URL,
  				"https://github.com/login/oauth/authorize");
  		ENDPOINTS.put(Constants.OAUTH_ACCESS_TOKEN_URL,
  				"https://github.com/login/oauth/access_token");
  		ENDPOINTS.put(Constants.API_URL,
  				"https://api.github.com");
  	}
  
  	/**
  	 * Stores configuration for the provider
  	 * 
  	 * @param providerConfig
  	 *            It contains the configuration of application like consumer key
  	 *            and consumer secret
  	 * @throws Exception
  	 */
  	public GitHubImpl(final OAuthConfig providerConfig) throws Exception {
  		config = providerConfig;
  		if (config.getCustomPermissions() != null) {
  			scope = Permission.CUSTOM;
  		}
  
  		if (config.getAuthenticationUrl() != null) {
  			ENDPOINTS.put(Constants.OAUTH_AUTHORIZATION_URL,
  					config.getAuthenticationUrl());
  		} else {
  			config.setAuthenticationUrl(ENDPOINTS
  					.get(Constants.OAUTH_AUTHORIZATION_URL));
  		}
  
  		if (config.getAccessTokenUrl() != null) {
  			ENDPOINTS.put(Constants.OAUTH_ACCESS_TOKEN_URL,
  					config.getAccessTokenUrl());
  		} else {
  			config.setAccessTokenUrl(ENDPOINTS
  					.get(Constants.OAUTH_ACCESS_TOKEN_URL));
  		}
  		// Get GitHub API_URL from custom properties
  		if (config.getCustomProperties() != null) {
  			Map<String, String> properties = config.getCustomProperties();
  			if (properties.get(Constants.API_URL) != null) {
  				ENDPOINTS.put(Constants.API_URL,
  						config.getCustomProperties().get(Constants.API_URL));
  			} else {
  				properties.put(Constants.API_URL, ENDPOINTS.get(Constants.API_URL));
  				config.setCustomProperties(properties);
  			}
  		}
  
  		authenticationStrategy = new OAuth2(config, ENDPOINTS);
  		authenticationStrategy.setPermission(scope);
  		authenticationStrategy.setScope(getScope());
  	}
  
  	@Override
  	public String getLoginRedirectURL(final String successUrl) throws Exception {
  		return authenticationStrategy.getLoginRedirectURL(successUrl);
  	}
  
  	@Override
  	public Profile verifyResponse(final Map<String, String> requestParams)
  			throws Exception {
  		return doVerifyResponse(requestParams);
  	}
  
  	private Profile doVerifyResponse(final Map<String, String> requestParams)
  			throws Exception {
  		LOG.info("Retrieving Access Token in verify response function");
  		if (requestParams.get("error_reason") != null
  				&& "user_denied".equals(requestParams.get("error_reason"))) {
  			throw new UserDeniedPermissionException();
  		}
  		accessGrant = authenticationStrategy.verifyResponse(requestParams,
  				MethodType.POST.toString());
  
  		if (accessGrant != null) {
  			LOG.debug("Obtaining user profile");
  			return getProfile();
  		} else {
  			throw new SocialAuthException("Access token not found");
  		}
  	}
  
  	private Profile getProfile() throws Exception {
  		String presp;
  
  		try {
  			Response response = authenticationStrategy.executeFeed(ENDPOINTS.get(Constants.API_URL) + "/user");
  			presp = response.getResponseBodyAsString(Constants.ENCODING);
  		} catch (Exception e) {
  			throw new SocialAuthException("Error while getting profile from "
  					+ ENDPOINTS.get(Constants.API_URL) + "/user", e);
  		}
  		try {
  			LOG.debug("User Profile : " + presp);
  			JSONObject resp = new JSONObject(presp);
  			Profile p = new Profile();
  			p.setValidatedId(resp.optString("id", null));
  			p.setFullName(resp.optString("name", null));
  			p.setEmail(resp.optString("email", null));
  			p.setLocation(resp.optString("location", null));
  			p.setProfileImageURL(resp.optString("avatar_url", null));
  			p.setDisplayName(resp.optString("login", null));
  			p.setProviderId(getProviderId());
  			if (config.isSaveRawResponse()) {
  				p.setRawResponse(presp);
  			}
  			userProfile = p;
  			return p;
  		} catch (Exception ex) {
  			throw new ServerDataException(
  					"Failed to parse the user profile json : " + presp, ex);
  		}
  	}
  
  	@Override
  	public Response updateStatus(final String msg) throws Exception {
  		LOG.warn("WARNING: Not implemented for GitHub");
  		throw new SocialAuthException(
  				"Update Status is not implemented for GitHub");
  	}
  
  	@Override
  	public List<Contact> getContactList() throws Exception {
  		LOG.warn("WARNING: Not implemented for GitHub");
  		throw new SocialAuthException(
  				"Get contact list is not implemented for GitHub");
  	}
  
  	@Override
  	public Profile getUserProfile() throws Exception {
  		if (userProfile == null && accessGrant != null) {
  			getProfile();
  		}
  		return userProfile;
  	}
  
  	@Override
  	public void logout() {
  		accessGrant = null;
  		authenticationStrategy.logout();
  	}
  
  	@Override
  	public void setPermission(final Permission p) {
  		LOG.debug("Permission requested : " + p.toString());
  		this.scope = p;
  		authenticationStrategy.setPermission(this.scope);
  		authenticationStrategy.setScope(getScope());
  	}
  
  	@Override
  	public Response api(final String url, final String methodType,
  			final Map<String, String> params,
  			final Map<String, String> headerParams, final String body)
  			throws Exception {
  		LOG.info("Calling api function for url	:	" + url);
  		Response response = null;
  		try {
  			response = authenticationStrategy.executeFeed(url, methodType,
  					params, headerParams, body);
  		} catch (Exception e) {
  			throw new SocialAuthException(
  					"Error while making request to URL : " + url, e);
  		}
  		return response;
  	}
  
  	@Override
  	public AccessGrant getAccessGrant() {
  		return accessGrant;
  	}
  
  	@Override
  	public String getProviderId() {
  		return config.getId();
  	}
  
  	@Override
  	public void setAccessGrant(final AccessGrant accessGrant)
  			throws AccessTokenExpireException, SocialAuthException {
  		this.accessGrant = accessGrant;
  		authenticationStrategy.setAccessGrant(accessGrant);
  
  	}
  
  	@Override
  	public Response uploadImage(final String message, final String fileName,
  			final InputStream inputStream) throws Exception {
  		LOG.warn("WARNING: Not implemented for GitHub");
  		throw new SocialAuthException(
  				"Upload Image is not implemented for GitHub");
  	}
  
  	@Override
  	protected List<String> getPluginsList() {
  		List<String> list = new ArrayList<String>();
  		if (config.getRegisteredPlugins() != null
  				&& config.getRegisteredPlugins().length > 0) {
  			list.addAll(Arrays.asList(config.getRegisteredPlugins()));
  		}
  		return list;
  	}
  
  	@Override
  	protected OAuthStrategyBase getOauthStrategy() {
  		return authenticationStrategy;
  	}
  
  	private String getScope() {
  		StringBuffer result = new StringBuffer();
  		String arr[] = null;
  		if (Permission.AUTHENTICATE_ONLY.equals(scope)) {
  			arr = AuthPerms;
  		} else if (Permission.CUSTOM.equals(scope)
  				&& config.getCustomPermissions() != null) {
  			arr = config.getCustomPermissions().split(",");
  		} else {
  			arr = AllPerms;
  		}
  		result.append(arr[0]);
  		for (int i = 1; i < arr.length; i++) {
  			result.append(",").append(arr[i]);
  		}
  		String pluginScopes = getPluginsScope(config);
  		if (pluginScopes != null) {
  			result.append(",").append(pluginScopes);
  		}
  		return result.toString();
  	}
  
  }
  