ThemeHandler.php 15 KB
Newer Older
1 2 3 4 5 6 7 8 9 10
<?php

/**
 * @file
 * Contains \Drupal\Core\Extension\ThemeHandler.
 */

namespace Drupal\Core\Extension;

use Drupal\Component\Utility\String;
11
use Drupal\Core\Cache\Cache;
12
use Drupal\Core\Cache\CacheBackendInterface;
13
use Drupal\Core\Config\ConfigFactoryInterface;
14
use Drupal\Core\Config\ConfigInstallerInterface;
15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48
use Drupal\Core\Routing\RouteBuilder;

/**
 * Default theme handler using the config system for enabled/disabled themes.
 */
class ThemeHandler implements ThemeHandlerInterface {

  /**
   * Contains the features enabled for themes by default.
   *
   * @var array
   */
  protected $defaultFeatures = array(
    'logo',
    'favicon',
    'name',
    'slogan',
    'node_user_picture',
    'comment_user_picture',
    'comment_user_verification',
    'main_menu',
    'secondary_menu',
  );

  /**
   * A list of all currently available themes.
   *
   * @var array
   */
  protected $list = array();

  /**
   * The config factory to get the enabled themes.
   *
49
   * @var \Drupal\Core\Config\ConfigFactoryInterface
50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66
   */
  protected $configFactory;

  /**
   * The module handler to fire themes_enabled/themes_disabled hooks.
   *
   * @var \Drupal\Core\Extension\ModuleHandlerInterface
   */
  protected $moduleHandler;

  /**
   * The cache backend to clear the local tasks cache.
   *
   * @var \Drupal\Core\Cache\CacheBackendInterface
   */
  protected $cacheBackend;

67 68 69 70 71 72 73
  /**
   *  The config installer to install configuration.
   *
   * @var \Drupal\Core\Config\ConfigInstallerInterface
   */
  protected $configInstaller;

74 75 76 77 78 79 80 81 82 83 84 85
  /**
   * The info parser to parse the theme.info.yml files.
   *
   * @var \Drupal\Core\Extension\InfoParserInterface
   */
  protected $infoParser;

  /**
   * The route builder to rebuild the routes if a theme is enabled.
   *
   * @var \Drupal\Core\Routing\RouteBuilder
   */
86
  protected $routeBuilder;
87 88

  /**
89
   * An extension discovery instance.
90
   *
91
   * @var \Drupal\Core\Extension\ExtensionDiscovery
92
   */
93
  protected $extensionDiscovery;
94 95 96 97

  /**
   * Constructs a new ThemeHandler.
   *
98
   * @param \Drupal\Core\Config\ConfigFactoryInterface $config_factory
99 100 101 102 103 104 105
   *   The config factory to get the enabled themes.
   * @param \Drupal\Core\Extension\ModuleHandlerInterface $module_handler
   *   The module handler to fire themes_enabled/themes_disabled hooks.
   * @param \Drupal\Core\Cache\CacheBackendInterface $cache_backend
   *   The cache backend to clear the local tasks cache.
   * @param \Drupal\Core\Extension\InfoParserInterface $info_parser
   *   The info parser to parse the theme.info.yml files.
106 107 108 109
   * @param \Drupal\Core\Config\ConfigInstallerInterface $config_installer
   *   (optional) The config installer to install configuration. This optional
   *   to allow the theme handler to work before Drupal is installed and has a
   *   database.
110 111
   * @param \Drupal\Core\Routing\RouteBuilder $route_builder
   *   (optional) The route builder to rebuild the routes if a theme is enabled.
112 113
   * @param \Drupal\Core\Extension\ExtensionDiscovery $extension_discovery
   *   (optional) A extension discovery instance (for unit tests).
114
   */
115
  public function __construct(ConfigFactoryInterface $config_factory, ModuleHandlerInterface $module_handler, CacheBackendInterface $cache_backend, InfoParserInterface $info_parser, ConfigInstallerInterface $config_installer = NULL, RouteBuilder $route_builder = NULL, ExtensionDiscovery $extension_discovery = NULL) {
116 117 118 119
    $this->configFactory = $config_factory;
    $this->moduleHandler = $module_handler;
    $this->cacheBackend = $cache_backend;
    $this->infoParser = $info_parser;
120
    $this->configInstaller = $config_installer;
121
    $this->routeBuilder = $route_builder;
122
    $this->extensionDiscovery = $extension_discovery;
123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144
  }

