[WIP][Process] Add Process\Command #11972
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,169 @@ | ||
| <?php | ||
|
|
||
| /* | ||
| * This file is part of the Symfony package. | ||
| * | ||
| * (c) Fabien Potencier <fabien@symfony.com> | ||
| * | ||
| * For the full copyright and license information, please view the LICENSE | ||
| * file that was distributed with this source code. | ||
| */ | ||
|
|
||
| namespace Symfony\Component\Process; | ||
|
|
||
| /** | ||
| * @author Romain Neutron <imprec@gmail.com> | ||
| */ | ||
| class Command | ||
| { | ||
| private $parts = array(); | ||
| private $appended = array(); | ||
| private $piped; | ||
| private $redirects = array(); | ||
|
|
||
| public function __construct($parts = null, $escape = true) | ||
| { | ||
| if (null !== $parts) { | ||
| $this->add($parts, $escape); | ||
| } | ||
| } | ||
|
|
||
| public function add($parts, $escape = true, $prepend = false) | ||
| { | ||
| if (!is_array($parts)) { | ||
| $parts = array($parts); | ||
| } | ||
|
|
||
| if ($prepend) { | ||
| $this->parts = array_merge(($escape ? array_map(array($this, 'escape'), $parts) : $parts), $this->parts); | ||
| } else { | ||
| $this->parts = array_merge($this->parts, $escape ? array_map(array($this, 'escape'), $parts) : $parts); | ||
| } | ||
|
|
||
| return $this; | ||
| } | ||
|
|
||
| public function append(Command $command) | ||
| { | ||
| $this->appended[] = $command; | ||
|
|
||
| return $this; | ||
| } | ||
|
|
||
| public function pipe(Command $command) | ||
| { | ||
| $this->piped = $command; | ||
|
|
||
| return $command; | ||
| } | ||
|
|
||
| public function redirect($fd, $target = null, $append = false) | ||
| { | ||
| $this->redirects[$fd] = array('target' => $target, 'append' => $append); | ||
|
|
||
| return $this; | ||
| } | ||
|
|
||
| public function prepareForexecution() | ||
| { | ||
| if (defined('PHP_WINDOWS_VERSION_BUILD')) { | ||
| return 'cmd /V:ON /E:ON /C "('.$this.')"'; | ||
| } | ||
|
|
||
| return (string) $this; | ||
| } | ||
|
|
||
| public function __toString() | ||
| { | ||
| $command = implode(' ', $this->parts).(count($this->appended) > 0 ? '; ' : ' ').implode('; ', $this->appended); | ||
|
|
||
| if ($this->hasRedirects()) { | ||
| $command = '('.$command.$this->getRedirects().')'; | ||
| } | ||
|
|
||
| $command .= ($this->piped ? '| '.$this->piped : ''); | ||
|
There was a problem hiding this comment. I wonder if piped should be applied to the original command or the last appended ? $c = new Command('ls -al');
$c->pipped(new Command('wc -l'))
->append(new Command('exit $code', false));There was a problem hiding this comment. IMHO, appended commands should be appended to the line after piped and redirects. new Command('cmd1')
->append(new Command('cmd2')->pipe(new Command('cmd3')));But if I want execute new Command('cmd1')
->append(new Command('cmd2'))
->pipe(new Command('cmd3'));It will not works There was a problem hiding this comment. Thank you very much for your feedback @jeremy-derusse, this is indeed something we need to pay attention, I'm gonna work on this during the week, let's take some time to see what are the best options for us |
||
|
|
||
| return trim($command); | ||
| } | ||
|
|
||
| public static function fromString($commandline) | ||
| { | ||
| $command = new self(); | ||
|
|
||
| $command->add($commandline, false); | ||
|
|
||
| return $command; | ||
| } | ||
|
|
||
| private function hasRedirects() | ||
| { | ||
| return 0 < count($this->redirects); | ||
| } | ||
|
|
||
| private function getRedirects() | ||
| { | ||
| $redirects = ''; | ||
|
|
||
| foreach ($this->redirects as $fd => $props) { | ||
| if (null === $props['target']) { | ||
| $props['target'] = defined('PHP_WINDOWS_VERSION_BUILD') ? 'NUL' : '/dev/null'; | ||
| } | ||
| $redirects .= ' '.$fd.'>'.($props['append'] ? '>' : '').self::escape($props['target']); | ||
| } | ||
|
|
||
| return $redirects ? $redirects : ''; | ||
| } | ||
|
|
||
| /** | ||
| * Escapes a string to be used as a shell argument. | ||
| * | ||
| * @param string $argument The argument that will be escaped | ||
| * | ||
| * @return string The escaped argument | ||
| * | ||
| * @internal Method is a static public to provide BC to ProcessUtils until Symfony 3.0 | ||
| * This method will be a private non-static as of Symfony 3.0 | ||
| */ | ||
| public static function escape($argument) | ||
| { | ||
| //Fix for PHP bug #43784 escapeshellarg removes % from given string | ||
| //Fix for PHP bug #49446 escapeshellarg doesn't work on Windows | ||
| //@see https://bugs.php.net/bug.php?id=43784 | ||
| //@see https://bugs.php.net/bug.php?id=49446 | ||
| if (defined('PHP_WINDOWS_VERSION_BUILD')) { | ||
| if ('' === $argument) { | ||
| return escapeshellarg($argument); | ||
| } | ||
|
|
||
| $escapedArgument = ''; | ||
| $quote = false; | ||
| foreach (preg_split('/(")/i', $argument, -1, PREG_SPLIT_NO_EMPTY | PREG_SPLIT_DELIM_CAPTURE) as $part) { | ||
| if ('"' === $part) { | ||
| $escapedArgument .= '\\"'; | ||
| } elseif (self::isSurroundedBy($part, '%')) { | ||
| // Avoid environment variable expansion | ||
| $escapedArgument .= '^%"'.substr($part, 1, -1).'"^%'; | ||
| } else { | ||
| // escape trailing backslash | ||
| if ('\\' === substr($part, -1)) { | ||
| $part .= '\\'; | ||
| } | ||
| $quote = true; | ||
| $escapedArgument .= $part; | ||
| } | ||
| } | ||
| if ($quote) { | ||
| $escapedArgument = '"'.$escapedArgument.'"'; | ||
| } | ||
|
|
||
| return $escapedArgument; | ||
| } | ||
|
|
||
| return escapeshellarg($argument); | ||
| } | ||
|
|
||
| private static function isSurroundedBy($arg, $char) | ||
| { | ||
| return 2 < strlen($arg) && $char === $arg[0] && $char === $arg[strlen($arg) - 1]; | ||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -19,6 +19,9 @@ | |
| * This class contains static methods only and is not meant to be instantiated. | ||
| * | ||
| * @author Martin Hasoň <martin.hason@gmail.com> | ||
| * | ||
| * @internal | ||
| * @deprecated Deprecated as of Symfony 2.6, to be removed in symfony 3.0 | ||
| */ | ||
| class ProcessUtils | ||
| { | ||
|
|
@@ -35,43 +38,12 @@ private function __construct() | |
| * @param string $argument The argument that will be escaped | ||
| * | ||
| * @return string The escaped argument | ||
| * | ||
| * @deprecated Deprecated as of Symfony 2.6, to be removed in symfony 3.0 | ||
|
There was a problem hiding this comment. -1 for deprecating it. Having the fixed escaping is useful for people not using the ProcessBuilder to build the process, for instance Composer: composer/composer#3297 There was a problem hiding this comment. I deprecated it here because I moved it in the There was a problem hiding this comment. IMO, yes (and then, Command can use it as well). Btw, the ProcessBuilder still uses it too |
||
| */ | ||
| public static function escapeArgument($argument) | ||
| { | ||
| return Command::escape($argument); | ||
| } | ||
|
|
||
| /** | ||
|
|
@@ -103,9 +75,4 @@ public static function validateInput($caller, $input) | |
|
|
||
| return $input; | ||
| } | ||
| } | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
IMHO call to explicit method
$this->__toString()will be more readableThere was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
8000I prefer to keep the __toString method to keep the commandline, and use
prepareForExecutionto wrap this commandline with OS dependant parameters