
| Current Path : /var/www/html/rocksensor2/vendor/consolidation/site-process/src/ |
Linux ift1.ift-informatik.de 5.4.0-216-generic #236-Ubuntu SMP Fri Apr 11 19:53:21 UTC 2025 x86_64 |
| Current File : /var/www/html/rocksensor2/vendor/consolidation/site-process/src/ProcessBase.php |
<?php
namespace Consolidation\SiteProcess;
use Psr\Log\LoggerInterface;
use Symfony\Component\Console\Style\OutputStyle;
use Symfony\Component\Process\Process;
use Consolidation\SiteProcess\Util\RealtimeOutputHandler;
use Consolidation\SiteProcess\Util\Escape;
use Symfony\Component\Console\Output\OutputInterface;
use Symfony\Component\Console\Output\ConsoleOutputInterface;
/**
* A wrapper around Symfony Process.
*
* - Supports simulated mode. Typically enabled via a --simulate option.
* - Supports verbose mode - logs all runs.
* - Can convert output json data into php array (convenience method)
* - Provides a "realtime output" helper
*/
class ProcessBase extends Process
{
/**
* @var OutputStyle
*/
protected $output;
/**
* @var OutputInterface
*/
protected $stderr;
private $simulated = false;
private $verbose = false;
/**
* @var LoggerInterface
*/
private $logger;
/**
* realtimeStdout returns the output stream that realtime output
* should be sent to (if applicable)
*
* @return OutputStyle $output
*/
public function realtimeStdout()
{
return $this->output;
}
protected function realtimeStderr()
{
if ($this->stderr) {
return $this->stderr;
}
if (method_exists($this->output, 'getErrorStyle')) {
return $this->output->getErrorStyle();
}
return $this->realtimeStdout();
}
/**
* setRealtimeOutput allows the caller to inject an OutputStyle object
* that will be used to stream realtime output if applicable.
*
* @param OutputStyle $output
*/
public function setRealtimeOutput(OutputInterface $output, $stderr = null)
{
$this->output = $output;
$this->stderr = $stderr instanceof ConsoleOutputInterface ? $stderr->getErrorOutput() : $stderr;
}
/**
* @return bool
*/
public function isVerbose()
{
return $this->verbose;
}
/**
* @param bool $verbose
*/
public function setVerbose($verbose)
{
$this->verbose = $verbose;
}
/**
* @return bool
*/
public function isSimulated()
{
return $this->simulated;
}
/**
* @param bool $simulated
*/
public function setSimulated($simulated)
{
$this->simulated = $simulated;
}
/**
* @return LoggerInterface
*/
public function getLogger()
{
return $this->logger;
}
/**
* @param LoggerInterface $logger
*/
public function setLogger($logger)
{
$this->logger = $logger;
}
/**
* @inheritDoc
*/
public function start(?callable $callback = null, array $env = []): void
{
$cmd = $this->getCommandLine();
if ($this->isSimulated()) {
$this->getLogger()->notice('Simulating: ' . $cmd);
// Run a command that always succeeds (on Linux and Windows).
$this->overrideCommandLine('true');
} elseif ($this->isVerbose()) {
$this->getLogger()->info('Executing: ' . $cmd);
}
parent::start($callback, $env);
// Set command back to original value in case anyone asks.
if ($this->isSimulated()) {
$this->overrideCommandLine($cmd);
}
}
/**
* Get Process output and decode its JSON.
*
* @return array
* An associative array.
*/
public function getOutputAsJson()
{
$output = trim($this->getOutput());
if (empty($output)) {
throw new \InvalidArgumentException('Output is empty.');
}
if (Escape::isWindows()) {
// Doubled double quotes were converted to \\".
// Revert to double quote.
$output = str_replace('\\"', '"', $output);
// Revert of doubled backslashes.
$output = preg_replace('#\\\\{2}#', '\\', $output);
}
$sanitizedOutput = $this->removeNonJsonJunk($output);
$json = json_decode($sanitizedOutput, true);
if (!isset($json)) {
$msg = 'Unable to decode output into JSON: ' . json_last_error_msg();
if (json_last_error() == JSON_ERROR_SYNTAX) {
$msg .= "\n\n$output";
}
throw new \InvalidArgumentException($msg);
}
return $json;
}
/**
* Allow for a certain amount of resiliancy in the output received when
* json is expected.
*
* @param string $data
* @return string
*/
protected function removeNonJsonJunk($data)
{
// Exit early if we have no output.
$data = trim($data);
if (empty($data)) {
return $data;
}
// If the data is a simple quoted string, or an array, then exit.
if ((($data[0] == '"') && ($data[strlen($data) - 1] == '"')) ||
(($data[0] == "[") && ($data[strlen($data) - 1] == "]"))
) {
return $data;
}
// If the json is not a simple string or a simple array, then is must
// be an associative array. We will remove non-json garbage characters
// before and after the enclosing curley-braces.
$start = strpos($data, '{');
$end = strrpos($data, '}') + 1;
$data = substr($data, $start, $end - $start);
return $data;
}
/**
* Return a realTime output object.
*
* @return callable
*/
public function showRealtime()
{
$realTimeOutput = new RealtimeOutputHandler($this->realtimeStdout(), $this->realtimeStderr());
$realTimeOutput->configure($this);
return $realTimeOutput;
}
/**
* Overrides the command line to be executed.
*
* @param string|array $commandline The command to execute
*
* @return $this
*
* @todo refactor library so this hack to get around changes in
* symfony/process 5 is unnecessary.
*/
private function overrideCommandLine($commandline)
{
$commandlineSetter = function ($commandline) {
$this->commandline = $commandline;
};
$commandlineSetter->bindTo($this, Process::class)($commandline);
return $this;
}
}