-
Notifications
You must be signed in to change notification settings - Fork 5
/
CLImax.php
352 lines (310 loc) · 11.7 KB
/
CLImax.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
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
<?php
class CLImaxController
{
protected $commandMap = array();
protected $usageCommands = array();
protected $defaultCommand = NULL;
protected $defaultCommandAlwaysRuns = false;
protected $environment = array();
/**
* @var string The character linking a command flag to its argument. Default NULL (ie whitespace).
*/
protected $argLinker = NULL;
const OPT_RETURN_INSTEAD_OF_EXIT = 'returnInsteadOfExit';
const OPT_SLIENT = 'silent';
const ERR_USAGE = -1;
public function __construct($opts = array())
{
$this->environment = $_ENV;
$this->options = array_merge(array(
self::OPT_RETURN_INSTEAD_OF_EXIT => false,
self::OPT_SLIENT => false,
), $opts);
}
public static function create($opts = array())
{
return new CLImaxController($opts);
}
public function mergeEnvironment($env, $opts = array())
{
if (!is_array($env)) throw new Exception("Array required.");
if (isset($opts['overwrite']) && $opts['overwrite'])
{
$this->environment = array_merge($this->environment, $env);
}
else
{
$this->environment = array_merge($env, $this->environment);
}
return $this;
}
public function setEnvironment($key, $value = NULL)
{
if (is_array($key))
{
if ($value !== NULL) throw new Exception("When calling setEnvironment() with an array, only 1 parameter is accepted.");
$this->environment = $key;
}
else
{
$this->environment[$key] = $value;
}
return $this;
}
public function getEnvironment($key = NULL)
{
if ($key)
{
if (!array_key_exists($key, $this->environment)) return NULL;
return $this->environment[$key];
}
else
{
return $this->environment;
}
}
public function hasEnvironment($key)
{
return array_key_exists($key, $this->environment);
}
public function addCommand($CLImaxCommand, $aliases = array())
{
if (!($CLImaxCommand instanceof CLImaxCommand)) throw new Exception("CLImaxCommand required.");
if (!is_array($aliases))
{
$aliases = array($aliases);
}
if (count($aliases) === 0) throw new Exception("addCommand() requires at least one alias.");
foreach ($aliases as $alias) {
if (isset($this->commandMap[$alias])) throw new Exception("Command " . get_class($this->commandMap[$alias]) . " has already been registered for alias {$alias}.");
$this->commandMap[$alias] = $CLImaxCommand;
}
$this->usageCommands[] = array('aliases' => $aliases, 'command' => $CLImaxCommand);
return $this;
}
public function addEnvironmentFlagWithExactlyOneArgument($key, $aliases = NULL, $opts = array())
{
if ($aliases === NULL)
{
$aliases = "--{$key}";
}
$opts = array_merge($opts, array('requiresArgument' => true)); // requiresArgument should always win
$this->addCommand(new CLImaxEnvironmentOption($key, $opts), $aliases);
return $this;
}
public function addEnvironmentFlagSetsValue($key, $flagSetsValue, $aliases = NULL, $opts = array())
{
if ($aliases === NULL)
{
$aliases = "--{$key}";
}
$opts = array_merge($opts, array('requiresArgument' => false, 'noArgumentValue' => $flagSetsValue)); // these values always win
$this->addCommand(new CLImaxEnvironmentOption($key, $opts), $aliases);
return $this;
}
public function setDefaultCommand($CLImaxCommand, $opts = array())
{
if ($this->defaultCommand) throw new Exception("A default command has already been registered.");
$this->defaultCommand = $CLImaxCommand;
$this->defaultCommandAlwaysRuns = (isset($opts['alwaysRuns']) && $opts['alwaysRuns']);
return $this;
}
public function run($argv, $argc, $opts = array())
{
$commandNameRun = array_shift($argv);
$result = 0;
$commands = array();
$previousCommand = NULL;
// convert argv stack into processable list
$cmd = NULL;
$cmdToken = NULL;
$args = array();
$defaultCommandArguments = array();
while (true) {
$token = array_shift($argv);
//print "processing '{$token}'\n";
if ($token === NULL) // reached end
{
if ($cmd) // push last command
{
$commands[] = array('command' => $cmd, 'arguments' => $args, 'token' => $cmdToken);
$cmd = NULL;
$args = array();
}
if (
$this->defaultCommand
and (count($commands) === 0 or $this->defaultCommandAlwaysRuns)
)
{
//print "adding default command\n";
if (count($commands) >= 1)
{
$args = $defaultCommandArguments;
}
$commands[] = array('command' => $this->defaultCommand, 'arguments' => $args, 'token' => '<default>');
}
break;
}
$nextCmd = $this->commandForToken($token);
if ($nextCmd)
{
if ($cmd)
{
$commands[] = array('command' => $cmd, 'arguments' => $args, 'token' => $cmdToken);
}
else // stash original set of arguments away for use with defaultCommand as needed
{
$defaultCommandArguments = $args;
}
$cmd = $nextCmd;
$cmdToken = $token;
$args = array();
}
else
{
$args[] = $token;
}
}
if (count($commands) === 0)
{
return $this->usage();
}
// run commands
$currentCommand = NULL;
try {
foreach ($commands as $key => $command) {
$currentCommand = $command;
//print "Calling " . get_class($command['command']) . "::run(" . join(', ', $command['arguments']) . ")";
$cmdCallback = array($command['command'], 'run');
if (!is_callable($cmdCallback)) throw new Exception("Not callable: " . var_export($cmdCallback, true));
$result = call_user_func_array($cmdCallback, array($command['arguments'], $this));
if (is_null($result)) throw new Exception("Command " . get_class($command['command']) . " returned NULL.");
if ($result !== 0) break;
}
} catch (CLImaxCommand_ArugumentException $e) {
$this->options[self::OPT_SLIENT] || fwrite(STDERR, "Error processing {$currentCommand['token']}: {$e->getMessage()}\n");
$result = -2;
} catch (Exception $e) {
$this->options[self::OPT_SLIENT] || fwrite(STDERR, get_class($e) . ": {$e->getMessage()}\n{$e->getTraceAsString()}\n");
$result = -1;
}
if ($this->options['returnInsteadOfExit'])
{
return $result;
}
else
{
exit($result);
}
}
public function usage()
{
print "Usage:\n------\n";
foreach ($this->usageCommands as $usageInfo) {
print $usageInfo['command']->getUsage($usageInfo['aliases'], $this->argLinker) . "\n";
}
if ($this->options['returnInsteadOfExit'])
{
return self::ERR_USAGE;
}
else
{
exit(self::ERR_USAGE);
}
}
// returns the CLImaxCommand or NULL if not a command switch
protected final function commandForToken($token)
{
if (isset($this->commandMap[$token])) return $this->commandMap[$token];
return NULL;
}
}
class CLImaxCommand_ArugumentException extends Exception {}
interface CLImaxCommand
{
const ARG_NONE = 'none';
const ARG_OPTIONAL = 'optional';
const ARG_REQUIRED = 'required';
public function run($arguments, CLImaxController $cliController);
public function getUsage($aliases, $argLinker);
public function getDescription($aliases, $argLinker);
public function getArgumentType();
public function getAllowsMultipleUse();
}
abstract class CLIMax_BaseCommand implements CLImaxCommand
{
public function getAllowsMultipleUse() { return false; }
public function getArgumentType() { return CLImaxCommand::ARG_NONE; }
public function getUsage($aliases, $argLinker)
{
// calculate arg linker string
switch ($this->getArgumentType()) {
case CLImaxCommand::ARG_NONE:
$argLinker = NULL;
break;
default:
$argLinker = "{$argLinker}<arg>";
break;
}
$cmd = NULL;
foreach ($aliases as $alias) {
if ($cmd)
{
$cmd .= " / ";
}
$cmd .= "{$alias}{$argLinker}";
}
$description = $this->getDescription($aliases, $argLinker);
if ($description)
{
$cmd .= "\n {$description}\n";
}
return $cmd;
}
public function getDescription($aliases, $argLinker) { return NULL; }
}
class CLImaxEnvironmentOption extends CLIMax_BaseCommand
{
protected $environmentKey;
protected $requiresArgument;
protected $allowsMultipleArguments;
protected $noArgumentValue;
protected $allowedValues;
public function __construct($environmentKey, $opts = array())
{
$this->environmentKey = $environmentKey;
$opts = array_merge(array(
'requiresArgument' => false,
'allowsMultipleArguments' => false,
'noArgumentValue' => NULL,
'allowedValues' => NULL,
), $opts);
$this->requiresArgument = $opts['requiresArgument'];
$this->allowsMultipleArguments = $opts['allowsMultipleArguments'];
$this->noArgumentValue = $opts['noArgumentValue'];
$this->allowedValues = $opts['allowedValues'];
}
public function run($arguments, CLImaxController $cliController)
{
// argument checks
if ($this->requiresArgument && count($arguments) === 0) throw new CLImaxCommand_ArugumentException("Argument required.");
if (!$this->allowsMultipleArguments && count($arguments) > 1) throw new CLImaxCommand_ArugumentException("Only one argument accepted.");
if (count($arguments) === 0 && $this->noArgumentValue)
{
$arguments = array($this->noArgumentValue);
}
if (!is_array($arguments)) throw new Exception("Arguments should be an array but wasn't. Internal fail.");
if ($this->allowedValues)
{
$badArgs = array_diff($arguments, $this->allowedValues);
if (count($badArgs) > 0) throw new CLImaxCommand_ArugumentException("Invalid argument(s): " . join(', ', $badArgs));
}
// flatten argument to a single value as a convenience for working with the environment data later
if (count($arguments) === 1)
{
$arguments = $arguments[0];
}
$cliController->setEnvironment($this->environmentKey, $arguments);
return 0;
}
}