interface/modules/zend_modules/library/Zend/Console/Adapter/Posix.php

   1 <?php
   2 /**
   3  * Zend Framework (http://framework.zend.com/)
   4  *
   5  * @link      http://github.com/zendframework/zf2 for the canonical source repository
   6  * @copyright Copyright (c) 2005-2013 Zend Technologies USA Inc. (http://www.zend.com)
   7  * @license   http://framework.zend.com/license/new-bsd New BSD License
   8  */
   9
  10 namespace Zend\Console\Adapter;
  11
  12 use ReflectionClass;
  13 use Zend\Console\Charset;
  14 use Zend\Console\Exception;
  15 use Zend\Console\Color\Xterm256;
  16 use Zend\Console\ColorInterface as Color;
  17
  18 /**
  19  * @todo Add GNU readline support
  20  * @link http://en.wikipedia.org/wiki/ANSI_escape_code
  21  */
  22 class Posix extends AbstractAdapter
  23 {
  24     /**
  25      * Whether or not mbstring is enabled
  26      *
  27      * @var null|bool
  28      */
  29     protected static $hasMBString;
  30
  31     /**
  32      * @var Charset\CharsetInterface
  33      */
  34     protected $charset;
  35
  36     /**
  37      * Map of colors to ANSI codes
  38      *
  39      * @var array
  40      */
  41     protected static $ansiColorMap = array(
  42         'fg' => array(
  43             Color::NORMAL        => '22;39',
  44             Color::RESET         => '22;39',
  45
  46             Color::BLACK         => '0;30',
  47             Color::RED           => '0;31',
  48             Color::GREEN         => '0;32',
  49             Color::YELLOW        => '0;33',
  50             Color::BLUE          => '0;34',
  51             Color::MAGENTA       => '0;35',
  52             Color::CYAN          => '0;36',
  53             Color::WHITE         => '0;37',
  54
  55             Color::GRAY          => '1;30',
  56             Color::LIGHT_RED     => '1;31',
  57             Color::LIGHT_GREEN   => '1;32',
  58             Color::LIGHT_YELLOW  => '1;33',
  59             Color::LIGHT_BLUE    => '1;34',
  60             Color::LIGHT_MAGENTA => '1;35',
  61             Color::LIGHT_CYAN    => '1;36',
  62             Color::LIGHT_WHITE   => '1;37',
  63         ),
  64         'bg' => array(
  65             Color::NORMAL        => '0;49',
  66             Color::RESET         => '0;49',
  67
  68             Color::BLACK         => '40',
  69             Color::RED           => '41',
  70             Color::GREEN         => '42',
  71             Color::YELLOW        => '43',
  72             Color::BLUE          => '44',
  73             Color::MAGENTA       => '45',
  74             Color::CYAN          => '46',
  75             Color::WHITE         => '47',
  76
  77             Color::GRAY          => '40',
  78             Color::LIGHT_RED     => '41',
  79             Color::LIGHT_GREEN   => '42',
  80             Color::LIGHT_YELLOW  => '43',
  81             Color::LIGHT_BLUE    => '44',
  82             Color::LIGHT_MAGENTA => '45',
  83             Color::LIGHT_CYAN    => '46',
  84             Color::LIGHT_WHITE   => '47',
  85         ),
  86     );
  87
  88     /**
  89      * Last fetched TTY mode
  90      *
  91      * @var string|null
  92      */
  93     protected $lastTTYMode = null;
  94
  95     /**
  96      * Write a single line of text to console and advance cursor to the next line.
  97      *
  98      * This override works around a bug in some terminals that cause the background color
  99      * to fill the next line after EOL. To remedy this, we are sending the colored string with
 100      * appropriate color reset sequences before sending EOL character.
 101      *
 102      * @link https://github.com/zendframework/zf2/issues/4167
 103      * @param string   $text
 104      * @param null|int $color
 105      * @param null|int $bgColor
 106      */
 107     public function writeLine($text = "", $color = null, $bgColor = null)
 108     {
 109         $this->write($text, $color, $bgColor);
 110         $this->write(PHP_EOL);
 111     }
 112
 113     /**
 114      * Determine and return current console width.
 115      *
 116      * @return int
 117      */
 118     public function getWidth()
 119     {
 120         static $width;
 121         if ($width > 0) {
 122             return $width;
 123         }
 124
 125         /**
 126          * Try to read env variable
 127          */
 128         if (($result = getenv('COLUMNS')) !== false) {
 129             return $width = (int) $result;
 130         }
 131
 132         /**
 133          * Try to read console size from "tput" command
 134          */
 135         $result = exec('tput cols', $output, $return);
 136         if (!$return && is_numeric($result)) {
 137             return $width = (int) $result;
 138         }
 139
 140         return $width = parent::getWidth();
 141     }
 142
 143     /**
 144      * Determine and return current console height.
 145      *
 146      * @return false|int
 147      */
 148     public function getHeight()
 149     {
 150         static $height;
 151         if ($height > 0) {
 152             return $height;
 153         }
 154
 155         // Try to read env variable
 156         if (($result = getenv('LINES')) !== false) {
 157             return $height = (int) $result;
 158         }
 159
 160         // Try to read console size from "tput" command
 161         $result = exec('tput lines', $output, $return);
 162         if (!$return && is_numeric($result)) {
 163             return $height = (int) $result;
 164         }
 165
 166         return $height = parent::getHeight();
 167     }
 168
 169     /**
 170      * Run a mode command and store results
 171      *
 172      * @return void
 173      */
 174     protected function runModeCommand()
 175     {
 176         exec('mode', $output, $return);
 177         if ($return || !count($output)) {
 178             $this->modeResult = '';
 179         } else {
 180             $this->modeResult = trim(implode('', $output));
 181         }
 182     }
 183
 184     /**
 185      * Check if console is UTF-8 compatible
 186      *
 187      * @return bool
 188      */
 189     public function isUtf8()
 190     {
 191         // Try to retrieve it from LANG env variable
 192         if (($lang = getenv('LANG')) !== false) {
 193             return stristr($lang, 'utf-8') || stristr($lang, 'utf8');
 194         }
 195
 196         return false;
 197     }
 198
 199     /**
 200      * Show console cursor
 201      */
 202     public function showCursor()
 203     {
 204         echo "\x1b[?25h";
 205     }
 206
 207     /**
 208      * Hide console cursor
 209      */
 210     public function hideCursor()
 211     {
 212         echo "\x1b[?25l";
 213     }
 214
 215     /**
 216      * Set cursor position
 217      * @param int $x
 218      * @param int $y
 219      */
 220     public function setPos($x, $y)
 221     {
 222         echo "\x1b[" . $y . ';' . $x . 'f';
 223     }
 224
 225     /**
 226      * Prepare a string that will be rendered in color.
 227      *
 228      * @param  string   $string
 229      * @param  int      $color
 230      * @param  null|int $bgColor
 231      * @throws Exception\BadMethodCallException
 232      * @return string
 233      */
 234     public function colorize($string, $color = null, $bgColor = null)
 235     {
 236         $color   = $this->getColorCode($color, 'fg');
 237         $bgColor = $this->getColorCode($bgColor, 'bg');
 238         return ($color !== null ? "\x1b[" . $color   . 'm' : '')
 239             . ($bgColor !== null ? "\x1b[" . $bgColor . 'm' : '')
 240             . $string
 241             . "\x1b[22;39m\x1b[0;49m";
 242     }
 243
 244     /**
 245      * Change current drawing color.
 246      *
 247      * @param int $color
 248      * @throws Exception\BadMethodCallException
 249      */
 250     public function setColor($color)
 251     {
 252         $color = $this->getColorCode($color, 'fg');
 253         echo "\x1b[" . $color . 'm';
 254     }
 255
 256     /**
 257      * Change current drawing background color
 258      *
 259      * @param int $bgColor
 260      * @throws Exception\BadMethodCallException
 261      */
 262     public function setBgColor($bgColor)
 263     {
 264         $bgColor = $this->getColorCode($bgColor, 'bg');
 265         echo "\x1b[" . ($bgColor) . 'm';
 266     }
 267
 268     /**
 269      * Reset color to console default.
 270      */
 271     public function resetColor()
 272     {
 273         echo "\x1b[0;49m";  // reset bg color
 274         echo "\x1b[22;39m"; // reset fg bold, bright and faint
 275         echo "\x1b[25;39m"; // reset fg blink
 276         echo "\x1b[24;39m"; // reset fg underline
 277     }
 278
 279     /**
 280      * Set Console charset to use.
 281      *
 282      * @param Charset\CharsetInterface $charset
 283      */
 284     public function setCharset(Charset\CharsetInterface $charset)
 285     {
 286         $this->charset = $charset;
 287     }
 288
 289     /**
 290      * Get charset currently in use by this adapter.
 291      *
 292      * @return Charset\CharsetInterface $charset
 293      */
 294     public function getCharset()
 295     {
 296         if ($this->charset === null) {
 297             $this->charset = $this->getDefaultCharset();
 298         }
 299
 300         return $this->charset;
 301     }
 302
 303     /**
 304      * @return Charset\CharsetInterface
 305      */
 306     public function getDefaultCharset()
 307     {
 308         if ($this->isUtf8()) {
 309             return new Charset\Utf8;
 310         }
 311         return new Charset\DECSG();
 312     }
 313
 314     /**
 315      * Read a single character from the console input
 316      *
 317      * @param  string|null $mask   A list of allowed chars
 318      * @return string
 319      */
 320     public function readChar($mask = null)
 321     {
 322         $this->setTTYMode('-icanon -echo');
 323
 324         $stream = fopen('php://stdin', 'rb');
 325         do {
 326             $char = fgetc($stream);
 327         } while (strlen($char) !== 1 || ($mask !== null && false === strstr($mask, $char)));
 328         fclose($stream);
 329
 330         $this->restoreTTYMode();
 331         return $char;
 332     }
 333
 334     /**
 335      * Reset color to console default.
 336      */
 337     public function clear()
 338     {
 339         echo "\x1b[2J";      // reset bg color
 340         $this->setPos(1, 1); // reset cursor position
 341     }
 342
 343     /**
 344      * Restore TTY (Console) mode to previous value.
 345      *
 346      * @return void
 347      */
 348     protected function restoreTTYMode()
 349     {
 350         if ($this->lastTTYMode === null) {
 351             return;
 352         }
 353
 354         shell_exec('stty ' . escapeshellarg($this->lastTTYMode));
 355     }
 356
 357     /**
 358      * Change TTY (Console) mode
 359      *
 360      * @link  http://en.wikipedia.org/wiki/Stty
 361      * @param $mode
 362      */
 363     protected function setTTYMode($mode)
 364     {
 365         // Store last mode
 366         $this->lastTTYMode = trim(`stty -g`);
 367
 368         // Set new mode
 369         shell_exec('stty '.escapeshellcmd($mode));
 370     }
 371
 372     /**
 373      * Get the final color code and throw exception on error
 374      *
 375      * @param  null|int|Xterm256 $color
 376      * @throws Exception\BadMethodCallException
 377      * @return string
 378      */
 379     protected function getColorCode($color, $type = 'fg')
 380     {
 381         if ($color instanceof Xterm256) {
 382             $r    = new ReflectionClass($color);
 383             $code = $r->getStaticPropertyValue('color');
 384             if ($type == 'fg') {
 385                 $code = sprintf($code, $color::FOREGROUND);
 386             } else {
 387                 $code = sprintf($code, $color::BACKGROUND);
 388             }
 389             return $code;
 390         }
 391
 392         if ($color !== null) {
 393             if (!isset(static::$ansiColorMap[$type][$color])) {
 394                 throw new Exception\BadMethodCallException(sprintf(
 395                         'Unknown color "%s". Please use one of the Zend\Console\ColorInterface constants or use Zend\Console\Color\Xterm256::calculate',
 396                         $color
 397                 ));
 398             }
 399
 400             return static::$ansiColorMap[$type][$color];
 401         }
 402
 403         return null;
 404     }
 405 }