Executor

Complexity

Total Complexity

7

Size/Duplication

Total Lines	55
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Importance

Changes

0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	execLocal()	0	4	1
A	execRemote()	0	4	1
A	createLocal()	0	6	2
A	createRemote()	0	5	1
A	commandArrayToString()	0	7	2

<?php

/*
 * Responsible for executing commands.
 *
 * This could probably be replaced with something from Symfony, but right now this simple implementation works.
 */
class Executor {
	protected $defaultOptions = array(
		'throwException' => true,
		'inputContent' => null,
		'inputFile' => null,
		'inputStream' => null,
		'outputFile' => null,
		'outputFileAppend' => false,
		'outputStream' => null,
	);

	/**
	 * @param string $command The command
	 * @param boolean $throwException If true, an Exception will be thrown on a nonzero error code

There is no parameter named $throwException. Was it maybe removed?

	 * @param boolean $returnOutput If true, output will be captured

There is no parameter named $returnOutput. Was it maybe removed?

	 * @param boolean $inputContent Content for STDIN. Otherwise the parent script's STDIN is used

There is no parameter named $inputContent. Was it maybe removed?

	 * @return A map containing 'return', 'output', and 'error'
	 */
	public function execLocal($command, $options = array()) {
		$process = $this->createLocal($command, $options);
		return $process->exec();
	}

	public function execRemote($command, $options = array()) {
		$process = $this->createRemote($command, $options);
		return $process->exec();
	}

	public function createLocal($command, $options) {
		$options = array_merge($this->defaultOptions, $options);
		if(is_array($command)) $command = $this->commandArrayToString($command);

		return new Process($command, $options);
	}

	public function createRemote($server, $command, $options = array()) {
		$process = $this->createLocal($command, $options);
		$process->setRemoteServer($server);
		return $process;
	}

	/**
	 * Turn an array command in a string, escaping and concatenating each item
	 * @param array $command Command array. First element is the command and all remaining are the arguments.
	 * @return string String command
	 */
	public function commandArrayToString($command) {
		$string = escapeshellcmd(array_shift($command));
		foreach($command as $arg) {
			$string .= ' ' . escapeshellarg($arg);
		}
		return $string;
	}

}


class Process {
	protected $command;
	protected $options;
	protected $remoteServer = null;

	public function __construct($command, $options = array()) {
		$this->command = $command;
		$this->options = $options;
	}

	public function setRemoteServer($remoteServer) {
		$this->remoteServer = $remoteServer;
	}

	public function exec($options = array()) {
		$options = array_merge($this->options, $options);

		// Modify command for remote execution, if necessary.
		if($this->remoteServer) {
			if(!empty($options['outputFile']) || !empty($options['outputStream'])) $ssh = "ssh -T ";
			else $ssh = "ssh -t ";
			if (!empty($options['identity'])) {
				$ssh .= '-i ' . escapeshellarg($options['identity']) . ' ';
			}
			$command = $ssh . escapeshellarg($this->remoteServer) . ' ' . escapeshellarg($this->command);
		} else {
			$command = $this->command;
		}

		$pipes = array();
		$pipeSpec = array(
			0 => STDIN,
			1 => array('pipe', 'w'),
			2 => STDERR,
		);

		// Alternatives
		if($options['inputContent'] || $options['inputStream']) $pipeSpec[0] = array('pipe', 'r');

		if($options['outputFile']) {
			$pipeSpec[1] = array('file',
				$options['outputFile'],
				$options['outputFileAppend'] ? 'a' : 'w');
		}

		$process = proc_open($command, $pipeSpec, $pipes);

		if($options['inputContent']) {

This code seems to be duplicated across your project.

			fwrite($pipes[0], $options['inputContent']);

		} else if($options['inputStream']) {
			while($content = fread($options['inputStream'], 8192)) {
				fwrite($pipes[0], $content);
			}
		}
		if(isset($pipes[0])) fclose($pipes[0]);

		$result = array();

		if(isset($pipes[1])) {
			// If a stream was provided, then pipe all the content
			// Doing it this way rather than passing outputStream to $pipeSpec
			// Means that streams as well as simple FDs can be used
			if($options['outputStream']) {

This code seems to be duplicated across your project.

				while($content = fread($pipes[1], 8192)) {
					fwrite($options['outputStream'], $content);
				}

			// Otherwise save to a string
			} else {
				$result['output'] = stream_get_contents($pipes[1]);
			}
			fclose($pipes[1]);
		}
		if(isset($pipes[2])) {
			$result['error'] = stream_get_contents($pipes[2]);
			fclose($pipes[2]);
		}

		$result['return'] = proc_close($process);

		if($options['throwException'] && $result['return'] != 0)	{
			throw new Exception("Command: $command\nExecution failed: returned {$result['return']}.\n"
				. (empty($result['output']) ? "" : "Output:\n{$result['output']}"));
		}

		return $result;
	}
}