Console.php 23.5 KB
Newer Older
Qiang Xue committed
1 2 3 4 5 6 7 8 9 10
<?php
/**
 * @link http://www.yiiframework.com/
 * @copyright Copyright (c) 2008 Yii Software LLC
 * @license http://www.yiiframework.com/license/
 */

namespace yii\helpers\base;

/**
Carsten Brandt committed
11 12 13
 * TODO adjust phpdoc
 * TODO test this on all kinds of terminals, especially windows (check out lib ncurses)
 *
Qiang Xue committed
14 15 16 17 18
 * Console View is the base class for console view components
 *
 * A console view provides functionality to create rich console application by allowing to format output
 * by adding color and font style to it.
 *
19 20 21 22 23 24
 * The following constants are available for formatting:
 *
 * TODO document constants
 *
 *
 *
Qiang Xue committed
25 26 27
 * @author Carsten Brandt <mail@cebe.cc>
 * @since 2.0
 */
28
class Console
Qiang Xue committed
29
{
Carsten Brandt committed
30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47
	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;

48
	const RESET       = 0;
Carsten Brandt committed
49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243
	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";
	}

	/**
244
	 * Returns the ANSI format code.
Carsten Brandt committed
245
	 *
246
	 * @param array $format You can pass any of the FG_*, BG_* and TEXT_* constants and also [[xtermFgColor]] and [[xtermBgColor]].
Carsten Brandt committed
247
	 * TODO: documentation
248
	 * @return string
Carsten Brandt committed
249
	 */
250
	public static function ansiFormatCode($format)
Carsten Brandt committed
251
	{
252
		return "\033[" . implode(';', $format) . 'm';
Carsten Brandt committed
253 254
	}

255
	/**
256 257 258 259 260
	 * Sets the ANSI format for any text that is printed afterwards.
	 *
	 * @param array $format You can pass any of the FG_*, BG_* and TEXT_* constants and also [[xtermFgColor]] and [[xtermBgColor]].
	 * TODO: documentation
	 * @see ansiFormatEnd()
261
	 */
262
	public static function beginAnsiFormat($format)
263
	{
264
		echo "\033[" . implode(';', $format) . 'm';
265 266 267
	}

	/**
268 269 270
	 * Resets any ANSI format set by previous method [[ansiFormatBegin()]]
	 * Any output after this is will have default text style.
	 * This is equal to
271
	 *
272 273 274
	 * ```php
	 * echo Console::ansiFormatCode(array(Console::RESET))
	 * ```
275
	 */
276
	public static function endAnsiFormat()
277
	{
278
		echo "\033[0m";
279 280
	}

Carsten Brandt committed
281 282 283 284
	/**
	 * Will return a string formatted with the given ANSI style
	 *
	 * @param string $string the string to be formatted
285
	 * @param array $format array containing formatting values.
286
	 * You can pass any of the FG_*, BG_* and TEXT_* constants and also [[xtermFgColor]] and [[xtermBgColor]].
Carsten Brandt committed
287 288
	 * @return string
	 */
resurtm committed
289
	public static function ansiFormat($string, $format = array())
Carsten Brandt committed
290
	{
291
		$code = implode(';', $format);
Carsten Brandt committed
292 293 294
		return "\033[0m" . ($code !== '' ? "\033[" . $code . "m" : '') . $string . "\033[0m";
	}

295 296 297 298 299 300 301 302 303 304
	/**
	 * Returns the ansi format code for xterm foreground color.
	 * You can pass the returnvalue 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)
Carsten Brandt committed
305
	{
306
		return '38;5;' . $colorCode;
Carsten Brandt committed
307 308
	}

309 310 311 312 313 314 315 316 317 318
	/**
	 * Returns the ansi format code for xterm foreground color.
	 * You can pass the returnvalue 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)
Carsten Brandt committed
319
	{
320
		return '48;5;' . $colorCode;
Carsten Brandt committed
321 322 323 324 325 326 327 328
	}

	/**
	 * Strips ANSI control codes from a string
	 *
	 * @param string $string String to strip
	 * @return string
	 */
