{

use InputOutputTrait, SimpleEventTrait;

/**

protected static $internalCommands = [

'version' => 'Show application version information',

'help' => 'Show application help information',

'list' => 'List all group and independent commands',

];

/**

protected static $internalOptions = [

'--debug' => 'Setting the application runtime debug level',

'--profile' => 'Display timing and memory usage information',

'--no-color' => 'Disable color/ANSI for message output',

'-h, --help' => 'Display this help message',

'-V, --version' => 'Show application version information',

];

/**

private $meta = [

'name' => 'My Console',

'debug' => false,

'profile' => false,

'version' => '0.5.1',

'publishAt' => '2017.03.24',

'updateAt' => '2017.03.24',

'rootPath' => '',

'hideRootPath' => true,

// 'timeZone' => 'Asia/Shanghai',

// 'env' => 'pdt', // dev test pdt

// 'charset' => 'UTF-8',

// runtime stats

'_stats' => [],

];

/** @var string Command delimiter. e.g dev:serve */

public $delimiter = ':'; // '/' ':'

/** @var array The group commands */

protected $controllers = [];

/** @var array The independent commands */

protected $commands = [];

/** @var array */

private $commandMessages = [];

/** @var string */

private $commandName;

/**

public function __construct(array $meta = [], Input $input = null, Output $output = null)

{

$this->runtimeCheck();

$this->setMeta($meta);

$this->input = $input ?: new Input();

$this->output = $output ?: new Output();

$this->init();

}

protected function init()

{

$this->meta['_stats'] = [

'startTime' => microtime(1),

'startMemory' => memory_get_usage(true),

];

$this->commandName = $this->input->getCommand();

set_exception_handler([$this, 'handleException']);

}

/**********************************************************

protected function prepareRun()

{

// date_default_timezone_set($this->config('timeZone', 'UTC'));

//new AutoCompletion(array_merge($this->getCommandNames(), $this->getControllerNames()));

}

protected function beforeRun()

{}

/**

public function run($exit = true)

{

$command = trim($this->input->getCommand(), $this->delimiter);

$this->prepareRun();

$this->filterSpecialCommand($command);

// call 'onBeforeRun' service, if it is registered.

self::fire(self::ON_BEFORE_RUN, [$this]);

$this->beforeRun();

// do run ...

try {

$returnCode = $this->dispatch($command);

} catch (\Throwable $e) {

self::fire(self::ON_RUN_ERROR, [$e, $this]);

$returnCode = $e->getCode() === 0 ? $e->getLine() : $e->getCode();

$this->handleException($e);

}

$this->meta['_stats']['endTime'] = microtime(1);

// call 'onAfterRun' service, if it is registered.

self::fire(self::ON_AFTER_RUN, [$this]);

$this->afterRun();

if ($exit) {

$this->stop((int)$returnCode);

}

}

/**

abstract protected function dispatch($command);

/**

abstract public function runCommand($name, $believable = false);

/**

abstract public function runAction($name, $action, $believable = false, $standAlone = false);

protected function afterRun()

{

// display runtime info

if ($this->isProfile()) {

$title = '---------- Runtime Stats(profile=true) ----------';

$stats = $this->meta['_stats'];

$this->meta['_stats'] = Helper::runtime($stats['startTime'], $stats['startMemory'], $stats);

$this->output->write('');

$this->output->aList($this->meta['_stats'], $title);

}

}

/**

public function stop($code = 0)

{

// call 'onAppStop' service, if it is registered.

self::fire(self::ON_STOP_RUN, [$this]);

exit((int)$code);

}

/**********************************************************

/**

protected function runtimeCheck()

{

// check env

if (!\in_array(PHP_SAPI, ['cli', 'cli-server'], true)) {

header('HTTP/1.1 403 Forbidden');

exit(" 403 Forbidden \n\n"

. " current environment is CLI. \n"

. " :( Sorry! Run this script is only allowed in the terminal environment!\n,You are not allowed to access this file.\n");

}

}

/**

public function handleException($e)

{

$type = $e instanceof \Error ? 'Error' : 'Exception';

$title = ":( OO ... An $type Occurred!";

$this->logError($e);

// open debug, throw exception

if ($this->isDebug()) {

$tpl = <<<ERR

ERR;

$message = sprintf(

$tpl,

// $e->getCode(),

$e->getMessage(),

$e->getFile(),

$e->getLine(),

__METHOD__,

$e->getTraceAsString()

);

if ($this->meta['hideRootPath'] && ($rootPath = $this->meta['rootPath'])) {

$message = str_replace($rootPath, '{ROOT}', $message);

}

$this->output->write($message, false);

} else {

// simple output

$this->output->error('An error occurred! MESSAGE: ' . $e->getMessage() . '. you can use --debug to see error details.');

}

}

/**

protected function logError($e)

{

// you can log error on sub class ...

}

/**

protected function filterSpecialCommand($command)

{

if (!$command) {

if ($this->input->getSameOpt(['V', 'version'])) {

$this->showVersionInfo();

}

if ($this->input->getSameOpt(['h', 'help'])) {

$this->showHelpInfo();

}

}

if ($this->input->getSameOpt(['no-color'])) {

Style::setNoColor();

}

$command = $command ?: 'list';

switch ($command) {

case 'help':

$this->showHelpInfo(true, $this->input->getFirstArg());

break;

case 'list':

$this->showCommandList();

break;

case 'version':

$this->showVersionInfo();

break;

}

}

/**

protected function validateName(string $name, $isGroup = false)

{

$pattern = $isGroup ? '/^[a-z][\w-]+$/' : '/^[a-z][\w-]*:?([a-z][\w-]+)?$/';

if (1 !== preg_match($pattern, $name)) {

throw new \InvalidArgumentException('The command name is must match: ' . $pattern);

}

if ($this->isInternalCommand($name)) {

throw new \InvalidArgumentException("The command name [$name] is not allowed. It is a built in command.");

}

}

/***************************************************************************

/**

public function showHelpInfo($quit = true, string $command = null)

{

// display help for a special command

if ($command) {

$this->input->setCommand($command);

$this->input->setSOpt('h', true);

$this->input->clearArgs();

$this->dispatch($command);

$this->stop();

}

$script = $this->input->getScript();

$sep = $this->delimiter;

$this->output->helpPanel([

'usage' => "$script {command} [arg0 arg1=value1 arg2=value2 ...] [--opt -v -h ...]",

'example' => [

"$script test (run a independent command)",

"$script home{$sep}index (run a command of the group)",

"$script help {command} (see a command help information)",

"$script home{$sep}index -h (see a command help of the group)",

]

], $quit);

}

/**

public function showVersionInfo($quit = true)

{

$date = date('Y.m.d');

$name = $this->getMeta('name', 'Console Application');

$version = $this->getMeta('version', 'Unknown');

$publishAt = $this->getMeta('publishAt', 'Unknown');

$updateAt = $this->getMeta('updateAt', 'Unknown');

$phpVersion = PHP_VERSION;

$os = PHP_OS;

$this->output->aList([

"\n <info>{$name}</info>, Version <comment>$version</comment>\n",

'System Info' => "PHP version <info>$phpVersion</info>, on <info>$os</info> system",

'Application Info' => "Update at <info>$updateAt</info>, publish at <info>$publishAt</info>(current $date)",

], null, [

'leftChar' => '',

'sepChar' => ' : '

]);

$quit && $this->stop();

}

/**

public function showCommandList($quit = true)

{

$script = $this->getScriptName();

$hasGroup = $hasCommand = false;

$controllerArr = $commandArr = [];

$desPlaceholder = 'No description of the command';

// all console controllers

$controllerArr[] = PHP_EOL . '- <cyan>Group Commands</cyan>';

$controllers = $this->controllers;

ksort($controllers);

foreach ($controllers as $name => $controller) {

$hasGroup = true;

/** @var AbstractCommand $controller */

$controllerArr[$name] = $controller::getDescription() ?: $desPlaceholder;

}

