ci-bonfire / Sprint

myth/CLI.php

<?php
/**
 * Part of the Fuel framework.
 *
 * @package    Fuel
 * @version    1.7
 * @author     Fuel Development Team
 * @license    MIT License
 * @copyright  2010 - 2013 Fuel Development Team
 * @link       http://fuelphp.com
 */

/**
 * Modified to work with CodeIgniter by Lonnie Ezell.
 * And provided additional features and tools, like the progress bar
 * and different option handling.
 */

namespace Myth;

/**
 * Cli class
 *
 * Interact with the command line by accepting input options, parameters and output text
 *
 * @package		Fuel
 * @category	Core
 * @author		Phil Sturgeon
 * @link		http://docs.fuelphp.com/classes/cli.html
 */
class CLI {

    public static $readline_support = false;

    public static $wait_msg = 'Press any key to continue...';

    public static $segments = [];

	protected static $options = [];

	protected static $initialized = false;

    // Used by progress bar
    protected static $inProgress = false;

    protected static $foreground_colors = array(
        'black'			=> '0;30',
        'dark_gray'		=> '1;30',
        'blue'			=> '0;34',
        'dark_blue'		=> '1;34',
        'light_blue'	=> '1;34',
        'green'			=> '0;32',
        'light_green'	=> '1;32',
        'cyan'			=> '0;36',
        'light_cyan'	=> '1;36',
        'red'			=> '0;31',
        'light_red'		=> '1;31',
        'purple'		=> '0;35',
        'light_purple'	=> '1;35',
        'light_yellow'	=> '0;33',
        'yellow'		=> '1;33',
        'light_gray'	=> '0;37',
        'white'			=> '1;37',
    );

    protected static $background_colors = array(
        'black'			=> '40',
        'red'			=> '41',
        'green'			=> '42',
        'yellow'		=> '43',
        'blue'			=> '44',
        'magenta'		=> '45',
        'cyan'			=> '46',
        'light_gray'	=> '47',
    );

    //--------------------------------------------------------------------

    /**
     * Static constructor.	Parses all the CLI params.
     */
    public static function _init()
    {
	    if (static::$initialized === true)
	    {
		    return;
	    }

        if ( ! (PHP_SAPI === 'cli' || defined('STDIN')) )
        {
            throw new \Exception('Cli class cannot be used outside of the command line.');
        }

	    self::parseCommand();

        // Readline is an extension for PHP that makes interactive with PHP much more bash-like
        // http://www.php.net/manual/en/readline.installation.php
        static::$readline_support = extension_loaded('readline');

	    static::$initialized = true;
    }

    //--------------------------------------------------------------------

    /**
     * Grabs an individual
     *
     * @param $index
     * @return null
     */
    public static function segment($index)
    {
        if (! isset(static::$segments[$index - 1]))
        {
            return null;
        }

        return static::$segments[$index - 1];
    }

    //--------------------------------------------------------------------

    /**
     * Returns the command string portion of the arguments. Used
     * by the 'sprint' CLI script to grab the portion of the arguments
     * that is used to call the CodeIgniter application.
     *
     * @return string
     */
    public static function cli_string()
    {
        return implode(' ', static::$segments);
    }

    //--------------------------------------------------------------------



    /**
     * Get input from the shell, using readline or the standard STDIN
     *
     * Named options must be in the following formats:
     * php index.php user -v --v -name=John --name=John
     *
     * @param	string|int	$name	the name of the option (int if unnamed)
     * @return	string
     */
    public static function input($prefix = '')
    {
        if (static::$readline_support)
        {
            return readline($prefix);
        }

        echo $prefix;
        return fgets(STDIN);
    }

    //--------------------------------------------------------------------

