deploy.php

<?php
if ( ! defined( 'WP_CLI' ) ) return;
require 'helpers.php';
require 'runner.php';
use \WP_Deploy_Command\Helpers as Util;
use \WP_Deploy_Command\Command_Runner as Runner;


/**
 * __Current Version__: 1.0.0
 *
 * Deploys the local WordPress database or uploads directory.
 *
 * The tool requires defining a set of constants in your wp-config.php file.
 * The constants should be prefixed with the environment handle which you will use as the first paramater for your desired subcommand. An example configuration for a "dev" environment:
 *
 * ```php
 * <?php
 * define( 'DEV_URL', 'the-remote-website-url.com' );
 * define( 'DEV_WP_PATH', '/path/to/the/wp/dir/on/the/server' );
 * define( 'DEV_HOST', 'ssh_hosr' );
 * define( 'DEV_USER', 'ssh_user' );
 * define( 'DEV_PATH', '/path/to/a/writable/dir/on/the/server' );
 * define( 'DEV_UPLOADS_PATH', '/path/to/the/remote/uploads/directory' );
 * define( 'DEV_DB_HOST', 'the_remote_db_host' );
 * define( 'DEV_DB_NAME', 'the_remote_db_name' );
 * define( 'DEV_DB_USER', 'the_remote_db_user' );
 * define( 'DEV_DB_PASSWORD', 'the_remote_db_password' );
 * define( 'DEV_POST_HOOK', 'echo "something to be executed when the command
 * finishes"' );
 * ```
 *
 * => `wp deploy push dev ...`
 *
 * Not all commands / subcommands require all constants to be defined. To test what
 * a subcommand requires, execute it with a non-existing environment handle. e.g.
 * `wp deploy dump johndoe`.
 *
 * You can define as many constant groups as deployment eviroments you wish to have.
 *
 * __Examples__
 *
 *     # Deploy the local db to the staging environment
 *     wp deploy push staging --what=db
 *
 *     # Pull both the production database and uploads
 *     wp deploy pull production --what=db && wp deploy pull production --what=uploads
 *
 *     # Dump the local db with the siteurl replaced
 *     wp deploy dump andrew
 *
 * ### Configuration
 *
 * In order to be able to use the deploy command, you need to define certain
 * constants in your `wp-config.php` file.
 *
 * #### Configuration Dependecies
 *
 * Subcommands depend on different constants in order to work.
 * Here's the dependency list:
 *
 * * __`wp deploy push`__: In order to push to your server, you need to define the
 * ssh credentials, and a path to a writable directory on the server. _These
 * constants are needed whatever the arguments passed to the `push` subcommand_:
 *     * `%%ENV%%_USER`
 *     * `%%ENV%%_HOST`
 *     * `%%ENV%%_PATH`
 *
 * * __`wp deploy push %%env%% --what=db`__: In order to deploy the database to your
 * server, you need to define the url of your WordPress website, the path to
 * the WordPress code on your server, and the credentials to the database on
 * the server:
 *     * `%%ENV%%_URL`
 *     * `%%ENV%%_WP_PATH`
 *     * `%%ENV%%_DB_HOST`
 *     * `%%ENV%%_DB_NAME`
 *     * `%%ENV%%_DB_USER`
 *     * `%%ENV%%_DB_PASSWORD`
 *
 * * __`wp deploy push %%env%% --what=uploads`__: In order to push the uploads directory,
 * you need to define the path to the uploads directory on your server:
 *     * `%%ENV%%_UPLOADS_PATH`
 *
 *  __`wp deploy pull`__: In order to pull to your server, you need to define the
 * sh credentials constants. _These constants are needed whatever the arguments
 * assed to the `pull` subcommand_:
 *     * `%%ENV%%_USER`
 *     * `%%ENV%%_HOST`
 *
 * * __`wp deploy pull %%env%% --what=db`__: In order to pull the database to from your
 * server, you need to define the url of your remote WordPress website, the
 * path to the WordPress code on your server, and the credentials to the
 * database on the server:
 *     * `%%ENV%%_PATH`
 *     * `%%ENV%%_URL`
 *     * `%%ENV%%_WP_PATH`
 *     * `%%ENV%%_DB_HOST`
 *     * `%%ENV%%_DB_NAME`
 *     * `%%ENV%%_DB_USER`
 *     * `%%ENV%%_DB_PASSWORD`
 *
 * * __`wp deploy push %%env%% --what=uploads`__: As in the `push` command's case, in
 * order to pull the remote server uploads, we need their path on the server.
 *     * `%%ENV%%_UPLOADS_PATH`
 *
 * * __`wp dump %%env%%`__: This subcommand only requires the path to the target
 * WordPress path and its URL.
 *
 * #### `%%ENV%%_POST_HOOK`
 *
 * You can __optionally__ define a constant with bash code which is called at the
 * end of the subcommand execution.
 *
 * You can refer to environment variables using placeholders. Some of the
 * available environment variables are:
 * * `env`: The environment handle
 * * `command`: The subcommand (Currently `push`, `pull`, or `dump`).
 * * `what`: The what argument value for the `push` or `pull` subcommand.
 * * `wd`: The path to the working directory for the deploy command. This is
 * the directory where the database is pulled, and other temporary files are
 * created.
 * * `timestamp`: The date formatted with "Y_m_d-H_i"
 * * `tmp_path`: The path to the temporary files directory used by the deploy
 * tool.
 * * `bk_path`: The path to the backups directory used by the deploy tool.
 * * `local_uploads`: The path to the local WordPress instance uploads
 * directory.
 * * `ssh`: The ssh server handle in the `user@host` format.
 *
 *
 * __Example__
 *
 * Here's an example of a `DEV_POST_HOOK` that posts a message to a hipchat
 * room after a `pull` or a `push` is performed using the HipChat REST API
 * (https://github.com/hipchat/hipchat-cli).
 * For pushes, it also clears the cache.
 *
 * ```php
 * <?php
 * $hipchat_message = "http://%%url%%"
 * 	. "\njeandoe has successfully %%command%%ed %%what%%";
 * $command = "if [[ '%%command%%' != 'dump' ]]; then "
 * 		. "echo '$hipchat_message' | %%abspath%%/hipchat-cli/hipchat_room_message -t 1245678 -r 123456 -f 'WP-Cli Deploy';"
 * 	. "fi;"
 * 	. "if [[ '%%command%%' == 'push' ]]; then "
 * 		. "curl -Ss http://example.com/clear_cache.php?token=12385328523;"
 * 	. "fi;";
 * define( 'DEV_POST_HOOK', $command );
 * ```
 *
 */
