nice_menus.module

<?php

/**
 * @file
 * Module to enable CSS dropdown and flyout menus.
 *
 * Maintainer: Addison Berry (add1sun)
 * Originally written by Jake Gordon (jakeg)
 */

/**
 * Implements hook_config_info().
 */
function nice_menus_config_info() {
  $prefixes['nice_menus.settings'] = array(
    'label' => t('Nice Menus settings'),
    'group' => t('Configuration'),
  );
  return $prefixes;
}


/**
 * Implements hook_menu().
 */
function nice_menus_menu() {
  $items['admin/config/user-interface/nice_menus'] = array(
    'title' => 'Nice menus',
    'description' => 'Configure Nice menus.',
    'page callback' => 'backdrop_get_form',
    'page arguments' => array('nice_menus_admin_settings'),
    'access arguments' => array('administer site configuration'),
    'file' => 'nice_menus.admin.inc',
  );

  return $items;
}

/**
 * Implements hook_library().
 */
function nice_menus_library() {
  $module_path = backdrop_get_path('module', 'nice_menus');
  // Jquery bgiframe.
  $libraries['jquery.bgiframe'] = array(
    'title' => 'bgiframe',
    'website' => 'http://docs.jquery.com/Plugins/bgiframe',
    'version' => '2.1',
    'js' => array(
      $module_path . '/js/jquery.bgiframe.js' => array(),
    ),
  );

  // Jquery hoverIntent.
  $libraries['jquery.hoverIntent'] = array(
    'title' => 'hoverIntent',
    'website' => 'http://cherne.net/brian/resources/jquery.hoverIntent.html',
    'version' => '0.5',
    'js' => array(
      $module_path . '/js/jquery.hoverIntent.js' => array(),
    ),
  );

  // Superfish.
  $libraries['superfish'] = array(
    'title' => 'Superfish',
    'website' => 'http://users.tpg.com.au/j_birch/plugins/superfish/',
    'version' => '1.4.8',
    'js' => array(
      $module_path . '/js/superfish.js' => array(),
    ),
    'dependencies' => array(
      array('nice_menus', 'jquery.bgiframe'),
      array('nice_menus', 'jquery.hoverIntent'),
    ),
  );

  // Nicemenus.
  $libraries['nice_menus'] = array(
    'title' => 'Nice Menus',
    'website' => 'http://backdrop.org/project/nice_menus',
    'version' => '1.0',
    'js' => array(
      // Add the Superfish options variables.
      $module_path . '/js/nice_menus.js' => array(),
    ),
    'dependencies' => array(
      array('nice_menus', 'superfish'),
    ),
  );
  // Add the javascript according to configuration settings.
  $libraries['nice_menus']['js'][] = array(
    'type' => 'setting',
    'data' => array(
      'nice_menus_options' => array(
        'delay' => config_get('nice_menus.settings', 'nice_menus_sf_delay'),
        'speed' => config_get('nice_menus.settings', 'nice_menus_sf_speed'),
      ),
    ),
  );

  $jquery = backdrop_get_library('system', 'jquery');
  if (version_compare($jquery['version'], '1.7', '>=')) {
    $plugins = array(
      'jquery.hoverIntent' => array(
        'js' => 'jquery.hoverIntent.js',
        'version_pattern' => '@hoverIntent\s+(r[0-9]+)@i'
      ),
      'jquery.bgiframe' => array(
        'js' => 'jquery.bgiframe.js',
        'version_pattern' => '@version\s+([0-9a-zA-Z\.-]+)@i'
      ),
      'superfish' => array(
        'js' => 'superfish.js',
        'version_pattern' => '@Superfish\s(v[0-9\.-]+)@i'
      )
    );

    // config libraries directory.
    $searchdir = array(
      'libraries/',
      conf_path() . '/libraries/',
      'profiles/' . backdrop_get_profile() . '/libraries/',
      'sites/all/libraries/'
    );

    foreach ($plugins as $plugin => $file_info) {

      $libraries_file = NULL;

      // check libraries module.
      if (module_exists('libraries') && libraries_get_path($plugin) != '') {
        $library_directory = libraries_get_path($plugin);
        if (is_file(BACKDROP_ROOT . '/' . $library_directory . $plugin . '/' . $file_info['js'])) {
          $libraries_file = $library_directory . $plugin . '/' . $file_info['js'];
        }
      }

      // scan dir.
      if ($libraries_file === NULL) {
        foreach ($searchdir as $libraries_dir) {
          if (is_file(BACKDROP_ROOT . '/' . $libraries_dir . $plugin . '/' . $file_info['js'])) {
            $libraries_file = $libraries_dir . $plugin . '/' . $file_info['js'];
            break;
          }
        }
      }

      // add to libraries.
      if ($libraries_file !== NULL) {
        $libraries[$plugin]['version'] = nice_menus_get_version($libraries_file, array(
          'pattern' => $file_info['version_pattern']
        ));
        $libraries[$plugin]['js'] = array($libraries_file => array());
      }
    }
  }

  return $libraries;
}

