Updater.php 13 KB
Newer Older
1 2
<?php

3 4
namespace Drupal\Core\Updater;

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 22 23 24 25 26
  /**
   * The root directory under which new projects will be copied.
   *
   * @var string
   */
  protected $root;

27
  /**
28
   * Constructs a new updater.
29
   *
30 31
   * @param string $source
   *   Directory to install from.
32 33 34 35
   * @param string $root
   *   The root directory under which the project will be copied to if it's a
   *   new project. Usually this is the app root (the directory in which the
   *   Drupal site is installed).
36
   */
37
  public function __construct($source, $root) {
38
    $this->source = $source;
39
    $this->root = $root;
40 41 42 43 44
    $this->name = self::getProjectName($source);
    $this->title = self::getProjectTitle($source);
  }

  /**
45
   * Returns an Updater of the appropriate type depending on the source.
46 47 48 49 50 51
   *
   * If a directory is provided which contains a module, will return a
   * ModuleUpdater.
   *
   * @param string $source
   *   Directory of a Drupal project.
52 53 54 55
   * @param string $root
   *   The root directory under which the project will be copied to if it's a
   *   new project. Usually this is the app root (the directory in which the
   *   Drupal site is installed).
56
   *
57
   * @return \Drupal\Core\Updater\Updater
58 59
   *   A new Drupal\Core\Updater\Updater object.
   *
60
   * @throws \Drupal\Core\Updater\UpdaterException
61
   */
