theme.inc 105 KB
Newer Older
Dries's avatar
 
Dries committed
1
<?php
2
use Drupal\Core\Utility\CacheArray;
3
/**
Dries's avatar
 
Dries committed
4
 * @file
5
 * The theme system, which controls the output of Drupal.
Dries's avatar
 
Dries committed
6 7 8 9
 *
 * The theme system allows for nearly all output of the Drupal system to be
 * customized by user themes.
 */
Dries's avatar
 
Dries committed
10

11
/**
12
 * @defgroup content_flags Content markers
13 14 15 16
 * @{
 * Markers used by theme_mark() and node_mark() to designate content.
 * @see theme_mark(), node_mark()
 */
17 18 19 20

/**
 * Mark content as read.
 */
21
const MARK_READ = 0;
22 23 24 25

/**
 * Mark content as being new.
 */
26
const MARK_NEW = 1;
27 28 29 30

/**
 * Mark content as being updated.
 */
31
const MARK_UPDATED = 2;
32

33
/**
34
 * @} End of "defgroup content_flags".
35 36
 */

37 38 39 40
/**
 * Determines if a theme is available to use.
 *
 * @param $theme
41 42
 *   Either the name of a theme or a full theme object.
 *
43 44 45 46 47
 * @return
 *   Boolean TRUE if the theme is enabled or is the site administration theme;
 *   FALSE otherwise.
 */
function drupal_theme_access($theme) {
48 49 50 51 52 53 54 55 56 57 58 59 60 61 62
  if (is_object($theme)) {
    return _drupal_theme_access($theme);
  }
  else {
    $themes = list_themes();
    return isset($themes[$theme]) && _drupal_theme_access($themes[$theme]);
  }
}

/**
 * Helper function for determining access to a theme.
 *
 * @see drupal_theme_access()
 */
function _drupal_theme_access($theme) {
63 64 65 66
  $admin_theme = variable_get('admin_theme');
  return !empty($theme->status) || ($admin_theme && $theme->name == $admin_theme);
}

Dries's avatar
 
Dries committed
67
/**
Dries's avatar
 
Dries committed
68
 * Initialize the theme system by loading the theme.
Dries's avatar
 
Dries committed
69
 */
70
function drupal_theme_initialize() {
71
  global $theme, $user, $theme_key;
72 73 74 75 76

  // If $theme is already set, assume the others are set, too, and do nothing
  if (isset($theme)) {
    return;
  }
Dries's avatar
 
Dries committed
77

78
  drupal_bootstrap(DRUPAL_BOOTSTRAP_DATABASE);
Dries's avatar
 
Dries committed
79 80
  $themes = list_themes();

81
  // Only select the user selected theme if it is available in the
82
  // list of themes that can be accessed.
83
  $theme = !empty($user->theme) && drupal_theme_access($user->theme) ? $user->theme : variable_get('theme_default', 'stark');
Dries's avatar
 
Dries committed
84

85 86
  // Allow modules to override the theme. Validation has already been performed
  // inside menu_get_custom_theme(), so we do not need to check it again here.
87
  $custom_theme = menu_get_custom_theme();
88
  $theme = !empty($custom_theme) ? $custom_theme : $theme;
Dries's avatar
 
Dries committed
89 90 91 92

  // Store the identifier for retrieving theme settings with.
  $theme_key = $theme;

93 94 95 96
  // Find all our ancestor themes and put them in an array.
  $base_theme = array();
  $ancestor = $theme;
  while ($ancestor && isset($themes[$ancestor]->base_theme)) {
97
    $ancestor = $themes[$ancestor]->base_theme;
98
    $base_theme[] = $themes[$ancestor];
99
  }
100
  _drupal_theme_initialize($themes[$theme], array_reverse($base_theme));
101 102 103

  // Themes can have alter functions, so reset the drupal_alter() cache.
  drupal_static_reset('drupal_alter');
104 105

  // Provide the page with information about the theme that's used, so that a
106
  // later Ajax request can be rendered using the same theme.
107 108 109
  // @see ajax_base_page_theme()
  $setting['ajaxPageState'] = array(
    'theme' => $theme_key,
110
    'theme_token' => drupal_get_token($theme_key),
111 112
  );
  drupal_add_js($setting, 'setting');
113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136
}

/**
 * Initialize the theme system given already loaded information. This
 * function is useful to initialize a theme when no database is present.
 *
 * @param $theme
 *   An object with the following information:
 *     filename
 *       The .info file for this theme. The 'path' to
 *       the theme will be in this file's directory. (Required)
 *     owner
 *       The path to the .theme file or the .engine file to load for
 *       the theme. (Required)
 *     stylesheet
 *       The primary stylesheet for the theme. (Optional)
 *     engine
 *       The name of theme engine to use. (Optional)
 * @param $base_theme
 *    An optional array of objects that represent the 'base theme' if the
 *    theme is meant to be derivative of another theme. It requires
 *    the same information as the $theme object. It should be in
 *    'oldest first' order, meaning the top level of the chain will
 *    be first.
137 138
 * @param $registry_callback
 *   The callback to invoke to set the theme registry.
139
 */