/**
 * Gets the version information from an arbitrary library.
 *
 * @return
 *   A string containing the version of the library.
 */
function nice_menus_get_version($file, $options = array()) {
  // Provide defaults.
  $options += array(
    'file' => '',
    'pattern' => '',
    'lines' => 10,
    'cols' => 200,
  );

  $file = BACKDROP_ROOT . '/' . $file;

  if (!is_file($file)) {
    return;
  }
  $file = fopen($file, 'r');
  while ($options['lines'] && $line = fgets($file, $options['cols'])) {
    if (preg_match($options['pattern'], $line, $version)) {
      fclose($file);
      return $version[1];
    }
    $options['lines']--;
  }
  fclose($file);
}

/**
 * Implements hook_block_info().
 */
function nice_menus_block_info() {
  $blocks = array();
  $number = config_get('nice_menus.settings', 'nice_menus_number');
  // Todo hit config only once.
  for ($i = 1; $i <= $number; $i++) {
    if (config_get('nice_menus.settings', 'nice_menus_name_' . $i)) {
      $blocks[$i]['info'] = config_get('nice_menus.settings', 'nice_menus_name_' . $i) . ' (Nice menu)';
    }
    else {
      $blocks[$i]['info'] = 'Nice menu ' . $i . ' (Nice menu)';
    }
    // We have too many things changing per user, per page to cache.
    $blocks[$i]['cache'] = BACKDROP_NO_CACHE;
  }
  return $blocks;
}

/**
 * Implements hook_block_configure().
 */
function nice_menus_block_configure($delta) {
  $config = config('nice_menus.settings');

  $form['nice_menus_name_' . $delta] = array(
    '#type' => 'textfield',
    '#title' => t('Menu name'),
    '#default_value' => ($c = $config->get('nice_menus_name_' . $delta)) ? $c : 'Nice menu ' . $delta,
  );
  $form['nice_menus_menu_' . $delta] = array(
    '#type' => 'select',
    '#title' => t('Menu parent'),
    '#description' => t('The menu parent from which to show a Nice menu.'),
    '#default_value' => ($c = $config->get('nice_menus_menu_' . $delta)) ? $c : 'management:0',
    '#options' => menu_parent_options(menu_get_menus(), 0),
  );
  $form['nice_menus_depth_' . $delta] = array(
    '#type' => 'select',
    '#title' => t('Menu depth'),
    '#description' => t('The depth of the menu, i.e. the number of child levels starting with the parent selected above. Leave set to -1 to display all children and use 0 to display no children.'),
    '#default_value' => ($c = $config->get('nice_menus_depth_' . $delta)) ? $c : -1,
    '#options' => backdrop_map_assoc(range(-1, 5)),
  );
  $form['nice_menus_type_' . $delta] = array(
    '#type' => 'select',
    '#title' => t('Menu style'),
    '#description' => t('right: menu items are listed on top of each other and expand to the right') . '<br />' . t('left: menu items are listed on top of each other and expand to the left') . '<br />' . t('down: menu items are listed side by side and expand down'),
    '#default_value' => ($c = $config->get('nice_menus_type_' . $delta)) ? $c : 'right',
    '#options' => backdrop_map_assoc(array('right', 'left', 'down')),
  );
  $form['nice_menus_respect_expand_' . $delta] = array(
    '#type' => 'select',
    '#title' => t('Respect "Show as expanded" option'),
    '#description' => t('Menu items have a "Show as expanded" option, which is disabled by default. Since menu items do NOT have this option checked by default, you should choose Yes here once you have configured the menu items that you DO want to expand.'),
    '#options' => array(
      0 => t('No'),
      1 => t('Yes'),
    ),
    '#default_value' => ($c = $config->get('nice_menus_respect_expand_' . $delta)) ? $c : 0,
  );
  return $form;
}


