org.structr.web.auth.TwitterAuthClient Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of structr-ui Show documentation
Structr is an open source framework based on the popular Neo4j graph database.
The newest version!
/**
 * Copyright (C) 2010-2016 Structr GmbH
 *
 * This file is part of Structr .
 *
 * Structr is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as
 * published by the Free Software Foundation, either version 3 of the
 * License, or (at your option) any later version.
 *
 * Structr is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with Structr.  If not, see .
 */
package org.structr.web.auth;

import java.util.logging.Level;
import java.util.logging.Logger;
import javax.servlet.http.HttpServletRequest;
import org.structr.core.app.StructrApp;
import org.structr.core.property.PropertyKey;
import org.structr.web.entity.User;
import twitter4j.Twitter;
import twitter4j.TwitterException;
import twitter4j.TwitterFactory;
import twitter4j.auth.AccessToken;
import twitter4j.auth.RequestToken;
import twitter4j.conf.Configuration;
import twitter4j.conf.ConfigurationBuilder;

/**
 * Twitter supports only OAuth 1.0a, therefore we need a completely different
 * approach and library here.
 * 
 *
 */
public class TwitterAuthClient extends StructrOAuthClient {
	
	private static final Logger logger	= Logger.getLogger(TwitterAuthClient.class.getName());
	
	private static Twitter twitter;
	
	public TwitterAuthClient() {}

	@Override
	protected void init(final String authorizationLocation, final String tokenLocation, final String clientId, final String clientSecret, final String redirectUri, final Class tokenResponseClass) {

		super.init(authorizationLocation, tokenLocation, clientId, clientSecret, redirectUri, tokenResponseClass);

		ConfigurationBuilder cb = new ConfigurationBuilder();
		cb.setOAuthAuthorizationURL(authorizationLocation);
		cb.setOAuthAccessTokenURL(tokenLocation);

		Configuration conf = cb.build();
		
		TwitterFactory tf = new TwitterFactory(conf);
		twitter = tf.getInstance();
		twitter.setOAuthConsumer(clientId, clientSecret);
		
	}

	/**
	 * Create an end-user authorization request
	 * 
	 * Use with {@literal response.setRedirect(request.getLocationUri());}
	 * 
	 * @param request
	 * @return auth request URI
	 */
	@Override
	public String getEndUserAuthorizationRequestUri(final HttpServletRequest request) {
		
		RequestToken requestToken;
		
		try {
			// The following does not work, leads to the following error from Twitter:
			//String callbackUrl = getAbsoluteUrl(request, redirectUri);
			//logger.log(Level.INFO, "Callback URL: {0}", callbackUrl);
			//requestToken = twitter.getOAuthRequestToken(callbackUrl, "read");
			/*
			/* 401:Authentication credentials (https://dev.twitter.com/pages/auth) were missing or incorrect. Ensure that you have set valid consumer key/secret, access token/secret, and the system clock is in sync.
			/* 
			/* 
  			/*   Desktop applications only support the oauth_callback value 'oob'
  			/*   /oauth/request_token
			/* 
			/* 
			/* Relevant discussions can be found on the Internet at:
			/*	http://www.google.co.jp/search?q=6c607809 or
			/*	http://www.google.co.jp/search?q=102175dd
			/* 			 
			 */

			requestToken = twitter.getOAuthRequestToken();
			request.getSession().setAttribute("requestToken", requestToken);
			
			// Workaround for requestToken.getAuthorizationURL() ignoring configuration built with ConfigurationBuilder
			String authorizationUrl = twitter.getConfiguration().getOAuthAuthorizationURL().concat("?oauth_token=").concat(requestToken.getToken());
			logger.log(Level.INFO, "Authorization request location URI: {0}", authorizationUrl);
			
			return authorizationUrl;
			
		} catch (TwitterException ex) {
			
			logger.log(Level.SEVERE, null, ex);
			
		}

		return null;	
		
	}
		
	@Override
	public String getAccessToken(final HttpServletRequest request) {
		
		String verifier = request.getParameter("oauth_verifier");
		RequestToken requestToken = (RequestToken) request.getSession().getAttribute("requestToken");

		AccessToken accessToken;
		try {
			
			accessToken = twitter.getOAuthAccessToken(requestToken, verifier);
		
			return accessToken.toString();
			
		} catch (TwitterException ex) {
			
			logger.log(Level.SEVERE, null, ex);
			
		}
		
		return null;
			
	}

	@Override
	public String getValue(final HttpServletRequest request, final String key) {
		
		try {
			
			return twitter.getScreenName();
			
		} catch (TwitterException | IllegalStateException ex) {
			
			logger.log(Level.SEVERE, null, ex);
			
		}
		
		return null;
		
	}
	
	
	@Override
	public ResponseFormat getResponseFormat() {
		
		return ResponseFormat.json;
		
	}

	@Override
	public String getReturnUri() {
		
		return StructrApp.getConfigurationValue("oauth.twitter.return_uri", "/");
			
	}

	@Override
	public String getErrorUri() {
		
		return StructrApp.getConfigurationValue("oauth.twitter.error_uri", "/");
			
	}

	@Override
	public PropertyKey getCredentialKey() {
		
		return User.twitterName;
		
	}
	
	@Override
	public String getCredential(final HttpServletRequest request) {
		
		return getValue(request, "screen_name");
		
	}

	
}