Shell.php

<?php

namespace ArtSkills\Lib;

use ArtSkills\Traits\Library;

/**
 * Запуск команд в командной строке
 * Просто обёртка над exec() с небольшими удобствами
 */
class Shell
{
	use Library;

	/**
	 * Выполнить команду в консоли
	 *
	 * @param string|string[] $commands
	 * @param bool $withErrors перенаправлять stderr в stdout
	 * @param bool $stopOnFail если передан список команд, то останавливаться ли на ошибке (склеивать команды через && или ;)
	 * @return array [успех, вывод, результирующая команда, код возврата]
	 */
	public static function exec($commands, $withErrors = true, $stopOnFail = true)
	{
		$resultCommand = self::_processCommandList($commands, $withErrors, $stopOnFail);
		return self::_exec($resultCommand);
	}

	/**
	 * Запустить и не ждать выполнения
	 *
	 * @param string $command
	 * @param string $outputRedirect
	 */
	public static function execInBackground($command, $outputRedirect = '/dev/null')
	{
		exec('nohup ' . $command . ' > ' . escapeshellarg($outputRedirect) . ' 2>&1 &');
	}

	/**
	 * Выполнить команду в консоли из определённого места
	 *
	 * @param string $directory
	 * @param string|string[] $commands
	 * @param bool $withErrors перенаправлять stderr в stdout
	 * @param bool $stopOnFail если передан список команд, то останавливаться ли на ошибке (склеивать команды через && или ;)
	 * Но если свалится смена директорий, то дальше не пойдёт независимо от этого параметра
	 * @return array [успех, вывод, результирующая команда, код возврата]
	 */
	public static function execFromDir($directory, $commands, $withErrors = true, $stopOnFail = true)
	{
		$resultCommand = self::_processCommandList($commands, $withErrors, $stopOnFail);
		if (!empty($directory) && (getcwd() !== $directory)) {
			$cdCommand = 'cd ' . escapeshellarg($directory) . ($withErrors ? ' 2>&1' : '');
			$resultCommand = "$cdCommand && ($resultCommand)";
		}
		return self::_exec($resultCommand);
	}

	/**
	 * Обёртка вызова exec для целей мока в тесте
	 *
	 * @param string $command
	 * @return array [успех, вывод, результирующая команда, код возврата]
	 */
	private static function _exec($command)
	{
		exec($command, $output, $returnCode);
		return [$returnCode === 0, $output, $command, $returnCode];
	}

	/**
	 * Взять список команд и склеить их в одну строку в зависимости от параметров
	 *
	 * @param string|strings $commands
	 * @param bool $withErrors
	 * @param bool $stopOnFail
	 * @return string
	 */
	private static function _processCommandList($commands, $withErrors = true, $stopOnFail = true)
	{
		$commands = (array)$commands;
		if ($stopOnFail) {
			$glue = ' && ';
		} else {
			$glue = ' ; ';
		}
		if ($withErrors) {
			$errorRedirect = ' 2>&1';
			$glue = $errorRedirect . $glue;
			$resultCommand = implode($glue, $commands) . $errorRedirect;
		} else {
			$resultCommand = implode($glue, $commands);
		}
		return $resultCommand;
	}

}