  /**
   * {@inheritdoc}
   */
  public function enable(array $theme_list) {
    $this->clearCssCache();
    $theme_config = $this->configFactory->get('system.theme');
    $disabled_themes = $this->configFactory->get('system.theme.disabled');
    foreach ($theme_list as $key) {
      // Throw an exception if the theme name is too long.
      if (strlen($key) > DRUPAL_EXTENSION_NAME_MAX_LENGTH) {
        throw new ExtensionNameLengthException(String::format('Theme name %name is over the maximum allowed length of @max characters.', array(
          '%name' => $key,
          '@max' => DRUPAL_EXTENSION_NAME_MAX_LENGTH,
        )));
      }

      // The value is not used; the weight is ignored for themes currently.
      $theme_config->set("enabled.$key", 0)->save();
      $disabled_themes->clear($key)->save();

145 146
      // Refresh the theme list as installation of default configuration needs
      // an updated list to work.
147 148
      $this->reset();
      // Install default configuration of the theme.
149
      $this->configInstaller->installDefaultConfig('theme', $key);
150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222
    }

    $this->resetSystem();

    // Invoke hook_themes_enabled() after the themes have been enabled.
    $this->moduleHandler->invokeAll('themes_enabled', array($theme_list));
  }

  /**
   * {@inheritdoc}
   */
  public function disable(array $theme_list) {
    // Don't disable the default theme.
    if ($pos = array_search($this->configFactory->get('system.theme')->get('default'), $theme_list) !== FALSE) {
      unset($theme_list[$pos]);
      if (empty($theme_list)) {
        return;
      }
    }

    $this->clearCssCache();

    $theme_config = $this->configFactory->get('system.theme');
    $disabled_themes = $this->configFactory->get('system.theme.disabled');
    foreach ($theme_list as $key) {
      // The value is not used; the weight is ignored for themes currently.
      $theme_config->clear("enabled.$key");
      $disabled_themes->set($key, 0);
    }
    $theme_config->save();
    $disabled_themes->save();

    $this->reset();
    $this->resetSystem();

    // Invoke hook_themes_disabled after the themes have been disabled.
    $this->moduleHandler->invokeAll('themes_disabled', array($theme_list));
  }

  /**
   * {@inheritdoc}
   */
  public function listInfo() {
    if (empty($this->list)) {
      $this->list = array();
      try {
        $themes = $this->systemThemeList();
      }
      catch (\Exception $e) {
        // If the database is not available, rebuild the theme data.
        $themes = $this->rebuildThemeData();
      }

      foreach ($themes as $theme) {
        foreach ($theme->info['stylesheets'] as $media => $stylesheets) {
          foreach ($stylesheets as $stylesheet => $path) {
            $theme->stylesheets[$media][$stylesheet] = $path;
          }
        }
        foreach ($theme->info['scripts'] as $script => $path) {
          $theme->scripts[$script] = $path;
        }
        if (isset($theme->info['engine'])) {
          $theme->engine = $theme->info['engine'];
        }
        if (isset($theme->info['base theme'])) {
          $theme->base_theme = $theme->info['base theme'];
        }
        // Status is normally retrieved from the database. Add zero values when
        // read from the installation directory to prevent notices.
        if (!isset($theme->status)) {
          $theme->status = 0;
        }
223
        $this->list[$theme->getName()] = $theme;
224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244
      }
    }
    return $this->list;
  }

  /**
   * {@inheritdoc}
   */
  public function reset() {
    // listInfo() calls system_info() which has a lot of side effects that have
    // to be triggered like the classloading of theme classes.
    $this->list = array();
    $this->systemListReset();
    $this->listInfo();
    $this->list = array();
  }