class WP_Deploy_Command extends WP_CLI_Command {

	/**
	 * TODO:
	 * Post push
	 * Update paths in messages to be relative to wordpress dir.
	 * Fix the missing path directory at push issue.
	 */

	/** The config holder. */
	private static $config;

	private static $env;

	private static $default_verbosity;

	private static $runner;

	private static $config_dependencies;

	public function __construct() {
		if ( defined( 'WP_DEPLOY_DEBUG' ) && WP_DEPLOY_DEBUG ) {
			ini_set( 'error_reporting', E_ALL & ~E_STRICT );
			ini_set( 'display_errors', 'STDERR' );
		}

		self::$default_verbosity = 1;

		/** Define the constants dependencies. */
		self::$config_dependencies = array(
			'push' => array(
				'global' => array(
					'user',
					'host',
					'path',
				),
				'db' => array(
					'url',
					'wp_path',
					'db_host',
					'db_name',
					'db_user',
					'db_password',
				),
				'uploads' => array( 'uploads_path' )
			),
			'pull' => array(
				'global' => array(
					'user',
					'host',
				),
				'db' => array(
					'path',
					'url',
					'wp_path',
					'db_host',
					'db_name',
					'db_user',
					'db_password',
				),
				'uploads' => array( 'uploads_path' )
			),
			'dump' => array(
				'wp_path',
				'url'
			),
			'optional' => array(
				'post_hook'
			)
		);

		/**
		 * Depending paths need to be under the
		 * paths they depend on.
		 */
		self::$config = array(
			'env' => '%%env%%',

			/** Constants which refer to remote. */
			'host' => '%%host%%',
			'user' => '%%user%%',
			'path' => '%%path%%',
			'url' => '%%url%%',
			'wp' => '%%wp_path%%',
			'uploads' => '%%uploads_path%%',
			'db_host' => '%%db_host%%',
			'db_name' => '%%db_name%%',
			'db_user' => '%%db_user%%',
			'db_password' => '%%db_password%%',

			/** Optional */
			'post_hook' => '%%post_hook%%',
			'safe_mode' => '%%safe_mode%%', /** TODO */

			/** Helpers which refer to local. */
			'command' => '%%command%%',
			'what' => '%%what%%',
			'abspath' => '%%abspath%%',
			'wd' => '%%abspath%%/%%env%%_%%hash%%',
			'timestamp' => '%%pretty_date%%',
			'tmp_path' => '%%wd%%/tmp',
			'bk_path' => '%%wd%%/bk',
			'tmp' => '%%tmp_path%%/%%rand%%',
			'local_hostname' => '%%hostname%%',
			'ssh' => '%%user%%@%%host%%',
			'local_uploads' => '%%local_uploads%%',
			'siteurl' => '%%siteurl%%',
		);
	}

