PageRenderTime 10ms CodeModel.GetById 4ms app.highlight 163ms RepoModel.GetById 2ms app.codeStats 0ms

/includes/theme.inc

https://bitbucket.org/antisocnet/drupal
Pascal | 2905 lines | 1614 code | 142 blank | 1149 comment | 245 complexity | fa82d6b59f8fb0e685a89e3d3cfd3e3a MD5 | raw file
   1<?php
   2
   3/**
   4 * @file
   5 * The theme system, which controls the output of Drupal.
   6 *
   7 * The theme system allows for nearly all output of the Drupal system to be
   8 * customized by user themes.
   9 */
  10
  11/**
  12 * @defgroup content_flags Content markers
  13 * @{
  14 * Markers used by theme_mark() and node_mark() to designate content.
  15 * @see theme_mark(), node_mark()
  16 */
  17
  18/**
  19 * Mark content as read.
  20 */
  21define('MARK_READ', 0);
  22
  23/**
  24 * Mark content as being new.
  25 */
  26define('MARK_NEW', 1);
  27
  28/**
  29 * Mark content as being updated.
  30 */
  31define('MARK_UPDATED', 2);
  32
  33/**
  34 * @} End of "Content markers".
  35 */
  36
  37/**
  38 * Determines if a theme is available to use.
  39 *
  40 * @param $theme
  41 *   Either the name of a theme or a full theme object.
  42 *
  43 * @return
  44 *   Boolean TRUE if the theme is enabled or is the site administration theme;
  45 *   FALSE otherwise.
  46 */
  47function drupal_theme_access($theme) {
  48  if (is_object($theme)) {
  49    return _drupal_theme_access($theme);
  50  }
  51  else {
  52    $themes = list_themes();
  53    return isset($themes[$theme]) && _drupal_theme_access($themes[$theme]);
  54  }
  55}
  56
  57/**
  58 * Helper function for determining access to a theme.
  59 *
  60 * @see drupal_theme_access()
  61 */
  62function _drupal_theme_access($theme) {
  63  $admin_theme = variable_get('admin_theme');
  64  return !empty($theme->status) || ($admin_theme && $theme->name == $admin_theme);
  65}
  66
  67/**
  68 * Initializes the theme system by loading the theme.
  69 */
  70function drupal_theme_initialize() {
  71  global $theme, $user, $theme_key;
  72
  73  // If $theme is already set, assume the others are set, too, and do nothing
  74  if (isset($theme)) {
  75    return;
  76  }
  77
  78  drupal_bootstrap(DRUPAL_BOOTSTRAP_DATABASE);
  79  $themes = list_themes();
  80
  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', 'bartik');
  84
  85  // Allow modules to override the theme. Validation has already been performed
  86  // 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;
  89
  90  // Store the identifier for retrieving theme settings with.
  91  $theme_key = $theme;
  92
  93  // Find all our ancestor themes and put them in an array.
  94  $base_theme = array();
  95  $ancestor = $theme;
  96  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  // Themes can have alter functions, so reset the drupal_alter() cache.
 103  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  // @see ajax_base_page_theme()
 108  $setting['ajaxPageState'] = array(
 109    'theme' => $theme_key,
 110    'theme_token' => drupal_get_token($theme_key),
 111  );
 112  drupal_add_js($setting, 'setting');
 113}
 114
 115/**
 116 * Initializes the theme system given already loaded information.
 117 *
 118 * This function is useful to initialize a theme when no database is present.
 119 *
 120 * @param $theme
 121 *   An object with the following information:
 122 *     filename
 123 *       The .info file for this theme. The 'path' to
 124 *       the theme will be in this file's directory. (Required)
 125 *     owner
 126 *       The path to the .theme file or the .engine file to load for
 127 *       the theme. (Required)
 128 *     stylesheet
 129 *       The primary stylesheet for the theme. (Optional)
 130 *     engine
 131 *       The name of theme engine to use. (Optional)
 132 * @param $base_theme
 133 *    An optional array of objects that represent the 'base theme' if the
 134 *    theme is meant to be derivative of another theme. It requires
 135 *    the same information as the $theme object. It should be in
 136 *    'oldest first' order, meaning the top level of the chain will
 137 *    be first.
 138 * @param $registry_callback
 139 *   The callback to invoke to set the theme registry.
 140 */
 141function _drupal_theme_initialize($theme, $base_theme = array(), $registry_callback = '_theme_load_registry') {
 142  global $theme_info, $base_theme_info, $theme_engine, $theme_path;
 143  $theme_info = $theme;
 144  $base_theme_info = $base_theme;
 145
 146  $theme_path = dirname($theme->filename);
 147
 148  // Prepare stylesheets from this theme as well as all ancestor themes.
 149  // We work it this way so that we can have child themes override parent
 150  // theme stylesheets easily.
 151  $final_stylesheets = array();
 152
 153  // Grab stylesheets from base theme
 154  foreach ($base_theme as $base) {
 155    if (!empty($base->stylesheets)) {
 156      foreach ($base->stylesheets as $media => $stylesheets) {
 157        foreach ($stylesheets as $name => $stylesheet) {
 158          $final_stylesheets[$media][$name] = $stylesheet;
 159        }
 160      }
 161    }
 162  }
 163
 164  // Add stylesheets used by this theme.
 165  if (!empty($theme->stylesheets)) {
 166    foreach ($theme->stylesheets as $media => $stylesheets) {
 167      foreach ($stylesheets as $name => $stylesheet) {
 168        $final_stylesheets[$media][$name] = $stylesheet;
 169      }
 170    }
 171  }
 172
 173  // And now add the stylesheets properly
 174  foreach ($final_stylesheets as $media => $stylesheets) {
 175    foreach ($stylesheets as $stylesheet) {
 176      drupal_add_css($stylesheet, array('group' => CSS_THEME, 'every_page' => TRUE, 'media' => $media));
 177    }
 178  }
 179
 180  // Do basically the same as the above for scripts
 181  $final_scripts = array();
 182
 183  // Grab scripts from base theme
 184  foreach ($base_theme as $base) {
 185    if (!empty($base->scripts)) {
 186      foreach ($base->scripts as $name => $script) {
 187        $final_scripts[$name] = $script;
 188      }
 189    }
 190  }
 191
 192  // Add scripts used by this theme.
 193  if (!empty($theme->scripts)) {
 194    foreach ($theme->scripts as $name => $script) {
 195      $final_scripts[$name] = $script;
 196    }
 197  }
 198
 199  // Add scripts used by this theme.
 200  foreach ($final_scripts as $script) {
 201    drupal_add_js($script, array('group' => JS_THEME, 'every_page' => TRUE));
 202  }
 203
 204  $theme_engine = NULL;
 205
 206  // Initialize the theme.
 207  if (isset($theme->engine)) {
 208    // Include the engine.
 209    include_once DRUPAL_ROOT . '/' . $theme->owner;
 210
 211    $theme_engine = $theme->engine;
 212    if (function_exists($theme_engine . '_init')) {
 213      foreach ($base_theme as $base) {
 214        call_user_func($theme_engine . '_init', $base);
 215      }
 216      call_user_func($theme_engine . '_init', $theme);
 217    }
 218  }
 219  else {
 220    // include non-engine theme files
 221    foreach ($base_theme as $base) {
 222      // Include the theme file or the engine.
 223      if (!empty($base->owner)) {
 224        include_once DRUPAL_ROOT . '/' . $base->owner;
 225      }
 226    }
 227    // and our theme gets one too.
 228    if (!empty($theme->owner)) {
 229      include_once DRUPAL_ROOT . '/' . $theme->owner;
 230    }
 231  }
 232
 233  if (isset($registry_callback)) {
 234    _theme_registry_callback($registry_callback, array($theme, $base_theme, $theme_engine));
 235  }
 236}
 237
 238/**
 239 * Gets the theme registry.
 240 *
 241 * @param $complete
 242 *   Optional boolean to indicate whether to return the complete theme registry
 243 *   array or an instance of the ThemeRegistry class. If TRUE, the complete
 244 *   theme registry array will be returned. This is useful if you want to
 245 *   foreach over the whole registry, use array_* functions or inspect it in a
 246 *   debugger. If FALSE, an instance of the ThemeRegistry class will be
 247 *   returned, this provides an ArrayObject which allows it to be accessed
 248 *   with array syntax and  isset(), and should be more lightweight
 249 *   than the full registry. Defaults to TRUE.
 250 *
 251 * @return
 252 *   The complete theme registry array, or an instance of the ThemeRegistry
 253 *   class.
 254 */
 255function theme_get_registry($complete = TRUE) {
 256  // Use the advanced drupal_static() pattern, since this is called very often.
 257  static $drupal_static_fast;
 258  if (!isset($drupal_static_fast)) {
 259    $drupal_static_fast['registry'] = &drupal_static('theme_get_registry');
 260  }
 261  $theme_registry = &$drupal_static_fast['registry'];
 262
 263  // Initialize the theme, if this is called early in the bootstrap, or after
 264  // static variables have been reset.
 265  if (!is_array($theme_registry)) {
 266    drupal_theme_initialize();
 267    $theme_registry = array();
 268  }
 269
 270  $key = (int) $complete;
 271
 272  if (!isset($theme_registry[$key])) {
 273    list($callback, $arguments) = _theme_registry_callback();
 274    if (!$complete) {
 275      $arguments[] = FALSE;
 276    }
 277    $theme_registry[$key] = call_user_func_array($callback, $arguments);
 278  }
 279
 280  return $theme_registry[$key];
 281}
 282
 283/**
 284 * Sets the callback that will be used by theme_get_registry().
 285 *
 286 * @param $callback
 287 *   The name of the callback function.
 288 * @param $arguments
 289 *   The arguments to pass to the function.
 290 */
 291function _theme_registry_callback($callback = NULL, array $arguments = array()) {
 292  static $stored;
 293  if (isset($callback)) {
 294    $stored = array($callback, $arguments);
 295  }
 296  return $stored;
 297}
 298
 299/**
 300 * Gets the theme_registry cache; if it doesn't exist, builds it.
 301 *
 302 * @param $theme
 303 *   The loaded $theme object as returned by list_themes().
 304 * @param $base_theme
 305 *   An array of loaded $theme objects representing the ancestor themes in
 306 *   oldest first order.
 307 * @param $theme_engine
 308 *   The name of the theme engine.
 309 * @param $complete
 310 *   Whether to load the complete theme registry or an instance of the
 311 *   ThemeRegistry class.
 312 *
 313 * @return
 314 *   The theme registry array, or an instance of the ThemeRegistry class.
 315 */
 316function _theme_load_registry($theme, $base_theme = NULL, $theme_engine = NULL, $complete = TRUE) {
 317  if ($complete) {
 318    // Check the theme registry cache; if it exists, use it.
 319    $cached = cache_get("theme_registry:$theme->name");
 320    if (isset($cached->data)) {
 321      $registry = $cached->data;
 322    }
 323    else {
 324      // If not, build one and cache it.
 325      $registry = _theme_build_registry($theme, $base_theme, $theme_engine);
 326      // Only persist this registry if all modules are loaded. This assures a
 327      // complete set of theme hooks.
 328      if (module_load_all(NULL)) {
 329        _theme_save_registry($theme, $registry);
 330      }
 331    }
 332    return $registry;
 333  }
 334  else {
 335    return new ThemeRegistry('theme_registry:runtime:' . $theme->name, 'cache');
 336  }
 337}
 338
 339/**
 340 * Writes the theme_registry cache into the database.
 341 */
 342function _theme_save_registry($theme, $registry) {
 343  cache_set("theme_registry:$theme->name", $registry);
 344}
 345
 346/**
 347 * Forces the system to rebuild the theme registry.
 348 *
 349 * This function should be called when modules are added to the system, or when
 350 * a dynamic system needs to add more theme hooks.
 351 */
 352function drupal_theme_rebuild() {
 353  drupal_static_reset('theme_get_registry');
 354  cache_clear_all('theme_registry', 'cache', TRUE);
 355}
 356
 357/**
 358 * Builds the run-time theme registry.
 359 *
 360 * Extends DrupalCacheArray to allow the theme registry to be accessed as a
 361 * complete registry, while internally caching only the parts of the registry
 362 * that are actually in use on the site. On cache misses the complete
 363 * theme registry is loaded and used to update the run-time cache.
 364 */
 365class ThemeRegistry Extends DrupalCacheArray {
 366
 367  /**
 368   * Whether the partial registry can be persisted to the cache.
 369   *
 370   * This is only allowed if all modules and the request method is GET. theme()
 371   * should be very rarely called on POST requests and this avoids polluting
 372   * the runtime cache.
 373   */
 374  protected $persistable;
 375
 376  /**
 377   * The complete theme registry array.
 378   */
 379  protected $completeRegistry;
 380
 381  function __construct($cid, $bin) {
 382    $this->cid = $cid;
 383    $this->bin = $bin;
 384    $this->persistable = module_load_all(NULL) && $_SERVER['REQUEST_METHOD'] == 'GET';
 385
 386    $data = array();
 387    if ($this->persistable && $cached = cache_get($this->cid, $this->bin)) {
 388      $data = $cached->data;
 389    }
 390    else {
 391      // If there is no runtime cache stored, fetch the full theme registry,
 392      // but then initialize each value to NULL. This allows offsetExists()
 393      // to function correctly on non-registered theme hooks without triggering
 394      // a call to resolveCacheMiss().
 395      $data = $this->initializeRegistry();
 396      if ($this->persistable) {
 397        $this->set($data);
 398      }
 399    }
 400    $this->storage = $data;
 401  }
 402
 403  /**
 404   * Initializes the full theme registry.
 405   *
 406   * @return
 407   *   An array with the keys of the full theme registry, but the values
 408   *   initialized to NULL.
 409   */
 410  function initializeRegistry() {
 411    $this->completeRegistry = theme_get_registry();
 412
 413    return array_fill_keys(array_keys($this->completeRegistry), NULL);
 414  }
 415
 416  public function offsetExists($offset) {
 417    // Since the theme registry allows for theme hooks to be requested that
 418    // are not registered, just check the existence of the key in the registry.
 419    // Use array_key_exists() here since a NULL value indicates that the theme
 420    // hook exists but has not yet been requested.
 421    return array_key_exists($offset, $this->storage);
 422  }
 423
 424  public function offsetGet($offset) {
 425    // If the offset is set but empty, it is a registered theme hook that has
 426    // not yet been requested. Offsets that do not exist at all were not
 427    // registered in hook_theme().
 428    if (isset($this->storage[$offset])) {
 429      return $this->storage[$offset];
 430    }
 431    elseif (array_key_exists($offset, $this->storage)) {
 432      return $this->resolveCacheMiss($offset);
 433    }
 434  }
 435
 436  public function resolveCacheMiss($offset) {
 437    if (!isset($this->completeRegistry)) {
 438      $this->completeRegistry = theme_get_registry();
 439    }
 440    $this->storage[$offset] = $this->completeRegistry[$offset];
 441    if ($this->persistable) {
 442      $this->persist($offset);
 443    }
 444    return $this->storage[$offset];
 445  }
 446
 447  public function set($data, $lock = TRUE) {
 448    $lock_name = $this->cid . ':' . $this->bin;
 449    if (!$lock || lock_acquire($lock_name)) {
 450      if ($cached = cache_get($this->cid, $this->bin)) {
 451        // Use array merge instead of union so that filled in values in $data
 452        // overwrite empty values in the current cache.
 453        $data = array_merge($cached->data, $data);
 454      }
 455      else {
 456        $registry = $this->initializeRegistry();
 457        $data = array_merge($registry, $data);
 458      }
 459      cache_set($this->cid, $data, $this->bin);
 460      if ($lock) {
 461        lock_release($lock_name);
 462      }
 463    }
 464  }
 465}
 466
 467/**
 468 * Process a single implementation of hook_theme().
 469 *
 470 * @param $cache
 471 *   The theme registry that will eventually be cached; It is an associative
 472 *   array keyed by theme hooks, whose values are associative arrays describing
 473 *   the hook:
 474 *   - 'type': The passed-in $type.
 475 *   - 'theme path': The passed-in $path.
 476 *   - 'function': The name of the function generating output for this theme
 477 *     hook. Either defined explicitly in hook_theme() or, if neither 'function'
 478 *     nor 'template' is defined, then the default theme function name is used.
 479 *     The default theme function name is the theme hook prefixed by either
 480 *     'theme_' for modules or '$name_' for everything else. If 'function' is
 481 *     defined, 'template' is not used.
 482 *   - 'template': The filename of the template generating output for this
 483 *     theme hook. The template is in the directory defined by the 'path' key of
 484 *     hook_theme() or defaults to $path.
 485 *   - 'variables': The variables for this theme hook as defined in
 486 *     hook_theme(). If there is more than one implementation and 'variables' is
 487 *     not specified in a later one, then the previous definition is kept.
 488 *   - 'render element': The renderable element for this theme hook as defined
 489 *     in hook_theme(). If there is more than one implementation and
 490 *     'render element' is not specified in a later one, then the previous
 491 *     definition is kept.
 492 *   - 'preprocess functions': See theme() for detailed documentation.
 493 *   - 'process functions': See theme() for detailed documentation.
 494 * @param $name
 495 *   The name of the module, theme engine, base theme engine, theme or base
 496 *   theme implementing hook_theme().
 497 * @param $type
 498 *   One of 'module', 'theme_engine', 'base_theme_engine', 'theme', or
 499 *   'base_theme'. Unlike regular hooks that can only be implemented by modules,
 500 *   each of these can implement hook_theme(). _theme_process_registry() is
 501 *   called in aforementioned order and new entries override older ones. For
 502 *   example, if a theme hook is both defined by a module and a theme, then the
 503 *   definition in the theme will be used.
 504 * @param $theme
 505 *   The loaded $theme object as returned from list_themes().
 506 * @param $path
 507 *   The directory where $name is. For example, modules/system or
 508 *   themes/bartik.
 509 *
 510 * @see theme()
 511 * @see _theme_process_registry()
 512 * @see hook_theme()
 513 * @see list_themes()
 514 */
 515function _theme_process_registry(&$cache, $name, $type, $theme, $path) {
 516  $result = array();
 517
 518  // Processor functions work in two distinct phases with the process
 519  // functions always being executed after the preprocess functions.
 520  $variable_process_phases = array(
 521    'preprocess functions' => 'preprocess',
 522    'process functions'    => 'process',
 523  );
 524
 525  $hook_defaults = array(
 526    'variables' => TRUE,
 527    'render element' => TRUE,
 528    'pattern' => TRUE,
 529    'base hook' => TRUE,
 530  );
 531
 532  // Invoke the hook_theme() implementation, process what is returned, and
 533  // merge it into $cache.
 534  $function = $name . '_theme';
 535  if (function_exists($function)) {
 536    $result = $function($cache, $type, $theme, $path);
 537    foreach ($result as $hook => $info) {
 538      // When a theme or engine overrides a module's theme function
 539      // $result[$hook] will only contain key/value pairs for information being
 540      // overridden.  Pull the rest of the information from what was defined by
 541      // an earlier hook.
 542
 543      // Fill in the type and path of the module, theme, or engine that
 544      // implements this theme function.
 545      $result[$hook]['type'] = $type;
 546      $result[$hook]['theme path'] = $path;
 547
 548      // If function and file are omitted, default to standard naming
 549      // conventions.
 550      if (!isset($info['template']) && !isset($info['function'])) {
 551        $result[$hook]['function'] = ($type == 'module' ? 'theme_' : $name . '_') . $hook;
 552      }
 553
 554      if (isset($cache[$hook]['includes'])) {
 555        $result[$hook]['includes'] = $cache[$hook]['includes'];
 556      }
 557
 558      // If the theme implementation defines a file, then also use the path
 559      // that it defined. Otherwise use the default path. This allows
 560      // system.module to declare theme functions on behalf of core .include
 561      // files.
 562      if (isset($info['file'])) {
 563        $include_file = isset($info['path']) ? $info['path'] : $path;
 564        $include_file .= '/' . $info['file'];
 565        include_once DRUPAL_ROOT . '/' . $include_file;
 566        $result[$hook]['includes'][] = $include_file;
 567      }
 568
 569      // If the default keys are not set, use the default values registered
 570      // by the module.
 571      if (isset($cache[$hook])) {
 572        $result[$hook] += array_intersect_key($cache[$hook], $hook_defaults);
 573      }
 574
 575      // The following apply only to theming hooks implemented as templates.
 576      if (isset($info['template'])) {
 577        // Prepend the current theming path when none is set.
 578        if (!isset($info['path'])) {
 579          $result[$hook]['template'] = $path . '/' . $info['template'];
 580        }
 581      }
 582
 583      // Allow variable processors for all theming hooks, whether the hook is
 584      // implemented as a template or as a function.
 585      foreach ($variable_process_phases as $phase_key => $phase) {
 586        // Check for existing variable processors. Ensure arrayness.
 587        if (!isset($info[$phase_key]) || !is_array($info[$phase_key])) {
 588          $info[$phase_key] = array();
 589          $prefixes = array();
 590          if ($type == 'module') {
 591            // Default variable processor prefix.
 592            $prefixes[] = 'template';
 593            // Add all modules so they can intervene with their own variable
 594            // processors. This allows them to provide variable processors even
 595            // if they are not the owner of the current hook.
 596            $prefixes += module_list();
 597          }
 598          elseif ($type == 'theme_engine' || $type == 'base_theme_engine') {
 599            // Theme engines get an extra set that come before the normally
 600            // named variable processors.
 601            $prefixes[] = $name . '_engine';
 602            // The theme engine registers on behalf of the theme using the
 603            // theme's name.
 604            $prefixes[] = $theme;
 605          }
 606          else {
 607            // This applies when the theme manually registers their own variable
 608            // processors.
 609            $prefixes[] = $name;
 610          }
 611          foreach ($prefixes as $prefix) {
 612            // Only use non-hook-specific variable processors for theming hooks
 613            // implemented as templates. See theme().
 614            if (isset($info['template']) && function_exists($prefix . '_' . $phase)) {
 615              $info[$phase_key][] = $prefix . '_' . $phase;
 616            }
 617            if (function_exists($prefix . '_' . $phase . '_' . $hook)) {
 618              $info[$phase_key][] = $prefix . '_' . $phase . '_' . $hook;
 619            }
 620          }
 621        }
 622        // Check for the override flag and prevent the cached variable
 623        // processors from being used. This allows themes or theme engines to
 624        // remove variable processors set earlier in the registry build.
 625        if (!empty($info['override ' . $phase_key])) {
 626          // Flag not needed inside the registry.
 627          unset($result[$hook]['override ' . $phase_key]);
 628        }
 629        elseif (isset($cache[$hook][$phase_key]) && is_array($cache[$hook][$phase_key])) {
 630          $info[$phase_key] = array_merge($cache[$hook][$phase_key], $info[$phase_key]);
 631        }
 632        $result[$hook][$phase_key] = $info[$phase_key];
 633      }
 634    }
 635
 636    // Merge the newly created theme hooks into the existing cache.
 637    $cache = $result + $cache;
 638  }
 639
 640  // Let themes have variable processors even if they didn't register a
 641  // template.
 642  if ($type == 'theme' || $type == 'base_theme') {
 643    foreach ($cache as $hook => $info) {
 644      // Check only if not registered by the theme or engine.
 645      if (empty($result[$hook])) {
 646        foreach ($variable_process_phases as $phase_key => $phase) {
 647          if (!isset($info[$phase_key])) {
 648            $cache[$hook][$phase_key] = array();
 649          }
 650          // Only use non-hook-specific variable processors for theming hooks
 651          // implemented as templates. See theme().
 652          if (isset($info['template']) && function_exists($name . '_' . $phase)) {
 653            $cache[$hook][$phase_key][] = $name . '_' . $phase;
 654          }
 655          if (function_exists($name . '_' . $phase . '_' . $hook)) {
 656            $cache[$hook][$phase_key][] = $name . '_' . $phase . '_' . $hook;
 657            $cache[$hook]['theme path'] = $path;
 658          }
 659          // Ensure uniqueness.
 660          $cache[$hook][$phase_key] = array_unique($cache[$hook][$phase_key]);
 661        }
 662      }
 663    }
 664  }
 665}
 666
 667/**
 668 * Builds the theme registry cache.
 669 *
 670 * @param $theme
 671 *   The loaded $theme object as returned by list_themes().
 672 * @param $base_theme
 673 *   An array of loaded $theme objects representing the ancestor themes in
 674 *   oldest first order.
 675 * @param $theme_engine
 676 *   The name of the theme engine.
 677 */
 678function _theme_build_registry($theme, $base_theme, $theme_engine) {
 679  $cache = array();
 680  // First, process the theme hooks advertised by modules. This will
 681  // serve as the basic registry. Since the list of enabled modules is the same
 682  // regardless of the theme used, this is cached in its own entry to save
 683  // building it for every theme.
 684  if ($cached = cache_get('theme_registry:build:modules')) {
 685    $cache = $cached->data;
 686  }
 687  else {
 688    foreach (module_implements('theme') as $module) {
 689      _theme_process_registry($cache, $module, 'module', $module, drupal_get_path('module', $module));
 690    }
 691    // Only cache this registry if all modules are loaded.
 692    if (module_load_all(NULL)) {
 693      cache_set('theme_registry:build:modules', $cache);
 694    }
 695  }
 696
 697  // Process each base theme.
 698  foreach ($base_theme as $base) {
 699    // If the base theme uses a theme engine, process its hooks.
 700    $base_path = dirname($base->filename);
 701    if ($theme_engine) {
 702      _theme_process_registry($cache, $theme_engine, 'base_theme_engine', $base->name, $base_path);
 703    }
 704    _theme_process_registry($cache, $base->name, 'base_theme', $base->name, $base_path);
 705  }
 706
 707  // And then the same thing, but for the theme.
 708  if ($theme_engine) {
 709    _theme_process_registry($cache, $theme_engine, 'theme_engine', $theme->name, dirname($theme->filename));
 710  }
 711
 712  // Finally, hooks provided by the theme itself.
 713  _theme_process_registry($cache, $theme->name, 'theme', $theme->name, dirname($theme->filename));
 714
 715  // Let modules alter the registry.
 716  drupal_alter('theme_registry', $cache);
 717
 718  // Optimize the registry to not have empty arrays for functions.
 719  foreach ($cache as $hook => $info) {
 720    foreach (array('preprocess functions', 'process functions') as $phase) {
 721      if (empty($info[$phase])) {
 722        unset($cache[$hook][$phase]);
 723      }
 724    }
 725  }
 726  return $cache;
 727}
 728
 729/**
 730 * Returns a list of all currently available themes.
 731 *
 732 * Retrieved from the database, if available and the site is not in maintenance
 733 * mode; otherwise compiled freshly from the filesystem.
 734 *
 735 * @param $refresh
 736 *   Whether to reload the list of themes from the database. Defaults to FALSE.
 737 *
 738 * @return
 739 *   An associative array of the currently available themes. The keys are the
 740 *   themes' machine names and the values are objects having the following
 741 *   properties:
 742 *   - filename: The filepath and name of the .info file.
 743 *   - name: The machine name of the theme.
 744 *   - status: 1 for enabled, 0 for disabled themes.
 745 *   - info: The contents of the .info file.
 746 *   - stylesheets: A two dimensional array, using the first key for the
 747 *     media attribute (e.g. 'all'), the second for the name of the file
 748 *     (e.g. style.css). The value is a complete filepath (e.g.
 749 *     themes/bartik/style.css). Not set if no stylesheets are defined in the
 750 *     .info file.
 751 *   - scripts: An associative array of JavaScripts, using the filename as key
 752 *     and the complete filepath as value. Not set if no scripts are defined in
 753 *     the .info file.
 754 *   - prefix: The base theme engine prefix.
 755 *   - engine: The machine name of the theme engine.
 756 *   - base_theme: If this is a sub-theme, the machine name of the base theme
 757 *     defined in the .info file. Otherwise, the element is not set.
 758 *   - base_themes: If this is a sub-theme, an associative array of the
 759 *     base-theme ancestors of this theme, starting with this theme's base
 760 *     theme, then the base theme's own base theme, etc. Each entry has an
 761 *     array key equal to the theme's machine name, and a value equal to the
 762 *     human-readable theme name; if a theme with matching machine name does
 763 *     not exist in the system, the value will instead be NULL (and since the
 764 *     system would not know whether that theme itself has a base theme, that
 765 *     will end the array of base themes). This is not set if the theme is not
 766 *     a sub-theme.
 767 *   - sub_themes: An associative array of themes on the system that are
 768 *     either direct sub-themes (that is, they declare this theme to be
 769 *     their base theme), direct sub-themes of sub-themes, etc. The keys are
 770 *     the themes' machine names, and the values are the themes' human-readable
 771 *     names. This element is not set if there are no themes on the system that
 772 *     declare this theme as their base theme.
 773*/
 774function list_themes($refresh = FALSE) {
 775  $list = &drupal_static(__FUNCTION__, array());
 776
 777  if ($refresh) {
 778    $list = array();
 779    system_list_reset();
 780  }
 781
 782  if (empty($list)) {
 783    $list = array();
 784    $themes = array();
 785    // Extract from the database only when it is available.
 786    // Also check that the site is not in the middle of an install or update.
 787    if (!defined('MAINTENANCE_MODE')) {
 788      try {
 789        $themes = system_list('theme');
 790      }
 791      catch (Exception $e) {
 792        // If the database is not available, rebuild the theme data.
 793        $themes = _system_rebuild_theme_data();
 794      }
 795    }
 796    else {
 797      // Scan the installation when the database should not be read.
 798      $themes = _system_rebuild_theme_data();
 799    }
 800
 801    foreach ($themes as $theme) {
 802      foreach ($theme->info['stylesheets'] as $media => $stylesheets) {
 803        foreach ($stylesheets as $stylesheet => $path) {
 804          $theme->stylesheets[$media][$stylesheet] = $path;
 805        }
 806      }
 807      foreach ($theme->info['scripts'] as $script => $path) {
 808        $theme->scripts[$script] = $path;
 809      }
 810      if (isset($theme->info['engine'])) {
 811        $theme->engine = $theme->info['engine'];
 812      }
 813      if (isset($theme->info['base theme'])) {
 814        $theme->base_theme = $theme->info['base theme'];
 815      }
 816      // Status is normally retrieved from the database. Add zero values when
 817      // read from the installation directory to prevent notices.
 818      if (!isset($theme->status)) {
 819        $theme->status = 0;
 820      }
 821      $list[$theme->name] = $theme;
 822    }
 823  }
 824
 825  return $list;
 826}
 827
 828/**
 829 * Find all the base themes for the specified theme.
 830 *
 831 * Themes can inherit templates and function implementations from earlier themes.
 832 *
 833 * @param $themes
 834 *   An array of available themes.
 835 * @param $key
 836 *   The name of the theme whose base we are looking for.
 837 * @param $used_keys
 838 *   A recursion parameter preventing endless loops.
 839 * @return
 840 *   Returns an array of all of the theme's ancestors; the first element's value
 841 *   will be NULL if an error occurred.
 842 */
 843function drupal_find_base_themes($themes, $key, $used_keys = array()) {
 844  $base_key = $themes[$key]->info['base theme'];
 845  // Does the base theme exist?
 846  if (!isset($themes[$base_key])) {
 847    return array($base_key => NULL);
 848  }
 849
 850  $current_base_theme = array($base_key => $themes[$base_key]->info['name']);
 851
 852  // Is the base theme itself a child of another theme?
 853  if (isset($themes[$base_key]->info['base theme'])) {
 854    // Do we already know the base themes of this theme?
 855    if (isset($themes[$base_key]->base_themes)) {
 856      return $themes[$base_key]->base_themes + $current_base_theme;
 857    }
 858    // Prevent loops.
 859    if (!empty($used_keys[$base_key])) {
 860      return array($base_key => NULL);
 861    }
 862    $used_keys[$base_key] = TRUE;
 863    return drupal_find_base_themes($themes, $base_key, $used_keys) + $current_base_theme;
 864  }
 865  // If we get here, then this is our parent theme.
 866  return $current_base_theme;
 867}
 868
 869/**
 870 * Generates themed output.
 871 *
 872 * All requests for themed output must go through this function. It examines
 873 * the request and routes it to the appropriate
 874 * @link themeable theme function or template @endlink, by checking the theme
 875 * registry.
 876 *
 877 * Most commonly, the first argument to this function is the name of the theme
 878 * hook. For instance, to theme a taxonomy term, the theme hook name is
 879 * 'taxonomy_term'. Modules register theme hooks within a hook_theme()
 880 * implementation and provide a default implementation via a function named
 881 * theme_HOOK() (e.g., theme_taxonomy_term()) or via a template file named
 882 * according to the value of the 'template' key registered with the theme hook
 883 * (see hook_theme() for details). Default templates are implemented with the
 884 * PHPTemplate rendering engine and are named the same as the theme hook, with
 885 * underscores changed to hyphens, so for the 'taxonomy_term' theme hook, the
 886 * default template is 'taxonomy-term.tpl.php'.
 887 *
 888 * Themes may also register new theme hooks within a hook_theme()
 889 * implementation, but it is more common for themes to override default
 890 * implementations provided by modules than to register entirely new theme
 891 * hooks. Themes can override a default implementation by implementing a
 892 * function named THEME_HOOK() (for example, the 'bartik' theme overrides the
 893 * default implementation of the 'menu_tree' theme hook by implementing a
 894 * bartik_menu_tree() function), or by adding a template file within its folder
 895 * structure that follows the template naming structure used by the theme's
 896 * rendering engine (for example, since the Bartik theme uses the PHPTemplate
 897 * rendering engine, it overrides the default implementation of the 'page' theme
 898 * hook by containing a 'page.tpl.php' file within its folder structure).
 899 *
 900 * If the implementation is a template file, several functions are called
 901 * before the template file is invoked, to modify the $variables array. These
 902 * fall into the "preprocessing" phase and the "processing" phase, and are
 903 * executed (if they exist), in the following order (note that in the following
 904 * list, HOOK indicates the theme hook name, MODULE indicates a module name,
 905 * THEME indicates a theme name, and ENGINE indicates a theme engine name):
 906 * - template_preprocess(&$variables, $hook): Creates a default set of
 907 *   variables for all theme hooks with template implementations.
 908 * - template_preprocess_HOOK(&$variables): Should be implemented by the module
 909 *   that registers the theme hook, to set up default variables.
 910 * - MODULE_preprocess(&$variables, $hook): hook_preprocess() is invoked on all
 911 *   implementing modules.
 912 * - MODULE_preprocess_HOOK(&$variables): hook_preprocess_HOOK() is invoked on
 913 *   all implementing modules, so that modules that didn't define the theme
 914 *   hook can alter the variables.
 915 * - ENGINE_engine_preprocess(&$variables, $hook): Allows the theme engine to
 916 *   set necessary variables for all theme hooks with template implementations.
 917 * - ENGINE_engine_preprocess_HOOK(&$variables): Allows the theme engine to set
 918 *   necessary variables for the particular theme hook.
 919 * - THEME_preprocess(&$variables, $hook): Allows the theme to set necessary
 920 *   variables for all theme hooks with template implementations.
 921 * - THEME_preprocess_HOOK(&$variables): Allows the theme to set necessary
 922 *   variables specific to the particular theme hook.
 923 * - template_process(&$variables, $hook): Creates an additional set of default
 924 *   variables for all theme hooks with template implementations. The variables
 925 *   created in this function are derived from ones created by
 926 *   template_preprocess(), but potentially altered by the other preprocess
 927 *   functions listed above. For example, any preprocess function can add to or
 928 *   modify the $variables['attributes_array'] variable, and after all of them
 929 *   have finished executing, template_process() flattens it into a
 930 *   $variables['attributes'] string for convenient use by templates.
 931 * - template_process_HOOK(&$variables): Should be implemented by the module
 932 *   that registers the theme hook, if it needs to perform additional variable
 933 *   processing after all preprocess functions have finished.
 934 * - MODULE_process(&$variables, $hook): hook_process() is invoked on all
 935 *   implementing modules.
 936 * - MODULE_process_HOOK(&$variables): hook_process_HOOK() is invoked on
 937 *   on all implementing modules, so that modules that didn't define the theme
 938 *   hook can alter the variables.
 939 * - ENGINE_engine_process(&$variables, $hook): Allows the theme engine to
 940 *   process variables for all theme hooks with template implementations.
 941 * - ENGINE_engine_process_HOOK(&$variables): Allows the theme engine to process
 942 *   the variables specific to the theme hook.
 943 * - THEME_process(&$variables, $hook):  Allows the theme to process the
 944 *   variables for all theme hooks with template implementations.
 945 * - THEME_process_HOOK(&$variables):  Allows the theme to process the
 946 *   variables specific to the theme hook.
 947 *
 948 * If the implementation is a function, only the theme-hook-specific preprocess
 949 * and process functions (the ones ending in _HOOK) are called from the
 950 * list above. This is because theme hooks with function implementations
 951 * need to be fast, and calling the non-theme-hook-specific preprocess and
 952 * process functions for them would incur a noticeable performance penalty.
 953 *
 954 * There are two special variables that these preprocess and process functions
 955 * can set: 'theme_hook_suggestion' and 'theme_hook_suggestions'. These will be
 956 * merged together to form a list of 'suggested' alternate theme hooks to use,
 957 * in reverse order of priority. theme_hook_suggestion will always be a higher
 958 * priority than items in theme_hook_suggestions. theme() will use the
 959 * highest priority implementation that exists. If none exists, theme() will
 960 * use the implementation for the theme hook it was called with. These
 961 * suggestions are similar to and are used for similar reasons as calling
 962 * theme() with an array as the $hook parameter (see below). The difference
 963 * is whether the suggestions are determined by the code that calls theme() or
 964 * by a preprocess or process function.
 965 *
 966 * @param $hook
 967 *   The name of the theme hook to call. If the name contains a
 968 *   double-underscore ('__') and there isn't an implementation for the full
 969 *   name, the part before the '__' is checked. This allows a fallback to a
 970 *   more generic implementation. For example, if theme('links__node', ...) is
 971 *   called, but there is no implementation of that theme hook, then the
 972 *   'links' implementation is used. This process is iterative, so if
 973 *   theme('links__contextual__node', ...) is called, theme() checks for the
 974 *   following implementations, and uses the first one that exists:
 975 *   - links__contextual__node
 976 *   - links__contextual
 977 *   - links
 978 *   This allows themes to create specific theme implementations for named
 979 *   objects and contexts of otherwise generic theme hooks. The $hook parameter
 980 *   may also be an array, in which case the first theme hook that has an
 981 *   implementation is used. This allows for the code that calls theme() to
 982 *   explicitly specify the fallback order in a situation where using the '__'
 983 *   convention is not desired or is insufficient.
 984 * @param $variables
 985 *   An associative array of variables to merge with defaults from the theme
 986 *   registry, pass to preprocess and process functions for modification, and
 987 *   finally, pass to the function or template implementing the theme hook.
 988 *   Alternatively, this can be a renderable array, in which case, its
 989 *   properties are mapped to variables expected by the theme hook
 990 *   implementations.
 991 *
 992 * @return
 993 *   An HTML string representing the themed output.
 994 *
 995 * @see themeable
 996 * @see hook_theme()
 997 * @see template_preprocess()
 998 * @see template_process()
 999 */
