gnu-social/actions/twitterauthorization.php

223 lines
6.7 KiB
PHP
Raw Normal View History

2009-08-01 09:20:44 +01:00
<?php
/**
* Laconica, the distributed open-source microblogging tool
*
* Class for doing OAuth authentication against Twitter
*
* PHP version 5
*
* LICENCE: This program 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.
*
* This program 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 this program. If not, see <http://www.gnu.org/licenses/>.
*
* @category Twitter
2009-08-01 09:20:44 +01:00
* @package Laconica
* @author Zach Copely <zach@controlyourself.ca>
* @copyright 2009 Control Yourself, Inc.
* @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
* @link http://laconi.ca/
*/
if (!defined('LACONICA')) {
exit(1);
}
/**
* Class for doing OAuth authentication against Twitter
*
* Peforms the OAuth "dance" between Laconica and Twitter -- requests a token,
* authorizes it, and exchanges it for an access token. It also creates a link
* (Foreign_link) between the Laconica user and Twitter user and stores the
* access token and secret in the link.
*
* @category Twitter
* @package Laconica
* @author Zach Copley <zach@controlyourself.ca>
* @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
* @link http://laconi.ca/
*
*/
2009-08-01 09:20:44 +01:00
class TwitterauthorizationAction extends Action
{
/**
* Initialize class members. Looks for 'oauth_token' parameter.
*
* @param array $args misc. arguments
*
* @return boolean true
*/
2009-08-01 09:20:44 +01:00
function prepare($args)
{
parent::prepare($args);
$this->oauth_token = $this->arg('oauth_token');
return true;
}
/**
* Handler method
*
* @param array $args is ignored since it's now passed in in prepare()
*
* @return nothing
*/
2009-08-01 09:20:44 +01:00
function handle($args)
{
parent::handle($args);
if (!common_logged_in()) {
$this->clientError(_('Not logged in.'), 403);
}
$user = common_current_user();
2009-08-01 09:20:44 +01:00
$flink = Foreign_link::getByUserID($user->id, TWITTER_SERVICE);
// If there's already a foreign link record, it means we already
// have an access token, and this is unecessary. So go back.
if (isset($flink)) {
common_redirect(common_local_url('twittersettings'));
}
// $this->oauth_token is only populated once Twitter authorizes our
// request token. If it's empty we're at the beginning of the auth
// process
if (empty($this->oauth_token)) {
$this->authorizeRequestToken();
} else {
$this->saveAccessToken();
}
}
2009-08-01 09:20:44 +01:00
/**
* Asks Twitter for a request token, and then redirects to Twitter
* to authorize it.
*
* @return nothing
*/
function authorizeRequestToken()
{
try {
2009-08-01 09:20:44 +01:00
// Get a new request token and authorize it
2009-08-01 09:20:44 +01:00
$client = new TwitterOAuthClient();
$req_tok =
$client->getRequestToken(TwitterOAuthClient::$requestTokenURL);
2009-08-01 09:20:44 +01:00
// Sock the request token away in the session temporarily
$_SESSION['twitter_request_token'] = $req_tok->key;
$_SESSION['twitter_request_token_secret'] = $req_tok->secret;
$auth_link = $client->getAuthorizeLink($req_tok);
2009-08-01 09:20:44 +01:00
} catch (TwitterOAuthClientException $e) {
$msg = sprintf('OAuth client cURL error - code: %1s, msg: %2s',
$e->getCode(), $e->getMessage());
$this->serverError(_('Couldn\'t link your Twitter account.'));
}
2009-08-01 09:20:44 +01:00
common_redirect($auth_link);
}
2009-08-01 09:20:44 +01:00
/**
* Called when Twitter returns an authorized request token. Exchanges
* it for an access token and stores it.
*
* @return nothing
*/
function saveAccessToken()
{
2009-08-01 09:20:44 +01:00
// Check to make sure Twitter returned the same request
// token we sent them
2009-08-01 09:20:44 +01:00
if ($_SESSION['twitter_request_token'] != $this->oauth_token) {
$this->serverError(_('Couldn\'t link your Twitter account.'));
}
2009-08-01 09:20:44 +01:00
try {
2009-08-01 09:20:44 +01:00
$client = new TwitterOAuthClient($_SESSION['twitter_request_token'],
$_SESSION['twitter_request_token_secret']);
2009-08-01 09:20:44 +01:00
// Exchange the request token for an access token
2009-08-01 09:20:44 +01:00
$atok = $client->getAccessToken(TwitterOAuthClient::$accessTokenURL);
2009-08-01 09:20:44 +01:00
// Test the access token and get the user's Twitter info
$client = new TwitterOAuthClient($atok->key, $atok->secret);
$twitter_user = $client->verifyCredentials();
} catch (OAuthClientException $e) {
$msg = sprintf('OAuth client cURL error - code: %1$s, msg: %2$s',
$e->getCode(), $e->getMessage());
$this->serverError(_('Couldn\'t link your Twitter account.'));
}
2009-08-01 09:20:44 +01:00
// Save the access token and Twitter user info
2009-08-01 09:20:44 +01:00
$this->saveForeignLink($atok, $twitter_user);
2009-08-01 09:20:44 +01:00
// Clean up the the mess we made in the session
2009-08-01 09:20:44 +01:00
unset($_SESSION['twitter_request_token']);
unset($_SESSION['twitter_request_token_secret']);
2009-08-01 09:20:44 +01:00
common_redirect(common_local_url('twittersettings'));
}
2009-08-01 09:20:44 +01:00
/**
* Saves a Foreign_link between Twitter user and local user,
* which includes the access token and secret.
*
* @param OAuthToken $access_token the access token to save
* @param mixed $twitter_user twitter API user object
*
* @return nothing
*/
function saveForeignLink($access_token, $twitter_user)
{
$user = common_current_user();
2009-08-01 09:20:44 +01:00
$flink = new Foreign_link();
2009-08-01 09:20:44 +01:00
$flink->user_id = $user->id;
$flink->foreign_id = $twitter_user->id;
$flink->service = TWITTER_SERVICE;
$creds = TwitterOAuthClient::packToken($access_token);
$flink->credentials = $creds;
$flink->created = common_sql_now();
2009-08-01 09:20:44 +01:00
// Defaults: noticesync on, everything else off
2009-08-01 09:20:44 +01:00
$flink->set_flags(true, false, false, false);
$flink_id = $flink->insert();
if (empty($flink_id)) {
common_log_db_error($flink, 'INSERT', __FILE__);
$this->serverError(_('Couldn\'t link your Twitter account.'));
2009-08-01 09:20:44 +01:00
}
save_twitter_user($twitter_user->id, $twitter_user->screen_name);
2009-08-01 09:20:44 +01:00
}
}