	/**
	 * Displays information about the current version of the deploy command.
	 *
	 * ## EXAMPLE
	 *
	 *    wp deploy info
	 */
	public function info( $args, $assoc_args ) {

		WP_CLI::line( 'WP-Cli Deploy Command: https://github.com/c10b10/wp-cli-deploy' );
		WP_CLI::line( 'Supported subcommands: push, pull, dump' );
		WP_CLI::line( 'Version: 1.0.0' );
		WP_CLI::line( 'Author: Alex Ciobica / @ciobi' );
		WP_CLI::line( 'Run "wp help deploy" for the documentation' );
	}

	/**
	 * Pushes the local database and / or uploads from local to remote.
	 *
	 * ## OPTIONS
	 *
	 * <environment>
	 * : The handle of of the environment. This is the prefix of the constants
	 * defined in wp-config.
	 *
	 * `--what`=<what>
	 * : What needs to be deployed on the server. Valid options are:
	 *      db: pushes the database to the remote server
	 *      uploads: pushes the uploads to the remote server
	 *
	 * [`--v`=<verbosity>]
	 * : Verbosity level. Default 1. 0 is highest and 2 is lowest.
	 *
	 * ## EXAMPLE
	 *
	 *    # Push the database and the uploads for to "staging" environment.
	 *    # You must have STAGING_* constants defined for this to work.
	 *
	 *    wp deploy push staging --what=db,uploads
	 *
	 * @synopsis <environment> --what=<what> [--v=<v>]
	 */
	public function push( $args, $assoc_args ) {

		$args = self::sanitize_args( __FUNCTION__, $args, $assoc_args );

		if ( isset( $args->error ) ) {
			WP_Cli::line( $args->error );
			return false;
		}

		call_user_func( __CLASS__ . "::push_" . self::$config->what );

		self::run_post_hook();

		self::wow();
	}

	/**
	 * Pulls the database and / or uploads from remote to local. After pulling
	 * the uploads, they need to copied to the correct location.
	 *
	 * <environment>
	 * : The name of the environment. This is the prefix of the constants defined in
	 * wp-config.
	 *
	 * `--what`=<what>
	 * : What needs to be pulled. Valid options are:
	 *      db: pushes the database to the remote server
	 *      uploads: pushes the uploads to the remote server
	 *
	 * [`--v`=<verbosity>]
	 * : Verbosity level. Default 1. 0 is highest and 2 is lowest.
	 *
	 * ## EXAMPLES
	 *
	 *    # Pulls database and uploads folder
	 *    wp deploy pull staging --what=db,uploads
	 *
	 *    # Pull the remote db without prior local backup
	 *    wp deploy pull staging --what=db --backup=false
	 *
	 * @synopsis <environment> --what=<what> [--cleanup] [--backup=<backup>] [--v=<v>]
	 */
	public function pull( $args, $assoc_args ) {

		$args = self::sanitize_args( __FUNCTION__, $args, $assoc_args );

		if ( isset( $args->error ) ) {
			WP_Cli::line( $args->error );
			return false;
		}

		call_user_func( __CLASS__ . "::pull_" . self::$config->what );

		self::run_post_hook();

		self::wow();
	}

