Edit File by line

<?php

[0] Fix | Delete

[1] Fix | Delete

namespace AmpProject\Cli;

[2] Fix | Delete

[3] Fix | Delete

use AmpProject\Exception\AmpCliException;

[4] Fix | Delete

use AmpProject\Exception\Cli\InvalidSapi;

[5] Fix | Delete

use Exception;

[6] Fix | Delete

[7] Fix | Delete

/**

[8] Fix | Delete

* This file is adapted from the splitbrain\php-cli library, which is authored by Andreas Gohr <andi@splitbrain.org> and

[9] Fix | Delete

* licensed under the MIT license.

[10] Fix | Delete

[11] Fix | Delete

* Source: https://github.com/splitbrain/php-cli/blob/fb4f888866d090b10e3e68292d197ca274cea626/src/CLI.php

[12] Fix | Delete

[13] Fix | Delete

[14] Fix | Delete

/**

[15] Fix | Delete

* Your commandline script should inherit from this class and implement the abstract methods.

[16] Fix | Delete

[17] Fix | Delete

* @package ampproject/amp-toolbox

[18] Fix | Delete

[19] Fix | Delete

abstract class Executable

[20] Fix | Delete

{

[21] Fix | Delete

[22] Fix | Delete

/**

[23] Fix | Delete

* Instance of the Colors helper object.

[24] Fix | Delete

[25] Fix | Delete

* @var Colors

[26] Fix | Delete

[27] Fix | Delete

public $colors;

[28] Fix | Delete

[29] Fix | Delete

/**

[30] Fix | Delete

* The executable script itself.

[31] Fix | Delete

[32] Fix | Delete

* @var string

[33] Fix | Delete

[34] Fix | Delete

protected $bin;

[35] Fix | Delete

[36] Fix | Delete

/**

[37] Fix | Delete

* Instance of the options parser to use.

[38] Fix | Delete

[39] Fix | Delete

* @var Options

[40] Fix | Delete

[41] Fix | Delete

protected $options;

[42] Fix | Delete

[43] Fix | Delete

/**

[44] Fix | Delete

* PSR-3 compatible log levels and their prefix, color, output channel.

[45] Fix | Delete

[46] Fix | Delete

* @var array<array>

[47] Fix | Delete

[48] Fix | Delete

protected $loglevels = [

[49] Fix | Delete

LogLevel::DEBUG => ['', Colors::C_RESET, STDOUT],

[50] Fix | Delete

LogLevel::INFO => ['ℹ ', Colors::C_CYAN, STDOUT],

[51] Fix | Delete

LogLevel::NOTICE => ['☛ ', Colors::C_CYAN, STDOUT],

[52] Fix | Delete

LogLevel::SUCCESS => ['✓ ', Colors::C_GREEN, STDOUT],

[53] Fix | Delete

LogLevel::WARNING => ['⚠ ', Colors::C_BROWN, STDERR],

[54] Fix | Delete

LogLevel::ERROR => ['✗ ', Colors::C_RED, STDERR],

[55] Fix | Delete

LogLevel::CRITICAL => ['☠ ', Colors::C_LIGHTRED, STDERR],

[56] Fix | Delete

LogLevel::ALERT => ['✖ ', Colors::C_LIGHTRED, STDERR],

[57] Fix | Delete

LogLevel::EMERGENCY => ['✘ ', Colors::C_LIGHTRED, STDERR],

[58] Fix | Delete

];

[59] Fix | Delete

[60] Fix | Delete

/**

[61] Fix | Delete

* Default log level.

[62] Fix | Delete

[63] Fix | Delete

* @var string

[64] Fix | Delete

[65] Fix | Delete

protected $loglevel = 'info';

[66] Fix | Delete

[67] Fix | Delete

/**

[68] Fix | Delete

* Constructor.

[69] Fix | Delete

[70] Fix | Delete

* Initialize the arguments, set up helper classes and set up the CLI environment.

[71] Fix | Delete

[72] Fix | Delete

* @param bool $autocatch Optional. Whether exceptions should be caught and handled automatically. Defaults

[73] Fix | Delete

* to true.

[74] Fix | Delete

* @param Options|null $options Optional. Instance of the Options object to use. Defaults to null to instantiate a

[75] Fix | Delete

* new one.

[76] Fix | Delete

* @param Colors|null $colors Optional. Instance of the Colors object to use. Defaults to null to instantiate a

[77] Fix | Delete

* new one.

[78] Fix | Delete

[79] Fix | Delete

public function __construct($autocatch = true, Options $options = null, Colors $colors = null)

[80] Fix | Delete

{

[81] Fix | Delete

if ($autocatch) {

[82] Fix | Delete

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

[83] Fix | Delete

}

[84] Fix | Delete

[85] Fix | Delete

$this->colors = $colors instanceof Colors ? $colors : new Colors();

[86] Fix | Delete

$this->options = $options instanceof Options ? $options : new Options($this->colors);

[87] Fix | Delete

}

[88] Fix | Delete

[89] Fix | Delete

/**

[90] Fix | Delete

* Execute the CLI program.

[91] Fix | Delete

[92] Fix | Delete

* Executes the setup() routine, adds default options, initiate the options parsing and argument checking

[93] Fix | Delete

* and finally executes main() - Each part is split into their own protected function below, so behaviour

[94] Fix | Delete

* can easily be overwritten.

[95] Fix | Delete

[96] Fix | Delete

* @param bool $exitOnCompletion Optional. Whether to exit on completion. Defaults to true.

[97] Fix | Delete

* @throws InvalidSapi If a SAPI other than 'cli' is detected.

[98] Fix | Delete

[99] Fix | Delete

public function run($exitOnCompletion = true)

[100] Fix | Delete

{

[101] Fix | Delete

$sapi = php_sapi_name();

[102] Fix | Delete

[103] Fix | Delete

if ('cli' !== $sapi) {

[104] Fix | Delete

throw InvalidSapi::forSapi($sapi);

[105] Fix | Delete

}

[106] Fix | Delete

[107] Fix | Delete

$this->setup($this->options);

[108] Fix | Delete

$this->registerDefaultOptions();

[109] Fix | Delete

$this->parseOptions();

[110] Fix | Delete

$this->handleDefaultOptions();

[111] Fix | Delete

$this->setupLogging();

[112] Fix | Delete

$this->checkArguments();

[113] Fix | Delete

$this->execute();

[114] Fix | Delete

[115] Fix | Delete

if ($exitOnCompletion) {

[116] Fix | Delete

exit(0);

[117] Fix | Delete

}

[118] Fix | Delete

}

[119] Fix | Delete

[120] Fix | Delete

/**

[121] Fix | Delete

* Exits the program on a fatal error.

[122] Fix | Delete

[123] Fix | Delete

* @param Exception|string $error Either an exception or an error message.

[124] Fix | Delete

* @param array $context Optional. Associative array of contextual information. Defaults to an empty

[125] Fix | Delete

* array.

[126] Fix | Delete

[127] Fix | Delete

public function fatal($error, array $context = [])

[128] Fix | Delete

{

[129] Fix | Delete

$code = 0;

[130] Fix | Delete

[131] Fix | Delete

if ($error instanceof Exception) {

[132] Fix | Delete

$this->debug(get_class($error) . ' caught in ' . $error->getFile() . ':' . $error->getLine());

[133] Fix | Delete

$this->debug($error->getTraceAsString());

[134] Fix | Delete

$code = $error->getCode();

[135] Fix | Delete

$error = $error->getMessage();

[136] Fix | Delete

}

[137] Fix | Delete

[138] Fix | Delete

if (! $code) {

[139] Fix | Delete

$code = AmpCliException::E_ANY;

[140] Fix | Delete

}

[141] Fix | Delete

[142] Fix | Delete

$this->critical($error, $context);

[143] Fix | Delete

[144] Fix | Delete

exit($code);

[145] Fix | Delete

}

[146] Fix | Delete

[147] Fix | Delete

/**

[148] Fix | Delete

* System is unusable.

[149] Fix | Delete

[150] Fix | Delete

* @param string $message Log message.

[151] Fix | Delete

* @param array $context Optional. Contextual information. Defaults to an empty array.

[152] Fix | Delete

* @return void

[153] Fix | Delete

[154] Fix | Delete

public function emergency($message, array $context = [])

[155] Fix | Delete

{

[156] Fix | Delete

$this->log(LogLevel::EMERGENCY, $message, $context);

[157] Fix | Delete

}

[158] Fix | Delete

[159] Fix | Delete

/**

[160] Fix | Delete

* Action must be taken immediately.

[161] Fix | Delete

[162] Fix | Delete

* Example: Entire website down, database unavailable, etc. This should trigger the SMS alerts and wake you up.

[163] Fix | Delete

[164] Fix | Delete

* @param string $message Log message.

[165] Fix | Delete

* @param array $context Optional. Contextual information. Defaults to an empty array.

[166] Fix | Delete

* @return void

[167] Fix | Delete

[168] Fix | Delete

public function alert($message, array $context = [])

[169] Fix | Delete

{

[170] Fix | Delete

$this->log(LogLevel::ALERT, $message, $context);

[171] Fix | Delete

}

[172] Fix | Delete

[173] Fix | Delete

/**

[174] Fix | Delete

* Critical conditions.

[175] Fix | Delete

[176] Fix | Delete

* Example: Application component unavailable, unexpected exception.

[177] Fix | Delete

[178] Fix | Delete

* @param string $message Log message.

[179] Fix | Delete

* @param array $context Optional. Contextual information. Defaults to an empty array.

[180] Fix | Delete

* @return void

[181] Fix | Delete

[182] Fix | Delete

public function critical($message, array $context = [])

[183] Fix | Delete

{

[184] Fix | Delete

$this->log(LogLevel::CRITICAL, $message, $context);

[185] Fix | Delete

}

[186] Fix | Delete

[187] Fix | Delete

/**

[188] Fix | Delete

* Runtime errors that do not require immediate action but should typically be logged and monitored.

[189] Fix | Delete

[190] Fix | Delete

* @param string $message Log message.

[191] Fix | Delete

* @param array $context Optional. Contextual information. Defaults to an empty array.

[192] Fix | Delete

* @return void

[193] Fix | Delete

[194] Fix | Delete

public function error($message, array $context = [])

[195] Fix | Delete

{

[196] Fix | Delete

$this->log(LogLevel::ERROR, $message, $context);

[197] Fix | Delete

}

[198] Fix | Delete

[199] Fix | Delete

/**

[200] Fix | Delete

* Exceptional occurrences that are not errors.

[201] Fix | Delete

[202] Fix | Delete

* Example: Use of deprecated APIs, poor use of an API, undesirable things that are not necessarily wrong.

[203] Fix | Delete

[204] Fix | Delete

* @param string $message Log message.

[205] Fix | Delete

* @param array $context Optional. Contextual information. Defaults to an empty array.

[206] Fix | Delete

* @return void

[207] Fix | Delete

[208] Fix | Delete

public function warning($message, array $context = [])

[209] Fix | Delete

{

[210] Fix | Delete

$this->log(LogLevel::WARNING, $message, $context);

[211] Fix | Delete

}

[212] Fix | Delete

[213] Fix | Delete

/**

[214] Fix | Delete

* Normal, positive outcome.

[215] Fix | Delete

[216] Fix | Delete

* @param string $string

[217] Fix | Delete

* @param array $context

[218] Fix | Delete

* @return void

[219] Fix | Delete

[220] Fix | Delete

public function success($string, array $context = [])

[221] Fix | Delete

{

[222] Fix | Delete

$this->log(LogLevel::SUCCESS, $string, $context);

[223] Fix | Delete

}

[224] Fix | Delete

[225] Fix | Delete

/**

[226] Fix | Delete

* Normal but significant events.

[227] Fix | Delete

[228] Fix | Delete

* @param string $message Log message.

[229] Fix | Delete

* @param array $context Optional. Contextual information. Defaults to an empty array.

[230] Fix | Delete

* @return void

[231] Fix | Delete

[232] Fix | Delete

public function notice($message, array $context = [])

[233] Fix | Delete

{

[234] Fix | Delete

$this->log(LogLevel::NOTICE, $message, $context);

[235] Fix | Delete

}

[236] Fix | Delete

[237] Fix | Delete

/**

[238] Fix | Delete

* Interesting events.

[239] Fix | Delete

[240] Fix | Delete

* Example: User logs in, SQL logs.

[241] Fix | Delete

[242] Fix | Delete

* @param string $message Log message.

[243] Fix | Delete

* @param array $context Optional. Contextual information. Defaults to an empty array.

[244] Fix | Delete

* @return void

[245] Fix | Delete

[246] Fix | Delete

public function info($message, array $context = [])

[247] Fix | Delete

{

[248] Fix | Delete

$this->log(LogLevel::INFO, $message, $context);

[249] Fix | Delete

}

[250] Fix | Delete

[251] Fix | Delete

/**

[252] Fix | Delete

* Detailed debug information.

[253] Fix | Delete

[254] Fix | Delete

* @param string $message Log message.

[255] Fix | Delete

* @param array $context Optional. Contextual information. Defaults to an empty array.

[256] Fix | Delete

* @return void

[257] Fix | Delete

[258] Fix | Delete

public function debug($message, array $context = [])

[259] Fix | Delete

{

[260] Fix | Delete

$this->log(LogLevel::DEBUG, $message, $context);

[261] Fix | Delete

}

[262] Fix | Delete

[263] Fix | Delete

/**

[264] Fix | Delete

* Log a message of a given log level to the logs.

[265] Fix | Delete

[266] Fix | Delete

* @param string $level Log level to use.

[267] Fix | Delete

* @param string $message Log message.

[268] Fix | Delete

* @param array $context Optional. Contextual information. Defaults to an empty array.

[269] Fix | Delete

* @return void

[270] Fix | Delete

[271] Fix | Delete

public function log($level, $message, array $context = [])

[272] Fix | Delete

{

[273] Fix | Delete

if (! LogLevel::matches($level, $this->options->getOption('loglevel', $this->loglevel))) {

[274] Fix | Delete

return;

[275] Fix | Delete

}

[276] Fix | Delete

[277] Fix | Delete

list($prefix, $color, $channel) = $this->loglevels[$level];

[278] Fix | Delete

[279] Fix | Delete

if (! $this->colors->isEnabled()) {

[280] Fix | Delete

$prefix = '';

[281] Fix | Delete

}

[282] Fix | Delete

[283] Fix | Delete

$message = $this->interpolate($message, $context);

[284] Fix | Delete

[285] Fix | Delete

$this->colors->line($prefix . $message, $color, $channel);

[286] Fix | Delete

}

[287] Fix | Delete

[288] Fix | Delete

/**

[289] Fix | Delete

* Interpolates context values into the message placeholders.

[290] Fix | Delete

[291] Fix | Delete

* @param string $message Message to interpolate.

[292] Fix | Delete

* @param array $context Optional. Contextual information. Defaults to an empty array.

[293] Fix | Delete

* @return string Interpolated string.

[294] Fix | Delete

[295] Fix | Delete

protected function interpolate($message, array $context = [])

[296] Fix | Delete

{

[297] Fix | Delete

// Build a replacement array with braces around the context keys.

[298] Fix | Delete

$replace = [];

[299] Fix | Delete

foreach ($context as $key => $val) {

[300] Fix | Delete

// Check that the value can be cast to string.

[301] Fix | Delete

if (

[302] Fix | Delete

! is_array($val)

[303] Fix | Delete

[304] Fix | Delete

(

[305] Fix | Delete

! is_object($val)

[306] Fix | Delete

|| method_exists($val, '__toString')

[307] Fix | Delete

)

[308] Fix | Delete

) {

[309] Fix | Delete

$replace['{' . $key . '}'] = $val;

[310] Fix | Delete

}

[311] Fix | Delete

}

[312] Fix | Delete

[313] Fix | Delete

// Interpolate replacement values into the message and return.

[314] Fix | Delete

return strtr($message, $replace);

[315] Fix | Delete

}

[316] Fix | Delete

[317] Fix | Delete

/**

[318] Fix | Delete

* Add the default help, color and log options.

[319] Fix | Delete

[320] Fix | Delete

protected function registerDefaultOptions()

[321] Fix | Delete

{

[322] Fix | Delete

$this->options->registerOption(

[323] Fix | Delete

'help',

[324] Fix | Delete

'Display this help screen and exit immediately.',

[325] Fix | Delete

'h'

[326] Fix | Delete

);

[327] Fix | Delete

$this->options->registerOption(

[328] Fix | Delete

'no-colors',

[329] Fix | Delete

'Do not use any colors in output. Useful when piping output to other tools or files.'

[330] Fix | Delete

);

[331] Fix | Delete

$this->options->registerOption(

[332] Fix | Delete

'loglevel',

[333] Fix | Delete

"Minimum level of messages to display. Default is {$this->colors->wrap($this->loglevel, Colors::C_CYAN)}."

[334] Fix | Delete

. ' Valid levels are: debug, info, notice, success, warning, error, critical, alert, emergency.',

[335] Fix | Delete

null,

[336] Fix | Delete

'level'

[337] Fix | Delete

);

[338] Fix | Delete

}

[339] Fix | Delete

[340] Fix | Delete

/**

[341] Fix | Delete

* Handle the default options.

[342] Fix | Delete

[343] Fix | Delete

protected function handleDefaultOptions()

[344] Fix | Delete

{

[345] Fix | Delete

if ($this->options->getOption('no-colors')) {

[346] Fix | Delete

$this->colors->disable();

[347] Fix | Delete

}

[348] Fix | Delete

if ($this->options->getOption('help')) {

[349] Fix | Delete

echo $this->options->help();

[350] Fix | Delete

exit(0);

[351] Fix | Delete

}

[352] Fix | Delete

}

[353] Fix | Delete

[354] Fix | Delete

/**

[355] Fix | Delete

* Handle the logging options.

[356] Fix | Delete

[357] Fix | Delete

protected function setupLogging()

[358] Fix | Delete

{

[359] Fix | Delete

$this->loglevel = $this->options->getOption('loglevel', $this->loglevel);

[360] Fix | Delete

[361] Fix | Delete

if (! in_array($this->loglevel, LogLevel::ORDER)) {

[362] Fix | Delete

$this->fatal('Unknown log level');

[363] Fix | Delete

}

[364] Fix | Delete

}

[365] Fix | Delete

[366] Fix | Delete

/**

[367] Fix | Delete

* Wrapper around the option parsing.

[368] Fix | Delete

[369] Fix | Delete

protected function parseOptions()

[370] Fix | Delete

{

[371] Fix | Delete

$this->options->parseOptions();

[372] Fix | Delete

}

[373] Fix | Delete

[374] Fix | Delete

/**

[375] Fix | Delete

* Wrapper around the argument checking.

[376] Fix | Delete

[377] Fix | Delete

protected function checkArguments()

[378] Fix | Delete

{

[379] Fix | Delete

$this->options->checkArguments();

[380] Fix | Delete

}

[381] Fix | Delete

[382] Fix | Delete

/**

[383] Fix | Delete

* Wrapper around main.

[384] Fix | Delete

[385] Fix | Delete

protected function execute()

[386] Fix | Delete

{

[387] Fix | Delete

$this->main($this->options);

[388] Fix | Delete

}

[389] Fix | Delete

[390] Fix | Delete

/**

[391] Fix | Delete

* Register options and arguments on the given $options object.

[392] Fix | Delete

[393] Fix | Delete

* @param Options $options

[394] Fix | Delete

* @return void

[395] Fix | Delete

[396] Fix | Delete

abstract protected function setup(Options $options);

[397] Fix | Delete

[398] Fix | Delete

/**

[399] Fix | Delete

* Main program routine.

[400] Fix | Delete

[401] Fix | Delete

* Arguments and options have been parsed when this is run.

[402] Fix | Delete

[403] Fix | Delete

* @param Options $options

[404] Fix | Delete

* @return void

[405] Fix | Delete

[406] Fix | Delete

abstract protected function main(Options $options);

[407] Fix | Delete

}

[408] Fix | Delete

[409] Fix | Delete