'W3 Total Cache',
'wp-cache.php' => 'WP Super Cache',
);
/* is_network_activated()
*
* Returns a boolean indicating whether a plugin is network activated or not.
*
* @return boolean True if plugin is network activated, else false.
*/
function is_network_activated() {
if ( !function_exists( 'is_plugin_active_for_network' ) ) { // Function is not available on all WordPress pages for some reason according to codex.
require_once( ABSPATH . '/wp-admin/includes/plugin.php' );
}
if ( is_plugin_active_for_network( basename( pb_backupbuddy::plugin_path() ) . '/' . pb_backupbuddy::settings( 'init' ) ) ) { // Path relative to wp-content\plugins\ directory.
return true;
} else {
return false;
}
} // End is_network_activated().
/* backup_integrity_check()
*
* Scans a backup file and saves the result in data structure. Checks for key files & that .zip can be read properly. Stores results with details in data structure.
*
* @param string $file Full pathname & filename to backup file to check.
* @param obj $fileoptions fileoptions object currently holding the fileoptions file open, if any.
* @param array $options Array of options.
* @return array Returns integrity data array.
*/
function backup_integrity_check( $file, $fileoptions = '', $options = array() ) {
pb_backupbuddy::status( 'details', 'Started backup_integrity_check() function.' );
$serial = $this->get_serial_from_file( $file );
// User selected to rescan a file.
if ( pb_backupbuddy::_GET( 'reset_integrity' ) == $serial ) {
pb_backupbuddy::alert( 'Rescanning backup integrity for backup file `' . basename( $file ) . '`' );
flush();
}
$options = array_merge(
array(
'skip_database_dump' => '0',
),
$options
);
$scan_notes = array();
// Get backup fileoptions.
if ( $fileoptions != '' ) {
$backup_options = &$fileoptions;
} else {
require_once( pb_backupbuddy::plugin_path() . '/classes/fileoptions.php' );
$backup_options = new pb_backupbuddy_fileoptions( pb_backupbuddy::$options['log_directory'] . 'fileoptions/' . $serial . '.txt', $read_only = false, $ignore_lock = false, $create_file = true ); // Will create file to hold integrity data if nothing exists.
if ( true !== ( $result = $backup_options->is_ok() ) ) {
pb_backupbuddy::status( 'error', __('Fatal Error #9034 C. Unable to access fileoptions data.', 'it-l10n-backupbuddy' ) . ' Error on file `' . pb_backupbuddy::$options['log_directory'] . 'fileoptions/' . $serial . '.txt' . '`: ' . $result );
pb_backupbuddy::status( 'action', 'halt_script' ); // Halt JS on page.
return false;
}
}
if ( isset( $backup_options->options['profile'] ) ) {
$options = $backup_options->options['profile'];
$options = array_merge( pb_backupbuddy::settings( 'profile_defaults' ), $options );
}
// Integrity check disabled. Skip.
if ( ( pb_backupbuddy::$options['profiles'][0]['integrity_check'] == '0' ) && ( pb_backupbuddy::_GET( 'reset_integrity' ) == '' ) ) { // Integrity checking disabled. Allows run if manually rescanning on backups page.
pb_backupbuddy::status( 'details', 'Integrity check disabled. Skipping scan.' );
$file_stats = @stat( $file );
if ( $file_stats === false ) { // stat failure.
pb_backupbuddy::status( 'error', 'Error #4539774. Unable to get file details ( via stat() ) for file `' . $file . '`. The file may be corrupt or too large for the server.' );
$file_size = 0;
$file_modified = 0;
} else { // stat success.
$file_size = $file_stats['size'];
$file_modified = $file_stats['mtime'];
}
unset( $file_stats );
$integrity = array(
'status' => 'Unknown',
'tests' => array(),
'scan_time' => 0,
'detected_type' => 'unknown',
'size' => $file_size,
'modified' => $file_modified,
'file' => basename( $file ),
'comment' => false,
);
$backup_options->options['integrity'] = array_merge( pb_backupbuddy::settings( 'backups_integrity_defaults' ), $integrity );
$backup_options->save();
return $backup_options->options['integrity'];
}
// Return if cached.
if ( isset( $backup_options->options['integrity'] ) && ( count( $backup_options->options['integrity'] ) > 0 ) && ( pb_backupbuddy::_GET( 'reset_integrity' ) != $serial ) ) { // Already have integrity data and NOT resetting this one.
pb_backupbuddy::status( 'details', 'Integrity data for backup `' . $serial . '` is cached; not scanning again.' );
return $backup_options->options['integrity'];
} elseif ( pb_backupbuddy::_GET( 'reset_integrity' ) == $serial ) { // Resetting this one.
pb_backupbuddy::status( 'details', 'Resetting backup integrity stats for backup with serial `' . $serial . '`.' );
} else { // No integrity data; not resetting. Just keep going...
}
//***** BEGIN CALCULATING STATUS DETAILS.
$backup_type = '';
if ( !isset( pb_backupbuddy::$classes['zipbuddy'] ) ) {
require_once( pb_backupbuddy::plugin_path() . '/lib/zipbuddy/zipbuddy.php' );
pb_backupbuddy::$classes['zipbuddy'] = new pluginbuddy_zipbuddy( pb_backupbuddy::$options['backup_directory'] );
}
pb_backupbuddy::status( 'details', 'Redirecting status logging temporarily.' );
$previous_status_serial = pb_backupbuddy::get_status_serial(); // Store current status serial setting to reset back later.
pb_backupbuddy::set_status_serial( 'zipbuddy_test' ); // Redirect logging output to a certain log file.
// Look for comment.
pb_backupbuddy::status( 'details', 'Verifying comment in zip archive.' );
$raw_comment = pb_backupbuddy::$classes['zipbuddy']->get_comment( $file );
$comment = pb_backupbuddy::$classes['core']->normalize_comment_data( $raw_comment );
$comment = $comment['note'];
$tests = array();
// Check for DAT file.
$pass = false;
pb_backupbuddy::status( 'details', 'Verifying DAT file in zip archive.' );
if ( pb_backupbuddy::$classes['zipbuddy']->file_exists( $file, 'wp-content/uploads/backupbuddy_temp/' . $serial . '/backupbuddy_dat.php' ) === true ) { // Post 2.0 full backup
$backup_type = 'full';
$pass = true;
}
if ( pb_backupbuddy::$classes['zipbuddy']->file_exists( $file, 'wp-content/uploads/temp_' . $serial . '/backupbuddy_dat.php' ) === true ) { // Pre 2.0 full backup
$backup_type = 'full';
$pass = true;
}
if ( pb_backupbuddy::$classes['zipbuddy']->file_exists( $file, 'backupbuddy_dat.php' ) === true ) { // DB backup
$backup_type = 'db';
$pass = true;
}
$tests[] = array(
'test' => 'BackupBuddy data file',
'pass' => $pass,
);
// Check for DB .sql file.
$pass = false;
$db_test_note = '';
pb_backupbuddy::status( 'details', 'Verifying database SQL file in zip archive.' );
if ( pb_backupbuddy::$classes['zipbuddy']->file_exists( $file, 'wp-content/uploads/backupbuddy_temp/' . $serial . '/db_1.sql' ) === true ) { // post 2.0 full backup
$backup_type = 'full';
$pass = true;
}
if ( pb_backupbuddy::$classes['zipbuddy']->file_exists( $file, 'wp-content/uploads/temp_' . $serial . '/db.sql' ) === true ) { // pre 2.0 full backup
$backup_type = 'full';
$pass = true;
}
if ( pb_backupbuddy::$classes['zipbuddy']->file_exists( $file, 'db_1.sql' ) === true ) { // db only backup 2.0+
$backup_type = 'db';
$pass = true;
}
if ( pb_backupbuddy::$classes['zipbuddy']->file_exists( $file, 'db.sql' ) === true ) { // db only backup pre-2.0
$backup_type = 'db';
$pass = true;
}
if ( '1' == $options['skip_database_dump'] ) {
if ( false === $pass ) {
pb_backupbuddy::status( 'warning', 'WARNING: Database .SQL does NOT exist because database dump was set to be skipped based on settings. Use with caution. The database was NOT backed up.' );
} else { // DB dump set to be skipped but was found. Just in case...
pb_backupbuddy::status( 'warning', 'Warning #58458749. Database dump was set to be skip _BUT_ database file WAS found?' );
}
$pass = true;
$db_test_note = ' Warning: Database dump skipped based on settings';
$scan_notes[] = 'Database skipped';
}
$tests[] = array(
'test' => 'Database SQL file' . $db_test_note,
'pass' => $pass,
);
// Check for wp-config.php file if full backup.
if ( 'full' == $backup_type ) {
$pass = false;
pb_backupbuddy::status( 'details', 'Verifying WordPress wp-config.php configuration file in zip archive.' );
if ( pb_backupbuddy::$classes['zipbuddy']->file_exists( $file, 'wp-config.php' ) === true ) {
$pass = true;
}
if ( pb_backupbuddy::$classes['zipbuddy']->file_exists( $file, 'wp-content/uploads/backupbuddy_temp/' . $serial . '/wp-config.php' ) === true ) {
$pass = true;
}
$tests[] = array(
'test' => 'WordPress wp-config.php file (full backups only)',
'pass' => $pass,
);
} // end if full backup.
// Get zip scan log details.
pb_backupbuddy::status( 'details', 'Retrieving zip scan log.' );
$temp_details = pb_backupbuddy::get_status( 'zipbuddy_test' ); // Get zipbuddy scan log.
$scan_log = array();
foreach( $temp_details as $temp_detail ) {
$scan_log[] = $temp_detail[4];
}
pb_backupbuddy::set_status_serial( $previous_status_serial ); // Stop redirecting log to a specific file & set back to what it was prior.
pb_backupbuddy::status( 'details', 'Stopped temporary redirection of status logging.' );
pb_backupbuddy::status( 'details', 'Calculating integrity scan status,' );
// Check for any failed tests.
$is_ok = true;
$integrity_description = '';
foreach( $tests as $test ) {
if ( $test['pass'] !== true ) {
$is_ok = false;
$error = 'Error #389434. Integrity test FAILED. Test: `' . $test['test']. '`. ';
pb_backupbuddy::status( 'error', $error );
$integrity_description .= $error;
}
}
if ( true === $is_ok ) {
$integrity_status = 'Pass';
} else {
$integrity_status = 'Fail';
}
pb_backupbuddy::status( 'details', 'Status: `' . $integrity_status . '`. Description: `' . $integrity_description . '`.' );
//***** END CALCULATING STATUS DETAILS.
// Get file information from file system.
pb_backupbuddy::status( 'details', 'Getting file details such as size, timestamp, etc.' );
$file_stats = @stat( $file );
if ( $file_stats === false ) { // stat failure.
pb_backupbuddy::status( 'error', 'Error #4539774b. Unable to get file details ( via stat() ) for file `' . $file . '`. The file may be corrupt or too large for the server.' );
$file_size = 0;
$file_modified = 0;
} else { // stat success.
$file_size = $file_stats['size'];
$file_modified = $file_stats['ctime']; // Created time.
}
unset( $file_stats );
// Compile array of results for saving into data structure.
$integrity = array(
'is_ok' => $is_ok, // bool
'tests' => $tests, // Array of tests.
'scan_time' => time(),
'scan_log' => $scan_log,
'scan_notes' => $scan_notes, // Misc text to display next to status.
'detected_type' => $backup_type,
'size' => $file_size,
'modified' => $file_modified, // Actually created time now.
'file' => basename( $file ),
'comment' => $comment, // boolean false if no comment. string if comment.
);
pb_backupbuddy::status( 'details', 'Saving backup file integrity check details.' );
$backup_options->options['integrity'] = array_merge( pb_backupbuddy::settings( 'backups_integrity_defaults' ), $integrity );
$backup_options->save();
return $backup_options->options['integrity'];
} // End backup_integrity_check().
/* get_serial_from_file()
*
* Returns the backup serial based on the filename.
*
* @param string $file Filename containing a serial to extract.
* @return string Serial found.
*/
public function get_serial_from_file( $file ) {
$serial = strrpos( $file, '-' ) + 1;
$serial = substr( $file, $serial, ( strlen( $file ) - $serial - 4 ) );
return $serial;
} // End get_serial_from_file().
/**
* versions_confirm()
*
* Check the version of an item and compare it to the minimum requirements BackupBuddy requires.
*
* @param string $type Optional. If left blank '' then all tests will be performed. Valid values: wordpress, php, ''.
* @param boolean $notify Optional. Whether or not to alert to the screen (and throw error to log) of a version issue.\
* @return boolean True if the selected type is a bad version
*/
function versions_confirm( $type = '', $notify = false ) {
$bad_version = false;
if ( ( $type == 'wordpress' ) || ( $type == '' ) ) {
global $wp_version;
if ( version_compare( $wp_version, pb_backupbuddy::settings( 'wp_minimum' ), '<=' ) ) {
if ( $notify === true ) {
pb_backupbuddy::alert( sprintf( __('ERROR: BackupBuddy requires WordPress version %1$s or higher. You may experience unexpected behavior or complete failure in this environment. Please consider upgrading WordPress.', 'it-l10n-backupbuddy' ), $this->_wp_minimum) );
pb_backupbuddy::log( 'Unsupported WordPress Version: ' . $wp_version , 'error' );
}
$bad_version = true;
}
}
if ( ( $type == 'php' ) || ( $type == '' ) ) {
if ( version_compare( PHP_VERSION, pb_backupbuddy::settings( 'php_minimum' ), '<=' ) ) {
if ( $notify === true ) {
pb_backupbuddy::alert( sprintf( __('ERROR: BackupBuddy requires PHP version %1$s or higher. You may experience unexpected behavior or complete failure in this environment. Please consider upgrading PHP.', 'it-l10n-backupbuddy' ), PHP_VERSION ) );
pb_backupbuddy::log( 'Unsupported PHP Version: ' . PHP_VERSION , 'error' );
}
$bad_version = true;
}
}
return $bad_version;
} // End versions_confirm().
/* get_directory_exclusions()
*
* Get sanitized directory exclusions. See important note below!
* IMPORTANT NOTE: Cannot exclude the temp directory here as this is where SQL and DAT files are stored for inclusion in the backup archive.
*
* @param array $profile Profile array of data.
* @param bool $trim_suffix True (default) if trailing slash should be trimmed from directories
* @return array Array of directories to exclude.
*/
public static function get_directory_exclusions( $profile, $trim_suffix = true ) {
$profile = array_merge( pb_backupbuddy::settings( 'profile_defaults' ), $profile );
// Get initial array.
$exclusions = trim( $profile['excludes'] ); // Trim string.
$exclusions = preg_split('/\n|\r|\r\n/', $exclusions ); // Break into array on any type of line ending.
$abspath = str_replace( '\\', '/', ABSPATH );
// Add additional internal exclusions.
$exclusions[] = str_replace( rtrim( $abspath, '\\\/' ), '', pb_backupbuddy::$options['backup_directory'] ); // Exclude backup directory.
$exclusions[] = '/' . ltrim( str_replace( ABSPATH, '', pb_backupbuddy::$options['log_directory'] ), '\\/' ); // BackupBuddy logs & fileoptions data.
$exclusions[] = '/importbuddy/'; // Exclude importbuddy directory in root.
$exclusions[] = '/importbuddy.php'; // Exclude importbuddy.php script in root.
//$exclusions[] = str_replace( ABSPATH, '', pb_backupbuddy::$options['temp_directory'] ) . 'fileoptions/'; // Temporary backup options storage directory. Causes issues backing up if a lock file is set to backup and goes away so just bypass entirely. Not much need to store this anyways.
// Clean up & sanitize array.
if ( $trim_suffix ) {
array_walk( $exclusions, create_function( '&$val', '$val = rtrim( trim( $val ), \'/\' );' ) ); // Apply trim to all items within.
} else {
array_walk( $exclusions, create_function( '&$val', '$val = trim( $val );' ) ); // Apply (whitespace-only) trim to all items within.
}
$exclusions = array_filter( $exclusions, 'strlen' ); // Remove any empty / blank lines.
// IMPORTANT NOTE: Cannot exclude the temp directory here as this is where SQL and DAT files are stored for inclusion in the backup archive.
$exclusions = apply_filters( 'backupbuddy_zip_exclusions', $exclusions );
pb_backupbuddy::status( 'details', 'Initial zip exclusions (after filter): `' . implode( '; ', $exclusions ) . '`.' );
return $exclusions;
} // End get_directory_exclusions().
/* mail_error()
*
* Sends an error email to the defined email address(es) on settings page.
*
* @param string $message Message to be included in the body of the email.
* @param string $override_recipient Email address(es) to send to instead of the normal recipient.
* @param string|array String or array of filename(s) to send as email attachments.
* @return null
*/
function mail_error( $message, $override_recipient = '', $attachments = array() ) {
if ( !isset( pb_backupbuddy::$options ) ) {
pb_backupbuddy::load();
}
$subject = pb_backupbuddy::$options['email_notify_error_subject'];
$body = pb_backupbuddy::$options['email_notify_error_body'];
$replacements = array(
'{site_url}' => site_url(),
'{backupbuddy_version}' => pb_backupbuddy::settings( 'version' ),
'{current_datetime}' => date(DATE_RFC822),
'{message}' => $message
);
foreach( $replacements as $replace_key => $replacement ) {
$subject = str_replace( $replace_key, $replacement, $subject );
$body = str_replace( $replace_key, $replacement, $body );
}
$email = pb_backupbuddy::$options['email_notify_error'];
if ( $override_recipient != '' ) {
$email = $override_recipient;
pb_backupbuddy::status( 'details', 'Overriding email recipient to: `' . $override_recipient . '`.' );
}
pb_backupbuddy::status( 'error', 'Sending email error notification. Subject: `' . $subject . '`; body: `' . $body . '`; recipient(s): `' . $email . '`.' );
if ( !empty( $email ) ) {
if ( pb_backupbuddy::$options['email_return'] != '' ) {
$email_return = pb_backupbuddy::$options['email_return'];
} else {
$email_return = get_option('admin_email');
}
$result = wp_mail( $email, $subject, $body, 'From: BackupBuddy <' . $email_return . ">\r\n".'Reply-To: '.get_option('admin_email')."\r\n", $attachments );
if ( false === $result ) {
pb_backupbuddy::status( 'error', 'Error #45443554: Unable to send error email with WordPress wp_mail(). Verify WordPress & Server settings.' );
}
}
} // End mail_error().
/* mail_notify_scheduled()
*
* Sends a message email to the defined email address(es) on settings page.
*
* @param string $start_or_complete Whether this is the notifcation for starting or completing. Valid values: start, complete
* @param string $message Message to be included in the body of the email.
* @return null
*/
function mail_notify_scheduled( $serial, $start_or_complete, $message ) {
if ( !isset( pb_backupbuddy::$options ) ) {
pb_backupbuddy::load();
}
if ( $start_or_complete == 'start' ) {
$email = pb_backupbuddy::$options['email_notify_scheduled_start'];
$subject = pb_backupbuddy::$options['email_notify_scheduled_start_subject'];
$body = pb_backupbuddy::$options['email_notify_scheduled_start_body'];
$replacements = array(
'{site_url}' => site_url(),
'{backupbuddy_version}' => pb_backupbuddy::settings( 'version' ),
'{current_datetime}' => date(DATE_RFC822),
'{message}' => $message
);
} elseif ( $start_or_complete == 'complete' ) {
$email = pb_backupbuddy::$options['email_notify_scheduled_complete'];
$subject = pb_backupbuddy::$options['email_notify_scheduled_complete_subject'];
$body = pb_backupbuddy::$options['email_notify_scheduled_complete_body'];
$archive_file = '';
require_once( pb_backupbuddy::plugin_path() . '/classes/fileoptions.php' );
$backup_options = new pb_backupbuddy_fileoptions( pb_backupbuddy::$options['log_directory'] . 'fileoptions/' . $serial . '.txt', $read_only = true, $ignore_lock = true );
if ( true !== ( $result = $backup_options->is_ok() ) ) {
pb_backupbuddy::status( 'error', 'Error retrieving fileoptions file `' . pb_backupbuddy::$options['log_directory'] . 'fileoptions/' . $serial . '.txt' . '`. Err 35564332.' );
$archive_file = '[file_unknown]';
$backup_size = '[size_unknown]';
$backup_type = '[type_unknown]';
} else {
$archive_file = $backup_options->options['archive_file'];
$backup_size = pb_backupbuddy::$format->file_size( $backup_options->options['archive_size'] );
$backup_type = $backup_options->options['type'];
}
$replacements = array(
'{site_url}' => site_url(),
'{backupbuddy_version}' => pb_backupbuddy::settings( 'version' ),
'{current_datetime}' => date(DATE_RFC822),
'{message}' => $message,
'{backup_serial}' => $serial,
'{download_link}' => pb_backupbuddy::ajax_url( 'download_archive' ) . '&backupbuddy_backup=' . basename( $archive_file ),
'{backup_file}' => basename( $archive_file ),
'{backup_size}' => $backup_size,
'{backup_type}' => $backup_type,
);
} else {
pb_backupbuddy::status( 'error', 'ERROR #54857845785: Fatally halted. Invalid schedule type. Expected `start` or `complete`. Got `' . $start_or_complete . '`.' );
}
foreach( $replacements as $replace_key => $replacement ) {
$subject = str_replace( $replace_key, $replacement, $subject );
$body = str_replace( $replace_key, $replacement, $body );
}
if ( pb_backupbuddy::$options['email_return'] != '' ) {
$email_return = pb_backupbuddy::$options['email_return'];
} else {
$email_return = get_option('admin_email');
}
pb_backupbuddy::status( 'error', 'Sending email schedule notification. Subject: `' . $subject . '`; body: `' . $body . '`; recipient(s): `' . $email . '`.' );
if ( !empty( $email ) ) {
wp_mail( $email, $subject, $body, 'From: BackupBuddy <' . $email_return . ">\r\n".'Reply-To: '.get_option('admin_email')."\r\n");
}
} // End mail_notify_scheduled().
/* backup_prefix()
*
* Strips all non-file-friendly characters from the site URL. Used in making backup zip filename.
*
* @return string The filename friendly converted site URL.
*/
function backup_prefix() {
$siteurl = site_url();
$siteurl = str_replace( 'http://', '', $siteurl );
$siteurl = str_replace( 'https://', '', $siteurl );
$siteurl = str_replace( '/', '_', $siteurl );
$siteurl = str_replace( '\\', '_', $siteurl );
$siteurl = str_replace( '.', '_', $siteurl );
$siteurl = str_replace( ':', '_', $siteurl ); // Alternative port from 80 is stored in the site url.
$siteurl = str_replace( '~', '_', $siteurl ); // Strip ~.
return $siteurl;
} // End backup_prefix().
/* get_remote_send_defaults()
*
* Get default array values for the remote_sends fileoptions files.
* @return array
*
*/
public function get_remote_send_defaults() {
return array(
'destination' => 0,
'file' => '',
'file_size' => 0,
'trigger' => '', // What triggered this backup. Valid values: scheduled, manual.
'send_importbuddy' => false,
'start_time' => time(),
'finish_time' => 0,
'status' => 'timeout', // success, failure, timeout (default assumption if this is not updated in this PHP load)
'write_speed' => 0,
);
} // End get_remote_send_defaults();
/* send_remote_destination()
*
* function description
*
* @param int $destination_id ID number (index of the destinations array) to send it.
* @param string $file Full file path of file to send.
* @param string $trigger What triggered this backup. Valid values: scheduled, manual.
* @param bool $send_importbuddy Whether or not importbuddy.php should also be sent with the file to destination.
* @param bool $delete_after Whether or not to delete after send success after THIS send.
* @return bool Send status. true success, false failed.
*/
function send_remote_destination( $destination_id, $file, $trigger = '', $send_importbuddy = false, $delete_after = false ) {
if ( defined( 'PB_DEMO_MODE' ) ) {
return false;
}
$migrationkey_transient_time = 60*60*24;
if ( '' == $file ) {
$backup_file_size = 50000; // not sure why anything current would be sending importbuddy but NOT sending a backup but just in case...
} else {
$backup_file_size = filesize( $file );
}
// Generate remote send ID for reference and add it as a new logging serial for better recording details.
$identifier = pb_backupbuddy::random_string( 12 );
// Set migration key for later determining last initiated migration.
if ( 'migration' == $trigger ) {
set_transient( 'pb_backupbuddy_migrationkey', $identifier, $migrationkey_transient_time );
}
pb_backupbuddy::status( 'details', 'Sending file `' . $file . '` (size: `' . $backup_file_size . '`) to remote destination `' . $destination_id . '` triggered by `' . $trigger . '`.' );
pb_backupbuddy::status( 'details', 'About to create initial fileoptions data.' );
require_once( pb_backupbuddy::plugin_path() . '/classes/fileoptions.php' );
$fileoptions_obj = new pb_backupbuddy_fileoptions( pb_backupbuddy::$options['log_directory'] . 'fileoptions/send-' . $identifier . '.txt', $read_only = false, $ignore_lock = true, $create_file = true );
if ( true !== ( $result = $fileoptions_obj->is_ok() ) ) {
pb_backupbuddy::status( 'error', __('Fatal Error #9034 A. Unable to access fileoptions data.', 'it-l10n-backupbuddy' ) . ' Error: ' . $result );
return false;
}
pb_backupbuddy::status( 'details', 'Fileoptions data loaded.' );
$fileoptions = &$fileoptions_obj->options; // Set reference.
// Record some statistics.
$fileoptions = array_merge(
$this->get_remote_send_defaults(),
array(
'destination' => $destination_id,
'file' => $file,
'file_size' => $backup_file_size,
'trigger' => $trigger, // What triggered this backup. Valid values: scheduled, manual.
'send_importbuddy' => $send_importbuddy,
'start_time' => time(),
'finish_time' => 0,
'status' => 'timeout', // success, failure, timeout (default assumption if this is not updated in this PHP load)
'write_speed' => 0,
)
);
pb_backupbuddy::save();
// Prepare variables to pass to remote destination handler.
if ( '' == $file ) { // No file to send (blank string file typically happens when just sending importbuddy).
$files = array();
} else {
$files = array( $file );
}
$destination_settings = &pb_backupbuddy::$options['remote_destinations'][$destination_id];
// For Stash we will check the quota prior to initiating send.
if ( pb_backupbuddy::$options['remote_destinations'][$destination_id]['type'] == 'stash' ) {
// Pass off to destination handler.
require_once( pb_backupbuddy::plugin_path() . '/destinations/bootstrap.php' );
$send_result = pb_backupbuddy_destinations::get_info( 'stash' ); // Used to kick the Stash destination into life.
$stash_quota = pb_backupbuddy_destination_stash::get_quota( pb_backupbuddy::$options['remote_destinations'][$destination_id], true );
if ( $file != '' ) {
$backup_file_size = filesize( $file );
} else {
$backup_file_size = 50000;
}
if ( ( $backup_file_size + $stash_quota['quota_used'] ) > $stash_quota['quota_total'] ) {
$message = '';
$message .= "You do not have enough Stash storage space to send this file. Please upgrade your Stash storage at http://ithemes.com/member/stash.php or delete files to make space.\n\n";
$message .= 'Attempting to send file of size ' . pb_backupbuddy::$format->file_size( $backup_file_size ) . ' but you only have ' . $stash_quota['quota_available_nice'] . ' available. ';
$message .= 'Currently using ' . $stash_quota['quota_used_nice'] . ' of ' . $stash_quota['quota_total_nice'] . ' (' . $stash_quota['quota_used_percent'] . '%).';
pb_backupbuddy::status( 'error', $message );
pb_backupbuddy::$classes['core']->mail_error( $message );
$fileoptions['status'] = 'Failure. Insufficient destination space.';
$fileoptions_obj->save();
return false;
} else {
if ( isset( $stash_quota['quota_warning'] ) && ( $stash_quota['quota_warning'] != '' ) ) {
// We log warning of usage but dont send error email.
$message = '';
$message .= 'WARNING: ' . $stash_quota['quota_warning'] . "\n\nPlease upgrade your Stash storage at http://ithemes.com/member/stash.php or delete files to make space.\n\n";
$message .= 'Currently using ' . $stash_quota['quota_used_nice'] . ' of ' . $stash_quota['quota_total_nice'] . ' (' . $stash_quota['quota_used_percent'] . '%).';
pb_backupbuddy::status( 'details', $message );
//pb_backupbuddy::$classes['core']->mail_error( $message );
}
}
}
if ( $send_importbuddy === true ) {
pb_backupbuddy::status( 'details', 'Generating temporary importbuddy.php file for remote send.' );
$importbuddy_temp = pb_backupbuddy::$options['temp_directory'] . 'importbuddy.php'; // Full path & filename to temporary importbuddy
$this->importbuddy( $importbuddy_temp ); // Create temporary importbuddy.
pb_backupbuddy::status( 'details', 'Generated temporary importbuddy.' );
$files[] = $importbuddy_temp; // Add importbuddy file to the list of files to send.
$send_importbuddy = true; // Track to delete after finished.
} else {
pb_backupbuddy::status( 'details', 'Not sending importbuddy.' );
}
// Clear fileoptions so other stuff can access it if needed.
$fileoptions_obj->save();
$fileoptions_obj->unlock();
unset( $fileoptions_obj );
// Pass off to destination handler.
require_once( pb_backupbuddy::plugin_path() . '/destinations/bootstrap.php' );
$send_result = pb_backupbuddy_destinations::send( $destination_settings, $files, $identifier );
$this->kick_db(); // Kick the database to make sure it didn't go away, preventing options saving.
// Reload fileoptions.
pb_backupbuddy::status( 'details', 'About to load fileoptions data for saving send status.' );
require_once( pb_backupbuddy::plugin_path() . '/classes/fileoptions.php' );
$fileoptions_obj = new pb_backupbuddy_fileoptions( pb_backupbuddy::$options['log_directory'] . 'fileoptions/send-' . $identifier . '.txt', $read_only = false, $ignore_lock = false, $create_file = false );
if ( true !== ( $result = $fileoptions_obj->is_ok() ) ) {
pb_backupbuddy::status( 'error', __('Fatal Error #9034 G. Unable to access fileoptions data.', 'it-l10n-backupbuddy' ) . ' Error: ' . $result );
return false;
}
pb_backupbuddy::status( 'details', 'Fileoptions data loaded.' );
$fileoptions = &$fileoptions_obj->options; // Set reference.
// Update stats.
$fileoptions[$identifier]['finish_time'] = time();
if ( $send_result === true ) { // succeeded.
$fileoptions['status'] = 'success';
$fileoptions['finish_time'] = time();
pb_backupbuddy::status( 'details', 'Remote send SUCCESS.' );
} elseif ( $send_result === false ) { // failed.
$fileoptions['status'] = 'failure';
pb_backupbuddy::status( 'details', 'Remote send FAILURE.' );
} elseif ( is_array( $send_result ) ) { // Array so multipart.
$fileoptions['status'] = 'multipart';
$fileoptions['finish_time'] = 0;
$fileoptions['_multipart_id'] = $send_result[0];
$fileoptions['_multipart_status'] = $send_result[1];
pb_backupbuddy::status( 'details', 'Multipart send in progress.' );
} else {
pb_backupbuddy::status( 'error', 'Error #5485785576463. Invalid status send result: `' . $send_result . '`.' );
}
$fileoptions_obj->save();
// If we sent importbuddy then delete the local copy to clean up.
if ( $send_importbuddy !== false ) {
@unlink( $importbuddy_temp ); // Delete temporary importbuddy.
}
// Handle post-send deletion on success.
pb_backupbuddy::status( 'details', 'Checking if local file should be deleted after remote send based on settings.' );
if ( true === $send_result ) { // Success; only continue on bool true. false indicates failure, array chunking.
if ( true == $delete_after ) { // Delete enabled so delete file.
pb_backupbuddy::status( 'details', 'Local file should be deleted based on settings & success. Deleting local copy of file sent to destination.' );
if ( file_exists( $file ) ) {
$unlink_result = @unlink( $file );
if ( true !== $unlink_result ) {
pb_backupbuddy::status( 'error', 'Unable to unlink local file `' . $file . '`.' );
}
}
if ( file_exists( $file ) ) { // File still exists.
pb_backupbuddy::status( 'details', __('Error. Unable to delete local file `' . $file .'` after send as set in settings.', 'it-l10n-backupbuddy' ) );
$this->mail_error( 'BackupBuddy was unable to delete local file `' . $file . '` after successful remove transfer though post-remote send deletion is enabled. You may want to delete it manually. This can be caused by permission problems or improper server configuration.' );
} else { // Deleted.
pb_backupbuddy::status( 'details', __('Deleted local archive after successful remote destination send based on settings.', 'it-l10n-backupbuddy' ) );
pb_backupbuddy::status( 'action', 'archive_deleted' );
}
} else { // Delete after disabled.
pb_backupbuddy::status( 'details', 'Post-send local file deletion disabled so skipping.' );
}
} else { // Send failed or not complete (chunking).
pb_backupbuddy::status( 'details', 'Remote send not completed so skipping post-send deletion check.' );
}
return $send_result;
} // End send_remote_destination().
/* destination_send()
*
* Send file(s) to a destination. Pass full array of destination settings.
*
* @param array $destination_settings All settings for this destination for this action.
* @param array $files Array of files to send (full path).
* @return bool|array Bool true = success, bool false = fail, array = multipart transfer.
*/
public function destination_send( $destination_settings, $files, $send_id = '' ) {
// Pass off to destination handler.
require_once( pb_backupbuddy::plugin_path() . '/destinations/bootstrap.php' );
$send_result = pb_backupbuddy_destinations::send( $destination_settings, $files, $send_id );
return $send_result;
} // End destination_send().
/* backups_list()
*
* function description
*
* @param string $type Valid options: default, migrate
* @param boolean $subsite_mode When in subsite mode only backups for that specific subsite will be listed.
* @return
*/
public function backups_list( $type = 'default', $subsite_mode = false ) {
if ( ( pb_backupbuddy::_POST( 'bulk_action' ) == 'delete_backup' ) && ( is_array( pb_backupbuddy::_POST( 'items' ) ) ) ) {
$needs_save = false;
pb_backupbuddy::verify_nonce( pb_backupbuddy::_POST( '_wpnonce' ) ); // Security check to prevent unauthorized deletions by posting from a remote place.
$deleted_files = array();
foreach( pb_backupbuddy::_POST( 'items' ) as $item ) {
if ( file_exists( pb_backupbuddy::$options['backup_directory'] . $item ) ) {
if ( @unlink( pb_backupbuddy::$options['backup_directory'] . $item ) === true ) {
$deleted_files[] = $item;
// Cleanup any related fileoptions files.
$serial = pb_backupbuddy::$classes['core']->get_serial_from_file( $item );
$backup_files = glob( pb_backupbuddy::$options['backup_directory'] . '*.zip' );
if ( ! is_array( $backup_files ) ) {
$backup_files = array();
}
if ( count( $backup_files ) > 5 ) { // Keep a minimum number of backups in array for stats.
$this_serial = $this->get_serial_from_file( $item );
$fileoptions_file = pb_backupbuddy::$options['log_directory'] . 'fileoptions/' . $this_serial . '.txt';
if ( file_exists( $fileoptions_file ) ) {
@unlink( $fileoptions_file );
}
if ( file_exists( $fileoptions_file . '.lock' ) ) {
@unlink( $fileoptions_file . '.lock' );
}
$needs_save = true;
}
} else {
pb_backupbuddy::alert( 'Error: Unable to delete backup file `' . $item . '`. Please verify permissions.', true );
}
} // End if file exists.
} // End foreach.
if ( $needs_save === true ) {
pb_backupbuddy::save();
}
pb_backupbuddy::alert( __( 'Deleted:', 'it-l10n-backupbuddy' ) . ' ' . implode( ', ', $deleted_files ) );
} // End if deleting backup(s).
$backups = array();
$backup_sort_dates = array();
$files = glob( pb_backupbuddy::$options['backup_directory'] . 'backup*.zip' );
if ( is_array( $files ) && !empty( $files ) ) { // For robustness. Without open_basedir the glob() function returns an empty array for no match. With open_basedir in effect the glob() function returns a boolean false for no match.
$backup_prefix = $this->backup_prefix(); // Backup prefix for this site. Used for MS checking that this user can see this backup.
foreach( $files as $file_id => $file ) {
if ( ( $subsite_mode === true ) && is_multisite() ) { // If a Network and NOT the superadmin must make sure they can only see the specific subsite backups for security purposes.
// Only allow viewing of their own backups.
if ( !strstr( $file, $backup_prefix ) ) {
unset( $files[$file_id] ); // Remove this backup from the list. This user does not have access to it.
continue; // Skip processing to next file.
}
}
$serial = pb_backupbuddy::$classes['core']->get_serial_from_file( $file );
require_once( pb_backupbuddy::plugin_path() . '/classes/fileoptions.php' );
$backup_options = new pb_backupbuddy_fileoptions( pb_backupbuddy::$options['log_directory'] . 'fileoptions/' . $serial . '.txt', $read_only = false, $ignore_lock = false, $create_file = true ); // Will create file to hold integrity data if nothing exists.
$backup_integrity = pb_backupbuddy::$classes['core']->backup_integrity_check( $file, $backup_options );
/*
echo $file;
echo '';
print_r( $backup_integrity );
echo '
';
echo '
';
*/
// Backup status.
$pretty_status = array(
true => 'Good', // v4.0+ Good.
'pass' => 'Good', // Pre-v4.0 Good.
false => 'Bad', // v4.0+ Bad.
'fail' => 'Bad', // Pre-v4.0 Bad.
);
// Backup type.
$pretty_type = array(
'full' => 'Full',
'db' => 'Database',
);
// Defaults...
$detected_type = '';
$file_size = '';
$modified = '';
$modified_time = 0;
$integrity = '';
if ( is_array( $backup_options->options ) ) { // Data intact... put it all together.
// Calculate time ago.
$time_ago = '';
if ( isset( $backup_options->options['integrity'] ) && ( isset( $backup_options->options['integrity']['modified'] ) ) ) {
$time_ago = pb_backupbuddy::$format->time_ago( $backup_options->options['integrity']['modified'] ) . ' ago';
}
$detected_type = pb_backupbuddy::$format->prettify( $backup_options->options['integrity']['detected_type'], $pretty_type );
if ( $detected_type == '' ) {
$detected_type = 'Unknown';
} else {
if ( isset( $backup_options->options['profile'] ) ) {
$detected_type = $detected_type . '
' . htmlentities( $backup_options->options['profile']['title'] ) . '';
}
}
$file_size = pb_backupbuddy::$format->file_size( $backup_options->options['integrity']['size'] );
$modified = pb_backupbuddy::$format->date( pb_backupbuddy::$format->localize_time( $backup_options->options['integrity']['modified'] ), 'l, F j, Y - g:i:s a' );
$modified_time = $backup_options->options['integrity']['modified'];
if ( isset( $backup_options->options['integrity']['status'] ) ) { // Pre-v4.0.
$status = $backup_options->options['integrity']['status'];
} else { // v4.0+
$status = $backup_options->options['integrity']['is_ok'];
}
// Calculate main row string.
if ( $type == 'default' ) { // Default backup listing.
$main_string = '' . $modified . ' (' . $time_ago . ')';
} elseif ( $type == 'migrate' ) { // Migration backup listing.
$main_string = '' . $modified . ' (' . $time_ago . ')';
} else {
$main_string = '{Unknown type.}';
}
// Add comment to main row string if applicable.
if ( isset( $backup_options->options['integrity']['comment'] ) && ( $backup_options->options['integrity']['comment'] !== false ) && ( $backup_options->options['integrity']['comment'] !== '' ) ) {
$main_string .= '
Note: ' . htmlentities( $backup_options->options['integrity']['comment'] ) . '';
}
$integrity = pb_backupbuddy::$format->prettify( $status, $pretty_status ) . ' ';
if ( isset( $backup_options->options['integrity']['scan_notes'] ) && count( (array)$backup_options->options['integrity']['scan_notes'] ) > 0 ) {
foreach( (array)$backup_options->options['integrity']['scan_notes'] as $scan_note ) {
$integrity .= $scan_note . ' ';
}
}
$integrity .= ' . '/images/refresh_gray.gif)
';
$integrity .= '';
} // end if is_array( $backup_options ).
$backups[basename( $file )] = array(
array( basename( $file ), $main_string . '
' . basename( $file ) . '' ),
$detected_type,
$file_size,
$integrity,
);
$backup_sort_dates[basename( $file)] = $modified_time;
} // End foreach().
} // End if.
// Sort backup by date.
arsort( $backup_sort_dates );
// Re-arrange backups based on sort dates.
$sorted_backups = array();
foreach( $backup_sort_dates as $backup_file => $backup_sort_date ) {
$sorted_backups[$backup_file] = $backups[$backup_file];
unset( $backups[$backup_file] );
}
unset( $backups );
return $sorted_backups;
} // End backups_list().
// If output file not specified then outputs to browser as download.
// IMPORTANT: If outputting to browser (no output file) must die() after outputting content if using AJAX. Do not output to browser anything after this function in this case.
public static function importbuddy( $output_file = '', $importbuddy_pass_hash = '' ) {
if ( defined( 'PB_DEMO_MODE' ) ) {
echo 'Access denied in demo mode.';
return;
}
pb_backupbuddy::set_greedy_script_limits(); // Some people run out of PHP memory.
if ( $importbuddy_pass_hash == '' ) {
if ( !isset( pb_backupbuddy::$options ) ) {
pb_backupbuddy::load();
}
$importbuddy_pass_hash = pb_backupbuddy::$options['importbuddy_pass_hash'];
}
if ( $importbuddy_pass_hash == '' ) {
$message = 'Error #9032: Warning only - You have not set a password to generate the ImportBuddy script yet on the BackupBuddy Settings page. If you are creating a backup, the importbuddy.php restore script will not be included in the backup. You can download it from the Restore page. If you were trying to download ImportBuddy then you may have a plugin confict preventing the page from prompting you to enter a password.';
pb_backupbuddy::status( 'warning', $message );
return false;
}
$output = file_get_contents( pb_backupbuddy::plugin_path() . '/_importbuddy/_importbuddy.php' );
if ( $importbuddy_pass_hash != '' ) {
$output = preg_replace('/#PASSWORD#/', $importbuddy_pass_hash, $output, 1 ); // Only replaces first instance.
}
$version_string = pb_backupbuddy::settings( 'version' ) . ' (downloaded ' . date( DATE_W3C ) . ')';
// If on DEV system (.git dir exists) then append some details on current.
if ( @file_exists( pb_backupbuddy::plugin_path() . '/.git/logs/HEAD' ) ) {
$commit_log = escapeshellarg( pb_backupbuddy::plugin_path() . '/.git/logs/HEAD' );
$commit_line = exec( "tail -n 1 {$commit_log}" );
$version_string .= ' [DEV: ' . $commit_line . ']';
}
$output = preg_replace('/#VERSION#/', $version_string, $output, 1 ); // Only replaces first instance.
// PACK IMPORTBUDDY
$_packdata = array( // NO TRAILING OR PRECEEDING SLASHES!
'_importbuddy/importbuddy' => 'importbuddy',
'classes/_migrate_database.php' => 'importbuddy/classes/_migrate_database.php',
'classes/core.php' => 'importbuddy/classes/core.php',
'classes/import.php' => 'importbuddy/classes/import.php',
'js/jquery.leanModal.min.js' => 'importbuddy/js/jquery.leanModal.min.js',
'js/jquery.joyride-2.0.3.js' => 'importbuddy/js/jquery.joyride-2.0.3.js',
'js/modernizr.mq.js' => 'importbuddy/js/modernizr.mq.js',
'css/joyride.css' => 'importbuddy/css/joyride.css',
'images/working.gif' => 'importbuddy/images/working.gif',
'images/bullet_go.png' => 'importbuddy/images/bullet_go.png',
'images/favicon.png' => 'importbuddy/images/favicon.png',
'images/sort_down.png' => 'importbuddy/images/sort_down.png',
'images/icon_menu_32x32.png' => 'importbuddy/images/icon_menu_32x32.png',
'lib/dbreplace' => 'importbuddy/lib/dbreplace',
'lib/dbimport' => 'importbuddy/lib/dbimport',
'lib/commandbuddy' => 'importbuddy/lib/commandbuddy',
'lib/zipbuddy' => 'importbuddy/lib/zipbuddy',
'lib/mysqlbuddy' => 'importbuddy/lib/mysqlbuddy',
'lib/textreplacebuddy' => 'importbuddy/lib/textreplacebuddy',
'lib/cpanel' => 'importbuddy/lib/cpanel',
'pluginbuddy' => 'importbuddy/pluginbuddy',
'controllers/pages/server_info' => 'importbuddy/controllers/pages/server_info',
'controllers/pages/server_info.php' => 'importbuddy/controllers/pages/server_info.php',
// Stash
'destinations/stash/lib/class.itx_helper.php' => 'importbuddy/classes/class.itx_helper.php',
'destinations/_s3lib/aws-sdk/lib/requestcore' => 'importbuddy/lib/requestcore',
);
$output .= "\n $pack_destination ) {
$pack_source = '/' . $pack_source;
if ( is_dir( pb_backupbuddy::plugin_path() . $pack_source ) ) {
$files = pb_backupbuddy::$filesystem->deepglob( pb_backupbuddy::plugin_path() . $pack_source );
} else {
$files = array( pb_backupbuddy::plugin_path() . $pack_source );
}
foreach( $files as $file ) {
if ( is_file( $file ) ) {
$source = str_replace( pb_backupbuddy::plugin_path(), '', $file );
$destination = $pack_destination . substr( $source, strlen( $pack_source ) );
$output .= "###PACKDATA,FILE_START,{$source},{$destination}\n";
$output .= base64_encode( file_get_contents( $file ) );
$output .= "\n";
$output .= "###PACKDATA,FILE_END,{$source},{$destination}\n";
}
}
}
$output .= "###PACKDATA,END\n*/";
$output .= "\n\n\n\n\n\n\n\n\n\n";
if ( $output_file == '' ) { // No file so output to browser.
header( 'Content-Description: File Transfer' );
header( 'Content-Type: text/plain; name=importbuddy.php' );
header( 'Content-Disposition: attachment; filename=importbuddy.php' );
header( 'Expires: 0' );
header( 'Content-Length: ' . strlen( $output ) );
flush();
echo $output;
flush();
// BE SURE TO die() AFTER THIS AND NOT OUTPUT TO BROWSER!
} else { // Write to file.
if ( false === file_put_contents( $output_file, $output ) ) {
pb_backupbuddy::status( 'error', 'Error #483894: Unable to write to file `' . $output_file . '`.' );
}
}
} // End importbuddy().
// If output file not specified then outputs to browser as download.
// IMPORTANT: If outputting to browser (no output file) must die() after outputting content if using AJAX. Do not output to browser anything after this function in this case.
public static function serverbuddy( $output_file = '', $serverbuddy_pass_hash = '' ) {
if ( defined( 'PB_DEMO_MODE' ) ) {
echo 'Access denied in demo mode.';
return;
}
pb_backupbuddy::set_greedy_script_limits(); // Some people run out of PHP memory.
if ( $serverbuddy_pass_hash == '' ) {
if ( !isset( pb_backupbuddy::$options ) ) {
pb_backupbuddy::load();
}
$serverbuddy_pass_hash = pb_backupbuddy::$options['importbuddy_pass_hash'];
}
if ( $serverbuddy_pass_hash == '' ) {
$message = 'Error #9032c: Warning only - You have not set a password to generate the ServerBuddy script yet on the BackupBuddy Settings page. If you were trying to download ServerBuddy then you may have a plugin confict preventing the page from prompting you to enter a password.';
pb_backupbuddy::status( 'warning', $message );
return false;
}
$output = file_get_contents( pb_backupbuddy::plugin_path() . '/_serverbuddy/_serverbuddy.php' );
if ( $serverbuddy_pass_hash != '' ) {
$output = preg_replace('/#PASSWORD#/', $serverbuddy_pass_hash, $output, 1 ); // Only replaces first instance.
}
$output = preg_replace('/#VERSION#/', pb_backupbuddy::settings( 'version' ), $output, 1 ); // Only replaces first instance.
// PACK SERVERBUDDY
$_packdata = array( // NO TRAILING OR PRECEEDING SLASHES!
'_serverbuddy/serverbuddy' => 'serverbuddy',
'classes/_migrate_database.php' => 'serverbuddy/classes/_migrate_database.php',
'classes/core.php' => 'serverbuddy/classes/core.php',
'images/working.gif' => 'serverbuddy/images/working.gif',
'images/bullet_go.png' => 'serverbuddy/images/bullet_go.png',
'images/favicon.png' => 'serverbuddy/images/favicon.png',
'images/sort_down.png' => 'serverbuddy/images/sort_down.png',
'lib/dbreplace' => 'serverbuddy/lib/dbreplace',
'lib/commandbuddy' => 'serverbuddy/lib/commandbuddy',
'lib/zipbuddy' => 'serverbuddy/lib/zipbuddy',
'lib/mysqlbuddy' => 'serverbuddyy/lib/mysqlbuddy',
'lib/textreplacebuddy' => 'serverbuddy/lib/textreplacebuddy',
'pluginbuddy' => 'serverbuddy/pluginbuddy',
'controllers/pages/server_info' => 'serverbuddy/controllers/pages/server_info',
'controllers/pages/server_info.php' => 'serverbuddy/controllers/pages/server_info.php',
);
$output .= "\n $pack_destination ) {
$pack_source = '/' . $pack_source;
if ( is_dir( pb_backupbuddy::plugin_path() . $pack_source ) ) {
$files = pb_backupbuddy::$filesystem->deepglob( pb_backupbuddy::plugin_path() . $pack_source );
} else {
$files = array( pb_backupbuddy::plugin_path() . $pack_source );
}
foreach( $files as $file ) {
if ( is_file( $file ) ) {
$source = str_replace( pb_backupbuddy::plugin_path(), '', $file );
$destination = $pack_destination . substr( $source, strlen( $pack_source ) );
$output .= "###PACKDATA,FILE_START,{$source},{$destination}\n";
$output .= base64_encode( file_get_contents( $file ) );
$output .= "\n";
$output .= "###PACKDATA,FILE_END,{$source},{$destination}\n";
}
}
}
$output .= "###PACKDATA,END\n*/";
$output .= "\n\n\n\n\n\n\n\n\n\n";
if ( $output_file == '' ) { // No file so output to browser.
header( 'Content-Description: File Transfer' );
header( 'Content-Type: text/plain; name=importbuddy.php' );
header( 'Content-Disposition: attachment; filename=importbuddy.php' );
header( 'Expires: 0' );
header( 'Content-Length: ' . strlen( $output ) );
flush();
echo $output;
flush();
// BE SURE TO die() AFTER THIS AND NOT OUTPUT TO BROWSER!
} else { // Write to file.
file_put_contents( $output_file, $output );
}
} // End serverbuddy().
// TODO: RepairBuddy is not yet converted into new framework so just using pre-BB3.0 version for now.
public function repairbuddy( $output_file = '' ) {
if ( defined( 'PB_DEMO_MODE' ) ) {
echo 'Access denied in demo mode.';
return;
}
if ( !isset( pb_backupbuddy::$options ) ) {
pb_backupbuddy::load();
}
$output = file_get_contents( pb_backupbuddy::plugin_path() . '/_repairbuddy.php' );
if ( pb_backupbuddy::$options['importbuddy_pass_hash'] != '' ) {
$output = preg_replace('/#PASSWORD#/', pb_backupbuddy::$options['importbuddy_pass_hash'], $output, 1 ); // Only replaces first instance.
}
$output = preg_replace('/#VERSION#/', pb_backupbuddy::settings( 'version' ), $output, 1 ); // Only replaces first instance.
if ( $output_file == '' ) { // No file so output to browser.
header( 'Content-Description: File Transfer' );
header( 'Content-Type: text/plain; name=repairbuddy.php' );
header( 'Content-Disposition: attachment; filename=repairbuddy.php' );
header( 'Expires: 0' );
header( 'Content-Length: ' . strlen( $output ) );
flush();
echo $output;
flush();
// BE SURE TO die() AFTER THIS AND NOT OUTPUT TO BROWSER!
} else { // Write to file.
file_put_contents( $output_file, $output );
}
} // End repairbuddy().
function pretty_destination_type( $type ) {
if ( $type == 'rackspace' ) {
return 'Rackspace';
} elseif ( $type == 'email' ) {
return 'Email';
} elseif ( $type == 's3' ) {
return 'Amazon S3';
} elseif ( $type == 'ftp' ) {
return 'FTP';
} elseif ( $type == 'dropbox' ) {
return 'Dropbox';
} else {
return $type;
}
} // End pretty_destination_type().
// $max_depth int Maximum depth of tree to display. Npte that deeper depths are still traversed for size calculations.
function build_icicle( $dir, $base, $icicle_json, $max_depth = 10, $depth_count = 0, $is_root = true ) {
$bg_color = '005282';
$depth_count++;
$bg_color = dechex( hexdec( $bg_color ) - ( $depth_count * 15 ) );
$icicle_json = '{' . "\n";
$dir_name = $dir;
$dir_name = str_replace( ABSPATH, '', $dir );
$dir_name = str_replace( '\\', '/', $dir_name );
$dir_size = 0;
$sub = opendir( $dir );
$has_children = false;
while( $file = readdir( $sub ) ) {
if ( ( $file == '.' ) || ( $file == '..' ) ) {
continue; // Next loop.
} elseif ( is_dir( $dir . '/' . $file ) ) {
$dir_array = '';
$response = $this->build_icicle( $dir . '/' . $file, $base, $dir_array, $max_depth, $depth_count, false );
if ( ( $max_depth-1 > 0 ) || ( $max_depth == -1 ) ) { // Only adds to the visual tree if depth isnt exceeded.
if ( $max_depth > 0 ) {
$max_depth = $max_depth - 1;
}
if ( $has_children === false ) { // first loop add children section
$icicle_json .= '"children": [' . "\n";
} else {
$icicle_json .= ',';
}
$icicle_json .= $response[0];
$has_children = true;
}
$dir_size += $response[1];
unset( $response );
unset( $file );
} else {
$stats = stat( $dir . '/' . $file );
$dir_size += $stats['size'];
unset( $file );
}
}
closedir( $sub );
unset( $sub );
if ( $has_children === true ) {
$icicle_json .= ' ]' . "\n";
}
if ( $has_children === true ) {
$icicle_json .= ',';
}
$icicle_json .= '"id": "node_' . str_replace( '/', ':', $dir_name ) . ': ^' . str_replace( ' ', '~', pb_backupbuddy::$format->file_size( $dir_size ) ) . '"' . "\n";
$dir_name = str_replace( '/', '', strrchr( $dir_name, '/' ) );
if ( $dir_name == '' ) { // Set root to be /.
$dir_name = '/';
}
$icicle_json .= ', "name": "' . $dir_name . ' (' . pb_backupbuddy::$format->file_size( $dir_size ) . ')"' . "\n";
$icicle_json .= ',"data": { "$dim": ' . ( $dir_size + 10 ) . ', "$color": "#' . str_pad( $bg_color, 6, '0', STR_PAD_LEFT ) . '" }' . "\n";
$icicle_json .= '}';
if ( $is_root !== true ) {
//$icicle_json .= ',x';
}
return array( $icicle_json, $dir_size );
} // End build_icicle().
// return array of tests and their results.
public function preflight_check() {
$tests = array();
// MULTISITE BETA WARNING.
if ( is_multisite() && pb_backupbuddy::$classes['core']->is_network_activated() && !defined( 'PB_DEMO_MODE' ) ) { // Multisite installation.
$tests[] = array(
'test' => 'multisite_beta',
'success' => false,
'message' => 'WARNING: BackupBuddy Multisite functionality is EXPERIMENTAL and NOT officially supported. Multiple issues are known. Usage of it is at your own risk and should not be relied upon. Standalone WordPress sites are suggested. You may use the "Export" feature to export your subsites into standalone WordPress sites. To enable experimental BackupBuddy Multisite functionality you must add the following line to your wp-config.php file: define( \'PB_BACKUPBUDDY_MULTISITE_EXPERIMENT\', true );
'
);
/*
$tests[] = array(
'test' => 'multisite_beta_35',
'success' => false,
'message' => 'WARNING: Multisite running on WordPress v3.5 may have introduced multiple issues with importing sites into a Network, possibly including problems with media, users, and URL migration. Only using BackupBuddy with standalone sites is highly recommended.'
);
*/
} // end network-activated multisite.
// LOOPBACKS TEST.
if ( ( $loopback_response = $this->loopback_test() ) === true ) {
$success = true;
$message = '';
} else { // failed
$success = false;
if ( defined( 'ALTERNATE_WP_CRON' ) && ( ALTERNATE_WP_CRON == true ) ) {
$message = __('Running in Alternate WordPress Cron mode. HTTP Loopback Connections are not enabled on this server but you have overridden this in the wp-config.php file (this is a good thing).', 'it-l10n-backupbuddy' ) . ' ' . __('Additional Information Here', 'it-l10n-backupbuddy' ) . '.';
} else {
$message = __('HTTP Loopback Connections are not enabled on this server or are not functioning properly. You may encounter stalled, significantly delayed backups, or other difficulties. See details in the box below. This may be caused by a conflicting plugin such as a caching plugin.', 'it-l10n-backupbuddy' ) . ' ' . __('Click for instructions on how to resolve this issue.', 'it-l10n-backupbuddy' ) . '';
$message .= ' Details: ';
}
}
$tests[] = array(
'test' => 'loopbacks',
'success' => $success,
'message' => $message,
);
// POSSIBLE CACHING PLUGIN CONFLICT WARNING.
$success = true;
$message = '';
$found_plugins = array();
if ( ! is_multisite() ) {
$active_plugins = serialize( get_option( 'active_plugins' ) );
foreach( $this->warn_plugins as $warn_plugin => $warn_plugin_title ) {
if ( FALSE !== strpos( $active_plugins, $warn_plugin ) ) { // Plugin active.
$found_plugins[] = $warn_plugin_title;
$success = false;
}
}
}
if ( count( $found_plugins ) > 0 ) {
$message = __( 'One or more caching plugins were detected as activated. Some caching plugin configurations may possibly cache & interfere with backup processes or WordPress cron. If you encounter problems clear the caching plugin\'s cache (deactivating the plugin may help) to troubleshoot.', 'it-l10n-backupbuddy' ) . ' ';
$message .= __( 'Activated caching plugins detected:', 'it-l10n-backupbuddy' ) . ' ';
$message .= implode( ', ', $found_plugins );
$message .= '.';
}
$tests[] = array(
'test' => 'loopbacks',
'success' => $success,
'message' => $message,
);
// WORDPRESS IN SUBDIRECTORIES TEST.
$wordpress_locations = $this->get_wordpress_locations();
if ( count( $wordpress_locations ) > 0 ) {
$success = false;
$message = __( 'WordPress may have been detected in one or more subdirectories. Backing up multiple instances of WordPress may result in server timeouts due to increased backup time. You may exclude WordPress directories via the Settings page. Detected non-excluded locations:', 'it-l10n-backupbuddy' ) . ' ' . implode( ', ', $wordpress_locations );
} else {
$success = true;
$message = '';
}
$tests[] = array(
'test' => 'wordpress_subdirectories',
'success' => $success,
'message' => $message,
);
// Log file directory writable for status logging.
$status_directory = WP_CONTENT_DIR . '/uploads/pb_' . pb_backupbuddy::settings( 'slug' ) . '/';
if ( ! is_writable( $status_directory ) ) {
$success = false;
$message = 'The status log file directory `' . $status_directory . '` is not writable. Please verify permissions before creating a backup. Backup status information will be unavailable until this is resolved.';
} else {
$success = true;
$message = '';
}
$tests[] = array(
'test' => 'status_directory_writable',
'success' => $success,
'message' => $message,
);
// CHECK ZIP AVAILABILITY.
require_once( pb_backupbuddy::plugin_path() . '/lib/zipbuddy/zipbuddy.php' );
if ( !isset( pb_backupbuddy::$classes['zipbuddy'] ) ) {
pb_backupbuddy::$classes['zipbuddy'] = new pluginbuddy_zipbuddy( pb_backupbuddy::$options['backup_directory'] );
}
/***** BEGIN LOOKING FOR UNFINISHED RECENT BACKUPS *****/
if ( '' != pb_backupbuddy::$options['last_backup_serial'] ) {
require_once( pb_backupbuddy::plugin_path() . '/classes/fileoptions.php' );
$backup_options = new pb_backupbuddy_fileoptions( pb_backupbuddy::$options['log_directory'] . 'fileoptions/' . pb_backupbuddy::$options['last_backup_serial'] . '.txt', $read_only = true );
if ( true !== ( $result = $backup_options->is_ok() ) || ( ! isset( $backup_options->options['updated_time'] ) ) ) {
// NOTE: If this files during a backup it may try to read the fileoptions file too early due to the last_backup_serial being set. Suppressing errors for now.
pb_backupbuddy::status( 'details', 'Unable to retrieve fileoptions file (this is normal if a backup is currently in process & may be ignored) `' . pb_backupbuddy::$options['log_directory'] . 'fileoptions/' . pb_backupbuddy::$options['last_backup_serial'] . '.txt' . '`. Err 54478236765. Details: `' . $result . '`.' );
} else {
if ( $backup_options->options['updated_time'] < 180 ) { // Been less than 3min since last backup.
if ( !empty( $backup_options->options['steps'] ) ) { // Look for incomplete steps.
$found_unfinished = false;
foreach( $backup_options->options['steps'] as $step ) {
if ( $step['finish_time'] == '0' ) { // Found an unfinished step.
$found_unfinished = true;
break;
}
} // end foreach.
if ( $found_unfinished === true ) {
$tests[] = array(
'test' => 'recent_backup',
'success' => false,
'message' => __('A backup was recently started and reports unfinished steps. You should wait unless you are sure the previous backup has completed or failed to avoid placing a heavy load on your server.', 'it-l10n-backupbuddy' ) .
' Last updated: ' . pb_backupbuddy::$format->date( $backup_options->options['updated_time'] ) . '; '.
' Serial: ' . pb_backupbuddy::$options['last_backup_serial']
,
);
} // end $found_unfinished === true.
} // end if.
}
}
}
/***** END LOOKING FOR UNFINISHED RECENT BACKUPS *****/
/***** BEGIN LOOKING FOR BACKUP FILES IN SITE ROOT *****/
$files = glob( ABSPATH . 'backup-*.zip' );
if ( !is_array( $files ) || empty( $files ) ) {
$files = array();
}
foreach( $files as &$file ) {
$file = basename( $file );
}
if ( count( $files ) > 0 ) {
$files_string = implode( ', ', $files );
$tests[] = array(
'test' => 'root_backups-' . $files_string,
'success' => false,
'message' => 'One or more backup files, `' . $files_string . '` was found in the root directory of this site. This may be leftover from a recent restore. You should usually remove backup files from the site root for security.',
);
}
/***** END LOOKING FOR BACKUP FILES IN SITE ROOT *****/
return $tests;
} // End preflight_check().
// returns true on success, error message otherwise.
/* loopback_test()
*
* Connects back to same site via AJAX call to an AJAX slug that has NOT been registered.
* WordPress AJAX returns a -1 (or 0 in newer version?) for these. Also not logged into
* admin when connecting back. Checks to see if body contains -1 / 0. If loopbacks are not
* enabled then will fail connecting or do something else.
*
*
* @param
* @return boolean True on success, string error message otherwise.
*/
function loopback_test() {
$loopback_url = admin_url('admin-ajax.php');
pb_backupbuddy::status( 'details', 'Testing loopback connections by connecting back to site at the URL: `' . $loopback_url . '`. It should display simply "0" or "-1" in the body.' );
$response = wp_remote_get(
$loopback_url,
array(
'method' => 'GET',
'timeout' => 8, // X second delay. A loopback should be very fast.
'redirection' => 5,
'httpversion' => '1.0',
'blocking' => true,
'headers' => array(),
'body' => null,
'cookies' => array()
)
);
if( is_wp_error( $response ) ) { // Loopback failed. Some kind of error.
$error = $response->get_error_message();
pb_backupbuddy::status( 'error', 'Loopback test error: `' . $error . '`.' );
return 'Error: ' . $error;
} else {
if ( ( $response['body'] == '-1' ) || ( $response['body'] == '0' ) ) { // Loopback succeeded.
pb_backupbuddy::status( 'details', 'HTTP Loopback test success. Returned `' . $response['body'] . '`.' );
return true;
} else { // Loopback failed.
$error = 'Connected to server but unexpected output: ' . htmlentities( $response['body'] );
pb_backupbuddy::status( 'error', $error );
return $error;
}
}
}
// Returns array of subdirectories that contain WordPress.
function get_wordpress_locations() {
$wordpress_locations = array();
$files = glob( ABSPATH . '*/' );
if ( !is_array( $files ) || empty( $files ) ) {
$files = array();
}
foreach( $files as $file ) {
if ( file_exists( $file . 'wp-config.php' ) ) {
$wordpress_locations[] = rtrim( '/' . str_replace( ABSPATH, '', $file ), '/\\' );
}
}
// Remove any excluded directories from showing up in this.
$directory_exclusions = $this->get_directory_exclusions( pb_backupbuddy::$options['profiles'][0] ); // default profile.
$wordpress_locations = array_diff( $wordpress_locations, $directory_exclusions );
return $wordpress_locations;
} // End get_wordpress_locations().
/* periodic_cleanup()
*
* Periodic housekeeping cleanup function to clean up after BackupBuddy. Clean up orphaned files, data structure,
* old log files, etc. Also verifies anti-directory browsing files exist in expected locations and any potential
* problems are handled.
*
* @param int $backup_age_limit Maximum age (in seconds) to allow logs or other transient files/structures to exist after no longer needed. Default: 172800 (48 hours).
* @param bool $die_on_fail Whether or not to die fatally if something goes wrong (such as unable to make anti-directory browsing files).
*
*/
function periodic_cleanup( $backup_age_limit = 172800, $die_on_fail = true ) {
$max_importbuddy_age = 60*60*1; // 1hr - Max age, in seconds, importbuddy files can be there before cleaning up (delay useful if just imported and testing out site).
$max_status_log_age = 48; // Max age in hours.
$max_site_log_size = pb_backupbuddy::$options['max_site_log_size'] * 1024 * 1024; // in bytes.
pb_backupbuddy::status( 'message', 'Starting cleanup procedure for BackupBuddy v' . pb_backupbuddy::settings( 'version' ) . '.' );
if ( !isset( pb_backupbuddy::$options ) ) {
$this->load();
}
// Alert user if no new backups FINISHED within X number of days if enabled. Max 1 email notification per 24 hours period.
if ( pb_backupbuddy::$options['no_new_backups_error_days'] > 0 ) {
if ( pb_backupbuddy::$options['last_backup_finish'] > 0 ) {
$time_since_last = time() - pb_backupbuddy::$options['last_backup_finish'];
$days_since_last = $time_since_last / 60 / 60 / 24;
if ( $days_since_last > pb_backupbuddy::$options['no_new_backups_error_days'] ) {
$last_sent = get_transient( 'pb_backupbuddy_no_new_backup_error' );
if ( false === $last_sent ) {
$last_sent = time();
set_transient( 'pb_backupbuddy_no_new_backup_error', $last_sent, (60*60*24) );
}
if ( ( time() - $last_sent ) > (60*60*24) ) { // 24hrs+ elapsed since last email sent.
$message = 'Alert! BackupBuddy is configured to notify you if no new backups have completed in `' . pb_backupbuddy::$options['no_new_backups_error_days'] . '` days. It has been `' . $days_since_last . '` days since your last completed backups.';
pb_backupbuddy::status( 'warning', $message );
pb_backupbuddy::$classes['core']->mail_error( $message );
}
}
}
}
// TODO: Check for orphaned .gz files in root from PCLZip.
// Cleanup backup itegrity portion of array (status logging info inside function).
// DEPRECATED: $this->trim_backups_integrity_stats();
/***** BEGIN CLEANUP LOGS *****/
// Purge old logs.
pb_backupbuddy::status( 'details', 'Cleaning up old logs.' );
$log_directory = WP_CONTENT_DIR . '/uploads/pb_' . pb_backupbuddy::settings( 'slug' ) . '/';
// Purge individual backup status logs unmodified in certain number of hours.
$files = glob( $log_directory . 'status-*.txt' );
if ( is_array( $files ) && !empty( $files ) ) { // For robustness. Without open_basedir the glob() function returns an empty array for no match. With open_basedir in effect the glob() function returns a boolean false for no match.
foreach( $files as $file ) {
$file_stats = stat( $file );
if ( ( time() - $file_stats['mtime'] ) > $max_status_log_age ) {
@unlink( $file );
}
}
}
// Purge site-wide log if over certain size.
$files = glob( $log_directory . 'log-*.txt' );
if ( is_array( $files ) && !empty( $files ) ) { // For robustness. Without open_basedir the glob() function returns an empty array for no match. With open_basedir in effect the glob() function returns a boolean false for no match.
foreach( $files as $file ) {
$file_stats = stat( $file );
if ( $file_stats['size'] > ( $max_site_log_size ) ) {
$this->mail_error( 'NOTICE ONLY (not an error): A BackupBuddy log file has exceeded the size threshold of ' . $max_site_log_size . ' KB and has been deleted to maintain performance. This is only a notice. Deleted log file: ' . $file . '.' );
@unlink( $file );
}
}
}
/***** END CLEANUP LOGS *****/
// Cleanup any temporary local destinations.
pb_backupbuddy::status( 'details', 'Cleaning up any temporary local destinations.' );
foreach( pb_backupbuddy::$options['remote_destinations'] as $destination_id => $destination ) {
if ( ( $destination['type'] == 'local' ) && ( isset( $destination['temporary'] ) && ( $destination['temporary'] === true ) ) ) { // If local and temporary.
if ( ( time() - $destination['created'] ) > $backup_age_limit ) { // Older than 12 hours; clear out!
pb_backupbuddy::status( 'details', 'Cleaned up stale local destination `' . $destination_id . '`.' );
unset( pb_backupbuddy::$options['remote_destinations'][$destination_id] );
pb_backupbuddy::save();
}
}
}
// Cleanup excess remote sending stats.
pb_backupbuddy::status( 'details', 'Cleaning up remote send stats.' );
$this->trim_remote_send_stats( $backup_age_limit );
// Verify directory existance and anti-directory browsing is in place everywhere.
self::verify_directories();
require_once( pb_backupbuddy::plugin_path() . '/classes/fileoptions.php' );
// Purge fileoptions files without matching backup file in existance that are older than 30 days.
pb_backupbuddy::status( 'details', 'Cleaning up old backup fileoptions option files.' );
$fileoptions_directory = pb_backupbuddy::$options['log_directory'] . 'fileoptions/';
$files = glob( $fileoptions_directory . '*.txt' );
if ( ! is_array( $files ) ) {
$files = array();
}
foreach( $files as $file ) {
$backup_options = new pb_backupbuddy_fileoptions( $file, $read_only = true );
if ( true !== ( $result = $backup_options->is_ok() ) ) {
pb_backupbuddy::status( 'error', 'Error retrieving fileoptions file `' . $file . '`. Err 335353266.' );
} else {
if ( isset( $backup_options->options['archive_file'] ) ) {
if ( ! file_exists( $backup_options->options['archive_file'] ) ) { // No corresponding backup ZIP file.
$modified = filemtime( $file );
if ( ( time() - $modified ) > self::MAX_SECONDS_TO_KEEP_ORPHANED_FILEOPTIONS_FILES ) { // Too many days old so delete.
if ( false === unlink( $file ) ) {
pb_backupbuddy::status( 'error', 'Unable to delete orphaned fileoptions file `' . $file . '`.' );
}
if ( file_exists( $file . '.lock' ) ) {
@unlink( $file . '.lock' );
}
} else {
// Do not delete orphaned fileoptions because it is not old enough. Recent backups page needs these to list the backup.
}
} else { // Backup ZIP file exists.
}
}
}
} // end foreach.
// Handle high security mode archives directory .htaccess system. If high security backup directory mode: Make sure backup archives are NOT downloadable by default publicly. This is only lifted for ~8 seconds during a backup download for security. Overwrites any existing .htaccess in this location.
if ( pb_backupbuddy::$options['lock_archives_directory'] == '0' ) { // Normal security mode. Put normal .htaccess.
pb_backupbuddy::status( 'details', 'Removing .htaccess high security mode for backups directory. Normal mode .htaccess to be added next.' );
// Remove high security .htaccess.
if ( file_exists( pb_backupbuddy::$options['backup_directory'] . '.htaccess' ) ) {
$unlink_status = @unlink( pb_backupbuddy::$options['backup_directory'] . '.htaccess' );
if ( $unlink_status === false ) {
pb_backupbuddy::alert( 'Error #844594. Unable to temporarily remove .htaccess security protection on archives directory to allow downloading. Please verify permissions of the BackupBuddy archives directory or manually download via FTP.' );
}
}
// Place normal .htaccess.
pb_backupbuddy::anti_directory_browsing( pb_backupbuddy::$options['backup_directory'], $die_on_fail );
} else { // High security mode. Make sure high security .htaccess in place.
pb_backupbuddy::status( 'details', 'Adding .htaccess high security mode for backups directory.' );
$htaccess_creation_status = @file_put_contents( pb_backupbuddy::$options['backup_directory'] . '.htaccess', 'deny from all' );
if ( $htaccess_creation_status === false ) {
pb_backupbuddy::alert( 'Error #344894545. Security Warning! Unable to create security file (.htaccess) in backups archive directory. This file prevents unauthorized downloading of backups should someone be able to guess the backup location and filenames. This is unlikely but for best security should be in place. Please verify permissions on the backups directory.' );
}
}
// Remove any copy of importbuddy.php in root.
pb_backupbuddy::status( 'details', 'Cleaning up importbuddy.php script in site root if it exists & is not very recent.' );
if ( file_exists( ABSPATH . 'importbuddy.php' ) ) {
$modified = filemtime( ABSPATH . 'importbuddy.php' );
if ( ( FALSE === $modified ) || ( time() > ( $modified + $max_importbuddy_age ) ) ) { // If time modified unknown OR was modified long enough ago.
pb_backupbuddy::status( 'details', 'Unlinked importbuddy.php in root of site.' );
unlink( ABSPATH . 'importbuddy.php' );
} else {
pb_backupbuddy::status( 'details', 'SKIPPED unlinking importbuddy.php in root of site as it is fresh and may still be in use.' );
}
}
// Remove any copy of importbuddy directory in root.
pb_backupbuddy::status( 'details', 'Cleaning up importbuddy directory in site root if it exists & is not very recent.' );
if ( file_exists( ABSPATH . 'importbuddy/' ) ) {
$modified = filemtime( ABSPATH . 'importbuddy/' );
if ( ( FALSE === $modified ) || ( time() > ( $modified + $max_importbuddy_age ) ) ) { // If time modified unknown OR was modified long enough ago.
pb_backupbuddy::status( 'details', 'Unlinked importbuddy directory recursively in root of site.' );
pb_backupbuddy::$filesystem->unlink_recursive( ABSPATH . 'importbuddy/' );
} else {
pb_backupbuddy::status( 'details', 'SKIPPED unlinked importbuddy directory recursively in root of site as it is fresh and may still be in use.' );
}
}
// Remove any old temporary directories in wp-content/uploads/backupbuddy_temp/. Logs any directories it cannot delete.
pb_backupbuddy::status( 'details', 'Cleaning up any old temporary zip directories in: wp-content/uploads/backupbuddy_temp/' );
$temp_directory = WP_CONTENT_DIR . '/uploads/backupbuddy_temp/';
$files = glob( $temp_directory . '*' );
if ( is_array( $files ) && !empty( $files ) ) { // For robustness. Without open_basedir the glob() function returns an empty array for no match. With open_basedir in effect the glob() function returns a boolean false for no match.
foreach( $files as $file ) {
if ( ( strpos( $file, 'index.' ) !== false ) || ( strpos( $file, '.htaccess' ) !== false ) ) { // Index file or htaccess dont get deleted so go to next file.
continue;
}
$file_stats = stat( $file );
if ( ( time() - $file_stats['mtime'] ) > $backup_age_limit ) { // If older than 12 hours, delete the log.
if ( @pb_backupbuddy::$filesystem->unlink_recursive( $file ) === false ) {
pb_backupbuddy::status( 'error', 'Unable to clean up (delete) temporary directory/file: `' . $file . '`. You should manually delete it or check permissions.' );
}
}
}
}
// Cleanup any temp files from a failed restore within WordPress. (extract file feature).
$temp_dir = get_temp_dir();
pb_backupbuddy::status( 'details', 'Cleaning up temporary files from individual file / directory restores in directory `' . $temp_dir . '`...' );
$possibly_temp_restore_dirs = glob( $temp_dir . 'backupbuddy-*' );
if ( ! is_array( $possibly_temp_restore_dirs ) ) { $possibly_temp_restore_dirs = array(); }
foreach( $possibly_temp_restore_dirs as $possibly_temp_restore_dir ) {
if ( false === pb_backupbuddy::$filesystem->unlink_recursive( $possibly_temp_restore_dir ) ) { // Delete.
pb_backupbuddy::status( 'details', 'Unable to delete temporary holding directory `' . $possibly_temp_restore_dir . '`.' );
} else {
pb_backupbuddy::status( 'details', 'Cleaned up temporary files.' );
}
}
pb_backupbuddy::status( 'details', 'Individual file / directory restore cleanup complete.' );
// Remove any old temporary zip directories: wp-content/uploads/backupbuddy_backups/temp_zip_XXXX/. Logs any directories it cannot delete.
pb_backupbuddy::status( 'details', 'Cleaning up any old temporary zip directories in backup directory temp location `' . pb_backupbuddy::$options['backup_directory'] . 'temp_zip_XXXX/`.' );
// $temp_directory = WP_CONTENT_DIR . '/uploads/backupbuddy_backups/temp_zip_*';
$temp_directory = pb_backupbuddy::$options['backup_directory'] . 'temp_zip_*';
$files = glob( $temp_directory . '*' );
if ( is_array( $files ) && !empty( $files ) ) { // For robustness. Without open_basedir the glob() function returns an empty array for no match. With open_basedir in effect the glob() function returns a boolean false for no match.
foreach( $files as $file ) {
if ( ( strpos( $file, 'index.' ) !== false ) || ( strpos( $file, '.htaccess' ) !== false ) ) { // Index file or htaccess dont get deleted so go to next file.
continue;
}
$file_stats = stat( $file );
if ( ( time() - $file_stats['mtime'] ) > $backup_age_limit ) { // If older than 12 hours, delete the log.
if ( @pb_backupbuddy::$filesystem->unlink_recursive( $file ) === false ) {
$message = 'BackupBuddy was unable to clean up (delete) temporary directory/file: `' . $file . '`. You should manually delete it and/or verify proper file permissions to allow BackupBuddy to clean up for you.';
pb_backupbuddy::status( 'error', $message );
$this->mail_error( $message );
}
}
}
}
// Cleanup remote S3 multipart chunking.
foreach( pb_backupbuddy::$options['remote_destinations'] as $destination ) {
if ( $destination['type'] != 's3' ) { continue; }
if ( isset( $destination['max_chunk_size'] ) && ( $destination['max_chunk_size'] == '0' ) ) { continue; }
pb_backupbuddy::status( 'details', 'Found S3 Multipart Chunking Destinations to cleanup.' );
require_once( pb_backupbuddy::plugin_path() . '/destinations/bootstrap.php' );
$cleanup_result = pb_backupbuddy_destinations::multipart_cleanup( $destination );
/*
if ( true === $cleanup_result ) {
pb_backupbuddy::status( 'details', 'S3 Multipart Chunking Cleanup Success.' );
} else {
pb_backupbuddy::status( 'error', 'S3 Multipart Chunking Cleanup FAILURE. Manually cleanup stalled multipart send via S3 or try again later.' );
}
*/
}
@clearstatcache(); // Clears file info stat cache.
pb_backupbuddy::status( 'message', 'Finished cleanup procedure.' );
} // End periodic_cleanup().
public function final_cleanup( $serial ) {
if ( !isset( pb_backupbuddy::$options ) ) {
pb_backupbuddy::load();
}
pb_backupbuddy::status( 'details', 'cron_final_cleanup started' );
require_once( pb_backupbuddy::plugin_path() . '/classes/fileoptions.php' );
$backup_options = new pb_backupbuddy_fileoptions( pb_backupbuddy::$options['log_directory'] . 'fileoptions/' . $serial . '.txt', $read_only = true );
if ( true !== ( $result = $backup_options->is_ok() ) ) {
pb_backupbuddy::status( 'error', 'Unable to open fileoptions file.' );
}
// Delete temporary data directory.
if ( isset( $backup_options->options['temp_directory'] ) && file_exists( $backup_options->options['temp_directory'] ) ) {
pb_backupbuddy::$filesystem->unlink_recursive( $backup_options->options['temp_directory'] );
}
// Delete temporary zip directory.
if ( isset( $backup_options->options['temporary_zip_directory'] ) && file_exists( $backup_options->options['temporary_zip_directory'] ) ) {
pb_backupbuddy::$filesystem->unlink_recursive( $backup_options->options['temporary_zip_directory'] );
}
// Delete status log text file.
if ( file_exists( pb_backupbuddy::$options['backup_directory'] . 'temp_status_' . $serial . '.txt' ) ) {
unlink( pb_backupbuddy::$options['backup_directory'] . 'temp_status_' . $serial. '.txt' );
}
} // End final_cleanup().
/* trim_remote_send_stats()
*
* Handles trimming the number of remote sends to the most recent ones.
*
* @return null
*/
public function trim_remote_send_stats( $max_age = 172800 ) {
$limit = 5; // Maximum number of remote sends to keep track of.
$send_fileoptions = pb_backupbuddy::$filesystem->glob_by_date( pb_backupbuddy::$options['log_directory'] . 'fileoptions/send-*.txt' );
if ( ! is_array( $send_fileoptions ) ) {
$send_fileoptions = array();
}
// Return if limit not yet met.
if ( count( $send_fileoptions ) <= $limit ) {
return;
}
$i = 0;
foreach( $send_fileoptions as $send_fileoption ) {
$i++;
if ( $i > $limit ) {
$modified = filemtime( $send_fileoption );
if ( ( time() - $modified ) > $max_age ) {
if ( false === @unlink( $send_fileoption ) ) {
pb_backupbuddy::status( 'error', 'Unable to delete old remote send log file `' . $send_fileoption . '`. You may manually delete it. Check directory permissions for future cleanup.' );
}
}
}
}
return;
} // End trim_remote_send_stats().
/* get_site_size()
*
* Returns an array with the site size and the site size sans exclusions. Saves updates stats in options.
*
* @return array Index 0: site size; Index 1: site size sans excluded files/dirs.; Index 2: Total number of objects (files+folders); Index 3: Total objects sans excluded files/folders.
*/
public function get_site_size() {
$exclusions = pb_backupbuddy_core::get_directory_exclusions( pb_backupbuddy::$options['profiles'][0] );
$dir_array = array();
$result = pb_backupbuddy::$filesystem->dir_size_map( ABSPATH, ABSPATH, $exclusions, $dir_array );
unset( $dir_array ); // Free this large chunk of memory.
$total_size = pb_backupbuddy::$options['stats']['site_size'] = $result[0];
$total_size_excluded = pb_backupbuddy::$options['stats']['site_size_excluded'] = $result[1];
$total_objects = pb_backupbuddy::$options['stats']['site_objects'] = $result[2];
$total_objects_excluded = pb_backupbuddy::$options['stats']['site_objects_excluded'] = $result[3];
pb_backupbuddy::$options['stats']['site_size_updated'] = time();
pb_backupbuddy::save();
return array( $total_size, $total_size_excluded, $total_objects, $total_objects_excluded );
} // End get_site_size().
/* get_database_size()
*
* Return array of database size, database sans exclusions.
*
* @return array Index 0: db size, Index 1: db size sans exclusions.
*/
public function get_database_size( $profile_id = 0 ) {
global $wpdb;
$prefix = $wpdb->prefix;
$prefix_length = strlen( $wpdb->prefix );
$additional_includes = explode( "\n", pb_backupbuddy::$options['profiles'][$profile_id]['mysqldump_additional_includes'] );
array_walk( $additional_includes, create_function('&$val', '$val = trim($val);'));
$additional_excludes = explode( "\n", pb_backupbuddy::$options['profiles'][$profile_id]['mysqldump_additional_excludes'] );
array_walk( $additional_excludes, create_function('&$val', '$val = trim($val);'));
$total_size = 0;
$total_size_with_exclusions = 0;
$result = mysql_query( "SHOW TABLE STATUS", $wpdb->dbh );
while( $rs = mysql_fetch_array( $result ) ) {
$excluded = true; // Default.
// TABLE STATUS.
$resultb = mysql_query( "CHECK TABLE `{$rs['Name']}`", $wpdb->dbh );
while( $rsb = mysql_fetch_array( $resultb ) ) {
if ( $rsb['Msg_type'] == 'status' ) {
$status = $rsb['Msg_text'];
}
}
mysql_free_result( $resultb );
// TABLE SIZE.
$size = ( $rs['Data_length'] + $rs['Index_length'] );
$total_size += $size;
// HANDLE EXCLUSIONS.
if ( pb_backupbuddy::$options['profiles'][$profile_id]['backup_nonwp_tables'] == 0 ) { // Only matching prefix.
if ( ( substr( $rs['Name'], 0, $prefix_length ) == $prefix ) OR ( in_array( $rs['Name'], $additional_includes ) ) ) {
if ( !in_array( $rs['Name'], $additional_excludes ) ) {
$total_size_with_exclusions += $size;
$excluded = false;
}
}
} else { // All tables.
if ( !in_array( $rs['Name'], $additional_excludes ) ) {
$total_size_with_exclusions += $size;
$excluded = false;
}
}
}
pb_backupbuddy::$options['stats']['db_size'] = $total_size;
pb_backupbuddy::$options['stats']['db_size_excluded'] = $total_size_with_exclusions;
pb_backupbuddy::$options['stats']['db_size_updated'] = time();
pb_backupbuddy::save();
mysql_free_result( $result );
return array( $total_size, $total_size_with_exclusions );
} // End get_database_size().
/* Doesnt work?
public function error_handler( $error_number, $error_string, $error_file, $error_line ) {
pb_backupbuddy::status( 'error', "PHP error caught. Error #`{$error_number}`; Description: `{$error_string}`; File: `{$error_file}`; Line: `{$error_line}`." );
return true;
}
*/
public function kick_db() {
$kick_db = true; // Change true to false for debugging purposes to disable kicker.
// Need to make sure the database connection is active. Sometimes it goes away during long bouts doing other things -- sigh.
// This is not essential so use include and not require (suppress any warning)
if ( $kick_db === true ) {
pb_backupbuddy::status( 'details', 'kick_db()' );
pb_backupbuddy::status( 'details', 'Loading DB kicker in case database has gone away.' );
@include_once( pb_backupbuddy::plugin_path() . '/lib/wpdbutils/wpdbutils.php' );
if ( class_exists( 'pluginbuddy_wpdbutils' ) ) {
// This is the database object we want to use
global $wpdb;
// Get our helper object and let it use us to output status messages
$dbhelper = new pluginbuddy_wpdbutils( $wpdb );
// If we cannot kick the database into life then signal the error and return false which will stop the backup
// Otherwise all is ok and we can just fall through and let the function return true
if ( !$dbhelper->kick() ) {
pb_backupbuddy::status( 'error', __('Database Server has gone away, unable to update remote destination transfer status. This is most often caused by mysql running out of memory or timing out far too early. Please contact your host.', 'it-l10n-backupbuddy' ) );
} else {
pb_backupbuddy::status( 'details', 'Database seems to still be connected.' );
}
} else {
// Utils not available so cannot verify database connection status - just notify
pb_backupbuddy::status( 'details', __('Database Server connection status unverified.', 'it-l10n-backupbuddy' ) );
}
}
} // End kick_db().
/* verify_directories()
*
* Verify existance and security of key directories. Result available via global $pb_backupbuddy_directory_verification with return value.
*
* @return bool true on success creating / verifying, else false.
*
*/
public function verify_directories() {
$success = true;
// Keep backup directory up to date.
if ( ( pb_backupbuddy::$options['backup_directory'] == '' ) || ( ! @is_writable( pb_backupbuddy::$options['backup_directory'] ) ) ) {
$default_backup_dir = ABSPATH . 'wp-content/uploads/backupbuddy_backups/';
pb_backupbuddy::status( 'details', 'Backup directory invalid. Updating from `' . pb_backupbuddy::$options['backup_directory'] . '` to the default `' . $default_backup_dir . '`.' );
pb_backupbuddy::$options['backup_directory'] = $default_backup_dir;
pb_backupbuddy::save();
}
$response = pb_backupbuddy::anti_directory_browsing( pb_backupbuddy::$options['backup_directory'], $die = false );
if ( false === $response ) {
$success = false;
}
// Keep log directory up to date.
if ( ( pb_backupbuddy::$options['log_directory'] == '' ) || ( ! @is_writable( pb_backupbuddy::$options['log_directory'] ) ) ) {
$default_log_dir = ABSPATH . 'wp-content/uploads/pb_backupbuddy/';
pb_backupbuddy::status( 'details', 'Log directory invalid. Updating from `' . pb_backupbuddy::$options['log_directory'] . '` to the default `' . $default_log_dir . '`.' );
pb_backupbuddy::$options['log_directory'] = $default_log_dir;
pb_backupbuddy::save();
}
pb_backupbuddy::anti_directory_browsing( pb_backupbuddy::$options['log_directory'], $die = false );
if ( false === $response ) {
$success = false;
}
// Keep temp directory up to date.
if ( pb_backupbuddy::$options['temp_directory'] != ( ABSPATH . 'wp-content/uploads/backupbuddy_temp/' ) ) {
pb_backupbuddy::status( 'details', 'Temporary directory has changed. Updating from `' . pb_backupbuddy::$options['temp_directory'] . '` to `' . ABSPATH . 'wp-content/uploads/backupbuddy_temp/' . '`.' );
pb_backupbuddy::$options['temp_directory'] = ABSPATH . 'wp-content/uploads/backupbuddy_temp/';
pb_backupbuddy::save();
}
pb_backupbuddy::anti_directory_browsing( pb_backupbuddy::$options['temp_directory'], $die = false );
if ( false === $response ) {
$success = false;
}
global $pb_backupbuddy_directory_verification;
$pb_backupbuddy_directory_verification = $success;
return $success;
} // End verify_directories().
/* schedule_single_event()
*
* API to wp_schedule_single_event() that also verifies that the schedule actually got created in WordPRess.
* Sometimes the database rejects this update so we need to do actual verification.
*
* @return boolean True on verified schedule success, else false.
*/
public function schedule_single_event( $time, $tag, $args ) {
$schedule_result = wp_schedule_single_event( $time, $tag, $args ); // Schedule.
$next_scheduled = wp_next_scheduled( $tag, $args ); // Retrieve schedule to verify it stuck.
if ( FALSE === $schedule_result ) {
pb_backupbuddy::status( 'error', 'Unable to create schedule as wp_schedule_single_event() returned false. A plugin may have prevented it.' );
return false;
}
if ( FALSE === $next_scheduled ) {
pb_backupbuddy::status( 'error', 'WordPress reported success scheduling BUT wp_next_scheduled() could NOT confirm schedule existance. The database may have rejected the update.' );
return false;
}
return true;
} // End schedule_single_event().
/* schedule_event()
*
* API to wp_schedule_event() that also verifies that the schedule actually got created in WordPRess.
* Sometimes the database rejects this update so we need to do actual verification.
*
* @return boolean True on verified schedule success, else false.
*/
public function schedule_event( $time, $period, $tag, $args ) {
$schedule_result = wp_schedule_event( $time, $period, $tag, $args );
$next_scheduled = wp_next_scheduled( $tag, $args );
if ( FALSE === $schedule_result ) {
pb_backupbuddy::status( 'error', 'Unable to create schedule as wp_schedule_event() returned false. A plugin may have prevented it.' );
return false;
}
if ( FALSE === $next_scheduled ) {
pb_backupbuddy::status( 'error', 'WordPress reported success scheduling BUT wp_next_scheduled() could NOT confirm schedule existance. The database may have rejected the update.' );
return false;
}
return true;
} // End schedule_event().
/* unschedule_event()
*
* API to wp_unschedule_event() that also verifies that the schedule actually got removed WordPRess.
* Sometimes the database rejects this update so we need to do actual verification.
*
* @return boolean True on verified schedule deletion success, else false.
*/
public function unschedule_event( $time, $tag, $args ) {
$unschedule_result = wp_unschedule_event( $time, $tag, $args );
$next_scheduled = wp_next_scheduled( $tag, $args );
if ( FALSE === $unschedule_result ) {
pb_backupbuddy::status( 'error', 'Unable to remove schedule as wp_unschedule_event() returned false. A plugin may have prevented it.' );
return false;
}
if ( FALSE !== $next_scheduled ) {
pb_backupbuddy::status( 'error', 'WordPress reported success unscheduling BUT wp_next_scheduled() confirmed schedule existance. The database may have rejected the removal.' );
return false;
}
return true;
} // End unschedule_event().
/* normalize_comment_data()
*
* Handle normalizing zip comment data, defaults, etc.
*
* @param array $comment Array of meta data to normalize & apply defaults to.
* @return array Normalized array.
*/
public function normalize_comment_data( $comment ) {
$defaults = array(
'serial' => '',
'siteurl' => '',
'type' => '',
'profile' => '',
'created' => '',
'bb_version' => '',
'wp_version' => '',
'dat_path' => '',
'note' => '',
);
if ( ! is_array( $comment ) ) { // Plain text; place in note field.
if ( is_string( $comment ) ) {
$defaults['note'] = $comment;
}
return $defaults;
} else { // Array. Merge defaults and return.
return array_merge( $defaults, $comment );
}
} // End normalize_comment_data().
/* add_backup_schedule()
*
* Adds a new schedule for backing up.
*
* @param string $title Schedule title (user-friendly name).
* @param int $profile Profile ID.
* @param string $interval WordPress schedule interval for cron (ie weekly, daily, hourly, etc).
* @param int $first_run Timestamp of when to run the first in this scheduled cron series.
* @param array $remote_destinations Array of remote destination IDs to send to.
* @param bool $delete_after Whether or not to delete local backup file after success sending to all remote destinations (if any). Does not delete if no destinations defined.
* @param bool $enabled true if enabled, else false.
* @return true|string true on success, else error message string.
*
*/
public function add_backup_schedule( $title, $profile, $interval, $first_run, $remote_destinations = array(), $delete_after = false, $enabled = true ) {
$schedule = pb_backupbuddy::settings( 'schedule_defaults' );
$schedule['title'] = $title;
$schedule['profile'] = (int)$profile;
$schedule['interval'] = $interval;
$schedule['first_run'] = $first_run;
$schedule['remote_destinations'] = implode( '|', $remote_destinations );
if ( true == $delete_after ) {
$schedule['delete_after'] = '1';
} else {
$schedule['delete_after'] = '0';
}
if ( false == $enabled ) {
$schedule['on_off'] = '0';
} else {
$schedule['on_off'] = '1';
}
$next_index = pb_backupbuddy::$options['next_schedule_index']; // v2.1.3: $next_index = end( array_keys( pb_backupbuddy::$options['schedules'] ) ) + 1;
pb_backupbuddy::$options['next_schedule_index']++; // This change will be saved in savesettings function below.
pb_backupbuddy::$options['schedules'][$next_index] = $schedule;
$result = pb_backupbuddy::$classes['core']->schedule_event( $schedule['first_run'], $schedule['interval'], 'pb_backupbuddy-cron_scheduled_backup', array( $next_index ) );
if ( $result === false ) {
return 'Error scheduling event with WordPress. Your schedule may not work properly. Please try again. Error #3488439b. Check your BackupBuddy error log for details.';
} else {
pb_backupbuddy::save();
return true;
}
} // End add_backup_schedule().
/* pretty_meta_info()
*
* Translates meta information field names and values into nice readable forms.
*
* @param string $comment_line_name Meta field name.
* @param string $comment_line_value Value of meta item.
* @return array|false Array with two entries: the updates comment line name and updated comment line value. false if empty.
*
*/
public function pretty_meta_info( $comment_line_name, $comment_line_value ) {
if ( $comment_line_name == 'serial' ) {
$comment_line_name = 'Unique serial identifier';
} elseif ( $comment_line_name == 'siteurl' ) {
$comment_line_name = 'Site URL';
} elseif ( $comment_line_name == 'type' ) {
$comment_line_name = 'Backup type';
if ( $comment_line_value == 'db' ) {
$comment_line_value = 'Database';
} elseif ( $comment_line_value == 'full' ) {
$comment_line_value = 'Full';
}
} elseif ( $comment_line_name == 'profile' ) {
$comment_line_name = 'Backup Profile';
} elseif ( $comment_line_name == 'created' ) {
$comment_line_name = 'Backup creation time';
if ( $comment_line_value != '' ) {
$comment_line_value = pb_backupbuddy::$format->date( $comment_line_value );
}
} elseif ( $comment_line_name == 'bb_version' ) {
$comment_line_name = 'BackupBuddy version at creation';
} elseif ( $comment_line_name == 'wp_version' ) {
$comment_line_name = 'WordPress version at creation';
} elseif ( $comment_line_name == 'dat_path' ) {
$comment_line_name = 'BackupBuddy data file (relative)';
} elseif ( $comment_line_name == 'note' ) {
$comment_line_name = 'User-specified note';
if ( $comment_line_value != '' ) {
$comment_line_value = '"' . htmlentities( $comment_line_value ) . '"';
}
} else {
$step_name = $step['function'];
}
if ( $comment_line_value != '' ) {
return array( $comment_line_name, $comment_line_value );
} else {
return false;
}
} // End pretty_meta_info().
/* alert_core_file_excludes()
*
* Outputs an alert warning if a core db table is excluded.
*
*/
public function alert_core_file_excludes( $excludes ) {
global $wpdb;
$prefix = $wpdb->prefix;
// If these tables are found excluded then warn that may be a bad idea.
$warn_tables = array(
$prefix . 'comments',
$prefix . 'posts',
$prefix . 'users',
$prefix . 'commentmeta',
$prefix . 'postmeta',
$prefix . 'term_relationships',
$prefix . 'options',
$prefix . 'term_taxonomy',
$prefix . 'links',
$prefix . 'terms',
);
$excludes_arr = explode( "\n", trim( $excludes ) );
foreach( $warn_tables as $warn_table ) {
if ( in_array( $warn_table, $excludes_arr ) ) {
pb_backupbuddy::disalert( 'excluding_coretable-' . md5( $excludes ), 'Warning You are excluding one or more core WordPress tables which may result in an incomplete backup. Remove exclusions or backup with another profile or method.' );
}
}
}
} // Emd Class pb_backupbuddy_core.
?>