140
function _drupal_theme_initialize($theme, $base_theme = array(), $registry_callback = '_theme_load_registry') {
141 142 143 144 145 146
  global $theme_info, $base_theme_info, $theme_engine, $theme_path;
  $theme_info = $theme;
  $base_theme_info = $base_theme;

  $theme_path = dirname($theme->filename);

147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162
  // Prepare stylesheets from this theme as well as all ancestor themes.
  // We work it this way so that we can have child themes override parent
  // theme stylesheets easily.
  $final_stylesheets = array();

  // Grab stylesheets from base theme
  foreach ($base_theme as $base) {
    if (!empty($base->stylesheets)) {
      foreach ($base->stylesheets as $media => $stylesheets) {
        foreach ($stylesheets as $name => $stylesheet) {
          $final_stylesheets[$media][$name] = $stylesheet;
        }
      }
    }
  }

163 164 165
  // Add stylesheets used by this theme.
  if (!empty($theme->stylesheets)) {
    foreach ($theme->stylesheets as $media => $stylesheets) {
166 167 168 169 170 171 172 173 174
      foreach ($stylesheets as $name => $stylesheet) {
        $final_stylesheets[$media][$name] = $stylesheet;
      }
    }
  }

  // And now add the stylesheets properly
  foreach ($final_stylesheets as $media => $stylesheets) {
    foreach ($stylesheets as $stylesheet) {
175
      drupal_add_css($stylesheet, array('group' => CSS_THEME, 'every_page' => TRUE, 'media' => $media));
176 177 178 179 180 181 182 183 184 185 186
    }
  }

  // Do basically the same as the above for scripts
  $final_scripts = array();

  // Grab scripts from base theme
  foreach ($base_theme as $base) {
    if (!empty($base->scripts)) {
      foreach ($base->scripts as $name => $script) {
        $final_scripts[$name] = $script;
187
      }
Dries's avatar
 
Dries committed
188 189
    }
  }
190

191 192
  // Add scripts used by this theme.
  if (!empty($theme->scripts)) {
193 194
    foreach ($theme->scripts as $name => $script) {
      $final_scripts[$name] = $script;
195 196 197
    }
  }

198 199
  // Add scripts used by this theme.
  foreach ($final_scripts as $script) {
200
    drupal_add_js($script, array('group' => JS_THEME, 'every_page' => TRUE));
201 202
  }

203 204 205 206 207
  $theme_engine = NULL;

  // Initialize the theme.
  if (isset($theme->engine)) {
    // Include the engine.
208
    include_once DRUPAL_ROOT . '/' . $theme->owner;
209 210

    $theme_engine = $theme->engine;
211
    if (function_exists($theme_engine . '_init')) {
212
      foreach ($base_theme as $base) {
213
        call_user_func($theme_engine . '_init', $base);
214
      }
215
      call_user_func($theme_engine . '_init', $theme);
216 217 218 219 220 221 222
    }
  }
  else {
    // include non-engine theme files
    foreach ($base_theme as $base) {
      // Include the theme file or the engine.
      if (!empty($base->owner)) {
223
        include_once DRUPAL_ROOT . '/' . $base->owner;
224 225 226 227
      }
    }
    // and our theme gets one too.
    if (!empty($theme->owner)) {
228
      include_once DRUPAL_ROOT . '/' . $theme->owner;
Dries's avatar
 
Dries committed
229 230
    }
  }
231

232 233
  if (isset($registry_callback)) {
    _theme_registry_callback($registry_callback, array($theme, $base_theme, $theme_engine));
234
  }
Dries's avatar
 
Dries committed
235 236
}

237
/**
238
 * Get the theme registry.
239
 *
240
 * @param bool $complete
241 242 243 244 245 246 247 248 249
 *   Optional boolean to indicate whether to return the complete theme registry
 *   array or an instance of the ThemeRegistry class. If TRUE, the complete
 *   theme registry array will be returned. This is useful if you want to
 *   foreach over the whole registry, use array_* functions or inspect it in a
 *   debugger. If FALSE, an instance of the ThemeRegistry class will be
 *   returned, this provides an ArrayObject which allows it to be accessed
 *   with array syntax and  isset(), and should be more lightweight
 *   than the full registry. Defaults to TRUE.
 *
250
 * @return
251 252
 *   The complete theme registry array, or an instance of the ThemeRegistry
 *   class.
253
 */
254
function theme_get_registry($complete = TRUE) {
255 256 257 258 259 260 261 262 263 264 265 266 267 268
  // Use the advanced drupal_static() pattern, since this is called very often.
  static $drupal_static_fast;
  if (!isset($drupal_static_fast)) {
    $drupal_static_fast['registry'] = &drupal_static('theme_get_registry');
  }
  $theme_registry = &$drupal_static_fast['registry'];

  // Initialize the theme, if this is called early in the bootstrap, or after
  // static variables have been reset.
  if (!is_array($theme_registry)) {
    drupal_theme_initialize();
    $theme_registry = array();
  }

269
  $key = (int) $complete;
270

271
  if (!isset($theme_registry[$key])) {
272
    list($callback, $arguments) = _theme_registry_callback();
273 274 275 276
    if (!$complete) {
      $arguments[] = FALSE;
    }
    $theme_registry[$key] = call_user_func_array($callback, $arguments);
277 278
  }

279
  return $theme_registry[$key];
280 281 282
}

