namibia
df0489e1eeeeab5a9bd44e1d84fce49924fe1bac
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 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 |
<?php namespace MrClay; use MrClay\Cli\Arg; use InvalidArgumentException; /** * Forms a front controller for a console app, handling and validating arguments (options) * * Instantiate, add arguments, then call validate(). Afterwards, the user's valid arguments * and their values will be available in $cli->values. * * You may also specify that some arguments be used to provide input/output. By communicating * solely through the file pointers provided by openInput()/openOutput(), you can make your * app more flexible to end users. * * @author Steve Clay <steve@mrclay.org> * @license http://www.opensource.org/licenses/mit-license.php MIT License */ class Cli { /** * @var array validation errors */ public $errors = array(); /** * @var array option values available after validation. * * E.g. array( * 'a' => false // option was missing * ,'b' => true // option was present * ,'c' => "Hello" // option had value * ,'f' => "/home/user/file" // file path from root * ,'f.raw' => "~/file" // file path as given to option * ) */ public $values = array(); /** * @var array */ public $moreArgs = array(); /** * @var array */ public $debug = array(); /** * @var bool The user wants help info */ public $isHelpRequest = false; /** * @var Arg[] */ protected $_args = array(); /** * @var resource */ protected $_stdin = null; /** * @var resource */ protected $_stdout = null; /** * @param bool $exitIfNoStdin (default true) Exit() if STDIN is not defined */ public function __construct($exitIfNoStdin = true) { if ($exitIfNoStdin && ! defined('STDIN')) { exit('This script is for command-line use only.'); } if (isset($GLOBALS['argv'][1]) && ($GLOBALS['argv'][1] === '-?' || $GLOBALS['argv'][1] === '--help')) { $this->isHelpRequest = true; } } /** * @param Arg|string $letter * @return Arg */ public function addOptionalArg($letter) { return $this->addArgument($letter, false); } /** * @param Arg|string $letter * @return Arg */ public function addRequiredArg($letter) { return $this->addArgument($letter, true); } /** * @param string $letter * @param bool $required * @param Arg|null $arg * @return Arg * @throws InvalidArgumentException */ public function addArgument($letter, $required, Arg $arg = null) { if (! preg_match('/^[a-zA-Z]$/', $letter)) { throw new InvalidArgumentException('$letter must be in [a-zA-Z]'); } if (! $arg) { $arg = new Arg($required); } $this->_args[$letter] = $arg; return $arg; } /** * @param string $letter * @return Arg|null */ public function getArgument($letter) { return isset($this->_args[$letter]) ? $this->_args[$letter] : null; } /* * Read and validate options * * @return bool true if all options are valid */ public function validate() { $options = ''; $this->errors = array(); $this->values = array(); $this->_stdin = null; if ($this->isHelpRequest) { return false; } $lettersUsed = ''; foreach ($this->_args as $letter => $arg) { /* @var Arg $arg */ $options .= $letter; $lettersUsed .= $letter; if ($arg->mayHaveValue || $arg->mustHaveValue) { $options .= ($arg->mustHaveValue ? ':' : '::'); } } $this->debug['argv'] = $GLOBALS['argv']; $argvCopy = array_slice($GLOBALS['argv'], 1); $o = getopt($options); $this->debug['getopt_options'] = $options; $this->debug['getopt_return'] = $o; foreach ($this->_args as $letter => $arg) { /* @var Arg $arg */ $this->values[$letter] = false; if (isset($o[$letter])) { if (is_bool($o[$letter])) { // remove from argv copy $k = array_search("-$letter", $argvCopy); if ($k !== false) { array_splice($argvCopy, $k, 1); } if ($arg->mustHaveValue) { $this->addError($letter, "Missing value"); } else { $this->values[$letter] = true; } } else { // string $this->values[$letter] = $o[$letter]; $v =& $this->values[$letter]; // remove from argv copy // first look for -ovalue or -o=value $pattern = "/^-{$letter}=?" . preg_quote($v, '/') . "$/"; $foundInArgv = false; foreach ($argvCopy as $k => $argV) { if (preg_match($pattern, $argV)) { array_splice($argvCopy, $k, 1); $foundInArgv = true; break; } } if (! $foundInArgv) { // space separated $k = array_search("-$letter", $argvCopy); if ($k !== false) { array_splice($argvCopy, $k, 2); } } // check that value isn't really another option if (strlen($lettersUsed) > 1) { $pattern = "/^-[" . str_replace($letter, '', $lettersUsed) . "]/i"; if (preg_match($pattern, $v)) { $this->addError($letter, "Value was read as another option: %s", $v); return false; } } if ($arg->assertFile || $arg->assertDir) { if ($v[0] !== '/' && $v[0] !== '~') { $this->values["$letter.raw"] = $v; $v = getcwd() . "/$v"; } } if ($arg->assertFile) { if ($arg->useAsInfile) { $this->_stdin = $v; } elseif ($arg->useAsOutfile) { $this->_stdout = $v; } if ($arg->assertReadable && ! is_readable($v)) { $this->addError($letter, "File not readable: %s", $v); continue; } if ($arg->assertWritable) { if (is_file($v)) { if (! is_writable($v)) { $this->addError($letter, "File not writable: %s", $v); } } else { if (! is_writable(dirname($v))) { $this->addError($letter, "Directory not writable: %s", dirname($v)); } } } } elseif ($arg->assertDir && $arg->assertWritable && ! is_writable($v)) { $this->addError($letter, "Directory not readable: %s", $v); } } } else { if ($arg->isRequired()) { $this->addError($letter, "Missing"); } } } $this->moreArgs = $argvCopy; reset($this->moreArgs); return empty($this->errors); } /** * Get the full paths of file(s) passed in as unspecified arguments * * @return array */ public function getPathArgs() { $r = $this->moreArgs; foreach ($r as $k => $v) { if ($v[0] !== '/' && $v[0] !== '~') { $v = getcwd() . "/$v"; $v = str_replace('/./', '/', $v); do { $v = preg_replace('@/[^/]+/\\.\\./@', '/', $v, 1, $changed); } while ($changed); $r[$k] = $v; } } return $r; } /** * Get a short list of errors with options * * @return string */ public function getErrorReport() { if (empty($this->errors)) { return ''; } $r = "Some arguments did not pass validation:\n"; foreach ($this->errors as $letter => $arr) { $r .= " $letter : " . implode(', ', $arr) . "\n"; } $r .= "\n"; return $r; } /** * @return string */ public function getArgumentsListing() { $r = "\n"; foreach ($this->_args as $letter => $arg) { /* @var Arg $arg */ $desc = $arg->getDescription(); $flag = " -$letter "; if ($arg->mayHaveValue) { $flag .= "[VAL]"; } elseif ($arg->mustHaveValue) { $flag .= "VAL"; } if ($arg->assertFile) { $flag = str_replace('VAL', 'FILE', $flag); } elseif ($arg->assertDir) { $flag = str_replace('VAL', 'DIR', $flag); } if ($arg->isRequired()) { $desc = "(required) $desc"; } $flag = str_pad($flag, 12, " ", STR_PAD_RIGHT); $desc = wordwrap($desc, 70); $r .= $flag . str_replace("\n", "\n ", $desc) . "\n\n"; } return $r; } /** * Get resource of open input stream. May be STDIN or a file pointer * to the file specified by an option with 'STDIN'. * * @return resource */ public function openInput() { if (null === $this->_stdin) { return STDIN; } else { $this->_stdin = fopen($this->_stdin, 'rb'); return $this->_stdin; } } public function closeInput() { if (null !== $this->_stdin) { fclose($this->_stdin); } } /** * Get resource of open output stream. May be STDOUT or a file pointer * to the file specified by an option with 'STDOUT'. The file will be * truncated to 0 bytes on opening. * * @return resource */ public function openOutput() { if (null === $this->_stdout) { return STDOUT; } else { $this->_stdout = fopen($this->_stdout, 'wb'); return $this->_stdout; } } public function closeOutput() { if (null !== $this->_stdout) { fclose($this->_stdout); } } /** * @param string $letter * @param string $msg * @param string $value */ protected function addError($letter, $msg, $value = null) { if ($value !== null) { $value = var_export($value, 1); } $this->errors[$letter][] = sprintf($msg, $value); } } |
Commits for namibiapublic/min/lib/MrClay/Cli.php
Revision | Author | Commited | Message |
---|---|---|---|
df0489 ... | Mark | Fri 14 Oct, 2016 10:01:00 +0000 | initial commit |