From 98c47f24ba56d2b06301b8778e3fa940d0e1cf0c Mon Sep 17 00:00:00 2001 From: Benjamin Lorteau Date: Wed, 11 Dec 2019 13:04:36 -0500 Subject: [PATCH 1/4] [tumblr] Fix formatting in library/tumblroauth --- tumblr/library/tumblroauth.php | 465 ++++++++++++++++++--------------- 1 file changed, 254 insertions(+), 211 deletions(-) diff --git a/tumblr/library/tumblroauth.php b/tumblr/library/tumblroauth.php index 37da6142..895269f2 100644 --- a/tumblr/library/tumblroauth.php +++ b/tumblr/library/tumblroauth.php @@ -9,234 +9,277 @@ /** * Tumblr OAuth class */ -class TumblrOAuth { - /* 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.tumblr.com/v2/"; - /* Set timeout default. */ - public $timeout = 30; - /* Set connect timeout. */ - public $connecttimeout = 30; - /* Verify SSL Cert. */ - public $ssl_verifypeer = FALSE; - /* Respons format. */ - public $format = 'json'; - /* Decode returned json data. */ - public $decode_json = TRUE; - /* Contains the last HTTP headers returned. */ - public $http_info; - /* Set the useragnet. */ - public $useragent = 'TumblrOAuth v0.2.0-beta2'; - /* Immediately retry the API call if the response was not successful. */ - //public $retry = TRUE; +class TumblrOAuth +{ + /* 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.tumblr.com/v2/"; + /* Set timeout default. */ + public $timeout = 30; + /* Set connect timeout. */ + public $connecttimeout = 30; + /* Verify SSL Cert. */ + public $ssl_verifypeer = FALSE; + /* Respons format. */ + public $format = 'json'; + /* Decode returned json data. */ + public $decode_json = TRUE; + /* Contains the last HTTP headers returned. */ + public $http_info; + /* Set the useragnet. */ + public $useragent = 'TumblrOAuth v0.2.0-beta2'; + /* Immediately retry the API call if the response was not successful. */ + //public $retry = TRUE; + /** + * Set API URLS + */ + function accessTokenURL() + { + return 'https://www.tumblr.com/oauth/access_token'; + } + + function authenticateURL() + { + return 'https://www.tumblr.com/oauth/authorize'; + } + + function authorizeURL() + { + return 'https://www.tumblr.com/oauth/authorize'; + } + + function requestTokenURL() + { + return 'https://www.tumblr.com/oauth/request_token'; + } + + /** + * Debug helpers + */ + function lastStatusCode() + { + return $this->http_status; + } + + function lastAPICall() + { + return $this->last_api_call; + } + + /** + * construct TumblrOAuth object + */ + 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); + } else { + $this->token = null; + } + } - /** - * Set API URLS - */ - function accessTokenURL() { return 'https://www.tumblr.com/oauth/access_token'; } - function authenticateURL() { return 'https://www.tumblr.com/oauth/authorize'; } - function authorizeURL() { return 'https://www.tumblr.com/oauth/authorize'; } - function requestTokenURL() { return 'https://www.tumblr.com/oauth/request_token'; } + /** + * Get a request_token from Tumblr + * + * @returns a key/value array containing oauth_token and oauth_token_secret + */ + function getRequestToken($oauth_callback = null) + { + $parameters = array(); + if (!empty($oauth_callback)) { + $parameters['oauth_callback'] = $oauth_callback; + } - /** - * Debug helpers - */ - function lastStatusCode() { return $this->http_status; } - function lastAPICall() { return $this->last_api_call; } + $request = $this->oAuthRequest($this->requestTokenURL(), 'GET', $parameters); + $token = OAuthUtil::parse_parameters($request); + $this->token = new OAuthConsumer($token['oauth_token'], $token['oauth_token_secret']); + return $token; + } - /** - * construct TumblrOAuth object - */ - 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); - } else { - $this->token = null; - } - } + /** + * Get the authorize URL + * + * @returns a string + */ + function getAuthorizeURL($token, $sign_in_with_tumblr = TRUE) + { + if (is_array($token)) { + $token = $token['oauth_token']; + } + if (empty($sign_in_with_tumblr)) { + return $this->authorizeURL() . "?oauth_token={$token}"; + } else { + return $this->authenticateURL() . "?oauth_token={$token}"; + } + } - /** - * Get a request_token from Tumblr - * - * @returns a key/value array containing oauth_token and oauth_token_secret - */ - function getRequestToken($oauth_callback = null) { - $parameters = array(); - 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']); - return $token; - } + /** + * Exchange request token and secret for an access token and + * secret, to sign API calls. + * + * @returns 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(); + if (!empty($oauth_verifier)) { + $parameters['oauth_verifier'] = $oauth_verifier; + } - /** - * Get the authorize URL - * - * @returns a string - */ - function getAuthorizeURL($token, $sign_in_with_tumblr = TRUE) { - if (is_array($token)) { - $token = $token['oauth_token']; - } - if (empty($sign_in_with_tumblr)) { - return $this->authorizeURL() . "?oauth_token={$token}"; - } else { - return $this->authenticateURL() . "?oauth_token={$token}"; - } - } + $request = $this->oAuthRequest($this->accessTokenURL(), 'GET', $parameters); + $token = OAuthUtil::parse_parameters($request); + $this->token = new OAuthConsumer($token['oauth_token'], $token['oauth_token_secret']); - /** - * Exchange request token and secret for an access token and - * secret, to sign API calls. - * - * @returns 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(); - 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']); - return $token; - } + return $token; + } - /** - * One time exchange of username and password for access token and secret. - * - * @returns array("oauth_token" => "the-access-token", - * "oauth_token_secret" => "the-access-secret", - * "user_id" => "9436992", - * "screen_name" => "abraham", - * "x_auth_expires" => "0") - */ - function getXAuthToken($username, $password) { - $parameters = array(); - $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']); - return $token; - } + /** + * One time exchange of username and password for access token and secret. + * + * @returns array("oauth_token" => "the-access-token", + * "oauth_token_secret" => "the-access-secret", + * "user_id" => "9436992", + * "screen_name" => "abraham", + * "x_auth_expires" => "0") + */ + function getXAuthToken($username, $password) + { + $parameters = array(); + $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']); - /** - * GET wrapper for oAuthRequest. - */ - function get($url, $parameters = array()) { - $response = $this->oAuthRequest($url, 'GET', $parameters); - if ($this->format === 'json' && $this->decode_json) { - return json_decode($response); - } - return $response; - } + return $token; + } - /** - * POST wrapper for oAuthRequest. - */ - function post($url, $parameters = array()) { - $response = $this->oAuthRequest($url, 'POST', $parameters); - if ($this->format === 'json' && $this->decode_json) { - return json_decode($response); - } - return $response; - } + /** + * GET wrapper for oAuthRequest. + */ + function get($url, $parameters = array()) + { + $response = $this->oAuthRequest($url, 'GET', $parameters); + if ($this->format === 'json' && $this->decode_json) { + return json_decode($response); + } - /** - * DELETE wrapper for oAuthReqeust. - */ - function delete($url, $parameters = array()) { - $response = $this->oAuthRequest($url, 'DELETE', $parameters); - if ($this->format === 'json' && $this->decode_json) { - return json_decode($response); - } - return $response; - } + return $response; + } - /** - * Format and sign an OAuth / API request - */ - function oAuthRequest($url, $method, $parameters) { - if (strrpos($url, 'https://') !== 0 && strrpos($url, 'http://') !== 0) { - $url = "{$this->host}{$url}"; - } - $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) { - case 'GET': - return $this->http($request->to_url(), 'GET'); - default: - return $this->http($request->get_normalized_http_url(), $method, $request->to_postdata()); - } - } + /** + * POST wrapper for oAuthRequest. + */ + function post($url, $parameters = array()) + { + $response = $this->oAuthRequest($url, 'POST', $parameters); + if ($this->format === 'json' && $this->decode_json) { + return json_decode($response); + } - /** - * Make an HTTP request - * - * @return API results - */ - function http($url, $method, $postfields = null) { - $this->http_info = array(); - $ci = curl_init(); - /* Curl settings */ - curl_setopt($ci, CURLOPT_USERAGENT, $this->useragent); - curl_setopt($ci, CURLOPT_CONNECTTIMEOUT, $this->connecttimeout); - curl_setopt($ci, CURLOPT_TIMEOUT, $this->timeout); - curl_setopt($ci, CURLOPT_RETURNTRANSFER, TRUE); - curl_setopt($ci, CURLOPT_HTTPHEADER, array('Expect:')); - curl_setopt($ci, CURLOPT_SSL_VERIFYPEER, $this->ssl_verifypeer); - curl_setopt($ci, CURLOPT_HEADERFUNCTION, array($this, 'getHeader')); - curl_setopt($ci, CURLOPT_HEADER, FALSE); + return $response; + } - switch ($method) { - case 'POST': - curl_setopt($ci, CURLOPT_POST, TRUE); - if (!empty($postfields)) { - curl_setopt($ci, CURLOPT_POSTFIELDS, $postfields); - } - break; - case 'DELETE': - curl_setopt($ci, CURLOPT_CUSTOMREQUEST, 'DELETE'); - if (!empty($postfields)) { - $url = "{$url}?{$postfields}"; - } - } + /** + * DELETE wrapper for oAuthReqeust. + */ + function delete($url, $parameters = array()) + { + $response = $this->oAuthRequest($url, 'DELETE', $parameters); + if ($this->format === 'json' && $this->decode_json) { + return json_decode($response); + } - curl_setopt($ci, CURLOPT_URL, $url); - $response = curl_exec($ci); - $this->http_code = curl_getinfo($ci, CURLINFO_HTTP_CODE); - $this->http_info = array_merge($this->http_info, curl_getinfo($ci)); - $this->url = $url; - curl_close ($ci); - return $response; - } + return $response; + } - /** - * Get the header info to store. - */ - function getHeader($ch, $header) { - $i = strpos($header, ':'); - if (!empty($i)) { - $key = str_replace('-', '_', strtolower(substr($header, 0, $i))); - $value = trim(substr($header, $i + 2)); - $this->http_header[$key] = $value; - } - return strlen($header); - } + /** + * Format and sign an OAuth / API request + */ + function oAuthRequest($url, $method, $parameters) + { + if (strrpos($url, 'https://') !== 0 && strrpos($url, 'http://') !== 0) { + $url = "{$this->host}{$url}"; + } + + $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) { + case 'GET': + return $this->http($request->to_url(), 'GET'); + default: + return $this->http($request->get_normalized_http_url(), $method, $request->to_postdata()); + } + } + + /** + * Make an HTTP request + * + * @return API results + */ + function http($url, $method, $postfields = null) + { + $this->http_info = array(); + $ci = curl_init(); + /* Curl settings */ + curl_setopt($ci, CURLOPT_USERAGENT, $this->useragent); + curl_setopt($ci, CURLOPT_CONNECTTIMEOUT, $this->connecttimeout); + curl_setopt($ci, CURLOPT_TIMEOUT, $this->timeout); + curl_setopt($ci, CURLOPT_RETURNTRANSFER, TRUE); + curl_setopt($ci, CURLOPT_HTTPHEADER, array('Expect:')); + curl_setopt($ci, CURLOPT_SSL_VERIFYPEER, $this->ssl_verifypeer); + curl_setopt($ci, CURLOPT_HEADERFUNCTION, array($this, 'getHeader')); + curl_setopt($ci, CURLOPT_HEADER, FALSE); + + switch ($method) { + case 'POST': + curl_setopt($ci, CURLOPT_POST, TRUE); + if (!empty($postfields)) { + curl_setopt($ci, CURLOPT_POSTFIELDS, $postfields); + } + break; + case 'DELETE': + curl_setopt($ci, CURLOPT_CUSTOMREQUEST, 'DELETE'); + if (!empty($postfields)) { + $url = "{$url}?{$postfields}"; + } + } + + curl_setopt($ci, CURLOPT_URL, $url); + $response = curl_exec($ci); + $this->http_code = curl_getinfo($ci, CURLINFO_HTTP_CODE); + $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. + */ + function getHeader($ch, $header) + { + $i = strpos($header, ':'); + if (!empty($i)) { + $key = str_replace('-', '_', strtolower(substr($header, 0, $i))); + $value = trim(substr($header, $i + 2)); + $this->http_header[$key] = $value; + } + + return strlen($header); + } } From f8e0df1f71b50928d95077eea265ca6a9be90a08 Mon Sep 17 00:00:00 2001 From: Benjamin Lorteau Date: Wed, 11 Dec 2019 13:18:17 -0500 Subject: [PATCH 2/4] [tumblr] Improve phpDoc in library/tumblroauth --- tumblr/library/tumblroauth.php | 105 +++++++++++++++++++++------------ 1 file changed, 66 insertions(+), 39 deletions(-) diff --git a/tumblr/library/tumblroauth.php b/tumblr/library/tumblroauth.php index 895269f2..904855ff 100644 --- a/tumblr/library/tumblroauth.php +++ b/tumblr/library/tumblroauth.php @@ -11,10 +11,6 @@ */ class TumblrOAuth { - /* 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.tumblr.com/v2/"; /* Set timeout default. */ @@ -23,17 +19,34 @@ class TumblrOAuth 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 = 'TumblrOAuth 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 @@ -58,22 +71,6 @@ class TumblrOAuth return 'https://www.tumblr.com/oauth/request_token'; } - /** - * Debug helpers - */ - function lastStatusCode() - { - return $this->http_status; - } - - function lastAPICall() - { - return $this->last_api_call; - } - - /** - * construct TumblrOAuth object - */ function __construct($consumer_key, $consumer_secret, $oauth_token = null, $oauth_token_secret = null) { $this->sha1_method = new OAuthSignatureMethod_HMAC_SHA1(); @@ -85,15 +82,15 @@ class TumblrOAuth } } - /** * Get a request_token from Tumblr * - * @returns a key/value array containing oauth_token and oauth_token_secret + * @param callback $oauth_callback + * @return array */ function getRequestToken($oauth_callback = null) { - $parameters = array(); + $parameters = []; if (!empty($oauth_callback)) { $parameters['oauth_callback'] = $oauth_callback; } @@ -107,7 +104,9 @@ class TumblrOAuth /** * Get the authorize URL * - * @returns a string + * @param array $token + * @param bool $sign_in_with_tumblr + * @return string */ function getAuthorizeURL($token, $sign_in_with_tumblr = TRUE) { @@ -126,14 +125,15 @@ class TumblrOAuth * 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; } @@ -148,7 +148,9 @@ class TumblrOAuth /** * 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", @@ -156,7 +158,7 @@ class TumblrOAuth */ function getXAuthToken($username, $password) { - $parameters = array(); + $parameters = []; $parameters['x_auth_username'] = $username; $parameters['x_auth_password'] = $password; $parameters['x_auth_mode'] = 'client_auth'; @@ -169,8 +171,12 @@ class TumblrOAuth /** * 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) { @@ -182,8 +188,12 @@ class TumblrOAuth /** * 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) { @@ -195,8 +205,12 @@ class TumblrOAuth /** * 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) { @@ -208,6 +222,11 @@ class TumblrOAuth /** * Format and sign an OAuth / API request + * + * @param string $url + * @param string $method + * @param array $parameters + * @return mixed|string */ function oAuthRequest($url, $method, $parameters) { @@ -228,11 +247,15 @@ class TumblrOAuth /** * 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) { - $this->http_info = array(); + $this->http_info = []; $ci = curl_init(); /* Curl settings */ curl_setopt($ci, CURLOPT_USERAGENT, $this->useragent); @@ -270,6 +293,10 @@ class TumblrOAuth /** * Get the header info to store. + * + * @param resource $ch + * @param string $header + * @return int */ function getHeader($ch, $header) { From 9e27e3061ca839e4a0af08fd7447e6a3511113ce Mon Sep 17 00:00:00 2001 From: Benjamin Lorteau Date: Wed, 11 Dec 2019 13:19:32 -0500 Subject: [PATCH 3/4] [tumblr] Use correct object class for Oauth token in library/tumblroauth - Addresses https://github.com/friendica/friendica/issues/7675#issuecomment-564648263 --- tumblr/library/tumblroauth.php | 9 ++++----- 1 file changed, 4 insertions(+), 5 deletions(-) diff --git a/tumblr/library/tumblroauth.php b/tumblr/library/tumblroauth.php index 904855ff..782c6b4b 100644 --- a/tumblr/library/tumblroauth.php +++ b/tumblr/library/tumblroauth.php @@ -76,7 +76,7 @@ class TumblrOAuth $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; } @@ -97,7 +97,7 @@ class TumblrOAuth $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; } @@ -140,7 +140,7 @@ class TumblrOAuth $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; } @@ -164,7 +164,7 @@ class TumblrOAuth $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; } @@ -247,7 +247,6 @@ class TumblrOAuth /** * Make an HTTP request * - * * @param string $url * @param string $method * @param mixed $postfields From a042470051e672674a291dfb6fb343c718ca9473 Mon Sep 17 00:00:00 2001 From: Benjamin Lorteau Date: Wed, 11 Dec 2019 14:46:03 -0500 Subject: [PATCH 4/4] [twitter] Use correct object class for Oauth token in library/tumblroauth - Addresses https://github.com/friendica/friendica/issues/7675#issuecomment-564562386 --- statusnet/library/twitteroauth.php | 132 +++++++++++++++++++---------- 1 file changed, 85 insertions(+), 47 deletions(-) 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); } }