329
	public static function stripAnsiFormat($string)
Carsten Brandt committed
330
	{
331
		return preg_replace('/\033\[[\d;?]*\w/', '', $string);
Carsten Brandt committed
332 333 334 335 336 337 338 339 340 341 342 343
	}

	// TODO refactor and review
	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) {
344
						case self::FG_BLACK:
Carsten Brandt committed
345 346
							$style = array('color' => '#000000');
							break;
347
						case self::FG_BLUE:
Carsten Brandt committed
348 349
							$style = array('color' => '#000078');
							break;
350
						case self::FG_CYAN:
Carsten Brandt committed
351 352
							$style = array('color' => '#007878');
							break;
353
						case self::FG_GREEN:
Carsten Brandt committed
354 355
							$style = array('color' => '#007800');
							break;
356
						case self::FG_GREY:
Carsten Brandt committed
357 358
							$style = array('color' => '#787878');
							break;
359
						case self::FG_PURPLE:
Carsten Brandt committed
360 361
							$style = array('color' => '#780078');
							break;
362
						case self::FG_RED:
Carsten Brandt committed
363 364
							$style = array('color' => '#780000');
							break;
365
						case self::FG_YELLOW:
Carsten Brandt committed
366 367
							$style = array('color' => '#787800');
							break;
368
						case self::BG_BLACK:
Carsten Brandt committed
369 370
							$style = array('background-color' => '#000000');
							break;
371
						case self::BG_BLUE:
Carsten Brandt committed
372 373
							$style = array('background-color' => '#000078');
							break;
374
						case self::BG_CYAN:
Carsten Brandt committed
375 376
							$style = array('background-color' => '#007878');
							break;
377
						case self::BG_GREEN:
Carsten Brandt committed
378 379
							$style = array('background-color' => '#007800');
							break;
380
						case self::BG_GREY:
Carsten Brandt committed
381 382
							$style = array('background-color' => '#787878');
							break;
383
						case self::BG_PURPLE:
Carsten Brandt committed
384 385
							$style = array('background-color' => '#780078');
							break;
386
						case self::BG_RED:
Carsten Brandt committed
387 388
							$style = array('background-color' => '#780000');
							break;
389
						case self::BG_YELLOW:
Carsten Brandt committed
390 391
							$style = array('background-color' => '#787800');
							break;
392
						case self::BOLD:
Carsten Brandt committed
393 394
							$style = array('font-weight' => 'bold');
							break;
395
						case self::ITALIC:
Carsten Brandt committed
396 397
							$style = array('font-style' => 'italic');
							break;
398
						case self::UNDERLINE:
Carsten Brandt committed
399 400
							$style = array('text-decoration' => array('underline'));
							break;
401
						case self::OVERLINED:
Carsten Brandt committed
402 403
							$style = array('text-decoration' => array('overline'));
							break;
404
						case self::CROSSED_OUT:
Carsten Brandt committed
405 406
							$style = array('text-decoration' => array('line-through'));
							break;
407
						case self::BLINK:
Carsten Brandt committed
408 409
							$style = array('text-decoration' => array('blink'));
							break;
410 411 412 413
						case self::NEGATIVE: // ???
						case self::CONCEALED:
						case self::ENCIRCLED:
						case self::FRAMED:
Carsten Brandt committed
414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439
							// TODO allow resetting codes
							break;
						case 0: // ansi reset
							$return = '';
							for ($n = $tags; $tags > 0; $tags--) {
								$return .= '</span>';
							}
							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 '<span' . (!empty($styleString) ? 'style="' . implode(';', $styleString) : '') . '>';
			},
			$string
		);
	}

440
	public function markdownToAnsi()