/**
 * Implements hook_block_save().
 */
function nice_menus_block_save($delta, $edit) {
  $config = config('nice_menus.settings');
  $config->set('nice_menus_name_' . $delta, $edit['nice_menus_name_' . $delta]);
  $config->set('nice_menus_menu_' . $delta, $edit['nice_menus_menu_' . $delta]);
  $config->set('nice_menus_depth_' . $delta, $edit['nice_menus_depth_' . $delta]);
  $config->set('nice_menus_type_' . $delta, $edit['nice_menus_type_' . $delta]);
  $config->set('nice_menus_respect_expand_' . $delta, $edit['nice_menus_respect_expand_' . $delta]);
  $config->save();
}

/**
 * Implements hook_block_view().
 */
function nice_menus_block_view($delta = 1) {
  // Todo hit config once
  // Build the Nice menu for the block.
  list($menu_name, $mlid) = explode(':', config_get('nice_menus.settings', 'nice_menus_menu_' . $delta));
  $direction = config_get('nice_menus.settings', 'nice_menus_type_' . $delta);
  $depth = config_get('nice_menus.settings', 'nice_menus_depth_' . $delta);
  $respect_expanded = config_get('nice_menus.settings', 'nice_menus_respect_expand_' . $delta);
  if ($output = theme('nice_menus', array(
    'id' => $delta,
    'menu_name' => $menu_name,
    'mlid' => $mlid,
    'direction' => $direction,
    'depth' => $depth,
    'respect_expanded' => $respect_expanded))) {
    $block['content']['#markup'] = $output['content'];
    if (config_get('nice_menus.settings', 'nice_menus_type_' . $delta) == 'down') {
      $class = 'nice-menu-hide-title';
    }
    else {
      $class = 'nice-menu-show-title';
    }
    // If we're building the navigation block
    // use the same block title logic as menu module.
    global $user;
    if ($output['subject'] == t('navigation') && $user->uid) {
      $subject = $user->name;
    }
    else {
      $subject = $output['subject'];
    }
    $block['subject'] = '<span class="' . $class . '">' . check_plain($subject) . '</span>';
    $block['content']['#contextual_links']['simple_menus'] = array('admin/structure/menu/manage', array($menu_name));
  }
  else {
    $block['content'] = FALSE;
  }
  return $block;
}


/**
 * add nice_menus js library.
 */
function _load_nice_menus_library() {
  static $is_load = FALSE;
  if ($is_load === FALSE) {
    // Add Superfish JavaScript, if enabled.
    if (config_get('nice_menus.settings', 'nice_menus_js') == 1) {
      backdrop_add_library('nice_menus', 'nice_menus');
    }
    // Add main CSS functionality.
    backdrop_add_css(backdrop_get_path('module', 'nice_menus') . '/css/nice_menus.css', array('group' => CSS_DEFAULT, 'basename' => 'nice_menus.css'));
    // Add custom CSS layout if specified.
    if ($custom = config_get('nice_menus.settings', 'nice_menus_custom_css')) {
      backdrop_add_css($custom, array('group' => CSS_DEFAULT, 'basename' => '/css/nice_menus_custom.css'));
    }
    // Fall back to default layout.
    else {
      backdrop_add_css(backdrop_get_path('module', 'nice_menus') . '/css/nice_menus_default.css', array('group' => CSS_DEFAULT, 'basename' => '/css/nice_menus_default.css'));
    }
    $is_load = TRUE;
  }
}

/**
 * Implements hook_theme().
 */
