first commit
This commit is contained in:
Roman Pyrih
959
wp-content/plugins/updraftplus/includes/onedrive/client.php
Normal file
959
wp-content/plugins/updraftplus/includes/onedrive/client.php
Normal file
@@ -0,0 +1,959 @@
|
||||
<?php
|
||||
namespace Onedrive;
|
||||
|
||||
/*
|
||||
* A Client instance allows communication with the OneDrive API and perform
|
||||
* operations programmatically.
|
||||
*
|
||||
* For an overview of the OneDrive protocol flow, see here:
|
||||
* http://msdn.microsoft.com/en-us/library/live/hh243647.aspx
|
||||
*
|
||||
* To manage your Live Connect applications, see here:
|
||||
* https://account.live.com/developers/applications/index
|
||||
* Or here:
|
||||
* https://manage.dev.live.com/ (not working?)
|
||||
*
|
||||
* For an example implementation, see here:
|
||||
* https://github.com/drumaddict/skydrive-api-yii/blob/master/SkyDriveAPI.php
|
||||
*/
|
||||
// TODO: support refresh tokens: http://msdn.microsoft.com/en-us/library/live/hh243647.aspx
|
||||
// TODO: pass parameters in POST request body when obtaining the access token
|
||||
class Client {
|
||||
|
||||
// Client information.
|
||||
private $_clientId;
|
||||
|
||||
// OAuth state (token, etc...).
|
||||
private $_state;
|
||||
|
||||
// The last HTTP status received.
|
||||
private $_httpStatus;
|
||||
|
||||
// The last Content-Type received.
|
||||
private $_contentType;
|
||||
|
||||
// Verify SSL hosts and peers.
|
||||
private $_sslVerify;
|
||||
|
||||
// Over-ride SSL CA path for verification (only relevant when verifying).
|
||||
private $_sslCAPath;
|
||||
|
||||
private $safeMode;
|
||||
|
||||
private $use_msgraph_api;
|
||||
|
||||
private $api_url;
|
||||
|
||||
private $route_prefix;
|
||||
|
||||
// The base URL for authorization requests.
|
||||
private $auth_url;
|
||||
|
||||
// The base URL for token requests.
|
||||
private $token_url;
|
||||
|
||||
/**
|
||||
* Creates a base cURL object which is compatible with the OneDrive API.
|
||||
*
|
||||
* @param (string) $path - The path of the API call (eg. me/skydrive).
|
||||
* @param (array) $options - Further curl options to set.
|
||||
* @return (resource) A compatible cURL object.
|
||||
*/
|
||||
private function _createCurl($path, $options = array()) {
|
||||
$curl = curl_init();
|
||||
$curl_version = curl_version();
|
||||
$curl_version = isset($curl_version['version']) ? $curl_version['version'] : '0';
|
||||
|
||||
$default_options = array(
|
||||
CURLOPT_RETURNTRANSFER => true,
|
||||
|
||||
CURLOPT_SSL_VERIFYHOST => ($this->_sslVerify ? 2 : false),
|
||||
CURLOPT_SSL_VERIFYPEER => $this->_sslVerify,
|
||||
|
||||
CURLOPT_AUTOREFERER => true,
|
||||
);
|
||||
|
||||
if (version_compare($curl_version, '8.0', '<') && version_compare($curl_version, '7.62', '>=')) $default_options[CURLOPT_HTTP_VERSION] = CURL_HTTP_VERSION_1_1;
|
||||
if (defined('UPDRAFTPLUS_ONEDRIVE_CURL_HTTP_VERSION')) $default_options[CURLOPT_HTTP_VERSION] = UPDRAFTPLUS_ONEDRIVE_CURL_HTTP_VERSION;
|
||||
|
||||
if ($this->_sslVerify && $this->_sslCAPath) {
|
||||
$default_options[CURLOPT_CAINFO] = $this->_sslCAPath;
|
||||
}
|
||||
|
||||
// Prevent misleading PHP notice
|
||||
if (!$this->safeMode) $default_options[CURLOPT_FOLLOWLOCATION] = true;
|
||||
|
||||
// See http://php.net/manual/en/function.array-merge.php for a description of the + operator (and why array_merge() would be wrong)
|
||||
$final_options = $options + $default_options;
|
||||
|
||||
curl_setopt_array($curl, $final_options);
|
||||
|
||||
return $curl;
|
||||
}
|
||||
|
||||
/**
|
||||
* Processes a result returned by the OneDrive API call using a cURL object.
|
||||
*
|
||||
* @param (resource) $curl - The cURL object used to perform the call.
|
||||
* @return (object|string) The content returned, as an object instance if
|
||||
* served a JSON, or as a string if served as anything else.
|
||||
*/
|
||||
private function _processResult($curl) {
|
||||
$result = curl_exec($curl);
|
||||
|
||||
if (false === $result) {
|
||||
throw new \Exception('curl_exec() failed: ' . curl_error($curl)); // phpcs:ignore WordPress.Security.EscapeOutput.ExceptionNotEscaped -- Error message to be escaped when caught and printed.
|
||||
}
|
||||
|
||||
$info = curl_getinfo($curl);
|
||||
|
||||
$this->_httpStatus = array_key_exists('http_code', $info) ?
|
||||
(int) $info['http_code'] : null;
|
||||
|
||||
$this->_contentType = array_key_exists('content_type', $info) ?
|
||||
(string) $info['content_type'] : null;
|
||||
|
||||
|
||||
// Parse nothing but JSON.
|
||||
if (1 !== preg_match('|^application/json|', $this->_contentType)) {
|
||||
return $result;
|
||||
}
|
||||
|
||||
// Empty JSON string is returned as an empty object.
|
||||
if ('' == $result) {
|
||||
return (object) array();
|
||||
}
|
||||
|
||||
$decoded = json_decode($result);
|
||||
$vars = get_object_vars($decoded);
|
||||
|
||||
if (array_key_exists('error', $vars)) {
|
||||
throw new \Exception($decoded->error->message, (int) $decoded->error->code); // phpcs:ignore WordPress.Security.EscapeOutput.ExceptionNotEscaped -- Error message to be escaped when caught and printed.
|
||||
}
|
||||
|
||||
return $decoded;
|
||||
}
|
||||
|
||||
/**
|
||||
* Constructor.
|
||||
*
|
||||
* @param (array) $options. The options to use while creating this object.
|
||||
* Valid supported keys are:
|
||||
* 'state': When defined, it should contain a valid OneDrive client
|
||||
* state, as returned by getState(). Default: array().
|
||||
* (boolean)'ssl_verify': whether to verify SSL hosts and peers (default: false)
|
||||
* (boolean|string)'ssl_capath': CA path to use for verifying SSL certificate chain (default: false)
|
||||
*/
|
||||
public function __construct(array $options = array()) {
|
||||
$this->_clientId = array_key_exists('client_id', $options)
|
||||
? (string) $options['client_id'] : null;
|
||||
|
||||
$this->_state = array_key_exists('state', $options)
|
||||
? $options['state'] : (object) array(
|
||||
'redirect_uri' => null,
|
||||
'token' => null
|
||||
);
|
||||
|
||||
$this->_sslVerify = array_key_exists('ssl_verify', $options)
|
||||
? $options['ssl_verify'] : false;
|
||||
|
||||
$this->_sslCAPath = array_key_exists('ssl_capath', $options)
|
||||
? $options['ssl_capath'] : false;
|
||||
|
||||
$this->safeMode = (@ini_get('safe_mode') && strtolower(@ini_get('safe_mode')) != "off") ? 1 : 0;
|
||||
|
||||
$this->use_msgraph_api = array_key_exists('use_msgraph_api', $options) ? $options['use_msgraph_api'] : false;
|
||||
|
||||
if ($this->use_msgraph_api) {
|
||||
$endpoint_tld = (isset($options['endpoint_tld']) && 'de' == $options['endpoint_tld']) ? $options['endpoint_tld'] : 'com';
|
||||
$this->api_url = UpdraftPlus_OneDrive_Account::$types[$endpoint_tld]['api_url'];
|
||||
$this->route_prefix = 'me/';
|
||||
|
||||
// The base URL for authorization requests.
|
||||
$this->auth_url = UpdraftPlus_OneDrive_Account::$types[$endpoint_tld]['auth_url'];
|
||||
// The base URL for token requests.
|
||||
$this->token_url = UpdraftPlus_OneDrive_Account::$types[$endpoint_tld]['token_url'];
|
||||
} else { // Custom App or old live sdk
|
||||
$this->route_prefix = '';
|
||||
$this->api_url = 'https://api.onedrive.com/v1.0/';
|
||||
|
||||
// The base URL for authorization requests.
|
||||
$this->auth_url = 'https://login.live.com/oauth20_authorize.srf';
|
||||
|
||||
// The base URL for token requests.
|
||||
$this->token_url = 'https://login.live.com/oauth20_token.srf';
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
/**
|
||||
* Gets the current state of this Client instance. Typically saved in the
|
||||
* session and passed back to the Client constructor for further requests.
|
||||
*
|
||||
* @return (object) The state of this Client instance.
|
||||
*/
|
||||
public function getState() {
|
||||
return $this->_state;
|
||||
}
|
||||
|
||||
/**
|
||||
* Gets the URL of the log in form. After login, the browser is redirected to
|
||||
* the redirect URL, and a code is passed as a GET parameter to this URL.
|
||||
*
|
||||
* The browser is also redirected to this URL if the user is already logged
|
||||
* in.
|
||||
*
|
||||
* @param (array) $scopes - The OneDrive scopes requested by the application.
|
||||
* Supported values: 'wl.signin', 'wl.basic', 'wl.contacts_skydrive',
|
||||
* 'wl.skydrive_update'.
|
||||
* @param (string) $redirectUri - The URI to which to redirect to upon
|
||||
* successful log in.
|
||||
* @param (array) $options. Reserved for future use. Default: array(). TODO:
|
||||
* support it.
|
||||
* @param (string) $instance_id - the id of the instance that we are currently trying to authorise
|
||||
* @param string $callback_uri - the current site url where control should redirect after auth server authenticated
|
||||
* @return (string) The login URL.
|
||||
*/
|
||||
public function getLogInUrl(array $scopes, $redirectUri, array $options = array(), $instance_id = '', $callback_uri = '') {
|
||||
if (null === $this->_clientId) {
|
||||
throw new \Exception('The client ID must be set to call getLoginUrl()');
|
||||
}
|
||||
|
||||
if ($this->use_msgraph_api) {
|
||||
$imploded = implode(' ', $scopes);
|
||||
} else {
|
||||
$imploded = implode(',', $scopes);
|
||||
}
|
||||
$redirectUri = (string) $redirectUri;
|
||||
$this->_state->redirect_uri = $redirectUri;
|
||||
|
||||
$prefixed_instance_id = ':' . $instance_id;
|
||||
if ($this->use_msgraph_api) {
|
||||
$token = 'token'.$prefixed_instance_id.$callback_uri;
|
||||
} else {
|
||||
$token = $prefixed_instance_id;
|
||||
}
|
||||
// When using this URL, the browser will eventually be redirected to the
|
||||
// callback URL with a code passed in the URL query string (the name of the
|
||||
// variable is "code"). This is suitable for PHP.
|
||||
$url = $this->auth_url
|
||||
. '?client_id=' . urlencode($this->_clientId)
|
||||
. '&scope=' . urlencode($imploded)
|
||||
. '&response_type=code'
|
||||
. '&redirect_uri=' . urlencode($redirectUri)
|
||||
. '&state=' . urlencode($token)
|
||||
. '&display=popup'
|
||||
. '&locale=en';
|
||||
return $url;
|
||||
}
|
||||
|
||||
/**
|
||||
* Gets the access token expiration delay.
|
||||
*
|
||||
* @return (int) The token expiration delay, in seconds.
|
||||
*/
|
||||
public function getTokenExpire() {
|
||||
return $this->_state->token->obtained
|
||||
+ $this->_state->token->data->expires_in - time();
|
||||
}
|
||||
|
||||
/**
|
||||
* Gets the status of the current access token.
|
||||
*
|
||||
* @return (int) The status of the current access token:
|
||||
* 0 => no access token
|
||||
* -1 => access token will expire soon (1 minute or less)
|
||||
* -2 => access token is expired
|
||||
* 1 => access token is valid
|
||||
*/
|
||||
public function getAccessTokenStatus() {
|
||||
if (null === $this->_state->token) {
|
||||
return 0;
|
||||
}
|
||||
|
||||
$remaining = $this->getTokenExpire();
|
||||
|
||||
if (0 >= $remaining) {
|
||||
return -2;
|
||||
}
|
||||
|
||||
if (60 >= $remaining) {
|
||||
return -1;
|
||||
}
|
||||
|
||||
return 1;
|
||||
}
|
||||
|
||||
/**
|
||||
* Obtains a new access token from OAuth. This token is valid for one hour.
|
||||
*
|
||||
* @param (string) $clientSecret - The OneDrive client secret.
|
||||
* @param (string) $code - The code returned by OneDrive after successful log
|
||||
* in.
|
||||
* @param (string) $redirectUri. Must be the same as the redirect URI passed
|
||||
* to getLoginUrl().
|
||||
*/
|
||||
public function obtainAccessToken($clientSecret, $code) {
|
||||
if (null === $this->_clientId) {
|
||||
throw new \Exception('The client ID must be set to call obtainAccessToken()');
|
||||
}
|
||||
|
||||
if (null === $this->_state->redirect_uri) {
|
||||
throw new \Exception('The state\'s redirect URI must be set to call obtainAccessToken()');
|
||||
}
|
||||
|
||||
$url = $this->token_url;
|
||||
|
||||
$curl = curl_init();
|
||||
$curl_version = curl_version();
|
||||
$curl_version = isset($curl_version['version']) ? $curl_version['version'] : '0';
|
||||
|
||||
$curl_options = array(
|
||||
CURLOPT_RETURNTRANSFER => true,
|
||||
|
||||
CURLOPT_SSL_VERIFYHOST => ($this->_sslVerify ? 2 : false),
|
||||
CURLOPT_SSL_VERIFYPEER => $this->_sslVerify,
|
||||
|
||||
CURLOPT_URL => $url,
|
||||
|
||||
CURLOPT_AUTOREFERER => true,
|
||||
CURLOPT_POST => 1, // i am sending post data
|
||||
CURLOPT_POSTFIELDS => 'client_id=' . urlencode($this->_clientId)
|
||||
. '&redirect_uri=' . urlencode($this->_state->redirect_uri)
|
||||
. '&client_secret=' . urlencode($clientSecret)
|
||||
. '&grant_type=authorization_code'
|
||||
. '&code=' . urlencode($code),
|
||||
);
|
||||
|
||||
if (version_compare($curl_version, '8.0', '<') && version_compare($curl_version, '7.62', '>=')) $curl_options[CURLOPT_HTTP_VERSION] = CURL_HTTP_VERSION_1_1;
|
||||
if (defined('UPDRAFTPLUS_ONEDRIVE_CURL_HTTP_VERSION')) $curl_options[CURLOPT_HTTP_VERSION] = UPDRAFTPLUS_ONEDRIVE_CURL_HTTP_VERSION;
|
||||
|
||||
// Prevent misleading PHP notice
|
||||
if (!$this->safeMode) $curl_options[CURLOPT_FOLLOWLOCATION] = true;
|
||||
|
||||
curl_setopt_array($curl, $curl_options);
|
||||
|
||||
$result = curl_exec($curl);
|
||||
|
||||
if (false === $result) {
|
||||
if (curl_errno($curl)) {
|
||||
throw new \Exception('Curl error: '.curl_error($curl)); // phpcs:ignore WordPress.Security.EscapeOutput.ExceptionNotEscaped -- Error message to be escaped when caught and printed.
|
||||
} else {
|
||||
throw new \Exception('Curl error: empty response');
|
||||
}
|
||||
}
|
||||
|
||||
$decoded = json_decode($result);
|
||||
|
||||
if (null === $decoded) {
|
||||
throw new \Exception('json_decode() failed');
|
||||
}
|
||||
|
||||
$this->_state->redirect_uri = null;
|
||||
|
||||
$this->_state->token = (object) array(
|
||||
'obtained' => time(),
|
||||
'data' => $decoded
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* Renews the access token from OAuth. This token is valid for one hour.
|
||||
*/
|
||||
/*public function renewAccessToken($clientSecret, $redirectUri) {
|
||||
$url = self::TOKEN_URL
|
||||
. '?client_id=' . $this->_clientId
|
||||
. '&redirect_uri=' . (string) $redirectUri
|
||||
. '&client_secret=' . (string) $clientSecret
|
||||
. '&grant_type=' . 'refresh_token'
|
||||
. '&code=' . (string) $code;
|
||||
}*/
|
||||
|
||||
/**
|
||||
* Performs a call to the OneDrive API using the GET method.
|
||||
*
|
||||
* @param (string) $path - The path of the API call (eg. me/skydrive).
|
||||
* @param (array) $options - Further curl options to set.
|
||||
* @param (boolean) $use_authorization_header - Whether to include authorisation header in the request (it's true by default)
|
||||
* @return (boolean) Object of result
|
||||
*/
|
||||
public function apiGet($path, $options = array(), $use_authorization_header = true) {
|
||||
$api = $this->api_url;
|
||||
|
||||
$url = (strpos($path, 'https://') === 0) ? $path : $api . $path;
|
||||
|
||||
if (!$this->use_msgraph_api) $url .= '?access_token=' . urlencode($this->_state->token->data->access_token);
|
||||
|
||||
$curl = $this->_createCurl($path, $options);
|
||||
$curl_options = array(
|
||||
CURLOPT_URL => $url,
|
||||
);
|
||||
|
||||
if ($use_authorization_header) {
|
||||
$curl_options[CURLOPT_HTTPHEADER] = array(
|
||||
'Authorization: Bearer ' . $this->_state->token->data->access_token
|
||||
);
|
||||
}
|
||||
|
||||
curl_setopt_array($curl, $curl_options);
|
||||
//curl_setopt($curl, CURLOPT_URL, $url);
|
||||
|
||||
return $this->_processResult($curl);
|
||||
}
|
||||
|
||||
/**
|
||||
* Performs a call to the OneDrive API using the POST method.
|
||||
*
|
||||
* @param (string) $path - The path of the API call (eg. me/skydrive).
|
||||
* @param (array|object) $data - The data to pass in the body of the request.
|
||||
*/
|
||||
public function apiPost($path, $data = null) {
|
||||
$api = $this->api_url;
|
||||
|
||||
$url = (strpos($path, 'https://') === 0) ? $path : $api . $path;
|
||||
|
||||
$curl = $this->_createCurl($path);
|
||||
|
||||
$curl_options = array(
|
||||
CURLOPT_URL => $url,
|
||||
CURLOPT_POST => true,
|
||||
|
||||
CURLOPT_HTTPHEADER => array(
|
||||
'Content-Type: application/json', // The data is sent as JSON as per OneDrive documentation
|
||||
'Authorization: Bearer ' . $this->_state->token->data->access_token
|
||||
),
|
||||
|
||||
);
|
||||
|
||||
if (null !== $data) {
|
||||
$data = (object) $data;
|
||||
$curl_options[CURLOPT_POSTFIELDS] = json_encode($data);
|
||||
} else {
|
||||
// This doesn't seem to be necessary in my testing, but another user got an error from OneDrive indicating it was needed. Perhaps varies between curl versions?
|
||||
$curl_options[CURLOPT_HTTPHEADER][] = 'Content-Length: 0';
|
||||
}
|
||||
|
||||
curl_setopt_array($curl, $curl_options);
|
||||
|
||||
return $this->_processResult($curl);
|
||||
}
|
||||
|
||||
/**
|
||||
* Performs a call to the OneDrive API using the PUT method.
|
||||
*
|
||||
* @param (string) $path - The path of the API call (eg. me/skydrive).
|
||||
* @param (resource) $stream - The data stream to upload.
|
||||
* @param (string) $contentType - The MIME type of the data stream, or null
|
||||
* if unknown. Default: null.
|
||||
* @param (int) $size - The number of bytes to send. Default: as many as are left in the stream.
|
||||
* @param (array) $headers - Further headers to send
|
||||
* @param (boolean) $use_authorization_header - Whether to include authorisation header in the request (it's true by default)
|
||||
* @return (object|string) The content returned, as an object instance if served a JSON, or as a string if served as anything else.
|
||||
*/
|
||||
public function apiPut($path, $stream, $contentType = null, $size = null, $headers = array(), $use_authorization_header = true) {
|
||||
$api = $this->api_url;
|
||||
|
||||
$url = (strpos($path, 'https://') === 0) ? $path : $api . $path;
|
||||
$curl = $this->_createCurl($path);
|
||||
|
||||
if (null === $size) {
|
||||
$stats = fstat($stream);
|
||||
$size = $stats[7];
|
||||
}
|
||||
|
||||
if ($use_authorization_header) $headers[] = 'Authorization: Bearer ' . $this->_state->token->data->access_token;
|
||||
|
||||
if (null !== $contentType) {
|
||||
$headers[] = 'Content-Type: ' . $contentType;
|
||||
}
|
||||
|
||||
$options = array(
|
||||
CURLOPT_URL => $url,
|
||||
CURLOPT_HTTPHEADER => $headers,
|
||||
CURLOPT_PUT => true,
|
||||
CURLOPT_INFILE => $stream,
|
||||
CURLOPT_INFILESIZE => $size
|
||||
);
|
||||
|
||||
curl_setopt_array($curl, $options);
|
||||
return $this->_processResult($curl);
|
||||
}
|
||||
|
||||
/**
|
||||
* Performs a call to the OneDrive API using the DELETE method.
|
||||
*
|
||||
* @param (string) $path - The path of the API call (eg. me/skydrive).
|
||||
*/
|
||||
public function apiDelete($path) {
|
||||
$url = $this->api_url . $path;
|
||||
// . '?access_token=' . urlencode($this->_state->token->data->access_token);
|
||||
|
||||
$curl = $this->_createCurl($path);
|
||||
|
||||
curl_setopt_array($curl, array(
|
||||
CURLOPT_URL => $url,
|
||||
CURLOPT_CUSTOMREQUEST => 'DELETE',
|
||||
|
||||
CURLOPT_HTTPHEADER => array(
|
||||
'Authorization: Bearer ' . $this->_state->token->data->access_token
|
||||
)
|
||||
));
|
||||
|
||||
return $this->_processResult($curl);
|
||||
}
|
||||
|
||||
/**
|
||||
* Performs a call to the OneDrive API using the DELETE method.
|
||||
*
|
||||
* @param (string) $path - The path of the API call (eg. me/skydrive).
|
||||
* @param (array) $objectIdArray - An array of unique IDs of the objects to delete.
|
||||
*/
|
||||
public function apiDeleteMulti($path, $objectIdArray) {
|
||||
|
||||
$multi_curl = curl_multi_init();
|
||||
$curl_objects = array();
|
||||
|
||||
foreach($objectIdArray as $id) {
|
||||
$current_path = $path . $id;
|
||||
$url = $this->api_url . $current_path;
|
||||
|
||||
$curl = $this->_createCurl($current_path);
|
||||
|
||||
curl_setopt_array($curl, array(
|
||||
CURLOPT_URL => $url,
|
||||
CURLOPT_CUSTOMREQUEST => 'DELETE',
|
||||
CURLOPT_HTTPHEADER => array(
|
||||
'Authorization: Bearer ' . $this->_state->token->data->access_token
|
||||
)
|
||||
));
|
||||
curl_multi_add_handle($multi_curl, $curl);
|
||||
$curl_objects[] = $curl;
|
||||
}
|
||||
|
||||
$active = null;
|
||||
|
||||
do {
|
||||
$status = curl_multi_exec($multi_curl, $active);
|
||||
if ($active) {
|
||||
// Wait a short time for more activity
|
||||
curl_multi_select($multi_curl);
|
||||
}
|
||||
} while ($active && $status == CURLM_OK);
|
||||
|
||||
$response_array = array();
|
||||
|
||||
foreach ($curl_objects as $curl_object) {
|
||||
$response = curl_multi_getcontent($curl_object);
|
||||
// If empty then it's a success other wise we have an error array
|
||||
if (empty($response)) {
|
||||
$response_array[] = 'success';
|
||||
} else {
|
||||
$response_array[] = json_decode($response, true);
|
||||
}
|
||||
curl_multi_remove_handle($multi_curl, $curl_object);
|
||||
}
|
||||
|
||||
curl_multi_close($multi_curl);
|
||||
|
||||
return $response_array;
|
||||
}
|
||||
|
||||
/**
|
||||
* Performs a call to the OneDrive API using the MOVE method.
|
||||
*
|
||||
* @param (string) $path - The path of the API call (eg. me/skydrive).
|
||||
* @param (array|object) $data - The data to pass in the body of the request.
|
||||
*/
|
||||
public function apiMove($path, $data) {
|
||||
$url = $this->api_url . $path;
|
||||
$data = (object) $data;
|
||||
$curl = $this->_createCurl($path);
|
||||
|
||||
curl_setopt_array($curl, array(
|
||||
CURLOPT_URL => $url,
|
||||
CURLOPT_CUSTOMREQUEST => 'MOVE',
|
||||
|
||||
CURLOPT_HTTPHEADER => array(
|
||||
'Content-Type: application/json', // The data is sent as JSON as per OneDrive documentation
|
||||
'Authorization: Bearer ' . $this->_state->token->data->access_token
|
||||
),
|
||||
|
||||
CURLOPT_POSTFIELDS => json_encode($data)
|
||||
));
|
||||
|
||||
return $this->_processResult($curl);
|
||||
}
|
||||
|
||||
/**
|
||||
* Performs a call to the OneDrive API using the COPY method.
|
||||
*
|
||||
* @param (string) $path - The path of the API call (eg. me/skydrive).
|
||||
* @param (array|object) $data - The data to pass in the body of the request.
|
||||
*/
|
||||
public function apiCopy($path, $data) {
|
||||
$url = $this->api_url . $path;
|
||||
$data = (object) $data;
|
||||
$curl = $this->_createCurl($path);
|
||||
|
||||
curl_setopt_array($curl, array(
|
||||
CURLOPT_URL => $url,
|
||||
CURLOPT_CUSTOMREQUEST => 'COPY',
|
||||
|
||||
CURLOPT_HTTPHEADER => array(
|
||||
'Content-Type: application/json', // The data is sent as JSON as per OneDrive documentation
|
||||
'Authorization: Bearer ' . $this->_state->token->data->access_token
|
||||
),
|
||||
|
||||
CURLOPT_POSTFIELDS => json_encode($data)
|
||||
));
|
||||
|
||||
return $this->_processResult($curl);
|
||||
}
|
||||
|
||||
/**
|
||||
* Creates a folder in the current OneDrive account.
|
||||
*
|
||||
* @param (string) $name - The name of the OneDrive folder to be created.
|
||||
* @param (null|string) $parentId - The ID of the OneDrive folder into which
|
||||
* to create the OneDrive folder, or null to create it in the OneDrive
|
||||
* root folder. Default: null.
|
||||
* @param (null|string) $description - The description of the OneDrive folder to be
|
||||
* created, or null to create it without a description. Default: null.
|
||||
* @return (Folder) The folder created, as a Folder instance referencing to
|
||||
* the OneDrive folder created.
|
||||
*/
|
||||
public function createFolder($name, $parentId = null, $description = null) {
|
||||
if (null === $parentId) {
|
||||
$parent_path = $this->route_prefix.'drive/root/children';
|
||||
} else{
|
||||
$parent_path = $this->route_prefix.'drive/items/'.$parentId.'/children';
|
||||
}
|
||||
|
||||
$properties = array(
|
||||
'name' => (string) $name,
|
||||
'folder' => (object) array()
|
||||
);
|
||||
|
||||
//if (null !== $description) {
|
||||
// $properties['description'] = (string) $description;
|
||||
//}
|
||||
|
||||
$folder_body = (object) $properties;
|
||||
|
||||
$folder = $this->apiPost($parent_path, $folder_body);
|
||||
return new Folder($this, $folder->id, $folder);
|
||||
}
|
||||
|
||||
/**
|
||||
* Creates a file in the current OneDrive account.
|
||||
*
|
||||
* @param (string) $name - The name of the OneDrive file to be created.
|
||||
* @param (null|string) $parentId - The ID of the OneDrive folder into which
|
||||
* to create the OneDrive file, or null to create it in the OneDrive
|
||||
* root folder. Default: null.
|
||||
* @param (string|resource) $content - The content of the OneDrive file to be created.
|
||||
* @return (File) The file created, as File instance referencing to the
|
||||
* OneDrive file created.
|
||||
* @throw (\Exception) Thrown on I/O errors.
|
||||
*/
|
||||
public function createFile($name, $parentId = null, $content = '') {
|
||||
if (null === $parentId) {
|
||||
$parent_path = $this->route_prefix.'drive/root';
|
||||
} else{
|
||||
$parent_path = $this->route_prefix.'drive/items/'.$parentId;
|
||||
}
|
||||
|
||||
if (is_resource($content)) {
|
||||
$stream = $content;
|
||||
} else {
|
||||
$stream = fopen('php://temp', 'rw+b');
|
||||
|
||||
if (false === $stream) {
|
||||
throw new \Exception('fopen() failed');
|
||||
}
|
||||
|
||||
if (false === fwrite($stream, $content)) {
|
||||
fclose($stream);
|
||||
throw new \Exception('fwrite() failed');
|
||||
}
|
||||
|
||||
if (!rewind($stream)) {
|
||||
fclose($stream);
|
||||
throw new \Exception('rewind() failed');
|
||||
}
|
||||
}
|
||||
|
||||
// TODO: some versions of cURL cannot PUT memory streams? See here for a
|
||||
// workaround: https://bugs.php.net/bug.php?id=43468
|
||||
$file = $this->apiPut($parent_path . '/children/' . urlencode($name).'/content/', $stream, null, null, array());
|
||||
if (!is_resource($content)) fclose($stream);
|
||||
return new File($this, $file->id, $file);
|
||||
}
|
||||
|
||||
/**
|
||||
* Fetches an object from the current OneDrive account.
|
||||
*
|
||||
* @param (null|string) The unique ID of the OneDrive object to fetch, or
|
||||
* null to fetch the OneDrive root folder. Default: null.
|
||||
* @return (Object) The object fetched, as an Object instance referencing to
|
||||
* the OneDrive object fetched.
|
||||
*/
|
||||
public function fetchObject($objectId = null) {
|
||||
$objectId = null !== $objectId ? $objectId : $this->route_prefix.'drive/root';
|
||||
$result = $this->apiGet($objectId, array());
|
||||
|
||||
if (property_exists($result, 'folder')) {
|
||||
return new Folder($this, $objectId, $result);
|
||||
}
|
||||
|
||||
return new File($this, $objectId, $result);
|
||||
}
|
||||
|
||||
/**
|
||||
* Fetches the root folder from the current OneDrive account.
|
||||
*
|
||||
* @return (Folder) The root folder, as a Folder instance referencing to the
|
||||
* OneDrive root folder.
|
||||
*/
|
||||
public function fetchRoot() {
|
||||
return $this->fetchObject();
|
||||
}
|
||||
|
||||
/**
|
||||
* Fetches the "Camera Roll" folder from the current OneDrive account.
|
||||
*
|
||||
* @return (Folder) The "Camera Roll" folder, as a Folder instance referencing
|
||||
* to the OneDrive "Camera Roll" folder.
|
||||
*/
|
||||
public function fetchCameraRoll() {
|
||||
return $this->fetchObject($this->route_prefix.'drive/special/cameraroll');
|
||||
}
|
||||
|
||||
/**
|
||||
* Fetches the "Documents" folder from the current OneDrive account.
|
||||
*
|
||||
* @return (Folder) The "Documents" folder, as a Folder instance referencing
|
||||
* to the OneDrive "Documents" folder.
|
||||
*/
|
||||
public function fetchDocs() {
|
||||
return $this->fetchObject($this->route_prefix.'drive/special/documents');
|
||||
}
|
||||
|
||||
/**
|
||||
* Fetches the "Pictures" folder from the current OneDrive account.
|
||||
*
|
||||
* @return (Folder) The "Pictures" folder, as a Folder instance referencing to
|
||||
* the OneDrive "Pictures" folder.
|
||||
*/
|
||||
public function fetchPics() {
|
||||
return $this->fetchObject($this->route_prefix.'drive/special/photos');
|
||||
}
|
||||
|
||||
/**
|
||||
* Fetches the "Public" folder from the current OneDrive account.
|
||||
*
|
||||
* @return (Folder) The "Public" folder, as a Folder instance referencing to
|
||||
* the OneDrive "Public" folder.
|
||||
*/
|
||||
public function fetchPublicDocs() {
|
||||
return $this->fetchObject($this->route_prefix.'drive/special/public_documents');
|
||||
}
|
||||
|
||||
/**
|
||||
* Fetches the properties of an object in the current OneDrive account.
|
||||
*
|
||||
* @return (array) The properties of the object fetched.
|
||||
*/
|
||||
public function fetchProperties($objectId) {
|
||||
if (null === $objectId) {
|
||||
$object_path = $this->route_prefix.'drive/root';
|
||||
} else {
|
||||
$object_path = $this->route_prefix.'drive/items/'.$objectId;
|
||||
}
|
||||
|
||||
return $this->apiGet($objectId, array());
|
||||
}
|
||||
|
||||
/**
|
||||
* Fetches the objects in a folder in the current OneDrive account.
|
||||
*
|
||||
* @return (array) The objects in the folder fetched, as Object instances
|
||||
* referencing OneDrive objects.
|
||||
*/
|
||||
public function fetchObjects($objectId) {
|
||||
if (null === $objectId) {
|
||||
$object_path = $this->route_prefix.'drive/root';
|
||||
} else{
|
||||
$object_path = $this->route_prefix.'drive/items/'.$objectId;
|
||||
}
|
||||
|
||||
$fetch_url = $object_path . '/children';
|
||||
|
||||
$objects = array();
|
||||
|
||||
while ($fetch_url) {
|
||||
|
||||
$result = $this->apiGet($fetch_url, array());
|
||||
|
||||
foreach ($result->value as $data) {
|
||||
$object = property_exists($data, 'folder') ?
|
||||
new Folder($this, $data->id, $data)
|
||||
: new File($this, $data->id, $data);
|
||||
|
||||
$objects[] = $object;
|
||||
}
|
||||
|
||||
$next_url_key = '@odata.nextLink';
|
||||
|
||||
$fetch_url = !empty($result->$next_url_key) ? $result->$next_url_key : false;
|
||||
}
|
||||
|
||||
return $objects;
|
||||
}
|
||||
|
||||
/**
|
||||
* Updates the properties of an object in the current OneDrive account.
|
||||
*
|
||||
* @param (string) $objectId - The unique ID of the object to update.
|
||||
* @param (array|object) $properties - The properties to update. Default:
|
||||
* array().
|
||||
* @throw (\Exception) Thrown on I/O errors.
|
||||
*/
|
||||
public function updateObject($objectId, $properties = array()) {
|
||||
$objectId = $objectId;
|
||||
$properties = (object) $properties;
|
||||
$encoded = json_encode($properties);
|
||||
$stream = fopen('php://temp', 'w+b');
|
||||
|
||||
if (false === $stream) {
|
||||
throw new \Exception('fopen() failed');
|
||||
}
|
||||
|
||||
if (false === fwrite($stream, $encoded)) {
|
||||
throw new \Exception('fwrite() failed');
|
||||
}
|
||||
|
||||
if (!rewind($stream)) {
|
||||
throw new \Exception('rewind() failed');
|
||||
}
|
||||
|
||||
$this->apiPut($objectId, $stream, 'application/json', null, array());
|
||||
}
|
||||
|
||||
/**
|
||||
* Moves an object into another folder.
|
||||
*
|
||||
* @param (string) The unique ID of the object to move.
|
||||
* @param (null|string) The unique ID of the folder into which to move the
|
||||
* object, or null to move it to the OneDrive root folder. Default:
|
||||
* null.
|
||||
*/
|
||||
public function moveObject($objectId, $destinationId = null) {
|
||||
if (null === $destinationId) {
|
||||
$destinationId = $this->route_prefix.'drive/root';
|
||||
}
|
||||
|
||||
$this->apiMove($objectId, array(
|
||||
'destination' => $destinationId
|
||||
));
|
||||
}
|
||||
|
||||
/**
|
||||
* Copies a file into another folder. OneDrive does not support copying
|
||||
* folders.
|
||||
*
|
||||
* @param (string) The unique ID of the file to copy.
|
||||
* @param (null|string) The unique ID of the folder into which to copy the
|
||||
* file, or null to copy it to the OneDrive root folder. Default:
|
||||
* null.
|
||||
*/
|
||||
public function copyFile($objectId, $destinationId = null) {
|
||||
if (null === $destinationId) {
|
||||
$destinationId = $this->route_prefix.'drive/root';
|
||||
}
|
||||
|
||||
$this->apiCopy($objectId, array(
|
||||
'destination' => $destinationId
|
||||
));
|
||||
}
|
||||
|
||||
/**
|
||||
* Deletes an object in the current OneDrive account.
|
||||
*
|
||||
* @param (string) $objectId - The unique ID of the object to delete.
|
||||
*/
|
||||
public function deleteObject($objectId) {
|
||||
$objectId = $objectId;
|
||||
$this->apiDelete($this->route_prefix.'drive/items/'.$objectId);
|
||||
}
|
||||
|
||||
/**
|
||||
* Deletes an array of objects in the current OneDrive account.
|
||||
*
|
||||
* @param (array) $objectIdArray - An array of unique IDs of the objects to delete.
|
||||
*
|
||||
* @return array - returns an array of responses
|
||||
*/
|
||||
public function deleteObjectMulti($objectIdArray) {
|
||||
if (!is_array($objectIdArray)) return;
|
||||
return $this->apiDeleteMulti($this->route_prefix.'drive/items/', $objectIdArray);
|
||||
}
|
||||
|
||||
/**
|
||||
* Fetches the quota of the current OneDrive account.
|
||||
*
|
||||
* @return (object) An object with the following properties:
|
||||
* (int) quota - The total space, in bytes.
|
||||
* (int) available - The available space, in bytes.
|
||||
*/
|
||||
public function fetchQuota() {
|
||||
$drive = $this->apiGet($this->route_prefix.'drive', array());
|
||||
return $drive->quota;
|
||||
}
|
||||
|
||||
/**
|
||||
* Fetches the account info of the current OneDrive account.
|
||||
*
|
||||
* @return (object) An object with the following properties:
|
||||
* (string) id - OneDrive account ID.
|
||||
* (string) first_name - account owner's first name.
|
||||
* (string) last_name - account owner's last name.
|
||||
* (string) name - account owner's full name.
|
||||
* (string) gender - account owner's gender.
|
||||
* (string) locale - account owner's locale.
|
||||
*/
|
||||
public function fetchAccountInfo() {
|
||||
//$drive = $this->apiGet('drive', array(), true);
|
||||
$drive = $this->apiGet($this->route_prefix.'drive', array());
|
||||
return $drive->owner;
|
||||
}
|
||||
|
||||
/**
|
||||
* Fetches the recent documents uploaded to the current OneDrive account.
|
||||
*
|
||||
* @return (object) An object with the following properties:
|
||||
* (array) data - The list of the recent documents uploaded.
|
||||
*/
|
||||
public function fetchRecentDocs() {
|
||||
return $this->apiGet($this->route_prefix.'drive/special/recent_docs', array());
|
||||
}
|
||||
|
||||
/**
|
||||
* Fetches the objects shared with the current OneDrive account.
|
||||
*
|
||||
* @return (object) An object with the following properties:
|
||||
* (array) data - The list of the shared objects.
|
||||
*/
|
||||
public function fetchShared() {
|
||||
return $this->apiGet($this->route_prefix.'drive/special/shared', array());
|
||||
}
|
||||
|
||||
/**
|
||||
* Give $use_msgraph_api variable
|
||||
*
|
||||
* @return boolean private $use_msgraph_api var
|
||||
*/
|
||||
public function use_msgraph_api() {
|
||||
return $this->use_msgraph_api;
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user