	/**
	 * Dumps the local database and / or uploads from local to remote. The
	 * database will be prepared for upload to the specified environment.
	 *
	 * ## OPTIONS
	 *
	 * <environment>
	 * : The name of the environment. This is the prefix of the constants
	 * defined in wp-config.php.
	 *
	 * [`--v`=<v>]
	 * : Verbosity level. Default 1. 0 is highest and 2 is lowest.
	 *
	 * ## EXAMPLE
	 *
	 *    # Dumps database for to "staging" environment.
	 *    wp deploy dump staging
	 *
	 * @synopsis <environment> [--file=<file>] [--v=<v>]
	 */
	public function dump( $args, $assoc_args ) {

		$args = self::sanitize_args( __FUNCTION__, $args, $assoc_args );

		if ( isset( $args->error ) ) {
			WP_Cli::line( $args->error );
			return false;
		}

		self::dump_db();

		self::run_post_hook();

		self::wow();
	}

	/** Pushes the database to the server. */
	private function push_db() {

		$c = self::$config;

		$dump_file = self::dump_db( array(
			'wd' => $c->tmp_path,
			'name' => basename( $c->tmp ),
		) );
		$server_file = "{$c->local_hostname}_{$c->env}.sql";

		$runner = self::$runner;

		$runner->add(
			Util::get_rsync(
				$dump_file,
				"$c->ssh:$c->path/$server_file"
			),
			"Uploaded the database file to '$c->path/$server_file' on the server.",
			'Failed to upload the database to the server'
		);

		/** Removing the dump file after upload. */
		$runner->add( "rm -f $dump_file" );

		$runner->add(
			"ssh $c->ssh 'cd $c->path;"
			. " sh -l -c \"wp --path=$c->wp db import $server_file\"'",
			'Deployed the database on server.',
			'Failed deploying the db on server.'
		);

		$runner->run();
	}

	/** Pushes the uploads to the server. */
	private function push_uploads( $args = array() ) {

		$c = self::$config;

		$runner = self::$runner;

		/** TODO safe mode */
		$path = isset( $c->safe_mode ) ? $c->path : $c->uploads;

		$runner->add(
			Util::get_rsync(
				// When pushing safe, we push the dir, hence no trailing slash
				"$c->local_uploads/",
				"$c->ssh:$path"
			),
			"Synced local uploads to '$path' on '$c->host'.",
			'Failed to upload the database to the server'
		);

		$runner->run();
	}

	/** Pulls the database from the server. */
	private function pull_db() {

		$c = self::$config;

		$server_file = "{$c->env}_{$c->timestamp}.sql";

		$runner = self::$runner;

		$runner->add(
			"ssh $c->ssh 'mkdir -p $c->path; cd $c->path;"
			. " mysqldump --user=$c->db_user --password=$c->db_password --host=$c->db_host"
			. " --add-drop-table $c->db_name > $server_file'",
			"Dumped the remote database to '$c->path/$server_file' on the server.",
			'Failed dumping the remote database.'
		);

		$runner->add(
			Util::get_rsync(
				"$c->ssh:$c->path/$server_file",
				"$c->wd/$server_file",
				false, false // No delete or compression
			),
			"Copied the database from the server to '$c->wd/$server_file'."
		);

		$runner->add(
			"ssh $c->ssh 'cd $c->path; rm -f $server_file'",
			'Deleted the server dump.'
		);

		/** TODO Finalize safe mode. */
		$runner->add(
			! isset( $c->safe_mode ),
			"wp db export $c->bk_path/$c->timestamp.sql",
			"Backed up local database to '$c->bk_path/$c->timestamp.sql'"
		);

		$runner->add(
			"wp db import $c->wd/$server_file",
			'Imported the remote database.'
		);

		$runner->add(
			( $c->siteurl != $c->url ),
			"wp search-replace --network $c->url $c->siteurl",
			"Replaced '$c->url' with '$c->siteurl' on the imported database."
		);

		$runner->add(
			( $c->abspath != $c->wp ),
			"wp search-replace --network $c->wp $c->abspath",
			"Replaced '$c->wp' with '$c->abspath' on local database."
		);

		$runner->run();
	}

