ArgvInput.php 10KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346
  1. <?php
  2. /*
  3. * This file is part of the Symfony package.
  4. *
  5. * (c) Fabien Potencier <fabien@symfony.com>
  6. *
  7. * For the full copyright and license information, please view the LICENSE
  8. * file that was distributed with this source code.
  9. */
  10. namespace Symfony\Component\Console\Input;
  11. use Symfony\Component\Console\Exception\RuntimeException;
  12. /**
  13. * ArgvInput represents an input coming from the CLI arguments.
  14. *
  15. * Usage:
  16. *
  17. * $input = new ArgvInput();
  18. *
  19. * By default, the `$_SERVER['argv']` array is used for the input values.
  20. *
  21. * This can be overridden by explicitly passing the input values in the constructor:
  22. *
  23. * $input = new ArgvInput($_SERVER['argv']);
  24. *
  25. * If you pass it yourself, don't forget that the first element of the array
  26. * is the name of the running application.
  27. *
  28. * When passing an argument to the constructor, be sure that it respects
  29. * the same rules as the argv one. It's almost always better to use the
  30. * `StringInput` when you want to provide your own input.
  31. *
  32. * @author Fabien Potencier <fabien@symfony.com>
  33. *
  34. * @see http://www.gnu.org/software/libc/manual/html_node/Argument-Syntax.html
  35. * @see http://www.opengroup.org/onlinepubs/009695399/basedefs/xbd_chap12.html#tag_12_02
  36. */
  37. class ArgvInput extends Input
  38. {
  39. private $tokens;
  40. private $parsed;
  41. /**
  42. * @param array|null $argv An array of parameters from the CLI (in the argv format)
  43. * @param InputDefinition|null $definition A InputDefinition instance
  44. */
  45. public function __construct(array $argv = null, InputDefinition $definition = null)
  46. {
  47. if (null === $argv) {
  48. $argv = $_SERVER['argv'];
  49. }
  50. // strip the application name
  51. array_shift($argv);
  52. $this->tokens = $argv;
  53. parent::__construct($definition);
  54. }
  55. protected function setTokens(array $tokens)
  56. {
  57. $this->tokens = $tokens;
  58. }
  59. /**
  60. * {@inheritdoc}
  61. */
  62. protected function parse()
  63. {
  64. $parseOptions = true;
  65. $this->parsed = $this->tokens;
  66. while (null !== $token = array_shift($this->parsed)) {
  67. if ($parseOptions && '' == $token) {
  68. $this->parseArgument($token);
  69. } elseif ($parseOptions && '--' == $token) {
  70. $parseOptions = false;
  71. } elseif ($parseOptions && 0 === strpos($token, '--')) {
  72. $this->parseLongOption($token);
  73. } elseif ($parseOptions && '-' === $token[0] && '-' !== $token) {
  74. $this->parseShortOption($token);
  75. } else {
  76. $this->parseArgument($token);
  77. }
  78. }
  79. }
  80. /**
  81. * Parses a short option.
  82. *
  83. * @param string $token The current token
  84. */
  85. private function parseShortOption($token)
  86. {
  87. $name = substr($token, 1);
  88. if (strlen($name) > 1) {
  89. if ($this->definition->hasShortcut($name[0]) && $this->definition->getOptionForShortcut($name[0])->acceptValue()) {
  90. // an option with a value (with no space)
  91. $this->addShortOption($name[0], substr($name, 1));
  92. } else {
  93. $this->parseShortOptionSet($name);
  94. }
  95. } else {
  96. $this->addShortOption($name, null);
  97. }
  98. }
  99. /**
  100. * Parses a short option set.
  101. *
  102. * @param string $name The current token
  103. *
  104. * @throws RuntimeException When option given doesn't exist
  105. */
  106. private function parseShortOptionSet($name)
  107. {
  108. $len = strlen($name);
  109. for ($i = 0; $i < $len; ++$i) {
  110. if (!$this->definition->hasShortcut($name[$i])) {
  111. throw new RuntimeException(sprintf('The "-%s" option does not exist.', $name[$i]));
  112. }
  113. $option = $this->definition->getOptionForShortcut($name[$i]);
  114. if ($option->acceptValue()) {
  115. $this->addLongOption($option->getName(), $i === $len - 1 ? null : substr($name, $i + 1));
  116. break;
  117. } else {
  118. $this->addLongOption($option->getName(), null);
  119. }
  120. }
  121. }
  122. /**
  123. * Parses a long option.
  124. *
  125. * @param string $token The current token
  126. */
  127. private function parseLongOption($token)
  128. {
  129. $name = substr($token, 2);
  130. if (false !== $pos = strpos($name, '=')) {
  131. if (0 === strlen($value = substr($name, $pos + 1))) {
  132. array_unshift($this->parsed, $value);
  133. }
  134. $this->addLongOption(substr($name, 0, $pos), $value);
  135. } else {
  136. $this->addLongOption($name, null);
  137. }
  138. }
  139. /**
  140. * Parses an argument.
  141. *
  142. * @param string $token The current token
  143. *
  144. * @throws RuntimeException When too many arguments are given
  145. */
  146. private function parseArgument($token)
  147. {
  148. $c = count($this->arguments);
  149. // if input is expecting another argument, add it
  150. if ($this->definition->hasArgument($c)) {
  151. $arg = $this->definition->getArgument($c);
  152. $this->arguments[$arg->getName()] = $arg->isArray() ? array($token) : $token;
  153. // if last argument isArray(), append token to last argument
  154. } elseif ($this->definition->hasArgument($c - 1) && $this->definition->getArgument($c - 1)->isArray()) {
  155. $arg = $this->definition->getArgument($c - 1);
  156. $this->arguments[$arg->getName()][] = $token;
  157. // unexpected argument
  158. } else {
  159. $all = $this->definition->getArguments();
  160. if (count($all)) {
  161. throw new RuntimeException(sprintf('Too many arguments, expected arguments "%s".', implode('" "', array_keys($all))));
  162. }
  163. throw new RuntimeException(sprintf('No arguments expected, got "%s".', $token));
  164. }
  165. }
  166. /**
  167. * Adds a short option value.
  168. *
  169. * @param string $shortcut The short option key
  170. * @param mixed $value The value for the option
  171. *
  172. * @throws RuntimeException When option given doesn't exist
  173. */
  174. private function addShortOption($shortcut, $value)
  175. {
  176. if (!$this->definition->hasShortcut($shortcut)) {
  177. throw new RuntimeException(sprintf('The "-%s" option does not exist.', $shortcut));
  178. }
  179. $this->addLongOption($this->definition->getOptionForShortcut($shortcut)->getName(), $value);
  180. }
  181. /**
  182. * Adds a long option value.
  183. *
  184. * @param string $name The long option key
  185. * @param mixed $value The value for the option
  186. *
  187. * @throws RuntimeException When option given doesn't exist
  188. */
  189. private function addLongOption($name, $value)
  190. {
  191. if (!$this->definition->hasOption($name)) {
  192. throw new RuntimeException(sprintf('The "--%s" option does not exist.', $name));
  193. }
  194. $option = $this->definition->getOption($name);
  195. if (null !== $value && !$option->acceptValue()) {
  196. throw new RuntimeException(sprintf('The "--%s" option does not accept a value.', $name));
  197. }
  198. if (in_array($value, array('', null), true) && $option->acceptValue() && count($this->parsed)) {
  199. // if option accepts an optional or mandatory argument
  200. // let's see if there is one provided
  201. $next = array_shift($this->parsed);
  202. if ((isset($next[0]) && '-' !== $next[0]) || in_array($next, array('', null), true)) {
  203. $value = $next;
  204. } else {
  205. array_unshift($this->parsed, $next);
  206. }
  207. }
  208. if (null === $value) {
  209. if ($option->isValueRequired()) {
  210. throw new RuntimeException(sprintf('The "--%s" option requires a value.', $name));
  211. }
  212. if (!$option->isArray() && !$option->isValueOptional()) {
  213. $value = true;
  214. }
  215. }
  216. if ($option->isArray()) {
  217. $this->options[$name][] = $value;
  218. } else {
  219. $this->options[$name] = $value;
  220. }
  221. }
  222. /**
  223. * {@inheritdoc}
  224. */
  225. public function getFirstArgument()
  226. {
  227. foreach ($this->tokens as $token) {
  228. if ($token && '-' === $token[0]) {
  229. continue;
  230. }
  231. return $token;
  232. }
  233. }
  234. /**
  235. * {@inheritdoc}
  236. */
  237. public function hasParameterOption($values, $onlyParams = false)
  238. {
  239. $values = (array) $values;
  240. foreach ($this->tokens as $token) {
  241. if ($onlyParams && '--' === $token) {
  242. return false;
  243. }
  244. foreach ($values as $value) {
  245. // Options with values:
  246. // For long options, test for '--option=' at beginning
  247. // For short options, test for '-o' at beginning
  248. $leading = 0 === strpos($value, '--') ? $value.'=' : $value;
  249. if ($token === $value || '' !== $leading && 0 === strpos($token, $leading)) {
  250. return true;
  251. }
  252. }
  253. }
  254. return false;
  255. }
  256. /**
  257. * {@inheritdoc}
  258. */
  259. public function getParameterOption($values, $default = false, $onlyParams = false)
  260. {
  261. $values = (array) $values;
  262. $tokens = $this->tokens;
  263. while (0 < count($tokens)) {
  264. $token = array_shift($tokens);
  265. if ($onlyParams && '--' === $token) {
  266. return false;
  267. }
  268. foreach ($values as $value) {
  269. if ($token === $value) {
  270. return array_shift($tokens);
  271. }
  272. // Options with values:
  273. // For long options, test for '--option=' at beginning
  274. // For short options, test for '-o' at beginning
  275. $leading = 0 === strpos($value, '--') ? $value.'=' : $value;
  276. if ('' !== $leading && 0 === strpos($token, $leading)) {
  277. return substr($token, strlen($leading));
  278. }
  279. }
  280. }
  281. return $default;
  282. }
  283. /**
  284. * Returns a stringified representation of the args passed to the command.
  285. *
  286. * @return string
  287. */
  288. public function __toString()
  289. {
  290. $tokens = array_map(function ($token) {
  291. if (preg_match('{^(-[^=]+=)(.+)}', $token, $match)) {
  292. return $match[1].$this->escapeToken($match[2]);
  293. }
  294. if ($token && '-' !== $token[0]) {
  295. return $this->escapeToken($token);
  296. }
  297. return $token;
  298. }, $this->tokens);
  299. return implode(' ', $tokens);
  300. }
  301. }