Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Various cleanups and fixes #8

Open
wants to merge 6 commits into
base: master
Choose a base branch
from
Open

Various cleanups and fixes #8

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
7d7c1c9
Fixed incorrect/inconsistent phpdoc.
Jan 12, 2013
adf5ba7
Added developer hint if they don't realise that call parameters are m…
Jan 12, 2013
6843ac5
Vimeo API docs talk of booleans, but those result in hash signature e…
Jan 12, 2013
11746f6
Put more meaningful API error message into the PHP thrown errors
Jan 12, 2013
27d9731
Fix broken chunked upload handling, and add proper Exception support …
Jan 12, 2013
a9d2ee6
Fix sloppy implicit type conversions, declare code more carefully
Jan 12, 2013
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
77 changes: 52 additions & 25 deletions vimeo.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@ public function __construct($consumer_key, $consumer_secret, $token = null, $tok
*
* @param array $params The parameters for the response.
* @param string $response The serialized response data.
* @return boolean Success status, or NULL if cache not enabled.
*/
private function _cache($params, $response)
{
Expand Down Expand Up @@ -70,7 +71,7 @@ private function _generateAuthHeader($oauth_params)
/**
* Generate a nonce for the call.
*
* @return string The nonce
* @return string The nonce.
*/
private function _generateNonce()
{
Expand Down Expand Up @@ -115,6 +116,7 @@ private function _generateSignature($params, $request_method = 'GET', $url = sel
* Get the unserialized contents of the cached request.
*
* @param array $params The full list of api parameters for the request.
* @return object Cached request response, or NULL if not cached.
*/
private function _getCached($params)
{
Expand Down Expand Up @@ -142,7 +144,7 @@ private function _getCached($params)
* @param string $url The base URL to use.
* @param boolean $cache Whether or not to cache the response.
* @param boolean $use_auth_header Use the OAuth Authorization header to pass the OAuth params.
* @return string The response from the method call.
* @return object The response from the method call, or false on error.
*/
private function _request($method, $call_params = array(), $request_method = 'GET', $url = self::API_REST_URL, $cache = true, $use_auth_header = true)
{
Expand All @@ -168,10 +170,14 @@ private function _request($method, $call_params = array(), $request_method = 'GE

// Merge args
foreach ($call_params as $k => $v) {
if (!is_string($k)) {
throw new VimeoAPIException('API parameters require key names', 0);
}

if (strpos($k, 'oauth_') === 0) {
$oauth_params[$k] = $v;
}
else if ($call_params[$k] !== null) {
else if ($v !== null) {
$api_params[$k] = $v;
}
}
Expand All @@ -183,7 +189,7 @@ private function _request($method, $call_params = array(), $request_method = 'GE
$all_params = array_merge($oauth_params, $api_params);

// Returned cached value
if ($this->_cache_enabled && ($cache && $response = $this->_getCached($all_params))) {
if ($this->_cache_enabled && ($cache && ($response = $this->_getCached($all_params)) !== NULL)) {
return $response;
}

Expand Down Expand Up @@ -231,12 +237,17 @@ private function _request($method, $call_params = array(), $request_method = 'GE

// Return
if (!empty($method)) {
if ($response===false) {
throw new VimeoAPIException('API call returned false;', 0);
}

$response = unserialize($response);

if ($response->stat == 'ok') {
return $response;
}
else if ($response->err) {
throw new VimeoAPIException($response->err->msg, $response->err->code);
else if (isset($response->err)) {
throw new VimeoAPIException($response->err->expl, intval($response->err->code));
}

return false;
Expand All @@ -250,6 +261,7 @@ private function _request($method, $call_params = array(), $request_method = 'GE
* http://www.vimeo.com/api/docs/oauth
*
* @param string $perms The level of permissions to request: read, write, or delete.
* @param string $callback_url The callback URL.
*/
public function auth($permission = 'read', $callback_url = 'oob')
{
Expand All @@ -267,7 +279,7 @@ public function auth($permission = 'read', $callback_url = 'oob')
* @param string $request_method The HTTP request method to use.
* @param string $url The base URL to use.
* @param boolean $cache Whether or not to cache the response.
* @return array The response from the API method
* @return object The response from the API method, or false on error.
*/
public function call($method, $params = array(), $request_method = 'GET', $url = self::API_REST_URL, $cache = true)
{
Expand Down Expand Up @@ -303,10 +315,12 @@ public function enableCache($type, $path, $expire = 600)
* request token before calling this function.
*
* @param string $verifier The OAuth verifier returned from the authorization page or the user.
* @return array An array with the token and token secret.
*/
public function getAccessToken($verifier)
{
$access_token = $this->_request(null, array('oauth_verifier' => $verifier), 'GET', self::API_ACCESS_TOKEN_URL, false, true);
$parsed = array();
parse_str($access_token, $parsed);
return $parsed;
}
Expand All @@ -316,7 +330,6 @@ public function getAccessToken($verifier)
*
* @param string $token The request token.
* @param string $permission The level of permissions to request: read, write, or delete.
* @param string $callback_url The URL to redirect the user back to, or oob for the default.
* @return string The Authorization URL.
*/
public function getAuthorizeUrl($token, $permission = 'read')
Expand All @@ -326,6 +339,9 @@ public function getAuthorizeUrl($token, $permission = 'read')

/**
* Get a request token.
*
* @param string $callback_url The callback URL.
* @return array The request token.
*/
public function getRequestToken($callback_url = 'oob')
{
Expand All @@ -338,6 +354,7 @@ public function getRequestToken($callback_url = 'oob')
false
);

$parsed = array();
parse_str($request_token, $parsed);
return $parsed;
}
Expand All @@ -355,11 +372,11 @@ public function getToken()
/**
* Set the OAuth token.
*
* @param string $token The OAuth token
* @param string $token_secret The OAuth token secret
* @param string $type The type of token, either request or access
* @param boolean $session_store Store the token in a session variable
* @return boolean true
* @param string $token The OAuth token.
* @param string $token_secret The OAuth token secret.
* @param string $type The type of token, either request or access.
* @param boolean $session_store Store the token in a session variable.
* @return boolean true.
*/
public function setToken($token, $token_secret, $type = 'access', $session_store = false)
{
Expand All @@ -377,11 +394,12 @@ public function setToken($token, $token_secret, $type = 'access', $session_store
/**
* Upload a video in one piece.
*
* @param string $file_path The full path to the file
* @param boolean $use_multiple_chunks Whether or not to split the file up into smaller chunks
* @param string $chunk_temp_dir The directory to store the chunks in
* @param int $size The size of each chunk in bytes (defaults to 2MB)
* @return int The video ID
* @param string $file_path The full path to the file.
* @param boolean $use_multiple_chunks Whether or not to split the file up into smaller chunks.
* @param string $chunk_temp_dir The directory to store the chunks in.
* @param int $size The size of each chunk in bytes (defaults to 2MB).
* @param int $replace_id The ID of the video to replace, or NULL if not replacing a video.
* @return int The video ID.
*/
public function upload($file_path, $use_multiple_chunks = false, $chunk_temp_dir = '.', $size = 2097152, $replace_id = null)
{
Expand All @@ -396,7 +414,7 @@ public function upload($file_path, $use_multiple_chunks = false, $chunk_temp_dir

// Make sure we have enough room left in the user's quota
$quota = $this->call('vimeo.videos.upload.getQuota');
if ($quota->user->upload_space->free < $file_size) {
if (intval($quota->user->upload_space->free) < $file_size) {
throw new VimeoAPIException('The file is larger than the user\'s remaining quota.', 707);
}

Expand All @@ -412,7 +430,7 @@ public function upload($file_path, $use_multiple_chunks = false, $chunk_temp_dir
$endpoint = $rsp->ticket->endpoint;

// Make sure we're allowed to upload this size file
if ($file_size > $rsp->ticket->max_file_size) {
if ($file_size > intval($rsp->ticket->max_file_size)) {
throw new VimeoAPIException('File exceeds maximum allowed size.', 710);
}

Expand Down Expand Up @@ -478,11 +496,11 @@ public function upload($file_path, $use_multiple_chunks = false, $chunk_temp_dir

// Make sure our file sizes match up
foreach ($verify->ticket->chunks as $chunk_check) {
$chunk = $chunks[$chunk_check->id];
$chunk = $chunks[$chunk_check['id']];

if ($chunk['size'] != $chunk_check->size) {
if ($chunk['size'] != intval($chunk_check['size'])) {
// size incorrect, uh oh
echo "Chunk {$chunk_check->id} is actually {$chunk['size']} but uploaded as {$chunk_check->size}<br>";
throw new VimeoAPIException("Chunk {$chunk_check['id']} is actually {$chunk['size']} but uploaded as {$chunk_check['size']}", -1);
}
}

Expand All @@ -504,7 +522,7 @@ public function upload($file_path, $use_multiple_chunks = false, $chunk_temp_dir
return $complete->ticket->video_id;
}
else if ($complete->err) {
throw new VimeoAPIException($complete->err->msg, $complete->err->code);
throw new VimeoAPIException($complete->err->expl, $complete->err->code);
}
}

Expand All @@ -522,14 +540,23 @@ public function uploadMulti($file_name, $size = 1048576)
/**
* URL encode a parameter or array of parameters.
*
* @param array/string $input A parameter or set of parameters to encode.
* @param array/string/int/boolean $input A parameter or set of parameters to encode.
* @return array/string URL encoded version of input.
*/
public static function url_encode_rfc3986($input)
{
if (is_array($input)) {
return array_map(array('phpVimeo', 'url_encode_rfc3986'), $input);
}
else if (is_scalar($input)) {
if (!is_string($input)) {
if (is_bool($input)) {
$input=$input?'1':'0';
} else {
$input=strval($input);
}
}

return str_replace(array('+', '%7E'), array(' ', '~'), rawurlencode($input));
}
else {
Expand Down