Issue #624058: Replace _zen_path() with drupal_get_path('theme', 'zen')
[project/zen.git] / template.php
index f192abc..ea89406 100644 (file)
@@ -1,6 +1,4 @@
 <?php
-// $Id$
-
 /**
  * @file
  * Contains theme override functions and preprocess functions for the Zen theme.
@@ -49,11 +47,12 @@ function zen_breadcrumb($breadcrumb) {
 
     // Return the breadcrumb with separators.
     if (!empty($breadcrumb)) {
-      $breadcrumb_separator = theme_get_setting('zen_breadcrumb_separator');
+      $breadcrumb_separator = filter_xss_admin(theme_get_setting('zen_breadcrumb_separator'));
       $trailing_separator = $title = '';
       if (theme_get_setting('zen_breadcrumb_title')) {
-        $trailing_separator = $breadcrumb_separator;
-        $title = drupal_get_title();
+        if ($title = drupal_get_title()) {
+          $trailing_separator = $breadcrumb_separator;
+        }
       }
       elseif (theme_get_setting('zen_breadcrumb_trailing')) {
         $trailing_separator = $breadcrumb_separator;
@@ -66,6 +65,102 @@ function zen_breadcrumb($breadcrumb) {
 }
 
 /**
+ * Return a themed set of links.
+ *
+ * @param $links
+ *   A keyed array of links to be themed.
+ * @param $attributes
+ *   A keyed array of attributes
+ * @param $heading
+ *   An optional keyed array or a string for a heading to precede the links.
+ *   When using an array the following keys can be used:
+ *     - text: the heading text
+ *     - level: the heading level (e.g. 'h2', 'h3')
+ *     - class: (optional) a string of the CSS classes for the heading
+ *   When using a string it will be used as the text of the heading and the
+ *   level will default to 'h2'.
+ *   Headings should be used on navigation menus and any list of links that
+ *   consistently appears on multiple pages. To make the heading invisible
+ *   use the 'element-invisible' CSS class. Do not use 'display:none', which
+ *   removes it from screen-readers and assistive technology. Headings allow
+ *   screen-reader and keyboard only users to navigate to or skip the links.
+ *   See http://juicystudio.com/article/screen-readers-display-none.php
+ *   and http://www.w3.org/TR/WCAG-TECHS/H42.html for more information.
+ * @return
+ *   A string containing an unordered list of links.
+ */
+function zen_links($links, $attributes = array('class' => 'links'), $heading = '') {
+  global $language;
+  $output = '';
+
+  if (count($links) > 0) {
+    // Treat the heading first if it is present to prepend it to the
+    // list of links.
+    if (!empty($heading)) {
+      if (is_string($heading)) {
+        // Prepare the array that will be used when the passed heading
+        // is a string.
+        $heading = array(
+          'text' => $heading,
+          // Set the default level of the heading.
+          'level' => 'h2',
+        );
+      }
+      $output .= '<' . $heading['level'];
+      if (!empty($heading['class'])) {
+        $output .= drupal_attributes(array('class' => $heading['class']));
+      }
+      $output .= '>' . check_plain($heading['text']) . '</' . $heading['level'] . '>';
+    }
+
+    $output .= '<ul'. drupal_attributes($attributes) .'>';
+
+    $num_links = count($links);
+    $i = 1;
+
+    foreach ($links as $key => $link) {
+      $class = $key;
+
+      // Add first, last and active classes to the list of links to help out themers.
+      if ($i == 1) {
+        $class .= ' first';
+      }
+      if ($i == $num_links) {
+        $class .= ' last';
+      }
+      if (isset($link['href']) && ($link['href'] == $_GET['q'] || ($link['href'] == '<front>' && drupal_is_front_page()))
+          && (empty($link['language']) || $link['language']->language == $language->language)) {
+        $class .= ' active';
+      }
+      $output .= '<li'. drupal_attributes(array('class' => $class)) .'>';
+
+      if (isset($link['href'])) {
+        // Pass in $link as $options, they share the same keys.
+        $output .= l($link['title'], $link['href'], $link);
+      }
+      else if (!empty($link['title'])) {
+        // Some links are actually not links, but we wrap these in <span> for adding title and class attributes
+        if (empty($link['html'])) {
+          $link['title'] = check_plain($link['title']);
+        }
+        $span_attributes = '';
+        if (isset($link['attributes'])) {
+          $span_attributes = drupal_attributes($link['attributes']);
+        }
+        $output .= '<span'. $span_attributes .'>'. $link['title'] .'</span>';
+      }
+
+      $i++;
+      $output .= "</li>\n";
+    }
+
+    $output .= '</ul>';
+  }
+
+  return $output;
+}
+
+/**
  * Implements theme_menu_item_link()
  */
 function zen_menu_item_link($link) {
@@ -83,16 +178,27 @@ function zen_menu_item_link($link) {
 }
 
 /**
- * Duplicate of theme_menu_local_tasks() but adds clear-block to tabs.
+ * Duplicate of theme_menu_local_tasks() but adds clearfix to tabs.
  */
 function zen_menu_local_tasks() {
   $output = '';
 
-  if ($primary = menu_primary_local_tasks()) {
-    $output .= '<ul class="tabs primary clear-block">' . $primary . '</ul>';
+  // CTools requires a different set of local task functions.
+  if (module_exists('ctools')) {
+    ctools_include('menu');
+    $primary = ctools_menu_primary_local_tasks();
+    $secondary = ctools_menu_secondary_local_tasks();
   }
-  if ($secondary = menu_secondary_local_tasks()) {
-    $output .= '<ul class="tabs secondary clear-block">' . $secondary . '</ul>';
+  else {
+    $primary = menu_primary_local_tasks();
+    $secondary = menu_secondary_local_tasks();
+  }
+
+  if ($primary) {
+    $output .= '<ul class="tabs primary clearfix">' . $primary . '</ul>';
+  }
+  if ($secondary) {
+    $output .= '<ul class="tabs secondary clearfix">' . $secondary . '</ul>';
   }
 
   return $output;
@@ -103,26 +209,73 @@ function zen_menu_local_tasks() {
  *
  * @param $region
  *   Which set of blocks to retrieve.
+ * @param $show_blocks
+ *   A boolean to determine whether to render sidebar regions or not. Should be
+ *   the same value as passed to theme_page.
  * @return
  *   A string containing the themed blocks for this region.
+ *
+ * @see zen_show_blocks_discovery()
  */
-function zen_blocks($region) {
-  $output = '';
+function zen_blocks($region, $show_blocks = NULL) {
+  // Since Drupal 6 doesn't pass $show_blocks to theme_blocks, we manually call
+  // theme('blocks', NULL, $show_blocks) so that this function can remember the
+  // value on later calls.
+  static $render_sidebars = TRUE;
+  if (!is_null($show_blocks)) {
+    $render_sidebars = $show_blocks;
+  }
 
-  if ($list = block_list($region)) {
-    foreach ($list as $key => $block) {
-      // $key == module_delta
-      $output .= theme('block', $block);
+  // If zen_blocks was called with a NULL region, its likely we were just
+  // setting the $render_sidebars static variable.
+  if ($region) {
+    $output = '';
+
+    // If $renders_sidebars is FALSE, don't render any region whose name begins
+    // with "sidebar_".
+    if ($render_sidebars || (strpos($region, 'sidebar_') !== 0)) {
+      // Allow context module to set blocks.
+      if (function_exists('context_blocks')) {
+        $output = context_blocks($region);
+      }
+      else {
+        foreach (block_list($region) as $key => $block) {
+          // $key == module_delta
+          $output .= theme('block', $block);
+        }
+      }
     }
-  }
 
-  // Add any content assigned to this region through drupal_set_content() calls.
-  $output .= drupal_get_content($region);
+    // Add any content assigned to this region through drupal_set_content() calls.
+    $output .= drupal_get_content($region);
 
-  $elements['#children'] = $output;
-  $elements['#region'] = $region;
+    $elements['#children'] = $output;
+    $elements['#region'] = $region;
 
-  return $output ? theme('region', $elements) : '';
+    // Set the theme hook suggestions.
+    $hook = array('region_' . $region);
+    if (strpos($region, 'sidebar_') === 0) {
+      $hook[] = 'region_sidebar';
+    }
+    $hook[] = 'region';
+    return $output ? theme($hook, $elements) : '';
+  }
+}
+
+/**
+ * Examine the $show_blocks variable before template_preprocess_page() is called.
+ *
+ * @param $vars
+ *   An array of variables to pass to the page template.
+ *
+ * @see zen_blocks()
+ */
+function zen_show_blocks_discovery(&$vars) {
+  if ($vars['show_blocks'] == FALSE) {
+    // Allow zen_blocks() to statically cache the $show_blocks variable. A TRUE
+    // value is assumed, so we only need to override when $show_blocks is FALSE.
+    theme('blocks', NULL, FALSE);
+  }
 }
 
 /**
@@ -142,13 +295,17 @@ function zen_preprocess(&$vars, $hook) {
     // Views (and possibly other modules) have templates with a $classes
     // variable that isn't a string, so we leave those variables alone.
     if (is_string($vars[$key])) {
-      $vars['classes_array'] = explode(' ', $vars[$key]);
+      $vars['classes_array'] = explode(' ', $hook . ' ' . $vars[$key]);
       unset($vars[$key]);
     }
   }
   else {
     $vars['classes_array'] = array($hook);
   }
+  // Add support for Skinr
+  if (!empty($vars['skinr']) && array_key_exists('classes_array', $vars)) {
+    $vars['classes_array'][] = $vars['skinr'];
+  }
 }
 
 /**
@@ -167,7 +324,9 @@ function zen_preprocess_page(&$vars, $hook) {
   }
   // Add conditional stylesheets.
   elseif (!module_exists('conditional_styles')) {
-    $vars['styles'] .= $vars['conditional_styles'] = variable_get('conditional_styles_' . $GLOBALS['theme'], '');
+    $language = $GLOBALS['language']->direction == LANGUAGE_RTL ? '_rtl' : '';
+    $vars['conditional_styles'] = variable_get('conditional_styles_' . $GLOBALS['theme'] . $language, '');
+    $vars['styles'] .= $vars['conditional_styles'];
   }
 
   // Classes for body element. Allows advanced theming based on context
@@ -179,7 +338,7 @@ function zen_preprocess_page(&$vars, $hook) {
   if (!$vars['is_front']) {
     // Add unique class for each page.
     $path = drupal_get_path_alias($_GET['q']);
-    $vars['classes_array'][] = zen_id_safe('page-' . $path);
+    $vars['classes_array'][] = drupal_html_class('page-' . $path);
     // Add unique class for each website section.
     list($section, ) = explode('/', $path, 2);
     if (arg(0) == 'node') {
@@ -190,20 +349,49 @@ function zen_preprocess_page(&$vars, $hook) {
         $section = 'node-' . arg(2);
       }
     }
-    $vars['classes_array'][] = zen_id_safe('section-' . $section);
+    $vars['classes_array'][] = drupal_html_class('section-' . $section);
   }
   if (theme_get_setting('zen_wireframes')) {
     $vars['classes_array'][] = 'with-wireframes'; // Optionally add the wireframes style.
   }
-  // Add new sidebar classes in addition to Drupal core's sidebar-* classes.
-  // This provides some backwards compatibility with Zen 6.x-1.x themes.
-  if ($vars['layout'] != 'both') {
-    $new_layout = ($vars['layout'] == 'left') ? 'first' : 'second';
-    if (array_search('sidebar-' . $vars['layout'], $vars['classes_array'])) {
-      $vars['classes_array'][] = 'sidebar-' . $new_layout;
+  // We need to re-do the $layout and body classes because
+  // template_preprocess_page() assumes sidebars are named 'left' and 'right'.
+  $vars['layout'] = 'none';
+  if (!empty($vars['sidebar_first'])) {
+    $vars['layout'] = 'first';
+  }
+  if (!empty($vars['sidebar_second'])) {
+    $vars['layout'] = ($vars['layout'] == 'first') ? 'both' : 'second';
+  }
+  // If the layout is 'none', then template_preprocess_page() will already have
+  // set a 'no-sidebars' class since it won't find a 'left' or 'right' sidebar.
+  if ($vars['layout'] != 'none') {
+    // Remove the incorrect 'no-sidebars' class.
+    if ($index = array_search('no-sidebars', $vars['classes_array'])) {
+      unset($vars['classes_array'][$index]);
+    }
+    // Set the proper layout body classes.
+    if ($vars['layout'] == 'both') {
+      $vars['classes_array'][] = 'two-sidebars';
+    }
+    else {
+      $vars['classes_array'][] = 'one-sidebar';
+      $vars['classes_array'][] = 'sidebar-' . $vars['layout'];
     }
-    // Replace core's $layout variable with our naming of sidebars.
-    $vars['layout'] = $new_layout;
+  }
+  // Store the menu item since it has some useful information.
+  $vars['menu_item'] = menu_get_item();
+  switch ($vars['menu_item']['page_callback']) {
+    case 'views_page':
+      // Is this a Views page?
+      $vars['classes_array'][] = 'page-views';
+      break;
+    case 'page_manager_page_execute':
+    case 'page_manager_node_view':
+    case 'page_manager_contact_site':
+      // Is this a Panels page?
+      $vars['classes_array'][] = 'page-panels';
+      break;
   }
 }
 
@@ -223,12 +411,10 @@ function zen_preprocess_maintenance_page(&$vars, $hook) {
   }
   // Add conditional stylesheets.
   elseif (!module_exists('conditional_styles')) {
-    $vars['styles'] .= $vars['conditional_styles'] = variable_get('conditional_styles_' . $GLOBALS['theme'], '');
+    $language = $GLOBALS['language']->direction == LANGUAGE_RTL ? '_rtl' : '';
+    $vars['conditional_styles'] = variable_get('conditional_styles_' . $GLOBALS['theme'] . $language, '');
+    $vars['styles'] .= $vars['conditional_styles'];
   }
-
-  // Classes for body element. Allows advanced theming based on context
-  // (home page, node of certain type, etc.)
-  $vars['body_classes_array'] = explode(' ', $vars['body_classes']);
 }
 
 /**
@@ -243,7 +429,12 @@ function zen_preprocess_node(&$vars, $hook) {
   // Create the build_mode variable.
   switch ($vars['node']->build_mode) {
     case NODE_BUILD_NORMAL:
-      $vars['build_mode'] = $vars['teaser'] ? 'teaser' : 'full';
+      if ($vars['node']->build_mode === NODE_BUILD_NORMAL) {
+        $vars['build_mode'] = $vars['teaser'] ? 'teaser' : 'full';
+      }
+      else {
+        $vars['build_mode'] = $vars['node']->build_mode;
+      }
       break;
     case NODE_BUILD_PREVIEW:
       $vars['build_mode'] = 'preview';
@@ -260,6 +451,8 @@ function zen_preprocess_node(&$vars, $hook) {
     case NODE_BUILD_PRINT:
       $vars['build_mode'] = 'print';
       break;
+    default:
+      $vars['build_mode'] = $vars['node']->build_mode;
   }
 
   // Create the user_picture variable.
@@ -270,7 +463,7 @@ function zen_preprocess_node(&$vars, $hook) {
 
   // Special classes for nodes.
   // Class for node type: "node-type-page", "node-type-story", "node-type-my-custom-type", etc.
-  $vars['classes_array'][] = zen_id_safe('node-type-' . $vars['type']);
+  $vars['classes_array'][] = drupal_html_class('node-type-' . $vars['type']);
   if ($vars['promote']) {
     $vars['classes_array'][] = 'node-promoted';
   }
@@ -285,7 +478,7 @@ function zen_preprocess_node(&$vars, $hook) {
     $vars['unpublished'] = FALSE;
   }
   if ($vars['uid'] && $vars['uid'] == $GLOBALS['user']->uid) {
-    $vars['classes_array'][] = 'node-mine'; // Node is authored by current user.
+    $vars['classes_array'][] = 'node-by-viewer'; // Node is authored by current user.
   }
   if ($vars['teaser']) {
     $vars['classes_array'][] = 'node-teaser'; // Node is displayed as teaser.
@@ -293,6 +486,7 @@ function zen_preprocess_node(&$vars, $hook) {
   if (isset($vars['preview'])) {
     $vars['classes_array'][] = 'node-preview';
   }
+  $vars['classes_array'][] = 'build-mode-' . $vars['build_mode'] ;
 }
 
 /**
@@ -312,8 +506,7 @@ function zen_preprocess_comment(&$vars, $hook) {
  * Preprocess variables for region.tpl.php
  *
  * Prepare the values passed to the theme_region function to be passed into a
- * pluggable template engine. Uses the region name to generate a template file
- * suggestions. If none are found, the default region.tpl.php is used.
+ * pluggable template engine.
  *
  * @see region.tpl.php
  */
@@ -322,12 +515,14 @@ function zen_preprocess_region(&$vars, $hook) {
   $vars['content'] = $vars['elements']['#children'];
   $vars['region'] = $vars['elements']['#region'];
 
-  $region = 'region-' . str_replace('_', '-', $vars['region']);
-  $vars['classes_array'] = array('region', $region);
-  if ($vars['region'] == 'navbar') {
-    $vars['classes_array'][] = 'clearfix';
+  // Setup the default classes.
+  $vars['classes_array'] = array('region', 'region-' . str_replace('_', '-', $vars['region']));
+
+  // Sidebar regions get a couple extra classes.
+  if (strpos($vars['region'], 'sidebar_') === 0) {
+    $vars['classes_array'][] = 'column';
+    $vars['classes_array'][] = 'sidebar';
   }
-  $vars['template_files'][] = $region;
 }
 
 /**
@@ -348,11 +543,21 @@ function zen_preprocess_block(&$vars, $hook) {
 
   // Special classes for blocks.
   $vars['classes_array'][] = 'block-' . $block->module;
+  // Classes describing the position of the block within the region.
+  if ($vars['block_id'] == 1) {
+    $vars['classes_array'][] = 'first';
+  }
+  if (!function_exists('context_blocks') && count(block_list($vars['block']->region)) == $vars['block_id']) {
+    $vars['classes_array'][] = 'last';
+  }
   $vars['classes_array'][] = 'region-' . $vars['block_zebra'];
   $vars['classes_array'][] = $vars['zebra'];
   $vars['classes_array'][] = 'region-count-' . $vars['block_id'];
   $vars['classes_array'][] = 'count-' . $vars['id'];
 
+  // Create the block ID.
+  $vars['block_html_id'] = 'block-' . $block->module . '-' . $block->delta;
+
   $vars['edit_links_array'] = array();
   if (theme_get_setting('zen_block_editing') && user_access('administer blocks')) {
     include_once './' . _zen_path() . '/zen-internals/template.block-editing.inc';
@@ -370,7 +575,8 @@ function zen_preprocess_block(&$vars, $hook) {
  *   The name of the template being rendered.
  */
 function zen_process(&$vars, $hook) {
-  if (array_key_exists('classes_array', $vars)) {
+  // Don't clobber Views 3 classes.
+  if (array_key_exists('classes_array', $vars) && !array_key_exists('classes', $vars)) {
     $vars['classes'] = implode(' ', $vars['classes_array']);
   }
 }
@@ -387,30 +593,62 @@ function zen_process_block(&$vars, $hook) {
   $vars['edit_links'] = !empty($vars['edit_links_array']) ? '<div class="edit">' . implode(' ', $vars['edit_links_array']) . '</div>' : '';
 }
 
-/**
- * Converts a string to a suitable html ID attribute.
- *
- * http://www.w3.org/TR/html4/struct/global.html#h-7.5.2 specifies what makes a
- * valid ID attribute in HTML. This function:
- *
- * - Ensure an ID starts with an alpha character by optionally adding an 'id'.
- * - Replaces any character except alphanumeric characters with dashes.
- * - Converts entire string to lowercase.
- *
- * @param $string
- *   The string
- * @return
- *   The converted string
- */
-function zen_id_safe($string) {
-  // Replace with dashes anything that isn't A-Z, numbers, dashes, or underscores.
-  $string = strtolower(preg_replace('/[^a-zA-Z0-9-]+/', '-', $string));
-  // If the first character is not a-z, add 'id' in front.
-  if (!ctype_lower($string{0})) { // Don't use ctype_alpha since its locale aware.
-    $string = 'id' . $string;
-  }
-  return $string;
-}
+if (!function_exists('drupal_html_class')) {
+  /**
+   * Prepare a string for use as a valid class name.
+   *
+   * Do not pass one string containing multiple classes as they will be
+   * incorrectly concatenated with dashes, i.e. "one two" will become "one-two".
+   *
+   * @param $class
+   *   The class name to clean.
+   * @return
+   *   The cleaned class name.
+   */
+  function drupal_html_class($class) {
+    // By default, we filter using Drupal's coding standards.
+    $class = strtr(drupal_strtolower($class), array(' ' => '-', '_' => '-', '/' => '-', '[' => '-', ']' => ''));
+
+    // http://www.w3.org/TR/CSS21/syndata.html#characters shows the syntax for valid
+    // CSS identifiers (including element names, classes, and IDs in selectors.)
+    //
+    // Valid characters in a CSS identifier are:
+    // - the hyphen (U+002D)
+    // - a-z (U+0030 - U+0039)
+    // - A-Z (U+0041 - U+005A)
+    // - the underscore (U+005F)
+    // - 0-9 (U+0061 - U+007A)
+    // - ISO 10646 characters U+00A1 and higher
+    // We strip out any character not in the above list.
+    $class = preg_replace('/[^\x{002D}\x{0030}-\x{0039}\x{0041}-\x{005A}\x{005F}\x{0061}-\x{007A}\x{00A1}-\x{FFFF}]/u', '', $class);
+
+    return $class;
+  }
+} /* End of drupal_html_class conditional definition. */
+
+if (!function_exists('drupal_html_id')) {
+  /**
+   * Prepare a string for use as a valid HTML ID and guarantee uniqueness.
+   *
+   * @param $id
+   *   The ID to clean.
+   * @return
+   *   The cleaned ID.
+   */
+  function drupal_html_id($id) {
+    $id = strtr(drupal_strtolower($id), array(' ' => '-', '_' => '-', '[' => '-', ']' => ''));
+
+    // As defined in http://www.w3.org/TR/html4/types.html#type-name, HTML IDs can
+    // only contain letters, digits ([0-9]), hyphens ("-"), underscores ("_"),
+    // colons (":"), and periods ("."). We strip out any character not in that
+    // list. Note that the CSS spec doesn't allow colons or periods in identifiers
+    // (http://www.w3.org/TR/CSS21/syndata.html#characters), so we strip those two
+    // characters as well.
+    $id = preg_replace('/[^A-Za-z0-9\-_]/', '', $id);
+
+    return $id;
+  }
+} /* End of drupal_html_id conditional definition. */
 
 /**
  * Returns the path to the Zen theme.
@@ -421,9 +659,14 @@ function zen_id_safe($string) {
 function _zen_path() {
   static $path = FALSE;
   if (!$path) {
-    $matches = drupal_system_listing('zen\.info$', 'themes', 'name', 0);
-    if (!empty($matches['zen']->filename)) {
-      $path = dirname($matches['zen']->filename);
+    if (db_is_active()) {
+      $path = drupal_get_path('theme', 'zen');
+    }
+    else {
+      $matches = drupal_system_listing('zen\.info$', 'themes', 'name', 0);
+      if (!empty($matches['zen']->filename)) {
+        $path = dirname($matches['zen']->filename);
+      }
     }
   }
   return $path;