diff --git a/statusnet/library/twitteroauth.php b/statusnet/library/twitteroauth.php index bf56fc01..860a74b6 100644 --- a/statusnet/library/twitteroauth.php +++ b/statusnet/library/twitteroauth.php @@ -13,10 +13,6 @@ */ class TwitterOAuth { - /* Contains the last HTTP status code returned. */ - public $http_code; - /* Contains the last API call. */ - public $url; /* Set up the API root URL. */ public $host = "https://api.twitter.com/1.1/"; /* Set timeout default. */ @@ -25,17 +21,34 @@ class TwitterOAuth public $connecttimeout = 30; /* Verify SSL Cert. */ public $ssl_verifypeer = FALSE; - /* Respons format. */ + /* Response format. */ public $format = 'json'; /* Decode returned json data. */ public $decode_json = TRUE; - /* Contains the last HTTP headers returned. */ - public $http_info; - /* Set the useragnet. */ + /* Set the useragent. */ public $useragent = 'TwitterOAuth v0.2.0-beta2'; - /* Immediately retry the API call if the response was not successful. */ - //public $retry = TRUE; + /* Contains the last HTTP status code returned. */ + public $http_code; + /* Contains the last API call. */ + public $url; + /** + * Contains the last HTTP headers returned. + * @var array + */ + public $http_header; + /** + * Contains the last HTTP request info + * @var string + */ + public $http_info; + + /** @var OAuthToken */ + private $token; + /** @var OAuthConsumer */ + private $consumer; + /** @var OAuthSignatureMethod_HMAC_SHA1 */ + private $sha1_method; /** * Set API URLS @@ -60,60 +73,49 @@ class TwitterOAuth return 'https://api.twitter.com/oauth/request_token'; } - /** - * Debug helpers - */ - function lastStatusCode() - { - return $this->http_status; - } - - function lastAPICall() - { - return $this->last_api_call; - } - - /** - * construct TwitterOAuth object - */ - function __construct($consumer_key, $consumer_secret, $oauth_token = NULL, $oauth_token_secret = NULL) + function __construct($consumer_key, $consumer_secret, $oauth_token = null, $oauth_token_secret = null) { $this->sha1_method = new OAuthSignatureMethod_HMAC_SHA1(); $this->consumer = new OAuthConsumer($consumer_key, $consumer_secret); if (!empty($oauth_token) && !empty($oauth_token_secret)) { - $this->token = new OAuthConsumer($oauth_token, $oauth_token_secret); + $this->token = new OAuthToken($oauth_token, $oauth_token_secret); } else { - $this->token = NULL; + $this->token = null; } } /** - * Get a request_token from Twitter + * Get a request_token * - * @returns a key/value array containing oauth_token and oauth_token_secret + * @param callback $oauth_callback + * @return array */ - function getRequestToken($oauth_callback = NULL) + function getRequestToken($oauth_callback = null) { - $parameters = array(); + $parameters = []; if (!empty($oauth_callback)) { $parameters['oauth_callback'] = $oauth_callback; } + $request = $this->oAuthRequest($this->requestTokenURL(), 'GET', $parameters); $token = OAuthUtil::parse_parameters($request); - $this->token = new OAuthConsumer($token['oauth_token'], $token['oauth_token_secret']); + $this->token = new OAuthToken($token['oauth_token'], $token['oauth_token_secret']); return $token; } /** * Get the authorize URL * - * @returns a string + * @param array $token + * @param bool $sign_in_with_tumblr + * @return string */ function getAuthorizeURL($token, $sign_in_with_twitter = TRUE) { if (is_array($token)) { $token = $token['oauth_token']; } + if (empty($sign_in_with_twitter)) { return $this->authorizeURL() . "?oauth_token={$token}"; } else { @@ -125,27 +127,32 @@ class TwitterOAuth * Exchange request token and secret for an access token and * secret, to sign API calls. * - * @returns array("oauth_token" => "the-access-token", + * @param bool $oauth_verifier + * @return array ("oauth_token" => "the-access-token", * "oauth_token_secret" => "the-access-secret", * "user_id" => "9436992", * "screen_name" => "abraham") */ function getAccessToken($oauth_verifier = FALSE) { - $parameters = array(); + $parameters = []; if (!empty($oauth_verifier)) { $parameters['oauth_verifier'] = $oauth_verifier; } + $request = $this->oAuthRequest($this->accessTokenURL(), 'GET', $parameters); $token = OAuthUtil::parse_parameters($request); - $this->token = new OAuthConsumer($token['oauth_token'], $token['oauth_token_secret']); + $this->token = new OAuthToken($token['oauth_token'], $token['oauth_token_secret']); + return $token; } /** * One time exchange of username and password for access token and secret. * - * @returns array("oauth_token" => "the-access-token", + * @param string $username + * @param string $password + * @return array ("oauth_token" => "the-access-token", * "oauth_token_secret" => "the-access-secret", * "user_id" => "9436992", * "screen_name" => "abraham", @@ -153,60 +160,82 @@ class TwitterOAuth */ function getXAuthToken($username, $password) { - $parameters = array(); + $parameters = []; $parameters['x_auth_username'] = $username; $parameters['x_auth_password'] = $password; $parameters['x_auth_mode'] = 'client_auth'; $request = $this->oAuthRequest($this->accessTokenURL(), 'POST', $parameters); $token = OAuthUtil::parse_parameters($request); - $this->token = new OAuthConsumer($token['oauth_token'], $token['oauth_token_secret']); + $this->token = new OAuthToken($token['oauth_token'], $token['oauth_token_secret']); + return $token; } /** * GET wrapper for oAuthRequest. + * + * @param string $url + * @param array $parameters + * @return mixed|string */ - function get($url, $parameters = array()) + function get($url, $parameters = []) { $response = $this->oAuthRequest($url, 'GET', $parameters); if ($this->format === 'json' && $this->decode_json) { return json_decode($response); } + return $response; } /** * POST wrapper for oAuthRequest. + * + * @param string $url + * @param array $parameters + * @return mixed|string */ - function post($url, $parameters = array()) + function post($url, $parameters = []) { $response = $this->oAuthRequest($url, 'POST', $parameters); if ($this->format === 'json' && $this->decode_json) { return json_decode($response); } + return $response; } /** * DELETE wrapper for oAuthReqeust. + * + * @param string $url + * @param array $parameters + * @return mixed|string */ - function delete($url, $parameters = array()) + function delete($url, $parameters = []) { $response = $this->oAuthRequest($url, 'DELETE', $parameters); if ($this->format === 'json' && $this->decode_json) { return json_decode($response); } + return $response; } /** * Format and sign an OAuth / API request + * + * @param string $url + * @param string $method + * @param array $parameters + * @return mixed|string */ function oAuthRequest($url, $method, $parameters) { if (strrpos($url, 'https://') !== 0 && strrpos($url, 'http://') !== 0) { $url = "{$this->host}{$url}.{$this->format}"; } + $request = OAuthRequest::from_consumer_and_token($this->consumer, $this->token, $method, $url, $parameters); $request->sign_request($this->sha1_method, $this->consumer, $this->token); switch ($method) { @@ -222,11 +251,14 @@ class TwitterOAuth /** * Make an HTTP request * - * @return API results + * @param string $url + * @param string $method + * @param mixed $postfields + * @return string API results */ - function http($url, $method, $postfields = NULL) + function http($url, $method, $postfields = null) { - $this->http_info = array(); + $this->http_info = []; $ci = curl_init(); /* Curl settings */ curl_setopt($ci, CURLOPT_USERAGENT, $this->useragent); @@ -258,11 +290,16 @@ class TwitterOAuth $this->http_info = array_merge($this->http_info, curl_getinfo($ci)); $this->url = $url; curl_close($ci); + return $response; } /** * Get the header info to store. + * + * @param resource $ch + * @param string $header + * @return int */ function getHeader($ch, $header) { @@ -272,6 +309,7 @@ class TwitterOAuth $value = trim(substr($header, $i + 2)); $this->http_header[$key] = $value; } + return strlen($header); } }