	/** Pulls the uploads from the server. */
	private static function pull_uploads() {

		$c = self::$config;

		$runner = self::$runner;

		/** TODO Finalize safe mode. */
		$runner->add(
			isset( $c->safe_mode ),
			"cp -rf $c->local_uploads $c->bk_path/uploads_$c->timestamp",
			'Backed up local uploads.'
		);

		$runner->add(
			Util::get_rsync(
				"$c->ssh:$c->uploads/",
				"$c->local_uploads"
			),
			"Pulled the '$c->env' uploads locally."
		);


		$runner->run();
	}

	/** Dumps the local database after performing search-replace. */
	private static function dump_db( $args = array() ) {

		$c = self::$config;

		$args = wp_parse_args( $args, array(
			'name' => "{$c->env}_{$c->timestamp}",
			'wd' => $c->wd
		) );
		$path = "{$args['wd']}/{$args['name']}.sql";

		$runner = self::$runner;

		$runner->add(
			( $c->abspath != $c->wp ) || ( $c->url != $c->siteurl ),
			"wp db export $c->tmp",
			"Exported a local backup of the database to '$c->tmp'."
		);

		$runner->add(
			( $c->siteurl != $c->url ),
			"wp search-replace --network $c->siteurl $c->url",
			"Replaced '$c->siteurl' with '$c->url' in local database."
		);

		$runner->add(
			( $c->abspath != $c->wp ),
			"wp search-replace --network $c->abspath $c->wp",
			"Replaced '$c->abspath' with with '$c->wp' in local database."
		);

		$runner->add(
			"wp db export $path",
			"Dumped the database to '$path'."
		);

		$runner->add(
			( $c->abspath != $c->wp ) || ( $c->url != $c->siteurl ),
			"wp db import $c->tmp",
			'Imported the local backup.'
		);

		$runner->add(
			( $c->abspath != $c->wp ) || ( $c->url != $c->siteurl ),
			"rm -f $c->tmp",
			'Cleaned up.'
		);

		$runner->run();

		return $path;
	}

	/** Sanitizes the arguments, and sets the configuration. */
	private static function sanitize_args( $command, $args, $assoc_args = null ) {

		self::$env = $args[0];

		/** If what is available, it needs to refer to an existing method. */
		$what = '';
		if ( isset( $assoc_args['what'] ) ) {
			$what = $assoc_args['what'];
			if ( ! method_exists( __CLASS__, "{$command}_{$what}" ) ) {
				WP_Cli::error( "Using unknown '$what' parameter for --what argument." );
			}
		}

		/**
		 * Eeeek! So ugly.
		 * TODO. Fix this.
		 */
		$verbosity = self::$default_verbosity;
		if ( isset( $assoc_args['v'] ) && in_array( $assoc_args['v'], range( 0, 2 ) ) )
			$verbosity = $assoc_args['v'];
		self::$runner = new Runner( $verbosity );

		/** Get the environmental and set the tool config. */
		$constants = self::validate_config( $command, $what, self::$env );
		self::$config = self::expand( self::$config, $constants, $command, $what );

		/** Create paths. */
		Runner::get_result( 'mkdir -p ' . self::$config->tmp_path . ';' );
		Runner::get_result( 'mkdir -p ' . self::$config->bk_path . ';' );

		return self::$config;
	}

	/** Determines the verbosity level: 1, 2, or 3 */
	private static function get_verbosity( $string, $default ) {
		$number = count_chars_unicode( $string, 'v' );
		if ( $number )
			return min( $number, 2 );
		return $default;
	}

