theme_utils.module

<?php
/**
 * @file
 * A set of utilities to make theming a bit easier.
 */

/**
 * Implements hook_help().
 */
function theme_utils_help($path, $arg) {
  switch ($path) {
    case 'admin/config/user-interface/theme_utils':
      return '<p>' . t('Select the options below that you want enabled.') . '</p>';

    case 'admin/help#theme_utils':
      $output = '';
      $output .= '<p>' . t('Various utilities that make theming a bit easier.') . '</p>';
      return $output;
  }
}

/**
 * Implements hook_menu().
 */
function theme_utils_menu() {
  $items['admin/config/user-interface/theme_utils'] = array(
    'title' => 'Theme Utils',
    'description' => 'Configure settings for Theme Utils.',
    'page callback' => 'drupal_get_form',
    'page arguments' => array('theme_utils_settings'),
    'access arguments' => array('administer site configuration'),
  );

  return $items;
}

/**
 * Implements hook_libraries_info().
 */
function theme_utils_libraries_info() {
  return array(
    'php-css-parser' => array(
      'name' => 'PHP CSS Parser',
      'vendor url' => 'https://github.com/sabberworm/PHP-CSS-Parser',
      'download url' => 'https://github.com/sabberworm/PHP-CSS-Parser/tags',
      'version' => '3.0.0',
      'xautoload' => function($api) {
        $api->namespaceRoot('Sabberworm\CSS', 'lib');
      },
    ),
  );
}

/**
 * Form builder function for module settings.
 */
function theme_utils_settings() {
  $form['theme_utils_block_title_class'] = array(
    '#type' => 'checkbox',
    '#title' => t('Block title to class'),
    '#default_value' => variable_get('theme_utils_block_title_class', TRUE),
    '#description' => t("Adds the block's title to the block's set of HTML classes. Useful when theming to quickly identify and target individual blocks."),
  );

  $form['theme_utils_block_id_class'] = array(
    '#type' => 'checkbox',
    '#title' => t('Block HTML ID to class'),
    '#default_value' => variable_get('theme_utils_block_id_class', TRUE),
    '#description' => t("Adds the block's HTML ID to the block's set of HTML classes. Useful when theming to quickly identify and target individual blocks."),
  );

  $form['theme_utils_region_body_class'] = array(
    '#type' => 'checkbox',
    '#title' => t('Regions to body class'),
    '#default_value' => variable_get('theme_utils_region_body_class', TRUE),
    '#description' => t("Adds the page's active regions to the body element's list of HTML classes."),
  );

  // Verify that namespaces are supported & that the library is installed.
  $disabled = FALSE;
  $error_msg = theme_utils_media_query_supported();
  if ($error_msg !== '') {
    $disabled = TRUE;
  }
  $form['theme_utils_media_query'] = array(
    '#type' => 'checkbox',
    '#disabled' => $disabled ? TRUE : FALSE,
    '#title' => t('Display @media query'),
    '#default_value' => variable_get('theme_utils_media_query', !$disabled),
    '#description' => t('Displays the active @media query in the browser window.') . '<br />' . $error_msg,
  );

  $form['theme_utils_viewport_dimensions'] = array(
    '#type' => 'checkbox',
    '#title' => t('Display viewport dimensions'),
    '#default_value' => variable_get('theme_utils_viewport_dimensions', TRUE),
    '#description' => t("Displays the viewport's dimensions in the browser window."),
  );

  $form['theme_utils_base_font_size'] = array(
    '#type' => 'textfield',
    '#title' => t('Base font size'),
    '#default_value' => variable_get('theme_utils_base_font_size', "16"),
    '#description' => t("Set to the base font size of your theme for proper viewport calculations."),
    '#maxlength' => 15,
    '#size' => 10,
    '#required' => TRUE,
    '#element_validate' => array('element_validate_number'),
  );

  return system_settings_form($form);
}

/**
 * Implements hook_preprocess_HOOK().
 *
 * Extend block's HTML classes with the block's title and/or ID.
 */
function theme_utils_preprocess_block(&$vars) {
  if ($setting = variable_get('theme_utils_block_title_class', TRUE)) {
    ctools_include('cleanstring', 'ctools', 'includes');

    $block = $vars['block'];

    // Use the block's title/subject if available,
    // otherwise use the delta value.
    if (strlen($block->subject) > 0) {
      $title = $block->subject;
    }
    else {
      $title = $block->delta;
    }

    // Remove any non-alphanumeric characters from title
    // and replace whitespace with hyphens.
    $title = ctools_cleanstring($title, array('lower case' => TRUE));

    // Add the block's module to the beginning of the class.
    $module = 'block-' . $block->module;

    $class[] = $module . '-' . $title;
  }

  if ($setting = variable_get('theme_utils_block_id_class', TRUE)) {
    $block = $vars['block'];

    // Use the HTML ID generated by block.module if available,
    // otherwise use the delta value.
    if (isset($vars['block_html_id']) && !empty($vars['block_html_id'])) {
      $class[] = $vars['block_html_id'];
    }
    else {
      $class[] = 'block-' . $block->module . '-' . $block->delta;
    }
  }

  if (isset($class)) {
    $vars['classes_array'] = array_merge($vars['classes_array'], $class);
  }
}

/**
 * Implements hook_preprocess_HOOK().
 *
 * Extend body's HTML classes with regions in use on a given page.
 */
