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

3 4
namespace Drupal\Core\Updater;

5
use Drupal\Component\Utility\Unicode;
6
use Drupal\Core\FileTransfer\FileTransferException;
7
use Drupal\Core\FileTransfer\FileTransfer;
8

9
/**
10
 * Defines the base class for Updaters used in Drupal.
11
 */
12
class Updater {
13 14

  /**
15
   * Directory to install from.
16
   *
17
   * @var string
18
   */
19
  public $source;
20

21 22 23 24 25 26 27
  /**
   * The root directory under which new projects will be copied.
   *
   * @var string
   */
  protected $root;

28
  /**
29
   * Constructs a new updater.
30
   *
31 32
   * @param string $source
   *   Directory to install from.
33 34 35 36
   * @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).
37
   */
38
  public function __construct($source, $root) {
39
    $this->source = $source;
40
    $this->root = $root;
41 42 43 44 45
    $this->name = self::getProjectName($source);
    $this->title = self::getProjectTitle($source);
  }

  /**
46
   * Returns an Updater of the appropriate type depending on the source.
47 48 49 50 51 52
   *
   * If a directory is provided which contains a module, will return a
   * ModuleUpdater.
   *
   * @param string $source
   *   Directory of a Drupal project.
53 54 55 56
   * @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).
57
   *
58
   * @return \Drupal\Core\Updater\Updater
59 60
   *   A new Drupal\Core\Updater\Updater object.
   *
61
   * @throws \Drupal\Core\Updater\UpdaterException
62
   */
63
  public static function factory($source, $root) {
64 65 66 67 68 69
    if (is_dir($source)) {
      $updater = self::getUpdaterFromDirectory($source);
    }
    else {
      throw new UpdaterException(t('Unable to determine the type of the source directory.'));
    }
70
    return new $updater($source, $root);
71 72 73
  }

  /**
74
   * Determines which Updater class can operate on the given directory.
75 76 77 78 79 80
   *
   * @param string $directory
   *   Extracted Drupal project.
   *
   * @return string
   *   The class name which can work with this project type.
81
   *
82
   * @throws \Drupal\Core\Updater\UpdaterException
83 84 85 86 87 88 89 90 91 92 93 94 95 96
   */
  public static function getUpdaterFromDirectory($directory) {
    // Gets a list of possible implementing classes.
    $updaters = drupal_get_updaters();
    foreach ($updaters as $updater) {
      $class = $updater['class'];
      if (call_user_func(array($class, 'canUpdateDirectory'), $directory)) {
        return $class;
      }
    }
    throw new UpdaterException(t('Cannot determine the type of project.'));
  }

  /**
97
   * Determines what the most important (or only) info file is in a directory.
98 99 100 101 102 103 104 105 106 107 108 109
   *
   * 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) {
110
    $info_files = file_scan_directory($directory, '/.*\.info.yml$/');
111 112 113 114
    if (!$info_files) {
      return FALSE;
    }
    foreach ($info_files as $info_file) {
115
      if (Unicode::substr($info_file->filename, 0, -9) == drupal_basename($directory)) {
116 117 118 119 120 121 122 123 124
        // 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;
  }

125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146
  /**
   * 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)) {
      throw new UpdaterException(t('Unable to parse info file: %info_file.', ['%info_file' => $info_file]));
    }

    return $info;
  }

147
  /**
148
   * Gets the name of the project directory (basename).
149
   *
150 151
   * @todo It would be nice, if projects contained an info file which could
   *   provide their canonical name.
152 153 154 155 156 157 158 159 160 161 162
   *
   * @param string $directory
   *
   * @return string
   *   The name of the project.
   */
  public static function getProjectName($directory) {
    return drupal_basename($directory);
  }

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

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

  /**
201
   * Updates a Drupal project and returns a list of next actions.
202
   *
203
   * @param \Drupal\Core\FileTransfer\FileTransfer $filetransfer
204 205 206 207 208 209 210
   *   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
211
   *
212 213
   * @throws \Drupal\Core\Updater\UpdaterException
   * @throws \Drupal\Core\Updater\UpdaterFileTransferException
214 215 216 217 218 219 220 221
   */
  public function update(&$filetransfer, $overrides = array()) {
    try {
      // Establish arguments with possible overrides.
      $args = $this->getInstallArgs($overrides);

      // Take a Backup.
      if ($args['make_backup']) {
222
        $this->makeBackup($filetransfer, $args['install_dir'], $args['backup_dir']);
223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244
      }

      if (!$this->name) {
        // This is bad, don't want to delete the install directory.
        throw new UpdaterException(t('Fatal error in update, cowardly refusing to wipe out the install directory.'));
      }

      // 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.
245
      // @todo Decide if we want to implement this.
246 247 248 249 250 251
      $this->postUpdate();

      // For now, just return a list of links of things to do.
      return $this->postUpdateTasks();
    }
    catch (FileTransferException $e) {
252
      throw new UpdaterFileTransferException(t('File Transfer failed, reason: @reason', array('@reason' => strtr($e->getMessage(), $e->arguments))));
253 254 255 256 257 258
    }
  }

  /**
   * Installs a Drupal project, returns a list of next actions.
   *
259
   * @param \Drupal\Core\FileTransfer\FileTransfer $filetransfer
260 261 262 263 264 265
   *   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.
266
   *
267
   * @throws \Drupal\Core\Updater\UpdaterFileTransferException
268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283
   */
  public function install(&$filetransfer, $overrides = array()) {
    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?
284
      // @todo Decide if we want to implement this.
285 286 287 288 289
      $this->postInstall();
      // For now, just return a list of links of things to do.
      return $this->postInstallTasks();
    }
    catch (FileTransferException $e) {
290
      throw new UpdaterFileTransferException(t('File Transfer failed, reason: @reason', array('@reason' => strtr($e->getMessage(), $e->arguments))));
291 292 293 294
    }
  }

  /**
295
   * Makes sure the installation parent directory exists and is writable.
296
   *
297
   * @param \Drupal\Core\FileTransfer\FileTransfer $filetransfer
298 299 300
   *   Object which is a child of FileTransfer.
   * @param string $directory
   *   The installation directory to prepare.
301
   *
302
   * @throws \Drupal\Core\Updater\UpdaterException
303 304 305 306 307 308 309 310 311 312 313 314 315 316 317
   */
  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.
318
          // @todo Make a new exception class so we can catch it differently.
319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339
          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);
            $throw_message = t('Unable to create %directory due to the following: %reason', array('%directory' => $directory, '%reason' => $message));
            throw new UpdaterException($throw_message);
          }
        }
        // Put the parent directory back.
        @chmod($parent_dir, 0555);
      }
    }
  }

  /**
340
   * Ensures that a given directory is world readable.
341
   *
342
   * @param \Drupal\Core\FileTransfer\FileTransfer $filetransfer
343 344 345 346 347 348 349 350 351 352 353 354 355 356 357
   *   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);
    }
  }

  /**
358
   * Performs a backup.
359
   *
360
   * @param \Drupal\Core\FileTransfer\FileTransfer $filetransfer
361 362 363 364 365 366
   *   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.
   *
367
   * @todo Not implemented: https://www.drupal.org/node/2474355
368
   */
369
  public function makeBackup(FileTransfer $filetransfer, $from, $to) {
370 371 372
  }

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

  /**
380
   * Performs actions after new code is updated.
381 382 383 384 385
   */
  public function postUpdate() {
  }

  /**
386
   * Performs actions after installation.
387 388 389 390 391
   */
  public function postInstall() {
  }

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

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