Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit 0fef0f4

Browse files
romainneutronromainneutron
committed
[Processs] Add Process\Command
1 parent a469c56 commit 0fef0f4

File tree

4 files changed

+209
-54
lines changed

4 files changed

+209
-54
lines changed

‎src/Symfony/Component/Process/Command.php

Lines changed: 154 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,154 @@
1+
<?php
2+
3+
/*
4+
* This file is part of the Symfony package.
5+
*
6+
* (c) Fabien Potencier <[email protected]>
7+
*
8+
* For the full copyright and license information, please view the LICENSE
9+
* file that was distributed with this source code.
10+
*/
11+
12+
namespace Symfony\Component\Process;
13+
14+
/**
15+
* @author Romain Neutron <[email protected]>
16+
*/
17+
class Command
18+
{
19+
private $parts;
20+
private $appended = array();
21+
private $piped;
22+
private $redirects = array();
23+
24+
public function __construct(array $parts = array(), $escape = true)
25+
{
26+
$this->parts = $escape ? array_map([self, 'escape'], $parts) : $parts;
27+
}
28+
29+
public function add($parts, $escape = true, $prepend = false)
30+
{
31+
if (!is_array($parts)) {
32+
$parts = array($parts);
33+
}
34+
35+
if ($prepend) {
36+
$this->parts = ($escape ? array_map([self, 'escape'], $parts) : $parts) + $this->parts;
37+
} else {
38+
$this->parts += $escape ? array_map([self, 'escape'], $parts) : $parts;
39+
}
40+
41+
return $this;
42+
}
43+
44+
public function append(Command $command)
45+
{
46+
$this->appended[] = $command;
47+
48+
return $this;
49+
}
50+
51+
public function pipe(Command $command)
52+
{
53+
$this->piped = $command;
54+
55+
return $command;
56+
}
57+
58+
public function redirect($fd, $target = null, $append = false)
59+
{
60+
$this->redirects[$fd] = ['target' => $target, 'append' => $append];
61+
62+
return $this;
63+
}
64+
65+
public function prepareForexecution()
66+
{
67+
if (defined('PHP_WINDOWS_VERSION_BUILD')) {
68+
return 'cmd /V:ON /E:ON /C "('.$this.')"';
69+
}
70+
71+
return (string) $this;
72+
}
73+
74+
public function __toString()
75+
{
76+
return implode(' ', $this->parts).array_map('; ', $this->appended).$this->getredirects().($this->piped ? ' | '.$this->piped : '');
77+
}
78+
79+
public static function fromString($commandline)
80+
{
81+
$command = new self();
82+
83+
$command->add($commandline, false);
84+
85+
return $command;
86+
}
87+
88+
private function getredirects()
89+
{
90+
$redirects = '';
91+
92+
foreach ($this->redirects as $fd => $props) {
93+
if (null === $props['target']) {
94+
$props['target'] = defined('PHP_WINDOWS_VERSION_BUILD') ? 'NUL' : '/dev/null';
95+
}
96+
$redirects .= ' '.$fd.'>'.($props['append'] ? '>' : '').self::escape($props['target']);
97+
}
98+
99+
return $redirects ? '('.$redirects.')' : '';
100+
}
101+
102+
/**
103+
* Escapes a string to be used as a shell argument.
104+
*
105+
* @param string $argument The argument that will be escaped
106+
*
107+
* @return string The escaped argument
108+
*
109+
* @internal Method is a static public to provide BC to ProcessUtils until Symfony 3.0
110+
* This method will be a private non-static as of Symfony 3.0
111+
*/
112+
public static function escape($argument)
113+
{
114+
//Fix for PHP bug #43784 escapeshellarg removes % from given string
115+
//Fix for PHP bug #49446 escapeshellarg doesn't work on Windows
116+
//@see https://bugs.php.net/bug.php?id=43784
117+
//@see https://bugs.php.net/bug.php?id=49446
118+
if (defined('PHP_WINDOWS_VERSION_BUILD')) {
119+
if ('' === $argument) {
120+
return escapeshellarg($argument);
121+
}
122+
123+
$escapedArgument = '';
124+
$quote = false;
125+
foreach (preg_split('/(")/i', $argument, -1, PREG_SPLIT_NO_EMPTY | PREG_SPLIT_DELIM_CAPTURE) as $part) {
126+
if ('"' === $part) {
127+
$escapedArgument .= '\\"';
128+
} elseif (self::isSurroundedBy($part, '%')) {
129+
// Avoid environment variable expansion
130+
$escapedArgument .= '^%"'.substr($part, 1, -1).'"^%';
131+
} else {
132+
// escape trailing backslash
133+
if ('\\' === substr($part, -1)) {
134+
$part .= '\\';
135+
}
136+
$quote = true;
137+
$escapedArgument .= $part;
138+
}
139+
}
140+
if ($quote) {
141+
$escapedArgument = '"'.$escapedArgument.'"';
142+
}
143+
144+
return $escapedArgument;
145+
}
146+
147+
return escapeshellarg($argument);
148+
}
149+
150+
private static function isSurroundedBy($arg, $char)
151+
{
152+
return 2 < strlen($arg) && $char === $arg[0] && $char === $arg[strlen($arg) - 1];
153+
}
154+
}