    /**
     * Asks the user for input.  This can have either 1 or 2 arguments.
     *
     * Usage:
     *
     * // Waits for any key press
     * CLI::prompt();
     *
     * // Takes any input
     * $color = CLI::prompt('What is your favorite color?');
     *
     * // Takes any input, but offers default
     * $color = CLI::prompt('What is your favourite color?', 'white');
     *
     * // Will only accept the options in the array
     * $ready = CLI::prompt('Are you ready?', array('y','n'));
     *
     * @return	string	the user input
     */
    public static function prompt()
    {
        $args = func_get_args();

        $options = array();
        $output = '';
        $default = null;

        // How many we got
        $arg_count = count($args);

        // Is the last argument a boolean? True means required
        $required = end($args) === true;

        // Reduce the argument count if required was passed, we don't care about that anymore
        $required === true and --$arg_count;

        // This method can take a few crazy combinations of arguments, so lets work it out
        switch ($arg_count)
        {
            case 2:

The case body in a switch statement must start on the line following the statement.

                // E.g: $ready = CLI::prompt('Are you ready?', array('y','n'));
                if (is_array($args[1]))
                {
                    list($output, $options)=$args;
                }

                // E.g: $color = CLI::prompt('What is your favourite color?', 'white');
                elseif (is_string($args[1]))
                {
                    list($output, $default)=$args;
                }

                break;

            case 1:

The case body in a switch statement must start on the line following the statement.

                // No question (probably been asked already) so just show options
                // E.g: $ready = CLI::prompt(array('y','n'));
                if (is_array($args[0]))
                {
                    $options = $args[0];
                }

                // Question without options
                // E.g: $ready = CLI::prompt('What did you do today?');
                elseif (is_string($args[0]))
                {
                    $output = $args[0];
                }

                break;
        }

        // If a question has been asked with the read
        if ($output !== '')
        {
            $extra_output = '';

            if ($default !== null)
            {
                $extra_output = ' [ Default: "'.$default.'" ]';
            }

            elseif ($options !== array())
            {
                $extra_output = ' [ '.implode(', ', $options).' ]';
            }

            fwrite(STDOUT, $output.$extra_output.': ');
        }

        // Read the input from keyboard.
        $input = trim(static::input()) ?: $default;

        // No input provided and we require one (default will stop this being called)
        if (empty($input) and $required === true)
        {
            static::write('This is required.');
            static::new_line();

            $input = forward_static_call_array(array(__CLASS__, 'prompt'), $args);
        }

        // If options are provided and the choice is not in the array, tell them to try again
        if ( ! empty($options) and ! in_array($input, $options))
        {
            static::write('This is not a valid option. Please try again.');
            static::new_line();

            $input = forward_static_call_array(array(__CLASS__, 'prompt'), $args);
        }

        return $input;
    }

    //--------------------------------------------------------------------

    /**
     * Outputs a string to the cli.	 If you send an array it will implode them
     * with a line break.
     *
     * @param	string|array	$text	the text to output, or array of lines
     */
    public static function write($text = '', $foreground = null, $background = null)
    {
        if (is_array($text))
        {
            $text = implode(PHP_EOL, $text);
        }

        if ($foreground or $background)
        {
            $text = static::color($text, $foreground, $background);
        }

        fwrite(STDOUT, $text.PHP_EOL);
    }

    //--------------------------------------------------------------------

    /**
     * Outputs an error to the CLI using STDERR instead of STDOUT
     *
     * @param	string|array	$text	the text to output, or array of errors
     */
    public static function error($text = '', $foreground = 'light_red', $background = null)
    {
        if (is_array($text))
        {
            $text = implode(PHP_EOL, $text);
        }

        if ($foreground OR $background)
        {
            $text = static::color($text, $foreground, $background);
        }

        fwrite(STDERR, $text.PHP_EOL);
    }

    //--------------------------------------------------------------------

    /**
     * Beeps a certain number of times.
     *
     * @param	int $num	the number of times to beep
     */
    public static function beep($num = 1)
    {
        echo str_repeat("\x07", $num);
    }

    //--------------------------------------------------------------------

