1: 2: 3: 4: 5: 6: 7: 8: 9: 10: 11: 12: 13: 14: 15: 16: 17: 18: 19: 20: 21: 22: 23: 24: 25: 26: 27: 28: 29: 30: 31: 32: 33: 34: 35: 36: 37: 38: 39: 40: 41: 42: 43: 44: 45: 46: 47: 48: 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: 244: 245: 246: 247: 248: 249: 250: 251: 252: 253: 254: 255: 256: 257: 258: 259: 260: 261: 262: 263: 264: 265: 266: 267: 268: 269: 270: 271: 272: 273: 274: 275: 276: 277: 278: 279: 280: 281: 282: 283: 284: 285: 286: 287: 288: 289: 290: 291: 292: 293: 294: 295: 296: 297: 298: 299: 300: 301: 302: 303: 304: 305: 306: 307: 308: 309: 310: 311: 312: 313: 314: 315: 316: 317: 318: 319: 320: 321: 322: 323: 324: 325: 326: 327: 328: 329: 330: 331: 332: 333: 334: 335: 336: 337: 338: 339: 340: 341: 342: 343: 344: 345: 346: 347: 348: 349: 350: 351: 352: 353: 354: 355: 356: 357: 358: 359: 360: 361: 362: 363: 364: 365: 366: 367: 368: 369: 370: 371: 372: 373: 374: 375: 376: 377: 378: 379: 380: 381: 382: 383: 384: 385: 386: 387: 388: 389: 390: 391: 392: 393: 394: 395: 396: 397: 398: 399: 400: 401: 402: 403: 404: 405: 406: 407: 408: 409: 410: 411: 412: 413: 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: 440: 441: 442: 443: 444: 445: 446: 447: 448: 449: 450: 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: 483: 484: 485: 486: 487: 488: 489: 490: 491: 492: 493: 494: 495: 496: 497: 498: 499: 500: 501: 502: 503: 504: 505:
<?php
namespace Webmozart\Console\Api\Command;
use Exception;
use LogicException;
use Symfony\Component\EventDispatcher\EventDispatcherInterface;
use Webmozart\Console\Api\Application\Application;
use Webmozart\Console\Api\Args\Args;
use Webmozart\Console\Api\Args\CannotParseArgsException;
use Webmozart\Console\Api\Args\Format\ArgsFormat;
use Webmozart\Console\Api\Args\RawArgs;
use Webmozart\Console\Api\Config\CommandConfig;
use Webmozart\Console\Api\Config\OptionCommandConfig;
use Webmozart\Console\Api\Config\SubCommandConfig;
use Webmozart\Console\Api\Event\ConsoleEvents;
use Webmozart\Console\Api\Event\PreHandleEvent;
use Webmozart\Console\Api\IO\IO;
use Webmozart\Console\Util\ProcessTitle;
class Command
{
private $name;
private $shortName;
private $aliases = array();
private $config;
private $argsFormat;
private $application;
private $parentCommand;
private $subCommands;
private $namedSubCommands;
private $defaultSubCommands;
private $dispatcher;
public function __construct(CommandConfig $config, Application $application = null, Command $parentCommand = null)
{
if (!$config->getName()) {
throw new LogicException('The name of the command config must be set.');
}
$this->name = $config->getName();
$this->shortName = $config instanceof OptionCommandConfig ? $config->getShortName() : null;
$this->aliases = $config->getAliases();
$this->config = $config;
$this->application = $application;
$this->parentCommand = $parentCommand;
$this->subCommands = new CommandCollection();
$this->namedSubCommands = new CommandCollection();
$this->defaultSubCommands = new CommandCollection();
$this->argsFormat = $config->buildArgsFormat($this->getBaseFormat());
$this->dispatcher = $application ? $application->getConfig()->getEventDispatcher() : null;
foreach ($config->getSubCommandConfigs() as $subConfig) {
$this->addSubCommand($subConfig);
}
}
public function getName()
{
return $this->name;
}
public function getShortName()
{
return $this->shortName;
}
public function getAliases()
{
return $this->aliases;
}
public function hasAliases()
{
return count($this->aliases) > 0;
}
public function getConfig()
{
return $this->config;
}
public function getArgsFormat()
{
return $this->argsFormat;
}
public function getApplication()
{
return $this->application;
}
public function getParentCommand()
{
return $this->parentCommand;
}
public function getSubCommands()
{
return $this->subCommands;
}
public function getSubCommand($name)
{
return $this->subCommands->get($name);
}
public function hasSubCommand($name)
{
return $this->subCommands->contains($name);
}
public function hasSubCommands()
{
return !$this->subCommands->isEmpty();
}
public function getNamedSubCommands()
{
return $this->namedSubCommands;
}
public function hasNamedSubCommands()
{
return count($this->namedSubCommands) > 0;
}
public function getDefaultSubCommands()
{
return $this->defaultSubCommands;
}
public function hasDefaultSubCommands()
{
return count($this->defaultSubCommands) > 0;
}
public function parseArgs(RawArgs $args, $lenient = null)
{
if (null === $lenient) {
$lenient = $this->config->isLenientArgsParsingEnabled();
}
return $this->config->getArgsParser()->parseArgs($args, $this->argsFormat, $lenient);
}
public function run(RawArgs $args, IO $io)
{
return $this->handle($this->parseArgs($args), $io);
}
public function handle(Args $args, IO $io)
{
$processTitle = $this->config->getProcessTitle();
$this->warnIfProcessTitleNotSupported($processTitle, $io);
if ($processTitle && ProcessTitle::isSupported()) {
ProcessTitle::setProcessTitle($processTitle);
try {
$statusCode = $this->doHandle($args, $io);
} catch (Exception $e) {
ProcessTitle::resetProcessTitle();
throw $e;
}
ProcessTitle::resetProcessTitle();
} else {
$statusCode = $this->doHandle($args, $io);
}
if (!$statusCode) {
return 0;
}
return min(max((int) $statusCode, 1), 255);
}
private function getBaseFormat()
{
if ($this->parentCommand) {
return $this->parentCommand->getArgsFormat();
}
if ($this->application) {
return $this->application->getGlobalArgsFormat();
}
return null;
}
private function addSubCommand(SubCommandConfig $config)
{
if (!$config->isEnabled()) {
return;
}
$this->validateSubCommandName($config);
$command = new self($config, $this->application, $this);
$this->subCommands->add($command);
if ($config->isDefault()) {
$this->defaultSubCommands->add($command);
}
if (!$config->isAnonymous()) {
$this->namedSubCommands->add($command);
}
}
private function warnIfProcessTitleNotSupported($processTitle, IO $io)
{
if ($processTitle && !ProcessTitle::isSupported()) {
$io->errorLine(
'<warn>Notice: Install the proctitle PECL to be able to change the process title.</warn>',
IO::VERY_VERBOSE
);
}
}
private function validateSubCommandName(SubCommandConfig $config)
{
$name = $config->getName();
if (!$name) {
throw CannotAddCommandException::nameEmpty();
}
if ($this->subCommands->contains($name)) {
throw CannotAddCommandException::nameExists($name);
}
if ($config instanceof OptionCommandConfig) {
if ($this->argsFormat->hasOption($name)) {
throw CannotAddCommandException::optionExists($name);
}
if ($shortName = $config->getShortName()) {
if ($this->subCommands->contains($shortName)) {
throw CannotAddCommandException::nameExists($name);
}
if ($this->argsFormat->hasOption($shortName)) {
throw CannotAddCommandException::optionExists($shortName);
}
}
}
}
private function doHandle(Args $args, IO $io)
{
if ($this->dispatcher && $this->dispatcher->hasListeners(ConsoleEvents::PRE_HANDLE)) {
$event = new PreHandleEvent($args, $io, $this);
$this->dispatcher->dispatch(ConsoleEvents::PRE_HANDLE, $event);
if ($event->isHandled()) {
return $event->getStatusCode();
}
}
$commandHandler = $this->config->getHandler();
$handlerMethod = $this->config->getHandlerMethod();
return $commandHandler->$handlerMethod($args, $io, $this);
}
}