‎src/Symfony/Component/Process/Process.php

Lines changed: 46 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -148,6 +148,10 @@ public function __construct($commandline, $cwd = null, array $env = null, $input
148148
throw new RuntimeException('The Process class relies on proc_open, which is not available on your PHP installation.');
149149
}
150150

151+
if (!$commandline instanceof Command) {
152+
$commandline = Command::fromString($commandline);
153+
}
154+
151155
$this->commandline = $commandline;
152156
$this->cwd = $cwd;
153157

@@ -274,21 +278,29 @@ public function start($callback = null)
274278
$this->callback = $this->buildCallback($callback);
275279
$descriptors = $this->getDescriptors();
276280

277-
$commandline = $this->commandline;
281+
$commandline = clone $this->commandline;
282+
283+
if (!$this->useFileHandles && $this->enhanceSigchildCompatibility && $this->isSigchildEnabled()) {
284+
// last exit code is output on the fourth pipe and caught to work around --enable-sigchild
285+
$descriptors = array_merge($descriptors, array(array('pipe', 'w')));
286+
287+
$commandline
288+
->redirect(3, '/dev/null')
289+
->append(new Command('code=$?', false))
290+
->append(new Command('echo $code >&3', false))
291+
->append(new Command('exit $code', false));
292+
}
278293

279294
if (defined('PHP_WINDOWS_VERSION_BUILD') && $this->enhanceWindowsCompatibility) {
280-
$commandline = 'cmd /V:ON /E:ON /C "('.$commandline.')';
281295
foreach ($this->processPipes->getFiles() as $offset => $filename) {
282-
$commandline .= ' '.$offset.'>'.ProcessUtils::escapeArgument($filename);
296+
$commandline->redirect($offset, $filename);
283297
}
284-
$commandline .= '"';
285-
286298
if (!isset($this->options['bypass_shell'])) {
287299
$this->options['bypass_shell'] = true;
288300
}
289301
}
290302

291-
$this->process = proc_open($commandline, $descriptors, $this->processPipes->pipes, $this->cwd, $this->env, $this->options);
303+
$this->process = proc_open($commandline->prepareForexecution(), $descriptors, $this->processPipes->pipes, $this->cwd, $this->env, $this->options);
292304

293305
if (!is_resource($this->process)) {
294306
throw new RuntimeException('Unable to launch a new process.');
@@ -840,14 +852,38 @@ public function addErrorOutput($line)
840852
$this->stderr .= $line;
841853
}
842854

855+
/**
856+
* Gets the command to be executed.
857+
*
858+
* @return Command The command to execute
859+
*/
860+
public function getCommand()
861+
{
862+
return $this->commandline;
863+
}
864+
865+
/**
866+
* Gets the command to be executed.
867+
*
868+
* @param Command $command The command to execute
869+
*
870+
* @return Command The command to execute
871+
*/
872+
public function setCommand(Command $command)
873+
{
874+
return $this->commandline = $command;
875+
}
876+
843877
/**
844878
* Gets the command line to be executed.
845879
*
846880
* @return string The command to execute
881+
*
882+
* @deprecated Deprecated since Symfony 2.6 in favor of setCommand, to be removed in Symfony 3.0
847883
*/
848884
public function getCommandLine()
849885
{
850-
return $this->commandline;
886+
return (string) $this->commandline;
851887
}
852888