function nice_menus_theme() {
  return array(
    'nice_menus_tree' => array(
      'variables' => array(
        'menu_name' => NULL,
        'mlid' => NULL,
        'depth' => -1,
        'menu' => NULL,
        'respect_expanded' => 0,
      ),
    ),
    'nice_menus_build' => array(
      'variables' => array(
        'menu' => NULL,
        'depth' => -1,
        'trail' => NULL,
        'respect_expanded' => 0,
      ),
    ),
    'nice_menus' => array(
      'variables' => array(
        'id' => NULL,
        'menu_name' => NULL,
        'mlid' => NULL, 'direction' =>
        'right', 'depth' => -1,
        'respect_expanded' => 0,
        'menu' => NULL,
      ),
    ),
    'nice_menus_main_menu' => array(
      'variables' => array('direction' => 'down', 'depth' => -1),
    ),
    'nice_menus_secondary_menu' => array(
      'variables' => array('direction' => 'down', 'depth' => -1),
    ),
  );
}

/**
 * Builds the active trail from the page's menu data.
 *
 * @param array $page_menu
 *   The menu data for a page.
 *
 * @return mixed
 *   An array of parent menu item ids.
 */
function nice_menus_build_page_trail($page_menu) {
  $trail = array();
  foreach ($page_menu as $item) {
    if ($item['link']['in_active_trail']) {
      $trail[] = $item['link']['mlid'];
    }
    if ($item['below']) {
      $trail = array_merge($trail, nice_menus_build_page_trail($item['below']));
    }
  }
  return $trail;
}

/**
 * Builds the final Nice menu.
 *
 * @return mixed
 *   An HTML string of properly nested Nice menu lists.
 */
function theme_nice_menus_tree($variables) {
  // load nice_menus js and css.
  _load_nice_menus_library();

  /*
   * The top-level menu name that contains the menu to use (e.g. navigation
   * or main-menu) for Backdrop menus. For custom $menus this is just the
   * name for menu display.
   */
  $menu_name = $variables['menu_name'];

  /*
   * The menu ID from which to start building the items, i.e. the parent
   * of the displayed menu.
   */
  $mlid = $variables['mlid'];

  /*
   * The number of children levels to display. Use -1 to display all children
   * and use 0 to display no children.
   */
  $depth = $variables['depth'];

  /*
   * Optional. A custom menu array to use for theming -- it should have.
   * the same structure as that returned by menu_tree_all_data().
   */
  $menu = $variables['menu'];
  $respect_expanded = $variables['respect_expanded'];
  // Load the full menu array.
  $menu = isset($menu) ? $menu : menu_tree_all_data($menu_name);
  if (isset($menu)) {
    $page_menu = menu_tree_page_data($menu_name);
    $trail = nice_menus_build_page_trail($page_menu);
    unset($page_menu);
  }

  // Allow i18n module to translate strings where available.
  if (module_exists('i18n_menu')) {
    $menu = i18n_menu_localize_tree($menu);
  }
  // Assume depth == 0 by default, overriden if mlid is specified.
  $parent_depth = 0;

  // For custom $menus and menus built all the way from the top-level we.
  // don't need to "create" the specific sub-menu and we need to get the title.
  // from the $menu_name since there is no "parent item" array.
  // Create the specific menu if we have a mlid.
  if (!empty($mlid)) {
    // Load the parent menu item.
    $item = menu_link_load($mlid);
    $title = check_plain($item['title']);
    // The depth for our parent item, if it exists.
    $parent_depth = ($item['depth']) ? $item['depth'] : 0;

    // Narrow down the full menu to the specific sub-tree we need.
    for ($p = 1; $p < 10; $p++) {
      if ($sub_mlid = $item["p$p"]) {
        $subitem = menu_link_load($sub_mlid);
        // Menu sets these ghetto-ass keys in _menu_tree_check_access().
        $menu = $menu[(50000 + $subitem['weight']) . ' ' . $subitem['title'] . ' ' . $subitem['mlid']]['below'];
      }
    }
  }
  // Otherwise just set a title and move on.
  else {
    // Get the title from the DB since we don't have it in the $menu.
    //$result = db_query("SELECT title FROM {menu_custom} WHERE menu_name = :menu_name", array(':menu_name' => $menu_name))->fetchField();
    $title = 'test'; //check_plain($result);
  }

  $output['content'] = '';
  $output['subject'] = $title;

  if ($menu) {
    // Set the total menu depth counting from this parent if we need it.
    $depth = ($depth > 0) ? ($parent_depth + $depth) : $depth;
    $output['content'] .= theme('nice_menus_build', array(
      'menu' => $menu,
      'depth' => $depth,
      'trail' => $trail,
      'respect_expanded' => $respect_expanded,
    ));
  }

  return $output;
}