/**
283
 * Set the callback that will be used by theme_get_registry() to fetch the registry.
284
 *
285 286 287 288
 * @param $callback
 *   The name of the callback function.
 * @param $arguments
 *   The arguments to pass to the function.
289
 */
290 291 292 293
function _theme_registry_callback($callback = NULL, array $arguments = array()) {
  static $stored;
  if (isset($callback)) {
    $stored = array($callback, $arguments);
294
  }
295
  return $stored;
296 297 298
}

/**
299
 * Get the theme_registry cache; if it doesn't exist, build it.
300 301
 *
 * @param $theme
302
 *   The loaded $theme object as returned by list_themes().
303 304 305
 * @param $base_theme
 *   An array of loaded $theme objects representing the ancestor themes in
 *   oldest first order.
306
 * @param $theme_engine
307
 *   The name of the theme engine.
308 309 310 311 312 313
 * @param $complete
 *   Whether to load the complete theme registry or an instance of the
 *   ThemeRegistry class.
 *
 * @return
 *   The theme registry array, or an instance of the ThemeRegistry class.
314
 */
315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331
function _theme_load_registry($theme, $base_theme = NULL, $theme_engine = NULL, $complete = TRUE) {
  if ($complete) {
    // Check the theme registry cache; if it exists, use it.
    $cached = cache()->get("theme_registry:$theme->name");
    if (isset($cached->data)) {
      $registry = $cached->data;
    }
    else {
      // If not, build one and cache it.
      $registry = _theme_build_registry($theme, $base_theme, $theme_engine);
      // Only persist this registry if all modules are loaded. This assures a
      // complete set of theme hooks.
      if (module_load_all(NULL)) {
        _theme_save_registry($theme, $registry);
      }
    }
    return $registry;
332 333
  }
  else {
334
    return new ThemeRegistry('theme_registry:runtime:' . $theme->name, 'cache');
335 336 337 338 339 340 341
  }
}

/**
 * Write the theme_registry cache into the database.
 */
function _theme_save_registry($theme, $registry) {
342
  cache()->set("theme_registry:$theme->name", $registry);
343 344 345 346 347 348 349
}

/**
 * Force the system to rebuild the theme registry; this should be called
 * when modules are added to the system, or when a dynamic system needs
 * to add more theme hooks.
 */
350
function drupal_theme_rebuild() {
351
  drupal_static_reset('theme_get_registry');
352
  cache()->deletePrefix('theme_registry');
353 354
}

355 356 357 358 359 360 361 362
/**
 * Builds the run-time theme registry.
 *
 * Extends DrupalCacheArray to allow the theme registry to be accessed as a
 * complete registry, while internally caching only the parts of the registry
 * that are actually in use on the site. On cache misses the complete
 * theme registry is loaded and used to update the run-time cache.
 */
363
class ThemeRegistry Extends CacheArray {
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

  /**
   * Whether the partial registry can be persisted to the cache.
   *
   * This is only allowed if all modules and the request method is GET. theme()
   * should be very rarely called on POST requests and this avoids polluting
   * the runtime cache.
   */
  protected $persistable;

  /**
   * The complete theme registry array.
   */
  protected $completeRegistry;

  function __construct($cid, $bin) {
    $this->cid = $cid;
    $this->bin = $bin;
    $this->persistable = module_load_all(NULL) && $_SERVER['REQUEST_METHOD'] == 'GET';

    $data = array();
    if ($this->persistable && $cached = cache($this->bin)->get($this->cid)) {
      $data = $cached->data;
    }
    else {
389 390 391 392 393
      // If there is no runtime cache stored, fetch the full theme registry,
      // but then initialize each value to NULL. This allows offsetExists()
      // to function correctly on non-registered theme hooks without triggering
      // a call to resolveCacheMiss().
      $data = $this->initializeRegistry();
394
      if ($this->persistable) {
395
        $this->set($data);
396 397 398 399 400
      }
    }
    $this->storage = $data;
  }

401 402 403 404 405 406 407 408 409 410 411 412 413
  /**
   * Initializes the full theme registry.
   *
   * @return
   *   An array with the keys of the full theme registry, but the values
   *   initialized to NULL.
   */
  function initializeRegistry() {
    $this->completeRegistry = theme_get_registry();

    return array_fill_keys(array_keys($this->completeRegistry), NULL);
  }

414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444
  public function offsetExists($offset) {
    // Since the theme registry allows for theme hooks to be requested that
    // are not registered, just check the existence of the key in the registry.
    // Use array_key_exists() here since a NULL value indicates that the theme
    // hook exists but has not yet been requested.
    return array_key_exists($offset, $this->storage);
  }

