0; $i--) { $current = ''; $count = 0; for ($j = $length; $j >= 0; $j--) { if ($i & (1 << $j)) { $count++; $current .= $parts[$length - $j]; } else { $current .= '%'; } if ($j) { $current .= '/'; } } // If the number was like 10...0 then the next number will be 11...11, // one bit less wide. if ($count == 1) { $length--; } $placeholders[] = "'%s'"; $ancestors[] = $current; } return array($ancestors, $placeholders); } /** * The menu system uses serialized arrays stored in the database for * arguments. However, often these need to change according to the * current path. This function unserializes such an array and does the * necessary change. * * Integer values are mapped according to the $map parameter. For * example, if unserialize($data) is array('view', 1) and $map is * array('node', '12345') then 'view' will not be changed because * it is not an integer, but 1 will as it is an integer. As $map[1] * is '12345', 1 will be replaced with '12345'. So the result will * be array('node_load', '12345'). * * @param @data * A serialized array. * @param @map * An array of potential replacements. * @return * The $data array unserialized and mapped. */ function menu_unserialize($data, $map) { if ($data = unserialize($data)) { foreach ($data as $k => $v) { if (is_int($v)) { $data[$k] = isset($map[$v]) ? $map[$v] : ''; } } return $data; } else { return array(); } } /** * Get the menu callback for the a path. * * @param $path * A path, or NULL for the current path */ function menu_get_item($path = NULL) { static $router_items; if (!isset($path)) { $path = $_GET['q']; } if (!isset($router_items[$path])) { $original_map = arg(NULL, $path); $parts = array_slice($original_map, 0, MENU_MAX_PARTS); list($ancestors, $placeholders) = menu_get_ancestors($parts); if ($router_item = db_fetch_array(db_query_range('SELECT * FROM {menu_router} WHERE path IN ('. implode (',', $placeholders) .') ORDER BY fit DESC', $ancestors, 0, 1))) { //var_dump($router_item); $map = _menu_translate($router_item, $original_map); if ($map === FALSE) { $router_items[$path] = FALSE; return FALSE; } if ($router_item['access']) { $router_item['map'] = $map; $router_item['page_arguments'] = array_merge(menu_unserialize($router_item['page_arguments'], $map), array_slice($map, $router_item['number_parts'])); } } $router_items[$path] = $router_item; } return $router_items[$path]; } /** * Execute the page callback associated with the current path */ function menu_execute_active_handler($path = NULL) { if (_menu_site_is_offline()) { return MENU_SITE_OFFLINE; } if ($router_item = menu_get_item($path)) { if ($router_item['access']) { if ($router_item['file']) { require_once($router_item['file']); } return call_user_func_array($router_item['page_callback'], $router_item['page_arguments']); } else { return MENU_ACCESS_DENIED; } } return MENU_NOT_FOUND; } /** * Loads objects into the map as defined in the $item['load_functions']. * * @param $item * A menu router or menu link item * @param $map * An array of path arguments (ex: array('node', '5')) * @return * Returns TRUE for success, FALSE if an object cannot be loaded */ function _menu_load_objects($item, &$map) { if ($item['load_functions']) { $load_functions = unserialize($item['load_functions']); $path_map = $map; foreach ($load_functions as $index => $function) { if ($function) { $return = $function(isset($path_map[$index]) ? $path_map[$index] : ''); // If callback returned an error or there is no callback, trigger 404. if ($return === FALSE) { $item['access'] = FALSE; $map = FALSE; return FALSE; } $map[$index] = $return; } } } return TRUE; } /** * Check access to a menu item using the access callback * * @param $item * A menu router or menu link item * @param $map * An array of path arguments (ex: array('node', '5')) * @return * $item['access'] becomes TRUE if the item is accessible, FALSE otherwise. */ function _menu_check_access(&$item, $map) { // Determine access callback, which will decide whether or not the current user has // access to this path. $callback = trim($item['access_callback']); // Check for a TRUE or FALSE value. if (is_numeric($callback)) { $item['access'] = $callback; } else { $arguments = menu_unserialize($item['access_arguments'], $map); // As call_user_func_array is quite slow and user_access is a very common // callback, it is worth making a special case for it. if ($callback == 'user_access') { $item['access'] = (count($arguments) == 1) ? user_access($arguments[0]) : user_access($arguments[0], $arguments[1]); } else { $item['access'] = call_user_func_array($callback, $arguments); } } } function _menu_item_localize(&$item) { // Translate the title to allow storage of English title strings // in the database, yet display of them in the language required // by the current user. $callback = $item['title_callback']; // t() is a special case. Since it is used very close to all the time, // we handle it directly instead of using indirect, slower methods. if ($callback == 't') { if (empty($item['title_arguments'])) { $item['title'] = t($item['title']); } else { $item['title'] = t($item['title'], unserialize($item['title_arguments'])); } } else { if (empty($item['title_arguments'])) { $item['title'] = $callback($item['title']); } else { $item['title'] = call_user_func_array($callback, unserialize($item['title_arguments'])); } } // Translate description, see the motivation above. if (!empty($item['description'])) { $item['description'] = t($item['description']); } } /** * Handles dynamic path translation and menu access control. * * When a user arrives on a page such as node/5, this function determines * what "5" corresponds to, by inspecting the page's menu path definition, * node/%node. This will call node_load(5) to load the corresponding node * object. * * It also works in reverse, to allow the display of tabs and menu items which * contain these dynamic arguments, translating node/%node to node/5. * * Translation of menu item titles and descriptions are done here to * allow for storage of English strings in the database, and translation * to the language required to generate the current page * * @param $router_item * A menu router item * @param $map * An array of path arguments (ex: array('node', '5')) * @param $to_arg * Execute $item['to_arg_functions'] or not. Use only if you want to render a * path from the menu table, for example tabs. * @return * Returns the map with objects loaded as defined in the * $item['load_functions. $item['access'] becomes TRUE if the item is * accessible, FALSE otherwise. $item['href'] is set according to the map. * If an error occurs during calling the load_functions (like trying to load * a non existing node) then this function return FALSE. */ function _menu_translate(&$router_item, $map, $to_arg = FALSE) { $path_map = $map; if (!_menu_load_objects($router_item, $map)) { // An error occurred loading an object. $router_item['access'] = FALSE; return FALSE; } if ($to_arg) { _menu_link_map_translate($path_map, $router_item['to_arg_functions']); } // Generate the link path for the page request or local tasks. $link_map = explode('/', $router_item['path']); for ($i = 0; $i < $router_item['number_parts']; $i++) { if ($link_map[$i] == '%') { $link_map[$i] = $path_map[$i]; } } $router_item['href'] = implode('/', $link_map); _menu_check_access($router_item, $map); _menu_item_localize($router_item); return $map; } /** * This function translates the path elements in the map using any to_arg * helper function. These functions take an argument and return an object. * See http://drupal.org/node/109153 for more information. * * @param map * An array of path arguments (ex: array('node', '5')) * @param $to_arg_functions * An array of helper function (ex: array(1 => 'node_load')) */ function _menu_link_map_translate(&$map, $to_arg_functions) { if ($to_arg_functions) { $to_arg_functions = unserialize($to_arg_functions); foreach ($to_arg_functions as $index => $function) { // Translate place-holders into real values. $arg = $function(!empty($map[$index]) ? $map[$index] : ''); if (!empty($map[$index]) || isset($arg)) { $map[$index] = $arg; } else { unset($map[$index]); } } } } /** * This function is similar to _menu_translate() but does link-specific * preparation such as always calling to_arg functions * * @param $item * A menu link * @return * Returns the map of path arguments with objects loaded as defined in the * $item['load_functions']. * $item['access'] becomes TRUE if the item is accessible, FALSE otherwise. * $item['href'] is generated from link_path, possibly by to_arg functions. * $item['title'] is generated from link_title, and may be localized. */ function _menu_link_translate(&$item) { if ($item['external']) { $item['access'] = 1; $map = array(); $item['href'] = $item['link_path']; $item['title'] = $item['link_title']; } else { $map = explode('/', $item['link_path']); _menu_link_map_translate($map, $item['to_arg_functions']); $item['href'] = implode('/', $map); // Note- skip callbacks without real values for their arguments if (strpos($item['href'], '%') !== FALSE) { $item['access'] = FALSE; return FALSE; } // TODO: menu_tree_data may set this ahead of time for links to nodes if (!isset($item['access'])) { if (!_menu_load_objects($item, $map)) { // An error occured loading an object $item['access'] = FALSE; return FALSE; } _menu_check_access($item, $map); } // If the link title matches that of a router item, localize it. if (isset($item['title']) && ($item['title'] == $item['link_title'])) { _menu_item_localize($item); } else { $item['title'] = $item['link_title']; } } $item['options'] = unserialize($item['options']); return $map; } /** * Returns a rendered menu tree. The tree is expanded based on the current * path and dynamic paths are also changed according to the defined to_arg * functions (for example the 'My account' link is changed from user/% to * a link with the current user's uid). * * @param $menu_name * The name of the menu. * @return * The rendered HTML of that menu on the current page. */ function menu_tree($menu_name = 'navigation') { static $menu_output = array(); if (!isset($menu_output[$menu_name])) { $tree = menu_tree_page_data($menu_name); $menu_output[$menu_name] = menu_tree_output($tree); } return $menu_output[$menu_name]; } /** * Returns a rendered menu tree. * * @param $tree * A data structure representing the tree as returned from menu_tree_data. * @return * The rendered HTML of that data structure. */ function menu_tree_output($tree) { $output = ''; foreach ($tree as $data) { if (!$data['link']['hidden']) { $link = theme('menu_item_link', $data['link']); if ($data['below']) { $output .= theme('menu_item', $link, $data['link']['has_children'], menu_tree_output($data['below']), $data['link']['in_active_trail']); } else { $output .= theme('menu_item', $link, $data['link']['has_children'], '', $data['link']['in_active_trail']); } } } return $output ? theme('menu_tree', $output) : ''; } /** * Get the data structure representing a named menu tree. Since this can be * the full tree including hidden items, the data returned may be used for * generating an an admin interface or a select. * * @param $menu_name * The named menu links to return * @param $item * A fully loaded menu link, or NULL. If a link is supplied, only the * path to root will be included in the returned tree- as if this link * represented the current page in a visible menu. * @param $show_hidden * Show disabled links (such as suggested menu items). * @return * An tree of menu links in an array, in the order they should be rendered. */ function menu_tree_all_data($menu_name = 'navigation', $item = NULL, $show_hidden = FALSE) { static $tree = array(); $mlid = isset($item['mlid']) ? $item['mlid'] : 0; $cid = 'links:'. $menu_name .':all:'. $mlid .':'. (int)$show_hidden; if (!isset($tree[$cid])) { $cache = cache_get($cid, 'cache_menu'); if ($cache && isset($cache->data)) { $tree[$cid] = $cache->data; } else { if ($mlid) { $args = array(0, $item['p1'], $item['p2'], $item['p3'], $item['p4'], $item['p5']); $args = array_unique($args); $placeholders = implode(', ', array_fill(0, count($args), '%d')); $where = ' AND ml.plid IN ('. $placeholders .')'; $parents = $args; $parents[] = $item['mlid']; } else { $where = ''; $args = array(); $parents = array(); } if (!$show_hidden) { $where .= ' AND ml.hidden = 0'; } else { $where .= ' AND ml.hidden > 0'; } array_unshift($args, $menu_name); list(, $tree[$cid]) = _menu_tree_data(db_query(" SELECT m.*, ml.menu_name, ml.mlid, ml.plid, ml.link_path, ml.router_path, ml.hidden, ml.external, ml.has_children, ml.expanded, ml.weight + 50000 AS weight, ml.depth, ml.p1, ml.p2, ml.p3, ml.p4, ml.p5, ml.p6, ml.module, ml.link_title, ml.options FROM {menu_links} ml LEFT JOIN {menu_router} m ON m.path = ml.router_path WHERE ml.menu_name = '%s'". $where ." ORDER BY p1 ASC, p2 ASC, p3 ASC, p4 ASC, p5 ASC", $args), $parents); cache_set($cid, $tree[$cid], 'cache_menu'); } // TODO: special case node links and access check via db_rewite_sql() _menu_tree_check_access($tree[$cid]); } return $tree[$cid]; } /** * Get the data structure representing a named menu tree, based on the current * page. The tree order is maintained by storing each parent in an invidual * field, see http://drupal.org/node/141866 for more. * * @param $menu_name * The named menu links to return * @return * An array of menu links, in the order they should be rendered. The array * is a list of associative arrays -- these have two keys, link and below. * link is a menu item, ready for theming as a link. Below represents the * submenu below the link if there is one and it is a similar list that was * described so far. */ function menu_tree_page_data($menu_name = 'navigation') { static $tree = array(); if ($item = menu_get_item()) { $cid = 'links:'. $menu_name .':page:'. $item['href'] .':'. (int)$item['access']; if (!isset($tree[$cid])) { $cache = cache_get($cid, 'cache_menu'); if ($cache && isset($cache->data)) { $tree[$cid] = $cache->data; } else { if ($item['access']) { $parents = db_fetch_array(db_query("SELECT p1, p2, p3, p4, p5, p6 FROM {menu_links} WHERE menu_name = '%s' AND link_path = '%s'", $menu_name, $item['href'])); // We may be on a local task that's not in the links // TODO how do we handle the case like a local task on a specific node in the menu? if (empty($parents)) { $parents = db_fetch_array(db_query("SELECT p1, p2, p3, p4, p5, p6 FROM {menu_links} WHERE menu_name = '%s' AND link_path = '%s'", $menu_name, $item['tab_root'])); } $parents[] = '0'; $args = $parents = array_unique($parents); $placeholders = implode(', ', array_fill(0, count($args), '%d')); $expanded = variable_get('menu_expanded', array()); if (in_array($menu_name, $expanded)) { do { $result = db_query("SELECT mlid FROM {menu_links} WHERE expanded != 0 AND has_children != 0 AND menu_name = '%s' AND plid IN (". $placeholders .') AND mlid NOT IN ('. $placeholders .')', array_merge(array($menu_name), $args, $args)); while ($item = db_fetch_array($result)) { $args[] = $item['mlid']; } $placeholders = implode(', ', array_fill(0, count($args), '%d')); } while (db_num_rows($result)); } array_unshift($args, $menu_name); } // Show the root menu for access denied. else { $args = array('navigation', '0'); $placeholders = '%d'; $parents = array(); } // LEFT JOIN since there is no match in {menu_router} for an external link. // No need to order by p6 - there is a sort by weight later. list(, $tree[$cid]) = _menu_tree_data(db_query(" SELECT m.*, ml.menu_name, ml.mlid, ml.plid, ml.link_path, ml.router_path, ml.hidden, ml.external, ml.has_children, ml.expanded, ml.weight + 50000 AS weight, ml.depth, ml.p1, ml.p2, ml.p3, ml.p4, ml.p5, ml.p6, ml.module, ml.link_title, ml.options FROM {menu_links} ml LEFT JOIN {menu_router} m ON m.path = ml.router_path WHERE ml.menu_name = '%s' AND ml.plid IN (". $placeholders .") AND ml.hidden = 0 ORDER BY p1 ASC, p2 ASC, p3 ASC, p4 ASC, p5 ASC", $args), $parents); cache_set($cid, $tree[$cid], 'cache_menu'); } // TODO: special case node links and access check via db_rewite_sql() _menu_tree_check_access($tree[$cid]); } return $tree[$cid]; } return array(); } function _menu_tree_check_access(&$tree) { foreach ($tree as $key => $v) { $item = &$tree[$key]['link']; _menu_link_translate($item); if (!$item['access']) { unset($tree[$key]); } elseif ($tree[$key]['below']) { _menu_tree_check_access($tree[$key]['below']); } } } /** * Build the data representing a menu tree. * * The function is a bit complex because the rendering of an item depends on * the next menu item. So we are always rendering the element previously * processed not the current one. * * @param $result * The database result. * @param $parents * An array of the plid values that represent the path from the current page * to the root of the menu tree. * @param $depth * The depth of the current menu tree. * @param $previous_element * The previous menu link in the current menu tree. * @return * See menu_tree_data for a description of the data structure. */ function _menu_tree_data($result = NULL, $parents = array(), $depth = 1, $previous_element = '') { $remnant = NULL; $tree = array(); while ($item = db_fetch_array($result)) { // We need to determine if we're on the path to root so we can later build // the correct active trail and breadcrumb. $item['in_active_trail'] = in_array($item['mlid'], $parents); // The weights are uniform 5 digits because of the 50000 offset in the // query. We add mlid at the end of the index to insure uniqueness. $index = $previous_element ? ($previous_element['weight'] .' '. $previous_element['title'] . $previous_element['mlid']) : ''; // The current item is the first in a new submenu. if ($item['depth'] > $depth) { // _menu_tree returns an item and the menu tree structure. list($item, $below) = _menu_tree_data($result, $parents, $item['depth'], $item); $tree[$index] = array( 'link' => $previous_element, 'below' => $below, ); // We need to fall back one level. if (!isset($item) || $item['depth'] < $depth) { ksort($tree); return array($item, $tree); } // This will be the link to be output in the next iteration. $previous_element = $item; } // We are in the same menu. We render the previous element, $previous_element. elseif ($item['depth'] == $depth) { if ($previous_element) { // Only the first time $tree[$index] = array( 'link' => $previous_element, 'below' => '', ); } // This will be the link to be output in the next iteration. $previous_element = $item; } // The submenu ended with the previous item, so pass back the current item. else { $remnant = $item; break; } } if ($previous_element) { // We have one more link dangling. $tree[$previous_element['weight'] .' '. $previous_element['title'] .' '. $previous_element['mlid']] = array( 'link' => $previous_element, 'below' => '', ); } ksort($tree); return array($remnant, $tree); } /** * Generate the HTML output for a single menu link. */ function theme_menu_item_link($link) { return l($link['title'], $link['href'], $link['options']); } /** * Generate the HTML output for a menu tree */ function theme_menu_tree($tree) { return ''; } /** * Generate the HTML output for a menu item and submenu. */ function theme_menu_item($link, $has_children, $menu = '', $in_active_trail = FALSE) { $class = ($menu ? 'expanded' : ($has_children ? 'collapsed' : 'leaf')); if ($in_active_trail) { $class .= ' active-trail'; } return '
  • '. $link . $menu .'
  • '."\n"; } function theme_menu_local_task($link, $active = FALSE) { return '
  • '. $link .'
  • '; } /** * Returns the help associated with the active menu item. */ function menu_get_active_help() { $output = ''; $item = menu_get_item(); if (!$item || !$item['access']) { // Don't return help text for areas the user cannot access. return; } $path = ($item['type'] == MENU_DEFAULT_LOCAL_TASK) ? $item['tab_parent'] : $item['path']; foreach (module_list() as $name) { if (module_hook($name, 'help')) { if ($temp = module_invoke($name, 'help', $path)) { $output .= $temp ."\n"; } if (module_hook('help', 'page')) { if (arg(0) == "admin") { if (module_invoke($name, 'help', 'admin/help#'. arg(2)) && !empty($output)) { $output .= theme("more_help_link", url('admin/help/'. arg(2))); } } } } } return $output; } /** * Build a list of named menus. */ function menu_get_names($reset = FALSE) { static $names; if ($reset || empty($names)) { $names = array(); $result = db_query("SELECT DISTINCT(menu_name) FROM {menu_links} ORDER BY menu_name"); while ($name = db_fetch_array($result)) { $names[] = $name['menu_name']; } } return $names; } function menu_primary_links() { $tree = menu_tree_page_data('primary_links'); $links = array(); foreach ($tree as $item) { $l = $item['link']['options']; $l['href'] = $item['link']['href']; $l['title'] = $item['link']['title']; $links[] = $l; } return $links; } function menu_secondary_links() { $tree = menu_tree_page_data('secondary_links'); $links = array(); foreach ($tree as $item) { $l = $item['link']['options']; $l['href'] = $item['link']['href']; $l['title'] = $item['link']['title']; $links[] = $l; } return $links; } /** * Collects the local tasks (tabs) for a given level. * * @param $level * The level of tasks you ask for. Primary tasks are 0, secondary are 1. * @return * An array of links to the tabs. */ function menu_local_tasks($level = 0) { static $tabs = array(); if (empty($tabs)) { $router_item = menu_get_item(); if (!$router_item || !$router_item['access']) { return array(); } // Get all tabs $result = db_query("SELECT * FROM {menu_router} WHERE tab_root = '%s' AND tab_parent != '' ORDER BY weight, title", $router_item['tab_root']); $map = arg(); $children = array(); $tab_parent = array(); while ($item = db_fetch_array($result)) { $children[$item['tab_parent']][$item['path']] = $item; $tab_parent[$item['path']] = $item['tab_parent']; } // Find all tabs below the current path $path = $router_item['path']; while (isset($children[$path])) { $tabs_current = ''; $next_path = ''; foreach ($children[$path] as $item) { _menu_translate($item, $map, TRUE); if ($item['access']) { $link = l($item['title'], $item['href']); // TODO options? // The default task is always active. if ($item['type'] == MENU_DEFAULT_LOCAL_TASK) { $tabs_current .= theme('menu_local_task', $link, TRUE); $next_path = $item['path']; } else { $tabs_current .= theme('menu_local_task', $link); } } } $path = $next_path; $tabs[$item['number_parts']] = $tabs_current; } // Find all tabs at the same level or above the current one $parent = $router_item['tab_parent']; $path = $router_item['path']; $current = $router_item; while (isset($children[$parent])) { $tabs_current = ''; $next_path = ''; $next_parent = ''; foreach ($children[$parent] as $item) { _menu_translate($item, $map, TRUE); if ($item['access']) { $link = l($item['title'], $item['href']); // TODO options? // We check for the active tab. if ($item['path'] == $path) { $tabs_current .= theme('menu_local_task', $link, TRUE); $next_path = $item['tab_parent']; if (isset($tab_parent[$next_path])) { $next_parent = $tab_parent[$next_path]; } } else { $tabs_current .= theme('menu_local_task', $link); } } } $path = $next_path; $parent = $next_parent; $tabs[$item['number_parts']] = $tabs_current; } // Sort by depth ksort($tabs); // Remove the depth, we are interested only in their relative placement. $tabs = array_values($tabs); } return isset($tabs[$level]) ? $tabs[$level] : array(); } function menu_primary_local_tasks() { return menu_local_tasks(0); } function menu_secondary_local_tasks() { return menu_local_tasks(1); } /** * Returns the rendered local tasks. The default implementation renders * them as tabs. * * @ingroup themeable */ function theme_menu_local_tasks() { $output = ''; if ($primary = menu_primary_local_tasks()) { $output .= "\n"; } if ($secondary = menu_secondary_local_tasks()) { $output .= "\n"; } return $output; } function menu_set_active_menu_name($menu_name = NULL) { static $active; if (isset($menu_name)) { $active = $menu_name; } elseif (!isset($active)) { $active = 'navigation'; } return $active; } function menu_get_active_menu_name() { return menu_set_active_menu_name(); } function menu_set_active_item() { } function menu_set_active_trail($new_trail = NULL) { static $trail; if (isset($new_trail)) { $trail = $new_trail; } elseif (!isset($trail)) { $trail = array(); $trail[] = array('title' => t('Home'), 'href' => '', 'options' => array(), 'type' => 0); $item = menu_get_item(); // We are on a tab. if ($item['tab_parent']) { $href = $item['tab_root']; } else { $href = $item['href']; } $tree = menu_tree_page_data(menu_get_active_menu_name()); $curr = array_shift($tree); while ($curr) { if ($curr['link']['href'] == $href) { $trail[] = $curr['link']; $curr = FALSE; } else { if ($curr['below'] && $curr['link']['in_active_trail']) { $trail[] = $curr['link']; $tree = $curr['below']; } $curr = array_shift($tree); } } } return $trail; } function menu_get_active_trail() { return menu_set_active_trail(); } function menu_set_location() { } function menu_get_active_breadcrumb() { $breadcrumb = array(); $item = menu_get_item(); if ($item && $item['access']) { $active_trail = menu_get_active_trail(); foreach ($active_trail as $parent) { $breadcrumb[] = l($parent['title'], $parent['href'], $parent['options']); } $end = end($active_trail); // Don't show a link to the current page in the breadcrumb trail. if ($item['href'] == $end['href'] || ($item['type'] == MENU_DEFAULT_LOCAL_TASK && $end['href'] != '')) { array_pop($breadcrumb); } } return $breadcrumb; } function menu_get_active_title() { $active_trail = menu_get_active_trail(); foreach (array_reverse($active_trail) as $item) { if (!(bool)($item['type'] & MENU_IS_LOCAL_TASK)) { return $item['title']; } } } /** * Get a menu link by its mlid, access checked and link translated for * rendering. * * @param $mlid * The mlid of the menu item. * @return * A menu link, with $item['access'] filled and link translated for * rendering. */ function menu_link_load($mlid) { if ($item = db_fetch_array(db_query("SELECT * FROM {menu_links} ml LEFT JOIN {menu_router} m ON m.path = ml.router_path WHERE ml.mlid = %d", $mlid))) { _menu_link_translate($item); return $item; } return FALSE; } function menu_cache_clear($menu_name = 'navigation') { cache_clear_all('links:'. $menu_name .':', 'cache_menu', TRUE); } /** * This should be called any time broad changes might have been made to the * router items or menu links. */ function menu_cache_clear_all() { cache_clear_all('*', 'cache_menu', TRUE); } /** * Populate the database representation of the {menu_router} table (router items) * and the navigation menu in the {menu_links} table. */ function menu_rebuild() { menu_cache_clear_all(); $menu = menu_router_build(TRUE); _menu_navigation_links_rebuild($menu); } /** * Collect, alter and store the menu definitions. */ function menu_router_build($reset = FALSE) { static $menu; if (!isset($menu) || $reset) { $cache = cache_get('router:', 'cache_menu'); if (!$reset && $cache && isset($cache->data)) { $menu = $cache->data; } else { db_query('DELETE FROM {menu_router}'); // We need to manually call each module so that we can know which module a given item came from. $callbacks = array(); foreach (module_implements('menu') as $module) { $router_items = call_user_func($module . '_menu'); if (isset($router_items) && is_array($router_items)) { foreach (array_keys($router_items) as $path) { $router_items[$path]['module'] = $module; } $callbacks = array_merge($callbacks, $router_items); } } // Alter the menu as defined in modules, keys are like user/%user. drupal_alter('menu', $callbacks); $menu = _menu_router_build($callbacks); cache_set('router:', $menu, 'cache_menu'); } } return $menu; } function _menu_navigation_links_rebuild($menu) { // Add normal and suggested items as links. $menu_links = array(); foreach ($menu as $path => $item) { if ($item['type'] == MENU_CALLBACK) { $item['hidden'] = -1; } elseif ($item['type'] == MENU_SUGGESTED_ITEM) { $item['hidden'] = 1; } // Note, we set this as 'system', so that we can be sure to distinguish all // the menu links generated automatically from entries in {menu_router}. $item['module'] = 'system'; $item += array( 'menu_name' => 'navigation', 'link_title' => $item['title'], 'link_path' => $path, 'hidden' => 0, 'options' => empty($item['description']) ? array() : array('attributes' => array('title' => $item['description'])), ); // We add nonexisting items. if ($item['_visible'] && !db_result(db_query("SELECT COUNT(*) FROM {menu_links} WHERE menu_name = '%s' AND link_path = '%s'", $item['menu_name'], $item['link_path']))) { $menu_links[$path] = $item; $sort[$path] = $item['_number_parts']; } } if ($menu_links) { // Make sure no child comes before its parent. array_multisort($sort, SORT_NUMERIC, $menu_links); foreach ($menu_links as $item) { menu_link_save($item); } } $placeholders = implode(', ', array_fill(0, count($menu), "'%s'")); // Remove items if their router path does not exist any more. db_query('DELETE FROM {menu_links} WHERE router_path NOT IN ('. $placeholders .')', array_keys($menu)); } /** * Delete one or several menu links. * * @param $mlid * A valid menu link mlid or NULL. If NULL, $path is used. * @param $path * The path to the menu items to be deleted. $mlid must be NULL. */ function menu_link_delete($mlid, $path = NULL) { if (isset($mlid)) { _menu_delete_item(db_fetch_array(db_query("SELECT * FROM {menu_links} WHERE mlid = %d", $mlid))); } else { $result = db_query("SELECT * FROM {menu_links} WHERE link_path = '%s'", $path); while ($link = db_fetch_array($result)) { _menu_delete_item($link); } } } function _menu_delete_item($item) { // System-created items get automatically deleted, but only on menu rebuild. if ($item && $item['module'] != 'system') { // Children get re-attached to the item's parent if ($item['has_children']) { $result = db_query("SELECT mlid FROM {menu_links} WHERE plid = %d", $item['mlid']); while ($m = db_fetch_array($result)) { $child = menu_link_load($m['mlid']); $child['plid'] = $item['plid']; menu_link_save($child); } } db_query('DELETE FROM {menu_links} WHERE mlid = %d', $item['mlid']); // Update the has_children status of the parent $children = (bool)db_result(db_query("SELECT COUNT(*) FROM {menu_links} WHERE plid = %d AND hidden = 0", $item['plid'])); db_query("UPDATE {menu_links} SET has_children = %d WHERE mlid = %d", $children, $item['plid']); menu_cache_clear($item['menu_name']); } } /** * Save a menu link. * * @param $item * An array representing a menu link item. The only mandatory keys are * link_path and link_title. Possible keys are * menu_name default is navigation * weight default is 0 * expanded whether the item is expanded. * options An array of options, @see l for more. * mlid If it's an existing item, this comes from the database. * Never set by hand. * plid The mlid of the parent. * router_path The path of the relevant router item. */ function menu_link_save(&$item) { $menu = menu_router_build(); drupal_alter('menu_link', $item, $menu); $item['_external'] = menu_path_is_external($item['link_path']); // Load defaults. $item += array( 'menu_name' => 'navigation', 'weight' => 0, 'link_title' => '', 'hidden' => 0, 'has_children' => 0, 'expanded' => 0, 'options' => array(), 'module' => 'menu', ); $menu_name = $item['menu_name']; $existing_item = FALSE; if (isset($item['mlid'])) { $existing_item = db_fetch_array(db_query("SELECT * FROM {menu_links} WHERE mlid = %d", $item['mlid'])); } else { $existing_item = db_fetch_array(db_query("SELECT * FROM {menu_links} WHERE menu_name = '%s' AND link_path = '%s'", $menu_name, $item['link_path'])); } if (!$existing_item) { $item['mlid'] = db_next_id('{menu_links}_mlid'); } else { $item['mlid'] = $existing_item['mlid']; } // Find the parent - it must be in the same menu. if (isset($item['plid'])) { $parent = db_fetch_array(db_query("SELECT * FROM {menu_links} WHERE menu_name = '%s' AND mlid = %d", $menu_name, $item['plid'])); } else { $parent_path = $item['link_path']; do { $parent_path = substr($parent_path, 0, strrpos($parent_path, '/')); $parent = db_fetch_array(db_query("SELECT * FROM {menu_links} WHERE menu_name = '%s' AND link_path = '%s'", $menu_name, $parent_path)); } while ($parent === FALSE && $parent_path); } // Menu callbacks need to be in the links table for breadcrumbs, but can't // be parents if they are generated directly from a router item if (empty($parent['mlid']) || $parent['hidden'] < 0) { $item['plid'] = 0; } else { $item['plid'] = $parent['mlid']; } if (!$item['plid']) { $item['p1'] = $item['mlid']; $item['p2'] = $item['p3'] = $item['p4'] = $item['p5'] = $item['p6'] = 0; $item['depth'] = 1; } else { // Cannot add beyond the maximum depth. if ($item['has_children'] && $existing_item) { $limit = MENU_MAX_DEPTH - menu_link_children_relative_depth($existing_item) - 1; } else { $limit = MENU_MAX_DEPTH - 1; } if ($parent['depth'] > $limit) { return FALSE; } $item['depth'] = $parent['depth'] + 1; _menu_link_parents_set($item, $parent); } // Need to check both plid and menu_name, since plid can be 0 in any menu. if ($existing_item && ($item['plid'] != $existing_item['plid'] || $menu_name != $existing_item['menu_name'])) { _menu_link_move_children($item, $existing_item); } // Find the callback. if (empty($item['router_path']) || !$existing_item || ($existing_item['link_path'] != $item['link_path'])) { if ($item['_external']) { $item['router_path'] = ''; } else { // Find the router path which will serve this path. $item['parts'] = explode('/', $item['link_path'], MENU_MAX_PARTS); $item['router_path'] = $item['link_path']; if (!isset($menu[$item['router_path']])) { list($ancestors) = menu_get_ancestors($item['parts']); while ($ancestors && (empty($menu[$item['router_path']]))) { $item['router_path'] = array_shift($ancestors); } } if (empty($item['router_path'])) { return FALSE; } } } if ($existing_item) { db_query("UPDATE {menu_links} SET menu_name = '%s', plid = %d, link_path = '%s', router_path = '%s', hidden = %d, external = %d, has_children = %d, expanded = %d, weight = %d, depth = %d, p1 = %d, p2 = %d, p3 = %d, p4 = %d, p5 = %d, p6 = %d, module = '%s', link_title = '%s', options = '%s' WHERE mlid = %d", $item['menu_name'], $item['plid'], $item['link_path'], $item['router_path'], $item['hidden'], $item['_external'], $item['has_children'], $item['expanded'], $item['weight'], $item['depth'], $item['p1'], $item['p2'], $item['p3'], $item['p4'], $item['p5'], $item['p6'], $item['module'], $item['link_title'], serialize($item['options']), $item['mlid']); } else { db_query("INSERT INTO {menu_links} ( menu_name, mlid, plid, link_path, router_path, hidden, external, has_children, expanded, weight, depth, p1, p2, p3, p4, p5, p6, module, link_title, options) VALUES ( '%s', %d, %d, '%s', '%s', %d, %d, %d, %d, %d, %d, %d, %d, %d, %d, %d, %d, '%s', '%s', '%s')", $item['menu_name'], $item['mlid'], $item['plid'], $item['link_path'], $item['router_path'], $item['hidden'], $item['_external'], $item['has_children'], $item['expanded'], $item['weight'], $item['depth'], $item['p1'], $item['p2'], $item['p3'], $item['p4'], $item['p5'], $item['p6'], $item['module'], $item['link_title'], serialize($item['options'])); } // Check the has_children status of the parent. if ($item['plid']) { $parent_has_children = (bool)db_result(db_query("SELECT COUNT(*) FROM {menu_links} WHERE plid = %d AND hidden = 0", $item['plid'])); db_query("UPDATE {menu_links} SET has_children = %d WHERE mlid = %d", $parent_has_children, $item['plid']); } menu_cache_clear($menu_name); if ($existing_item && $menu_name != $existing_item['menu_name']) { menu_cache_clear($existing_item['menu_name']); } // Keep track of which menus have expanded items. $names = array(); $result = db_query("SELECT menu_name FROM {menu_links} WHERE expanded != 0 GROUP BY menu_name"); while ($n = db_fetch_array($result)) { $names[] = $n['menu_name']; } variable_set('menu_expanded', $names); return TRUE; } /** * Find the depth of an item's children relative to its depth. For example, if * the item has a depth of 2, and the maximum of any child in the menu link tree * is 5, the relative depth is 3. * * @param $item * An array representing a menu link item. * @return * The relative depth, or zero. * */ function menu_link_children_relative_depth($item) { $i = 1; $match = ''; $args[] = $item['menu_name']; $p = 'p1'; while ($i <= MENU_MAX_DEPTH && $item[$p]) { $match .= " AND $p = %d"; $args[] = $item[$p]; $p = 'p'. ++$i; } $max_depth = db_result(db_query_range("SELECT depth FROM {menu_links} WHERE menu_name = '%s'". $match ." ORDER BY depth DESC", $args, 0, 1)); return ($max_depth > $item['depth']) ? $max_depth - $item['depth'] : 0; } /** * Update the menu name, parents (p1 - p6), and depth for the children of * a menu link that's being moved in the tree and check the has_children status * of the previous parent. */ function _menu_link_move_children($item, $existing_item) { $args[] = $item['menu_name']; $set = ''; $shift = $item['depth'] - $existing_item['depth']; if ($shift < 0) { $args[] = -$shift; $set = ', depth = depth - %d'; } elseif ($shift > 0) { $args[] = $shift; $set = ', depth = depth + %d'; } $i = 1; while ($i <= $item['depth']) { $p = 'p'. $i++; $set .= ", $p = %d"; $args[] = $item[$p]; } $j = $existing_item['depth'] + 1; while ($i <= MENU_MAX_DEPTH && $j <= MENU_MAX_DEPTH) { $set .= ', p'. $i++ .' = p'. $j++; } while ($i <= MENU_MAX_DEPTH) { $set .= ', p'. $i++ .' = 0'; } $args[] = $existing_item['menu_name']; $i = 1; $match = ''; $p = 'p1'; while ($i <= MENU_MAX_DEPTH && $existing_item[$p]) { $match .= " AND $p = %d"; $args[] = $existing_item[$p]; $p = 'p'. ++$i; } db_query("UPDATE {menu_links} SET menu_name = '%s'". $set ." WHERE menu_name = '%s'". $match, $args); if ($existing_item['plid']) { $parent_has_children = (bool)db_result(db_query("SELECT COUNT(*) FROM {menu_links} WHERE plid = %d AND hidden = 0 AND mlid != %d", $existing_item['plid'], $existing_item['mlid'])); db_query("UPDATE {menu_links} SET has_children = %d WHERE mlid = %d", $parent_has_children, $existing_item['plid']); } } function _menu_link_parents_set(&$item, $parent) { $i = 1; while ($i < $item['depth']) { $p = 'p'. $i++; $item[$p] = $parent[$p]; } $p = 'p'. $i++; // The parent (p1 - p6) corresponding to the depth always equals the mlid. $item[$p] = $item['mlid']; while ($i <= MENU_MAX_DEPTH) { $p = 'p'. $i++; $item[$p] = 0; } } function _menu_router_build($callbacks) { // First pass: separate callbacks from paths, making paths ready for // matching. Calculate fitness, and fill some default values. $menu = array(); foreach ($callbacks as $path => $item) { $load_functions = array(); $to_arg_functions = array(); $fit = 0; $move = FALSE; $parts = explode('/', $path, MENU_MAX_PARTS); $number_parts = count($parts); // We store the highest index of parts here to save some work in the fit // calculation loop. $slashes = $number_parts - 1; // extract functions foreach ($parts as $k => $part) { $match = FALSE; if (preg_match('/^%([a-z_]*)$/', $part, $matches)) { if (empty($matches[1])) { $match = TRUE; $load_functions[$k] = NULL; } else { if (function_exists($matches[1] .'_to_arg')) { $to_arg_functions[$k] = $matches[1] .'_to_arg'; $load_functions[$k] = NULL; $match = TRUE; } if (function_exists($matches[1] .'_load')) { $load_functions[$k] = $matches[1] .'_load'; $match = TRUE; } } } if ($match) { $parts[$k] = '%'; } else { $fit |= 1 << ($slashes - $k); } } if ($fit) { $move = TRUE; } else { // If there is no %, it fits maximally. $fit = (1 << $number_parts) - 1; } $item['load_functions'] = empty($load_functions) ? '' : serialize($load_functions); $item['to_arg_functions'] = empty($to_arg_functions) ? '' : serialize($to_arg_functions); $item += array( 'title' => '', 'weight' => 0, 'type' => MENU_NORMAL_ITEM, '_number_parts' => $number_parts, '_parts' => $parts, '_fit' => $fit, ); $item += array( '_visible' => (bool)($item['type'] & MENU_VISIBLE_IN_BREADCRUMB), '_tab' => (bool)($item['type'] & MENU_IS_LOCAL_TASK), ); if ($move) { $new_path = implode('/', $item['_parts']); $menu[$new_path] = $item; $sort[$new_path] = $number_parts; } else { $menu[$path] = $item; $sort[$path] = $number_parts; } } array_multisort($sort, SORT_NUMERIC, $menu); // Apply inheritance rules. foreach ($menu as $path => $v) { $item = &$menu[$path]; if (!isset($item['access callback']) && isset($item['access arguments'])) { $item['access callback'] = 'user_access'; // Default callback } if (!$item['_tab']) { // Non-tab items $item['tab_parent'] = ''; $item['tab_root'] = $path; } for ($i = $item['_number_parts'] - 1; $i; $i--) { $parent_path = implode('/', array_slice($item['_parts'], 0, $i)); if (isset($menu[$parent_path])) { $parent = $menu[$parent_path]; if (!isset($item['tab_parent'])) { // parent stores the parent of the path. $item['tab_parent'] = $parent_path; } if (!isset($item['tab_root']) && !$parent['_tab']) { $item['tab_root'] = $parent_path; } // If a callback is not found, we try to find the first parent that // has a callback. if (!isset($item['access callback']) && isset($parent['access callback'])) { $item['access callback'] = $parent['access callback']; if (!isset($item['access arguments']) && isset($parent['access arguments'])) { $item['access arguments'] = $parent['access arguments']; } } // Same for page callbacks. if (!isset($item['page callback']) && isset($parent['page callback'])) { $item['page callback'] = $parent['page callback']; if (!isset($item['page arguments']) && isset($parent['page arguments'])) { $item['page arguments'] = $parent['page arguments']; } if (!isset($item['file']) && isset($parent['file'])) { $item['file'] = $parent['file']; } if (!isset($item['file path']) && isset($parent['file path'])) { $item['file path'] = $parent['file path']; } } } } if (!isset($item['access callback']) || empty($item['page callback'])) { $item['access callback'] = 0; } if (is_bool($item['access callback'])) { $item['access callback'] = intval($item['access callback']); } $item += array( 'access arguments' => array(), 'access callback' => '', 'page arguments' => array(), 'page callback' => '', 'block callback' => '', 'title arguments' => array(), 'title callback' => 't', 'description' => '', 'position' => '', 'tab_parent' => '', 'tab_root' => $path, 'path' => $path, 'file' => '', 'file path' => '', 'include file' => '', ); // Calculate out the file to be included for each callback, if any. if ($item['file']) { $file_path = $item['file path'] ? $item['file path'] : drupal_get_path('module', $item['module']); $item['include file'] = $file_path . '/' . $item['file']; } db_query("INSERT INTO {menu_router} (path, load_functions, to_arg_functions, access_callback, access_arguments, page_callback, page_arguments, fit, number_parts, tab_parent, tab_root, title, title_callback, title_arguments, type, block_callback, description, position, weight, file) VALUES ('%s', '%s', '%s', '%s', '%s', '%s', '%s', %d, %d, '%s', '%s', '%s', '%s', '%s', %d, '%s', '%s', '%s', %d, '%s')", $path, $item['load_functions'], $item['to_arg_functions'], $item['access callback'], serialize($item['access arguments']), $item['page callback'], serialize($item['page arguments']), $item['_fit'], $item['_number_parts'], $item['tab_parent'], $item['tab_root'], $item['title'], $item['title callback'], serialize($item['title arguments']), $item['type'], $item['block callback'], $item['description'], $item['position'], $item['weight'], $item['include file']); } return $menu; } function menu_path_is_external($path) { $colonpos = strpos($path, ':'); return $colonpos !== FALSE && !preg_match('![/?#]!', substr($path, 0, $colonpos)) && filter_xss_bad_protocol($path, FALSE) == check_plain($path); } /** * Returns TRUE if the site is off-line for maintenance. */ function _menu_site_is_offline() { // Check if site is set to off-line mode if (variable_get('site_offline', 0)) { // Check if the user has administration privileges if (!user_access('administer site configuration')) { // Check if this is an attempt to login if (drupal_get_normal_path($_GET['q']) != 'user') { return TRUE; } } else { $offline_message = t('Operating in off-line mode.'); $messages = drupal_set_message(); // Ensure that the off-line message is displayed only once [allowing for page redirects]. if (!isset($messages) || !isset($messages['status']) || !in_array($offline_message, $messages['status'])) { drupal_set_message($offline_message); } } } return FALSE; }