command = $command; $this->cwd = $cwd ?? ""; foreach ($env as $key => $value) { if (\is_array($value)) { throw new \Error("\$env cannot accept array values"); } $this->env[(string) $key] = (string) $value; } $this->options = $options; } /** * Stops the process if it is still running. */ public function __destruct() { if (\getmypid() === $this->oid) { $this->kill(); // Will only terminate if the process is still running. } if ($this->watcher !== null) { Loop::cancel($this->watcher); } if (\is_resource($this->process)) { \proc_close($this->process); } if ($this->stdin && \is_resource($resource = $this->stdin->getResource())) { \fclose($resource); } if ($this->stdout && \is_resource($resource = $this->stdout->getResource())) { \fclose($resource); } if ($this->stderr && \is_resource($resource = $this->stderr->getResource())) { \fclose($resource); } } /** * Resets process values. */ public function __clone() { $this->process = null; $this->deferred = null; $this->watcher = null; $this->pid = 0; $this->oid = 0; $this->stdin = null; $this->stdout = null; $this->stderr = null; $this->running = false; } /** * @throws \Amp\Process\ProcessException If starting the process fails. * @throws \Amp\Process\StatusError If the process is already running. */ public function start() { if ($this->deferred !== null) { throw new StatusError("The process has already been started"); } $this->deferred = $deferred = new Deferred; $fd = [ ["pipe", "r"], // stdin ["pipe", "w"], // stdout ["pipe", "w"], // stderr ["pipe", "w"], // exit code pipe ]; if (self::$onWindows) { $command = $this->command; } else { $command = \sprintf( '{ (%s) <&3 3<&- 3>/dev/null & } 3<&0;' . 'pid=$!; echo $pid >&3; wait $pid; RC=$?; echo $RC >&3; exit $RC', $this->command ); } $this->process = @\proc_open($command, $fd, $pipes, $this->cwd ?: null, $this->env ?: null, $this->options); if (!\is_resource($this->process)) { $message = "Could not start process"; if ($error = \error_get_last()) { $message .= \sprintf(" Errno: %d; %s", $error["type"], $error["message"]); } $deferred->fail(new ProcessException($message)); return; } $this->oid = \getmypid(); $status = \proc_get_status($this->process); if (!$status) { \proc_close($this->process); $this->process = null; $deferred->fail(new ProcessException("Could not get process status")); return; } if (self::$onWindows) { $this->pid = $status["pid"]; } else { // This blocking read will only block until the process scheduled, generally a few microseconds. $pid = \rtrim(@\fgets($pipes[3])); if (!$pid || !\is_numeric($pid)) { $deferred->fail(new ProcessException("Could not determine PID")); return; } $this->pid = (int) $pid; } $this->stdin = new ResourceOutputStream($pipes[0]); $this->stdout = new ResourceInputStream($pipes[1]); $this->stderr = new ResourceInputStream($pipes[2]); \stream_set_blocking($pipes[3], false); $this->running = true; $process = &$this->process; $running = &$this->running; $this->watcher = Loop::onReadable($pipes[3], static function ($watcher, $resource) use ( &$process, &$running, $deferred ) { Loop::cancel($watcher); $running = false; try { try { if (!\is_resource($resource) || \feof($resource)) { throw new ProcessException("Process ended unexpectedly"); } if (self::$onWindows) { $code = \proc_get_status($process)["exitcode"]; } else { $code = \rtrim(@\stream_get_contents($resource)); } } finally { if (\is_resource($resource)) { \fclose($resource); } } } catch (\Throwable $exception) { $deferred->fail($exception); return; } $deferred->resolve((int) $code); }); Loop::unreference($this->watcher); } /** * @return \Amp\Promise Succeeds with exit code of the process or fails if the process is killed. */ public function join(): Promise { if ($this->deferred === null) { throw new StatusError("The process is not running"); } if ($this->watcher !== null && $this->running) { Loop::reference($this->watcher); } return $this->deferred->promise(); } /** * {@inheritdoc} */ public function kill() { if ($this->running && \is_resource($this->process)) { $this->running = false; // Forcefully kill the process using SIGKILL. \proc_terminate($this->process, 9); Loop::cancel($this->watcher); $this->deferred->fail(new ProcessException("The process was killed")); } } /** * Sends the given signal to the process. * * @param int $signo Signal number to send to process. * * @throws \Amp\Process\StatusError If the process is not running. */ public function signal(int $signo) { if (!$this->isRunning()) { throw new StatusError("The process is not running"); } \proc_terminate($this->process, $signo); } /** * Returns the PID of the child process. Value is only meaningful if PHP was not compiled with --enable-sigchild. * * @return int * * @throws \Amp\Process\StatusError */ public function getPid(): int { if ($this->pid === 0) { throw new StatusError("The process has not been started"); } return $this->pid; } /** * Returns the command to execute. * * @return string The command to execute. */ public function getCommand(): string { return $this->command; } /** * Gets the current working directory. * * @return string The current working directory an empty string if inherited from the current PHP process. */ public function getWorkingDirectory(): string { if ($this->cwd === "") { return \getcwd() ?: ""; } return $this->cwd; } /** * Gets the environment variables array. * * @return string[] Array of environment variables. */ public function getEnv(): array { return $this->env; } /** * Gets the options to pass to proc_open(). * * @return mixed[] Array of options. */ public function getOptions(): array { return $this->options; } /** * Determines if the process is still running. * * @return bool */ public function isRunning(): bool { return $this->running; } /** * Gets the process input stream (STDIN). * * @return \Amp\ByteStream\OutputStream * * @throws \Amp\Process\StatusError If the process is not running. */ public function getStdin(): OutputStream { if ($this->stdin === null) { throw new StatusError("The process has not been started"); } return $this->stdin; } /** * Gets the process output stream (STDOUT). * * @return \Amp\ByteStream\InputStream * * @throws \Amp\Process\StatusError If the process is not running. */ public function getStdout(): InputStream { if ($this->stdout === null) { throw new StatusError("The process has not been started"); } return $this->stdout; } /** * Gets the process error stream (STDERR). * * @return \Amp\ByteStream\InputStream * * @throws \Amp\Process\StatusError If the process is not running. */ public function getStderr(): InputStream { if ($this->stderr === null) { throw new StatusError("The process has not been started"); } return $this->stderr; } }