bug #34848 [Process] change the syntax of portable command lines (nicolas-grekas)

nicolas-grekas · nicolas-grekas · commit 2e7032420f67 · 2019-12-10T11:51:39.000+01:00
This PR was merged into the 4.4 branch. Discussion ---------- [Process] change the syntax of portable command lines | Q | A | ------------- | --- | Branch? | 4.4 | Bug fix? | yes | New feature? | no | Deprecations? | no | Tickets | Fix #34838 | License | MIT | Doc PR | symfony/symfony-docs#12772 An alternative to #34845 Right now, portable command lines use `"$FOO"` for placeholders. But because we validate that a corresponding variable exists before running the command, this fails with `Command line is missing a value for key "$FOO"` when `FOO` is not defined. This PR proposes to use `"${:FOO}"` instead. The difference with the previous syntax is that this cannot collide with existing shell scripts as it is invalid for them. When this is merged, we'll have to update https://symfony.com/blog/new-in-symfony-4-1-prepared-commands too. Commits ------- 3c7b775 [Process] change the syntax of portable prepared command lines
diff --git a/src/Symfony/Component/Process/Process.php b/src/Symfony/Component/Process/Process.php
@@ -1643,12 +1643,12 @@ private function escapeArgument(?string $argument): string
 
     private function replacePlaceholders(string $commandline, array $env)
     {
-        return preg_replace_callback('/"\$([_a-zA-Z]++[_a-zA-Z0-9]*+)"/', function ($matches) use ($commandline, $env) {
+        return preg_replace_callback('/"\$\{:([_a-zA-Z]++[_a-zA-Z0-9]*+)\}"/', function ($matches) use ($commandline, $env) {
             if (!isset($env[$matches[1]]) || false === $env[$matches[1]]) {
-                throw new InvalidArgumentException(sprintf('Command line is missing a value for key %s: %s.', $matches[0], $commandline));
+                throw new InvalidArgumentException(sprintf('Command line is missing a value for parameter "%s": %s.', $matches[1], $commandline));
             }
 
-            return '\\' === \DIRECTORY_SEPARATOR ? $this->escapeArgument($env[$matches[1]]) : $matches[0];
+            return $this->escapeArgument($env[$matches[1]]);
         }, $commandline);
     }
 
diff --git a/src/Symfony/Component/Process/Tests/ProcessTest.php b/src/Symfony/Component/Process/Tests/ProcessTest.php
@@ -1463,23 +1463,23 @@ public function provideEscapeArgument()
 
     public function testPreparedCommand()
     {
-        $p = Process::fromShellCommandline('echo "$abc"DEF');
+        $p = Process::fromShellCommandline('echo "${:abc}"DEF');
         $p->run(null, ['abc' => 'ABC']);
 
         $this->assertSame('ABCDEF', rtrim($p->getOutput()));
     }
 
     public function testPreparedCommandMulti()
     {
-        $p = Process::fromShellCommandline('echo "$abc""$def"');
+        $p = Process::fromShellCommandline('echo "${:abc}""${:def}"');
         $p->run(null, ['abc' => 'ABC', 'def' => 'DEF']);
 
         $this->assertSame('ABCDEF', rtrim($p->getOutput()));
     }
 
     public function testPreparedCommandWithQuoteInIt()
     {
-        $p = Process::fromShellCommandline('php -r "$code" "$def"');
+        $p = Process::fromShellCommandline('php -r "${:code}" "${:def}"');
         $p->run(null, ['code' => 'echo $argv[1];', 'def' => '"DEF"']);
 
         $this->assertSame('"DEF"', rtrim($p->getOutput()));
@@ -1488,16 +1488,16 @@ public function testPreparedCommandWithQuoteInIt()
     public function testPreparedCommandWithMissingValue()
     {
         $this->expectException('Symfony\Component\Process\Exception\InvalidArgumentException');
-        $this->expectExceptionMessage('Command line is missing a value for key "$abc": echo "$abc".');
-        $p = Process::fromShellCommandline('echo "$abc"');
+        $this->expectExceptionMessage('Command line is missing a value for parameter "abc": echo "${:abc}".');
+        $p = Process::fromShellCommandline('echo "${:abc}"');
         $p->run(null, ['bcd' => 'BCD']);
     }
 
     public function testPreparedCommandWithNoValues()
     {
         $this->expectException('Symfony\Component\Process\Exception\InvalidArgumentException');
-        $this->expectExceptionMessage('Command line is missing a value for key "$abc": echo "$abc".');
-        $p = Process::fromShellCommandline('echo "$abc"');
+        $this->expectExceptionMessage('Command line is missing a value for parameter "abc": echo "${:abc}".');
+        $p = Process::fromShellCommandline('echo "${:abc}"');
         $p->run(null, []);
     }
 

Original file line number	Diff line number	Diff line change
`@@ -1643,12 +1643,12 @@ private function escapeArgument(?string $argument): string`
`1643`	`1643`
`1644`	`1644`	`private function replacePlaceholders(string $commandline, array $env)`
`1645`	`1645`	`{`
`1646`		`- return preg_replace_callback('/"\$([_a-zA-Z]++[_a-zA-Z0-9]*+)"/', function ($matches) use ($commandline, $env) {`
	`1646`	`+ return preg_replace_callback('/"\$\{:([_a-zA-Z]++[_a-zA-Z0-9]*+)\}"/', function ($matches) use ($commandline, $env) {`
`1647`	`1647`	`if (!isset($env[$matches[1]]) \|\| false === $env[$matches[1]]) {`
`1648`		`- throw new InvalidArgumentException(sprintf('Command line is missing a value for key %s: %s.', $matches[0], $commandline));`
	`1648`	`+ throw new InvalidArgumentException(sprintf('Command line is missing a value for parameter "%s": %s.', $matches[1], $commandline));`
`1649`	`1649`	`}`
`1650`	`1650`
`1651`		`- return '\\' === \DIRECTORY_SEPARATOR ? $this->escapeArgument($env[$matches[1]]) : $matches[0];`
	`1651`	`+ return $this->escapeArgument($env[$matches[1]]);`
`1652`	`1652`	`}, $commandline);`
`1653`	`1653`	`}`
`1654`	`1654`
Original file line number	Diff line number	Diff line change
`@@ -1463,23 +1463,23 @@ public function provideEscapeArgument()`
`1463`	`1463`
`1464`	`1464`	`public function testPreparedCommand()`
`1465`	`1465`	`{`
`1466`		`- $p = Process::fromShellCommandline('echo "$abc"DEF');`
	`1466`	`+ $p = Process::fromShellCommandline('echo "${:abc}"DEF');`
`1467`	`1467`	`$p->run(null, ['abc' => 'ABC']);`
`1468`	`1468`
`1469`	`1469`	`$this->assertSame('ABCDEF', rtrim($p->getOutput()));`
`1470`	`1470`	`}`
`1471`	`1471`
`1472`	`1472`	`public function testPreparedCommandMulti()`
`1473`	`1473`	`{`
`1474`		`- $p = Process::fromShellCommandline('echo "$abc""$def"');`
	`1474`	`+ $p = Process::fromShellCommandline('echo "${:abc}""${:def}"');`
`1475`	`1475`	`$p->run(null, ['abc' => 'ABC', 'def' => 'DEF']);`
`1476`	`1476`
`1477`	`1477`	`$this->assertSame('ABCDEF', rtrim($p->getOutput()));`
`1478`	`1478`	`}`
`1479`	`1479`
`1480`	`1480`	`public function testPreparedCommandWithQuoteInIt()`
`1481`	`1481`	`{`
`1482`		`- $p = Process::fromShellCommandline('php -r "$code" "$def"');`
	`1482`	`+ $p = Process::fromShellCommandline('php -r "${:code}" "${:def}"');`
`1483`	`1483`	`$p->run(null, ['code' => 'echo $argv[1];', 'def' => '"DEF"']);`
`1484`	`1484`
`1485`	`1485`	`$this->assertSame('"DEF"', rtrim($p->getOutput()));`
`@@ -1488,16 +1488,16 @@ public function testPreparedCommandWithQuoteInIt()`
`1488`	`1488`	`public function testPreparedCommandWithMissingValue()`
`1489`	`1489`	`{`
`1490`	`1490`	`$this->expectException('Symfony\Component\Process\Exception\InvalidArgumentException');`
`1491`		`- $this->expectExceptionMessage('Command line is missing a value for key "$abc": echo "$abc".');`
`1492`		`- $p = Process::fromShellCommandline('echo "$abc"');`
	`1491`	`+ $this->expectExceptionMessage('Command line is missing a value for parameter "abc": echo "${:abc}".');`
	`1492`	`+ $p = Process::fromShellCommandline('echo "${:abc}"');`
`1493`	`1493`	`$p->run(null, ['bcd' => 'BCD']);`
`1494`	`1494`	`}`
`1495`	`1495`
`1496`	`1496`	`public function testPreparedCommandWithNoValues()`
`1497`	`1497`	`{`
`1498`	`1498`	`$this->expectException('Symfony\Component\Process\Exception\InvalidArgumentException');`
`1499`		`- $this->expectExceptionMessage('Command line is missing a value for key "$abc": echo "$abc".');`
`1500`		`- $p = Process::fromShellCommandline('echo "$abc"');`
	`1499`	`+ $this->expectExceptionMessage('Command line is missing a value for parameter "abc": echo "${:abc}".');`
	`1500`	`+ $p = Process::fromShellCommandline('echo "${:abc}"');`
`1501`	`1501`	`$p->run(null, []);`
`1502`	`1502`	`}`
`1503`	`1503`