  public function offsetGet($offset) {
    // If the offset is set but empty, it is a registered theme hook that has
    // not yet been requested. Offsets that do not exist at all were not
    // registered in hook_theme().
    if (isset($this->storage[$offset])) {
      return $this->storage[$offset];
    }
    elseif (array_key_exists($offset, $this->storage)) {
      return $this->resolveCacheMiss($offset);
    }
  }

  public function resolveCacheMiss($offset) {
    if (!isset($this->completeRegistry)) {
      $this->completeRegistry = theme_get_registry();
    }
    $this->storage[$offset] = $this->completeRegistry[$offset];
    if ($this->persistable) {
      $this->persist($offset);
    }
    return $this->storage[$offset];
  }

445 446
  public function set($data, $lock = TRUE) {
    $lock_name = $this->cid . ':' . $this->bin;
447
    if (!$lock || lock_acquire($lock_name)) {
448
      if ($cached = cache($this->bin)->get($this->cid)) {
449 450 451 452
        // Use array merge instead of union so that filled in values in $data
        // overwrite empty values in the current cache.
        $data = array_merge($cached->data, $data);
      }
453 454 455 456 457
      else {
        $registry = $this->initializeRegistry();
        $data = array_merge($registry, $data);
      }
      cache($this->bin)->set($this->cid, $data);
458 459 460 461 462 463 464
      if ($lock) {
        lock_release($lock_name);
      }
    }
  }
}

465
/**
466
 * Process a single implementation of hook_theme().
467
 *
468 469 470 471
 * @param $cache
 *   The theme registry that will eventually be cached; It is an associative
 *   array keyed by theme hooks, whose values are associative arrays describing
 *   the hook:
472 473
 *   - 'type': The passed-in $type.
 *   - 'theme path': The passed-in $path.
474 475 476 477 478 479 480 481 482
 *   - 'function': The name of the function generating output for this theme
 *     hook. Either defined explicitly in hook_theme() or, if neither 'function'
 *     nor 'template' is defined, then the default theme function name is used.
 *     The default theme function name is the theme hook prefixed by either
 *     'theme_' for modules or '$name_' for everything else. If 'function' is
 *     defined, 'template' is not used.
 *   - 'template': The filename of the template generating output for this
 *     theme hook. The template is in the directory defined by the 'path' key of
 *     hook_theme() or defaults to $path.
483 484
 *   - 'variables': The variables for this theme hook as defined in
 *     hook_theme(). If there is more than one implementation and 'variables' is
485
 *     not specified in a later one, then the previous definition is kept.
486 487 488 489
 *   - 'render element': The renderable element for this theme hook as defined
 *     in hook_theme(). If there is more than one implementation and
 *     'render element' is not specified in a later one, then the previous
 *     definition is kept.
490
 *   - 'preprocess functions': See theme() for detailed documentation.
491
 *   - 'process functions': See theme() for detailed documentation.
492 493 494 495 496 497 498 499 500 501 502 503 504 505
 * @param $name
 *   The name of the module, theme engine, base theme engine, theme or base
 *   theme implementing hook_theme().
 * @param $type
 *   One of 'module', 'theme_engine', 'base_theme_engine', 'theme', or
 *   'base_theme'. Unlike regular hooks that can only be implemented by modules,
 *   each of these can implement hook_theme(). _theme_process_registry() is
 *   called in aforementioned order and new entries override older ones. For
 *   example, if a theme hook is both defined by a module and a theme, then the
 *   definition in the theme will be used.
 * @param $theme
 *   The loaded $theme object as returned from list_themes().
 * @param $path
 *   The directory where $name is. For example, modules/system or
506
 *   themes/bartik.
507
 *
508 509 510 511
 * @see theme()
 * @see _theme_process_registry()
 * @see hook_theme()
 * @see list_themes()
512
 */