if (!$hasGroup) {

$controllerArr[] = '... No register any group command(controller)';

}

// all independent commands

$commands = $this->commands;

$commandArr[] = PHP_EOL . '- <cyan>Independent Commands</cyan>';

ksort($commands);

foreach ($commands as $name => $command) {

$desc = $desPlaceholder;

$hasCommand = true;

/** @var AbstractCommand $command */

if (is_subclass_of($command, CommandInterface::class)) {

$desc = $command::getDescription() ?: $desPlaceholder;

} else if ($msg = $this->getCommandMessage($name)) {

$desc = $msg;

} else if (\is_string($command)) {

$desc = 'A handler : ' . $command;

} else if (\is_object($command)) {

$desc = 'A handler by ' . \get_class($command);

}

$commandArr[$name] = $desc;

}

if (!$hasCommand) {

$commandArr[] = '... No register any group command(controller)';

}

// built in commands

$internalCommands = static::$internalCommands;

ksort($internalCommands);

array_unshift($internalCommands, "\n- <cyan>Internal Commands</cyan>");

$this->output->mList([

//'There are all console controllers and independent commands.',

'Usage:' => "$script {command} [arg0 arg1=value1 arg2=value2 ...] [--opt -v -h ...]",

'Options:' => self::$internalOptions,

'Available Commands:' => array_merge($controllerArr, $commandArr, $internalCommands),

//'Independent Commands:' => $commandArr ?: '... No register any independent command',

// 'Internal Commands:' => $internalCommands,

]);

