[WIP][Process] Add commandline parameter binding support #12488
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,166 @@ | ||
| <?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; | ||
|
|
||
| use Symfony\Component\Process\Exception\InvalidArgumentException; | ||
|
|
||
| /** | ||
| * @author Romain Neutron <imprec@gmail.com> | ||
| * | ||
| * @api | ||
| */ | ||
| class CommandLine | ||
| { | ||
| const DEFAULT_PLACEHOLDER = '{}'; | ||
| private $commandLine; | ||
| private $placeholder; | ||
| private $disabled = false; | ||
|
|
||
| public function __construct($commandLine, $placeholder = self::DEFAULT_PLACEHOLDER) | ||
| { | ||
| $this->commandLine = (string) $commandLine; | ||
| $this->setPlaceholder($placeholder); | ||
| } | ||
|
|
||
| /** | ||
| * @return string | ||
| * | ||
| * @api | ||
| */ | ||
| public function getCommandLine() | ||
| { | ||
| return $this->commandLine; | ||
| } | ||
|
|
||
| /** | ||
| * @param string $commandLine | ||
| * | ||
| * @return CommandLine | ||
| * | ||
| * @api | ||
| */ | ||
| public function setCommandLine($commandLine) | ||
| { | ||
| $this->commandLine = $commandLine; | ||
|
|
||
| return $this; | ||
| } | ||
|
|
||
| /** | ||
| * @return string | ||
| * | ||
| * @api | ||
| */ | ||
| public function getPlaceholder() | ||
| { | ||
| return $this->placeholder; | ||
| } | ||
|
|
||
| /** | ||
| * @param string $placeholder | ||
| * | ||
| * @return CommandLine | ||
| * | ||
| * @throws InvalidArgumentException | ||
| * | ||
| * @api | ||
| */ | ||
| public function setPlaceholder($placeholder) | ||
| { | ||
| if (null !== $placeholder && 0 === strlen($placeholder)) { | ||
| throw new InvalidArgumentException('Invalid placeholder'); | ||
| } | ||
|
|
||
| $this->placeholder = $placeholder; | ||
|
|
||
| return $this; | ||
| } | ||
|
|
||
| /** | ||
| * @param array $parameters | ||
| * | ||
| * @return string | ||
| * | ||
| * @throws InvalidArgumentException | ||
| * | ||
| * @api | ||
| */ | ||
| public function prepare(array $parameters) | ||
| { | ||
| if ($this->disabled) { | ||
| return $this->commandLine; | ||
| } | ||
|
|
||
| $placeholders = $this->countPlaceholders(array_filter(array_keys($parameters), function ($value) { return !is_numeric($value); })); | ||
|
|
||
| if (count($parameters) !== $placeholders) { | ||
| throw new InvalidArgumentException('Invalid number of bound parameters'); | ||
| } | ||
|
|
||
| if (0 === $placeholders) { | ||
| return $this->commandLine; | ||
| } | ||
|
|
||
| $command = ''; | ||
| $offset = 0; | ||
|
|
||
| foreach ($parameters as $key => $value) { | ||
| $placeholder = is_numeric($key) ? $this->placeholder : $key; | ||
|
|
||
| $pos = strpos($this->commandLine, $placeholder, $offset); | ||
| $command .= substr($this->commandLine, $offset, $pos - $offset); | ||
| $offset = $pos + strlen($placeholder); | ||
| $command .= $this->escape($value); | ||
| } | ||
| $command .= substr($this->commandLine, $offset); | ||
|
|
||
| return $command; | ||
| } | ||
|
|
||
| /** | ||
| * @internal | ||
| */ | ||
| public function disableArguments() | ||
| { | ||
| $this->disabled = true; | ||
| } | ||
|
|
||
| /** | ||
| * @param array $placeholders | ||
| * | ||
| * @return int | ||
| */ | ||
| private function countPlaceholders(array $placeholders) | ||
| { | ||
| if (null === $this->placeholder && 0 === count($placeholders)) { | ||
| return 0; | ||
| } | ||
|
|
||
| $total = preg_match_all('#' . preg_quote($this->placeholder, '#') . '#', $this->commandLine, $matches); | ||
|
|
||
| foreach ($placeholders as $placeholder) { | ||
| $total += preg_match_all('#' . preg_quote($placeholder, '#') . '#', $this->commandLine, $matches); | ||
| } | ||
|
|
||
| return $total; | ||
| } | ||
|
|
||
| /** | ||
| * @param string $string | ||
| * | ||
| * @return string | ||
| */ | ||
| private function escape($string) | ||
| { | ||
| return ProcessUtils::escapeArgument($string); | ||
| } | ||
| } | ||
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
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,31 @@ | ||
| <?php | ||
|
|
||
| namespace Symfony\Component\Process\Tests; | ||
|
|
||
| use Symfony\Component\Process\CommandLine; | ||
|
|
||
| class CommandLineTest extends \PHPUnit_Framework_TestCase | ||
| { | ||
| /** | ||
| * @dataProvider provideVariousCommandsAndParameters | ||
| */ | ||
| public function testCommandLinePrepare($commandLine, $placeholder, $parameters, $expected) | ||
| { | ||
| $commandLine = new CommandLine($commandLine, $placeholder); | ||
| $this->assertSame($expected, $commandLine->prepare($parameters)); | ||
| } | ||
|
|
||
| public function provideVariousCommandsAndParameters() | ||
| { | ||
| return array( | ||
| array("{} | grep {}", CommandLine::DEFAULT_PLACEHOLDER, array('/usr/bin/ls', 'symfony'), "'/usr/bin/ls' | grep 'symfony'"), | ||
| array("## | grep ##", '##', array('/usr/bin/ls', 'symfony'), "'/usr/bin/ls' | grep 'symfony'"), | ||
| array("{ } | grep {}", CommandLine::DEFAULT_PLACEHOLDER, array('symfony'), "{ } | grep 'symfony'"), | ||
| array("exec {} | grep {} > symfony.log", CommandLine::DEFAULT_PLACEHOLDER, array('/usr/bin/ls', 'symfony'), "exec '/usr/bin/ls' | grep 'symfony' > symfony.log"), | ||
| array("exec ## | grep ## > symfony.log", '##', array('/usr/bin/ls', 'symfony'), "exec '/usr/bin/ls' | grep 'symfony' > symfony.log"), | ||
| array("exec Ê™ | grep Ê™ > symfony.log", 'Ê™', array('/usr/bin/ls', 'symfony'), "exec '/usr/bin/ls' | grep 'symfony' > symfony.log"), | ||
| array("exec {} | grep {} > symfony.log", CommandLine::DEFAULT_PLACEHOLDER, array('i\'m', 'symfony'), "exec 'i'\\''m' | grep 'symfony' > symfony.log"), | ||
| array("{} | grep {}", CommandLine::DEFAULT_PLACEHOLDER, array('/usr/bin/ls', 'symfony'), "'/usr/bin/ls' | grep 'symfony'"), | ||
| ); | ||
| } | ||
| } |
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.
IMO, this method is not needed. Use the static util directly