513
function _theme_process_registry(&$cache, $name, $type, $theme, $path) {
514
  $result = array();
515

516
  // Processor functions work in two distinct phases with the process
517
  // functions always being executed after the preprocess functions.
518
  $variable_process_phases = array(
519 520 521 522
    'preprocess functions' => 'preprocess',
    'process functions'    => 'process',
  );

523 524 525 526 527 528 529 530 531 532
  $hook_defaults = array(
    'variables' => TRUE,
    'render element' => TRUE,
    'pattern' => TRUE,
    'base hook' => TRUE,
  );

  // Invoke the hook_theme() implementation, process what is returned, and
  // merge it into $cache.
  $function = $name . '_theme';
533
  if (function_exists($function)) {
534
    $result = $function($cache, $type, $theme, $path);
535
    foreach ($result as $hook => $info) {
536 537 538 539 540 541 542
      // When a theme or engine overrides a module's theme function
      // $result[$hook] will only contain key/value pairs for information being
      // overridden.  Pull the rest of the information from what was defined by
      // an earlier hook.

      // Fill in the type and path of the module, theme, or engine that
      // implements this theme function.
543
      $result[$hook]['type'] = $type;
544
      $result[$hook]['theme path'] = $path;
545 546

      // If function and file are omitted, default to standard naming
547
      // conventions.
548
      if (!isset($info['template']) && !isset($info['function'])) {
549
        $result[$hook]['function'] = ($type == 'module' ? 'theme_' : $name . '_') . $hook;
550
      }
551

552 553
      if (isset($cache[$hook]['includes'])) {
        $result[$hook]['includes'] = $cache[$hook]['includes'];
554
      }
555 556 557 558 559

      // If the theme implementation defines a file, then also use the path
      // that it defined. Otherwise use the default path. This allows
      // system.module to declare theme functions on behalf of core .include
      // files.
560 561 562 563 564
      if (isset($info['file'])) {
        $include_file = isset($info['path']) ? $info['path'] : $path;
        $include_file .= '/' . $info['file'];
        include_once DRUPAL_ROOT . '/' . $include_file;
        $result[$hook]['includes'][] = $include_file;
565
      }
566

567 568 569 570
      // If the default keys are not set, use the default values registered
      // by the module.
      if (isset($cache[$hook])) {
        $result[$hook] += array_intersect_key($cache[$hook], $hook_defaults);
571
      }
572 573 574 575 576 577

      // The following apply only to theming hooks implemented as templates.
      if (isset($info['template'])) {
        // Prepend the current theming path when none is set.
        if (!isset($info['path'])) {
          $result[$hook]['template'] = $path . '/' . $info['template'];
578
        }
579
      }
580

581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602
      // Allow variable processors for all theming hooks, whether the hook is
      // implemented as a template or as a function.
      foreach ($variable_process_phases as $phase_key => $phase) {
        // Check for existing variable processors. Ensure arrayness.
        if (!isset($info[$phase_key]) || !is_array($info[$phase_key])) {
          $info[$phase_key] = array();
          $prefixes = array();
          if ($type == 'module') {
            // Default variable processor prefix.
            $prefixes[] = 'template';
            // Add all modules so they can intervene with their own variable
            // processors. This allows them to provide variable processors even
            // if they are not the owner of the current hook.
            $prefixes += module_list();
          }
          elseif ($type == 'theme_engine' || $type == 'base_theme_engine') {
            // Theme engines get an extra set that come before the normally
            // named variable processors.
            $prefixes[] = $name . '_engine';
            // The theme engine registers on behalf of the theme using the
            // theme's name.
            $prefixes[] = $theme;
603
          }
604 605 606 607
          else {
            // This applies when the theme manually registers their own variable
            // processors.
            $prefixes[] = $name;
608
          }
609 610
          foreach ($prefixes as $prefix) {
            // Only use non-hook-specific variable processors for theming hooks
611
            // implemented as templates. See theme().
612 613 614 615 616 617
            if (isset($info['template']) && function_exists($prefix . '_' . $phase)) {
              $info[$phase_key][] = $prefix . '_' . $phase;
            }
            if (function_exists($prefix . '_' . $phase . '_' . $hook)) {
              $info[$phase_key][] = $prefix . '_' . $phase . '_' . $hook;
            }
618
          }
619
        }
620 621 622 623 624 625 626 627 628 629 630
        // Check for the override flag and prevent the cached variable
        // processors from being used. This allows themes or theme engines to
        // remove variable processors set earlier in the registry build.
        if (!empty($info['override ' . $phase_key])) {
          // Flag not needed inside the registry.
          unset($result[$hook]['override ' . $phase_key]);
        }
        elseif (isset($cache[$hook][$phase_key]) && is_array($cache[$hook][$phase_key])) {
          $info[$phase_key] = array_merge($cache[$hook][$phase_key], $info[$phase_key]);
        }
        $result[$hook][$phase_key] = $info[$phase_key];
631
      }
632 633
    }

634
    // Merge the newly created theme hooks into the existing cache.
635
    $cache = $result + $cache;
636
  }
637

638
  // Let themes have variable processors even if they didn't register a template.
639 640
  if ($type == 'theme' || $type == 'base_theme') {
    foreach ($cache as $hook => $info) {
641 642 643
      // Check only if not registered by the theme or engine.
      if (empty($result[$hook])) {
        foreach ($variable_process_phases as $phase_key => $phase) {
644 645 646
          if (!isset($info[$phase_key])) {
            $cache[$hook][$phase_key] = array();
          }
647
          // Only use non-hook-specific variable processors for theming hooks
648
          // implemented as templates. See theme().
649 650
          if (isset($info['template']) && function_exists($name . '_' . $phase)) {
            $cache[$hook][$phase_key][] = $name . '_' . $phase;
651
          }
652 653
          if (function_exists($name . '_' . $phase . '_' . $hook)) {
            $cache[$hook][$phase_key][] = $name . '_' . $phase . '_' . $hook;
654
            $cache[$hook]['theme path'] = $path;
655 656 657
          }
          // Ensure uniqueness.
          $cache[$hook][$phase_key] = array_unique($cache[$hook][$phase_key]);
658 659 660 661
        }
      }
    }
  }
662 663 664
}

