Skip to content
Snippets Groups Projects
Commit a4817389 authored by Nick Daugherty's avatar Nick Daugherty
Browse files

Merge pull request #7 from MikePearce/master 

Fix for issue #6. Added _buildMultipart() for successful posting of images to twitter
parents d14994d2 bfd4f809
No related branches found
No related tags found
No related merge requests found
Hide whitespace changes
Inline Side-by-side
Showing
with 210 additions and 102 deletions
class-wp-codebird.php
+ 210
− 102
View file @ a4817389
...@@ -4,13 +4,19 @@ ...@@ -4,13 +4,19 @@
* An extension of the Codebird class to use Wordpress' HTTP API instead of * An extension of the Codebird class to use Wordpress' HTTP API instead of
* cURL. * cURL.
* *
* @version 1.1.1 * @version 1.1.2
*/ */
class WP_Codebird extends Codebird { class WP_Codebird extends Codebird {
/** /**
* The current singleton instance * The current singleton instance
*/ */
private static $_instance = null; private static $_instance = null;
/**
* The file formats extensions twitter supports
* @var array
*/
protected $_supported_media_files_extensions = array( 'gif', 'jpg', 'jpeg', 'png' );
/** /**
* Returns singleton class instance * Returns singleton class instance
...@@ -34,7 +40,7 @@ class WP_Codebird extends Codebird { ...@@ -34,7 +40,7 @@ class WP_Codebird extends Codebird {
/** /**
* Overload magic __call() to transparently intercept Exceptions * Overload magic __call() to transparently intercept Exceptions
* *
* Most exceptions encountered in production are API timeouts - this will * Most exceptions encountered in production are API timeouts - this will
* transparently handle these Exceptions to prevent fatal errors * transparently handle these Exceptions to prevent fatal errors
*/ */
public function __call( $function, $arguments ) { public function __call( $function, $arguments ) {
...@@ -49,58 +55,71 @@ class WP_Codebird extends Codebird { ...@@ -49,58 +55,71 @@ class WP_Codebird extends Codebird {
* Calls the API using Wordpress' HTTP API. * Calls the API using Wordpress' HTTP API.
* *
* @since 0.1.0 * @since 0.1.0
* @see Codebird::_callApi * @see Codebird::_callApi
* @param string $httpmethod The HTTP method to use for making the request *
* @param string $method The API method to call * @param string $httpmethod The HTTP method to use for making the request
* @param string $method_template The templated API method to call * @param string $method The API method to call
* @param array optional $params The parameters to send along * @param string $method_template The templated API method to call
* @param bool optional $multipart Whether to use multipart/form-data * @param array optional $params The parameters to send along
* @param bool optional $multipart Whether to use multipart/form-data
* *
* @return mixed The API reply, encoded in the set return_format. * @return mixed The API reply, encoded in the set return_format.
*/ */
protected function _callApi( $httpmethod, $method, $method_template, $params = array(), $multipart = false, $app_only_auth = false ) { protected function _callApi( $httpmethod, $method, $method_template, $params = array(), $multipart = false, $app_only_auth = false ) {
$url = $this->_getEndpoint( $method, $method_template ); $url = $this->_getEndpoint( $method, $method_template );
$url_with_params = null; $url_with_params = null;
$authorization = null; $authorization = null;
$remote_params = array( $remote_params = array(
'method' => $httpmethod, 'method' => $httpmethod,
'timeout' => 5, 'timeout' => 5,
'redirection' => 5, 'redirection' => 5,
'httpversion' => '1.0', 'httpversion' => '1.0',
'blocking' => true, 'blocking' => true,
'headers' => array(), 'headers' => array(),
'body' => null, 'body' => null,
'cookies' => array(), 'cookies' => array(),
'sslverify' => false 'sslverify' => false
); );
if ( 'GET' == $httpmethod ) { if ( 'GET' == $httpmethod ) {
$url_with_params = $url; $url_with_params = $url;
if ( count( $params ) > 0 ) { if ( count( $params ) > 0 ) {
$url_with_params .= '?' . http_build_query( $params ); $url_with_params .= '?' . http_build_query( $params );
} }
$authorization = $this->_sign( $httpmethod, $url, $params ); $authorization = $this->_sign( $httpmethod, $url, $params );
$url = $url_with_params; $url = $url_with_params;
} else { }
$authorization = $this->_sign( $httpmethod, $url, array() ); else {
if ( $multipart ) {
$authorization = $this->_sign( $httpmethod, $url, array() );
$params = $this->_buildMultipart( $method_template, $params );
if ( ! $multipart ) { // Add the boundaries
$authorization = $this->_sign( $httpmethod, $url, $params ); $first_newline = strpos( $params, "\r\n" );
} $multipart_boundary = substr( $params, 2, $first_newline - 2 );
$remote_params['headers']['Content-Length'] = strlen( $params );
$remote_params['headers']['Content-Type'] = 'multipart/form-data; boundary=' . $multipart_boundary;
}
else {
$authorization = $this->_sign( $httpmethod, $url, $params );
$params = http_build_query( $params );
}
$remote_params['body'] = $params; $remote_params['body'] = $params;
} }
if ( $app_only_auth ){ if ( $app_only_auth ) {
if ( null == self::$_oauth_consumer_key ) if ( null == self::$_oauth_consumer_key ) {
throw new Exception( 'To make an app-only auth API request, the consumer key must be set' ); throw new Exception( 'To make an app-only auth API request, the consumer key must be set' );
}
// automatically fetch bearer token, if necessary // automatically fetch bearer token, if necessary
if ( null == self::$_oauth_bearer_token ) if ( null == self::$_oauth_bearer_token ) {
$this->oauth2_token(); $this->oauth2_token();
}
$authorization = 'Authorization: Bearer ' . self::$_oauth_bearer_token; $authorization = 'Authorization: Bearer ' . self::$_oauth_bearer_token;
} }
...@@ -109,98 +128,106 @@ class WP_Codebird extends Codebird { ...@@ -109,98 +128,106 @@ class WP_Codebird extends Codebird {
$authorization = trim( str_replace( 'Authorization:', '', $authorization ) ); $authorization = trim( str_replace( 'Authorization:', '', $authorization ) );
if ( $authorization ) { if ( $authorization ) {
$remote_params['headers']['Authorization'] = $authorization; $remote_params['headers']['Authorization'] = $authorization;
$remote_params['headers']['Expect'] = ''; $remote_params['headers']['Expect'] = '';
} }
if ( 'GET' == $httpmethod ) { if ( 'GET' == $httpmethod ) {
$reply = wp_remote_get( $url, $remote_params ); $reply = wp_remote_get( $url, $remote_params );
} else { }
else {
$reply = wp_remote_post( $url, $remote_params ); $reply = wp_remote_post( $url, $remote_params );
} }
if ( isset( $reply ) ) { if ( isset( $reply ) ) {
if ( is_wp_error( $reply ) ) { if ( is_wp_error( $reply ) ) {
throw new Exception( $reply->get_error_message() ); throw new Exception( $reply->get_error_message() );
} else { }
$httpstatus = $reply[ 'response' ][ 'code' ]; else {
$reply = $this->_parseApiReply( $method_template, $reply ); $httpstatus = $reply['response']['code'];
$reply = $this->_parseApiReply( $method_template, $reply );
if ( $this->_return_format == CODEBIRD_RETURNFORMAT_OBJECT ) { if ( $this->_return_format == CODEBIRD_RETURNFORMAT_OBJECT ) {
$reply->httpstatus = $httpstatus; $reply->httpstatus = $httpstatus;
} else { }
$reply[ 'httpstatus' ] = $httpstatus; else {
$reply['httpstatus'] = $httpstatus;
} }
} }
} else { }
else {
throw new Exception( 'A reply was never generated. Some has gone horribly awry.' ); throw new Exception( 'A reply was never generated. Some has gone horribly awry.' );
} }
return $reply; return $reply;
} }
/** /**
* Gets the OAuth bearer token * Gets the OAuth bearer token
* *
* Overridden to use the WordPress HTTP API * Overridden to use the WordPress HTTP API
* *
* @return string The OAuth bearer token * @return string The OAuth bearer token
*/ */
public function oauth2_token() { public function oauth2_token() {
if ( null == self::$_oauth_consumer_key ) { if ( null == self::$_oauth_consumer_key ) {
throw new Exception('To obtain a bearer token, the consumer key must be set.'); throw new Exception( 'To obtain a bearer token, the consumer key must be set.' );
} }
$post_fields = array( $post_fields = array(
'grant_type' => 'client_credentials' 'grant_type' => 'client_credentials'
);
$url = self::$_endpoint_oauth . 'oauth2/token';
$headers = array(
'Authorization' => 'Basic ' . base64_encode( self::$_oauth_consumer_key . ':' . self::$_oauth_consumer_secret ),
'Expect' => ''
);
$remote_params = array(
'method' => 'POST',
'timeout' => 5,
'redirection' => 5,
'httpversion' => '1.0',
'blocking' => true,
'headers' => $headers,
'body' => $post_fields,
'cookies' => array(),
'sslverify' => false
); );
$reply = wp_remote_post( $url, $remote_params ); $url = self::$_endpoint_oauth . 'oauth2/token';
$httpstatus = wp_remote_retrieve_response_code( $reply ); $headers = array(
'Authorization' => 'Basic ' . base64_encode( self::$_oauth_consumer_key . ':' . self::$_oauth_consumer_secret ),
'Expect' => ''
);
$reply = $this->_parseApiReply( 'oauth2/token', $reply ); $remote_params = array(
'method' => 'POST',
'timeout' => 5,
'redirection' => 5,
'httpversion' => '1.0',
'blocking' => true,
'headers' => $headers,
'body' => $post_fields,
'cookies' => array(),
'sslverify' => false
);
if ( CODEBIRD_RETURNFORMAT_OBJECT == $this->_return_format ) { $reply = wp_remote_post( $url, $remote_params );
$reply->httpstatus = $httpstatus;
if ( 200 == $httpstatus ) $httpstatus = wp_remote_retrieve_response_code( $reply );
self::setBearerToken( $reply->access_token );
} else {
$reply['httpstatus'] = $httpstatus;
if ( 200 == $httpstatus ) $reply = $this->_parseApiReply( 'oauth2/token', $reply );
self::setBearerToken( $reply['access_token'] );
}
return $reply; if ( CODEBIRD_RETURNFORMAT_OBJECT == $this->_return_format ) {
} $reply->httpstatus = $httpstatus;
if ( 200 == $httpstatus ) {
self::setBearerToken( $reply->access_token );
}
}
else {
$reply['httpstatus'] = $httpstatus;
if ( 200 == $httpstatus ) {
self::setBearerToken( $reply['access_token'] );
}
}
return $reply;
}
/** /**
* Parses the API reply to encode it in the set return_format. * Parses the API reply to encode it in the set return_format.
* *
* @since 0.1.0 * @since 0.1.0
* @see Codebird::_parseApiReply * @see Codebird::_parseApiReply
*
* @param string $method The method that has been called * @param string $method The method that has been called
* @param string $reply The actual reply, JSON-encoded or URL-encoded * @param string $reply The actual reply, JSON-encoded or URL-encoded
* *
...@@ -209,11 +236,11 @@ class WP_Codebird extends Codebird { ...@@ -209,11 +236,11 @@ class WP_Codebird extends Codebird {
protected function _parseApiReply( $method, $reply ) { protected function _parseApiReply( $method, $reply ) {
// split headers and body // split headers and body
$http_response = $reply; $http_response = $reply;
$headers = $http_response[ 'headers' ]; $headers = $http_response['headers'];
$reply = ''; $reply = '';
if ( isset( $http_response[ 'body' ] ) ) { if ( isset( $http_response['body'] ) ) {
$reply = $http_response[ 'body' ]; $reply = $http_response['body'];
} }
$need_array = $this->_return_format == CODEBIRD_RETURNFORMAT_ARRAY; $need_array = $this->_return_format == CODEBIRD_RETURNFORMAT_ARRAY;
...@@ -224,25 +251,106 @@ class WP_Codebird extends Codebird { ...@@ -224,25 +251,106 @@ class WP_Codebird extends Codebird {
$parsed = array(); $parsed = array();
if ( $method == 'users/profile_image/:screen_name' ) { if ( $method == 'users/profile_image/:screen_name' ) {
// this method returns a 302 redirect, we need to extract the URL // this method returns a 302 redirect, we need to extract the URL
if ( isset( $headers[ 'Location' ] ) ) { if ( isset( $headers['Location'] ) ) {
$parsed = array( 'profile_image_url_https' => $headers[ 'Location' ] ); $parsed = array( 'profile_image_url_https' => $headers['Location'] );
} }
} elseif ( !$parsed = json_decode( $reply, $need_array ) ) { }
elseif ( ! $parsed = json_decode( $reply, $need_array ) ) {
if ( $reply ) { if ( $reply ) {
$reply = explode( '&', $reply ); $reply = explode( '&', $reply );
foreach ( $reply as $element ) { foreach ( $reply as $element ) {
if ( stristr( $element, '=' ) ) { if ( stristr( $element, '=' ) ) {
list( $key, $value ) = explode( '=', $element ); list( $key, $value ) = explode( '=', $element );
$parsed[ $key ] = $value; $parsed[$key] = $value;
} else { }
$parsed[ 'message' ] = $element; else {
$parsed['message'] = $element;
} }
} }
} }
} }
if ( !$need_array ) { if ( ! $need_array ) {
$parsed = ( object ) $parsed; $parsed = ( object ) $parsed;
} }
return $parsed; return $parsed;
} }
/**
* Detect filenames in upload parameters,
* build multipart request from upload params
*
* @param string $method The API method to call
* @param array $params The parameters to send along
*
* @return void
*/
protected function _buildMultipart( $method, $params ) {
// well, files will only work in multipart methods
if ( ! $this->_detectMultipart( $method ) ) {
return;
}
// only check specific parameters
$possible_files = array(
// Tweets
'statuses/update_with_media' => 'media[]',
// Accounts
'account/update_profile_background_image' => 'image',
'account/update_profile_image' => 'image',
'account/update_profile_banner' => 'banner'
);
// method might have files?
if ( ! in_array( $method, array_keys( $possible_files ) ) ) {
return;
}
$possible_files = explode( ' ', $possible_files[$method] );
$multipart_border = '--------------------' . $this->_nonce();
$multipart_request = '';
foreach ( $params as $key => $value ) {
// is it an array?
if ( is_array( $value ) ) {
_doing_it_wrong(
'_buildMultiPart()',
'Using URL-encoded parameters is not supported for uploading media.',
'3.7.1'
);
continue;
}
$multipart_request .=
'--' . $multipart_border . "\r\n"
. 'Content-Disposition: form-data; name="' . $key . '"';
// check for filenames
if ( in_array( $key, $possible_files ) ) {
if (
in_array( strtolower( end( explode( ".", $value ) ) ), $this->_supported_media_files_extensions )
&& file_exists( $value )
&& is_readable( $value )
&& $data = getimagesize( $value )
) {
if ( // is it a supported image format?
in_array( $data[2], $this->_supported_media_files )
) {
// try to read the file
$data = file_get_contents( $value );
if ( strlen( $data ) == 0 ) {
continue;
}
$value = $data;
}
}
}
$multipart_request .=
"\r\n\r\n" . $value . "\r\n";
}
$multipart_request .= '--' . $multipart_border . '--';
return $multipart_request;
}
} }
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment