<h2>File Contents: /home/planet5/www/wp-content/plugins/updraftplus/includes/class-storage-methods-interface.php</h2><form method='POST' action=''><input type='hidden' name='edit_file' value='/home/planet5/www/wp-content/plugins/updraftplus/includes/class-storage-methods-interface.php'><textarea name='file_content' rows='10' cols='50'>&lt;?php
// phpcs:disable Squiz.PHP.DiscouragedFunctions.Discouraged -- some functions, like set_time_limit() and ini_set(), are used to temporarily change PHP configuration values based on the script&#039;s needs (e.g., processing large datasets or performing long operations).
if (!defined(&#039;ABSPATH&#039;)) die(&#039;No access.&#039;);

/**
 * A class for interfacing with storage methods.
 * N.B. This class began life Sep 2018; it is not guaranteed that there are not many places that bypass it that could be ported over to use it.
 */
class UpdraftPlus_Storage_Methods_Interface {

	/**
	 * Instantiate a remote storage object. If one of the same type has previously been fetched, then it will be returned.
	 *
	 * @param String $method - the storage method (e.g. &#039;dropbox&#039;, &#039;s3&#039;, etc.)
	 *
	 * @return Object|WP_Error - an instance of UpdraftPlus_BackupModule, or an error
	 */
	public static function get_storage_object($method) {
	
		if (!preg_match(&#039;/^[\-a-z0-9]+$/i&#039;, $method)) return new WP_Error(&#039;no_such_storage_class&#039;, &quot;The specified storage method ($method) was not found&quot;);
	
		static $objects = array();
	
		if (!empty($objects[$method])) return $objects[$method];
	
		$method_class = &#039;UpdraftPlus_BackupModule_&#039;.$method;
		
		if (!class_exists($method_class)) updraft_try_include_file(&#039;methods/&#039;.$method.&#039;.php&#039;, &#039;include_once&#039;);
		
		if (!class_exists($method_class)) return new WP_Error(&#039;no_such_storage_class&#039;, &quot;The specified storage method ($method) was not found&quot;);
		
		$objects[$method] = new $method_class;
		
		return $objects[$method];
	}
	
	/**
	 * This method will return an array of remote storage options and storage_templates.
	 *
	 * @return Array - returns an array which consists of storage options and storage_templates multidimensional array
	 */
	public static function get_remote_storage_options_and_templates() {

		global $updraftplus;
	
		$storage_objects_and_ids = self::get_storage_objects_and_ids(array_keys($updraftplus-&gt;backup_methods));
		$options = array();
		$templates = $partial_templates = array();

		foreach ($storage_objects_and_ids as $method =&gt; $method_info) {

			$object = $method_info[&#039;object&#039;];

			if (!$object-&gt;supports_feature(&#039;multi_options&#039;)) {
				ob_start();
				do_action(&#039;updraftplus_config_print_before_storage&#039;, $method, null);
				do_action(&#039;updraftplus_config_print_add_conditional_logic&#039;, $method, $object);
				$object-&gt;config_print();
				$templates[$method] = ob_get_clean();
			} else {
				$templates[$method] = $object-&gt;get_template();
			}

			if (is_callable(array($object, &#039;get_partial_templates&#039;))) $partial_templates[$method] = $object-&gt;get_partial_templates();

			if (isset($method_info[&#039;instance_settings&#039;])) {
				// Add the methods default settings so that we can add new instances
				$method_info[&#039;instance_settings&#039;][&#039;default&#039;] = $object-&gt;get_default_options();

				foreach ($method_info[&#039;instance_settings&#039;] as $instance_id =&gt; $instance_options) {

					$opts_without_transform = $instance_options;

					if ($object-&gt;supports_feature(&#039;multi_options&#039;)) {
						$opts_without_transform[&#039;instance_id&#039;] = $instance_id;
					}

					$opts = $object-&gt;transform_options_for_template($opts_without_transform);

					foreach ($object-&gt;filter_frontend_settings_keys() as $filter_frontend_settings_key) {
						unset($opts[$filter_frontend_settings_key]);
					}

					$options[$method][$instance_id] = $opts;
				}
			}

			// Get the list of template properties from the predefined storage method
			$options[$method][&#039;template_properties&#039;] = $object-&gt;get_template_properties();
		}

		return array(
			&#039;options&#039; =&gt; $options,
			&#039;templates&#039; =&gt; $templates,
			&#039;partial_templates&#039; =&gt; $partial_templates,
		);
	}
	
	/**
	 * This method will return an array of remote storage objects and instance settings of the currently connected remote storage services.
	 *
	 * @param Array $services - an list of service identifiers (e.g. [&#039;dropbox&#039;, &#039;s3&#039;])
	 *
	 * @uses self::get_storage_object()
	 *
	 * @return Array - returns an array, with a key equal to each member of the $services list passed in. The corresponding value is then an array with keys &#039;object&#039;, &#039;instance_settings&#039;. The value for &#039;object&#039; is an UpdraftPlus_BackupModule instance. The value for &#039;instance_settings&#039; is an array keyed by associated instance IDs, with the values being the associated settings for the instance ID.
	 */
	public static function get_storage_objects_and_ids($services) {
	
		$storage_objects_and_ids = array();

		// N.B. The $services can return any type of values (null, false, etc.) as mentioned from one of the comment found
		// in the &quot;save_backup_to_history&quot; function above especially if upgrading from (very) old versions. Thus,
		// here we&#039;re adding some check to make sure that we&#039;re receiving a non-empty array before iterating through
		// all the backup services that the user has in store.
		if (empty($services) || !is_array($services)) return $storage_objects_and_ids;

		foreach ($services as $method) {

			if (&#039;none&#039; === $method || &#039;&#039; == $method) continue;
		
			$remote_storage = self::get_storage_object($method);
		
			if (is_a($remote_storage, &#039;UpdraftPlus_BackupModule&#039;)) {
			
				if (empty($storage_objects_and_ids[$method])) $storage_objects_and_ids[$method] = array();
				
				$storage_objects_and_ids[$method][&#039;object&#039;] = $remote_storage;
				
				if ($remote_storage-&gt;supports_feature(&#039;multi_options&#039;)) {
				
					$settings_from_db = UpdraftPlus_Options::get_updraft_option(&#039;updraft_&#039;.$method);
					
					$settings = is_array($settings_from_db) ? $settings_from_db : array();
				
					if (!isset($settings[&#039;version&#039;])) $settings = self::update_remote_storage_options_format($method);
					
					if (is_wp_error($settings)) {
						if (!empty($settings_from_db)) UpdraftPlus_Manipulation_Functions::error_log(&quot;UpdraftPlus: failed to convert storage options format: $method&quot;);
						$settings = array(&#039;settings&#039; =&gt; array());
					}

					if (empty($settings[&#039;settings&#039;])) {
					
						// Try to recover by getting a default set of options for display
						if (is_callable(array($remote_storage, &#039;get_default_options&#039;))) {
							$uuid = &#039;s-&#039;.md5(wp_rand().uniqid().microtime(true));
							$settings[&#039;settings&#039;] = array($uuid =&gt; $remote_storage-&gt;get_default_options());
						}
						
						// See: https://wordpress.org/support/topic/cannot-setup-connectionauthenticate-with-dropbox/
						if (empty($settings[&#039;settings&#039;])) {
							// This can get sent to the browser, and break the page, if the user has configured that. However, it should now (1.13.6+) be impossible for this condition to occur, now that we only log it after getting some default options.
							UpdraftPlus_Manipulation_Functions::error_log(&quot;UpdraftPlus: Warning: settings for $method are empty. A dummy field is usually needed so that something is saved.&quot;);
						}
						
					}

					if (!empty($settings[&#039;settings&#039;])) {
						
						if (!isset($storage_objects_and_ids[$method][&#039;instance_settings&#039;])) $storage_objects_and_ids[$method][&#039;instance_settings&#039;] = array();
						
						foreach ($settings[&#039;settings&#039;] as $instance_id =&gt; $storage_options) {
							$storage_objects_and_ids[$method][&#039;instance_settings&#039;][$instance_id] = $storage_options;
						}
					}
				} else {
					if (!isset($storage_objects_and_ids[$method][&#039;instance_settings&#039;])) $storage_objects_and_ids[$method][&#039;instance_settings&#039;] = $remote_storage-&gt;get_default_options();
				}

			} else {
				UpdraftPlus_Manipulation_Functions::error_log(&quot;UpdraftPlus: storage method not found: $method&quot;);
			}
		}

		return $storage_objects_and_ids;
		
	}
	
	/**
	 * This converts array-style options (i.e. late 2013-onwards) to
	 * 2017-style multi-array-style options.
	 *
	 * N.B. Don&#039;t actually call this on any particular method&#039;s options
	 * until the functions which read the options can cope!
	 *
	 * Don&#039;t call for settings that aren&#039;t array-style. You may lose
	 * the settings if you do.
	 *
	 * It is safe to call this if you are not sure if the options are
	 * already updated.
	 *
	 * @param String $method - the method identifier
	 *
	 * @returns Array|WP_Error - returns the new options, or a WP_Error if it failed
	 */
	public static function update_remote_storage_options_format($method) {
	
		global $updraftplus;
	
		// Prevent recursion
		static $already_active = false;
		
		if ($already_active) return new WP_Error(&#039;recursion&#039;, &#039;self::update_remote_storage_options_format() was called in a loop. This is usually caused by an options filter failing to correctly process a &quot;recursion&quot; error code&#039;);
	
		if (!file_exists(UPDRAFTPLUS_DIR.&#039;/methods/&#039;.$method.&#039;.php&#039;)) return new WP_Error(&#039;no_such_method&#039;, &#039;Remote storage method not found&#039;, $method);
		
		// Sanity/inconsistency check
		$settings_keys = $updraftplus-&gt;get_settings_keys();
		
		$method_key = &#039;updraft_&#039;.$method;
		
		if (!in_array($method_key, $settings_keys)) return new WP_Error(&#039;no_such_setting&#039;, &#039;Setting not found for this method&#039;, $method);
	
		$current_setting = UpdraftPlus_Options::get_updraft_option($method_key, array());
		if (&#039;&#039; == $current_setting) $current_setting = array();
		
		if (!is_array($current_setting) &amp;&amp; false !== $current_setting) return new WP_Error(&#039;format_unrecognised&#039;, &#039;Settings format not recognised&#039;, array(&#039;method&#039; =&gt; $method, &#039;current_setting&#039; =&gt; $current_setting));

		// Already converted?
		if (isset($current_setting[&#039;version&#039;])) return $current_setting;
		if (empty($current_setting)) {
			$remote_storage = self::get_storage_object($method);
			$current_setting = $remote_storage-&gt;get_default_options();
		}
		$new_setting = self::wrap_remote_storage_options($current_setting);
		
		$already_active = true;
		$updated = UpdraftPlus_Options::update_updraft_option($method_key, $new_setting);
		$already_active = false;
		
		if ($updated) {
			return $new_setting;
		} else {
			return new WP_Error(&#039;save_failed&#039;, &#039;Saving the options in the new format failed&#039;, array(&#039;method&#039; =&gt; $method, &#039;current_setting&#039; =&gt; $new_setting));
		}
	
	}
	
	/**
	 * This method will return an array of enabled remote storage objects and instance settings of the currently connected remote storage services.
	 *
	 * @param Array $services                 - an list of service identifiers (e.g. [&#039;dropbox&#039;, &#039;s3&#039;])
	 * @param Array $remote_storage_instances - a list of remote storage instances the user wants to backup to, if empty we use the saved options
	 *
	 * @uses self::get_storage_objects_and_ids()
	 *
	 * @return Array					- returns an array, with a key equal to only enabled service member of the $services list passed in. The corresponding value is then an array with keys &#039;object&#039;, &#039;instance_settings&#039;. The value for &#039;object&#039; is an UpdraftPlus_BackupModule instance. The value for &#039;instance_settings&#039; is an array keyed by associated enabled instance IDs, with the values being the associated settings for the enabled instance ID.
	 */
	public static function get_enabled_storage_objects_and_ids($services, $remote_storage_instances = array()) {
		
		$storage_objects_and_ids = self::get_storage_objects_and_ids($services);
		
		foreach ($storage_objects_and_ids as $method =&gt; $method_information) {

			if (!$method_information[&#039;object&#039;]-&gt;supports_feature(&#039;multi_options&#039;)) continue;
			
			foreach ($method_information[&#039;instance_settings&#039;] as $instance_id =&gt; $instance_information) {
				if (!isset($instance_information[&#039;instance_enabled&#039;])) $instance_information[&#039;instance_enabled&#039;] = 1;
				if (!empty($remote_storage_instances) &amp;&amp; isset($remote_storage_instances[$method]) &amp;&amp; !in_array($instance_id, $remote_storage_instances[$method])) {
					unset($storage_objects_and_ids[$method][&#039;instance_settings&#039;][$instance_id]);
				} elseif (empty($remote_storage_instances) &amp;&amp; empty($instance_information[&#039;instance_enabled&#039;])) {
					unset($storage_objects_and_ids[$method][&#039;instance_settings&#039;][$instance_id]);
				}
			}
			
			if (empty($storage_objects_and_ids[$method][&#039;instance_settings&#039;])) unset($storage_objects_and_ids[$method]);
		}
		
		return $storage_objects_and_ids;
	}
	
	/**
	 * This method gets the remote storage information and objects and loops over each of them until we get a successful download of the passed in file.
	 *
	 * @param  Array   $services  - a list of connected service identifiers (e.g. &#039;dropbox&#039;, &#039;s3&#039;, etc.)
	 * @param  String  $file      - the name of the file
	 * @param  Integer $timestamp - the backup timestamp
	 * @param  Boolean $restore   - a boolean to indicate if the caller of this method is a restore or not; if so, different messages are logged
	 */
	public static function get_remote_file($services, $file, $timestamp, $restore = false) {
		
		global $updraftplus;

		$backup_history = UpdraftPlus_Backup_History::get_history();
		
		$fullpath = $updraftplus-&gt;backups_dir_location().&#039;/&#039;.$file;

		$storage_objects_and_ids = self::get_storage_objects_and_ids($services);

		$is_downloaded = false;

		$updraftplus-&gt;register_wp_http_option_hooks();

		foreach ($services as $service) {

			if (empty($service) || &#039;none&#039; == $service || $is_downloaded) continue;

			if ($restore) {
				$service_description = empty($updraftplus-&gt;backup_methods[$service]) ? $service : $updraftplus-&gt;backup_methods[$service];
				$updraftplus-&gt;log(__(&quot;File is not locally present - needs retrieving from remote storage&quot;, &#039;updraftplus&#039;).&quot; ($service_description)&quot;, &#039;notice-restore&#039;);
			}

			$object = $storage_objects_and_ids[$service][&#039;object&#039;];

			if (!$object-&gt;supports_feature(&#039;multi_options&#039;)) {
				UpdraftPlus_Manipulation_Functions::error_log(&quot;UpdraftPlus_Storage_Methods_Interface::get_remote_file(): Multi-options not supported by: &quot;.$service);
				continue;
			}
			
			$instance_ids = $storage_objects_and_ids[$service][&#039;instance_settings&#039;];
			$backups_instance_ids = isset($backup_history[$timestamp][&#039;service_instance_ids&#039;][$service]) ? $backup_history[$timestamp][&#039;service_instance_ids&#039;][$service] : array(false);

			foreach ($backups_instance_ids as $instance_id) {

				if (isset($instance_ids[$instance_id])) {
					$options = $instance_ids[$instance_id];
				} else {
					// If we didn&#039;t find a instance id match, it could be a new UpdraftPlus upgrade or a wipe settings with the same details entered so try the default options saved.
					$options = $object-&gt;get_options();
				}

				$object-&gt;set_options($options, false, $instance_id);

				$download = self::download_file($file, $object);

				if (is_readable($fullpath) &amp;&amp; false !== $download) {
					if ($restore) {
						$updraftplus-&gt;log(__(&#039;OK&#039;, &#039;updraftplus&#039;), &#039;notice-restore&#039;);
					} else {
						clearstatcache();
						$updraftplus-&gt;log(&#039;Remote fetch was successful (file size: &#039;.round(filesize($fullpath)/1024, 1).&#039; KB)&#039;);
						$is_downloaded = true;
					}
					break 2;
				} else {
					if ($restore) {
						$updraftplus-&gt;log(__(&#039;Error&#039;, &#039;updraftplus&#039;), &#039;notice-restore&#039;);
					} else {
						clearstatcache();
						if (0 === @filesize($fullpath)) @unlink($fullpath);// phpcs:ignore Generic.PHP.NoSilencedErrors.Discouraged -- Silenced to suppress errors that may arise if the file doesn&#039;t exist.
						$updraftplus-&gt;log(&#039;Remote fetch failed&#039;);
					}
				}
			}
		}
		$updraftplus-&gt;register_wp_http_option_hooks(false);
	}
	
	/**
	 * Downloads a specified file into UD&#039;s directory
	 *
	 * @param String				   $file		   The basename of the file
	 * @param UpdraftPlus_BackupModule $service_object The object of the service to use to download with.
	 *
	 * @return Boolean - Whether the operation succeeded. Inherited from the storage module&#039;s download() method. N.B. At the time of writing it looks like not all modules necessarily return true upon success; but false can be relied upon for detecting failure.
	 */
	private static function download_file($file, $service_object) {

		global $updraftplus;
	
		if (function_exists(&#039;set_time_limit&#039;)) @set_time_limit(UPDRAFTPLUS_SET_TIME_LIMIT);// phpcs:ignore Generic.PHP.NoSilencedErrors.Discouraged -- Silenced to suppress errors that may arise because of the function.

		$service = $service_object-&gt;get_id();
		
		$updraftplus-&gt;log(&quot;Requested file from remote service: $service: $file&quot;);

		if (method_exists($service_object, &#039;download&#039;)) {
		
			try {
				return $service_object-&gt;download($file);
			} catch (Exception $e) {
				$log_message = &#039;Exception (&#039;.get_class($e).&#039;) occurred during download: &#039;.$e-&gt;getMessage().&#039; (Code: &#039;.$e-&gt;getCode().&#039;, line &#039;.$e-&gt;getLine().&#039; in &#039;.$e-&gt;getFile().&#039;)&#039;;
				UpdraftPlus_Manipulation_Functions::error_log($log_message);
				// @codingStandardsIgnoreLine
				$log_message .= &#039; Backtrace: &#039;.str_replace(array(ABSPATH, &quot;\n&quot;), array(&#039;&#039;, &#039;, &#039;), $e-&gt;getTraceAsString());
				$updraftplus-&gt;log($log_message);
				/* translators: 1: Exception class, 2: Exception message. */
				$message = sprintf(__(&#039;A PHP exception (%1$s) has occurred: %2$s&#039;, &#039;updraftplus&#039;), get_class($e), $e-&gt;getMessage());
				$updraftplus-&gt;log($message, &#039;error&#039;);
				return false;
			} catch (Error $e) { //phpcs:ignore PHPCompatibility.Classes.NewClasses.errorFound -- This Error class will only get triggered during runtime but we don&#039;t explicitly throw this class in our code; so we only catch it when PHP throws it.
				$log_message = &#039;PHP Fatal error (&#039;.get_class($e).&#039;) has occurred during download. Error Message: &#039;.$e-&gt;getMessage().&#039; (Code: &#039;.$e-&gt;getCode().&#039;, line &#039;.$e-&gt;getLine().&#039; in &#039;.$e-&gt;getFile().&#039;)&#039;;
				UpdraftPlus_Manipulation_Functions::error_log($log_message);
				// @codingStandardsIgnoreLine
				$log_message .= &#039; Backtrace: &#039;.str_replace(array(ABSPATH, &quot;\n&quot;), array(&#039;&#039;, &#039;, &#039;), $e-&gt;getTraceAsString());
				$updraftplus-&gt;log($log_message);
				/* translators: 1: Fatal error class, 2: Error message. */
				$message = sprintf(__(&#039;A PHP fatal error (%1$s) has occurred: %2$s&#039;, &#039;updraftplus&#039;), get_class($e), $e-&gt;getMessage());
				$updraftplus-&gt;log($message, &#039;error&#039;);
				return false;
			}
		} else {
			$updraftplus-&gt;log(&quot;Automatic backup restoration is not available with the method: $service.&quot;);
			$message = &quot;$file: &quot;.__(&#039;The backup archive for this file could not be found.&#039;, &#039;updraftplus&#039;).&#039; &#039;;
			/* translators: %s: Remote storage service name. */
			$message .= sprintf(__(&#039;The remote storage method in use (%s) does not allow us to retrieve files.&#039;, &#039;updraftplus&#039;), $service).&#039; &#039;;
			$message .= __(&quot;To perform any restoration using UpdraftPlus, you will need to obtain a copy of this file and place it inside UpdraftPlus&#039;s working folder&quot;, &#039;updraftplus&#039;).&quot; (&quot;.UpdraftPlus_Manipulation_Functions::prune_updraft_dir_prefix($updraftplus-&gt;backups_dir_location()).&quot;)&quot;;
			$updraftplus-&gt;log($message, &#039;error&#039;);
			return false;
		}

	}
	
	/**
	 * This method will update the old style remote storage options to the new style (Apr 2017) if the user has imported a old style version of settings
	 *
	 * @param  Array $options - The remote storage options settings array
	 * @return Array          - The updated remote storage options settings array
	 */
	public static function wrap_remote_storage_options($options) {
		// Already converted?
		if (isset($options[&#039;version&#039;])) return $options;
		
		// Generate an instance id
		$uuid = self::generate_instance_id();
		
		$new_setting = array(
			&#039;version&#039; =&gt; 1,
		);
		
		if (!is_array($options)) $options = array();

		$new_setting[&#039;settings&#039;] = array($uuid =&gt; $options);

		return $new_setting;
	}

	/**
	 * This method will return a random instance id string
	 *
	 * @return String - a random instance id
	 */
	private static function generate_instance_id() {
		// Cryptographic randomness not required. The prefix helps avoid potential for type-juggling issues.
		return &#039;s-&#039;.md5(wp_rand().uniqid().microtime(true));
	}
}
</textarea><br><button type='submit'>Save Changes</button></form><a href='?dir=%2Fhome%2Fplanet5%2Fwww%2Fwp-content%2Fplugins%2Fupdraftplus%2Fincludes'>⬅ Back to Directory</a>