system.updater.inc

<?php

/**
 * @file
 * Subclasses of the Updater class to update Backdrop core, modules, themes, and layouts.
 */

/**
 * Class for updating Backdrop core using FileTransfer classes via authorize.php.
 */
class CoreUpdater extends Updater {

  /**
   * Return the Backdrop core directory.
   */
  public function getInstallDirectory() {
    return realpath(BACKDROP_ROOT);
  }

  public function isInstalled() {
    return (bool) file_exists($this->getInstallDirectory());
  }

  public static function canUpdateDirectory($directory) {
    return (self::getProjectType($directory) == 'core');
  }

  static function canUpdate($project_name) {
    return (bool) $this->isInstalled();
  }

  /**
   * List of post install actions.
   */
  public function postInstall() {
    $project = array();
    $project['name'] = $this->name;
    $project['type'] = 'core';
    $_SESSION['project_browser_installed_projects'][$this->name] = $project;
  }

  /**
   * List of post install actions.
   */
  public function postInstallTasks() {
    return array();
  }

  public function postUpdateTasks() {
    // We don't want to check for DB updates here, we do that once for all
    // updated modules on the landing page.
  }

}

/**
 * Class for updating modules using FileTransfer classes via authorize.php.
 */
class ModuleUpdater extends Updater {

  /**
   * Return the directory where a module should be installed.
   *
   * If the module is already installed, backdrop_get_path() will return
   * a valid path and we should install it there (although we need to use an
   * absolute path, so we prepend BACKDROP_ROOT). If we're installing a new
   * module, we always want it to go into /modules, since that's
   * where all the documentation recommends users install their modules, and
   * there's no way that can conflict on a multi-site installation, since
   * the Update manager won't let you install a new module if it's already
   * found on your system, and if there was a copy in top-level, we'd see it.
   */
  public function getInstallDirectory() {
    if ($relative_path = backdrop_get_path('module', $this->name)) {
      $relative_path = dirname($relative_path);
    }
    elseif (file_exists(BACKDROP_ROOT . '/modules/contrib')) {
      $relative_path = 'modules/contrib';
    }
    else {
      $relative_path = 'modules';
    }
    return realpath(BACKDROP_ROOT) . '/' . $relative_path;
  }

  public function isInstalled() {
    return (bool) backdrop_get_path('module', $this->name);
  }

  public static function canUpdateDirectory($directory) {
    return (self::getProjectType($directory) == 'module');
  }

  static function canUpdate($project_name) {
    return (bool) backdrop_get_path('module', $project_name);
  }

  /**
   * List of post install actions.
   */
  public function postInstall() {
    $project = array();
    $project['name'] = $this->name;
    $project['type'] = 'module';
    $_SESSION['project_browser_installed_projects'][$this->name] = $project;
  }

  /**
   * List of post install actions.
   */
  public function postInstallTasks() {
    return array(
      l(t('Enable newly added modules'), 'admin/modules'),
      l(t('Browse more modules'), 'admin/modules/install'),
    );
  }

  public function postUpdateTasks() {
    // We don't want to check for DB updates here, we do that once for all
    // updated modules on the landing page.
  }

}

/**
 * Class for updating themes using FileTransfer classes via authorize.php.
 */
class ThemeUpdater extends Updater {

  /**
   * Return the directory where a theme should be installed.
   *
   * If the theme is already installed, backdrop_get_path() will return
   * a valid path and we should install it there (although we need to use an
   * absolute path, so we prepend BACKDROP_ROOT). If we're installing a new
   * theme, we always want it to go into /themes, since that's
   * where all the documentation recommends users install their themes, and
   * there's no way that can conflict on a multi-site installation, since
   * the Update manager won't let you install a new theme if it's already
   * found on your system, and if there was a copy in top-level, we'd see it.
   */
  public function getInstallDirectory() {
    if ($relative_path = backdrop_get_path('theme', $this->name)) {
      $relative_path = dirname($relative_path);
    }
    elseif (file_exists(BACKDROP_ROOT . '/themes/contrib')) {
      $relative_path = 'themes/contrib';
    }
    else {
      $relative_path = 'themes';
    }
    return realpath(BACKDROP_ROOT) . '/' . $relative_path;
  }

  public function isInstalled() {
    return (bool) backdrop_get_path('theme', $this->name);
  }

  public static function canUpdateDirectory($directory) {
    return (self::getProjectType($directory) == 'theme');
  }

  public static function canUpdate($project_name) {
    return (bool) backdrop_get_path('theme', $project_name);
  }

  public function postInstall() {
    // Update the system table.
    clearstatcache();
    system_rebuild_theme_data();
  }

  public function postInstallTasks() {
    return array(
      l(t('Enable newly added themes'), 'admin/appearance'),
      l(t('Browse more themes'), 'admin/appearance/install'),
    );
  }
}

/**
 * Class for updating layouts using FileTransfer classes via authorize.php.
 */
class LayoutUpdater extends Updater {

  /**
   * Return the directory where a layout should be installed.
   *
   * If the layout is already installed, backdrop_get_path() will return
   * a valid path and we should install it there (although we need to use an
   * absolute path, so we prepend BACKDROP_ROOT). If we're installing a new
   * layout, we always want it to go into /layouts, since that's
   * where all the documentation recommends users install their layouts, and
   * there's no way that can conflict on a multi-site installation, since
   * the Update manager won't let you install a new layout if it's already
   * found on your system, and if there was a copy in top-level, we'd see it.
   */
  public function getInstallDirectory() {
    if ($relative_path = backdrop_get_path('layout', $this->name)) {
      $relative_path = dirname($relative_path);
    }
    elseif (file_exists(BACKDROP_ROOT . '/layouts/contrib')) {
      $relative_path = 'layouts/contrib';
    }
    else {
      $relative_path = 'layouts';
    }
    return realpath(BACKDROP_ROOT) . '/' . $relative_path;
  }

  public function isInstalled() {
    return (bool) backdrop_get_path('layout', $this->name);
  }

  public static function canUpdateDirectory($directory) {
    return (self::getProjectType($directory) == 'layout');
  }

  public static function canUpdate($project_name) {
    return (bool) backdrop_get_path('layout', $project_name);
  }

  public function postInstall() {
    layout_reset_caches();
    clearstatcache();
  }

  public function postInstallTasks() {
    return array(
      l(t('Use newly added layouts'), 'admin/structure/layouts'),
      l(t('Browse more layouts'), 'admin/structure/layouts/install'),
    );
  }
}