    /**
     * Waits a certain number of seconds, optionally showing a wait message and
     * waiting for a key press.
     *
     * @param	int		$seconds	number of seconds
     * @param	bool	$countdown	show a countdown or not
     */
    public static function wait($seconds = 0, $countdown = false)
    {
        if ($countdown === true)
        {
            $time = $seconds;

            while ($time > 0)
            {
                fwrite(STDOUT, $time.'... ');
                sleep(1);
                $time--;
            }
            static::write();
        }

        else
        {
            if ($seconds > 0)
            {
                sleep($seconds);
            }
            else
            {
                static::write(static::$wait_msg);
                static::input();
            }
        }
    }


    //--------------------------------------------------------------------

    /**
     * if operating system === windows
     */
    public static function is_windows()
    {
        return 'win' === strtolower(substr(php_uname("s"), 0, 3));
    }

    //--------------------------------------------------------------------

    /**
     * Enter a number of empty lines
     *
     * @param	integer	Number of lines to output
     * @return	void
     */
    public static function new_line($num = 1)
    {
        // Do it once or more, write with empty string gives us a new line
        for($i = 0; $i < $num; $i++)
        {
            static::write();
        }
    }

    //--------------------------------------------------------------------

    /**
     * Clears the screen of output
     *
     * @return	void
     */
    public static function clear_screen()
    {
        static::is_windows()

            // Windows is a bit crap at this, but their terminal is tiny so shove this in
            ? static::new_line(40)

            // Anything with a flair of Unix will handle these magic characters
            : fwrite(STDOUT, chr(27)."[H".chr(27)."[2J");
    }

    //--------------------------------------------------------------------

    /**
     * Returns the given text with the correct color codes for a foreground and
     * optionally a background color.
     *
     * @param	string	$text		the text to color
     * @param	string	$foreground the foreground color
     * @param	string	$background the background color
     * @param	string	$format		other formatting to apply. Currently only 'underline' is understood
     * @return	string	the color coded string
     */
    public static function color($text, $foreground, $background = null, $format=null)
    {
        if (static::is_windows() and ! isset($_SERVER['ANSICON']))
        {
            return $text;
        }

        if ( ! array_key_exists($foreground, static::$foreground_colors))
        {
            throw new \RuntimeException('Invalid CLI foreground color: '.$foreground);
        }

        if ( $background !== null and ! array_key_exists($background, static::$background_colors))
        {
            throw new \RuntimeException('Invalid CLI background color: '.$background);
        }

        $string = "\033[".static::$foreground_colors[$foreground]."m";

        if ($background !== null)
        {
            $string .= "\033[".static::$background_colors[$background]."m";
        }

        if ($format === 'underline')
        {
            $string .= "\033[4m";
        }

        $string .= $text."\033[0m";

        return $string;
    }

    //--------------------------------------------------------------------

    public static function getWidth($default=80)
    {
        if (static::is_windows())
        {
            return $default;
        }

        return (int)shell_exec('tput cols');
    }
    
    //--------------------------------------------------------------------

    public static function getHeight($default=32)
    {
        if (static::is_windows())
        {
            return $default;
        }

        return (int)shell_exec('tput lines');
    }

    //--------------------------------------------------------------------

    /**
     * Displays a progress bar on the CLI. You must call it repeatedly
     * to update it. Set $thisStep = false to erase the progress bar.
     *
     * @param int $thisStep
     * @param int $totalSteps
     */
    public static function showProgress($thisStep=1, $totalSteps=10)
    {
        // The first time through, save
        // our position so the script knows where to go
        // back to when writing the bar, and
        // at the end of the script.
        if (! static::$inProgress) {
            fwrite(STDOUT, "\0337");
            static::$inProgress = true;
        }

        // Restore position
        fwrite(STDERR, "\0338");

        if ($thisStep !== false) {
            // Don't allow div by zero or negative numbers....
            $thisStep = abs($thisStep);
            $totalSteps = $totalSteps < 1 ? 1 : $totalSteps;

            $percent = intval( ($thisStep / $totalSteps) * 100 );
            $step = (int)round($percent / 10);

            // Write the progress bar
            fwrite(STDOUT, "[\033[32m" . str_repeat('#', $step) . str_repeat('.', 10 - $step) . "\033[0m]");
            // Textual representation...
            fwrite(STDOUT, " {$percent}% Complete" . PHP_EOL);
            // Move up, undo the PHP_EOL
            fwrite(STDOUT, "\033[1A");
        }
        else
        {
            fwrite(STDERR, "\007");
        }
    }