/**
665
 * Build the theme registry cache.
666 667
 *
 * @param $theme
668
 *   The loaded $theme object as returned by list_themes().
669 670 671
 * @param $base_theme
 *   An array of loaded $theme objects representing the ancestor themes in
 *   oldest first order.
672
 * @param $theme_engine
673
 *   The name of the theme engine.
674
 */
675
function _theme_build_registry($theme, $base_theme, $theme_engine) {
676
  $cache = array();
677
  // First, process the theme hooks advertised by modules. This will
678 679 680
  // serve as the basic registry. Since the list of enabled modules is the same
  // regardless of the theme used, this is cached in its own entry to save
  // building it for every theme.
681
  if ($cached = cache()->get('theme_registry:build:modules')) {
682 683 684 685 686 687 688 689
    $cache = $cached->data;
  }
  else {
    foreach (module_implements('theme') as $module) {
      _theme_process_registry($cache, $module, 'module', $module, drupal_get_path('module', $module));
    }
    // Only cache this registry if all modules are loaded.
    if (module_load_all(NULL)) {
690
      cache()->set('theme_registry:build:modules', $cache);
691
    }
692 693 694 695
  }

  // Process each base theme.
  foreach ($base_theme as $base) {
696
    // If the base theme uses a theme engine, process its hooks.
697 698 699 700 701
    $base_path = dirname($base->filename);
    if ($theme_engine) {
      _theme_process_registry($cache, $theme_engine, 'base_theme_engine', $base->name, $base_path);
    }
    _theme_process_registry($cache, $base->name, 'base_theme', $base->name, $base_path);
702 703
  }

704
  // And then the same thing, but for the theme.
705
  if ($theme_engine) {
706
    _theme_process_registry($cache, $theme_engine, 'theme_engine', $theme->name, dirname($theme->filename));
707 708
  }

709 710
  // Finally, hooks provided by the theme itself.
  _theme_process_registry($cache, $theme->name, 'theme', $theme->name, dirname($theme->filename));
711

712
  // Let modules alter the registry.
713
  drupal_alter('theme_registry', $cache);
714 715 716 717 718 719 720 721 722

  // Optimize the registry to not have empty arrays for functions.
  foreach ($cache as $hook => $info) {
    foreach (array('preprocess functions', 'process functions') as $phase) {
      if (empty($info[$phase])) {
        unset($cache[$hook][$phase]);
      }
    }
  }
723 724 725
  return $cache;
}

Dries's avatar
 
Dries committed
726
/**
727
 * Return a list of all currently available themes.
Dries's avatar
 
Dries committed
728
 *
729 730
 * Retrieved from the database, if available and the site is not in maintenance
 * mode; otherwise compiled freshly from the filesystem.
731
 *
Dries's avatar
 
Dries committed
732
 * @param $refresh
733
 *   Whether to reload the list of themes from the database. Defaults to FALSE.
734
 *
735
 * @return
736 737 738 739
 *   An associative array of the currently available themes. The keys are the
 *   names of the themes and the values are objects having the following
 *   properties:
 *   - 'filename': The name of the .info file.
740
 *   - 'name': The machine name of the theme.
741 742 743 744 745
 *   - 'status': 1 for enabled, 0 for disabled themes.
 *   - 'info': The contents of the .info file.
 *   - 'stylesheets': A two dimensional array, using the first key for the
 *     'media' attribute (e.g. 'all'), the second for the name of the file
 *     (e.g. style.css). The value is a complete filepath
746
 *     (e.g. themes/bartik/style.css).
747 748 749
 *   - 'scripts': An associative array of JavaScripts, using the filename as key
 *     and the complete filepath as value.
 *   - 'engine': The name of the theme engine.
750 751 752 753
 *   - 'base_theme': The name of the base theme.
 *   - 'base_themes': An ordered array of all the base themes. If the first item
 *     is NULL, a base theme is missing for this theme.
 *   - 'sub_themes': An unordered array of sub-themes of this theme.
Dries's avatar
 
Dries committed
754
 */
755
function list_themes($refresh = FALSE) {
756
  $list = &drupal_static(__FUNCTION__, array());
Dries's avatar
 
Dries committed
757 758

  if ($refresh) {
759
    $list = array();
760
    system_list_reset();
Dries's avatar
 
Dries committed
761 762
  }

763
  if (empty($list)) {
Dries's avatar
 
Dries committed
764
    $list = array();
765 766
    $themes = array();
    // Extract from the database only when it is available.
767
    // Also check that the site is not in the middle of an install or update.
768 769
    if (!defined('MAINTENANCE_MODE')) {
      try {
770
        $themes = system_list('theme');
771
      }
772 773 774 775
      catch (Exception $e) {
        // If the database is not available, rebuild the theme data.
        $themes = _system_rebuild_theme_data();
      }
776 777
    }
    else {
778
      // Scan the installation when the database should not be read.
779
      $themes = _system_rebuild_theme_data();
780 781 782 783 784
    }

    foreach ($themes as $theme) {
      foreach ($theme->info['stylesheets'] as $media => $stylesheets) {
        foreach ($stylesheets as $stylesheet => $path) {
785
          $theme->stylesheets[$media][$stylesheet] = $path;
786
        }
787 788
      }
      foreach ($theme->info['scripts'] as $script => $path) {
789
        $theme->scripts[$script] = $path;
Dries's avatar
 
Dries committed
790
      }
791 792
      if (isset($theme->info['engine'])) {
        $theme->engine = $theme->info['engine'];
Dries's avatar
 
Dries committed
793
      }
794 795 796
      if (isset($theme->info['base theme'])) {
        $theme->base_theme = $theme->info['base theme'];
      }
797 798 799 800 801
      // 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;
      }
802
      $list[$theme->name] = $theme;
Dries's avatar
 
Dries committed
803 804 805 806 807 808
    }
  }

  return $list;
}

