BackendCommandsTrait.php

<?php

namespace Drush\Commands\BurdaStyleGroup;

use Consolidation\AnnotatedCommand\AnnotationData;
use Consolidation\SiteAlias\SiteAliasInterface;
use Consolidation\SiteAlias\SiteAliasManagerAwareTrait;
use Drupal\Core\Site\Settings;
use Drush\Drush;
use Symfony\Component\Console\Command\Command;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Input\InputOption;
use Symfony\Component\Filesystem\Path;

/**
 * Trait for backend drush commands.
 */
trait BackendCommandsTrait
{
    use SiteAliasManagerAwareTrait;

    /**
     * Maps site alias to site directory.
     *
     * @var string[]
     */
    private $siteDomainDirectoryMapping = [
        '@elle.dev' => 'elle.de',
        '@esquire.dev' => 'esquire.de',
        '@focusplus.dev' => 'focusplus.de',
        '@freundin.dev' => 'freundin.de',
        '@harpersbazaar.dev' => 'harpersbazaar.de',
        '@instyle.dev' => 'instyle.de',
    ];

    /**
     * @var string
     */
    private $projectDirectory;

    /**
     * Drush command wrapper.
     *
     * Runs the command and prints the output.
     *
     * @param \Consolidation\SiteAlias\SiteAliasInterface $siteAlias
     * @param $command
     * @param array                                       $args
     * @param array                                       $options
     * @param array                                       $optionsDoubleDash
     */
    protected function drush(SiteAliasInterface $siteAlias, $command, $args = [], $options = [], $optionsDoubleDash = [])
    {
        /**
         * @var \Consolidation\SiteProcess\SiteProcess $process
         */
        $process = $this->processManager()->drush($siteAlias, $command, $args, $options, $optionsDoubleDash);

        $isTtySupported = (bool) @proc_open('echo 1 >/dev/null', [['file', '/dev/tty', 'r'], ['file', '/dev/tty', 'w'], ['file', '/dev/tty', 'w']], $pipes);
        if ($isTtySupported) {
            // This allows us to ask user for confirmation, if --yes option was not given.
            $process->setTty(true);
        }
        $process->mustRun($process->showRealtime());
    }

    /**
     * Process wrapper.
     *
     * Runs the process and prints the output.
     *
     * @param $command
     * @param null       $cwd
     * @param array|null $env
     * @param null       $input
     * @param int        $timeout
     */
    protected function process($command, $cwd = null, array $env = null, $input = null, $timeout = 60)
    {
        $process = $this->processManager()->process($command, $cwd, $env, $input, $timeout);
        $process->mustRun($process->showRealtime());
    }

    /**
     * The base project directory, where most commands will be executed from.
     * Defaults to composer root of project-
     *
     * @return string
     */
    protected function projectDirectory(): string
    {
        return $this->projectDirectory;
    }

    /**
     * The drupal root directory for a given site.
     *
     * @return string
     */
    protected function drupalRootDirectory(): string
    {
        return $this->projectDirectory().'/docroot';
    }

    /**
     * The site directory for a given site.
     * @see SiteInstallCommands::getSitesSubdirFromUri().
     *
     * @return string
     */
    protected function siteDirectory(): string
    {
        $uri = preg_replace('#^https?://#', '', $this->selfRecord()->get('uri'));
        $sitesFile = $this->drupalRootDirectory().'/sites/sites.php';
        if (file_exists($sitesFile)) {
            include $sitesFile;
            /** @var array $sites */
            if (isset($sites) && array_key_exists($uri, $sites)) {
                return Path::join($this->drupalRootDirectory(), 'sites', $sites[$uri]);
            }
        }
        // Fall back to default directory if it exists.
        if (file_exists(Path::join($this->drupalRootDirectory(), 'sites', 'default'))) {
            return 'default';
        }

        return false;
    }

    /**
     * The directory, where site specific configuration is placed.
     *
     * @return string
     */
    protected function siteConfigSyncDirectory(): string
    {
        return $this->drupalRootDirectory().'/'.Settings::get('config_sync_directory', false);
    }

    /**
     * The directory, where shared configuration is placed.
     *
     * @return string
     */
    protected function configSharedDirectory(): string
    {
        return $this->siteConfigSyncDirectory().'/../../shared';
    }

    /**
     * The directory, where site specific overridden configuration is placed.
     *
     * @return string
     */
    protected function siteConfigOverrideDirectory(): string
    {
        return $this->siteConfigSyncDirectory().'/../override';
    }

    /**
     * Get the '@self' alias record.
     *
     * @return \Consolidation\SiteAlias\SiteAlias|\Consolidation\SiteAlias\SiteAliasInterface
     */
    protected function selfRecord(): SiteAliasInterface
    {
        return $this->siteAliasManager()->getSelf();
    }

    /**
     * The supported site alias records.
     *
     * @return string[]
     */
    protected function supportedAliases()
    {
        return array_keys($this->siteDomainDirectoryMapping);
    }
}