/**
 * Helper function that builds the nested lists of a Nice menu.
 *
 * @param array $variables
 *   Menu arguments.
 */
function theme_nice_menus_build($variables) {
  // Menu array from which to build the nested lists.
  $menu = $variables['menu'];

  // The number of children levels to display. Use -1 to display all children
  // and use 0 to display no children.
  $depth = $variables['depth'];

  // An array of parent menu items.
  $trail = $variables['trail'];
  // "Show as expanded" option.
  $respect_expanded = $variables['respect_expanded'];

  $output = '';
  // Prepare to count the links so we can mark first, last, odd and even.
  $index = 0;
  $count = 0;
  foreach ($menu as $menu_count) {
    if ($menu_count['link']['hidden'] == 0) {
      $count++;
    }
  }
  // Get to building the menu.
  foreach ($menu as $menu_item) {
    $mlid = $menu_item['link']['mlid'];
    // Check to see if it is a visible menu item.
    if (!isset($menu_item['link']['hidden']) || $menu_item['link']['hidden'] == 0) {
      // Check our count and build first, last, odd/even classes.
      $index++;
      $first_class = ($index == 1) ? 'first' : '';
      $oddeven_class = ($index % 2 == 0) ? 'even' : 'odd';
      $last_class = ($index == $count) ? 'last' : '';
      // Build class name based on menu path
      // e.g. to give each menu item individual style.
      $class = str_replace(array('http', 'https', '://', 'www'), '', $menu_item['link']['href']);
      // Strip funny symbols.
      $class = backdrop_html_class('menu-path-' . $class);
      if ($trail && in_array($mlid, $trail)) {
        $class .= ' active-trail';
      }
      // If it has children build a nice little tree under it.
      // Build a nice little tree under it if it has children, and has been set
      // to expand (when that option is being respected).
      if ((!empty($menu_item['link']['has_children'])) &&
          (!empty($menu_item['below'])) && $depth != 0 &&
          ($respect_expanded == 0 || $menu_item['link']['expanded'])) {
        // Keep passing children into the function 'til we get them all.
        if ($menu_item['link']['depth'] <= $depth || $depth == -1) {
          $children = array(
            '#theme' => 'nice_menus_build',
            '#prefix' => '<ul>',
            '#suffix' => '</ul>',
            '#menu' => $menu_item['below'],
            '#depth' => $depth,
            '#trail' => $trail,
            '#respect_expanded' => $respect_expanded,
          );
        }
        else {
          $children = '';
        }
        // Set the class to parent only of children are displayed.
        $parent_class = ($children && ($menu_item['link']['depth'] <= $depth || $depth == -1)) ? 'menuparent ' : '';
        $element = array(
          '#below' => $children,
          '#title' => $menu_item['link']['title'],
          '#href' => $menu_item['link']['href'],
          '#localized_options' => $menu_item['link']['localized_options'],
          '#attributes' => array(
            'class' => array(
              'menu-' . $mlid,
              $parent_class,
              $class,
              $first_class,
              $oddeven_class,
              $last_class,
            ),
          ),
          '#original_link' => $menu_item['link'],
        );
        $variables['element'] = $element;

        // Check for context reactions menu.
        if (module_exists('context')) {
          context_preprocess_menu_link($variables);
          if (isset($variables['element']['#localized_options']['attributes']['class']) &&
            in_array('active', $variables['element']['#localized_options']['attributes']['class']) &&
            !in_array('active-trail', $variables['element']['#attributes']['class'])) {
            $variables['element']['#attributes']['class'][] = ' active-trail';
          }
        }

        $output .= theme('menu_link', $variables);
      }
      else {
        $element = array(
          '#below' => '',
          '#title' => $menu_item['link']['title'],
          '#href' => $menu_item['link']['href'],
          '#localized_options' => $menu_item['link']['localized_options'],
          '#attributes' => array(
            'class' => array(
              'menu-' . $mlid,
              $class,
              $first_class,
              $oddeven_class,
              $last_class,
            ),
          ),
          '#original_link' => $menu_item['link'],
        );
        $variables['element'] = $element;

        // Check for context reactions menu.
        if (module_exists('context')) {
          context_preprocess_menu_link($variables);
          if (isset($variables['element']['#localized_options']['attributes']['class']) &&
            in_array('active', $variables['element']['#localized_options']['attributes']['class']) &&
            !in_array('active-trail', $variables['element']['#attributes']['class'])) {
            $variables['element']['#attributes']['class'][] = ' active-trail';
          }
        }

        $output .= theme('menu_link', $variables);
      }
    }
  }
  return $output;
}

