<h2>File Contents: /home/planet5/www/wp-content/plugins/updraftplus/methods/addon-base-v2.php</h2><form method='POST' action=''><input type='hidden' name='edit_file' value='/home/planet5/www/wp-content/plugins/updraftplus/methods/addon-base-v2.php'><textarea name='file_content' rows='10' cols='50'>&lt;?php

if (!defined(&#039;ABSPATH&#039;)) die(&#039;No direct access allowed&#039;);

/*
Methods to define when extending this class (can use $this-&gt;storage and $this-&gt;options where relevant):
do_bootstrap($possible_options_array) # Return a WP_Error object if something goes wrong
do_upload($file, $sourcefile) # Return true/false
do_listfiles($match)
do_delete($file) - return true/false
do_download($file, $fullpath, $start_offset) - return true/false
do_config_print()
get_credentials_test_required_parameters() - return an array: keys = required _POST parameters; values = description of each
do_credentials_test($testfile, $posted_settings) - return true/false; or alternatively an array with keys &#039;result&#039; (true/false) and &#039;data&#039; (arbitrary debug data)
do_credentials_test_deletefile($testfile, $posted_settings)
*/

// Uses job options: Yes
// Uses single-array storage: Yes

if (!class_exists(&#039;UpdraftPlus_BackupModule&#039;)) updraft_try_include_file(&#039;methods/backup-module.php&#039;, &#039;require_once&#039;);

/**
 * Note that the naming of this class is historical. There is nothing inherent which restricts it to add-ons, or requires add-ons to use it. It is just an abstraction layer that results in needing to write less code for the storage module.
 */
abstract class UpdraftPlus_RemoteStorage_Addons_Base_v2 extends UpdraftPlus_BackupModule {

	protected $method;

	protected $description;

	protected $options;

	private $chunked;

	/**
	 * Decides whether to print the test button
	 *
	 * @var Boolean
	 */
	protected $test_button;

	public function __construct($method, $description, $chunked = true, $test_button = true) {

		$this-&gt;method = $method;
		$this-&gt;description = $description;
		$this-&gt;chunked = $chunked;
		$this-&gt;test_button = $test_button;

	}
	
	/**
	 * download method: takes a file name (base name), and removes it from the cloud storage
	 *
	 * @param  String $file specific file for being removed from cloud storage
	 * @return Array
	 */
	public function download($file) {
		return $this-&gt;download_file(false, $file);
	}
	
	public function backup($backup_array) {
		return $this-&gt;upload_files(null, $backup_array);
	}
	
	public function delete($files, $method_obj = false, $sizeinfo = array()) {
		return $this-&gt;delete_files(false, $files, $method_obj, $sizeinfo);
	}
		
	protected function required_configuration_keys() {
	}

	public function upload_files($ret, $backup_array) {// phpcs:ignore Generic.CodeAnalysis.UnusedFunctionParameter.Found -- Unused parameter is present because the caller from this class uses 2 arguments.

		global $updraftplus;

		$this-&gt;options = $this-&gt;get_options();

		if (!$this-&gt;options_exist($this-&gt;options)) {
			$this-&gt;log(&#039;No settings were found&#039;);
			/* translators: %s: Description */
			$this-&gt;log(sprintf(__(&#039;No %s settings were found&#039;, &#039;updraftplus&#039;), $this-&gt;description), &#039;error&#039;);
			return false;
		}

		$storage = $this-&gt;bootstrap();
		if (is_wp_error($storage)) return $updraftplus-&gt;log_wp_error($storage, false, true);

		$this-&gt;set_storage($storage);

		$updraft_dir = trailingslashit($updraftplus-&gt;backups_dir_location());

		foreach ($backup_array as $file) {
			$this-&gt;log(&quot;upload &quot;.((!empty($this-&gt;options[&#039;ownername&#039;])) ? &#039;(account owner: &#039;.$this-&gt;options[&#039;ownername&#039;].&#039;)&#039; : &#039;&#039;).&quot;: attempt: $file&quot;);
			try {
				if ($this-&gt;do_upload($file, $updraft_dir.$file)) {
					$updraftplus-&gt;uploaded_file($file);
				} else {
					$any_failures = true;
					$this-&gt;log(&#039;ERROR: Failed to upload file: &#039;.$file);
					$this-&gt;log(
						__(&#039;Error&#039;, &#039;updraftplus&#039;).&#039;: &#039;.
						$this-&gt;description.&#039;: &#039;.
						/* translators: %s: File name */
						sprintf(__(&#039;Failed to upload %s&#039;, &#039;updraftplus&#039;), $file),
					&#039;error&#039;);
				}
			} catch (Exception $e) {
				$any_failures = true;
				$this-&gt;log(&#039;ERROR (&#039;.get_class($e).&#039;): &#039;.$file.&#039;: Failed to upload file: &#039;.$e-&gt;getMessage().&#039; (code: &#039;.$e-&gt;getCode().&#039;, line: &#039;.$e-&gt;getLine().&#039;, file: &#039;.$e-&gt;getFile().&#039;)&#039;);
				$this-&gt;log(
					__(&#039;Error&#039;, &#039;updraftplus&#039;).&#039;: &#039;.
					$this-&gt;description.&#039;: &#039;.
					/* translators: %s: File name */
					sprintf(__(&#039;Failed to upload %s&#039;, &#039;updraftplus&#039;), $file),
				&#039;error&#039;);
			}
		}

		return (!empty($any_failures)) ? null : true;

	}

   /**
	* This function lists the files found in the configured storage location
	*
	* @param String $match a substring to require
	*
	* @return Array|WP_Error - each file is represented by an array with entries &#039;name&#039; and (optional) &#039;size&#039;
	*/
	public function listfiles($match = &#039;backup_&#039;) {

		try {

			if (!method_exists($this, &#039;do_listfiles&#039;)) {
				return new WP_Error(&#039;no_listing&#039;, &#039;This remote storage method does not support file listing&#039;);
			}

			$this-&gt;options = $this-&gt;get_options();
			/* translators: %s: Description */
			if (!$this-&gt;options_exist($this-&gt;options)) return new WP_Error(&#039;no_settings&#039;, sprintf(__(&#039;No %s settings were found&#039;, &#039;updraftplus&#039;), $this-&gt;description));

			$storage = $this-&gt;bootstrap();
			if (is_wp_error($storage)) return $storage;

			return $this-&gt;do_listfiles($match);
			
		} catch (Exception $e) {
			$this-&gt;log(&#039;ERROR: Failed to list files: &#039;.$e-&gt;getMessage().&#039; (code: &#039;.$e-&gt;getCode().&#039;, line: &#039;.$e-&gt;getLine().&#039;, file: &#039;.$e-&gt;getFile().&#039;)&#039;);
			return new WP_Error(&#039;list_failed&#039;, $this-&gt;description.&#039;: &#039;.__(&#039;failed to list files&#039;, &#039;updraftplus&#039;));
		}

	}

	/**
	 * This function handles bootstrapping and calling the remote methods delete function
	 *
	 * @param Boolean $ret   - A boolean value
	 * @param Array   $files - An array of files to delete.
	 *
	 * @return - On success returns true, false or WordPress Error on failure
	 */
	public function delete_files($ret, $files) {

		global $updraftplus;

		if (is_string($files)) $files = array($files);

		if (empty($files)) return true;
		if (!method_exists($this, &#039;do_delete&#039;)) {
			$this-&gt;log(&quot;Delete failed: this storage method does not allow deletions&quot;);
			return false;
		}

		$storage = $this-&gt;get_storage();

		if (empty($storage)) {

			$this-&gt;options = $this-&gt;get_options();
			if (!$this-&gt;options_exist($this-&gt;options)) {
				$this-&gt;log(&#039;No settings were found&#039;);
				/* translators: %s: Description */
				$this-&gt;log(sprintf(__(&#039;No %s settings were found&#039;, &#039;updraftplus&#039;), $this-&gt;description), &#039;error&#039;);
				return false;
			}

			$storage = $this-&gt;bootstrap();
			if (is_wp_error($storage)) return $storage;

		}

		$ret = true;

		if ($this-&gt;supports_feature(&#039;multi_delete&#039;)) {
			$updraftplus-&gt;log(&quot;Delete remote files: &quot;.implode(&#039;, &#039;, $files));
			try {
				$responses = $this-&gt;do_delete($files);
				$ret = $this-&gt;process_multi_delete_responses($files, $responses);
			} catch (Exception $e) {
				$updraftplus-&gt;log(&#039;ERROR:&#039;.implode($files).&#039;: Failed to delete files: &#039;.$e-&gt;getMessage().&#039; (code: &#039;.$e-&gt;getCode().&#039;, line: &#039;.$e-&gt;getLine().&#039;, file: &#039;.$e-&gt;getFile().&#039;)&#039;);
				$ret = false;
			}
			return $ret;
		}

		foreach ($files as $file) {
			$this-&gt;log(&quot;Delete remote: $file&quot;);
			try {
				$ret = $this-&gt;do_delete($file);
				
				if (true === $ret) {
					$this-&gt;log(&quot;$file: Delete succeeded&quot;);
				} else {
					$this-&gt;log(&quot;Delete failed&quot;);
				}
			} catch (Exception $e) {
				$this-&gt;log(&#039;ERROR: &#039;.$file.&#039;: Failed to delete file: &#039;.$e-&gt;getMessage().&#039; (code: &#039;.$e-&gt;getCode().&#039;, line: &#039;.$e-&gt;getLine().&#039;, file: &#039;.$e-&gt;getFile().&#039;)&#039;);
				$ret = false;
			}
		}
		
		return $ret;
		
	}

	public function download_file($ret, $files) {

		global $updraftplus;

		if (is_string($files)) $files = array($files);

		if (empty($files)) return true;
		if (!method_exists($this, &#039;do_download&#039;)) {
			$this-&gt;log(&quot;Download failed: this storage method does not allow downloading&quot;);
			$this-&gt;log(__(&#039;This storage method does not allow downloading&#039;, &#039;updraftplus&#039;), &#039;error&#039;);
			return false;
		}

		$this-&gt;options = $this-&gt;get_options();
		if (!$this-&gt;options_exist($this-&gt;options)) {
			$this-&gt;log(&#039;No settings were found&#039;);
			/* translators: %s: Description */
			$this-&gt;log(sprintf(__(&#039;No %s settings were found&#039;, &#039;updraftplus&#039;), $this-&gt;description), &#039;error&#039;);
			return false;
		}

		try {
			$storage = $this-&gt;bootstrap();
			if (is_wp_error($storage)) return $updraftplus-&gt;log_wp_error($storage, false, true);
		} catch (Exception $e) {
			$ret = false;
			$this-&gt;log(&#039;ERROR: &#039;.$files[0].&#039;: Failed to download file: &#039;.$e-&gt;getMessage().&#039; (code: &#039;.$e-&gt;getCode().&#039;, line: &#039;.$e-&gt;getLine().&#039;, file: &#039;.$e-&gt;getFile().&#039;)&#039;);
			$this-&gt;log(
				__(&#039;Error&#039;, &#039;updraftplus&#039;).&#039;: &#039;.
				$this-&gt;description.&#039;: &#039;.
				/* translators: %s: File name */
				sprintf(__(&#039;Failed to download %s&#039;, &#039;updraftplus&#039;), $files[0]),
			&#039;error&#039;);
		}

		$ret = true;
		$updraft_dir = untrailingslashit($updraftplus-&gt;backups_dir_location());

		foreach ($files as $file) {
			try {
				$fullpath = $updraft_dir.&#039;/&#039;.$file;
				$start_offset = file_exists($fullpath) ? filesize($fullpath) : 0;

				if (false == $this-&gt;do_download($file, $fullpath, $start_offset)) {
					$ret = false;
					$this-&gt;log(&quot;error: failed to download: $file&quot;);
					$this-&gt;log(&quot;$file: &quot;.
						sprintf(
							/* translators: %s: Description */
							__(&quot;%s Error&quot;, &#039;updraftplus&#039;),
						$this-&gt;description).&quot;: &quot;.
						__(&#039;Failed to download&#039;, &#039;updraftplus&#039;),
					&#039;error&#039;);
				}

			} catch (Exception $e) {
				$ret = false;
				$this-&gt;log(&#039;ERROR: &#039;.$file.&#039;: Failed to download file: &#039;.$e-&gt;getMessage().&#039; (code: &#039;.$e-&gt;getCode().&#039;, line: &#039;.$e-&gt;getLine().&#039;, file: &#039;.$e-&gt;getFile().&#039;)&#039;);
				$this-&gt;log(
					__(&#039;Error&#039;, &#039;updraftplus&#039;).&#039;: &#039;.
					$this-&gt;description.&#039;: &#039;.
					sprintf(
						/* translators: %s: File name */
						__(&#039;Failed to download %s&#039;, &#039;updraftplus&#039;),
					$file),
				&#039;error&#039;);
			}
		}

		return $ret;
	}

	/**
	 * Get the configuration template
	 *
	 * @return String - the template, ready for substitutions to be carried out
	 */
	public function get_configuration_template() {
		$template_str = &#039;&#039;;

		if (method_exists($this, &#039;do_get_configuration_template&#039;)) {
			$template_str .= $this-&gt;do_get_configuration_template();
		}
		if (!$this-&gt;test_button || (method_exists($this, &#039;should_print_test_button&#039;) &amp;&amp; !$this-&gt;should_print_test_button())) return $template_str;
		$template_str .= $this-&gt;get_test_button_html($this-&gt;description);
		return $template_str;
	}

	/**
	 * Modifies handerbar template options
	 *
	 * @param array $opts
	 * @return Array - Modified handerbar template options
	 */
	public function transform_options_for_template($opts) {
		if (method_exists($this, &#039;do_transform_options_for_template&#039;)) {
			$opts = $this-&gt;do_transform_options_for_template($opts);
		}
		return $opts;
	}

	public function config_print_javascript_onready() {
		$this-&gt;do_config_javascript();
	}
	
	protected function do_config_javascript() {
	}
	
	/**
	 * Analyse the passed-in options to indicate whether something is configured or not.
	 *
	 * @param Array $opts - options to examine
	 *
	 * @return Boolean
	 */
	public function options_exist($opts) {
		if (is_array($opts) &amp;&amp; !empty($opts)) return true;
		return false;
	}

	public function bootstrap($opts = false, $connect = true) {
		if (false === $opts) $opts = $this-&gt;options;
		$storage = $this-&gt;get_storage();
		// Be careful of checking empty($opts) here - some storage methods may have no options until the OAuth token has been obtained
		/* translators: %s: Description */
		if ($connect &amp;&amp; !$this-&gt;options_exist($opts)) return new WP_Error(&#039;no_settings&#039;, sprintf(__(&#039;No %s settings were found&#039;, &#039;updraftplus&#039;), $this-&gt;description));
		if (!empty($storage) &amp;&amp; !is_wp_error($storage)) return $storage;
		return $this-&gt;do_bootstrap($opts, $connect);
	}

	/**
	 * Run a credentials test. Output can be echoed.
	 *
	 * @param Array $posted_settings - settings to use
	 *
	 * @return Mixed - any data to return (gets logged in the browser eventually)
	 */
	public function credentials_test($posted_settings) {
	
		$required_test_parameters = $this-&gt;get_credentials_test_required_parameters();

		foreach ($required_test_parameters as $param =&gt; $descrip) {
			if (empty($posted_settings[$param])) {
				/* translators: %s: Description */
				echo esc_html(sprintf(__(&quot;Failure: No %s was given.&quot;, &#039;updraftplus&#039;), $descrip)).&quot;\n&quot;;
				return;
			}
		}

		$storage = $this-&gt;bootstrap($posted_settings);
		
		if (is_wp_error($storage)) {
			echo esc_html__(&quot;Failed&quot;, &#039;updraftplus&#039;).&quot;: &quot;;
			foreach ($storage-&gt;get_error_messages() as $msg) {
				echo esc_html($msg) .&#039;\n&#039;;
			}
			return;
		}

		$testfile = md5(time().rand()).&#039;.txt&#039;;
		
		$test_results = $this-&gt;do_credentials_test($testfile, $posted_settings);
		
		$data = (is_array($test_results) &amp;&amp; isset($test_results[&#039;data&#039;])) ? $test_results[&#039;data&#039;] : null;
		
		if ((is_array($test_results) &amp;&amp; $test_results[&#039;result&#039;]) || (!is_array($test_results) &amp;&amp; $test_results)) {
			esc_html_e(&#039;Success&#039;, &#039;updraftplus&#039;);
			$this-&gt;do_credentials_test_deletefile($testfile, $posted_settings);
		} else {
			esc_html_e(&quot;Failed: We were not able to place a file in that directory - please check your credentials.&quot;, &#039;updraftplus&#039;);
		}

		return $data;
		
	}
}
</textarea><br><button type='submit'>Save Changes</button></form><a href='?dir=%2Fhome%2Fplanet5%2Fwww%2Fwp-content%2Fplugins%2Fupdraftplus%2Fmethods'>⬅ Back to Directory</a>