Back compat pass

Ensure the API we expose to Extensions stays backwards compatible.

- Renames Site_Backup back to Backup as the extensions use type hinting to ensure that the Backup object is of type `Backup`.
- Introduce a back compat `Backup::get_archive_filepath()` which fires a deprecated warning and calls `Backup::get_backup_filepath()`.
- Introduce a back compat `Scheduled_Backup::set_status()` which fires a deprecated warning and calls `Scheduled_Backup->status::set_status()`.
- Introduce a back compat `hmbkp_add_settings_error` which fires a deprecated warning and calls `add_settings_error`.

Tested the existing versions of all our extensions and they now work as intended.

Author: willmot

admin/actions.php

@@ -193,7 +193,7 @@ function edit_schedule_services_submit() {
 
 	if ( $errors ) {
 		foreach ( $errors as $error ) {
-			hmbkp_add_settings_error( $error );
+			add_settings_error( $error );
 		}
 	}
 

classes/backup/class-site-backup.php classes/backup/class-backup.php

@@ -2,7 +2,7 @@
 
 namespace HM\BackUpWordPress;
 
-class Site_Backup {
+class Backup {
 
 	private $excludes;
 	public $warnings = array();
@@ -186,4 +186,15 @@ public function get_backup_filepath() {
 		return $this->backup_filepath;
 	}
 
+	/**
+	 * Back compat with old method name
+	 *
+	 * @see Backup::get_backup_filepath()
+ 	 * @deprecated 3.4 Use Backup::get_backup_filepath()
+	 */
+	public function get_archive_filepath() {
+		_deprecated_function( __FUNCTION__, '3.4', 'get_backup_filepath()' );
+		return $this->get_backup_filepath();
+	}
+
 }

classes/class-backupwordpress-wp-cli-command.php

@@ -1,13 +1,15 @@
 <?php
 
+namespace HM\BackUpWordPress;
+
 /**
  * Implement backup command
  *
  * @todo fix
  * @package wp-cli
  * @subpackage commands/third-party
  */
-class BackUpWordPress_WP_CLI_Command extends WP_CLI_Command {
+class CLI extends \WP_CLI_Command {
 
 	/**
 	 * Perform a Backup.
@@ -26,12 +28,6 @@ class BackUpWordPress_WP_CLI_Command extends WP_CLI_Command {
 	 * [--root]
 	 * : dir that should be backed up, defaults to site root.
 	 *
-	 * [--zip_command_path]
-	 * : path to your zip binary, standard locations are automatically used
-	 *
-	 * [--mysqldump_command_path]
-	 * : path to your mysqldump binary, standard locations are automatically used
-	 *
 	 * [--archive_filename]
 	 * : filename for the resulting zip file
 	 *
@@ -47,39 +43,41 @@ class BackUpWordPress_WP_CLI_Command extends WP_CLI_Command {
 	public function backup( $args, $assoc_args ) {
 
 		add_action( 'hmbkp_mysqldump_started', function () {
-			WP_CLI::line( __( 'Backup: Dumping database...', 'backupwordpress' ) );
+			\WP_CLI::line( __( 'Backup: Dumping database...', 'backupwordpress' ) );
 		} );
 
 		add_action( 'hmbkp_archive_started', function () {
-			WP_CLI::line( __( 'Backup: Zipping everything up...', 'backupwordpress' ) );
+			\WP_CLI::line( __( 'Backup: Zipping everything up...', 'backupwordpress' ) );
 		} );
 
-		$hm_backup = new HM\BackUpWordPress\Backup();
-
 		if ( ! empty( $assoc_args['destination'] ) ) {
-			HM\BackUpWordPress\Path::get_instance()->set_path( $assoc_args['destination'] );
+			Path::get_instance()->set_path( $assoc_args['destination'] );
 		}
 
-		HM\BackUpWordPress\Path::get_instance()->cleanup();
+		Path::get_instance()->cleanup();
 
 		if ( ! empty( $assoc_args['root'] ) ) {
-			HM\BackUpWordPress\Path->set_root( $assoc_args['root'] );
+			Path::get_instance()->set_root( $assoc_args['root'] );
 		}
 
 		if ( ( ! is_dir( Path::get_path() ) ) ) {
-			WP_CLI::error( __( 'Invalid backup path', 'backupwordpress' ) );
+			\WP_CLI::error( __( 'Invalid backup path', 'backupwordpress' ) );
 			return false;
 		}
 
 		if ( ! is_dir( Path::get_root() ) || ! is_readable( Path::get_root() ) ) {
-			WP_CLI::error( __( 'Invalid root path', 'backupwordpress' ) );
+			\WP_CLI::error( __( 'Invalid root path', 'backupwordpress' ) );
 			return false;
 		}
 
+		$filename = 'backup.zip';
+
 		if ( isset( $assoc_args['archive_filename'] ) ) {
-			$hm_backup->set_archive_filename( $assoc_args['archive_filename'] );
+			$filename = $assoc_args['archive_filename'];
 		}
 
+		$hm_backup = new Backup( $filename );
+
 		if ( ! empty( $assoc_args['files_only'] ) ) {
 			$hm_backup->set_type( 'file' );
 		}
@@ -88,28 +86,20 @@ public function backup( $args, $assoc_args ) {
 			$hm_backup->set_type( 'database' );
 		}
 
-		if ( isset( $assoc_args['mysqldump_command_path'] ) ) {
-			$hm_backup->set_mysqldump_command_path( $assoc_args['mysqldump_command_path'] );
-		}
-
-		if ( isset( $assoc_args['zip_command_path'] ) ) {
-			$hm_backup->set_zip_command_path( $assoc_args['zip_command_path'] );
-		}
-
 		if ( ! empty( $assoc_args['excludes'] ) ) {
 			$hm_backup->set_excludes( $assoc_args['excludes'] );
 		}
 
-		$hm_backup->backup();
+		$hm_backup->run();
 
-		if ( file_exists( $hm_backup->get_archive_filepath() ) ) {
-			WP_CLI::success( __( 'Backup Complete: ', 'backupwordpress' ) . $hm_backup->get_archive_filepath() );
+		if ( file_exists( $hm_backup->get_backup_filepath() ) ) {
+			\WP_CLI::success( __( 'Backup Complete: ', 'backupwordpress' ) . $hm_backup->get_backup_filepath() );
 		} else {
-			WP_CLI::error( __( 'Backup Failed', 'backupwordpress' ) );
+			\WP_CLI::error( __( 'Backup Failed', 'backupwordpress' ) );
 		}
 
 	}
 
 }
 
-WP_CLI::add_command( 'backupwordpress', 'BackUpWordPress_WP_CLI_Command' );
+\WP_CLI::add_command( 'backupwordpress', 'HM\BackUpWordPress\CLI' );

classes/class-email-service.php

@@ -150,7 +150,7 @@ private function get_email_address_array() {
 	 * @param  string $action The action received from the backup
 	 * @return void
 	 */
-	public function action( $action, Site_Backup $backup ) {
+	public function action( $action, Backup $backup ) {
 
 		if ( $action === 'hmbkp_backup_complete' && $this->get_email_address_array() ) {
 

classes/class-plugin.php

@@ -147,7 +147,7 @@ protected function includes() {
 		require_once( HMBKP_PLUGIN_PATH . 'classes/backup/class-backup-engine-file-zip.php' );
 		require_once( HMBKP_PLUGIN_PATH . 'classes/backup/class-backup-engine-file-zip-archive.php' );
 
-		require_once( HMBKP_PLUGIN_PATH . 'classes/backup/class-site-backup.php' );
+		require_once( HMBKP_PLUGIN_PATH . 'classes/backup/class-backup.php' );
 
 		// Load the backup scheduling classes
 		require_once( HMBKP_PLUGIN_PATH . 'classes/class-scheduled-backup.php' );

classes/class-scheduled-backup.php

@@ -209,6 +209,16 @@ public function get_status() {
 		return $this->status;
 	}
 
+	/**
+	 * Back compat with old set_status mathod
+	 *
+ 	 * @deprecated 3.4 Backup->status->set_status()
+	 */
+	public function set_status( $message ) {
+		_deprecated_function( __FUNCTION__, '3.4', 'Backup->status->set_status()' );
+		$this->status->set_status( $message );
+	}
+
 	/**
 	 * Get the array of services options for this schedule
 	 *
@@ -408,7 +418,7 @@ public function run() {
 		}
 
 		// Setup our Site Backup Object
-		$backup = new Site_Backup( $this->get_backup_filename(), $this->get_database_dump_filename() );
+		$backup = new Backup( $this->get_backup_filename(), $this->get_database_dump_filename() );
 		$backup->set_type( $this->get_type() );
 		$backup->set_excludes( $this->get_excludes() );
 		$backup->set_status( $this->status );
@@ -462,7 +472,7 @@ public function get_database_dump_filename() {
 	 *
 	 * @param $action
 	 */
-	public function do_action( $action, Site_Backup $backup ) {
+	public function do_action( $action, Backup $backup ) {
 
 		// Pass the actions to all the services
 		// Todo should be decoupled into the service class

classes/class-service.php

@@ -86,7 +86,7 @@ abstract public function display();
 	 *
 	 * @return mixed
 	 */
-	public function action( $action, Site_Backup $backup ) {}
+	public function action( $action, Backup $backup ) {}
 
 	public function get_slug() {
 		return sanitize_key( $this->name );

classes/class-webhook-service.php

@@ -32,7 +32,7 @@ abstract protected function get_url();
 	 * @param  string $action The action received from the backup
 	 * @return void
 	 */
-	public function action( $action, Site_Backup $backup ) {
+	public function action( $action, Backup $backup ) {
 
 		if ( 'hmbkp_backup_complete' !== $action || ! $this->is_service_active() ) {
 			return;

functions/interface.php

@@ -349,7 +349,7 @@ function get_settings_url() {
  *
  * @param $error_message
  */
-function add_settings_error( $error_message ){
+function add_settings_error( $error_message ) {
 
 	$hmbkp_settings_errors = get_transient( 'hmbkp_settings_errors' );
 
@@ -362,6 +362,16 @@ function add_settings_error( $error_message ){
 
 }
 
+/**
+ * Back compat version of add_settings_error
+ *
+ * @deprecated 3.4 add_settings_error()
+ */
+function hmbkp_add_settings_error( $error_message ) {
+	_deprecated_function( __FUNCTION__, '3.4', 'add_settings_error()' );
+	add_settings_error( $error_message );
+}
+
 /**
  * Fetch the form submission errors for display.
  *

tests/class-site-backup/test-backup-director.php

@@ -8,7 +8,7 @@ public function setUp() {
 
 		$this->good_backup_engine = new Mock_Backup_Engine;
 		$this->bad_backup_engine = new Mock_Failing_Backup_Engine;
-		$this->backup = new Site_Backup( 'backup.zip' );
+		$this->backup = new Backup( 'backup.zip' );
 
 	}
 

tests/class-site-backup/test-class-site-backup.php

@@ -5,7 +5,7 @@
 class Site_Backup_Tests extends \HM_Backup_UnitTestCase {
 
 	public function setUp() {
-		$this->backup = new Site_Backup( 'backup.zip' );
+		$this->backup = new Backup( 'backup.zip' );
 		$this->setup_test_data();
 		Path::get_instance()->set_path( $this->test_data . '/tmp' );
 		Path::get_instance()->set_root( $this->test_data );