friendica/friendica-addons
7
2
Fork 14
Code Issues 3 Pull requests 3 Releases 16 Wiki Activity

[various] Use correct object class for Oauth token #919

Merged
MrPetovan merged 4 commits from bug/tumblr-oauth into 2019.12-rc 2019-12-11 23:13:17 +01:00
Conversation 3 Commits 4 Files changed 2 +365 -258
2 changed files with 365 additions and 258 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

132
statusnet/library/twitteroauth.php
View file

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

167
tumblr/library/tumblroauth.php
View file

@ -9,11 +9,8 @@
/** /**
* Tumblr OAuth class * Tumblr OAuth class
*/ */
class TumblrOAuth { 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. */ /* Set up the API root URL. */
public $host = "https://api.tumblr.com/v2/"; public $host = "https://api.tumblr.com/v2/";
/* Set timeout default. */ /* Set timeout default. */
@ -22,73 +19,101 @@ class TumblrOAuth {
public $connecttimeout = 30; public $connecttimeout = 30;
/* Verify SSL Cert. */ /* Verify SSL Cert. */
public $ssl_verifypeer = FALSE; public $ssl_verifypeer = FALSE;
/* Respons format. */ /* Response format. */
public $format = 'json'; public $format = 'json';
/* Decode returned json data. */ /* Decode returned json data. */
public $decode_json = TRUE; public $decode_json = TRUE;
/* Contains the last HTTP headers returned. */ /* Set the useragent. */
public $http_info;
/* Set the useragnet. */
public $useragent = 'TumblrOAuth v0.2.0-beta2'; 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 * Set API URLS
*/ */
function accessTokenURL() { return 'https://www.tumblr.com/oauth/access_token'; } function accessTokenURL()
function authenticateURL() { return 'https://www.tumblr.com/oauth/authorize'; } {
function authorizeURL() { return 'https://www.tumblr.com/oauth/authorize'; } return 'https://www.tumblr.com/oauth/access_token';
function requestTokenURL() { return 'https://www.tumblr.com/oauth/request_token'; } }
/** function authenticateURL()
* Debug helpers {
*/ return 'https://www.tumblr.com/oauth/authorize';
function lastStatusCode() { return $this->http_status; } }
function lastAPICall() { return $this->last_api_call; }
/** function authorizeURL()
* construct TumblrOAuth object {
*/ return 'https://www.tumblr.com/oauth/authorize';
function __construct($consumer_key, $consumer_secret, $oauth_token = null, $oauth_token_secret = null) { }
function requestTokenURL()
{
return 'https://www.tumblr.com/oauth/request_token';
}
function __construct($consumer_key, $consumer_secret, $oauth_token = null, $oauth_token_secret = null)
{
$this->sha1_method = new OAuthSignatureMethod_HMAC_SHA1(); $this->sha1_method = new OAuthSignatureMethod_HMAC_SHA1();
$this->consumer = new OAuthConsumer($consumer_key, $consumer_secret); $this->consumer = new OAuthConsumer($consumer_key, $consumer_secret);
if (!empty($oauth_token) && !empty($oauth_token_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 { } else {
$this->token = null; $this->token = null;
} }
} }
/** /**
* Get a request_token from Tumblr * 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) { function getRequestToken($oauth_callback = null)
$parameters = array(); {
$parameters = [];
if (!empty($oauth_callback)) { if (!empty($oauth_callback)) {
$parameters['oauth_callback'] = $oauth_callback; $parameters['oauth_callback'] = $oauth_callback;
} }
$request = $this->oAuthRequest($this->requestTokenURL(), 'GET', $parameters); $request = $this->oAuthRequest($this->requestTokenURL(), 'GET', $parameters);
$token = OAuthUtil::parse_parameters($request); $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; return $token;
} }
/** /**
* Get the authorize URL * 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) { function getAuthorizeURL($token, $sign_in_with_tumblr = TRUE)
{
if (is_array($token)) { if (is_array($token)) {
$token = $token['oauth_token']; $token = $token['oauth_token'];
} }
if (empty($sign_in_with_tumblr)) { if (empty($sign_in_with_tumblr)) {
return $this->authorizeURL() . "?oauth_token={$token}"; return $this->authorizeURL() . "?oauth_token={$token}";
} else { } else {
@ -100,82 +125,115 @@ class TumblrOAuth {
* Exchange request token and secret for an access token and * Exchange request token and secret for an access token and
* secret, to sign API calls. * 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", * "oauth_token_secret" => "the-access-secret",
* "user_id" => "9436992", * "user_id" => "9436992",
* "screen_name" => "abraham") * "screen_name" => "abraham")
*/ */
function getAccessToken($oauth_verifier = FALSE) { function getAccessToken($oauth_verifier = FALSE)
$parameters = array(); {
$parameters = [];
if (!empty($oauth_verifier)) { if (!empty($oauth_verifier)) {
$parameters['oauth_verifier'] = $oauth_verifier; $parameters['oauth_verifier'] = $oauth_verifier;
} }
$request = $this->oAuthRequest($this->accessTokenURL(), 'GET', $parameters); $request = $this->oAuthRequest($this->accessTokenURL(), 'GET', $parameters);
$token = OAuthUtil::parse_parameters($request); $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; return $token;
} }
/** /**
* One time exchange of username and password for access token and secret. * 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", * "oauth_token_secret" => "the-access-secret",
* "user_id" => "9436992", * "user_id" => "9436992",
* "screen_name" => "abraham", * "screen_name" => "abraham",
* "x_auth_expires" => "0") * "x_auth_expires" => "0")
*/ */
function getXAuthToken($username, $password) { function getXAuthToken($username, $password)
$parameters = array(); {
$parameters = [];
$parameters['x_auth_username'] = $username; $parameters['x_auth_username'] = $username;
$parameters['x_auth_password'] = $password; $parameters['x_auth_password'] = $password;
$parameters['x_auth_mode'] = 'client_auth'; $parameters['x_auth_mode'] = 'client_auth';
$request = $this->oAuthRequest($this->accessTokenURL(), 'POST', $parameters); $request = $this->oAuthRequest($this->accessTokenURL(), 'POST', $parameters);
$token = OAuthUtil::parse_parameters($request); $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; return $token;
} }
/** /**
* GET wrapper for oAuthRequest. * 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); $response = $this->oAuthRequest($url, 'GET', $parameters);
if ($this->format === 'json' && $this->decode_json) { if ($this->format === 'json' && $this->decode_json) {
return json_decode($response); return json_decode($response);
} }
return $response; return $response;
} }
/** /**
* POST wrapper for oAuthRequest. * 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); $response = $this->oAuthRequest($url, 'POST', $parameters);
if ($this->format === 'json' && $this->decode_json) { if ($this->format === 'json' && $this->decode_json) {
return json_decode($response); return json_decode($response);
} }
return $response; return $response;
} }
/** /**
* DELETE wrapper for oAuthReqeust. * 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); $response = $this->oAuthRequest($url, 'DELETE', $parameters);
if ($this->format === 'json' && $this->decode_json) { if ($this->format === 'json' && $this->decode_json) {
return json_decode($response); return json_decode($response);
} }
return $response; return $response;
} }
/** /**
* Format and sign an OAuth / API request * Format and sign an OAuth / API request
*
* @param string $url
* @param string $method
* @param array $parameters
* @return mixed|string
*/ */
function oAuthRequest($url, $method, $parameters) { function oAuthRequest($url, $method, $parameters)
{
if (strrpos($url, 'https://') !== 0 && strrpos($url, 'http://') !== 0) { if (strrpos($url, 'https://') !== 0 && strrpos($url, 'http://') !== 0) {
$url = "{$this->host}{$url}"; $url = "{$this->host}{$url}";
} }
$request = OAuthRequest::from_consumer_and_token($this->consumer, $this->token, $method, $url, $parameters); $request = OAuthRequest::from_consumer_and_token($this->consumer, $this->token, $method, $url, $parameters);
$request->sign_request($this->sha1_method, $this->consumer, $this->token); $request->sign_request($this->sha1_method, $this->consumer, $this->token);
switch ($method) { switch ($method) {
@ -189,10 +247,14 @@ class TumblrOAuth {
/** /**
* Make an HTTP request * 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(); $ci = curl_init();
/* Curl settings */ /* Curl settings */
curl_setopt($ci, CURLOPT_USERAGENT, $this->useragent); curl_setopt($ci, CURLOPT_USERAGENT, $this->useragent);
@ -224,19 +286,26 @@ class TumblrOAuth {
$this->http_info = array_merge($this->http_info, curl_getinfo($ci)); $this->http_info = array_merge($this->http_info, curl_getinfo($ci));
$this->url = $url; $this->url = $url;
curl_close($ci); curl_close($ci);
return $response; return $response;
} }
/** /**
* Get the header info to store. * Get the header info to store.
*
* @param resource $ch
* @param string $header
* @return int
*/ */
function getHeader($ch, $header) { function getHeader($ch, $header)
{
$i = strpos($header, ':'); $i = strpos($header, ':');
if (!empty($i)) { if (!empty($i)) {
$key = str_replace('-', '_', strtolower(substr($header, 0, $i))); $key = str_replace('-', '_', strtolower(substr($header, 0, $i)));
$value = trim(substr($header, $i + 2)); $value = trim(substr($header, $i + 2));
$this->http_header[$key] = $value; $this->http_header[$key] = $value;
} }
return strlen($header); return strlen($header);
} }
} }