Command.php

<?php

namespace aubreypwd\PHP_CLI;

use \splitbrain\phpcli\Options;
use \splitbrain\phpcli\Colors;

/**
 * CLI
 *
 * @TODO Methods to do colors easier
 *     - ->log( )
 *
 * @since 1.0.0
 */
abstract class Command extends \splitbrain\phpcli\CLI {

	abstract protected function setup( Options $options );
	abstract protected function main( Options $options );

	/**
	 * Colors
	 *
	 * @since 1.0.0
	 *
	 * @var \splitbrain\phpcli\Colors
	 */
	public $colors;

	/**
	 * Construct
	 *
	 * @since 1.0.0
	 *
	 * @return void
	 */
	public function __construct() {

		$this->colors = new Colors();

		parent::__construct();
	}

	/**
	 * Set the description of the command.
	 *
	 * @since 1.0.0
	 *
	 * @param Options  $options Options.
	 * @param string   $help    Description string.
	 */
	protected function set_desc( Options $options, string $help ) : void {
		$options->setHelp( $help );
	}

	/**
	 * Log something out to console.
	 *
	 * This method is a bit of a hack to do things like:
	 *
	 *     $this->log( "A generic message to the console." );
	 *
	 * That way you can express something out without having to format
	 * it using debug, info, warning, etc.
	 *
	 * But, if you want to use those designations (see parent::$logLevel),
	 * you can by setting $level normally to a log level and using
	 * $message instead.
	 *
	 * @since  1.0.0
	 *
	 * @param  string   $level   If you set this to anything in
	 *                           parent::$logLevel we'll use parent::logMessage()
	 *                           and forward your $message to the console.
	 *                           But if it is not, we will treat $level like the
	 *                           message (ignoring $message) to ouput that to
	 *                           the console.
	 * @param  string   $message If you set $level to anything in
	 *                           parent::$logLevel then we will treat $message as
	 *                           the message and forward it along to
	 *                           parent::logMessage().
	 * @param  array    $context Conect (see parent::logMessage()).
	 * @return void
	 */
	public function log( $level = '', $message = '', array $context = array() ) {

		if ( in_array( $level, array_keys( $this->loglevel ), true ) ) {

			// $level is set to something specific, use that.
			$this->logMessage($level, $message, $context);

			return;
		}

		// Just log out some text.
		echo $this->parse_html( $this->colorize_message( "{$level}\n" ) );
	}

	/**
	 * Does the system have the command?
	 *
	 * @since  1.0.0
	 *
	 * @param  string   $command The command, e.g. `ls`.
	 * @return bool
	 */
	protected function has_command( string $command ) : bool {

		if ( empty( $command ) ) {
			return false;
		}

		$exec = exec( "command -v {$command}" );

		if ( ! is_string( $exec ) ) {
			return false;
		}

		if ( empty( $exec ) ) {
			return false;
		}

		return basename( trim( $exec ) ) === $command;
	}

	/**
	 * Run a command.
	 *
	 * You will need to use exec_* tools here to extrapolate data.
	 *
	 * @since  1.0.0
	 *
	 * @param  string   $command The command.
	 * @param  bool     $quiet   Pipe into /dev/null to supress output (you will get no output info).
	 * @param  bool     $force   Force the run, even if we can't determine the command exists.
	 * @return array             Data about the run.
	 */
	protected function exec( string $command, $quiet = false, $force = false, ) : array {

		if ( ! $force && ! $this->has_command( strtok( $command, ' ' ) ) ) {

			return [
				'last_line' => '',
				'output'    => [],
				'code'      => 1,
			];
		}

		$last_line = exec(
			$quiet
				? "{$command} &> /dev/null 2>&1" // Re-direct everything.
				: "{$command} 2> /dev/null", // Just re-direct errors.
			$output,
			$code
		);

		return [
			'last_line' => $last_line,
			'output'    => $output,
			'code'      => intval( $code )
		];
	}

	/**
	 * Get the output of aubreypwd\PHP_CLI\CLI::exec().
	 *
	 * @since  1.0.0
	 *
	 * @param  array    $result The result from aubreypwd\PHP_CLI\CLI::exec().
	 * @param  string   $as     Set to `string` to get back a string with \n
	 *                          line breaks. Defaults to `array` with an array
	 *                          of lines of the output.
	 * @return string|array     See $as.
	 */
	protected function exec_get_output( array $result, string $as = 'string' ) : string|array {

		if ( 'array' !== $as && 'string' !== $as ) {
			throw new \InvalidArgumentException( '$as must be set to array|string.' );
		}

		if ( ! isset( $result['output'] ) || ! is_array( $result['output'] ) ) {
			throw new \InvalidArgumentException( 'We can only work with an array from exec().' );
		}

		return 'array' === $as ? $result['output'] : implode( "\n", $result['output'] );
	}

	/**
	 * Get the status of aubreypwd\PHP_CLI\CLI::exec().
	 *
	 * @since  1.0.0
	 *
	 * @param  array    $exec The data from aubreypwd\PHP_CLI\CLI::exec().
	 * @return bool           True if no errors, false if there were.
	 */
	protected function exec_get_status( array $exec ) : bool {

		if ( ! is_array( $exec ) || ! isset( $exec['code'] ) ) {
			throw new \Exception( 'We can only work with result from aubreypwd\PHP_CLI\CLI::exec().' );
		}

		return $exec['code'] === 0
			? true
			: false;
	}

	/**
	 * Get the last line of aubreypwd\PHP_CLI\CLI::exec().
	 *
	 * @since  1.0.0
	 *
	 * @param  array    $exec Result of aubreypwd\PHP_CLI\CLI::exec().
	 * @return string
	 */
	protected function exec_last_line( array $exec ) : string {
		return isset( $exec['last_line'] ) ? trim( $exec['last_line'] ) : '';
	}

