RemoteManager.php

<?php namespace Illuminate\Remote;

use Symfony\Component\Console\Output\NullOutput;
use Symfony\Component\Console\Output\ConsoleOutput;

class RemoteManager {

	/**
	 * The application instance.
	 *
	 * @var \Illuminate\Foundation\Application
	 */
	protected $app;

	/**
	 * Create a new remote manager instance.
	 *
	 * @param  \Illuminate\Foundation\Application  $app
	 * @return void
	 */
	public function __construct($app)
	{
		$this->app = $app;
	}

	/**
	 * Get a remote connection instance.
	 *
	 * @param  string|array|mixed  $name
	 * @return \Illuminate\Remote\ConnectionInterface
	 */
	public function into($name)
	{
		if (is_string($name) || is_array($name))
		{
			return $this->connection($name);
		}
		else
		{
			return $this->connection(func_get_args());
		}
	}

	/**
	 * Get a remote connection instance.
	 *
	 * @param  string|array  $name
	 * @return \Illuminate\Remote\ConnectionInterface
	 */
	public function connection($name = null)
	{
		if (is_array($name)) return $this->multiple($name);

		return $this->resolve($name ?: $this->getDefaultConnection());
	}

	/**
	 * Get a connection group instance by name.
	 *
	 * @param  string  $name
	 * @return \Illuminate\Remote\ConnectionInterface
	 */
	public function group($name)
	{
		return $this->connection($this->app['config']['remote.groups.'.$name]);
	}

	/**
	 * Resolve a multiple connection instance.
	 *
	 * @param  array  $names
	 * @return \Illuminate\Remote\MultiConnection
	 */
	public function multiple(array $names)
	{
		return new MultiConnection(array_map(array($this, 'resolve'), $names));
	}

	/**
	 * Resolve a remote connection instance.
	 *
	 * @param  string  $name
	 * @return \Illuminate\Remote\Connection
	 */
	public function resolve($name)
	{
		return $this->makeConnection($name, $this->getConfig($name));
	}

	/**
	 * Make a new connection instance.
	 *
	 * @param  string  $name
	 * @param  array   $config
	 * @return \Illuminate\Remote\Connection
	 */
	protected function makeConnection($name, array $config)
	{
		$this->setOutput($connection = new Connection(

			$name, $config['host'], $config['username'], $this->getAuth($config)

		));

		return $connection;
	}

	/**
	 * Set the output implementation on the connection.
	 *
	 * @param  \Illuminate\Remote\Connection  $connection
	 * @return void
	 */
	protected function setOutput(Connection $connection)
	{
		$output = php_sapi_name() == 'cli' ? new ConsoleOutput : new NullOutput;

		$connection->setOutput($output);
	}

	/**
	 * Format the appropriate authentication array payload.
	 *
	 * @param  array  $config
	 * @return array
	 *
	 * @throws \InvalidArgumentException
	 */
	protected function getAuth(array $config)
	{
		if (isset($config['agent']) && $config['agent'] === true)
		{
			return array('agent' => true);
		}
		elseif (isset($config['key']) && trim($config['key']) != '')
		{
			return array('key' => $config['key'], 'keyphrase' => $config['keyphrase']);
		}
		elseif (isset($config['keytext']) && trim($config['keytext']) != '')
		{
			return array('keytext' => $config['keytext']);
		}
		elseif (isset($config['password']))
		{
			return array('password' => $config['password']);
		}

		throw new \InvalidArgumentException('Password / key is required.');
	}

	/**
	 * Get the configuration for a remote server.
	 *
	 * @param  string  $name
	 * @return array
	 *
	 * @throws \InvalidArgumentException
	 */
	protected function getConfig($name)
	{
		$config = $this->app['config']['remote.connections.'.$name];

		if ( ! is_null($config)) return $config;

		throw new \InvalidArgumentException("Remote connection [$name] not defined.");
	}

	/**
	 * Get the default connection name.
	 *
	 * @return string
	 */
	public function getDefaultConnection()
	{
		return $this->app['config']['remote.default'];
	}

	/**
	 * Set the default connection name.
	 *
	 * @param  string  $name
	 * @return void
	 */
	public function setDefaultConnection($name)
	{
		$this->app['config']['remote.default'] = $name;
	}

	/**
	 * Dynamically pass methods to the default connection.
	 *
	 * @param  string  $method
	 * @param  array   $parameters
	 * @return mixed
	 */
	public function __call($method, $parameters)
	{
		return call_user_func_array(array($this->connection(), $method), $parameters);
	}

}