809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849
/**
 * Find all the base themes for the specified theme.
 *
 * Themes can inherit templates and function implementations from earlier themes.
 *
 * @param $themes
 *   An array of available themes.
 * @param $key
 *   The name of the theme whose base we are looking for.
 * @param $used_keys
 *   A recursion parameter preventing endless loops.
 * @return
 *   Returns an array of all of the theme's ancestors; the first element's value
 *   will be NULL if an error occurred.
 */
function drupal_find_base_themes($themes, $key, $used_keys = array()) {
  $base_key = $themes[$key]->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_keys[$base_key])) {
      return array($base_key => NULL);
    }
    $used_keys[$base_key] = TRUE;
    return drupal_find_base_themes($themes, $base_key, $used_keys) + $current_base_theme;
  }
  // If we get here, then this is our parent theme.
  return $current_base_theme;
}

Dries's avatar
 
Dries committed
850
/**
851 852 853
 * Generates themed output.
 *
 * All requests for themed output must go through this function. It examines
854 855 856
 * the request and routes it to the appropriate
 * @link themeable theme function or template @endlink, by checking the theme
 * registry.
857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910
 *
 * The first argument to this function is the name of the theme hook. For
 * instance, to theme a table, the theme hook name is 'table'. By default, this
 * theme hook could be implemented by a function called 'theme_table' or a
 * template file called 'table.tpl.php', but hook_theme() can override the
 * default function or template name.
 *
 * If the implementation is a template file, several functions are called
 * before the template file is invoked, to modify the $variables array. These
 * fall into the "preprocessing" phase and the "processing" phase, and are
 * executed (if they exist), in the following order (note that in the following
 * list, HOOK indicates the theme hook name, MODULE indicates a module name,
 * THEME indicates a theme name, and ENGINE indicates a theme engine name):
 * - template_preprocess(&$variables, $hook): Creates a default set of variables
 *   for all theme hooks.
 * - template_preprocess_HOOK(&$variables): Should be implemented by
 *   the module that registers the theme hook, to set up default variables.
 * - MODULE_preprocess(&$variables, $hook): hook_preprocess() is invoked on all
 *   implementing modules.
 * - MODULE_preprocess_HOOK(&$variables): hook_preprocess_HOOK() is invoked on
 *   all implementing modules, so that modules that didn't define the theme hook
 *   can alter the variables.
 * - ENGINE_engine_preprocess(&$variables, $hook): Allows the theme engine to
 *   set necessary variables for all theme hooks.
 * - ENGINE_engine_preprocess_HOOK(&$variables): Allows the theme engine to set
 *   necessary variables for the particular theme hook.
 * - THEME_preprocess(&$variables, $hook): Allows the theme to set necessary
 *   variables for all theme hooks.
 * - THEME_preprocess_HOOK(&$variables): Allows the theme to set necessary
 *   variables specific to the particular theme hook.
 * - template_process(&$variables, $hook): Creates a default set of variables
 *   for all theme hooks.
 * - template_process_HOOK(&$variables): This is the first processor specific
 *   to the theme hook; it should be implemented by the module that registers
 *   it.
 * - MODULE_process(&$variables, $hook): hook_process() is invoked on all
 *   implementing modules.
 * - MODULE_process_HOOK(&$variables): hook_process_HOOK() is invoked on
 *   on all implementing modules, so that modules that didn't define the theme
 *   hook can alter the variables.
 * - ENGINE_engine_process(&$variables, $hook): Allows the theme engine to set
 *   necessary variables for all theme hooks.
 * - ENGINE_engine_process_HOOK(&$variables): Allows the theme engine to set
 *   necessary variables for the particular theme hook.
 * - ENGINE_process(&$variables, $hook): Allows the theme engine to process the
 *   variables.
 * - ENGINE_process_HOOK(&$variables): Allows the theme engine to process the
 *   variables specific to the theme hook.
 * - THEME_process(&$variables, $hook):  Allows the theme to process the
 *   variables.
 * - THEME_process_HOOK(&$variables):  Allows the theme to process the
 *   variables specific to the theme hook.
 *
 * If the implementation is a function, only the theme-hook-specific preprocess
911
 * and process functions (the ones ending in _HOOK) are called from the
912 913 914
 * list above. This is because theme hooks with function implementations
 * need to be fast, and calling the non-theme-hook-specific preprocess and
 * process functions for them would incur a noticeable performance penalty.
915
 *
916
 * There are two special variables that these preprocess and process functions
917 918 919 920 921 922 923 924 925 926
 * can set: 'theme_hook_suggestion' and 'theme_hook_suggestions'. These will be
 * merged together to form a list of 'suggested' alternate theme hooks to use,
 * in reverse order of priority. theme_hook_suggestion will always be a higher
 * priority than items in theme_hook_suggestions. theme() will use the
 * highest priority implementation that exists. If none exists, theme() will
 * use the implementation for the theme hook it was called with. These
 * suggestions are similar to and are used for similar reasons as calling
 * theme() with an array as the $hook parameter (see below). The difference
 * is whether the suggestions are determined by the code that calls theme() or
 * by a preprocess or process function.
927
 *
928
 * @param $hook
929 930 931 932
 *   The name of the theme hook to call. If the name contains a
 *   double-underscore ('__') and there isn't an implementation for the full
 *   name, the part before the '__' is checked. This allows a fallback to a more
 *   generic implementation. For example, if theme('links__node', ...) is
933
 *   called, but there is no implementation of that theme hook, then the 'links'
934 935 936 937 938 939 940 941
 *   implementation is used. This process is iterative, so if
 *   theme('links__contextual__node', ...) is called, theme() checks for the
 *   following implementations, and uses the first one that exists:
 *   - links__contextual__node
 *   - links__contextual
 *   - links
 *   This allows themes to create specific theme implementations for named
 *   objects and contexts of otherwise generic theme hooks. The $hook parameter
942
 *   may also be an array, in which case the first theme hook that has an
943 944
 *   implementation is used. This allows for the code that calls theme() to
 *   explicitly specify the fallback order in a situation where using the '__'
945
 *   convention is not desired or is insufficient.
946 947 948 949
 * @param $variables
 *   An associative array of variables to merge with defaults from the theme
 *   registry, pass to preprocess and process functions for modification, and
 *   finally, pass to the function or template implementing the theme hook.
950 951 952
 *   Alternatively, this can be a renderable array, in which case, its
 *   properties are mapped to variables expected by the theme hook
 *   implementations.
953
 *
954
 * @return
955
 *   An HTML string representing the themed output.
956 957
 *
 * @see themeable
Dries's avatar
 
Dries committed
958
 */