/**
 * Theme function to allow any menu tree to be themed as a Nice menu.
 *
 * @param array $variables
 *   is an array, menu arguments.
 *
 * @return mixed
 *   An HTML string of Nice menu links.
 */
function theme_nice_menus($variables) {
  $output = array(
    'content' => '',
    'subject' => '',
  );

  // The Nice menu ID.
  $id = $variables['id'];
  // The top parent menu name from which to build the full menu.
  $menu_name = $variables['menu_name'];
  // The menu ID from which to build the displayed menu.
  $mlid = $variables['mlid'];
  // Optional. The direction the menu expands. Default is 'right'.
  $direction = $variables['direction'];
  // The number of children levels to display. Use -1 to display all children
  // and use 0 to display no children.
  $depth = $variables['depth'];
  /*
   * Optional. A custom menu array to use for theming --
   * it should have the same structure as that returned
   * by menu_tree_all_data(). Default is the standard menu tree.
   */
  $menu = $variables['menu'];
  // "Show as expanded" option.
  $respect_expanded = $variables['respect_expanded'];
  if ($menu_tree = theme('nice_menus_tree', array(
    'menu_name' => $menu_name,
    'mlid' => $mlid,
    'depth' => $depth,
    'menu' => $menu,
    'respect_expanded' => $respect_expanded))) {
    if ($menu_tree['content']) {
      $output['content'] = '<ul class="nice-menu nice-menu-' . $direction . ' nice-menu-' . $menu_name . '" id="nice-menu-' . $id . '">' . $menu_tree['content'] . '</ul>' . "\n";
      $output['subject'] = $menu_tree['subject'];
    }
  }
  return $output;
}

/**
 * Theme the main menu as a Nice menu.
 *
 * @return mixed
 *   An HTML string of Nice main menu links.
 */
function theme_nice_menus_main_menu($variables) {
  // Optional. The direction the menu expands. Default is 'down'.
  $direction = $variables['direction'];

  // The number of children levels to display. Use -1 to display all children.
  // and use 0 to display no children.
  $depth = $variables['depth'];
  $menu_name = config_get('nice_menus.settings', 'menu_main_links_source');
  $output = theme('nice_menus', array(
    'id' => 0,
    'menu_name' => $menu_name,
    'mlid' => 0,
    'direction' => $direction,
    'depth' => $depth,
  ));
  return $output['content'];
}

/**
 * Theme the secondary menu as a Nice menu.
 *
 * @return mixed
 *   An HTML string of Nice secondary menu links.
 */
function theme_nice_menus_secondary_menu($variables) {
  // Optional. The direction the menu expands. Default is 'down'.
  $direction = $variables['direction'];

  // The number of children levels to display. Use -1 to display all children
  // and use 0 to display no children.
  $depth = $variables['depth'];
  $menu_name = config_get('nice_menus.settings', 'menu_secondary_links_source');
  $output = theme('nice_menus', array(
    'id' => 0,
    'menu_name' => $menu_name,
    'mlid' => 0,
    'direction' => $direction,
    'depth' => $depth,
  ));
  return $output['content'];
}