	/**
	 * Verifies that all required constants are defined.
	 * Constants must be of the form: "%ENV%_%NAME%"
	 */
	private static function validate_config( $command, $what, $env ) {

		/** Get the required contstants from the dependency array. */
		$deps = self::$config_dependencies;
		$required = $deps[$command];
		if ( ! empty( $what ) ) {
			$required = array_unique( array_merge(
				$deps[$command][$what],
				$deps[$command]['global']
			) );
		}

		/** Get all definable constants. */
		$all_const = array();
		foreach( $deps as $comm_deps ) {
			foreach ( $comm_deps as $item ) {
				$const = is_array( $item ) ? $item : array( $item );
				$all_const = array_merge( $all_const, $const );
			}
		}
		$all_const = array_unique( $all_const );

		$get_const = function ( $const ) use ( $env ) {
			return strtoupper( $env . '_' . $const );
		};

		$errors = array();
		$constants = array();
		foreach ( $all_const as $short_name ) {
			/** The constants template */
			$constant = $get_const( $short_name );
			if ( in_array( $short_name, $required ) && ! defined( $constant ) ) {
				$errors[] = "Required constant $constant is not defined.";
			} elseif ( defined( $constant ) ) {
				$constants[$short_name] = constant( $constant );
			}
		}

		if ( count( $errors ) ) {
			foreach ( $errors as $error ) {
				WP_Cli::line( "$error" );
			}
			WP_Cli::error( "The missing constants are required in order to run this subcommand.\nType `wp help deploy` for more information." );
		}

		/** Add the optional constants. */
		foreach ( $deps['optional'] as $optional ) {
			$const = $get_const( $optional );
			if ( defined( $const ) )
				$constants[$optional] = constant( $const );
		}

		return $constants;
	}

	/** Replaces the placeholders in the paths with actual data. */
	private static function expand( $config, $constants, $command, $what ) {

		$data = array(
			'env' => self::$env,
			'command' => $command,
			'what' => $what,
			'hash' => Util::get_hash(),
			'abspath' => untrailingslashit( ABSPATH ),
			'pretty_date' => date( 'Y_m_d-H_i' ),
			'rand' => substr( sha1( time() ), 0, 8 ),
			'hostname' => Runner::get_result( "hostname" ),
			'local_uploads' => call_user_func( function() {
				$uploads_dir = wp_upload_dir();
				return untrailingslashit( Runner::get_result(
					"cd {$uploads_dir['basedir']}; pwd -P;"
				) );
			} ),
			'siteurl' => untrailingslashit( Util::trim_url(
				get_option( 'siteurl' )
			) ),
			'object' => (object) array_map( 'untrailingslashit', $constants )
		);

		foreach ( $config as &$item ) {
			$item = Util::unplaceholdit( $item, array_merge(
				/** This esures we can have dependecies. */
				$config,
				$data
			) );
		}

		if ( isset( $constants['post_hook'] ) ) {
			$config['post_hook'] = Util::unplaceholdit( $config['post_hook'], array_merge( $config, $data ) );
		}

		/** Remove unset config items (constants). */
		$config = array_filter( $config, function ( $item ) {
			return strpos( $item, '%%' ) === false;
		} );

		/** Return the config in object form. */
		return (object) $config;
	}

	public function run_post_hook() {

		if ( isset( self::$config->post_hook ) ) {
			$result = Runner::get_result( self::$config->post_hook );
			if ( ! empty( $result ) ) {
				var_dump( $result );
			}
			WP_Cli::line( "Ran post hook." );
		}
	}

	private static function wow() {
		$doge = array( 'wow', 'many', 'such', 'so' );
		$words = array( 'finish', 'done', 'end', 'deploy' );
		WP_CLI::line('');
		WP_Cli::success(
			$doge[array_rand( $doge, 1 )] . ' ' .
			$words[array_rand( $words, 1 )] . '!'
		);
	}
}

WP_CLI::add_command( 'deploy', 'WP_Deploy_Command' );