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 +254 -211
1 changed files with 254 additions and 211 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files
Showing only changes of commit 98c47f24ba - Show all commits

465
tumblr/library/tumblroauth.php
View file

@ -9,234 +9,277 @@
/** /**
* Tumblr OAuth class * Tumblr OAuth class
*/ */
class TumblrOAuth { class TumblrOAuth
/* Contains the last HTTP status code returned. */ {
public $http_code; /* Contains the last HTTP status code returned. */
/* Contains the last API call. */ public $http_code;
public $url; /* Contains the last API call. */
/* Set up the API root URL. */ public $url;
public $host = "https://api.tumblr.com/v2/"; /* Set up the API root URL. */
/* Set timeout default. */ public $host = "https://api.tumblr.com/v2/";
public $timeout = 30; /* Set timeout default. */
/* Set connect timeout. */ public $timeout = 30;
public $connecttimeout = 30; /* Set connect timeout. */
/* Verify SSL Cert. */ public $connecttimeout = 30;
public $ssl_verifypeer = FALSE; /* Verify SSL Cert. */
/* Respons format. */ public $ssl_verifypeer = FALSE;
public $format = 'json'; /* Respons format. */
/* Decode returned json data. */ public $format = 'json';
public $decode_json = TRUE; /* Decode returned json data. */
/* Contains the last HTTP headers returned. */ public $decode_json = TRUE;
public $http_info; /* Contains the last HTTP headers returned. */
/* Set the useragnet. */ public $http_info;
public $useragent = 'TumblrOAuth v0.2.0-beta2'; /* Set the useragnet. */
/* Immediately retry the API call if the response was not successful. */ public $useragent = 'TumblrOAuth v0.2.0-beta2';
//public $retry = TRUE; /* 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 * Get a request_token from Tumblr
*/ *
function accessTokenURL() { return 'https://www.tumblr.com/oauth/access_token'; } * @returns a key/value array containing oauth_token and oauth_token_secret
function authenticateURL() { return 'https://www.tumblr.com/oauth/authorize'; } */
function authorizeURL() { return 'https://www.tumblr.com/oauth/authorize'; } function getRequestToken($oauth_callback = null)
function requestTokenURL() { return 'https://www.tumblr.com/oauth/request_token'; } {
$parameters = array();
if (!empty($oauth_callback)) {
$parameters['oauth_callback'] = $oauth_callback;
}
/** $request = $this->oAuthRequest($this->requestTokenURL(), 'GET', $parameters);
* Debug helpers $token = OAuthUtil::parse_parameters($request);
*/ $this->token = new OAuthConsumer($token['oauth_token'], $token['oauth_token_secret']);
function lastStatusCode() { return $this->http_status; } return $token;
function lastAPICall() { return $this->last_api_call; } }
/** /**
* construct TumblrOAuth object * Get the authorize URL
*/ *
function __construct($consumer_key, $consumer_secret, $oauth_token = null, $oauth_token_secret = null) { * @returns a string
$this->sha1_method = new OAuthSignatureMethod_HMAC_SHA1(); */
$this->consumer = new OAuthConsumer($consumer_key, $consumer_secret); function getAuthorizeURL($token, $sign_in_with_tumblr = TRUE)
if (!empty($oauth_token) && !empty($oauth_token_secret)) { {
$this->token = new OAuthConsumer($oauth_token, $oauth_token_secret); if (is_array($token)) {
} else { $token = $token['oauth_token'];
$this->token = null; }
}
}
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 * Exchange request token and secret for an access token and
* * secret, to sign API calls.
* @returns a key/value array containing oauth_token and oauth_token_secret *
*/ * @returns array("oauth_token" => "the-access-token",
function getRequestToken($oauth_callback = null) { * "oauth_token_secret" => "the-access-secret",
$parameters = array(); * "user_id" => "9436992",
if (!empty($oauth_callback)) { * "screen_name" => "abraham")
$parameters['oauth_callback'] = $oauth_callback; */
} function getAccessToken($oauth_verifier = FALSE)
$request = $this->oAuthRequest($this->requestTokenURL(), 'GET', $parameters); {
$token = OAuthUtil::parse_parameters($request); $parameters = array();
$this->token = new OAuthConsumer($token['oauth_token'], $token['oauth_token_secret']); if (!empty($oauth_verifier)) {
return $token; $parameters['oauth_verifier'] = $oauth_verifier;
} }
/** $request = $this->oAuthRequest($this->accessTokenURL(), 'GET', $parameters);
* Get the authorize URL $token = OAuthUtil::parse_parameters($request);
* $this->token = new OAuthConsumer($token['oauth_token'], $token['oauth_token_secret']);
* @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}";
}
}
/** 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;
}
$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;
}
/** /**
* 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", * @returns 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['x_auth_username'] = $username; $parameters = array();
$parameters['x_auth_password'] = $password; $parameters['x_auth_username'] = $username;
$parameters['x_auth_mode'] = 'client_auth'; $parameters['x_auth_password'] = $password;
$request = $this->oAuthRequest($this->accessTokenURL(), 'POST', $parameters); $parameters['x_auth_mode'] = 'client_auth';
$token = OAuthUtil::parse_parameters($request); $request = $this->oAuthRequest($this->accessTokenURL(), 'POST', $parameters);
$this->token = new OAuthConsumer($token['oauth_token'], $token['oauth_token_secret']); $token = OAuthUtil::parse_parameters($request);
return $token; $this->token = new OAuthConsumer($token['oauth_token'], $token['oauth_token_secret']);
}
/** return $token;
* 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;
}
/** /**
* POST wrapper for oAuthRequest. * GET wrapper for oAuthRequest.
*/ */
function post($url, $parameters = array()) { function get($url, $parameters = array())
$response = $this->oAuthRequest($url, 'POST', $parameters); {
if ($this->format === 'json' && $this->decode_json) { $response = $this->oAuthRequest($url, 'GET', $parameters);
return json_decode($response); if ($this->format === 'json' && $this->decode_json) {
} return json_decode($response);
return $response; }
}
/** return $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;
}
/** /**
* Format and sign an OAuth / API request * POST wrapper for oAuthRequest.
*/ */
function oAuthRequest($url, $method, $parameters) { function post($url, $parameters = array())
if (strrpos($url, 'https://') !== 0 && strrpos($url, 'http://') !== 0) { {
$url = "{$this->host}{$url}"; $response = $this->oAuthRequest($url, 'POST', $parameters);
} if ($this->format === 'json' && $this->decode_json) {
$request = OAuthRequest::from_consumer_and_token($this->consumer, $this->token, $method, $url, $parameters); return json_decode($response);
$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());
}
}
/** return $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);
switch ($method) { /**
case 'POST': * DELETE wrapper for oAuthReqeust.
curl_setopt($ci, CURLOPT_POST, TRUE); */
if (!empty($postfields)) { function delete($url, $parameters = array())
curl_setopt($ci, CURLOPT_POSTFIELDS, $postfields); {
} $response = $this->oAuthRequest($url, 'DELETE', $parameters);
break; if ($this->format === 'json' && $this->decode_json) {
case 'DELETE': return json_decode($response);
curl_setopt($ci, CURLOPT_CUSTOMREQUEST, 'DELETE'); }
if (!empty($postfields)) {
$url = "{$url}?{$postfields}";
}
}
curl_setopt($ci, CURLOPT_URL, $url); return $response;
$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. * Format and sign an OAuth / API request
*/ */
function getHeader($ch, $header) { function oAuthRequest($url, $method, $parameters)
$i = strpos($header, ':'); {
if (!empty($i)) { if (strrpos($url, 'https://') !== 0 && strrpos($url, 'http://') !== 0) {
$key = str_replace('-', '_', strtolower(substr($header, 0, $i))); $url = "{$this->host}{$url}";
$value = trim(substr($header, $i + 2)); }
$this->http_header[$key] = $value;
} $request = OAuthRequest::from_consumer_and_token($this->consumer, $this->token, $method, $url, $parameters);
return strlen($header); $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);
}
} }