-
-
Notifications
You must be signed in to change notification settings - Fork 1.1k
/
DrushCommands.php
156 lines (138 loc) · 4.52 KB
/
DrushCommands.php
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
<?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\Style\DrushStyle;
use GuzzleHttp\HandlerStack;
use GuzzleHttp\MessageFormatter;
use GuzzleHttp\Middleware;
use Psr\Log\LoggerAwareInterface;
use Psr\Log\LoggerAwareTrait;
use Psr\Log\LoggerInterface;
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
{
if (!$this->io) {
// Specify our own Style class when needed.
$this->io = new DrushStyle($this->input(), $this->output());
}
return $this->io;
}
/**
* Sets a logger, if none is available yet.
*
* @param LoggerInterface $logger
*/
public function setLoggerIfEmpty(LoggerInterface $logger): void
{
if ($this->logger === NULL) {
$this->setLogger($logger);
}
}
/**
* Returns a logger object.
*/
protected function logger(): ?DrushLoggerManager
{
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;
}
/**
* Persist commandData for use in primary command callback. Used by 'topic' commands.
*/
#[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;
}
}