PhutilExecPassthru.php
View Options

	<?php

	/**
	* Execute a command which takes over stdin, stdout and stderr, similar to
	* `passthru()`, but which preserves TTY semantics, escapes arguments, and is
	* traceable.
	*
	* Passthru commands use the `STDIN`, `STDOUT` and `STDERR` of the parent
	* process, so input can be read from the console and output is printed to it.
	* This is primarily useful for executing things like `$EDITOR` from command
	* line scripts.
	*
	* $exec = new PhutilExecPassthru('nano -- %s', $filename);
	* $err = $exec->resolve();
	*
	* You can set the current working directory for the command with
	* @{method:setCWD}, and set the environment with @{method:setEnv}.
	*
	* @task command Executing Passthru Commands
	*/
	final class PhutilExecPassthru extends PhutilExecutableFuture {

	private $stdinData;

	public function write($data) {
	$this->stdinData = $data;
	return $this;
	}

	/* -( Executing Passthru Commands )---------------------------------------- */


	public function execute() {
	phlog(
	pht(
	'The "execute()" method of "PhutilExecPassthru" is deprecated and '.
	'calls should be replaced with "resolve()". See T13660.'));
	return $this->resolve();
	}

	/**
	* Execute this command.
	*
	* @return int Error code returned by the subprocess.
	*
	* @task command
	*/
	private function executeCommand() {
	$command = $this->getCommand();

	$is_write = ($this->stdinData !== null);

	if ($is_write) {
	$stdin_spec = array('pipe', 'r');
	} else {
	$stdin_spec = PhutilSystem::getStdinHandle();
	}

	$spec = array(
	$stdin_spec,
	PhutilSystem::getStdoutHandle(),
	PhutilSystem::getStderrHandle(),
	);
	$pipes = array();

	$unmasked_command = $command->getUnmaskedString();

	if ($this->hasEnv()) {
	$env = $this->getEnv();
	} else {
	$env = null;
	}

	$cwd = $this->getCWD();

	$options = array();
	if (phutil_is_windows()) {
	// Without 'bypass_shell', things like launching vim don't work properly,
	// and we can't execute commands with spaces in them, and all commands
	// invoked from git bash fail horridly, and everything is a mess in
	// general.
	$options['bypass_shell'] = true;
	}

	$trap = new PhutilErrorTrap();
	$proc = @proc_open(
	$unmasked_command,
	$spec,
	$pipes,
	$cwd,
	$env,
	$options);
	$errors = $trap->getErrorsAsString();
	$trap->destroy();

	if (!is_resource($proc)) {
	// See T13504. When "proc_open()" is given a command with a binary
	// that isn't available on Windows with "bypass_shell", the function
	// fails entirely.
	if (phutil_is_windows()) {
	$err = 1;
	} else {
	throw new Exception(
	pht(
	'Failed to passthru %s: %s',
	'proc_open()',
	$errors));
	}
	} else {
	if ($is_write) {
	fwrite($pipes[0], $this->stdinData);
	fclose($pipes[0]);
	}

	$err = proc_close($proc);
	}

	return $err;
	}


	/* -( Future )------------------------------------------------------------- */


	public function isReady() {
	// This isn't really a future because it executes synchronously and has
	// full control of the console. We're just implementing the interfaces to
	// make it easier to share code with ExecFuture.

	if (!$this->hasResult()) {
	$result = $this->executeCommand();
	$this->setResult($result);
	}

	return true;
	}



	protected function getServiceProfilerStartParameters() {
	return array(
	'type' => 'exec',
	'subtype' => 'passthru',
	'command' => phutil_string_cast($this->getCommand()),
	);
	}

	protected function getServiceProfilerResultParameters() {
	if ($this->hasResult()) {
	$err = $this->getResult();
	} else {
	$err = null;
	}

	return array(
	'err' => $err,
	);
	}

	}

File Metadata

Mime Type: text/x-php
Expires: Sun, Jan 19, 18:15 (1 w, 4 d ago)
Storage Engine: blob
Storage Format: Raw Data
Storage Handle: 1119994
Default Alt Text: PhutilExecPassthru.php (3 KB)

PhutilExecPassthru.php
No OneTemporary
Actions

PhutilExecPassthru.php
View Options

File Metadata

Event Timeline

PhutilExecPassthru.phpNo OneTemporaryActions

PhutilExecPassthru.phpView Options

File Metadata

Event Timeline

PhutilExecPassthru.php
No OneTemporary
Actions

PhutilExecPassthru.php
View Options