www.aleph1.co.uk Git - yaffs-website/blob - web/core/lib/Drupal/Core/Updater/Module.php

   1 <?php
   2
   3 namespace Drupal\Core\Updater;
   4
   5 use Drupal\Core\Url;
   6
   7 /**
   8  * Defines a class for updating modules using
   9  * Drupal\Core\FileTransfer\FileTransfer classes via authorize.php.
  10  */
  11 class Module extends Updater implements UpdaterInterface {
  12
  13   /**
  14    * Returns the directory where a module should be installed.
  15    *
  16    * If the module is already installed, drupal_get_path() will return a valid
  17    * path and we should install it there. If we're installing a new module, we
  18    * always want it to go into /modules, since that's where all the
  19    * documentation recommends users install their modules, and there's no way
  20    * that can conflict on a multi-site installation, since the Update manager
  21    * won't let you install a new module if it's already found on your system,
  22    * and if there was a copy in the top-level we'd see it.
  23    *
  24    * @return string
  25    *   The absolute path of the directory.
  26    */
  27   public function getInstallDirectory() {
  28     if ($this->isInstalled() && ($relative_path = drupal_get_path('module', $this->name))) {
  29       // The return value of drupal_get_path() is always relative to the site,
  30       // so prepend DRUPAL_ROOT.
  31       return DRUPAL_ROOT . '/' . dirname($relative_path);
  32     }
  33     else {
  34       // When installing a new module, prepend the requested root directory.
  35       return $this->root . '/' . $this->getRootDirectoryRelativePath();
  36     }
  37   }
  38
  39   /**
  40    * {@inheritdoc}
  41    */
  42   public static function getRootDirectoryRelativePath() {
  43     return 'modules';
  44   }
  45
  46   /**
  47    * {@inheritdoc}
  48    */
  49   public function isInstalled() {
  50     // Check if the module exists in the file system, regardless of whether it
  51     // is enabled or not.
  52     $modules = \Drupal::state()->get('system.module.files', []);
  53     return isset($modules[$this->name]);
  54   }
  55
  56   /**
  57    * {@inheritdoc}
  58    */
  59   public static function canUpdateDirectory($directory) {
  60     $info = static::getExtensionInfo($directory);
  61
  62     return (isset($info['type']) && $info['type'] == 'module');
  63   }
  64
  65   /**
  66    * Determines whether this class can update the specified project.
  67    *
  68    * @param string $project_name
  69    *   The project to check.
  70    *
  71    * @return bool
  72    */
  73   public static function canUpdate($project_name) {
  74     return (bool) drupal_get_path('module', $project_name);
  75   }
  76
  77   /**
  78    * Returns available database schema updates once a new version is installed.
  79    *
  80    * @return array
  81    */
  82   public function getSchemaUpdates() {
  83     require_once DRUPAL_ROOT . '/core/includes/install.inc';
  84     require_once DRUPAL_ROOT . '/core/includes/update.inc';
  85
  86     if (!self::canUpdate($this->name)) {
  87       return [];
  88     }
  89     module_load_include('install', $this->name);
  90
  91     if (!$updates = drupal_get_schema_versions($this->name)) {
  92       return [];
  93     }
  94     $modules_with_updates = update_get_update_list();
  95     if ($updates = $modules_with_updates[$this->name]) {
  96       if ($updates['start']) {
  97         return $updates['pending'];
  98       }
  99     }
 100     return [];
 101   }
 102
 103   /**
 104    * {@inheritdoc}
 105    */
 106   public function postInstallTasks() {
 107     // Since this is being called outsite of the primary front controller,
 108     // the base_url needs to be set explicitly to ensure that links are
 109     // relative to the site root.
 110     // @todo Simplify with https://www.drupal.org/node/2548095
 111     $default_options = [
 112       '#type' => 'link',
 113       '#options' => [
 114         'absolute' => TRUE,
 115         'base_url' => $GLOBALS['base_url'],
 116       ],
 117     ];
 118     return [
 119       $default_options + [
 120         '#url' => Url::fromRoute('update.module_install'),
 121         '#title' => t('Install another module'),
 122       ],
 123       $default_options + [
 124         '#url' => Url::fromRoute('system.modules_list'),
 125         '#title' => t('Enable newly added modules'),
 126       ],
 127       $default_options + [
 128         '#url' => Url::fromRoute('system.admin'),
 129         '#title' => t('Administration pages'),
 130       ],
 131     ];
 132   }
 133
 134   /**
 135    * {@inheritdoc}
 136    */
 137   public function postUpdateTasks() {
 138     // We don't want to check for DB updates here, we do that once for all
 139     // updated modules on the landing page.
 140   }
 141
 142 }