function theme_utils_preprocess_html(&$vars) {
  if ($setting = variable_get('theme_utils_region_body_class', TRUE)) {
    if (isset($vars['page'])) {
      foreach ($vars['page'] as $region) {
        if (is_array($region) && isset($region['#region'])) {
          $vars['classes_array'][] = 'with-' . $region['#region'];
        }
      }
    }
  }
}

/**
 * Implements hook_page_build().
 *
 * Show the media query and/or the browser viewport dimensions.
 */
function theme_utils_page_build(&$page) {
  $setting = array();
  $should_attach = FALSE;

  // Media queries.
  if (variable_get('theme_utils_media_query', TRUE)) {
    if ($media_queries = theme_utils_get_media_queries()) {
      $css = '';
      $js = '';
      // Parse through each CSS file for the current page,
      // and extract all media queries.
      foreach ($media_queries as $idx => $query) {
        $css .= '@media ' . $query . ' { ';
        $css .= ' #theme-utils-media-query .query-' . $idx . ' { ';
        $css .= '  display: block; ';
        $css .= ' } ';
        $css .= '} ';

        $setting['themeUtils']['mediaQueries'][] = array(
          'itemNum' => $idx,
          'query' => $query,
        );
      }

      // Inject inline css into page.
      drupal_add_css($css, array('type' => 'inline', 'weight' => '9999'));
      $should_attach = TRUE;
    }
  }

  // Viewport dimensions.
  if (variable_get('theme_utils_viewport_dimensions', TRUE)) {
    $setting['themeUtils']['browserViewport'] = array(
      'show' => 'true',
    );
    $setting['themeUtils']['baseFontSize'] = array(
      'size' => variable_get('theme_utils_base_font_size', "16"),
    );
    $should_attach = TRUE;
  }

  // Only inject css/js if media queries and/or viewport dimensions should be
  // displayed.
  if ($should_attach) {
    $path = drupal_get_path('module', 'theme_utils');
    drupal_add_js($setting, 'setting');
    drupal_add_js($path . '/theme_utils.js', 'file');
    drupal_add_css($path . '/theme_utils.css', 'file');
  }
}

/**
 * Get all media queries from all stylesheets attached to the page.
 */
function theme_utils_get_media_queries() {
  // The css parser uses namespaces, which requires php 5.3.0 or higher.
  if (theme_utils_media_query_supported() == '') {
    $media_queries = array();

    // Use cache since scanning every css file is time consuming.
    $cid = 'theme_utils_media_queries/' . current_path();
    if ($cache = cache_get($cid, 'cache')) {
      $media_queries = $cache->data;
    }
    else {
      // Get all css files from current page.
      $css_files = theme_utils_get_css_files();

      foreach ($css_files as $file) {
        // Load each css file in parser.
        if (class_exists('Sabberworm\CSS\Parser')) {
          // Parser is autoloaded.
          $parser = new Sabberworm\CSS\Parser(file_get_contents(DRUPAL_ROOT . '/' . $file['data']));
          $doc = $parser->parse();
          $contents = $doc->getContents();

          foreach ($contents as $key => $value) {
            // Only want @media queries.
            if ($value instanceof Sabberworm\CSS\CSSList\MediaQuery) {
              $media_queries[] = $value->getQuery();
            }
          }
        }
      }

      // Store for 1 hour.
      cache_set($cid, $media_queries, 'cache', REQUEST_TIME + (60 * 60));
    }

    return $media_queries;
  }
  else {
    return FALSE;
  }
}

/**
 * Gets all stylesheets attached to the page.
 */
function theme_utils_get_css_files() {
  $css = drupal_add_css();

  // Sort CSS items, so that they appear in the correct order.
  uasort($css, 'drupal_sort_css_js');

  // Remove the overridden CSS files. Later CSS files override former ones.
  $previous_item = array();
  foreach ($css as $key => $item) {
    if ($item['type'] == 'file') {
      // If defined, force a unique basename for this file.
      $basename = isset($item['basename']) ? $item['basename'] : drupal_basename($item['data']);
      if (isset($previous_item[$basename])) {
        // Remove the previous item that shared the same base name.
        unset($css[$previous_item[$basename]]);
      }
      $previous_item[$basename] = $key;
    }
  }

  return $css;
}

/**
 * Verify that the @media query requirements are met.
 */
function theme_utils_media_query_supported() {
  $error_msg = '';

  // Check if php namespaces are supported.
  if (strnatcmp(phpversion(), '5.3.0') < 0) {
    $error_msg .= t('PHP version 5.3.0 is required. This server is using ') . phpversion();
  }
  else {
    // Verify Library API is installed/enabled.
    if (module_exists('libraries')) {
      // Verify parser is in correct location.
      $library_path = libraries_get_path('php-css-parser');
      if (!$library_path) {
        $error_msg .= t('Required library not found. PHP-CSS-Parser is either not installed or is installed incorrectly. Please see the README.txt file for installation instructions. ');
      }
    }
    else {
      $error_msg .= t('<a href="@libraries-module">Libraries API</a> module is required. ', array('@libraries-module' => 'http://drupal.org/project/libraries'));
    }

    // Verify X Autoload is installed/enabled.
    if (!module_exists('xautoload')) {
      $error_msg .= t('<a href="@xautoload-module">X Autoload</a> module is required. ', array('@xautoload-module' => 'http://drupal.org/project/xautoload'));
    }
  }

  return $error_msg;
}