From 2f9d9e1b5268fce1058afbbc9dac48f8b4b8b3b8 Mon Sep 17 00:00:00 2001 From: Bob Vincent Date: Fri, 12 Aug 2011 19:15:58 -0400 Subject: [PATCH] Issue #942782: Allow custom menus to receive an active trail. --- includes/menu.inc | 63 ++++++++++++++++++++++++++++++--------------- modules/menu/menu.install | 22 +++++++++++++++ modules/menu/menu.module | 18 +++++++++++++ 3 files changed, 82 insertions(+), 21 deletions(-) diff --git a/includes/menu.inc b/includes/menu.inc index a32fa1310ebe166eb497d1f4abdc648be5004a46..876468505373df5fab6992b50eef982a46c3fec7 100644 --- a/includes/menu.inc +++ b/includes/menu.inc @@ -1199,7 +1199,7 @@ function menu_tree_page_data($menu_name, $max_depth = NULL, $only_active_trail = // parameters accordingly. if ($item['access']) { // Find a menu link corresponding to the current path. - if ($active_link = menu_link_get_preferred()) { + if ($active_link = menu_link_get_preferred(NULL, $menu_name)) { // The active link may only be taken into account to build the // active trail, if it resides in the requested menu. Otherwise, // we'd needlessly re-run _menu_build_tree() queries for every menu @@ -2206,6 +2206,13 @@ function theme_menu_local_tasks(&$variables) { /** * Set (or get) the active menu for the current page - determines the active trail. + * + * @return + * An array of menu machine names, in order of preference. The + * 'menu_default_active_menus' variable may be used to assert a menu order + * different from the order of creation, or to prevent a particular menu from + * being used at all in the active trail. + * e.g. $conf['menu_default_active_menus'] = array('navigation', 'main-menu') */ function menu_set_active_menu_names($menu_names = NULL) { $active = &drupal_static(__FUNCTION__); @@ -2338,23 +2345,30 @@ function menu_set_active_trail($new_trail = NULL) { * @param $path * The path, for example 'node/5'. The function will find the corresponding * menu link ('node/5' if it exists, or fallback to 'node/%'). + * @param $selected_menu + * The name of a menu used to restrict the search for a preferred menu link. + * If not specified, all the menus returned by menu_get_active_menu_names() + * will be used. * * @return - * A fully translated menu link, or NULL if no matching menu link was + * A fully translated menu link, or FALSE if no matching menu link was * found. The most specific menu link ('node/5' preferred over 'node/%') in * the most preferred menu (as defined by menu_get_active_menu_names()) is * returned. */ -function menu_link_get_preferred($path = NULL) { +function menu_link_get_preferred($path = NULL, $select4ed_menu = NULL) { $preferred_links = &drupal_static(__FUNCTION__); if (!isset($path)) { $path = $_GET['q']; } + if (empty($selected_menu)) { + // Use an illegal menu name as the key for the preferred menu link. + $selected_menu = '__preferred__'; + } + if (!isset($preferred_links[$path])) { - $preferred_links[$path] = FALSE; - // Look for the correct menu link by building a list of candidate paths, // which are ordered by priority (translated hrefs are preferred over // untranslated paths). Afterwards, the most relevant path is picked from @@ -2376,6 +2390,8 @@ function menu_link_get_preferred($path = NULL) { // Retrieve a list of menu names, ordered by preference. $menu_names = menu_get_active_menu_names(); + // Put the selected menu at the front of the list. + array_unshift($menu_names, $selected_menu); $query = db_select('menu_links', 'ml', array('fetch' => PDO::FETCH_ASSOC)); $query->leftJoin('menu_router', 'm', 'm.path = ml.router_path'); @@ -2383,7 +2399,6 @@ function menu_link_get_preferred($path = NULL) { // Weight must be taken from {menu_links}, not {menu_router}. $query->addField('ml', 'weight', 'link_weight'); $query->fields('m'); - $query->condition('ml.menu_name', $menu_names, 'IN'); $query->condition('ml.link_path', $path_candidates, 'IN'); // Sort candidates by link path and menu name. @@ -2391,29 +2406,35 @@ function menu_link_get_preferred($path = NULL) { foreach ($query->execute() as $candidate) { $candidate['weight'] = $candidate['link_weight']; $candidates[$candidate['link_path']][$candidate['menu_name']] = $candidate; + // Add any menus not already in the menu name search list. + if (!in_array($candidate['menu_name'], $menu_names)) { + $menu_names[] = $candidate['menu_name']; + } } - // Pick the most specific link, in the most preferred menu. + // Store the most specific link for each menu. Also save the most specific + // link of the most preferred menu in $preferred_link. foreach ($path_candidates as $link_path) { - if (!isset($candidates[$link_path])) { - continue; - } - foreach ($menu_names as $menu_name) { - if (!isset($candidates[$link_path][$menu_name])) { - continue; + if (isset($candidates[$link_path])) { + foreach ($menu_names as $menu_name) { + if (empty($preferred_links[$path][$menu_name]) && isset($candidates[$link_path][$menu_name])) { + $candidate_item = $candidates[$link_path][$menu_name]; + $map = explode('/', $path); + _menu_translate($candidate_item, $map); + if ($candidate_item['access']) { + $preferred_links[$path][$menu_name] = $candidate_item; + if (empty($preferred_links[$path]['__preferred__'])) { + // Store the most specific link. + $preferred_links[$path]['__preferred__'] = $candidate_item; + } + } + } } - $candidate_item = $candidates[$link_path][$menu_name]; - $map = explode('/', $path); - _menu_translate($candidate_item, $map); - if ($candidate_item['access']) { - $preferred_links[$path] = $candidate_item; - } - break 2; } } } - return $preferred_links[$path]; + return isset($preferred_links[$path][$selected_menu]) ? $preferred_links[$path][$selected_menu] : FALSE; } /** diff --git a/modules/menu/menu.install b/modules/menu/menu.install index 13cb3cb50415e6e96a150490eedee74ef836ee42..8a392eaff922e9243661a7dac4f617aa3f12d40b 100644 --- a/modules/menu/menu.install +++ b/modules/menu/menu.install @@ -161,6 +161,28 @@ function menu_update_7001() { } /** + * Add missing custom menus to active menus list. + */ +function menu_update_7002(&$sandbox) { + // Make sure all custom menus are present in the active menus variable so that + // their items may appear in the active trail. + // @see menu_set_active_menu_names() + $active_menus = variable_get('menu_default_active_menus', array_keys(menu_list_system_menus())); + $update_variable = FALSE; + foreach (menu_get_names() as $menu_name) { + if (!in_array($menu_name, $active_menus) && (strpos($menu_name, 'menu-') === 0)) { + $active_menus[] = $menu_name; + $update_variable = TRUE; + } + } + if ($update_variable) { + variable_set('menu_default_active_menus', $active_menus); + } + // Clear the menu cache. + cache_clear_all(NULL, 'cache_menu'); +} + +/** * @} End of "defgroup updates-7.x-extra" * The next series of updates should start at 8000. */ diff --git a/modules/menu/menu.module b/modules/menu/menu.module index 254079700c9ef7ab43ec1ea1fa7f5d177802c1d3..040df0758555b95aff2e96c35a90733235038705 100644 --- a/modules/menu/menu.module +++ b/modules/menu/menu.module @@ -268,6 +268,15 @@ function menu_save($menu) { switch ($status) { case SAVED_NEW: + // Make sure the menu is present in the active menus variable so that its + // items may appear in the menu active trail. + // @see menu_set_active_menu_names() + $active_menus = variable_get('menu_default_active_menus', array_keys(menu_get_menus())); + if (!in_array($menu['menu_name'], $active_menus)) { + $active_menus[] = $menu['menu_name']; + variable_set('menu_default_active_menus', $active_menus); + } + module_invoke_all('menu_insert', $menu); break; @@ -305,6 +314,15 @@ function menu_delete($menu) { // Delete all links from the menu. menu_delete_links($menu['menu_name']); + // Remove menu from active menus variable. + $active_menus = variable_get('menu_default_active_menus', array_keys(menu_get_menus())); + foreach ($active_menus as $i => $menu_name) { + if ($menu['menu_name'] == $menu_name) { + unset($active_menus[$i]); + variable_set('menu_default_active_menus', $active_menus); + } + } + // Delete the custom menu. db_delete('menu_custom') ->condition('menu_name', $menu['menu_name']) -- 1.7.4.1