Carsten Brandt committed
441
	{
442
		// TODO implement
Carsten Brandt committed
443 444 445
	}

	/**
446
	 * Converts a string to ansi formatted by replacing patterns like %y (for yellow) with ansi control codes
Carsten Brandt committed
447
	 *
448 449 450
	 * // TODO documentation
	 * Uses almost the same syntax as https://github.com/pear/Console_Color2/blob/master/Console/Color2.php
	 * The conversion table is: ('bold' meaning 'light' on some
Carsten Brandt committed
451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482
	 * terminals). It's almost the same conversion table irssi uses.
	 * <pre>
	 *                  text      text            background
	 *      ------------------------------------------------
	 *      %k %K %0    black     dark grey       black
	 *      %r %R %1    red       bold red        red
	 *      %g %G %2    green     bold green      green
	 *      %y %Y %3    yellow    bold yellow     yellow
	 *      %b %B %4    blue      bold blue       blue
	 *      %m %M %5    magenta   bold magenta    magenta
	 *      %p %P       magenta (think: purple)
	 *      %c %C %6    cyan      bold cyan       cyan
	 *      %w %W %7    white     bold white      white
	 *
	 *      %F     Blinking, Flashing
	 *      %U     Underline
	 *      %8     Reverse
	 *      %_,%9  Bold
	 *
	 *      %n     Resets the color
	 *      %%     A single %
	 * </pre>
	 * First param is the string to convert, second is an optional flag if
	 * colors should be used. It defaults to true, if set to false, the
	 * colorcodes will just be removed (And %% will be transformed into %)
	 *
	 * @param string $string  String to convert
	 * @param bool   $colored Should the string be colored?
	 * @return string
	 */
	public static function renderColoredString($string, $colored = true)
	{
483
		static $conversions = array(
484 485 486 487 488 489 490 491 492
			'%y' => array(self::FG_YELLOW),
			'%g' => array(self::FG_GREEN),
			'%b' => array(self::FG_BLUE),
			'%r' => array(self::FG_RED),
			'%p' => array(self::FG_PURPLE),
			'%m' => array(self::FG_PURPLE),
			'%c' => array(self::FG_CYAN),
			'%w' => array(self::FG_GREY),
			'%k' => array(self::FG_BLACK),
493
			'%n' => array(0), // reset
494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516
			'%Y' => array(self::FG_YELLOW, self::BOLD),
			'%G' => array(self::FG_GREEN, self::BOLD),
			'%B' => array(self::FG_BLUE, self::BOLD),
			'%R' => array(self::FG_RED, self::BOLD),
			'%P' => array(self::FG_PURPLE, self::BOLD),
			'%M' => array(self::FG_PURPLE, self::BOLD),
			'%C' => array(self::FG_CYAN, self::BOLD),
			'%W' => array(self::FG_GREY, self::BOLD),
			'%K' => array(self::FG_BLACK, self::BOLD),
			'%N' => array(0, self::BOLD),
			'%3' => array(self::BG_YELLOW),
			'%2' => array(self::BG_GREEN),
			'%4' => array(self::BG_BLUE),
			'%1' => array(self::BG_RED),
			'%5' => array(self::BG_PURPLE),
			'%6' => array(self::BG_PURPLE),
			'%7' => array(self::BG_CYAN),
			'%0' => array(self::BG_GREY),
			'%F' => array(self::BLINK),
			'%U' => array(self::UNDERLINE),
			'%8' => array(self::NEGATIVE),
			'%9' => array(self::BOLD),
			'%_' => array(self::BOLD)
Carsten Brandt committed
517 518 519 520 521 522 523
		);

		if ($colored) {
			$string = str_replace('%%', '% ', $string);
			foreach ($conversions as $key => $value) {
				$string = str_replace(
					$key,
524
					static::ansiFormatCode($value),
Carsten Brandt committed
525 526 527 528 529 530 531 532 533 534 535
					$string
				);
			}
			$string = str_replace('% ', '%', $string);
		} else {
			$string = preg_replace('/%((%)|.)/', '$2', $string);
		}
		return $string;
	}

	/**
536 537 538 539 540 541 542 543
	 * Escapes % so they don't get interpreted as color codes when
	 * the string is parsed by [[renderColoredString]]
	 *
	 * @param string $string String to escape
	 *
	 * @access public
	 * @return string
	 */