// $this->output->mList([

// //'There are all console controllers and independent commands.',

// 'Usage:' => "$script {command} [arg0 arg1=value1 arg2=value2 ...] [--opt -v -h ...]",

// 'Options:' => self::$internalOptions,

// 'Group Commands:' => $controllerArr ?: '... No register any group command(controller)',

// 'Independent Commands:' => $commandArr ?: '... No register any independent command',

// 'Internal Commands:' => $internalCommands,

// ]);

unset($controllerArr, $commandArr, $internalCommands);

$this->output->write("More command information, please use: <cyan>$script {command} -h</cyan>");

$quit && $this->stop();

}

/**

public function getCommandMessage($name, $default = null)

{

return $this->commandMessages[$name] ?? $default;

}

/**

public function addCommandMessage($name, $message)

{

return $this->commandMessages[$name] = $message;

}

/**********************************************************

/**

public function getControllerNames()

{

return array_keys($this->controllers);

}

/**

public function getCommandNames()

{

return array_keys($this->commands);

}

/**

public function setControllers(array $controllers)

{

foreach ($controllers as $name => $controller) {

if (\is_int($name)) {

$this->controller($controller);

} else {

$this->controller($name, $controller);

}

}

}

/**

public function getControllers(): array

{

return $this->controllers;

}

/**

public function isController($name)

{

return isset($this->controllers[$name]);

}

/**

public function setCommands(array $commands)

{

foreach ($commands as $name => $handler) {

if (\is_int($name)) {

$this->command($handler);

} else {

$this->command($name, $handler);

}

}

}

/**

public function getCommands(): array

{

return $this->commands;

}

/**

public function isCommand($name)

{

return isset($this->commands[$name]);

}

/**

public static function getInternalCommands(): array

{

return static::$internalCommands;

}

/**

public function isInternalCommand(string $name): bool

{

return isset(static::$internalCommands[$name]);

}

/**

public function getName()

{

return $this->meta['name'];

}

/**

public function setMeta(array $meta)

{

if ($meta) {

$this->meta = array_merge($this->meta, $meta);

}

}

/**

public function getMeta($name = null, $default = null)

{

if (!$name) {

return $this->meta;

}

return $this->meta[$name] ?? $default;

}

/**

public function isDebug()

{

return $this->input->getOpt('debug', $this->meta['debug']);

}

/**

public function isProfile()

{

return (bool)$this->input->getOpt('profile', $this->getMeta('profile'));

}

/**

public function getCommandMessages(): array

{

return $this->commandMessages;

}

/**

public function setCommandMessages(array $commandMessages)

{

$this->commandMessages = $commandMessages;

}