    //--------------------------------------------------------------------

	/**
	 * Checks to see if an option was passed to us on the CLI and returns
	 * the value if so. Otherwise, returns null.
	 *
	 * @param $name
	 *
	 * @return null
	 */
	public static function option($name)
	{
	    if (array_key_exists($name, self::$options))
	    {
		    $val = self::$options[$name] === null ? true : self::$options[$name];
		    return $val;
	    }

		return null;
	}

	//--------------------------------------------------------------------

	/**
	 * Gets all of the options set and returns that array.
	 *
	 * @return array
	 */
	public static function getOptions()
	{
	    return self::$options;
	}

	//--------------------------------------------------------------------

	/**
	 * Returns the options as a string, suitable for passing along on
	 * the CLI to other commands.
	 */
	public static function optionString()
	{
		if (! count(static::$options))
		{
			return '';
		}

		$out = '';

		foreach (static::$options as $name => $value)
		{
			// If there's a space, we need to group
			// so it will pass correctly.
			if (strpos($value, ' ') !== false)
			{
				$value = '"'. $value .'"';
			}
			$out .= "-{$name} $value ";
		}

		return $out;
	}

	//--------------------------------------------------------------------



	/**
	 * Takes a string and writes it to the command line, wrapping to a maximum
	 * width. If no maximum width is specified, will wrap to the window's max
	 * width.
	 *
	 * If an int is passed into $pad_left, then all strings after the first
	 * will padded with that many spaces to the left. Useful when printing
	 * short descriptions that need to start on an existing line.
	 *
	 * @param null $string
	 * @param int $max
	 * @param int $pad_left
	 */
	public static function wrap($string=null, $max=0, $pad_left=0)
	{
		if (empty($string))
		{
			return '';
		}

        if ($max == 0)
        {
            $max = CLI::getWidth();
        }

		if (CLI::getWidth() < $max)
		{
			$max = CLI::getWidth();
		}

		$max = $max - $pad_left;

		$lines = wordwrap($string, $max);

		if ($pad_left > 0) {
			$lines = explode( "\n", $lines );

			$first = true;

			array_walk( $lines, function ( &$line, $index ) use($max, $pad_left, &$first) {
				if (! $first) {
					$line = str_repeat( " ", $pad_left ) . $line;
				}
				else
				{
					$first = false;
				}
			} );

			$lines = implode("\n", $lines);
		}

		return $lines;
	}

	//--------------------------------------------------------------------

	/**
	 * Parses the command line it was called from and collects all
	 * options and valid segments.
	 *
	 * I tried to use getopt but had it fail occasionally to find any
	 * but argc has always had our back. We don't have all of the "power"
	 * of getopt but this does us just fine.
	 */
	protected static function parseCommand()
	{
		$options_found = false;

		for ($i = 1; $i < $_SERVER['argc']; $i++)
		{
			// If there's no '-' at the beginning of the argument
			// then add it to our segments.
			if (! $options_found && strpos($_SERVER['argv'][$i], '-') === false)
			{
				self::$segments[] = $_SERVER['argv'][$i];
				continue;
			}

			$options_found = true;

			if (substr($_SERVER['argv'][$i], 0, 1) != '-')
			{
				continue;
			}

			$arg = str_replace('-', '', $_SERVER['argv'][$i]);
			$value = null;

			// If the next item starts with a dash it's a value
			if (isset($_SERVER['argv'][$i + 1]) && substr($_SERVER['argv'][$i + 1], 0, 1) != '-' )
			{
				$value = $_SERVER['argv'][$i + 1];
				$i++;
			}

			self::$options[$arg] = $value;
		}
	}

	//--------------------------------------------------------------------

}

CLI::_init();