' . wp_kses(
sprintf(
// translators: 1 A description of what updates are available (such as plugins, themes, or core).
__( 'The following updates are available: %1$s', 'boldgrid-backup' ),
$data['title']
),
[]
) . '
';
$this->content .= '
' .
wp_kses(
sprintf(
// translators: 1 An opening anchor tag to the update-core.php page, 2 its closing tag.
__( 'Not everything is up to date. %1$sFix this%2$s.', 'boldgrid-backup' ),
'',
''
),
[
'a' => [
'href' => [],
],
]
) .
'
';
} else {
$this->content = '
' . esc_html__( 'Everything is up to date!', 'boldgrid-backup' ) . '
';
}
}
}
admin/card/feature/class-timely-auto-updates.php 0000644 00000003411 14757772271 0015752 0 ustar 00
*/
namespace Boldgrid\Backup\Admin\Card\Feature;
/**
* Class: Timely_Auto_Updates.
*
* This class is responsible for rendering the, "Timely Auto Updates" feature on the BoldGrid.
* Backup Dashboard.
*
* @since 1.14.0
*/
class Timely_Auto_Updates extends \Boldgrid\Library\Library\Ui\Feature {
/**
* Init.
*
* @since 1.14.0
*/
public function init() {
$core = apply_filters( 'boldgrid_backup_get_core', null );
$this->icon = '';
$this->title = __( 'Timely Auto Updates', 'boldgrid-backup' );
// Determine whether or not this feature is enabled.
$auto_update_settings = $core->settings->get_setting( 'auto_update' );
$is_enabled = ! empty( $auto_update_settings['timely-updates-enabled'] );
if ( $is_enabled ) {
$this->content = '
' . esc_html__( 'Timely Auto Updates are enabled!', 'boldgrid-backup' ) . '
';
} else {
$this->content = '
' . esc_html__( 'By setting up Timely Auto Updates, you can have more control over when new updates are installed by WordPress.', 'boldgrid-backup' ) . '
';
$this->content .= '
' . wp_kses(
sprintf(
// translators: 1 Opening anchor tag to "Auto Updates" settings page, 2 its closing tag.
__( 'Timely Auto Updates are not enabled. %1$sFix this%2$s.', 'boldgrid-backup' ),
'',
''
),
[ 'a' => [ 'href' => [] ] ]
) . '
' . esc_html__( 'A faster website means happier visitors and higher rankings on the search engines. Simply type in your website’s URL and receive detailed advice on making your site lightning fast.', 'boldgrid-backup' ) . '
' . esc_html__( 'There’s more waiting for you in BoldGrid Central. Download the full-featured community versions of ALL our plugins for FREE. It’s just a click away.', 'boldgrid-backup' ) . '
';
}
}
admin/card/feature/class-scheduled-backups.php 0000644 00000005471 14757772271 0015434 0 ustar 00
*/
namespace Boldgrid\Backup\Admin\Card\Feature;
/**
* Class: Scheduled_Backups
*
* This class is responsible for displaying the scheduled backups feature on this plugin's dashboard.
*
* @since 1.11.0
*/
class Scheduled_Backups extends \Boldgrid\Library\Library\Ui\Feature {
/**
* Init.
*
* @since 1.11.0
*/
public function init() {
$core = apply_filters( 'boldgrid_backup_get_core', null );
$this->icon = '';
$this->title = esc_html__( 'Scheduled Backups', 'boldgrid-backup' );
$cron = new \Boldgrid\Backup\Admin\Cron();
$backup_entry = $cron->get_entry( 'backup' );
/*
* If a user does not have backups scheduled, suggest they schedule them.
*
* As of 1.11.4, in addition to checking if a schedule is saved in the settings, we also ensure
* that the backup cron can be found. We need to check for the scenario in which the user has
* manually deleted the cron entry yet the settings say backups are scheduled.
*
* In some cases where the settings say backups are scheduled but the cron doesn't actually
* exist, false positives may be given or errors triggered. We may want to explore the idea
* of showing an admin notice. For now, if this scenario exists, the dashboard will tell the
* user to schedule backups, and resaving the settings will resave the cron entry.
*/
if ( $core->settings->has_scheduled_backups() && $backup_entry->is_set() ) {
$next_runtime = $backup_entry->get_next_runtime();
$this->content = '
' . wp_kses(
sprintf(
// Translators: 1 An opening span tag, 2 the date of the next backup, 3 its closing span tag.
__( 'Next backup in: %1$s%2$s%3$s', 'boldgrid-backup' ),
'',
human_time_diff( time(), $next_runtime ),
''
),
[
'span' => [
'class' => [],
'title' => [],
],
]
) . '
';
} else {
$this->content = '
' . esc_html__( 'It\'s easy to forget to make a backup. Schedule automatic backups so they\'re made for you.', 'boldgrid-backup' ) . '
';
$this->content .= '
' . wp_kses(
sprintf(
// translators: 1 An opening anchor tag to the settings page, 2 its closing tag.
__( 'Scheduled Backups not configured. %1$sFix this%2$s.', 'boldgrid-backup' ),
'',
''
),
[
'a' => [
'href' => [],
],
]
) . '
' . esc_html__( 'Unlock more features within BoldGrid Central, including Cloud WordPress Advanced Controls and Automated Website Speed Tests.', 'boldgrid-backup' ) . '
' . esc_html__( 'Gain access to all BoldGrid premium plugins and services. This includes Post and Page Builder Premium, which offers premium Blocks and native sliders.', 'boldgrid-backup' ) . '
' . wp_kses(
sprintf(
// translators: 1 A span displaying the Google Drive logo, 2 a span displaying the Amazon S3 logo.
esc_html__( '%3$s can store backups on %1$s and %2$s, restore individual files with just a click, and more!', 'boldgrid-backup' ),
'',
'',
BOLDGRID_BACKUP_TITLE . ' Premium'
),
[
'span' => [
'class' => [],
'title' => [],
],
]
) . '
' . __( 'Create a fully functional free WordPress demo in just a few clicks. Easily design, build, test and share your WordPress website with clients or teams.', 'boldgrid-backup' ) . '
';
}
}
admin/card/feature/class-central.php 0000644 00000002241 14757772271 0013466 0 ustar 00
*/
namespace Boldgrid\Backup\Admin\Card\Feature;
/**
* Class: Central
*
* This class is responsible for initializing a BoldGrid Central "feature" for use within a card.
*
* @since 1.11.0
*/
class Central extends \Boldgrid\Library\Library\Ui\Feature {
/**
* Init.
*
* @since 1.11.0
*/
public function init() {
$reseller = new \Boldgrid\Library\Library\Reseller();
$this->icon = '';
$this->title = esc_html__( 'BoldGrid Central', 'boldgrid-backup' );
$this->content = '
' . esc_html__( 'Manage your account, Run Automated Website Speed Tests, and more within BoldGrid Central.', 'boldgrid-backup' ) . '
' . esc_html__( 'With Auto Rollback, we can help fix your site if anything goes wrong while performing updates.', 'boldgrid-backup' ) . '
';
$this->content .= '
' .
wp_kses(
sprintf(
// translators: 1 An opening anchor tag to the "Auto Updates" settings page, 2 its closing tag.
__( 'Auto Rollback is not enabled. %1$sFix this%2$s.', 'boldgrid-backup' ),
'',
''
),
[ 'a' => [ 'href' => [] ] ]
) . '
';
}
}
}
admin/card/class-updates.php 0000644 00000002272 14757772271 0012054 0 ustar 00
*/
namespace Boldgrid\Backup\Admin\Card;
/**
* Class: Updates
*
* This class is responsible for rendering the "Update Management" card on this plugin's dashboard.
*
* @since 1.11.0
*/
class Updates extends \Boldgrid\Library\Library\Ui\Card {
/**
* Init.
*
* @since 1.11.0
*/
public function init() {
$core = apply_filters( 'boldgrid_backup_get_core', null );
$this->id = 'bgbkup_updates';
$this->title = esc_html__( 'Update Management', 'boldgrid-backup' );
$this->subTitle = esc_html__( 'Keep everything tidy and up to date.', 'boldgrid-backup' ); // phpcs:ignore WordPress.NamingConventions.ValidVariableName.NotSnakeCaseMemberVar
$this->icon = '';
$this->features = [
new Feature\Versions(),
new Feature\Auto_Rollback(),
new Feature\Auto_Update_Backup(),
];
if ( $core->config->get_is_premium() ) {
$this->features[] = new Feature\Timely_Auto_Updates();
}
}
}
admin/card/class-timely-auto-updates.php 0000644 00000002255 14757772271 0014324 0 ustar 00
*/
namespace Boldgrid\Backup\Admin\Card;
/**
* Class: Timely Auto Updates
*
* This class is responsible for rendering the "Timely Auto Updates" card on this plugin's Premium Features page.
*
* @since 1.14.0
*/
class Timely_Auto_Updates extends \Boldgrid\Library\Library\Ui\Card {
/**
* Init.
*
* @since 1.14.0
*/
public function init() {
$this->id = 'bgbkup_timely_auto_updates';
$this->title = esc_html__( 'Timely Auto Updates', 'boldgrid-backup' );
$this->footer = '
' .
esc_html__(
'Gives you more control over when new updates are installed by WordPress\' Automatic Updates.',
'boldgrid-backup' ) .
'
';
$url = esc_url( 'https://www.boldgrid.com/support/total-upkeep/timely-auto-updates/' );
$this->links = '
' .
esc_html__( 'Setup Guide', 'boldgrid-backup' ) . '
';
$this->icon = '';
}
}
admin/card/class-premium.php 0000644 00000003750 14757772271 0012067 0 ustar 00
*/
namespace Boldgrid\Backup\Admin\Card;
/**
* Class: Premium
*
* This class is responsible for rendering the "Premium" card on this plugin's dashboard.
*
* @since 1.11.0
*/
class Premium extends \Boldgrid\Library\Library\Ui\Card {
/**
* Init.
*
* @since 1.11.0
*/
public function init() {
$core = apply_filters( 'boldgrid_backup_get_core', null );
$api_key = apply_filters( 'Boldgrid\Library\License\getApiKey', '' ); // phpcs:ignore
$this->id = 'bgbkup_get_premium';
$this->icon = '';
$features = [];
if ( empty( $api_key ) ) {
$this->title = esc_html__( 'BoldGrid Central', 'boldgrid-backup' );
$this->subTitle = esc_html__( 'All the tools and services you need to succeed.', 'boldgrid-backup' ); // phpcs:ignore WordPress.NamingConventions.ValidVariableName.NotSnakeCaseMemberVar
$this->features = [
new Feature\Cloud_Wordpress(),
new Feature\Speed_Coach(),
new Feature\Sign_Up(),
];
} elseif ( ! $core->config->get_is_premium() ) {
$this->title = esc_html__( 'Enjoying your free account?', 'boldgrid-backup' );
$this->subTitle = esc_html__( 'We hope so. There\'s more available by upgrading now!', 'boldgrid-backup' ); // phpcs:ignore WordPress.NamingConventions.ValidVariableName.NotSnakeCaseMemberVar
$this->features = [
new Feature\More_Backup(),
new Feature\More_Boldgrid(),
new Feature\More_Central(),
];
} else {
$this->title = esc_html__( 'BoldGrid Premium', 'boldgrid-backup' );
$this->subTitle = esc_html__( 'Thank you for running BoldGrid Premium!', 'boldgrid-backup' ); // phpcs:ignore WordPress.NamingConventions.ValidVariableName.NotSnakeCaseMemberVar
$this->features = [
new Feature\Central(),
];
}
}
}
admin/card/class-plugin-editor-tools.php 0000644 00000003153 14757772271 0014326 0 ustar 00
*/
namespace Boldgrid\Backup\Admin\Card;
/**
* Class: Plugin_Editor_Tools.
*
* This class is responsible for rendering the "Plugin Editor Tools".
* card on this plugin's Premium Features Page.
*
* @since 1.13.0
*/
class Plugin_Editor_Tools extends \Boldgrid\Library\Library\Ui\Card {
/**
* Init.
*
* @since 1.13.0
*/
public function init() {
$this->id = 'bgbkup_plugin_editor_tools';
$this->title = esc_html__( 'Plugin Editor Tools', 'boldgrid-backup' );
$this->icon = '';
$this->footer = '
' .
esc_html__(
'When using the WordPress Plugin Editor, Total Upkeep Premium will save a copy of the file in case you need to undo any changes.',
'boldgrid-backup'
) .
'
';
$url = 'https://www.boldgrid.com/support/total-upkeep/plugin-editor-backup/?source=plugin-editor-tools';
$video = 'https://www.youtube.com/embed/Nb0AFEXpE00?controls=1&autoplay=1&modestbranding=1&width=560&height=315&KeepThis=true&TB_iframe=true';
$this->links = '
' .
esc_html__( 'Learn More' ) .
'' .
esc_html__( 'Setup Guide' ) . '
';
}
}
admin/card/class-one-click-restoration.php 0000644 00000003103 14757772271 0014614 0 ustar 00
*/
namespace Boldgrid\Backup\Admin\Card;
/**
* Class: One_Click_Restoration.
*
* This class is responsible for rendering the "One Click Restoration" card.
* on this plugin's Premium Features Page.
*
* @since 1.13.0
*/
class One_Click_Restoration extends \Boldgrid\Library\Library\Ui\Card {
/**
* Init.
*
* @since 1.13.0
*/
public function init() {
$this->id = 'bgbkup_one_click_restoration';
$this->title = esc_html__( 'One Click File Restorations', 'boldgrid-backup' );
$this->icon = '';
$this->footer = '
' .
esc_html__(
'Restore a single file within the backup browser. Helpful when modifying individual files.',
'boldgrid-backup'
) .
'
';
$url = 'https://www.boldgrid.com/support/total-upkeep/individual-file-restorations/?source=one-click-restore';
$video = 'https://www.youtube.com/embed/r2VCQ-9fQP8?controls=1&autoplay=1&modestbranding=1&width=560&height=315&KeepThis=true&TB_iframe=true';
$this->links = '
' .
esc_html__( 'Learn More' ) .
'' .
esc_html__( 'Setup Guide' ) . '
';
}
}
admin/card/class-history.php 0000644 00000003033 14757772271 0012104 0 ustar 00
*/
namespace Boldgrid\Backup\Admin\Card;
/**
* Class: History.
*
* This class is responsible for rendering the "History" card on this plugin's.
* Premium Features Page.
*
* @since 1.13.0
*/
class History extends \Boldgrid\Library\Library\Ui\Card {
/**
* Init.
*
* @since 1.13.0
*/
public function init() {
$this->id = 'bgbkup_history';
$this->title = esc_html__( 'Update History', 'boldgrid-backup' );
$this->icon = '';
$this->footer = '
' .
esc_html__(
'View a running log of significant actions to your WordPress site, including which users updated a plugin, theme, or WordPress itself.',
'boldgrid-backup'
) .
'
';
$url = 'https://www.boldgrid.com/support/total-upkeep/backup-changed-files-history/?source=update-history';
$video = 'https://www.youtube.com/embed/kaeb30pYPYU?controls=1&autoplay=1&modestbranding=1&width=560&height=315&KeepThis=true&TB_iframe=true';
$this->links = '
' .
esc_html__( 'Learn More' ) .
'' .
esc_html__( 'Setup Guide' ) . '
';
}
}
admin/card/class-historical-versions.php 0000644 00000003070 14757772271 0014413 0 ustar 00
*/
namespace Boldgrid\Backup\Admin\Card;
/**
* Class: Historical_Versions.
*
* This class is responsible for rendering the "Historical Versions" card on this.
* plugin's Premium Features Page.
*
* @since 1.13.0
*/
class Historical_Versions extends \Boldgrid\Library\Library\Ui\Card {
/**
* Init.
*
* @since 1.13.0
*/
public function init() {
$this->id = 'bgbkup_historical_versions';
$this->title = esc_html__( 'Historical Versions', 'boldgrid-backup' );
$this->icon = '';
$this->footer = '
' .
esc_html__(
'Search through all backup archives for a particular, individual file and restore it.',
'boldgrid-backup'
) .
'
';
$url = 'https://www.boldgrid.com/support/total-upkeep/restore-historical-files/?source=historical-versions';
$video = 'https://www.youtube.com/embed/wGda86tdScg?controls=1&autoplay=1&modestbranding=1&width=560&height=315&KeepThis=true&TB_iframe=true';
$this->links = '
' .
esc_html__( 'Learn More' ) .
'' .
esc_html__( 'Setup Guide' ) . '
';
}
}
admin/card/class-google-drive.php 0000644 00000003051 14757772271 0012766 0 ustar 00
*/
namespace Boldgrid\Backup\Admin\Card;
/**
* Class: Google Drive.
*
* This class is responsible for rendering the "Google drive" card on this.
* plugin's Premium Features Page.
*
* @since 1.13.0
*/
class Google_Drive extends \Boldgrid\Library\Library\Ui\Card {
/**
* Init.
*
* @since 1.13.0
*/
public function init() {
$this->id = 'bgbkup_google_drive';
$this->title = esc_html__( 'Google Drive', 'boldgrid-backup' );
$this->icon = '';
$this->footer = '
' .
esc_html__(
'Keep your backup archives safe and secure with remote, automated backups to Google Drive.',
'boldgrid-backup'
) .
'
' .
esc_html__(
'Search for all files modified within a certain time period. You can also look for other versions of that file within your backups.',
'boldgrid-backup'
) .
'
';
$url = esc_url( 'https://www.boldgrid.com/support/total-upkeep/additional-tools/' );
$this->links = '
' .
esc_html__( 'Setup Guide' ) . '
';
}
}
admin/card/class-dream-objects.php 0000644 00000003103 14757772271 0013120 0 ustar 00
*/
namespace Boldgrid\Backup\Admin\Card;
/**
* Class: Dream_Objects.
*
* This class is responsible for rendering the "Dream Objects" card.
* on this plugin's Premium Features Page.
*
* @since 1.13.0
*/
class Dream_Objects extends \Boldgrid\Library\Library\Ui\Card {
/**
* Init.
*
* @since 1.13.0
*/
public function init() {
$this->id = 'bgbkup_dream_objects';
$this->title = esc_html__( 'DreamObjects', 'boldgrid-backup' );
$this->footer = '
' .
esc_html__(
'Safely store backups in the cloud via DreamObjects by DreamHost. Compatible with automated backups feature.',
'boldgrid-backup'
) .
'
';
$url = 'https://www.boldgrid.com/support/total-upkeep/dreamobjects-storage/?source=dreamobjects';
$video = 'https://www.youtube.com/embed/fJXnMq5JYi8?controls=1&autoplay=1&modestbranding=1&width=560&height=315&KeepThis=true&TB_iframe=true';
$this->links = '
' .
esc_html__( 'Learn More' ) .
'' .
esc_html__( 'Setup Guide' ) . '
';
$this->icon = '';
}
}
admin/card/class-database-encryption.php 0000644 00000003106 14757772271 0014340 0 ustar 00
*/
namespace Boldgrid\Backup\Admin\Card;
/**
* Class: Encryption.
*
* This class is responsible for rendering the "Encryption" card on this plugin's Premium Features page.
*
* @since 1.13.0
*/
class Database_Encryption extends \Boldgrid\Library\Library\Ui\Card {
/**
* Init.
*
* @since 1.13.0
*/
public function init() {
$this->id = 'bgbkup_database_encryption';
$this->title = esc_html__( 'Database Encryption', 'boldgrid-backup' );
$this->footer = '
' .
esc_html__(
'Provides another level of protection by preventing unauthorized access to your database backup archives.',
'boldgrid-backup'
) .
'
';
$url = 'https://www.boldgrid.com/support/total-upkeep/encrypt-database-backups/?source=encrypt-database-backups';
$video = 'https://www.youtube.com/embed/Pwxous6_LKg?controls=1&autoplay=1&modestbranding=1&width=560&height=315&KeepThis=true&TB_iframe=true';
$this->links = '
' .
esc_html__( 'Learn More' ) .
'' .
esc_html__( 'Setup Guide' ) . '
';
$this->icon = '';
}
}
admin/card/class-backups.php 0000644 00000002134 14757772271 0012034 0 ustar 00
*/
namespace Boldgrid\Backup\Admin\Card;
/**
* Class: Backups.
*
* This class is responsible for rendering the "Backups" card on this plugin's dashboard.
*
* @since 1.11.0
*/
class Backups extends \Boldgrid\Library\Library\Ui\Card {
/**
* Init.
*
* @since 1.11.0
*/
public function init() {
$this->id = 'bgbkup_backups';
$this->title = esc_html__( 'Backups', 'boldgrid-backup' );
$this->subTitle = esc_html__( 'It\'s website insurance. Make sure you have a backup.', 'boldgrid-backup' ); // phpcs:ignore WordPress.NamingConventions.ValidVariableName
$this->icon = '';
$this->features = array(
new Feature\Scheduled_Backups(),
new Feature\Remote_Storage(),
);
if ( ! get_option( 'boldgrid_backup_settings' )['encrypt_db'] ) {
$this->features[] = new Feature\Database_Encryption();
}
}
}
admin/card/class-amazon-s3.php 0000644 00000003035 14757772271 0012215 0 ustar 00
*/
namespace Boldgrid\Backup\Admin\Card;
/**
* Class: Amazon_S3.
*
* This class is responsible for rendering the "Amazon S3" card on this plugin's Premium Features page.
*
* @since 1.13.0
*/
class Amazon_S3 extends \Boldgrid\Library\Library\Ui\Card {
/**
* Init.
*
* @since 1.13.0
*/
public function init() {
$this->id = 'bgbkup_amazon_s3';
$this->title = esc_html__( 'Amazon S3', 'boldgrid-backup' );
$this->footer = '
' .
esc_html__(
'Safely store backups in the cloud via Amazon S3. Compatible with automated remote backups feature.',
'boldgrid-backup'
) .
'
' ),
data = {
action: 'boldgrid_backup_browse_archive_file_actions',
security: $( '#bgbkup_archive_details_nonce' ).val(),
filename: $( '#filename' ).val(),
file: $tr.attr( 'data-dir' )
};
if ( ! expanded ) {
$newTr.css( 'background-color', $tr.css( 'background-color' ) ).insertAfter( $tr );
$dummyTr.insertAfter( $newTr );
$tr.attr( 'data-expanded', '1' );
$.post( ajaxurl, data, function( response ) {
if ( response.success !== undefined ) {
$newTr.find( 'td' ).html( response.data );
} else {
$newTr.find( 'td' ).html( boldgrid_backup_zip_browser.unknownError );
}
} ).error( function() {
$newTr.find( 'td' ).html( boldgrid_backup_zip_browser.unknownError );
} );
} else {
$tr
.next( 'tr' )
.remove()
.end()
.next( 'tr' )
.remove()
.end()
.attr( 'data-expanded', '0' );
}
};
/**
* @summary Handle the click of a folder.
*
* @since 1.5.3
*/
self.onClickFolder = function() {
var $a = $( this ),
$tr = $a.closest( 'tr' ),
dir = $tr.attr( 'data-dir' );
self.renderBrowser( dir );
};
/**
* @summary Handle the click of the "load archive browser" button.
*
* @since 1.6.0
*/
self.onClickLoadBrowser = function() {
$( this ).attr( 'disabled', 'disabled' );
self.renderBrowser( '.' );
};
/**
* @summary Handle the click of the "restore this database" button.
*
* @since 1.6.0
*/
self.onClickRestoreDb = function() {
var $a = $( this ),
$p = $a.closest( 'p' ),
$spinner = $a.next(),
data = {
action: 'boldgrid_backup_browse_archive_restore_db',
security: $( '#bgbkup_archive_details_nonce' ).val(),
filename: $( '#filename' ).val(),
file: $a.attr( 'data-file' )
},
confirmation,
status = ' Restoring';
confirmation = confirm( boldgrid_backup_zip_browser.confirmDbRestore );
if ( ! confirmation ) {
return false;
}
$p.empty().html( status );
$a.attr( 'disabled', 'disabled' );
$spinner.addClass( 'inline middle' );
$.post( ajaxurl, data, function( response ) {
location.reload();
} ).error( function() {
location.reload();
} );
return false;
};
/**
* @summary Handle the postbox-like toggle on thead th's that hide a table.
*
* @since 1.6.0
*/
self.onClickToggle = function() {
var $toggle = $( this ),
$tbody = $toggle.closest( 'table' ).find( 'tbody' );
$toggle.toggleClass( 'closed' );
if ( $toggle.hasClass( 'closed' ) ) {
$tbody.hide();
} else {
$tbody.show();
}
};
/**
* @summary Handle the click of the "View details" button for a database.
*
* @since 1.6.0
*/
self.onClickViewDb = function() {
var $a = $( this ),
data = {
action: 'boldgrid_backup_browse_archive_view_db',
security: $( '#bgbkup_archive_details_nonce' ).val(),
filename: $( '#filename' ).val(),
file: $( '#dump_filename' ).val()
},
$details = $( '#db_details' ),
errorCallback;
// Only render the view once.
if ( 'true' === $details.attr( 'data-rendered' ) ) {
return;
}
$details.attr( 'data-rendered', 'true' );
$a.attr( 'disabled', 'disabled' );
$details.html( loading );
errorCallback = function() {
$details.html( boldgrid_backup_zip_browser.unknownErrorNotice );
};
$.post( ajaxurl, data, function( response ) {
var success = response.success !== undefined && true === response.success,
fail = response.success !== undefined && false === response.success;
if ( success || fail ) {
$details.html( response.data );
} else {
errorCallback();
}
} ).error( errorCallback );
};
/**
* @summary Render breadcrumbs.
*
* @since 1.5.3
*
* @param string dir
*/
self.renderBreadcrumbs = function( dir ) {
var split,
$container = $zipBrowser.find( '.breadcrumbs' ),
html =
' ' +
boldgrid_backup_zip_browser.home +
' ',
dataDir = '';
dir = 'undefined' !== typeof dir ? dir.trim() : '/';
split = dir.split( '/' );
split.forEach( function( element ) {
if ( '' === element || '.' === element ) {
return;
}
dataDir += element + '/';
html += ' / ' + element + '';
} );
$container.html( html );
};
/**
* @summary Render the archive browser.
*
* @since 1.5.3
*/
self.renderBrowser = function( dir ) {
var data,
colspan = $listing.find( 'thead th' ).length;
dir = 'undefined' !== typeof dir ? dir : '.';
$zipBrowser.show();
data = {
action: 'boldgrid_backup_browse_archive',
security: $( '#bgbkup_archive_details_nonce' ).val(),
filename: $( '#filename' ).val(),
dir: dir
};
self.renderBreadcrumbs( dir );
$listing.find( 'tbody' ).html( '
' + loading + '
' );
$.post( ajaxurl, data, function( response ) {
if ( response.success !== undefined ) {
$listing.html( response.data );
} else {
$listing.html( boldgrid_backup_zip_browser.unknownBrowseError );
}
} ).error( function() {
$listing.html( boldgrid_backup_zip_browser.unknownBrowseError );
} );
};
/**
* @summary Init.
*
* @since 1.5.3
*/
$( function() {
$( 'body' ).on( 'click', '.listing .folder', self.onClickFolder );
$( 'body' ).on( 'click', '.listing .file', self.onClickFile );
$( 'body' ).on( 'click', '.breadcrumbs a', self.onClickBreadcrumb );
$( 'body' ).on( 'click', '.restore-db', self.onClickRestoreDb );
$( 'body' ).on( 'click', '.view-db', self.onClickViewDb );
$( 'body' ).on( 'click', 'th .toggle-indicator', self.onClickToggle );
$( 'body' ).on( 'click', '.load-browser', self.onClickLoadBrowser );
self.renderBrowser( '.' );
} );
};
BoldGrid.ZipBrowser = new BoldGrid.ZipBrowser( jQuery );
admin/js/boldgrid-backup-admin-update-selectors.js 0000644 00000007121 14757772271 0016232 0 ustar 00 /**
* Update Selectors
*
* JavaScript for handling WordPress' native "update" buttons and links. Primary
* function is to disable "update" buttons when we're in the middle of making a
* backup.
*
* @since 1.6.0
*
* @param $ The jQuery object.
*/
/* global boldgrid_backup_admin_update_selectors,jQuery */
var BOLDGRID = BOLDGRID || {};
BOLDGRID.BACKUP = BOLDGRID.BACKUP || {};
( function( $ ) {
BOLDGRID.BACKUP.UpdateSelectors = {
lang: boldgrid_backup_admin_update_selectors,
$selectors: null,
selectors: [
// Plugins > Installed Plugins > "Apply" button for "Bulk Actions".
'#doaction',
'#doaction2',
// Plugins > Installed Plugins > Inline "update now" link on Plugins > Installed Plugins.
'.update-link',
// Dashboard > Updates > "Update Plugins" button.
'#upgrade-plugins',
'#upgrade-plugins-2',
// Dashboard > Updates > "Update" and "Re-install" WordPress button.
'#upgrade',
// Dashboard > Updates > "Update Themes" button.
'#upgrade-themes',
'#upgrade-themes-2',
// Dashboard > Customize > Change Themes > Inline "Update now" link.
// Customizer > Installed themes > "Update now" link.
'.themes .update-message .button-link',
// Dashboard > Customize > Changes Themes > Click a theme > "update now" link.
// Customizer > Installed themes > click a theme > "update now" link.
'#update-theme',
// Update Protection > "Backup Site Now" button.
'.notice #backup-site-now',
// Backup Archive > "Backup Site Now" button.
'.page-title-actions .page-title-action'
],
/**
* @summary Enable update selectors.
*
* @since 1.6.0
*/
enable: function() {
var self = BOLDGRID.BACKUP.UpdateSelectors;
self.setSelectors();
self.$selectors.each( function() {
var $el = $( this ),
$target;
$el.attr( 'disabled', false );
// See comment in self::disable().
$target = $el.is( 'a' ) ? $el.parent() : $el;
$target.attr( 'title', '' ).removeClass( self.lang.waitClass );
} );
},
/**
* @summary Disable update selectors.
*
* @since 1.6.0
*/
disable: function() {
/*
* Timeout is required because some "Update" links are added via the
* wp.template system and do not call a trigger to alert when they're
* done.
*/
setTimeout( function() {
var self = BOLDGRID.BACKUP.UpdateSelectors;
self.setSelectors();
self.$selectors.each( function() {
var $el = $( this ),
$target;
$el.attr( 'disabled', true );
/*
* Anchors behave differently. When you set an anchor to disabled,
* you cannot hover and see a title. For anchors, we'll temporarily
* adjust the parent instead.
*/
$target = $el.is( 'a' ) ? $el.parent() : $el;
$target.attr( 'title', self.lang.backupInProgress ).addClass( self.lang.waitClass );
} );
}, 250 );
},
/**
* @summary Init.
*
* @since 1.6.0
*/
init: function() {
$( 'body' ).on( 'boldgrid_backup_complete', $.proxy( this.enable, this ) );
$( 'body' ).on( 'boldgrid_backup_progress_notice_added', $.proxy( this.disable, this ) );
this.onInProgress();
},
/**
* @summary Actions to take when there is a backup in progress.
*
* @since 1.6.0
*/
onInProgress: function() {
if ( 1 === $( '.boldgrid-backup-in-progress' ).length ) {
this.disable();
}
},
/**
* @summary Set our $selectors, which are used to find "update" buttons.
*
* @since 1.6.0
*/
setSelectors: function() {
this.$selectors = $( this.selectors.join( ', ' ) );
}
};
$( function() {
BOLDGRID.BACKUP.UpdateSelectors.init();
} );
} )( jQuery );
admin/js/boldgrid-backup-admin-table-includes.js 0000644 00000006700 14757772271 0015644 0 ustar 00 /**
* Table include
*
* @summary JavaScript for handling table include settings.
*
* @since 1.6.0
*
* @param $ The jQuery object.
*/
/* global jQuery */
var BoldGrid = BoldGrid || {};
BoldGrid.TableInclude = function( $ ) {
'use strict';
var self = this,
$container = $( 'div#table_inclusion' ),
$includeTables = $container.find( '.include-tables [type="checkbox"]' ),
$type = $container.find( '[name="table_inclusion_type"]' ),
$configContainer = $container.find( '#table_inclusion_config' ),
// Buttons to include / exclude all.
$buttonAll = $container.find( '#include_all_tables, .include-all' ),
$buttonNone = $container.find( '#exclude_all_tables' ),
// Defaults are the status messages indicating default settings used.
$yesDefault = $container.find( '.yes-default' ),
$noDefault = $container.find( '.no-default' );
/**
* @summary Action to take when the type (full / custom) has been changed.
*
* @since 1.6.0
*
* @param typeInput The type input element clicked in the toggle.
*/
self.onChangeType = function( typeInput ) {
self.toggleConfig( typeInput );
};
/**
* @summary Toogle all database tables so they are all backed up.
*
* @since 1.6.0
*/
self.toggleAll = function() {
$includeTables.bgbuDrawAttention();
$includeTables.prop( 'checked', true );
self.toggleStatus();
return false;
};
/**
* @summary Toggle the area that allows you to choose which tables to backup.
*
* @since 1.6.0
*
* @param typeInput The type input element clicked in the toggle.
*/
self.toggleConfig = function( typeInput ) {
var type = $( typeInput )
.filter( ':checked' )
.val();
if ( 'full' === type ) {
$configContainer.hide();
} else if ( 'custom' === type ) {
$configContainer.show();
}
};
/**
* @summary Deselect all tables.
*
* @since 1.6.0
*/
self.toggleNone = function() {
$includeTables.bgbuDrawAttention();
$includeTables.prop( 'checked', false );
self.toggleStatus();
return false;
};
/**
* Update Values
*
* @since 1.6.0
*
* @param eventTarget The target of the triggering event.
* @param $container The set of container divs.
*/
self.updateValues = function( eventTarget, $container ) {
var name = $( eventTarget ).attr( 'name' ),
value = $( eventTarget ).val(),
type = $( eventTarget ).attr( 'type' );
if ( 'radio' == type || 'checkbox' == type ) {
$container
.find( 'input[name="' + name + '"][value="' + value + '"]' )
.prop( 'checked', $( eventTarget ).prop( 'checked' ) );
} else {
$container.find( 'input[name=' + name + ']' ).val( value );
}
};
/**
* @summary Toogle the status that tells the user if they're backing up all tables.
*
* @since 1.6.0
*/
self.toggleStatus = function() {
var allIncluded = $includeTables.length === $includeTables.filter( ':checked' ).length;
if ( allIncluded ) {
$yesDefault.show();
$noDefault.hide();
} else {
$yesDefault.hide();
$noDefault.show();
}
};
$( function() {
$buttonAll.on( 'click', self.toggleAll );
$buttonNone.on( 'click', self.toggleNone );
self.toggleStatus();
$type.each( function() {
self.toggleConfig( this );
} );
$type.on( 'change', function() {
self.onChangeType( this );
} );
$container.find( 'input' ).each( function() {
$( this ).on( 'input', function() {
self.updateValues( this, $container );
} );
} );
$includeTables.on( 'change', self.toggleStatus );
} );
};
new BoldGrid.TableInclude( jQuery );
admin/js/boldgrid-backup-admin-settings.js 0000644 00000017776 14757772271 0014630 0 ustar 00 /**
* Settings page
*
* @summary JavaScript for the settings page.
*
* @since 1.0
*
* @param $ The jQuery object.
*/
/* global ajaxurl,bglibLicense,BOLDGRID,jQuery */
var BoldGrid = BoldGrid || {};
BoldGrid.Settings = function( $ ) {
'use strict';
// General Variables.
var self = this,
$scheduleDow,
$noBackupDays,
$useSparingly,
$backupDir,
$body = $( 'body' ),
tb_unload_count,
$moveBackups,
$siteCheck;
/**
* Directory to store backups.
*
* @since 1.3.6
*/
$backupDir = $( '#backup-directory-path' );
// Define a context selector for schedule-dow.
$scheduleDow = $( '.schedule-dow' );
// Define a context selector for no-backup-days.
$noBackupDays = $( '#no-backup-days' );
/**
* Message asking user if we should move their backups.
*
* @since 1.3.6
*/
$moveBackups = $( '#move-backups' );
/**
* @summary Number of times tb_unload has been triggered.
*
* When a thickbox is closed, tb_unload is called twice. We need to keep
* track of how many times it's been called so that we know to only run our
* callback once.
*
* @since 1.5.2
*/
tb_unload_count = 0;
/**
* Message describing resource usage.
*
* @since 1.3.1
*/
$useSparingly = $( '#use-sparingly' );
/**
* @summary Take action when the user clicks Check again.
*
* The user is checking their license status again.
*
* @since 1.6.0
*/
self.onClickCheckAgain = function() {
var $button = $( this ),
$parent = $button.parent(),
$licenseString = $parent.find( '#license_string' ),
$reloadMessage = $( '#license_reload_page' ),
$spinner = $parent.find( '.spinner' ),
successFunction,
errorFunction;
$spinner.show();
$licenseString.empty();
errorFunction = function( response ) {
var error =
response !== undefined && response.data !== undefined && response.data.string !== undefined ?
response.data.string :
bglibLicense.unknownError;
$spinner.hide();
$licenseString.html( error );
};
successFunction = function( response ) {
if (
true !== response.success ||
response.data === undefined ||
response.data.string === undefined
) {
errorFunction( response );
return;
}
$spinner.hide();
$licenseString.html( response.data.string );
if ( response.data.isPremium ) {
$reloadMessage.removeClass( 'hidden' );
}
};
BOLDGRID.LIBRARY.License.clear( 'boldgrid-backup', successFunction, errorFunction );
return false;
};
/**
* @summary Action to take when a remote storage provider has been clicked.
*
* Primary function is to flag the clicked provider with the active class.
*
* @since 1.5.2
*/
self.on_click_provider = function() {
var $a = $( this ),
$tr = $a.closest( 'tr' ),
$table = $a.closest( 'table' );
$table.find( 'tr' ).removeClass( 'active' );
/*
* We add the active class so that we can identify the provider that is
* being updated.
*/
$tr.addClass( 'active' );
};
/**
* @summary Action to take when the thickbox is closed.
*
* @since 1.5.2
*/
self.on_tb_unload = function() {
tb_unload_count++;
// Only take action on the odd occurences of tb_unload.
if ( 0 === tb_unload_count % 2 ) {
return;
}
self.refresh_storage_configuration();
};
/**
* @summary Refresh remote storage provider summary.
*
* For example, if Amazon S3 was unconfigured, an applicable message will
* show. After being configured, the "unconfigured" message needs to be
* updated.
*
* @since 1.5.2
*/
self.refresh_storage_configuration = function() {
var $tr = $( '#storage_locations tr.active:not(.refreshing)' ),
$td_configure = $tr.find( 'td.configure' ),
data = {
action: 'boldgrid_backup_is_setup_' + $tr.attr( 'data-key' ),
security: $( '#bgbkup_settings_nonce' ).val()
},
$new_tr;
$tr.addClass( 'refreshing' );
$td_configure.html( '' );
$.post( ajaxurl, data, function( response ) {
$new_tr = $( response.data );
$tr.replaceWith( $new_tr );
self.toggleNoStorage();
} );
};
/**
* @summary Check if any days of the week selected.
*
* @since 1.0
*/
self.scheduleDowChecked = function() {
// Define vars.
var isDowChecked = false;
if ( $scheduleDow.find( 'input' ).is( ':checked' ) ) {
isDowChecked = true;
}
return isDowChecked;
};
/**
* @summary Toogle the move backups message.
*
* @since 1.3.6
*/
self.toggleMoveBackups = function() {
if ( $backupDir.val() === $backupDir.prop( 'defaultValue' ) ) {
$moveBackups.hide();
} else {
$moveBackups.show();
}
};
/**
* Toggle notice for no backup days selected.
*
* @since 1.0
*/
self.toggleNoBackupDays = function() {
// How many days of the week are checked?
var daysCount = $scheduleDow.find( ':checked' ).length;
/*
* If the user has selected more than 1 day under "Days of the Week", show a message about
* resource usage.
*
* @since 1.3.1
*/
if ( 1 < daysCount ) {
$useSparingly.show();
} else {
$useSparingly.hide();
}
if ( true === self.scheduleDowChecked() ) {
$noBackupDays.hide();
} else {
$noBackupDays.show();
}
};
/**
* @summary Toggle the warning about no backups if no storage selected.
*
* @since 1.5.2
*/
self.toggleNoStorage = function() {
var count_checked = $( '#storage_locations input[type="checkbox"]:checked' ).length,
$noStorage = $( '#no_storage' );
if ( 0 === count_checked ) {
$noStorage.show();
} else {
$noStorage.hide();
}
};
/**
* @summary Toggle site check options.
*
* @since 1.10.0
*/
self.toggleSiteCheck = function() {
if ( '1' === $siteCheck.filter( ':checked' ).val() ) {
// Site Check is enabled.
$( '#site-check-interval' ).prop( 'disabled', false );
$( 'input[name="site_check_logger"]' ).prop( 'disabled', false );
$( 'input[name="auto_recovery"]' ).prop( 'disabled', false );
$( '#notification-site-check' ).prop( 'disabled', false );
} else {
// Site Check is disabled.
$( '#site-check-interval' ).prop( 'disabled', true );
$( 'input[name="site_check_logger"]' ).prop( 'disabled', true );
$( 'input[name="auto_recovery"]' ).prop( 'disabled', true );
$( '#notification-site-check' ).prop( 'disabled', true );
}
};
self.toggleCompressionInfo = function() {
var isSystemZip = false,
compressorSelector = $( 'select[name="compressor"]' );
isSystemZip = 'system_zip' === $( compressorSelector ).val();
if ( isSystemZip ) {
$( '.compression-level' ).show();
} else {
$( '.compression-level' ).hide();
}
};
/**
* Toggle Cron Interval
*
* @summary Toggle the cron interval select element.
*
* @since 1.16.0
*/
self.toggleCronInterval = function() {
var $schedulerSelect = $( 'select[name="scheduler"]' ),
toggleInterval = function( val ) {
if ( 'cron' === val ) {
$( '#cron_interval' ).show();
} else {
$( '#cron_interval' ).hide();
}
};
toggleInterval( $schedulerSelect.find( 'option:selected' ).val() );
$schedulerSelect.on( 'change', function() {
toggleInterval(
$( this )
.find( 'option:selected' )
.val()
);
} );
};
// Onload event listener.
$( function() {
// Check if any days or the week are checked, toggle notice.
self.toggleNoBackupDays();
self.toggleNoStorage();
self.toggleCompressionInfo();
self.toggleCronInterval();
$body.on( 'click', '#storage_locations input[type="checkbox"]', self.toggleNoStorage );
$backupDir.on( 'input', self.toggleMoveBackups );
// On click action for days, check if any days or the week are checked,
// toggle notice.
$scheduleDow.on( 'click', self.toggleNoBackupDays );
$( window ).on( 'tb_unload', self.on_tb_unload );
$body.on( 'click', '#storage_locations .thickbox', self.on_click_provider );
$body.on( 'click', '#license_check_again', self.onClickCheckAgain );
$siteCheck = $( 'input[name="site_check"]' );
self.toggleSiteCheck();
$body.on( 'click', $siteCheck, self.toggleSiteCheck );
$( 'select[name="compressor"]' ).on( 'change', self.toggleCompressionInfo );
} );
};
BoldGrid.Settings( jQuery );
admin/js/boldgrid-backup-admin-settings-autoupdate.js 0000644 00000013330 14757772271 0016757 0 ustar 00 /**
* Auto update settings
*
* @summary JavaScript for the auto update settings.
*/
/* global ajaxurl,jQuery */
var BOLDGRID = BOLDGRID || {};
BOLDGRID.SETTINGS = BOLDGRID.SETTINGS || {};
( function( $ ) {
var self;
BOLDGRID.SETTINGS.AutoUpdate = {
/**
* Constructor.
*
* @since 1.7.0
*/
init: function() {
$( self._onLoad );
},
/**
* On DOM load.
*
* @since 1.7.0
*/
_onLoad: function() {
var $bgBox = $( '.bg-box' );
// Initialize jquery-toggles.
$bgBox.find( '.toggle' ).toggles( {
text: {
on: '',
off: ''
},
height: 15,
width: 40
} );
self._setMasterToggles();
$bgBox.find( '.toggle-group' ).on( 'click swipe contextmenu', self._toggleGroup );
$bgBox
.find( '.toggle' )
.not( '.toggle-group' )
.on( 'click swipe contextmenu', self._setMasterToggles );
$bgBox
.find( '.table-help td p' )
.attr( 'style', 'height: 0em; opacity: 0%; position: relative; z-index:-1' );
$bgBox
.find( '.div-table-body .dashicons-editor-help, .help-icon' )
.on( 'click', self._toggleHelp );
$bgBox.find( '.help-icon' ).css( 'cursor', 'pointer' );
$bgBox.find( '.bglib-collapsible-control' ).on( 'click', function() {
var target = $( this ).attr( 'data-target' );
$( target ).animate( { height: 'toggle', opacity: 'toggle' }, 'slow' );
$( this ).toggleClass( 'bglib-collapsible-open' );
} );
if ( true === $( '#timely-updates-disabled' ).prop( 'checked' ) ) {
$( '#timely-updates-days' ).prop( 'disabled', true );
$( '#timely-updates-days-hidden' ).prop( 'disabled', false );
}
$( 'input[name="auto_update[timely-updates-enabled]"]' ).change( function() {
if ( true === $( '#timely-updates-disabled' ).prop( 'checked' ) ) {
$( '#timely-updates-days' ).prop( 'disabled', true );
$( '#timely-updates-days-hidden' ).prop( 'disabled', false );
} else {
$( '#timely-updates-days' ).prop( 'disabled', false );
$( '#timely-updates-days-hidden' ).prop( 'disabled', true );
}
} );
},
/**
* Set inputs for toggles.
*
* @since 1.7.0
*/
_setInputs: function() {
var $bgBox = $( '.bg-box' ),
$wpcoreToggles = $bgBox.find( '.wpcore-toggle' ),
$pluginToggles = $bgBox.find( '.plugin-toggle' ),
$themeToggles = $bgBox.find( '.theme-toggle' ),
$pluginsDefault = $bgBox.find( '#toggle-default-plugins' ),
$themesDefault = $bgBox.find( '#toggle-default-themes' ),
$timelyUpdatesEnabled = $bgBox.find( '#timely-updates-enabled' ),
$timelyUpdatesDisabled = $bgBox.find( '#timely-updates-disabled' ),
$timelyUpdatesDays = $bgBox.find( '#timely-updates-days' );
// If the updates section is not in use, then just return.
if ( ! $pluginsDefault.data( 'toggles' ) ) {
return;
}
$wpcoreToggles.each( function() {
var $this = $( this );
var $thisInput = $this
.next( 'input' )
.attr( 'name', 'auto_update[wpcore][' + $this.data( 'wpcore' ) + ']' )
.val( $this.data( 'toggles' ).active ? 1 : 0 );
} );
$pluginToggles.each( function() {
var $this = $( this );
var $thisInput = $this
.next( 'input' )
.attr( 'name', 'auto_update[plugins][' + $this.data( 'plugin' ) + ']' )
.val( $this.data( 'toggles' ).active ? 1 : 0 );
} );
$themeToggles.each( function() {
var $this = $( this );
var $thisInput = $this
.next( 'input' )
.attr( 'name', 'auto_update[themes][' + $this.data( 'stylesheet' ) + ']' )
.val( $this.data( 'toggles' ).active ? 1 : 0 );
} );
$pluginsDefault.next( 'input' ).val( $pluginsDefault.data( 'toggles' ).active ? 1 : 0 );
$themesDefault.next( 'input' ).val( $themesDefault.data( 'toggles' ).active ? 1 : 0 );
},
/**
* Set master toggles.
*
* @since 1.7.0
*/
_setMasterToggles: function() {
var $masters = $( '.bg-box' ).find( '.toggle-group' );
$masters.each( function() {
var $master = $( this ),
state = true;
$master
.closest( '.div-table-body' )
.find( '.toggle' )
.not( '.toggle-group,#toggle-default-plugins,#toggle-default-themes' )
.each( function() {
if ( ! state || ! $( this ).data( 'toggles' ).active ) {
state = false;
}
} );
$master.toggles( state );
} );
self._setInputs();
},
/**
* Toggle an entire group on/off.
*
* @since 1.7.0
*/
_toggleGroup: function() {
var $this = $( this ),
$toggles = $this
.parent()
.parent()
.parent()
.find( '.toggle' )
.not( '#toggle-default-plugins,#toggle-default-themes' );
$toggles.toggles( $this.data( 'toggles' ).active );
self._setInputs();
},
/**
* Replace the notice with a clone when removed by dismissal.
*
* @since 1.7.0
*/
_replaceNotice: function( $notice ) {
var $noticeClone = $notice.clone(),
$noticeNext = $notice.next();
$notice.one( 'click.wp-dismiss-notice', '.notice-dismiss', function() {
$noticeNext.before( $noticeClone );
$notice = $noticeClone;
$notice.hide();
} );
},
/**
* Handle form submission.
*
* @since 1.7.0
*/
_toggleHelp: function( e ) {
var id = $( this ).attr( 'data-id' ),
target = $( '.table-help[data-id="' + id + '"]' );
e.preventDefault();
if ( id === undefined ) {
return false;
}
$( target ).toggleClass( 'show-help hide-help' );
$( '.table-help.show-help[data-id="' + id + '"] td p' ).animate(
{ height: '3em', opacity: '100%', 'z-index': 0 },
400
);
$( '.table-help.hide-help[data-id="' + id + '"] td p' ).animate(
{ height: '0em', opacity: '0%', 'z-index': -1 },
400
);
return false;
}
};
// eslint-disable-next-line vars-on-top
var self = BOLDGRID.SETTINGS.AutoUpdate;
BOLDGRID.SETTINGS.AutoUpdate.init();
} )( jQuery );
admin/js/boldgrid-backup-admin-rollback.js 0000644 00000025771 14757772271 0014553 0 ustar 00 /**
* Rollback notice
*
* @summary JavaScript for the rollback notice.
*
* @since 1.0
*/
/* global ajaxurl,boldgrid_backup_admin_rollback,pagenow,jQuery,wp */
// Declare namespace.
var BOLDGRID = BOLDGRID || {};
// Define sub-namespace.
BOLDGRID.BACKUP = BOLDGRID.BACKUP || {};
/**
* Rollback notice.
*
* @summary JavaScript for the rollback notice.
*
* @since 1.0
*
* @param $ The jQuery object.
*/
( function( $ ) {
'use strict';
// Onload event listener.
$( function() {
$( 'body' ).on( 'click', '#cancel-rollback-button', BOLDGRID.BACKUP.RollbackTimer.cancelRollback );
BOLDGRID.BACKUP.RollbackTimer.adjustOnAbout();
} );
/**
* Namespace BOLDGRID.BACKUP.RollbackTimer.
*
* @since 1.0
*/
BOLDGRID.BACKUP.RollbackTimer = {
// When we show a global notice in the customizer, it is identified by this code.
countdownCode: 'boldgrid-backup-countdown',
/**
* Cancel pending rollback.
*
* @since 1.0
*/
cancelRollback: function() {
// Declare variables.
var data,
cancelNonce,
wpHttpReferer,
errorCallback,
$cancelRollbackSection,
$cancelRollbackResults,
$rollbackSpinner,
$this = $( this ),
successCallBack;
// Disable the Cancel Rollback button.
$this.attr( 'disabled', 'disabled' ).css( 'pointer-events', 'none' );
// Create a context selector for the cancel rollback section.
$cancelRollbackSection = $( '#cancel-rollback-section' );
// Create a context selector for the cancel rollback results.
$cancelRollbackResults = $( '#cancel-rollback-results' );
// Create a context selector for the cancel rollback spinner.
$rollbackSpinner = $cancelRollbackSection.find( '.spinner' );
// Show the spinner.
$rollbackSpinner.addClass( 'is-active' );
$rollbackSpinner.css( 'display', 'inline-block' );
// Get the wpnonce and referer values.
cancelNonce = $cancelRollbackSection.find( '#cancel_rollback_auth' ).val();
wpHttpReferer = $cancelRollbackSection.find( '[name="_wp_http_referer"]' ).val();
// Create an error callback function.
errorCallback = function() {
// Show error message.
var markup =
'
There was an error processing your request. Please reload the page and try again.
';
$cancelRollbackResults.html( markup );
};
// Generate a data array for the download request.
data = {
action: 'boldgrid_cancel_rollback',
cancel_rollback_auth: cancelNonce,
_wp_http_referer: wpHttpReferer
};
/**
* Action to take when we successfully canceled the rollback.
*
* @since 1.6.0
*/
successCallBack = function( response ) {
// Remove the restore now section.
$( '[data-restore-now]' )
.parent()
.slideUp();
// Insert markup in the results section.
$cancelRollbackResults.html( response );
// Hide the cancel rollback section.
$cancelRollbackSection.slideUp();
if ( 'customize' === pagenow ) {
wp.customize.notifications.remove( BOLDGRID.BACKUP.RollbackTimer.countdownCode );
}
};
// Make the call.
$.ajax( {
url: ajaxurl,
data: data,
type: 'post',
dataType: 'text',
success: successCallBack,
error: errorCallback,
complete: function() {
// Hide the spinner.
$cancelRollbackSection.find( '.spinner' ).removeClass( 'is-active' );
}
} );
// Return false so the page does not reload.
return false;
},
/**
* Get the time remaining to an end time.
*
* @since 1.0
*
* @param string endTime A data/time parsed with Date.parse().
* @return array
*/
getTimeRemaining: function( endTime ) {
// Declare variables.
var totalSeconds, seconds, minutes;
// Parse data into seconds from now.
totalSeconds = Date.parse( endTime ) - Date.parse( new Date() );
// If totalSeconds is less than or equal to zero, then return zero array.
if ( 0 >= totalSeconds ) {
return {
total: 0,
minutes: '0',
seconds: '00'
};
}
// Calculate seconds, minutes, hours, days.
seconds = Math.floor( ( totalSeconds / 1000 ) % 60 );
minutes = Math.floor( totalSeconds / 1000 / 60 );
// Return the data in an array.
return {
total: totalSeconds,
minutes: minutes,
seconds: ( '0' + seconds ).slice( -2 )
};
},
/**
* Initialize a countdown timer, updating a DOM id.
*
* Uses BOLDGRID.BACKUP.RollbackTimer.deadline for the end time/deadline.
*
* @since 1.0
*
* @see getTimeRemaining().
* @see updateDeadline().
*
* @param string deadline
*/
initializeClock: function() {
// Define variables.
var $clock,
interval,
totalSeconds,
self = this;
// Get the element for the clock display.
$clock = $( '#rollback-countdown-timer' );
// Use an interval of 1 second to update the clock.
interval = setInterval( function() {
totalSeconds = self.getTimeRemaining( BOLDGRID.BACKUP.RollbackTimer.deadline );
// Update the clock display.
$clock.html( totalSeconds.minutes + ':' + totalSeconds.seconds );
// When the timer reaches zero, stop the countdown and disable the cancel button.
if ( 0 >= totalSeconds.total ) {
clearInterval( interval );
// Disable the Cancel Rollback button.
$( '#cancel-rollback-button' )
.attr( 'disabled', 'disabled' )
.css( 'pointer-events', 'none' );
}
}, 1000 );
},
/**
* If updating something, then update the timer deadline.
*
* @since 1.2
*/
updateDeadline: function() {
// Declare variables.
var $RollbackDeadline;
// Check for the deadline in the source (when completing updates in the admin section).
$RollbackDeadline = $( 'iframe' )
.contents()
.find( '#rollback-deadline' );
// Update the rollback timer.
if ( $RollbackDeadline.length ) {
BOLDGRID.BACKUP.RollbackTimer.deadline = $RollbackDeadline.text();
BOLDGRID.BACKUP.RollbackTimer.initializeClock();
}
},
/**
* If updating something, then update the timer deadline from the retrieved ISO time.
*
* @since 1.2.1
*/
getUpdatedDeadline: function() {
// Declare variables.
var $bulkActionForm, wpnonce, wpHttpReferer, data;
// Create a context selector for bulk-action-form.
$bulkActionForm = $( '#bulk-action-form' );
// Get the bulk-action-form wpnonce.
wpnonce = $bulkActionForm.find( '#_wpnonce' ).val();
// Get the bulk-action-form wpnonce.
wpHttpReferer = $bulkActionForm.find( '[name="_wp_http_referer"]' ).val();
// Use adminajax to get the updated deadline.
// Generate the data array.
data = {
action: 'boldgrid_backup_deadline',
_wpnonce: wpnonce,
_wp_http_referer: wpHttpReferer
};
// Make the call.
return $.ajax( {
url: ajaxurl,
data: data,
type: 'post',
dataType: 'text',
success: function( response ) {
// Update the rollback timer.
if ( response.length ) {
BOLDGRID.BACKUP.RollbackTimer.deadline = response;
}
/*
* Someone may be waiting to see if we have a deadline, let
* them know we're done.
*/
$( 'body' ).trigger( 'boldgrid-backup-have-deadline' );
}
} );
},
/**
* @summary Show the countdown notice.
*
* This method makes an ajax request to get the countdown notice. Useful
* when plugins / themes are updated via ajaxy.
*
* @since 1.6.0
*/
show: function() {
/*
* Show only one countdown.
*
* If there is already a countdown showing, abort. The user may be
* on the themes page updating themes, and if they update two themes,
* we don't want to show two countdown notices.
*/
if ( 0 < $( '.boldgrid-backup-countdown:visible' ).length ) {
return;
}
var data = {
action: 'boldgrid_backup_get_countdown_notice'
},
successCallback;
/**
* Action to take after getting the countdown notice.
*
* @since 1.6.0
*/
successCallback = function( response ) {
var $notice,
notification,
$headerEnd = $( '.wp-header-end' ),
$wrap = $( '.wrap' ).first();
if ( response.success !== undefined && true === response.success ) {
$( '.boldgrid-backup-protect-now, .boldgrid-backup-protected' ).slideUp();
$notice = $( response.data );
// Determine where and how to add the notice.
if ( 'customize' === pagenow ) {
notification = new wp.customize.Notification(
BOLDGRID.BACKUP.RollbackTimer.countdownCode,
{ message: $notice.removeClass( 'notice notice-warning' ).html(), type: 'warning' }
);
wp.customize.notifications.add( notification );
} else {
$notice.addClass( 'hidden' );
if ( 1 === $headerEnd.length ) {
$notice.insertAfter( $headerEnd );
} else {
$notice.prependTo( $wrap );
}
$notice.slideDown();
}
/*
* Allow the countdown to render (especially in the
* customizer) before initializing the clock.
*/
setTimeout( function() {
BOLDGRID.BACKUP.RollbackTimer.initializeClock();
}, 500 );
}
};
$.ajax( {
url: ajaxurl,
data: data,
type: 'post',
dataType: 'json',
success: successCallback
} );
},
/**
* @summary Show the countdown notice on the about page.
*
* WordPress hides all admin notices on the wp-admin/about.php page. The
* countdown notice is important enough to break this mold.
*
* @since 1.6.0
*/
adjustOnAbout: function() {
if ( 'about' !== pagenow ) {
return;
}
var $notice = $( '.notice.boldgrid-backup-countdown' );
$notice.css( 'display', 'block!important' ).insertBefore( '.wrap' );
},
/**
* If the rollback countdown timer is needed, then initialize the clock.
*
* @since 1.0
*
* @see initializeClock().
*/
init: function() {
// Declare vars.
var $document = $( document ),
haveDeadline;
// Determine whether or not we have a valid deadline.
haveDeadline =
'object' === typeof boldgrid_backup_admin_rollback &&
boldgrid_backup_admin_rollback.rolloutDeadline !== undefined &&
'1970' !== boldgrid_backup_admin_rollback.rolloutDeadline.slice( 0, 4 );
// If there is a defined rollout deadline, then initialize the timer.
if ( haveDeadline ) {
// Set the end time/deadline.
BOLDGRID.BACKUP.RollbackTimer.deadline = boldgrid_backup_admin_rollback.rolloutDeadline;
// Initialize the clock/timer.
this.initializeClock();
}
// When the update progress iframe loads, check for a new deadline.
$( 'iframe' ).on( 'load', this.updateDeadline );
// When a plugin is updated via adminajax, then get the new deadline and update the timer.
$document.on( 'wp-plugin-update-success', this.getUpdatedDeadline );
// When a theme is updated via adminajax, then get the new deadline and update the timer.
$document.on( 'wp-theme-update-success', this.getUpdatedDeadline );
$document.on( 'wp-plugin-update-success wp-theme-update-success', this.show );
}
};
// Initialize the deadline.
BOLDGRID.BACKUP.RollbackTimer.deadline = '';
// Initialize the rollback timer.
BOLDGRID.BACKUP.RollbackTimer.init();
} )( jQuery );
admin/js/boldgrid-backup-admin-logs.js 0000644 00000004365 14757772271 0013722 0 ustar 00 /**
* Backup Logs.
*
* @summary This file handles the displaying of log files.
*
* @since 1.12.5
*/
/* global jQuery */
var BOLDGRID = BOLDGRID || {};
BOLDGRID.BACKUP = BOLDGRID.BACKUP || {};
( function( $ ) {
'use strict';
var self;
/**
* Logs.
*
* @since 1.12.5
*/
BOLDGRID.BACKUP.Logs = {
/**
* i18n.
*
* @since 1.7.0
*
* @type object
*/
i18n: window.BoldGridBackupAdminLogs || {},
/**
* Init.
*
* @since 1.12.5
*/
init: function() {
self._onReady();
},
/**
* Steps to take when a log file is clicked on.
*
* @since 1.12.5
*/
onClickLog: function() {
var data = {
action: 'boldgrid_backup_view_log',
filename: $( this ).attr( 'data-filename' ),
nonce: $( '#bgbup_log_nonce' ).val()
};
/*
* Show a loading message in the thickbox modal.
*
* Thickbox has a few events, but "on open" is not one of them. The timeout is required
* to allow some time for the modal to open before we take action. In testing, a 1ms timeout
* worked. To be on the safe side, we're using 10ms.
*/
setTimeout( function() {
$( '#TB_window' ).addClass( 'bg-full-screen' );
$( '#TB_ajaxContent' ).html(
'
' +
self.i18n.loading +
'
'
);
}, 10 );
$.post( ajaxurl, data, function( response ) {
$( '#TB_ajaxContent' ).html( response.data );
} ).fail( function( jqXHR ) {
/*
* @todo This error message could use some work. For 500 errors, WordPress will return
* "There has been a critical error on this website. Learn more about debugging in WordPress."
* Show an "unknown error" and have the user contact BoldGrid for help rather than send
* the user off learning about debugging.
*/
var error = jqXHR.status + ' ' + jqXHR.statusText + ': ' + self.i18n.unknownError;
$( '#TB_ajaxContent' ).html( '
' + error + '
' );
} );
},
/**
* On ready.
*
* @since 1.7.0
*/
_onReady: function() {
$( function() {
$( '#section_logs a[data-filename]' ).on( 'click', self.onClickLog );
} );
}
};
self = BOLDGRID.BACKUP.Logs;
} )( jQuery );
BOLDGRID.BACKUP.Logs.init();
admin/js/boldgrid-backup-admin.js 0000644 00000013132 14757772271 0012750 0 ustar 00 /**
* This file contains javascript to load on all admin pages of the plugin
*
* @summary JS for all admin backup pages.
*
* @since 1.3.1
*/
/* global jQuery,pagenow, BoldGridBackupAdmin */
var BoldGrid = BoldGrid || {};
BoldGrid.Backup = function( $ ) {
var self = this;
/**
* @summary Handle the click of help buttons.
*
* @since 1.3.1
*/
this.bindHelpClick = function() {
$( 'body' ).on( 'click', '.dashicons-editor-help', function() {
var id = $( this ).attr( 'data-id' );
// If we don't have a data-id, abort.
if ( id === undefined ) {
return;
}
// Toggle the help text.
$( '.help[data-id="' + id + '"]' ).slideToggle();
} );
};
/**
* @summary Remove WordPress' important notice about backups.
*
* We're already adding our own notice, no need to have 2 notices.
*
* @since 1.5.3
*/
self.hideBackupNotice = function() {
if ( pagenow === undefined || 'update-core' !== pagenow ) {
return;
}
$( 'a[href*="WordPress_Backups"]' )
.closest( '.notice' )
.remove();
};
/**
* @summary Handle the clicking of a show / hide toggle.
*
* In the example below, the show / hide link has a data-bgbkup-toggle-target attr
* that helps to identify the element to toggle.
* # Show
* #
*
* @since 1.6.0
*/
self.onClickToggle = function() {
var $e = $( this ),
show = 'Show',
hide = 'Hide',
target = $e.attr( 'data-bgbkup-toggle-target' ),
$target = $( target ),
isVisible = $target.is( ':visible' );
if ( isVisible ) {
$target.slideUp();
$e.html( show );
} else {
$target.slideDown();
$e.html( hide );
}
return false;
};
/**
* @summary Make an admin notice dismissible.
*
* This is a core WordPress function copied from wp-admin/js/common.js.
*
* Unfortunately this function cannot be called upon at will. If we dynamically
* add a notice and it includess the is-dismissible class, then we'll need
* to actually make it dismissible.
*
* As of WordPress 5.5, automatically included l10n classes have been removed
* Therefore we have to defer to using i18n. Additionally this function is no
* longer included in wp-admin/js/common.js
*
* @since 1.6.0
*/
self.makeNoticesDismissible = function() {
$( '.notice.is-dismissible' ).each( function() {
var $el = $( this ),
$button = $(
''
),
btnText = 'undefined' !== typeof commonL10n ? commonL10n.dismiss : wp.i18n.__( 'dismiss' );
// Ensure plain text
$button.find( '.screen-reader-text' ).text( btnText );
$button.on( 'click.wp-dismiss-notice', function( event ) {
event.preventDefault();
$el.fadeTo( 100, 0, function() {
$el.slideUp( 100, function() {
$el.remove();
} );
} );
} );
$el.append( $button );
} );
};
$( function() {
self.bindHelpClick();
self.hideBackupNotice();
self.updatePremiumLink();
$( 'body' ).on( 'click', '[data-bgbkup-toggle-target]', self.onClickToggle );
$( 'body' ).on( 'make_notices_dismissible', self.makeNoticesDismissible );
/*
* Remove temporary "page loading" messages.
*
* Some pages may take a few moments to render. For example, when checking
* ftp credentials, it may take ~3 seconds. We give the user a message,
* "Checking credentials", and then remove this notices afterwards by
* removing anything with a bgbu_remove_load class.
*/
$( '.bgbu-remove-load' ).remove();
} );
/**
* @summary Open submenu "Get Premium" link in a new tab.
*
* WordPress does not have a way to configure dashboard menu items to open
* in a new tab, so we'll handle it via js.
*
* @since 1.6.0
*/
self.updatePremiumLink = function() {
$( '#adminmenu' )
.find( 'a[href="' + BoldGridBackupAdmin.get_premium_url + '"]' )
.attr( 'target', '_blank' );
};
};
BoldGrid.Backup( jQuery );
/**
* @summary Draw attention to an element.
*
* @since 1.6.0
*/
jQuery.fn.bgbuDrawAttention = function() {
var currentColor,
// In seconds, minimum time between each animation.
animateInterval = 1 * 1000,
d = new Date(),
lastAnimation = this.attr( 'data-last-animation' );
this.attr( 'data-last-animation', d.getTime() );
// If we are currently animating this element, return.
if ( this.parent().hasClass( 'ui-effects-wrapper' ) ) {
return;
}
// If enough time hasn't passed yet since the last animation, return.
if ( lastAnimation && d.getTime() - lastAnimation < animateInterval ) {
return;
}
if ( this.is( 'input' ) ) {
this.css( 'background', '#ddd' ).animate( { backgroundColor: '#fff' }, 500 );
} else if ( this.is( '.dashicons-editor-help' ) ) {
this.effect( 'bounce', { times: 2 }, 'normal' );
} else if ( this.is( 'span' ) ) {
/*
* Get the original color to animate back to. This is needed because if
* the user clicks on an element that is in the middle of an animation,
* the current color will not be the original.
*/
if ( ! this.attr( 'data-original-color' ) ) {
this.attr( 'data-original-color', this.css( 'color' ) );
}
currentColor = this.attr( 'data-original-color' );
this.css( 'color', '#fff' ).animate( { color: currentColor }, 500 );
}
};
/**
* @summary Disable all actions found within an element (a, buttons, etc).
*
* For example, if we click "restore" on a page, we want to disable all other
* actions within the wpwrap (IE can't restore and delete at the same time).
*
* @since 1.6.0
*/
jQuery.fn.bgbuDisableActions = function() {
this.find( 'a, [type="submit"]' ).attr( 'disabled', 'disabled' );
};
admin/js/boldgrid-backup-admin-in-progress.js 0000644 00000044622 14757772271 0015226 0 ustar 00 /**
* Backup In Progress Bar
*
* @summary This file handles the "In progress" bar for when a backup is in progress.
*
* @since 1.7.0
*/
/* global jQuery,wp */
var BOLDGRID = BOLDGRID || {};
BOLDGRID.BACKUP = BOLDGRID.BACKUP || {};
( function( $ ) {
'use strict';
var self;
/**
* Suggest starter content.
*
* @since 1.7.0
*/
BOLDGRID.BACKUP.InProgress = {
/**
* Whether or not there's an "In progress" notice on the page.
*
* @since 1.11.2
*
* @type bool
*/
hasProgressNotice: false,
/**
* Whether or not there's an "Update Protection" notice on the page.
*
* @since 1.11.2
*
* @type bool
*/
hasProtectionNotice: false,
/**
* The number of times our ajax call has said yes, is done.
*
* This is used to help prevent a race condition. Before showing results, we let the is done
* count reach 2 so that all processes can finish and we ensure we have the appropriate error
* message, if any.
*
* @since 1.14.13
*
* @type int
*/
isDoneCount: 0,
/**
* Label.
*
* @since 1.7.0
*
* @type string
*/
$label: null,
/**
* In progress notice.
*
* @since 1.7.0
*
* @type string
*/
$inProgressNotice: null,
/**
* i18n.
*
* @since 1.7.0
*
* @type object
*/
i18n: window.BoldGridBackupAdminInProgress || {},
/**
* The Update Protection notice.
*
* @since 1.11.2
*
* @type string
*/
$protectionNotice: null,
/**
* Init.
*
* @since 1.7.0
*/
init: function() {
self._onReady();
},
/**
* Init our protection notice variables.
*
* Prior to @1.14.13, this code lived within the _onReady. It has since been moved here
* so that it may be called within the customizer. The Protection notice is added via ajax in
* the Customizer, and we cannot set these values accurately within the _onReady.
*/
initProtectionNotice: function() {
self.$protectionNotice = $( '.boldgrid-backup-protect-now' );
self.hasProtectionNotice = 1 === self.$protectionNotice.length;
},
/**
* On ready.
*
* @since 1.7.0
*/
_onReady: function() {
$( function() {
if ( 'undefined' !== typeof wp.heartbeat ) {
/*
* Check for a backup in progress.
*
* If there is, we need to begin listenting to the heartbeat to find out when it
* completes (so we can adjust the message).
*
* If there is a quick fail, we still need to load the in progress system so we
* can show the user the error.
*/
if ( ! BoldGridBackupAdmin.is_done || BoldGridBackupAdmin.is_quick_fail ) {
setTimeout( self.start, 1000 );
}
/*
* Event "boldgrid_backup_progress_notice_added" currently only triggered within the
* customizer. When a user clicks on themes, we may dynamically show them a notice that
* a backup is in progress.
*/
$( document ).on( 'boldgrid_backup_progress_notice_added', 'body', self.start );
/*
* Take action when a backup is started.
*
* The only script triggering this event is backup-now.js.
*/
$( document ).on( 'boldgrid_backup_initiated', 'body', self.start );
$( document ).on( 'boldgrid_backup_complete', 'body', self.onComplete );
// Configure our "Update Protection" values.
self.$protectionNotice = $( '.boldgrid-backup-protect-now' );
self.hasProtectionNotice = 1 === self.$protectionNotice.length;
// Take action when a tab within the in progress notice is clicked.
$( document ).on(
'click',
'.notice .bgbkup-nav-tab-wrapper-in-progress .nav-tab',
self.onNavClick
);
// Take action when the user clicks cancel backup.
$( document ).on( 'click', '#bgbkup_cancel_backup', self.onClickCancel );
} else {
// Something's gone wrong.
console.log( 'Error: Progress bar needs heartbeat enqueued.' );
}
} );
},
/**
* Determine whether or not a step is active.
*
* @since 1.7.0
*
* @param string step The id of the container.
* @return bool
*/
isStepActive: function( step ) {
return $( '#boldgrid_backup_in_progress_steps' )
.find( '[data-step="' + step + '"]' )
.hasClass( 'active' );
},
/**
* Action to take when a user clicks to cancel a backup.
*
* @since 1.14.13
*/
onClickCancel: function() {
/*
* Make the ajax call to cancel the backup.
*
* No success, error, or complete callback is passed to the ajax call. Status updates will
* be handled naturally by the in progress system.
*/
$.ajax( {
url: ajaxurl,
data: {
action: 'boldgrid_backup_cancel',
cancel_auth: $( '#bgbkup-cancel' ).val()
},
type: 'post'
} );
$( '#bgbkup_progress_actions' ).html(
wp.i18n.__( 'Canceling backup', 'boldgrid-backup' ) + ' '
);
},
/**
* Action to take when a backup is completed.
*
* This function is called within this file's onHeartbeatTick listener.
*
* @since 1.7.0
*
* @param object data The data object received from the WordPress Heartbeat.
*/
onComplete: function( data ) {
// Bail out of the heartbeat.
$( document ).off( 'heartbeat-tick', self.onHeartbeatTick );
$( document ).off( 'heartbeat-send', self.heartbeatModify );
/*
* Enable buttons again.
*
* We disabled certain buttons during the backup, like "Update now" and "Backup site now".
* Enable those buttons now.
*/
if ( undefined !== BOLDGRID.BACKUP.UpdateSelectors ) {
BOLDGRID.BACKUP.UpdateSelectors.enable();
} else {
console.log( 'Error: BOLDGRID.BACKUP.UpdateSelectors class not available.' );
}
$( 'body' ).trigger( 'make_notices_dismissible' );
data.is_success ? self.onSuccess( data ) : self.onError( data );
},
/**
* Steps to take when an error has occurred.
*
* @since 1.11.2
*
* @param object Heartbeat data.
*/
onError: function( data ) {
var $notice;
// Init "protection notice" values if in the customizer. Please see that init method.
if ( typeof pagenow !== undefined && 'customize' === pagenow ) {
self.initProtectionNotice();
}
if ( self.hasProtectionNotice ) {
self.$protectionNotice
// Change the notice from a warning to an error.
.removeClass( 'notice-warning' )
.addClass( 'notice-error' )
// Clean up the existing markup of the notice.
.find( '#protection_enabled' )
.nextUntil( '#boldgrid_backup_in_progress_container' )
.remove()
.end()
.remove()
.end();
$( '
' + self.i18n.backup_error + '
' + self.i18n.get_support + '
' ).insertBefore(
'#boldgrid_backup_in_progress_container'
);
self.updateStatus( { message: data.boldgrid_backup_error.message } );
} else {
self.updateStatus( data.boldgrid_backup_error );
}
},
/**
* Steps to take when a user clicks on a nav element.
*
* @since 1.14.13
*/
onNavClick: function() {
var $clickedNav = $( this ),
$activeNav = $clickedNav.siblings( '.nav-tab-active' ).eq( 0 );
// If clicking on the active tab, do nothing.
if ( $clickedNav.is( $activeNav ) ) {
return;
}
// Toggle which tab is active.
$clickedNav.addClass( 'nav-tab-active' );
$activeNav.removeClass( 'nav-tab-active' );
// Toggle the container that's actually shown.
$( '#' + $clickedNav.attr( 'data-container' ) ).show();
$( '#' + $activeNav.attr( 'data-container' ) ).hide();
},
/**
* Steps to take when our backup was successful.
*
* @since 1.11.2
*
* @param object Heartbeat data.
*/
onSuccess: function( data ) {
var $notice;
if ( self.hasProgressNotice ) {
self.updateStatus( data.boldgrid_backup_complete );
}
/*
* Show a notice that upgrade protection is now enabled. This updates the current notice
* rather than generate a new one.
*
* This logic was originally introduced in 1.5.3 within backup-now.js. As of 1.11.2 it
* has been moved here so that backup-now.js can focus soley on triggering the ajax call
* to generate the backup and nothing else.
*/
$( '#backup-site-now-results' )
.closest( '.notice' )
// Change it from warning to success.
.removeClass( 'notice-warning' )
.addClass( 'notice-success' )
// Find the protection enabled and change the html.
.find( '#protection_enabled' )
.html( self.i18n.update_protection_activated );
/*
* When a backup is completed, replace the "Backup Site Now" button with a "Backup Created
* Successfully" message.
*
* The .backup-site-now-section is the container for the "Backup Site Now" ';
$formDom = $( form );
$formDom.appendTo( 'body' ).submit();
e.preventDefault();
};
/**
* @summary Confirm to restore a selected backup archive file.
*
* This function was originally in admin-home.js as of 1.0, but moved here
* as of 1.5.4.
*
* @since 1.6.0
*/
self.restoreArchiveConfirm = function() {
var $this = $( this ),
confirmResponse,
filename = $this.data( 'archive-filename' ),
restoreConfirmText = lang.restoreConfirmText.replace( '%s', filename ),
data = {
action: 'boldgrid_backup_restore_archive',
restore_now: $this.data( 'restore-now' ),
archive_key: $this.data( 'archive-key' ),
archive_filename: filename,
archive_auth: $this.data( 'nonce' )
},
$spinner = $this.next( '.spinner' ),
encryptDb = $wpbody.find( '#bgb-details-encrypt_db' ).data( 'value' ),
tokenMatch = $wpbody.find( '#bgbp-token-match' ).data( 'value' );
if ( 'Y' === encryptDb && 'Y' !== tokenMatch ) {
restoreConfirmText = restoreConfirmText + '\n\n' + lang.tokenMismatchText;
}
confirmResponse = confirm( restoreConfirmText );
if ( true === confirmResponse ) {
$spinner.addClass( 'inline' );
$wpbody.bgbuDisableActions();
$.post( ajaxurl, data, function( response ) {
var redirectUrl =
response.data !== undefined && response.data.redirect_url !== undefined ?
response.data.redirect_url :
false;
if ( redirectUrl ) {
window.location.href = redirectUrl;
} else {
location.reload();
}
} ).error( function() {
location.reload();
} );
}
return false;
};
/**
* @summary Get a download link for a selected backup archive file.
*
* @since 1.7.0
*/
self.getDownloadLink = function( e ) {
var $this = $( this ),
data = {
action: 'boldgrid_backup_generate_download_link',
archive_filename: $this.attr( 'data-filename' ),
archive_auth: $this.attr( 'data-nonce' )
},
$spinner = $this.next(),
$downloadLink = $( '#download-link-copy' );
e.preventDefault();
$this.attr( 'disabled', 'disabled' );
$spinner.addClass( 'inline' );
$.post( ajaxurl, data, function( response ) {
var $copyLink;
if ( response.data !== undefined && response.data.download_url !== undefined ) {
$downloadLink
.removeClass( 'notice-error' )
.addClass( 'notice-info' )
.html( response.data.download_url + ' ' );
$copyLink = $(
''
);
$downloadLink.append( $copyLink );
$downloadLink.wrapInner( '' );
$downloadLink.append(
'
'
);
new ClipboardJS( $copyLink[0] );
} else if ( response.data !== undefined && response.data.error !== undefined ) {
$downloadLink
.removeClass( 'notice-info' )
.addClass( 'notice-error' )
.html( response.data.error );
} else {
$downloadLink
.removeClass( 'notice-info' )
.addClass( 'notice-error' )
.html( lang.linkErrorText );
}
} )
.error( function() {
$downloadLink.html( lang.unknownErrorText );
} )
.always( function() {
$downloadLink.show();
$spinner.removeClass( 'inline' );
$this.prop( 'disabled', false );
} );
};
/**
* @summary Update the download link copy button after clicking, and then reset after 3 seconds.
*
* @since 1.7.0
*/
self.updateCopyText = function( e ) {
var $this = $( this ),
oldHtml = $this.html();
e.preventDefault();
$this.attr( 'disabled', 'disabled' );
$this.html( lang.copiedText );
setTimeout( function() {
$this.html( oldHtml );
$this.prop( 'disabled', false );
}, 3000 );
};
$( function() {
$wpbody = $( 'body #wpbody' );
$wpbody.on( 'click', '.action-download', self.downloadArchive );
$wpbody.on( 'click', '.restore-now', self.restoreArchiveConfirm );
$wpbody.on( 'click', '#delete-action a', self.onClickDelete );
$wpbody.on( 'click', '#download-link-button', self.getDownloadLink );
$wpbody.on( 'click', '#download-copy-button', self.updateCopyText );
} );
};
new BOLDGRID.BACKUP.ACTIONS( jQuery );
admin/orphan/README.md 0000644 00000003001 14757772271 0010417 0 ustar 00 # Orphaned Files
An orphaned file is a backup file that should not exist. For example, while a `.zip` file is being written
it may temporarily be named `backup.zip.JIE4T9A`. When the file is successfully written, the random `JIE4T9A`
extension will be removed.
If the backup process is killed, the orphaned `backup.zip.JIE4T9A` file will exists and just take up
space. It should be removed.
## Naming Conventions
### PclZip ###
PclZip does not appear to store `.zip` files anywhere temporarily while they're written. Testing shows
backup files are written in the permanent location using the permanent filename.
```
/home/user/boldgrid_backup/backup.zip
```
### ZipArchive ###
ZipArchive will append a random string to the end of the file, such as `backup.zip.hzWRMm`, and then
remove it when the file is written.
```
/home/user/boldgrid_backup/backup.zip.hzWRMm
```
### System Zip ###
We've setup System Zip to archive files in a separate folder, and then move them when done.
```
/home/user/boldgrid_backup/system-zip-temp/zi5XqLpx
```
In testing, when the backup process received a `kill -9`, the zip file was created, but it was incomplete:
```
/home/user/boldgrid_backup/backup.zip
```
Running a test command still showed the zip was valid.
```
unzip -t backup.zip
Archive: backup.zip
testing: domain.20200605-181832.sql OK
testing: domain.log OK
No errors detected in compressed data of backup.zip.
```
As you can see, it looks like only 2 files, the `.sql` file and the `.log` file were written. admin/orphan/class-finder.php 0000644 00000005225 14757772271 0012235 0 ustar 00
*/
namespace Boldgrid\Backup\Admin\Orphan;
/**
* Class: Finder
*
* @since 1.13.8
*/
class Finder {
/**
* An instance of Boldgrid_Backup_Admin_Core.
*
* @since 1.13.8
* @access private
* @var Boldgrid_Backup_Admin_Core
*/
private $core;
/**
* An array of all orphaned files.
*
* Example: https://pastebin.com/T36y5PXb
*
* @since 1.13.8
* @access private
* @var array
*/
private $filelist = array();
/**
* Constructor.
*
* @since 1.13.8
*/
public function __construct() {
$this->core = apply_filters( 'boldgrid_backup_get_core', null );
}
/**
* Determine whether or not a file is considered old enough to be an orphan.
*
* For example, we may be in the middle of creating a backup with system zip. Just because a file
* exists in /home/user/boldgrid_backup/system_zip_temp, doesn't mean it's an orphan. It could be
* the actual temp file for the zip in progress.
*
* @since 1.13.8
*
* @param array $file An array of file information as received from a WP_Filesystm::dirlist call.
* @return bool
*/
public function is_file_old( array $file ) {
// Any possible orphan over 2 hours old will be considered an orphan.
$threshold = 60 * 60 * 2;
return 'f' === $file['type'] && ( time() - $file['lastmodunix'] > $threshold );
}
/**
* Get and return a list of orphaned files.
*
* These files are considered safe to delete.
*
* @since 1.13.8
*
* @return array
*/
public function run() {
$this->set_filelist();
return $this->filelist;
}
/**
* Set our filelist, our array or orphaned files.
*
* @since 1.13.8
*/
public function set_filelist() {
// Get orphaned files in the root of the backup directory.
$zip_with_extension = $this->core->backup_dir->dirlist_containing( '.zip.' );
$sqls = $this->core->backup_dir->dirlist_containing( '.sql', 'end' );
$files = array_merge( $zip_with_extension, $sqls );
foreach ( $files as $file ) {
if ( $this->is_file_old( $file ) ) {
$full_path = $this->core->backup_dir->get_path_to( $file['name'] );
$this->filelist[ $full_path ] = $file;
}
}
// Get orphaned files in the system zip temp folder.
$system_zip_temp = new \Boldgrid_Backup_Admin_Compressor_System_Zip_Temp_Folder();
foreach ( $system_zip_temp->dirlist() as $filepath => $file ) {
if ( $this->is_file_old( $file ) ) {
$this->filelist[ $filepath ] = $file;
}
}
}
}
admin/orphan/class-cleanup.php 0000644 00000003336 14757772271 0012416 0 ustar 00
*/
namespace Boldgrid\Backup\Admin\Orphan;
/**
* Class: Cleanup
*
* @since 1.13.8
*/
class Cleanup {
/**
* An instance of core.
*
* @since 1.13.8
* @access private
* @var Boldgrid_Backup_Admin_Core
*/
private $core;
/**
* Header message for log file.
*
* @since 1.13.8
* @access private
* @var string
*/
private $header;
/**
* Constructor.
*
* @since 1.13.8
*/
public function __construct() {
$this->core = apply_filters( 'boldgrid_backup_get_core', null );
$this->header = "\n" .
'This is your "orphaned files" log. If a backup process fails, orphaned files might remain in ' .
'your backup directory, and they will need to be deleted. Total Upkeep will delete those files ' .
'and keep a log of them here. If this file exists and you see an excess of orphaned files being ' .
'deleted, please contact support for further assistance at https://wordpress.org/support/plugin/boldgrid-backup/';
}
/**
* Delete orphaned files.
*
* @since 1.13.8
*/
public function run() {
$orphan_finder = new Finder();
$orphans = $orphan_finder->run();
if ( $orphans ) {
$logger = new \Boldgrid_Backup_Admin_Log( $this->core );
$logger->init( 'orphaned-files.log' );
if ( $logger->is_new ) {
$logger->add( $this->header );
}
foreach ( $orphans as $filepath => $data ) {
$this->core->wp_filesystem->delete( $filepath );
$logger->add( 'Deleted: ' . $filepath . ' (' . size_format( $data['size'], 2 ) . ')' );
}
}
}
}
admin/partials/archive-details/remote-storage.php 0000644 00000010441 14757772271 0016210 0 ustar 00
*
* @param bool $archive_found Whether or not the archive was found.
*/
defined( 'WPINC' ) || die;
$data['postbox'] = '';
$action = 'boldgrid_backup_single_archive_remote_options';
if ( ! empty( $archive['filepath'] ) ) {
do_action( $action, $archive['filepath'] );
} elseif ( ! empty( $archive['filename'] ) ) {
do_action( $action, $archive['filename'] );
}
if ( empty( $this->remote_storage_li ) ) {
$data['postbox'] = __( 'No remote storage options available.', 'boldgrid-backup' );
return $data;
}
// This is the template used to render each remote storage provider.
$entry_template = '%5$s
%1$s%2$s
%4$s
';
$count = 0;
foreach ( $this->remote_storage_li as $provider ) {
$count++;
// Generate a link to "download to server" from remote provider.
$download = '';
if ( ! $archive_found && $provider['uploaded'] ) {
$download = sprintf(
'
%1$s
%2$s
',
__( 'Download to web server', 'boldgrid-backup' ),
$this->core->lang['spinner'],
$provider['id']
);
}
if ( $provider['uploaded'] ) {
$upload = '✓ ' . __( 'Uploaded', 'boldgrid-backup' );
} elseif ( $provider['allow_upload'] && $archive_found ) {
$upload = sprintf(
'%1$s',
__( 'Upload', 'boldgrid-backup' ),
$provider['id']
);
} elseif ( isset( $provider['is_setup'] ) && false === $provider['is_setup'] ) {
$upload = sprintf(
// translators: 1: HTML anchor open tag, 2: HTML anchor close tag, 3: Provider title.
esc_html__(
'Please go to your %1$ssettings page%2$s to configure %3$s.',
'boldgrid-backup'
),
'',
'',
$provider['title']
);
} else {
$upload = '';
}
$data['postbox'] .= sprintf(
$entry_template,
/* 1 */ esc_html( $provider['title'] ),
/* 2 */ $upload,
/* 3 */ $provider['id'],
/* 4 */ $download,
/* 5 */ 1 !== $count ? '' : '',
/* 6 */ empty( $provider['title_attr'] ) ? '' : sprintf( 'title="%1$s"', esc_attr( $provider['title_attr'] ) )
);
}
/*
* If the user is not on pro, show the remote storage providers available in pro.
*
* This is done by looping through the "premium_remote" settings in the configs.
*/
if ( ! $this->core->config->get_is_premium() ) {
foreach ( $this->core->configs['premium_remote'] as $provider ) {
// Some providers will have a logo ($provider_span) shown instead of a title.
$provider_span = '';
if ( ! empty( $provider['logo_class'] ) ) {
$provider_span = '';
}
$data['postbox'] .= sprintf(
$entry_template,
/* 1 */ empty( $provider_span ) ? esc_html( $provider['title'] ) : $provider_span,
/* 2 */ wp_kses(
sprintf(
// translators: 1: HTML opening anchor tag linking to the plugin, 2: HTML closing anchor tag, 3: Name of a remote storage provider, 4: Premium plugin title.
__( 'Please upgrade to %1$s%4$s%2$s to enable %3$s.', 'boldgrid-backup' ),
'',
'',
$provider['title'],
BOLDGRID_BACKUP_TITLE . ' Premium'
),
[
'span' => [
'class' => [],
'title' => [],
],
'a' => [
'href' => [],
],
]
),
/* 3 */ '',
/* 4 */ '',
/* 5 */ '',
/* 6 */ ''
);
}
}
return $data;
admin/partials/archive-details/only-remote.php 0000644 00000002756 14757772271 0015537 0 ustar 00
*/
defined( 'WPINC' ) || die;
return sprintf(
'
%1$s
%4$s
%2$s %3$s
',
__( 'This backup file is not on your web server, but it is saved to one or more of your remote storage providers. If you would like to restore this backup or review the contents of this backup, you will first need to download it to your web server.', 'boldgrid-backup' ),
'Download to web server',
$this->core->lang['spinner'],
wp_kses(
sprintf(
// translators: 1 An opening anchor tag to the tools page, 2 its closing tag.
__(
'After your backup has been downloaded to the web server, this page will refresh and you will see more options available. To learn more about your web server vs. remote storage providers, %1$sclick here%2$s.',
'boldgrid-backup'
),
'',
''
),
[
'a' => [
'href' => [],
],
]
)
);
admin/partials/archive-details/not-found.php 0000644 00000000754 14757772271 0015172 0 ustar 00
*/
defined( 'WPINC' ) || die;
return '
must pause your site momentarily. Use sparingly.
*/
printf(
wp_kses(
// translators: 1: URL address.
__(
'Note: Backups use resources and must pause your site momentarily. Use sparingly. ',
'boldgrid-backup'
),
array(
'a' => array(
'href' => array(),
'target' => array(),
),
'strong' => array(),
)
),
esc_url( $this->configs['urls']['resource_usage'] )
);
/*
* Print this text:
*
* You currently have x backups stored on your server, and your backup settings are
* only configured to store x. Backing up your site now will delete your oldest backup to
* make room for your new backup. We recommend you download a backup to your local computer.
*/
if ( count( $archives ) >= $settings['retention_count'] ) {
printf(
wp_kses(
// translators: 1: Archive count, 2: Retention limit, 3: URL address.
__(
'You currently have %1$s backups stored on your server, and your backup settings are only configured to store %2$s. Backing up your site now will delete your oldest backup to make room for your new backup. We recommend you download a backup to your local computer.',
'boldgrid-backup'
),
array(
'a' => array( 'href' => array() ),
)
),
count( $archives ),
esc_html( $settings['retention_count'] ),
esc_url( get_admin_url( null, 'admin.php?page=boldgrid-backup-settings' ) )
);
}
?>
admin/partials/archives/add-new.php 0000644 00000011516 14757772271 0013336 0 ustar 00
*/
defined( 'WPINC' ) || die;
$max_file_size = Boldgrid_Backup_Admin_Utility::get_upload_limit();
$size_limit = __( 'File upload size limit', 'boldgrid-backup' ) . ': ' .
Boldgrid_Backup_Admin_Utility::bytes_to_human(
Boldgrid_Backup_Admin_Utility::get_upload_limit()
);
$size_info = __(
'Files uploaded from your computer are limited to a maximum size. To change the limit, you may be able to modify your server\'s php.ini or .htaccess file. Please ask your web hosting provider if you need assistance. Uploads from URL addresses do not have a size limit.',
'boldgrid-backup'
);
$upload_info = sprintf(
// translators: 1: Plugin title.
__(
'You can upload a backup file that was created with %1$s.
If you choose to restore an uploaded file from a different web location (URL), then we will try to ensure that references to URL address are updated.
There may be times when some items may need to be updated manually.',
'boldgrid-backup'
),
BOLDGRID_BACKUP_TITLE
);
$core = apply_filters( 'boldgrid_backup_get_core', null );
$backup_identifier = $core->get_backup_identifier();
$backup_id_notice = sprintf(
// translators: 1: HTML tag, 2: Filename part, 3: Backup identifier, 4: File extension, 5: Archive filename, 6: Backup directory path, 7: Plugin title.
__(
'Your %7$s id is %3$s. This backup id is used to determine if a backup archive file is associated with this WordPress installation.
Manually uploaded archive files must have filenames starting with "%2$s", contain the %7$s id "%3$s", and end with "%4$s", to be recognized.%1$s%1$s
For example: %5$s%1$s%1$s
Manually uploaded archive files should be uploaded to: %6$s',
'boldgrid-backup'
),
' ',
'boldgrid-backup-',
$backup_identifier,
'.zip',
'boldgrid-backup-' . $backup_identifier . '-my_backup_file.zip',
$settings['backup_directory'],
BOLDGRID_BACKUP_TITLE
);
?>
*/
defined( 'WPINC' ) || die;
ob_start();
// Add the web server storage details.
$storage_locations = [ $this->core->local->get_webserver_details() ];
/**
* Allow other storage providers to register themselves.
*
* @since 1.5.2
*
* @param array $storage_locations {
* An array of details about our storage locations.
*
* @type string $title Amazon S3
* @type string $key amazon_s3
* @type string $configure admin.php?page=boldgrid-backup-amazon-s3
* @type bool $is_setup Whether or not this provider is properly configured.
* @type bool $enabled Whether or not the checkbox should be checked.
* }
*/
$storage_locations = apply_filters( 'boldgrid_backup_register_storage_location', $storage_locations );
/*
* Create markup containing a list of premium storage providers. These will only be shown to the user
* if they are on the free version.
*/
$premium_inputs = '';
if ( ! $this->core->config->is_premium_done ) {
foreach ( $this->core->configs['premium_remote'] as $provider ) {
$premium_inputs .= '
BOLDGRID_BACKUP_TITLE User Guide for more information.
*/
printf(
wp_kses(
// translators: 1: URL address, 2: Plugin title.
esc_html__(
'You are running the Premium version of the %2$s plugin. Please visit our %2$s User Guide for more information.',
'boldgrid-backup'
),
[
'a' => [
'href' => [],
'target' => [],
],
]
),
esc_url( $this->core->configs['urls']['user_guide'] ),
esc_html( BOLDGRID_BACKUP_TITLE )
);
?>
BOLDGRID_BACKUP_TITLE User Guide.
*
* Key differences are size of backups supported, scheduling capabilities, and number of
* archives supported. To upgrade now, go here.
*/
printf(
wp_kses(
// translators: 1: URL address for user guide, 2: URL address for upgrade, 3: Plugin title.
esc_html__(
'
The %3$s plugin comes in two versions, the Free and Premium. The Premium version is part of the BoldGrid Premium Suite. To learn about the capabilities of the %3$s plugin, check out our %3$s User Guide.
Key differences are size of backups supported, scheduling capabilities, and number of archives supported. To upgrade now, go here.
';
// TR for the header and intro.
$tr_header = sprintf(
'
%1$s
%2$s
',
/* 1 */ esc_html__( 'Backup all files (full backup)', 'boldgrid-backup' ),
/* 2 */ esc_html__( 'Custom Backup', 'boldgrid-backup' ),
/* 3 */ $in_modal || $using_defaults ? $checked : '',
/* 4 */ ! $in_modal && ! $using_defaults ? $checked : ''
);
// This markup for the legend. TR for the help text.
$table_legend = sprintf(
'
*
%1$s %2$s
WPCORE
%3$s %4$s
/
%5$s %6$s
,
%7$s %8$s
',
/* 1 */ wp_kses( __( 'Use an asterisk(*) as a wildcard.', 'boldgrid-inspirations' ), $tags ),
/* 2 */ wp_kses( __( 'For example, wp-* will match wp-content, wp-admin, and wp-includes.', 'boldgrid-inspirations' ), $tags ),
/* 3 */ wp_kses( __( 'Use WPCORE to specify WordPress core files.', 'boldgrid-bacukp' ), $tags ),
/* 4 */ wp_kses( __( 'This includes the wp-admin and wp-includes folders, as well as all of the core WordPress files in the root directory of WordPress.', 'boldgrid-backup' ), $tags ),
/* 5 */ wp_kses( __( 'Begin a filter with a forward slash(/) to specify the file or folder must be in the root WordPress directory.', 'boldgrid-backup' ), $tags ),
/* 6 */ wp_kses( __( 'For example, /index.php will not match index.php files in subdirectories, such as wp-includes/index.php', 'boldgrid-backup' ), $tags ),
/* 7 */ wp_kses( __( 'Use a comma to add more than one filter.', 'boldgrid-backup' ), $tags ),
/* 8 */ wp_kses( __( 'For example, wp-admin,wp-includes will backup both the wp-admin folder and the wp-includes folder.', 'boldgrid-backup' ), $tags )
);
// Examples.
$table_examples = sprintf(
'
',
/* 1 */ $core->folder_exclusion->default_include,
/* 2 */ $core->folder_exclusion->default_exclude,
/* 3 */ wp_kses( __( 'Default', 'boldgrid-backup' ), $tags ),
/* 4 */ wp_kses( __( 'These are the default settings. Include all core WordPress files and the wp-content folder (which includes your plugins, themes, and uploads).', 'boldgrid-backup' ), $tags ),
/* 5 */ wp_kses( __( 'Example 1', 'boldgrid-backup' ), $tags ),
/* 6 */ wp_kses( __( 'Backup only the wp-content folder.', 'boldgrid-backup' ), $tags ),
/* 7 */ wp_kses( __( 'Example 2', 'boldgrid-backup' ), $tags ),
/* 8 */ wp_kses( __( 'Backup only the plugins and themes folders.', 'boldgrid-backup' ), $tags ),
/* 9 */ wp_kses( __( 'Example 3', 'boldgrid-backup' ), $tags ),
/* 10 */ wp_kses( __( 'Backup everything except WordPress core files.', 'boldgrid-backup' ), $tags )
);
$status = sprintf(
'
%1$s
%2$s %3$s
',
/* 1 */ $core->lang['icon_success'] . wp_kses( __( 'You are using the the default Include and Exclude settings. Backups created will contain all of the needed files to restore your website in the event of an emergency.', 'boldgrid-backup' ), $tags ),
/* 2 */ $core->lang['icon_warning'] . wp_kses( __( 'You are not using the the default Include and Exclude settings. Backups created may not contain all of the needed files to restore your website in the event of an emergency.', 'boldgrid-backup' ), $tags ),
/* 3 */ sprintf(
'%3$s',
/* 1A */ $core->folder_exclusion->default_include,
/* 2A */ $core->folder_exclusion->default_exclude,
/* 3A */ wp_kses( __( 'Use default settings', 'boldgrid-backup' ), $tags )
)
);
// TR for the help text.
$tr_help = sprintf(
'
%2$s
%3$s
%4$s
%5$s
%6$s
%7$s
',
/* 1 */ $using_defaults ? 'hidden' : '',
/* 2 */ wp_kses( __( 'Use the Include and Exclude settings to adjust which files are included in your backup. Click the Preview button to see which files will be included in your backup based on your settings.', 'boldgrid-backup' ), $tags ),
/* 3 */ wp_kses( __( 'The following special characters can be used in your include and exclude filters:', 'boldgrid-backup' ), $tags ),
/* 4 */ $table_legend,
/* 5 */ wp_kses( __( 'For help with creating a filter, click one of the examples. This will fill in the Include and Exclude settings below.', 'boldgrid-backup' ), $tags ),
/* 6 */ $table_examples,
/* 7 */ $status
);
// TR for the include.
$tr_include = sprintf(
'
',
/* 1 */ esc_html__( 'Files and Folders', 'boldgrid-backup' ),
/* 2 */ $tr_header,
/* 3 */ $tr_help,
/* 4 */ $tr_include,
/* 5 */ $tr_exclude,
/* 6 */ $tr_preview
);
return $markup;
admin/partials/settings/db.php 0000644 00000005004 14757772271 0012433 0 ustar 00
*/
defined( 'WPINC' ) || die;
// $core will vary based on how this file is included.
$core = isset( $this->core ) ? $this->core : $this;
$in_modal = isset( $in_modal ) && true === $in_modal;
// If we are in a modal, by default we want all tables to be backed up.
$tables = $core->db_omit->format_prefixed_tables();
// Determine if the "Backup all tables" option should be checked.
$all_included = empty( $settings['exclude_tables'] );
$type = $core->db_omit->get_settings_type();
$full_checked = 'full' === $type || $all_included;
$checked = 'checked="checked"';
$types = sprintf(
'
%1$s
%2$s
',
/* 1 */ __( 'Backup all tables (full backup)', 'boldgrid-backup' ),
/* 2 */ __( 'Custom Backup', 'boldgrid-backup' ),
/* 3 */ $in_modal || $full_checked ? $checked : '',
/* 4 */ $in_modal || $full_checked ? '' : $checked
);
$buttons = sprintf(
'
',
/* 1 */ esc_html__( 'Include all', 'boldgrid-backup' ),
/* 2 */ esc_html__( 'Exclude all', 'boldgrid-backup' )
);
$status = sprintf(
'
%1$s
%2$s %3$s
',
/* 1 */ $core->lang['icon_success'] . wp_kses( __( 'All database tables will be backed up.', 'boldgrid-backup' ), $tags ),
/* 2 */ $core->lang['icon_warning'] . wp_kses( __( 'You are not backing up all database tables. Backups created may not contain all of the needed tables to restore your website in the event of an emergency.', 'boldgrid-backup' ), $tags ),
/* 3 */ sprintf( '%1$s', __( 'Backup all tables', 'boldgrid-backup' ) )
);
return sprintf(
'
';
$message .= '';
$notice = [
'class' => 'notice notice-warning boldgrid-backup-in-progress',
'message' => $message,
'heading' => BOLDGRID_BACKUP_TITLE . ' - ' . __( 'Backup in progress', 'boldgrid-backup' ),
];
return $notice;
}
/**
* Get our notice markup.
*
* @since 1.6.0
*
* @return mixed Returns a string (html markup), a WordPress admin notice or
* false if we don't have a notice.
*/
public function get_notice_markup() {
$notice = self::get_notice();
$markup = false;
if ( $notice ) {
$markup = $this->core->notice->get_notice_markup( $notice['class'], $notice['message'], $notice['heading'] );
}
return $markup;
}
/**
* Return how many seconds ago the backup started.
*
* @since 1.14.13
*
* @return mixed False if we cannot determine, otherwise an int to show how many seconds ago.
*/
public static function get_start_ago() {
$time_start = Boldgrid_Backup_Admin_In_Progress_Data::get_arg( 'start_time' );
if ( false === $time_start ) {
return false;
}
return time() - $time_start;
}
/**
* Get our backup process' pgid.
*
* @since 1.14.13
*
* @return null if not supported, otherwise value of posix_getpgid().
*/
public function getpgid() {
if ( ! Boldgrid_Backup_Admin_Test::is_getpgid_supported() ) {
return null;
}
$pid = Boldgrid_Backup_Admin_In_Progress_Data::get_arg( 'pid' );
if ( empty( $pid ) ) {
return null;
}
return posix_getpgid( $pid );
}
/**
* Determine whether or not this backup process is done.
*
* This does not return success or failure, simply that the backup process is done.
*
* @since 1.14.13
*
* @return bool
*/
public static function is_done() {
// If we can't get the timestamp of the current backup in progress, it's "done" and been cleared.
$timestamp = self::get();
if ( empty( $timestamp ) ) {
return true;
}
// If the backup process finished and it flagged itself success, we're done.
if ( is_bool( Boldgrid_Backup_Admin_In_Progress_Data::get_arg( 'success', null ) ) ) {
return true;
}
// If the backup process is no longer running, we're done.
if ( false === self::is_running() ) {
return true;
}
return false;
}
/**
* A "quick fail" is when a backup fails within the first 5 - 10 seconds of starting.
*
* This causes a problem with the in progress toolbar because (1) the user clicks "backup now",
* (2) the backup pretty much fails right away, and (3) by the time the page refreshes there's no
* longer a backup in progress. This means the user clicks "backup now", the page refreshes, but
* they never see an in progress bar.
*
* @since 1.14.13
*
* @return bool
*/
public static function is_quick_fail() {
// If there's a backup in progress, then it can't be a quick fail.
$in_progress = self::get();
if ( ! empty( $in_progress ) ) {
return false;
}
/*
* If we can't determine when the backup started, or it started more than 20 seconds ago, it
* wasn't a "quick" fail.
*/
$start_ago = self::get_start_ago();
if ( false === $start_ago || 20 <= $start_ago ) {
return false;
}
return true;
}
/**
* Determine whether or not the backup is running.
*
* This method relies on getpgid support. If this method returns null, then we don't know for sure
* if the backup is running or not. An alternative is to use the is_done() method.
*
* @since 1.14.13
*
* @return mixed null if support for this is not available. Otherwise, bool.
*/
public static function is_running() {
if ( ! Boldgrid_Backup_Admin_Test::is_getpgid_supported() ) {
return null;
}
$pid = Boldgrid_Backup_Admin_In_Progress_Data::get_arg( 'pid' );
if ( empty( $pid ) ) {
return null;
}
return false !== posix_getpgid( $pid );
}
/**
* Take action when the heartbeat is received.
*
* Include data in the heartbeat to let the user know if their backup is
* still in progress, or it has finished.
*
* @since 1.6.0
*
* @param array $response Response.
* @param array $data Data in heartbeat.
* @return array
*/
public function heartbeat_received( $response, $data ) {
// Only admins should see the status of a backup in progress.
if ( ! Boldgrid_Backup_Admin_Utility::is_user_admin() ) {
return $response;
}
$key = 'boldgrid_backup_in_progress';
if ( empty( $data[ $key ] ) ) {
return $response;
}
$log = self::get_log();
/*
* An int specifiying when the current "in progress" backup started.
*
* The value is:
* 1. Stored in Total Upkeep's settings.
* 2. Originally set by Boldgrid_Backup_Admin_Core::archive_files() when archiving begins.
* 3. Unset by:
* a. self::pre_dump().
* b. Boldgrid_Backup_Admin_Archive_Fail::shutdown().
*
* When this value is missing, the in-progress.js script then determines that a backup is no
* longer in progress, and updates the UI for the user.
*/
$response[ $key ] = self::get();
// Our "backup complete!" admin notice.
$response['boldgrid_backup_complete'] = $this->core->notice->get_backup_complete();
$response['in_progress_data'] = Boldgrid_Backup_Admin_In_Progress_Data::get_args();
$response['is_success'] = Boldgrid_Backup_Admin_In_Progress_Data::get_arg( 'success', null );
$response['boldgrid_backup_error'] = array();
// If we have an error message (either a shutdown fatal error, or a process error), return it.
if ( false !== self::get_error_message() ) {
$style = ! empty( $response['in_progress_data']['shutdown_fatal_error'] ) ?
' style="white-space:pre;font-family:\'Courier New\';overflow:auto"' : '';
$header = Boldgrid_Backup_Admin_In_Progress_Data::get_arg( 'is_user_killed' ) ?
__( 'Backup Canceled', 'boldgrid-backup' ) : __( 'Error creating backup', 'boldgrid-backup' );
$response['boldgrid_backup_error'] = array(
'class' => 'notice notice-error boldgrid-backup-in-progress',
'message' => '
' . wp_kses(
self::get_error_message(),
array( 'strong' => array() )
) . '',
'header' => BOLDGRID_BACKUP_TITLE . ' - ' . $header,
);
}
// Steps to take if we're on the last step, step 3, closing the archive.
if ( 3 === Boldgrid_Backup_Admin_In_Progress_Data::get_arg( 'step' ) ) {
$tmp = $this->tmp->get();
if ( ! empty( $tmp ) ) {
$response['in_progress_data']['tmp'] = $tmp;
}
}
/*
* Add the backup log file to the response.
*
* @todo To save on bandwidth, we don't have to return the entire log file, just the part the
* user hasn't seen.
*/
$response['log'] = esc_html( $log->get_contents() );
// If support is available, add info about whether the backup process is running.
if ( Boldgrid_Backup_Admin_Test::is_getpgid_supported() ) {
$response['is_running'] = self::is_running();
$log->add( 'Backup process running: ' . ( ! $response['is_running'] ? 'No' : 'Yes (pgid = ' . self::getpgid() . ')' ) );
}
$response['is_killed'] = false === $response['is_running'] && ! is_bool( $response['is_success'] ) && empty( $response['boldgrid_backup_error'] );
if ( $response['is_killed'] ) {
/*
* If the backup process was killed, we may have not been able to flag that the process
* has ended. Also note: do not set the success value as false because we are expecting
* a killed backup to not have been able to flag a backup with a status.
*/
$this->end();
$response['boldgrid_backup_error'] = array(
'class' => 'notice notice-error',
'header' => BOLDGRID_BACKUP_TITLE . ' - ' . __( 'Backup failed', 'boldgrid-backup' ),
'message' => '
' . wp_kses(
sprintf(
// Translators: 1 An opening anchor tag to our troubleshooting tutorial, 2 its closing tag.
__( 'Your backup failed, and we were unable to detect any fatal errors. This usually happens when your hosting provider kills a backup process using the "SIGKILL" signal. To learn more about this as well as troubleshooting techniques, please %1$sclick here%2$s.', 'boldgrid-backup' ),
'',
''
),
array(
'a' => array(
'href' => array(),
'target' => array(),
),
)
) . '
',
);
}
// Tell the "in progress" system we're done, and it should run onSuccess / onFailure functions.
$response['is_done'] = self::is_done();
return $response;
}
/**
* Action to take before a database is dumped.
*
* @since 1.6.0
*/
public function post_dump() {
/*
* After the database has been dumped, restore the flag stating a backup
* is still in progress.
*
* @see documentation in $this->pre_dump().
*/
if ( ! empty( $this->in_progress ) ) {
$this->set( $this->in_progress );
}
}
/**
* Action to take after a database is dumped.
*
* @since 1.6.0
*/
public function pre_dump() {
/*
* Cancel any "Backup in progress" statuses.
*
* Avoid this issue:
* Before we begin creating a backup, we set a flag stating there is a
* "Backup in progress". So, when we create a backup of the database,
* that flag is in the backup. When we restore a backup, that flag will
* be restored, even if we're not in the middle of making a backup, thus
* giving us a false positive.
*/
$this->in_progress = self::get();
$this->end();
}
/**
* Set that we are in progress of backing up a website.
*
* @since 1.6.0
*
* @param int $time A unix timestamp indicating the time a backup started.
*/
public function set( $time = null ) {
$settings = $this->core->settings->get_settings( true );
$settings['in_progress'] = ! empty( $time ) ? $time : time();
$this->core->settings->save( $settings );
}
/**
* Via ajax, get our "in progress" admin notice.
*
* Example usage includes the customizer. When a user goes to the "change themes" section of the
* customizer, an ajax call is made (action:boldgrid_backup_get_progress_notice) and this method
* handles it. If the $in_progress_markup data we return is not false, then we add the notice and
* trigger boldgrid_backup_progress_notice_added. If there is not a backup in progress, then ultimately
* nothing happens.
*
* @since 1.6.0
*/
public function wp_ajax_get_progress_notice() {
if ( ! current_user_can( 'update_plugins' ) ) {
wp_send_json_error( __( 'Permission denied.', 'boldgrid-backup' ) );
}
if ( ! check_ajax_referer( 'boldgrid_backup_customizer', 'nonce', false ) ) {
wp_send_json_error( __( 'Invalid nonce.', 'boldgrid-backup' ) );
}
$in_progress_markup = $this->get_notice_markup();
wp_send_json_success( $in_progress_markup );
}
}
admin/class-boldgrid-backup-admin-in-progress-data.php 0000644 00000005105 14757772271 0016770 0 ustar 00
*/
/**
* Class: Boldgrid_Backup_Admin_In_Progress_Data
*
* @since 1.7.0
*/
class Boldgrid_Backup_Admin_In_Progress_Data {
/**
* Option name in which data is stored.
*
* @since 1.7.0
* @var string
*/
public static $option_name = 'boldgrid_backup_in_progress_data';
/**
* Delete one arguement.
*
* @since 1.7.0
*
* @param string $arg The key.
*/
public static function delete_arg( $arg ) {
$args = self::get_args();
if ( isset( $args[ $arg ] ) ) {
unset( $args[ $arg ] );
}
update_option( self::$option_name, $args );
}
/**
* Get one argument.
*
* @since 1.7.0
*
* @param string $key Index/key.
* @param mixed $default The default value to return if key is not set.
* @return mixed
*/
public static function get_arg( $key, $default = false ) {
$args = get_option( self::$option_name );
return isset( $args[ $key ] ) ? $args[ $key ] : $default;
}
/**
* Get all arguments.
*
* @since 1.7.0
*
* @return array
*/
public static function get_args() {
return get_option( self::$option_name );
}
/**
* Set one arguement, a key / value pair.
*
* @since 1.7.0
*
* @param string $arg The key.
* @param string $value The value.
*/
public static function set_arg( $arg, $value ) {
$args = self::get_args();
$args[ $arg ] = $value;
update_option( self::$option_name, $args );
/*
* If we're setting step 2 or 3, the status will always be a number for the progress bar. Any
* old status can be removed. This will prevent a random, "Backing up database" when that's not
* what we're actually doing.
*/
if ( 'step' === $arg && $value >= 2 ) {
self::delete_arg( 'status' );
}
}
/**
* Set an array of data.
*
* @since 1.14.13
*
* @param string $arg The key.
* @param string $value The value.
*/
public static function set_args( $data ) {
foreach ( $data as $key => $value ) {
self::set_arg( $key, $value );
}
}
/**
* Init data.
*
* This removes all other in progress data and adds fresh data. This should only be used when a
* backup is initially started.
*
* @since 1.7.0
*
* @param array $args Arguments.
*/
public static function init( $args ) {
update_option( self::$option_name, $args );
}
}
admin/class-boldgrid-backup-admin-home-dir.php 0000644 00000002725 14757772271 0015322 0 ustar 00
*/
/**
* Class: Boldgrid_Backup_Admin_Home_Dir
*
* @since 1.5.1
*/
class Boldgrid_Backup_Admin_Home_Dir {
/**
* The core class object.
*
* @since 1.5.1
* @access private
* @var Boldgrid_Backup_Admin_Core
*/
private $core;
/**
* Constructor.
*
* @since 1.5.1
*
* @param Boldgrid_Backup_Admin_Core $core Boldgrid_Backup_Admin_Core object.
*/
public function __construct( $core ) {
$this->core = $core;
}
/**
* Get home dir used to calculate disk space.
*
* We'll assume that the user's home dir is the appropriate directory to use
* when calculating available disk space. If this dir has permissions that
* make it difficult to calculate disk space, such as
* C:\WINDOWS\system32\config\systemprofile then try a few other dirs.
*
* @since 1.5.1
*/
public function get_for_disk() {
$possible_dirs[] = $this->core->config->get_home_directory();
$possible_dirs[] = ABSPATH;
foreach ( $possible_dirs as $dir ) {
$dir = Boldgrid_Backup_Admin_Utility::trailingslashit( $dir );
if ( ! empty( $dir ) && $this->core->wp_filesystem->is_dir( $dir ) && $this->core->wp_filesystem->is_readable( $dir ) ) {
return $dir;
}
}
return false;
}
}
admin/class-boldgrid-backup-admin-go-pro.php 0000644 00000014701 14757772271 0015016 0 ustar 00
*/
/**
* Class: Boldgrid_Backup_Admin_Go_Pro
*
* @since 1.6.0
*/
class Boldgrid_Backup_Admin_Go_Pro {
/**
* The core class object.
*
* @since 1.6.0
* @access private
* @var Boldgrid_Backup_Admin_Core
*/
private $core;
/**
* Generic upgrade link.
*
* @since 1.6.0
* @access public
* @var string
*/
public static $url = 'https://www.boldgrid.com/update-backup';
/**
* Constructor.
*
* @since 1.6.0
*
* @param Boldgrid_Backup_Admin_Core $core Core class object.
*/
public function __construct( $core ) {
$this->core = $core;
}
/**
* Get "setup" admin notices.
*
* This method is currently used to create the admin notices to help guide the user to getting a
* premium key and getting / activating the premium extension.
*
* @since 1.11.0
*
* @return array
*/
public function get_admin_notices() {
$notices = [];
// If the premium plugin is installed and all is good, abort!
if ( $this->core->config->is_premium_done ) {
return $notices;
}
// Check user role.
if ( ! current_user_can( 'update_plugins' ) ) {
return $notices;
}
if ( ! class_exists( '\Boldgrid\Library\Library\Notice' ) ) {
return $notices;
}
// Avoid a fatal error.
if ( ! class_exists( '\Boldgrid\Library\Library\Plugin\Plugin' ) ) {
$notices = [
[
'id' => 'boldgrid_backup_missing_library',
'show' => true,
'message' => '
' . __( 'Class "Boldgrid\Library\Library\Plugin\Plugin" not found. Please ensure you are running the lastest version of the BoldGrid Library.', 'boldgrid-backup' ) . '
' . sprintf(
// translators: 1: URL address for the wp-admin plugins page, 2: Plugin/extension title.
__(
'You have a Premium BoldGrid Connect Key and you have the %2$s Extension installed. Please go to your plugins page and activate your premium extension!',
'boldgrid-backup'
),
admin_url( 'plugins.php' ),
BOLDGRID_BACKUP_TITLE . ' Premium'
) . '
' . sprintf(
// translators: 1: URL address for the upgrade page, 2: Premium plugin title.
__( 'Thank you for activating the %3$s plugin! Before you can begin using all of the premium features, you must add your premium key. If you are using an Official BoldGrid Host, contact them or login to their management system to retrieve your Premium key. Otherwise, please visit BoldGrid Central to upgrade.', 'boldgrid-backup' ),
$this->get_premium_url( 'bgbkup-premium-activate' ),
admin_url( 'options-general.php?page=boldgrid-connect.php' ),
BOLDGRID_BACKUP_TITLE . ' Premium'
) . '
' . sprintf(
// translators: 1: URL address to download plugin 2: URL to plugin-installer.php, 3: Plugin title, 4: Premium plugin title.
__(
'Hello there! We see that you have a Premium BoldGrid Connect Key and you have the %3$s plugin activated! Click here to download the %4$s plugin and gain access to more features! After the download completes, go to Plugins » Add New and click the Upload Plugin button at the top of the page to upload your new plugin.',
'boldgrid-backup'
),
$premium_plugin->getDownloadUrl(),
admin_url( 'plugin-install.php' ),
BOLDGRID_BACKUP_TITLE,
BOLDGRID_BACKUP_TITLE . ' Premium'
) . '
',
'class' => 'notice notice-warning',
],
];
return $notices;
}
/**
* Display "setup" admin notices.
*
* This method is currently used to display admin notices to help guide the
* user to getting a premium key and getting / activating the premium extension.
*
* @since 1.6.0
*/
public function admin_notice_setup() {
// Don't bombard the user with admin notices. Only show these notices if the user is on a page for this plugin.
$page = ! empty( $_GET['page'] ) ? $_GET['page'] : ''; // phpcs:ignore
if ( substr( $page, 0, strlen( 'boldgrid-backup' ) ) !== 'boldgrid-backup' ) {
return;
}
$notices = $this->get_admin_notices();
foreach ( $notices as $notice ) {
if ( $notice['show'] ) {
\Boldgrid\Library\Library\Notice::show( $notice['message'], $notice['id'], $notice['class'] );
break;
}
}
}
/**
* Get a "Get Premium" button.
*
* @since 1.6.0
*
* @param string $url URL address for the upgrade page.
* @param string $text Button text.
* @return string
*/
public function get_premium_button( $url = null, $text = 'Get Premium' ) {
$url = ! empty( $url ) ? $url : $this->get_premium_url();
return sprintf(
'
%2$s',
esc_url( $url ),
$text
);
}
/**
* Get a "Get Premium" url.
*
* @since 1.7.0
*
* @param string $source Source to append to url.
* @param string $url URL address for the upgrade page.
* @return string
*/
public function get_premium_url( $source = 'bgbkup', $url = 'https://www.boldgrid.com/update-backup' ) {
$url = add_query_arg( 'source', $source, $url );
/**
* Allow the filtering of the premium url.
*
* @since SINCEVERISON
*
* @param string $url The url to be filtered.
* @param string $source A label (used in the url) to uniquely identify this link.
*/
$url = apply_filters( 'boldgrid_backup_premium_url', $url, $source );
return $url;
}
}
admin/class-boldgrid-backup-admin-folder-exclusion.php 0000644 00000034370 14757772271 0017101 0 ustar 00
*/
// phpcs:disable WordPress.VIP, WordPress.CSRF.NonceVerification.NoNonceVerification
/**
* Class: Boldgrid_Backup_Admin_Folder_Exclusion
*
* @since 1.6.0
*/
class Boldgrid_Backup_Admin_Folder_Exclusion {
/**
* The default exclude value.
*
* @since 1.6.0
* @var string
*/
public $default_exclude = '.git,node_modules,wp-content/cache';
/**
* The default include value.
*
* @since 1.6.0
* @var string
*/
public $default_include = 'WPCORE,/wp-content';
/**
* By default, backup all files and folders (use default settings).
*
* @since 1.6.0
* @var string
*/
public $default_type = 'full';
/**
* Our exclude value.
*
* @since 1.6.0
* @var string|null
*/
public $exclude = null;
/**
* Our include value.
*
* @since 1.6.0
* @var string|null
*/
public $include = null;
/**
* Whether or not we're in the ajax preview.
*
* @since 1.6.0
* @var bool
*/
public $in_ajax_preview = false;
/**
* Filename of our restore-info.json file.
*
* @since 1.14.10
* @var string
*/
public $restore_info_filename;
/**
* Determine the type of backup we are performing.
*
* Usually it will be 'full' or 'custom'.
*
* @since 1.6.0
* @var null|string
*/
public $type = null;
/**
* Allowable types.
*
* @since 1.6.0
* @var array
*/
public $types = array( 'include', 'exclude', 'type' );
/**
* Valid backup types.
*
* @since 1.6.0
* @var array
*/
public $valid_types = array( 'full', 'custom' );
/**
* The core class object.
*
* @since 1.6.0
* @access private
* @var Boldgrid_Backup_Admin_Core
*/
private $core;
/**
* Constructor.
*
* @since 1.6.0
*
* @param Boldgrid_Backup_Admin_Core $core Core class object.
*/
public function __construct( $core ) {
$this->core = $core;
/**
* Allow the filtering of the default include and exclude settings.
*
* As of 1.6.0, the backup plugin is not yet "properly" designed to
* allow for these settings to be filtered. Yes, these filters below are
* being ran, however they're being ran in the constructor. The only
* plugins we can guarantee that will be able to hook into these filters
* are mu-plugins. One possible scenario this would be used is an mu-plugin
* hooking into these filters to ensure "mu-plugins" are excluded from
* backups.
*
* @since 1.6.0
*
* @param string $this->default_include Default include values.
*/
$this->default_include = apply_filters( 'boldgrid_backup_default_folder_include', $this->default_include );
$this->default_exclude = apply_filters( 'boldgrid_backup_default_folder_exclude', $this->default_exclude );
// Set in the constructor so as to prevent excessive calls in self::allow_file.
$this->restore_info_filename = basename( \Boldgrid\Backup\Cli\Info::get_results_filepath() );
}
/**
* Determine if we should allow a file in the backup.
*
* @since 1.6.0
*
* @param string $file File path.
* @return bool
*/
public function allow_file( $file ) {
// If this file is in our backup directory, do not allow it.
if ( $this->core->backup_dir->file_in_dir( ABSPATH . $file, true ) ) {
return false;
}
// Do not allow the "cron/restore-info.json" file used for emergency restorations.
if ( $this->is_match( 'cron/' . $this->restore_info_filename, $file ) ) {
return false;
}
if ( $this->is_banned( $file ) ) {
return false;
}
// Get comma-delimited lists from user input or settings. Sanitizing is done below.
$include = $this->in_ajax_preview ? $_POST['include'] : $this->from_settings( 'include' );
$exclude = $this->in_ajax_preview ? $_POST['exclude'] : $this->from_settings( 'exclude' );
// Convert comma-delimited strings to arrays, and sanitize (also trim whitespace).
$includes = array_map( 'sanitize_text_field', explode( ',', $include ) );
$excludes = array_map( 'sanitize_text_field', explode( ',', $exclude ) );
// Default values, include everything and exclude nothing.
$is_match_include = false;
$is_match_exclude = false;
foreach ( $includes as $include ) {
if ( $this->is_match( $include, $file ) ) {
$is_match_include = true;
}
}
// If we're not including this file, we don't need to check excludes.
if ( ! $is_match_include ) {
return false;
}
// If the user left "excludes" blank, then we're not excluding anything.
if ( empty( $exclude ) ) {
return true;
}
foreach ( $excludes as $exclude ) {
if ( $this->is_match( $exclude, $file ) ) {
$is_match_exclude = true;
}
}
return ! $is_match_exclude;
}
/**
* Generate a section for email alerts including information about files and
* folders excluded.
*
* @since 1.6.0
*
* @param array $info File and folder settings.
* @return string
*/
public function email_part( $info ) {
$body = '';
$has_folder_included = isset( $info['folder_include'] );
$has_folder_excluded = isset( $info['folder_exclude'] );
if ( $has_folder_included || $has_folder_excluded ) {
$body .= "\n" . __( 'FILE AND FOLDER SETTINGS', 'boldgrid-backup' ) . "\n";
}
if ( $has_folder_included ) {
$body .= sprintf(
// translators: 1: Included folder list.
esc_html__( 'Included: %1$s', 'boldgrid-backup' ),
$info['folder_include']
) . "\n";
}
if ( $has_folder_excluded ) {
$body .= sprintf(
// translators: 1: Excluded folder list.
esc_html__( 'Excluded: %1$s', 'boldgrid-backup' ),
$info['folder_exclude']
) . "\n";
}
return $body;
}
/**
* Create our regex pattern.
*
* If the user enters wp-* for their include / exclude value, then we need
* to convert that into a proper regex pattern.
*
* When we look for matches, we want to keep it specific to one folder.
* For example, if we're given wp-adm*n, the expectation is that we want
* to find everything within the wp-admin folder.
*
* To prevent this false positive:
* wp-admin/images/media-button.png
* wp-adm************************ng
* ... we will set the wildcard to match everything except a directory separator.
*
* @since 1.6.0
*
* @param string $value Input string.
* @return string
*/
public function create_pattern( $value ) {
$first_char = substr( $value, 0, 1 );
// Clean up our value. Forward slashes will be hanlded uniquely.
$value = trim( $value, ' /' );
// Escape everything except the wildcard.
$value = preg_quote( $value );
$value = str_replace( '\*', '*', $value );
/*
* If the first character is a /, then assume we're requiring the $file
* to be directly in the ABSPATH, and so the $file should beging with
* ^$value.
*
* Otherwise assume our $file should begin with ^value or procede a
* forward slash /$value.
*/
$pattern = '/' === $first_char ? '#^' : '#(^|/)';
/*
* To keep wildcards within a path part, ensure the wildcard matches
* anything except a /. This ensure that wp-adm* matches wp-adm*n and
* not wp-admin/file.png.
*/
$pattern .= str_replace( '*', '[^/]*', $value );
/*
* Our $file should either end with our $$value, or our $value should be
* followed by a forward slash $value/.
*/
$pattern .= '($|/)#';
return $pattern;
}
/**
* Enqueue scripts.
*
* @since 1.6.0
*/
public function enqueue_scripts() {
$handle = 'boldgrid-backup-admin-folder-exclude';
wp_register_script(
$handle,
plugin_dir_url( __FILE__ ) . 'js/boldgrid-backup-admin-folder-exclude.js',
array( 'jquery' ),
BOLDGRID_BACKUP_VERSION,
false
);
$translation = array(
'default_include' => $this->default_include,
'default_exclude' => $this->default_exclude,
'items' => __( 'items', 'boldgrid-backup' ),
'no_results' => __( 'No results', 'boldgrid-backup' ),
'of' => __( 'of', 'boldgrid-backup' ),
);
wp_localize_script( $handle, 'BoldGridBackupAdminFolderExclude', $translation );
wp_enqueue_script( $handle );
// Enqueue CSS for folder exclude functionality.
wp_enqueue_style(
$handle,
plugin_dir_url( __FILE__ ) . 'css/boldgrid-backup-admin-folder-exclude.css', array(),
BOLDGRID_BACKUP_VERSION
);
wp_enqueue_script( 'jquery-effects-core' );
wp_enqueue_script( 'jquery-effects-bounce' );
}
/**
* Get our include or exclude value from the settings.
*
* @since 1.6.0
*
* @param string $type Either 'include' or 'exclude'.
* @param array $settings File and folder settings.
* @return string
*/
public function from_settings( $type, $settings = false ) {
if ( ! in_array( $type, $this->types, true ) ) {
return false;
}
$key = 'folder_exclusion_' . $type;
$default = 'default_' . $type;
/*
* Determine if we need to do a full backup.
*
* Scenarios include:
* # We are in the middle of creating a backup file for update protection.
* # We are creating a 'full' backup.
* # We are creating a backup immediately before a WordPress auto update.
*/
if ( $this->core->is_archiving_update_protection || $this->core->is_backup_full || $this->core->pre_auto_update ) {
return $this->$default;
}
/*
* If we are backing up a site now (not for update protection) and
* we've posted folder settings, use those.
*/
if ( $this->core->is_backup_now && isset( $_POST[ $key ] ) ) {
$this->$type = $this->from_post( $type );
return $this->$type;
}
if ( ! is_null( $this->$type ) ) {
return $this->$type;
}
if ( $this->core->settings->is_saving_settings ) {
$this->$type = $this->from_post( $type );
} elseif ( isset( $settings['folder_exclusion_type'] ) && 'full' === $settings['folder_exclusion_type'] ) {
/*
* If the user configured "Backup all files" as the "Files and Folders" settings, then
* use the default values.
*/
$this->$default;
} elseif ( isset( $settings[ $key ] ) ) {
/*
* Is there value for this in the settings?
*
* Initially, we checked to make sure $settings[$key] wasn't empty and
* it was a string. Now, we'll simply see if it is set. This will allow
* for the user to enter nothing in the exclude field.
*/
$this->$type = $settings[ $key ];
} elseif ( ! $settings ) {
$settings = $this->core->settings->get_settings();
if ( ! empty( $settings[ $key ] ) && is_string( $settings[ $key ] ) ) {
$this->$type = $settings[ $key ];
}
}
if ( is_null( $this->$type ) ) {
$this->$type = $this->$default;
}
return $this->$type;
}
/**
* Whether or not a file is banned.
*
* Some files are just bad for business. Files in this list won't be backed up, and the user has
* no control at this time to modify. Only files we're certain should be banned, should be.
*
* @since 1.14.13
*
* @param string $file A filepath. Not absolute, but relative to ABSPATH, such as wp-admin/css/about.css
*
* @return bool
*/
public function is_banned( $filepath ) {
$banned = Boldgrid_Backup_Admin::get_configs()['banned'];
// @todo Allow for regular expressions in the future.
return in_array( basename( $filepath ), $banned, true );
}
/**
* Determine if a include/exclude value matches a file.
*
* For example, if I pass in "wp-content" as a $value and
* wp-content/file.php as a $file, it should match. If I pass in "joec" as a
* $value and wp-content/file.php as a $file, it should not match.
*
* @param string $value Input string.
* @param string $file File path relative to ABSPATH, such as:
* "wp-content/plugins/boldgrid-backup/boldgrid-backup.php".
* @return bool
*/
public function is_match( $value, $file ) {
if ( '*' === $value ) {
return true;
}
// Handle filtering of core WordPress files.
if ( 'WPCORE' === $value ) {
return $this->core->core_files->is_core_file( $file );
}
/*
* Convert a Windows filepath to Linux. In this method we're going to
* assume that / is the directory separator.
*/
$file = str_replace( '\\', '/', $file );
$pattern = $this->create_pattern( $value );
preg_match( $pattern, $file, $matches );
return ! empty( $matches );
}
/**
* Is using default settings?
*
* @since 1.6.0
*
* @return bool
*/
public function is_using_defaults() {
$type = $this->from_settings( 'type' );
return 'full' === $type;
}
/**
* Get our include / exclude settings from $_POST.
*
* @since 1.6.0
*
* @param string $type Either include or exclude.
* @return string
*/
public function from_post( $type ) {
if ( ! in_array( $type, $this->types, true ) ) {
return false;
}
$key = 'folder_exclusion_' . $type;
switch ( $type ) {
case 'include':
/*
* If you submit an empty "include" setting, it will be
* interpreted as include all, *.
*/
$value = ! empty( $_POST[ $key ] ) ? $_POST[ $key ] : $this->default_include;
break;
case 'exclude':
/*
* You are allowed to submit a blank "exclude" setting. It means
* you do not want to exclude anything.
*/
$value = empty( $_POST[ $key ] ) ? '' : $_POST[ $key ];
break;
case 'type':
$value = ! empty( $_POST[ $key ] ) &&
in_array( $_POST[ $key ], $this->valid_types, true ) ?
$_POST[ $key ] : $this->default_type;
break;
}
$value = sanitize_text_field( $value );
return $value;
}
/**
* Handle the ajax request to preview the filters.
*
* @since 1.6.0
*/
public function wp_ajax_preview() {
if ( ! check_ajax_referer( 'folder_exclusion_preview', 'security', false ) ) {
wp_send_json_error( __( 'Invalid nonce.', 'boldgrid-backup' ) );
}
$include = isset( $_POST['include'] ) ? sanitize_text_field( $_POST['include'] ) : null;
$exclude = isset( $_POST['exclude'] ) ? sanitize_text_field( $_POST['exclude'] ) : null;
if ( is_null( $include ) || is_null( $exclude ) ) {
wp_send_json_error( __( 'Invalid include / exclude values.', 'boldgrid-backup' ) );
}
$this->in_ajax_preview = true;
$filelist = $this->core->get_filtered_filelist();
if ( empty( $filelist ) ) {
wp_send_json_error( __( 'No files match your criteria.', 'boldgrid-backup' ) );
}
$markup = array();
foreach ( $filelist as $file ) {
$markup[] = $file[1];
}
wp_send_json_success( $markup );
}
}
admin/class-boldgrid-backup-admin-filelist.php 0000644 00000005702 14757772271 0015427 0 ustar 00
*/
/**
* Class: Boldgrid_Backup_Admin_Filelist
*
* @since 1.5.1
*/
class Boldgrid_Backup_Admin_Filelist {
/**
* The core class object.
*
* @since 1.6.0
* @access private
* @var Boldgrid_Backup_Admin_Core
*/
private $core;
/**
* The filelist filter array.
*
* This existed in the core class as of 1.0, moved to this class as of 1.5.4
*
* This array primarily exists to help get the total size of your website.
* We loop through this list and calculate the disk space of each item.
*
* @since 1.6.0
* @access public
* @var array
*/
public $filelist_filter = array(
'.htaccess',
'.htaccess.bgb',
'index.php',
'license.txt',
'readme.html',
'wp-activate.php',
'wp-admin',
'wp-blog-header.php',
'wp-comments-post.php',
'wp-config.php',
'wp-content',
'wp-cron.php',
'wp-includes',
'wp-links-opml.php',
'wp-load.php',
'wp-login.php',
'wp-mail.php',
'wp-settings.php',
'wp-signup.php',
'wp-trackback.php',
'xmlrpc.php',
);
/**
* Constructor.
*
* @since 1.6.0
*
* @param Boldgrid_Backup_Admin_Core $core Core class object.
*/
public function __construct( $core ) {
$this->core = $core;
}
/**
* Get the total size of WordPress core and the wp-content directory.
*
* @since 1.6.0
*
* @return int
*/
public function get_size() {
/*
* Include wp-includes/ms-functions.php.
*
* This method uses WordPress' recurse_dirsize function, which is loaded on multisite
* installations. If the recurse_dirsize function does not exist, include the necessary
* file.
*/
if ( ! function_exists( 'recurse_dirsize' ) ) {
require_once ABSPATH . 'wp-includes/ms-functions.php';
}
$size = 0;
// Delete transient "dirsize_cache" that WordPress sets when using recurse_dirsize(); used for Site Health info, our REST endpoint, and here.
delete_transient( 'dirsize_cache' );
foreach ( $this->filelist_filter as $file ) {
$file_path = ABSPATH . $file;
if ( is_dir( $file_path ) ) {
$this_size = recurse_dirsize( $file_path );
} else {
$this_size = $this->core->wp_filesystem->size( $file_path );
}
$size += $this_size;
}
return $size;
}
/**
* Get the total size of a $filelist.
*
* @since 1.5.1
*
* @param array $filelist {
* An array files and data about those files.
*
* @type string 0 The path of a file. /home/user/public_html/readme.html
* @type string 1 The filename. readme.html
* @type int 2 The size of the file. 7413
* }
* @return int
*/
public function get_total_size( $filelist ) {
$total_size = 0;
foreach ( $filelist as $fileinfo ) {
$total_size += $fileinfo[2];
}
return $total_size;
}
}
admin/class-boldgrid-backup-admin-filelist-analyzer.php 0000644 00000010302 14757772271 0017242 0 ustar 00
*/
/**
* Class: Boldgrid_Backup_Admin_Filelist
*
* @since 1.14.13
*/
class Boldgrid_Backup_Admin_Filelist_Analyzer {
/**
* The key used to save this setting in the Total Upkeep settings.
*
* @since 1.14.13
* @var string
*/
public static $settings_key = 'filelist_analysis';
/**
* The unix timestamp used for the parent backup's log file.
*
* This is passed in via the constructor, and is only used when creating the log file. We want
* the unixtime in the "backup" and "backup filelist" log fies to match so you know their is a
* relationship.
*
* @since 1.14.13
* @access private
* @var int
*/
private $log_time;
/**
* An array of files.
*
* This is passed in via the contructor. This is the same filelist that is passed to each compressor
* so they know which files to backup.
*
* @since 1.14.13
* @access private
* @var array
*/
private $filelist;
/**
* Constructor.
*
* @since 1.14.13
*
* @param array $filelist
* @param int $log_time
*/
public function __construct( $filelist = array(), $log_time = 0 ) {
$this->filelist = is_array( $filelist ) ? $filelist : array();
$this->log_time = ! empty( $log_time ) ? $log_time : time();
}
/**
* Whether or not the filelist analyer is enabled.
*
* @since 1.14.13
*
* @return bool
*/
public static function is_enabled() {
$core = apply_filters( 'boldgrid_backup_get_core', null );
$setting = $core->settings->get_setting( self::$settings_key );
return ! empty( $setting );
}
/**
* Run.
*
* Do all the magic and write the log file.
*
* @since 1.14.13
*/
public function run() {
$core = apply_filters( 'boldgrid_backup_get_core', null );
$logger = new Boldgrid_Backup_Admin_Log( $core );
$size_by_extension = array();
$count_by_extension = array();
$size_by_dir = array();
$logger->init( 'archive-' . $this->log_time . '-filelist.log' );
// Loop through each file.
foreach ( $this->filelist as $file ) {
$extension = pathinfo( $file[1], PATHINFO_EXTENSION );
$dir = dirname( $file[1] );
// Generate our stats.
$size_by_extension[ $extension ] = empty( $size_by_extension[ $extension ] ) ? $file[2] : $size_by_extension[ $extension ] + $file[2];
$count_by_extension[ $extension ] = empty( $count_by_extension[ $extension ] ) ? 1 : $count_by_extension[ $extension ] + 1;
$size_by_dir[ $dir ] = empty( $size_by_dir[ $dir ] ) ? $file[2] : $size_by_dir[ $dir ] + $file[2];
}
// Display top 100 files.
$limit = 100;
$to_show = count( $size_by_extension ) >= $limit ? $limit : count( $size_by_extension );
$key = 1;
$logger->add_separator();
$logger->add( 'LARGEST FILES' );
usort( $this->filelist, function ( $item1, $item2 ) {
return $item1[2] <= $item2[2] ? 1 : -1;
} );
foreach ( $this->filelist as $file ) {
$logger->add( '(' . $key . ') ' . $file[1] . ' - ' . size_format( $file[2], 2 ) );
$key++;
if ( $key > $to_show ) {
break;
}
}
// Display size by extension.
$limit = 30;
$to_show = count( $size_by_extension ) >= $limit ? $limit : count( $size_by_extension );
$key = 1;
$logger->add_separator();
$logger->add( 'SIZE BY EXTENSION' );
arsort( $size_by_extension );
foreach ( $size_by_extension as $extension => $size ) {
$logger->add( '(' . $key . ') .' . $extension . ' - ' . number_format( $count_by_extension[ $extension ] ) . ' files totaling ' . size_format( $size, 2 ) );
$key++;
if ( $key > $to_show ) {
break;
}
}
// Display size by directory.
$limit = 30;
$to_show = count( $size_by_dir ) >= $limit ? $limit : count( $size_by_dir );
$key = 1;
$logger->add_separator();
$logger->add( 'SIZE BY DIRECTORY' );
arsort( $size_by_dir );
foreach ( $size_by_dir as $directory => $size ) {
$logger->add( '(' . $key . ') ' . $directory . ' - ' . size_format( $size, 2 ) );
$key++;
if ( $key > $to_show ) {
break;
}
}
}
}
admin/class-boldgrid-backup-admin-environment.php 0000644 00000011365 14757772271 0016162 0 ustar 00
*/
/**
* Class: Boldgrid_Backup_Admin_Environment
*
* The purpose of this class is to help us get more information about our environment. It should also
* help answer questions, such as, has our environment changed?
*
* @since 1.14.5
*/
class Boldgrid_Backup_Admin_Environment {
/**
* The option to which we'll save environment data to.
*
* For example, to know if something has changed in the environment, we'll need to know both the
* old values and the new values. The old values will be stored in this option.
*
* @since 1.14.5
* @var string
*/
const OPTION_NAME = 'boldgrid_backup_environment';
/**
* Determine whether or not our environment has changed.
*
* @since 1.14.5
*
* @return bool
*/
public function has_changed() {
/*
* Run all the tests.
*
* This is done instead of a simple return ! thing1_changed() and ! thing2_changed and etc...
*
* If they're not run all at the same time, it could potentionally take the same number of
* pageloads as there are tests to set all the initial values.
*
* An xhprof of the first 3 tests shows it takes 0.00065 seconds and 15.5kb
*/
$has_hostname_changed = $this->has_hostname_changed();
$has_phpversion_changed = $this->has_phpversion_changed();
$has_wpversion_changed = $this->has_wpversion_changed();
return $has_hostname_changed ||
$has_phpversion_changed ||
$has_wpversion_changed;
}
/**
* Determine whether or not our hostname has changed.
*
* @since 1.14.5
*
* @return bool
*/
public function has_hostname_changed() {
$key = 'hostname';
$current_hostname = gethostname();
$previous_hostname = $this->get_saved_value( $key );
/*
* We took the time to get the current hostname, so save it. We need to know our previous hostname,
* so it's important to only save AFTER we've retrieved the previous hostname.
*/
$this->save_value( $key, $current_hostname );
return $current_hostname !== $previous_hostname;
}
/**
* Determine whether or not our php version has changed.
*
* @since 1.14.5
*
* @return bool
*/
public function has_phpversion_changed() {
$key = 'phpversion';
$current_phpversion = phpversion();
$previous_phpversion = $this->get_saved_value( $key );
/*
* We took the time to get the current phpversion, so save it. We need to know our previous phpversion,
* so it's important to only save AFTER we've retrieved the previous phpversion.
*/
$this->save_value( $key, $current_phpversion );
return $current_phpversion !== $previous_phpversion;
}
/**
* Determine whether or not our WordPress version has changed.
*
* @since 1.14.5
*
* @global string $wp_version The current WordPress version.
*
* @return bool
*/
public function has_wpversion_changed() {
$key = 'wpversion';
global $wp_version;
$previous_wpversion = $this->get_saved_value( $key );
/*
* We took the time to get the current wpversion, so save it. We need to know our previous wpversion,
* so it's important to only save AFTER we've retrieved the previous wpversion.
*/
$this->save_value( $key, $wp_version );
return $wp_version !== $previous_wpversion;
}
/**
* Get a saved environment value.
*
* @since 1.14.5
*
* @access private
* @see self::OPTION_NAME
*
* @param string $key The name of the value to get.
* @param mixed $default The default value to return.
* @return mixed
*/
private function get_saved_value( $key, $default = false ) {
$saved_values = $this->get_saved_values();
return isset( $saved_values[ $key ] ) ? $saved_values[ $key ] : $default;
}
/**
* Get all of our saved values.
*
* @since 1.14.5
*
* @access private
* @see self::OPTION_NAME
*
* @return array
*/
private function get_saved_values() {
return get_option( self::OPTION_NAME, array() );
}
/**
* Save a specific environment value.
*
* @since 1.14.5
*
* @access private
* @see self::OPTION_NAME
*
* @param string $key The environment key, like "hostname".
* @param mixed $value The value, such as "domain.com".
*/
private function save_value( $key, $value ) {
$saved_values = $this->get_saved_values();
$saved_values[ $key ] = $value;
$this->save_values( $saved_values );
}
/**
* Save all of our environment values.
*
* @since 1.14.5
*
* @access private
* @see self::OPTION_NAME
*
* @param array $values All of our environment values.
*/
private function save_values( array $values ) {
update_option( self::OPTION_NAME, $values );
}
}
admin/class-boldgrid-backup-admin-email.php 0000644 00000017222 14757772271 0014703 0 ustar 00
*/
/**
* Class: Boldgrid_Backup_Admin_Email
*
* @since 1.5.2
*/
class Boldgrid_Backup_Admin_Email {
/**
* An array of ads.
*
* @since 1.6.0
* @access private
* @var array
*/
private $ads = array();
/**
* The core class object.
*
* @since 1.5.2
* @access private
* @var Boldgrid_Backup_Admin_Core
*/
private $core;
/**
* Constructor.
*
* @since 1.5.2
*
* @param Boldgrid_Backup_Admin_Core $core Boldgrid_Backup_Admin_Core object.
*/
public function __construct( $core ) {
$this->core = $core;
}
/**
* Create a generic email body.
*
* @since 1.5.2
*
* @param string $message Message to send.
* @param bool $add_ad Allow ads to be added to the email. In some cases,
* like when we have bad news (something failed), we
* may not want to ask the user to upgrade (bad timing).
* @return string
*/
public function fill_generic_template( $message, $add_ad = true ) {
$this->init_ads();
$email_body = __( 'Hello', 'boldgrid-backup' ) . ",\n\n";
$email_body .= trim( $message ) . "\n\n";
if ( $add_ad ) {
$email_body .= $this->ads['generic'];
}
$email_body .= __( 'Best regards', 'boldgrid-backup' ) . ",\n\n";
$email_body .= sprintf(
// translators: 1: Plugin title.
__( 'The %1$s plugin', 'boldgrid-backup' ) . "\n\n",
BOLDGRID_BACKUP_TITLE
);
return $email_body;
}
/**
* Init our ads.
*
* @since 1.6.0
*/
public function init_ads() {
$this->ads = [
'generic' => $this->core->config->get_is_premium() ? '' : sprintf(
// translators: 1: URL address, 2: Premium plugin title.
__(
'Want to store your backups on Google Drive and Amazon S3, restore individual files with just a click, and have access to more tools? Get %2$s! - %1$s',
'boldgrid-backup'
),
$this->core->go_pro->get_premium_url( 'bgbkup-email' ),
BOLDGRID_BACKUP_TITLE . ' Premium'
) . "\n\n",
];
}
/**
* Get the email to send after a backup has been generated.
*
* @since 1.5.2
*
* @param array $info Archive process information.
* @return array
*/
public function post_archive_parts( $info ) {
$this->init_ads();
$parts = array();
$site_id = Boldgrid_Backup_Admin_Utility::create_site_id();
// translators: 1: Site identifier.
$parts['subject'] = sprintf( __( 'Backup completed for %1$s', 'boldgrid-backup' ), $site_id );
$parts['body']['main'] = esc_html__( 'Hello', 'boldgrid-backup' ) . ",\n\n";
if ( $info['dryrun'] ) {
$body['main'] .= esc_html__( 'THIS OPERATION WAS A DRY-RUN TEST', 'boldgrid-backup' ) . ".\n\n";
}
$parts['body']['main'] .= sprintf(
// translators: 1: Site identifier/name.
esc_html__( 'A backup archive has been created for %1$s', 'boldgrid-backup' ),
$site_id
) . ".\n\n";
$parts['body']['main'] .= esc_html__( 'Backup details', 'boldgrid-backup' ) . ":\n";
$parts['body']['main'] .= sprintf( $this->core->configs['lang']['est_pause'], $info['db_duration'] ) . "\n";
// translators: 1: Backup duration.
$parts['body']['main'] .= sprintf( esc_html__( 'Duration: %1$s seconds', 'boldgrid-backup' ), $info['duration'] ) . "\n";
// translators: 1: Total backup size.
$parts['body']['main'] .= sprintf( esc_html__( 'Total size: %1$s', 'boldgrid-backup' ), Boldgrid_Backup_Admin_Utility::bytes_to_human( $info['total_size'] ) ) . "\n";
// translators: 1: Archive file path.
$parts['body']['main'] .= sprintf( esc_html__( 'Archive file path: %1$s', 'boldgrid-backup' ), $info['filepath'] ) . "\n";
// translators: 1: Archive file size.
$parts['body']['main'] .= sprintf( esc_html__( 'Archive file size: %1$s', 'boldgrid-backup' ), Boldgrid_Backup_Admin_Utility::bytes_to_human( $info['filesize'] ) ) . "\n";
// translators: 1: Archive compressor name.
$parts['body']['main'] .= sprintf( esc_html__( 'Compressor used: %1$s', 'boldgrid-backup' ), $info['compressor'] ) . "\n";
if ( ! empty( $info['trigger'] ) ) {
// translators: 1: What triggered the backup process.
$parts['body']['main'] .= sprintf( esc_html__( 'Backup triggered by: %1$s', 'boldgrid-backup' ), $info['trigger'] ) . "\n";
}
$parts['body']['main'] .= $this->core->folder_exclusion->email_part( $info );
$parts['body']['main'] .= $this->core->db_omit->email_part( $info );
$parts['body']['main'] .= "\n";
$parts['body']['signature'] = sprintf(
// translators: 1: Plugin title.
__(
'You can manage notifications in your WordPress admin panel, under %1$s settings',
'boldgrid-backup'
),
BOLDGRID_BACKUP_TITLE
) . ".\n\n";
$parts['body']['signature'] .= sprintf(
// translators: 1: Plugin title, 2: URL address for help restoring a backup archive file.
esc_html__( 'For help with restoring a %1$s archive file, please visit: %2$s', 'boldgrid-backup' ),
BOLDGRID_BACKUP_TITLE,
esc_url( $this->core->configs['urls']['restore'] )
) . "\n\n";
$parts['body']['signature'] .= $this->ads['generic'];
$parts['body']['signature'] .= esc_html__( 'Best regards', 'boldgrid-backup' ) . ",\n\n";
$parts['body']['signature'] .= sprintf(
// translators: 1: Plugin title.
esc_html__( 'The %1$s plugin', 'boldgrid-backup' ),
BOLDGRID_BACKUP_TITLE
) . "\n\n";
return $parts;
}
/**
* Send a notification email to the admin email address.
*
* @since 1.5.2
* @access public
*
* @param string $subject The email subject.
* @param string $body The email body.
* @return bool Whether or not the notification email was sent.
*/
public function send( $subject, $body ) {
// Abort if subject or body is empty.
if ( empty( $subject ) || empty( $body ) ) {
return false;
}
// Get settings, for the notification email address.
$settings = $this->core->settings->get_settings();
$admin_email = $settings['notification_email'];
// Get the site title.
$site_title = get_bloginfo( 'name' );
// Configure mail headers.
$headers = 'From: ' . $site_title . ' <' . $admin_email . '>' . "\r\n" . 'X-Mailer: PHP/' .
phpversion() . "\r\n";
/*
* Send mail.
*
* The default behaviour is to include $headers in our call to wp_mail. In very rare circumstances,
* this will cause the following error:
*
* # Could not instantiate mail function.
* # phpmailer_exception_code 2
*
* In those rare cases, the user can define BGBKUP_SKIP_EMAIL_HEADERS to skip adding the headers.
*/
if ( defined( 'BGBKUP_SKIP_EMAIL_HEADERS' ) ) {
$status = wp_mail( $admin_email, $subject, $body );
} else {
$status = wp_mail( $admin_email, $subject, $body, $headers );
}
// Return status.
return $status;
}
/**
* Determine if the user wants a certain notification.
*
* @since 1.5.2
*
* @param string $task Such as 'backup' or 'restore'.
*/
public function user_wants_notification( $task ) {
$settings = $this->core->settings->get_settings();
return ! empty( $settings['notifications'][ $task ] );
}
/**
* Hook into the wp_mail_failed action.
*
* @since 1.13.4
*
* @param WP_Error $wp_error A WP error object.
*/
public function wp_mail_failed( $wp_error ) {
// If in the middle of archiving files and an email failed, add info about it to the log.
if ( $this->core->archiving_files || $this->core->restoring_archive_file ) {
$errors = array(
'wp_error' => $wp_error,
'last_error' => error_get_last(),
);
$this->core->logger->add( 'wp_mail_failed: ' . print_r( $errors, 1 ) ); // phpcs:ignore
}
}
}
admin/class-boldgrid-backup-admin-db-omit.php 0000644 00000016655 14757772271 0015160 0 ustar 00
*/
// phpcs:disable WordPress.VIP
/**
* Class: Boldgrid_Backup_Admin_Db_Omit
*
* @since 1.5.3
*/
class Boldgrid_Backup_Admin_Db_Omit {
/**
* The core class object.
*
* @since 1.5.3
* @access private
* @var Boldgrid_Backup_Admin_Core
*/
private $core;
/**
* Default type.
*
* Usually 'full' or 'custom' backup.
*
* @since 1.6.0
* @access public
* @var string
*/
public $default_type = 'full';
/**
* Valid types.
*
* Usually 'full' or 'custom' backup.
*
* @since 1.6.0
* @access public
* @var array
*/
public $valid_types = array( 'full', 'custom' );
/**
* Constructor.
*
* @since 1.5.3
*
* @param Boldgrid_Backup_Admin_Core $core Core class object.
*/
public function __construct( $core ) {
$this->core = $core;
}
/**
* Generate a section for email alerts including information about tables
* excluded.
*
* @since 1.6.0
*
* @param array $info Database table information.
* @return string
*/
public function email_part( $info ) {
$body = '';
// Include database tables excluded.
if ( isset( $info['table_exclude'] ) ) {
$body .= "\n" . __( 'DATABASE SETTINGS', 'boldgrid-backup' ) . "\n";
$tables_excluded = empty( $info['table_exclude'] ) ? __( 'None', 'boldgrid-backup' ) : implode( ',', $info['table_exclude'] );
$body .= sprintf(
// translators: 1: Database tables excluded.
__(
'Tables Excluded: %1$s', 'boldgrid-backup'
),
$tables_excluded
) . "\n";
}
return $body;
}
/**
* Enqueue scripts.
*
* @since 1.6.0
*/
public function enqueue_scripts() {
$handle = 'boldgrid-backup-admin-table-include';
wp_register_script(
$handle,
plugin_dir_url( __FILE__ ) . 'js/boldgrid-backup-admin-table-includes.js',
array( 'jquery' ),
BOLDGRID_BACKUP_VERSION,
false
);
$translation = array();
wp_localize_script( $handle, 'BoldGridBackupAdminTableInclude', $translation );
wp_enqueue_script( $handle );
}
/**
* Get our exluded tables list.
*
* This method determines what tables to exclude based upon several
* different scenarios. For example, if we are doing a backup for update
* protection, we will not exclude any tables. If we are doing a backup via
* a scheduled cron, the exlucded tables will be calculated based upon our
* excluded_tables_type (full or custom).
*
* @since 1.5.3
*
* @return array
*/
public function get_excluded_tables() {
/*
* Determine if the user is doing "backup site now" and they selected to
* backup all tables (full backup).
*/
$backup_now_full = $this->core->is_backup_now && 'full' === $this->get_post_type();
if ( $this->core->is_archiving_update_protection || $backup_now_full || $this->core->pre_auto_update ) {
$excluded_tables = array();
} elseif ( $this->core->is_backup_now ) {
$excluded_tables = $this->get_from_post();
} else {
$settings = $this->core->settings->get_settings();
$type = $this->get_settings_type( $settings );
$excluded_tables = 'full' === $type ? array() : $this->get_settings_excluded( $settings );
}
$excluded_tables = is_array( $excluded_tables ) ? $excluded_tables : array();
return $excluded_tables;
}
/**
* Get the tables we need to backup.
*
* We first get all the prefixed tables, and then we remove the tables from
* that list that the user specifically set not to backup.
*
* @since 1.5.3
*
* @return array
*/
public function get_filtered_tables() {
$prefixed_tables = $this->core->db_get->prefixed();
// If we're creating a backup for update protection, backup all tables.
if ( $this->core->is_archiving_update_protection || $this->core->pre_auto_update ) {
return $prefixed_tables;
}
$exclude_tables = $this->get_excluded_tables();
foreach ( $prefixed_tables as $key => $table ) {
if ( in_array( $table, $exclude_tables, true ) ) {
unset( $prefixed_tables[ $key ] );
}
}
return $prefixed_tables;
}
/**
* From post, get an array of tables to exclude.
*
* We are submitting via post "include_tables", however we use this data to
* then calculate "exclude_tables".
*
* @since 1.6.0
*
* @return array
*/
public function get_from_post() {
$exclude_tables = array();
$include_tables = ! empty( $_POST['include_tables'] ) ? // phpcs:ignore WordPress.CSRF.NonceVerification.NoNonceVerification
array_map( 'sanitize_text_field', $_POST['include_tables'] ) : array();
$all_tables = $this->core->db_get->prefixed();
/*
* Loop through every table we have.
*
* If the table we want to
*/
foreach ( $all_tables as $table ) {
if ( ! in_array( $table, $include_tables, true ) ) {
$exclude_tables[] = $table;
}
}
return $exclude_tables;
}
/**
* Get value of 'table_inclusion_type' from $_POST.
*
* @since 1.6.0
*
* @return string
*/
public function get_post_type() {
$key = 'table_inclusion_type';
return ! empty( $_POST[ $key ] ) && in_array( $_POST[ $key ], $this->valid_types, true ) ? // phpcs:ignore WordPress.CSRF.NonceVerification.NoNonceVerification
sanitize_key( $_POST[ $key ] ) : null;
}
/**
* From settings, get our exclude_tables.
*
* If no exclude_tables are set, return an empty array.
*
* @since 1.6.0
*
* @param array $settings Settings.
* @return bool
*/
public function get_settings_excluded( $settings = [] ) {
if ( empty( $settings ) ) {
$settings = $this->core->settings->get_settings();
}
// Get the actual value stored in the settings. Set to an empty array if non existing.
$key = 'exclude_tables';
return ! isset( $settings[ $key ] ) || ! is_array( $settings[ $key ] ) ?
[] : array_map( 'sanitize_text_field', $settings[ $key ] );
}
/**
* From settings, get our type.
*
* In addition to getting the 'type' from settings, we can also get the type
* from $_POST. Please see this->get_post_type.
*
* Return null if we do not have a type saved in the settings.
*
* @since 1.6.0
*
* @param array $settings Settings.
* @return bool
*/
public function get_settings_type( $settings = array() ) {
if ( empty( $settings ) ) {
$settings = $this->core->settings->get_settings();
}
$key = 'exclude_tables_type';
return ! empty( $settings[ $key ] ) && in_array( $settings[ $key ], $this->valid_types, true ) ? $settings[ $key ] : null;
}
/**
* Format an array of tables.
*
* Creates checkboxes for each table.
*
* @since 1.5.3
*
* @return string
*/
public function format_prefixed_tables() {
$exclude_tables = $this->get_excluded_tables();
$tables = $this->core->db_get->prefixed();
$return = '';
foreach ( $tables as $table ) {
$checked = in_array( $table, $exclude_tables, true ) ? '' : 'checked';
$return .= sprintf(
'
%1$s
',
esc_html( $table ),
$checked
);
}
return $return;
}
/**
* Determine if we are omitting all tables from the backup.
*
* @since 1.5.3
*
* @return bool
*/
public function is_omit_all() {
$exclude_tables = $this->get_excluded_tables();
$prefixed_tables = $this->core->db_get->prefixed();
$diff = array_diff( $prefixed_tables, $exclude_tables );
return empty( $diff );
}
}
admin/class-boldgrid-backup-admin-db-import.php 0000644 00000025136 14757772271 0015514 0 ustar 00
*/
/**
* Class: Boldgrid_Backup_Admin_Db_Import.
*
* @since 1.5.1
*/
class Boldgrid_Backup_Admin_Db_Import {
/**
* The core class object.
*
* @since 1.6.0
* @var Boldgrid_Backup_Admin_Core
* @access private
*/
private $core;
/**
* Errors.
*
* @since 1.6.0
* @var array
*/
public $errors = array();
/**
* Constructor.
*
* @since 1.6.0
*
* @param Boldgrid_Backup_Admin_Core $core Boldgrid_Backup_Admin_Core object.
*/
public function __construct( $core = false ) {
// We don't always require $core for this class.
if ( $core ) {
$this->core = $core;
}
}
/**
* Get Lines from file.
*
* Gets an array of lines from a file.
*
* @since 1.14.0
*
* @param string $file String ocntaining the path of the file.
*
* @return array An array of lines.
*/
public function get_lines( $file ) {
if ( false === file_exists( $file ) ) {
return false;
}
return file( $file );
}
/**
* Import a mysqldump.
*
* @since 1.5.1
*
* @param string $file File path.
* @return bool TRUE on success.
*/
public function import( $file ) {
$lines = $this->get_lines( $file );
if ( false === $lines ) {
return array(
'error' => sprintf(
// translators: 1: File path.
__( 'Unable to open mysqldump, %1$s.', 'boldgrid-backup' ),
$file
),
);
}
$lines = $this->fix_view_statements( $lines );
if ( true === empty( $lines ) ) {
return array(
'error' => sprintf(
/* translators: 1: Database File Name */
__( 'MySQL Database User does not have necessary priviliges to restore mysqldump, %1$s.', 'boldgrid-backup' ),
$file
),
);
}
$success = $this->import_lines( $lines );
return $success;
}
/**
* Import a database dump from an archive.
*
* Pass in "file.zip" and "backup.sql" and we'll find "backup.sql" in the file.zip file and restore it.
*
* @since 1.6.0
*
* @param string $archive_filepath Archive file path.
* @param string $file Filename.
* @return bool
*/
public function import_from_archive( $archive_filepath, $file ) {
$this->core->archive->init( $archive_filepath );
$file_contents = $this->core->archive->get_dump_file( $file );
$sql = ! empty( $file_contents[0]['content'] ) ? $file_contents[0]['content'] : null;
if ( empty( $sql ) ) {
$this->errors[] = __( 'Unable to get contents of file.', 'boldgrid-backup' );
return false;
}
$success = $this->import_string( $sql );
return $success;
}
/**
* Import lines (queries).
*
* This method accepts an array of $lines, and loops through each $line and imports it.
*
* These lines usually come from either a .sql file, or a string is parsed
* into separate lines.
*
* The functionality in this method use to be in the main import method,
* however it was broken away to make more reusable.
*
* @since 1.6.0
*
* @param array $lines MySQL dump file lines.
* @return bool
*/
public function import_lines( $lines ) {
if ( empty( $lines ) ) {
return false;
}
/* phpcs:disable WordPress.DB.RestrictedClasses */
$db = new PDO( $this->get_connection_string(), DB_USER, DB_PASSWORD );
$templine = '';
foreach ( $lines as $line ) {
// Skip comments and empty lines.
if ( substr( $line, 0, 2 ) === '--' || empty( $line ) ) {
continue;
}
$templine .= $line;
// Check if this is the end of the query.
if ( substr( trim( $line ), -1, 1 ) === ';' ) {
$affected_rows = $this->exec_import( $db, $templine );
if ( false === $affected_rows ) {
return false;
}
$templine = '';
}
}
return true;
}
/**
* Import a string into a database.
*
* Generally this method is used when we grab a .sql file from within a .zip file and import it.
* Instead of saving the .sql file then importing, it comes straight from the .zip file as a string to here.
*
* @since 1.6.0
*
* @param string $string MySQL dump file as a string.
* @return bool
*/
public function import_string( $string ) {
$lines = preg_split( "/\\r\\n|\\r|\\n/", $string );
$lines = $this->fix_view_statements( $lines );
if ( true === empty( $lines ) ) {
return __( 'The Database User does not have the necessary priviliges to restore this database.', 'boldgrid-backup' );
}
$success = $this->import_lines( $lines );
return $success;
}
/**
* Fix View Statements.
*
* Fixes view statements to ensure the definer matches the current db user.
*
* @since 1.14.0
*
* @param array $lines An array of lines from db file.
* @return array
*/
public function fix_view_statements( array $lines ) {
$has_drop_view_if_exists = false;
foreach ( $lines as $line ) {
if ( strpos( $line, 'DROP VIEW IF EXISTS' ) ) {
$has_drop_view_if_exists = true;
}
}
if ( false === $has_drop_view_if_exists ) {
return $lines;
}
$user_has_privileges = $this->has_db_privileges( array( 'SHOW VIEW', 'CREATE VIEW' ) );
if ( false === $user_has_privileges ) {
return array();
}
$fixed_lines = array();
foreach ( $lines as $line ) {
if ( strpos( $line, 'DEFINER=' ) === 9 ) {
$fixed_lines[] = $this->fix_definer( $line );
} else {
$fixed_lines[] = $line;
}
}
return $fixed_lines;
}
/**
* Fix Definer.
*
* Fixes the actual definer line.
*
* @since 1.14.0
*
* @param string $line The line from db dump file to fix.
* @return string The line with the DEFINER option removed.
*/
public function fix_definer( $line ) {
$line_fixed_definer = '';
$sql_security_offset = strpos( $line, 'SQL SECURITY' );
$line_fixed_definer = substr( $line, 0, 9 );
if ( strpos( $line, '@`%`' ) ) {
$line_fixed_definer .= 'DEFINER=`' . DB_USER . '`@`%` ';
} else {
$line_fixed_definer .= 'DEFINER=`' . DB_USER . '`@`' . DB_HOST . '` ';
}
if ( strpos( $line, 'SQL SECURITY' ) ) {
$line_fixed_definer .= subStr( $line, $sql_security_offset );
} else {
$line_fixed_definer .= '*/';
}
return $line_fixed_definer;
}
/**
* Tests if database user has specific privileges.
*
* @since 1.14.0
*
* @param array $privileges An array of permissions to check against.
* @return bool True if user has specified privileges.
*/
public function has_db_privileges( array $privileges ) {
$user_grants = $this->get_db_privileges();
if ( in_array( 'ALL', $user_grants, true ) ) {
return true;
}
if ( count( $privileges ) === count( array_intersect( $privileges, $user_grants ) ) ) {
return true;
}
return false;
}
/**
* Get database user privileges.
*
* @since 1.14.0
*
* @global wpdb $wpdb The WordPress database class object.
*
* @return array An array of database user privileges.
*/
public function get_db_privileges() {
$results = $this->show_grants_query();
foreach ( $results as $result ) {
$result[0] = str_replace( '\\', '', $result[0] );
$is_string_db_grant = ( false !== strpos( $result[0], 'ON `' . DB_NAME . '`' ) );
$is_string_all_grant = ( false !== strpos( $result[0], 'ON *.*' ) );
$is_grant_all_privileges = ( false !== strpos( $result[0], 'GRANT ALL PRIVILEGES' ) );
if ( ( $is_string_db_grant || $is_string_all_grant ) && $is_grant_all_privileges ) {
return array( 'ALL' );
}
if ( ( $is_string_db_grant ) && false === $is_grant_all_privileges ) {
return $this->get_grants_array( $result[0] );
}
}
return array();
}
/**
* Show Grants Query.
*
* Queries the database for 'SHOW GRANTS'.
*
* @since 1.14.0
*
* @return array an array of results from the database query
*/
public function show_grants_query() {
$db = new PDO( $this->get_connection_string(), DB_USER, DB_PASSWORD );
$db_statement = $db->query( 'SHOW GRANTS' );
return $db_statement->fetchAll();
}
/**
* Execute Import.
*
* Executes Import MySql Query.
*
* @since 1.14.0
*
* @param PDO $db The PDO Object.
* @param string $sql_line The line of sql to execute.
*
* @return int Number of affected rows
*/
public function exec_import( PDO $db, $sql_line ) {
return $db->exec( $sql_line );
}
/**
* Get a user's grants in the form of an array.
*
* @since 1.14.0
*
* @param string $grants_string A string containing the user's grants.
* @return array
*/
public function get_grants_array( $grants_string ) {
$expected_grants_string_start = 6;
if ( strpos( $grants_string, 'GRANT' ) === 0 ) {
$grants_string = substr( $grants_string, $expected_grants_string_start );
}
$on_strpos = strpos( $grants_string, ' ON ' );
if ( $on_strpos ) {
$grants_string = substr( $grants_string, 0, $on_strpos );
}
return explode( ', ', $grants_string );
}
/**
* Get our PDO DSN connection string.
*
* This function is copied from class-boldgrid-backup-admin-db-dump.php. It hasn't been migrated to a utility function
* because these scripts are designed to be able to run without WordPress from the command line, including without the
* core wpdb::parse_db_host() function.
*
* @since 1.15.8
*
* @param string $db_host DB hostname.
* @param string $db_name DB name.
* @return string
*/
public function get_connection_string( $db_host = null, $db_name = null ) {
$params = array();
// Configure parameters passed in.
$db_name = empty( $db_name ) ? DB_NAME : $db_name;
$db_host = empty( $db_host ) ? DB_HOST : $db_host;
$db_host = explode( ':', $db_host );
// Parse info and get hostname, port, and socket. Not all required. See comments below.
switch ( count( $db_host ) ) {
/*
* Examples:
*
* # localhost
* # /var/lib/mysql/mysql.sock
*/
case 1:
$has_socket = 'sock' === pathinfo( $db_host[0], PATHINFO_EXTENSION );
if ( $has_socket ) {
$params['unix_socket'] = $db_host[0];
} else {
$params['host'] = $db_host[0];
}
break;
/*
* Examples:
*
* # localhost:/var/lib/mysql/mysql.sock
* # localhost:3306
*/
case 2:
$has_socket = 'sock' === pathinfo( $db_host[1], PATHINFO_EXTENSION );
$has_port = is_numeric( $db_host[1] );
$params['host'] = $db_host[0];
if ( $has_socket ) {
$params['unix_socket'] = $db_host[1];
} elseif ( $has_port ) {
$params['port'] = $db_host[1];
}
break;
}
$connection_string = 'mysql:';
foreach ( $params as $key => $value ) {
$connection_string .= $key . '=' . $value . ';';
}
$connection_string .= 'dbname=' . $db_name;
return $connection_string;
}
}
admin/class-boldgrid-backup-admin-db-get.php 0000644 00000006672 14757772271 0014765 0 ustar 00
*/
// phpcs:disable WordPress.VIP
/**
* Class: Boldgrid_Backup_Admin_Db_Get
*
* @since 1.5.3
*/
class Boldgrid_Backup_Admin_Db_Get {
/**
* The core class object.
*
* @since 1.5.3
* @access private
* @var Boldgrid_Backup_Admin_Core
*/
private $core;
/**
* Constructor.
*
* @since 1.5.3
*
* @param Boldgrid_Backup_Admin_Core $core Core class object.
*/
public function __construct( $core ) {
$this->core = $core;
}
/**
* Get an array of all tables by table type.
*
* Types must be either "BASE TABLE" or "VIEW".
*
* This method does not filter the list of tables based on prefix.
*
* @since 1.12.4
*
* @param string $type The table type to get.
* @return array
*/
public function get_by_type( $type ) {
global $wpdb;
$tables = [];
// Validate our table type.
$types = [ 'BASE TABLE', 'VIEW' ];
if ( ! in_array( $type, $types, true ) ) {
return [];
}
/*
* Get our list of tables by type.
*
* $results will be an array of arrays, with the latter arrays containing [0] table name and
* [1] table type.
*/
$results = $wpdb->get_results(
$wpdb->prepare(
'SHOW FULL TABLES WHERE TABLE_TYPE = %s;',
$type
),
ARRAY_N
);
// Convert results to an array of table names (rather than an array of arrays).
foreach ( $results as $result ) {
$tables[] = $result[0];
}
return $tables;
}
/**
* Filter an array of table names by table type.
*
* For example, pass in an array of tables that include both "tables" and "views", and this method
* allows you get back only those that match $type.
*
* @since 1.12.4
*
* @param array $tables An array of table names.
* @param string $type A table type, such as "BASE TABLE" or "VIEW".
* @return array
*/
public function filter_by_type( $tables, $type ) {
// The filtered list of tables that we will return.
$tables_by_type = [];
$all_of_type = $this->get_by_type( $type );
foreach ( $tables as $table ) {
if ( in_array( $table, $all_of_type, true ) ) {
$tables_by_type[] = $table;
}
}
return $tables_by_type;
}
/**
* Get a list of all tables based on system prefix.
*
* @since 1.5.3
*
* @global wpdb $wpdb The WordPress database class object.
*
* @return array
*/
public function prefixed() {
global $wpdb;
$prefix_tables = array();
$results = $wpdb->get_results(
$wpdb->prepare(
'SHOW TABLES LIKE %s;',
$wpdb->esc_like( $wpdb->prefix ) . '%'
),
ARRAY_N
);
foreach ( $results as $v ) {
$prefix_tables[] = $v[0];
}
return $prefix_tables;
}
/**
* Get a list of all prefixed tables and the number of rows in each.
*
* This is similar to self::prefixed, except this method returns the number
* of rows in each table.
*
* @since 1.5.3
*
* @global wpdb $wpdb The WordPress database class object.
*
* @return array
*/
public function prefixed_count() {
global $wpdb;
$return = array();
$tables = $this->prefixed();
foreach ( $tables as $table ) {
$num = $wpdb->get_var( 'SELECT COUNT(*) FROM `' . $table . '`;' ); // phpcs:ignore WordPress.WP.PreparedSQL.NotPrepared
$return[ $table ] = $num;
}
return $return;
}
}
admin/class-boldgrid-backup-admin-db-dump.php 0000644 00000020251 14757772271 0015140 0 ustar 00
*/
use Ifsnop\Mysqldump as IMysqldump;
/**
* Class: Boldgrid_Backup_Admin_Db_Dump
*
* @since 1.5.1
*/
class Boldgrid_Backup_Admin_Db_Dump {
/**
* The core class object.
*
* @since 1.5.3
* @access private
* @var Boldgrid_Backup_Admin_Core
*/
private $core;
/**
* Constructor.
*
* @since 1.5.3
*
* @param Boldgrid_Backup_Admin_Core $core Core class object.
*/
public function __construct( $core ) {
$this->core = $core;
}
/**
* Create a MySQL dump of the database.
*
* @since 1.5.1
*
* @global wpdb $wpdb
*
* @param string $file The filepath to our file.
* @return bool True on success.
*/
public function dump( $file ) {
global $wpdb;
$include_tables = $this->core->db_omit->get_filtered_tables();
if ( empty( $include_tables ) ) {
return array( 'error' => esc_html__( 'No tables selected to backup.', 'boldgrid-backup' ) );
}
/*
* Create separate arrays for the "tables" and "views" that we want to dump.
*
* When dumping our database, we need to send a separate list of tables to dump, and a separate
* one for views to dump. $include_tables is an array possibly containing both tables and views,
* so we'll split it up now.
*
* In the list below, it is important that $include_tables is processed last.
*/
$include_views = $this->core->db_get->filter_by_type( $include_tables, 'VIEW' );
$include_tables = $this->core->db_get->filter_by_type( $include_tables, 'BASE TABLE' );
Boldgrid_Backup_Admin_In_Progress_Data::set_args(
array(
'status' => __( 'Backing up database...', 'boldgrid-backup' ),
'tables' => $include_tables,
'step' => 1,
)
);
/**
* Take action before a database is dumped.
*
* @since 1.6.0
*/
do_action( 'boldgrid_backup_pre_dump', $file );
$settings = array(
'include-tables' => $include_tables,
'include-views' => $include_views,
'add-drop-table' => true,
'no-autocommit' => false,
);
/*
* Set default character set.
*
* By default, IMysqldump\Mysqldump uses utf8.
*
* By default, WordPress sets CHARSET to utf8 in wp-config but will default to utf8mb4
* if it's available.
*
* @see wpdb::determine_charset
*/
if ( ! empty( $wpdb->charset ) ) {
$settings['default-character-set'] = $wpdb->charset;
}
if ( ! empty( $include_views ) ) {
$db_import = new Boldgrid_Backup_Admin_Db_Import();
$user_has_privileges = $db_import->has_db_privileges( array( 'SHOW VIEW' ) );
if ( false === $user_has_privileges ) {
return array(
'error' => esc_html__(
'The database contains VIEWS, but the database user does not have the permissions needed to create a backup.',
'boldgrid-backup'
),
);
}
}
try {
$dump = new IMysqldump\Mysqldump(
$this->get_connection_string(),
DB_USER,
DB_PASSWORD,
$settings
);
$dump->start( $file );
} catch ( \Exception $e ) {
return array( 'error' => $e->getMessage() );
}
/**
* Take action after a database is dumped.
*
* @since 1.6.0
*/
do_action( 'boldgrid_backup_post_dump', $file );
return true;
}
/**
* Get our PDO DSN connection string.
*
* @since 1.13.3
*
* @param string $db_host DB hostname.
* @param string $db_name DB name.
* @return string
*/
public function get_connection_string( $db_host = null, $db_name = null ) {
$params = array();
// Configure parameters passed in.
$db_name = empty( $db_name ) ? DB_NAME : $db_name;
$db_host = empty( $db_host ) ? DB_HOST : $db_host;
$db_host = explode( ':', $db_host );
// Parse info and get hostname, port, and socket. Not all required. See comments below.
switch ( count( $db_host ) ) {
/*
* Examples:
*
* # localhost
* # /var/lib/mysql/mysql.sock
*/
case 1:
$has_socket = 'sock' === pathinfo( $db_host[0], PATHINFO_EXTENSION );
if ( $has_socket ) {
$params['unix_socket'] = $db_host[0];
} else {
$params['host'] = $db_host[0];
}
break;
/*
* Examples:
*
* # localhost:/var/lib/mysql/mysql.sock
* # localhost:3306
*/
case 2:
$has_socket = 'sock' === pathinfo( $db_host[1], PATHINFO_EXTENSION );
$has_port = is_numeric( $db_host[1] );
$params['host'] = $db_host[0];
if ( $has_socket ) {
$params['unix_socket'] = $db_host[1];
} elseif ( $has_port ) {
$params['port'] = $db_host[1];
}
break;
}
$connection_string = 'mysql:';
foreach ( $params as $key => $value ) {
$connection_string .= $key . '=' . $value . ';';
}
$connection_string .= 'dbname=' . $db_name;
return $connection_string;
}
/**
* Get data on all tables and the number of records in the backup file.
*
* @since 1.5.3
*
* @param string $filepath Path to zip file.
* @param string $file Path to file in zip.
* @return array
*/
public function get_insert_count( $filepath, $file ) {
$return = [];
$tables = [];
$this->core->archive->init( $filepath );
$file_contents = $this->core->archive->get_dump_file( $file );
// Check for the dump file header.
if ( false !== strpos( $file_contents[0]['content'], '-- mysqldump-php' ) ) {
$tables = $this->get_insert_tables( $filepath, $file );
} else {
// The file header is missing; the file may have been encrypted with other settings.
$return = [ 'encrypted_other' => true ];
}
foreach ( $tables as $table ) {
/*
* Grab the exact insert statement.
*
* We have to use preg_match_all because some tables may have
* multiple INSERT INTO commands.
*/
$expression = sprintf( '/INSERT INTO \`%1$s\` VALUES(.*);/', $table );
preg_match_all( $expression, $file_contents[0]['content'], $matches );
if ( empty( $matches[1] ) ) {
$return[ $table ] = 0;
continue;
}
$count = 0;
foreach ( $matches[1] as $line ) {
/*
* Ultimately what we're trying to do below is get the number of
* records in the INSERT statement.
*
* We cannot simply count the number of items between ()'s, as there
* could be a text entry like this ('()'),(), that would trigger a
* false positive.
*
* What we're doing is converting:
* 'some text goes \' () here ' to
* 'text'
* ... so we can simply count the number of ('s to find the number
* of records.
*/
$insert_command = str_replace( '\\\'', '', $line );
$exploded = explode( '\'', $insert_command );
foreach ( $exploded as $k => $v ) {
// Odd numbers are what was between quotes.
if ( 0 !== $k % 2 ) {
$exploded[ $k ] = '';
}
}
$insert_command = implode( '\'', $exploded );
$count += substr_count( $insert_command, '(' );
}
$return[ $table ] = $count;
}
return $return;
}
/**
* Get a list of all tables a .sql file has insert commands for.
*
* @since 1.5.3
*
* @param string $filepath Path to zip file.
* @param string $file Path to file in zip.
* @return array
*/
public function get_insert_tables( $filepath, $file ) {
$this->core->archive->init( $filepath );
$file_contents = $this->core->archive->get_dump_file( $file );
/*
* Get a list of all tables within the dump that we are inserting
* records into.
*
* We initially did this taking a preg_match_all approach, but it fails
* for really long tables / fails with really long strings.
* # preg_match_all('/INSERT INTO \`(.*)\` VALUES(.*)/', $file_contents[0]['content'], $matches );
* # $tables = ! empty( $matches[1] ) ? $matches[1] : array();
*
* @link https://stackoverflow.com/questions/3021316/preg-match-and-long-strings
*
* For now, we'll go with the handy explode technique.
*/
$tables = array();
$exploded = explode( 'INSERT INTO `', $file_contents[0]['content'] );
unset( $exploded[0] );
foreach ( $exploded as $table ) {
$tables[] = strstr( $table, '`', true );
}
// Tables may have more than one INSERT INTO statement.
$tables = array_unique( $tables );
return $tables;
}
}
admin/class-boldgrid-backup-admin-dashboard-widget.php 0000644 00000004046 14757772271 0017024 0 ustar 00
*/
/**
* Class: Boldgrid_Backup_Admin_Dashboard_Widget
*
* @since 1.10.0
*/
class Boldgrid_Backup_Admin_Dashboard_Widget {
/**
* The core class object.
*
* @since 1.10.0
* @access private
* @var Boldgrid_Backup_Admin_Core
*/
private $core;
/**
* Constructor.
*
* @since 1.10.1
*
* @param Boldgrid_Backup_Admin_Core $core Boldgrid_Backup_Admin_Core object.
*/
public function __construct( Boldgrid_Backup_Admin_Core $core ) {
$this->core = $core;
}
/**
* Filter the item in the dashboard widget.
*
* @since 1.10.0
*
* @param \Boldgrid\Library\Library\Ui\Feature $feature The feature object.
* @param \Boldgrid\Library\Library\Plugin\Plugin $plugin The plugin object.
* @return \Boldgrid\Library\Library\Ui\Feature
*/
public function filter_feature( Boldgrid\Library\Library\Ui\Feature $feature, \Boldgrid\Library\Library\Plugin\Plugin $plugin ) {
// Full site protection.
if ( ! $this->core->settings->has_full_protection() ) {
$feature->content .= '
' . wp_kses(
sprintf(
// translators: 1 The opening anchor tag to the Inspirations page, 2 its closing tag.
__( 'Not fully protected. %1$sFix this%2$s.', 'boldgrid-backup' ),
'',
''
),
array( 'a' => array( 'href' => array() ) )
) . '
';
}
// Show notices if the user has the premium plugin but needs to enable it, or a similar situation.
$notices = $this->core->go_pro->get_admin_notices();
foreach ( $notices as $notice ) {
if ( $notice['show'] ) {
$feature->content .= '
' . $notice['message'] . '
';
}
}
return $feature;
}
}
admin/class-boldgrid-backup-admin-dashboard.php 0000644 00000005771 14757772271 0015551 0 ustar 00
*/
/**
* Class: Boldgrid_Backup_Admin_Dashboard
*
* @since 1.11.0
*/
class Boldgrid_Backup_Admin_Dashboard {
/**
* The core class object.
*
* @since 1.11.0
* @access private
* @var Boldgrid_Backup_Admin_Core
*/
private $core;
/**
* Constructor.
*
* @since 1.11.0
*
* @param Boldgrid_Backup_Admin_Core $core Core class object.
*/
public function __construct( Boldgrid_Backup_Admin_Core $core ) {
$this->core = $core;
}
/**
* Enqueue scripts.
*
* @since 1.11.0
*
* @param string $hook Hook name.
*/
public function admin_enqueue_scripts( $hook ) {
if ( 'toplevel_page_boldgrid-backup-dashboard' === $hook ) {
wp_enqueue_style(
'boldgrid-backup-admin-dashboard',
plugin_dir_url( __FILE__ ) . 'css/boldgrid-backup-admin-dashboard.css',
array(),
BOLDGRID_BACKUP_VERSION
);
}
}
/**
* Get cards needed for the dashboard.
*
* @since 1.11.0
*
* @return array
*/
public function get_cards() {
$cards = [
new \Boldgrid\Backup\Admin\Card\Premium(),
new \Boldgrid\Backup\Admin\Card\Backups(),
new \Boldgrid\Backup\Admin\Card\Updates(),
];
return $cards;
}
/**
* Render the dashboard page.
*
* @since 1.11.0
*/
public function page() {
$settings = $this->core->settings->get_settings();
wp_enqueue_style( 'boldgrid-backup-admin-new-thickbox-style' );
wp_enqueue_style( 'bglib-ui-css' );
$this->core->auto_rollback->enqueue_home_scripts();
$this->core->auto_rollback->enqueue_backup_scripts();
$this->core->archive_actions->enqueue_scripts();
$this->core->folder_exclusion->enqueue_scripts();
$this->core->db_omit->enqueue_scripts();
$in_modal = true;
$modal = include BOLDGRID_BACKUP_PATH . '/admin/partials/boldgrid-backup-admin-backup-modal.php';
$in_modal = false;
echo '
';
$markup .= sprintf( $run_test, esc_attr( __( 'Run test again', 'boldgrid-backup' ) ) );
}
// Help info, displayed by clicking the help icon.
$markup .= '
' . __( 'Cron should run in the same time zone as your server. For example, if your server timezone is EST, setting a cron to run at 5am should run it at 5am EST. This test runs a series of cron jobs to determine which timezone is used by Cron.', 'boldgrid-backup' ) . '
';
return $markup;
}
/**
* Get the cron offset.
*
* This looks in the cron-test.result file for the data.
*
* @since 1.6.5
*
* @return mixed
*/
public function get_offset() {
$result = $this->core->wp_filesystem->get_contents( $this->cron_result_path );
if ( ! $result ) {
return false;
}
$result = json_decode( $result, true );
return isset( $result['offset'] ) ? $result['offset'] : false;
}
/**
* Whether or not the test is currently running.
*
* @since 1.6.5
*
* @return bool
*/
public function is_running() {
$config_file_exists = $this->core->wp_filesystem->exists( $this->cron_config_path );
$matching_crons = $this->core->cron->entry_search( $this->cron_path );
return false === $this->get_offset() && $config_file_exists && ! empty( $matching_crons );
}
/**
* Setup the tests.
*
* HERE'S THE PROBLEM:
* Cron is supposed to run using the server's timezone. In one scenario, the crons were not running
* when we expected them to. Further troubleshooting found that the server was set to PDT and the
* Crons were running at EDT times. So, our 5am PDT cron was actually running at 5am EDT. It took
* a while to figure this out, so this test was built.
*
* HERE'S HOW THIS TEST WORKS:
* We get the current UTC time. Let's say it's 3:15 pm. We then setup the following crons:
*
* # 3:18 pm (UTC)
* # 4:19 pm (UTC+1)
* # 5:20 pm (UTC+2)
*
* We don't know when each of these crons will actually run, but they're basically 1 hour and
* 1 minute apart. When the first of these crons actually does run, the script it triggers (cron-test.php)
* will look at the current MINUTE. Using the example above, if the minute is 19, then we know cron
* is running on UTC+1 time. If the minute is 20, then we know we're running at UTC+2.
*
* The array of times to offsets (like 4:19 pm = UTC+1) is stored in the cron-test.config file.
*
* @since 1.6.5
*/
public function setup() {
// Delete the log, the config file, and all existing crons.
$this->clean_up();
wp_delete_file( $this->cron_result_path );
$time_data = array();
$unix_time = time();
$minutes_ahead = 3;
// When looping through offsets, begin at the user's offset so test completes faster.
$server_offset = (int) $this->core->time->get_server_offset();
/*
* Add our cron jobs.
*
* Currently, we are only doing hour increments. A few 30 & 45 minute offsets exist, but this
* test is really for edge cases, and those 30/45 offsets are edge cases too. We'll get to those
* later.
*
* @see https://www.timeanddate.com/time/time-zones-interesting.html
*/
for ( $x = 1; $x <= 25; $x++ ) {
$cron_time = $unix_time + ( $server_offset * 60 * 60 ) + ( $minutes_ahead * 60 );
$time_data[] = array(
'time' => $cron_time,
'offset' => $server_offset,
);
// Add our cron. Use (int) to make sure our minutes do not have leading zero's.
$cron_command = (int) date( 'i', $cron_time ) . ' ' . date( 'G * * *', $cron_time ) . ' php -d register_argc_argv=1 -qf ' . $this->cron_path . ' > /dev/null 2>&1';
$all_crons_added = $this->core->cron->update_cron( $cron_command );
if ( ! $all_crons_added ) {
break;
}
$minutes_ahead++;
// Server offset must be between -12 and 12.
$server_offset++;
$server_offset = $server_offset > 12 ? -12 : $server_offset;
}
if ( $all_crons_added ) {
$this->core->wp_filesystem->put_contents( $this->cron_config_path, wp_json_encode( $time_data ) );
} else {
$error = __( 'Failed to setup Cron time zone test.', 'boldgrid-backup' );
$this->core->notice->boldgrid_backup_notice( $error );
$this->clean_up();
}
}
}
admin/class-boldgrid-backup-admin-cron.php 0000644 00000074763 14757772271 0014572 0 ustar 00
*/
// phpcs:disable WordPress.VIP
/**
* Class: Boldgrid_Backup_Admin_Cron
*
* @since 1.2
*/
class Boldgrid_Backup_Admin_Cron {
/**
* The core class object.
*
* @since 1.2
* @access private
* @var Boldgrid_Backup_Admin_Core
*/
private $core;
/**
* Path to run-jobs.php.
*
* @since 1.5.2
* @var string
*/
public $run_jobs = 'cron/run-jobs.php';
/**
* Path to the bgbkup-cli script.
*
* @since 1.10.0
* @var string
*/
public $site_check = 'cli/bgbkup-cli.php';
/**
* Cron command.
*
* This is the base of most of our cron commands.
*
* The following was added as of 1.6.5 for those hosts that have register_argc_argv disabled:
* -d register_argc_argv="1"
*
* @since 1.6.5
* @access private
* @var string
*/
private $cron_command = 'php -d register_argc_argv="1" -qf';
/**
* A cron secret used to validate unauthenticated crontab jobs.
*
* @since 1.6.1-rc.1
* @access private
* @var string
*/
private $cron_secret = null;
/**
* Linux crontab entry version string.
*
* The version represents the plugin version string when the crontab entry format was changed.
*
* @var string
*/
public $crontab_version = '1.6.4';
/**
* Constructor.
*
* @since 1.2
*
* @param Boldgrid_Backup_Admin_Core $core Core class object.
*/
public function __construct( $core ) {
// Save the Boldgrid_Backup_Admin_Core object as a class property.
$this->core = $core;
}
/**
* Get the cron command prefix.
*
* @return string
*/
public function get_cron_command() {
return $this->cron_command;
}
/**
* Add cron entry for backups from stored settings.
*
* @since 1.2
*
* @see Boldgrid_Backup_Admin_Cron::delete_cron_entries().
* @see Boldgrid_Backup_Admin_Cron::update_cron().
* @see BoldGrid_Backup_Admin_Core::get_backup_identifier()
* @see BoldGrid_Backup_Admin_Cron::get_cron_secret()
*
* @param array $settings Settings.
* @return bool Success.
*/
public function add_cron_entry( array $settings = [] ) {
if ( empty( $settings ) ) {
$settings = $this->core->settings->get_settings();
}
// Delete existing backup cron jobs.
$cron_status = $this->delete_cron_entries( 'backup' );
// Initialize $days_scheduled_list.
$days_scheduled_list = '';
// Create an array of days index names.
$days = array(
'dow_sunday' => 0,
'dow_monday' => 1,
'dow_tuesday' => 2,
'dow_wednesday' => 3,
'dow_thursday' => 4,
'dow_friday' => 5,
'dow_saturday' => 6,
);
// Add scheduled days to the list.
foreach ( $days as $index => $int ) {
if ( isset( $settings['schedule'][ $index ] ) &&
1 === $settings['schedule'][ $index ] ) {
$days_scheduled_list .= $int . ',';
}
}
// If no days are scheduled, then abort.
if ( empty( $days_scheduled_list ) ) {
return true;
}
// Strip trailing comma.
$days_scheduled_list = rtrim( $days_scheduled_list, ',' );
// Convert our WordPress time to Server time.
$date = $this->core->time->get_settings_date( $settings );
if ( false === $date ) {
return false;
}
$server_timezone = $this->core->time->get_server_timezone();
if ( false === $server_timezone ) {
return false;
}
$date->setTimezone( $server_timezone );
// Build cron job line in crontab format.
$entry = $date->format( 'i G' ) . ' * * ';
$entry .= $days_scheduled_list . ' ' . $this->cron_command . ' "' . dirname( dirname( __FILE__ ) ) .
'/boldgrid-backup-cron.php" mode=backup siteurl=' . get_site_url() . ' id=' .
$this->core->get_backup_identifier() . ' secret=' . $this->get_cron_secret();
// If not Windows, then also silence the cron job.
if ( ! $this->core->test->is_windows() ) {
$entry .= ' > /dev/null 2>&1';
}
// Update cron.
$status = $this->update_cron( $entry );
return $status;
}
/**
* Add all cron jobs.
*
* This method first clears all crons, then adds all necessary crons based
* upon our settings.
*
* This method is useful for when:
* # User saves settings on settings page and crons need to be updated.
* # User reactivates plugin and all crons need to be added again.
*
* @since 1.6.0
*
* @param array $settings Settings.
* @return bool
*/
public function add_all_crons( array $settings ) {
$success = false;
$scheduler = ! empty( $settings['scheduler'] ) ? $settings['scheduler'] : null;
$schedule = ! empty( $settings['schedule'] ) ? $settings['schedule'] : null;
if ( 'cron' === $scheduler && $this->core->scheduler->is_available( $scheduler ) ) {
$this->core->scheduler->clear_all_schedules();
$scheduled = false;
if ( ! empty( $schedule ) ) {
$scheduled = $this->add_cron_entry( $settings );
}
$jobs_scheduled = $this->schedule_jobs( $settings );
$site_check = $this->schedule_site_check( $settings );
$success = $scheduled && $jobs_scheduled;
if ( $success ) {
$settings['crontab_version'] = $this->crontab_version;
$settings['cron_secret'] = $this->get_cron_secret();
update_site_option( 'boldgrid_backup_settings', $settings );
}
}
return $success;
}
/**
* Add a cron job to restore (rollback) using the last backup.
*
* @since 1.2
*
* @see Boldgrid_Backup_Admin_Core::get_archive_list()
* @see Boldgrid_Backup_Admin_Core::execute_command()
* @see Boldgrid_Backup_Admin_Cron::delete_cron_entries().
* @see Boldgrid_Backup_Admin_Cron::update_cron().
* @see Boldgrid_Backup_Admin_Test::is_windows()
* @see BoldGrid_Backup_Admin_Core::get_backup_identifier()
* @see BoldGrid_Backup_Admin_Cron::get_cron_secret()
*/
public function add_restore_cron() {
// Remove existing restore cron jobs.
$this->delete_cron_entries( 'restore' );
$entry = $this->get_restore_command();
$status = $this->update_cron( $entry );
$time = $this->core->auto_rollback->get_time_data();
// If cron job was added, then update the boldgrid_backup_pending_rollback option with time.
if ( $status ) {
$pending_rollback = get_site_option( 'boldgrid_backup_pending_rollback' );
$pending_rollback['deadline'] = $time['deadline'];
update_site_option( 'boldgrid_backup_pending_rollback', $pending_rollback );
}
}
/**
* Read an entry from the system user crontab or wp-cron.
*
* @since 1.2
*
* @param string $mode The mode of the cron job; either "backup" or "restore".
* @return array An array containing the backup schedule.
*/
public function read_cron_entry( $mode = 'backup' ) {
// Validate mode.
if ( 'backup' !== $mode && 'restore' !== $mode ) {
return array();
}
// Set a search pattern to match for our cron jobs.
$pattern = dirname( dirname( __FILE__ ) ) . '/boldgrid-backup-cron.php" mode=' . $mode;
// Get our cron jobs.
$crontab_exploded = $this->get_all();
if ( empty( $crontab_exploded ) ) {
return array();
}
// If there's no cron jobs matching our pattern, abort.
$crontab = implode( '', $crontab_exploded );
if ( false === strpos( $crontab, $pattern ) ) {
return array();
}
// Initialize $entry.
$entry = '';
foreach ( $crontab_exploded as $line ) {
if ( false !== strpos( $line, $pattern ) ) {
// Found a matching entry.
$entry = trim( $line );
break;
}
}
$schedule = $this->get_schedule( $entry );
return $schedule;
}
/**
* Schedule "run_jobs".
*
* This hook will run every 5 minutes and run one job at a time, such as
* upload to a remote storage provider.
*
* This method is usually ran after saving the settings. If after save cron is our scheduler,
* then we need to make sure we have the "run_jobs" wp-cron scheduled.
*
* @since 1.5.2
*
* @see BoldGrid_Backup_Admin_Core::get_backup_identifier()
* @see BoldGrid_Backup_Admin_Cron::get_cron_secret()
*
* @param array $settings Settings.
*
* @return bool Success.
*/
public function schedule_jobs( $settings ) {
$cron_interval = isset( $settings['cron_interval'] ) ? $settings['cron_interval'] : '*/10 * * * *';
$entry = sprintf(
'%7$s %6$s "%1$s/%2$s" siteurl=%3$s id=%4$s secret=%5$s > /dev/null 2>&1',
dirname( dirname( __FILE__ ) ),
$this->run_jobs,
get_site_url(),
$this->core->get_backup_identifier(),
$this->get_cron_secret(),
$this->cron_command,
$cron_interval
);
return $this->update_cron( $entry );
}
/**
* Schedule Site Check.
*
* This method is usually ran after saving the settings. If (after save) cron is our scheduler,
* then we need to make sure we have the "site_check" wp-cron scheduled.
*
* @since 1.10.0
*
* @see BoldGrid_Backup_Admin_Core::get_backup_identifier()
* @see BoldGrid_Backup_Admin_Cron::get_cron_secret()
*
* @param array $settings Settings.
* @return bool
*/
public function schedule_site_check( array $settings = [] ) {
if ( empty( $settings ) ) {
$settings = $this->core->settings->get_settings();
}
if ( empty( $settings['site_check']['enabled'] ) ) {
return false;
}
$args = implode(
' ',
[
'auto_recovery=' . ( ! empty( $settings['site_check']['auto_recovery'] ) ? 1 : 0 ),
'email=' . $settings['notification_email'],
'log=' . ( ! empty( $settings['site_check']['logger'] ) ? 1 : 0 ),
'notify=' . ( ! empty( $settings['notifications']['site_check'] ) ? 1 : 0 ),
]
);
$entry = sprintf(
'*/%1$u * * * * %2$s "%3$s/%4$s" check %5$s >/dev/null 2>&1',
$settings['site_check']['interval'],
$this->cron_command,
dirname( dirname( __FILE__ ) ),
$this->site_check,
$args
);
return $this->update_cron( $entry );
}
/**
* Update or add an entry to the system user crontab or wp-cron.
*
* @since 1.2
*
* @see \Boldgrid\Backup\Admin\Cron\Crontab::write_crontab()
*
* @global WP_Filesystem $wp_filesystem The WordPress Filesystem API global object.
*
* @param string $entry A cron entry.
* @return bool Success.
*/
public function update_cron( $entry ) {
// If no entry was passed, then abort.
if ( empty( $entry ) ) {
return false;
}
if ( $this->entry_exists( $entry ) ) {
return true;
}
// Check if the backup directory is configured.
if ( ! $this->core->backup_dir->get() ) {
return false;
}
$crontab = $this->get_all( true );
$crontab .= "\n" . $entry . "\n";
$crontab_written = ( new \Boldgrid\Backup\Admin\Cron\Crontab() )->write_crontab( $crontab );
return $crontab_written && $this->entry_exists( $entry );
}
/**
* Get the pattern determined by mode passed.
*
* @since 1.11.1
*
* @param string|bool $mode Please see in-method comments below when $pattern is configured.
* @return string
*/
public function get_mode_pattern( $mode = '' ) {
/*
* Configure our regex pattern.
*
* When this method was initially written, $mode was either
* empty (defaulting to "backup") or "restore", hence the first two
* conditionals below.
*
* As of @1.5.2, you can pass any other string to this method, such as
* "cron/run-jobs.php", so that the pattern will become
* /home/user/public_html/wp-content/plugins/boldgrid-backup/cron/run-jobs.php
*
* As of @1.6.0 you can pass true as the $mode so that nothing else is
* added to the pattern and ALL crons for this site will be removed.
*/
$pattern = BOLDGRID_BACKUP_PATH . '/';
switch ( true ) {
case '' === $mode:
case 'backup' === $mode:
$pattern .= 'boldgrid-backup-cron.php" mode=backup';
break;
case 'restore' === $mode:
// Match "boldgrid-backup-cron.php" (old) and "cli/bgbkup-cli.php" (new) in the pattern.
$pattern .= '(boldgrid-backup-cron|cli/bgbkup-cli).php" mode=restore';
break;
case 'jobs' === $mode:
// Match "run_jobs" (old) and "run-jobs" (new) filenames in the pattern.
$pattern .= '(cron/run_jobs.php|' . $this->run_jobs . ')';
break;
case 'site_check' === $mode:
$pattern .= $this->site_check . '" check';
break;
case 'all' === $mode:
case true === $mode:
break;
default:
$pattern .= $mode;
break;
}
// Format the periods in the pattern for regex; ensure a backslash before periods.
$pattern = str_replace( '\.', '.', $pattern );
$pattern = str_replace( '.', '\.', $pattern );
// Escape the regex delimited that we will use.
$pattern = str_replace( '~', '\~', $pattern );
return $pattern;
}
/**
* Remove lines matching the pattern.
*
* @since 1.11.1
*
* @param string $pattern Regex pattern, without delimiter "~".
* @param string $crontab The crontab contents.
* @return string
*/
public function filter_crontab( $pattern, $crontab ) {
$crontab_exploded = explode( "\n", $crontab );
$crontab = '';
foreach ( $crontab_exploded as $line ) {
if ( ! empty( $line ) && ! preg_match( '~' . $pattern . '~', $line ) ) {
$line = trim( $line );
$crontab .= $line . "\n";
}
}
return $crontab;
}
/**
* Delete boldgrid-backup cron entries from the system user crontab.
*
* @since 1.2
*
* @see \Boldgrid_Backup_Admin_Cron::get_mode_pattern()
* @see \Boldgrid_Backup_Admin_Cron::filter_crontab()
* @see \Boldgrid\Backup\Admin\Cron\Crontab::write_crontab()
*
* @param string|bool $mode Please see in-method comments below when $pattern is configured.
* @return bool
*/
public function delete_cron_entries( $mode = '' ) {
if ( ! $this->core->test->is_crontab_available() ) {
return false;
}
if ( ! $this->core->backup_dir->get() ) {
return false;
}
$crontab_helper = new \Boldgrid\Backup\Admin\Cron\Crontab();
$crontab = $this->get_all( true );
if ( false === $crontab ) {
return false;
}
$pattern = $this->get_mode_pattern( $mode );
// If no entries exist, then return success.
if ( ! preg_match( '~' . $pattern . '~', $crontab ) ) {
return true;
}
$crontab = $this->filter_crontab( $pattern, $crontab );
return $crontab_helper->write_crontab( $crontab );
}
/**
* Delete one entry from the crontab.
*
* @since 1.6.0
*
* @see \Boldgrid\Backup\Admin\Cron\Crontab::write_crontab()
* @see \Boldgrid_Backup_Admin_Cron::entry_exists()
*
* @param string $entry Crontab entry.
* @return bool True if the entry does not exist or was deleted successfully.
*/
public function entry_delete( $entry ) {
if ( ! $this->entry_exists( $entry ) ) {
return true;
}
$all_entries = $this->get_all();
$key = array_search( $entry, $all_entries, true );
if ( false !== $key ) {
unset( $all_entries[ $key ] );
}
$all_entries = implode( "\n", $all_entries );
$crontab_written = ( new \Boldgrid\Backup\Admin\Cron\Crontab() )->write_crontab( $all_entries );
return $crontab_written && ! $this->entry_exists( $entry );
}
/**
* Delete all cron entries that contain a string.
*
* @since 1.6.5
*
* @param string $string The string to look for.
*/
public function entry_delete_contains( $string ) {
$all_entries = $this->get_all();
if ( ! is_array( $all_entries ) ) {
return;
}
foreach ( $all_entries as $entry ) {
if ( false !== strpos( $entry, $string ) ) {
$this->entry_delete( $entry );
}
}
}
/**
* Determine if an entry exists in the crontab.
*
* @since 1.6.0
*
* @param string $entry Crontab entry.
* @return bool
*/
public function entry_exists( $entry ) {
$all_entries = $this->get_all();
if ( empty( $all_entries ) ) {
return false;
}
return false !== array_search( $entry, $all_entries, true );
}
/**
* Search for cron entries that contain a specfic string.
*
* @since 1.6.5
*
* @param string $search String to search for.
* @return array An array of matches.
*/
public function entry_search( $search ) {
$matches = array();
$entries = $this->get_all();
if ( empty( $entries ) ) {
return $matches;
}
foreach ( $entries as $entry ) {
if ( false !== strpos( $entry, $search ) ) {
$matches[] = $entry;
}
}
return $matches;
}
/**
* Get all entries in cron.
*
* Prior to 1.13.9, the Boldgrid\Backup\Admin\Cron\Crontab class had a read_crontab() method that
* aimed to do the same thing as this method. However, it only executed "crontab -l" and returned
* the results. It did not take into account that not all lines of the crontab may be returned (this
* method does and has a conditional for it, so is better).
*
* @todo Migrate this method to the Boldgrid\Backup\Admin\Cron\Crontab. This method currently called
* 9+ times, and will need some good testing.
*
* @since 1.5.2
*
* @see Boldgrid_Backup_Admin_Core::execute_command()
*
* @param bool $raw Return a string of crons when true, an array when false.
* @return mixed
*/
public function get_all( $raw = false ) {
/*
* Cron is not available on Windows.
*
* It would be clean to call is_crontab_available(), but that method
* uses this method, and would result in an infinite loop.
*/
if ( $this->core->test->is_windows() ) {
return false;
}
/*
* Attempt to read the crontab.
*
* Historically, we just read the output of "crontab -l". In certain scenarious, this does
* not return the full output of the command. Another solution would be to output that command
* to a file, and then read the file.
*
* As of 1.6.5, we'll first try the latter option.
*/
if ( $this->core->backup_dir->can_exec_write() ) {
$crontab_file_path = $this->core->backup_dir->get_path_to( 'crontab' );
// Write crontab to temp file.
$command = sprintf( 'crontab -l > %1$s', $crontab_file_path );
$this->core->execute_command( $command, $success );
// Read the crontab from temp file.
$crontab = $this->core->wp_filesystem->get_contents( $crontab_file_path );
$success = false !== $crontab;
$this->core->wp_filesystem->delete( $crontab_file_path );
} else {
$command = 'crontab -l';
$crontab = $this->core->execute_command( $command, $success );
}
if ( ! $success ) {
return false;
}
return $raw ? $crontab : explode( "\n", $crontab );
}
/**
* Get all of our cron jobs.
*
* Similar to self::get_all, except only returns crons belonging to this
* installation.
*
* @since 1.5.2
*
* @return array
*/
public function get_our_crons() {
$our = array();
$all = $this->get_all();
if ( empty( $all ) ) {
return $our;
}
foreach ( $all as $cron ) {
if ( false !== strpos( $cron, BOLDGRID_BACKUP_PATH ) ) {
$our[] = $cron;
}
}
return $our;
}
/**
* Get restore command.
*
* Create the cron markup (creates the markup, does not actually add to crontab) to restore a
* backup archive.
*
* Before @since xxx, this method was in add_cron_entry. It has since been moved to its own
* method here for reusability.
*
* @since xxx
*
* return string
*/
public function get_restore_command() {
$entry = '';
// Use the first key to get info on the most recent archive.
if ( ! $this->core->archive->init_by_key( 0 ) ) {
return $entry;
}
$time = $this->core->auto_rollback->get_time_data();
$settings = $this->core->settings->get_settings();
$backup_id = $this->core->get_backup_identifier();
$entry_parts = [
date( $time['minute'] . ' ' . $time['hour'], $time['deadline'] ) . ' * * ' . date( 'w' ),
$this->cron_command,
'"' . dirname( dirname( __FILE__ ) ) . '/cli/bgbkup-cli.php"',
/*
* Info on mode=restore and restore:
*
* The "mode=restore" property is for the cron remove function (it's a pattern searched for),
* and "plain" is used by CLI. If you take out "mode=restore", it will still do the
* restoration but it won't be able to find and delete the cron.
*
* @todo simplify this.
*/
'mode=restore restore',
'notify email=' . $settings['notification_email'],
'backup_id=' . $backup_id,
'zip=' . $this->core->archive->filepath,
];
// If not Windows, then also silence the cron job.
if ( ! $this->core->test->is_windows() ) {
$entry_parts[] = '> /dev/null 2>&1';
}
$entry = implode( ' ', $entry_parts );
return $entry;
}
/**
* Read a line from the cron and return the schedule.
*
* @since 1.5.2
*
* @param string $cron_line An entry from cron.
* @return array Please see the $schedule initialized early in this method.
*/
public function get_schedule( $cron_line ) {
// Initialize $schedule.
$schedule = array(
'dow_sunday' => 0,
'dow_monday' => 0,
'dow_tuesday' => 0,
'dow_wednesday' => 0,
'dow_thursday' => 0,
'dow_friday' => 0,
'dow_saturday' => 0,
'tod_h' => null,
'tod_m' => null,
'tod_a' => null,
);
if ( empty( $cron_line ) ) {
return $schedule;
}
// Parse cron schedule.
preg_match_all( '/([0-9*]+)(,([0-9*])+)*? /', $cron_line, $matches );
// Minute.
if ( isset( $matches[1][0] ) && is_numeric( $matches[1][0] ) ) {
$schedule['tod_m'] = intval( $matches[1][0] );
} else {
return array();
}
// Hour.
if ( isset( $matches[1][1] ) && is_numeric( $matches[1][1] ) ) {
$schedule['tod_h'] = intval( $matches[1][1] );
} else {
return array();
}
// Convert from 24H to 12H time format.
$unix_time = strtotime( $schedule['tod_h'] . ':' . $schedule['tod_m'] );
$schedule['tod_h'] = intval( date( 'g', $unix_time ) );
$schedule['tod_a'] = date( 'A', $unix_time );
// Days of the week.
if ( isset( $matches[0][4] ) ) {
$days = explode( ',', $matches[0][4] );
foreach ( $days as $day ) {
switch ( $day ) {
case 0:
$schedule['dow_sunday'] = 1;
break;
case 1:
$schedule['dow_monday'] = 1;
break;
case 2:
$schedule['dow_tuesday'] = 1;
break;
case 3:
$schedule['dow_wednesday'] = 1;
break;
case 4:
$schedule['dow_thursday'] = 1;
break;
case 5:
$schedule['dow_friday'] = 1;
break;
case 6:
$schedule['dow_saturday'] = 1;
break;
default:
break;
}
}
}
return $schedule;
}
/**
* Print cron report.
*
* @since 1.2
*
* @param array $archive_info An array of archive file information.
*/
public function print_cron_report( $archive_info ) {
// Validate mode.
if ( empty( $archive_info['mode'] ) ) {
wp_die( esc_html__( 'Error: A mode was not specified.', 'boldgrid-backup' ) );
}
$valid_modes = array(
'backup',
'restore',
);
if ( ! in_array( $archive_info['mode'], $valid_modes, true ) ) {
printf(
// translators: 1: Archive mode ("backup" or "restore").
esc_html__( 'Error: Invalid mode "%s".', 'boldgrid-backup' ),
$archive_info['mode'] // phpcs:ignore WordPress.XSS.EscapeOutput.OutputNotEscaped
);
wp_die();
}
// Create action name.
switch ( $archive_info['mode'] ) {
case 'backup':
$action_name = 'creating';
break;
case 'restore':
$action_name = 'restoring';
break;
default:
$action_name = 'handling';
break;
}
// Print report.
if ( ! empty( $archive_info['error'] ) ) {
// Error.
printf(
esc_html__( 'There was an error $s backup archive file.', 'boldgrid-backup' ),
$action_name // phpcs:ignore WordPress.XSS.EscapeOutput.OutputNotEscaped
) . PHP_EOL;
printf(
// translators: 1: Error message.
esc_html__( 'Error: %s', 'boldgrid-backup' ),
$archive_info['error'] // phpcs:ignore WordPress.XSS.EscapeOutput.OutputNotEscaped
) . PHP_EOL;
if ( isset( $archive_info['error_message'] ) ) {
printf(
// translators: 1: Error message.
esc_html__( 'Error Message: %s', 'boldgrid-backup' ),
$archive_info['error_message'] // phpcs:ignore WordPress.XSS.EscapeOutput.OutputNotEscaped
);
}
if ( isset( $archive_info['error_code'] ) ) {
printf(
' (%s)',
esc_html( $archive_info['error_code'] )
) . PHP_EOL;
}
} elseif ( ! empty( $archive_info['filesize'] ) || ! empty( $archive_info['dryrun'] ) ) {
// Dry run.
if ( ! empty( $archive_info['filepath'] ) ) {
printf(
// translators: 1: File path.
esc_html__( 'File Path: %s', 'boldgrid-backup' ),
$archive_info['filepath'] // phpcs:ignore WordPress.XSS.EscapeOutput.OutputNotEscaped
) . PHP_EOL;
}
if ( ! empty( $archive_info['filesize'] ) ) {
printf(
// translators: 1: File size.
esc_html__( 'File Size: %s', 'boldgrid-backup' ),
Boldgrid_Backup_Admin_Utility::bytes_to_human( $archive_info['filesize'] ) // phpcs:ignore WordPress.XSS.EscapeOutput.OutputNotEscaped
) . PHP_EOL;
}
if ( ! empty( $archive_info['total_size'] ) ) {
printf(
// translators: 1: Total backup size.
esc_html__( 'Total size: %s', 'boldgrid-backup' ),
Boldgrid_Backup_Admin_Utility::bytes_to_human( $archive_info['total_size'] ) // phpcs:ignore WordPress.XSS.EscapeOutput.OutputNotEscaped
) . PHP_EOL;
}
if ( ! empty( $archive_info['compressor'] ) ) {
printf(
// translators: 1: Compressor name.
esc_html__( 'Compressor: %s', 'boldgrid-backup' ),
$archive_info['compressor'] // phpcs:ignore WordPress.XSS.EscapeOutput.OutputNotEscaped
) . PHP_EOL;
}
// Show how long the website was paused for.
if ( isset( $archive_info['db_duration'] ) ) {
printf(
esc_html( $this->core->configs['lang']['est_pause'] ),
$archive_info['db_duration'] // phpcs:ignore WordPress.XSS.EscapeOutput.OutputNotEscaped
) . PHP_EOL;
}
if ( isset( $archive_info['duration'] ) ) {
printf(
// translators: 1: Backup duration.
esc_html__( 'Duration: %s seconds', 'boldgrid-backup' ),
$archive_info['duration'] // phpcs:ignore WordPress.XSS.EscapeOutput.OutputNotEscaped
) . PHP_EOL;
}
} else {
// Unknown error.
printf(
// translators: 1: Backup action name.
esc_html__(
'There was an unknown error %s a backup archive file.',
'boldgrid-backup'
),
$action_name // phpcs:ignore WordPress.XSS.EscapeOutput.OutputNotEscaped
) . PHP_EOL;
}
}
/**
* Get the cron secret used to validate unauthenticated crontab jobs.
*
* @since 1.6.1-rc.1
*
* @see BoldGrid_Backup_Admin_Settings::get_settings()
*
* @return string
*/
public function get_cron_secret() {
if ( empty( $this->cron_secret ) ) {
$settings = $this->core->settings->get_settings( true );
if ( empty( $settings['cron_secret'] ) ) {
$settings['cron_secret'] = hash( 'sha256', openssl_random_pseudo_bytes( 21 ) );
update_site_option( 'boldgrid_backup_settings', $settings );
}
$this->cron_secret = $settings['cron_secret'];
}
return $this->cron_secret;
}
/**
* Validate an unauthenticated wp_ajax_nopriv_ call by backup id and cron secret.
*
* @since 1.6.1-rc.1
*
* @uses $_GET['id']
* @uses $_GET['secret']
*
* @see current_user_can()
* @see BoldGrid_Backup_Admin_Core::get_backup_identifier()
* @see BoldGrid_Backup_Admin_Cron::get_cron_secret()
*
* @return bool
*/
public function is_valid_call() {
// phpcs:disable WordPress.CSRF.NonceVerification.NoNonceVerification
$backup_id_match = ! empty( $_GET['id'] ) &&
$this->core->get_backup_identifier() === sanitize_key( $_GET['id'] );
$cron_secret_match = ! empty( $_GET['secret'] ) &&
$this->get_cron_secret() === $_GET['secret'];
// phpcs:enable WordPress.CSRF.NonceVerification.NoNonceVerification
return current_user_can( 'update_plugins' ) || ( $backup_id_match && $cron_secret_match );
}
/**
* Upgrade crontab entries, if not already upgraded.
*
* @since 1.6.1-rc.1
*
* @see BoldGrid_Backup_Admin_Settings::get_settings()
* @see BoldGrid_Backup_Admin_Cron::add_all_crons()
*
* @return bool Returns TRUE only if an upgrade was performed.
*/
public function upgrade_crontab_entries() {
$upgraded = false;
$settings = $this->core->settings->get_settings( true );
if ( empty( $settings['crontab_version'] ) ||
$this->crontab_version !== $settings['crontab_version'] ) {
// Delete and recreate the crontab entries.
$upgraded = $this->add_all_crons( $settings );
if ( $upgraded ) {
/**
* Action when the crontab entry upgrade is successfully completed.
*
* @since 1.6.1-rc.1
*
* @param string The new crontab entry version.
*/
do_action(
'boldgrid_backup_upgrade_crontab_entries_complete',
$this->crontab_version
);
}
}
return $upgraded;
}
/**
* Hook into "wp_ajax_nopriv_boldgrid_backup_run_backup" and generate backup.
*
* A scheduled backup (via cron) will call a url which ultimately triggers this method to be ran
* to backup the site.
*
* @since 1.6.1
*
* @see Boldgrid_Backup_Admin_Cron::is_valid_call()
*
* @return array An array of archive file information.
*/
public function backup() {
if ( ! $this->is_valid_call() ) {
wp_die( esc_html__( 'Error: Invalid request.', 'boldgrid-backup' ) );
}
$archiver = new Boldgrid_Backup_Archiver();
$archiver->run();
return $archiver->get_info();
}
/**
* Hook into "wp_ajax_nopriv_boldgrid_backup_run_restore" and restores from backup.
*
* @since 1.6.1-rc.1
*
* @see Boldgrid_Backup_Admin_Cron::is_valid_call()
*
* @return array An array of archive file information.
*/
public function restore() {
// phpcs:disable WordPress.CSRF.NonceVerification.NoNonceVerification
$task_id = ! empty( $_POST['task_id'] ) ? $_POST['task_id'] : null;
// phpcs:enable WordPress.CSRF.NonceVerification.NoNonceVerification
if ( ! $this->is_valid_call() ) {
wp_die( esc_html__( 'Error: Invalid request.', 'boldgrid-backup' ) );
}
// A default error to return if restoration is not started in conditionals below.
$archive_info = [
'error' => __( 'Unknown error attempting restore.', 'boldgrid-backup' ),
];
/*
* Restore an archive.
*
* As of @SINCEVERSION, archives can be restored via REST. If we have a task, we're handling
* a REST restore. Otherwise, we're handling a standard restore request.
*/
if ( ! empty( $task_id ) ) {
$task = new Boldgrid_Backup_Admin_Task();
$task_found = $task->init_by_id( $task_id );
$restorer = new Boldgrid_Backup_Restorer();
if ( ! $task_found ) {
$archive_info = [
'error' => __( 'Resore error: Unable to instantiate task.', 'boldgrid-backup' ),
];
} elseif ( false !== $task->get_data( 'url' ) ) {
$restorer->run_by_url( $task->get_data( 'url' ) );
$archive_info = $restorer->get_info();
} elseif ( false !== $task->get_data( 'backup_id' ) ) {
$restorer->run_by_id( $task->get_data( 'backup_id' ) );
$archive_info = $restorer->get_info();
} else {
$archive_info = [
'error' => __( 'Restore error: Missing url / id.', 'boldgrid-backup' ),
];
}
} else {
if ( $this->core->restore_helper->prepare_restore() ) {
$archive_info = $this->core->restore_archive_file();
}
}
return $archive_info;
}
}
admin/class-boldgrid-backup-admin-cron-log.php 0000644 00000013370 14757772271 0015334 0 ustar 00
*/
/**
* Class: Boldgrid_Backup_Admin_Cron_Log
*
* @since 1.6.5
*/
class Boldgrid_Backup_Admin_Cron_Log {
/**
* The core class object.
*
* @since 1.6.5
* @access private
* @var Boldgrid_Backup_Admin_Core
*/
private $core;
/**
* The full path to the log file.
*
* @since 1.6.5
* @access private
* @var string
*/
private $log_path;
/**
* The name of our log file.
*
* @since 1.6.5
* @access static
* @var string
*/
public static $log_name = 'boldgrid-backup-cron.log';
/**
* Constructor.
*
* @since 1.6.5
*
* @param Boldgrid_Backup_Admin_Core $core Core class object.
*/
public function __construct( $core ) {
$this->core = $core;
$this->log_path = trailingslashit( BOLDGRID_BACKUP_PATH ) . self::$log_name;
}
/**
* Add an entry to the log.
*
* This is a static method accessed outside of the scope of WordPress (boldgrid-backup-cron.php).
* Therefore, we do not have access to any WordPress specific functions.
*
* @since 1.6.5
*
* @param string $message A message to add to the log.
*/
public static function add_log( $message ) {
$file = dirname( __DIR__ ) . '/' . self::$log_name;
$data = array();
// Get data already in the file.
if ( file_exists( $file ) && is_readable( $file ) ) {
$current_contents = file_get_contents( $file ); // phpcs:ignore
$data = empty( $current_contents ) ? array() : json_decode( $current_contents, true );
}
$data[] = array(
'time' => time(),
'message' => $message,
'read' => false,
);
// Only keep the last 10 entries.
$data = array_slice( $data, -10, 10 );
file_put_contents( $file, json_encode( $data ) ); // phpcs:ignore
}
/**
* Display an admin notice to the user informing them of new cron notices.
*
* @since 1.6.5
*/
public function admin_notice() {
if ( ! current_user_can( 'update_plugins' ) || ! $this->has_unread() || $this->on_log_page() ) {
return;
}
$message = sprintf(
wp_kses(
/* translators: %1$s is the URL to view the cron log. */
__( 'Your latest scheduled backup may not have finished successfully. For more info, please click here to see your latest cron notices.', 'boldgrid-backup' ),
array(
'a' => array(
'href' => array(),
),
'em' => array(),
'strong' => array(),
)
), esc_url( 'admin.php?page=boldgrid-backup-tools§ion=section_cron_log' )
);
$this->core->notice->boldgrid_backup_notice( $message );
}
/**
* Get our log.
*
* @since 1.6.5
*
* @return array An array of log entries.
*/
public function get_log() {
$log = array();
if ( ! $this->core->wp_filesystem->exists( $this->log_path ) || ! $this->core->wp_filesystem->is_readable( $this->log_path ) ) {
return $log;
}
$contents = $this->core->wp_filesystem->get_contents( $this->log_path );
return json_decode( $contents, true );
}
/**
* Generate and return the markup displaying our log entries.
*
* @since 1.6.5
*/
public function get_markup() {
// If we're getting the markup, the user is looking at it. Mark it as read.
$this->set_as_read();
$log = $this->get_log();
$markup = '
' . __( 'If a scheduled backup cron fails, an error message will be logged to the cron notices log file. You can view those log entries below:', 'boldgrid-backup' ) . '
';
if ( empty( $log ) ) {
$markup .= '
' . __( 'No entries in the log.', 'boldgrid-backup' ) . '
';
}
return $markup;
}
/**
* Whether or not there are unread messages.
*
* @since 1.6.5
*
* @return bool
*/
public function has_unread() {
$log = $this->get_log();
if ( empty( $log ) ) {
return false;
}
foreach ( $log as $item ) {
if ( empty( $item['read'] ) ) {
return true;
}
}
return false;
}
/**
* Whether or not we are on the logs page.
*
* Specifically, if the user clicked "click here" to be taken to
* admin.php?page=boldgrid-backup-tools§ion=section_cron_log
*
* @since 1.6.5
*
* @return bool
*/
public function on_log_page() {
global $pagenow;
$on_login_page = 'admin.php' === $pagenow;
$params = array(
array(
'key' => 'page',
'value' => 'boldgrid-backup-tools',
),
array(
'key' => 'section',
'value' => 'section_cron_log',
),
);
foreach ( $params as $param ) {
if ( empty( $_GET[ $param['key'] ] ) || $param['value'] !== $_GET[ $param['key'] ] ) { // phpcs:ignore
$on_login_page = false;
}
}
return $on_login_page;
}
/**
* Set the log as being read.
*
* @since 1.6.5
*
* @return bool Whether or not the log file was updated successfully.
*/
public function set_as_read() {
$log = $this->get_log();
if ( empty( $log ) ) {
return true;
}
foreach ( $log as &$item ) {
$item['read'] = true;
}
return $this->core->wp_filesystem->put_contents( $this->log_path, wp_json_encode( $log ) );
}
}
admin/class-boldgrid-backup-admin-core.php 0000644 00000270254 14757772271 0014552 0 ustar 00
*
* phpcs:disable WordPress.VIP
*/
/**
* Class: Boldgrid_Backup_Admin_Core
*
* @since 1.0
*/
class Boldgrid_Backup_Admin_Core {
/**
* Archiver Utility class.
*
* @since 1.9.0
* @var Boldgrid_Backup_Admin_Archiver_Utility
*/
public $archiver_utility;
/**
* Auto Rollback class.
*
* @since 1.5.2
* @var Boldgrid_Backup_Admin_Auto_Rollback
*/
public $auto_rollback;
/**
* An instance of Boldgrid_Backup_Admin_Dashboard
*
* @since 1.11.0
* @var Boldgrid_Backup_Admin_Dashboard
*/
public $dashboard;
/**
* Dashboard widget.
*
* @since 1.10.0
* @var Boldgrid_Backup_Admin_Dashboard_Widget
*/
public $dashboard_widget;
/**
* The settings class object.
*
* @since 1.0
* @var Boldgrid_Backup_Admin_Settings
*/
public $settings;
/**
* The configuration class object.
*
* @since 1.0
* @var Boldgrid_Backup_Admin_Config
*/
public $config;
/**
* Plugin configs.
*
* @since 1.3.4
* @var array
*/
public $configs;
/**
* Plugin class.
*
* @since 1.13.0
* @var Boldgrid\Library\Library\Plugin\Plugin
*/
public $plugin;
/**
* Core Files class.
*
* @since 1.6.0
* @var Boldgrid_Backup_Admin_Core_Files
*/
public $core_files;
/**
* Whether or not we're in ajax.
*
* When we're on the archives page and click "Backup Site Now", when
* this->archive_files runs, it reports doing_ajax as true.
*
* @since 1.5.2
* @var bool
*/
public $doing_ajax;
/**
* Whether or not we're doing cron.
*
* Please see $this->set_doing_cron() for further clarification.
*
* @since 1.5.1
* @var bool
*/
public $doing_cron;
/**
* Whether or not we're doing wp_cron.
*
* In WordPress' wp-cron.php DOING_CRON is defined as true. In several of
* our files, we define DOING_CRON as well. When we want to tell the
* difference between (1)wp-cron.php and (2)cron / cli, it's difficult.
* This property is solely to know if we're in wp-cron.php.
*
* @todo Within our plugins, DOING_CRON should be cleaned up.
*
* @since 1.6.0
*
* @var bool
*/
public $doing_wp_cron;
/**
* Email.
*
* @since 1.5.2
* @var Boldgrid_Backup_Admin_Email
*/
public $email;
/**
* Elements.
*
* Common elements used throughout admin pages. Usually a combination of
* language strings.
*
* @since 1.5.3
* @var Boldgrid_Backup_Admin_Email
*/
public $elements = [];
/**
* The functionality test class object.
*
* @since 1.0
* @var Boldgrid_Backup_Admin_Test
*/
public $test;
/**
* The Time class object.
*
* @since 1.6.0
* @var Boldgrid_Backup_Admin_Time
*/
public $time;
/**
* An instance of Boldgrid_Backup_Admin_Tools.
*
* @since 1.6.0
* @var Boldgrid_Backup_Admin_Tools
*/
public $tools;
/**
* An instance of Boldgrid_Backup_Admin_Transfers.
*
* @since 1.11.0
* @var Boldgrid_Backup_Admin_Transfers
*/
public $transfers;
/**
* An instance of Boldgrid_Backup_Admin_Support.
*
* @since 1.10.1
* @var Boldgrid_Backup_Admin_Support
*/
public $support;
/**
* An instance of Boldgrid_Backup_Admin_Premium.
*
* @since 1.12.4
* @var Boldgrid_Backup_Admin_Premium_Features
*/
public $premium_page;
/**
* An instance of Boldgrid_Backup_Admin_Utility.
*
* @since 1.5.3
* @var Boldgrid_Backup_Admin_Utility
*/
public $utility;
/**
* The admin notice class object.
*
* @since 1.0
* @var Boldgrid_Backup_Admin_Notice
*/
public $notice;
/**
* WordPress' global pagenow.
*
* @since 1.6.0
* @var string
*/
public $pagenow;
/**
* A bool indicating at the time of archivign files whether or not the
* current_filter() was pre_auto_update (the action ran immediately before
* WordPress does an auto upgrade).
*
* @since 1.6.0
* @var bool
*/
public $pre_auto_update = false;
/**
* The admin cron class object.
*
* @since 1.0
* @var Boldgrid_Backup_Admin_Cron
*/
public $cron;
/**
* Cron log class.
*
* @since 1.6.5
* @var Boldgrid_Backup_Admin_Cron_Log
*/
public $cron_log;
/**
* Cron test class.
*
* @since 1.6.5
* @var Boldgrid_Backup_Admin_Cron_Test
*/
public $cron_test;
/**
* The admin xhprof class object.
*
* @since 1.2
* @var Boldgrid_Backup_Admin_Xhprof
*/
public $xhprof;
/**
* WP Cron class.
*
* @since 1.5.1
* @var Boldgrid_Backup_Admin_WP_Cron
*/
public $wp_cron;
/**
* An instance of the filesystem.
*
* @since 1.5.1
* @var WP_Filesystem
*/
public $wp_filesystem;
/**
* An instance of the Boldgrid_Backup_Admin_Archive class.
*
* @since 1.5.3
* @var Boldgrid_Backup_Admin_Archive
*/
public $archive;
/**
* An instance of the Boldgrid_Backup_Admin_Archives class.
*
* @since 1.6.0
* @var Boldgrid_Backup_Admin_Archives
*/
public $archives;
/**
* An instance of the Boldgrid_Backup_Admin_Archives_All class.
*
* @since 1.6.0
* @var Boldgrid_Backup_Admin_Archives_All
*/
public $archives_all;
/**
* An instance of the Boldgrid_Backup_Admin_Archive_Actions class.
*
* @since 1.6.0
* @var Boldgrid_Backup_Admin_Archive_Actions
*/
public $archive_actions;
/**
* An instance of the Boldgrid_Backup_Admin_Archive_Browser class.
*
* @since 1.5.2
* @var Boldgrid_Backup_Admin_Archive_Browser
*/
public $archive_browser;
/**
* An instance of the Archive Log class.
*
* @since 1.5.1
* @var Boldgrid_Backup_Admin_Archive_Log
*/
public $archive_log;
/**
* An instance of the Archive Details class.
*
* @since 1.5.1
* @var Boldgrid_Backup_Admin_Archive_Details
*/
public $archive_details;
/**
* An instance of the Archive Fail class.
*
* @since 1.5.2
* @var Boldgrid_Backup_Admin_Archive_Fail
*/
public $archive_fail;
/**
* Archive filepath.
*
* This is similar to $db_dump_filepath, but holds the path to the archive instead of the .sql file.
* This is being added in 1.14.13 to handle the scenario of a user canceling a backup. If the
* user does cancel the backup, we need to delete it (which is handled in archive-fail).
*
* @since 1.14.13
* @var string
*/
public $archive_filepath;
/**
* Whether or not we're in the middle of archiving files.
*
* This is set at the beginning and end of self::archive_files().
*
* @since 1.13.4
* @var bool
*/
public $archiving_files = false;
/**
* Db Dump.
*
* @since 1.5.3
* @var Boldgrid_Backup_Admin_Db_Dump
*/
public $db_dump;
/**
* Database backup file path.
*
* @since 1.0
* @var string
*/
public $db_dump_filepath = '';
/**
* Db Get.
*
* @since 1.5.3
* @var Boldgrid_Backup_Admin_Db_Dump
*/
public $db_get;
/**
* An instance of Boldgrid_Backup_Admin_Db_Omit.
*
* @since 1.5.3
* @var Boldgrid_Backup_Admin_Db_Omit
*/
public $db_omit;
/**
* Database Restoration errro
*
* @since 1.14.0
* @var string
*/
public $db_restore_error;
/**
* An instance of Boldgrid_Backup_Admin_Filelist.
*
* @since 1.5.1
* @var Boldgrid_Backup_Admin_Filelist
*/
public $filelist;
/**
* Base directory for the get_filelist method.
*
* @since 1.0
* @access private
* @var string
*/
private $filelist_basedir = null;
/**
* An instance of the Boldgrid_Backup_Admin_Folder_Exclusion class.
*
* @since 1.6.0
* @var Boldgrid_Backup_Admin_Folder_Exclusion
*/
public $folder_exclusion;
/**
* An instance of the Boldgrid_Backup_Admin_Ftp class.
*
* @since 1.6.0
* @var Boldgrid_Backup_Admin_Ftp
*/
public $ftp;
/**
* An instance of the Boldgrid_Backup_Admin_Go_Pro class.
*
* @since 1.6.0
* @var Boldgrid_Backup_Admin_Go_Pro
*/
public $go_pro;
/**
* An instance of Boldgrid_Backup_Admin_Backup_Dir.
*
* @since 1.5.1
* @var Boldgrid_Backup_Admin_Backup_Dir
*/
public $backup_dir;
/**
* A unique identifier for backups of this WordPress installation.
*
* @since 1.0.1
* @access private
* @var string
*/
private $backup_identifier = null;
/**
* Value indicating we are in the Backup Site Now callback and the user is
* choosing a full backup.
*
* @since 1.6.0
* @var bool
*/
public $is_backup_full = false;
/**
* Value indicating we are in the Backup Site Now callback.
*
* @since 1.6.0
* @var bool
*/
public $is_backup_now = false;
/**
* An instance of Boldgrid_Backup_Admin_Home_Dir.
*
* @since 1.5.1
* @var Boldgrid_Backup_Admin_Home_Dir
*/
public $home_dir;
/**
* An instance of the In Progress class.
*
* @since 1.6.0
* @var Boldgrid_Backup_Admin_In_Progress object.
*/
public $in_progress;
/**
* Value indicating whether or not we're creating a backup for update
* protection.
*
* @since 1.6.0
* @var bool
*/
public $is_archiving_update_protection = false;
/**
* Whether or not we are in a scheduled backup (IE a cron backup).
*
* @since 1.9.0
* @var bool
*/
public $is_scheduled_backup;
/**
* Common elements.
*
* @since 1.5.3
* @var array
*/
public $lang = [];
/**
* Local storage.
*
* @since 1.5.2
* @var Boldgrid_Backup_Admin_Storage_Local
*/
public $local;
/**
* Log page.
*
* @since 1.12.5
* @var Boldgrid_Backup_Admin_Log_Page
*/
public $log_page;
/**
* Logger.
*
* @since 1.12.5
* @var Boldgrid_Backup_Admin_Log
*/
public $logger;
/**
* Path to our config.rating-prompt.php file.
*
* @since 1.7.2
* @var string
*/
public $rating_prompt_config;
/**
* The Restore Helper class.
*
* @since 1.6.1
* @var Boldgrid_Backup_Admin_Restore_Helper
*/
public $restore_helper;
/**
* Whether or not we are in the middle of restoring an archive.
*
* @since 1.13.5
* @var bool
*
* @see self::archiving_files
*/
public $restoring_archive_file = false;
/**
* The scheduler class object.
*
* @since 1.5.1
* @var Boldgrid_Backup_Admin_Scheduler
*/
public $scheduler;
/**
* The public download class object.
*
* @since 1.7.0
* @var Boldgrid_Backup_Download
*/
public $download;
/**
* An instance of the Boldgrid\Library\Library\Activity class.
*
* @since 1.7.2
* @var Boldgrid\Library\Library\Activity
*/
public $activity;
/**
* An instance of the Auto Updates class
*
* @since 1.14.0
* @var Boldgrid_Backup_Admin_Auto_Updates
*/
public $auto_updates;
/**
* An Instance of the Upload class.
*
* @since 1.2.2
* @var Boldgrid_Backup_Admin_Upload
*/
public $upload;
/**
* An instance of the Restore Git class.
*
* @since 1.5.1
* @var Boldgrid_Backup_Admin_Restore_Git
*/
public $restore_git;
/**
* An instance of the Compressors class.
*
* @since 1.5.1
* @var Boldgrid_Backup_Admin_Compressors
*/
public $compressors;
/**
* An instance of the Remote class
*
* @since 1.5.2
* @var Boldgrid_Backup_Admin_Remote
*/
public $remote;
/**
* An instance of the Jobs class
*
* @since 1.5.2
* @var Boldgrid_Backup_Admin_Jobs
*/
public $jobs;
/**
* An instance of the Premium class
*
* @since 1.0.0
* @var Boldgrid_Backup_Premium
*/
public $premium;
/**
* Constructor.
*
* @since 1.0
*
* @global $wp_filesystem
*/
public function __construct() {
/*
* Moves the definition of 'boldgrid_backup_get_core' from Boldgrid_Backup here.
* This should help prevent issues where this filter doesn't work in some places.
*/
add_filter( 'boldgrid_backup_get_core', array( $this, 'get_core' ), 10, 1 );
WP_Filesystem();
global $wp_filesystem;
global $pagenow;
$this->set_doing_cron();
$this->doing_ajax = is_admin() && defined( 'DOING_AJAX' ) && DOING_AJAX;
$this->doing_wp_cron = ! empty( $_SERVER['SCRIPT_FILENAME'] ) &&
trailingslashit( ABSPATH ) . 'wp-cron.php' === $_SERVER['SCRIPT_FILENAME'];
$this->wp_filesystem = $wp_filesystem;
$this->pagenow = $pagenow;
// Instantiate Configs Array
$this->configs = Boldgrid_Backup_Admin::get_configs();
// Instantiate Boldgrid_Backup_Admin_Settings.
$this->settings = new Boldgrid_Backup_Admin_Settings( $this );
// Instantiate Boldgrid_Backup_Admin_Config.
$this->config = new Boldgrid_Backup_Admin_Config( $this );
// Instantiate Boldgrid_Backup_Admin_Test.
$this->test = new Boldgrid_Backup_Admin_Test( $this );
// Instantiate Boldgrid_Backup_Admin_Notice.
$this->notice = new Boldgrid_Backup_Admin_Notice( $this );
// Instantiate Boldgrid_Backup_Admin_Cron.
$this->cron = new Boldgrid_Backup_Admin_Cron( $this );
// Instantiate Boldgrid_Backup_Admin_Upload.
$this->upload = new Boldgrid_Backup_Admin_Upload( $this );
// Instantiate Boldgrid_Backup_Admin_Xhprof.
// Starts profiling and saves a report, if enabled in the "config.local.php" file.
$this->xhprof = new Boldgrid_Backup_Admin_Xhprof();
$this->restore_helper = new Boldgrid_Backup_Admin_Restore_Helper();
$this->restore_git = new Boldgrid_Backup_Admin_Restore_Git();
$this->filelist = new Boldgrid_Backup_Admin_Filelist( $this );
$this->backup_dir = new Boldgrid_Backup_Admin_Backup_Dir( $this );
$this->home_dir = new Boldgrid_Backup_Admin_Home_Dir( $this );
$this->compressors = new Boldgrid_Backup_Admin_Compressors( $this );
$this->archive_browser = new Boldgrid_Backup_Admin_Archive_Browser( $this );
$this->archive = new Boldgrid_Backup_Admin_Archive( $this );
$this->archive_actions = new Boldgrid_Backup_Admin_Archive_Actions( $this );
$this->archives = new Boldgrid_Backup_Admin_Archives( $this );
$this->archives_all = new Boldgrid_Backup_Admin_Archives_All( $this );
$this->archive_log = new Boldgrid_Backup_Admin_Archive_Log( $this );
$this->archive_details = new Boldgrid_Backup_Admin_Archive_Details( $this );
$this->archive_fail = new Boldgrid_Backup_Admin_Archive_Fail( $this );
$this->archiver_utility = new Boldgrid_Backup_Admin_Archiver_Utility( $this );
$this->wp_cron = new Boldgrid_Backup_Admin_WP_Cron( $this );
$this->scheduler = new Boldgrid_Backup_Admin_Scheduler( $this );
$this->auto_rollback = new Boldgrid_Backup_Admin_Auto_Rollback( $this );
$this->remote = new Boldgrid_Backup_Admin_Remote( $this );
$this->jobs = new Boldgrid_Backup_Admin_Jobs( $this );
$this->local = new Boldgrid_Backup_Admin_Storage_Local( $this );
$this->email = new Boldgrid_Backup_Admin_Email( $this );
$this->db_omit = new Boldgrid_Backup_Admin_Db_Omit( $this );
$this->db_dump = new Boldgrid_Backup_Admin_Db_Dump( $this );
$this->db_get = new Boldgrid_Backup_Admin_Db_get( $this );
$this->utility = new Boldgrid_Backup_Admin_Utility();
$this->folder_exclusion = new Boldgrid_Backup_Admin_Folder_Exclusion( $this );
$this->core_files = new Boldgrid_Backup_Admin_Core_Files( $this );
$this->in_progress = new Boldgrid_Backup_Admin_In_Progress( $this );
$this->ftp = new Boldgrid_Backup_Admin_Ftp( $this );
$this->go_pro = new Boldgrid_Backup_Admin_Go_Pro( $this );
$this->tools = new Boldgrid_Backup_Admin_Tools( $this );
$this->transfers = new Boldgrid_Backup_Admin_Transfers( $this );
$this->support = new Boldgrid_Backup_Admin_Support( $this );
$this->time = new Boldgrid_Backup_Admin_Time( $this );
$this->cron_test = new Boldgrid_Backup_Admin_Cron_Test( $this );
$this->cron_log = new Boldgrid_Backup_Admin_Cron_Log( $this );
$this->download = new Boldgrid_Backup_Download( $this );
$this->dashboard_widget = new Boldgrid_Backup_Admin_Dashboard_Widget( $this );
$this->dashboard = new Boldgrid_Backup_Admin_Dashboard( $this );
/**
* For backwards compatibility with plugins using previous versions of the Library, this will
* allow the plugins to be instantiated without using the new Factory methods.
*/
$this->plugin = new \Boldgrid\Library\Library\Plugin\Plugin( 'boldgrid-backup', $this->configs );
$this->premium_page = new Boldgrid_Backup_Admin_Premium_Features( $this );
// Instantiate Boldgrid_Backup_Admin_Auto_Updates.
if ( Boldgrid_Backup_Admin_Utility::is_active() ) {
$this->auto_updates = new Boldgrid_Backup_Admin_Auto_Updates();
}
// Ensure there is a backup identifier.
$this->get_backup_identifier();
$this->set_lang();
// Log system.
$this->logger = new Boldgrid_Backup_Admin_Log( $this );
$this->log_page = new Boldgrid_Backup_Admin_Log_Page( $this );
// Need to construct class so necessary filters are added.
if ( class_exists( '\Boldgrid\Library\Library\Ui' ) ) {
$ui = new \Boldgrid\Library\Library\Ui();
}
// Setup library's Activity and RatingPrompt classes; init RatingPrompt to add necessary filters.
$this->rating_prompt_config = BOLDGRID_BACKUP_PATH . '/includes/config/config.rating-prompt.php';
if ( class_exists( '\Boldgrid\Library\Library\RatingPrompt' ) ) {
new \Boldgrid\Library\Library\RatingPrompt();
}
if ( class_exists( '\Boldgrid\Library\Library\Activity' ) ) {
$this->activity = new \Boldgrid\Library\Library\Activity( BOLDGRID_BACKUP_KEY );
}
}
/**
* Get the unique identifier for backups of this WordPress installation.
*
* @since 1.0.1
*
* @return string A unique identifier for backups.
*/
public function get_backup_identifier() {
// If the id was already stored, then return it.
if ( ! empty( $this->backup_identifier ) ) {
return $this->backup_identifier;
}
// Check wp_options for the id.
$backup_identifier = get_site_option( 'boldgrid_backup_id' );
// If the id was already stored in WP options, then save and return it.
if ( ! empty( $backup_identifier ) ) {
$this->backup_identifier = $backup_identifier;
return $backup_identifier;
}
// Generate a new backup id.
$admin_email = $this->config->get_admin_email();
$unique_string = site_url() . ' <' . $admin_email . '>';
$backup_identifier = hash( 'crc32', hash( 'sha512', $unique_string ) );
// If something went wrong with hashing, then just use a random string to make the id.
if ( empty( $backup_identifier ) ) {
$random_string = '';
for ( $i = 0; $i <= 32; $i ++ ) {
$random_string .= chr( mt_rand( 40, 126 ) );
}
$backup_identifier = hash( 'crc32', $random_string );
}
// Save and return the id.
$this->backup_identifier = $backup_identifier;
update_site_option( 'boldgrid_backup_id', $backup_identifier );
return $backup_identifier;
}
/**
* Get core.
*
* Callable via the boldgrid_backup_get_core filter.
*
* @since 1.7.2
*
* @return Boldgrid_Backup_Admin_Core object.
*/
public function get_core() {
return $this;
}
/**
* Initialize the premium version of the plugin.
*
* @since 1.5.2
*
* @global string $pagenow
*/
public function init_premium() {
global $pagenow;
$premium_class = 'Boldgrid_Backup_Premium';
/*
* Only initialize premium if both the plugin exists, is activated, and
* we have a premium key.
*/
if ( ! class_exists( $premium_class ) || ! $this->config->get_is_premium() ) {
return;
}
/*
* If this version of the backup plugin is not compatible with the premium version:
* 1. Don't init the premium extension.
* 2. Display an admin notice telling the user to upgrade.
*/
if ( ! $this->support->is_premium_compatible() ) {
if ( 'update-core.php' !== $pagenow ) {
add_action( 'admin_notices', function() {
$message = wp_kses(
sprintf(
// Translators: 1 The minimum version required, 2 an opening strong tag, 3 its closing strong tag, 4 an opening anchor to the updates page, 5 its closing anchor, 6: Plugin title, 7: Premium plugin title.
__(
'The version of the %2$s%7$s%3$s plugin you have installed requires %2$s%6$s%3$s version %1$s or higher. Don\'t worry, the fix is simple. Please go to your %4$sUpdates page%5$s and update the %2$s%6$s%3$s plugin.',
'boldgrid-backup'
),
BOLDGRID_BACKUP_MIN_VERSION_FOR_PREMIUM,
'',
'',
'',
'',
BOLDGRID_BACKUP_TITLE,
BOLDGRID_BACKUP_TITLE . ' Premium'
),
[
'strong' => [],
'a' => [
'href' => [],
],
]
);
$notice_markup = $this->notice->get_notice_markup(
'notice notice-error is-dismissible',
$message,
BOLDGRID_BACKUP_TITLE . ' - ' . esc_html__( 'Update required', 'boldgrid-backup' )
);
echo $notice_markup; // phpcs:ignore
});
}
return;
}
$this->premium = new $premium_class( $this );
$this->premium->run();
}
/**
* Execute a system command using an array of execution functions.
*
* @since 1.0
*
* @see Boldgrid_Backup_Admin_Cli::call_command()
*
* @param string $command A command string to be executed.
* @param bool $success Success or failure of the operation, passed back.
* @param int $return_var If present, the return_var, passed back.
* @param string $filepath An optional file path to write the output.
* @return string|bool Returns the command output or FALSE on error.
*/
public function execute_command( $command, &$success = false, &$return_var = 0, $filepath = null ) {
// If no command was passed, then fail.
if ( empty( $command ) ) {
return false;
}
// If an output filepath is supplied, and the directory is writable, then write to file.
if ( $filepath && $this->wp_filesystem->is_writable( dirname( $filepath ) ) ) {
$command .= ' > ' . wp_normalize_path( $filepath );
}
// Disable stderr.
if ( ! $this->test->is_windows() && false === strpos( $command, '2>/dev/null' ) ) {
$command .= ' 2>/dev/null';
}
$output = Boldgrid_Backup_Admin_Cli::call_command( $command, $success, $return_var );
return $output;
}
/**
* Add menu items.
*
* @since 1.0
*
* @global array $submenu
*/
public function add_menu_items() {
global $submenu;
$lang = [
'backup_archive' => esc_html__( 'Backup Archives', 'boldgrid-backup' ),
'boldgrid_backup' => BOLDGRID_BACKUP_TITLE,
'get_premium' => esc_html__( 'Get Premium', 'boldgrid-bacukp' ),
'preflight_check' => esc_html__( 'Preflight Check', 'boldgrid-backup' ),
'settings' => esc_html__( 'Settings', 'boldgrid-backup' ),
'tools' => esc_html__( 'Tools', 'boldgrid-backup' ),
'transfers' => esc_html__( 'Transfers', 'boldgrid-backup' ),
'support' => esc_html__( 'Support', 'boldgrid-backup' ),
'premium' => esc_html__( 'Premium Features', 'boldgrid-backup' ),
];
// The main slug all sub menu items are children of.
$main_slug = 'boldgrid-backup-dashboard';
// The capability required for these menu items to be displayed to the user.
$capability = 'administrator';
// Add the main menu item.
add_menu_page(
$lang['boldgrid_backup'],
// This value is escaped already by Library\Plugin\Page::getUnreadMarkup
$lang['boldgrid_backup'],
$capability,
$main_slug,
[
$this->dashboard,
'page',
],
'none'
);
// Add our "Dashboard" page.
add_submenu_page(
$main_slug,
__( 'Dashboard', 'boldgrid-backup' ),
__( 'Dashboard', 'boldgrid-backup' ),
$capability,
'boldgrid-backup-dashboard',
[
$this->dashboard,
'page',
]
);
// Add "Backup Archive page".
add_submenu_page(
$main_slug,
'BoldGrid ' . $lang['backup_archive'],
$lang['backup_archive'],
$capability,
'boldgrid-backup',
[
$this,
'page_archives',
]
);
// Add "Transfers" page.
add_submenu_page(
$main_slug,
$lang['boldgrid_backup'] . ' ' . $lang['transfers'],
$lang['transfers'],
$capability,
'boldgrid-backup-transfers',
[
$this->transfers,
'page',
]
);
// Add "Tools" page.
add_submenu_page(
$main_slug,
$lang['boldgrid_backup'] . ' ' . $lang['tools'],
$lang['tools'],
$capability,
'boldgrid-backup-tools',
[
$this->tools,
'page',
]
);
/*
* Add "Settings", formally known as "Backup Settings".
*
* @link http://wordpress.stackexchange.com/questions/66498/add-menu-page-with-different-name-for-first-submenu-item
*/
add_submenu_page(
$main_slug,
$lang['boldgrid_backup'] . ' ' . $lang['settings'],
$lang['settings'],
$capability,
'boldgrid-backup-settings',
[
$this->settings,
'page_backup_settings',
]
);
// Add "Preflight Check" page, formally know as "Functionality Test".
add_submenu_page(
$main_slug,
$lang['boldgrid_backup'] . ' ' . $lang['preflight_check'],
$lang['preflight_check'],
$capability,
'boldgrid-backup-test',
[
$this,
'page_backup_test',
]
);
// Add "Backup Archive Details" page.
add_submenu_page(
'boldgrid-backup',
'BoldGrid ' . $lang['backup_archive'],
$lang['backup_archive'],
$capability,
'boldgrid-backup-archive-details',
[
$this->archive_details,
'render_archive',
]
);
// Add "Support" page.
add_submenu_page(
$main_slug,
$lang['boldgrid_backup'] . ' ' . $lang['support'],
$lang['support'],
$capability,
'boldgrid-backup-support',
[
$this->support,
'page',
]
);
// Add "Premium" page.
add_submenu_page(
$main_slug,
$lang['boldgrid_backup'] . ' ' . $lang['premium'],
// Count value is escaped already by Library\Plugin\Page::getUnreadMarkup
$lang['premium'],
$capability,
'boldgrid-backup-premium-features',
[
$this->premium_page,
'page',
]
);
/*
* Add our "Get Premium" link to the navigation.
*
* Leave this as the last menu item.
*/
if ( ! $this->config->get_is_premium() ) {
$menu_slug = 'boldgrid-backup-get-premium';
add_submenu_page(
$main_slug,
$lang['get_premium'],
' ' . $lang['get_premium'] . '',
$capability,
$menu_slug
);
/*
* Change the url (2 is key of the menu item's slug / url).
*
* The ! empty check is to ensure the submenu exists. In some cases, such as when a user
* is logged in as an editor, it will not exist.
*/
if ( ! empty( $submenu[ $main_slug ] ) ) {
foreach ( $submenu[ $main_slug ] as &$item ) {
if ( $menu_slug === $item[2] ) {
$item[2] = $this->go_pro->get_premium_url( 'bgbkup-nav' );
}
}
}
}
}
/**
* Register / enqueue scripts.
*
* This method is being called during the "admin_enqueue_scripts" hook.
*
* @since 1.5.2
*/
public function admin_enqueue_scripts() {
wp_register_style(
'boldgrid-backup-admin-new-thickbox-style',
plugin_dir_url( __FILE__ ) . 'css/boldgrid-backup-admin-new-thickbox-style.css',
[],
BOLDGRID_BACKUP_VERSION
);
wp_register_style(
'boldgrid-backup-admin-hide-all',
plugin_dir_url( __FILE__ ) . 'css/boldgrid-backup-admin-hide-all.css',
[],
BOLDGRID_BACKUP_VERSION
);
}
/**
* Backup the WordPress database.
*
* @since 1.0
* @access private
*
* @global WP_Filesystem $wp_filesystem The WordPress Filesystem API global object.
*
* @return bool Status of the operation.
*/
private function backup_database() {
/*
* If we're omitting all the tables, we can skip trying to backup the
* database.
*/
if ( $this->db_omit->is_omit_all() ) {
$this->logger->add( 'No database tables selected to backup. A database export will not be in this backup.' );
return true;
}
/*
* Log generic info about database.
*
* Before we begin to backup the database, let's log how big it is. While troubleshooting, it
* will be helpful to know how many tables we're seeing that COULD be backed up, as well as
* how large they are.
*/
$this->logger->add( 'Database info: ' . print_r( $this->db_get->prefixed_count(), 1 ) ); // phpcs:ignore
// Check if functional.
if ( ! $this->test->run_functionality_tests() ) {
// Display an error notice.
$this->notice->functionality_fail_notice();
return [ 'error' => esc_html__( 'Unable to create backup, functionality test failed.', 'boldgrid_backup' ) ];
}
// Get the backup directory path.
$backup_directory = $this->backup_dir->get();
// Connect to the WordPress Filesystem API.
global $wp_filesystem;
// Check if the backup directory is writable.
if ( ! $wp_filesystem->is_writable( $backup_directory ) ) {
return [
'error' => sprintf(
// translators: 1: Backup directory path.
__( 'The backup directory is not writable: %1$s.', 'boldgrid-backup' ),
$backup_directory
),
];
}
// Create a file path for the dump file.
$db_dump_filepath = $backup_directory . DIRECTORY_SEPARATOR . DB_NAME . '.' . date( 'Ymd-His' ) . '.sql';
// Save the file path.
$this->db_dump_filepath = $db_dump_filepath;
$this->set_time_limit();
// Create a dump of our database.
$status = $this->db_dump->dump( $db_dump_filepath );
if ( ! empty( $status['error'] ) ) {
return [ 'error' => $status['error'] ];
}
// Ensure file is written and is over 100 bytes.
$exists = $this->test->exists( $db_dump_filepath );
if ( ! $exists ) {
return [
'error' => sprintf(
// translators: 1: MySQL dump file path.
__( 'mysqldump file does not exist: %1$s', 'boldgrid-backup' ),
$db_dump_filepath
),
];
}
$dump_file_size = $this->wp_filesystem->size( $db_dump_filepath );
if ( 100 > $dump_file_size ) {
return [
'error' => sprintf(
// translators: 1: MySQL dump file path.
__( 'mysqldump file was not written to: %1$s', 'boldgrid-backup' ),
$db_dump_filepath
),
];
}
// Limit file permissions to the dump file.
$wp_filesystem->chmod( $db_dump_filepath, 0600 );
// Return success.
return true;
}
/**
* Restore the WordPress database from a dump file.
*
* @since 1.0
* @access private
*
* @see Boldgrid_Backup_Admin_Test::run_functionality_tests()
* @see Boldgrid_Backup_Admin_Backup_Dir::get()
* @see Boldgrid_Backup_Admin_Utility::update_siteurl()
* @global WP_Filesystem $wp_filesystem The WordPress Filesystem API global object.
* @global wpdb $wpdb The WordPress database class object.
* @global WP_Rewrite $wp_rewrite Core class used to implement a rewrite component API.
*
* @param string $db_dump_filepath File path to the mysql dump file.
* @param string $db_prefix The database prefix to use, if restoring and it changed.
* @param bool $db_encrypted Is the database dump file encrypted.
* @return bool Status of the operation.
*/
private function restore_database( $db_dump_filepath, $db_prefix = null, $db_encrypted = false ) {
// Check input.
if ( empty( $db_dump_filepath ) ) {
// Display an error notice.
do_action(
'boldgrid_backup_notice',
esc_html__( 'The database dump file was not found.', 'boldgrid-backup' ),
'notice notice-error is-dismissible'
);
return false;
}
// Check if functional.
if ( ! $this->test->run_functionality_tests() ) {
// Display an error notice.
$this->notice->functionality_fail_notice();
return false;
}
// Connect to the WordPress Filesystem API.
global $wp_filesystem;
// Save the file path.
$this->db_dump_filepath = $db_dump_filepath;
// Get the WP Options for "siteurl" and "home", to restore later.
$wp_siteurl = get_option( 'siteurl' );
$wp_home = get_option( 'home' );
$this->set_time_limit();
if ( $db_encrypted ) {
/**
* If BGBP is activated, then check for encryption and decrypt the file.
*
* @since 1.12.0
*/
do_Action( 'boldgrid_backup_crypt_file', $db_dump_filepath, 'd' );
}
// Import the dump file.
$importer = new Boldgrid_Backup_Admin_Db_Import();
$status = $importer->import( $db_dump_filepath );
if ( ! empty( $status['error'] ) ) {
$this->db_restore_error = $status['error'];
do_action( 'boldgrid_backup_notice', $status['error'], 'notice notice-error is-dismissible' );
return false;
}
// Set the database prefix, if supplied/changed.
if ( ! empty( $db_prefix ) ) {
// Connect to the WordPress database via $wpdb.
global $wpdb;
// Set the database table prefix.
$wpdb->set_prefix( $db_prefix );
}
// Clear the WordPress cache.
wp_cache_flush();
/**
* In addition to flushing the cache (above), some classes may have cached option values (or other
* data from the database) in some other way - e.g. in class properties. That cached data cannot
* be flushed with wp_cache_flush.
*
* For example, the global $wp_rewrite class caches the permalink_structure option's value during
* its init method. Running the cache flush above will not update this class' permalink_structure
* property.
*
* @link https://github.com/WordPress/WordPress/blob/master/wp-includes/class-wp-rewrite.php#L1894
*
* This is important because if trying to rebuild the .htaccess file, it won't rebuild correctly
* based on the permalink_structure option in the database just restored.
*/
global $wp_rewrite;
$wp_rewrite->init();
// Get the restored "siteurl" and "home".
$restored_wp_siteurl = get_option( 'siteurl' );
$restored_wp_home = get_option( 'home' );
// If changed, then update the siteurl in the database.
if ( $restored_wp_siteurl !== $wp_siteurl ) {
$update_siteurl_success =
Boldgrid_Backup_Admin_Utility::update_siteurl( array(
'old_siteurl' => $restored_wp_siteurl,
'siteurl' => $wp_siteurl,
) );
if ( ! $update_siteurl_success ) {
// Display an error notice.
do_action(
'boldgrid_backup_notice',
esc_html__(
'The WordPress siteurl has changed. There was an issue changing it back. You will have to fix the siteurl manually in the database, or use an override in your wp-config.php file.',
'boldgrid-backup'
),
'notice notice-error is-dismissible'
);
}
}
// If changed, then restore the WP Option for "home".
if ( $restored_wp_home !== $wp_home ) {
// There may be a filter, so remove it.
remove_all_filters( 'pre_update_option_home' );
update_option( 'home', untrailingslashit( $wp_home ) );
}
// Return success.
return true;
}
/**
* Get a single-dimension filelist array from a directory path.
*
* @since 1.0
*
* @param string $dirpath A directory path.
* @return array A single-dimension filelist array for use in this class.
*/
public function get_filelist( $dirpath ) {
// If this is a node_modules folder, do not iterate through it.
if ( false !== strpos( $dirpath, '/node_modules' ) ) {
return [];
}
// Connect to the WordPress Filesystem API.
global $wp_filesystem;
// Validate input.
if ( empty( $dirpath ) || ! $wp_filesystem->is_readable( $dirpath ) ) {
return [];
}
// Remove any training slash in dirpath.
$dirpath = untrailingslashit( $dirpath );
// Mark the base directory, if not set (the first run).
if ( empty( $this->filelist_basedir ) ) {
$this->filelist_basedir = $dirpath;
}
// Get the non-recursive directory listing for the specified path.
$dirlist = $wp_filesystem->dirlist( $dirpath, true, false );
// Initialize $filelist.
$filelist = [];
/*
* Add empty directory.
*
* If this is an empty directory, add the directory itself to the
* $filelist.
*
* Previously we used Boldgrid_Backup_Admin_Compressor_Php_Zip::add_dirs
* to add all empty directories, but that method is no longer needed.
*/
if ( empty( $dirlist ) ) {
$filelist[] = [
$dirpath,
str_replace( ABSPATH, '', $dirpath ),
0,
// Since 1.6.0, this 4th key represetnts 'type', as in a file or a directory.
'd',
];
}
// Sort the dirlist array by filename.
uasort(
$dirlist,
function ( $a, $b ) {
if ( $a['name'] < $b['name'] ) {
return - 1;
}
if ( $a['name'] > $b['name'] ) {
return 1;
}
return 0;
}
);
// Perform conversion.
foreach ( $dirlist as $fileinfo ) {
// If item is a directory, then recurse, merge, and continue.
if ( 'd' === $fileinfo['type'] ) {
$filelist_add = $this->get_filelist( $dirpath . '/' . $fileinfo['name'] );
$filelist = array_merge( $filelist, $filelist_add );
continue;
}
// Get the file path.
$filepath = $dirpath . '/' . $fileinfo['name'];
// The relative path inside the ZIP file.
$relative_path = substr( $filepath, strlen( $this->filelist_basedir ) + 1 );
// For files, add to the filelist array.
$filelist[] = [
$filepath,
$relative_path,
$fileinfo['size'],
];
}
// Return the array.
return $filelist;
}
/**
* Get a recursive file list of the WordPress installation root directory.
*
* This is a recursive function, which uses the class property filelist_basedir.
*
* @since 1.0
*
* @see Boldgrid_Backup_Admin_Core::get_filelist().
*
* @param string $dirpath A directory path, defaults to ABSPATH.
* @return array An array of absolute file paths, relative paths, and file sizes.
* Example: https://pastebin.com/QiquHdcC
*/
public function get_filtered_filelist( $dirpath = ABSPATH ) {
// Validate input.
if ( empty( $dirpath ) || ! $this->wp_filesystem->is_readable( $dirpath ) ) {
return [];
}
// Get the recursive directory listing for the specified path.
$filelist = $this->get_filelist( $dirpath );
// If no files were found, then return an empty array.
if ( empty( $filelist ) ) {
return [];
}
// Initialize $new_filelist.
$new_filelist = [];
// Filter the filelist array.
foreach ( $filelist as $fileinfo ) {
// @todo The user needs a way to specifiy what to skip in the backups.
$is_node_modules = false !== strpos( $fileinfo[1], '/node_modules/' );
$is_backup_directory = $this->backup_dir->file_in_dir( $fileinfo[1] );
if ( $is_node_modules || $is_backup_directory ) {
continue;
}
if ( ! $this->folder_exclusion->allow_file( $fileinfo[1] ) ) {
continue;
}
$new_filelist[] = $fileinfo;
}
// Replace filelist.
$filelist = $new_filelist;
// Clear filelist_basedir.
$this->filelist_basedir = null;
// Return the filelist array.
return $filelist;
}
/**
* Generate an new archive file path.
*
* @since 1.0
* @access private
*
* @param string $extension An optional file extension.
* @return string|bool An archive file path, or FALSE on error.
*/
public function generate_archive_path( $extension = null ) {
// Get the backup directory path.
$backup_directory = $this->backup_dir->get();
// Connect to the WordPress Filesystem API.
global $wp_filesystem;
// Check if the backup directory is writable.
if ( ! $wp_filesystem->is_writable( $backup_directory ) ) {
return false;
}
// Get backup identifier.
$backup_identifier = $this->get_backup_identifier();
// Create a site identifier.
$site_id = Boldgrid_Backup_Admin_Utility::create_site_id();
$filename = sprintf(
'boldgrid-backup-%1$s-%2$s-%3$s',
$site_id,
$backup_identifier,
date( 'Ymd-His' )
);
$filename = sanitize_file_name( $filename );
// Create a file path with no extension (added later).
$filepath = $backup_directory . DIRECTORY_SEPARATOR . $filename;
// If specified, add an extension.
if ( ! empty( $extension ) ) {
// Trim the input extension.
$extension = trim( $extension, ' .' );
$filepath .= '.' . $extension;
}
return $filepath;
}
/**
* Create an archive file containing the WordPress files.
*
* @since 1.0
*
* @see Boldgrid_Backup_Admin_Core::backup_database()
* @see Boldgrid_Backup_Admin_Archive::write_results_file()
*
* @param bool $save A switch to save the archive file. Default is FALSE.
* @param bool $dryrun An optional switch to perform a dry run test.
* @return array An array of archive file information.
*/
public function archive_files( $save = false, $dryrun = false ) {
$this->archiving_files = true;
$pid = getmypid();
$log_time = time();
$log_filename = 'archive-' . $log_time . '.log';
$this->logger->init( $log_filename );
$this->logger->add( 'Backup process initialized.' );
$this->logger->add( 'Process id: ' . $pid );
$this->utility->bump_memory_limit( '1G' );
$this->pre_auto_update = 'pre_auto_update' === current_filter();
/*
* A scheduled backup is a backup triggered by the user's Settings > Backup Schedule. If the user clicked
* "Backup Site Now" or this is a backup before an auto update occurs, this is not a scheduled backup.
*/
$this->is_scheduled_backup = $this->doing_cron && ! $this->pre_auto_update;
Boldgrid_Backup_Admin_In_Progress_Data::init( array(
'status' => esc_html__( 'Initializing backup', 'boldgrid-backup' ),
'log_filename' => $log_filename,
'pid' => $pid,
'start_time' => $log_time,
) );
/**
* Actions to take before any archiving begins.
*
* @since 1.5.2
*/
do_action( 'boldgrid_backup_archive_files_init' );
if ( $save && ! $dryrun ) {
$this->in_progress->set();
}
/*
* If this is a scheduled backup and no location is selected to save the
* backup to, abort.
*
* While we could prevent he user from setting this up in the first place,
* at the moment the settings page saves all settings. So, if the user
* wanted to change their retention settings but did not want to schedule
* backups, validating storage locations would be problematic.
*/
if ( $this->is_scheduled_backup && ! $this->remote->any_enabled() ) {
$error = esc_html__( 'No backup locations selected! While we could create a backup archive, you have not selected where the backup archive should be saved. Please choose a storage location in your settings for where to save this backup archive.', 'boldgrid-backup' );
$this->archive_fail->schedule_fail_email( $error );
$this->logger->add( $error );
return [ 'error' => $error ];
}
// Check if functional.
if ( ! $this->test->run_functionality_tests() ) {
// Display an error notice, if not already on the test page.
if ( ! isset( $_GET['page'] ) || 'boldgrid-backup-test' !== $_GET['page'] ) { // phpcs:ignore WordPress.CSRF.NonceVerification.NoNonceVerification
// Display an error notice.
$this->notice->functionality_fail_notice();
}
$error = __( 'Functionality tests fail.', 'boldgrid-backup' );
$this->logger->add( $error );
return [ 'error' => $error ];
}
// Close any PHP session, so that another session can open during the backup operation.
session_write_close();
/*
* Initialize return array and add "compressor" and "save" keys.
* Since 1.6.0, the folder include and exclude settings below are
* for informational purposes only. This array cannot be filtered to
* adjust which folders are actually included / excluded.
*/
$info = [
'mode' => 'backup',
'dryrun' => $dryrun,
'compressor' => null,
'filesize' => 0,
'save' => $save,
'total_size' => 0,
'folder_include' => $this->folder_exclusion->from_settings( 'include' ),
'folder_exclude' => $this->folder_exclusion->from_settings( 'exclude' ),
'table_exclude' => $this->db_omit->get_excluded_tables(),
'title' => ! empty( $_POST['backup_title'] ) ? stripslashes( $_POST['backup_title'] ) : null, // phpcs:ignore WordPress.CSRF.NonceVerification,WordPress.Arrays.ArrayDeclarationSpacing.ArrayItemNoNewLine
'description' => ! empty( $_POST['backup_description'] ) ? stripslashes( $_POST['backup_description'] ) : null, // phpcs:ignore WordPress.CSRF.NonceVerification,WordPress.Arrays.ArrayDeclarationSpacing.ArrayItemNoNewLine
// Information used for the emergency restoration process.
'ABSPATH' => ABSPATH,
'backup_id' => $this->get_backup_identifier(),
'siteurl' => site_url(),
'timestamp' => time(), // @todo Is this a duplicate value? $info['lastmodunix'] is added below.
// Environment information.
'gateway_interface' => getenv( 'GATEWAY_INTERFACE' ),
'http_host' => getenv( 'HTTP_HOST' ),
'php_sapi_name' => php_sapi_name(),
'php_uname' => php_uname(),
'php_version' => phpversion(),
'server_addr' => getenv( 'SERVER_ADDR' ) ? getenv( 'SERVER_ADDR' ) : getenv( 'LOCAL_ADDR' ),
'server_name' => getenv( 'SERVER_NAME' ),
'server_protocol' => getenv( 'SERVER_PROTOCOL' ),
'server_software' => getenv( 'SERVER_SOFTWARE' ),
'uid' => getmyuid(),
'username' => get_current_user(),
'encrypt_db' => false,
];
// Determine how this backup was triggered.
if ( $this->pre_auto_update ) {
$info['trigger'] = esc_html__( 'Auto update', 'boldgrid-bakcup' );
} elseif ( $this->doing_ajax && is_user_logged_in() ) {
$current_user = wp_get_current_user();
$info['trigger'] = $current_user->user_login . ' (' . $current_user->user_email . ')';
} elseif ( $this->doing_wp_cron ) {
$info['trigger'] = 'WP cron';
} elseif ( $this->doing_cron ) {
$info['trigger'] = 'Cron';
} else {
$info['trigger'] = esc_html__( 'Unknown', 'boldgrid-backup' );
}
Boldgrid_Backup_Admin_In_Progress_Data::set_arg( 'trigger', $info['trigger'] );
$this->logger->add( 'Backup triggered by: ' . $info['trigger'] );
$info['compressor'] = $this->compressors->get();
// If there is no available compressor, then fail.
if ( null === $info['compressor'] ) {
return [ 'error' => 'No available compressor.' ];
}
// Cleanup. Enforce retention and delete orphaned files.
$this->enforce_retention();
$orphan_cleanup = new Boldgrid\Backup\Admin\Orphan\Cleanup();
$orphan_cleanup->run();
// Prevent this script from dying.
ignore_user_abort( true );
// Start timer.
$time_start = microtime( true );
// Backup the database, if saving an archive file and not a dry run.
if ( $save && ! $dryrun ) {
$this->logger->add_separator();
$this->logger->add( 'Starting dump of database...' );
$this->logger->add_memory();
$status = $this->backup_database();
$this->logger->add( 'Dump of database complete! $status = ' . print_r( $status, 1 ) ); // phpcs:ignore
$this->logger->add_memory();
$this->logger->add_separator();
if ( false === $status || ! empty( $status['error'] ) ) {
$error = ! empty( $status['error'] ) ? $status['error'] : __( 'An unknown error occurred when backing up the database.', 'boldgrid-backup' );
$this->logger->add( $error );
return array( 'error' => $error );
}
}
// Keep track of how long the site was paused for / the time to backup the database.
$db_time_stop = microtime( true );
// Get the file list.
$this->logger->add( 'Retrieving file list.' );
$filelist = $this->get_filtered_filelist( ABSPATH );
// Initialize total_size.
$info['total_size'] = 0;
// If not saving, then just return info.
if ( ! $save ) {
foreach ( $filelist as $fileinfo ) {
// Add the file size to the total.
$info['total_size'] += $fileinfo[2];
}
return $info;
}
// Get the backup directory path.
$this->logger->add( 'Retrieving backup directory.' );
$backup_directory = $this->backup_dir->get();
// Check if the backup directory is writable.
if ( ! $this->wp_filesystem->is_writable( $backup_directory ) ) {
$this->logger->add( 'Backup directory is not writable.' );
return false;
}
// Add the database dump file to the beginning of file list.
$this->logger->add( 'Adding Database to file list.' );
if ( ! empty( $this->db_dump_filepath ) ) {
$db_dump_size = $this->wp_filesystem->size( $this->db_dump_filepath );
$db_file_array = [
$this->db_dump_filepath,
substr( $this->db_dump_filepath, strlen( $backup_directory ) + 1 ),
$db_dump_size,
];
array_unshift( $filelist, $db_file_array );
$this->logger->add(
sprintf(
'Database dump file added to file list: %1$s / %2$s (%3$s)',
$this->db_dump_filepath,
$db_dump_size,
size_format( $db_dump_size, 2 )
)
);
}
$this->set_time_limit();
/**
* Allow the filtering of our $info before generating a backup.
*
* @since 1.5.1
*
* @see Boldgrid_Backup_Admin_Compressor_Php_Zip::archive_files
* @see \Boldgrid\Backup\Premium\Admin\Crypt::post_dump()
*
* @param array $info Archive information.
*/
$info = apply_filters( 'boldgrid_backup_pre_archive_info', $info );
$this->logger->add( 'Starting archiving of files. Chosen compressor: ' . $info['compressor'] );
$this->logger->add_memory();
// Determine the path to our zip file.
$info['filepath'] = $this->generate_archive_path( 'zip' );
$this->archive_filepath = $info['filepath'];
Boldgrid_Backup_Admin_In_Progress_Data::set_args( array(
'total_files_todo' => count( $filelist ),
'filepath' => $info['filepath'],
'compressor' => $info['compressor'],
) );
if ( Boldgrid_Backup_Admin_Filelist_Analyzer::is_enabled() ) {
$this->logger->add_separator();
$this->logger->add( 'Starting to analyze filelist...' );
$this->logger->add_memory();
$filelist_analyzer = new Boldgrid_Backup_Admin_Filelist_Analyzer( $filelist, $log_time );
$filelist_analyzer->run();
$this->logger->add( 'Finished analyzing filelist!' );
$this->logger->add_memory();
}
/*
* Use the chosen compressor to build an archive.
* If the is no available compressor, then return an error.
*/
switch ( $info['compressor'] ) {
case 'php_zip':
$compressor = new Boldgrid_Backup_Admin_Compressor_Php_Zip( $this );
$status = $compressor->archive_files( $filelist, $info );
break;
case 'pcl_zip':
$compressor = new Boldgrid_Backup_Admin_Compressor_Pcl_Zip( $this );
$status = $compressor->archive_files( $filelist, $info );
break;
case 'php_bz2':
// Generate a new archive file path.
$info['filepath'] = $this->generate_archive_path( 'b2z' );
break;
case 'php_zlib':
// Generate a new archive file path.
$info['filepath'] = $this->generate_archive_path( 'zlib' );
break;
case 'php_lzf':
// Generate a new archive file path.
$info['filepath'] = $this->generate_archive_path( 'lzf' );
break;
case 'system_tar':
// Generate a new archive file path.
$info['filepath'] = $this->generate_archive_path( 'tar.gz' );
break;
case 'system_zip':
$compressor = new Boldgrid_Backup_Admin_Compressor_System_Zip( $this );
$status = $compressor->archive_files( $filelist, $info );
break;
default:
$status = [ 'error' => 'No available compressor' ];
break;
}
Boldgrid_Backup_Admin_In_Progress_Data::set_arg( 'status', 'Wrapping things up...' );
$archive_exists = ! empty( $info['filepath'] ) && $this->wp_filesystem->exists( $info['filepath'] );
$archive_size = ! $archive_exists ? 0 : $this->wp_filesystem->size( $info['filepath'] );
// Add additional info to the logs.
$this->logger->add( 'Archiving of files complete!' );
if ( true !== $status ) {
$this->logger->add( 'Archiving of files did not complete successfully: ' . print_r( $status, 1 ) ); // phpcs:ignore
}
$this->logger->add(
sprintf(
'Archive filepath / size: %1$s / %2$s (%3$s)',
( empty( $info['filepath'] ) ? 'MISSING FILEPATH' : $info['filepath'] ),
$archive_size,
size_format( $archive_size, 2 )
)
);
$this->logger->add_memory();
$info['total_size'] += $this->filelist->get_total_size( $filelist );
if ( true === $status && ! $archive_exists ) {
$status = [ 'error' => 'The archive file "' . $info['filepath'] . '" was not written.' ];
}
if ( ! empty( $status['error'] ) ) {
$this->logger->add( $status['error'] );
return $status;
}
$info['lastmodunix'] = $this->wp_filesystem->mtime( $info['filepath'] );
if ( $save && ! $dryrun ) {
// Modify the archive file permissions to help protect from public access.
$this->wp_filesystem->chmod( $info['filepath'], 0600 );
// Add some statistics to the return.
$info['filesize'] = $this->wp_filesystem->size( $info['filepath'] );
// Delete the temporary database dump file.
$this->wp_filesystem->delete( $this->db_dump_filepath, false, 'f' );
}
// Stop timer.
$time_stop = microtime( true );
// Calculate duration.
$info['duration'] = number_format( ( $time_stop - $time_start ), 2, '.', '' );
$info['db_duration'] = number_format( ( $db_time_stop - $time_start ), 2, '.', '' );
$info['db_filename'] = basename( $this->db_dump_filepath );
/**
* Actions to take after a backup has been created.
*
* At priority 10, we add to the jobs queue the tasks of uploading this backup to our remote
* storage providers. Each remote storage provider individually hooks into this action and adds
* a job to the queue.
*
* At priority 100, we add a job to delete the local backup file if the user does
* not want to keep it.
*
* At priority 200, we send an email to the user with a summary of the
* backup and the jobs.
*
* @since 1.5.2
*
* @param array $info {
* An array of info about the backup just created.
*
* @type string $mode backup
* @type bool $dryrun
* @type string $compressor pcl_zip
* @type int $filesize 30992482
* @type bool $save
* @type int $total_size
* @type string $filepath C:\file.zip
* @type int $lastmodunix 1506602959
* @type int $duration 57.08
* @type int $db_duration 0.35
* @type bool $mail_success
* }
*/
do_action( 'boldgrid_backup_post_archive_files', $info );
/*
* Send an email to the user, RIGHT NOW.
*
* Only send an email to the user now IF they are manually creating a backup. If this backup
* was created during a scheduled backup, the user will get an email from the jobs queue.
* Scheduled backups receive email notifications from the jobs queue because that email will
* not only include the standard info about the backup (which we're sending now), it will
* also include info about other jobs that were run (such as uploading the backup remotely).
*/
if ( $this->email->user_wants_notification( 'backup' ) && ! $this->is_scheduled_backup ) {
$this->logger->add( 'Starting sending of email...' );
Boldgrid_Backup_Admin_In_Progress_Data::set_arg( 'status', 'Sending email...' );
$email_parts = $this->email->post_archive_parts( $info );
$email_body = $email_parts['body']['main'] . $email_parts['body']['signature'];
$info['mail_success'] = $this->email->send( $email_parts['subject'], $email_body );
$this->logger->add( 'Sending of email complete! Status: ' . $info['mail_success'] );
}
// If not a dry-run test, update the last backup option and enforce retention.
if ( ! $dryrun ) {
// Update WP option for "boldgrid_backup_last_backup".
update_site_option( 'boldgrid_backup_last_backup', time() );
$this->archive_log->write( $info );
// Enforce retention setting.
$this->enforce_retention();
update_option( 'boldgrid_backup_latest_backup', $info );
}
// Actions to take if we're creating a full site backup.
if ( ! $dryrun && $this->archiver_utility->is_full_backup() ) {
$this->archive->write_results_file( $info );
}
if ( isset( $this->activity ) ) {
$this->activity->add( 'any_backup_created', 1, $this->rating_prompt_config );
}
$this->logger->add( 'Backup complete!' );
$this->logger->add_memory();
$this->archiving_files = false;
Boldgrid_Backup_Admin_In_Progress_Data::set_args( array(
'status' => esc_html__( 'Backup complete!', 'boldgrid-backup' ),
'success' => true,
) );
// Return the array of archive information.
return $info;
}
/**
* Get information for the list of archive file(s) (in descending order by date modified).
*
* @since 1.0
*
* @global WP_Filesystem $wp_filesystem The WordPress Filesystem API global object.
*
* @param string $download_filename A filename to match to get info.
* @param string $backup_directory Specify a directory to look within for backups.
* @return array {
* A numbered array of arrays containing the following indexes.
* @type string $filepath Archive file path.
* @type string $filename Archive filename.
* @type string $filedate Localized file modification date.
* @type int $filesize The archive file size in bytes.
* @type int $lastmodunix The archive file modification time in unix seconds.
* }
*/
public function get_archive_list( $download_filename = null, $backup_directory = null ) {
// Connect to the WordPress Filesystem API.
global $wp_filesystem;
// Initialize $archive_files array.
$archive_files = [];
// Get the backup directory.
if ( is_null( $backup_directory ) ) {
$backup_directory = $this->backup_dir->get();
}
// If the backup directory is not configured, then return an empty array.
if ( ! $backup_directory ) {
return [];
}
// Find all backups.
$dirlist = $wp_filesystem->dirlist( $backup_directory, false, false );
// If no files were found, then return an empty array.
if ( empty( $dirlist ) ) {
return [];
}
// Sort the dirlist array by "lastmodunix" descending.
uasort(
$dirlist,
function ( $a, $b ) {
if ( $a['lastmodunix'] < $b['lastmodunix'] ) {
return 1;
}
if ( $a['lastmodunix'] > $b['lastmodunix'] ) {
return - 1;
}
return 0;
}
);
// Initialize $index.
$index = -1;
// Filter the array.
foreach ( $dirlist as $fileinfo ) {
if ( $this->archive->is_site_archive( $fileinfo['name'] ) ) {
// Increment the index.
$index++;
// If looking for one match, skip an iteration if not the matching filename.
if ( ! empty( $download_filename ) && $download_filename !== $fileinfo['name'] ) {
continue;
}
// Create the return array.
// @todo Should we use the data and time from the filename, or rely on lastmodunix?
$archive_files[ $index ] = [
'filepath' => $backup_directory . '/' . $fileinfo['name'],
'filename' => $fileinfo['name'],
'filedate' => get_date_from_gmt(
date( 'Y-m-d H:i:s', $fileinfo['lastmodunix'] ), 'n/j/Y g:i A'
),
'filesize' => $fileinfo['size'],
'lastmodunix' => $fileinfo['lastmodunix'],
];
// If looking for info on one file and we found the match, then break the loop.
if ( ! empty( $download_filename ) ) {
break;
}
}
}
// Return the array.
return $archive_files;
}
/**
* Delete an archive file.
*
* @since 1.0
* @access private
*
* @return bool Whether or not the archive file was deleted.
*/
public function delete_archive_file() {
// If a deletion was not requested, then abort.
if ( empty( $_POST['delete_now'] ) ) {
return false;
}
// Initialize $delete_ok.
$delete_ok = true;
// Verify nonce, or die.
check_admin_referer( 'archive_auth', 'archive_auth' );
// Validate archive_key.
if ( isset( $_POST['archive_key'] ) && is_numeric( $_POST['archive_key'] ) ) {
$archive_key = (int) $_POST['archive_key'];
} else {
$delete_ok = false;
do_action(
'boldgrid_backup_notice',
esc_html__( 'Invalid key for the selected archive file.', 'boldgrid-backup' ),
'notice notice-error is-dismissible'
);
$archive_key = null;
}
// Validate archive_filename.
if ( ! empty( $_POST['archive_filename'] ) ) {
$archive_filename = sanitize_file_name( $_POST['archive_filename'] );
} else {
// Fail with a notice.
do_action(
'boldgrid_backup_notice',
esc_html__( 'Invalid filename for the selected archive file.', 'boldgrid-backup' ),
'notice notice-error is-dismissible'
);
return false;
}
// If there are errors, then abort.
if ( ! $delete_ok ) {
return false;
}
// Get archive list.
$archives = $this->get_archive_list( $archive_filename );
// If no files were found, then show a notice.
if ( empty( $archives ) ) {
// Fail with a notice.
do_action(
'boldgrid_backup_notice',
esc_html__( 'No archive files were found.', 'boldgrid-backup' ),
'notice notice-error is-dismissible'
);
return false;
}
// Locate the filename by key number.
$filename = (
! empty( $archives[ $archive_key ]['filename'] ) ?
$archives[ $archive_key ]['filename'] : null
);
// Verify specified filename.
if ( $archive_filename !== $filename ) {
// Fail with a notice.
do_action(
'boldgrid_backup_notice',
esc_html__( 'The selected archive file was not found.', 'boldgrid-backup' ),
'notice notice-error is-dismissible'
);
return false;
}
// Get the file path to delete.
$filepath = (
! empty( $archives[ $archive_key ]['filepath'] ) ?
$archives[ $archive_key ]['filepath'] : null
);
$delete_ok = $this->archive->delete( $filepath );
// Display notice of deletion status.
if ( ! $delete_ok ) {
do_action(
'boldgrid_backup_notice',
esc_html__( 'Error deleting the selected archive file.', 'boldgrid-backup' ),
'notice notice-error is-dismissible'
);
}
/**
* Take action after a user deletes a backup.
*
* @since 1.5.3
*
* @param string $filepath
* @param bool $delete_ok
*/
do_action( 'boldgrid_backup_user_deleted_backup', $filepath, $delete_ok );
// Return deletion status.
return $delete_ok;
}
/**
* Get the newest database dump file path from a restored archive.
*
* @since 1.0
*
* @global WP_Filesystem $wp_filesystem The WordPress Filesystem API global object.
*
* @param string $filepath The full filepath to the file .zip archive.
* @return string File path to the database dump file.
*/
public function get_dump_file( $filepath ) {
if ( empty( $filepath ) || ! $this->wp_filesystem->exists( $filepath ) ) {
return '';
}
/*
* Get the sql file to restore.
*
* These few lines below are new to the get_dump_file method.
* Historically we searched the ABSPATH for a filename matching
* ########-######.sql and returned the first one we found. Well, what
* if there were more than one matching file, which .sql file do we
* restore?
*
* $pcl_zip->get_sqls Searches the zip file and finds a list of all
* .sql files that match the pattern we're looking for and returns them.
* We should only get 1 back, and that is the appropriate dump file.
*
* These few lines should do the trick. If not, the original code is
* still in place to take the initial approach and find a dump file to
* restore (the first applicable one it can find).
*/
$pcl_zip = new Boldgrid_Backup_Admin_Compressor_Pcl_Zip( $this );
$sqls = $pcl_zip->get_sqls( $filepath );
if ( 1 === count( $sqls ) ) {
return ABSPATH . $sqls[0];
}
// Initialize $db_dump_filepath.
$db_dump_filepath = '';
// Find all backups.
$dirlist = $this->wp_filesystem->dirlist( ABSPATH, false, false );
// If no files were found, then return an empty array.
if ( empty( $dirlist ) ) {
return '';
}
// Sort the dirlist array by "name" descending.
uasort(
$dirlist,
function ( $a, $b ) {
if ( $a['name'] < $b['name'] ) {
return 1;
}
if ( $a['name'] > $b['name'] ) {
return - 1;
}
return 0;
}
);
/*
* Find the first occurrence of a MySQL dump file.
* Format: "*.########-######.sql".
* An example filename: joec_wrdp2.20160919-162431.sql".
*/
foreach ( $dirlist as $fileinfo ) {
if ( 1 === preg_match( '/\.[\d]+-[\d]+\.sql$/', $fileinfo['name'] ) ) {
$db_dump_filepath = ABSPATH . $fileinfo['name'];
break;
}
}
// Return the array.
return $db_dump_filepath;
}
/**
* Restore from a specified archive file.
*
* @since 1.0
*
* @see https://codex.wordpress.org/Function_Reference/flush_rewrite_rules
*
* @param bool $dryrun An optional switch to perform a dry run test.
* @param array $args {
* An optional array of args.
*
* @type int $archive_key An archive key.
* @type string $archive_filename An archive filename.
* }
* @return array An array of archive file information.
*/
public function restore_archive_file( $dryrun = false, array $args = [] ) {
$this->restoring_archive_file = true;
$this->logger->init( 'restore-' . time() . '.log' );
$this->logger->add( 'Restoration process initialized.' );
$this->logger->add_memory();
// Using pcl_zip (ZipArchive unavailable), a 400MB+ zip used over 500MB+ of memory to restore.
Boldgrid_Backup_Admin_Utility::bump_memory_limit( '1G' );
$restore_ok = true;
/*
* This is a generic method to restore an archive. Do not assume the request to restore is coming
* from a user directly via $_POST.
*
* Refer to check_ajax_referer usage below to help protect ajax requests.
*/
$is_post_restore = isset( $_POST['action'] ) && 'boldgrid_backup_restore_archive' === $_POST['action']; // phpcs:ignore WordPress.CSRF.NonceVerification.NoNonceVerification
// If a restoration was not requested, then abort.
if ( empty( $_POST['restore_now'] ) ) { // phpcs:ignore WordPress.CSRF.NonceVerification.NoNonceVerification
$error_message = esc_html__( 'Invalid restore_now value.', 'boldgrid-backup' );
$this->logger->add( $error_message );
return [ 'error' => $error_message ];
}
if ( $is_post_restore && ! check_ajax_referer( 'boldgrid_backup_restore_archive', 'archive_auth', false ) ) {
$error_message = esc_html__( 'Invalid nonce.', 'boldgrid-backup' );
$this->logger->add( $error_message );
return [ 'error' => $error_message ];
}
// Check if functional.
if ( ! $this->test->run_functionality_tests() ) {
$error_message = esc_html__( 'Functionality tests fail.', 'boldgrid-backup' );
$this->logger->add( $error_message );
return [ 'error' => $error_message ];
}
/*
* Get our archive key.
*
* It can be passed in via $args or $_POST.
*/
$archive_key = false;
if ( isset( $args['archive_key'] ) ) {
$archive_key = (int) $args['archive_key'];
} elseif ( isset( $_POST['archive_key'] ) && is_numeric( $_POST['archive_key'] ) ) { // phpcs:ignore WordPress.CSRF.NonceVerification.NoNonceVerification
$archive_key = (int) $_POST['archive_key'];
} else {
$error_message = esc_html__( 'Invalid key for the selected archive file.', 'boldgrid-backup' );
$this->logger->add( $error_message );
return [ 'error' => $error_message ];
}
/*
* Get our archive filename.
*
* It can be passed in via $args or $_POST.
*/
$archive_filename = false;
if ( ! empty( $args['archive_filename'] ) ) {
$archive_filename = sanitize_file_name( $args['archive_filename'] );
} elseif ( ! empty( $_POST['archive_filename'] ) ) { // phpcs:ignore WordPress.CSRF.NonceVerification.NoNonceVerification
$archive_filename = sanitize_file_name( $_POST['archive_filename'] );
} else {
$error_message = esc_html__( 'Invalid filename for the selected archive file.', 'boldgrid-backup' );
$this->logger->add( $error_message );
return [ 'error' => $error_message ];
}
// Close any PHP session, so that another session can open during this restore operation.
session_write_close();
$archives = $this->get_archive_list( $archive_filename );
if ( empty( $archives ) ) {
$error_message = esc_html__( 'No archive files were found.', 'boldgrid-backup' );
$this->logger->add( $error_message );
return [ 'error' => $error_message ];
}
$filename = ! empty( $archives[ $archive_key ]['filename'] ) ? $archives[ $archive_key ]['filename'] : null;
if ( $archive_filename !== $filename ) {
$error_message = esc_html__( 'The selected archive file was not found.', 'boldgrid-backup' );
$this->logger->add( $error_message );
return [ 'error' => $error_message ];
}
$filepath = ! empty( $archives[ $archive_key ]['filepath'] ) ? $archives[ $archive_key ]['filepath'] : null;
if ( ! empty( $filepath ) && $this->wp_filesystem->exists( $filepath ) ) {
$filesize = $this->wp_filesystem->size( $filepath );
} else {
$error_message = esc_html__( 'The selected archive file is empty.', 'boldgrid-backup' );
$this->logger->add( $error_message );
return [ 'error' => $error_message ];
}
// Populate $info.
$info = [
'mode' => 'restore',
'dryrun' => $dryrun,
'filename' => $archive_filename,
'filepath' => $filepath,
'filesize' => $filesize,
'archive_key' => $archive_key,
'restore_ok' => $restore_ok,
];
$this->logger->add( 'Restore info: ' . print_r( $info, 1 ) ); // phpcs:ignore
// Prevent this script from dying.
ignore_user_abort( true );
$this->set_time_limit();
/**
* Action to take before restoring an archive.
*
* @since 1.5.1
*
* @param array $info
*/
do_action( 'boldgrid_backup_pre_restore', $info );
/*
* Attempt to fix any permissions related issues before the restoration begins. If we're
* unable to, the restoration may not continue.
*/
if ( class_exists( 'ZipArchive' ) ) {
if ( ! $this->restore_helper->set_writable_permissions( $info['filepath'] ) ) {
$error_message = $this->restore_helper->get_last_error();
$this->logger->add( $error_message );
return [ 'error' => $error_message ];
}
} else {
$this->logger->add( 'ZipArchive not available. Unable to set_writable_permissions. Trying restore anyways...' );
}
$this->logger->add( 'Unzipping archive... filepath / ABSPATH: ' . $info['filepath'] . ' / ' . ABSPATH );
$this->logger->add_memory();
$unzip_status = ! $dryrun ? unzip_file( $info['filepath'], ABSPATH ) : null;
$this->logger->add( 'Unzip complete! Status: ' . print_r( $unzip_status, 1 ) ); // phpcs:ignore
$this->logger->add_memory();
if ( is_wp_error( $unzip_status ) ) {
$error = false;
/**
* Take action when a restoration fails.
*
* Those actions may return a custom error message, such as:
* "Your restoration failed, but we did XYZ. Please try again".
*
* @param WP_Error $unzip_status
*/
$error = apply_filters( 'boldgrid_backup_restore_fail', $unzip_status );
if ( empty( $error ) ) {
$message = $unzip_status->get_error_message();
$data = $unzip_status->get_error_data();
$error = sprintf( '%1$s%2$s', $message, is_string( $data ) && ! empty( $data ) ? ': ' . $data : '' );
}
return [ 'error' => $error ];
}
/**
* Action to take after restoring an archive.
*
* @since 1.5.1
*
* @param array $info
*/
do_action( 'boldgrid_backup_post_restore', $info );
/*
* Restore database.
*
* As of 1.5.4, we are checking to see if the backup archive contains a
* database dump before running the below conditional. Not all archives
* will contain a database dump, so we may be able to skip this step.
*/
$db_dump_filepath = $this->get_dump_file( $filepath );
$this->logger->add( 'Attempting database restoration... $db_dump_filepath = ' . $db_dump_filepath );
$this->logger->add_memory();
if ( ! $dryrun && ! empty( $db_dump_filepath ) ) {
$db_prefix = null;
// Get the database table prefix from the new "wp-config.php" file, if exists.
if ( $this->wp_filesystem->exists( ABSPATH . 'wp-config.php' ) ) {
$wpcfg_contents = $this->wp_filesystem->get_contents( ABSPATH . 'wp-config.php' );
}
if ( ! empty( $wpcfg_contents ) ) {
preg_match( '#\$table_prefix.*?=.*?' . "'" . '(.*?)' . "'" . ';#', $wpcfg_contents, $matches );
if ( ! empty( $matches[1] ) ) {
$db_prefix = $matches[1];
}
}
// Determine if the dump file is encrypted.
$this->archive->init( $filepath );
$db_encrypted = $this->archive->get_attribute( 'encrypt_db' );
// Restore the database and then delete the dump.
$restore_ok = $this->restore_database( $db_dump_filepath, $db_prefix, $db_encrypted );
$this->wp_filesystem->delete( $db_dump_filepath, false, 'f' );
// Display notice of deletion status.
if ( ! $restore_ok ) {
$error_message = $this->db_restore_error ? $this->db_restore_error : esc_html__( 'Could not restore database.', 'boldgrid-backup' );
$this->logger->add( $error_message );
return [ 'error' => $error_message ];
}
}
$this->logger->add( 'Database restoration complete.' );
$this->logger->add_memory();
// Clear rollback information and restoration cron jobs that may be present.
$this->auto_rollback->cancel();
// Get settings.
$settings = $this->settings->get_settings();
// If enabled, send email notification for restoration completed.
if ( ! empty( $settings['notifications']['restore'] ) ) {
$this->logger->add( 'Sending "restoration complete" email notification...' );
// Include the mail template.
include BOLDGRID_BACKUP_PATH . '/admin/partials/boldgrid-backup-admin-mail-restore.php';
// Send the notification.
// Parameters come from the included mail template file.
$info['mail_success'] = $this->email->send( $subject, $body );
$this->logger->add( 'Email sent. Status: ' . ( empty( $info['mail_success'] ) ? 'Fail' : 'Success' ) );
}
// Update status.
$info['restore_ok'] = $restore_ok;
// Check backup directory.
$info['backup_directory_set'] = $this->backup_dir->get();
$this->logger->add( 'Restoration complete!' );
$this->restoring_archive_file = false;
// Return info array.
return $info;
}
/**
* Menu callback to display the Backup home page.
*
* @since 1.0
*
* @see Boldgrid_Backup_Admin_Upload::upload_archive_file().
* @global string $pagenow
*
* @return null
*/
public function page_archives() {
global $pagenow;
// Thickbox used for Backup Site Now modal.
wp_enqueue_style( 'boldgrid-backup-admin-new-thickbox-style' );
wp_enqueue_style( 'bglib-ui-css' );
// Run the functionality tests.
$is_functional = $this->test->run_functionality_tests();
// If tests fail, then show an admin notice and abort.
if ( ! $is_functional ) {
$this->notice->functionality_fail_notice();
return;
}
$this->auto_rollback->enqueue_home_scripts();
$this->auto_rollback->enqueue_backup_scripts();
$this->archive_actions->enqueue_scripts();
$this->folder_exclusion->enqueue_scripts();
$this->db_omit->enqueue_scripts();
// Get archive list.
$archives = $this->get_archive_list();
// Get the archives file count.
$archives_count = count( $archives );
// Get the total size for all archives.
$archives_size = 0;
foreach ( $archives as $archive ) {
$archives_size += $archive['filesize'];
}
// Get backup identifier.
$backup_identifier = $this->get_backup_identifier();
$settings = $this->settings->get_settings();
// If the directory path is not in the settings, then add it for the form.
if ( empty( $settings['backup_directory'] ) ) {
$settings['backup_directory'] = $this->backup_dir->get();
}
$table = $this->archives->get_table();
// Include the home page template.
include BOLDGRID_BACKUP_PATH . '/admin/partials/boldgrid-backup-admin-home.php';
}
/**
* Callback function for creating a backup archive file now via AJAX.
*
* @since 1.0
*
* @see Boldgrid_Backup_Admin_Core::archive_files()
*/
public function boldgrid_backup_now_callback() {
// Verify nonce.
if ( ! isset( $_POST['backup_auth'] ) || 1 !== check_ajax_referer( 'boldgrid_backup_now', 'backup_auth', false ) ) {
$this->notice->add_user_notice(
'
',
'error'
);
wp_die();
}
$this->is_backup_now = true;
$is_all_files = isset( $_POST['folder_exclusion_type'] ) && 'full' === $_POST['folder_exclusion_type'];
$is_all_tables = isset( $_POST['table_inclusion_type'] ) && 'full' === $_POST['table_inclusion_type'];
$this->is_backup_full = $is_all_files && $is_all_tables;
$this->is_archiving_update_protection = ! empty( $_POST['is_updating'] ) &&
'true' === $_POST['is_updating'];
$archiver = new Boldgrid_Backup_Archiver();
$archiver->run();
$archive_info = $archiver->get_info();
/*
* If there were any errors encountered during the backup, save them to the In Progress data.
*
* A "process error" is when the archive_files() method successfully returns info, and it includes
* an error.
*/
if ( ! empty( $archive_info['error'] ) ) {
Boldgrid_Backup_Admin_In_Progress_Data::set_arg( 'process_error', $archive_info['error'] );
Boldgrid_Backup_Admin_In_Progress_Data::set_arg( 'success', false );
}
if ( $this->is_archiving_update_protection ) {
update_site_option( 'boldgrid_backup_pending_rollback', $archive_info );
}
/*
* Finish.
*
* Normally we'd give the user a notice that the backup has been completed. However, since
* 1.11.2, we are no longer waiting for this ajax call to complete. The "in progress" bar
* will give the user any updates they need.
*/
wp_send_json_success();
}
/**
* Callback function for downloading an archive file via AJAX.
*
* This callback function should only be called if the WP_Filesystem method is "direct", or
* a message should be displayed with the path to download using an alternate method.
*
* @since 1.0
*
* @see Boldgrid_Backup_File::send_file()
*/
public function download_archive_file_callback() {
$log = new Boldgrid_Backup_Admin_Log( $this );
$log->init( 'backup-download.log' );
$log->add_separator();
$log->add( 'Attempting ajax download...' );
// Verify nonce, or die.
check_ajax_referer( 'archive_auth', 'wpnonce' );
// Check user capabilities.
if ( ! current_user_can( 'update_plugins' ) ) {
$error = __( 'Security violation (not authorized).', 'boldgrid-backup' );
echo esc_html( $error );
$log->add( $error );
wp_die();
}
// Validate download_key.
if ( isset( $_POST['download_key'] ) && is_numeric( $_POST['download_key'] ) ) {
$download_key = (int) $_POST['download_key'];
} else {
$error = __( 'INVALID DOWNLOAD KEY', 'boldgrid-backup' );
echo esc_html( $error );
$log->add( $error );
wp_die();
}
// Validate download_filename.
if ( ! empty( $_POST['download_filename'] ) ) {
$download_filename = sanitize_file_name( $_POST['download_filename'] );
} else {
$error = __( 'INVALID DOWNLOAD FILENAME', 'boldgrid-backup' );
echo esc_html( $error );
$log->add( $error );
wp_die();
}
// Get the current wp_filesystem access method.
$access_type = get_filesystem_method();
// Check WP_Filesystem method; ensure it is "direct".
if ( 'direct' !== $access_type ) {
$error = __( 'WP_Filesystem method is not "direct"', 'boldgrid-backup' );
echo esc_html( $error );
$log->add( $error );
wp_die();
}
// Get archive list.
$archives = $this->get_archive_list( $download_filename );
// If no files were found, then abort.
if ( empty( $archives ) ) {
$error = __( 'NO BACKUP ARCHIVES FOUND', 'boldgrid-backup' );
echo esc_html( $error );
$log->add( $error );
wp_die();
}
// Locate the filename by key number.
$filename = (
! empty( $archives[ $download_key ]['filename'] ) ?
$archives[ $download_key ]['filename'] : null
);
// Verify filename.
if ( $download_filename !== $filename ) {
$error = __( 'FILE NOT FOUND', 'boldgrid-backup' );
echo esc_html( $error );
$log->add( $error );
wp_die();
}
$filepath = $archives[ $download_key ]['filepath'];
$filesize = $archives[ $download_key ]['filesize'];
if ( isset( $this->activity ) ) {
$this->activity->add( 'download_to_local_machine', 1, $this->rating_prompt_config );
}
// Send the file and die nicely.
$log->add( 'Request validated successfully. Now on to sending the file...' );
Boldgrid_Backup_File::send_file( $filepath, $filesize );
}
/**
* Menu callback to display the Backup functionality test page.
*
* @since 1.0
*
* @global string $wp_version The WordPress version string.
* @global wpdb $wpdb The WordPress database class object.
*/
public function page_backup_test() {
// Perform functionality tests.
$is_functional = $this->test->run_functionality_tests();
// Get the user home directory.
$home_dir = $this->config->get_home_directory();
// Get the mode of the directory.
$home_dir_mode = $this->config->get_home_mode();
// Check if home directory is writable.
$home_dir_writable = $this->test->is_homedir_writable();
// Get the backup directory path.
$backup_directory = $this->backup_dir->get();
$possible_backup_dirs = $this->backup_dir->get_possible_dirs();
// Get the WordPress version.
global $wp_version;
// Connect to the WordPress database via $wpdb.
global $wpdb;
// Get the database size.
$db_size = $this->test->get_database_size();
// Get the database character set.
$db_charset = $wpdb->charset;
// Get the database collation.
$db_collate = $wpdb->collate;
$disk_space = $this->test->get_disk_space();
/*
* Cron time zone testing.
*
* This set of code may modify cron jobs. Be sure to run before we get the cron jobs below
* so that we give the user accurate info about which cron jobs are set.
*/
if ( ! empty( $_POST['cron_timezone_test'] ) && check_admin_referer( 'cron_timezone_test' ) ) { // Input var okay.
$this->cron_test->setup();
} elseif ( ! $this->cron_test->is_running() ) {
$this->cron_test->clean_up();
}
// Get our crons and ready them for display.
$our_crons = $this->cron->get_our_crons();
foreach ( $our_crons as &$cron ) {
$cron = esc_html( $cron );
}
$our_wp_crons = $this->wp_cron->get_our_crons();
foreach ( $our_wp_crons as &$cron ) {
$cron = esc_html( $cron );
}
$cli_support = $this->test->get_cli_support();
// Enqueue CSS for the test page.
wp_enqueue_style(
'boldgrid-backup-admin-test',
plugin_dir_url( __FILE__ ) . 'css/boldgrid-backup-admin-test.css',
[],
BOLDGRID_BACKUP_VERSION, 'all'
);
$settings = $this->settings->get_settings();
wp_enqueue_style( 'boldgrid-backup-admin-new-thickbox-style' );
wp_enqueue_style( 'bglib-ui-css' );
$this->auto_rollback->enqueue_home_scripts();
$this->auto_rollback->enqueue_backup_scripts();
$this->archive_actions->enqueue_scripts();
$this->folder_exclusion->enqueue_scripts();
$this->db_omit->enqueue_scripts();
$in_modal = true;
$modal = include BOLDGRID_BACKUP_PATH . '/admin/partials/boldgrid-backup-admin-backup-modal.php';
$in_modal = false;
echo '
';
}
/**
* Set doing_cron.
*
* $this->doing_cron specifies whether or not we're doing cron.
*
* When we're generating a backup, both via cron and wpcron, doing_cron is true.
*
* @uses $_GET['doing_wp_cron'] The timestamp the cron has been triggered. Please see:
* @link https://github.com/WordPress/WordPress/blob/5.1.1/wp-cron.php#L84-L96
* @link https://github.com/WordPress/WordPress/blob/5.1.1/wp-includes/cron.php#L635-L639
*
* @since 1.9.2
*/
public function set_doing_cron() {
$this->doing_cron = ( defined( 'DOING_CRON' ) && DOING_CRON ) || isset( $_GET['doing_wp_cron'] ); // phpcs:ignore WordPress.CSRF.NonceVerification.NoNonceVerification
}
/**
* Set lang strings.
*
* @since 1.5.3
*/
public function set_lang() {
/*
* The "want_to" string is a generic "why you should upgrade" string used for general
* purposes. For example, it's currently used at the bottom of the backups page.
*/
$this->lang = [
// Mine count, total number of backups.
'All' => esc_html__( 'All', 'boldgrid-backup' ),
'backup_created' => esc_html__( 'Backup created successfully!', 'boldgrid-backup' ),
'Checking_credentials' => esc_html__( 'Checking credentials', 'boldgrid-backup' ),
'checkmark' => '✓',
'get_support' => wp_kses(
sprintf(
// translators: 1 The opening anchor tag to the support tab, 2 its closing anchor tag.
esc_html__( 'Please try again. If you continue to experience problems, please %1$scontact us for additional support%2$s.', 'boldgrid-backup' ),
'',
''
),
[ 'a' => [ 'href' => [] ] ]
),
'icon_success' => ' ',
'icon_warning' => ' ',
'heading_update_protection' => BOLDGRID_BACKUP_TITLE . ' - ' . esc_html__( 'Update Protection', 'boldgrid-backup' ),
// Mine count, number of backups on remote storage providers.
'Remote' => esc_html__( 'Remote', 'boldgrid-backup' ),
'spinner' => '',
'spinner_inline' => '',
/*
* The "want_to" string is a generic "why you should upgrade" string used for general
* purposes. For example, it's currently used at the bottom of the backups page.
*/
'want_to' => sprintf(
// translators: 1 Markup showing a "Google Drive" logo, 2 Markup showing an "Amazon S3" logo.
__( 'Catastrophic data loss can happen at any time. Storing your archives in multiple secure locations will keep your website data safe and put your mind at ease. Upgrade to %3$s to enable automated remote backups to %1$s and %2$s', 'boldgrid-backup' ),
'',
'',
BOLDGRID_BACKUP_TITLE . ' Premium'
),
// Mine count, number of backups on local web server.
'Web_Server' => esc_html__( 'Web Server', 'boldgrid-backup' ),
];
$this->elements = [
'update_protection_activated' => sprintf( '%1$s %2$s', $this->lang['icon_success'], esc_html__( 'Update protection activated!', 'boldgrid-backup' ) ),
// Use on long loading pages. Javascript will remove this on page load.
'long_checking_creds' => sprintf( '
%1$s %2$s
', $this->lang['Checking_credentials'], $this->lang['spinner_inline'] ),
];
}
/**
* Set the PHP timeout limit to at least 15 minutes.
*
* Various places within this class use to set the timeout limit to 300 seconds. This timeout
* limit has been increased to 900 seconds and moved into its own method.
*
* @since 1.3.5
*
* @param int $time_limit Limit in seconds.
*/
public function set_time_limit( $time_limit = 900 ) {
$max_execution_time = ini_get( 'max_execution_time' );
set_time_limit( ( $max_execution_time > $time_limit ? $max_execution_time : $time_limit ) );
}
/**
* Handle ajax request to restore a file.
*
* @since 1.6.0
*/
public function wp_ajax_restore() {
$error = esc_html__( 'Unable to restore backup: ', 'boldgrid-backup' );
$redirect_url = esc_url( admin_url( 'admin.php?page=boldgrid-backup' ) );
// Validate user role.
if ( ! current_user_can( 'update_plugins' ) ) {
$this->notice->add_user_notice(
'
 . 'boldgrid-backup/admin/image/db-lock-64.png)
';
$this->title = esc_html__( 'Database Encryption', 'boldgrid-backup' );
$this->content = ' . '../image/remote/google-drive.png)
';
$this->footer = '
 . '../image/remote/dreamhost-logo.png){kind=logo}
';
}
}
admin/card/class-database-encryption.php 0000644 00000003106 14757772271 0014340 0 ustar 00
*/
namespace Boldgrid\Backup\Admin\Card;
/**
* Class: Encryption.
*
* This class is responsible for rendering the "Encryption" card on this plugin's Premium Features page.
*
* @since 1.13.0
*/
class Database_Encryption extends \Boldgrid\Library\Library\Ui\Card {
/**
* Init.
*
* @since 1.13.0
*/
public function init() {
$this->id = 'bgbkup_database_encryption';
$this->title = esc_html__( 'Database Encryption', 'boldgrid-backup' );
$this->footer = '
 . '../image/db-lock-64.png)
';
}
}
admin/card/class-backups.php 0000644 00000002134 14757772271 0012034 0 ustar 00
*/
namespace Boldgrid\Backup\Admin\Card;
/**
* Class: Backups.
*
* This class is responsible for rendering the "Backups" card on this plugin's dashboard.
*
* @since 1.11.0
*/
class Backups extends \Boldgrid\Library\Library\Ui\Card {
/**
* Init.
*
* @since 1.11.0
*/
public function init() {
$this->id = 'bgbkup_backups';
$this->title = esc_html__( 'Backups', 'boldgrid-backup' );
$this->subTitle = esc_html__( 'It\'s website insurance. Make sure you have a backup.', 'boldgrid-backup' ); // phpcs:ignore WordPress.NamingConventions.ValidVariableName
$this->icon = '';
$this->features = array(
new Feature\Scheduled_Backups(),
new Feature\Remote_Storage(),
);
if ( ! get_option( 'boldgrid_backup_settings' )['encrypt_db'] ) {
$this->features[] = new Feature\Database_Encryption();
}
}
}
admin/card/class-amazon-s3.php 0000644 00000003035 14757772271 0012215 0 ustar 00
*/
namespace Boldgrid\Backup\Admin\Card;
/**
* Class: Amazon_S3.
*
* This class is responsible for rendering the "Amazon S3" card on this plugin's Premium Features page.
*
* @since 1.13.0
*/
class Amazon_S3 extends \Boldgrid\Library\Library\Ui\Card {
/**
* Init.
*
* @since 1.13.0
*/
public function init() {
$this->id = 'bgbkup_amazon_s3';
$this->title = esc_html__( 'Amazon S3', 'boldgrid-backup' );
$this->footer = '
 . '../image/remote/amazon-s3-logo.png){kind=logo}
';
}
}
admin/compressor/class-boldgrid-backup-admin-compressor-system-zip-test.php 0000644 00000016706 14757772271 0023311 0 ustar 00
*/
/**
* Class: Boldgrid_Backup_Admin_Compressor_System_Zip_Test
*
* @since 1.13.0
*/
class Boldgrid_Backup_Admin_Compressor_System_Zip_Test {
/**
* An instance of core.
*
* @since 1.13.0
* @access private
* @var Boldgrid_Backup_Admin_Core
*/
private $core;
/**
* An error message.
*
* @since 1.13.0
* @access private
* @var string
*/
private $error;
/**
* An array of files that will make up the self::filelist_filepath file.
*
* @since 1.13.0
* @access private
* @var array
*/
private $filelist = [];
/**
* A filepath to the file containing a list of files we will zip.
*
* @since 1.13.0
* @access private
* @var array
*/
private $filelist_filepath;
/**
* An array of files and folders that we will create.
*
* @since 1.13.0
* @access private
* @var array
*/
private $items;
/**
* A path to a directory we will be creating, filling with files, and zipping.
*
* @since 1.13.0
* @access private
* @var string
*/
private $test_dir;
/**
* A filepath to the zip we will be creating.
*
* @since 1.13.0
* @access private
* @var string
*/
private $zip_filepath;
/**
* Constructor.
*
* @since 1.13.0
*
* @param Boldgrid_Backup_Admin_Core $core
*/
public function __construct( Boldgrid_Backup_Admin_Core $core ) {
$this->core = $core;
$this->items = [
[
'type' => 'f',
'name' => 'file.txt',
],
[
'type' => 'd',
'name' => 'folder-empty',
],
[
'type' => 'd',
'name' => 'folder-1',
],
[
'type' => 'f',
'name' => 'folder-1/file-1.txt',
],
[
'type' => 'd',
'name' => 'folder-1/folder-1a',
],
[
'type' => 'd',
'name' => 'folder-1/folder-1a/folder-1a.txt',
],
];
$this->zip_filepath = $this->core->backup_dir->get_path_to( $this->core->test->test_prefix . 'system-zip-test.zip' );
$this->filelist_filepath = $this->core->backup_dir->get_path_to( $this->core->test->test_prefix . 'system-zip-filelist.txt' );
$this->test_dir = $this->core->backup_dir->get_path_to( $this->core->test->test_prefix . 'system-zip-test' );
}
/**
* Get our error message.
*
* @since 1.13.0
*
* @return string
*/
public function get_error() {
return $this->error;
}
/**
* Create and setup our test directory.
*
* We will be zipping up this directory.
*
* @since 1.13.0
*
* @return bool True on success.
*/
private function test_dir_create() {
// Create our test directory.
if ( ! $this->core->wp_filesystem->mkdir( $this->test_dir ) ) {
$this->error = sprintf(
// translators: 1 The name of a folder that could not be created.
esc_html__( 'Unable to create test directory: %1$s', 'boldgrid-backup' ),
$this->test_dir
);
return false;
}
// Create all the files. Abort if one could not be.
foreach ( $this->items as $item ) {
$created = false;
switch ( $item['type'] ) {
case 'd':
$created = $this->core->wp_filesystem->mkdir( $this->test_dir . DIRECTORY_SEPARATOR . $item['name'] );
break;
case 'f':
$created = $this->core->wp_filesystem->touch( $this->test_dir . DIRECTORY_SEPARATOR . $item['name'] );
break;
}
// Add this item to our filelist (a .txt file containing a list of files to backup).
$this->filelist[] = $item['name'];
// Above if we could not create a file.
if ( ! $created ) {
$this->error = sprintf(
// translators: 1 The name of a file that could not be created.
esc_html__( 'Unable to create test file: %1$s', 'boldgrid-backup' ),
$item['name']
);
return false;
}
}
// Save the filelist.
if ( ! $this->core->wp_filesystem->put_contents( $this->filelist_filepath, implode( PHP_EOL, $this->filelist ) ) ) {
$this->error = esc_html__( 'Unable to create filelist.txt', 'boldgrid-backup' );
return false;
}
return true;
}
/**
* Restore our test directory from zip and make sure everything was restored.
*
* @since 1.13.0
*
* @return bool True on success.
*/
private function test_dir_restore() {
// Delete the folder we zipped and make sure it's gone.
if ( ! $this->core->wp_filesystem->delete( $this->test_dir, true ) ) {
$this->error = esc_html__( 'Unable to delete test directory.', 'boldgrid-backup' );
return false;
}
// Create our test directory again.
if ( ! $this->core->wp_filesystem->mkdir( $this->test_dir ) ) {
$this->error = esc_html__( 'Unable to recreate test directory.', 'boldgrid-backup' );
return false;
}
// Move our zip file to our test directory.
if ( ! $this->core->wp_filesystem->move( $this->zip_filepath, $this->test_dir . DIRECTORY_SEPARATOR . basename( $this->zip_filepath ) ) ) {
$this->error = esc_html__( 'Unable to move zip to test directory.', 'boldgrid-backup' );
return false;
}
// Unzip.
$this->core->execute_command( 'cd ' . $this->test_dir . '; unzip ' . basename( $this->zip_filepath ) );
foreach ( $this->items as $item ) {
$path = $this->test_dir . DIRECTORY_SEPARATOR . $item['name'];
if ( ! $this->core->wp_filesystem->exists( $path ) ) {
$this->error = esc_html__( 'Unable to restore all files and folders.', 'boldgrid-backup' );
return false;
}
}
return true;
}
/**
* Zip up our test directory.
*
* @since 1.13.0
*
* @return bool True on success.
*/
private function test_dir_zip() {
// Zip everything up and make sure it worked.
$this->core->execute_command( 'cd ' . $this->test_dir . '; zip ' . $this->zip_filepath . ' -@ < ' . $this->filelist_filepath );
if ( ! $this->core->wp_filesystem->exists( $this->zip_filepath ) ) {
$this->error = esc_html__( 'Unable to create zip file.', 'boldgrid-backup' );
return false;
}
return true;
}
/**
* Determine if system_zip is working as expected.
*
* On average, this takes 0.019 seconds to complete.
*
* @since 1.13.0
*
* @param bool $force Whether to run this test or get results from transient.
* @return bool True on success.
*/
public function run( $force = false ) {
// Force a fresh test if we're on the preflight check page.
$force = Boldgrid_Backup_Admin_Utility::is_admin_page( 'boldgrid-backup-test' ) ? true : $force;
$pass = 1;
$transient_key = 'boldgrid_backup_system_zip_test';
$transient_value = get_transient( $transient_key );
if ( ! $force && false !== $transient_value ) {
return $transient_value;
}
// Before and after running the test, delete test files created.
$this->core->test->delete_test_files( $this->core->backup_dir->get() );
// This is the beef of the test, where we actually test things.
if ( ! $this->core->execute_command( '/usr/bin/zip -v ' ) ) {
$this->error = __( '/usr/bin/zip is not available.', 'boldgrid-backup' );
$pass = 0;
} elseif ( ! $this->test_dir_create() ) {
// Create our test directory.
$pass = 0;
} elseif ( ! $this->test_dir_zip() ) {
// Zip up our test directory.
$pass = 0;
} elseif ( ! $this->test_dir_restore() ) {
// Restore our test directory.
$pass = 0;
}
$this->core->test->delete_test_files( $this->core->backup_dir->get() );
set_transient( $transient_key, $pass, 24 * HOUR_IN_SECONDS );
return ! empty( $pass );
}
}
admin/compressor/class-boldgrid-backup-admin-compressor-system-zip-temp-folder.php 0000644 00000004715 14757772271 0024545 0 ustar 00
*/
/**
* Class: Boldgrid_Backup_Admin_Compressor_System_Zip_Temp_Folder
*
* @since 1.13.0
*/
class Boldgrid_Backup_Admin_Compressor_System_Zip_Temp_Folder {
/**
* An instance of core.
*
* @since 1.13.0
* @access private
* @var Boldgrid_Backup_Admin_Core
*/
private $core;
/**
* The name of the temporary folder where the compression will take place.
*
* @since 1.13.0
* @access private
* @var string
*/
private static $name = 'system-zip-temp';
/**
* Constructor.
*
* @since 1.13.0
*/
public function __construct() {
$this->core = apply_filters( 'boldgrid_backup_get_core', null );
}
/**
* Create the temp folder.
*
* @since 1.13.0
*
* @return bool True on success.
*/
public function create() {
return $this->core->wp_filesystem->mkdir( self::get_path() );
}
/**
* Delete the temp folder.
*
* @since 1.13.0
*
* @return bool True on success.
*/
public function delete() {
return $this->core->wp_filesystem->rmdir( self::get_path() );
}
/**
* Determine whether or not the system zip temp folder exists.
*
* @since 1.13.8
*
* @return bool
*/
public function exists() {
$path = self::get_path();
return $this->core->wp_filesystem->exists( $path );
}
/**
* Return a list of files in the system zip temp folder.
*
* @since 1.13.8
*
* @return array
*/
public function dirlist() {
$dirlist = array();
if ( $this->exists() ) {
$path = trailingslashit( self::get_path() );
$dirlist = $this->core->wp_filesystem->dirlist( $path );
$dirlist = empty( $dirlist ) ? array() : $dirlist;
/*
* When using WP_Filesystem, the key of each array element is the name of the file. For
* this method, we prefer the keys to be the full path to the file.
*/
foreach ( $dirlist as $filename => $data ) {
$dirlist[ $path . $filename ] = $data;
unset( $dirlist[ $filename ] );
}
}
return $dirlist;
}
/**
* Get the path to our temp folder.
*
* @since 1.13.0
*
* @return string
*/
public static function get_path() {
$core = apply_filters( 'boldgrid_backup_get_core', null );
return $core->backup_dir->get_path_to( self::$name );
}
}
admin/compressor/class-boldgrid-backup-admin-compressor-system-zip.php 0000644 00000025207 14757772271 0022330 0 ustar 00
*/
/**
* Class: Boldgrid_Backup_Admin_Compressor_System_Zip
*
* @since 1.13.0
*/
class Boldgrid_Backup_Admin_Compressor_System_Zip extends Boldgrid_Backup_Admin_Compressor {
/**
* An error message.
*
* If we encounter an error while zipping, the error may be placed here - key phrase "may be placed
* here". At the introduction of this class property, it is being used in only one place. The entire
* class was not checked and tested to ensure all methods add any errors they run into here.
*
* @since SINCEVERSION
* @access private
* @var string
*/
private $error;
/**
* An array of files that should be archived.
*
* @since 1.13.0
* @access private
* @var array {
* An array of files.
*
* @type string 0 Path. Example: ""/home/user/public_html/readme.html".
* @type string 1 basename. Example: "readme.html".
* @type int 2 File size (in bytes). Example: "7413".
* @type string 3 File type. Examples: "d", "f".
* }
*/
private $filelist = [];
/**
* The filepath to our text file holding list of files to archive.
*
* @since 1.13.0
* @access private
* @var string
*/
private $filelist_path;
/**
* The filepath to the zip file.
*
* @since 1.13.0
* @access PRIVATE
* @var string
*/
private $filepath;
/**
* The temporary folder used when saving a zip file.
*
* @since 1.13.0
* @access private
* @var Boldgrid_Backup_Admin_Compressor_System_Zip_Temp_Folder
*/
private $temp_folder;
/**
* Key.
*
* @since 1.13.0
* @access protected
* @var string
*/
protected $key = 'system_zip';
/**
* Total Size Archived.
*
* @since 1.14.0
* @var int
*/
public $total_size_archived;
/**
* Default Compression Level.
*
* @since 1.14.0
* @var string
*/
public $default_compression_level = '6';
/**
* Constructor.
*
* @since 1.13.0
*/
public function __construct() {
$core = apply_filters( 'boldgrid_backup_get_core', null );
parent::__construct( $core );
$this->temp_folder = new Boldgrid_Backup_Admin_Compressor_System_Zip_Temp_Folder();
}
/**
* Archive files.
*
* @since 1.5.1
*
* @see Boldgrid_Backup_Admin_Filelist::get_total_size()
*
* @param array $filelist {
* File details.
*
* @type string 0 Path. Example: ""/home/user/public_html/readme.html".
* @type string 1 basename. Example: "readme.html".
* @type int 2 File size (in bytes). Example: "7413".
* @type string 3 File type. Examples: "d", "f".
* }
* @param array $info {
* Data about the backup archive we are generating.
*
* @type string mode backup
* @type bool dryrun
* @type string compressor php_zip
* @type int filesize 0
* @type bool save 1
* @type int total_size 0
* }
* @return mixed True on success, an array on failure. This approach has been taken to follow the
* standards already set by the pcl-zip and php-zip classes.
*/
public function archive_files( $filelist, &$info ) {
if ( $info['dryrun'] ) {
return true;
}
// Prevent this process from ending; allow the archive to be completed.
ignore_user_abort( true );
set_time_limit( 0 );
$this->filelist = $filelist;
$this->filepath = $info['filepath'];
$this->filelist_create();
Boldgrid_Backup_Admin_In_Progress_Data::set_arg( 'step', 3 );
$zip_success = $this->zip();
// @todo Simliar to the zip call above which returns a success status, so should zip_sql.
$this->zip_sql();
Boldgrid_Backup_Admin_In_Progress_Data::delete_arg( 'step' );
// Actions to take when we're all done / cleanup.
$this->core->wp_filesystem->delete( $this->filelist_path );
return true === $zip_success ? true : array(
'error' => $this->error,
);
}
/**
* Create the file containing a list of files to backup.
*
* @since 1.13.0
*/
private function filelist_create() {
$this->core->logger->add( 'Starting to create list of files to include in zip.' );
$this->core->logger->add_memory();
Boldgrid_Backup_Admin_In_Progress_Data::set_arg( 'step', 2 );
$this->filelist_path = $this->core->backup_dir->get_path_to( 'system_zip_filelist-' . time() . '.txt' );
$this->total_size_archived = 0;
// Create the file list.
$filelist_array = [];
foreach ( $this->filelist as $file ) {
$filelist_array[] = str_replace( ABSPATH, '', $file[0] );
$this->total_size_archived += empty( $file[2] ) ? 0 : $file[2];
}
// Add some values for "In progress".
Boldgrid_Backup_Admin_In_Progress_Data::set_arg( 'total_files_done', count( $this->filelist ) );
Boldgrid_Backup_Admin_In_Progress_Data::set_arg( 'total_size_archived', $this->total_size_archived );
Boldgrid_Backup_Admin_In_Progress_Data::set_arg( 'total_size_archived_size_format', size_format( $this->total_size_archived, 2 ) );
/*
* Remove our db_dump_filepath from the list.
*
* If we add it now, the zip file will include /home/user/boldgrid_backup/db.sql
*
* We'll add the sql separately in self::zip_sql().
*/
if ( ( $key = array_search( $this->core->db_dump_filepath, $filelist_array ) ) !== false ) { // phpcs:ignore
unset( $filelist_array[ $key ] );
}
$this->core->wp_filesystem->put_contents(
$this->filelist_path,
implode( PHP_EOL, $filelist_array )
);
$this->core->logger->add( 'Finished creating list of files to include in zip. ' . count( $filelist_array ) . ' files in zip.' );
$this->core->logger->add_memory();
}
/**
* Run the command to actually zip the files.
*
* @since 1.13.0
*
* @return bool True on success. Do note that $this->close() calls $this->zip_proc(), which will
* store any error messages in $this->error.
*/
private function zip() {
$this->core->logger->add( 'Starting to close the zip file.' );
$this->core->logger->add_memory();
$this->temp_folder->create();
$success = $this->close();
$this->temp_folder->delete();
$this->core->logger->add( 'Finished closing the zip file.' );
$this->core->logger->add_memory();
return $success;
}
/**
* Get Filelist Chunks.
*
* @since 1.14.0
*
* @return array Example https://pastebin.com/JsSEzNwA
*/
public function get_filelist_chunks() {
// Chunk size in bytes.
$max_chunk_size = 26214400;
$size_of_chunk = 0;
$filelist_chunks = array( array() );
$chunk_position = 0;
foreach ( $this->filelist as $file ) {
// Adds file to this chunk.
$filelist_chunks[ $chunk_position ][] = $file[1];
// Adds the most recent file's size to chunk size.
$size_of_chunk = $size_of_chunk + (int) $file[2];
// If the chunk size is >= the max chunk size, then move to next chunk.
if ( $size_of_chunk >= $max_chunk_size ) {
$chunk_position++;
$size_of_chunk = 0;
}
}
return $filelist_chunks;
}
/**
* Close.
*
* @since 1.14.0
*/
private function close() {
$chunks_closed = 0;
$filelist_chunks = $this->get_filelist_chunks();
$total_chunks = count( $filelist_chunks );
foreach ( $filelist_chunks as $filelist_chunk ) {
$chunk_start_time = microtime( true );
$success = $this->zip_proc( $filelist_chunk );
if ( ! $success ) {
return false;
}
// Process some stats.
$chunks_closed++;
$percent_complete = round( $chunks_closed / $total_chunks, 2 );
$chunk_end_time = microtime( true );
$close_duration = $chunk_end_time - $chunk_start_time;
Boldgrid_Backup_Admin_In_Progress_Data::set_arg( 'percent_closed', $percent_complete );
// Add messages to the log.
$this->core->logger->add(
'Chunk closed in ' .
$close_duration .
' seconds. ' . $percent_complete * 100 .
'% complete closing'
);
$this->core->logger->add_memory();
}
return true;
}
/**
* Get Compression Level.
*
* @since 1.14.0
*
* @return string
*/
private function get_compression_level() {
$compression_level = $this->core->settings->get_setting( 'compression_level' );
return isset( $compression_level ) ? $compression_level : $this->default_compression_level;
}
/**
* Close Zip using proc_open.
*
* @since 1.14.0
*
* @param array $filelist_chunk Array of Files to be added.
* @return bool True on success.
*/
private function zip_proc( $filelist_chunk ) {
$has_error = false;
$descriptorspec = array(
0 => array( 'pipe', 'r' ), // stdin is a pipe that the child will read from.
1 => array( 'pipe', 'w' ), // stdout is a pipe that the child will write to.
/**
* Initially we sent errors to /tmp/error-output.txt. This caused warnings when the file
* was not writable. For any error messages, see $pipes[2] further down this method.
*/
2 => array( 'pipe', 'w' ),
);
$cwd = ABSPATH;
$compression_level = $this->get_compression_level();
$process = proc_open( //phpcs:ignore WordPress.PHP.DiscouragedPHPFunctions.system_calls_proc_open
'zip -' . $compression_level . ' -g -q -@ ' . $this->filepath,
$descriptorspec,
$pipes,
$cwd
);
if ( is_resource( $process ) ) {
foreach ( $filelist_chunk as $file ) {
fwrite( $pipes[0], $file . "\n" ); //phpcs:ignore WordPress.WP.AlternativeFunctions
}
fclose( $pipes[0] ); //phpcs:ignore WordPress.WP.AlternativeFunctions
fclose( $pipes[1] ); //phpcs:ignore WordPress.WP.AlternativeFunctions
// Check for any errors.
$stderr = stream_get_contents( $pipes[2] );
fclose( $pipes[2] ); //phpcs:ignore WordPress.WP.AlternativeFunctions
if ( ! empty( $stderr ) ) {
$this->error = $stderr;
$this->core->logger->add( 'Error zipping files with system zip: ' . $stderr );
$has_error = true;
}
// It is important that you close any pipes before calling.
// proc_close in order to avoid a deadlock.
proc_close( $process );
} else {
$has_error = true;
}
return ! $has_error;
}
/**
* Add the .sql file individually.
*
* @since 1.13.0
*
* @see self::filelist_create
*/
private function zip_sql() {
$this->core->logger->add( 'Starting to add db dump to the zip file.' );
$this->core->logger->add_memory();
$dir = pathinfo( $this->core->db_dump_filepath, PATHINFO_DIRNAME );
$compression_level = $this->get_compression_level();
$this->core->execute_command( 'cd ' . $dir . '; zip -' . $compression_level . ' -g -q ' . $this->filepath . ' ' . basename( $this->core->db_dump_filepath ) . ';' );
$this->core->logger->add( 'Finished adding db dump to the zip file.' );
$this->core->logger->add_memory();
}
}
admin/compressor/class-boldgrid-backup-admin-compressor-php-zip.php 0000644 00000024347 14757772271 0021577 0 ustar 00
*/
/**
* Class: Boldgrid_Backup_Admin_Compressor_Php_Zip
*
* @since 1.5.1
*/
class Boldgrid_Backup_Admin_Compressor_Php_Zip extends Boldgrid_Backup_Admin_Compressor {
/**
* An array of directories we've added to the zip.
*
* @since 1.6.0
* @access public
* @var array
*/
public $dirs = array();
/**
* The status of our test result.
*
* @since 1.5.1
* @access public
* @var mixed|bool|null
*/
public static $test_result = null;
/**
* An array of any errors received while testing.
*
* @since 1.5.1
* @access public
* @var array
*/
public $test_errors = array();
/**
* An instance of ZipArchive.
*
* @since 1.5.1
* @var ZipArchive
*/
public $zip;
/**
* Key.
*
* @since 1.13.0
* @access protected
* @var string
*/
protected $key = 'php_zip';
/**
* Add a file's directories to the zip.
*
* When you add a file, the parent directories are not always explicitly
* created. For example, if you add wp-content/themes/pavilion/index.php the
* wp-content directory (and so forth) is not explicity added to the zip.
*
* @since 1.6.0
*
* @param string $file A file path.
*/
public function add_dir( $file ) {
$add_directory = '';
$dirs = explode( DIRECTORY_SEPARATOR, dirname( $file ) );
foreach ( $dirs as $key => $dir ) {
if ( 0 === $key ) {
$add_directory = $dir;
} else {
$add_directory .= '/' . $dir;
}
if ( ! in_array( $add_directory, $this->dirs, true ) ) {
$this->zip->addEmptyDir( $add_directory );
$this->dirs[] = $add_directory;
}
}
}
/**
* Archive files.
*
* @since 1.5.1
*
* @see Boldgrid_Backup_Admin_Filelist::get_total_size()
*
* @param array $filelist {
* File details.
*
* @type string 0 Path. Example: ""/home/user/public_html/readme.html".
* @type string 1 basename. Example: "readme.html".
* @type int 2 File size (in bytes). Example: "7413".
* @type string 3 File type. Examples: "d", "f".
* }
* @param array $info {
* Data about the backup archive we are generating.
*
* @type string mode backup
* @type bool dryrun
* @type string compressor php_zip
* @type int filesize 0
* @type bool save 1
* @type int total_size 0
* }
*/
public function archive_files( $filelist, &$info ) {
// Init vars used for our "in progress" bar.
$number_files_archived = 0;
$total_size_archived = 0;
$number_files_todo = count( $filelist );
$last_x_files = array();
if ( $info['dryrun'] ) {
return true;
}
// Prevent this process from ending; allow the archive to be completed.
ignore_user_abort( true );
set_time_limit( 0 );
$this->zip = new ZipArchive();
$status = $this->zip->open( $info['filepath'], ZipArchive::CREATE );
if ( ! $status ) {
return array(
'error' => 'Cannot open ZIP archive file "' . $info['filepath'] . '".',
'error_code' => $status,
'error_message' => Boldgrid_Backup_Admin_Utility::translate_zip_error( $status ),
);
}
$has_setexternalattributesname = method_exists( $this->zip, 'setExternalAttributesName' );
foreach ( $filelist as $fileinfo ) {
$is_dir = ! empty( $fileinfo[3] ) && 'd' === $fileinfo[3];
switch ( $is_dir ) {
case true:
$this->zip->addEmptyDir( $fileinfo[1] );
break;
case false:
if ( ! is_readable( $fileinfo[0] ) ) {
$info['backup_errors'][] = sprintf(
// translators: 1 The path to a file that was unable to be added to the backup.
__( 'Permission defined. Unable to add the following file to your backup: %1$s', 'boldgrid-backup' ),
$fileinfo[0]
);
continue 2;
} else {
$this->zip->addFile( $fileinfo[0], $fileinfo[1] );
$this->add_dir( $fileinfo[1] );
}
break;
}
/*
* ZipArchive::setExternalAttributesName() is avaiable in PHP >= 5.6.
* If available, use the method to set the permissions for items in the ZIP archive.
* By default, items in a ZIP file are extracted with loose (777/666) modes, which can
* cause issues on Linux systems using suEXEX/suPHP or other mechanisms requiring
* tighter (755/644; world non-writable permissions) modes on directories and files.
*/
if ( $has_setexternalattributesname ) {
$this->zip->setExternalAttributesName(
$is_dir ? $fileinfo[1] . '/' : $fileinfo[1],
ZipArchive::OPSYS_UNIX,
fileperms( $fileinfo[0] ) << 16
);
}
$number_files_archived++;
$total_size_archived += empty( $fileinfo[2] ) ? 0 : $fileinfo[2];
/*
* If applicable, add this file to the list of files archived that we show the user.
*
* To give the user a more broad sense of the files being added, our list only contains
* every 20th file.
*
* Our list is only 5 long because we make hook into the heartbeat every 5 seconds to grab
* the last 5 files, and we display each file for 1 second.
*/
if ( 0 === $number_files_archived % 20 ) {
$last_x_files[] = $fileinfo[1];
if ( count( $last_x_files ) > 5 ) {
array_shift( $last_x_files );
}
}
/*
* Update our "in progress" data.
*
* To prevent excessive calls to update options, we only update our in progress data every
* 100 files.
*/
$all_files_archived = $number_files_archived >= $number_files_todo;
if ( 0 === $number_files_archived % 100 || $all_files_archived ) {
Boldgrid_Backup_Admin_In_Progress_Data::set_arg( 'total_files_done', $number_files_archived );
Boldgrid_Backup_Admin_In_Progress_Data::set_arg( 'last_files', $last_x_files );
Boldgrid_Backup_Admin_In_Progress_Data::set_arg( 'total_size_archived', $total_size_archived );
Boldgrid_Backup_Admin_In_Progress_Data::set_arg( 'total_size_archived_size_format', size_format( $total_size_archived, 2 ) );
Boldgrid_Backup_Admin_In_Progress_Data::set_arg( 'step', 2 );
}
}
$this->core->logger->add(
sprintf(
'Total files / size archived: %1$s / %2$s (%3$s)',
$number_files_archived,
$total_size_archived,
size_format( $total_size_archived, 2 )
)
);
/*
* We're done archiving all files.
*
* Empty out the "last files archived" data, and set an appropriate status.
*/
Boldgrid_Backup_Admin_In_Progress_Data::delete_arg( 'last_files' );
Boldgrid_Backup_Admin_In_Progress_Data::set_arg( 'step', 3 );
/*
* Verify files before write/close. Delete any invalid file indicies in the ZIP index.
*
* In some scenarios, a file will be added above, but then deleted before the zip->close()
* call below. For example, while a backup is in progress, users may be editing pages and
* on save, cache files may get deleted. If the cache file was added to the zip above, and then
* deleted before the zip->close() below, we're going to have a problem.
*
* There is one file path outside of ABSPATH; the database dump file.
* The full path of each file is determined by checking if it is the dump file or not.
*
* @todo The user is not notified if a file is removed below.
*/
for ( $i = 0; $i < $this->zip->numFiles; $i++ ) {
$filename = $this->zip->getNameIndex( $i );
$filepath = false !== strpos( $this->core->db_dump_filepath, $filename ) ?
$this->core->db_dump_filepath : ABSPATH . $filename;
if ( ! $this->core->wp_filesystem->is_readable( $filepath ) ) {
$this->zip->deleteIndex( $i );
}
}
$this->core->logger->add( 'Starting to close the zip file.' );
$this->core->logger->add_memory();
$close = $this->zip->close();
$this->core->logger->add( 'Finished closing the zip file.' );
$this->core->logger->add_memory();
Boldgrid_Backup_Admin_In_Progress_Data::delete_arg( 'step' );
if ( ! $close ) {
return array(
'error' => 'Cannot close ZIP archive file "' . $info['filepath'] . '".',
);
}
return true;
}
/**
* Determine if ZipArchive is available.
*
* @since 1.5.2
*/
public static function is_extension_available() {
return extension_loaded( 'zip' ) && class_exists( 'ZipArchive' );
}
/**
* Test the functionality of php_zip.
*
* @since 1.5
*
* @return bool
*/
public function test() {
if ( null !== self::$test_result ) {
return self::$test_result;
}
$backup_dir = $this->core->backup_dir->get();
$test_file_contents = sprintf(
// translators: 1: Plugin title.
__( 'This is a test file from %1$s. You can delete this file.', 'boldgrid-backup' ),
BOLDGRID_BACKUP_TITLE
);
// translators: 1: A filename.
$cannot_open_zip = __( 'Unable to create zip file: %1$s', 'boldgrid-backup' );
// translators: 1: Backup directory path.
$cannot_close_zip = __( 'When testing ZipArchive functionality, we are able to create a zip file and add files to it, but we were unable to close the zip file.