1000function theme($hook, $variables = array()) {
1001  // If called before all modules are loaded, we do not necessarily have a full
1002  // theme registry to work with, and therefore cannot process the theme
1003  // request properly. See also _theme_load_registry().
1004  if (!module_load_all(NULL) && !defined('MAINTENANCE_MODE')) {
1005    throw new Exception(t('theme() may not be called until all modules are loaded.'));
1006  }
1007
1008  $hooks = theme_get_registry(FALSE);
1009
1010  // If an array of hook candidates were passed, use the first one that has an
1011  // implementation.
1012  if (is_array($hook)) {
1013    foreach ($hook as $candidate) {
1014      if (isset($hooks[$candidate])) {
1015        break;
1016      }
1017    }
1018    $hook = $candidate;
1019  }
1020
1021  // If there's no implementation, check for more generic fallbacks. If there's
1022  // still no implementation, log an error and return an empty string.
1023  if (!isset($hooks[$hook])) {
1024    // Iteratively strip everything after the last '__' delimiter, until an
1025    // implementation is found.
1026    while ($pos = strrpos($hook, '__')) {
1027      $hook = substr($hook, 0, $pos);
1028      if (isset($hooks[$hook])) {
1029        break;
1030      }
1031    }
1032    if (!isset($hooks[$hook])) {
1033      // Only log a message when not trying theme suggestions ($hook being an
1034      // array).
1035      if (!isset($candidate)) {
1036        watchdog('theme', 'Theme hook %hook not found.', array('%hook' => $hook), WATCHDOG_WARNING);
1037      }
1038      return '';
1039    }
1040  }
1041
1042  $info = $hooks[$hook];
1043  global $theme_path;
1044  $temp = $theme_path;
1045  // point path_to_theme() to the currently used theme path:
1046  $theme_path = $info['theme path'];
1047
1048  // Include a file if the theme function or variable processor is held
1049  // elsewhere.
1050  if (!empty($info['includes'])) {
1051    foreach ($info['includes'] as $include_file) {
1052      include_once DRUPAL_ROOT . '/' . $include_file;
1053    }
1054  }
1055
1056  // If a renderable array is passed as $variables, then set $variables to
1057  // the arguments expected by the theme function.
1058  if (isset($variables['#theme']) || isset($variables['#theme_wrappers'])) {
1059    $element = $variables;
1060    $variables = array();
1061    if (isset($info['variables'])) {
1062      foreach (array_keys($info['variables']) as $name) {
1063        if (isset($element["#$name"])) {
1064          $variables[$name] = $element["#$name"];
1065        }
1066      }
1067    }
1068    else {
1069      $variables[$info['render element']] = $element;
1070    }
1071  }
1072
1073  // Merge in argument defaults.
1074  if (!empty($info['variables'])) {
1075    $variables += $info['variables'];
1076  }
1077  elseif (!empty($info['render element'])) {
1078    $variables += array($info['render element'] => array());
1079  }
1080
1081  // Invoke the variable processors, if any. The processors may specify
1082  // alternate suggestions for which hook's template/function to use. If the
1083  // hook is a suggestion of a base hook, invoke the variable processors of
1084  // the base hook, but retain the suggestion as a high priority suggestion to
1085  // be used unless overridden by a variable processor function.
1086  if (isset($info['base hook'])) {
1087    $base_hook = $info['base hook'];
1088    $base_hook_info = $hooks[$base_hook];
1089    // Include files required by the base hook, since its variable processors
1090    // might reside there.
1091    if (!empty($base_hook_info['includes'])) {
1092      foreach ($base_hook_info['includes'] as $include_file) {
1093        include_once DRUPAL_ROOT . '/' . $include_file;
1094      }
1095    }
1096    if (isset($base_hook_info['preprocess functions']) || isset($base_hook_info['process functions'])) {
1097      $variables['theme_hook_suggestion'] = $hook;
1098      $hook = $base_hook;
1099      $info = $base_hook_info;
1100    }
1101  }
1102  if (isset($info['preprocess functions']) || isset($info['process functions'])) {
1103    $variables['theme_hook_suggestions'] = array();
1104    foreach (array('preprocess functions', 'process functions') as $phase) {
1105      if (!empty($info[$phase])) {
1106        foreach ($info[$phase] as $processor_function) {
1107          if (function_exists($processor_function)) {
1108            // We don't want a poorly behaved process function changing $hook.
1109            $hook_clone = $hook;
1110            $processor_function($variables, $hook_clone);
1111          }
1112        }
1113      }
1114    }
1115    // If the preprocess/process functions specified hook suggestions, and the
1116    // suggestion exists in the theme registry, use it instead of the hook that
1117    // theme() was called with. This allows the preprocess/process step to
1118    // route to a more specific theme hook. For example, a function may call
1119    // theme('node', ...), but a preprocess function can add 'node__article' as
1120    // a suggestion, enabling a theme to have an alternate template file for
1121    // article nodes. Suggestions are checked in the following order:
1122    // - The 'theme_hook_suggestion' variable is checked first. It overrides
1123    //   all others.
1124    // - The 'theme_hook_suggestions' variable is checked in FILO order, so the
1125    //   last suggestion added to the array takes precedence over suggestions
1126    //   added earlier.
1127    $suggestions = array();
1128    if (!empty($variables['theme_hook_suggestions'])) {
1129      $suggestions = $variables['theme_hook_suggestions'];
1130    }
1131    if (!empty($variables['theme_hook_suggestion'])) {
1132      $suggestions[] = $variables['theme_hook_suggestion'];
1133    }
1134    foreach (array_reverse($suggestions) as $suggestion) {
1135      if (isset($hooks[$suggestion])) {
1136        $info = $hooks[$suggestion];
1137        break;
1138      }
1139    }
1140  }
1141
1142  // Generate the output using either a function or a template.
1143  $output = '';
1144  if (isset($info['function'])) {
1145    if (function_exists($info['function'])) {
1146      $output = $info['function']($variables);
1147    }
1148  }
1149  else {
1150    // Default render function and extension.
1151    $render_function = 'theme_render_template';
1152    $extension = '.tpl.php';
1153
1154    // The theme engine may use a different extension and a different renderer.
1155    global $theme_engine;
1156    if (isset($theme_engine)) {
1157      if ($info['type'] != 'module') {
1158        if (function_exists($theme_engine . '_render_template')) {
1159          $render_function = $theme_engine . '_render_template';
1160        }
1161        $extension_function = $theme_engine . '_extension';
1162        if (function_exists($extension_function)) {
1163          $extension = $extension_function();
1164        }
1165      }
1166    }
1167
1168    // In some cases, a template implementation may not have had
1169    // template_preprocess() run (for example, if the default implementation is
1170    // a function, but a template overrides that default implementation). In
1171    // these cases, a template should still be able to expect to have access to
1172    // the variables provided by template_preprocess(), so we add them here if
1173    // they don't already exist. We don't want to run template_preprocess()
1174    // twice (it would be inefficient and mess up zebra striping), so we use the
1175    // 'directory' variable to determine if it has already run, which while not
1176    // completely intuitive, is reasonably safe, and allows us to save on the
1177    // overhead of adding some new variable to track that.
1178    if (!isset($variables['directory'])) {
1179      $default_template_variables = array();
1180      template_preprocess($default_template_variables, $hook);
1181      $variables += $default_template_variables;
1182    }
1183
1184    // Render the output using the template file.
1185    $template_file = $info['template'] . $extension;
1186    if (isset($info['path'])) {
1187      $template_file = $info['path'] . '/' . $template_file;
1188    }
1189    $output = $render_function($template_file, $variables);
1190  }
1191
1192  // restore path_to_theme()
1193  $theme_path = $temp;
1194  return $output;
1195}
1196
1197/**
1198 * Returns the path to the current themed element.
1199 *
1200 * It can point to the active theme or the module handling a themed
1201 * implementation. For example, when invoked within the scope of a theming call
1202 * it will depend on where the theming function is handled. If implemented from
1203 * a module, it will point to the module. If implemented from the active theme,
1204 * it will point to the active theme. When called outside the scope of a
1205 * theming call, it will always point to the active theme.
1206 */
1207function path_to_theme() {
1208  global $theme_path;
1209
1210  if (!isset($theme_path)) {
1211    drupal_theme_initialize();
1212  }
1213
1214  return $theme_path;
1215}
1216
1217/**
1218 * Allows themes and/or theme engines to discover overridden theme functions.
1219 *
1220 * @param $cache
1221 *   The existing cache of theme hooks to test against.
1222 * @param $prefixes
1223 *   An array of prefixes to test, in reverse order of importance.
1224 *
1225 * @return $implementations
1226 *   The functions found, suitable for returning from hook_theme;
1227 */
1228function drupal_find_theme_functions($cache, $prefixes) {
1229  $implementations = array();
1230  $functions = get_defined_functions();
1231
1232  foreach ($cache as $hook => $info) {
1233    foreach ($prefixes as $prefix) {
1234      // Find theme functions that implement possible "suggestion" variants of
1235      // registered theme hooks and add those as new registered theme hooks.
1236      // The 'pattern' key defines a common prefix that all suggestions must
1237      // start with. The default is the name of the hook followed by '__'. An
1238      // 'base hook' key is added to each entry made for a found suggestion,
1239      // so that common functionality can be implemented for all suggestions of
1240      // the same base hook. To keep things simple, deep hierarchy of
1241      // suggestions is not supported: each suggestion's 'base hook' key
1242      // refers to a base hook, not to another suggestion, and all suggestions
1243      // are found using the base hook's pattern, not a pattern from an
1244      // intermediary suggestion.
1245      $pattern = isset($info['pattern']) ? $info['pattern'] : ($hook . '__');
1246      if (!isset($info['base hook']) && !empty($pattern)) {
1247        $matches = preg_grep('/^' . $prefix . '_' . $pattern . '/', $functions['user']);
1248        if ($matches) {
1249          foreach ($matches as $match) {
1250            $new_hook = substr($match, strlen($prefix) + 1);
1251            $arg_name = isset($info['variables']) ? 'variables' : 'render element';
1252            $implementations[$new_hook] = array(
1253              'function' => $match,
1254              $arg_name => $info[$arg_name],
1255              'base hook' => $hook,
1256            );
1257          }
1258        }
1259      }
1260      // Find theme functions that implement registered theme hooks and include
1261      // that in what is returned so that the registry knows that the theme has
1262      // this implementation.
1263      if (function_exists($prefix . '_' . $hook)) {
1264        $implementations[$hook] = array(
1265          'function' => $prefix . '_' . $hook,
1266        );
1267      }
1268    }
1269  }
1270
1271  return $implementations;
1272}
1273
1274/**
1275 * Allows themes and/or theme engines to easily discover overridden templates.
1276 *
1277 * @param $cache
1278 *   The existing cache of theme hooks to test against.
1279 * @param $extension
1280 *   The extension that these templates will have.
1281 * @param $path
1282 *   The path to search.
1283 */
1284function drupal_find_theme_templates($cache, $extension, $path) {
1285  $implementations = array();
1286
1287  // Collect paths to all sub-themes grouped by base themes. These will be
1288  // used for filtering. This allows base themes to have sub-themes in its
1289  // folder hierarchy without affecting the base themes template discovery.
1290  $theme_paths = array();
1291  foreach (list_themes() as $theme_info) {
1292    if (!empty($theme_info->base_theme)) {
1293      $theme_paths[$theme_info->base_theme][$theme_info->name] = dirname($theme_info->filename);
1294    }
1295  }
1296  foreach ($theme_paths as $basetheme => $subthemes) {
1297    foreach ($subthemes as $subtheme => $subtheme_path) {
1298      if (isset($theme_paths[$subtheme])) {
1299        $theme_paths[$basetheme] = array_merge($theme_paths[$basetheme], $theme_paths[$subtheme]);
1300      }
1301    }
1302  }
1303  global $theme;
1304  $subtheme_paths = isset($theme_paths[$theme]) ? $theme_paths[$theme] : array();
1305
1306  // Escape the periods in the extension.
1307  $regex = '/' . str_replace('.', '\.', $extension) . '$/';
1308  // Get a listing of all template files in the path to search.
1309  $files = drupal_system_listing($regex, $path, 'name', 0);
1310
1311  // Find templates that implement registered theme hooks and include that in
1312  // what is returned so that the registry knows that the theme has this
1313  // implementation.
1314  foreach ($files as $template => $file) {
1315    // Ignore sub-theme templates for the current theme.
1316    if (strpos($file->uri, str_replace($subtheme_paths, '', $file->uri)) !== 0) {
1317      continue;
1318    }
1319    // Chop off the remaining extensions if there are any. $template already
1320    // has the rightmost extension removed, but there might still be more,
1321    // such as with .tpl.php, which still has .tpl in $template at this point.
1322    if (($pos = strpos($template, '.')) !== FALSE) {
1323      $template = substr($template, 0, $pos);
1324    }
1325    // Transform - in filenames to _ to match function naming scheme
1326    // for the purposes of searching.
1327    $hook = strtr($template, '-', '_');
1328    if (isset($cache[$hook])) {
1329      $implementations[$hook] = array(
1330        'template' => $template,
1331        'path' => dirname($file->uri),
1332      );
1333    }
1334  }
1335
1336  // Find templates that implement possible "suggestion" variants of registered
1337  // theme hooks and add those as new registered theme hooks. See
1338  // drupal_find_theme_functions() for more information about suggestions and
1339  // the use of 'pattern' and 'base hook'.
1340  $patterns = array_keys($files);
1341  foreach ($cache as $hook => $info) {
1342    $pattern = isset($info['pattern']) ? $info['pattern'] : ($hook . '__');
1343    if (!isset($info['base hook']) && !empty($pattern)) {
1344      // Transform _ in pattern to - to match file naming scheme
1345      // for the purposes of searching.
1346      $pattern = strtr($pattern, '_', '-');
1347
1348      $matches = preg_grep('/^' . $pattern . '/', $patterns);
1349      if ($matches) {
1350        foreach ($matches as $match) {
1351          $file = substr($match, 0, strpos($match, '.'));
1352          // Put the underscores back in for the hook name and register this
1353          // pattern.
1354          $arg_name = isset($info['variables']) ? 'variables' : 'render element';
1355          $implementations[strtr($file, '-', '_')] = array(
1356            'template' => $file,
1357            'path' => dirname($files[$match]->uri),
1358            $arg_name => $info[$arg_name],
1359            'base hook' => $hook,
1360          );
1361        }
1362      }
1363    }
1364  }
1365  return $implementations;
1366}
1367
1368/**
1369 * Retrieves a setting for the current theme or for a given theme.
1370 *
1371 * The final setting is obtained from the last value found in the following
1372 * sources:
1373 * - the default global settings specified in this function
1374 * - the default theme-specific settings defined in any base theme's .info file
1375 * - the default theme-specific settings defined in the theme's .info file
1376 * - the saved values from the global theme settings form
1377 * - the saved values from the theme's settings form
1378 * To only retrieve the default global theme setting, an empty string should be
1379 * given for $theme.
1380 *
1381 * @param $setting_name
1382 *   The name of the setting to be retrieved.
1383 * @param $theme
1384 *   The name of a given theme; defaults to the current theme.
1385 *
1386 * @return
1387 *   The value of the requested setting, NULL if the setting does not exist.
1388 */
1389function theme_get_setting($setting_name, $theme = NULL) {
1390  $cache = &drupal_static(__FUNCTION__, array());
1391
1392  // If no key is given, use the current theme if we can determine it.
1393  if (!isset($theme)) {
1394    $theme = !empty($GLOBALS['theme_key']) ? $GLOBALS['theme_key'] : '';
1395  }
1396
1397  if (empty($cache[$theme])) {
1398    // Set the default values for each global setting.
1399    // To add new global settings, add their default values below, and then
1400    // add form elements to system_theme_settings() in system.admin.inc.
1401    $cache[$theme] = array(
1402      'default_logo'                     =>  1,
1403      'logo_path'                        =>  '',
1404      'default_favicon'                  =>  1,
1405      'favicon_path'                     =>  '',
1406      // Use the IANA-registered MIME type for ICO files as default.
1407      'favicon_mimetype'                 =>  'image/vnd.microsoft.icon',
1408    );
1409    // Turn on all default features.
1410    $features = _system_default_theme_features();
1411    foreach ($features as $feature) {
1412      $cache[$theme]['toggle_' . $feature] = 1;
1413    }
1414
1415    // Get the values for the theme-specific settings from the .info files of
1416    // the theme and all its base themes.
1417    if ($theme) {
1418      $themes = list_themes();
1419      $theme_object = $themes[$theme];
1420
1421      // Create a list which includes the current theme and all its base themes.
1422      if (isset($theme_object->base_themes)) {
1423        $theme_keys = array_keys($theme_object->base_themes);
1424        $theme_keys[] = $theme;
1425      }
1426      else {
1427        $theme_keys = array($theme);
1428      }
1429      foreach ($theme_keys as $theme_key) {
1430        if (!empty($themes[$theme_key]->info['settings'])) {
1431          $cache[$theme] = array_merge($cache[$theme], $themes[$theme_key]->info['settings']);
1432        }
1433      }
1434    }
1435
1436    // Get the saved global settings from the database.
1437    $cache[$theme] = array_merge($cache[$theme], variable_get('theme_settings', array()));
1438
1439    if ($theme) {
1440      // Get the saved theme-specific settings from the database.
1441      $cache[$theme] = array_merge($cache[$theme], variable_get('theme_' . $theme . '_settings', array()));
1442
1443      // If the theme does not support a particular feature, override the global
1444      // setting and set the value to NULL.
1445      if (!empty($theme_object->info['features'])) {
1446        foreach ($features as $feature) {
1447          if (!in_array($feature, $theme_object->info['features'])) {
1448            $cache[$theme]['toggle_' . $feature] = NULL;
1449          }
1450        }
1451      }
1452
1453      // Generate the path to the logo image.
1454      if ($cache[$theme]['toggle_logo']) {
1455        if ($cache[$theme]['default_logo']) {
1456          $cache[$theme]['logo'] = file_create_url(dirname($theme_object->filename) . '/logo.png');
1457        }
1458        elseif ($cache[$theme]['logo_path']) {
1459          $cache[$theme]['logo'] = file_create_url($cache[$theme]['logo_path']);
1460        }
1461      }
1462
1463      // Generate the path to the favicon.
1464      if ($cache[$theme]['toggle_favicon']) {
1465        if ($cache[$theme]['default_favicon']) {
1466          if (file_exists($favicon = dirname($theme_object->filename) . '/favicon.ico')) {
1467            $cache[$theme]['favicon'] = file_create_url($favicon);
1468          }
1469          else {
1470            $cache[$theme]['favicon'] = file_create_url('misc/favicon.ico');
1471          }
1472        }
1473        elseif ($cache[$theme]['favicon_path']) {
1474          $cache[$theme]['favicon'] = file_create_url($cache[$theme]['favicon_path']);
1475        }
1476        else {
1477          $cache[$theme]['toggle_favicon'] = FALSE;
1478        }
1479      }
1480    }
1481  }
1482
1483  return isset($cache[$theme][$setting_name]) ? $cache[$theme][$setting_name] : NULL;
1484}
1485
1486/**
1487 * Renders a system default template, which is essentially a PHP template.
1488 *
1489 * @param $template_file
1490 *   The filename of the template to render.
1491 * @param $variables
1492 *   A keyed array of variables that will appear in the output.
1493 *
1494 * @return
1495 *   The output generated by the template.
1496 */
1497function theme_render_template($template_file, $variables) {
1498  // Extract the variables to a local namespace
1499  extract($variables, EXTR_SKIP);
1500
1501  // Start output buffering
1502  ob_start();
1503
1504  // Include the template file
1505  include DRUPAL_ROOT . '/' . $template_file;
1506
1507  // End buffering and return its contents
1508  return ob_get_clean();
1509}
1510
1511/**
1512 * Enables a given list of themes.
1513 *
1514 * @param $theme_list
1515 *   An array of theme names.
1516 */
1517function theme_enable($theme_list) {
1518  drupal_clear_css_cache();
1519
1520  foreach ($theme_list as $key) {
1521    db_update('system')
1522      ->fields(array('status' => 1))
1523      ->condition('type', 'theme')
1524      ->condition('name', $key)
1525      ->execute();
1526  }
1527
1528  list_themes(TRUE);
1529  menu_rebuild();
1530  drupal_theme_rebuild();
1531
1532  // Invoke hook_themes_enabled() after the themes have been enabled.
1533  module_invoke_all('themes_enabled', $theme_list);
1534}
1535
1536/**
1537 * Disables a given list of themes.
1538 *
1539 * @param $theme_list
1540 *   An array of theme names.
1541 */
1542function theme_disable($theme_list) {
1543  // Don't disable the default theme.
1544  if ($pos = array_search(variable_get('theme_default', 'bartik'), $theme_list) !== FALSE) {
1545    unset($theme_list[$pos]);
1546    if (empty($theme_list)) {
1547      return;
1548    }
1549  }
1550
1551  drupal_clear_css_cache();
1552
1553  foreach ($theme_list as $key) {
1554    db_update('system')
1555      ->fields(array('status' => 0))
1556      ->condition('type', 'theme')
1557      ->condition('name', $key)
1558      ->execute();
1559  }
1560
1561  list_themes(TRUE);
1562  menu_rebuild();
1563  drupal_theme_rebuild();
1564
1565  // Invoke hook_themes_disabled after the themes have been disabled.
1566  module_invoke_all('themes_disabled', $theme_list);
1567}
1568
1569/**
1570 * @addtogroup themeable
1571 * @{
1572 */
1573
1574/**
1575 * Returns HTML for status and/or error messages, grouped by type.
1576 *
1577 * An invisible heading identifies the messages for assistive technology.
1578 * Sighted users see a colored box. See http://www.w3.org/TR/WCAG-TECHS/H69.html
1579 * for info.
1580 *
1581 * @param $variables
1582 *   An associative array containing:
1583 *   - display: (optional) Set to 'status' or 'error' to display only messages
1584 *     of that type.
1585 */
1586function theme_status_messages($variables) {
1587  $display = $variables['display'];
1588  $output = '';
1589
1590  $status_heading = array(
1591    'status' => t('Status message'),
1592    'error' => t('Error message'),
1593    'warning' => t('Warning message'),
1594  );
1595  foreach (drupal_get_messages($display) as $type => $messages) {
1596    $output .= "<div class=\"messages $type\">\n";
1597    if (!empty($status_heading[$type])) {
1598      $output .= '<h2 class="element-invisible">' . $status_heading[$type] . "</h2>\n";
1599    }
1600    if (count($messages) > 1) {
1601      $output .= " <ul>\n";
1602      foreach ($messages as $message) {
1603        $output .= '  <li>' . $message . "</li>\n";
1604      }
1605      $output .= " </ul>\n";
1606    }
1607    else {
1608      $output .= $messages[0];
1609    }
1610    $output .= "</div>\n";
1611  }
1612  return $output;
1613}
1614
1615/**
1616 * Returns HTML for a link.
1617 *
1618 * All Drupal code that outputs a link should call the l() function. That
1619 * function performs some initial preprocessing, and then, if necessary, calls
1620 * theme('link') for rendering the anchor tag.
1621 *
1622 * To optimize performance for sites that don't need custom theming of links,
1623 * the l() function includes an inline copy of this function, and uses that
1624 * copy if none of the enabled modules or the active theme implement any
1625 * preprocess or process functions or override this theme implementation.
1626 *
1627 * @param $variables
1628 *   An associative array containing the keys 'text', 'path', and 'options'.
1629 *   See the l() function for information about these variables.
1630 *
1631 * @see l()
1632 */
1633function theme_link($variables) {
1634  return '<a href="' . check_plain(url($variables['path'], $variables['options'])) . '"' . drupal_attributes($variables['options']['attributes']) . '>' . ($variables['options']['html'] ? $variables['text'] : check_plain($variables['text'])) . '</a>';
1635}
1636
1637/**
1638 * Returns HTML for a set of links.
1639 *
1640 * @param $variables
1641 *   An associative array containing:
1642 *   - links: An associative array of links to be themed. The key for each link
1643 *     is used as its CSS class. Each link should be itself an array, with the
1644 *     following elements:
1645 *     - title: The link text.
1646 *     - href: The link URL. If omitted, the 'title' is shown as a plain text
1647 *       item in the links list.
1648 *     - html: (optional) Whether or not 'title' is HTML. If set, the title
1649 *       will not be passed through check_plain().
1650 *     - attributes: (optional) Attributes for the anchor, or for the <span>
1651 *       tag used in its place if no 'href' is supplied. If element 'class' is
1652 *       included, it must be an array of one or more class names.
1653 *     If the 'href' element is supplied, the entire link array is passed to
1654 *     l() as its $options parameter.
1655 *   - attributes: A keyed array of attributes for the UL containing the
1656 *     list of links.
1657 *   - heading: (optional) A heading to precede the links. May be an
1658 *     associative array or a string. If it's an array, it can have the
1659 *     following elements:
1660 *     - text: The heading text.
1661 *     - level: The heading level (e.g. 'h2', 'h3').
1662 *     - class: (optional) An array of the CSS classes for the heading.
1663 *     When using a string it will be used as the text of the heading and the
1664 *     level will default to 'h2'. Headings should be used on navigation menus
1665 *     and any list of links that consistently appears on multiple pages. To
1666 *     make the heading invisible use the 'element-invisible' CSS class. Do not
1667 *     use 'display:none', which removes it from screen-readers and assistive
1668 *     technology. Headings allow screen-reader and keyboard only users to
1669 *     navigate to or skip the links. See
1670 *     http://juicystudio.com/article/screen-readers-display-none.php and
1671 *     http://www.w3.org/TR/WCAG-TECHS/H42.html for more information.
1672 */
1673function theme_links($variables) {
1674  $links = $variables['links'];
1675  $attributes = $variables['attributes'];
1676  $heading = $variables['heading'];
1677  global $language_url;
1678  $output = '';
1679
1680  if (count($links) > 0) {
1681    $output = '';
1682
1683    // Treat the heading first if it is present to prepend it to the
1684    // list of links.
1685    if (!empty($heading)) {
1686      if (is_string($heading)) {
1687        // Prepare the array that will be used when the passed heading
1688        // is a string.
1689        $heading = array(
1690          'text' => $heading,
1691          // Set the default level of the heading.
1692          'level' => 'h2',
1693        );
1694      }
1695      $output .= '<' . $heading['level'];
1696      if (!empty($heading['class'])) {
1697        $output .= drupal_attributes(array('class' => $heading['class']));
1698      }
1699      $output .= '>' . check_plain($heading['text']) . '</' . $heading['level'] . '>';
1700    }
1701
1702    $output .= '<ul' . drupal_attributes($attributes) . '>';
1703
1704    $num_links = count($links);
1705    $i = 1;
1706
1707    foreach ($links as $key => $link) {
1708      $class = array($key);
1709
1710      // Add first, last and active classes to the list of links to help out themers.
1711      if ($i == 1) {
1712        $class[] = 'first';
1713      }
1714      if ($i == $num_links) {
1715        $class[] = 'last';
1716      }
1717      if (isset($link['href']) && ($link['href'] == $_GET['q'] || ($link['href'] == '<front>' && drupal_is_front_page()))
1718          && (empty($link['language']) || $link['language']->language == $language_url->language)) {
1719        $class[] = 'active';
1720      }
1721      $output .= '<li' . drupal_attributes(array('class' => $class)) . '>';
1722
1723      if (isset($link['href'])) {
1724        // Pass in $link as $options, they share the same keys.
1725        $output .= l($link['title'], $link['href'], $link);
1726      }
1727      elseif (!empty($link['title'])) {
1728        // Some links are actually not links, but we wrap these in <span> for adding title and class attributes.
1729        if (empty($link['html'])) {
1730          $link['title'] = check_plain($link['title']);
1731        }
1732        $span_attributes = '';
1733        if (isset($link['attributes'])) {
1734          $span_attributes = drupal_attributes($link['attributes']);
1735        }
1736        $output .= '<span' . $span_attributes . '>' . $link['title'] . '</span>';
1737      }
1738
1739      $i++;
1740      $output .= "</li>\n";
1741    }
1742
1743    $output .= '</ul>';
1744  }
1745
1746  return $output;
1747}
1748
1749/**
1750 * Returns HTML for an image.
1751 *
1752 * @param $variables
1753 *   An associative array containing:
1754 *   - path: Either the path of the image file (relative to base_path()) or a
1755 *     full URL.
1756 *   - width: The width of the image (if known).
1757 *   - height: The height of the image (if known).
1758 *   - alt: The alternative text for text-based browsers. HTML 4 and XHTML 1.0
1759 *     always require an alt attribute. The HTML 5 draft allows the alt
1760 *     attribute to be omitted in some cases. Therefore, this variable defaults
1761 *     to an empty string, but can be set to NULL for the attribute to be
1762 *     omitted. Usually, neither omission nor an empty string satisfies
1763 *     accessibility requirements, so it is strongly encouraged for code
1764 *     calling theme('image') to pass a meaningful value for this variable.
1765 *     - http://www.w3.org/TR/REC-html40/struct/objects.html#h-13.8
1766 *     - http://www.w3.org/TR/xhtml1/dtds.html
1767 *     - http://dev.w3.org/html5/spec/Overview.html#alt
1768 *   - title: The title text is displayed when the image is hovered in some
1769 *     popular browsers.
1770 *   - attributes: Associative array of attributes to be placed in the img tag.
1771 */
1772function theme_image($variables) {
1773  $attributes = $variables['attributes'];
1774  $attributes['src'] = file_create_url($variables['path']);
1775
1776  foreach (array('width', 'height', 'alt', 'title') as $key) {
1777
1778    if (isset($variables[$key])) {
1779      $attributes[$key] = $variables[$key];
1780    }
1781  }
1782
1783  return '<img' . drupal_attributes($attributes) . ' />';
1784}
1785
1786/**
1787 * Returns HTML for a breadcrumb trail.
1788 *
1789 * @param $variables
1790 *   An associative array containing:
1791 *   - breadcrumb: An array containing the breadcrumb links.
1792 */
1793function theme_breadcrumb($variables) {
1794  $breadcrumb = $variables['breadcrumb'];
1795
1796  if (!empty($breadcrumb)) {
1797    // Provide a navigational heading to give context for breadcrumb links to
1798    // screen-reader users. Make the heading invisible with .element-invisible.
1799    $output = '<h2 class="element-invisible">' . t('You are here') . '</h2>';
1800
1801    $output .= '<div class="breadcrumb">' . implode(' ? ', $breadcrumb) . '</div>';
1802    return $output;
1803  }
1804}
1805
1806/**
1807 * Returns HTML for a table.
1808 *
1809 * @param $variables
1810 *   An associative array containing:
1811 *   - header: An array containing the table headers. Each element of the array
1812 *     can be either a localized string or an associative array with the
1813 *     following keys:
1814 *     - "data": The localized title of the table column.
1815 *     - "field": The database field represented in the table column (required
1816 *       if user is to be able to sort on this column).
1817 *     - "sort": A default sort order for this column ("asc" or "desc").
1818 *     - Any HTML attributes, such as "colspan", to apply to the column header
1819 *       cell.
1820 *   - rows: An array of table rows. Every row is an array of cells, or an
1821 *     associative array with the following keys:
1822 *     - "data": an array of cells
1823 *     - Any HTML attributes, such as "class", to apply to the table row.
1824 *     - "no_striping": a boolean indicating that the row should receive no
1825 *       'even / odd' styling. Defaults to FALSE.
1826 *     Each cell can be either a string or an associative array with the
1827 *     following keys:
1828 *     - "data": The string to display in the table cell.
1829 *     - "header": Indicates this cell is a header.
1830 *     - Any HTML attributes, such as "colspan", to apply to the table cell.
1831 *     Here's an example for $rows:
1832 *     @code
1833 *     $rows = array(
1834 *       // Simple row
1835 *       array(
1836 *         'Cell 1', 'Cell 2', 'Cell 3'
1837 *       ),
1838 *       // Row with attributes on the row and some of its cells.
1839 *       array(
1840 *         'data' => array('Cell 1', array('data' => 'Cell 2', 'colspan' => 2)), 'class' => array('funky')
1841 *       )
1842 *     );
1843 *     @endcode
1844 *   - attributes: An array of HTML attributes to apply to the table tag.
1845 *   - caption: A localized string to use for the <caption> tag.
1846 *   - colgroups: An array of column groups. Each element of the array can be
1847 *     either:
1848 *     - An array of columns, each of which is an associative array of HTML
1849 *       attributes applied to the COL element.
1850 *     - An array of attributes applied to the COLGROUP element, which must
1851 *       include a "data" attribute. To add attributes to COL elements, set the
1852 *       "data" attribute with an array of columns, each of which is an
1853 *       associative array of HTML attributes.
1854 *     Here's an example for $colgroup:
1855 *     @code
1856 *     $colgroup = array(
1857 *       // COLGROUP with one COL element.
1858 *       array(
1859 *         array(
1860 *           'class' => array('funky'), // Attribute for the COL element.
1861 *         ),
1862 *       ),
1863 *       // Colgroup with attributes and inner COL elements.
1864 *       array(
1865 *         'data' => array(
1866 *           array(
1867 *             'class' => array('funky'), // Attribute for the COL element.
1868 *           ),
1869 *         ),
1870 *         'class' => array('jazzy'), // Attribute for the COLGROUP element.
1871 *       ),
1872 *     );
1873 *     @endcode
1874 *     These optional tags are used to group and set properties on columns
1875 *     within a table. For example, one may easily group three columns and
1876 *     apply same background style to all.
1877 *   - sticky: Use a "sticky" table header.
1878 *   - empty: The message to display in an extra row if table does not have any
1879 *     rows.
1880 */
1881function theme_table($variables) {
1882  $header = $variables['header'];
1883  $rows = $variables['rows'];
1884  $attributes = $variables['attributes'];
1885  $caption = $variables['caption'];
1886  $colgroups = $variables['colgroups'];
1887  $sticky = $variables['sticky'];
1888  $empty = $variables['empty'];
1889
1890  // Add sticky headers, if applicable.
1891  if (count($header) && $sticky) {
1892    drupal_add_js('misc/tableheader.js');
1893    // Add 'sticky-enabled' class to the table to identify it for JS.
1894    // This is needed to target tables constructed by this function.
1895    $attributes['class'][] = 'sticky-enabled';
1896  }
1897
1898  $output = '<table' . drupal_attributes($attributes) . ">\n";
1899
1900  if (isset($caption)) {
1901    $output .= '<caption>' . $caption . "</caption>\n";
1902  }
1903
1904  // Format the table columns:
1905  if (count($colgroups)) {
1906    foreach ($colgroups as $number => $colgroup) {
1907      $attributes = array();
1908
1909      // Check if we're dealing with a simple or complex column
1910      if (isset($colgroup['data'])) {
1911        foreach ($colgroup as $key => $value) {
1912          if ($key == 'data') {
1913            $cols = $value;
1914          }
1915          else {
1916            $attributes[$key] = $value;
1917          }
1918        }
1919      }
1920      else {
1921        $cols = $colgroup;
1922      }
1923
1924      // Build colgroup
1925      if (is_array($cols) && count($cols)) {
1926        $output .= ' <colgroup' . drupal_attributes($attributes) . '>';
1927        $i = 0;
1928        foreach ($cols as $col) {
1929          $output .= ' <col' . drupal_attributes($col) . ' />';
1930        }
1931        $output .= " </colgroup>\n";
1932      }
1933      else {
1934        $output .= ' <colgroup' . drupal_attributes($attributes) . " />\n";
1935      }
1936    }
1937  }
1938
1939  // Add the 'empty' row message if available.
1940  if (!count($rows) && $empty) {
1941    $header_count = 0;
1942    foreach ($header as $header_cell) {
1943      if (is_array($header_cell)) {
1944        $header_count += isset($header_cell['colspan']) ? $header_cell['colspan'] : 1;
1945      }
1946      else {
1947        $header_count++;
1948      }
1949    }
1950    $rows[] = array(array('data' => $empty, 'colspan' => $header_count, 'class' => array('empty', 'message')));
1951  }
1952
1953  // Format the table header:
1954  if (count($header)) {
1955    $ts = tablesort_init($header);
1956    // HTML requires that the thead tag has tr tags in it followed by tbody
1957    // tags. Using ternary operator to check and see if we have any rows.
1958    $output .= (count($rows) ? ' <thead><tr>' : ' <tr>');
1959    foreach ($header as $cell) {
1960      $cell = tablesort_header($cell, $header, $ts);
1961      $output .= _theme_table_cell($cell, TRUE);
1962    }
1963    // Using ternary operator to close the tags based on whether or not there are rows
1964    $output .= (count($rows) ? " </tr></thead>\n" : "</tr>\n");
1965  }
1966  else {
1967    $ts = array();
1968  }
1969
1970  // Format the table rows:
1971  if (count($rows)) {
1972    $output .= "<tbody>\n";
1973    $flip = array('even' => 'odd', 'odd' => 'even');
1974    $class = 'even';
1975    foreach ($rows as $number => $row) {
1976      $attributes = array();
1977
1978      // Check if we're dealing with a simple or complex row
1979      if (isset($row['data'])) {
1980        foreach ($row as $key => $value) {
1981          if ($key == 'data') {
1982            $cells = $value;
1983          }
1984          else {
1985            $attributes[$key] = $value;
1986          }
1987        }
1988      }
1989      else {
1990        $cells = $row;
1991      }
1992      if (count($cells)) {
1993        // Add odd/even class
1994        if (empty($row['no_striping'])) {
1995          $class = $flip[$class];
1996          $attributes['class'][] = $class;
1997        }
1998
1999        // Build row
2000        $output .= ' <tr' . drupal_attributes($attributes) . '>';
2001        $i = 0;
2002        foreach ($cells as $cell) {
2003          $cell = tablesort_cell($cell, $header, $ts, $i++);
2004          $output .= _theme_table_cell($cell);
2005        }
2006        $output .= " </tr>\n";
2007      }
2008    }
2009    $output .= "</tbody>\n";
2010  }
2011
2012  $output .= "</table>\n";
2013  return $output;
2014}
2015
2016/**
2017 * Returns HTML for a sort icon.
2018 *
2019 * @param $variables
2020 *   An associative array containing:
2021 *   - style: Set to either 'asc' or 'desc', this determines which icon to
2022 *     show.
2023 */
2024function theme_tablesort_indicator($variables) {
2025  if ($variables['style'] == "asc") {
2026    return theme('image', array('path' => 'misc/arrow-asc.png', 'width' => 13, 'height' => 13, 'alt' => t('sort ascending'), 'title' => t('sort ascending')));
2027  }
2028  else {
2029    return theme('image', array('path' => 'misc/arrow-desc.png', 'width' => 13, 'height' => 13, 'alt' => t('sort descending'), 'title' => t('sort descending')));
2030  }
2031}
2032
2033/**
2034 * Returns HTML for a marker for new or updated content.
2035 *
2036 * @param $variables
2037 *   An associative array containing:
2038 *   - type: Number representing the marker type to display. See MARK_NEW,
2039 *     MARK_UPDATED, MARK_READ.
2040 */
2041function theme_mark($variables) {
2042  $type = $variables['type'];
2043  global $user;
2044  if ($user->uid) {
2045    if ($type == MARK_NEW) {
2046      return ' <span class="marker">' . t('new') . '</span>';
2047    }
2048    elseif ($type == MARK_UPDATED) {
2049      return ' <span class="marker">' . t('updated') . '</span>';
2050    }
2051  }
2052}
2053
2054/**
2055 * Returns HTML for a list or nested list of items.
2056 *
2057 * @param $variables
2058 *   An associative array containing:
2059 *   - items: An array of items to be displayed in the list. If an item is a
2060 *     string, then it is used as is. If an item is an array, then the "data"
2061 *     element of the array is used as the contents of the list item. If an item
2062 *     is an array with a "children" element, those children are displayed in a
2063 *     nested list. All other elements are treated as attributes of the list
2064 *     item element.
2065 *   - title: The title of the list.
2066 *   - type: The type of list to return (e.g. "ul", "ol").
2067 *   - attributes: The attributes applied to the list element.
2068 */
2069function theme_item_list($variables) {
2070  $items = $variables['items'];
2071  $title = $variables['title'];
2072  $type = $variables['type'];
2073  $attributes = $variables['attributes'];
2074
2075  // Only output the list container and title, if there are any list items.
2076  // Check to see whether the block title exists before adding a header.
2077  // Empty headers are not semantic and present accessibility challenges.
2078  $output = '<div class="item-list">';
2079  if (isset($title) && $title !== '') {
2080    $output .= '<h3>' . $title . '</h3>';
2081  }
2082
2083  if (!empty($items)) {
2084    $output .= "<$type" . drupal_attributes($attributes) . '>';
2085    $num_items = count($items);
2086    $i = 0;
2087    foreach ($items as $item) {
2088      $attributes = array();
2089      $children = array();
2090      $data = '';
2091      $i++;
2092      if (is_array($item)) {
2093        foreach ($item as $key => $value) {
2094          if ($key == 'data') {
2095            $data = $value;
2096          }
2097          elseif ($key == 'children') {
2098            $children = $value;
2099          }
2100          else {
2101            $attributes[$key] = $value;
2102          }
2103        }
2104      }
2105      else {
2106        $data = $item;
2107      }
2108      if (count($children) > 0) {
2109        // Render nested list.
2110        $data .= theme_item_list(array('items' => $children, 'title' => NULL, 'type' => $type, 'attributes' => $attributes));
2111      }
2112      if ($i == 1) {
2113        $attributes['class'][] = 'first';
2114      }
2115      if ($i == $num_items) {
2116        $attributes['class'][] = 'last';
2117      }
2118      $output .= '<li' . drupal_attributes($attributes) . '>' . $data . "</li>\n";
2119    }
2120    $output .= "</$type>";
2121  }
2122  $output .= '</div>';
2123  return $output;
2124}
2125
2126/**
2127 * Returns HTML for a "more help" link.
2128 *
2129 * @param $variables
2130 *   An associative array containing:
2131 *   - url: The URL for the link.
2132 */
2133function theme_more_help_link($variables) {
2134  return '<div class="more-help-link">' . l(t('More help'), $variables['url']) . '</div>';
2135}
2136
2137/**
2138 * Returns HTML for a feed icon.
2139 *
2140 * @param $variables
2141 *   An associative array containing:
2142 *   - url: An internal system path or a fully qualified external URL of the
2143 *     feed.
2144 *   - title: A descriptive title of the feed.
2145 */
2146function theme_feed_icon($variables) {
2147  $text = t('Subscribe to !feed-title', array('!feed-title' => $variables['title']));
2148  if ($image = theme('image', array('path' => 'misc/feed.png', 'width' => 16, 'height' => 16, 'alt' => $text))) {
2149    return l($image, $variables['url'], array('html' => TRUE, 'attributes' => array('class' => array('feed-icon'), 'title' => $text)));
2150  }
2151}
2152
2153/**
2154 * Returns HTML for a generic HTML tag with attributes.
2155 *
2156 * @param $variables
2157 *   An associative array containing:
2158 *   - element: An associative array describing the tag:
2159 *     - #tag: The tag name to output. Typical tags added to the HTML HEAD:
2160 *       - meta: To provide meta information, such as a page refresh.
2161 *       - link: To refer to stylesheets and other contextual information.
2162 *       - script: To load JavaScript.
2163 *     - #attributes: (optional) An array of HTML attributes to apply to the
2164 *       tag.
2165 *     - #value: (optional) A string containing tag content, such as inline
2166 *       CSS.
2167 *     - #value_prefix: (optional) A string to prepend to #value, e.g. a CDATA
2168 *       wrapper prefix.
2169 *     - #value_suffix: (optional) A string to append to #value, e.g. a CDATA
2170 *       wrapper suffix.
2171 */
2172function theme_html_tag($variables) {
2173  $element = $variables['element'];
2174  $attributes = isset($element['#attributes']) ? drupal_attributes($element['#attributes']) : '';
2175  if (!isset($element['#value'])) {
2176    return '<' . $element['#tag'] . $attributes . " />\n";
2177  }
2178  else {
2179    $output = '<' . $element['#tag'] . $attributes . '>';
2180    if (isset($element['#value_prefix'])) {
2181      $output .= $element['#value_prefix'];
2182    }
2183    $output .= $element['#value'];
2184    if (isset($element['#value_suffix'])) {
2185      $output .= $element['#value_suffix'];
2186    }
2187    $output .= '</' . $element['#tag'] . ">\n";
2188    return $output;
2189  }
2190}
2191
2192/**
2193 * Returns HTML for a "more" link, like those used in blocks.
2194 *
2195 * @param $variables
2196 *   An associative array containing:
2197 *   - url: The URL of the main page.
2198 *   - title: A descriptive verb for the link, like 'Read more'.
2199 */
2200function theme_more_link($variables) {
2201  return '<div class="more-link">' . l(t('More'), $variables['url'], array('attributes' => array('title' => $variables['title']))) . '</div>';
2202}
2203
2204/**
2205 * Returns HTML for a username, potentially linked to the user's page.
2206 *
2207 * @param $variables
2208 *   An associative array containing:
2209 *   - account: The user object to format.
2210 *   - name: The user's name, sanitized.
2211 *   - extra: Additional text to append to the user's name, sanitized.
2212 *   - link_path: The path or URL of the user's profile page, home page, or
2213 *     other desired page to link to for more information about the user.
2214 *   - link_options: An array of options to pass to the l() function's $options
2215 *     parameter if linking the user's name to the user's page.
2216 *   - attributes_array: An array of attributes to pass to the
2217 *     drupal_attributes() function if not linking to the user's page.
2218 *
2219 * @see template_preprocess_username()
2220 * @see template_process_username()
2221 */
2222function theme_username($variables) {
2223  if (isset($variables['link_path'])) {
2224    // We have a link path, so we should generate a link using l().
2225    // Additional classes may be added as array elements like
2226    // $variables['link_options']['attributes']['class'][] = 'myclass';
2227    $output = l($variables['name'] . $variables['extra'], $variables['link_path'], $variables['link_options']);
2228  }
2229  else {
2230    // Modules may have added important attributes so they must be included
2231    // in the output. Additional classes may be added as array elements like
2232    // $variables['attributes_array']['class'][] = 'myclass';
2233    $output = '<span' . drupal_attributes($variables['attributes_array']) . '>' . $variables['name'] . $variables['extra'] . '</span>';
2234  }
2235  return $output;
2236}
2237
2238/**
2239 * Returns HTML for a progress bar.
2240 *
2241 * Note that the core Batch API uses this only for non-JavaScript batch jobs.
2242 *
2243 * @param $variables
2244 *   An associative array containing:
2245 *   - percent: The percentage of the progress.
2246 *   - message: A string containing information to be displayed.
2247 */
2248function theme_progress_bar($variables) {
2249  $output = '<div id="progress" class="progress">';
2250  $output .= '<div class="bar"><div class="filled" style="width: ' . $variables['percent'] . '%"></div></div>';
2251  $output .= '<div class="percentage">' . $variables['percent'] . '%</div>';
2252  $output .= '<div class="message">' . $variables['message'] . '</div>';
2253  $output .= '</div>';
2254
2255  return $output;
2256}
2257
2258/**
2259 * Returns HTML for an indentation div; used for drag and drop tables.
2260 *
2261 * @param $variables
2262 *   An associative array containing:
2263 *   - size: Optional. The number of indentations to create.
2264 */
2265function theme_indentation($variables) {
2266  $output = '';
2267  for ($n = 0; $n < $variables['size']; $n++) {
2268    $output .= '<div class="indentation">&nbsp;</div>';
2269  }
2270  return $output;
2271}
2272
2273/**
2274 * @} End of "addtogroup themeable".
2275 */
2276
2277/**
2278 * Returns HTML output for a single table cell for theme_table().
2279 *
2280 * @param $cell
2281 *   Array of cell information, or string to display in cell.
2282 * @param bool $header
2283 *   TRUE if this cell is a table header cell, FALSE if it is an ordinary
2284 *   table cell. If $cell is an array with element 'header' set to TRUE, that
2285 *   will override the $header parameter.
2286 *
2287 * @return
2288 *   HTML for the cell.
2289 */
2290function _theme_table_cell($cell, $header = FALSE) {
2291  $attributes = '';
2292
2293  if (is_array($cell)) {
2294    $data = isset($cell['data']) ? $cell['data'] : '';
2295    // Cell's data property can be a string or a renderable array.
2296    if (is_array($data)) {
2297      $data = drupal_render($data);
2298    }
2299    $header |= isset($cell['header']);
2300    unset($cell['data']);
2301    unset($cell['header']);
2302    $attributes = drupal_attributes($cell);
2303  }
2304  else {
2305    $data = $cell;
2306  }
2307
2308  if ($header) {
2309    $output = "<th$attributes>$data</th>";
2310  }
2311  else {
2312    $output = "<td$attributes>$data</td>";
2313  }
2314
2315  return $output;
2316}
2317
2318/**
2319 * Adds a default set of helper variables for variable processors and templates.
2320 *
2321 * This function is called for theme hooks implemented as templates only, not
2322 * for theme hooks implemented as functions. This preprocess function is the
2323 * first in the sequence of preprocessing and processing functions that is
2324 * called when preparing variables for a template. See theme() for more details
2325 * about the full sequence.
2326 *
2327 * @see theme()
2328 * @see template_process()
2329 */
2330function template_preprocess(&$variables, $hook) {
2331  global $user;
2332  static $count = array();
2333
2334  // Track run count for each hook to provide zebra striping. See
2335  // "template_preprocess_block()" which provides the same feature specific to
2336  // blocks.
2337  $count[$hook] = isset($count[$hook]) && is_int($count[$hook]) ? $count[$hook] : 1;
2338  $variables['zebra'] = ($count[$hook] % 2) ? 'odd' : 'even';
2339  $variables['id'] = $count[$hook]++;
2340
2341  // Tell all templates where they are located.
2342  $variables['directory'] = path_to_theme();
2343
2344  // Initialize html class attribute for the current hook.
2345  $variables['classes_array'] = array(drupal_html_class($hook));
2346
2347  // Merge in variables that don't depend on hook and don't change during a
2348  // single page request.
2349  // Use the advanced drupal_static() pattern, since this is called very often.
2350  static $drupal_static_fast;
2351  if (!isset($drupal_static_fast)) {
2352    $drupal_static_fast['default_variables'] = &drupal_static(__FUNCTION__);
2353  }
2354  $default_variables = &$drupal_static_fast['default_variables'];
2355  // Global $user object shouldn't change during a page request once rendering
2356  // has started, but if there's an edge case where it does, re-fetch the
2357  // variables appropriate for the new user.
2358  if (!isset($default_variables) || ($user !== $default_variables['user'])) {
2359    $default_variables = _template_preprocess_default_variables();
2360  }
2361  $variables += $default_variables;
2362}
2363
2364/**
2365 * Returns hook-independent variables to template_preprocess().
2366 */
2367function _template_preprocess_default_variables() {
2368  global $user;
2369
2370  // Variables that don't depend on a database connection.
2371  $variables = array(
2372    'attributes_array' => array(),
2373    'title_attributes_array' => array(),
2374    'content_attributes_array' => array(),
2375    'title_prefix' => array(),
2376    'title_suffix' => array(),
2377    'user' => $user,
2378    'db_is_active' => !defined('MAINTENANCE_MODE'),
2379    'is_admin' => FALSE,
2380    'logged_in' => FALSE,
2381  );
2382
2383  // The user object has no uid property when the database does not exist during
2384  // install. The user_access() check deals with issues when in maintenance mode
2385  // as uid is set but the user.module has not been included.
2386  if (isset($user->uid) && function_exists('user_access')) {
2387    $variables['is_admin'] = user_access('access administration pages');
2388    $variables['logged_in'] = ($user->uid > 0);
2389  }
2390
2391  // drupal_is_front_page() might throw an exception.
2392  try {
2393    $variables['is_front'] = drupal_is_front_page();
2394  }
2395  catch (Exception $e) {
2396    // If the database is not yet available, set default values for these
2397    // variables.
2398    $variables['is_front'] = FALSE;
2399    $variables['db_is_active'] = FALSE;
2400  }
2401
2402  return $variables;
2403}
2404
2405/**
2406 * Adds helper variables derived from variables defined during preprocessing.
2407 *
2408 * When preparing variables for a theme hook implementation, all 'preprocess'
2409 * functions run first, then all 'process' functions (see theme() for details
2410 * about the full sequence).
2411 *
2412 * This function serializes array variables manipulated during the preprocessing
2413 * phase into strings for convenient use by templates. As with
2414 * template_preprocess(), this function does not get called for theme hooks
2415 * implemented as functions.
2416 *
2417 * @see theme()
2418 * @see template_preprocess()
2419 */
2420function template_process(&$variables, $hook) {
2421  // Flatten out classes.
2422  $variables['classes'] = implode(' ', $variables['classes_array']);
2423
2424  // Flatten out attributes, title_attributes, and content_attributes.
2425  // Because this function can be called very often, and often with empty
2426  // attributes, optimize performance by only calling drupal_attributes() if
2427  // necessary.
2428  $variables['attributes'] = $variables['attributes_array'] ? drupal_attributes($variables['attributes_array']) : '';
2429  $variables['title_attributes'] = $variables['title_attributes_array'] ? drupal_attributes($variables['title_attributes_array']) : '';
2430  $variables['content_attributes'] = $variables['content_attributes_array'] ? drupal_attributes($variables['content_attributes_array']) : '';
2431}
2432
2433/**
2434 * Preprocess variables for html.tpl.php
2435 *
2436 * @see system_elements()
2437 * @see html.tpl.php
2438 */
2439function template_preprocess_html(&$variables) {
2440  // Compile a list of classes that are going to be applied to the body element.
2441  // This allows advanced theming based on context (home page, node of certain type, etc.).
2442  // Add a class that tells us whether we're on the front page or not.
2443  $variables['classes_array'][] = $variables['is_front'] ? 'front' : 'not-front';
2444  // Add a class that tells us whether the page is viewed by an authenticated user or not.
2445  $variables['classes_array'][] = $variables['logged_in'] ? 'logged-in' : 'not-logged-in';
2446
2447  // Add information about the number of sidebars.
2448  if (!empty($variables['page']['sidebar_first']) && !empty($variables['page']['sidebar_second'])) {
2449    $variables['classes_array'][] = 'two-sidebars';
2450  }
2451  elseif (!empty($variables['page']['sidebar_first'])) {
2452    $variables['classes_array'][] = 'one-sidebar sidebar-first';
2453  }
2454  elseif (!empty($variables['page']['sidebar_second'])) {
2455    $variables['classes_array'][] = 'one-sidebar sidebar-second';
2456  }
2457  else {
2458    $variables['classes_array'][] = 'no-sidebars';
2459  }
2460
2461  // Populate the body classes.
2462  if ($suggestions = theme_get_suggestions(arg(), 'page', '-')) {
2463    foreach ($suggestions as $suggestion) {
2464      if ($suggestion != 'page-front') {
2465        // Add current suggestion to page classes to make it possible to theme
2466        // the page depending on the current page type (e.g. node, admin, user,
2467        // etc.) as well as more specific data like node-12 or node-edit.
2468        $variables['classes_array'][] = drupal_html_class($suggestion);
2469      }
2470    }
2471  }
2472
2473  // If on an individual node page, add the node type to body classes.
2474  if ($node = menu_get_object()) {
2475    $variables['classes_array'][] = drupal_html_class('node-type-' . $node->type);
2476  }
2477
2478  // RDFa allows annotation of XHTML pages with RDF data, while GRDDL provides
2479  // mechanisms for extraction of this RDF content via XSLT transformation
2480  // using an associated GRDDL profile.
2481  $variables['rdf_namespaces']    = drupal_get_rdf_namespaces();
2482  $variables['grddl_profile']     = 'http://www.w3.org/1999/xhtml/vocab';
2483  $variables['language']          = $GLOBALS['language'];
2484  $variables['language']->dir     = $GLOBALS['language']->direction ? 'rtl' : 'ltr';
2485
2486  // Add favicon.
2487  if (theme_get_setting('toggle_favicon')) {
2488    $favicon = theme_get_setting('favicon');
2489    $type = theme_get_setting('favicon_mimetype');
2490    drupal_add_html_head_link(array('rel' => 'shortcut icon', 'href' => drupal_strip_dangerous_protocols($favicon), 'type' => $type));
2491  }
2492
2493  // Construct page title.
2494  if (drupal_get_title()) {
2495    $head_title = array(
2496      'title' => strip_tags(drupal_get_title()),
2497      'name' => check_plain(variable_get('site_name', 'Drupal')),
2498    );
2499  }
2500  else {
2501    $head_title = array('name' => check_plain(variable_get('site_name', 'Drupal')));
2502    if (variable_get('site_slogan', '')) {
2503      $head_title['slogan'] = filter_xss_admin(variable_get('site_slogan', ''));
2504    }
2505  }
2506  $variables['head_title_array'] = $head_title;
2507  $variables['head_title'] = implode(' | ', $head_title);
2508
2509  // Populate the page template suggestions.
2510  if ($suggestions = theme_get_suggestions(arg(), 'html')) {
2511    $variables['theme_hook_suggestions'] = $suggestions;
2512  }
2513}
2514
2515/**
2516 * Preprocess variables for page.tpl.php
2517 *
2518 * Most themes utilize their own copy of page.tpl.php. The default is located
2519 * inside "modules/system/page.tpl.php". Look in there for the full list of
2520 * variables.
2521 *
2522 * Uses the arg() function to generate a series of page template suggestions
2523 * based on the current path.
2524 *
2525 * Any changes to variables in this preprocessor should also be changed inside
2526 * template_preprocess_maintenance_page() to keep all of them consistent.
2527 *
2528 * @see drupal_render_page()
2529 * @see template_process_page()
2530 * @see page.tpl.php
2531 */
2532function template_preprocess_page(&$variables) {
2533  // Move some variables to the top level for themer convenience and template cleanliness.
2534  $variables['show_messages'] = $variables['page']['#show_messages'];
2535
2536  foreach (system_region_list($GLOBALS['theme']) as $region_key => $region_name) {
2537    if (!isset($variables['page'][$region_key])) {
2538      $variables['page'][$region_key] = array();
2539    }
2540  }
2541
2542  // Set up layout variable.
2543  $variables['layout'] = 'none';
2544  if (!empty($variables['page']['sidebar_first'])) {
2545    $variables['layout'] = 'first';
2546  }
2547  if (!empty($variables['page']['sidebar_second'])) {
2548    $variables['layout'] = ($variables['layout'] == 'first') ? 'both' : 'second';
2549  }
2550
2551  $variables['base_path']         = base_path();
2552  $variables['front_page']        = url();
2553  $variables['feed_icons']        = drupal_get_feeds();
2554  $variables['language']          = $GLOBALS['language'];
2555  $variables['language']->dir     = $GLOBALS['language']->direction ? 'rtl' : 'ltr';
2556  $variables['logo']              = theme_get_setting('logo');
2557  $variables['main_menu']         = theme_get_setting('toggle_main_menu') ? menu_main_menu() : array();
2558  $variables['secondary_menu']    = theme_get_setting('toggle_secondary_menu') ? menu_secondary_menu() : array();
2559  $variables['action_links']      = menu_local_actions();
2560  $variables['site_name']         = (theme_get_setting('toggle_name') ? filter_xss_admin(variable_get('site_name', 'Drupal')) : '');
2561  $variables['site_slogan']       = (theme_get_setting('toggle_slogan') ? filter_xss_admin(variable_get('site_slogan', '')) : '');
2562  $variables['tabs']              = menu_local_tabs();
2563
2564  if ($node = menu_get_object()) {
2565    $variables['node'] = $node;
2566  }
2567
2568  // Populate the page template suggestions.
2569  if ($suggestions = theme_get_suggestions(arg(), 'page')) {
2570    $variables['theme_hook_suggestions'] = $suggestions;
2571  }
2572}
2573
2574/**
2575 * Process variables for page.tpl.php
2576 *
2577 * Perform final addition of variables before passing them into the template.
2578 * To customize these variables, simply set them in an earlier step.
2579 *
2580 * @see template_preprocess_page()
2581 * @see page.tpl.php
2582 */
2583function template_process_page(&$variables) {
2584  if (!isset($variables['breadcrumb'])) {
2585    // Build the breadcrumb last, so as to increase the chance of being able to
2586    // re-use the cache of an already rendered menu containing the active link
2587    // for the current page.
2588    // @see menu_tree_page_data()
2589    $variables['breadcrumb'] = theme('breadcrumb', array('breadcrumb' => drupal_get_breadcrumb()));
2590  }
2591  if (!isset($variables['title'])) {
2592    $variables['title'] = drupal_get_title();
2593  }
2594
2595  // Generate messages last in order to capture as many as possible for the
2596  // current page.
2597  if (!isset($variables['messages'])) {
2598    $variables['messages'] = $variables['show_messages'] ? theme('status_messages') : '';
2599  }
2600}
2601
2602/**
2603 * Process variables for html.tpl.php
2604 *
2605 * Perform final addition and modification of variables before passing into
2606 * the template. To customize these variables, call drupal_render() on elements
2607 * in $variables['page'] during THEME_preprocess_page().
2608 *
2609 * @see template_preprocess_html()
2610 * @see html.tpl.php
2611 */
2612function template_process_html(&$variables) {
2613  // Render page_top and page_bottom into top level variables.
2614  $variables['page_top'] = drupal_render($variables['page']['page_top']);
2615  $variables['page_bottom'] = drupal_render($variables['page']['page_bottom']);
2616  // Place the rendered HTML for the page body into a top level variable.
2617  $variables['page']              = $variables['page']['#children'];
2618  $variables['page_bottom'] .= drupal_get_js('footer');
2619
2620  $variables['head']    = drupal_get_html_head();
2621  $variables['css']     = drupal_add_css();
2622  $variables['styles']  = drupal_get_css();
2623  $variables['scripts'] = drupal_get_js();
2624}
2625
2626/**
2627 * Generate an array of suggestions from path arguments.
2628 *
2629 * This is typically called for adding to the 'theme_hook_suggestions' or
2630 * 'classes_array' variables from within preprocess functions, when wanting to
2631 * base the additional suggestions on the path of the current page.
2632 *
2633 * @param $args
2634 *   An array of path arguments, such as from function arg().
2635 * @param $base
2636 *   A string identifying the base 'thing' from which more specific suggestions
2637 *   are derived. For example, 'page' or 'html'.
2638 * @param $delimiter
2639 *   The string used to delimit increasingly specific information. The default
2640 *   of '__' is appropriate for theme hook suggestions. '-' is appropriate for
2641 *   extra classes.
2642 *
2643 * @return
2644 *   An array of suggestions, suitable for adding to
2645 *   $variables['theme_hook_suggestions'] within a preprocess function or to
2646 *   $variables['classes_array'] if the suggestions represent extra CSS classes.
2647 */
2648function theme_get_suggestions($args, $base, $delimiter = '__') {
2649
2650  // Build a list of suggested theme hooks or body classes in order of
2651  // specificity. One suggestion is made for every element of the current path,
2652  // though numeric elements are not carried to subsequent suggestions. For
2653  // example, for $base='page', http://www.example.com/node/1/edit would result
2654  // in the following suggestions and body classes:
2655  //
2656  // page__node              page-node
2657  // page__node__%           page-node-%
2658  // page__node__1           page-node-1
2659  // page__node__edit        page-node-edit
2660
2661  $suggestions = array();
2662  $prefix = $base;
2663  foreach ($args as $arg) {
2664    // Remove slashes or null per SA-CORE-2009-003 and change - (hyphen) to _
2665    // (underscore).
2666    //
2667    // When we discover templates in @see drupal_find_theme_templates,
2668    // hyphens (-) are converted to underscores (_) before the theme hook
2669    // is registered. We do this because the hyphens used for delimiters
2670    // in hook suggestions cannot be used in the function names of the
2671    // associated preprocess functions. Any page templates designed to be used
2672    // on paths that contain a hyphen are also registered with these hyphens
2673    // converted to underscores so here we must convert any hyphens in path
2674    // arguments to underscores here before fetching theme hook suggestions
2675    // to ensure the templates are appropriately recognized.
2676    $arg = str_replace(array("/", "\\", "\0", '-'), array('', '', '', '_'), $arg);
2677    // The percent acts as a wildcard for numeric arguments since
2678    // asterisks are not valid filename characters on many filesystems.
2679    if (is_numeric($arg)) {
2680      $suggestions[] = $prefix . $delimiter . '%';
2681    }
2682    $suggestions[] = $prefix . $delimiter . $arg;
2683    if (!is_numeric($arg)) {
2684      $prefix .= $delimiter . $arg;
2685    }
2686  }
2687  if (drupal_is_front_page()) {
2688    // Front templates should be based on root only, not prefixed arguments.
2689    $suggestions[] = $base . $delimiter . 'front';
2690  }
2691
2692  return $suggestions;
2693}
2694
2695/**
2696 * Process variables for maintenance-page.tpl.php.
2697 *
2698 * The variables array generated here is a mirror of
2699 * template_preprocess_page(). This preprocessor will run its course when
2700 * theme_maintenance_page() is invoked. An alternate template file of
2701 * maintenance-page--offline.tpl.php can be used when the database is offline to
2702 * hide errors and completely replace the content.
2703 *
2704 * The $variables array contains the following arguments:
2705 * - $content
2706 *
2707 * @see maintenance-page.tpl.php
2708 */
2709function template_preprocess_maintenance_page(&$variables) {
2710  // Add favicon
2711  if (theme_get_setting('toggle_favicon')) {
2712    $favicon = theme_get_setting('favicon');
2713    $type = theme_get_setting('favicon_mimetype');
2714    drupal_add_html_head_link(array('rel' => 'shortcut icon', 'href' => drupal_strip_dangerous_protocols($favicon), 'type' => $type));
2715  }
2716
2717  global $theme;
2718  // Retrieve the theme data to list all available regions.
2719  $theme_data = list_themes();
2720  $regions = $theme_data[$theme]->info['regions'];
2721
2722  // Get all region content set with drupal_add_region_content().
2723  foreach (array_keys($regions) as $region) {
2724    // Assign region to a region variable.
2725    $region_content = drupal_get_region_content($region);
2726    isset($variables[$region]) ? $variables[$region] .= $region_content : $variables[$region] = $region_content;
2727  }
2728
2729  // Setup layout variable.
2730  $variables['layout'] = 'none';
2731  if (!empty($variables['sidebar_first'])) {
2732    $variables['layout'] = 'first';
2733  }
2734  if (!empty($variables['sidebar_second'])) {
2735    $variables['layout'] = ($variables['layout'] == 'first') ? 'both' : 'second';
2736  }
2737
2738  // Construct page title
2739  if (drupal_get_title()) {
2740    $head_title = array(
2741      'title' => strip_tags(drupal_get_title()),
2742      'name' => variable_get('site_name', 'Drupal'),
2743    );
2744  }
2745  else {
2746    $head_title = array('name' => variable_get('site_name', 'Drupal'));
2747    if (variable_get('site_slogan', '')) {
2748      $head_title['slogan'] = variable_get('site_slogan', '');
2749    }
2750  }
2751
2752  // set the default language if necessary
2753  $language = isset($GLOBALS['language']) ? $GLOBALS['language'] : language_default();
2754
2755  $variables['head_title_array']  = $head_title;
2756  $variables['head_title']        = implode(' | ', $head_title);
2757  $variables['base_path']         = base_path();
2758  $variables['front_page']        = url();
2759  $variables['breadcrumb']        = '';
2760  $variables['feed_icons']        = '';
2761  $variables['help']              = '';
2762  $variables['language']          = $language;
2763  $variables['language']->dir     = $language->direction ? 'rtl' : 'ltr';
2764  $variables['logo']              = theme_get_setting('logo');
2765  $variables['messages']          = $variables['show_messages'] ? theme('status_messages') : '';
2766  $variables['main_menu']         = array();
2767  $variables['secondary_menu']    = array();
2768  $variables['site_name']         = (theme_get_setting('toggle_name') ? variable_get('site_name', 'Drupal') : '');
2769  $variables['site_slogan']       = (theme_get_setting('toggle_slogan') ? variable_get('site_slogan', '') : '');
2770  $variables['tabs']              = '';
2771  $variables['title']             = drupal_get_title();
2772
2773  // Compile a list of classes that are going to be applied to the body element.
2774  $variables['classes_array'][] = 'in-maintenance';
2775  if (isset($variables['db_is_active']) && !$variables['db_is_active']) {
2776    $variables['classes_array'][] = 'db-offline';
2777  }
2778  if ($variables['layout'] == 'both') {
2779    $variables['classes_array'][] = 'two-sidebars';
2780  }
2781  elseif ($variables['layout'] == 'none') {
2782    $variables['classes_array'][] = 'no-sidebars';
2783  }
2784  else {
2785    $variables['classes_array'][] = 'one-sidebar sidebar-' . $variables['layout'];
2786  }
2787
2788  // Dead databases will show error messages so supplying this template will
2789  // allow themers to override the page and the content completely.
2790  if (isset($variables['db_is_active']) && !$variables['db_is_active']) {
2791    $variables['theme_hook_suggestion'] = 'maintenance_page__offline';
2792  }
2793}
2794
2795/**
2796 * Theme process function for theme_maintenance_field().
2797 *
2798 * The variables array generated here is a mirror of template_process_html().
2799 * This processor will run its course when theme_maintenance_page() is invoked.
2800 *
2801 * @see maintenance-page.tpl.php
2802 * @see template_process_html()
2803 */
2804function template_process_maintenance_page(&$variables) {
2805  $variables['head']    = drupal_get_html_head();
2806  $variables['css']     = drupal_add_css();
2807  $variables['styles']  = drupal_get_css();
2808  $variables['scripts'] = drupal_get_js();
2809}
2810
2811/**
2812 * Preprocess variables for region.tpl.php
2813 *
2814 * Prepares the values passed to the theme_region function to be passed into a
2815 * pluggable template engine. Uses the region name to generate a template file
2816 * suggestions. If none are found, the default region.tpl.php is used.
2817 *
2818 * @see drupal_region_class()
2819 * @see region.tpl.php
2820 */
2821function template_preprocess_region(&$variables) {
2822  // Create the $content variable that templates expect.
2823  $variables['content'] = $variables['elements']['#children'];
2824  $variables['region'] = $variables['elements']['#region'];
2825
2826  $variables['classes_array'][] = drupal_region_class($variables['region']);
2827  $variables['theme_hook_suggestions'][] = 'region__' . $variables['region'];
2828}
2829
2830/**
2831 * Preprocesses variables for theme_username().
2832 *
2833 * Modules that make any changes to variables like 'name' or 'extra' must insure
2834 * that the final string is safe to include directly in the output by using
2835 * check_plain() or filter_xss().
2836 *
2837 * @see template_process_username()
2838 */
2839function template_preprocess_username(&$variables) {
2840  $account = $variables['account'];
2841
2842  $variables['extra'] = '';
2843  if (empty($account->uid)) {
2844   $variables['uid'] = 0;
2845   if (theme_get_setting('toggle_comment_user_verification')) {
2846     $variables['extra'] = ' (' . t('not verified') . ')';
2847   }
2848  }
2849  else {
2850    $variables['uid'] = (int) $account->uid;
2851  }
2852
2853  // Set the name to a formatted name that is safe for printing and
2854  // that won't break tables by being too long. Keep an unshortened,
2855  // unsanitized version, in case other preprocess functions want to implement
2856  // their own shortening logic or add markup. If they do so, they must ensure
2857  // that $variables['name'] is safe for printing.
2858  $name = $variables['name_raw'] = format_username($account);
2859  if (drupal_strlen($name) > 20) {
2860    $name = drupal_substr($name, 0, 15) . '...';
2861  }
2862  $variables['name'] = check_plain($name);
2863
2864  $variables['profile_access'] = user_access('access user profiles');
2865  $variables['link_attributes'] = array();
2866  // Populate link path and attributes if appropriate.
2867  if ($variables['uid'] && $variables['profile_access']) {
2868    // We are linking to a local user.
2869    $variables['link_attributes'] = array('title' => t('View user profile.'));
2870    $variables['link_path'] = 'user/' . $variables['uid'];
2871  }
2872  elseif (!empty($account->homepage)) {
2873    // Like the 'class' attribute, the 'rel' attribute can hold a
2874    // space-separated set of values, so initialize it as an array to make it
2875    // easier for other preprocess functions to append to it.
2876    $variables['link_attributes'] = array('rel' => array('nofollow'));
2877    $variables['link_path'] = $account->homepage;
2878    $variables['homepage'] = $account->homepage;
2879  }
2880  // We do not want the l() function to check_plain() a second time.
2881  $variables['link_options']['html'] = TRUE;
2882  // Set a default class.
2883  $variables['attributes_array'] = array('class' => array('username'));
2884}
2885
2886/**
2887 * Processes variables for theme_username().
2888 *
2889 * @see template_preprocess_username()
2890 */
2891function template_process_username(&$variables) {
2892  // Finalize the link_options array for passing to the l() function.
2893  // This is done in the process phase so that attributes may be added by
2894  // modules or the theme during the preprocess phase.
2895  if (isset($variables['link_path'])) {
2896    // $variables['attributes_array'] contains attributes that should be applied
2897    // regardless of whether a link is being rendered or not.
2898    // $variables['link_attributes'] contains attributes that should only be
2899    // applied if a link is being rendered. Preprocess functions are encouraged
2900    // to use the former unless they want to add attributes on the link only.
2901    // If a link is being rendered, these need to be merged. Some attributes are
2902    // themselves arrays, so the merging needs to be recursive.
2903    $variables['link_options']['attributes'] = array_merge_recursive($variables['link_attributes'], $variables['attributes_array']);
2904  }
2905}