Merge pull request #32 from dennisinteractive/27689_remove_hardcoded_web_folder

27689 remove hardcoded web folder

Author: marcelovani

README.md

@@ -44,9 +44,6 @@ e.g. https://raw.githubusercontent.com/dennisinteractive/drupal_console_commands
 - drupal **site:settings:memcache** *site-name*
 	Creates *settings.memcache.php* in the *web/sites/default* folder. This file contains Memcache configuration and should not be committed.
 
-- drupal **site:drush:alias** *site-name*
-	Sets up drush aliases
-
 - drupal **site:phpunit:setup** *site-name*
 	Creates *phpunit.xml* in the root. This file contains PHPUnit configuration and should not be committed.
 
@@ -81,7 +78,6 @@ Chains that can be reused on various environments
     - site:settings:db
     - site:settings:local
     - site:settings:memcache
-    - site:drush:alias
 
 - drupal **site:test:setup** Sets the test suites
     - site:phpunit:setup

chain/chain-site-configure.yml

@@ -15,7 +15,3 @@ commands:
   - command: site:settings:memcache
     arguments:
       name: '%{{name}}'
-# Create the drush alias
-  - command: site:drush:alias
-    arguments:
-      name: '%{{name}}'

console.config.yml

@@ -16,8 +16,6 @@ application:
           class: \DennisDigital\Drupal\Console\Command\Site\Settings\MemcacheCommand
         'site:settings:local':
           class: \DennisDigital\Drupal\Console\Command\Site\Settings\LocalCommand
-        'site:drush:alias':
-          class: \DennisDigital\Drupal\Console\Command\Site\DrushAliasCommand
         'site:db:import':
           class: \DennisDigital\Drupal\Console\Command\Site\DbImportCommand
         'site:behat:setup':

src/Command/Site/AbstractCommand.php