  /**
   * {@inheritdoc}
   */
  public function rebuildThemeData() {
245 246 247
    $listing = $this->getExtensionDiscovery();
    $themes = $listing->scan('theme');
    $engines = $listing->scan('theme_engine');
248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273

    // Set defaults for theme info.
    $defaults = array(
      'engine' => 'twig',
      'regions' => array(
        'sidebar_first' => 'Left sidebar',
        'sidebar_second' => 'Right sidebar',
        'content' => 'Content',
        'header' => 'Header',
        'footer' => 'Footer',
        'highlighted' => 'Highlighted',
        'help' => 'Help',
        'page_top' => 'Page top',
        'page_bottom' => 'Page bottom',
      ),
      'description' => '',
      'features' => $this->defaultFeatures,
      'screenshot' => 'screenshot.png',
      'php' => DRUPAL_MINIMUM_PHP,
      'stylesheets' => array(),
      'scripts' => array(),
    );

    $sub_themes = array();
    // Read info files for each theme.
    foreach ($themes as $key => $theme) {
274
      $theme->info = $this->infoParser->parse($theme->getPathname()) + $defaults;
275 276 277

      // Add the info file modification time, so it becomes available for
      // contributed modules to use for ordering theme lists.
278
      $theme->info['mtime'] = $theme->getMTime();
279 280 281

      // Invoke hook_system_info_alter() to give installed modules a chance to
      // modify the data in the .info.yml files if necessary.
282
      // @todo Remove $type argument, obsolete with $theme->getType().
283
      $type = 'theme';
284
      $this->moduleHandler->alter('system_info', $theme->info, $theme, $type);
285

286
      if (!empty($theme->info['base theme'])) {
287 288 289
        $sub_themes[] = $key;
      }

290 291
      // Defaults to 'twig' (see $defaults above).
      $engine = $theme->info['engine'];
292
      if (isset($engines[$engine])) {
293
        $theme->owner = $engines[$engine]->getExtensionPathname();
294
        $theme->prefix = $engines[$engine]->getName();
295 296
      }

297 298
      // Prefix stylesheets, scripts, and screenshot with theme path.
      $path = $theme->getPath();
299 300
      $theme->info['stylesheets'] = $this->themeInfoPrefixPath($theme->info['stylesheets'], $path);
      $theme->info['scripts'] = $this->themeInfoPrefixPath($theme->info['scripts'], $path);
301 302
      if (!empty($theme->info['screenshot'])) {
        $theme->info['screenshot'] = $path . '/' . $theme->info['screenshot'];
303 304 305
      }
    }

306 307
    // After establishing the full list of available themes, fill in data for
    // sub-themes.
308
    foreach ($sub_themes as $key) {
309 310 311 312 313 314 315 316
      $sub_theme = $themes[$key];
      // The $base_themes property is optional; only set for sub themes.
      // @see ThemeHandlerInterface::listInfo()
      $sub_theme->base_themes = $this->getBaseThemes($themes, $key);
      // empty() cannot be used here, since ThemeHandler::doGetBaseThemes() adds
      // the key of a base theme with a value of NULL in case it is not found,
      // in order to prevent needless iterations.
      if (!current($sub_theme->base_themes)) {
317 318
        continue;
      }
319 320 321 322 323
      // Determine the root base theme.
      $root_key = key($sub_theme->base_themes);
      // Build the list of sub-themes for each of the theme's base themes.
      foreach (array_keys($sub_theme->base_themes) as $base_theme) {
        $themes[$base_theme]->sub_themes[$key] = $sub_theme->info['name'];
324
      }
325 326 327 328 329
      // Add the theme engine info from the root base theme.
      if (isset($themes[$root_key]->owner)) {
        $sub_theme->info['engine'] = $themes[$root_key]->info['engine'];
        $sub_theme->owner = $themes[$root_key]->owner;
        $sub_theme->prefix = $themes[$root_key]->prefix;
330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415
      }
    }

    return $themes;
  }

