deployphp / deployer

src/Component/Ssh/Arguments.php

<?php
/* (c) Anton Medvedev <anton@medv.io>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Deployer\Component\Ssh;

use Deployer\Exception\Exception;
use Deployer\Host\Host;
use Deployer\Support\Unix;

The type Deployer\Support\Unix was not found. Maybe you did not declare it correctly or list all dependencies?

use function Deployer\Support\parse_home_dir;

class Arguments
{
    /**
     * @var array
     */
    private $flags = [];

    /**
     * @var array
     */
    private $options = [];

    public function getCliArguments()
    {
        $boolFlags = array_keys(array_filter($this->flags, 'is_null'));

        $valueFlags = array_filter($this->flags);
        $valueFlags = array_map(function ($key, $value) {
            return "$key $value";
        }, array_keys($valueFlags), $valueFlags);

        $options = array_map(function ($key, $value) {
            return "-o $key=$value";
        }, array_keys($this->options), $this->options);

        $args = sprintf('%s %s %s', implode(' ', $boolFlags), implode(' ', $valueFlags), implode(' ', $options));

        return trim(preg_replace('!\s+!', ' ', $args));
    }

    public function getOption(string $option)
    {
        return $this->options[$option] ?? '';
    }

    public function getFlag(string $flag)
    {
        if (!array_key_exists($flag, $this->flags)) {
            return false;
        }

        return $this->flags[$flag] ?? true;
    }

    public function withFlags(array $flags)
    {
        $clone = clone $this;
        $clone->flags = $this->buildFlagsFromArray($flags);

        return $clone;
    }

    public function withOptions(array $options)
    {
        $clone = clone $this;
        $clone->options = $options;

        return $clone;
    }

    public function withFlag(string $flag, string $value = null)
    {
        $clone = clone $this;
        $clone->flags = array_merge($this->flags, [$flag => $value]);

        return $clone;
    }

    public function withOption(string $option, string $value)
    {
        $clone = clone $this;
        $clone->options = array_merge($this->options, [$option => $value]);

        return $clone;
    }

    public function withDefaults(Arguments $defaultOptions)
    {
        $clone = clone $this;
        $clone->options = array_merge($defaultOptions->options, $this->options);
        $clone->flags = array_merge($defaultOptions->flags, $this->flags);

        return $clone;
    }

    public function withMultiplexing(Host $host)
    {
        $controlPath = $this->generateControlPath($host);

        $multiplexDefaults = (new Arguments)->withOptions([
            'ControlMaster' => 'auto',
            'ControlPersist' => $host->get('ssh_control_persist', 60),
            'ControlPath' => $controlPath,
        ]);

        return $this->withDefaults($multiplexDefaults);
    }

    /**
     * Return SSH multiplexing control path
     *
     * When ControlPath is longer than 104 chars we can get:
     *
     *     SSH Error: unix_listener: too long for Unix domain socket
     *
     * So try to get as descriptive path as possible.
     * %C is for creating hash out of connection attributes.
     *
     * @param Host $host
     * @return string ControlPath
     * @throws Exception
     */
    private function generateControlPath(Host $host)
    {
        // TODO: ->addSshOption('ControlPath', '/dev/shm/deployer-%C')
        $connectionHashLength = 16; // Length of connection hash that OpenSSH appends to controlpath
        $unixMaxPath = 104; // Theoretical max limit for path length
        $homeDir = parse_home_dir('~');
        $port = empty($host->get('port', '')) ? '' : ':' . $host->getPort();
        $connectionData = "{$host->getConnectionString()}$port";

        $tryLongestPossible = 0;
        $controlPath = '';
        do {
            switch ($tryLongestPossible) {
                case 1:
                    $controlPath = "$homeDir/.ssh/deployer_%C";
                    break;
                case 2:
                    $controlPath = "$homeDir/.ssh/" . hash("crc32", $connectionData);
                    break;
                case 3:
                    throw new Exception("The multiplexing control path is too long. Control path is: $controlPath");
                default:
                    $controlPath = "$homeDir/.ssh/deployer_$connectionData";
            }
            $tryLongestPossible++;
        } while (strlen($controlPath) + $connectionHashLength > $unixMaxPath); // Unix socket max length

        return $controlPath;
    }

    private function buildFlagsFromArray($flags)
    {
        $boolFlags = array_filter(array_map(function ($key, $value) {
            if (is_int($key)) {
                return $value;
            }

            if (null === $value) {
                return $key;
            }

            return false;
        }, array_keys($flags), $flags));

        $valueFlags = array_filter($flags, function ($key, $value) {
            return is_string($key) && is_string($value);
        }, ARRAY_FILTER_USE_BOTH);

        return array_merge(array_fill_keys($boolFlags, null), $valueFlags);
    }

    public function __toString()
    {
        return $this->getCliArguments();
    }
}