Move Tumblr addon dependencies to library subfolder

- Move OAuth1 to library/OAuth1.php
- Move TumblOAuth to library/tumblroauth.php
This commit is contained in:
Hypolite Petovan 2018-01-28 14:43:56 -05:00
parent 7afef6b87f
commit 715edd98e2
3 changed files with 1120 additions and 1121 deletions

File diff suppressed because it is too large Load diff

View file

@ -1,245 +1,245 @@
<?php <?php
/* /*
* Abraham Williams (abraham@abrah.am) http://abrah.am * Abraham Williams (abraham@abrah.am) http://abrah.am
* *
* The first PHP Library to support OAuth for Tumblr's REST API. (Originally for Twitter, modified for Tumblr by Lucas) * The first PHP Library to support OAuth for Tumblr's REST API. (Originally for Twitter, modified for Tumblr by Lucas)
*/ */
/* Load OAuth lib. You can find it at http://oauth.net */ /* Load OAuth lib. You can find it at http://oauth.net */
//require_once('OAuth.php'); require_once __DIR__ . DIRECTORY_SEPARATOR . 'OAuth1.php';
/** /**
* Tumblr OAuth class * Tumblr OAuth class
*/ */
class TumblrOAuth { class TumblrOAuth {
/* Contains the last HTTP status code returned. */ /* Contains the last HTTP status code returned. */
public $http_code; public $http_code;
/* Contains the last API call. */ /* Contains the last API call. */
public $url; public $url;
/* Set up the API root URL. */ /* Set up the API root URL. */
public $host = "http://api.tumblr.com/v2/"; public $host = "http://api.tumblr.com/v2/";
/* Set timeout default. */ /* Set timeout default. */
public $timeout = 30; public $timeout = 30;
/* Set connect timeout. */ /* Set connect timeout. */
public $connecttimeout = 30; public $connecttimeout = 30;
/* Verify SSL Cert. */ /* Verify SSL Cert. */
public $ssl_verifypeer = FALSE; public $ssl_verifypeer = FALSE;
/* Respons format. */ /* Respons 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. */ /* Contains the last HTTP headers returned. */
public $http_info; public $http_info;
/* Set the useragnet. */ /* 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. */ /* Immediately retry the API call if the response was not successful. */
//public $retry = TRUE; //public $retry = TRUE;
/** /**
* Set API URLS * Set API URLS
*/ */
function accessTokenURL() { return 'http://www.tumblr.com/oauth/access_token'; } function accessTokenURL() { return 'http://www.tumblr.com/oauth/access_token'; }
function authenticateURL() { return 'http://www.tumblr.com/oauth/authorize'; } function authenticateURL() { return 'http://www.tumblr.com/oauth/authorize'; }
function authorizeURL() { return 'http://www.tumblr.com/oauth/authorize'; } function authorizeURL() { return 'http://www.tumblr.com/oauth/authorize'; }
function requestTokenURL() { return 'http://www.tumblr.com/oauth/request_token'; } function requestTokenURL() { return 'http://www.tumblr.com/oauth/request_token'; }
/** /**
* Debug helpers * Debug helpers
*/ */
function lastStatusCode() { return $this->http_status; } function lastStatusCode() { return $this->http_status; }
function lastAPICall() { return $this->last_api_call; } function lastAPICall() { return $this->last_api_call; }
/** /**
* construct TumblrOAuth object * construct TumblrOAuth 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->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 OAuthConsumer($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 * @returns a key/value array containing oauth_token and oauth_token_secret
*/ */
function getRequestToken($oauth_callback = NULL) { function getRequestToken($oauth_callback = NULL) {
$parameters = array(); $parameters = array();
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 OAuthConsumer($token['oauth_token'], $token['oauth_token_secret']);
return $token; return $token;
} }
/** /**
* Get the authorize URL * Get the authorize URL
* *
* @returns a string * @returns a 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 {
return $this->authenticateURL() . "?oauth_token={$token}"; return $this->authenticateURL() . "?oauth_token={$token}";
} }
} }
/** /**
* 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", * @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")
*/ */
function getAccessToken($oauth_verifier = FALSE) { function getAccessToken($oauth_verifier = FALSE) {
$parameters = array(); $parameters = array();
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 OAuthConsumer($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", * @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 = array();
$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 OAuthConsumer($token['oauth_token'], $token['oauth_token_secret']);
return $token; return $token;
} }
/** /**
* GET wrapper for oAuthRequest. * GET wrapper for oAuthRequest.
*/ */
function get($url, $parameters = array()) { function get($url, $parameters = array()) {
$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.
*/ */
function post($url, $parameters = array()) { function post($url, $parameters = array()) {
$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.
*/ */
function delete($url, $parameters = array()) { function delete($url, $parameters = array()) {
$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
*/ */
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) {
case 'GET': case 'GET':
return $this->http($request->to_url(), 'GET'); return $this->http($request->to_url(), 'GET');
default: default:
return $this->http($request->get_normalized_http_url(), $method, $request->to_postdata()); return $this->http($request->get_normalized_http_url(), $method, $request->to_postdata());
} }
} }
/** /**
* Make an HTTP request * Make an HTTP request
* *
* @return API results * @return API results
*/ */
function http($url, $method, $postfields = NULL) { function http($url, $method, $postfields = NULL) {
$this->http_info = array(); $this->http_info = array();
$ci = curl_init(); $ci = curl_init();
/* Curl settings */ /* Curl settings */
curl_setopt($ci, CURLOPT_USERAGENT, $this->useragent); curl_setopt($ci, CURLOPT_USERAGENT, $this->useragent);
curl_setopt($ci, CURLOPT_CONNECTTIMEOUT, $this->connecttimeout); curl_setopt($ci, CURLOPT_CONNECTTIMEOUT, $this->connecttimeout);
curl_setopt($ci, CURLOPT_TIMEOUT, $this->timeout); curl_setopt($ci, CURLOPT_TIMEOUT, $this->timeout);
curl_setopt($ci, CURLOPT_RETURNTRANSFER, TRUE); curl_setopt($ci, CURLOPT_RETURNTRANSFER, TRUE);
curl_setopt($ci, CURLOPT_HTTPHEADER, array('Expect:')); curl_setopt($ci, CURLOPT_HTTPHEADER, array('Expect:'));
curl_setopt($ci, CURLOPT_SSL_VERIFYPEER, $this->ssl_verifypeer); curl_setopt($ci, CURLOPT_SSL_VERIFYPEER, $this->ssl_verifypeer);
curl_setopt($ci, CURLOPT_HEADERFUNCTION, array($this, 'getHeader')); curl_setopt($ci, CURLOPT_HEADERFUNCTION, array($this, 'getHeader'));
curl_setopt($ci, CURLOPT_HEADER, FALSE); curl_setopt($ci, CURLOPT_HEADER, FALSE);
switch ($method) { switch ($method) {
case 'POST': case 'POST':
curl_setopt($ci, CURLOPT_POST, TRUE); curl_setopt($ci, CURLOPT_POST, TRUE);
if (!empty($postfields)) { if (!empty($postfields)) {
curl_setopt($ci, CURLOPT_POSTFIELDS, $postfields); curl_setopt($ci, CURLOPT_POSTFIELDS, $postfields);
} }
break; break;
case 'DELETE': case 'DELETE':
curl_setopt($ci, CURLOPT_CUSTOMREQUEST, 'DELETE'); curl_setopt($ci, CURLOPT_CUSTOMREQUEST, 'DELETE');
if (!empty($postfields)) { if (!empty($postfields)) {
$url = "{$url}?{$postfields}"; $url = "{$url}?{$postfields}";
} }
} }
curl_setopt($ci, CURLOPT_URL, $url); curl_setopt($ci, CURLOPT_URL, $url);
$response = curl_exec($ci); $response = curl_exec($ci);
$this->http_code = curl_getinfo($ci, CURLINFO_HTTP_CODE); $this->http_code = curl_getinfo($ci, CURLINFO_HTTP_CODE);
$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.
*/ */
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);
} }
} }

View file

@ -7,8 +7,7 @@
* Author: Michael Vogel <https://pirati.ca/profile/heluecht> * Author: Michael Vogel <https://pirati.ca/profile/heluecht>
*/ */
require_once 'library/OAuth1.php'; require_once __DIR__ . DIRECTORY_SEPARATOR . 'library' . DIRECTORY_SEPARATOR . 'tumblroauth.php';
require_once 'addon/tumblr/tumblroauth/tumblroauth.php';
use Friendica\Content\Text\BBCode; use Friendica\Content\Text\BBCode;
use Friendica\Core\Addon; use Friendica\Core\Addon;