/*
===========================================================================
Copyright (c) 2010 BrickRed Technologies Limited
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.oauthstrategy.OAuth1;
import org.brickred.socialauth.oauthstrategy.OAuthStrategyBase;
import org.brickred.socialauth.util.AccessGrant;
import org.brickred.socialauth.util.BirthDate;
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.brickred.socialauth.util.XMLParseUtil;
import org.w3c.dom.Element;
import org.w3c.dom.NodeList;
/**
* Implementation of LinkedIn provider. This uses the OAuth API provided by
* Linkedin
*
*
* @author tarunn@brickred.com
*
*/
public class LinkedInImpl extends AbstractProvider {
private static final long serialVersionUID = -6141448721085510813L;
private static final String CONNECTION_URL = "http://api.linkedin.com/v1/people/~/connections:(id,first-name,last-name,public-profile-url,picture-url)";
private static final String UPDATE_STATUS_URL = "http://api.linkedin.com/v1/people/~/shares";
private static final String PROFILE_URL = "http://api.linkedin.com/v1/people/~:(id,first-name,last-name,languages,date-of-birth,picture-url,email-address,location:(name),phone-numbers,main-address)";
private static final String STATUS_BODY = "<?xml version=\"1.0\" encoding=\"UTF-8\"?><share><comment>%1$s</comment><visibility><code>anyone</code></visibility></share>";
private static final Map<String, String> ENDPOINTS;
private final Log LOG = LogFactory.getLog(LinkedInImpl.class);
private Permission scope;
private AccessGrant accessToken;
private OAuthConfig config;
private Profile userProfile;
private OAuthStrategyBase authenticationStrategy;
private static final String[] AllPerms = new String[] { "r_fullprofile",
"r_emailaddress", "r_network", "r_contactinfo", "rw_nus" };
private static final String[] AuthPerms = new String[] { "r_fullprofile",
"r_emailaddress" };
static {
ENDPOINTS = new HashMap<String, String>();
ENDPOINTS.put(Constants.OAUTH_REQUEST_TOKEN_URL,
"https://api.linkedin.com/uas/oauth/requestToken");
ENDPOINTS.put(Constants.OAUTH_AUTHORIZATION_URL,
"https://api.linkedin.com/uas/oauth/authenticate");
ENDPOINTS.put(Constants.OAUTH_ACCESS_TOKEN_URL,
"https://api.linkedin.com/uas/oauth/accessToken");
}
/**
* Stores configuration for the provider
*
* @param providerConfig
* It contains the configuration of application like consumer key
* and consumer secret
* @throws Exception
*/
public LinkedInImpl(final OAuthConfig providerConfig) throws Exception {
config = providerConfig;
// Need to pass scope while fetching RequestToken from LinkedIn for new
// keys
if (config.getCustomPermissions() != null) {
scope = Permission.CUSTOM;
}
if (config.getRequestTokenUrl() != null) {
ENDPOINTS.put(Constants.OAUTH_REQUEST_TOKEN_URL,
config.getRequestTokenUrl());
} else {
config.setRequestTokenUrl(ENDPOINTS
.get(Constants.OAUTH_REQUEST_TOKEN_URL));
}
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));
}
String perms = getScope();
if (perms != null) {
String rURL = ENDPOINTS.get(Constants.OAUTH_REQUEST_TOKEN_URL);
if (!rURL.contains("scope=")) {
rURL += "?scope=" + perms;
} else {
rURL = rURL.substring(0, rURL.indexOf('?'));
rURL += "?scope=" + perms;
}
ENDPOINTS.put(Constants.OAUTH_REQUEST_TOKEN_URL, rURL);
config.setRequestTokenUrl(rURL);
}
authenticationStrategy = new OAuth1(config, ENDPOINTS);
config.setRequestTokenUrl(ENDPOINTS
.get(Constants.OAUTH_REQUEST_TOKEN_URL));
config.setAuthenticationUrl(ENDPOINTS
.get(Constants.OAUTH_AUTHORIZATION_URL));
config.setAccessTokenUrl(ENDPOINTS
.get(Constants.OAUTH_ACCESS_TOKEN_URL));
}
/**
* Stores access grant for the provider
*
* @param accessGrant
* It contains the access token and other information
* @throws AccessTokenExpireException
*/
@Override
public void setAccessGrant(final AccessGrant accessGrant)
throws AccessTokenExpireException {
this.accessToken = accessGrant;
authenticationStrategy.setAccessGrant(accessGrant);
}
/**
* This is the most important action. It redirects the browser to an
* appropriate URL which will be used for authentication with the provider
* that has been set using setId()
*
* @throws Exception
*/
@Override
public String getLoginRedirectURL(final String successUrl) throws Exception {
return authenticationStrategy.getLoginRedirectURL(successUrl);
}
/**
* Verifies the user when the external provider redirects back to our
* application.
*
*
* @param requestParams
* request parameters, received from the provider
* @return Profile object containing the profile information
* @throws Exception
*/
@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("Verifying the authentication response from provider");
accessToken = authenticationStrategy.verifyResponse(requestParams);
return getProfile();
}
/**
* Gets the list of contacts of the user and their email.
*
* @return List of profile objects representing Contacts. Only name and
* email will be available
*/
@Override
public List<Contact> getContactList() throws Exception {
LOG.info("Fetching contacts from " + CONNECTION_URL);
Response serviceResponse = null;
try {
serviceResponse = authenticationStrategy
.executeFeed(CONNECTION_URL);
} catch (Exception ie) {
throw new SocialAuthException(
"Failed to retrieve the contacts from " + CONNECTION_URL,
ie);
}
Element root;
try {
root = XMLParseUtil.loadXmlResource(serviceResponse
.getInputStream());
} catch (Exception e) {
throw new ServerDataException(
"Failed to parse the contacts from response."
+ CONNECTION_URL, e);
}
List<Contact> contactList = new ArrayList<Contact>();
if (root != null) {
NodeList pList = root.getElementsByTagName("person");
if (pList != null && pList.getLength() > 0) {
LOG.debug("Found contacts : " + pList.getLength());
for (int i = 0; i < pList.getLength(); i++) {
Element p = (Element) pList.item(i);
String fname = XMLParseUtil.getElementData(p, "first-name");
String lname = XMLParseUtil.getElementData(p, "last-name");
String id = XMLParseUtil.getElementData(p, "id");
String profileUrl = XMLParseUtil.getElementData(p,
"public-profile-url");
String pictureUrl = XMLParseUtil.getElementData(p,
"picture-url");
if (id != null) {
Contact cont = new Contact();
if (fname != null) {
cont.setFirstName(fname);
}
if (lname != null) {
cont.setLastName(lname);
}
if (profileUrl != null) {
cont.setProfileUrl(profileUrl);
}
if (pictureUrl != null) {
cont.setProfileImageURL(pictureUrl);
}
cont.setId(id);
contactList.add(cont);
}
}
} else {
LOG.debug("No connections were obtained from : "
+ CONNECTION_URL);
}
}
return contactList;
}
@Override
public Response updateStatus(final String msg) throws Exception {
if (msg == null || msg.trim().length() == 0) {
throw new ServerDataException("Status cannot be blank");
}
String message = msg;
if (msg.length() > 700) {
LOG.warn("Message length can not be greater than 700 characters. So truncating it to 700 chars");
message = msg.substring(0, 700);
}
// message = URLEncoder.encode(message, Constants.ENCODING);
message = message.replace("&", "&");
LOG.info("Updating status " + message + " on " + UPDATE_STATUS_URL);
Map<String, String> headerParams = new HashMap<String, String>();
headerParams.put("Content-Type", "text/xml;charset=UTF-8");
String msgBody = String.format(STATUS_BODY, message);
Response serviceResponse = null;
try {
serviceResponse = authenticationStrategy.executeFeed(
UPDATE_STATUS_URL, MethodType.POST.toString(), null,
headerParams, msgBody);
} catch (Exception ie) {
throw new SocialAuthException("Failed to update status on "
+ UPDATE_STATUS_URL, ie);
}
LOG.debug("Status Updated and return status code is : "
+ serviceResponse.getStatus());
// return 201
return serviceResponse;
}
/**
* Logout
*/
@Override
public void logout() {
accessToken = null;
authenticationStrategy.logout();
}
private Profile getProfile() throws Exception {
LOG.debug("Obtaining user profile");
Profile profile = new Profile();
Response serviceResponse = null;
try {
serviceResponse = authenticationStrategy.executeFeed(PROFILE_URL);
} catch (Exception e) {
throw new SocialAuthException(
"Failed to retrieve the user profile from " + PROFILE_URL,
e);
}
if (serviceResponse.getStatus() != 200) {
throw new SocialAuthException(
"Failed to retrieve the user profile from " + PROFILE_URL
+ ". Staus :" + serviceResponse.getStatus());
}
Element root;
try {
root = XMLParseUtil.loadXmlResource(serviceResponse
.getInputStream());
} catch (Exception e) {
throw new ServerDataException(
"Failed to parse the profile from response." + PROFILE_URL,
e);
}
if (root != null) {
String fname = XMLParseUtil.getElementData(root, "first-name");
String lname = XMLParseUtil.getElementData(root, "last-name");
NodeList dob = root.getElementsByTagName("date-of-birth");
if (dob != null && dob.getLength() > 0) {
Element dobel = (Element) dob.item(0);
if (dobel != null) {
String y = XMLParseUtil.getElementData(dobel, "year");
String m = XMLParseUtil.getElementData(dobel, "month");
String d = XMLParseUtil.getElementData(dobel, "day");
BirthDate bd = new BirthDate();
if (m != null) {
bd.setMonth(Integer.parseInt(m));
}
if (d != null) {
bd.setDay(Integer.parseInt(d));
}
if (y != null) {
bd.setYear(Integer.parseInt(y));
}
profile.setDob(bd);
}
}
String picUrl = XMLParseUtil.getElementData(root, "picture-url");
String id = XMLParseUtil.getElementData(root, "id");
if (picUrl != null) {
profile.setProfileImageURL(picUrl);
}
String email = XMLParseUtil.getElementData(root, "email-address");
if (email != null) {
profile.setEmail(email);
}
NodeList location = root.getElementsByTagName("location");
if (location != null && location.getLength() > 0) {
Element locationEl = (Element) location.item(0);
String loc = XMLParseUtil.getElementData(locationEl, "name");
if (loc != null) {
profile.setLocation(loc);
}
}
Map<String, String> map = new HashMap<String, String>();
NodeList phoneNodes = root.getElementsByTagName("phone-number");
if (phoneNodes != null && phoneNodes.getLength() > 0) {
Element phoneEl = (Element) phoneNodes.item(0);
String type = XMLParseUtil
.getElementData(phoneEl, "phone-type");
String phone = XMLParseUtil.getElementData(phoneEl,
"phone-number");
if (type != null && type.length() > 0 && phone != null) {
map.put(type, phone);
}
}
String mainAddress = XMLParseUtil.getElementData(root,
"main-address");
if (mainAddress != null) {
map.put("mainAddress", mainAddress);
}
if (map != null && !map.isEmpty()) {
profile.setContactInfo(map);
}
profile.setFirstName(fname);
profile.setLastName(lname);
profile.setValidatedId(id);
profile.setProviderId(getProviderId());
LOG.debug("User Profile :" + profile.toString());
userProfile = profile;
}
return profile;
}
/**
*
* @param p
* Permission object which can be Permission.AUHTHENTICATE_ONLY,
* Permission.ALL, Permission.DEFAULT
*/
@Override
public void setPermission(final Permission p) {
LOG.debug("Permission requested : " + p.toString());
this.scope = p;
authenticationStrategy.setPermission(this.scope);
}
/**
* Makes OAuth signed HTTP request to a given URL. It attaches Authorization
* header with HTTP request.
*
* @param url
* URL to make HTTP request.
* @param methodType
* Method type can be GET, POST or PUT
* @param params
* Any additional parameters whose signature need to compute.
* Only used in case of "POST" and "PUT" method type.
* @param headerParams
* Any additional parameters need to pass as Header Parameters
* @param body
* Request Body
* @return Response object
* @throws Exception
*/
@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.debug("Calling URL : " + url);
return authenticationStrategy.executeFeed(url, methodType, params,
headerParams, body);
}
/**
* Retrieves the user profile.
*
* @return Profile object containing the profile information.
*/
@Override
public Profile getUserProfile() throws Exception {
if (userProfile == null && accessToken != null) {
getProfile();
}
return userProfile;
}
@Override
public AccessGrant getAccessGrant() {
return accessToken;
}
@Override
public String getProviderId() {
return config.getId();
}
@Override
public Response uploadImage(final String message, final String fileName,
final InputStream inputStream) throws Exception {
LOG.warn("WARNING: Not implemented for LinkedIn");
throw new SocialAuthException(
"Update Image is not implemented for LinkedIn");
}
@Override
protected List<String> getPluginsList() {
List<String> list = new ArrayList<String>();
list.add("org.brickred.socialauth.plugin.linkedin.FeedPluginImpl");
list.add("org.brickred.socialauth.plugin.linkedin.CareerPluginImpl");
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]);
}
List<String> scopes = config.getPluginsScopes();
if (scopes != null && !scopes.isEmpty()) {
String scopesStr = scopes.get(0);
for (int i = 1; i < scopes.size(); i++) {
scopesStr += " " + scopes.get(i);
}
result.append(" ").append(scopesStr);
}
return result.toString();
}
}