	/**
	 * Run a command in a directory.
	 *
	 * You will have to use exec_* tools here to extrapolate data.
	 *
	 * @since  1.0.0
	 *
	 * @param  string   $command   The command.
	 * @param  string   $directory The directory.
	 * @param  bool     $quietly   Supress output.
	 * @return array               Result data from aubreypwd\PHP_CLI\CLI::exec().
	 */
	protected function rid( string $command, string $directory, $quietly = false ) : string|array {

		if ( ! file_exists( $directory ) ) {
			throw new \Exception( "{$directory} doesn't exist." );
		}

		if ( empty( $command ) ) {
			throw new \Exception( '$command is empty.' );
		}

		return $this->exec( "( cd '{$directory}' && {$command} )", $quietly, true );
	}

	/**
	 * Explain/Register an argument.
	 *
	 * @since  1.0.0
	 *
	 * @param  Options  $options  Options.
	 * @param  string   $arg      The argument name.
	 * @param  string   $help     The explanation of the argument.
	 * @param  bool     $required Is the argument required?
	 * @param  string   $command  Command
	 * @return void
	 */
	protected function explain_argument( Options $options, string $arg, string $help, bool $required = true, string $command = '' ) : void {
		$options->registerArgument( $arg, $help, $required, $command );
	}

	/**
	 * Is an argument present (in any position)?
	 *
	 * @since  1.0.0
	 *
	 * @param  Options  $options Options.
	 * @param  string   $arg     Argument name.
	 * @return bool
	 */
	protected function arg_present( Options $options, string $arg ) : bool {
		return in_array( $arg, $this->get_args( $options ), true );
	}

	/**
	 * Get all the arguments.
	 *
	 * @since  1.0.0
	 *
	 * @param  Options  $options Options.
	 * @return array
	 */
	protected function get_args( Options $options ) : array {
		return $options->getArgs();
	}

	/**
	 * Get argument of position.
	 *
	 * @since  1.0.0
	 *
	 * @param  Options  $options  Options.
	 * @param  int      $position Position.
	 * @return string             The value of the argument in that position.
	 */
	protected function get_arg( Options $options, int $position ) : string {

		$args = $options->getArgs();

		return isset( $args[ $position ] )
			? $args[ $position ]
			: '';
	}

	/**
	 * Explain/Register an option.
	 *
	 * @since  1.0.0
	 *
	 * @param  Options    $options     Options.
	 * @param  string     $long        Long version.
	 * @param  string     $help        Help contents.
	 * @param  mixed|null $short       Short version (optional).
	 * @param  bool       $explain_arg If it requires an argument, explain it here.
	 * @param  string     $command     Command.
	 * @return void
	 */
	protected function explain_option( Options $options, string $long, string $help, mixed $short = null, string $explain_arg = '', string $command = '' ) : void {
		$options->registerOption( $long, $help, $short, empty( $explain_arg ) ? false : $explain_arg, $command );
	}

	/**
	 * Get the value of an option of if an option is set.
	 *
	 * @since  1.0.0
	 *
	 * @param  Options  $options Options.
	 * @param  string   $option  Option.
	 * @return bool|string True or false if it is or is not set.
	 *                     String if it's set to a value, e.g. --flag=.
	 */
	protected function get_opt( Options $options, $option ) : bool|string {
		return $options->getOpt( $option );
	}

	/**
	 * Show the help.
	 *
	 * @since  1.0.0
	 *
	 * @param  Options  $options Options.
	 * @return void
	 */
	protected function show_help( Options $options ) : void {
		echo $options->help();
	}

	/**
	 * Convert HTML.
	 *
	 * @since  1.0.0
	 *
	 * @param  string   $message The message which includes HTML.
	 * @return string            The message with known HTML converted.
	 */
	protected function parse_html( $message ) {

		return str_replace(
			array(
				'<br>',
				'<p>',
				'</p>',
				'<li>',
				'</li>',
			),
			array(
				"\n",
				"\n",
				"\n",
				" • ",
				""
			),
			$message
		);
	}

	/**
	 * Colorize a message.
	 *
	 * @since  [-NEXT-]
	 *
	 * @param  string   $message The message with colors in HTML tags, e.g.
	 *                           "This is <red>bad</red>".
	 * @return string            Colorized message,
	 */
	protected function colorize_message( string $message ) : string {

		foreach ( [
			'reset',
			'black',
			'darkgray',
			'blue',
			'lightblue',
			'green',
			'lightgreen',
			'cyan',
			'lightcyan',
			'red',
			'lightred',
			'purple',
			'lightpurple',
			'brown',
			'yellow',
			'lightgray',
			'white',
		] as $color ) {

			$message = str_replace(
				array(
					"<$color>",
					"</$color>",
				),
				array(
					$this->colors->getColorCode( $color ),
					$this->colors->getColorCode( 'reset' )
				),
				$message
			);

		}


		return $message;
	}

	/**
	 * Get the running PHP version.
	 *
	 * @since  1.0.0
	 *
	 * @return string
	 */
	protected function get_php_version() : string {
		return $this->exec_last_line( $this->exec( "php -r 'echo phpversion() . \"\n\";' | sed 's/ *$//g'" ) );
	}

	/**
	 * Get the working directory path.
	 *
	 * @since  1.0.0
	 *
	 * @return string
	 */
	protected function get_working_dir() : string {
		return $this->exec_last_line( $this->exec( 'pwd' ) );
	}

	/**
	 * Get the working directory basename.
	 *
	 * @since  1.0.0
	 *
	 * @return string
	 */
	protected function get_working_dirname() : string {
		return $this->exec_last_line( $this->exec( 'echo "${PWD##*/}"' ) );
	}
}