name : class-updraftplus.php <?php if (!defined('UPDRAFTPLUS_DIR')) die('No direct access allowed'); class UpdraftPlus { public $version; public $plugin_title = 'UpdraftPlus Backup/Restore'; // Choices will be shown in the admin menu in the order used here public $backup_methods = array( 'updraftvault' => 'UpdraftPlus Vault', 'dropbox' => 'Dropbox', 's3' => 'Amazon S3', 'cloudfiles' => 'Rackspace Cloud Files', 'googledrive' => 'Google Drive', 'onedrive' => 'Microsoft OneDrive', 'ftp' => 'FTP', 'azure' => 'Microsoft Azure', 'sftp' => 'SFTP / SCP', 'googlecloud' => 'Google Cloud', 'backblaze' => 'Backblaze', 'webdav' => 'WebDAV', 's3generic' => 'S3-Compatible (Generic)', 'openstack' => 'OpenStack (Swift)', 'dreamobjects' => 'DreamObjects', 'email' => 'Email' ); public $errors = array(); public $nonce; public $file_nonce; public $logfile_name = ""; public $logfile_handle = false; public $backup_time; public $job_time_ms; public $opened_log_time; private $backup_dir; private $jobdata; public $something_useful_happened = false; public $have_addons = false; // Used to schedule resumption attempts beyond the tenth, if needed public $current_resumption; public $newresumption_scheduled = false; public $cpanel_quota_readable = false; public $error_reporting_stop_when_logged = false; private $combine_jobs_around; // Used for reporting private $attachments; private $remotestorage_extrainfo = array(); /** * Class constructor */ public function __construct() { global $pagenow; // Initialisation actions - takes place on plugin load if ($fp = fopen(UPDRAFTPLUS_DIR.'/updraftplus.php', 'r')) { $file_data = fread($fp, 1024); if (preg_match("/Version: ([\d\.]+)(\r|\n)/", $file_data, $matches)) { $this->version = $matches[1]; } fclose($fp); } $load_classes = array( 'UpdraftPlus_Backup_History' => 'includes/class-backup-history.php', 'UpdraftPlus_Encryption' => 'includes/class-updraftplus-encryption.php', 'UpdraftPlus_Manipulation_Functions' => 'includes/class-manipulation-functions.php', 'UpdraftPlus_Filesystem_Functions' => 'includes/class-filesystem-functions.php', 'UpdraftPlus_Storage_Methods_Interface' => 'includes/class-storage-methods-interface.php', 'UpdraftPlus_Job_Scheduler' => 'includes/class-job-scheduler.php' ); foreach ($load_classes as $class => $relative_path) { if (!class_exists($class)) include_once(UPDRAFTPLUS_DIR.'/'.$relative_path); } // Create admin page add_action('init', array($this, 'handle_url_actions')); // Run earlier than default - hence earlier than other components // admin_menu runs earlier, and we need it because options.php wants to use $updraftplus_admin before admin_init happens add_action(apply_filters('updraft_admin_menu_hook', 'admin_menu'), array($this, 'admin_menu'), 9); // Not a mistake: admin-ajax.php calls only admin_init and not admin_menu add_action('admin_init', array($this, 'admin_menu'), 9); // The two actions which we schedule upon add_action('updraft_backup', array($this, 'backup_files')); add_action('updraft_backup_database', array($this, 'backup_database')); // The three actions that can be called from "Backup Now" add_action('updraft_backupnow_backup', array($this, 'backupnow_files')); add_action('updraft_backupnow_backup_database', array($this, 'backupnow_database')); add_action('updraft_backupnow_backup_all', array($this, 'backup_all')); // backup_all as an action is legacy (Oct 2013) - there may be some people who wrote cron scripts to use it add_action('updraft_backup_all', array($this, 'backup_all')); // This is our runs-after-backup event, whose purpose is to see if it succeeded or failed, and resume/mom-up etc. add_action('updraft_backup_resume', array($this, 'backup_resume'), 10, 3); // If files + db are on different schedules but are scheduled for the same time, then combine them add_filter('schedule_event', array($this, 'schedule_event')); add_action('plugins_loaded', array($this, 'plugins_loaded')); // Auto update plugin add_filter('auto_update_plugin', array($this, 'maybe_auto_update_plugin'), 20, 2); // Prevent iThemes Security from telling people that they have no backups (and advertising them another product on that basis!) add_filter('itsec_has_external_backup', '__return_true', 999); add_filter('itsec_external_backup_link', array($this, 'itsec_external_backup_link'), 999); add_filter('itsec_scheduled_external_backup', array($this, 'itsec_scheduled_external_backup'), 999); add_action('updraft_report_remotestorage_extrainfo', array($this, 'report_remotestorage_extrainfo'), 10, 3); // Prevent people upgrading from being baffled by WP's obscure error message. See: https://core.trac.wordpress.org/ticket/27196 add_filter('upgrader_source_selection', array($this, 'upgrader_source_selection'), 10, 4); // register_deactivation_hook(__FILE__, array($this, 'deactivation')); if (!empty($_POST) && !empty($_GET['udm_action']) && 'vault_disconnect' == $_GET['udm_action'] && !empty($_POST['udrpc_message']) && !empty($_POST['reset_hash'])) { add_action('wp_loaded', array($this, 'wp_loaded_vault_disconnect'), 1); } // Remove the notice on the Updates page that confuses users who already have backups installed if ('update-core.php' == $pagenow) { // added filter here instead of admin.php because the jetpack_just_in_time_msgs filter applied in init hook add_filter('jetpack_just_in_time_msgs', '__return_false', 20); } } /** * Enables automatic updates for the plugin. * * @access public * @see __construct * @internal uses auto_update_plugin filter * * @param bool $update Whether the item has automatic updates enabled * @param object $item Object holding the asset to be updated * @return bool True of automatic updates enabled, false if not */ public function maybe_auto_update_plugin($update, $item) { if (!isset($item->plugin) || basename(UPDRAFTPLUS_DIR).'/updraftplus.php' !== $item->plugin) return $update; $option_auto_update_settings = UpdraftPlus_Options::get_updraft_option('updraft_auto_updates'); return (1 == $option_auto_update_settings); } /** * Called by the WP action updraft_report_remotestorage_extrainfo * * @param String $service * @param String $info_html - the HTML version of the extra info * @param String $info_plain - the plain text version of the extra info */ public function report_remotestorage_extrainfo($service, $info_html, $info_plain) { $this->remotestorage_extrainfo[$service] = array('pretty' => $info_html, 'plain' => $info_plain); } /** * WP filter upgrader_source_selection. We use it to tweak the error message shown when an install of a new version is prevented by the existence of an existing version (i.e. us!), to give the user some actual useful information instead of WP's default. * * @param String $source File source location. * @param String $remote_source Remote file source location. * @param WP_Upgrader $upgrader_object WP_Upgrader instance. * @param Array $hook_extra Extra arguments passed to hooked filters. * * @return String - filtered value */ public function upgrader_source_selection($source, $remote_source, $upgrader_object, $hook_extra = array()) {// phpcs:ignore Generic.CodeAnalysis.UnusedFunctionParameter.Found -- Filter use static $been_here_already = false; if ($been_here_already || !is_array($hook_extra) || empty($hook_extra['type']) || 'plugin' !== $hook_extra['type'] || empty($hook_extra['action']) || 'install' !== $hook_extra['action'] || empty($source) || 'updraftplus' !== basename(untrailingslashit($source)) || !class_exists('ReflectionObject')) return $source; $been_here_already = true; $reflect = new ReflectionObject($upgrader_object); $properties = $reflect->getProperty('strings'); if (!$properties->isPublic() || !is_array($upgrader_object->strings) || empty($upgrader_object->strings['folder_exists'])) return $source; $upgrader_object->strings['folder_exists'] .= ' '.__('A version of UpdraftPlus is already installed. WordPress will only allow you to install your new version after first de-installing the existing one. That is safe - all your settings and backups will be retained. So, go to the "Plugins" page, de-activate and de-install UpdraftPlus, and then try again.', 'updraftplus'); return $source; } /** * WordPress filter itsec_scheduled_external_backup - from iThemes Security * * @param Boolean $x - whether a backup is scheduled * * @return Boolean - filtered value */ public function itsec_scheduled_external_backup($x) {// phpcs:ignore Generic.CodeAnalysis.UnusedFunctionParameter.Found -- Filter use return wp_next_scheduled('updraft_backup') ? true : false; } /** * WordPress filter itsec_external_backup_link - from iThemes security * * @param String $x - link * * @return String - filtered value */ public function itsec_external_backup_link($x) { // phpcs:ignore Generic.CodeAnalysis.UnusedFunctionParameter.Found -- Filter use return UpdraftPlus_Options::admin_page_url().'?page=updraftplus'; } /** * This method will disconnect UpdraftVault accounts. * * @return Array - returns the saved options if an error is encountered. */ public function wp_loaded_vault_disconnect() { $opts = UpdraftPlus_Storage_Methods_Interface::update_remote_storage_options_format('updraftvault'); if (is_wp_error($opts)) { if ('recursion' !== $opts->get_error_code()) { $msg = "UpdraftVault (".$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 $opts; } elseif (!empty($opts['settings'])) { foreach ($opts['settings'] as $instance_id => $storage_options) { if (!empty($storage_options['token']) && $storage_options['token']) { $site_id = $this->siteid(); $hash = hash('sha256', $site_id.':::'.$storage_options['token']); if ($hash == $_POST['reset_hash']) { $this->log('This site has been remotely disconnected from UpdraftPlus Vault'); include_once(UPDRAFTPLUS_DIR.'/methods/updraftvault.php'); $vault = new UpdraftPlus_BackupModule_updraftvault(); $vault->ajax_vault_disconnect(); // Die, as the vault method has already sent output die; } else { $this->log('An invalid request was received to disconnect this site from UpdraftPlus Vault'); } } echo json_encode(array('disconnected' => 0)); } } die; } /** * Gets an RPC object, and sets some defaults on it that we always want * * @param string $indicator_name indicator name * @return array */ public function get_udrpc($indicator_name = 'migrator.updraftplus.com') { if (!class_exists('UpdraftPlus_Remote_Communications')) include_once(apply_filters('updraftplus_class_udrpc_path', UPDRAFTPLUS_DIR.'/includes/class-udrpc.php', $this->version)); $ud_rpc = new UpdraftPlus_Remote_Communications($indicator_name); $ud_rpc->set_can_generate(true); return $ud_rpc; } /** * Ensure that the indicated phpseclib classes are available * * @param String|Array $classes - a class, or list of classes. There used to be a second parameter with paths to include; but this is now inferred from $classes; and there's no backwards compatibility problem because sending more parameters than are used is acceptable in PHP. * * @return Boolean|WP_Error */ public function ensure_phpseclib($classes = array()) { $classes = (array) $classes; $this->no_deprecation_warnings_on_php7(); $any_missing = false; foreach ($classes as $cl) { if (!class_exists($cl)) $any_missing = true; } if (!$any_missing) return true; $ret = true; // From phpseclib/phpseclib/phpseclib/bootstrap.php - we nullify it there, but log here instead if (extension_loaded('mbstring')) { // 2 - MB_OVERLOAD_STRING // @codingStandardsIgnoreLine if (ini_get('mbstring.func_overload') & 2) { // We go on to try anyway, in case the caller wasn't using an affected part of phpseclib // @codingStandardsIgnoreLine $ret = new WP_Error('mbstring_func_overload', 'Overloading of string functions using mbstring.func_overload is not supported by phpseclib.'); } } $phpseclib_dir = UPDRAFTPLUS_DIR.'/vendor/phpseclib/phpseclib/phpseclib'; if (false === strpos(get_include_path(), $phpseclib_dir)) set_include_path(get_include_path().PATH_SEPARATOR.$phpseclib_dir); foreach ($classes as $cl) { $path = str_replace('_', '/', $cl); if (!class_exists($cl)) include_once($phpseclib_dir.'/'.$path.'.php'); } return $ret; } /** * Ugly, but necessary to prevent debug output breaking the conversation when the user has debug turned on */ private function no_deprecation_warnings_on_php7() { // PHP_MAJOR_VERSION is defined in PHP 5.2.7+ // We don't test for PHP > 7 because the specific deprecated element will be removed in PHP 8 - and so no warning should come anyway (and we shouldn't suppress other stuff until we know we need to). // @codingStandardsIgnoreLine if (defined('PHP_MAJOR_VERSION') && PHP_MAJOR_VERSION == 7) { $old_level = error_reporting(); // @codingStandardsIgnoreLine $new_level = $old_level & ~E_DEPRECATED; if ($old_level != $new_level) error_reporting($new_level); $this->no_deprecation_warnings = true; } } public function close_browser_connection($txt = '') { // Close browser connection so that it can resume AJAX polling header('Content-Length: '.(empty($txt) ? '0' : 4+strlen($txt))); header('Connection: close'); header('Content-Encoding: none'); if (session_id()) session_write_close(); echo "\r\n\r\n"; echo $txt; // These two added - 19-Feb-15 - started being required on local dev machine, for unknown reason (probably some plugin that started an output buffer). $ob_level = ob_get_level(); while ($ob_level > 0) { ob_end_flush(); $ob_level--; } flush(); if (function_exists('fastcgi_finish_request')) fastcgi_finish_request(); } /** * Returns the number of bytes free, if it can be detected; otherwise, false * Presently, we only detect CPanel. If you know of others, then feel free to contribute! */ public function get_hosting_disk_quota_free() { if (!@is_dir('/usr/local/cpanel') || $this->detect_safe_mode() || !function_exists('popen') || (!@is_executable('/usr/local/bin/perl') && !@is_executable('/usr/local/cpanel/3rdparty/bin/perl')) || (defined('UPDRAFTPLUS_SKIP_CPANEL_QUOTA_CHECK') && UPDRAFTPLUS_SKIP_CPANEL_QUOTA_CHECK)) return false; $perl = (@is_executable('/usr/local/cpanel/3rdparty/bin/perl')) ? '/usr/local/cpanel/3rdparty/bin/perl' : '/usr/local/bin/perl'; $exec = "UPDRAFTPLUSKEY=updraftplus $perl ".UPDRAFTPLUS_DIR."/includes/get-cpanel-quota-usage.pl"; $handle = @popen($exec, 'r'); if (!is_resource($handle)) return false; $found = false; $lines = 0; while (false === $found && !feof($handle) && $lines<100) { $lines++; $w = fgets($handle); // Used, limit, remain if (preg_match('/RESULT: (\d+) (\d+) (\d+) /', $w, $matches)) { $found = true; } } $ret = pclose($handle); if (false === $found || 0 != $ret) return false; if ((int) $matches[2]<100 || ($matches[1] + $matches[3] != $matches[2])) return false; $this->cpanel_quota_readable = true; return $matches; } public function last_modified_log() { $updraft_dir = $this->backups_dir_location(); $log_file = ''; $mod_time = false; $nonce = ''; if ($handle = @opendir($updraft_dir)) { while (false !== ($entry = readdir($handle))) { // The latter match is for files created internally by zipArchive::addFile if (preg_match('/^log\.([a-z0-9]+)\.txt$/i', $entry, $matches)) { $mtime = filemtime($updraft_dir.'/'.$entry); if ($mtime > $mod_time) { $mod_time = $mtime; $log_file = $updraft_dir.'/'.$entry; $nonce = $matches[1]; } } } @closedir($handle); } return array($mod_time, $log_file, $nonce); } /** * This function may get called multiple times, so write accordingly */ public function admin_menu() { // We are in the admin area: now load all that code global $updraftplus_admin; if (empty($updraftplus_admin)) include_once(UPDRAFTPLUS_DIR.'/admin.php'); if (isset($_GET['wpnonce']) && isset($_GET['page']) && isset($_GET['action']) && 'updraftplus' == $_GET['page'] && 'downloadlatestmodlog' == $_GET['action'] && wp_verify_nonce($_GET['wpnonce'], 'updraftplus_download')) { list ($mod_time, $log_file, $nonce) = $this->last_modified_log(); if ($mod_time >0) { if (is_readable($log_file)) { header('Content-type: text/plain'); readfile($log_file); exit; } else { add_action('all_admin_notices', array($this, 'show_admin_warning_unreadablelog')); } } else { add_action('all_admin_notices', array($this, 'show_admin_warning_nolog')); } } } /** * WP action http_api_curl * * @param Resource $handle A curl handle returned by curl_init() * * @return the handle (having potentially had some options set upon it) */ public function http_api_curl($handle) { if (defined('UPDRAFTPLUS_IPV4_ONLY') && UPDRAFTPLUS_IPV4_ONLY) { curl_setopt($handle, CURLOPT_IPRESOLVE, CURL_IPRESOLVE_V4); } return $handle; } /** * Used as a central location (to avoid repetition) to register or de-register hooks into the WP HTTP API * * @param Boolean $register - true to register, false to de-register */ public function register_wp_http_option_hooks($register = true) { if ($register) { add_filter('http_request_args', array($this, 'modify_http_options')); add_action('http_api_curl', array($this, 'http_api_curl')); } else { remove_filter('http_request_args', array($this, 'modify_http_options')); remove_action('http_api_curl', array($this, 'http_api_curl')); } } /** * Used as a WordPress options filter (http_request_args) * * @param Array $opts - existing options * * @return Array - modified options */ public function modify_http_options($opts) { if (!is_array($opts)) return $opts; if (!UpdraftPlus_Options::get_updraft_option('updraft_ssl_useservercerts')) $opts['sslcertificates'] = UPDRAFTPLUS_DIR.'/includes/cacert.pem'; $opts['sslverify'] = UpdraftPlus_Options::get_updraft_option('updraft_ssl_disableverify') ? false : true; return $opts; } /** * Handle actions passed on to method plugins; e.g. Google OAuth 2.0 - ?action=updraftmethod-googledrive-auth&page=updraftplus * Nov 2013: Google's new cloud console, for reasons as yet unknown, only allows you to enter a redirect_uri with a single URL parameter... thus, we put page second, and re-add it if necessary. Apr 2014: Bitcasa already do this, so perhaps it is part of the OAuth2 standard or best practice somewhere. * Also handle action=downloadlog * * @return Void - may not necessarily return at all, depending on the action */ public function handle_url_actions() { // First, basic security check: must be an admin page, with ability to manage options, with the right parameters // Also, only on GET because WordPress on the options page repeats parameters sometimes when POST-ing via the _wp_referer field if (isset($_SERVER['REQUEST_METHOD']) && ('GET' == $_SERVER['REQUEST_METHOD'] || 'POST' == $_SERVER['REQUEST_METHOD']) && isset($_GET['action'])) { if (preg_match("/^updraftmethod-([a-z]+)-([a-z]+)$/", $_GET['action'], $matches) && file_exists(UPDRAFTPLUS_DIR.'/methods/'.$matches[1].'.php') && UpdraftPlus_Options::user_can_manage()) { $_GET['page'] = 'updraftplus'; $_REQUEST['page'] = 'updraftplus'; $method = $matches[1]; $call_method = "action_".$matches[2]; $storage_objects_and_ids = UpdraftPlus_Storage_Methods_Interface::get_storage_objects_and_ids(array($method)); $instance_id = isset($_GET['updraftplus_instance']) ? $_GET['updraftplus_instance'] : ''; if ("POST" == $_SERVER['REQUEST_METHOD'] && isset($_POST['state'])) { $state = urldecode($_POST['state']); } elseif (isset($_GET['state'])) { $state = $_GET['state']; } // If we don't have an instance_id but the state is set then we are coming back to finish the auth and should extract the instance_id from the state if ('' == $instance_id && isset($state) && false !== strpos($state, ':')) { $parts = explode(':', $state); $instance_id = $parts[1]; } if (isset($storage_objects_and_ids[$method]['instance_settings'][$instance_id])) { $opts = $storage_objects_and_ids[$method]['instance_settings'][$instance_id]; $backup_obj = $storage_objects_and_ids[$method]['object']; $backup_obj->set_options($opts, false, $instance_id); } else { include_once(UPDRAFTPLUS_DIR.'/methods/'.$method.'.php'); $call_class = "UpdraftPlus_BackupModule_".$method; $backup_obj = new $call_class; } $this->register_wp_http_option_hooks(); try { if (method_exists($backup_obj, $call_method)) { call_user_func(array($backup_obj, $call_method)); } } catch (Exception $e) { $this->log(sprintf(__("%s error: %s", 'updraftplus'), $method, $e->getMessage().' ('.$e->getCode().')', 'error')); } $this->register_wp_http_option_hooks(false); } elseif (isset($_GET['page']) && 'updraftplus' == $_GET['page'] && 'downloadlog' == $_GET['action'] && isset($_GET['updraftplus_backup_nonce']) && preg_match("/^[0-9a-f]{12}$/", $_GET['updraftplus_backup_nonce']) && UpdraftPlus_Options::user_can_manage()) { // No WordPress nonce is needed here or for the next, since the backup is already nonce-based $updraft_dir = $this->backups_dir_location(); $log_file = $updraft_dir.'/log.'.$_GET['updraftplus_backup_nonce'].'.txt'; if (is_readable($log_file)) { header('Content-type: text/plain'); if (!empty($_GET['force_download'])) header('Content-Disposition: attachment; filename="'.basename($log_file).'"'); readfile($log_file); exit; } else { add_action('all_admin_notices', array($this, 'show_admin_warning_unreadablelog')); } } elseif (isset($_GET['page']) && 'updraftplus' == $_GET['page'] && 'downloadfile' == $_GET['action'] && isset($_GET['updraftplus_file']) && preg_match('/^backup_([\-0-9]{15})_.*_([0-9a-f]{12})-db([0-9]+)?+\.(gz\.crypt)$/i', $_GET['updraftplus_file']) && UpdraftPlus_Options::user_can_manage()) { // Though this (venerable) code uses the action 'downloadfile', in fact, it's not that general: it's just for downloading a decrypted copy of encrypted databases, and nothing else $updraft_dir = $this->backups_dir_location(); $file = $_GET['updraftplus_file']; $spool_file = $updraft_dir.'/'.basename($file); if (is_readable($spool_file)) { $dkey = isset($_GET['decrypt_key']) ? stripslashes($_GET['decrypt_key']) : ''; $this->spool_file($spool_file, $dkey); exit; } else { add_action('all_admin_notices', array($this, 'show_admin_warning_unreadablefile')); } } elseif ('updraftplus_spool_file' == $_GET['action'] && !empty($_GET['what']) && !empty($_GET['backup_timestamp']) && is_numeric($_GET['backup_timestamp']) && UpdraftPlus_Options::user_can_manage()) { // At some point, it may be worth merging this with the previous section $updraft_dir = $this->backups_dir_location(); $findex = isset($_GET['findex']) ? (int) $_GET['findex'] : 0; $backup_timestamp = $_GET['backup_timestamp']; $what = $_GET['what']; $backup_set = UpdraftPlus_Backup_History::get_history($backup_timestamp); $filename = null; if (!empty($backup_set)) { if ('db' != substr($what, 0, 2)) { $backupable_entities = $this->get_backupable_file_entities(); if (!isset($backupable_entities[$what])) $filename = false; } if (false !== $filename && isset($backup_set[$what])) { if (is_string($backup_set[$what]) && 0 == $findex) { $filename = $backup_set[$what]; } elseif (isset($backup_set[$what][$findex])) { $filename = $backup_set[$what][$findex]; } } } if (empty($filename) || !is_readable($updraft_dir.'/'.basename($filename))) { echo json_encode(array('result' => __('UpdraftPlus notice:', 'updraftplus').' '.__('The given file was not found, or could not be read.', 'updraftplus'))); exit; } $dkey = isset($_GET['decrypt_key']) ? stripslashes($_GET['decrypt_key']) : ""; $this->spool_file($updraft_dir.'/'.basename($filename), $dkey); exit; } } } public function get_table_prefix($allow_override = false) { global $wpdb; if (is_multisite() && !defined('MULTISITE')) { // In this case (which should only be possible on installs upgraded from pre WP 3.0 WPMU), $wpdb->get_blog_prefix() cannot be made to return the right thing. $wpdb->base_prefix is not explicitly marked as public, so we prefer to use get_blog_prefix if we can, for future compatibility. $prefix = $wpdb->base_prefix; } else { $prefix = $wpdb->get_blog_prefix(0); } return ($allow_override) ? apply_filters('updraftplus_get_table_prefix', $prefix) : $prefix; } public function siteid() { $sid = get_site_option('updraftplus-addons_siteid'); if (!is_string($sid) || empty($sid)) { $sid = md5(rand().microtime(true).home_url()); update_site_option('updraftplus-addons_siteid', $sid); } return $sid; } public function show_admin_warning_unreadablelog() { global $updraftplus_admin; $updraftplus_admin->show_admin_warning('<strong>'.__('UpdraftPlus notice:', 'updraftplus').'</strong> '.__('The log file could not be read.', 'updraftplus')); } public function show_admin_warning_nolog() { global $updraftplus_admin; $updraftplus_admin->show_admin_warning('<strong>'.__('UpdraftPlus notice:', 'updraftplus').'</strong> '.__('No log files were found.', 'updraftplus')); } public function show_admin_warning_unreadablefile() { global $updraftplus_admin; $updraftplus_admin->show_admin_warning('<strong>'.__('UpdraftPlus notice:', 'updraftplus').'</strong> '.__('The given file was not found, or could not be read.', 'updraftplus')); } /** * Runs upon the WP action plugins_loaded */ public function plugins_loaded() { // Tell WordPress where to find the translations load_plugin_textdomain('updraftplus', false, basename(dirname(__FILE__)).'/languages/'); // The Google Analyticator plugin does something horrible: loads an old version of the Google SDK on init, always - which breaks us if ((defined('DOING_CRON') && DOING_CRON) || (defined('DOING_AJAX') && DOING_AJAX && isset($_REQUEST['subaction']) && 'backupnow' == $_REQUEST['subaction']) || (isset($_GET['page']) && 'updraftplus' == $_GET['page'] )) { remove_action('init', 'ganalyticator_stats_init'); // Appointments+ does the same; but provides a cleaner way to disable it @define('APP_GCAL_DISABLE', true); } add_filter('updraftplus_remotecontrol_command_classes', array($this, 'updraftplus_remotecontrol_command_classes')); add_action('updraftcentral_command_class_wanted', array($this, 'updraftcentral_command_class_wanted')); add_action('updraftcentral_listener_pre_udrpc_action', array($this, 'updraftcentral_listener_pre_udrpc_action')); add_action('updraftcentral_listener_post_udrpc_action', array($this, 'updraftcentral_listener_post_udrpc_action')); if (file_exists(UPDRAFTPLUS_DIR.'/central/bootstrap.php')) { include_once(UPDRAFTPLUS_DIR.'/central/bootstrap.php'); } $load_classes = array(); if (defined('UPDRAFTPLUS_THIS_IS_CLONE')) { $load_classes['UpdraftPlus_Temporary_Clone_Dash_Notice'] = 'includes/updraftclone/temporary-clone-dash-notice.php'; $load_classes['UpdraftPlus_Temporary_Clone_User_Notice'] = 'includes/updraftclone/temporary-clone-user-notice.php'; $load_classes['UpdraftPlus_Temporary_Clone_Restore'] = 'includes/updraftclone/temporary-clone-restore.php'; $load_classes['UpdraftPlus_Temporary_Clone_Auto_Login'] = 'includes/updraftclone/temporary-clone-auto-login.php'; $load_classes['UpdraftPlus_Temporary_Clone_Status'] = 'includes/updraftclone/temporary-clone-status.php'; } foreach ($load_classes as $class => $relative_path) { if (!class_exists($class)) include_once(UPDRAFTPLUS_DIR.'/'.$relative_path); } } /** * Get the character set for the current database connection * * @uses WPDB::determine_charset() - exists on WP 4.6+ * * @param Object|Null $wpdb - WPDB object; if none passed, then use the global one * * @return String */ public function get_connection_charset($wpdb = null) { if (null === $wpdb) { global $wpdb; } $charset = (defined('DB_CHARSET') && DB_CHARSET) ? DB_CHARSET : 'utf8mb4'; if (method_exists($wpdb, 'determine_charset')) { $charset_collate = $wpdb->determine_charset($charset, ''); if (!empty($charset_collate['charset'])) $charset = $charset_collate['charset']; } return $charset; } /** * Runs upon the action updraftcentral_listener_pre_udrpc_action */ public function updraftcentral_listener_pre_udrpc_action() { $this->register_wp_http_option_hooks(); } /** * Runs upon the action updraftcentral_listener_post_udrpc_action */ public function updraftcentral_listener_post_udrpc_action() { $this->register_wp_http_option_hooks(false); } /** * Register our class. WP filter updraftplus_remotecontrol_command_classes. * * @param Array $command_classes sends across the command class * * @return Array - filtered value */ public function updraftplus_remotecontrol_command_classes($command_classes) { if (is_array($command_classes)) $command_classes['updraftplus'] = 'UpdraftCentral_UpdraftPlus_Commands'; if (is_array($command_classes)) $command_classes['updraftvault'] = 'UpdraftCentral_UpdraftVault_Commands'; return $command_classes; } /** * Load the class when required * * @param string $command_php_class Sends across the php class type */ public function updraftcentral_command_class_wanted($command_php_class) { if ('UpdraftCentral_UpdraftPlus_Commands' == $command_php_class) { include_once(UPDRAFTPLUS_DIR.'/includes/class-updraftcentral-updraftplus-commands.php'); } elseif ('UpdraftCentral_UpdraftVault_Commands' == $command_php_class) { include_once(UPDRAFTPLUS_DIR.'/includes/updraftvault.php'); } } /** * This function allows you to manually set the nonce and timestamp for the current backup job. If none are provided then it will create new ones. * * @param boolean|string $nonce - the nonce you want to set * @param boolean|string $timestamp - the timestamp you want to set * * @return string - returns the backup nonce that has been set */ public function backup_time_nonce($nonce = false, $timestamp = false) { $this->job_time_ms = microtime(true); if (false === $timestamp) $timestamp = time(); if (false === $nonce) $nonce = substr(md5(time().rand()), 20); $this->backup_time = $timestamp; $this->file_nonce = apply_filters('updraftplus_incremental_backup_file_nonce', $nonce); $this->nonce = $nonce; return $nonce; } /** * Get the WordPress version * * @return String - the version */ public function get_wordpress_version() { static $got_wp_version = false; if (!$got_wp_version) { global $wp_version; @include(ABSPATH.WPINC.'/version.php'); $got_wp_version = $wp_version; } return $got_wp_version; } /** * Opens the log file, writes a standardised header, and stores the resulting name and handle in the class variables logfile_name/logfile_handle/opened_log_time (and possibly backup_is_already_complete) * * @param string $nonce - Used in the log file name to distinguish it from other log files. Should be the job nonce. * @returns void */ public function logfile_open($nonce) { $updraft_dir = $this->backups_dir_location(); $this->logfile_name = $updraft_dir."/log.$nonce.txt"; if (file_exists($this->logfile_name)) { $seek_to = max((filesize($this->logfile_name) - 340), 1); $handle = fopen($this->logfile_name, 'r'); if (is_resource($handle)) { // Returns 0 on success if (0 === @fseek($handle, $seek_to)) { $bytes_back = filesize($this->logfile_name) - $seek_to; // Return to the end of the file $read_recent = fread($handle, $bytes_back); // Move to end of file - ought to be redundant if (false !== strpos($read_recent, ') The backup apparently succeeded') && false !== strpos($read_recent, 'and is now complete')) { $this->backup_is_already_complete = true; } } fclose($handle); } } $this->logfile_handle = fopen($this->logfile_name, 'a'); $this->opened_log_time = microtime(true); $this->write_log_header(array($this, 'log')); } /** * Writes a standardised header to the log file, using the specified logging function, which needs to be compatible with (or to be) UpdraftPlus::log() * * @param callable $logging_function */ public function write_log_header($logging_function) { global $wpdb; $updraft_dir = $this->backups_dir_location(); call_user_func($logging_function, 'Opened log file at time: '.date('r').' on '.network_site_url()); $wp_version = $this->get_wordpress_version(); $mysql_version = $wpdb->get_var('SELECT VERSION()'); if ('' == $mysql_version) $mysql_version = $wpdb->db_version(); $safe_mode = $this->detect_safe_mode(); $memory_limit = ini_get('memory_limit'); $memory_usage = round(@memory_get_usage(false)/1048576, 1); $memory_usage2 = round(@memory_get_usage(true)/1048576, 1); // Attempt to raise limit to avoid false positives @set_time_limit(UPDRAFTPLUS_SET_TIME_LIMIT); $max_execution_time = (int) @ini_get("max_execution_time"); $logline = "UpdraftPlus WordPress backup plugin (https://updraftplus.com): ".$this->version." WP: ".$wp_version." PHP: ".phpversion()." (".PHP_SAPI.", ".@php_uname().") MySQL: $mysql_version WPLANG: ".get_locale()." Server: ".$_SERVER["SERVER_SOFTWARE"]." safe_mode: $safe_mode max_execution_time: $max_execution_time memory_limit: $memory_limit (used: ${memory_usage}M | ${memory_usage2}M) multisite: ".(is_multisite() ? 'Y' : 'N')." openssl: ".(defined('OPENSSL_VERSION_TEXT') ? OPENSSL_VERSION_TEXT : 'N')." mcrypt: ".(function_exists('mcrypt_encrypt') ? 'Y' : 'N')." LANG: ".getenv('LANG')." ZipArchive::addFile: "; // method_exists causes some faulty PHP installations to segfault, leading to support requests if (version_compare(phpversion(), '5.2.0', '>=') && extension_loaded('zip')) { $logline .= 'Y'; } else { $logline .= (class_exists('ZipArchive') && method_exists('ZipArchive', 'addFile')) ? "Y" : "N"; } if (0 === $this->current_resumption) { $memlim = $this->memory_check_current(); if ($memlim<65 && $memlim>0) { $this->log(sprintf(__('The amount of memory (RAM) allowed for PHP is very low (%s Mb) - you should increase it to avoid failures due to insufficient memory (consult your web hosting company for more help)', 'updraftplus'), round($memlim, 1)), 'warning', 'lowram'); } if ($max_execution_time>0 && $max_execution_time<20) { call_user_func($logging_function, sprintf(__('The amount of time allowed for WordPress plugins to run is very low (%s seconds) - you should increase it to avoid backup failures due to time-outs (consult your web hosting company for more help - it is the max_execution_time PHP setting; the recommended value is %s seconds or more)', 'updraftplus'), $max_execution_time, 90), 'warning', 'lowmaxexecutiontime'); } } call_user_func($logging_function, $logline); $hosting_bytes_free = $this->get_hosting_disk_quota_free(); if (is_array($hosting_bytes_free)) { $perc = round(100*$hosting_bytes_free[1]/(max($hosting_bytes_free[2], 1)), 1); $quota_free = ' / '.sprintf('Free disk space in account: %s (%s used)', round($hosting_bytes_free[3]/1048576, 1)." MB", "$perc %"); if ($hosting_bytes_free[3] < 1048576*50) { $quota_free_mb = round($hosting_bytes_free[3]/1048576, 1); call_user_func($logging_function, sprintf(__('Your free space in your hosting account is very low - only %s Mb remain', 'updraftplus'), $quota_free_mb), 'warning', 'lowaccountspace'.$quota_free_mb); } } else { $quota_free = ''; } $disk_free_space = @disk_free_space($updraft_dir); // == rather than === here is deliberate; support experience shows that a result of (int)0 is not reliable. i.e. 0 can be returned when the real result should be false. if (false == $disk_free_space) { call_user_func($logging_function, "Free space on disk containing Updraft's temporary directory: Unknown".$quota_free); } else { call_user_func($logging_function, "Free space on disk containing Updraft's temporary directory: ".round($disk_free_space/1048576, 1)." MB".$quota_free); $disk_free_mb = round($disk_free_space/1048576, 1); if ($disk_free_space < 50*1048576) call_user_func($logging_function, sprintf(__('Your free disk space is very low - only %s Mb remain', 'updraftplus'), round($disk_free_space/1048576, 1)), 'warning', 'lowdiskspace'.$disk_free_mb); } } /** * This function will read the next chunk from the log file and return it's contents and last read byte position * * @param string $nonce - the UpdraftPlus file nonce * * @return array - an empty array if there is no log file or an array with log file contents and last read byte position */ public function get_last_log_chunk($nonce) { $updraft_dir = $this->backups_dir_location(); $this->logfile_name = $updraft_dir."/log.$nonce.txt"; if (file_exists($this->logfile_name)) { $contents = ''; $seek_to = max(0, $this->jobdata_get('clone_first_byte', 0)); $first_byte = $seek_to; $handle = fopen($this->logfile_name, 'r'); if (is_resource($handle)) { // Returns 0 on success if (0 === @fseek($handle, $seek_to)) { while (strlen($contents) < 1048576 && ($buffer = fgets($handle, 262144)) !== false) { $contents .= $buffer; $seek_to += 262144; } $this->jobdata_set('clone_first_byte', $seek_to); } fclose($handle); } return array('log_contents' => $contents, 'first_byte' => $first_byte); } return array(); } /** * * Verifies that the indicated amount of memory is available * * @param Integer $how_many_bytes_needed - how many bytes need to be available * * @return Boolean - whether the needed number of bytes is available */ public function verify_free_memory($how_many_bytes_needed) { // This returns in MB $memory_limit = $this->memory_check_current(); if (!is_numeric($memory_limit)) return false; $memory_limit = $memory_limit * 1048576; $memory_usage = round(@memory_get_usage(false)/1048576, 1); $memory_usage2 = round(@memory_get_usage(true)/1048576, 1); if ($memory_limit - $memory_usage > $how_many_bytes_needed && $memory_limit - $memory_usage2 > $how_many_bytes_needed) return true; return false; } /** * Logs the given line, adding (relative) time stamp and newline * Note these subtleties of log handling: * - Messages at level 'error' are not logged to file - it is assumed that a separate call to log() at another level will take place. This is because at level 'error', messages are translated; whereas the log file is for developers who may not know the translated language. Messages at level 'error' are for the user. * - Messages at level 'error' do not persist through the job (they are only saved with save_backup_to_history(), and never restored from there - so only the final save_backup_to_history() errors * persist); we presume that either a) they will be cleared on the next attempt, or b) they will occur again on the final attempt (at which point they will go to the user). But... * - messages at level 'warning' persist. These are conditions that are unlikely to be cleared, not-fatal, but the user should be informed about. The $uniq_id field (which should not be numeric) can then be used for warnings that should only be logged once * $skip_dblog = true is suitable when there's a risk of excessive logging, and the information is not important for the user to see in the browser on the settings page * The uniq_id field is also used with PHP event detection - it is set then to 'php_event' - which is useful for anything hooking the action to detect * * @param string $line the log line * @param string $level the log level: notice, warning, error. If suffixed with a hyphen and a destination, then the default destination is changed too. * @param boolean $uniq_id each of these will only be logged once * @param boolean $skip_dblog if true, then do not write to the database * @return null */ public function log($line, $level = 'notice', $uniq_id = false, $skip_dblog = false) { $destination = 'default'; if (preg_match('/^([a-z]+)-([a-z]+)$/', $level, $matches)) { $level = $matches[1]; $destination = $matches[2]; } if ('error' == $level || 'warning' == $level) { if ('error' == $level && 0 == $this->error_count()) $this->log('An error condition has occurred for the first time during this job'); if ($uniq_id) { $this->errors[$uniq_id] = array('level' => $level, 'message' => $line); } else { $this->errors[] = array('level' => $level, 'message' => $line); } // Errors are logged separately if ('error' == $level) return; // It's a warning $warnings = $this->jobdata_get('warnings'); if (!is_array($warnings)) $warnings = array(); if ($uniq_id) { $warnings[$uniq_id] = $line; } else { $warnings[] = $line; } $this->jobdata_set('warnings', $warnings); } if (false === ($line = apply_filters('updraftplus_logline', $line, $this->nonce, $level, $uniq_id, $destination))) return; if ($this->logfile_handle) { // Record log file times relative to the backup start, if possible $rtime = (!empty($this->job_time_ms)) ? microtime(true)-$this->job_time_ms : microtime(true)-$this->opened_log_time; fwrite($this->logfile_handle, sprintf("%08.03f", round($rtime, 3))." (".$this->current_resumption.") ".(('notice' != $level) ? '['.ucfirst($level).'] ' : '').$line."\n"); } switch ($this->jobdata_get('job_type')) { case 'download': // Download messages are keyed on the job (since they could be running several), and type // The values of the POST array were checked before $findex = empty($_POST['findex']) ? 0 : $_POST['findex']; if (!empty($_POST['timestamp']) && !empty($_POST['type'])) $this->jobdata_set('dlmessage_'.$_POST['timestamp'].'_'.$_POST['type'].'_'.$findex, $line); break; case 'restore': // if ('debug' != $level) echo $line."\n"; break; default: if (!$skip_dblog && 'debug' != $level) UpdraftPlus_Options::update_updraft_option('updraft_lastmessage', $line." (".date_i18n('M d H:i:s').")", false); break; } if (defined('UPDRAFTPLUS_CONSOLELOG') && UPDRAFTPLUS_CONSOLELOG) echo $line."\n"; if (defined('UPDRAFTPLUS_BROWSERLOG') && UPDRAFTPLUS_BROWSERLOG) echo htmlentities($line)."<br>\n"; } /** * Remove any logged warnings with the specified identifier. (The use case for this is that you can warn of something that may be about to happen (with a probably crash if it does), and then remove the warning if it did not happen). * * @see self::log() * * @param String $uniq_id - the identifier, previously passed to self::log() */ public function log_remove_warning($uniq_id) { $warnings = $this->jobdata_get('warnings'); if (!is_array($warnings)) $warnings = array(); unset($warnings[$uniq_id]); $this->jobdata_set('warnings', $warnings); unset($this->errors[$uniq_id]); } /** * For efficiency, you can also feed false or a string into this function * * @param Boolean|String|WP_Error $err - the errors * @param Boolean $echo - whether to echo() the error(s) * @param Boolean $logerror - whether to pass errors to UpdraftPlus::log() * @return Boolean - returns false for convenience */ public function log_wp_error($err, $echo = false, $logerror = false) { if (false === $err) return false; if (is_string($err)) { $this->log("Error message: $err"); if ($echo) $this->log(sprintf(__('Error: %s', 'updraftplus'), $err), 'notice-warning'); if ($logerror) $this->log($err, 'error'); return false; } foreach ($err->get_error_messages() as $msg) { $this->log("Error message: $msg"); if ($echo) $this->log(sprintf(__('Error: %s', 'updraftplus'), $msg), 'notice-warning'); if ($logerror) $this->log($msg, 'error'); } $codes = $err->get_error_codes(); if (is_array($codes)) { foreach ($codes as $code) { $data = $err->get_error_data($code); if (!empty($data)) { $ll = (is_string($data)) ? $data : serialize($data); $this->log("Error data (".$code."): ".$ll); } } } // Returns false so that callers can return with false more efficiently if they wish return false; } /** * This function will construct the restore information log line using the passed in parameters and then log the line using $this->log(); * * @param array $restore_information - an array of restore information * * @return void */ public function log_restore_update($restore_information) { $this->log("RINFO:".json_encode($restore_information), 'notice-progress'); } /** * Get the maximum packet size on the WPDB MySQL connection, in bytes, after (optionally) attempting to raise it to 32MB if it appeared to be lower. * A default value equal to 1MB is returned if the true value could not be found - it has been found reasonable to assume that at least this is available. * * @param Boolean $first_raise * @param Boolean $log_it * * @return Integer */ public function max_packet_size($first_raise = true, $log_it = true) { global $wpdb; $mp = (int) $wpdb->get_var("SELECT @@session.max_allowed_packet"); // Default to 1MB $mp = (is_numeric($mp) && $mp > 0) ? $mp : 1048576; // 32MB if ($first_raise && $mp < 33554432) { $save = $wpdb->show_errors(false); $req = @$wpdb->query("SET GLOBAL max_allowed_packet=33554432"); $wpdb->show_errors($save); if (!$req) $this->log("Tried to raise max_allowed_packet from ".round($mp/1048576, 1)." MB to 32 MB, but failed (".$wpdb->last_error.", ".serialize($req).")"); $mp = (int) $wpdb->get_var("SELECT @@session.max_allowed_packet"); // Default to 1MB $mp = (is_numeric($mp) && $mp > 0) ? $mp : 1048576; } if ($log_it) $this->log("Max packet size: ".round($mp/1048576, 1)." MB"); return $mp; } /** * Q. Why is this abstracted into a separate function? A. To allow poedit and other parsers to pick up the need to translate strings passed to it (and not pick up all of those passed to log()). * 1st argument = the line to be logged (obligatory) * Further arguments = parameters for sprintf() * * @return null */ public function log_e() { $args = func_get_args(); // Get first argument $pre_line = array_shift($args); // Log it whilst still in English if (is_wp_error($pre_line)) { $this->log_wp_error($pre_line); } else { // Now run (v)sprintf on it, using any remaining arguments. vsprintf = sprintf but takes an array instead of individual arguments $this->log(vsprintf($pre_line, $args)); // This is slightly hackish, in that we have no way to use a different level or destination. In that case, the caller should instead call log() twice with different parameters, instead of using this convenience function. $this->log(vsprintf($pre_line, $args), 'notice-restore'); } } /** * This function is used by cloud methods to provide standardised logging, but more importantly to help us detect that meaningful activity took place during a resumption run, so that we can schedule further resumptions if it is worthwhile * * @param Number $percent - the amount of the file uploaded * @param String $extra - anything extra to include in the log message * @param Boolean $file_path - the full path to the file being uploaded * @param Boolean $log_it - whether to pass the message to UpdraftPlus::log() * @return Void */ public function record_uploaded_chunk($percent, $extra = '', $file_path = false, $log_it = true) { // Touch the original file, which helps prevent overlapping runs if ($file_path) touch($file_path); // What this means in effect is that at least one of the files touched during the run must reach this percentage (so lapping round from 100 is OK) if ($percent > 0.7 * ($this->current_resumption - max($this->jobdata_get('uploaded_lastreset'), 9))) UpdraftPlus_Job_Scheduler::something_useful_happened(); // Log it global $updraftplus_backup; $log = (!empty($updraftplus_backup->current_service)) ? ucfirst($updraftplus_backup->current_service)." chunked upload: $percent % uploaded" : ''; if ($log && $log_it) $this->log($log.(($extra) ? " ($extra)" : '')); // If we are on an 'overtime' resumption run, and we are still meaningfully uploading, then schedule a new resumption // Our definition of meaningful is that we must maintain an overall average of at least 0.7% per run, after allowing 9 runs for everything else to get going // i.e. Max 100/.7 + 9 = 150 runs = 760 minutes = 12 hrs 40, if spaced at 5 minute intervals. However, our algorithm now decreases the intervals if it can, so this should not really come into play // If they get 2 minutes on each run, and the file is 1GB, then that equals 10.2MB/120s = minimum 59KB/s upload speed required $upload_status = $this->jobdata_get('uploading_substatus'); if (is_array($upload_status)) { $upload_status['p'] = $percent/100; $this->jobdata_set('uploading_substatus', $upload_status); } } /** * Method for helping remote storage methods to upload files in chunks without needing to duplicate all the overhead * * @param object $caller the object to call back to do the actual network API calls; needs to have a chunked_upload() method. * @param string $file the full path to the file * @param string $cloudpath this is passed back to the callback function; within this function, it is used only for logging * @param string $logname the prefix used on log lines. Also passed back to the callback function. * @param integer $chunk_size the size, in bytes, of each upload chunk * @param integer $uploaded_size how many bytes have already been uploaded. This is passed back to the callback function; within this method, it is only used for logging. * @param boolean $singletons when the file, given the chunk size, would only have one chunk, should that be uploaded (true), or instead should 1 be returned (false) ? * @return boolean */ public function chunked_upload($caller, $file, $cloudpath, $logname, $chunk_size, $uploaded_size, $singletons = false) { $fullpath = $this->backups_dir_location().'/'.$file; $orig_file_size = filesize($fullpath); if ($uploaded_size >= $orig_file_size && !method_exists($caller, 'chunked_upload_finish')) return true; $chunks = floor($orig_file_size / $chunk_size); // There will be a remnant unless the file size was exactly on a chunk boundary if ($orig_file_size % $chunk_size > 0) $chunks++; $this->log("$logname upload: $file (chunks: $chunks, of size: $chunk_size) -> $cloudpath ($uploaded_size)"); if (0 == $chunks) { return 1; } elseif ($chunks < 2 && !$singletons) { return 1; } // We have multiple chunks if ($uploaded_size < $orig_file_size) { if (false == ($fp = @fopen($fullpath, 'rb'))) { $this->log("$logname: failed to open file: $fullpath"); $this->log("$file: ".sprintf(__('%s Error: Failed to open local file', 'updraftplus'), $logname), 'error'); return false; } $upload_start = 0; $upload_end = -1; $chunk_index = 1; // The file size minus one equals the byte offset of the final byte $upload_end = min($chunk_size - 1, $orig_file_size - 1); $errors_on_this_chunk = 0; while ($upload_start < $orig_file_size) { // Don't forget the +1; otherwise the last byte is omitted $upload_size = $upload_end - $upload_start + 1; if ($upload_start) fseek($fp, $upload_start); /* * Valid return values for $uploaded are many, as the possibilities have grown over time. * This could be cleaned up; but, it works, and it's not hugely complex. * * WP_Error : an error occured. The only permissible codes are: reduce_chunk_size (only on the first chunk), try_again * (bool)true : What was requested was done * (int)1 : What was requested was done, but do not log anything * (bool)false : There was an error * (Object) : Properties: * (bool)log: (bool) - if absent, defaults to true * (int)new_chunk_size: advisory amount for the chunk size for future chunks * NOT IMPLEMENTED: (int)bytes_uploaded: Actual number of bytes uploaded (needs to be positive - o/w, should return an error instead) * N.B. Consumers should consult $fp and $upload_start to get data; they should not re-calculate from $chunk_index, which is not an indicator of file position. */ $uploaded = $caller->chunked_upload($file, $fp, $chunk_index, $upload_size, $upload_start, $upload_end, $orig_file_size); // Try again? (Just once - added in 1.12.6 (can make more sophisticated if there is a need)) if (is_wp_error($uploaded) && 'try_again' == $uploaded->get_error_code()) { // Arbitrary wait sleep(3); $this->log("Re-trying after wait (to allow apparent inconsistency to clear)"); $uploaded = $caller->chunked_upload($file, $fp, $chunk_index, $upload_size, $upload_start, $upload_end, $orig_file_size); } // This is the only other supported case of a WP_Error - otherwise, a boolean must be returned // Note that this is only allowed on the first chunk. The caller is responsible to remember its chunk size if it uses this facility. if (1 == $chunk_index && is_wp_error($uploaded) && 'reduce_chunk_size' == $uploaded->get_error_code() && false != ($new_chunk_size = $uploaded->get_error_data()) && is_numeric($new_chunk_size)) { $this->log("Re-trying with new chunk size: ".$new_chunk_size); return $this->chunked_upload($caller, $file, $cloudpath, $logname, $new_chunk_size, $uploaded_size, $singletons); } $uploaded_amount = $chunk_size; /* // Not using this approach for now. Instead, going to allow the consumers to increase the next chunk size if (is_object($uploaded) && isset($uploaded->bytes_uploaded)) { if (!$uploaded->bytes_uploaded) { $uploaded = false; } else { $uploaded_amount = $uploaded->bytes_uploaded; $uploaded = (!isset($uploaded->log) || $uploaded->log) ? true : 1; } } */ if (is_object($uploaded) && isset($uploaded->new_chunk_size)) { if ($uploaded->new_chunk_size >= 1048576) $new_chunk_size = $uploaded->new_chunk_size; $uploaded = (!isset($uploaded->log) || $uploaded->log) ? true : 1; } // The joys of PHP: is_wp_error() is not false-y. if ($uploaded && !is_wp_error($uploaded)) { $perc = round(100*($upload_end + 1)/max($orig_file_size, 1), 1); // Consumers use a return value of (int)1 (rather than (bool)true) to suppress logging $log_it = (1 === $uploaded) ? false : true; $this->record_uploaded_chunk($perc, $chunk_index, $fullpath, $log_it); // $uploaded_bytes = $upload_end + 1; // If there was an error, then we re-try the same chunk; we don't move on to the next one. Otherwise, we would need more code to handle potential 'intermediate' failed chunks (in case PHP dies before this method eventually returns false, and thus the intermediate chunk failure never gets detected) $chunk_index++; $errors_on_this_chunk = 0; $upload_start = $upload_end + 1; $upload_end += isset($new_chunk_size) ? $uploaded_amount + $new_chunk_size - $chunk_size : $uploaded_amount; $upload_end = min($upload_end, $orig_file_size - 1); } else { $errors_on_this_chunk++; // Either $uploaded is false-y, or is a WP_Error if (is_wp_error($uploaded)) { $this->log("$logname: Chunk upload ($chunk_index) failed (".$uploaded->get_error_code().'): '.$uploaded->get_error_message()); } else { $this->log("$logname: Chunk upload ($chunk_index) failed"); } if ($errors_on_this_chunk >= 3) { @fclose($fp); return false; } } } @fclose($fp); } // All chunks are uploaded - now combine the chunks $ret = true; // The action calls here exist to aid debugging if (method_exists($caller, 'chunked_upload_finish')) { do_action('updraftplus_pre_chunked_upload_finish', $file, $caller); $ret = $caller->chunked_upload_finish($file); if (!$ret) { $this->log("$logname - failed to re-assemble chunks"); $this->log(sprintf(__('%s error - failed to re-assemble chunks', 'updraftplus'), $logname), 'error'); } do_action('updraftplus_post_chunked_upload_finish', $file, $caller, $ret); } if ($ret) { // We allow chunked_upload_finish to return (int)1 to indicate that it took care of any logging. if (true === $ret) $this->log("$logname upload: success"); $ret = true; // UpdraftPlus_RemoteStorage_Addons_Base calls this itself if (!is_a($caller, 'UpdraftPlus_RemoteStorage_Addons_Base_v2')) $this->uploaded_file($file); } return $ret; } /** * Provides a convenience function allowing remote storage methods to download a file in chunks, without duplicated overhead. * * @param string $file - The basename of the file being downloaded * @param object $method - This remote storage method object needs to have a chunked_download() method to call back * @param integer $remote_size - The size, in bytes, of the object being downloaded * @param boolean $manually_break_up - Whether to break the download into multiple network operations (rather than just issuing a GET with a range beginning at the end of the already-downloaded data, and carrying on until it times out) * @param Mixed $passback - A value to pass back to the callback function * @param integer $chunk_size - Break up the download into chunks of this number of bytes. Should be set if and only if $manually_break_up is true. */ public function chunked_download($file, $method, $remote_size, $manually_break_up = false, $passback = null, $chunk_size = 1048576) { try { $fullpath = $this->backups_dir_location().'/'.$file; $start_offset = file_exists($fullpath) ? filesize($fullpath) : 0; if ($start_offset >= $remote_size) { $this->log("File is already completely downloaded ($start_offset/$remote_size)"); return true; } // Some more remains to download - so let's do it // N.B. We use ftell(), which precludes us from using open in append-only ('a') mode - see https://php.net/manual/en/function.fopen.php if (!($fh = fopen($fullpath, 'c'))) {// phpcs:ignore PHPCompatibility.ParameterValues.NewFopenModes.cFound -- Passing "c" as the $mode to fopen() is not supported in PHP 5.2.5 or lower. Found 'c' $this->log("Error opening local file: $fullpath"); $this->log($file.": ".__("Error", 'updraftplus').": ".__('Error opening local file: Failed to download', 'updraftplus'), 'error'); return false; } $last_byte = ($manually_break_up) ? min($remote_size, $start_offset + $chunk_size) : $remote_size; // This only affects logging $expected_bytes_delivered_so_far = true; while ($start_offset < $remote_size) { $headers = array(); // If resuming, then move to the end of the file $requested_bytes = $last_byte-$start_offset; if ($expected_bytes_delivered_so_far) { $this->log("$file: local file is status: $start_offset/$remote_size bytes; requesting next $requested_bytes bytes"); } else { $this->log("$file: local file is status: $start_offset/$remote_size bytes; requesting next chunk (${start_offset}-)"); } if ($start_offset > 0 || $last_byte<$remote_size) { fseek($fh, $start_offset); // N.B. Don't alter this format without checking what relies upon it $last_byte_start = $last_byte - 1; $headers['Range'] = "bytes=$start_offset-$last_byte_start"; } /* * The most common method is for the remote storage module to return a string with the results in it. In that case, the final $fh parameter is unused. However, since not all SDKs have that option conveniently, it is also possible to use the file handle and write directly to that; in that case, the method can either return the number of bytes written, or (boolean)true to infer it from the new file *pointer*. * The method is free to write/return as much data as it pleases. */ $ret = $method->chunked_download($file, $headers, $passback, $fh); if (true === $ret) { clearstatcache(); // Some SDKs (including AWS/S3) close the resource // N.B. We use ftell(), which precludes us from using open in append-only ('a') mode - see https://php.net/manual/en/function.fopen.php if (is_resource($fh)) { $ret = ftell($fh); } else { $ret = filesize($fullpath); // fseek returns - on success if (false == ($fh = fopen($fullpath, 'c')) || 0 !== fseek($fh, $ret)) {// phpcs:ignore PHPCompatibility.ParameterValues.NewFopenModes.cFound -- Passing "c" as the $mode to fopen() is not supported in PHP 5.2.5 or lower. Found 'c' $this->log("Error opening local file: $fullpath"); $this->log($file.": ".__("Error", 'updraftplus').": ".__('Error opening local file: Failed to download', 'updraftplus'), 'error'); return false; } } if (is_integer($ret)) $ret -= $start_offset; } // Note that this covers a false code returned either by chunked_download() or by ftell. if (false === $ret) return false; $returned_bytes = is_integer($ret) ? $ret : strlen($ret); if ($returned_bytes > $requested_bytes || $returned_bytes < $requested_bytes - 1) $expected_bytes_delivered_so_far = false; if (!is_integer($ret) && !fwrite($fh, $ret)) throw new Exception('Write failure (start offset: '.$start_offset.', bytes: '.strlen($ret).'; requested: '.$requested_bytes.')'); clearstatcache(); $start_offset = ftell($fh); $last_byte = ($manually_break_up) ? min($remote_size, $start_offset + $chunk_size) : $remote_size; } } catch (Exception $e) { $this->log('Error ('.get_class($e).') - failed to download the file ('.$e->getCode().', '.$e->getMessage().', line '.$e->getLine().' in '.$e->getFile().')'); $this->log("$file: ".__('Error - failed to download the file', 'updraftplus').' ('.$e->getCode().', '.$e->getMessage().')', 'error'); return false; } fclose($fh); return true; } /** * Detect if safe_mode is on. N.B. This is abolished from PHP 7.0 * * @return Integer - 1 or 0 */ public function detect_safe_mode() { // @codingStandardsIgnoreLine return (@ini_get('safe_mode') && 'off' != strtolower(@ini_get('safe_mode'))) ? 1 : 0; } /** * Find, if possible, a working mysqldump executable * * @param Boolean $logit - whether to log the workings or not * @param Boolean $cacheit - whether to cache the results for subsequent queries or not * * @return String|Boolean - either a path to an executable, or false for failure */ public function find_working_sqldump($logit = true, $cacheit = true) { // The hosting provider may have explicitly disabled the popen or proc_open functions if ($this->detect_safe_mode() || !function_exists('popen') || !function_exists('escapeshellarg')) { if ($cacheit) $this->jobdata_set('binsqldump', false); return false; } $existing = $this->jobdata_get('binsqldump', null); // Theoretically, we could have moved machines, due to a migration if (null !== $existing && (!is_string($existing) || @is_executable($existing))) return $existing; $updraft_dir = $this->backups_dir_location(); global $wpdb; $table_name = $wpdb->get_blog_prefix().'options'; $tmp_file = md5(time().rand()).".sqltest.tmp"; $pfile = md5(time().rand()).'.tmp'; file_put_contents($updraft_dir.'/'.$pfile, "[mysqldump]\npassword=".DB_PASSWORD."\n"); $result = false; foreach (explode(',', UPDRAFTPLUS_MYSQLDUMP_EXECUTABLE) as $potsql) { if (!@is_executable($potsql)) continue; if ($logit) $this->log("Testing potential mysqldump binary: $potsql"); if ('win' == strtolower(substr(PHP_OS, 0, 3))) { $exec = "cd ".escapeshellarg(str_replace('/', '\\', $updraft_dir))." & "; $siteurl = "'siteurl'"; if (false !== strpos($potsql, ' ')) $potsql = '"'.$potsql.'"'; } else { $exec = "cd ".escapeshellarg($updraft_dir)."; "; $siteurl = "\\'siteurl\\'"; if (false !== strpos($potsql, ' ')) $potsql = "'$potsql'"; } $exec .= "$potsql --defaults-file=$pfile --max_allowed_packet=1M --quote-names --add-drop-table --skip-comments --skip-set-charset --allow-keywords --dump-date --extended-insert --where=option_name=$siteurl --user=".escapeshellarg(DB_USER)." --host=".escapeshellarg(DB_HOST)." ".DB_NAME." ".escapeshellarg($table_name).""; $handle = popen($exec, "r"); if ($handle) { if (!feof($handle)) { $output = fread($handle, 8192); if ($output && $logit) { $log_output = (strlen($output) > 512) ? substr($output, 0, 512).' (truncated - '.strlen($output).' bytes total)' : $output; $this->log("Output: ".str_replace("\n", '\\n', trim($log_output))); } } else { $output = ''; } $ret = pclose($handle); if (0 != $ret) { if ($logit) { $this->log("Binary mysqldump: error (code: $ret)"); } } else { // $dumped = file_get_contents($updraft_dir.'/'.$tmp_file, false, null, 0, 4096); if (stripos($output, 'insert into') !== false) { if ($logit) $this->log("Working binary mysqldump found: $potsql"); $result = $potsql; break; } } } else { if ($logit) $this->log("Error: popen failed"); } } @unlink($updraft_dir.'/'.$pfile); @unlink($updraft_dir.'/'.$tmp_file); if ($cacheit) $this->jobdata_set('binsqldump', $result); return $result; } /** * This function will work out which zip object we want to use and return it's name * * @return string - the name of the zip object we want to use */ public function get_zip_object_name() { if (!class_exists('UpdraftPlus_BinZip')) include_once(UPDRAFTPLUS_DIR . '/includes/class-zip.php'); $zip_object = 'UpdraftPlus_ZipArchive'; // In tests, PclZip was found to be 25% slower than ZipArchive if (((defined('UPDRAFTPLUS_PREFERPCLZIP') && UPDRAFTPLUS_PREFERPCLZIP == true) || !class_exists('ZipArchive') || !class_exists('UpdraftPlus_ZipArchive') || (!extension_loaded('zip') && !method_exists('ZipArchive', 'AddFile')))) { $zip_object = 'UpdraftPlus_PclZip'; } return $zip_object; } /** * We require -@ and -u -r to work - which is the usual Linux binzip * * @param Boolean $logit - whether to record the results with UpdraftPlus::log() * @param Boolean $cacheit - whether to cache the results as job data * @return String|Boolean - the path to a working zip binary, or false */ public function find_working_bin_zip($logit = true, $cacheit = true) { if ($this->detect_safe_mode()) return false; // The hosting provider may have explicitly disabled the popen or proc_open functions if (!function_exists('popen') || !function_exists('proc_open') || !function_exists('escapeshellarg')) { if ($cacheit) $this->jobdata_set('binzip', false); return false; } $existing = $this->jobdata_get('binzip', null); // Theoretically, we could have moved machines, due to a migration if (null !== $existing && (!is_string($existing) || @is_executable($existing))) return $existing; $updraft_dir = $this->backups_dir_location(); foreach (explode(',', UPDRAFTPLUS_ZIP_EXECUTABLE) as $potzip) { if (!@is_executable($potzip)) continue; if ($logit) $this->log("Testing: $potzip"); // Test it, see if it is compatible with Info-ZIP // If you have another kind of zip, then feel free to tell me about it @mkdir($updraft_dir.'/binziptest/subdir1/subdir2', 0777, true); if (!file_exists($updraft_dir.'/binziptest/subdir1/subdir2')) return false; file_put_contents($updraft_dir.'/binziptest/subdir1/subdir2/test.html', '<html><body><a href="https://updraftplus.com">UpdraftPlus is a great backup and restoration plugin for WordPress.</a></body></html>'); @unlink($updraft_dir.'/binziptest/test.zip'); if (is_file($updraft_dir.'/binziptest/subdir1/subdir2/test.html')) { $exec = "cd ".escapeshellarg($updraft_dir)."; $potzip"; if (defined('UPDRAFTPLUS_BINZIP_OPTS') && UPDRAFTPLUS_BINZIP_OPTS) $exec .= ' '.UPDRAFTPLUS_BINZIP_OPTS; $exec .= " -v -u -r binziptest/test.zip binziptest/subdir1"; $all_ok=true; $handle = popen($exec, "r"); if ($handle) { while (!feof($handle)) { $w = fgets($handle); if ($w && $logit) $this->log("Output: ".trim($w)); } $ret = pclose($handle); if (0 != $ret) { if ($logit) $this->log("Binary zip: error (code: $ret)"); $all_ok = false; } } else { if ($logit) $this->log("Error: popen failed"); $all_ok = false; } // Now test -@ if (true == $all_ok) { file_put_contents($updraft_dir.'/binziptest/subdir1/subdir2/test2.html', '<html><body><a href="https://updraftplus.com">UpdraftPlus is a really great backup and restoration plugin for WordPress.</a></body></html>'); $exec = $potzip; if (defined('UPDRAFTPLUS_BINZIP_OPTS') && UPDRAFTPLUS_BINZIP_OPTS) $exec .= ' '.UPDRAFTPLUS_BINZIP_OPTS; $exec .= " -v -@ binziptest/test.zip"; $all_ok = true; $descriptorspec = array( 0 => array('pipe', 'r'), 1 => array('pipe', 'w'), 2 => array('pipe', 'w') ); $handle = proc_open($exec, $descriptorspec, $pipes, $updraft_dir); if (is_resource($handle)) { if (!fwrite($pipes[0], "binziptest/subdir1/subdir2/test2.html\n")) { @fclose($pipes[0]); @fclose($pipes[1]); @fclose($pipes[2]); $all_ok = false; } else { fclose($pipes[0]); while (!feof($pipes[1])) { $w = fgets($pipes[1]); if ($w && $logit) $this->log("Output: ".trim($w)); } fclose($pipes[1]); while (!feof($pipes[2])) { $last_error = fgets($pipes[2]); if (!empty($last_error) && $logit) $this->log("Stderr output: ".trim($w)); } fclose($pipes[2]); $ret = proc_close($handle); if (0 != $ret) { if ($logit) $this->log("Binary zip: error (code: $ret)"); $all_ok = false; } } } else { if ($logit) $this->log("Error: proc_open failed"); $all_ok = false; } } // Do we now actually have a working zip? Need to test the created object using PclZip // If it passes, then remove dirs and then return $potzip; $found_first = false; $found_second = false; if ($all_ok && file_exists($updraft_dir.'/binziptest/test.zip')) { if (function_exists('gzopen')) { if (!class_exists('PclZip')) include_once(ABSPATH.'/wp-admin/includes/class-pclzip.php'); $zip = new PclZip($updraft_dir.'/binziptest/test.zip'); $foundit = 0; if (($list = $zip->listContent()) != 0) { foreach ($list as $obj) { if ($obj['filename'] && !empty($obj['stored_filename']) && 'binziptest/subdir1/subdir2/test.html' == $obj['stored_filename'] && 131 == $obj['size']) $found_first=true; if ($obj['filename'] && !empty($obj['stored_filename']) && 'binziptest/subdir1/subdir2/test2.html' == $obj['stored_filename'] && 138 == $obj['size']) $found_second=true; } } } else { // PclZip will die() if gzopen is not found // Obviously, this is a kludge - we assume it's working. We could, of course, just return false - but since we already know now that PclZip can't work, that only leaves ZipArchive $this->log("gzopen function not found; PclZip cannot be invoked; will assume that binary zip works if we have a non-zero file"); if (filesize($updraft_dir.'/binziptest/test.zip') > 0) { $found_first = true; $found_second = true; } } } $this->remove_binzip_test_files($updraft_dir); if ($found_first && $found_second) { if ($logit) $this->log("Working binary zip found: $potzip"); if ($cacheit) $this->jobdata_set('binzip', $potzip); return $potzip; } } $this->remove_binzip_test_files($updraft_dir); } if ($cacheit) $this->jobdata_set('binzip', false); return false; } /** * Remove potentially existing test files after binzip testing * * @param String $updraft_dir - directory to find the files in */ private function remove_binzip_test_files($updraft_dir) { @unlink($updraft_dir.'/binziptest/subdir1/subdir2/test.html'); @unlink($updraft_dir.'/binziptest/subdir1/subdir2/test2.html'); @rmdir($updraft_dir.'/binziptest/subdir1/subdir2'); @rmdir($updraft_dir.'/binziptest/subdir1'); @unlink($updraft_dir.'/binziptest/test.zip'); @rmdir($updraft_dir.'/binziptest'); } public function option_filter_get($which) { global $wpdb; $row = $wpdb->get_row($wpdb->prepare("SELECT option_value FROM $wpdb->options WHERE option_name = %s LIMIT 1", $which)); // Has to be get_row instead of get_var because of funkiness with 0, false, null values return (is_object($row)) ? $row->option_value : false; } /** * Indicate which checksums to take for backup files. Abstracted for extensibilty and future changes. * * @returns array - a list of hashing algorithms, as understood by PHP's hash() function */ public function which_checksums() { return apply_filters('updraftplus_which_checksums', array('sha1', 'sha256')); } /** * Pretty printing of the raw backup information * * @param String $description * @param Array $history * @param String $entity * @param Array $checksums * @param Array $jobdata * @param Boolean $smaller * @return String */ public function printfile($description, $history, $entity, $checksums, $jobdata, $smaller = false) { if (empty($history[$entity])) return; // PHP 7.2+ throws a warning if you try to count() a string $how_many = is_string($history[$entity]) ? 1 : count($history[$entity]); if ($smaller) { $pfiles = "<strong>".$description." (".sprintf(__('files: %s', 'updraftplus'), $how_many).")</strong><br>\n"; } else { $pfiles = "<h3>".$description." (".sprintf(__('files: %s', 'updraftplus'), $how_many).")</h3>\n\n"; } $is_incremental = (!empty($jobdata) && !empty($jobdata['job_type']) && 'incremental' == $jobdata['job_type'] && 'db' != substr($entity, 0, 2)) ? true : false; if ($is_incremental) { $backup_timestamp = $jobdata['backup_time']; $backup_history = UpdraftPlus_Backup_History::get_history($backup_timestamp); $pfiles .= "<dl>"; foreach ($backup_history['incremental_sets'] as $timestamp => $backup) { if (isset($backup[$entity])) { $pfiles .= "<dt>".get_date_from_gmt(gmdate('Y-m-d H:i:s', (int) $timestamp), 'M d, Y G:i')."\n</dt>\n"; foreach ($backup[$entity] as $ind => $file) { $pfiles .= "<dd>".$this->get_entity_row($file, $history, $entity, $checksums, $jobdata, $ind)."\n</dd>\n"; } } } $pfiles .= "</dl>\n"; } else { $pfiles .= "<ul>"; $files = $history[$entity]; if (is_string($files)) $files = array($files); foreach ($files as $ind => $file) { $pfiles .= "<li>".$this->get_entity_row($file, $history, $entity, $checksums, $jobdata, $ind)."\n</li>\n"; } $pfiles .= "</ul>\n"; } return $pfiles; } /** * This function will use the passed in information to prepare a pretty string describing the backup from the raw backup history * * @param String $file - the backup file * @param Array $history - the backup history * @param String $entity - the backup entity * @param Array $checksums - checksums for the backup file * @param Array $jobdata - the jobdata for this backup * @param integer $ind - the index of the file * * @return String - returns the entity output string */ public function get_entity_row($file, $history, $entity, $checksums, $jobdata, $ind) { $op = htmlspecialchars($file)."\n"; $skey = $entity.((0 == $ind) ? '' : $ind).'-size'; $meta = ''; if ('db' == substr($entity, 0, 2) && 'db' != $entity) { $dind = substr($entity, 2); if (is_array($jobdata) && !empty($jobdata['backup_database']) && is_array($jobdata['backup_database']) && !empty($jobdata['backup_database'][$dind]) && is_array($jobdata['backup_database'][$dind]['dbinfo']) && !empty($jobdata['backup_database'][$dind]['dbinfo']['host'])) { $dbinfo = $jobdata['backup_database'][$dind]['dbinfo']; $meta .= sprintf(__('External database (%s)', 'updraftplus'), $dbinfo['user'].'@'.$dbinfo['host'].'/'.$dbinfo['name'])."<br>"; } } if (isset($history[$skey])) $meta .= sprintf(__('Size: %s MB', 'updraftplus'), round($history[$skey]/1048576, 1)); $ckey = $entity.$ind; foreach ($checksums as $ck) { $ck_plain = false; if (isset($history['checksums'][$ck][$ckey])) { $meta .= (($meta) ? ', ' : '').sprintf(__('%s checksum: %s', 'updraftplus'), strtoupper($ck), $history['checksums'][$ck][$ckey]); $ck_plain = true; } if (isset($history['checksums'][$ck][$ckey.'.crypt'])) { if ($ck_plain) $meta .= ' '.__('(when decrypted)'); $meta .= (($meta) ? ', ' : '').sprintf(__('%s checksum: %s', 'updraftplus'), strtoupper($ck), $history['checksums'][$ck][$ckey.'.crypt']); } } $fileinfo = apply_filters("updraftplus_fileinfo_$entity", array(), $ind); if (is_array($fileinfo) && !empty($fileinfo)) { if (isset($fileinfo['html'])) { $meta .= $fileinfo['html']; } } // if ($meta) $meta = " ($meta)"; if ($meta) $meta = "<br><em>$meta</em>"; return $op.$meta; } /** * This important function returns a list of file entities that can potentially be backed up (subject to users settings), and optionally further meta-data about them * * @param boolean $include_others * @param boolean $full_info * @return array */ public function get_backupable_file_entities($include_others = true, $full_info = false) { $wp_upload_dir = $this->wp_upload_dir(); if ($full_info) { $arr = array( 'plugins' => array('path' => untrailingslashit(WP_PLUGIN_DIR), 'description' => __('Plugins', 'updraftplus')), 'themes' => array('path' => WP_CONTENT_DIR.'/themes', 'description' => __('Themes', 'updraftplus')), 'uploads' => array('path' => untrailingslashit($wp_upload_dir['basedir']), 'description' => __('Uploads', 'updraftplus')) ); } else { $arr = array( 'plugins' => untrailingslashit(WP_PLUGIN_DIR), 'themes' => WP_CONTENT_DIR.'/themes', 'uploads' => untrailingslashit($wp_upload_dir['basedir']) ); } $arr = apply_filters('updraft_backupable_file_entities', $arr, $full_info); // We then add 'others' on to the end if ($include_others) { if ($full_info) { $arr['others'] = array('path' => WP_CONTENT_DIR, 'description' => __('Others', 'updraftplus')); } else { $arr['others'] = WP_CONTENT_DIR; } } // Entries that should be added after 'others' $arr = apply_filters('updraft_backupable_file_entities_final', $arr, $full_info); return $arr; } public function php_error_to_logline($errno, $errstr, $errfile, $errline) { switch ($errno) { case 1: $e_type = 'E_ERROR'; break; case 2: $e_type = 'E_WARNING'; break; case 4: $e_type = 'E_PARSE'; break; case 8: $e_type = 'E_NOTICE'; break; case 16: $e_type = 'E_CORE_ERROR'; break; case 32: $e_type = 'E_CORE_WARNING'; break; case 64: $e_type = 'E_COMPILE_ERROR'; break; case 128: $e_type = 'E_COMPILE_WARNING'; break; case 256: $e_type = 'E_USER_ERROR'; break; case 512: $e_type = 'E_USER_WARNING'; break; case 1024: $e_type = 'E_USER_NOTICE'; break; case 2048: $e_type = 'E_STRICT'; break; case 4096: $e_type = 'E_RECOVERABLE_ERROR'; break; case 8192: $e_type = 'E_DEPRECATED'; break; case 16384: $e_type = 'E_USER_DEPRECATED'; break; case 30719: $e_type = 'E_ALL'; break; default: $e_type = "E_UNKNOWN ($errno)"; break; } if (!is_string($errstr)) $errstr = serialize($errstr); if (0 === strpos($errfile, ABSPATH)) $errfile = substr($errfile, strlen(ABSPATH)); if ('E_DEPRECATED' == $e_type && !empty($this->no_deprecation_warnings)) { return false; } return "PHP event: code $e_type: $errstr (line $errline, $errfile)"; } public function php_error($errno, $errstr, $errfile, $errline) { if (0 == error_reporting()) return true; $logline = $this->php_error_to_logline($errno, $errstr, $errfile, $errline); if (false !== $logline) $this->log($logline, 'notice', 'php_event'); // Pass it up the chain return $this->error_reporting_stop_when_logged; } /** * Proceed with a backup; before calling this, at least all the initial job data must be set up * * @param Integer $resumption_no - which resumption this is; from 0 upwards * @param String $bnonce - the backup job identifier */ public function backup_resume($resumption_no, $bnonce) { set_error_handler(array($this, 'php_error'), E_ALL & ~E_STRICT); $this->current_resumption = $resumption_no; @set_time_limit(UPDRAFTPLUS_SET_TIME_LIMIT); @ignore_user_abort(true); $runs_started = array(); $time_now = microtime(true); UpdraftPlus_Backup_History::always_get_from_db(); // Restore state $resumption_extralog = ''; $prev_resumption = $resumption_no - 1; $last_successful_resumption = -1; $job_type = 'backup'; if (0 == $resumption_no) { $label = $this->jobdata_get('label'); if ($label) $resumption_extralog = apply_filters('updraftplus_autobackup_extralog', ", label=$label"); } else { $this->nonce = $bnonce; $file_nonce = $this->jobdata_get('file_nonce'); $this->file_nonce = $file_nonce ? $file_nonce : $bnonce; $this->backup_time = $this->jobdata_get('backup_time'); $this->job_time_ms = $this->jobdata_get('job_time_ms'); // Get the warnings before opening the log file, as opening the log file may generate new ones (which then leads to $this->errors having duplicate entries when they are copied over below) $warnings = $this->jobdata_get('warnings'); $this->logfile_open($this->file_nonce); // Import existing warnings. The purpose of this is so that when save_backup_to_history() is called, it has a complete set - because job data expires quickly, whilst the warnings of the last backup run need to persist if (is_array($warnings)) { foreach ($warnings as $warning) { $this->errors[] = array('level' => 'warning', 'message' => $warning); } } $runs_started = $this->jobdata_get('runs_started'); if (!is_array($runs_started)) $runs_started =array(); $time_passed = $this->jobdata_get('run_times'); if (!is_array($time_passed)) $time_passed = array(); foreach ($time_passed as $run => $passed) { if (isset($runs_started[$run]) && $runs_started[$run] + $time_passed[$run] + 30 > $time_now) { // We don't want to increase the resumption if WP has started two copies of the same resumption off if ($run && $run == $resumption_no) { $increase_resumption = false; $this->log("It looks like WordPress's scheduler has started multiple instances of this resumption"); } else { $increase_resumption = true; } UpdraftPlus_Job_Scheduler::terminate_due_to_activity('check-in', round($time_now, 1), round($runs_started[$run] + $time_passed[$run], 1), $increase_resumption); } } for ($i = 0; $i <= $prev_resumption; $i++) { if (isset($time_passed[$i])) $last_successful_resumption = $i; } if (isset($time_passed[$prev_resumption])) { // N.B. A check-in occurred; we haven't yet tested if it was useful $resumption_extralog = ", previous check-in=".round($time_passed[$prev_resumption], 1)."s"; } // This is just a simple test to catch restorations of old backup sets where the backup includes a resumption of the backup job if ($time_now - $this->backup_time > 172800 && true == apply_filters('updraftplus_check_obsolete_backup', true, $time_now, $this)) { // We have seen cases where the get_site_option() call that self::get_jobdata() relies on returns nothing, even though the data was there in the database. This appears to be sometimes reproducible for the people who get it, but stops being reproducible if they change their backup times - which suggests that they're having failures at times of extreme load. We can attempt to detect this case, and reschedule, instead of aborting. if (empty($this->backup_time) && empty($this->backup_is_already_complete) && !empty($this->logfile_name) && is_readable($this->logfile_name)) { $first_log_bit = file_get_contents($this->logfile_name, false, null, 0, 250); if (preg_match('/\(0\) Opened log file at time: (.*) on /', $first_log_bit, $matches)) { $first_opened = strtotime($matches[1]); // The value of 1000 seconds here is somewhat arbitrary; but allows for the problem to occur in ~ the first 15 minutes. In practice, the problem is extremely rare; if this does not catch it, we can tweak the algorithm. if (time() - $first_opened < 1000) { $this->log("This backup task (".$this->nonce.") failed to load its job data (possible database server malfunction), but appears to be only recently started: scheduling a fresh resumption in order to try again, and then ending this resumption ($time_now, ".$this->backup_time.") (existing jobdata keys: ".implode(', ', array_keys($this->jobdata)).")"); UpdraftPlus_Job_Scheduler::reschedule(120); die; } } } // If we are doing a local upload then we do not want to abort the backup as it's possible they are uploading a backup that is older than two days if (empty($this->jobdata['local_upload'])) { $this->log("This backup task (" . $this->nonce . ") is either complete or began over 2 days ago: ending ($time_now, " . $this->backup_time . ") (existing jobdata keys: " . implode(', ', array_keys($this->jobdata)) . ")"); die; } } } $this->last_successful_resumption = $last_successful_resumption; $runs_started[$resumption_no] = $time_now; if (!empty($this->backup_time)) $this->jobdata_set('runs_started', $runs_started); // Schedule again, to run in 5 minutes again, in case we again fail // The actual interval can be increased (for future resumptions) by other code, if it detects apparent overlapping $resume_interval = max(intval($this->jobdata_get('resume_interval')), 100); $btime = $this->backup_time; $job_type = $this->jobdata_get('job_type'); do_action('updraftplus_resume_backup_'.$job_type); $updraft_dir = $this->backups_dir_location(); $time_ago = time()-$btime; $this->log("Backup run: resumption=$resumption_no, nonce=$bnonce, file_nonce=".$this->file_nonce." begun at=$btime (${time_ago}s ago), job type=$job_type".$resumption_extralog); // This works round a bizarre bug seen in one WP install, where delete_transient and wp_clear_scheduled_hook both took no effect, and upon 'resumption' the entire backup would repeat. // Argh. In fact, this has limited effect, as apparently (at least on another install seen), the saving of the updated transient via jobdata_set() also took no effect. Still, it does not hurt. if ($resumption_no >= 1 && 'finished' == $this->jobdata_get('jobstatus')) { $this->log('Terminate: This backup job is already finished (1).'); die; } elseif ('clouduploading' != $this->jobdata_get('jobstatus') && 'backup' == $job_type && !empty($this->backup_is_already_complete)) { $this->jobdata_set('jobstatus', 'finished'); $this->log('Terminate: This backup job is already finished (2).'); die; } if ($resumption_no > 0 && isset($runs_started[$prev_resumption])) { $our_expected_start = $runs_started[$prev_resumption] + $resume_interval; // If the previous run increased the resumption time, then it is timed from the end of the previous run, not the start if (isset($time_passed[$prev_resumption]) && $time_passed[$prev_resumption]>0) $our_expected_start += $time_passed[$prev_resumption]; $our_expected_start = apply_filters('updraftplus_expected_start', $our_expected_start, $job_type); // More than 12 minutes late? if ($time_now > $our_expected_start + 720) { $this->log('Long time past since expected resumption time: approx expected='.round($our_expected_start, 1).", now=".round($time_now, 1).", diff=".round($time_now-$our_expected_start, 1)); $this->log(__('Your website is visited infrequently and UpdraftPlus is not getting the resources it hoped for; please read this page:', 'updraftplus').' https://updraftplus.com/faqs/why-am-i-getting-warnings-about-my-site-not-having-enough-visitors/', 'warning', 'infrequentvisits'); } } $this->jobdata_set('current_resumption', $resumption_no); $first_run = apply_filters('updraftplus_filerun_firstrun', 0); // We just do this once, as we don't want to be in permanent conflict with the overlap detector if ($resumption_no >= $first_run + 8 && $resumption_no < $first_run + 15 && $resume_interval >= 300) { // $time_passed is set earlier list($max_time, $timings_string, $run_times_known) = UpdraftPlus_Manipulation_Functions::max_time_passed($time_passed, $resumption_no - 1, $first_run); // Do this on resumption 8, or the first time that we have 6 data points if (($first_run + 8 == $resumption_no && $run_times_known >= 6) || (6 == $run_times_known && !empty($time_passed[$prev_resumption]))) { $this->log("Time passed on previous resumptions: $timings_string (known: $run_times_known, max: $max_time)"); // Remember that 30 seconds is used as the 'perhaps something is still running' detection threshold, and that 45 seconds is used as the 'the next resumption is approaching - reschedule!' interval if ($max_time + 52 < $resume_interval) { $resume_interval = round($max_time + 52); $this->log("Based on the available data, we are bringing the resumption interval down to: $resume_interval seconds"); $this->jobdata_set('resume_interval', $resume_interval); } // This next condition was added in response to HS#9174, a case where on one resumption, PHP was allowed to run for >3000 seconds - but other than that, up to 500 seconds. As a result, the resumption interval got stuck at a large value, whilst resumptions were only allowed to run for a much smaller amount. // This detects whether our last run was less than half the resume interval, but was non-trivial (at least 50 seconds - so, indicating it didn't just error out straight away), but with a resume interval of over 300 seconds. In this case, it is reduced. } elseif (isset($time_passed[$prev_resumption]) && $time_passed[$prev_resumption] > 50 && $resume_interval > 300 && $time_passed[$prev_resumption] < $resume_interval/2 && 'clouduploading' == $this->jobdata_get('jobstatus')) { $resume_interval = round($time_passed[$prev_resumption] + 52); $this->log("Time passed on previous resumptions: $timings_string (known: $run_times_known, max: $max_time). Based on the available data, we are bringing the resumption interval down to: $resume_interval seconds"); $this->jobdata_set('resume_interval', $resume_interval); } } // A different argument than before is needed otherwise the event is ignored $next_resumption = $resumption_no+1; if ($next_resumption < $first_run + 10) { if (true === $this->jobdata_get('one_shot')) { if (true === $this->jobdata_get('reschedule_before_upload') && 1 == $next_resumption) { $this->log('A resumption will be scheduled for the cloud backup stage'); $schedule_resumption = true; } else { $this->log('We are in "one shot" mode - no resumptions will be scheduled'); } } else { $schedule_resumption = true; } } else { // We're in over-time - we only reschedule if something useful happened last time (used to be that we waited for it to happen this time - but that meant that temporary errors, e.g. Google 400s on uploads, scuppered it all - we'd do better to have another chance $useful_checkin = $this->jobdata_get('useful_checkin'); $last_resumption = $resumption_no-1; $fail_on_resume = $this->jobdata_get('fail_on_resume'); if (empty($useful_checkin) || $useful_checkin < $last_resumption) { if (empty($fail_on_resume)) { $this->log(sprintf('The current run is resumption number %d, and there was nothing useful done on the last run (last useful run: %s) - will not schedule a further attempt until we see something useful happening this time', $resumption_no, $useful_checkin)); // Internally, we do actually schedule a resumption; but only in order to be able to nicely handle and log the failure, which otherwise may not be logged $this->jobdata_set('fail_on_resume', $next_resumption); $schedule_resumption = 1; } } else { // Something useful happened last time if (!empty($fail_on_resume)) { $this->jobdata_delete('fail_on_resume'); $fail_on_resume = false; } $schedule_resumption = true; } if (!isset($time_passed[$prev_resumption])) { $this->no_checkin_last_time = true; } if (!empty($fail_on_resume) && $fail_on_resume == $this->current_resumption) { $this->log('The backup is being aborted for a repeated failure to progress.', 'updraftplus'); $this->log(__('The backup is being aborted for a repeated failure to progress.', 'updraftplus'), 'error'); $this->backup_finish(true, true); die; } } // Sanity check if (empty($this->backup_time)) { $this->log('The backup_time parameter appears to be empty (usually caused by resuming an already-complete backup).'); return false; } if (!empty($schedule_resumption)) { $schedule_for = time() + $resume_interval; if (1 === $schedule_resumption) { $this->log("Scheduling a resumption ($next_resumption) after $resume_interval seconds ($schedule_for); but the job will then be aborted unless something happens this time"); } else { $this->log("Scheduling a resumption ($next_resumption) after $resume_interval seconds ($schedule_for) in case this run gets aborted"); } wp_schedule_single_event($schedule_for, 'updraft_backup_resume', array($next_resumption, $bnonce)); $this->newresumption_scheduled = $schedule_for; } $backup_files = $this->jobdata_get('backup_files'); global $updraftplus_backup; // Bring in all the backup routines include_once(UPDRAFTPLUS_DIR.'/backup.php'); $updraftplus_backup = new UpdraftPlus_Backup($backup_files, apply_filters('updraftplus_files_altered_since', -1, $job_type)); $undone_files = array(); if ('no' == $backup_files) { $this->log('This backup run is not intended for files - skipping'); $our_files = array(); } else { try { // This should be always called; if there were no files in this run, it returns us an empty array $backup_array = $updraftplus_backup->resumable_backup_of_files($resumption_no); // This save, if there was something, is then immediately picked up again if (is_array($backup_array)) { $this->log('Saving backup status to database (elements: '.count($backup_array).")"); $this->save_backup_to_history($backup_array); } // Switch of variable name is purely vestigial $our_files = $backup_array; if (!is_array($our_files)) $our_files = array(); } catch (Exception $e) { $log_message = 'Exception ('.get_class($e).') occurred during files backup: '.$e->getMessage().' (Code: '.$e->getCode().', line '.$e->getLine().' in '.$e->getFile().')'; error_log($log_message); // @codingStandardsIgnoreLine if (function_exists('wp_debug_backtrace_summary')) $log_message .= ' Backtrace: '.wp_debug_backtrace_summary(); $this->log($log_message); $this->log(sprintf(__('A PHP exception (%s) has occurred: %s', 'updraftplus'), get_class($e), $e->getMessage()), 'error'); die(); // @codingStandardsIgnoreLine } catch (Error $e) { $log_message = 'PHP Fatal error ('.get_class($e).') has occurred. Error Message: '.$e->getMessage().' (Code: '.$e->getCode().', line '.$e->getLine().' in '.$e->getFile().')'; error_log($log_message); // @codingStandardsIgnoreLine if (function_exists('wp_debug_backtrace_summary')) $log_message .= ' Backtrace: '.wp_debug_backtrace_summary(); $this->log($log_message); $this->log(sprintf(__('A PHP fatal error (%s) has occurred: %s', 'updraftplus'), get_class($e), $e->getMessage()), 'error'); die(); } } $backup_databases = $this->jobdata_get('backup_database'); if (!is_array($backup_databases)) $backup_databases = array('wp' => $backup_databases); foreach ($backup_databases as $whichdb => $backup_database) { if (is_array($backup_database)) { $dbinfo = $backup_database['dbinfo']; $backup_database = $backup_database['status']; } else { $dbinfo = array(); } $tindex = ('wp' == $whichdb) ? 'db' : 'db'.$whichdb; if ('begun' == $backup_database || 'finished' == $backup_database || 'encrypted' == $backup_database) { if ('wp' == $whichdb) { $db_descrip = 'WordPress DB'; } else { if (!empty($dbinfo) && is_array($dbinfo) && !empty($dbinfo['host'])) { $db_descrip = "External DB $whichdb - ".$dbinfo['user'].'@'.$dbinfo['host'].'/'.$dbinfo['name']; } else { $db_descrip = "External DB $whichdb - details appear to be missing"; } } if ('begun' == $backup_database) { if ($resumption_no > 0) { $this->log("Resuming creation of database dump ($db_descrip)"); } else { $this->log("Beginning creation of database dump ($db_descrip)"); } } elseif ('encrypted' == $backup_database) { $this->log("Database dump ($db_descrip): Creation and encryption were completed already"); } else { $this->log("Database dump ($db_descrip): Creation was completed already"); } if ('wp' != $whichdb && (empty($dbinfo) || !is_array($dbinfo) || empty($dbinfo['host']))) { unset($backup_databases[$whichdb]); $this->jobdata_set('backup_database', $backup_databases); continue; } // Catch fatal errors through try/catch blocks around the database backup try { $db_backup = $updraftplus_backup->backup_db($backup_database, $whichdb, $dbinfo); } catch (Exception $e) { $log_message = 'Exception ('.get_class($e).') occurred during files backup: '.$e->getMessage().' (Code: '.$e->getCode().', line '.$e->getLine().' in '.$e->getFile().')'; $this->log($log_message); error_log($log_message); $this->log(sprintf(__('A PHP exception (%s) has occurred: %s', 'updraftplus'), get_class($e), $e->getMessage()), 'error'); die(); // @codingStandardsIgnoreLine } catch (Error $e) { $log_message = 'PHP Fatal error ('.get_class($e).') has occurred. Error Message: '.$e->getMessage().' (Code: '.$e->getCode().', line '.$e->getLine().' in '.$e->getFile().')'; $this->log($log_message); error_log($log_message); $this->log(sprintf(__('A PHP fatal error (%s) has occurred: %s', 'updraftplus'), get_class($e), $e->getMessage()), 'error'); die(); } if (is_array($our_files) && is_string($db_backup)) $our_files[$tindex] = $db_backup; if ('encrypted' != $backup_database) { $backup_databases[$whichdb] = array('status' => 'finished', 'dbinfo' => $dbinfo); $this->jobdata_set('backup_database', $backup_databases); } } elseif ('no' == $backup_database) { $this->log("No database backup ($whichdb) - not part of this run"); } else { $this->log("Unrecognised data when trying to ascertain if the database ($whichdb) was backed up (".serialize($backup_database).")"); } // This is done before cloud despatch, because we want a record of what *should* be in the backup. Whether it actually makes it there or not is not yet known. $this->save_backup_to_history($our_files); // Potentially encrypt the database if it is not already if ('no' != $backup_database && isset($our_files[$tindex]) && !preg_match("/\.crypt$/", $our_files[$tindex]) && 'incremental' != $job_type) { $our_files[$tindex] = $updraftplus_backup->encrypt_file($our_files[$tindex]); // No need to save backup history now, as it will happen in a few lines time if (preg_match("/\.crypt$/", $our_files[$tindex])) { $backup_databases[$whichdb] = array('status' => 'encrypted', 'dbinfo' => $dbinfo); $this->jobdata_set('backup_database', $backup_databases); } } if ('no' != $backup_database && isset($our_files[$tindex]) && file_exists($updraft_dir.'/'.$our_files[$tindex])) { $our_files[$tindex.'-size'] = filesize($updraft_dir.'/'.$our_files[$tindex]); $this->save_backup_to_history($our_files); } } $backupable_entities = $this->get_backupable_file_entities(true); $checksum_list = $this->which_checksums(); $checksums = array(); foreach ($checksum_list as $checksum) { $checksums[$checksum] = array(); } $total_size = 0; // Queue files for upload foreach ($our_files as $key => $files) { // Only continue if the stored info was about a dump if (!isset($backupable_entities[$key]) && ('db' != substr($key, 0, 2) || '-size' == substr($key, -5, 5))) continue; if (is_string($files)) $files = array($files); foreach ($files as $findex => $file) { $size_key = (0 == $findex) ? $key.'-size' : $key.$findex.'-size'; $total_size = (false === $total_size || !isset($our_files[$size_key]) || !is_numeric($our_files[$size_key])) ? false : $total_size + $our_files[$size_key]; foreach ($checksum_list as $checksum) { $cksum = $this->jobdata_get($checksum.'-'.$key.$findex); if ($cksum) $checksums[$checksum][$key.$findex] = $cksum; $cksum = $this->jobdata_get($checksum.'-'.$key.$findex.'.crypt'); if ($cksum) $checksums[$checksum][$key.$findex.".crypt"] = $cksum; } if ($this->is_uploaded($file)) { $this->log("$file: $key: This file has already been successfully uploaded"); } elseif (is_file($updraft_dir.'/'.$file)) { if (!in_array($file, $undone_files)) { $this->log("$file: $key: This file has not yet been successfully uploaded: will queue"); $undone_files[$key.$findex] = $file; } else { $this->log("$file: $key: This file was already queued for upload (this condition should never be seen)"); } } elseif ('incremental' == $job_type && 'db' == substr($key, 0, 2)) { // Here we check if this is an incremental backup and if so then mark the db files as already uploaded as db files are not part of incremental file backups $this->log("$file: $key: This is an incremental backup; this file will be marked as successfully uploaded."); $this->uploaded_file($file, true); } else { $this->log("$file: $key: Note: This file was not marked as successfully uploaded, but does not exist on the local filesystem; now marking as uploaded ($updraft_dir/$file)"); $this->uploaded_file($file, true); } } } $our_files['checksums'] = $checksums; // Save again (now that we have checksums) $size_description = (false === $total_size) ? 'Unknown' : UpdraftPlus_Manipulation_Functions::convert_numeric_size_to_text($total_size); $this->log("Saving backup history. Total backup size: $size_description"); $this->save_backup_to_history($our_files); do_action('updraft_final_backup_history', $our_files); // We finished; so, low memory was not a problem $this->log_remove_warning('lowram'); if (0 == count($undone_files)) { $this->log("Resume backup ($bnonce, $resumption_no): finish run"); if (is_array($our_files)) $this->save_last_backup($our_files); $this->log("There were no more files that needed uploading"); // No email, as the user probably already got one if something else completed the run $allow_email = false; if ('begun' == $this->jobdata_get('prune')) { // Begun, but not finished $this->log('Restarting backup prune operation'); $updraftplus_backup->do_prune_standalone(); $allow_email = true; } $this->backup_finish(true, $allow_email); restore_error_handler(); return; } $this->error_count_before_cloud_backup = $this->error_count(); // This is intended for one-shot backups, where we do want a resumption if it's only for uploading if (empty($this->newresumption_scheduled) && 0 == $resumption_no && 0 == $this->error_count_before_cloud_backup && true === $this->jobdata_get('reschedule_before_upload')) { $this->log("Cloud backup stage reached on one-shot backup: scheduling resumption for the cloud upload"); UpdraftPlus_Job_Scheduler::reschedule(60); UpdraftPlus_Job_Scheduler::record_still_alive(); } $this->log("Requesting upload of the files that have not yet been successfully uploaded (".count($undone_files).")"); // Catch fatal errors through try/catch blocks around the upload to remote storage $updraftplus_backup->cloud_backup($undone_files); $this->log("Resume backup ($bnonce, $resumption_no): finish run"); if (is_array($our_files)) $this->save_last_backup($our_files); $this->backup_finish(true, true); restore_error_handler(); } /** * Get all the job data in a single array * * @param String $job_id - the job identifier (nonce) for the job whose data is to be retrieved * * @return Array */ public function jobdata_getarray($job_id) { return get_site_option('updraft_jobdata_'.$job_id, array()); } public function jobdata_set_from_array($array) { $this->jobdata = $array; if (!empty($this->nonce)) update_site_option("updraft_jobdata_".$this->nonce, $this->jobdata); } /** * This works with any amount of settings, but we provide also a jobdata_set for efficiency as normally there's only one setting * You can list the keys/values (keys must be strings) as consecutive/alternating parameters, or send them all in as an array (with no other parameters) * * @return null */ public function jobdata_set_multi() { if (!is_array($this->jobdata)) $this->jobdata = array(); $args = func_num_args(); // func_get_arg() could not be used in parameter lists prior to PHP 5.3, so, we get it as a variable if (1 == $args && null !== ($first_arg = func_get_arg(0)) && is_array($first_arg)) { foreach ($first_arg as $key => $value) { $this->jobdata[$key] = $value; } } else { for ($i=1; $i<=$args/2; $i++) { $key = func_get_arg($i*2-2); $value = func_get_arg($i*2-1); $this->jobdata[$key] = $value; } } if (!empty($this->nonce)) update_site_option('updraft_jobdata_'.$this->nonce, $this->jobdata); } /** * Set a job-data key/value pair for the current job * * @param String $key - the key * @param Mixed $value - needs to be serializable * * @uses update_site_option() */ public function jobdata_set($key, $value) { if (empty($this->jobdata)) { $this->jobdata = empty($this->nonce) ? array() : get_site_option('updraft_jobdata_'.$this->nonce); if (!is_array($this->jobdata)) $this->jobdata = array(); } $this->jobdata[$key] = $value; if ($this->nonce) update_site_option('updraft_jobdata_'.$this->nonce, $this->jobdata); } public function jobdata_delete($key) { if (!is_array($this->jobdata)) { $this->jobdata = empty($this->nonce) ? array() : get_site_option("updraft_jobdata_".$this->nonce); if (!is_array($this->jobdata)) $this->jobdata = array(); } unset($this->jobdata[$key]); if ($this->nonce) update_site_option("updraft_jobdata_".$this->nonce, $this->jobdata); } public function get_job_option($opt) { // These are meant to be read-only if (empty($this->jobdata['option_cache']) || !is_array($this->jobdata['option_cache'])) { if (!is_array($this->jobdata) && $this->nonce) $this->jobdata = get_site_option("updraft_jobdata_".$this->nonce, array()); $this->jobdata['option_cache'] = array(); } return isset($this->jobdata['option_cache'][$opt]) ? $this->jobdata['option_cache'][$opt] : UpdraftPlus_Options::get_updraft_option($opt); } public function jobdata_get($key, $default = null) { if (empty($this->jobdata)) { $this->jobdata = empty($this->nonce) ? array() : get_site_option("updraft_jobdata_".$this->nonce, array()); if (!is_array($this->jobdata)) return $default; } return isset($this->jobdata[$key]) ? $this->jobdata[$key] : $default; } /** * Reset the job data for the currently active job */ public function jobdata_reset() { $this->jobdata = null; } /** * Gets an instance of the "UpdraftPlus_Clone" class which will be * used to login the user to UpdraftPlus.com * * @return object */ public function get_updraftplus_clone() { if (!class_exists('UpdraftPlus_Clone')) include_once(UPDRAFTPLUS_DIR.'/includes/updraftplus-clone.php'); return new UpdraftPlus_Clone(); } /** * This function will add data to the backup options that is needed for the clone backup job * * @param array $options - the backup options array * @param array $request - the extra data we want to add to the backup options * * @return array - the backup options array with the extra data added */ public function updraftplus_clone_backup_options($options, $request) { if (!is_array($options)) return $options; if (!empty($request['clone_id']) && !empty($request['secret_token'])) { $options['clone_id'] = $request['clone_id']; $options['secret_token'] = $request['secret_token']; } if (isset($request['clone_url'])) $options['clone_url'] = $request['clone_url']; if (isset($request['key'])) $options['key'] = $request['key']; if (isset($request['backup_nonce']) && isset($request['backup_timestamp'])) { if ('current' != $request['backup_nonce'] && 'current' != $request['backup_timestamp']) { $options['use_nonce'] = $request['backup_nonce']; $options['use_timestamp'] = $request['backup_timestamp']; } else { $options['clone_backup'] = 'current'; } } return $options; } /** * This function will set up the backup job data for when we are starting a clone backup job. It changes the initial jobdata so that UpdraftPlus knows it's a clone job and adds the needed information for to lookup the clone and if we have it the URL and migration key for the clone. * * @param array $jobdata - the initial job data that we want to change * @param array $options - options sent from the front end includes the clone id, secret token and maybe clone url and migration key * @param integer $split_every - the size we should split the zips at * * @return array - the modified jobdata */ public function updraftplus_clone_backup_jobdata($jobdata, $options, $split_every) { if (!is_array($jobdata)) return $jobdata; if (!isset($options['clone_id']) && !isset($options['secret_token']) && !isset($options['clone_url']) && !isset($options['key'])) return $jobdata; $option_cache_key = array_search('option_cache', $jobdata) + 1; $option_cache = $jobdata[$option_cache_key]; $option_cache['updraft_encryptionphrase'] = ''; $jobdata[$option_cache_key] = $option_cache; // Reduce to 100MB if it was above. Since the user isn't expected to directly manipulate these zip files, the potentially higher number of zip files doesn't matter. $split_every_key = array_search('split_every', $jobdata) + 1; if ($split_every > 100) $jobdata[$split_every_key] = 100; $service_key = array_search('service', $jobdata) + 1; $jobdata[$service_key] = array('remotesend'); $jobdata[] = 'clone_job'; $jobdata[] = true; $jobdata[] = 'clone_id'; $jobdata[] = $options['clone_id']; $jobdata[] = 'secret_token'; $jobdata[] = $options['secret_token']; $jobdata[] = 'clone_url'; $jobdata[] = $options['clone_url']; $jobdata[] = 'clone_key'; $jobdata[] = $options['key']; $jobdata[] = 'remotesend_info'; $jobdata[] = array('url' => $options['clone_url']); // if clone_backup is set and is 'current' then theres nothing more that needs to be done, otherwise we need to tweak some more jobdata to skip to the upload stage and use the specified clone backup if (isset($options['clone_backup']) && 'current' == $options['clone_backup']) return $jobdata; global $updraftplus_admin; add_filter('updraftplus_get_backup_file_basename_from_time', array($updraftplus_admin, 'upload_local_backup_name'), 10, 3); $backup_history = UpdraftPlus_Backup_History::get_history(); $backup = $backup_history[$options['use_timestamp']]; $jobstatus_key = array_search('jobstatus', $jobdata) + 1; $backup_time_key = array_search('backup_time', $jobdata) + 1; $backup_database_key = array_search('backup_database', $jobdata) + 1; $backup_files_key = array_search('backup_files', $jobdata) + 1; $db_backups = $jobdata[$backup_database_key]; $db_backup_info = $this->update_database_jobdata($db_backups, $backup); $skip_entities = array('more', 'wpcore'); $file_backups = $this->update_files_jobdata($backup, $skip_entities); $jobdata[$jobstatus_key] = 'clouduploading'; $jobdata[$backup_time_key] = $options['use_timestamp']; $jobdata[$backup_files_key] = 'finished'; $jobdata[] = 'backup_files_array'; $jobdata[] = $file_backups; $jobdata[] = 'blog_name'; $jobdata[] = $db_backup_info['blog_name']; $jobdata[$backup_database_key] = $db_backup_info['db_backups']; $jobdata[] = 'local_upload'; $jobdata[] = true; return $jobdata; } /** * This function will update the database backup jobdata and set each entity to finished or encrypted to prevent that entity from being backed up again. This will also return the blog name that the database backup belongs to, just in case it's from another site. * * @param array $db_backups - the database backup jobdata * @param array $backup - the backup history for this backup * * @return array - an array that contains the updated database backup jobdata and the blog name */ public function update_database_jobdata($db_backups, $backup) { $backup_database_info = array( 'blog_name' => '', 'db_backups' => $db_backups ); if (!is_array($db_backups)) return $backup_database_info; /* We need to tweak the database array here by setting each database entity to finished or encrypted if it's an encrypted archive. I also grab the backups blog name here ready to be used later, just in case this backup set is from another site. */ foreach ($db_backups as $key => $db_info) { $status = 'finished'; $db_index = ('wp' == $key) ? 0 : $key; if (isset($backup['db'][$db_index])) { $db_backup_name = $backup['db'][$db_index]; if (preg_match('/^backup_([\-0-9]{15})_(.*)_([0-9a-f]{12})-[\-a-z]+([0-9]+)?+(\.(zip|gz|gz\.crypt))?$/i', $db_backup_name, $matches)) { $backup_database_info['blog_name'] = $matches[2]; } if (UpdraftPlus_Encryption::is_file_encrypted($db_backup_name)) $status = 'encrypted'; if (is_array($db_info) && isset($db_info['status'])) { $db_backups[$key]['status'] = $status; } else { $db_backups[$key] = $status; } } else { unset($db_backups[$key]); } } $backup_database_info['db_backups'] = $db_backups; return $backup_database_info; } /** * This function will update the files backup jobdata by constructing the backup entities and their sizes from the backup * * @param array $backup - the backup array * @param array $skip_entities - an array of entities to skip * * @return array - the files backup array */ public function update_files_jobdata($backup, $skip_entities = array()) { $file_backups = array(); $backupable_entities = $this->get_backupable_file_entities(true); // We need to construct the expected files array here, this gets added to the jobdata much later in the backup process but we need this before we start foreach ($backupable_entities as $entity => $path) { if (in_array($entity, $skip_entities)) continue; if (isset($backup[$entity])) $file_backups[$entity] = $backup[$entity]; if (isset($backup[$entity . '-size'])) $file_backups[$entity . '-size'] = $backup[$entity . '-size']; } return $file_backups; } public function backup_files() { // Note that the "false" for database gets over-ridden automatically if they turn out to have the same schedules $this->boot_backup(true, false); } public function backup_database() { // Note that nothing will happen if the file backup had the same schedule $this->boot_backup(false, true); } public function backup_all($options) { $skip_cloud = empty($options['nocloud']) ? false : true; $this->boot_backup(1, 1, false, false, ($skip_cloud) ? 'none' : false, $options); } public function backupnow_files($options) { $skip_cloud = empty($options['nocloud']) ? false : true; $this->boot_backup(1, 0, false, false, ($skip_cloud) ? 'none' : false, $options); } public function backupnow_database($options) { $skip_cloud = empty($options['nocloud']) ? false : true; $this->boot_backup(0, 1, false, false, ($skip_cloud) ? 'none' : false, $options); } /** * This function will try and get a lock for the backup, it will return false if it fails to get a lock. * * @param boolean $backup_files - boolean to indicate if we want a lock for files * @param boolean $backup_database - boolean to indicate if we want a lock for the database * * @return boolean - boolean to indicate if we got a lock or not */ public function get_semaphore_lock($backup_files, $backup_database) { $semaphore = ($backup_files ? 'f' : '') . ($backup_database ? 'd' : ''); if (!class_exists('UpdraftPlus_Semaphore')) include_once(UPDRAFTPLUS_DIR.'/includes/class-semaphore.php'); UpdraftPlus_Semaphore::ensure_semaphore_exists($semaphore); // Are we doing an action called by the WP scheduler? If so, we want to check when that last happened; the point being that the dodgy WP scheduler, when overloaded, can call the event multiple times - and sometimes, it evades the semaphore because it calls a second run after the first has finished, or > 3 minutes (our semaphore lock time) later // doing_action() was added in WP 3.9 // wp_cron() can be called from the 'init' action if (function_exists('doing_action') && (doing_action('init') || @constant('DOING_CRON')) && (doing_action('updraft_backup_database') || doing_action('updraft_backup'))) { $last_scheduled_action_called_at = get_option("updraft_last_scheduled_$semaphore"); // 11 minutes - so, we're assuming that they haven't custom-modified their schedules to run scheduled backups more often than that. If they have, they need also to use the filter to over-ride this check. $seconds_ago = time() - $last_scheduled_action_called_at; if ($last_scheduled_action_called_at && $seconds_ago < 660 && apply_filters('updraft_check_repeated_scheduled_backups', true)) { $this->log(sprintf('Scheduled backup aborted - another backup of this type was apparently invoked by the WordPress scheduler only %d seconds ago - the WordPress scheduler invoking events multiple times usually indicates a very overloaded server (or other plugins that mis-use the scheduler)', $seconds_ago)); return false; } } update_option("updraft_last_scheduled_$semaphore", time()); $this->semaphore = UpdraftPlus_Semaphore::factory(); $this->semaphore->lock_name = $semaphore; $semaphore_log_message = 'Requesting semaphore lock ('.$semaphore.')'; if (!empty($last_scheduled_action_called_at)) { $semaphore_log_message .= " (apparently via scheduler: last_scheduled_action_called_at=$last_scheduled_action_called_at, seconds_ago=$seconds_ago)"; } else { $semaphore_log_message .= " (apparently not via scheduler)"; } $this->log($semaphore_log_message); if (!$this->semaphore->lock()) { $this->log('Failed to gain semaphore lock ('.$semaphore.') - another backup of this type is apparently already active - aborting (if this is wrong - i.e. if the other backup crashed without removing the lock, then another can be started after 3 minutes)'); return false; } return true; } /** * This function will check to see if any of the known backups are still running and return true otherwise returns false. * * @return boolean|string - returns false if no backup is running or a error code if there is a backup running */ public function is_backup_running() { $backup_history = UpdraftPlus_Backup_History::get_history(); foreach ($backup_history as $key => $backup) { $nonce = $backup['nonce']; // Check the job is not still running. $jobdata = $this->jobdata_getarray($nonce); if (!empty($jobdata) && 'finished' != $jobdata['jobstatus']) { // Check that there is not a resumption scheduled if (wp_next_scheduled('updraft_backup_resume')) return "job_resumption_scheduled"; $time_passed = $jobdata['run_times']; // No runtime found so return if (!is_array($time_passed)) return "job_scheduled_${nonce}_no_run_times"; // Runtime has been found so make sure last activity is over an hour $time_passed = end($time_passed); if (strtotime($time_passed) <= time() - (3600)) continue; return "job_scheduled_${nonce}_run_time_activity"; } } return false; } /** * This function is a filter function which will return the nonce for the incremental backup set we want to add to * * @param string $nonce - the backup nonce we want to filter * * @return string - the backup nonce */ public function incremental_backup_file_nonce($nonce) { if (apply_filters('updraftplus_incremental_addon_installed', false) && !empty($this->file_nonce)) return $this->file_nonce; return $nonce; } /** * This procedure initiates a backup run * $backup_files/$backup_database: true/false = yes/no (over-write allowed); 1/0 = yes/no (force) * * @param Boolean $backup_files * @param Boolean $backup_database * @param Boolean|Array $restrict_files_to_override * @param Boolean $one_shot * @param Boolean|Array|String $service * @param Array $options * @return Boolean|Void - not currently well specified (though false indicates definite failure) */ public function boot_backup($backup_files, $backup_database, $restrict_files_to_override = false, $one_shot = false, $service = false, $options = array()) { @ignore_user_abort(true); @set_time_limit(UPDRAFTPLUS_SET_TIME_LIMIT); if (false === $restrict_files_to_override && isset($options['restrict_files_to_override'])) $restrict_files_to_override = $options['restrict_files_to_override']; // Generate backup information $use_nonce = empty($options['use_nonce']) ? false : $options['use_nonce']; $use_timestamp = empty($options['use_timestamp']) ? false : $options['use_timestamp']; $this->backup_time_nonce($use_nonce, $use_timestamp); // The current_resumption is consulted within logfile_open() $this->current_resumption = 0; $this->logfile_open($this->file_nonce); if (!is_file($this->logfile_name)) { $this->log('Failed to open log file ('.$this->logfile_name.') - you need to check your UpdraftPlus settings (your chosen directory for creating files in is not writable, or you ran out of disk space). Backup aborted.'); $this->log(__('Could not create files in the backup directory. Backup aborted - check your UpdraftPlus settings.', 'updraftplus'), 'error'); return false; } // Some house-cleaning UpdraftPlus_Filesystem_Functions::clean_temporary_files(); // Log some information that may be helpful $this->log("Tasks: Backup files: $backup_files (schedule: ".UpdraftPlus_Options::get_updraft_option('updraft_interval', 'unset').") Backup DB: $backup_database (schedule: ".UpdraftPlus_Options::get_updraft_option('updraft_interval_database', 'unset').")"); // The is_bool() check here is confirming that we're allowed to adjust the parameters if (false === $one_shot && is_bool($backup_database)) { // If the files and database schedules are the same, and if this the file one, then we rope in database too. // On the other hand, if the schedules were the same and this was the database run, then there is nothing to do. $files_schedule = UpdraftPlus_Options::get_updraft_option('updraft_interval'); $db_schedule = UpdraftPlus_Options::get_updraft_option('updraft_interval_database'); $sched_log_extra = ''; if ('manual' != $files_schedule) { if ($files_schedule == $db_schedule || UpdraftPlus_Options::get_updraft_option('updraft_interval_database', 'xyz') == 'xyz') { $sched_log_extra = 'Combining jobs from identical schedules. '; $backup_database = (true == $backup_files) ? true : false; } elseif ($files_schedule && $db_schedule && $files_schedule != $db_schedule) { // This stored value is the earliest of the two apparently-close jobs $combine_around = empty($this->combine_jobs_around) ? false : $this->combine_jobs_around; if (preg_match('/^(cancel:)?(\d+)$/', $combine_around, $matches)) { $combine_around = $matches[2]; // Re-save the option, since otherwise it will have been reset and not be accessible to the 'other' run UpdraftPlus_Options::update_updraft_option('updraft_combine_jobs_around', 'cancel:'.$this->combine_jobs_around); $margin = (defined('UPDRAFTPLUS_COMBINE_MARGIN') && is_numeric(UPDRAFTPLUS_COMBINE_MARGIN)) ? UPDRAFTPLUS_COMBINE_MARGIN : 600; $time_now = time(); // The margin is doubled, to cope with the lack of predictability in WP's cron system if ($time_now >= $combine_around && $time_now <= $combine_around + 2*$margin) { $sched_log_extra = 'Combining jobs from co-inciding events. '; if ('cancel:' == $matches[1]) { $backup_database = false; $backup_files = false; } else { // We want them both to happen on whichever run is first (since, afterwards, the updraft_combine_jobs_around option will have been removed when the event is rescheduled). $backup_database = true; $backup_files = true; } } } } } $this->log("Processed schedules. ${sched_log_extra}Tasks now: Backup files: $backup_files Backup DB: $backup_database"); } if (false == apply_filters('updraftplus_boot_backup', true, $backup_files, $backup_database, $one_shot)) { $this->log("Backup aborted (via filter)"); return false; } if (!is_string($service) && !is_array($service)) { $all_services = UpdraftPlus_Options::get_updraft_option('updraft_service'); if (is_string($all_services)) $all_services = (array) $all_services; $enabled_storage_objects_and_ids = UpdraftPlus_Storage_Methods_Interface::get_enabled_storage_objects_and_ids($all_services); $service = array_keys($enabled_storage_objects_and_ids); } $service = $this->just_one($service); if (is_string($service)) $service = array($service); if (!is_array($service)) $service = array('none'); if (!empty($options['extradata']) && !empty($options['extradata']['services']) && preg_match('#remotesend/(\d+)#', $options['extradata']['services'])) { if (array('none') === $service) $service = array(); $service[] = 'remotesend'; } $option_cache = array(); foreach ($service as $serv) { if ('' == $serv || 'none' == $serv) continue; include_once(UPDRAFTPLUS_DIR.'/methods/'.$serv.'.php'); $cclass = 'UpdraftPlus_BackupModule_'.$serv; if (!class_exists($cclass)) { error_log("UpdraftPlus: backup class does not exist: $cclass"); continue; } $obj = new $cclass; if (is_callable(array($obj, 'get_credentials'))) { $opts = $obj->get_credentials(); if (is_array($opts)) { foreach ($opts as $opt) $option_cache[$opt] = UpdraftPlus_Options::get_updraft_option($opt); } } } $option_cache = apply_filters('updraftplus_job_option_cache', $option_cache); // If nothing to be done, then just finish if (!$backup_files && !$backup_database) { $ret = $this->backup_finish(false, false); // Don't keep useless log files if (!UpdraftPlus_Options::get_updraft_option('updraft_debug_mode') && !empty($this->logfile_name) && file_exists($this->logfile_name)) { unlink($this->logfile_name); } return $ret; } if (!$this->get_semaphore_lock($backup_files, $backup_database)) return; // Allow the resume interval to be more than 300 if last time we know we went beyond that - but never more than 600 if (defined('UPDRAFTPLUS_INITIAL_RESUME_INTERVAL') && is_numeric(UPDRAFTPLUS_INITIAL_RESUME_INTERVAL)) { $resume_interval = UPDRAFTPLUS_INITIAL_RESUME_INTERVAL; } else { $resume_interval = (int) min(max(300, get_site_transient('updraft_initial_resume_interval')), 600); } // We delete it because we only want to know about behaviour found during the very last backup run (so, if you move servers then old data is not retained) delete_site_transient('updraft_initial_resume_interval'); $job_file_entities = array(); if ($backup_files) { $possible_backups = $this->get_backupable_file_entities(true); foreach ($possible_backups as $youwhat => $whichdir) { if ((false === $restrict_files_to_override && UpdraftPlus_Options::get_updraft_option("updraft_include_$youwhat", apply_filters("updraftplus_defaultoption_include_$youwhat", true))) || (is_array($restrict_files_to_override) && in_array($youwhat, $restrict_files_to_override))) { // The 0 indicates the zip file index $job_file_entities[$youwhat] = array( 'index' => 0 ); } } } $followups_allowed = (((!$one_shot && defined('DOING_CRON') && DOING_CRON)) || (defined('UPDRAFTPLUS_FOLLOWUPS_ALLOWED') && UPDRAFTPLUS_FOLLOWUPS_ALLOWED)); $split_every = max(intval(UpdraftPlus_Options::get_updraft_option('updraft_split_every', 400)), UPDRAFTPLUS_SPLIT_MIN); $initial_jobdata = array( 'resume_interval', $resume_interval, 'job_type', 'backup', 'jobstatus', 'begun', 'backup_time', $this->backup_time, 'job_time_ms', $this->job_time_ms, 'service', $service, 'split_every', $split_every, 'maxzipbatch', 26214400, // 25MB 'job_file_entities', $job_file_entities, 'option_cache', $option_cache, 'uploaded_lastreset', 9, 'one_shot', $one_shot, 'followsups_allowed', $followups_allowed, ); if ($one_shot) update_site_option('updraft_oneshotnonce', $this->nonce); if ($this->file_nonce && $this->file_nonce != $this->nonce) array_push($initial_jobdata, 'file_nonce', $this->file_nonce); // 'autobackup' == $options['extradata'] might be set from another plugin so keeping here to keep support if (!empty($options['extradata']) && (!empty($options['extradata']['autobackup']) || 'autobackup' === $options['extradata'])) array_push($initial_jobdata, 'is_autobackup', true); // Save what *should* be done, to make it resumable from this point on if ($backup_database) { $dbs = apply_filters('updraft_backup_databases', array('wp' => 'begun')); if (is_array($dbs)) { foreach ($dbs as $key => $db) { if ('wp' != $key && (!is_array($db) || empty($db['dbinfo']) || !is_array($db['dbinfo']) || empty($db['dbinfo']['host']))) unset($dbs[$key]); } } } else { $dbs = 'no'; } array_push($initial_jobdata, 'backup_database', $dbs); array_push($initial_jobdata, 'backup_files', (($backup_files) ? 'begun' : 'no')); if (is_array($options) && !empty($options['label'])) array_push($initial_jobdata, 'label', $options['label']); if (!empty($options['always_keep'])) array_push($initial_jobdata, 'always_keep', true); try { // Use of jobdata_set_multi saves around 200ms call_user_func_array(array($this, 'jobdata_set_multi'), apply_filters('updraftplus_initial_jobdata', $initial_jobdata, $options, $split_every)); } catch (Exception $e) { $this->log("Exception when calling jobdata_set_multi: ".$e->getMessage().' ('.$e->getCode().', line '.$e->getLine().' in '.$e->getFile().')'); return false; } // Everything is set up; now go $this->backup_resume(0, $this->nonce); if ($one_shot) delete_site_option('updraft_oneshotnonce'); } /** * The purpose of this function is to abstract away historical discrepancies in service lists, by returning in a single, logical form (in particular, no 'none' or '' entries, and always an array) * * @param Array|String|Boolean|Null $services - a list of services to canonicalize, or a string indicating a single service. If null is parsed, then the saved settings will be read. * * @return Array - an array of service names. All service names will be non-empty strings, and 'none' will not feature. If there are no services, then the array will be empty. */ public function get_canonical_service_list($services = null) { if (null === $services) $services = UpdraftPlus_Options::get_updraft_option('updraft_service'); $services = (array) $services; foreach ($services as $key => $service) { if ('' === $service || 'none' === $service || false === $service) unset($services[$key]); } return $services; } /** * Perform the tasks necessary when a backup has run through all the available steps. N.B. This does not imply that the were all successful or that the backup is finished. * * @param Boolean $do_cleanup - if (and only if) this is set will resumptions be unscheduled * @param Boolean $allow_email - if this is false, then no email will be sent * @param Boolean $force_abort - set to indicate that the user is manually aborting the backup */ public function backup_finish($do_cleanup, $allow_email, $force_abort = false) { if (!empty($this->semaphore)) $this->semaphore->unlock(); $delete_jobdata = false; $clone_job = $this->jobdata_get('clone_job'); if (!empty($clone_job)) { $clone_id = $this->jobdata_get('clone_id'); $secret_token = $this->jobdata_get('secret_token'); } // The valid use of $do_cleanup is to indicate if in fact anything exists to clean up (if no job really started, then there may be nothing) // In fact, leaving the hook to run (if debug is set) is harmless, as the resume job should only do tasks that were left unfinished, which at this stage is none. if (0 == $this->error_count() || $force_abort) { if ($do_cleanup) { $cancel_event = $this->current_resumption + 1; $this->log("There were no errors in the uploads, so the 'resume' event ($cancel_event) is being unscheduled"); // This apparently-worthless setting of metadata before deleting it is for the benefit of a WP install seen where wp_clear_scheduled_hook() and delete_transient() apparently did nothing (probably a faulty cache) $this->jobdata_set('jobstatus', 'finished'); wp_clear_scheduled_hook('updraft_backup_resume', array($cancel_event, $this->nonce)); // This should be unnecessary - even if it does resume, all should be detected as finished; but I saw one very strange case where it restarted, and repeated everything; so, this will help wp_clear_scheduled_hook('updraft_backup_resume', array($cancel_event+1, $this->nonce)); wp_clear_scheduled_hook('updraft_backup_resume', array($cancel_event+2, $this->nonce)); wp_clear_scheduled_hook('updraft_backup_resume', array($cancel_event+3, $this->nonce)); wp_clear_scheduled_hook('updraft_backup_resume', array($cancel_event+4, $this->nonce)); $delete_jobdata = true; } } else { if ($this->newresumption_scheduled) { if ($this->current_resumption + 1 != $this->jobdata_get('fail_on_resume')) { $this->log("There were errors in the uploads, so the 'resume' event is remaining scheduled"); $this->jobdata_set('jobstatus', 'resumingforerrors'); } } // If there were no errors before moving to the upload stage, on the first run, then bring the resumption back very close. Since this is only attempted on the first run, it is really only an efficiency thing for a quicker finish if there was an unexpected networking event. We don't want to do it straight away every time, as it may be that the cloud service is down - and might be up in 5 minutes time. This was added after seeing a case where resumption 0 got to run for 10 hours... and the resumption 7 that should have picked up the uploading of 1 archive that failed never occurred. if (isset($this->error_count_before_cloud_backup) && 0 === $this->error_count_before_cloud_backup) { if (0 == $this->current_resumption) { UpdraftPlus_Job_Scheduler::reschedule(60); } else { // Added 27/Feb/2016 - though the cloud service seems to be down, we still don't want to wait too long $resume_interval = $this->jobdata_get('resume_interval'); // 15 minutes + 2 for each resumption (a modest back-off) $max_interval = 900 + $this->current_resumption * 120; if ($resume_interval > $max_interval) { UpdraftPlus_Job_Scheduler::reschedule($max_interval); } } } } // Send the results email if appropriate, which means: // - The caller allowed it (which is not the case in an 'empty' run) // - And: An email address was set (which must be so in email mode) // And one of: // - Debug mode // - There were no errors (which means we completed and so this is the final run - time for the final report) // - It was the tenth resumption; everything failed $send_an_email = false; // Save the jobdata's state for the reporting - because it might get changed (e.g. incremental backup is scheduled) $jobdata_as_was = $this->jobdata; // Make sure that the final status is shown if ($force_abort) { $send_an_email = true; $final_message = __('The backup was aborted by the user', 'updraftplus'); if (!empty($clone_job)) $this->get_updraftplus_clone()->clone_failed_delete(array('clone_id' => $clone_id, 'secret_token' => $secret_token)); } elseif (0 == $this->error_count()) { $send_an_email = true; $service = $this->jobdata_get('service'); $remote_sent = (!empty($service) && ((is_array($service) && in_array('remotesend', $service)) || 'remotesend' === $service)) ? true : false; if (0 == $this->error_count('warning')) { $final_message = __('The backup apparently succeeded and is now complete', 'updraftplus'); // Ensure it is logged in English. Not hugely important; but helps with a tiny number of really broken setups in which the options cacheing is broken if ('The backup apparently succeeded and is now complete' != $final_message) { $this->log('The backup apparently succeeded and is now complete'); } } else { $final_message = __('The backup apparently succeeded (with warnings) and is now complete', 'updraftplus'); if ('The backup apparently succeeded (with warnings) and is now complete' != $final_message) { $this->log('The backup apparently succeeded (with warnings) and is now complete'); } } if ($remote_sent && !$force_abort) { $final_message .= empty($clone_job) ? '. '.__('To complete your migration/clone, you should now log in to the remote site and restore the backup set.', 'updraftplus') : '. '.__('Your clone will now deploy this data to re-create your site.', 'updraftplus'); do_action('updraftplus_remotesend_upload_complete'); } if ($do_cleanup) $delete_jobdata = apply_filters('updraftplus_backup_complete', $delete_jobdata); } elseif (false == $this->newresumption_scheduled || $this->current_resumption + 1 == $this->jobdata_get('fail_on_resume')) { if ($this->current_resumption + 1 == $this->jobdata_get('fail_on_resume')) { $this->log("The resumption is being cancelled, as it was only scheduled to enable error reporting, which can be performed now"); wp_clear_scheduled_hook('updraft_backup_resume', array($this->current_resumption + 1, $this->nonce)); } $send_an_email = true; $final_message = __('The backup attempt has finished, apparently unsuccessfully', 'updraftplus'); if (!empty($clone_job)) $this->get_updraftplus_clone()->clone_failed_delete(array('clone_id' => $clone_id, 'secret_token' => $secret_token)); } else { // There are errors, but a resumption will be attempted $final_message = __('The backup has not finished; a resumption is scheduled', 'updraftplus'); } // Now over-ride the decision to send an email, if needed if (UpdraftPlus_Options::get_updraft_option('updraft_debug_mode')) { $send_an_email = true; $this->log("An email has been scheduled for this job, because we are in debug mode"); } $email = UpdraftPlus_Options::get_updraft_option('updraft_email'); // If there's no email address, or the set was empty, that is the final over-ride: don't send if (!$allow_email) { $send_an_email = false; $this->log("No email will be sent - this backup set was empty."); } elseif (empty($email)) { $send_an_email = false; $this->log("No email will/can be sent - the user has not configured an email address."); } if ($force_abort) $jobdata_as_was['aborted'] = true; if ($send_an_email) $this->send_results_email($final_message, $jobdata_as_was); // Make sure this is the final message logged (so it remains on the dashboard) $this->log($final_message); @fclose($this->logfile_handle); $this->logfile_handle = null; // This is left until last for the benefit of the front-end UI, which then gets maximum chance to display the 'finished' status if ($delete_jobdata) delete_site_option('updraft_jobdata_'.$this->nonce); } /** * The jobdata is passed in instead of fetched, because the live jobdata may now differ from that which should be reported on (e.g. an incremental run was subsequently scheduled) * * @param String $final_message The final message to be sent * @param Array $jobdata Full job data */ private function send_results_email($final_message, $jobdata) { $debug_mode = UpdraftPlus_Options::get_updraft_option('updraft_debug_mode'); $sendmail_to = $this->just_one_email(UpdraftPlus_Options::get_updraft_option('updraft_email')); if (is_string($sendmail_to)) $sendmail_to = array($sendmail_to); $backup_files = $jobdata['backup_files']; $backup_db = $jobdata['backup_database']; if (is_array($backup_db)) $backup_db = $backup_db['wp']; if (is_array($backup_db)) $backup_db = $backup_db['status']; $backup_type = ('backup' == $jobdata['job_type']) ? __('Full backup', 'updraftplus') : __('Incremental', 'updraftplus'); $was_aborted = !empty($jobdata['aborted']); if ($was_aborted) { $backup_contains = __('The backup was aborted by the user', 'updraftplus'); } elseif ('finished' == $backup_files && ('finished' == $backup_db || 'encrypted' == $backup_db)) { $backup_contains = __('Files and database', 'updraftplus')." ($backup_type)"; } elseif ('finished' == $backup_files) { $backup_contains = ('begun' == $backup_db) ? __("Files (database backup has not completed)", 'updraftplus') : __('Files only (database was not part of this particular schedule)', 'updraftplus'); $backup_contains .= " ($backup_type)"; } elseif ('finished' == $backup_db || 'encrypted' == $backup_db) { $backup_contains = ('begun' == $backup_files) ? __("Database (files backup has not completed)", 'updraftplus') : __('Database only (files were not part of this particular schedule)', 'updraftplus'); } elseif ('begun' == $backup_db || 'begun' == $backup_files) { $backup_contains = __('Incomplete', 'updraftplus'); } else { $this->log('Unknown/unexpected status: '.serialize($backup_files).'/'.serialize($backup_db)); $backup_contains = __("Unknown/unexpected error - please raise a support request", 'updraftplus'); } $append_log = ''; $attachments = array(); $error_count = 0; if ($this->error_count() > 0) { $append_log .= __('Errors encountered:', 'updraftplus')."\r\n"; $attachments[0] = $this->logfile_name; foreach ($this->errors as $err) { if (is_wp_error($err)) { foreach ($err->get_error_messages() as $msg) { $append_log .= "* ".rtrim($msg)."\r\n"; } } elseif (is_array($err) && 'error' == $err['level']) { $append_log .= "* ".rtrim($err['message'])."\r\n"; } elseif (is_string($err)) { $append_log .= "* ".rtrim($err)."\r\n"; } $error_count++; } $append_log .="\r\n"; } $warnings = (isset($jobdata['warnings'])) ? $jobdata['warnings'] : array(); if (is_array($warnings) && count($warnings) >0) { $append_log .= __('Warnings encountered:', 'updraftplus')."\r\n"; $attachments[0] = $this->logfile_name; foreach ($warnings as $err) { $append_log .= "* ".rtrim($err)."\r\n"; } $append_log .="\r\n"; } if ($debug_mode && '' != $this->logfile_name && !in_array($this->logfile_name, $attachments)) { $append_log .= "\r\n".__('The log file has been attached to this email.', 'updraftplus'); $attachments[0] = $this->logfile_name; } // We have to use the action in order to set the MIME type on the attachment - by default, WordPress just puts application/octet-stream $subject = apply_filters('updraft_report_subject', sprintf(__('Backed up: %s', 'updraftplus'), get_bloginfo('name')).' (UpdraftPlus '.$this->version.') '.get_date_from_gmt(gmdate('Y-m-d H:i:s', time()), 'Y-m-d H:i'), $error_count, count($warnings)); // The class_exists() check here is a micro-optimization to prevent a possible HTTP call whose results may be disregarded by the filter $feed = ''; if (!class_exists('UpdraftPlus_Addon_Reporting') && !defined('UPDRAFTPLUS_NOADS_B') && !defined('UPDRAFTPLUS_NONEWSFEED')) { $this->log('Fetching RSS news feed'); $rss = $this->get_updraftplus_rssfeed(); $this->log('Fetched RSS news feed; result is a: '.get_class($rss)); if (is_a($rss, 'SimplePie')) { $feed .= __('Email reports created by UpdraftPlus (free edition) bring you the latest UpdraftPlus.com news', 'updraftplus')." - ".sprintf(__('read more at %s', 'updraftplus'), 'https://updraftplus.com/news/')."\r\n\r\n"; foreach ($rss->get_items(0, 6) as $item) { $feed .= '* '; $feed .= $item->get_title(); $feed .= " (".$item->get_date('j F Y').")"; // $feed .= ' - '.$item->get_permalink(); $feed .= "\r\n"; } } $feed .= "\r\n\r\n"; } $extra_messages = apply_filters('updraftplus_report_extramessages', array()); $extra_msg = ''; if (is_array($extra_messages)) { foreach ($extra_messages as $msg) { $extra_msg .= '<strong>'.$msg['key'].'</strong>: '.$msg['val']."\r\n"; } } foreach ($this->remotestorage_extrainfo as $service => $message) { if (!empty($this->backup_methods[$service])) $extra_msg .= $this->backup_methods[$service].': '.$message['plain']."\r\n"; } // Make it available to the filter $jobdata['remotestorage_extrainfo'] = $this->remotestorage_extrainfo; if (!class_exists('UpdraftPlus_Notices')) include_once(UPDRAFTPLUS_DIR.'/includes/updraftplus-notices.php'); global $updraftplus_notices; $ws_advert = $updraftplus_notices->do_notice(false, 'report-plain', true); $body = apply_filters('updraft_report_body', __('Backup of:', 'updraftplus').' '.site_url()."\r\n". "UpdraftPlus ".__('WordPress backup is complete', 'updraftplus').".\r\n". __('Backup contains:', 'updraftplus')." $backup_contains\r\n". __('Latest status:', 'updraftplus').' '.$final_message."\r\n". $extra_msg. "\r\n". $feed. $ws_advert."\r\n". $append_log, $final_message, $backup_contains, $this->errors, $warnings, $jobdata); $this->attachments = apply_filters('updraft_report_attachments', $attachments); if (count($this->attachments) > 0) add_action('phpmailer_init', array($this, 'phpmailer_init')); $attach_size = 0; $unlink_files = array(); foreach ($this->attachments as $ind => $attach) { if ($attach == $this->logfile_name && filesize($attach) > 6*1048576) { $this->log("Log file is large (".round(filesize($attach)/1024, 1)." KB): will compress before e-mailing"); if (!$handle = fopen($attach, "r")) { $this->log("Error: Failed to open log file for reading: ".$attach); } else { if (!$whandle = gzopen($attach.'.gz', 'w')) { $this->log("Error: Failed to open log file for reading: ".$attach.".gz"); } else { while (false !== ($line = @stream_get_line($handle, 131072, "\n"))) { @gzwrite($whandle, $line."\n"); } fclose($handle); gzclose($whandle); $this->attachments[$ind] = $attach.'.gz'; $unlink_files[] = $attach.'.gz'; } } } $attach_size += filesize($this->attachments[$ind]); } foreach ($sendmail_to as $ind => $mailto) { if (false === apply_filters('updraft_report_sendto', true, $mailto, $error_count, count($warnings), $ind)) continue; foreach (explode(',', $mailto) as $sendmail_addr) { $this->log("Sending email ('$backup_contains') report (attachments: ".count($attachments).", size: ".round($attach_size/1024, 1)." KB) to: ".substr($sendmail_addr, 0, 5)."..."); try { wp_mail(trim($sendmail_addr), $subject, $body, array("X-UpdraftPlus-Backup-ID: ".$this->nonce)); } catch (Exception $e) { $this->log("Exception occurred when sending mail (".get_class($e)."): ".$e->getMessage()); } } } foreach ($unlink_files as $file) @unlink($file); do_action('updraft_report_finished'); if (count($this->attachments) > 0) remove_action('phpmailer_init', array($this, 'phpmailer_init')); } /** * Called upon the WP action phpmailer_init * * @param Object $phpmailer */ public function phpmailer_init($phpmailer) { if (empty($this->attachments) || !is_array($this->attachments)) return; foreach ($this->attachments as $attach) { $mime_type = preg_match('/\.gz$/i', $attach) ? 'application/x-gzip' : 'text/plain'; try { $phpmailer->AddAttachment($attach, '', 'base64', $mime_type); } catch (Exception $e) { $this->log("Exception occurred when adding attachment (".get_class($e)."): ".$e->getMessage()); } } } /** * This function returns 'true' if mod_rewrite could be detected as unavailable; a 'false' result may mean it just couldn't find out the answer * * @param boolean $check_if_in_use_first * @return boolean */ public function mod_rewrite_unavailable($check_if_in_use_first = true) { if (function_exists('apache_get_modules')) { global $wp_rewrite; $mods = apache_get_modules(); if ((!$check_if_in_use_first || $wp_rewrite->using_mod_rewrite_permalinks()) && ((in_array('core', $mods) || in_array('http_core', $mods)) && !in_array('mod_rewrite', $mods))) { return true; } } return false; } /** * Count the number of alerts that have occurred at the specified level * * @param String $level - the level to count at * * @return Integer */ public function error_count($level = 'error') { $count = 0; foreach ($this->errors as $err) { if (('error' == $level && (is_string($err) || is_wp_error($err))) || (is_array($err) && $level == $err['level'])) { $count++; } } return $count; } public function list_errors() { echo '<ul style="list-style: disc inside;">'; foreach ($this->errors as $err) { if (is_wp_error($err)) { foreach ($err->get_error_messages() as $msg) { echo '<li>'.htmlspecialchars($msg).'<li>'; } } elseif (is_array($err) && ('error' == $err['level'] || 'warning' == $err['level'])) { echo "<li>".htmlspecialchars($err['message'])."</li>"; } elseif (is_string($err)) { echo "<li>".htmlspecialchars($err)."</li>"; } else { print "<li>".print_r($err, true)."</li>"; } } echo '</ul>'; } private function save_last_backup($backup_array) { $success = ($this->error_count() == 0) ? 1 : 0; $last_backup = apply_filters('updraftplus_save_last_backup', array( 'backup_time' => $this->backup_time, 'backup_array' => $backup_array, 'success' => $success, 'errors' => $this->errors, 'backup_nonce' => $this->nonce )); UpdraftPlus_Options::update_updraft_option('updraft_last_backup', $last_backup, false); } /** * $handle must be either false or a WPDB class (or extension thereof). Other options are not yet fully supported. * * @param Resource|Boolean|Object $handle * @param Boolean $logit - whether to log information about the check * @param Boolean $reschedule - whether to schedule a resumption if checking fails * @return Boolean|Integer - whether the check succeeded, or -1 for an unknown result */ public function check_db_connection($handle = false, $logit = false, $reschedule = false) { $type = false; if (false === $handle || is_a($handle, 'wpdb')) { $type = 'wpdb'; } elseif (is_resource($handle)) { // Expected: string(10) "mysql link" $type = get_resource_type($handle); } elseif (is_object($handle) && is_a($handle, 'mysqli')) { $type = 'mysqli'; } if (false === $type) return -1; $db_connected = -1; if ('mysql link' == $type || 'mysqli' == $type) { // @codingStandardsIgnoreLine if ('mysql link' == $type && @mysql_ping($handle)) return true; if ('mysqli' == $type && @mysqli_ping($handle)) return true; // @codingStandardsIgnoreLine for ($tries = 1; $tries <= 5; $tries++) { // to do, if ever needed // if ($this->db_connect(false )) return true; // sleep(1); } } elseif ('wpdb' == $type) { if (false === $handle || (is_object($handle) && 'wpdb' == get_class($handle))) { global $wpdb; $handle = $wpdb; } if (method_exists($handle, 'check_connection') && (!defined('UPDRAFTPLUS_SUPPRESS_CONNECTION_CHECKS') || !UPDRAFTPLUS_SUPPRESS_CONNECTION_CHECKS)) { if (!$handle->check_connection(false)) { if ($logit) $this->log("The database went away, and could not be reconnected to"); // Almost certainly a no-op if ($reschedule) UpdraftPlus_Job_Scheduler::reschedule(60); $db_connected = false; } else { $db_connected = true; } } } return $db_connected; } /** * This should be called whenever a file is successfully uploaded * * @param String $file - full filepath * @param Boolean $force - mark as successfully uploaded even if not on the last service * @return Void */ public function uploaded_file($file, $force = false) { global $updraftplus_backup; $db_connected = $this->check_db_connection(false, true, true); $service = empty($updraftplus_backup->current_service) ? '' : $updraftplus_backup->current_service; $instance_id = empty($updraftplus_backup->current_instance) ? '' : $updraftplus_backup->current_instance; $shash = $service.(('' == $service) ? '' : '-').$instance_id.(('' == $instance_id) ? '' : '-').md5($file); if ($force || !empty($updraftplus_backup->last_storage_instance)) { $this->log("Recording as successfully uploaded: $file"); $new_jobdata = $this->get_uploaded_jobdata_items($file, $service, $instance_id); } else { $new_jobdata = array('uploaded_'.$shash => 'yes'); $this->log("Recording as successfully uploaded: $file (".$updraftplus_backup->current_service.", more services to follow)"); } $upload_status = $this->jobdata_get('uploading_substatus'); if (is_array($upload_status) && isset($upload_status['i'])) { $upload_status['i']++; $upload_status['p'] = 0; $new_jobdata['uploading_substatus'] = $upload_status; } $this->jobdata_set_multi($new_jobdata); // Really, we could do this immediately when we realise the DB has gone away. This is just for the probably-impossible case that a DB write really can still succeed. But, we must abort before calling delete_local(), as the removal of the local file can cause it to be recreated if the DB is out of sync with the fact that it really is already uploaded if (false === $db_connected) { UpdraftPlus_Job_Scheduler::record_still_alive(); die; } // Delete local files immediately if the option is set // Where we are only backing up locally, only the "prune" function should do deleting $service = $this->jobdata_get('service'); if (!empty($updraftplus_backup->last_storage_instance) && ('' !== $service && ((is_array($service) && count($service)>0 && (count($service) > 1 || (array('') !== $service && array('none') !== $service))) || (is_string($service) && 'none' !== $service)))) { $this->delete_local($file); } } /** * Gets the jobdata items to be added to mark a file as uploaded * * @param String $file - the file (basename) * @param String $service - service identifier * @param String $instance_id - instance identifier * * @return Array - jobdata items */ public function get_uploaded_jobdata_items($file, $service = '', $instance_id = '') { $hash = md5($file); $shash = $service.(('' == $service) ? '' : '-').$instance_id.(('' == $instance_id) ? '' : '-').md5($file); return array( 'uploaded_lastreset' => $this->current_resumption, 'uploaded_'.$hash => 'yes', 'uploaded_'.$shash =>'yes' ); } /** * Return whether a particular file has been uploaded to a particular remote service * * @param String $file - the filename (basename) * @param String $service - the service identifier; or none, to indicate all services * @param String $instance_id - the instance identifier * * @return Boolean - the result */ public function is_uploaded($file, $service = '', $instance_id = '') { $hash = $service.(('' == $service) ? '' : '-').$instance_id.(('' == $instance_id) ? '' : '-').md5($file); return ('yes' === $this->jobdata_get("uploaded_$hash")) ? true : false; } private function delete_local($file) { $log = "Deleting local file: $file: "; if (UpdraftPlus_Options::get_updraft_option('updraft_delete_local', 1)) { $fullpath = $this->backups_dir_location().'/'.$file; // check to make sure it exists before removing if (realpath($fullpath)) { $deleted = unlink($fullpath); $this->log($log.(($deleted) ? 'OK' : 'failed')); return $deleted; } } else { $this->log($log."skipped: user has unchecked updraft_delete_local option"); } return true; } /** * For detecting another run, and aborting if one was found * * @param String $file - full file path of the file to check */ public function check_recent_modification($file) { if (file_exists($file)) { $time_mod = (int) @filemtime($file); $time_now = time(); if ($time_mod > 100 && ($time_now - $time_mod) < 30) { UpdraftPlus_Job_Scheduler::terminate_due_to_activity($file, $time_now, $time_mod); } } } public function get_exclude($whichone) { if ('uploads' == $whichone) { $exclude = explode(',', UpdraftPlus_Options::get_updraft_option('updraft_include_uploads_exclude', UPDRAFT_DEFAULT_UPLOADS_EXCLUDE)); } elseif ('others' == $whichone) { $exclude = explode(',', UpdraftPlus_Options::get_updraft_option('updraft_include_others_exclude', UPDRAFT_DEFAULT_OTHERS_EXCLUDE)); } else { $exclude = apply_filters('updraftplus_include_'.$whichone.'_exclude', array()); } return (empty($exclude) || !is_array($exclude)) ? array() : $exclude; } public function wp_upload_dir() { if (is_multisite()) { global $current_site; switch_to_blog($current_site->blog_id); } $wp_upload_dir = wp_upload_dir(); if (is_multisite()) restore_current_blog(); return $wp_upload_dir; } public function backup_uploads_dirlist($logit = false) { // Create an array of directories to be skipped // Make the values into the keys $exclude = UpdraftPlus_Options::get_updraft_option('updraft_include_uploads_exclude', UPDRAFT_DEFAULT_UPLOADS_EXCLUDE); if ($logit) $this->log("Exclusion option setting (uploads): ".$exclude); $skip = array_flip(preg_split("/,/", $exclude)); $wp_upload_dir = $this->wp_upload_dir(); $uploads_dir = $wp_upload_dir['basedir']; return $this->compile_folder_list_for_backup($uploads_dir, array(), $skip); } public function backup_others_dirlist($logit = false) { // Create an array of directories to be skipped // Make the values into the keys $exclude = UpdraftPlus_Options::get_updraft_option('updraft_include_others_exclude', UPDRAFT_DEFAULT_OTHERS_EXCLUDE); if ($logit) $this->log("Exclusion option setting (others): ".$exclude); $skip = array_flip(preg_split("/,/", $exclude)); $file_entities = $this->get_backupable_file_entities(false); // Keys = directory names to avoid; values = the label for that directory (used only in log files) // $avoid_these_dirs = array_flip($file_entities); $avoid_these_dirs = array(); foreach ($file_entities as $type => $dirs) { if (is_string($dirs)) { $avoid_these_dirs[$dirs] = $type; } elseif (is_array($dirs)) { foreach ($dirs as $dir) { $avoid_these_dirs[$dir] = $type; } } } return $this->compile_folder_list_for_backup(WP_CONTENT_DIR, $avoid_these_dirs, $skip); } /** * avoid_these_dirs and skip_these_dirs ultimately do the same thing; but avoid_these_dirs takes full paths whereas skip_these_dirs takes basenames; and they are logged differently (dirs in avoid are potentially dangerous to include; skip is just a user-level preference). They are allowed to overlap. * * @param string $backup_from_inside_dir * @param string $avoid_these_dirs * @param string $skip_these_dirs * @return array */ public function compile_folder_list_for_backup($backup_from_inside_dir, $avoid_these_dirs, $skip_these_dirs) { // Entries in $skip_these_dirs are allowed to end in *, which means "and anything else as a suffix". It's not a full shell glob, but it covers what is needed to-date. $dirlist = array(); $added = 0; $this->log('Looking for candidates to backup in: '.$backup_from_inside_dir); $updraft_dir = $this->backups_dir_location(); if (is_file($backup_from_inside_dir)) { array_push($dirlist, $backup_from_inside_dir); $added++; $this->log("finding files: $backup_from_inside_dir: adding to list ($added)"); } elseif ($handle = opendir($backup_from_inside_dir)) { while (false !== ($entry = readdir($handle))) { if ('.' == $entry || '..' == $entry) continue; // $candidate: full path; $entry = one-level $candidate = $backup_from_inside_dir.'/'.$entry; if (isset($avoid_these_dirs[$candidate])) { $this->log("finding files: $entry: skipping: this is the ".$avoid_these_dirs[$candidate]." directory"); } elseif ($candidate == $updraft_dir) { $this->log("finding files: $entry: skipping: this is the updraft directory"); } elseif (isset($skip_these_dirs[$entry])) { $this->log("finding files: $entry: skipping: excluded by options"); } else { $add_to_list = true; // Now deal with entries in $skip_these_dirs ending in * or starting with * foreach ($skip_these_dirs as $skip => $sind) { if ('*' == substr($skip, -1, 1) && '*' == substr($skip, 0, 1) && strlen($skip) > 2) { if (strpos($entry, substr($skip, 1, strlen($skip)-2)) !== false) { $this->log("finding files: $entry: skipping: excluded by options (glob)"); $add_to_list = false; } } elseif ('*' == substr($skip, -1, 1) && strlen($skip) > 1) { if (substr($entry, 0, strlen($skip)-1) == substr($skip, 0, strlen($skip)-1)) { $this->log("finding files: $entry: skipping: excluded by options (glob)"); $add_to_list = false; } } elseif ('*' == substr($skip, 0, 1) && strlen($skip) > 1) { if (strlen($entry) >= strlen($skip)-1 && substr($entry, (strlen($skip)-1)*-1) == substr($skip, 1)) { $this->log("finding files: $entry: skipping: excluded by options (glob)"); $add_to_list = false; } } } if ($add_to_list) { array_push($dirlist, $candidate); $added++; $skip_dblog = (($added > 50 && 0 != $added % 100) || ($added > 2000 && 0 != $added % 500)); $this->log("finding files: $entry: adding to list ($added)", 'notice', false, $skip_dblog); } } } @closedir($handle); } else { $this->log('ERROR: Could not read the directory: '.$backup_from_inside_dir); $this->log(__('Could not read the directory', 'updraftplus').': '.$backup_from_inside_dir, 'error'); } return $dirlist; } /** * Save the backup information to the backup history during a running backup (adding information to the currently-running job) * * @param Array $backup_array - the backup history */ private function save_backup_to_history($backup_array) { if (!is_array($backup_array)) { $this->log('Could not save backup history because we have no backup array. Backup probably failed.'); $this->log(__('Could not save backup history because we have no backup array. Backup probably failed.', 'updraftplus'), 'error'); return; } $job_type = $this->jobdata_get('job_type'); $backup_array['nonce'] = $this->file_nonce; $backup_array['service'] = $this->jobdata_get('service'); $backup_array['service_instance_ids'] = array(); if ('incremental' != $job_type) $backup_array['always_keep'] = $this->jobdata_get('always_keep', false); $backup_array['files_enumerated_at'] = $this->jobdata_get('files_enumerated_at'); // N.B. Though the saved 'service' option can have various forms (especially if upgrading from (very) old versions), in the jobdata, it is always an array. $storage_objects_and_ids = UpdraftPlus_Storage_Methods_Interface::get_enabled_storage_objects_and_ids($backup_array['service']); // N.B. On PHP 5.5+, we'd use array_column() foreach ($storage_objects_and_ids as $method => $method_information) { if ('none' == $method || !$method || !$method_information['object']->supports_feature('multi_options')) continue; $backup_array['service_instance_ids'][$method] = array_keys($method_information['instance_settings']); } if ('incremental' != $job_type && '' != ($label = $this->jobdata_get('label', ''))) $backup_array['label'] = $label; if (!isset($backup_array['created_by_version'])) $backup_array['created_by_version'] = $this->version; $backup_array['last_saved_by_version'] = $this->version; $backup_array['is_multisite'] = is_multisite() ? true : false; $remotesend_info = $this->jobdata_get('remotesend_info'); if (is_array($remotesend_info) && !empty($remotesend_info['url'])) $backup_array['remotesend_url'] = $remotesend_info['url']; if (false != $this->jobdata_get('is_autobackup', false)) $backup_array['autobackup'] = true; if (false != ($morefiles_linked_indexes = $this->jobdata_get('morefiles_linked_indexes', false))) $backup_array['morefiles_linked_indexes'] = $morefiles_linked_indexes; if (false != ($morefiles_more_locations = $this->jobdata_get('morefiles_more_locations', false))) $backup_array['morefiles_more_locations'] = $morefiles_more_locations; UpdraftPlus_Backup_History::save_backup(apply_filters('updraftplus_save_backup_history_timestamp', $this->backup_time), $backup_array); } /** * If files + db are on different schedules but are scheduled for the same time, * then combine them $event = (object) array('hook' => $hook, 'timestamp' => $timestamp, 'schedule' => $recurrence, 'args' => $args, 'interval' => $schedules[$recurrence]['interval']); * See wp_schedule_single_event() and wp_schedule_event() in wp-includes/cron.php * * @param Object|Boolean $event - the event being scheduled * @return Object|Boolean - the filtered value */ public function schedule_event($event) { static $scheduled = array(); if (is_object($event) && ('updraft_backup' == $event->hook || 'updraft_backup_database' == $event->hook)) { // Reset the option - but make sure it is saved first so that we can used it (since this hook may be called just before our actual cron task) $this->combine_jobs_around = UpdraftPlus_Options::get_updraft_option('updraft_combine_jobs_around'); UpdraftPlus_Options::delete_updraft_option('updraft_combine_jobs_around'); $scheduled[$event->hook] = true; // This next fragment is wrong: there's only a 'second call' when saving all settings; otherwise, the WP scheduler might just be updating one event. So, there's some inefficieny as the option is wiped and set uselessly at least once when saving settings. // We only want to take action on the second call (otherwise, our information is out-of-date already) // If there is no second call, then that's fine - nothing to do // if (count($scheduled) < 2) { // return $event; // } $backup_scheduled_for = ('updraft_backup' == $event->hook) ? $event->timestamp : wp_next_scheduled('updraft_backup'); $db_scheduled_for = ('updraft_backup_database' == $event->hook) ? $event->timestamp : wp_next_scheduled('updraft_backup_database'); $diff = absint($backup_scheduled_for - $db_scheduled_for); $margin = (defined('UPDRAFTPLUS_COMBINE_MARGIN') && is_numeric(UPDRAFTPLUS_COMBINE_MARGIN)) ? UPDRAFTPLUS_COMBINE_MARGIN : 600; if ($backup_scheduled_for && $db_scheduled_for && $diff < $margin) { // We could change the event parameters; however, this would complicate other code paths (because the WP cron system uses a hash of the parameters as a key, and you must supply the exact parameters to look up events). So, we just set a marker that boot_backup() can pick up on. UpdraftPlus_Options::update_updraft_option('updraft_combine_jobs_around', min($backup_scheduled_for, $db_scheduled_for)); } } return $event; } /** * This function is both the backup scheduler and a filter callback for saving the option. It is called in the register_setting for the updraft_interval, which means when the admin settings are saved it is called. * * @param String $interval * @return String - filtered value */ public function schedule_backup($interval) { $previous_time = wp_next_scheduled('updraft_backup'); // Clear schedule so that we don't stack up scheduled backups wp_clear_scheduled_hook('updraft_backup'); if ('manual' == $interval) { // Clear increments schedule as the file schedule is manual wp_clear_scheduled_hook('updraft_backup_increments'); return 'manual'; } $previous_interval = UpdraftPlus_Options::get_updraft_option('updraft_interval'); $valid_schedules = wp_get_schedules(); if (empty($valid_schedules[$interval])) $interval = 'daily'; // Try to avoid changing the time is one was already scheduled. This is fairly conservative - we could do more, e.g. check if a backup already happened today. $default_time = ($interval == $previous_interval && $previous_time>0) ? $previous_time : time()+120; $first_time = apply_filters('updraftplus_schedule_firsttime_files', $default_time); wp_schedule_event($first_time, $interval, 'updraft_backup'); return $interval; } /** * This function is both the database backup scheduler and a filter callback for saving the option. It is called in the register_setting for the updraft_interval_database, which means when the admin settings are saved it is called. * * @param String $interval * @return String - filtered value */ public function schedule_backup_database($interval) { $previous_time = wp_next_scheduled('updraft_backup_database'); // Clear schedule so that we don't stack up scheduled backups wp_clear_scheduled_hook('updraft_backup_database'); if ('manual' == $interval) return 'manual'; $previous_interval = UpdraftPlus_Options::get_updraft_option('updraft_interval_database'); $valid_schedules = wp_get_schedules(); if (empty($valid_schedules[$interval])) $interval = 'daily'; // Try to avoid changing the time is one was already scheduled. This is fairly conservative - we could do more, e.g. check if a backup already happened today. $default_time = ($interval == $previous_interval && $previous_time>0) ? $previous_time : time()+120; $first_time = apply_filters('updraftplus_schedule_firsttime_db', $default_time); wp_schedule_event($first_time, $interval, 'updraft_backup_database'); return $interval; } /** * This function is both the increments backup scheduler and a filter callback for saving the option. It is called in the register_setting for the updraft_interval_increments, which means when the admin settings are saved it is called. * * @param String $interval * @return String - filtered value */ public function schedule_backup_increments($interval) { $previous_time = wp_next_scheduled('updraft_backup_increments'); // Clear schedule so that we don't stack up scheduled backups wp_clear_scheduled_hook('updraft_backup_increments'); if ('none' == $interval || empty($interval)) return 'none'; $previous_interval = UpdraftPlus_Options::get_updraft_option('updraft_interval_increments'); $valid_schedules = wp_get_schedules(); if (empty($valid_schedules[$interval])) $interval = 'daily'; // Try to avoid changing the time is one was already scheduled. This is fairly conservative - we could do more, e.g. check if a backup already happened today. $default_time = ($interval == $previous_interval && $previous_time>0) ? $previous_time : time()+120; $first_time = apply_filters('updraftplus_schedule_firsttime_increments', $default_time); wp_schedule_event($first_time, $interval, 'updraft_backup_increments'); return $interval; } /** * Acts as a WordPress options filter * * @param Array $options - An array of options * @param String $option_name - The option name * * @return Array - the returned array can either be the set of updated options or a WordPress error array */ public function storage_options_filter($options, $option_name) { if ('updraft_' !== substr($option_name, 0, 8)) return $options; $method = substr($option_name, 8); $storage = UpdraftPlus_Storage_Methods_Interface::get_storage_object($method); if (!is_a($storage, 'UpdraftPlus_BackupModule') || !is_callable(array($storage, 'options_filter'))) return $options; return call_user_func(array($storage, 'options_filter'), $options); } /** * Get the location of UD's internal directory * * @param Boolean $allow_cache * @return String - the directory path. Returns without any trailing slash. */ public function backups_dir_location($allow_cache = true) { if ($allow_cache && !empty($this->backup_dir)) return $this->backup_dir; $updraft_dir = untrailingslashit(UpdraftPlus_Options::get_updraft_option('updraft_dir')); // When newly installing, if someone had (e.g.) wp-content/updraft in their database from a previous, deleted pre-1.7.18 install but had removed the updraft directory before re-installing, without this fix they'd end up with wp-content/wp-content/updraft. if (preg_match('/^wp-content\/(.*)$/', $updraft_dir, $matches) && ABSPATH.'wp-content' === WP_CONTENT_DIR) { UpdraftPlus_Options::update_updraft_option('updraft_dir', $matches[1]); $updraft_dir = WP_CONTENT_DIR.'/'.$matches[1]; } $default_backup_dir = WP_CONTENT_DIR.'/updraft'; $updraft_dir = ($updraft_dir) ? $updraft_dir : $default_backup_dir; // Do a test for a relative path if ('/' != substr($updraft_dir, 0, 1) && "\\" != substr($updraft_dir, 0, 1) && !preg_match('/^[a-zA-Z]:/', $updraft_dir)) { // Legacy - file paths stored related to ABSPATH if (is_dir(ABSPATH.$updraft_dir) && is_file(ABSPATH.$updraft_dir.'/index.html') && is_file(ABSPATH.$updraft_dir.'/.htaccess') && !is_file(ABSPATH.$updraft_dir.'/index.php') && false !== strpos(file_get_contents(ABSPATH.$updraft_dir.'/.htaccess', false, null, 0, 20), 'deny from all')) { $updraft_dir = ABSPATH.$updraft_dir; } else { // File paths stored relative to WP_CONTENT_DIR $updraft_dir = trailingslashit(WP_CONTENT_DIR).$updraft_dir; } } // Check for the existence of the dir and prevent enumeration // index.php is for a sanity check - make sure that we're not somewhere unexpected if ((!is_dir($updraft_dir) || !is_file($updraft_dir.'/index.html') || !is_file($updraft_dir.'/.htaccess')) && !is_file($updraft_dir.'/index.php') || !is_file($updraft_dir.'/web.config')) { @mkdir($updraft_dir, 0775, true); @file_put_contents($updraft_dir.'/index.html', "<html><body><a href=\"https://updraftplus.com\" target=\"_blank\">WordPress backups by UpdraftPlus</a></body></html>"); if (!is_file($updraft_dir.'/.htaccess')) @file_put_contents($updraft_dir.'/.htaccess', 'deny from all'); if (!is_file($updraft_dir.'/web.config')) @file_put_contents($updraft_dir.'/web.config', "<configuration>\n<system.webServer>\n<authorization>\n<deny users=\"*\" />\n</authorization>\n</system.webServer>\n</configuration>\n"); } $this->backup_dir = $updraft_dir; return $updraft_dir; } public function spool_file($fullpath, $encryption = '') { @set_time_limit(900); if (!file_exists($fullpath) || filesize($fullpath) < 1) { _e('File not found', 'updraftplus'); return; } // Prevent any debug output // Don't enable this line - it causes 500 HTTP errors in some cases/hosts on some large files, for unknown reason // @ini_set('display_errors', '0'); $spooled = false; if (UpdraftPlus_Encryption::is_file_encrypted($fullpath)) { if (ob_get_level()) { $flush_max = min(5, (int) ob_get_level()); for ($i=1; $i<=$flush_max; $i++) { @ob_end_clean(); } } header("Cache-Control: no-cache, must-revalidate"); // HTTP/1.1 header("Expires: Sat, 26 Jul 1997 05:00:00 GMT"); // Date in the past UpdraftPlus_Encryption::spool_crypted_file($fullpath, (string) $encryption); return; } $content_type = UpdraftPlus_Manipulation_Functions::get_mime_type_from_filename($fullpath, false); include_once(UPDRAFTPLUS_DIR.'/includes/class-partialfileservlet.php'); // Prevent the file being read into memory if (ob_get_level()) { $flush_max = min(5, (int) ob_get_level()); for ($i=1; $i<=$flush_max; $i++) { @ob_end_clean(); } } if (ob_get_level()) @ob_end_clean(); // Twice - see HS#6673 - someone at least needed it if (isset($_SERVER['HTTP_RANGE'])) { $range_header = trim($_SERVER['HTTP_RANGE']); } elseif (function_exists('apache_request_headers')) { foreach (apache_request_headers() as $name => $value) { if (strtoupper($name) === 'RANGE') { $range_header = trim($value); } } } if (empty($range_header)) { header("Content-Length: ".filesize($fullpath)); header("Content-type: $content_type"); header("Content-Disposition: attachment; filename=\"".basename($fullpath)."\";"); readfile($fullpath); return; } try { $range_header = UpdraftPlus_RangeHeader::createFromHeaderString($range_header); $servlet = new UpdraftPlus_PartialFileServlet($range_header); $servlet->send_file($fullpath, $content_type); } catch (UpdraftPlus_InvalidRangeHeaderException $e) { header("HTTP/1.1 400 Bad Request"); error_log("UpdraftPlus: UpdraftPlus_InvalidRangeHeaderException: ".$e->getMessage()); } catch (UpdraftPlus_UnsatisfiableRangeException $e) { header("HTTP/1.1 416 Range Not Satisfiable"); } catch (UpdraftPlus_NonExistentFileException $e) { header("HTTP/1.1 404 Not Found"); } catch (UpdraftPlus_UnreadableFileException $e) { header("HTTP/1.1 500 Internal Server Error"); } } public function just_one_email($input, $required = false) { $x = $this->just_one($input, 'saveemails', (empty($input) && false === $required) ? '' : get_bloginfo('admin_email')); if (is_array($x)) { foreach ($x as $ind => $val) { if (empty($val)) unset($x[$ind]); } if (empty($x)) $x = ''; } return $x; } /** * Filter the values down to just one (subject to being filtered) * * @param Array|String $input - input * @param String $filter - filter suffix to use * @param Boolean|String $rinput - a 'preferred' value (unless false) if no filtering is done * * @return Array|String - output, after filtering */ public function just_one($input, $filter = 'savestorage', $rinput = false) { $oinput = $input; if (false === $rinput) $rinput = is_array($input) ? array_pop($input) : $input; if (is_string($rinput) && false !== strpos($rinput, ',')) $rinput = substr($rinput, 0, strpos($rinput, ',')); return apply_filters('updraftplus_'.$filter, $rinput, $oinput); } /** * Enqueue the JavaScript and CSS for the select2 library */ public function enqueue_select2() { // De-register to defeat any plugins that may have registered incompatible versions (e.g. WooCommerce 2.5 beta1 still has the Select 2 3.5 series) wp_deregister_script('select2'); wp_deregister_style('select2'); $select2_version = $this->use_unminified_scripts() ? '4.0.3'.'.'.time() : '4.0.3'; $min_or_not = $this->use_unminified_scripts() ? '' : '.min'; wp_enqueue_script('select2', UPDRAFTPLUS_URL."/includes/select2/select2".$min_or_not.".js", array('jquery'), $select2_version); wp_enqueue_style('select2', UPDRAFTPLUS_URL."/includes/select2/select2".$min_or_not.".css", array(), $select2_version); } public function memory_check_current($memory_limit = false) { // Returns in megabytes if (false == $memory_limit) $memory_limit = ini_get('memory_limit'); $memory_limit = rtrim($memory_limit); $memory_unit = $memory_limit[strlen($memory_limit)-1]; if (0 == (int) $memory_unit && '0' !== $memory_unit) { $memory_limit = substr($memory_limit, 0, strlen($memory_limit)-1); } else { $memory_unit = ''; } switch ($memory_unit) { case '': $memory_limit = floor($memory_limit/1048576); break; case 'K': case 'k': $memory_limit = floor($memory_limit/1024); break; case 'G': $memory_limit = $memory_limit*1024; break; case 'M': // assumed size, no change needed break; } return $memory_limit; } public function memory_check($memory, $check_using = false) { $memory_limit = $this->memory_check_current($check_using); return ($memory_limit >= $memory) ? true : false; } /** * Get the UpdraftPlus RSS feed * * @uses fetch_feed() * * @return WP_Error|SimplePie WP_Error object on failure or SimplePie object on success */ public function get_updraftplus_rssfeed() { if (!function_exists('fetch_feed')) include(ABSPATH.WPINC.'/feed.php'); return fetch_feed('http://feeds.feedburner.com/updraftplus/'); } /** * Sets up the nonce, basic job data, opens a log file for a new restore job, and makes sure that the Updraft_Restorer class is available * * @param boolean|string $nonce - the job nonce we want to use or false for a new one * * @return void */ public function initiate_restore_job($nonce = false) { $this->backup_time_nonce($nonce); // we reset here so that we ensure the correct jobdata gets loaded while we resume $this->jobdata_reset(); $this->jobdata_set('job_type', 'restore'); $this->jobdata_set('job_time_ms', $this->job_time_ms); $this->logfile_open($this->nonce); if (!class_exists('Updraft_Restorer')) include_once(UPDRAFTPLUS_DIR.'/restorer.php'); } /** * Analyse a database file and return information about it * * @param Integer $timestamp - the database time in the backup history * @param Array $res - accompanying data. The key 'updraft_encryptionphrase' will be used for decryption if relevant. * @param Boolean|String $db_file - the path to the file to analyse; if not specified (false), then it will be obtained from the backup history * @param Boolean $header_only - whether or not to stop analysis once the header ends * * @return Array - containing arrays for the resulting messages, warnings, errors and meta information */ public function analyse_db_file($timestamp, $res, $db_file = false, $header_only = false) { $mess = array(); $warn = array(); $err = array(); $info = array(); $wp_version = $this->get_wordpress_version(); global $wpdb; $updraft_dir = $this->backups_dir_location(); if (false === $db_file) { // This attempts to raise the maximum packet size. This can't be done within the session, only globally. Therefore, it has to be done before the session starts; in our case, during the pre-analysis. $this->max_packet_size(); $backup = UpdraftPlus_Backup_History::get_history($timestamp); if (!isset($backup['nonce']) || !isset($backup['db'])) return array($mess, $warn, $err, $info); $db_file = is_string($backup['db']) ? $updraft_dir.'/'.$backup['db'] : $updraft_dir.'/'.$backup['db'][0]; } if (!is_readable($db_file)) return array($mess, $warn, $err, $info); // Encrypted - decrypt it if (UpdraftPlus_Encryption::is_file_encrypted($db_file)) { $encryption = empty($res['updraft_encryptionphrase']) ? UpdraftPlus_Options::get_updraft_option('updraft_encryptionphrase') : $res['updraft_encryptionphrase']; if (!$encryption) { if (class_exists('UpdraftPlus_Addon_MoreDatabase')) { $err[] = sprintf(__('Error: %s', 'updraftplus'), __('Decryption failed. The database file is encrypted, but you have no encryption key entered.', 'updraftplus')); } else { $err[] = sprintf(__('Error: %s', 'updraftplus'), __('Decryption failed. The database file is encrypted.', 'updraftplus')); } return array($mess, $warn, $err, $info); } $decrypted_file = UpdraftPlus_Encryption::decrypt($db_file, $encryption); if (is_array($decrypted_file)) { $db_file = $decrypted_file['fullpath']; } else { $err[] = __('Decryption failed. The most likely cause is that you used the wrong key.', 'updraftplus'); return array($mess, $warn, $err, $info); } } // Even the empty schema when gzipped comes to 1565 bytes; a blank WP 3.6 install at 5158. But we go low, in case someone wants to share single tables. if (filesize($db_file) < 1000) { $err[] = sprintf(__('The database is too small to be a valid WordPress database (size: %s Kb).', 'updraftplus'), round(filesize($db_file)/1024, 1)); return array($mess, $warn, $err, $info); } $is_plain = ('.gz' == substr($db_file, -3, 3)) ? false : true; $dbhandle = $is_plain ? fopen($db_file, 'r') : UpdraftPlus_Filesystem_Functions::gzopen_for_read($db_file, $warn, $err); if (!is_resource($dbhandle)) { $err[] = __('Failed to open database file.', 'updraftplus'); return array($mess, $warn, $err, $info); } $info['timestamp'] = $timestamp; // Analyse the file, print the results. $line = 0; $old_siteurl = ''; $old_home = ''; $old_table_prefix = ''; $old_siteinfo = array(); $gathering_siteinfo = true; $old_wp_version = ''; $old_php_version = ''; $tables_found = array(); $db_charsets_found = array(); // TODO: If the backup is the right size/checksum, then we could restore the $line <= 100 in the 'while' condition and not bother scanning the whole thing? Or better: sort the core tables to be first so that this usually terminates early $wanted_tables = array('terms', 'term_taxonomy', 'term_relationships', 'commentmeta', 'comments', 'links', 'options', 'postmeta', 'posts', 'users', 'usermeta'); $migration_warning = false; $processing_create = false; $db_version = $wpdb->db_version(); // Don't set too high - we want a timely response returned to the browser // Until April 2015, this was always 90. But we've seen a few people with ~1GB databases (uncompressed), and 90s is not enough. Note that we don't bother checking here if it's compressed - having a too-large timeout when unexpected is harmless, as it won't be hit. On very large dbs, they're expecting it to take a while. // "120 or 240" is a first attempt at something more useful than just fixed at 90 - but should be sufficient (as 90 was for everyone without ~1GB databases) $default_dbscan_timeout = (filesize($db_file) < 31457280) ? 120 : 240; $dbscan_timeout = (defined('UPDRAFTPLUS_DBSCAN_TIMEOUT') && is_numeric(UPDRAFTPLUS_DBSCAN_TIMEOUT)) ? UPDRAFTPLUS_DBSCAN_TIMEOUT : $default_dbscan_timeout; @set_time_limit($dbscan_timeout); // We limit the time that we spend scanning the file for character sets $db_charset_collate_scan_timeout = (defined('UPDRAFTPLUS_DB_CHARSET_COLLATE_SCAN_TIMEOUT') && is_numeric(UPDRAFTPLUS_DB_CHARSET_COLLATE_SCAN_TIMEOUT)) ? UPDRAFTPLUS_DB_CHARSET_COLLATE_SCAN_TIMEOUT : 10; $charset_scan_start_time = microtime(true); $db_supported_character_sets = (array) $GLOBALS['wpdb']->get_results('SHOW CHARACTER SET', OBJECT_K); $db_supported_collations = (array) $GLOBALS['wpdb']->get_results('SHOW COLLATION', OBJECT_K); $db_charsets_found = array(); $db_collates_found = array(); $db_supported_charset_related_to_unsupported_collation = false; $db_supported_charsets_related_to_unsupported_collations = array(); while ((($is_plain && !feof($dbhandle)) || (!$is_plain && !gzeof($dbhandle))) && ($line<100 || (!$header_only && count($wanted_tables)>0) || ((microtime(true) - $charset_scan_start_time) < $db_charset_collate_scan_timeout && !empty($db_supported_character_sets)))) { $line++; // Up to 1MB $buffer = $is_plain ? rtrim(fgets($dbhandle, 1048576)) : rtrim(gzgets($dbhandle, 1048576)); // Comments are what we are interested in if (substr($buffer, 0, 1) == '#') { $processing_create = false; if ('' == $old_siteurl && preg_match('/^\# Backup of: (http(.*))$/', $buffer, $matches)) { $old_siteurl = untrailingslashit($matches[1]); $mess[] = __('Backup of:', 'updraftplus').' '.htmlspecialchars($old_siteurl).((!empty($old_wp_version)) ? ' '.sprintf(__('(version: %s)', 'updraftplus'), $old_wp_version) : ''); // Check for should-be migration if (untrailingslashit(site_url()) != $old_siteurl) { if (!$migration_warning) { $migration_warning = true; $info['migration'] = true; // && !class_exists('UpdraftPlus_Addons_Migrator') if (UpdraftPlus_Manipulation_Functions::normalise_url($old_siteurl) == UpdraftPlus_Manipulation_Functions::normalise_url(site_url())) { // Same site migration with only http/https difference $info['same_url'] = false; $old_siteurl_parsed = parse_url($old_siteurl); $actual_siteurl_parsed = parse_url(site_url()); if ((stripos($old_siteurl_parsed['host'], 'www.') === 0 && stripos($actual_siteurl_parsed['host'], 'www.') !== 0) || (stripos($old_siteurl_parsed['host'], 'www.') !== 0 && stripos($actual_siteurl_parsed['host'], 'www.') === 0)) { $powarn = sprintf(__('The website address in the backup set (%s) is slightly different from that of the site now (%s). This is not expected to be a problem for restoring the site, as long as visits to the former address still reach the site.', 'updraftplus'), $old_siteurl, site_url()).' '; } else { $powarn = ''; } if (('https' == $old_siteurl_parsed['scheme'] && 'http' == $actual_siteurl_parsed['scheme']) || ('http' == $old_siteurl_parsed['scheme'] && 'https' == $actual_siteurl_parsed['scheme'])) { $powarn .= sprintf(__('This backup set is of this site, but at the time of the backup you were using %s, whereas the site now uses %s.', 'updraftplus'), $old_siteurl_parsed['scheme'], $actual_siteurl_parsed['scheme']); if ('https' == $old_siteurl_parsed['scheme']) { $powarn .= ' '.apply_filters('updraftplus_https_to_http_additional_warning', sprintf(__('This restoration will work if you still have an SSL certificate (i.e. can use https) to access the site. Otherwise, you will want to use %s to search/replace the site address so that the site can be visited without https.', 'updraftplus'), '<a href="https://updraftplus.com/shop/migrator/" target="_blank">'.__('the migrator add-on', 'updraftplus').'</a>')); } else { $powarn .= ' '.apply_filters('updraftplus_http_to_https_additional_warning', sprintf(__('As long as your web hosting allows http (i.e. non-SSL access) or will forward requests to https (which is almost always the case), this is no problem. If that is not yet set up, then you should set it up, or use %s so that the non-https links are automatically replaced.', 'updraftplus'), apply_filters('updraftplus_migrator_addon_link', '<a href="https://updraftplus.com/shop/migrator/" target="_blank">'.__('the migrator add-on', 'updraftplus').'</a>'))); } } else { $powarn .= apply_filters('updraftplus_dbscan_urlchange_www_append_warning', ''); } $warn[] = $powarn; } else { // For completely different site migration $info['same_url'] = false; $warn[] = apply_filters('updraftplus_dbscan_urlchange', '<a href="https://updraftplus.com/shop/migrator/" target="_blank">'.sprintf(__('This backup set is from a different site (%s) - this is not a restoration, but a migration. You need the Migrator add-on in order to make this work.', 'updraftplus'), htmlspecialchars($old_siteurl.' / '.untrailingslashit(site_url()))).'</a>', $old_siteurl, $res); } if (!class_exists('UpdraftPlus_Addons_Migrator')) { $warn[] .= '<strong><a href="'.apply_filters('updraftplus_com_link', "https://updraftplus.com/faqs/tell-me-more-about-the-search-and-replace-site-location-in-the-database-option/").'" target="_blank">'.__('You can search and replace your database (for migrating a website to a new location/URL) with the Migrator add-on - follow this link for more information', 'updraftplus').'</a></strong>'; } } if ($this->mod_rewrite_unavailable(false)) { $warn[] = sprintf(__('You are using the %s webserver, but do not seem to have the %s module loaded.', 'updraftplus'), 'Apache', 'mod_rewrite').' '.sprintf(__('You should enable %s to make any pretty permalinks (e.g. %s) work', 'updraftplus'), 'mod_rewrite', 'http://example.com/my-page/'); } } else { // For exactly same URL site restoration $info['same_url'] = true; } } elseif ('' == $old_home && preg_match('/^\# Home URL: (http(.*))$/', $buffer, $matches)) { $old_home = untrailingslashit($matches[1]); // Check for should-be migration if (!$migration_warning && UpdraftPlus_Manipulation_Functions::normalise_url(home_url()) != UpdraftPlus_Manipulation_Functions::normalise_url($old_home)) { $migration_warning = true; $powarn = apply_filters('updraftplus_dbscan_urlchange', '<a href="https://updraftplus.com/shop/migrator/" target="_blank">'.sprintf(__('This backup set is from a different site (%s) - this is not a restoration, but a migration. You need the Migrator add-on in order to make this work.', 'updraftplus'), htmlspecialchars($old_home.' / '.home_url())).'</a>', $old_home, $res); if (!empty($powarn)) $warn[] = $powarn; } } elseif (!isset($info['created_by_version']) && preg_match('/^\# Created by UpdraftPlus version ([\d\.]+)/', $buffer, $matches)) { $info['created_by_version'] = trim($matches[1]); } elseif ('' == $old_wp_version && preg_match('/^\# WordPress Version: ([0-9]+(\.[0-9]+)+)(-[-a-z0-9]+,)?(.*)$/', $buffer, $matches)) { $old_wp_version = $matches[1]; if (!empty($matches[3])) $old_wp_version .= substr($matches[3], 0, strlen($matches[3])-1); if (version_compare($old_wp_version, $wp_version, '>')) { // $mess[] = sprintf(__('%s version: %s', 'updraftplus'), 'WordPress', $old_wp_version); $warn[] = sprintf(__('You are importing from a newer version of WordPress (%s) into an older one (%s). There are no guarantees that WordPress can handle this.', 'updraftplus'), $old_wp_version, $wp_version); } if (preg_match('/running on PHP ([0-9]+\.[0-9]+)(\s|\.)/', $matches[4], $nmatches) && preg_match('/^([0-9]+\.[0-9]+)(\s|\.)/', PHP_VERSION, $cmatches)) { $old_php_version = $nmatches[1]; $current_php_version = $cmatches[1]; if (version_compare($old_php_version, $current_php_version, '>')) { // $mess[] = sprintf(__('%s version: %s', 'updraftplus'), 'WordPress', $old_wp_version); $warn[] = sprintf(__('The site in this backup was running on a webserver with version %s of %s. ', 'updraftplus'), $old_php_version, 'PHP').' '.sprintf(__('This is significantly newer than the server which you are now restoring onto (version %s).', 'updraftplus'), PHP_VERSION).' '.sprintf(__('You should only proceed if you cannot update the current server and are confident (or willing to risk) that your plugins/themes/etc. are compatible with the older %s version.', 'updraftplus'), 'PHP').' '.sprintf(__('Any support requests to do with %s should be raised with your web hosting company.', 'updraftplus'), 'PHP'); } } } elseif ('' == $old_table_prefix && (preg_match('/^\# Table prefix: (\S+)$/', $buffer, $matches) || preg_match('/^-- Table prefix: (\S+)$/i', $buffer, $matches))) { $old_table_prefix = $matches[1]; // echo '<strong>'.__('Old table prefix:', 'updraftplus').'</strong> '.htmlspecialchars($old_table_prefix).'<br>'; } elseif (empty($info['label']) && preg_match('/^\# Label: (.*)$/', $buffer, $matches)) { $info['label'] = $matches[1]; $mess[] = __('Backup label:', 'updraftplus').' '.htmlspecialchars($info['label']); } elseif ($gathering_siteinfo && preg_match('/^\# Site info: (\S+)$/', $buffer, $matches)) { if ('end' == $matches[1]) { $gathering_siteinfo = false; // Sanity checks if (isset($old_siteinfo['multisite']) && !$old_siteinfo['multisite'] && is_multisite()) { // Just need to check that you're crazy // if (!defined('UPDRAFTPLUS_EXPERIMENTAL_IMPORTINTOMULTISITE') || !UPDRAFTPLUS_EXPERIMENTAL_IMPORTINTOMULTISITE) { // $err[] = sprintf(__('Error: %s', 'updraftplus'), __('You are running on WordPress multisite - but your backup is not of a multisite site.', 'updraftplus')); // return array($mess, $warn, $err, $info); // } else { $warn[] = __('You are running on WordPress multisite - but your backup is not of a multisite site.', 'updraftplus').' '.__('It will be imported as a new site.', 'updraftplus').' <a href="https://updraftplus.com/information-on-importing-a-single-site-wordpress-backup-into-a-wordpress-network-i-e-multisite/" target="_blank">'.__('Please read this link for important information on this process.', 'updraftplus').'</a>'; // } // Got the needed code? if (!class_exists('UpdraftPlusAddOn_MultiSite') || !class_exists('UpdraftPlus_Addons_Migrator')) { $err[] = sprintf(__('Error: %s', 'updraftplus'), sprintf(__('To import an ordinary WordPress site into a multisite installation requires %s.', 'updraftplus'), 'UpdraftPlus Premium')); return array($mess, $warn, $err, $info); } } elseif (isset($old_siteinfo['multisite']) && $old_siteinfo['multisite'] && !is_multisite()) { $warn[] = __('Warning:', 'updraftplus').' '.__('Your backup is of a WordPress multisite install; but this site is not. Only the first site of the network will be accessible.', 'updraftplus').' <a href="https://codex.wordpress.org/Create_A_Network" target="_blank">'.__('If you want to restore a multisite backup, you should first set up your WordPress installation as a multisite.', 'updraftplus').'</a>'; } } elseif (preg_match('/^([^=]+)=(.*)$/', $matches[1], $kvmatches)) { $key = $kvmatches[1]; $val = $kvmatches[2]; if ('multisite' == $key) { $info['multisite'] = $val ? true : false; if ($val) $mess[] = '<strong>'.__('Site information:', 'updraftplus').'</strong> '.'backup is of a WordPress Network'; } $old_siteinfo[$key] = $val; } } elseif (preg_match('/^\# Skipped tables: (.*)$/', $buffer, $matches)) { $skipped_tables = explode(',', $matches[1]); } } elseif (preg_match('#^\s*/\*\!40\d+ SET NAMES (.*)\*\/#i', $buffer, $smatches)) { $db_charsets_found[] = rtrim($smatches[1]); } elseif (preg_match('/^\s*create table \`?([^\`\(]*)\`?\s*\(/i', $buffer, $matches)) { $table = $matches[1]; $tables_found[] = $table; if ($old_table_prefix) { // Remove prefix $table = UpdraftPlus_Manipulation_Functions::str_replace_once($old_table_prefix, '', $table); if (in_array($table, $wanted_tables)) { $wanted_tables = array_diff($wanted_tables, array($table)); } } if (';' != substr($buffer, -1, 1)) { $processing_create = true; $db_supported_charset_related_to_unsupported_collation = true; } } elseif ($processing_create) { if (!empty($db_supported_collations)) { if (preg_match('/ COLLATE=([^\s;]+)/i', $buffer, $collate_match)) { $db_collates_found[] = $collate_match[1]; if (!isset($db_supported_collations[$collate_match[1]])) { $db_supported_charset_related_to_unsupported_collation = true; } } if (preg_match('/ COLLATE ([a-zA-Z0-9._-]+),/i', $buffer, $collate_match)) { $db_collates_found[] = $collate_match[1]; if (!isset($db_supported_collations[$collate_match[1]])) { $db_supported_charset_related_to_unsupported_collation = true; } } if (preg_match('/ COLLATE ([a-zA-Z0-9._-]+) /i', $buffer, $collate_match)) { $db_collates_found[] = $collate_match[1]; if (!isset($db_supported_collations[$collate_match[1]])) { $db_supported_charset_related_to_unsupported_collation = true; } } } if (!empty($db_supported_character_sets)) { if (preg_match('/ CHARSET=([^\s;]+)/i', $buffer, $charset_match)) { $db_charsets_found[] = $charset_match[1]; if ($db_supported_charset_related_to_unsupported_collation && !in_array($charset_match[1], $db_supported_charsets_related_to_unsupported_collations)) { $db_supported_charsets_related_to_unsupported_collations[] = $charset_match[1]; } } } if (';' == substr($buffer, -1, 1)) { $processing_create = false; $db_supported_charset_related_to_unsupported_collation = false; } static $mysql_version_warned = false; if (!$mysql_version_warned && version_compare($db_version, '5.2.0', '<') && preg_match('/(CHARSET|COLLATE)[= ]utf8mb4/', $buffer)) { $mysql_version_warned = true; $err[] = sprintf(__('Error: %s', 'updraftplus'), sprintf(__('The database backup uses MySQL features not available in the old MySQL version (%s) that this site is running on.', 'updraftplus'), $db_version).' '.__('You must upgrade MySQL to be able to use this database.', 'updraftplus')); } } } if ($is_plain) { @fclose($dbhandle); } else { @gzclose($dbhandle); } if (!empty($db_supported_character_sets)) { $db_charsets_found_unique = array_unique($db_charsets_found); $db_unsupported_charset = array(); $db_charset_forbidden = false; foreach ($db_charsets_found_unique as $db_charset) { if (!isset($db_supported_character_sets[$db_charset])) { $db_unsupported_charset[] = $db_charset; $db_charset_forbidden = true; } } if ($db_charset_forbidden) { $db_unsupported_charset_unique = array_unique($db_unsupported_charset); $warn[] = sprintf(_n("The database server that this WordPress site is running on doesn't support the character set (%s) which you are trying to import.", "The database server that this WordPress site is running on doesn't support the character sets (%s) which you are trying to import.", count($db_unsupported_charset_unique), 'updraftplus'), implode(', ', $db_unsupported_charset_unique)).' '.__('You can choose another suitable character set instead and continue with the restoration at your own risk.', 'updraftplus').' <a target="_blank" href="https://updraftplus.com/faqs/implications-changing-tables-character-set/" target="_blank">'.__('Go here for more information.', 'updraftplus').'</a>'.' <a target="_blank" href="https://updraftplus.com/faqs/implications-changing-tables-character-set/" target="_blank">'.__('Go here for more information.', 'updraftplus').'</a>'; $db_supported_character_sets = array_keys($db_supported_character_sets); $similar_type_charset = UpdraftPlus_Manipulation_Functions::get_matching_str_from_array_elems($db_unsupported_charset_unique, $db_supported_character_sets, true); if (empty($similar_type_charset)) { $row = $GLOBALS['wpdb']->get_row('show variables like "character_set_database"'); $similar_type_charset = (null !== $row) ? $row->Value : ''; } if (empty($similar_type_charset) && !empty($db_supported_character_sets[0])) { $similar_type_charset = $db_supported_character_sets[0]; } $charset_select_html = '<label>'.__('Your chosen character set to use instead:', 'updraftplus').'</label> '; $charset_select_html .= '<select name="updraft_restorer_charset" id="updraft_restorer_charset">'; if (is_array($db_supported_character_sets)) { foreach ($db_supported_character_sets as $character_set) { $charset_select_html .= '<option value="'.esc_attr($character_set).'" '.selected($character_set, $similar_type_charset, false).'>'.esc_html($character_set).'</option>'; } } $charset_select_html .= '</select>'; if (empty($info['addui'])) $info['addui'] = ''; $info['addui'] .= $charset_select_html; } } if (!empty($db_supported_collations)) { $db_collates_found_unique = array_unique($db_collates_found); $db_unsupported_collate = array(); $db_collate_forbidden = false; foreach ($db_collates_found_unique as $db_collate) { if (!isset($db_supported_collations[$db_collate])) { $db_unsupported_collate[] = $db_collate; $db_collate_forbidden = true; } } if ($db_collate_forbidden) { $db_unsupported_collate_unique = array_unique($db_unsupported_collate); $warn[] = sprintf(_n("The database server that this WordPress site is running on doesn't support the collation (%s) used in the database which you are trying to import.", "The database server that this WordPress site is running on doesn't support multiple collations (%s) used in the database which you are trying to import.", count($db_unsupported_collate_unique), 'updraftplus'), implode(', ', $db_unsupported_collate_unique)).' '.__('You can choose another suitable collation instead and continue with the restoration (at your own risk).', 'updraftplus'); $similar_type_collate = ''; if ($db_charset_forbidden && !empty($similar_type_charset)) { $similar_type_collate = $this->get_similar_collate_related_to_charset($db_supported_collations, $db_unsupported_collate_unique, $similar_type_charset); } if (empty($similar_type_collate) && !empty($db_supported_charsets_related_to_unsupported_collations)) { $db_supported_collations_related_to_charset = array(); foreach ($db_supported_collations as $db_supported_collation => $db_supported_collations_info_obj) { if (isset($db_supported_collations_info_obj->Charset) && in_array($db_supported_collations_info_obj->Charset, $db_supported_charsets_related_to_unsupported_collations)) { $db_supported_collations_related_to_charset[] = $db_supported_collation; } } if (!empty($db_supported_collations_related_to_charset)) { $similar_type_collate = UpdraftPlus_Manipulation_Functions::get_matching_str_from_array_elems($db_unsupported_collate_unique, $db_supported_collations_related_to_charset, false); } } if (empty($similar_type_collate)) { $similar_type_collate = $this->get_similar_collate_based_on_ocuurence_count($db_collates_found, $db_supported_collations, $db_supported_charsets_related_to_unsupported_collations); } if (empty($similar_type_collate)) { $similar_type_collate = UpdraftPlus_Manipulation_Functions::get_matching_str_from_array_elems($db_unsupported_collate_unique, array_keys($db_supported_collations), false); } $collate_select_html = '<label>'.__('Your chosen replacement collation', 'updraftplus').':</label>'; $collate_select_html .= '<select name="updraft_restorer_collate" id="updraft_restorer_collate">'; $db_charsets_found_unique = array_unique($db_charsets_found); foreach ($db_supported_collations as $collate => $collate_info_obj) { $option_other_attr = array(); if ($db_charset_forbidden && isset($collate_info_obj->Charset)) { $option_other_attr[] = 'data-charset='.esc_attr($collate_info_obj->Charset); if ($similar_type_charset != $collate_info_obj->Charset) { $option_other_attr[] = 'style="display:none;"'; } } else { if (1 == count($db_charsets_found_unique)) { if (!in_array($collate_info_obj->Charset, $db_charsets_found_unique)) { $option_other_attr[] = 'style="display:none;"'; } } else { $option_other_attr[] = 'style="display:none;"'; } } $collate_select_html .= '<option value="'.esc_attr($collate).'" '.selected($collate, $similar_type_collate, $echo = false).' '.implode(' ', $option_other_attr).'>'.esc_html($collate).'</option>'; } if (count($db_charsets_found_unique) > 1 && !$db_charset_forbidden) { $collate_select_html .= '<option value="choose_a_default_for_each_table" selected="selected">'.__('Choose a default for each table', 'updraftplus').'</option>'; } $collate_select_html .= '</select>'; $info['addui'] = empty($info['addui']) ? $collate_select_html : $info['addui'].'<br>'.$collate_select_html; if ($db_charset_forbidden) { $collate_change_on_charset_selection_data = array( 'db_supported_collations' => $db_supported_collations, 'db_unsupported_collate_unique' => $db_unsupported_collate_unique, 'db_collates_found' => $db_collates_found, ); $info['addui'] .= '<input type="hidden" name="collate_change_on_charset_selection_data" id="collate_change_on_charset_selection_data" value="'.esc_attr(json_encode($collate_change_on_charset_selection_data)).'">'; } } } /* $blog_tables = "CREATE TABLE $wpdb->terms ( CREATE TABLE $wpdb->term_taxonomy ( CREATE TABLE $wpdb->term_relationships ( CREATE TABLE $wpdb->commentmeta ( CREATE TABLE $wpdb->comments ( CREATE TABLE $wpdb->links ( CREATE TABLE $wpdb->options ( CREATE TABLE $wpdb->postmeta ( CREATE TABLE $wpdb->posts ( $users_single_table = "CREATE TABLE $wpdb->users ( $users_multi_table = "CREATE TABLE $wpdb->users ( $usermeta_table = "CREATE TABLE $wpdb->usermeta ( $ms_global_tables = "CREATE TABLE $wpdb->blogs ( CREATE TABLE $wpdb->blog_versions ( CREATE TABLE $wpdb->registration_log ( CREATE TABLE $wpdb->site ( CREATE TABLE $wpdb->sitemeta ( CREATE TABLE $wpdb->signups ( */ if (!isset($skipped_tables)) $skipped_tables = array(); $missing_tables = array(); if ($old_table_prefix) { if (!$header_only) { foreach ($wanted_tables as $table) { if (!in_array($old_table_prefix.$table, $tables_found)) { $missing_tables[] = $table; } } foreach ($missing_tables as $key => $value) { if (in_array($old_table_prefix.$value, $skipped_tables)) { unset($missing_tables[$key]); } } if (count($missing_tables)>0) { $warn[] = sprintf(__('This database backup is missing core WordPress tables: %s', 'updraftplus'), implode(', ', $missing_tables)); } if (count($skipped_tables)>0) { $warn[] = sprintf(__('This database backup has the following WordPress tables excluded: %s', 'updraftplus'), implode(', ', $skipped_tables)); } } } else { if (empty($backup['meta_foreign'])) { $warn[] = __('UpdraftPlus was unable to find the table prefix when scanning the database backup.', 'updraftplus'); } } // //need to make sure that we reset the file back to .crypt before clean temp files // $db_file = $decrypted_file['fullpath'].'.crypt'; // unlink($decrypted_file['fullpath']); return array($mess, $warn, $err, $info); } /** * Get the current outgoing IP address. Use this wisely; of course, it's not guaranteed to always be the same. * * @return String|Boolean - returns false upon failure */ public function get_outgoing_ip_address() { $ip_lookup = wp_remote_get('https://ipvigilante.com/json', array('timeout' => 6)); if (200 == wp_remote_retrieve_response_code($ip_lookup)) { $info = json_decode(wp_remote_retrieve_body($ip_lookup), true); if (!empty($info['status']) && !empty($info['data']) && 'success' === $info['status']); if (!empty($info['data']['ipv4'])) return $info['data']['ipv4']; if (!empty($info['data']['ipv6'])) return $info['data']['ipv6']; } return false; } /** * Get default substitute similar collate related to charset * * @param array $db_supported_collations Supported collations. It should contain result of 'SHOW COLLATION' query * @param array $db_unsupported_collate_unique Unsupported unique collates collection * @param string $similar_type_charset Charset for which need to get default collate substitution * @return string $similar_type_collate default substitute collate which is best suitable or blank string */ public function get_similar_collate_related_to_charset($db_supported_collations, $db_unsupported_collate_unique, $similar_type_charset) { $similar_type_collate = ''; $db_supported_collations_related_to_charset = array(); foreach ($db_supported_collations as $db_supported_collation => $db_supported_collations_info_obj) { if (isset($db_supported_collations_info_obj->Charset) && $db_supported_collations_info_obj->Charset == $similar_type_charset) { $db_supported_collations_related_to_charset[] = $db_supported_collation; } } if (!empty($db_supported_collations_related_to_charset)) { $similar_type_collate = UpdraftPlus_Manipulation_Functions::get_matching_str_from_array_elems($db_unsupported_collate_unique, $db_supported_collations_related_to_charset, false); } return $similar_type_collate; } /** * Get default substitute similar collate based on existing supported collates count in database backup file * * @param array $db_collates_found All collates which have found in database backup file regardless whether they are supported or unsupported * @param array $db_supported_collations Supported collations. It should contain result of 'SHOW COLLATION' query * @param array $db_supported_charsets_related_to_unsupported_collations All charset which are related to unsupported collation * * @return string $similar_type_collate default substitute collate which is best suitable or blank string */ public function get_similar_collate_based_on_ocuurence_count($db_collates_found, $db_supported_collations, $db_supported_charsets_related_to_unsupported_collations) { $similar_type_collate = ''; $db_supported_collates_found_with_occurrence = array(); foreach ($db_collates_found as $db_collate_found) { if (isset($db_supported_collations[$db_collate_found])) { if (isset($db_supported_collates_found_with_occurrence[$db_collate_found])) { $db_supported_collates_found_with_occurrence[$db_collate_found] = intval($db_supported_collates_found_with_occurrence[$db_collate_found]) + 1; } else { $db_supported_collates_found_with_occurrence[$db_collate_found] = 1; } } } if (!empty($db_supported_collates_found_with_occurrence)) { arsort($db_supported_collates_found_with_occurrence); if (!empty($db_supported_charsets_related_to_unsupported_collations)) { foreach ($db_supported_collates_found_with_occurrence as $db_supported_collate_with_occurrence => $occurrence_count) { if (isset($db_supported_collations[$db_supported_collate_with_occurrence]) && isset($db_supported_collations[$db_supported_collate_with_occurrence]->Charset) && in_array($db_supported_collations[$db_supported_collate_with_occurrence]->Charset, $db_supported_charsets_related_to_unsupported_collations)) { $similar_type_collate = $db_supported_collate_with_occurrence; break; } } } else { $similar_type_collate = array_search(max($db_supported_collates_found_with_occurrence), $db_supported_collates_found_with_occurrence); } } return $similar_type_collate; } /** * Retrieves current clean url for anchor link where href attribute value is not url (for ex. #div) or empty * * @return String - current clean url */ public static function get_current_clean_url() { // Within an UpdraftCentral context, there should be no prefix on the anchor link if (defined('UPDRAFTCENTRAL_COMMAND') && UPDRAFTCENTRAL_COMMAND) return ''; if (defined('DOING_AJAX') && DOING_AJAX) { $current_url = $_SERVER["HTTP_REFERER"]; } else { $url_prefix = is_ssl() ? 'https' : 'http'; $current_url = $url_prefix."://".$_SERVER['HTTP_HOST'].$_SERVER['REQUEST_URI']; } $remove_query_args = array('state', 'action', 'oauth_verifier', 'nonce', 'updraftplus_instance', 'access_token', 'user_id', 'updraftplus_googledriveauth'); return UpdraftPlus_Manipulation_Functions::wp_unslash(remove_query_arg($remove_query_args, $current_url)); } /** * TODO: Remove legacy storage setting keys from here * These are used in 4 places (Feb 2016 - of course, you should re-scan the code to check if relying on this): showing current settings on the debug modal, wiping all current settings, getting a settings bundle to restore when migrating, and for relevant keys in POST-ed data when saving settings over AJAX * * @return Array - the list of keys */ public function get_settings_keys() { // N.B. updraft_backup_history is not included here, as we don't want that wiped return array( 'updraft_autobackup_default', 'updraft_dropbox', 'updraft_googledrive', 'updraftplus_tmp_googledrive_access_token', 'updraftplus_dismissedautobackup', 'dismissed_general_notices_until', 'dismissed_clone_php_notices_until', 'dismissed_clone_wc_notices_until', 'dismissed_season_notices_until', 'updraftplus_dismissedexpiry', 'updraftplus_dismisseddashnotice', 'updraft_interval', 'updraft_interval_increments', 'updraft_interval_database', 'updraft_retain', 'updraft_retain_db', 'updraft_encryptionphrase', 'updraft_service', 'updraft_googledrive_clientid', 'updraft_googledrive_secret', 'updraft_googledrive_remotepath', 'updraft_ftp', 'updraft_backblaze', 'updraft_server_address', 'updraft_dir', 'updraft_email', 'updraft_delete_local', 'updraft_debug_mode', 'updraft_include_plugins', 'updraft_include_themes', 'updraft_include_uploads', 'updraft_include_others', 'updraft_include_wpcore', 'updraft_include_wpcore_exclude', 'updraft_include_more', 'updraft_include_blogs', 'updraft_include_mu-plugins', 'updraft_auto_updates', 'updraft_include_others_exclude', 'updraft_include_uploads_exclude', 'updraft_lastmessage', 'updraft_googledrive_token', 'updraft_dropboxtk_request_token', 'updraft_dropboxtk_access_token', 'updraft_adminlocking', 'updraft_updraftvault', 'updraft_remotesites', 'updraft_migrator_localkeys', 'updraft_central_localkeys', 'updraft_retain_extrarules', 'updraft_googlecloud', 'updraft_include_more_path', 'updraft_split_every', 'updraft_ssl_nossl', 'updraft_backupdb_nonwp', 'updraft_extradbs', 'updraft_combine_jobs_around', 'updraft_last_backup', 'updraft_starttime_files', 'updraft_starttime_db', 'updraft_startday_db', 'updraft_startday_files', 'updraft_sftp', 'updraft_s3', 'updraft_s3generic', 'updraft_dreamhost', 'updraft_s3generic_login', 'updraft_s3generic_pass', 'updraft_s3generic_remote_path', 'updraft_s3generic_endpoint', 'updraft_webdav', 'updraft_openstack', 'updraft_onedrive', 'updraft_azure', 'updraft_cloudfiles', 'updraft_cloudfiles_user', 'updraft_cloudfiles_apikey', 'updraft_cloudfiles_path', 'updraft_cloudfiles_authurl', 'updraft_ssl_useservercerts', 'updraft_ssl_disableverify', 'updraft_s3_login', 'updraft_s3_pass', 'updraft_s3_remote_path', 'updraft_dreamobjects_login', 'updraft_dreamobjects_pass', 'updraft_dreamobjects_remote_path', 'updraft_dreamobjects', 'updraft_report_warningsonly', 'updraft_report_wholebackup', 'updraft_report_dbbackup', 'updraft_log_syslog', 'updraft_extradatabases', 'updraftplus_tour_cancelled_on', 'updraftplus_version', ); } /** * A function that works through the array passed to it and gets a list of all the tables from that database and puts the information in an array ready to be parsed and output to html. * * @param Array $dbsinfo an array that contains information about each database, the default 'wp' array is just an empty array, but other entries can be added so that this method can get tables from other databases the array structure for this would be array('wp' => array(), 'TestDB' => array('host' => '', 'user' => '', 'pass' => '', 'name' => '', 'prefix' => '')) * note that the extra tables array key must match the database name in the array note that the extra tables array key must match the database name in the array * @return Array - databases and their table names */ public function get_database_tables($dbsinfo = array('wp' => array())) { global $wpdb; if (!class_exists('UpdraftPlus_Database_Utility')) include_once(UPDRAFTPLUS_DIR.'/includes/class-database-utility.php'); $dbhandle = ''; $db_tables_array = array(); foreach ($dbsinfo as $key => $value) { if ('wp' == $key) { // The table prefix after being filtered - i.e. what filters what we'll actually backup $table_prefix = $this->get_table_prefix(true); // The unfiltered table prefix - i.e. the real prefix that things are relative to $table_prefix_raw = $this->get_table_prefix(false); $dbinfo['host'] = DB_HOST; $dbinfo['name'] = DB_NAME; $dbinfo['user'] = DB_USER; $dbinfo['pass'] = DB_PASSWORD; $dbhandle = $wpdb; } else { $dbhandle = new UpdraftPlus_WPDB_OtherDB_Utility($dbsinfo[$key]['user'], $dbsinfo[$key]['pass'], $dbsinfo[$key]['name'], $dbsinfo[$key]['host']); if (!empty($dbhandle->error)) { return $this->log_wp_error($dbhandle->error); } $table_prefix = $dbsinfo[$key]['prefix']; $table_prefix_raw = $dbsinfo[$key]['prefix']; } // SHOW FULL - so that we get to know whether it's a BASE TABLE or a VIEW $all_tables = $dbhandle->get_results("SHOW FULL TABLES", ARRAY_N); if (empty($all_tables) && !empty($dbhandle->last_error)) { $all_tables = $dbhandle->get_results("SHOW TABLES", ARRAY_N); $all_tables = array_map(array($this, 'cb_get_name_base_type'), $all_tables); } else { $all_tables = array_map(array($this, 'cb_get_name_type'), $all_tables); } // If this is not the WP database, then we do not consider it a fatal error if there are no tables if ('wp' == $key && 0 == count($all_tables)) { return $this->log_wp_error("No tables found in wp database."); die; } // Put the options table first $updraftplus_database_utility = new UpdraftPlus_Database_Utility($key, $table_prefix_raw, $dbhandle); usort($all_tables, array($updraftplus_database_utility, 'backup_db_sorttables')); $all_table_names = array_map(array($this, 'cb_get_name'), $all_tables); $db_tables_array[$key] = $all_table_names; } return $db_tables_array; } /** * Returns the member of the array with key (int)0, as a new array. This function is used as a callback for array_map(). * * @param Array $a - the array * * @return Array - with keys 'name' and 'type' */ private function cb_get_name_base_type($a) { return array('name' => $a[0], 'type' => 'BASE TABLE'); } /** * Returns the members of the array with keys (int)0 and (int)1, as part of a new array. * * @param Array $a - the array * * @return Array - keys are 'name' and 'type' */ private function cb_get_name_type($a) { return array('name' => $a[0], 'type' => $a[1]); } /** * Returns the member of the array with key (string)'name'. This function is used as a callback for array_map(). * * @param Array $a - the array * * @return Mixed - the value with key (string)'name' */ private function cb_get_name($a) { return $a['name']; } /** * Retrieves the appropriate URL for the given target page * * @internal * @param String $which_page The target page * @return String - The requested URL for a given page */ public function get_url($which_page = false) { switch ($which_page) { case 'my-account': return apply_filters('updraftplus_com_myaccount', 'https://updraftplus.com/my-account/'); break; case 'shop': return apply_filters('updraftplus_com_shop', 'https://updraftplus.com/shop/'); break; case 'premium': return apply_filters('updraftplus_com_premium', 'https://updraftplus.com/shop/updraftplus-premium/'); break; case 'buy-tokens': return apply_filters('updraftplus_com_updraftclone_tokens', 'https://updraftplus.com/shop/updraftclone-tokens/'); break; case 'lost-password': return apply_filters('updraftplus_com_myaccount_lostpassword', 'https://updraftplus.com/my-account/lost-password/'); break; case 'mothership': return apply_filters('updraftplus_com_mothership', 'https://updraftplus.com/plugin-info'); break; case 'shop_premium': return apply_filters('updraftplus_com_shop_premium', 'https://updraftplus.com/shop/updraftplus-premium/'); break; case 'shop_vault_5': return apply_filters('updraftplus_com_shop_vault_5', 'https://updraftplus.com/shop/updraftplus-vault-storage-5-gb/'); break; case 'shop_vault_15': return apply_filters('updraftplus_com_shop_vault_15', 'https://updraftplus.com/shop/updraftplus-vault-storage-15-gb/'); break; case 'shop_vault_50': return apply_filters('updraftplus_com_shop_vault_50', 'https://updraftplus.com/shop/updraftplus-vault-storage-50-gb/'); break; default: return 'URL not found ('.$which_page.')'; } } /** * Get log message for permission failure * * @param string $path full path of file or folder * @param string $log_message_prefix action which is performed to path * @param string $directory_prefix_in_log_message Directory Prefix. It should be either "Parent" or "Destination" * @return string|boolean log message (HTML). If posix function doesn't exist, It returns false */ public function log_permission_failure_message($path, $log_message_prefix, $directory_prefix_in_log_message = 'Parent') { if ($this->do_posix_functions_exist()) { $stat_data = stat($path); $log_message = $log_message_prefix.': Failed. '; $log_message .= $directory_prefix_in_log_message.' Directory UID='.$stat_data['uid'].', GID='.$stat_data['gid'].'. '; $log_message .= $this->get_log_message_for_current_uid_and_gid(); return $log_message; } else { return false; } } /** * Get log message for current uid and gid * * @return String log message of current process (HTML) */ private function get_log_message_for_current_uid_and_gid() { $log_message = 'Effective/real user IDs of the current process: '.posix_geteuid().'/'.posix_getuid().'. '; $log_message .= 'Effective/real group IDs of the current process: '.posix_getegid().'/'.posix_getgid().'. '; return $log_message; } /** * Checks whether POSIX functions exists or not * * @return boolean true if POSIX functions exists or not */ private function do_posix_functions_exist() { return function_exists('posix_geteuid') && function_exists('posix_getuid') && function_exists('posix_getegid') && function_exists('posix_getgid'); } /** * Wipe state-related data (e.g. on wiping settings, or on a restore). Note that there is some internal knowledge within the method below of how it is being used (if not including locks, then check for an active job) * * @param Boolean $include_locks */ public function wipe_state_data($include_locks = false) { // These aren't in get_settings_keys() because they are always in the options table, regardless of context global $wpdb; if ($include_locks) { $wpdb->query("DELETE FROM $wpdb->options WHERE (option_name LIKE 'updraftplus_unlocked_%' OR option_name LIKE 'updraftplus_locked_%' OR option_name LIKE 'updraftplus_last_lock_time_%' OR option_name LIKE 'updraftplus_semaphore_%' OR option_name LIKE 'updraft_jobdata_%' OR option_name LIKE 'updraft_last_scheduled_%' )"); } else { $sql = "DELETE FROM $wpdb->options WHERE option_name LIKE 'updraft_jobdata_%'"; if (!empty($this->nonce)) $sql .= " AND option_name != 'updraft_jobdata_".$this->nonce."'"; $wpdb->query($sql); } } /** * Checks whether debug mode is on or not. If it is on then unminified script will be used. * * @return boolean true indicate use the unminified script */ public function use_unminified_scripts() { return UpdraftPlus_Options::get_updraft_option('updraft_debug_mode') || (defined('SCRIPT_DEBUG') && SCRIPT_DEBUG); } }