62
  public static function factory($source, $root) {
63 64 65 66
    if (is_dir($source)) {
      $updater = self::getUpdaterFromDirectory($source);
    }
    else {
67
      throw new UpdaterException('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 76 77 78 79
   *
   * @param string $directory
   *   Extracted Drupal project.
   *
   * @return string
   *   The class name which can work with this project type.
80
   *
81
   * @throws \Drupal\Core\Updater\UpdaterException
82 83 84 85 86 87
   */
  public static function getUpdaterFromDirectory($directory) {
    // Gets a list of possible implementing classes.
    $updaters = drupal_get_updaters();
    foreach ($updaters as $updater) {
      $class = $updater['class'];
88
      if (call_user_func([$class, 'canUpdateDirectory'], $directory)) {
89 90 91
        return $class;
      }
    }
92
    throw new UpdaterException('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 99 100 101 102 103 104 105 106 107 108
   *
   * Since there is no enforcement of which info file is the project's "main"
   * info file, this will get one with the same name as the directory, or the
   * first one it finds.  Not ideal, but needs a larger solution.
   *
   * @param string $directory
   *   Directory to search in.
   *
   * @return string
   *   Path to the info file.
   */
  public static function findInfoFile($directory) {
109 110 111 112 113 114
    /** @var \Drupal\Core\File\FileSystemInterface $file_system */
    $file_system = \Drupal::service('file_system');
    $info_files = [];
    if (is_dir($directory)) {
      $info_files = $file_system->scanDirectory($directory, '/.*\.info.yml$/');
    }
115 116 117 118
    if (!$info_files) {
      return FALSE;
    }
    foreach ($info_files as $info_file) {
119
      if (mb_substr($info_file->filename, 0, -9) == $file_system->basename($directory)) {
120 121 122 123 124 125 126 127 128
        // Info file Has the same name as the directory, return it.
        return $info_file->uri;
      }
    }
    // Otherwise, return the first one.
    $info_file = array_shift($info_files);
    return $info_file->uri;
  }

129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144
  /**
   * Get Extension information from directory.
   *
   * @param string $directory
   *   Directory to search in.
   *
   * @return array
   *   Extension info.
   *
   * @throws \Drupal\Core\Updater\UpdaterException
   *   If the info parser does not provide any info.
   */
  protected static function getExtensionInfo($directory) {
    $info_file = static::findInfoFile($directory);
    $info = \Drupal::service('info_parser')->parse($info_file);
    if (empty($info)) {
145
      throw new UpdaterException("Unable to parse info file: '$info_file'.");
146 147 148 149 150
    }

    return $info;
  }

151
  /**
152
   * Gets the name of the project directory (basename).
153
   *
154 155
   * @todo It would be nice, if projects contained an info file which could
   *   provide their canonical name.
156 157 158 159 160 161 162
   *
   * @param string $directory
   *
   * @return string
   *   The name of the project.
   */
  public static function getProjectName($directory) {
163
    return \Drupal::service('file_system')->basename($directory);
164 165 166
  }

  /**
167
   * Returns the project name from a Drupal info file.
168 169 170 171 172 173
   *
   * @param string $directory
   *   Directory to search for the info file.
   *
   * @return string
   *   The title of the project.
174
   *
175
   * @throws \Drupal\Core\Updater\UpdaterException
176 177 178
   */
  public static function getProjectTitle($directory) {
    $info_file = self::findInfoFile($directory);
179
    $info = \Drupal::service('info_parser')->parse($info_file);
180
    if (empty($info)) {
181
      throw new UpdaterException("Unable to parse info file: '$info_file'.");
182 183 184 185 186
    }
    return $info['name'];
  }

  /**
187
   * Stores the default parameters for the Updater.
188 189 190 191 192 193 194
   *
   * @param array $overrides
   *   An array of overrides for the default parameters.
   *
   * @return array
   *   An array of configuration parameters for an update or install operation.
   */
195 196
  protected function getInstallArgs($overrides = []) {
    $args = [
197 198 199
      'make_backup' => FALSE,
      'install_dir' => $this->getInstallDirectory(),
      'backup_dir'  => $this->getBackupDir(),
200
    ];
201 202 203 204
    return array_merge($args, $overrides);
  }

  /**
205
   * Updates a Drupal project and returns a list of next actions.
206
   *
207
   * @param \Drupal\Core\FileTransfer\FileTransfer $filetransfer
208 209 210 211 212 213 214
   *   Object that is a child of FileTransfer. Used for moving files
   *   to the server.
   * @param array $overrides
   *   An array of settings to override defaults; see self::getInstallArgs().
   *
   * @return array
   *   An array of links which the user may need to complete the update
215
   *
216 217
   * @throws \Drupal\Core\Updater\UpdaterException
   * @throws \Drupal\Core\Updater\UpdaterFileTransferException
218
   */
219
  public function update(&$filetransfer, $overrides = []) {
220 221 222 223 224 225
    try {
      // Establish arguments with possible overrides.
      $args = $this->getInstallArgs($overrides);

      // Take a Backup.
      if ($args['make_backup']) {
226
        $this->makeBackup($filetransfer, $args['install_dir'], $args['backup_dir']);
227 228 229 230
      }

      if (!$this->name) {
        // This is bad, don't want to delete the install directory.
231
        throw new UpdaterException('Fatal error in update, cowardly refusing to wipe out the install directory.');
232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248
      }

      // Make sure the installation parent directory exists and is writable.
      $this->prepareInstallDirectory($filetransfer, $args['install_dir']);

      if (is_dir($args['install_dir'] . '/' . $this->name)) {
        // Remove the existing installed file.
        $filetransfer->removeDirectory($args['install_dir'] . '/' . $this->name);
      }

      // Copy the directory in place.
      $filetransfer->copyDirectory($this->source, $args['install_dir']);

      // Make sure what we just installed is readable by the web server.
      $this->makeWorldReadable($filetransfer, $args['install_dir'] . '/' . $this->name);

      // Run the updates.
249
      // @todo Decide if we want to implement this.
250 251 252 253 254 255
      $this->postUpdate();

      // For now, just return a list of links of things to do.
      return $this->postUpdateTasks();
    }
    catch (FileTransferException $e) {
256
      throw new UpdaterFileTransferException("File Transfer failed, reason: '" . strtr($e->getMessage(), $e->arguments) . "'");
257 258 259 260 261 262
    }
  }

  /**
   * Installs a Drupal project, returns a list of next actions.
   *
263
   * @param \Drupal\Core\FileTransfer\FileTransfer $filetransfer
264 265 266 267 268 269
   *   Object that is a child of FileTransfer.
   * @param array $overrides
   *   An array of settings to override defaults; see self::getInstallArgs().
   *
   * @return array
   *   An array of links which the user may need to complete the install.
270
   *
271
   * @throws \Drupal\Core\Updater\UpdaterFileTransferException
272
   */
273
  public function install(&$filetransfer, $overrides = []) {
274 275 276 277 278 279 280 281 282 283 284 285 286 287
    try {
      // Establish arguments with possible overrides.
      $args = $this->getInstallArgs($overrides);

      // Make sure the installation parent directory exists and is writable.
      $this->prepareInstallDirectory($filetransfer, $args['install_dir']);

      // Copy the directory in place.
      $filetransfer->copyDirectory($this->source, $args['install_dir']);

      // Make sure what we just installed is readable by the web server.
      $this->makeWorldReadable($filetransfer, $args['install_dir'] . '/' . $this->name);

      // Potentially enable something?
288
      // @todo Decide if we want to implement this.
289 290 291 292 293
      $this->postInstall();
      // For now, just return a list of links of things to do.
      return $this->postInstallTasks();
    }
    catch (FileTransferException $e) {
294
      throw new UpdaterFileTransferException("File Transfer failed, reason: '" . strtr($e->getMessage(), $e->arguments) . "'");
295 296 297 298
    }
  }

  /**
299
   * Makes sure the installation parent directory exists and is writable.
300
   *
301
   * @param \Drupal\Core\FileTransfer\FileTransfer $filetransfer
302 303 304
   *   Object which is a child of FileTransfer.
   * @param string $directory
   *   The installation directory to prepare.
305
   *
306
   * @throws \Drupal\Core\Updater\UpdaterException
307 308 309 310 311 312 313 314 315 316 317 318 319 320 321
   */
  public function prepareInstallDirectory(&$filetransfer, $directory) {
    // Make the parent dir writable if need be and create the dir.
    if (!is_dir($directory)) {
      $parent_dir = dirname($directory);
      if (!is_writable($parent_dir)) {
        @chmod($parent_dir, 0755);
        // It is expected that this will fail if the directory is owned by the
        // FTP user. If the FTP user == web server, it will succeed.
        try {
          $filetransfer->createDirectory($directory);
          $this->makeWorldReadable($filetransfer, $directory);
        }
        catch (FileTransferException $e) {
          // Probably still not writable. Try to chmod and do it again.
322
          // @todo Make a new exception class so we can catch it differently.
323 324 325 326 327 328 329 330 331 332
          try {
            $old_perms = substr(sprintf('%o', fileperms($parent_dir)), -4);
            $filetransfer->chmod($parent_dir, 0755);
            $filetransfer->createDirectory($directory);
            $this->makeWorldReadable($filetransfer, $directory);
            // Put the permissions back.
            $filetransfer->chmod($parent_dir, intval($old_perms, 8));
          }
          catch (FileTransferException $e) {
            $message = t($e->getMessage(), $e->arguments);
333
            $throw_message = t('Unable to create %directory due to the following: %reason', ['%directory' => $directory, '%reason' => $message]);
334 335 336 337 338 339 340 341 342 343
            throw new UpdaterException($throw_message);
          }
        }
        // Put the parent directory back.
        @chmod($parent_dir, 0555);
      }
    }
  }

  /**
344
   * Ensures that a given directory is world readable.
345
   *
346
   * @param \Drupal\Core\FileTransfer\FileTransfer $filetransfer
347 348 349 350 351 352 353 354 355 356 357 358 359 360 361
   *   Object which is a child of FileTransfer.
   * @param string $path
   *   The file path to make world readable.
   * @param bool $recursive
   *   If the chmod should be applied recursively.
   */
  public function makeWorldReadable(&$filetransfer, $path, $recursive = TRUE) {
    if (!is_executable($path)) {
      // Set it to read + execute.
      $new_perms = substr(sprintf('%o', fileperms($path)), -4, -1) . "5";
      $filetransfer->chmod($path, intval($new_perms, 8), $recursive);
    }
  }

  /**
362
   * Performs a backup.
363
   *
364
   * @param \Drupal\Core\FileTransfer\FileTransfer $filetransfer
365 366 367 368 369 370
   *   Object which is a child of FileTransfer.
   * @param string $from
   *   The file path to copy from.
   * @param string $to
   *   The file path to copy to.
   *
371
   * @todo Not implemented: https://www.drupal.org/node/2474355
372
   */
373
  public function makeBackup(FileTransfer $filetransfer, $from, $to) {
374 375 376
  }

  /**
377
   * Returns the full path to a directory where backups should be written.
378 379
   */
  public function getBackupDir() {
380
    return \Drupal::service('stream_wrapper_manager')->getViaScheme('temporary')->getDirectoryPath();
381 382 383
  }

  /**
384
   * Performs actions after new code is updated.
385 386 387 388 389
   */
  public function postUpdate() {
  }

  /**
390
   * Performs actions after installation.
391 392 393 394 395
   */
  public function postInstall() {
  }

  /**
396
   * Returns an array of links to pages that should be visited post operation.
397 398 399 400 401
   *
   * @return array
   *   Links which provide actions to take after the install is finished.
   */
  public function postInstallTasks() {
402
    return [];
403 404 405
  }

  /**
406
   * Returns an array of links to pages that should be visited post operation.
407 408 409 410 411
   *
   * @return array
   *   Links which provide actions to take after the update is finished.
   */
  public function postUpdateTasks() {
412
    return [];
413
  }
414

415
}