
| Current Path : /var/www/html/sirius-pallets/vendor/drush/drush/src/Commands/ |
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/sirius-pallets/vendor/drush/drush/src/Commands/DrushCommands.php |
<?php
declare(strict_types=1);
namespace Drush\Commands;
use Consolidation\AnnotatedCommand\AnnotationData;
use Consolidation\AnnotatedCommand\CommandData;
use Consolidation\AnnotatedCommand\Hooks\HookManager;
use Consolidation\SiteProcess\ProcessManagerAwareInterface;
use Consolidation\SiteProcess\ProcessManagerAwareTrait;
use Drush\Attributes as CLI;
use Drush\Config\ConfigAwareTrait;
use Drush\Drush;
use Drush\Exec\ExecTrait;
use Drush\Log\DrushLoggerManager;
use Drush\SiteAlias\ProcessManager;
use Drush\Style\DrushStyle;
use GuzzleHttp\HandlerStack;
use GuzzleHttp\MessageFormatter;
use GuzzleHttp\Middleware;
use Psr\Log\LoggerAwareInterface;
use Psr\Log\LoggerAwareTrait;
use Robo\Common\IO;
use Robo\Contract\ConfigAwareInterface;
use Robo\Contract\IOAwareInterface;
use Symfony\Component\Console\Input\InputOption;
use Symfony\Component\Filesystem\Path;
abstract class DrushCommands implements IOAwareInterface, LoggerAwareInterface, ConfigAwareInterface, ProcessManagerAwareInterface
{
use ProcessManagerAwareTrait;
use ExecTrait;
use ConfigAwareTrait;
use LoggerAwareTrait;
use IO {
io as roboIo;
}
use ConfiguresPrompts;
// This is more readable.
const REQ = InputOption::VALUE_REQUIRED;
const OPT = InputOption::VALUE_OPTIONAL;
// Common exit codes.
const EXIT_SUCCESS = 0;
const EXIT_FAILURE = 1;
// Used to signal that the command completed successfully, but we still want to indicate a failure to the caller.
const EXIT_FAILURE_WITH_CLARITY = 3;
protected ?CommandData $commandData = null;
public function __construct()
{
}
/**
* Override Robo's IO function with our custom style.
*/
protected function io(): DrushStyle
{
// @phpstan-ignore booleanNot.alwaysFalse
if (!$this->io) {
// Specify our own Style class when needed.
$this->io = new DrushStyle($this->input(), $this->output());
}
assert($this->io instanceof DrushStyle);
return $this->io;
}
/**
* Returns a logger object.
*/
public function logger(): ?DrushLoggerManager
{
assert(is_null($this->logger) || $this->logger instanceof DrushLoggerManager, 'Instead of using replacing Drush\'s logger, use $this->add() on DrushLoggerManager to add a custom logger. See https://github.com/drush-ops/drush/pull/5022');
return $this->logger;
}
/**
* Print the contents of a file.
*
* @param string $file
* Full path to a file.
*/
protected function printFile(string $file): void
{
if (str_ends_with($file, ".htm") || str_ends_with($file, ".html")) {
$tmp_file = drush_tempnam(basename($file));
file_put_contents($tmp_file, drush_html_to_text(file_get_contents($file)));
$file = $tmp_file;
}
if (self::input()->isInteractive()) {
if (self::programExists('less')) {
$process = $this->processManager()->process(['less', $file])->setTty(true);
if ($process->run() === 0) {
return;
}
}
}
$this->output()->writeln(file_get_contents($file));
}
/**
* Persist commandData for use in primary command callback. Used by 'topic' commands.
*/
#[CLI\Hook(type: HookManager::PRE_COMMAND_HOOK, target: '*')]
public function preHook(CommandData $commandData)
{
$this->commandData = $commandData;
}
/**
* Configure Laravel prompts package.
*/
#[CLI\Hook(type: HookManager::INITIALIZE, target: '*')]
public function initHook($input, AnnotationData $annotationData)
{
$this->configurePrompts($input);
}
/**
* Print the contents of a file. The path comes from the @topic annotation.
*
* @param CommandData $commandData
* Full path to a file.
*/
protected function printFileTopic(CommandData $commandData)
{
$file = $commandData->annotationData()->get('topic');
$this->printFile(Path::makeAbsolute($file, dirname($commandData->annotationData()->get('_path'))));
}
/**
* Get a Guzzle handler stack that uses the Drush logger.
*
* @see https://stackoverflow.com/questions/32681165/how-do-you-log-all-api-calls-using-guzzle-6.
*/
protected function getStack(): HandlerStack
{
$stack = HandlerStack::create();
$stack->push(Middleware::log($this->logger(), new MessageFormatter(Drush::debug() ? MessageFormatter::DEBUG : MessageFormatter::SHORT)));
return $stack;
}
/**
* This method overrides the trait in order to provide a more specific return type.
*/
public function processManager(): ProcessManager
{
return $this->processManager;
}
}