/
Runner.php
232 lines (189 loc) · 6.57 KB
/
Runner.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
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
<?php
/**
* @see \Yaoi\Cli\Command\Runner equals
* @see \Yaoi\Router
* TODO merge them
*/
namespace Yaoi\Cli\Command;
use Yaoi\BaseClass;
use Yaoi\Cli\Response;
use Yaoi\Cli\View\Table;
use Yaoi\Command;
use Yaoi\Command\Exception;
use Yaoi\Io\Content\Heading;
use Yaoi\Io\Content\SubContent;
use Yaoi\Io\Request;
/**
* Class Runner
* @package Yaoi\Cli\Command
* @todo move embedded actions (bash-completion, help, install ...) to separate commands
*/
class Runner extends BaseClass implements \Yaoi\Command\RunnerContract
{
const OPTION_NAME = '--';
const OPTION_SHORT = '-';
const HELP = 'help';
const VERSION = 'version';
const BASH_COMPLETION = 'bash-completion';
const INSTALL = 'install';
const GROUP_MISC = 'Misc';
const GROUP_DEFAULT = 'Options';
/** @var Command */
protected $command;
/** @var \Yaoi\Command\Option[] */
protected $optionsArray;
protected $commandName;
protected $commandDescription;
protected $commandVersion;
public function __construct(Command $command) {
$this->command = $command;
$definition = $command->definition();
$this->commandName = $definition->name;
$this->commandVersion = $definition->version;
$this->commandDescription = $definition->description;
$this->optionsArray = $this->command->optionsArray();
$this->response = new Response();
$command->setResponse($this->response);
}
protected $showHelp;
protected $showVersion;
protected $showBashCompletion;
/** @var Request */
protected $request;
/** @var Response */
protected $response;
/** @var RequestMapper */
protected $reader;
/**
* @var int Skips specified count of tokens at `argv` head, for embedding in application runner
* TODO refactor this to basePath (in array form here) from @see \Yaoi\Router
*/
protected $skipFirstTokens = 0;
public function run(Request $request = null)
{
if (null === $request) {
$request = Request::createAuto();
}
$this->request = $request;
try {
$this->reader = new RequestMapper();
$this->reader->skipFirstTokens = $this->skipFirstTokens;
$this->reader->read($request, $this->command->optionsArray());
} catch (Exception $exception) {
$this->response->error($exception->getMessage());
$this->response->addContent('Use --help to show information.');
return $this;
}
if (!empty($this->reader->values[self::HELP])) {
$this->showHelp();
return $this;
} elseif (!empty($this->reader->values[self::VERSION])) {
$this->showVersion();
return $this;
} elseif (!empty($this->reader->values[self::BASH_COMPLETION])) {
$this->showBashCompletion();
return $this;
} elseif (!empty($this->reader->values[self::INSTALL])) {
// @codeCoverageIgnoreStart
$this->install();
return $this;
// @codeCoverageIgnoreEnd
} else {
foreach ($this->reader->values as $name => $value) {
$this->command->$name = $value;
}
$this->command->performAction();
return $this;
}
}
public function showVersion()
{
if ($this->commandName) {
$versionText = '';
if ($this->commandVersion) {
$versionText .= $this->commandVersion . ' ';
}
$versionText .= $this->commandName;
$this->response->addContent(new Heading($versionText));
}
if ($this->commandDescription) {
$this->response->addContent(new Heading($this->commandDescription));
}
}
public function showBashCompletion()
{
$completion = new Completion($this->command);
$completion->render();
}
public function showHelp()
{
$this->showVersion();
try {
$def = new PrepareDefinition($this->optionsArray);
} catch (Exception $exception) {
$this->response->error('Command definition error: ' . $exception->getMessage());
return;
}
$def->initOptions();
$this->response->addContent(new Heading('Usage: '));
$this->response->addContent(new SubContent($this->commandName . $def->usage));
if ($def->argumentsDescription) {
$this->response->addContent(new SubContent(Table::create(new \ArrayIterator($def->argumentsDescription))));
}
if ($def->optionsDescription) {
foreach ($def->optionsDescription as $group => $descriptions) {
$this->response->addContent(new Heading($group . ": "));
$this->response->addContent(new SubContent(Table::create(new \ArrayIterator($descriptions))));
}
}
}
/**
* @codeCoverageIgnore
*/
public function install()
{
$this->response->addContent('Installing');
$request = Request::createAuto();
if (!$request->isCli()) {
$this->response->error('CLI mode required');
return;
}
$scriptFilename = realpath($request->server()->SCRIPT_NAME);
$basename = basename($scriptFilename);
ob_start();
$this->showBashCompletion();
$completion = ob_get_clean();
$completionDirs = array(
'/usr/local/etc/bash_completion.d/',
'/etc/bash_completion.d/',
);
$completionDir = null;
foreach ($completionDirs as $dir) {
if (file_exists($dir)) {
$completionDir = $dir;
break;
}
}
if (null === $completionDir) {
$this->response->error('bash_completion.d not found');
return;
}
$result = file_put_contents($completionDir . $basename, $completion)
&& chmod($completionDir . $basename, 0755);
if (!$result) {
$this->response->error('Unable to save bash completion');
return;
}
$scriptFilenameInstall = '/usr/local/bin/' . $basename;
if (!file_exists($scriptFilenameInstall)) {
$cmd = 'ln -s ' . $scriptFilename . ' ' . $scriptFilenameInstall;
$this->response->addContent($cmd);
system($cmd, $result);
if ($result) {
$this->response->error('Unable to create symlink to ' . $scriptFilenameInstall);
}
}
$this->response->success('OK');
system('exec bash');
}
}