| Current File : /var/www/e360ban/wp-content/updraft/plugins-old/updraftplus/methods/dropbox.php |
<?php
/**
* https://www.dropbox.com/developers/apply?cont=/developers/apps
*/
if (!defined('UPDRAFTPLUS_DIR')) die('No direct access allowed.');
// Converted to multi-options (Feb 2017-) and previous options conversion removed: Yes
if (!class_exists('UpdraftPlus_BackupModule')) updraft_try_include_file('methods/backup-module.php', 'require_once');
// Fix a potential problem for users who had the short-lived 1.12.35-1.12.38 free versions (see: https://wordpress.org/support/topic/1-12-37-dropbox-auth-broken/page/2/#post-8981457)
// Can be removed after a few months
$potential_options = UpdraftPlus_Options::get_updraft_option('updraft_dropbox');
if (is_array($potential_options) && isset($potential_options['version']) && isset($potential_options['settings']) && array() === $potential_options['settings']) {
// Wipe it, which will force its re-creation in proper format
UpdraftPlus_Options::delete_updraft_option('updraft_dropbox');
}
class UpdraftPlus_BackupModule_dropbox extends UpdraftPlus_BackupModule {
private $current_file_hash;
private $current_file_size;
private $uploaded_offset;
private $upload_tick;
/**
* This callback is called as upload progress is made
*
* @param Integer $offset - the byte offset
* @param String $uploadid - identifier for the upload in progress
* @param Boolean|String $fullpath - optional full path to the file being uploaded
*/
public function chunked_callback($offset, $uploadid, $fullpath = false) {
global $updraftplus;
$storage = $this->get_storage();
// Update upload ID
$this->jobdata_set('upload_id_'.$this->current_file_hash, $uploadid);
$this->jobdata_set('upload_offset_'.$this->current_file_hash, $offset);
$time_now = microtime(true);
$time_since_last_tick = $time_now - $this->upload_tick;
$data_since_last_tick = $offset - $this->uploaded_offset;
$this->upload_tick = $time_now;
$this->uploaded_offset = $offset;
// Here we use job-wide data, because we don't expect wildly different performance for different Dropbox accounts
$chunk_size = $updraftplus->jobdata_get('dropbox_chunk_size', 1048576);
// Don't go beyond 10MB, or change the chunk size after the last segment
if ($chunk_size < 10485760 && $this->current_file_size > 0 && $offset < $this->current_file_size) {
$job_run_time = $time_now - $updraftplus->job_time_ms;
if ($time_since_last_tick < 10) {
$upload_rate = $data_since_last_tick / max($time_since_last_tick, 1);
$upload_secs = min(floor($job_run_time), 10);
if ($job_run_time < 15) $upload_secs = max(6, $job_run_time*0.6);
$new_chunk = (int) max(min($upload_secs * $upload_rate * 0.9, 10485760), 1048576);
$new_chunk = $new_chunk - ($new_chunk % 524288);
$chunk_size = $new_chunk;
$storage->setChunkSize($chunk_size);
$updraftplus->jobdata_set('dropbox_chunk_size', $chunk_size);
}
}
if ($this->current_file_size > 0) {
$percent = round(100*($offset/$this->current_file_size), 1);
$updraftplus->record_uploaded_chunk($percent, "$uploadid, $offset, ".round($chunk_size/1024, 1)." KB", $fullpath);
} else {
$this->log("Chunked Upload: $offset bytes uploaded");
// This act is done by record_uploaded_chunk, and helps prevent overlapping runs
if ($fullpath) touch($fullpath);
}
}
/**
* Supported features
*
* @return Array
*/
public function get_supported_features() {
// This options format is handled via only accessing options via $this->get_options()
return array('multi_options', 'config_templates', 'multi_storage', 'conditional_logic', 'manual_authentication');
}
/**
* Default options
*
* @return Array
*/
public function get_default_options() {
return array(
'appkey' => '',
'secret' => '',
'folder' => '',
'tk_access_token' => '',
);
}
/**
* Check whether options have been set up by the user, or not
*
* @param Array $opts - the potential options
*
* @return Boolean
*/
public function options_exist($opts) {
if (is_array($opts) && !empty($opts['tk_access_token'])) return true;
return false;
}
/**
* Acts as a WordPress options filter
*
* @param Array $dropbox - An array of Dropbox options
* @return Array - the returned array can either be the set of updated Dropbox settings or a WordPress error array
*/
public function options_filter($dropbox) {
// Get the current options (and possibly update them to the new format)
$opts = UpdraftPlus_Storage_Methods_Interface::update_remote_storage_options_format('dropbox');
if (is_wp_error($opts)) {
if ('recursion' !== $opts->get_error_code()) {
$msg = "(".$opts->get_error_code()."): ".$opts->get_error_message();
$this->log($msg);
error_log("UpdraftPlus: $msg");
}
// The saved options had a problem; so, return the new ones
return $dropbox;
}
// If the input is not as expected, then return the current options
if (!is_array($dropbox)) return $opts;
// Remove instances that no longer exist
foreach ($opts['settings'] as $instance_id => $storage_options) {
if (!isset($dropbox['settings'][$instance_id])) unset($opts['settings'][$instance_id]);
}
// Dropbox has a special case where the settings could be empty so we should check for this before
if (!empty($dropbox['settings'])) {
foreach ($dropbox['settings'] as $instance_id => $storage_options) {
if (!empty($opts['settings'][$instance_id]['tk_access_token'])) {
$current_app_key = empty($opts['settings'][$instance_id]['appkey']) ? false : $opts['settings'][$instance_id]['appkey'];
$new_app_key = empty($storage_options['appkey']) ? false : $storage_options['appkey'];
// If a different app key is being used, then wipe the stored token as it cannot belong to the new app
if ($current_app_key !== $new_app_key) {
unset($opts['settings'][$instance_id]['tk_access_token']);
unset($opts['settings'][$instance_id]['ownername']);
unset($opts['settings'][$instance_id]['CSRF']);
}
}
// Now loop over the new options, and replace old options with them
foreach ($storage_options as $key => $value) {
if (null === $value) {
unset($opts['settings'][$instance_id][$key]);
} else {
if (!isset($opts['settings'][$instance_id])) $opts['settings'][$instance_id] = array();
$opts['settings'][$instance_id][$key] = $value;
}
}
if (!empty($opts['settings'][$instance_id]['folder']) && preg_match('#^https?://(www.)dropbox\.com/home/Apps/UpdraftPlus(.Com)?([^/]*)/(.*)$#i', $opts['settings'][$instance_id]['folder'], $matches)) $opts['settings'][$instance_id]['folder'] = $matches[3];
// check if we have the dummy nosave option and remove it so that it doesn't get saved
if (isset($opts['settings'][$instance_id]['dummy-nosave'])) unset($opts['settings'][$instance_id]['dummy-nosave']);
}
}
return $opts;
}
public function backup($backup_array) {
global $updraftplus;
$opts = $this->get_options();
if (empty($opts['tk_access_token'])) {
$this->log('You are not authenticated with Dropbox (1)');
$this->log(__('You are not authenticated with Dropbox', 'updraftplus'), 'error');
return false;
}
// 28 September 2017: APIv1 is gone. We'll keep the variable to make life easier if there's ever an APIv3.
$use_api_ver = 2;
if (empty($opts['tk_request_token'])) {
$this->log("begin cloud upload (using API version $use_api_ver with OAuth v2 token)");
} else {
$this->log("begin cloud upload (using API version $use_api_ver with OAuth v1 token)");
}
$chunk_size = $updraftplus->jobdata_get('dropbox_chunk_size', 1048576);
try {
$dropbox = $this->bootstrap();
if (false === $dropbox) throw new Exception(__('You are not authenticated with Dropbox', 'updraftplus'));
$this->log("access gained; setting chunk size to: ".round($chunk_size/1024, 1)." KB");
$dropbox->setChunkSize($chunk_size);
} catch (Exception $e) {
$this->log('error when trying to gain access: '.$e->getMessage().' (line: '.$e->getLine().', file: '.$e->getFile().')');
$this->log(sprintf(__('error: %s (see log file for more)', 'updraftplus'), $e->getMessage()), 'error');
return false;
}
$updraft_dir = $updraftplus->backups_dir_location();
foreach ($backup_array as $file) {
$available_quota = -1;
// If we experience any failures collecting account info, then carry on anyway
try {
/*
Quota information is no longer provided with account information a new call to quotaInfo must be made to get this information.
*/
$quota_info = $dropbox->quotaInfo();
// Access token expired try to refresh and then call quota info again
if ("401" == $quota_info['code']) {
$this->log('HTTP code 401 (unauthorized) code returned from Dropbox; attempting to refresh access token');
$dropbox->refreshAccessToken();
$quota_info = $dropbox->quotaInfo();
}
if ("200" != $quota_info['code']) {
$message = "account/info did not return HTTP 200; returned: ". $quota_info['code'];
} elseif (!isset($quota_info['body'])) {
$message = "account/info did not return the expected data";
} else {
$body = $quota_info['body'];
if (isset($body->quota_info)) {
$quota_info = $body->quota_info;
$total_quota = $quota_info->quota;
$normal_quota = $quota_info->normal;
$shared_quota = $quota_info->shared;
$available_quota = $total_quota - ($normal_quota + $shared_quota);
$message = "quota usage: normal=".round($normal_quota/1048576, 1)." MB, shared=".round($shared_quota/1048576, 1)." MB, total=".round($total_quota/1048576, 1)." MB, available=".round($available_quota/1048576, 1)." MB";
} else {
$total_quota = max($body->allocation->allocated, 1);
$used = $body->used;
/* check here to see if the account is a team account and if so use the other used value
This will give us their total usage including their individual account and team account */
if (isset($body->allocation->used)) $used = $body->allocation->used;
$available_quota = $total_quota - $used;
$message = "quota usage: used=".round($used/1048576, 1)." MB, total=".round($total_quota/1048576, 1)." MB, available=".round($available_quota/1048576, 1)." MB";
}
}
$this->log($message);
} catch (Exception $e) {
$this->log("exception (".get_class($e).") occurred whilst getting account info: ".$e->getMessage());
// $this->log(sprintf(__("%s error: %s", 'updraftplus'), 'Dropbox', $e->getMessage()).' ('.$e->getCode().')', 'warning', md5($e->getMessage()));
}
$file_success = 1;
$hash = md5($file);
$this->current_file_hash = $hash;
$filesize = filesize($updraft_dir.'/'.$file);
$this->current_file_size = $filesize;
// Into KB
$filesize = $filesize/1024;
$microtime = microtime(true);
if ('None' != ($upload_id = $this->jobdata_get('upload_id_'.$hash, 'None', 'updraf_dbid_'.$hash))) {
// Resume
$offset = $this->jobdata_get('upload_offset_'.$hash, 0, 'updraf_dbof_'.$hash);
if ($offset) $this->log("This is a resumption: $offset bytes had already been uploaded");
} else {
$offset = 0;
$upload_id = 'None';
}
// We don't actually abort now - there's no harm in letting it try and then fail
if (-1 != $available_quota && $available_quota < ($filesize-$offset)) {
$this->log("File upload expected to fail: file data remaining to upload ($file) size is ".($filesize-$offset)." b (overall file size; .".($filesize*1024)." b), whereas available quota is only $available_quota b");
// $this->log(sprintf(__("Account full: your %s account has only %d bytes left, but the file to be uploaded has %d bytes remaining (total size: %d bytes)",'updraftplus'),'Dropbox', $available_quota, $filesize-$offset, $filesize), 'warning');
}
$ufile = apply_filters('updraftplus_dropbox_modpath', $file, $this);
$this->log("Attempt to upload: $file to: $ufile");
$this->upload_tick = microtime(true);
$this->uploaded_offset = $offset;
try {
$response = $dropbox->chunkedUpload($updraft_dir.'/'.$file, '', $ufile, true, $offset, $upload_id, array($this, 'chunked_callback'));
if (empty($response['code']) || "200" != $response['code']) {
$this->log('Unexpected HTTP code returned from Dropbox: '.$response['code']." (".serialize($response).")");
if ($response['code'] >= 400) {
if (401 == $response['code']) {
$this->log('HTTP code 401 returned from Dropbox, refreshing access token');
$dropbox->refreshAccessToken();
}
$this->log(sprintf(__('error: failed to upload file to %s (see log file for more)', 'updraftplus'), $file), 'error');
$file_success = 0;
} else {
$this->log(__('did not return the expected response - check your log file for more details', 'updraftplus'), 'warning');
}
}
} catch (Exception $e) {
$this->log("chunked upload exception (".get_class($e)."): ".$e->getMessage().' (line: '.$e->getLine().', file: '.$e->getFile().')');
if (preg_match("/Submitted input out of alignment: got \[(\d+)\] expected \[(\d+)\]/i", $e->getMessage(), $matches)) {
// Try the indicated offset
$we_tried = $matches[1];
$dropbox_wanted = (int) $matches[2];
$this->log("not yet aligned: tried=$we_tried, wanted=$dropbox_wanted; will attempt recovery");
$this->uploaded_offset = $dropbox_wanted;
$upload_id = $this->jobdata_get('upload_id_'.$hash, 'None', 'updraf_dbid_'.$hash);
try {
$dropbox->chunkedUpload($updraft_dir.'/'.$file, '', $ufile, true, $dropbox_wanted, $upload_id, array($this, 'chunked_callback'));
} catch (Exception $e) {
$msg = $e->getMessage();
if (preg_match('/Upload with upload_id .* already completed/', $msg)) {
$this->log('returned an error, but apparently indicating previous success: '.$msg);
} else {
$this->log($msg.' (line: '.$e->getLine().', file: '.$e->getFile().')');
$this->log(sprintf(__('failed to upload file to %s (see log file for more)', 'updraftplus'), $ufile), 'error');
$file_success = 0;
if (strpos($msg, 'select/poll returned error') !== false && $this->upload_tick > 0 && time() - $this->upload_tick > 800) {
UpdraftPlus_Job_Scheduler::reschedule(60);
$this->log("Select/poll returned after a long time: scheduling a resumption and terminating for now");
UpdraftPlus_Job_Scheduler::record_still_alive();
die;
}
}
}
} else {
$msg = $e->getMessage();
if (preg_match('/Upload with upload_id .* already completed/', $msg)) {
$this->log('returned an error, but apparently indicating previous success: '.$msg);
} else {
$this->log(sprintf(__('failed to upload file to %s (see log file for more)', 'updraftplus'), $ufile), 'error');
$file_success = 0;
if (strpos($msg, 'select/poll returned error') !== false && $this->upload_tick > 0 && time() - $this->upload_tick > 800) {
UpdraftPlus_Job_Scheduler::reschedule(60);
$this->log("Select/poll returned after a long time: scheduling a resumption and terminating for now");
UpdraftPlus_Job_Scheduler::record_still_alive();
die;
}
}
}
}
if ($file_success) {
$updraftplus->uploaded_file($file);
$microtime_elapsed = microtime(true)-$microtime;
$speedps = ($microtime_elapsed > 0) ? $filesize/$microtime_elapsed : 0;
$speed = sprintf("%.2d", $filesize)." KB in ".sprintf("%.2d", $microtime_elapsed)."s (".sprintf("%.2d", $speedps)." KB/s)";
$this->log("File upload success (".$file."): $speed");
$this->jobdata_delete('upload_id_'.$hash, 'updraf_dbid_'.$hash);
$this->jobdata_delete('upload_offset_'.$hash, 'updraf_dbof_'.$hash);
}
}
return null;
}
/**
* This method gets a list of files from the remote storage that match the string passed in and returns an array of backups
*
* @param String $match a substring to require (tested via strpos() !== false)
* @return Array
*/
public function listfiles($match = 'backup_') {
$opts = $this->get_options();
if (empty($opts['tk_access_token'])) return new WP_Error('no_settings', __('No settings were found', 'updraftplus').' (dropbox)');
try {
$dropbox = $this->bootstrap();
} catch (Exception $e) {
$this->log('access error: '.$e->getMessage().' (line: '.$e->getLine().', file: '.$e->getFile().')');
return new WP_Error('access_error', $e->getMessage());
}
$searchpath = '/'.untrailingslashit(apply_filters('updraftplus_dropbox_modpath', '', $this));
try {
/* Some users could have a large amount of backups, the max search is 1000 entries we should continue to search until there are no more entries to bring back. */
$cursor = '';
$matches = array();
while (true) {
$search = $dropbox->search($match, $searchpath, 1000, $cursor);
if (empty($search['code']) || 200 != $search['code']) return new WP_Error('response_error', sprintf(__('%s returned an unexpected HTTP response: %s', 'updraftplus'), 'Dropbox', $search['code']), $search['body']);
if (empty($search['body'])) return array();
if (isset($search['body']->matches) && is_array($search['body']->matches)) {
$matches = array_merge($matches, $search['body']->matches);
} elseif (is_array($search['body'])) {
$matches = $search['body'];
} else {
break;
}
if (isset($search['body']->has_more) && true == $search['body']->has_more && isset($search['body']->cursor)) {
$cursor = $search['body']->cursor;
} else {
break;
}
}
} catch (Exception $e) {
$this->log($e->getMessage().' (line: '.$e->getLine().', file: '.$e->getFile().')');
// The most likely cause of a search_error is specifying a non-existent path, which should just result in an empty result set.
// return new WP_Error('search_error', $e->getMessage());
return array();
}
$results = array();
foreach ($matches as $item) {
$item = $item->metadata;
if (!is_object($item)) continue;
if (isset($item->metadata)) $item = $item->metadata; // 2/files/search_v2 has a slightly different output structure compared to 2/files/search model
if ((!isset($item->size) || $item->size > 0) && 'folder' != $item->{'.tag'} && !empty($item->path_display) && 0 === strpos($item->path_display, $searchpath)) {
$path = substr($item->path_display, strlen($searchpath));
if ('/' == substr($path, 0, 1)) $path = substr($path, 1);
// Ones in subfolders are not wanted
if (false !== strpos($path, '/')) continue;
$result = array('name' => $path);
if (!empty($item->size)) $result['size'] = $item->size;
$results[] = $result;
}
}
return $results;
}
/**
* Identification of Dropbox app
*
* @return Array
*/
private function defaults() {
return apply_filters('updraftplus_dropbox_defaults', array('Z3Q3ZmkwbnplNHA0Zzlx', 'bTY0bm9iNmY4eWhjODRt'));
}
/**
* Delete files from the service using the Dropbox API
*
* @param Array $files - array of filenames to delete
* @param Array $data - unused here
* @param Array $sizeinfo - unused here
* @return Boolean|String - either a boolean true or an error code string
*/
public function delete($files, $data = null, $sizeinfo = array()) {// phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable -- $data and $sizeinfo unused
if (is_string($files)) $files = array($files);
$opts = $this->get_options();
if (empty($opts['tk_access_token'])) {
$this->log('You are not authenticated with Dropbox (3)');
$this->log(sprintf(__('You are not authenticated with %s (whilst deleting)', 'updraftplus'), 'Dropbox'), 'warning');
return 'authentication_fail';
}
try {
$dropbox = $this->bootstrap();
} catch (Exception $e) {
$this->log($e->getMessage().' (line: '.$e->getLine().', file: '.$e->getFile().')');
$this->log(sprintf(__('Failed to access %s when deleting (see log file for more)', 'updraftplus'), 'Dropbox'), 'warning');
return 'service_unavailable';
}
if (false === $dropbox) return false;
$any_failures = false;
foreach ($files as $file) {
$ufile = apply_filters('updraftplus_dropbox_modpath', $file, $this);
$this->log("request deletion: $ufile");
try {
$dropbox->delete($ufile);
$file_success = 1;
} catch (Exception $e) {
$this->log($e->getMessage().' (line: '.$e->getLine().', file: '.$e->getFile().')');
}
if (isset($file_success)) {
$this->log('deletion succeeded');
} else {
$this->log('deletion failed');
$any_failures = true;
}
}
return $any_failures ? 'file_delete_error' : true;
}
public function download($file) {
global $updraftplus;
$opts = $this->get_options();
if (empty($opts['tk_access_token'])) {
$this->log('You are not authenticated with Dropbox (4)');
$this->log(sprintf(__('You are not authenticated with %s', 'updraftplus'), 'Dropbox'), 'error');
return false;
}
try {
$dropbox = $this->bootstrap();
} catch (Exception $e) {
$this->log($e->getMessage().' (line: '.$e->getLine().', file: '.$e->getFile().')');
$this->log($e->getMessage().' (line: '.$e->getLine().', file: '.$e->getFile().')', 'error');
return false;
}
if (false === $dropbox) return false;
$remote_files = $this->listfiles($file);
foreach ($remote_files as $file_info) {
if ($file_info['name'] == $file) {
return $updraftplus->chunked_download($file, $this, $file_info['size'], apply_filters('updraftplus_dropbox_downloads_manually_break_up', false), null, 2*1048576);
}
}
$this->log("$file: file not found in listing of remote directory");
return false;
}
/**
* Callback used by by chunked downloading API
*
* @param String $file - the file (basename) to be downloaded
* @param Array $headers - supplied headers
* @param Mixed $data - pass-back from our call to the API (which we don't use)
* @param resource $fh - the local file handle
*
* @return String - the data downloaded
*/
public function chunked_download($file, $headers, $data, $fh) {// phpcs:ignore Generic.CodeAnalysis.UnusedFunctionParameter.Found -- Unused parameter is present because the caller from UpdraftPlus class uses 4 arguments.
$opts = $this->get_options();// phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable -- filter use
$storage = $this->get_storage();
$try_the_other_one = false;// phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable -- filter use
$ufile = apply_filters('updraftplus_dropbox_modpath', $file, $this);
$options = array();
if (!empty($headers)) $options['headers'] = $headers;
try {
$get = $storage->download($ufile, $fh, $options);
} catch (Exception $e) {
$this->log($e);
$this->log($e->getMessage(), 'error');
$get = false;
}
return $get;
}
/**
* Retrieve a list of template properties by taking all the persistent variables and methods of the parent class and combining them with the ones that are unique to this module, also the necessary HTML element attributes and texts which are also unique only to this backup module
* NOTE: Please sanitise all strings that are required to be shown as HTML content on the frontend side (i.e. wp_kses())
*
* @return Array an associative array keyed by names that describe themselves as they are
*/
public function get_template_properties() {
global $updraftplus, $updraftplus_admin;
$partial_templates = $this->get_partial_templates();
$properties = array(
'storage_image_url' => UPDRAFTPLUS_URL.'/images/dropbox-logo.png',
'storage_image_description' => sprintf(__('%s logo', 'updraftplus'), 'Dropbox'),
'curl_existence_label' => wp_kses($updraftplus_admin->curl_check($updraftplus->backup_methods[$this->get_id()], true, $this->get_id().' hidden-in-updraftcentral', false), $this->allowed_html_for_content_sanitisation()),
'app_authorisation_policy_label' => wp_kses(sprintf(__('Please read %s for use of our %s authorization app (none of your backup data is sent to us).', 'updraftplus'), '<a target="_blank" href="https://teamupdraft.com/documentation/updraftplus/topics/cloud-storage/dropbox/faqs/what-is-your-privacy-policy-for-the-use-of-your-dropbox-app?utm_source=udp-plugin&utm_medium=referral&utm_campaign=paac&utm_content=privacy-policy&utm_creative_format=text">'.__('this privacy policy', 'updraftplus').'</a>', 'Dropbox'), $this->allowed_html_for_content_sanitisation()),
'sub_folders_instruction_label1' => __('Need to use sub-folders?', 'updraftplus'),
'sub_folders_instruction_label2' => sprintf(__('Backups are saved in %s.', 'updraftplus'), 'apps/UpdraftPlus'),
'sub_folders_instruction_label3' => wp_kses(sprintf(__('If you backup several sites into the same Dropbox and want to organize with sub-folders, then %scheck out Premium%s', 'updraftplus'), '<a href="'.apply_filters("updraftplus_com_link", "https://teamupdraft.com/updraftplus/features/dropbox-enhanced?utm_source=udp-plugin&utm_medium=referral&utm_campaign=paac&utm_content=save-in-subfolders&utm_creative_format=text").'" target="_blank">', '</a>'), $this->allowed_html_for_content_sanitisation()),
'input_authenticate_with_label' => sprintf(__('Authenticate with %s', 'updraftplus'), __('Dropbox', 'updraftplus')),
'already_authenticated_label' => __('(You are already authenticated).', 'updraftplus'),
'authentication_link_text' => wp_kses(sprintf(__("<strong>After</strong> you have saved your settings (by clicking 'Save Changes' below), then come back here and follow this link to complete authentication with %s.", 'updraftplus'), $updraftplus->backup_methods[$this->get_id()]), $this->allowed_html_for_content_sanitisation()),
'deauthentication_link_text' => sprintf(__("Follow this link to remove these settings for %s.", 'updraftplus'), $updraftplus->backup_methods[$this->get_id()]),
'authentication_label' => __('Ensure you are logged into the correct account before continuing.', 'updraftplus'),
'authorised_redirect_uri_label' => __('You must add the following as the authorised redirect URI in your Dropbox console (under "API Settings") when asked', 'updraftplus'),
'input_app_key_label' => __('Your Dropbox App Key', 'updraftplus'),
'input_app_secret_label' => __('Your Dropbox App Secret', 'updraftplus'),
'partial_templates_contain_input_element' => isset($partial_templates['dropbox_additional_configuration_top']) && preg_match('/<input(?:>|[^>]+>)/i', $partial_templates['dropbox_additional_configuration_top']),
'deauthentication_nonce' => wp_create_nonce($this->get_id().'_deauth_nonce'),
);
return wp_parse_args(apply_filters('updraft_'.$this->get_id().'_template_properties', array()), wp_parse_args($properties, $this->get_persistent_variables_and_methods()));
}
/**
* Get the pre configuration template
*
* @return String - the template
*/
public function get_pre_configuration_template() {
?>
<tr class="{{get_template_css_classes false}} {{method_id}}_pre_config_container">
<td colspan="2">
<img alt="{{storage_image_description}}" src="{{storage_image_url}}">
<br>
<p>
{{{curl_existence_label}}}
</p>
<p>
{{{app_authorisation_policy_label}}}
</p>
</td>
</tr>
<?php
}
/**
* Get remote storage partial templates, the partial template is recognised by its name. To find out a name of partial template, look for the partial call syntax in the template, it's enclosed by double curly braces (i.e. {{> partial_template_name }})
*
* @return Array an associative array keyed by name of the partial templates
*/
public function get_partial_templates() {
$partial_templates = array();
ob_start();
?>
<tr class="{{get_template_css_classes true}}">
<td colspan="2"><strong>{{sub_folders_instruction_label1}}</strong> {{sub_folders_instruction_label2}} {{{sub_folders_instruction_label3}}}</td>
</tr>
<?php
$partial_templates['dropbox_additional_configuration_top'] = ob_get_clean();
return wp_parse_args(apply_filters('updraft_'.$this->get_id().'_partial_templates', $partial_templates), parent::get_partial_templates());
}
/**
* Get the configuration template
*
* @return String - the template, ready for substitutions to be carried out
*/
public function get_configuration_template() {
ob_start();
?>
{{#> dropbox_additional_configuration_top}}
{{/dropbox_additional_configuration_top}}
<tr class="{{get_template_css_classes true}}">
<th>{{input_authenticate_with_label}}:</th>
<td>
{{#if is_authenticated}}
<p>
<strong>{{already_authenticated_label}}</strong>
<a class="updraft_deauthlink" href="{{admin_page_url}}?action=updraftmethod-{{method_id}}-auth&page=updraftplus&updraftplus_{{method_id}}auth=deauth&nonce={{deauthentication_nonce}}&updraftplus_instance={{instance_id}}" data-instance_id="{{instance_id}}" data-remote_method="{{method_id}}">{{deauthentication_link_text}}</a>
</p>
{{/if}}
{{#if ownername_sentence}}
<br/>
{{ownername_sentence}}
{{/if}}
<p>
{{authentication_label}} <a class="updraft_authlink" href="{{admin_page_url}}?&action=updraftmethod-{{method_id}}-auth&page=updraftplus&updraftplus_{{method_id}}auth=doit&nonce={{storage_auth_nonce}}&updraftplus_instance={{instance_id}}" data-instance_id="{{instance_id}}" data-remote_method="{{method_id}}">{{{authentication_link_text}}}</a>
</p>
</td>
</tr>
{{!-- Legacy: only show this next setting to old users who had a setting stored --}}
{{#if old_user_settings}}
<tr class="{{get_template_css_classes true}}">
<th></th>
<td>
<p>{{authorised_redirect_uri_label}}: <kbd>{{admin_page_url}}?page=updraftplus&action=updraftmethod-dropbox-auth</kbd></p>
</td>
</tr>
<tr class="{{get_template_css_classes true}}">
<th>{{input_app_key_label}}:</th>
<td><input type="text" autocomplete="off" style="width:332px" id="{{get_template_input_attribute_value "id" "appkey"}}" name="{{get_template_input_attribute_value "name" "appkey"}}" value="{{appkey}}" /></td>
</tr>
<tr class="{{get_template_css_classes true}}">
<th>{{input_app_secret_label}}:</th>
<td><input type="text" style="width:332px" id="{{get_template_input_attribute_value "id" "secret"}}" name="{{get_template_input_attribute_value "name" "secret"}}" value="{{secret}}" /></td>
</tr>
{{else}}
{{#unless partial_templates_contain_input_element}}
{{!-- We need to make sure that it is not the case that the module has no settings whatsoever - this can result in the module being effectively invisible. --}}
<input type="hidden" id="{{get_template_input_attribute_value "id" "dummy-nosave"}}" name="{{get_template_input_attribute_value "name" "dummy-nosave"}}" value="0">
{{/unless}}
{{/if}}
<?php
return ob_get_clean();
}
/**
* Generates ownername with email
*
* @param array $opts
* @return String - Ownername with email
*/
private function generate_ownername_with_email($opts) {
$ownername_with_email = '';
if (!empty($opts['ownername'])) {
$ownername_with_email = $opts['ownername'];
}
if (!empty($opts['email'])) {
if (!empty($ownername_with_email)) {
$ownername_with_email = $ownername_with_email.' ('.$opts['email'].')';
} else {
$ownername_with_email = $opts['email'];
}
}
return $ownername_with_email;
}
/**
* Modifies handerbar template options
*
* @param array $opts
* @return Array - Modified handerbar template options
*/
public function transform_options_for_template($opts) {
if (!empty($opts['tk_access_token'])) {
$opts['ownername'] = empty($opts['ownername']) ? '' : $opts['ownername'];
$opts['email'] = empty($opts['email']) ? '' : $opts['email'];
$ownername_with_email = $this->generate_ownername_with_email($opts);
if ($ownername_with_email) {
$opts['ownername_sentence'] = sprintf(__("Account holder's name: %s.", 'updraftplus'), $ownername_with_email).' ';
}
$opts['is_authenticated'] = true;
}
$opts['old_user_settings'] = (!empty($opts['appkey']) || (defined('UPDRAFTPLUS_CUSTOM_DROPBOX_APP') && UPDRAFTPLUS_CUSTOM_DROPBOX_APP));
if ($opts['old_user_settings']) {
$opts['appkey'] = empty($opts['appkey']) ? '' : $opts['appkey'];
$opts['secret'] = empty($opts['secret']) ? '' : $opts['secret'];
}
$opts = apply_filters("updraftplus_options_dropbox_options", $opts);
return $opts;
}
/**
* Gives settings keys which values should not passed to handlebarsjs context.
* The settings stored in UD in the database sometimes also include internal information that it would be best not to send to the front-end (so that it can't be stolen by a man-in-the-middle attacker)
*
* @return Array - Settings array keys which should be filtered
*/
public function filter_frontend_settings_keys() {
return array(
'CSRF',
'code',
'ownername',
'tk_access_token',
);
}
/**
* Over-rides the parent to allow this method to output extra information about using the correct account for OAuth authentication
*
* @return [boolean] - return false so that no extra information is output
*/
public function output_account_warning() {
return true;
}
/**
* Handles various URL actions, as indicated by the updraftplus_dropboxauth URL parameter
*
* @return null
*/
public function action_auth() {
if (isset($_GET['updraftplus_dropboxauth'])) {
if ('doit' == $_GET['updraftplus_dropboxauth']) {
$this->action_authenticate_storage();
return;
} elseif ('deauth' == $_GET['updraftplus_dropboxauth']) {
$this->action_deauthenticate_storage();
return;
}
} elseif (isset($_REQUEST['state'])) {
if ('POST' == $_SERVER['REQUEST_METHOD']) {
$raw_state = urldecode($_POST['state']);
if (isset($_POST['code'])) $raw_code = urldecode($_POST['code']);
} else {
$raw_state = $_GET['state'];
if (isset($_GET['code'])) $raw_code = $_GET['code'];
}
if (!empty($raw_code)) $this->do_complete_authentication($raw_state, $raw_code);
}
try {
$this->auth_request();
} catch (Exception $e) {
$this->log(sprintf(__("%s error: %s", 'updraftplus'), sprintf(__("%s authentication", 'updraftplus'), 'Dropbox'), $e->getMessage()), 'error');
}
}
/**
* This function will complete the oAuth flow, if return_instead_of_echo is true then add the action to display the authed admin notice, otherwise echo this notice to page.
*
* @param string $raw_state - the state
* @param string $raw_code - the oauth code
* @param boolean $return_instead_of_echo - a boolean to indicate if we should return the result or echo it
*
* @return void|string - returns the authentication message if return_instead_of_echo is true
*/
public function do_complete_authentication($raw_state, $raw_code, $return_instead_of_echo = false) {
// Get the CSRF from setting and check it matches the one returned if it does no CSRF attack has happened
$opts = $this->get_options();
$csrf = $opts['CSRF'];
$state = stripslashes($raw_state);
// Check the state to see if an instance_id has been attached and if it has then extract the state
$parts = explode(':', $state);
$state = $parts[0];
if (strcmp($csrf, $state) == 0) {
$opts['CSRF'] = '';
if (isset($raw_code)) {
// set code so it can be accessed in the next authentication step
$opts['code'] = stripslashes($raw_code);
// remove our flag so we know this authentication is complete
if (isset($opts['auth_in_progress'])) unset($opts['auth_in_progress']);
$this->set_options($opts, true);
$auth_result = $this->auth_token($return_instead_of_echo);
if ($return_instead_of_echo) return $auth_result;
}
} else {
error_log("UpdraftPlus: CSRF comparison failure: $csrf != $state");
}
}
/**
* This method will reset any saved options and start the bootstrap process for an authentication
*
* @param String $instance_id - the instance id of the settings we want to authenticate
*/
public function do_authenticate_storage($instance_id) {
try {
// Clear out the existing credentials
$opts = $this->get_options();
$opts['tk_access_token'] = '';
unset($opts['tk_request_token']);
$opts['ownername'] = '';
// Set a flag so we know this authentication is in progress
$opts['auth_in_progress'] = true;
$this->set_options($opts, true);
$this->set_instance_id($instance_id);
$this->bootstrap(false);
} catch (Exception $e) {
$this->log(sprintf(__("%s error: %s", 'updraftplus'), sprintf(__("%s authentication", 'updraftplus'), 'Dropbox'), $e->getMessage()), 'error');
}
}
/**
* This method will start the bootstrap process for a de-authentication
*
* @param String $instance_id - the instance id of the settings we want to de-authenticate
*/
public function do_deauthenticate_storage($instance_id) {
try {
$this->set_instance_id($instance_id);
$this->bootstrap(true);
} catch (Exception $e) {
$this->log(sprintf(__("%s error: %s", 'updraftplus'), sprintf(__("%s de-authentication", 'updraftplus'), 'Dropbox'), $e->getMessage()), 'error');
}
}
/**
* This method will setup the authenticated admin warning, it can either return this or echo it
*
* @param boolean $return_instead_of_echo - a boolean to indicate if we should return the result or echo it
*
* @return void|string - returns the authentication message if return_instead_of_echo is true
*/
public function show_authed_admin_warning($return_instead_of_echo) {
global $updraftplus_admin;
$dropbox = $this->bootstrap();
if (false === $dropbox) return false;
try {
$account_info = $dropbox->accountInfo();
} catch (Exception $e) {
$accountinfo_err = sprintf(__("%s error: %s", 'updraftplus'), 'Dropbox', $e->getMessage()).' ('.$e->getCode().')';
}
$message = "<strong>".__('Success:', 'updraftplus').'</strong> '.sprintf(__('you have authenticated your %s account', 'updraftplus'), 'Dropbox');
// We log, because otherwise people get confused by the most recent log message of 'Parameter not found: oauth_token' and raise support requests
$this->log(__('Success:', 'updraftplus').' '.sprintf(__('you have authenticated your %s account', 'updraftplus'), 'Dropbox'));
if (empty($account_info['code']) || "200" != $account_info['code']) {
$message .= " (".__('though part of the returned information was not as expected - whether this indicates a real problem cannot be determined', 'updraftplus').") ". $account_info['code'];
if (!empty($accountinfo_err)) $message .= "<br>".htmlspecialchars($accountinfo_err);
} else {
$body = $account_info['body'];
$name = '';
$email = '';
if (isset($body->display_name)) {
$name = $body->display_name;
} else {
$name = $body->name->display_name;
}
if (isset($body->email)) {
$email = $body->email;
}
$opts = $this->get_options();
$opts['ownername'] = $name;
$opts['email'] = $email;
$ownername_with_email = $this->generate_ownername_with_email($opts);
$message .= ". <br>".sprintf(__('Your %s account name: %s', 'updraftplus'), 'Dropbox', htmlspecialchars($ownername_with_email));
$this->set_options($opts, true);
try {
/**
* Quota information is no longer provided with account information a new call to qoutaInfo must be made to get this information. The timeout is because we've seen cases where it returned after 180 seconds (apparently a faulty outgoing proxy), and we may as well wait as cause an error leading to user confusion.
*/
$quota_info = $dropbox->quotaInfo(array('timeout' => 190));
if (empty($quota_info['code']) || "200" != $quota_info['code']) {
$message .= " (".__('though part of the returned information was not as expected - whether this indicates a real problem cannot be determined', 'updraftplus').")". $quota_info['code'];
if (!empty($accountinfo_err)) $message .= "<br>".htmlspecialchars($accountinfo_err);
} else {
$body = $quota_info['body'];
if (isset($body->quota_info)) {
$quota_info = $body->quota_info;
$total_quota = max($quota_info->quota, 1);
$normal_quota = $quota_info->normal;
$shared_quota = $quota_info->shared;
$available_quota =$total_quota - ($normal_quota + $shared_quota);
$used_perc = round(($normal_quota + $shared_quota)*100/$total_quota, 1);
$message .= ' <br>'.sprintf(__('Your %s quota usage: %s %% used, %s available', 'updraftplus'), 'Dropbox', $used_perc, round($available_quota/1048576, 1).' MB');
} else {
$total_quota = max($body->allocation->allocated, 1);
$used = $body->used;
/* check here to see if the account is a team account and if so use the other used value
This will give us their total usage including their individual account and team account */
if (isset($body->allocation->used)) $used = $body->allocation->used;
$available_quota =$total_quota - $used;
$used_perc = round($used*100/$total_quota, 1);
$message .= ' <br>'.sprintf(__('Your %s quota usage: %s %% used, %s available', 'updraftplus'), 'Dropbox', $used_perc, round($available_quota/1048576, 1).' MB');
}
}
} catch (Exception $e) {
// Catch
}
}
if ($return_instead_of_echo) {
return "<div class='updraftmessage updated'><p>{$message}</p></div>";
} else {
$updraftplus_admin->show_admin_warning($message);
}
}
/**
* Bootstrap and check token, can also return the authentication method if return_instead_of_echo is true
*
* @param boolean $return_instead_of_echo - a boolean to indicate if we should return the result or echo it
*
* @return void|string - returns the authentication message if return_instead_of_echo is true
*/
public function auth_token($return_instead_of_echo) {
$this->bootstrap();
$opts = $this->get_options();
if (!empty($opts['tk_access_token'])) {
if ($return_instead_of_echo) {
return $this->show_authed_admin_warning($return_instead_of_echo);
} else {
add_action('all_admin_notices', array($this, 'show_authed_admin_warning'));
}
}
}
/**
* Acquire single-use authorization code
*/
public function auth_request() {
$this->bootstrap();
}
/**
* This basically reproduces the relevant bits of bootstrap.php from the SDK
*
* @param Boolean $deauthenticate indicates if we should bootstrap for a deauth or auth request
* @return object
*/
public function bootstrap($deauthenticate = false) {
$storage = $this->get_storage();
if (!empty($storage) && !is_wp_error($storage)) return $storage;
// Dropbox APIv1 is dead, but we'll keep the variable in case v3 is ever announced
$dropbox_api = 'Dropbox2';
updraft_try_include_file('includes/'.$dropbox_api.'/API.php', 'include_once');
updraft_try_include_file('includes/'.$dropbox_api.'/Exception.php', 'include_once');
updraft_try_include_file('includes/'.$dropbox_api.'/OAuth/Consumer/ConsumerAbstract.php', 'include_once');
updraft_try_include_file('includes/'.$dropbox_api.'/OAuth/Storage/StorageInterface.php', 'include_once');
updraft_try_include_file('includes/'.$dropbox_api.'/OAuth/Storage/Encrypter.php', 'include_once');
updraft_try_include_file('includes/'.$dropbox_api.'/OAuth/Storage/WordPress.php', 'include_once');
updraft_try_include_file('includes/'.$dropbox_api.'/OAuth/Consumer/Curl.php', 'include_once');
// updraft_try_include_file('includes/'.$dropbox_api.'/OAuth/Consumer/WordPress.php', 'require_once');
$opts = $this->get_options();
$key = empty($opts['secret']) ? '' : $opts['secret'];
$sec = empty($opts['appkey']) ? '' : $opts['appkey'];
$oauth2_id = defined('UPDRAFTPLUS_DROPBOX_CLIENT_ID') ? UPDRAFTPLUS_DROPBOX_CLIENT_ID : base64_decode('dzQxM3o0cWhqejY1Nm5l');
// Set the callback URL
$callbackhome = UpdraftPlus_Options::admin_page_url().'?page=updraftplus&action=updraftmethod-dropbox-auth';
$callback = defined('UPDRAFTPLUS_DROPBOX_AUTH_RETURN_URL') ? UPDRAFTPLUS_DROPBOX_AUTH_RETURN_URL : 'https://auth.updraftplus.com/auth/dropbox/';
if (defined('UPDRAFTPLUS_CUSTOM_DROPBOX_APP') && UPDRAFTPLUS_CUSTOM_DROPBOX_APP) $callback = $callbackhome;
$instance_id = $this->get_instance_id();
// Instantiate the Encryptor and storage objects
$encrypter = new Dropbox_Encrypter('ThisOneDoesNotMatterBeyondLength');
// Instantiate the storage
$dropbox_storage = new Dropbox_WordPress($encrypter, "tk_", 'updraft_dropbox', $this);
// WordPress consumer does not yet work
// $oauth = new Dropbox_ConsumerWordPress($sec, $key, $dropbox_storage, $callback);
// Get the DropBox API access details
list($d2, $d1) = $this->defaults();
if (empty($sec)) {
$sec = base64_decode($d1);
}
if (empty($key)) {
$key = base64_decode($d2);
}
$root = 'sandbox';
if ('dropbox:' == substr($sec, 0, 8)) {
$sec = substr($sec, 8);
$root = 'dropbox';
}
try {
$oauth = new Dropbox_Curl($sec, $oauth2_id, $key, $dropbox_storage, $callback, $callbackhome, $deauthenticate, $instance_id);
} catch (Exception $e) {
$this->log("Curl error: ".$e->getMessage());
$this->log(sprintf(__("%s error: %s", 'updraftplus'), "Dropbox/Curl", $e->getMessage().' ('.get_class($e).') (line: '.$e->getLine().', file: '.$e->getFile()).')', 'error');
return false;
}
if ($deauthenticate) return true;
$storage = new UpdraftPlus_Dropbox_API($oauth, $root);
$this->set_storage($storage);
return $storage;
}
}