  /**
   * Prefixes all values in an .info.yml file array with a given path.
   *
   * This helper function is mainly used to prefix all array values of an
   * .info.yml file property with a single given path (to the module or theme);
   * e.g., to prefix all values of the 'stylesheets' or 'scripts' properties
   * with the file path to the defining module/theme.
   *
   * @param array $info
   *   A nested array of data of an .info.yml file to be processed.
   * @param string $path
   *   A file path to prepend to each value in $info.
   *
   * @return array
   *   The $info array with prefixed values.
   *
   * @see _system_rebuild_module_data()
   * @see self::rebuildThemeData()
   */
  protected function themeInfoPrefixPath(array $info, $path) {
    foreach ($info as $key => $value) {
      // Recurse into nested values until we reach the deepest level.
      if (is_array($value)) {
        $info[$key] = $this->themeInfoPrefixPath($info[$key], $path);
      }
      // Unset the original value's key and set the new value with prefix, using
      // the original value as key, so original values can still be looked up.
      else {
        unset($info[$key]);
        $info[$value] = $path . '/' . $value;
      }
    }
    return $info;
  }

  /**
   * {@inheritdoc}
   */
  public function getBaseThemes(array $themes, $theme) {
    return $this->doGetBaseThemes($themes, $theme);
  }

  /**
   * Finds the base themes for the specific theme.
   *
   * @param array $themes
   *   An array of available themes.
   * @param string $theme
   *   The name of the theme whose base we are looking for.
   * @param array $used_themes
   *   (optional) A recursion parameter preventing endless loops. Defaults to
   *   an empty array.
   *
   * @return array
   *   An array of base themes.
   */
  protected function doGetBaseThemes(array $themes, $theme, $used_themes = array()) {
    if (!isset($themes[$theme]->info['base theme'])) {
      return array();
    }

    $base_key = $themes[$theme]->info['base theme'];
    // Does the base theme exist?
    if (!isset($themes[$base_key])) {
      return array($base_key => NULL);
    }

    $current_base_theme = array($base_key => $themes[$base_key]->info['name']);

    // Is the base theme itself a child of another theme?
    if (isset($themes[$base_key]->info['base theme'])) {
      // Do we already know the base themes of this theme?
      if (isset($themes[$base_key]->base_themes)) {
        return $themes[$base_key]->base_themes + $current_base_theme;
      }
      // Prevent loops.
      if (!empty($used_themes[$base_key])) {
        return array($base_key => NULL);
      }
      $used_themes[$base_key] = TRUE;
416
      return $this->doGetBaseThemes($themes, $base_key, $used_themes) + $current_base_theme;
417 418 419 420 421 422
    }
    // If we get here, then this is our parent theme.
    return $current_base_theme;
  }

  /**
423
   * Returns an extension discovery object.
424
   *
425 426
   * @return \Drupal\Core\Extension\ExtensionDiscovery
   *   The extension discovery object.
427
   */
428 429 430
  protected function getExtensionDiscovery() {
    if (!isset($this->extensionDiscovery)) {
      $this->extensionDiscovery = new ExtensionDiscovery();
431
    }
432
    return $this->extensionDiscovery;
433 434 435 436 437 438 439
  }

  /**
   * Resets some other systems like rebuilding the route information or caches.
   */
  protected function resetSystem() {
    if ($this->routeBuilder) {
440
      $this->routeBuilder->setRebuildNeeded();
441 442 443 444 445
    }
    $this->systemListReset();

    // @todo It feels wrong to have the requirement to clear the local tasks
    //   cache here.
446
    Cache::deleteTags(array('local_task' => 1));
447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481
    $this->themeRegistryRebuild();
  }

  /**
   * Wraps system_list_reset().
   */
  protected function systemListReset() {
    system_list_reset();
  }

  /**
   * Wraps drupal_clear_css_cache().
   */
  protected function clearCssCache() {
    drupal_clear_css_cache();
  }

  /**
   * Wraps drupal_theme_rebuild().
   */
  protected function themeRegistryRebuild() {
    drupal_theme_rebuild();
  }

  /**
   * Wraps system_list().
   *
   * @return array
   *   A list of themes keyed by name.
   */
  protected function systemThemeList() {
    return system_list('theme');
  }

}