@@ -70,11 +70,29 @@ abstract class AbstractCommand extends Command {
   protected $profile = NULL;
 
   /**
-   * Stores the destination directory.
+   * The root directory.
    *
    * @var string
    */
-  protected $destination = NULL;
+  private $root = NULL;
+
+  /**
+   * The web root directory.
+   *
+   * This is the web directory within the root.
+   *
+   * @var string
+   */
+  private $webRoot = NULL;
+
+  /**
+   * The site root directory.
+   *
+   * This is where we put settings.php
+   *
+   * @var string
+   */
+  private $siteRoot = NULL;
 
   /**
    * Stores the site url.
@@ -180,13 +198,58 @@ protected function validateSiteParams(InputInterface $input, OutputInterface $ou
     // Validate profile.
     $this->validateProfile($input);
 
-    // Validate destination.
-    $this->validateDestination($input);
+    // Validate root.
+    $this->validateRoot($input);
+
+    // Validate web root.
+    $this->validateWebRoot();
+
+    // Validate settings.php directory.
+    $this->validateSiteRoot();
 
     // Validate url.
     $this->validateUrl($input);
   }
 
+  /**
+   * Getter for the root directory property.
+   */
+  protected function getRoot() {
+    if (is_null($this->root)) {
+      throw new CommandException('Root directory is not available.');
+    }
+    return $this->root;
+  }
+
+  /**
+   * Getter for the web root directory property.
+   */
+  protected function getWebRoot() {
+    if (is_null($this->webRoot)) {
+      throw new CommandException('Web root directory is not available.');
+    }
+    return $this->webRoot;
+  }
+
+  /**
+   * Getter for the site root directory property.
+   */
+  protected function getSiteRoot() {
+    if (is_null($this->siteRoot)) {
+      throw new CommandException('Site root directory is not available.');
+    }
+    return $this->siteRoot;
+  }
+
+  /**
+   * Check if the current build has a site root directory.
+   *
+   * @return bool
+   */
+  protected function hasSiteRoot() {
+    return !is_null($this->siteRoot);
+  }
+
   /**
    * Helper to check that the config file exits and load the configuration.
    *
@@ -253,54 +316,51 @@ protected function validateProfile(InputInterface $input) {
   }
 
   /**
-   * Helper to validate destination parameter.
+   * Validate and set the web root directory.
+   */
+  protected function validateWebRoot() {
+    $web_directory = empty($this->config['web_directory']) ? 'web' : $this->config['web_directory'];
+    $this->webRoot = $this->getRoot() . trim($web_directory, '/') . '/';
+  }
+
+  /**
+   * Validate and set the root directory.
    *
    * @param InputInterface $input
-   *
-   * @throws CommandException
-   *
-   * @return string Destination
+   * @return string
    */
-  protected function validateDestination(InputInterface $input) {
+  protected function validateRoot(InputInterface $input) {
     if ($input->hasOption('destination-directory') &&
       !is_null($input->getOption('destination-directory'))
     ) {
       // Use config from parameter.
-      $this->destination = $input->getOption('destination-directory');
+      $this->root = $input->getOption('destination-directory');
     }
     elseif (isset($this->config['root'])) {
       // Use config from sites.yml.
-      $this->destination = $this->config['root'];
+      $this->root = $this->config['root'];
     }
     else {
-      $this->destination = '/tmp/' . $this->siteName;
+      $this->root = '/tmp/' . $this->siteName;
     }
 
     // Allow destination to be overriden by environment variable. i.e.
     // export site_destination_directory="/directory/"
     if (!getenv('site_destination_directory')) {
-      putenv("site_destination_directory=$this->destination");
+      putenv("site_destination_directory=$this->root");
     }
     else {
-      $this->destination = getenv('site_destination_directory');
-    }
-
-    // Make sure we have a slash at the end.
-    if (substr($this->destination, -1) != '/') {
-      $this->destination .= '/';
+      $this->root = getenv('site_destination_directory');
     }
 
-    return $this->destination;
+    $this->root = rtrim($this->root, '/') . '/';
   }
 
   /**
-   * Helper to validate destination parameter.
+   * Helper to validate URL.
    *
    * @param InputInterface $input
-   *
-   * @throws CommandException
-   *
-   * @return string Destination
+   * @return string
    */
   protected function validateUrl(InputInterface $input) {
     $scheme = isset($this->config['scheme']) && !empty($this->config['scheme']) ? $this->config['scheme'] : 'http';
@@ -318,16 +378,25 @@ protected function validateUrl(InputInterface $input) {
   }
 
   /**
-   * Helper to return the path to settings.php
+   * Helper to set the site root.
+   *
+   * This is where we place settings.php
+   *
    * It will try to match a folder with same name as site name
    * If not found, it will try to match a folder called "default".
    *
    * @return string Path
    */
-  public function settingsPhpDirectory() {
-    $webSitesPath = $this->destination . 'web/sites/';
+  public function validateSiteRoot() {
+    $webSitesPath = $this->getWebRoot() . 'sites/';
     $settingsPath = $webSitesPath . 'default';
 
+    // It's possible that a command is run before the site is available. e.g. checkout
+    // We will skip setting in this situation, but throw an Exception in the site root getter to prevent any unpredictable behaviour.
+    if (!file_exists($settingsPath)) {
+      return;
+    }
+
     $command = sprintf(
       'cd %s && find . -name settings.php',
       $this->shellPath($webSitesPath)
@@ -360,7 +429,26 @@ public function settingsPhpDirectory() {
       $settingsPath .= '/';
     }
 
-    return $settingsPath;
+    // Fix folder permissions.
+    $this->fixSiteFolderPermissions();
+
+    $this->siteRoot = $settingsPath;
+  }
+
+  /**
+   * Fixes the site folder permissions which is often changed by Drupal core.
+   */
+  protected function fixSiteFolderPermissions() {
+    if ($this->hasSiteRoot()) {
+      $commands[] = sprintf('chmod 777 %s', $this->getSiteRoot());
+      $commands[] = sprintf('chmod 777 %ssettings.php', $this->getSiteRoot());
+      $command = implode(' && ', $commands);
+      $this->io->commentBlock($command);
+      $shellProcess = $this->getShellProcess();
+      if (!$shellProcess->exec($command, TRUE)) {
+        throw new CommandException($shellProcess->getOutput());
+      }
+    }
   }
 
   /**

src/Command/Site/AbstractConfigCommand.php

@@ -79,7 +79,6 @@ protected function configure() {
    */
   protected function interact(InputInterface $input, OutputInterface $output) {
     parent::interact($input, $output);
-
   }
 
   /**
@@ -97,8 +96,8 @@ protected function execute(InputInterface $input, OutputInterface $output) {
    * @throws \DennisDigital\Drupal\Console\Exception\CommandException
    */
   protected function generateConfigFile() {
-    $this->template = $this->destination . $this->template;
-    $this->filename = $this->destination . $this->filename;
+    $this->template = $this->getRoot() . $this->template;
+    $this->filename = $this->getRoot() . $this->filename;
 
     // Validation.
     if (!$this->fileExists($this->template)) {

src/Command/Site/Checkout/AbstractRefCommand.php

@@ -73,14 +73,14 @@ protected function execute(InputInterface $input, OutputInterface $output) {
     $this->io->comment(sprintf('Checking out %s (%s) on %s',
       $this->siteName,
       $this->ref,
-      $this->destination
+      $this->getRoot()
     ));
 
     switch ($this->repo['type']) {
       case 'git':
         // Check if repo exists and has any changes.
-        if ($this->fileExists($this->destination) &&
-          $this->fileExists($this->destination . '.' . $this->repo['type'])
+        if ($this->fileExists($this->getRoot()) &&
+          $this->fileExists($this->getRoot() . '.' . $this->repo['type'])
         ) {
           if ($input->hasOption('force') &&
             !$input->getOption('force')
@@ -133,7 +133,7 @@ protected function validateRepo() {
   protected function gitDiff() {
     $command = sprintf(
       'cd %s && git diff-files --name-status -r --ignore-submodules',
-      $this->shellPath($this->destination)
+      $this->shellPath($this->getRoot())
     );
 
     $shellProcess = $this->getShellProcess();
@@ -143,7 +143,7 @@ protected function gitDiff() {
         $message = sprintf('You have uncommitted changes on %s' . PHP_EOL .
           'Please commit or revert your changes before checking out the site.' . PHP_EOL .
           'If you want to wipe your local changes use --force.',
-          $this->destination
+          $this->getRoot()
         );
         throw new CommandException($message);
       }
@@ -165,14 +165,14 @@ protected function gitDiff() {
   protected function gitClone() {
     $command = sprintf('git clone %s %s',
       $this->repo['url'],
-      $this->shellPath($this->destination)
+      $this->shellPath($this->getRoot())
     );
     $this->io->commentBlock($command);
 
     $shellProcess = $this->getShellProcess();
 
     if ($shellProcess->exec($command, TRUE)) {
-      $this->io->success(sprintf('Repo cloned on %s', $this->destination));
+      $this->io->success(sprintf('Repo cloned on %s', $this->getRoot()));
     }
     else {
       throw new CommandException($shellProcess->getOutput());
@@ -192,15 +192,15 @@ protected function gitClone() {
    * @throws CommandException
    */
   protected function gitCheckout() {
-    $command = sprintf(
-      'cd %s && ' .
-      'git fetch --all && ' .
-      'chmod 777 web/sites/default && ' .
-      'chmod 777 web/sites/default/settings.php && ' .
-      'git checkout %s --force',
-      $this->shellPath($this->destination),
-      $this->ref
-    );
+
+    $commands = [];
+
+    // Checkout commands.
+    $commands[] = sprintf('cd %s', $this->shellPath($this->getRoot()));
+    $commands[] = 'git fetch --all';
+    $commands[] = sprintf('git checkout %s --force', $this->ref);
+
+    $command = implode(' && ', $commands);
 
     $shellProcess = $this->getShellProcess();
 
@@ -221,10 +221,10 @@ protected function gitCheckout() {
    * @return mixed
    */
   protected function getCurrentRef() {
-    if ($this->fileExists($this->destination)) {
+    if ($this->fileExists($this->getRoot())) {
       // Get branch from site directory.
       $command = sprintf('cd %s && git branch',
-        $this->shellPath($this->destination)
+        $this->shellPath($this->getRoot())
       );
 
       $shellProcess = $this->getShellProcess()->printOutput(FALSE);