853889
/**
@@ -856,10 +892,12 @@ public function getCommandLine()
856892
* @param string $commandline The command to execute
857893
*
858894
* @return self The current Process instance
895+
*
896+
* @deprecated Deprecated since Symfony 2.6 in favor of setCommand, to be removed in Symfony 3.0
859897
*/
860898
public function setCommandLine($commandline)
861899
{
862-
$this->commandline = $commandline;
900+
$this->commandline = Command::fromString($commandline);
863901

864902
return $this;
865903
}
@@ -1256,13 +1294,6 @@ private function getDescriptors()
12561294
}
12571295
$descriptors = $this->processPipes->getDescriptors($this->outputDisabled);
12581296

1259-
if (!$this->useFileHandles && $this->enhanceSigchildCompatibility && $this->isSigchildEnabled()) {
1260-
// last exit code is output on the fourth pipe and caught to work around --enable-sigchild
1261-
$descriptors = array_merge($descriptors, array(array('pipe', 'w')));
1262-
1263-
$this->commandline = '('.$this->commandline.') 3>/dev/null; code=$?; echo $code >&3; exit $code';
1264-
}
1265-
12661297
return $descriptors;
12671298
}
12681299

‎src/Symfony/Component/Process/ProcessUtils.php

Lines changed: 6 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,9 @@
1919
* This class contains static methods only and is not meant to be instantiated.
2020
*
2121
* @author Martin Hasoň <[email protected]>
22+
*
23+
* @internal
24+
* @deprecated Deprecated as of Symfony 2.6, to be removed in symfony 3.0
2225
*/
2326
class ProcessUtils
2427
{
@@ -35,43 +38,12 @@ private function __construct()
3538
* @param string $argument The argument that will be escaped
3639
*
3740
* @return string The escaped argument
41+
*
42+
* @deprecated Deprecated as of Symfony 2.6, to be removed in symfony 3.0
3843
*/
3944
public static function escapeArgument($argument)
4045
{
41-
//Fix for PHP bug #43784 escapeshellarg removes % from given string
42-
//Fix for PHP bug #49446 escapeshellarg doesn't work on Windows
43-
//@see https://bugs.php.net/bug.php?id=43784
44-
//@see https://bugs.php.net/bug.php?id=49446
45-
if (defined('PHP_WINDOWS_VERSION_BUILD')) {
46-
if ('' === $argument) {
47-
return escapeshellarg($argument);
48-
}
49-
50-
$escapedArgument = '';
51-
$quote = false;
52-
foreach (preg_split('/(")/i', $argument, -1, PREG_SPLIT_NO_EMPTY | PREG_SPLIT_DELIM_CAPTURE) as $part) {
53-
if ('"' === $part) {
54-
$escapedArgument .= '\\"';
55-
} elseif (self::isSurroundedBy($part, '%')) {
56-
// Avoid environment variable expansion
57-
$escapedArgument .= '^%"'.substr($part, 1, -1).'"^%';
58-
} else {
59-
// escape trailing backslash
60-
if ('\\' === substr($part, -1)) {
61-
$part .= '\\';
62-
}
63-
$quote = true;
64-
$escapedArgument .= $part;
65-
}
66-
}
67-
if ($quote) {
68-
$escapedArgument = '"'.$escapedArgument.'"';
69-
}
70-
71-
return $escapedArgument;
72-
}
73-
74-
return escapeshellarg($argument);
46+
return Command::escape($argument);
7547
}
7648

7749
/**
@@ -103,9 +75,4 @@ public static function validateInput($caller, $input)
10375

10476
return $input;
10577
}
106-
107-
private static function isSurroundedBy($arg, $char)
108-
{
109-
return 2 < strlen($arg) && $char === $arg[0] && $char === $arg[strlen($arg) - 1];
110-
}
11178
}

‎src/Symfony/Component/Process/Tests/CommandTest.php

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
<?php
2+
3+

0 commit comments

Comments
 (0)