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

   1 <?php
   2
   3 namespace Drupal\Core\Updater;
   4
   5 use Drupal\Core\FileTransfer\FileTransferException;
   6 use Drupal\Core\FileTransfer\FileTransfer;
   7
   8 /**
   9  * Defines the base class for Updaters used in Drupal.
  10  */
  11 class Updater {
  12
  13   /**
  14    * Directory to install from.
  15    *
  16    * @var string
  17    */
  18   public $source;
  19
  20   /**
  21    * The root directory under which new projects will be copied.
  22    *
  23    * @var string
  24    */
  25   protected $root;
  26
  27   /**
  28    * Constructs a new updater.
  29    *
  30    * @param string $source
  31    *   Directory to install from.
  32    * @param string $root
  33    *   The root directory under which the project will be copied to if it's a
  34    *   new project. Usually this is the app root (the directory in which the
  35    *   Drupal site is installed).
  36    */
  37   public function __construct($source, $root) {
  38     $this->source = $source;
  39     $this->root = $root;
  40     $this->name = self::getProjectName($source);
  41     $this->title = self::getProjectTitle($source);
  42   }
  43
  44   /**
  45    * Returns an Updater of the appropriate type depending on the source.
  46    *
  47    * If a directory is provided which contains a module, will return a
  48    * ModuleUpdater.
  49    *
  50    * @param string $source
  51    *   Directory of a Drupal project.
  52    * @param string $root
  53    *   The root directory under which the project will be copied to if it's a
  54    *   new project. Usually this is the app root (the directory in which the
  55    *   Drupal site is installed).
  56    *
  57    * @return \Drupal\Core\Updater\Updater
  58    *   A new Drupal\Core\Updater\Updater object.
  59    *
  60    * @throws \Drupal\Core\Updater\UpdaterException
  61    */
  62   public static function factory($source, $root) {
  63     if (is_dir($source)) {
  64       $updater = self::getUpdaterFromDirectory($source);
  65     }
  66     else {
  67       throw new UpdaterException(t('Unable to determine the type of the source directory.'));
  68     }
  69     return new $updater($source, $root);
  70   }
  71
  72   /**
  73    * Determines which Updater class can operate on the given directory.
  74    *
  75    * @param string $directory
  76    *   Extracted Drupal project.
  77    *
  78    * @return string
  79    *   The class name which can work with this project type.
  80    *
  81    * @throws \Drupal\Core\Updater\UpdaterException
  82    */
  83   public static function getUpdaterFromDirectory($directory) {
  84     // Gets a list of possible implementing classes.
  85     $updaters = drupal_get_updaters();
  86     foreach ($updaters as $updater) {
  87       $class = $updater['class'];
  88       if (call_user_func([$class, 'canUpdateDirectory'], $directory)) {
  89         return $class;
  90       }
  91     }
  92     throw new UpdaterException(t('Cannot determine the type of project.'));
  93   }
  94
  95   /**
  96    * Determines what the most important (or only) info file is in a directory.
  97    *
  98    * Since there is no enforcement of which info file is the project's "main"
  99    * info file, this will get one with the same name as the directory, or the
 100    * first one it finds.  Not ideal, but needs a larger solution.
 101    *
 102    * @param string $directory
 103    *   Directory to search in.
 104    *
 105    * @return string
 106    *   Path to the info file.
 107    */
 108   public static function findInfoFile($directory) {
 109     $info_files = file_scan_directory($directory, '/.*\.info.yml$/');
 110     if (!$info_files) {
 111       return FALSE;
 112     }
 113     foreach ($info_files as $info_file) {
 114       if (mb_substr($info_file->filename, 0, -9) == drupal_basename($directory)) {
 115         // Info file Has the same name as the directory, return it.
 116         return $info_file->uri;
 117       }
 118     }
 119     // Otherwise, return the first one.
 120     $info_file = array_shift($info_files);
 121     return $info_file->uri;
 122   }
 123
 124   /**
 125    * Get Extension information from directory.
 126    *
 127    * @param string $directory
 128    *   Directory to search in.
 129    *
 130    * @return array
 131    *   Extension info.
 132    *
 133    * @throws \Drupal\Core\Updater\UpdaterException
 134    *   If the info parser does not provide any info.
 135    */
 136   protected static function getExtensionInfo($directory) {
 137     $info_file = static::findInfoFile($directory);
 138     $info = \Drupal::service('info_parser')->parse($info_file);
 139     if (empty($info)) {
 140       throw new UpdaterException(t('Unable to parse info file: %info_file.', ['%info_file' => $info_file]));
 141     }
 142
 143     return $info;
 144   }
 145
 146   /**
 147    * Gets the name of the project directory (basename).
 148    *
 149    * @todo It would be nice, if projects contained an info file which could
 150    *   provide their canonical name.
 151    *
 152    * @param string $directory
 153    *
 154    * @return string
 155    *   The name of the project.
 156    */
 157   public static function getProjectName($directory) {
 158     return drupal_basename($directory);
 159   }
 160
 161   /**
 162    * Returns the project name from a Drupal info file.
 163    *
 164    * @param string $directory
 165    *   Directory to search for the info file.
 166    *
 167    * @return string
 168    *   The title of the project.
 169    *
 170    * @throws \Drupal\Core\Updater\UpdaterException
 171    */
 172   public static function getProjectTitle($directory) {
 173     $info_file = self::findInfoFile($directory);
 174     $info = \Drupal::service('info_parser')->parse($info_file);
 175     if (empty($info)) {
 176       throw new UpdaterException(t('Unable to parse info file: %info_file.', ['%info_file' => $info_file]));
 177     }
 178     return $info['name'];
 179   }
 180
 181   /**
 182    * Stores the default parameters for the Updater.
 183    *
 184    * @param array $overrides
 185    *   An array of overrides for the default parameters.
 186    *
 187    * @return array
 188    *   An array of configuration parameters for an update or install operation.
 189    */
 190   protected function getInstallArgs($overrides = []) {
 191     $args = [
 192       'make_backup' => FALSE,
 193       'install_dir' => $this->getInstallDirectory(),
 194       'backup_dir'  => $this->getBackupDir(),
 195     ];
 196     return array_merge($args, $overrides);
 197   }
 198
 199   /**
 200    * Updates a Drupal project and returns a list of next actions.
 201    *
 202    * @param \Drupal\Core\FileTransfer\FileTransfer $filetransfer
 203    *   Object that is a child of FileTransfer. Used for moving files
 204    *   to the server.
 205    * @param array $overrides
 206    *   An array of settings to override defaults; see self::getInstallArgs().
 207    *
 208    * @return array
 209    *   An array of links which the user may need to complete the update
 210    *
 211    * @throws \Drupal\Core\Updater\UpdaterException
 212    * @throws \Drupal\Core\Updater\UpdaterFileTransferException
 213    */
 214   public function update(&$filetransfer, $overrides = []) {
 215     try {
 216       // Establish arguments with possible overrides.
 217       $args = $this->getInstallArgs($overrides);
 218
 219       // Take a Backup.
 220       if ($args['make_backup']) {
 221         $this->makeBackup($filetransfer, $args['install_dir'], $args['backup_dir']);
 222       }
 223
 224       if (!$this->name) {
 225         // This is bad, don't want to delete the install directory.
 226         throw new UpdaterException(t('Fatal error in update, cowardly refusing to wipe out the install directory.'));
 227       }
 228
 229       // Make sure the installation parent directory exists and is writable.
 230       $this->prepareInstallDirectory($filetransfer, $args['install_dir']);
 231
 232       if (is_dir($args['install_dir'] . '/' . $this->name)) {
 233         // Remove the existing installed file.
 234         $filetransfer->removeDirectory($args['install_dir'] . '/' . $this->name);
 235       }
 236
 237       // Copy the directory in place.
 238       $filetransfer->copyDirectory($this->source, $args['install_dir']);
 239
 240       // Make sure what we just installed is readable by the web server.
 241       $this->makeWorldReadable($filetransfer, $args['install_dir'] . '/' . $this->name);
 242
 243       // Run the updates.
 244       // @todo Decide if we want to implement this.
 245       $this->postUpdate();
 246
 247       // For now, just return a list of links of things to do.
 248       return $this->postUpdateTasks();
 249     }
 250     catch (FileTransferException $e) {
 251       throw new UpdaterFileTransferException(t('File Transfer failed, reason: @reason', ['@reason' => strtr($e->getMessage(), $e->arguments)]));
 252     }
 253   }
 254
 255   /**
 256    * Installs a Drupal project, returns a list of next actions.
 257    *
 258    * @param \Drupal\Core\FileTransfer\FileTransfer $filetransfer
 259    *   Object that is a child of FileTransfer.
 260    * @param array $overrides
 261    *   An array of settings to override defaults; see self::getInstallArgs().
 262    *
 263    * @return array
 264    *   An array of links which the user may need to complete the install.
 265    *
 266    * @throws \Drupal\Core\Updater\UpdaterFileTransferException
 267    */
 268   public function install(&$filetransfer, $overrides = []) {
 269     try {
 270       // Establish arguments with possible overrides.
 271       $args = $this->getInstallArgs($overrides);
 272
 273       // Make sure the installation parent directory exists and is writable.
 274       $this->prepareInstallDirectory($filetransfer, $args['install_dir']);
 275
 276       // Copy the directory in place.
 277       $filetransfer->copyDirectory($this->source, $args['install_dir']);
 278
 279       // Make sure what we just installed is readable by the web server.
 280       $this->makeWorldReadable($filetransfer, $args['install_dir'] . '/' . $this->name);
 281
 282       // Potentially enable something?
 283       // @todo Decide if we want to implement this.
 284       $this->postInstall();
 285       // For now, just return a list of links of things to do.
 286       return $this->postInstallTasks();
 287     }
 288     catch (FileTransferException $e) {
 289       throw new UpdaterFileTransferException(t('File Transfer failed, reason: @reason', ['@reason' => strtr($e->getMessage(), $e->arguments)]));
 290     }
 291   }
 292
 293   /**
 294    * Makes sure the installation parent directory exists and is writable.
 295    *
 296    * @param \Drupal\Core\FileTransfer\FileTransfer $filetransfer
 297    *   Object which is a child of FileTransfer.
 298    * @param string $directory
 299    *   The installation directory to prepare.
 300    *
 301    * @throws \Drupal\Core\Updater\UpdaterException
 302    */
 303   public function prepareInstallDirectory(&$filetransfer, $directory) {
 304     // Make the parent dir writable if need be and create the dir.
 305     if (!is_dir($directory)) {
 306       $parent_dir = dirname($directory);
 307       if (!is_writable($parent_dir)) {
 308         @chmod($parent_dir, 0755);
 309         // It is expected that this will fail if the directory is owned by the
 310         // FTP user. If the FTP user == web server, it will succeed.
 311         try {
 312           $filetransfer->createDirectory($directory);
 313           $this->makeWorldReadable($filetransfer, $directory);
 314         }
 315         catch (FileTransferException $e) {
 316           // Probably still not writable. Try to chmod and do it again.
 317           // @todo Make a new exception class so we can catch it differently.
 318           try {
 319             $old_perms = substr(sprintf('%o', fileperms($parent_dir)), -4);
 320             $filetransfer->chmod($parent_dir, 0755);
 321             $filetransfer->createDirectory($directory);
 322             $this->makeWorldReadable($filetransfer, $directory);
 323             // Put the permissions back.
 324             $filetransfer->chmod($parent_dir, intval($old_perms, 8));
 325           }
 326           catch (FileTransferException $e) {
 327             $message = t($e->getMessage(), $e->arguments);
 328             $throw_message = t('Unable to create %directory due to the following: %reason', ['%directory' => $directory, '%reason' => $message]);
 329             throw new UpdaterException($throw_message);
 330           }
 331         }
 332         // Put the parent directory back.
 333         @chmod($parent_dir, 0555);
 334       }
 335     }
 336   }
 337
 338   /**
 339    * Ensures that a given directory is world readable.
 340    *
 341    * @param \Drupal\Core\FileTransfer\FileTransfer $filetransfer
 342    *   Object which is a child of FileTransfer.
 343    * @param string $path
 344    *   The file path to make world readable.
 345    * @param bool $recursive
 346    *   If the chmod should be applied recursively.
 347    */
 348   public function makeWorldReadable(&$filetransfer, $path, $recursive = TRUE) {
 349     if (!is_executable($path)) {
 350       // Set it to read + execute.
 351       $new_perms = substr(sprintf('%o', fileperms($path)), -4, -1) . "5";
 352       $filetransfer->chmod($path, intval($new_perms, 8), $recursive);
 353     }
 354   }
 355
 356   /**
 357    * Performs a backup.
 358    *
 359    * @param \Drupal\Core\FileTransfer\FileTransfer $filetransfer
 360    *   Object which is a child of FileTransfer.
 361    * @param string $from
 362    *   The file path to copy from.
 363    * @param string $to
 364    *   The file path to copy to.
 365    *
 366    * @todo Not implemented: https://www.drupal.org/node/2474355
 367    */
 368   public function makeBackup(FileTransfer $filetransfer, $from, $to) {
 369   }
 370
 371   /**
 372    * Returns the full path to a directory where backups should be written.
 373    */
 374   public function getBackupDir() {
 375     return \Drupal::service('stream_wrapper_manager')->getViaScheme('temporary')->getDirectoryPath();
 376   }
 377
 378   /**
 379    * Performs actions after new code is updated.
 380    */
 381   public function postUpdate() {
 382   }
 383
 384   /**
 385    * Performs actions after installation.
 386    */
 387   public function postInstall() {
 388   }
 389
 390   /**
 391    * Returns an array of links to pages that should be visited post operation.
 392    *
 393    * @return array
 394    *   Links which provide actions to take after the install is finished.
 395    */
 396   public function postInstallTasks() {
 397     return [];
 398   }
 399
 400   /**
 401    * Returns an array of links to pages that should be visited post operation.
 402    *
 403    * @return array
 404    *   Links which provide actions to take after the update is finished.
 405    */
 406   public function postUpdateTasks() {
 407     return [];
 408   }
 409
 410 }