* @since 2.0 */ abstract class AbstractConsole { const FG_BLACK = 30; const FG_RED = 31; const FG_GREEN = 32; const FG_YELLOW = 33; const FG_BLUE = 34; const FG_PURPLE = 35; const FG_CYAN = 36; const FG_GREY = 37; const BG_BLACK = 40; const BG_RED = 41; const BG_GREEN = 42; const BG_YELLOW = 43; const BG_BLUE = 44; const BG_PURPLE = 45; const BG_CYAN = 46; const BG_GREY = 47; const RESET = 0; const NORMAL = 0; const BOLD = 1; const ITALIC = 3; const UNDERLINE = 4; const BLINK = 5; const NEGATIVE = 7; const CONCEALED = 8; const CROSSED_OUT = 9; const FRAMED = 51; const ENCIRCLED = 52; const OVERLINED = 53; /** * Moves the terminal cursor up by sending ANSI control code CUU to the terminal. * If the cursor is already at the edge of the screen, this has no effect. * @param integer $rows number of rows the cursor should be moved up */ public static function moveCursorUp($rows = 1) { echo "\033[" . (int)$rows . 'A'; } /** * Moves the terminal cursor down by sending ANSI control code CUD to the terminal. * If the cursor is already at the edge of the screen, this has no effect. * @param integer $rows number of rows the cursor should be moved down */ public static function moveCursorDown($rows = 1) { echo "\033[" . (int)$rows . 'B'; } /** * Moves the terminal cursor forward by sending ANSI control code CUF to the terminal. * If the cursor is already at the edge of the screen, this has no effect. * @param integer $steps number of steps the cursor should be moved forward */ public static function moveCursorForward($steps = 1) { echo "\033[" . (int)$steps . 'C'; } /** * Moves the terminal cursor backward by sending ANSI control code CUB to the terminal. * If the cursor is already at the edge of the screen, this has no effect. * @param integer $steps number of steps the cursor should be moved backward */ public static function moveCursorBackward($steps = 1) { echo "\033[" . (int)$steps . 'D'; } /** * Moves the terminal cursor to the beginning of the next line by sending ANSI control code CNL to the terminal. * @param integer $lines number of lines the cursor should be moved down */ public static function moveCursorNextLine($lines = 1) { echo "\033[" . (int)$lines . 'E'; } /** * Moves the terminal cursor to the beginning of the previous line by sending ANSI control code CPL to the terminal. * @param integer $lines number of lines the cursor should be moved up */ public static function moveCursorPrevLine($lines = 1) { echo "\033[" . (int)$lines . 'F'; } /** * Moves the cursor to an absolute position given as column and row by sending ANSI control code CUP or CHA to the terminal. * @param integer $column 1-based column number, 1 is the left edge of the screen. * @param integer|null $row 1-based row number, 1 is the top edge of the screen. if not set, will move cursor only in current line. */ public static function moveCursorTo($column, $row = null) { if ($row === null) { echo "\033[" . (int)$column . 'G'; } else { echo "\033[" . (int)$row . ';' . (int)$column . 'H'; } } /** * Scrolls whole page up by sending ANSI control code SU to the terminal. * New lines are added at the bottom. This is not supported by ANSI.SYS used in windows. * @param int $lines number of lines to scroll up */ public static function scrollUp($lines = 1) { echo "\033[" . (int)$lines . "S"; } /** * Scrolls whole page down by sending ANSI control code SD to the terminal. * New lines are added at the top. This is not supported by ANSI.SYS used in windows. * @param int $lines number of lines to scroll down */ public static function scrollDown($lines = 1) { echo "\033[" . (int)$lines . "T"; } /** * Saves the current cursor position by sending ANSI control code SCP to the terminal. * Position can then be restored with {@link restoreCursorPosition}. */ public static function saveCursorPosition() { echo "\033[s"; } /** * Restores the cursor position saved with {@link saveCursorPosition} by sending ANSI control code RCP to the terminal. */ public static function restoreCursorPosition() { echo "\033[u"; } /** * Hides the cursor by sending ANSI DECTCEM code ?25l to the terminal. * Use {@link showCursor} to bring it back. * Do not forget to show cursor when your application exits. Cursor might stay hidden in terminal after exit. */ public static function hideCursor() { echo "\033[?25l"; } /** * Will show a cursor again when it has been hidden by {@link hideCursor} by sending ANSI DECTCEM code ?25h to the terminal. */ public static function showCursor() { echo "\033[?25h"; } /** * Clears entire screen content by sending ANSI control code ED with argument 2 to the terminal. * Cursor position will not be changed. * **Note:** ANSI.SYS implementation used in windows will reset cursor position to upper left corner of the screen. */ public static function clearScreen() { echo "\033[2J"; } /** * Clears text from cursor to the beginning of the screen by sending ANSI control code ED with argument 1 to the terminal. * Cursor position will not be changed. */ public static function clearScreenBeforeCursor() { echo "\033[1J"; } /** * Clears text from cursor to the end of the screen by sending ANSI control code ED with argument 0 to the terminal. * Cursor position will not be changed. */ public static function clearScreenAfterCursor() { echo "\033[0J"; } /** * Clears the line, the cursor is currently on by sending ANSI control code EL with argument 2 to the terminal. * Cursor position will not be changed. */ public static function clearLine() { echo "\033[2K"; } /** * Clears text from cursor position to the beginning of the line by sending ANSI control code EL with argument 1 to the terminal. * Cursor position will not be changed. */ public static function clearLineBeforeCursor() { echo "\033[1K"; } /** * Clears text from cursor position to the end of the line by sending ANSI control code EL with argument 0 to the terminal. * Cursor position will not be changed. */ public static function clearLineAfterCursor() { echo "\033[0K"; } /** * Returns the ANSI format code. * * @param array $format An array containing formatting values. * You can pass any of the FG_*, BG_* and TEXT_* constants * and also [[xtermFgColor]] and [[xtermBgColor]] to specify a format. * @return string The ANSI format code according to the given formatting constants. */ public static function ansiFormatCode($format) { return "\033[" . implode(';', $format) . 'm'; } /** * Echoes an ANSI format code that affects the formatting of any text that is printed afterwards. * * @param array $format An array containing formatting values. * You can pass any of the FG_*, BG_* and TEXT_* constants * and also [[xtermFgColor]] and [[xtermBgColor]] to specify a format. * @see ansiFormatCode() * @see ansiFormatEnd() */ public static function beginAnsiFormat($format) { echo "\033[" . implode(';', $format) . 'm'; } /** * Resets any ANSI format set by previous method [[ansiFormatBegin()]] * Any output after this will have default text format. * This is equal to calling * * ```php * echo Console::ansiFormatCode(array(Console::RESET)) * ``` */ public static function endAnsiFormat() { echo "\033[0m"; } /** * Will return a string formatted with the given ANSI style * * @param string $string the string to be formatted * @param array $format An array containing formatting values. * You can pass any of the FG_*, BG_* and TEXT_* constants * and also [[xtermFgColor]] and [[xtermBgColor]] to specify a format. * @return string */ public static function ansiFormat($string, $format = array()) { $code = implode(';', $format); return "\033[0m" . ($code !== '' ? "\033[" . $code . "m" : '') . $string . "\033[0m"; } /** * Returns the ansi format code for xterm foreground color. * You can pass the return value of this to one of the formatting methods: * [[ansiFormat]], [[ansiFormatCode]], [[beginAnsiFormat]] * * @param integer $colorCode xterm color code * @return string * @see http://en.wikipedia.org/wiki/Talk:ANSI_escape_code#xterm-256colors */ public static function xtermFgColor($colorCode) { return '38;5;' . $colorCode; } /** * Returns the ansi format code for xterm background color. * You can pass the return value of this to one of the formatting methods: * [[ansiFormat]], [[ansiFormatCode]], [[beginAnsiFormat]] * * @param integer $colorCode xterm color code * @return string * @see http://en.wikipedia.org/wiki/Talk:ANSI_escape_code#xterm-256colors */ public static function xtermBgColor($colorCode) { return '48;5;' . $colorCode; } /** * Strips ANSI control codes from a string * * @param string $string String to strip * @return string */ public static function stripAnsiFormat($string) { return preg_replace('/\033\[[\d;?]*\w/', '', $string); } /** * Converts an ANSI formatted string to HTML * @param $string * @return mixed */ // TODO rework/refactor according to https://github.com/yiisoft/yii2/issues/746 public static function ansiToHtml($string) { $tags = 0; return preg_replace_callback( '/\033\[[\d;]+m/', function ($ansi) use (&$tags) { $styleA = array(); foreach (explode(';', $ansi) as $controlCode) { switch ($controlCode) { case self::FG_BLACK: $style = array('color' => '#000000'); break; case self::FG_BLUE: $style = array('color' => '#000078'); break; case self::FG_CYAN: $style = array('color' => '#007878'); break; case self::FG_GREEN: $style = array('color' => '#007800'); break; case self::FG_GREY: $style = array('color' => '#787878'); break; case self::FG_PURPLE: $style = array('color' => '#780078'); break; case self::FG_RED: $style = array('color' => '#780000'); break; case self::FG_YELLOW: $style = array('color' => '#787800'); break; case self::BG_BLACK: $style = array('background-color' => '#000000'); break; case self::BG_BLUE: $style = array('background-color' => '#000078'); break; case self::BG_CYAN: $style = array('background-color' => '#007878'); break; case self::BG_GREEN: $style = array('background-color' => '#007800'); break; case self::BG_GREY: $style = array('background-color' => '#787878'); break; case self::BG_PURPLE: $style = array('background-color' => '#780078'); break; case self::BG_RED: $style = array('background-color' => '#780000'); break; case self::BG_YELLOW: $style = array('background-color' => '#787800'); break; case self::BOLD: $style = array('font-weight' => 'bold'); break; case self::ITALIC: $style = array('font-style' => 'italic'); break; case self::UNDERLINE: $style = array('text-decoration' => array('underline')); break; case self::OVERLINED: $style = array('text-decoration' => array('overline')); break; case self::CROSSED_OUT: $style = array('text-decoration' => array('line-through')); break; case self::BLINK: $style = array('text-decoration' => array('blink')); break; case self::NEGATIVE: // ??? case self::CONCEALED: case self::ENCIRCLED: case self::FRAMED: // TODO allow resetting codes break; case 0: // ansi reset $return = ''; for ($n = $tags; $tags > 0; $tags--) { $return .= ''; } return $return; } $styleA = ArrayHelper::merge($styleA, $style); } $styleString[] = array(); foreach ($styleA as $name => $content) { if ($name === 'text-decoration') { $content = implode(' ', $content); } $styleString[] = $name . ':' . $content; } $tags++; return ' $value) { echo " $key - $value\n"; } echo " ? - Show help\n"; goto top; } elseif (!in_array($input, array_keys($options))) { goto top; } return $input; } /** * Displays and updates a simple progress bar on screen. * * @param integer $done the number of items that are completed * @param integer $total the total value of items that are to be done * @param integer $size the size of the status bar (optional) * @see http://snipplr.com/view/29548/ */ public static function showProgress($done, $total, $size = 30) { static $start; // if we go over our bound, just ignore it if ($done > $total) { return; } if (empty($start)) { $start = time(); } $now = time(); $percent = (double)($done / $total); $bar = floor($percent * $size); $status = "\r["; $status .= str_repeat("=", $bar); if ($bar < $size) { $status .= ">"; $status .= str_repeat(" ", $size - $bar); } else { $status .= "="; } $display = number_format($percent * 100, 0); $status .= "] $display% $done/$total"; $rate = ($now - $start) / $done; $left = $total - $done; $eta = round($rate * $left, 2); $elapsed = $now - $start; $status .= " remaining: " . number_format($eta) . " sec. elapsed: " . number_format($elapsed) . " sec."; static::stdout("$status "); flush(); // when done, send a newline if ($done == $total) { echo "\n"; } } }