diff --git a/src/Symfony/Component/Process/Process.php b/src/Symfony/Component/Process/Process.php index 9f09407323a9..94ce99120025 100644 --- a/src/Symfony/Component/Process/Process.php +++ b/src/Symfony/Component/Process/Process.php @@ -38,6 +38,7 @@ class Process // Timeout Precision in seconds. const TIMEOUT_PRECISION = 0.2; + private $callback; private $commandline; private $cwd; private $env; @@ -164,6 +165,7 @@ public function __destruct() public function __clone() { + $this->callback = null; $this->exitcode = null; $this->fallbackExitcode = null; $this->processInformation = null; @@ -199,7 +201,7 @@ public function run($callback = null) { $this->start($callback); - return $this->wait($callback); + return $this->wait(); } /** @@ -234,7 +236,7 @@ public function start($callback = null) $this->stderr = ''; $this->incrementalOutputOffset = 0; $this->incrementalErrorOutputOffset = 0; - $callback = $this->buildCallback($callback); + $this->callback = $this->buildCallback($callback); //Fix for PHP bug #51800: reading from STDOUT pipe hangs forever on Windows if the output is too big. //Workaround for this problem is to use temporary files instead of pipes on Windows platform. @@ -285,67 +287,9 @@ public function start($callback = null) stream_set_blocking($pipe, false); } - if (null === $this->stdin) { - fclose($this->pipes[0]); - unset($this->pipes[0]); - - return; - } - - $writePipes = array($this->pipes[0]); - unset($this->pipes[0]); - $stdinLen = strlen($this->stdin); - $stdinOffset = 0; - - while ($writePipes) { - if (defined('PHP_WINDOWS_VERSION_BUILD')) { - $this->processFileHandles($callback); - } - - $r = $this->pipes; - $w = $writePipes; - $e = null; - - if (false === $n = @stream_select($r, $w, $e, 0, ceil(static::TIMEOUT_PRECISION * 1E6))) { - // if a system call has been interrupted, forget about it, let's try again - if ($this->hasSystemCallBeenInterrupted()) { - continue; - } - break; - } - - // nothing has changed, let's wait until the process is ready - if (0 === $n) { - continue; - } - - if ($w) { - $written = fwrite($writePipes[0], (binary) substr($this->stdin, $stdinOffset), 8192); - if (false !== $written) { - $stdinOffset += $written; - } - if ($stdinOffset >= $stdinLen) { - fclose($writePipes[0]); - $writePipes = null; - } - } - - foreach ($r as $pipe) { - $type = array_search($pipe, $this->pipes); - $data = fread($pipe, 8192); - if (strlen($data) > 0) { - call_user_func($callback, $type == 1 ? self::OUT : self::ERR, $data); - } - if (false === $data || feof($pipe)) { - fclose($pipe); - unset($this->pipes[$type]); - } - } - - $this->checkTimeout(); - } - - $this->updateStatus(); + $this->writePipes(false); + $this->updateStatus(false); + $this->checkTimeout(); } /** @@ -391,55 +335,15 @@ public function restart($callback = null) */ public function wait($callback = null) { - $this->updateStatus(); - $callback = $this->buildCallback($callback); - while ($this->pipes || (defined('PHP_WINDOWS_VERSION_BUILD') && $this->fileHandles)) { - if (defined('PHP_WINDOWS_VERSION_BUILD') && $this->fileHandles) { - $this->processFileHandles($callback, !$this->pipes); - } + $this->updateStatus(false); + if (null !== $callback) { + $this->callback = $this->buildCallback($callback); + } + while ($this->processInformation['running']) { + $this->updateStatus(true); $this->checkTimeout(); - - if ($this->pipes) { - $r = $this->pipes; - $w = null; - $e = null; - - // let's have a look if something changed in streams - if (false === $n = @stream_select($r, $w, $e, 0, ceil(static::TIMEOUT_PRECISION * 1E6))) { - // if a system call has been interrupted, forget about it, let's try again - // otherwise, an error occured, let's reset pipes - if (!$this->hasSystemCallBeenInterrupted()) { - $this->pipes = array(); - } - - continue; - } - - // nothing has changed - if (0 === $n) { - continue; - } - - foreach ($r as $pipe) { - $type = array_search($pipe, $this->pipes); - $data = fread($pipe, 8192); - - if (strlen($data) > 0) { - // last exit code is output and caught to work around --enable-sigchild - if (3 == $type) { - $this->fallbackExitcode = (int) $data; - } else { - call_user_func($callback, $type == 1 ? self::OUT : self::ERR, $data); - } - } - if (false === $data || feof($pipe)) { - fclose($pipe); - unset($this->pipes[$type]); - } - } - } } - $this->updateStatus(); + $this->updateStatus(false); if ($this->processInformation['signaled']) { if ($this->isSigchildEnabled()) { throw new RuntimeException('The process has been signaled.'); @@ -482,7 +386,7 @@ public function wait($callback = null) */ public function getOutput() { - $this->updateOutput(); + $this->readPipes(false); return $this->stdout; } @@ -514,7 +418,7 @@ public function getIncrementalOutput() */ public function getErrorOutput() { - $this->updateErrorOutput(); + $this->readPipes(false); return $this->stderr; } @@ -553,7 +457,7 @@ public function getExitCode() throw new RuntimeException('This PHP has been compiled with --enable-sigchild. You must use setEnhanceSigchildCompatibility() to use this method'); } - $this->updateStatus(); + $this->updateStatus(false); return $this->exitcode; } @@ -605,7 +509,7 @@ public function hasBeenSignaled() throw new RuntimeException('This PHP has been compiled with --enable-sigchild. Term signal can not be retrieved'); } - $this->updateStatus(); + $this->updateStatus(false); return $this->processInformation['signaled']; } @@ -627,7 +531,7 @@ public function getTermSignal() throw new RuntimeException('This PHP has been compiled with --enable-sigchild. Term signal can not be retrieved'); } - $this->updateStatus(); + $this->updateStatus(false); return $this->processInformation['termsig']; } @@ -643,7 +547,7 @@ public function getTermSignal() */ public function hasBeenStopped() { - $this->updateStatus(); + $this->updateStatus(false); return $this->processInformation['stopped']; } @@ -659,7 +563,7 @@ public function hasBeenStopped() */ public function getStopSignal() { - $this->updateStatus(); + $this->updateStatus(false); return $this->processInformation['stopsig']; } @@ -675,7 +579,7 @@ public function isRunning() return false; } - $this->updateStatus(); + $this->updateStatus(false); return $this->processInformation['running']; } @@ -697,7 +601,7 @@ public function isStarted() */ public function isTerminated() { - $this->updateStatus(); + $this->updateStatus(false); return $this->status == self::STATUS_TERMINATED; } @@ -711,7 +615,7 @@ public function isTerminated() */ public function getStatus() { - $this->updateStatus(); + $this->updateStatus(false); return $this->status; } @@ -1062,14 +966,18 @@ protected function buildCallback($callback) } /** - * Updates the status of the process. + * Updates the status of the process, reads pipes. + * + * @param Boolean $blocking Whether to use a clocking read call. */ - protected function updateStatus() + protected function updateStatus($blocking) { if (self::STATUS_STARTED !== $this->status) { return; } + $this->readPipes($blocking); + $this->processInformation = proc_get_status($this->process); if (!$this->processInformation['running']) { $this->status = self::STATUS_TERMINATED; @@ -1079,29 +987,6 @@ protected function updateStatus() } } - /** - * Updates the current error output of the process (STDERR). - */ - protected function updateErrorOutput() - { - if (isset($this->pipes[self::STDERR]) && is_resource($this->pipes[self::STDERR])) { - $this->addErrorOutput(stream_get_contents($this->pipes[self::STDERR])); - } - } - - /** - * Updates the current output of the process (STDOUT). - */ - protected function updateOutput() - { - if (defined('PHP_WINDOWS_VERSION_BUILD') && isset($this->fileHandles[self::STDOUT]) && is_resource($this->fileHandles[self::STDOUT])) { - fseek($this->fileHandles[self::STDOUT], $this->readBytes[self::STDOUT]); - $this->addOutput(stream_get_contents($this->fileHandles[self::STDOUT])); - } elseif (isset($this->pipes[self::STDOUT]) && is_resource($this->pipes[self::STDOUT])) { - $this->addOutput(stream_get_contents($this->pipes[self::STDOUT])); - } - } - /** * Return whether PHP has been compiled with the '--enable-sigchild' option or not * @@ -1122,10 +1007,9 @@ protected function isSigchildEnabled() /** * Handles the windows file handles fallbacks * - * @param callable $callback A valid PHP callback - * @param Boolean $closeEmptyHandles if true, handles that are empty will be assumed closed + * @param Boolean $closeEmptyHandles if true, handles that are empty will be assumed closed */ - private function processFileHandles($callback, $closeEmptyHandles = false) + private function processFileHandles($closeEmptyHandles = false) { $fh = $this->fileHandles; foreach ($fh as $type => $fileHandle) { @@ -1133,7 +1017,7 @@ private function processFileHandles($callback, $closeEmptyHandles = false) $data = fread($fileHandle, 8192); if (strlen($data) > 0) { $this->readBytes[$type] += strlen($data); - call_user_func($callback, $type == 1 ? self::OUT : self::ERR, $data); + call_user_func($this->callback, $type == 1 ? self::OUT : self::ERR, $data); } if (false === $data || ($closeEmptyHandles && '' === $data && feof($fileHandle))) { fclose($fileHandle); @@ -1154,4 +1038,106 @@ private function hasSystemCallBeenInterrupted() // stream_select returns false when the `select` system call is interrupted by an incoming signal return isset($lastError['message']) && false !== stripos($lastError['message'], 'interrupted system call'); } + + /** + * Reads pipes, executes callback. + * + * @param Boolean $blocking Whether to use blocking calls or not. + */ + private function readPipes($blocking) + { + if (defined('PHP_WINDOWS_VERSION_BUILD') && $this->fileHandles) { + $this->processFileHandles(!$this->pipes); + } + + if ($this->pipes) { + $r = $this->pipes; + $w = null; + $e = null; + + // let's have a look if something changed in streams + if (false === $n = @stream_select($r, $w, $e, 0, $blocking ? ceil(self::TIMEOUT_PRECISION * 1E6) : 0)) { + // if a system call has been interrupted, forget about it, let's try again + // otherwise, an error occured, let's reset pipes + if (!$this->hasSystemCallBeenInterrupted()) { + $this->pipes = array(); + } + + return; + } + + // nothing has changed + if (0 === $n) { + return; + } + + foreach ($r as $pipe) { + $type = array_search($pipe, $this->pipes); + $data = fread($pipe, 8192); + + if (strlen($data) > 0) { + // last exit code is output and caught to work around --enable-sigchild + if (3 == $type) { + $this->fallbackExitcode = (int) $data; + } else { + call_user_func($this->callback, $type == 1 ? self::OUT : self::ERR, $data); + } + } + if (false === $data || feof($pipe)) { + fclose($pipe); + unset($this->pipes[$type]); + } + } + } + } + + /** + * Writes data to pipes. + * + * @param Boolean $blocking Whether to use blocking calls or not. + */ + private function writePipes($blocking) + { + if (null === $this->stdin) { + fclose($this->pipes[0]); + unset($this->pipes[0]); + + return; + } + + $writePipes = array($this->pipes[0]); + unset($this->pipes[0]); + $stdinLen = strlen($this->stdin); + $stdinOffset = 0; + + while ($writePipes) { + $r = array(); + $w = $writePipes; + $e = null; + + if (false === $n = @stream_select($r, $w, $e, 0, $blocking ? ceil(static::TIMEOUT_PRECISION * 1E6) : 0)) { + // if a system call has been interrupted, forget about it, let's try again + if ($this->hasSystemCallBeenInterrupted()) { + continue; + } + break; + } + + // nothing has changed, let's wait until the process is ready + if (0 === $n) { + continue; + } + + if ($w) { + $written = fwrite($writePipes[0], (binary) substr($this->stdin, $stdinOffset), 8192); + if (false !== $written) { + $stdinOffset += $written; + } + if ($stdinOffset >= $stdinLen) { + fclose($writePipes[0]); + $writePipes = null; + } + } + } + } }