Carsten Brandt committed
544 545 546 547 548 549
	public static function escape($string)
	{
		return str_replace('%', '%%', $string);
	}

	/**
550
	 * Returns true if the stream supports colorization. ANSI colors are disabled if not supported by the stream.
Carsten Brandt committed
551
	 *
552
	 * - windows without ansicon
Carsten Brandt committed
553 554 555 556 557 558 559 560
	 * - not tty consoles
	 *
	 * @param mixed $stream
	 * @return bool true if the stream supports ANSI colors, otherwise false.
	 */
	public static function streamSupportsAnsiColors($stream)
	{
		return DIRECTORY_SEPARATOR == '\\'
561
			? getenv('ANSICON') !== false || getenv('ConEmuANSI') === 'ON'
Carsten Brandt committed
562 563 564 565 566 567 568 569 570
			: function_exists('posix_isatty') && @posix_isatty($stream);
	}

	/**
	 * Returns true if the console is running on windows
	 * @return bool
	 */
	public static function isRunningOnWindows()
	{
571
		return DIRECTORY_SEPARATOR == '\\';
Carsten Brandt committed
572 573 574
	}

	/**
575
	 * Usage: list($w, $h) = ConsoleHelper::getScreenSize();
Carsten Brandt committed
576
	 *
577 578 579
	 * @param bool $refresh whether to force checking and not re-use cached size value.
	 * This is useful to detect changing window size while the application is running but may
	 * not get up to date values on every terminal.
580
	 * @return array|boolean An array of ($width, $height) or false when it was not able to determine size.
Carsten Brandt committed
581
	 */
582
	public static function getScreenSize($refresh = false)
Carsten Brandt committed
583
	{
584 585 586 587 588 589
		static $size;
		if ($size !== null && !$refresh) {
			return $size;
		}

		if (static::isRunningOnWindows()) {
590 591
			$output = array();
			exec('mode con', $output);
resurtm committed
592
			if (isset($output) && strpos($output[1], 'CON') !== false) {
593 594
				return $size = array((int)preg_replace('~[^0-9]~', '', $output[3]), (int)preg_replace('~[^0-9]~', '', $output[4]));
			}
595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613
		} else {
			// try stty if available
			$stty = array();
			if (exec('stty -a 2>&1', $stty) && preg_match('/rows\s+(\d+);\s*columns\s+(\d+);/mi', implode(' ', $stty), $matches)) {
				return $size = array($matches[2], $matches[1]);
			}

			// fallback to tput, which may not be updated on terminal resize
			if (($width = (int) exec('tput cols 2>&1')) > 0 && ($height = (int) exec('tput lines 2>&1')) > 0) {
				return $size = array($width, $height);
			}

			// fallback to ENV variables, which may not be updated on terminal resize
			if (($width = (int) getenv('COLUMNS')) > 0 && ($height = (int) getenv('LINES')) > 0) {
				return $size = array($width, $height);
			}
		}

		return $size = false;
Carsten Brandt committed
614 615 616
	}

	/**
617
	 * Gets input from STDIN and returns a string right-trimmed for EOLs.
Carsten Brandt committed
618
	 *
619 620
	 * @param bool $raw If set to true, returns the raw string without trimming
	 * @return string
Carsten Brandt committed
621
	 */
622
	public static function stdin($raw = false)
Carsten Brandt committed
623
	{
624
		return $raw ? fgets(STDIN) : rtrim(fgets(STDIN), PHP_EOL);
Carsten Brandt committed
625 626 627
	}

	/**
628
	 * Prints a string to STDOUT.
Carsten Brandt committed
629
	 *
630 631
	 * @param string $string the string to print
	 * @return int|boolean Number of bytes printed or false on error
Carsten Brandt committed
632
	 */
633
	public static function stdout($string)
Carsten Brandt committed
634
	{
635
		return fwrite(STDOUT, $string);
Carsten Brandt committed
636 637 638
	}

	/**
639
	 * Prints a string to STDERR.
Carsten Brandt committed
640
	 *
641 642
	 * @param string $string the string to print
	 * @return int|boolean Number of bytes printed or false on error
Carsten Brandt committed
643
	 */