959
function theme($hook, $variables = array()) {
960 961 962 963 964 965 966
  // If called before all modules are loaded, we do not necessarily have a full
  // theme registry to work with, and therefore cannot process the theme
  // request properly. See also _theme_load_registry().
  if (!module_load_all(NULL) && !defined('MAINTENANCE_MODE')) {
    throw new Exception(t('theme() may not be called until all modules are loaded.'));
  }

967
  $hooks = theme_get_registry(FALSE);
968

969 970
  // If an array of hook candidates were passed, use the first one that has an
  // implementation.
971 972 973 974 975 976 977 978 979
  if (is_array($hook)) {
    foreach ($hook as $candidate) {
      if (isset($hooks[$candidate])) {
        break;
      }
    }
    $hook = $candidate;
  }

980 981
  // If there's no implementation, check for more generic fallbacks. If there's
  // still no implementation, log an error and return an empty string.
982
  if (!isset($hooks[$hook])) {
983 984 985 986 987 988 989 990 991
    // Iteratively strip everything after the last '__' delimiter, until an
    // implementation is found.
    while ($pos = strrpos($hook, '__')) {
      $hook = substr($hook, 0, $pos);
      if (isset($hooks[$hook])) {
        break;
      }
    }
    if (!isset($hooks[$hook])) {
992 993 994
      // Only log a message when not trying theme suggestions ($hook being an
      // array).
      if (!isset($candidate)) {
995
        watchdog('theme', 'Theme key "@key" not found.', array('@key' => $hook), WATCHDOG_WARNING);
996
      }
997 998
      return '';
    }
999 1000
  }

1001
  $info = $hooks[$hook];
1002 1003 1004
  global $theme_path;
  $temp = $theme_path;
  // point path_to_theme() to the currently used theme path:
1005
  $theme_path = $info['theme path'];
Dries's avatar
 
Dries committed
1006

1007
  // Include a file if the theme function or variable processor is held elsewhere.
1008 1009 1010
  if (!empty($info['includes'])) {
    foreach ($info['includes'] as $include_file) {
      include_once DRUPAL_ROOT . '/' . $include_file;
1011 1012
    }
  }
1013 1014

  // If a renderable array is passed as $variables, then set $variables to
1015
  // the arguments expected by the theme function.
1016 1017 1018
  if (isset($variables['#theme']) || isset($variables['#theme_wrappers'])) {
    $element = $variables;
    $variables = array();
1019 1020
    if (isset($info['variables'])) {
      foreach (array_keys($info['variables']) as $name) {