1
0
mirror of https://github.com/danog/parallel.git synced 2024-12-12 09:09:35 +01:00
parallel/lib/Context/Process.php

376 lines
11 KiB
PHP
Raw Normal View History

2016-12-30 02:16:04 +01:00
<?php
2015-08-27 16:10:08 +02:00
namespace Amp\Parallel\Context;
2015-08-27 16:10:08 +02:00
use Amp\Loop;
2017-05-18 09:51:31 +02:00
use Amp\Parallel\Sync\ChannelException;
use Amp\Parallel\Sync\ExitResult;
2017-12-08 04:26:55 +01:00
use Amp\Parallel\Sync\SynchronizationError;
use Amp\Process\Process as BaseProcess;
use Amp\Process\ProcessInputStream;
use Amp\Process\ProcessOutputStream;
2017-05-18 09:51:31 +02:00
use Amp\Promise;
use function Amp\call;
2016-08-18 18:04:48 +02:00
2018-10-21 17:54:46 +02:00
final class Process implements Context
2018-10-07 16:50:45 +02:00
{
const SCRIPT_PATH = __DIR__ . "/Internal/process-runner.php";
const KEY_LENGTH = 32;
2018-01-22 15:03:31 +01:00
/** @var string|null External version of SCRIPT_PATH if inside a PHAR. */
private static $pharScriptPath;
/** @var string|null PHAR path with a '.phar' extension. */
private static $pharCopy;
/** @var string|null Cached path to located PHP binary. */
private static $binaryPath;
/** @var Internal\ProcessHub */
private $hub;
2017-01-16 19:56:49 +01:00
/** @var \Amp\Process\Process */
2015-08-27 16:10:08 +02:00
private $process;
/** @var \Amp\Parallel\Sync\ChannelledSocket */
2015-08-27 16:10:08 +02:00
private $channel;
/**
* Creates and starts the process at the given path using the optional PHP binary path.
*
* @param string|array $script Path to PHP script or array with first element as path and following elements options
* to the PHP script (e.g.: ['bin/worker', 'Option1Value', 'Option2Value'].
* @param string|null $cwd Working directory.
* @param mixed[] $env Array of environment variables.
* @param string $binary Path to PHP binary. Null will attempt to automatically locate the binary.
*
* @return Promise<Process>
*/
2018-10-07 16:50:45 +02:00
public static function run($script, string $cwd = null, array $env = [], string $binary = null): Promise
{
$process = new self($script, $cwd, $env, $binary);
return call(function () use ($process) {
yield $process->start();
return $process;
});
}
2015-08-27 16:10:08 +02:00
/**
* @param string|array $script Path to PHP script or array with first element as path and following elements options
* to the PHP script (e.g.: ['bin/worker', 'Option1Value', 'Option2Value'].
* @param string|null $cwd Working directory.
* @param mixed[] $env Array of environment variables.
* @param string $binary Path to PHP binary. Null will attempt to automatically locate the binary.
*
* @throws \Error If the PHP binary path given cannot be found or is not executable.
2015-08-27 16:10:08 +02:00
*/
2018-10-07 16:50:45 +02:00
public function __construct($script, string $cwd = null, array $env = [], string $binary = null)
{
$this->hub = Loop::getState(self::class);
if (!$this->hub instanceof Internal\ProcessHub) {
$this->hub = new Internal\ProcessHub;
Loop::setState(self::class, $this->hub);
}
2017-06-21 17:30:26 +02:00
$options = [
"html_errors" => "0",
"display_errors" => "0",
"log_errors" => "1",
];
if ($binary === null) {
if (\PHP_SAPI === "cli") {
$binary = \PHP_BINARY;
} else {
$binary = self::$binaryPath ?? self::locateBinary();
}
} elseif (!\is_executable($binary)) {
throw new \Error(\sprintf("The PHP binary path '%s' was not found or is not executable", $binary));
}
2018-01-22 15:03:31 +01:00
// Write process runner to external file if inside a PHAR,
// because PHP can't open files inside a PHAR directly except for the stub.
if (\strpos(self::SCRIPT_PATH, "phar://") === 0) {
if (self::$pharScriptPath) {
$scriptPath = self::$pharScriptPath;
} else {
$path = \dirname(self::SCRIPT_PATH);
if (\substr(\Phar::running(false), -5) !== ".phar") {
self::$pharCopy = \sys_get_temp_dir() . "/phar-" . \bin2hex(\random_bytes(10)) . ".phar";
\copy(\Phar::running(false), self::$pharCopy);
\register_shutdown_function(static function () {
@\unlink(self::$pharCopy);
});
$path = "phar://" . self::$pharCopy . "/" . \substr($path, \strlen(\Phar::running(true)));
}
2018-01-22 15:03:31 +01:00
$contents = \file_get_contents(self::SCRIPT_PATH);
$contents = \str_replace("__DIR__", \var_export($path, true), $contents);
$suffix = \bin2hex(\random_bytes(10));
self::$pharScriptPath = $scriptPath = \sys_get_temp_dir() . "/amp-process-runner-" . $suffix . ".php";
2018-01-22 15:03:31 +01:00
\file_put_contents($scriptPath, $contents);
\register_shutdown_function(static function () {
@\unlink(self::$pharScriptPath);
});
}
// Monkey-patch the script path in the same way, only supported if the command is given as array.
if (isset(self::$pharCopy) && \is_array($script) && isset($script[0])) {
$script[0] = "phar://" . self::$pharCopy . \substr($script[0], \strlen(\Phar::running(true)));
}
2018-01-22 15:03:31 +01:00
} else {
$scriptPath = self::SCRIPT_PATH;
}
if (\is_array($script)) {
$script = \implode(" ", \array_map("escapeshellarg", $script));
} else {
$script = \escapeshellarg($script);
}
$command = \implode(" ", [
\escapeshellarg($binary),
$this->formatOptions($options),
\escapeshellarg($scriptPath),
$this->hub->getUri(),
$script,
]);
$this->process = new BaseProcess($command, $cwd, $env);
2015-08-27 16:10:08 +02:00
}
2018-10-07 16:50:45 +02:00
private static function locateBinary(): string
{
$executable = \strncasecmp(\PHP_OS, "WIN", 3) === 0 ? "php.exe" : "php";
2018-01-22 23:15:09 +01:00
$paths = \array_filter(\explode(\PATH_SEPARATOR, \getenv("PATH")));
$paths[] = \PHP_BINDIR;
$paths = \array_unique($paths);
foreach ($paths as $path) {
$path .= \DIRECTORY_SEPARATOR . $executable;
if (\is_executable($path)) {
return self::$binaryPath = $path;
}
}
throw new \Error("Could not locate PHP executable binary");
}
2018-10-07 16:50:45 +02:00
private function formatOptions(array $options)
{
2017-06-21 17:30:26 +02:00
$result = [];
foreach ($options as $option => $value) {
$result[] = \sprintf("-d%s=%s", $option, $value);
2017-06-21 17:30:26 +02:00
}
return \implode(" ", $result);
}
/**
* Private method to prevent cloning.
*/
2018-10-07 16:50:45 +02:00
private function __clone()
{
}
2015-08-27 16:10:08 +02:00
/**
* {@inheritdoc}
*/
2018-10-07 16:50:45 +02:00
public function start(): Promise
{
return call(function () {
try {
$pid = yield $this->process->start();
yield $this->process->getStdin()->write($this->hub->generateKey($pid, self::KEY_LENGTH));
$this->channel = yield $this->hub->accept($pid);
2018-11-04 18:34:18 +01:00
return $pid;
} catch (\Throwable $exception) {
$this->process->kill();
throw new ContextException("Starting the process failed", 0, $exception);
}
});
2015-08-27 16:10:08 +02:00
}
/**
* {@inheritdoc}
*/
2018-10-07 16:50:45 +02:00
public function isRunning(): bool
{
2015-08-27 16:10:08 +02:00
return $this->process->isRunning();
}
/**
* {@inheritdoc}
*/
2018-10-07 16:50:45 +02:00
public function receive(): Promise
{
2016-08-23 01:25:19 +02:00
if ($this->channel === null) {
throw new StatusError("The process has not been started");
2015-08-27 16:10:08 +02:00
}
return call(function () {
try {
$data = yield $this->channel->receive();
} catch (ChannelException $e) {
throw new ContextException("The context stopped responding, potentially due to a fatal error or calling exit", 0, $e);
}
if ($data instanceof ExitResult) {
$data = $data->getResult();
throw new SynchronizationError(\sprintf(
'Process unexpectedly exited with result of type: %s',
\is_object($data) ? \get_class($data) : \gettype($data)
));
}
2017-03-09 23:48:34 +01:00
return $data;
});
2015-08-27 16:10:08 +02:00
}
/**
* {@inheritdoc}
*/
2018-10-07 16:50:45 +02:00
public function send($data): Promise
{
2016-08-23 01:25:19 +02:00
if ($this->channel === null) {
throw new StatusError("The process has not been started");
}
2017-01-17 06:24:59 +01:00
if ($data instanceof ExitResult) {
throw new \Error("Cannot send exit result objects");
2015-08-27 16:10:08 +02:00
}
2017-12-13 23:29:44 +01:00
return $this->channel->send($data);
2015-08-27 16:10:08 +02:00
}
/**
* {@inheritdoc}
*/
2018-10-07 16:50:45 +02:00
public function join(): Promise
{
2017-01-16 19:56:49 +01:00
if ($this->channel === null) {
throw new StatusError("The process has not been started");
}
return call(function () {
try {
$data = yield $this->channel->receive();
} catch (\Throwable $exception) {
if ($this->isRunning()) {
$this->kill();
}
throw new ContextException("Failed to receive result from process", 0, $exception);
2017-01-16 19:56:49 +01:00
}
if (!$data instanceof ExitResult) {
if ($this->isRunning()) {
$this->kill();
}
throw new SynchronizationError("Did not receive an exit result from process");
}
$this->channel->close();
$code = yield $this->process->join();
if ($code !== 0) {
throw new ContextException(\sprintf("Process exited with code %d", $code));
}
2017-01-16 19:56:49 +01:00
return $data->getResult();
});
2015-08-27 16:10:08 +02:00
}
/**
* Send a signal to the process.
*
* @see \Amp\Process\Process::signal()
*
* @param int $signo
*
* @throws \Amp\Process\ProcessException
* @throws \Amp\Process\StatusError
*/
2018-10-07 16:50:45 +02:00
public function signal(int $signo)
{
$this->process->signal($signo);
}
/**
* Returns the PID of the process.
*
* @see \Amp\Process\Process::getPid()
*
* @return int
*
* @throws \Amp\Process\StatusError
*/
public function getPid(): int
2018-10-07 16:50:45 +02:00
{
return $this->process->getPid();
}
/**
* Returns the STDIN stream of the process.
*
* @see \Amp\Process\Process::getStdin()
*
* @return ProcessOutputStream
*
* @throws \Amp\Process\StatusError
*/
public function getStdin(): ProcessOutputStream
{
return $this->process->getStdin();
}
/**
* Returns the STDOUT stream of the process.
*
* @see \Amp\Process\Process::getStdout()
*
* @return ProcessInputStream
*
* @throws \Amp\Process\StatusError
*/
public function getStdout(): ProcessInputStream
{
return $this->process->getStdout();
}
/**
* Returns the STDOUT stream of the process.
*
* @see \Amp\Process\Process::getStderr()
*
* @return ProcessInputStream
*
* @throws \Amp\Process\StatusError
*/
public function getStderr(): ProcessInputStream
{
return $this->process->getStderr();
}
2015-08-27 16:10:08 +02:00
/**
* {@inheritdoc}
*/
2018-10-07 16:50:45 +02:00
public function kill()
{
2015-08-27 16:10:08 +02:00
$this->process->kill();
if ($this->channel !== null) {
$this->channel->close();
}
2015-08-27 16:10:08 +02:00
}
}