644
	public static function stderr($string)
Carsten Brandt committed
645
	{
646
		return fwrite(STDERR, $string);
Carsten Brandt committed
647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666
	}

	/**
	 * Asks the user for input. Ends when the user types a carriage return (PHP_EOL). Optionally, It also provides a
	 * prompt.
	 *
	 * @param string $prompt the prompt (optional)
	 * @return string the user's input
	 */
	public static function input($prompt = null)
	{
		if (isset($prompt)) {
			static::stdout($prompt);
		}
		return static::stdin();
	}

	/**
	 * Prints text to STDOUT appended with a carriage return (PHP_EOL).
	 *
667
	 * @param string $string
Carsten Brandt committed
668 669
	 * @return mixed Number of bytes printed or bool false on error
	 */
670
	public static function output($string = null)
671
	{
672
		return static::stdout($string . PHP_EOL);
673 674 675 676 677
	}

	/**
	 * Prints text to STDERR appended with a carriage return (PHP_EOL).
	 *
678
	 * @param string $string
679 680
	 * @return mixed Number of bytes printed or false on error
	 */
681
	public static function error($string = null)
Carsten Brandt committed
682
	{
683
		return static::stderr($string . PHP_EOL);
Carsten Brandt committed
684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738
	}

	/**
	 * Prompts the user for input and validates it
	 *
	 * @param string $text prompt string
	 * @param array $options the options to validate the input:
	 *  - required: whether it is required or not
	 *  - default: default value if no input is inserted by the user
	 *  - pattern: regular expression pattern to validate user input
	 *  - validator: a callable function to validate input. The function must accept two parameters:
	 *      - $input: the user input to validate
	 *      - $error: the error value passed by reference if validation failed.
	 * @return string the user input
	 */
	public static function prompt($text, $options = array())
	{
		$options = ArrayHelper::merge(
			$options,
			array(
				'required'  => false,
				'default'   => null,
				'pattern'   => null,
				'validator' => null,
				'error'     => 'Invalid input.',
			)
		);
		$error   = null;

		top:
		$input = $options['default']
			? static::input("$text [" . $options['default'] . ']: ')
			: static::input("$text: ");

		if (!strlen($input)) {
			if (isset($options['default'])) {
				$input = $options['default'];
			} elseif ($options['required']) {
				static::output($options['error']);
				goto top;
			}
		} elseif ($options['pattern'] && !preg_match($options['pattern'], $input)) {
			static::output($options['error']);
			goto top;
		} elseif ($options['validator'] &&
			!call_user_func_array($options['validator'], array($input, &$error))
		) {
			static::output(isset($error) ? $error : $options['error']);
			goto top;
		}

		return $input;
	}

	/**
739
	 * Asks user to confirm by typing y or n.
Carsten Brandt committed
740
	 *
741 742 743
	 * @param string $message to echo out before waiting for user input
	 * @param boolean $default this value is returned if no selection is made.
	 * @return boolean whether user confirmed
Carsten Brandt committed
744
	 */
745
	public static function confirm($message, $default = true)
Carsten Brandt committed
746
	{
747 748 749
		echo $message . ' (yes|no) [' . ($default ? 'yes' : 'no') . ']:';
		$input = trim(static::stdin());
		return empty($input) ? $default : !strncasecmp($input, 'y', 1);
Carsten Brandt committed
750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780
	}

	/**
	 * Gives the user an option to choose from. Giving '?' as an input will show
	 * a list of options to choose from and their explanations.
	 *
	 * @param string $prompt the prompt message
	 * @param array  $options Key-value array of options to choose from
	 *
	 * @return string An option character the user chose
	 */
	public static function select($prompt, $options = array())
	{
		top:
		static::stdout("$prompt [" . implode(',', array_keys($options)) . ",?]: ");
		$input = static::stdin();
		if ($input === '?') {
			foreach ($options as $key => $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.
	 *
781 782 783
	 * @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)
Carsten Brandt committed
784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833
	 * @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";
		}
	}
Qiang Xue committed
834
}