2904 lines
95 KiB
PHP
2904 lines
95 KiB
PHP
<?php
|
|
// $Id$
|
|
|
|
/**
|
|
* @file
|
|
* API for the Drupal menu system.
|
|
*/
|
|
|
|
/**
|
|
* @defgroup menu Menu system
|
|
* @{
|
|
* Define the navigation menus, and route page requests to code based on URLs.
|
|
*
|
|
* The Drupal menu system drives both the navigation system from a user
|
|
* perspective and the callback system that Drupal uses to respond to URLs
|
|
* passed from the browser. For this reason, a good understanding of the
|
|
* menu system is fundamental to the creation of complex modules.
|
|
*
|
|
* Drupal's menu system follows a simple hierarchy defined by paths.
|
|
* Implementations of hook_menu() define menu items and assign them to
|
|
* paths (which should be unique). The menu system aggregates these items
|
|
* and determines the menu hierarchy from the paths. For example, if the
|
|
* paths defined were a, a/b, e, a/b/c/d, f/g, and a/b/h, the menu system
|
|
* would form the structure:
|
|
* - a
|
|
* - a/b
|
|
* - a/b/c/d
|
|
* - a/b/h
|
|
* - e
|
|
* - f/g
|
|
* Note that the number of elements in the path does not necessarily
|
|
* determine the depth of the menu item in the tree.
|
|
*
|
|
* When responding to a page request, the menu system looks to see if the
|
|
* path requested by the browser is registered as a menu item with a
|
|
* callback. If not, the system searches up the menu tree for the most
|
|
* complete match with a callback it can find. If the path a/b/i is
|
|
* requested in the tree above, the callback for a/b would be used.
|
|
*
|
|
* The found callback function is called with any arguments specified
|
|
* in the "page arguments" attribute of its menu item. The
|
|
* attribute must be an array. After these arguments, any remaining
|
|
* components of the path are appended as further arguments. In this
|
|
* way, the callback for a/b above could respond to a request for
|
|
* a/b/i differently than a request for a/b/j.
|
|
*
|
|
* For an illustration of this process, see page_example.module.
|
|
*
|
|
* Access to the callback functions is also protected by the menu system.
|
|
* The "access callback" with an optional "access arguments" of each menu
|
|
* item is called before the page callback proceeds. If this returns TRUE,
|
|
* then access is granted; if FALSE, then access is denied. Menu items may
|
|
* omit this attribute to use the value provided by an ancestor item.
|
|
*
|
|
* In the default Drupal interface, you will notice many links rendered as
|
|
* tabs. These are known in the menu system as "local tasks", and they are
|
|
* rendered as tabs by default, though other presentations are possible.
|
|
* Local tasks function just as other menu items in most respects. It is
|
|
* convention that the names of these tasks should be short verbs if
|
|
* possible. In addition, a "default" local task should be provided for
|
|
* each set. When visiting a local task's parent menu item, the default
|
|
* local task will be rendered as if it is selected; this provides for a
|
|
* normal tab user experience. This default task is special in that it
|
|
* links not to its provided path, but to its parent item's path instead.
|
|
* The default task's path is only used to place it appropriately in the
|
|
* menu hierarchy.
|
|
*
|
|
* Everything described so far is stored in the menu_router table. The
|
|
* menu_links table holds the visible menu links. By default these are
|
|
* derived from the same hook_menu definitions, however you are free to
|
|
* add more with menu_link_save().
|
|
*/
|
|
|
|
/**
|
|
* @name Menu flags
|
|
* @{
|
|
* Flags for use in the "type" attribute of menu items.
|
|
*/
|
|
|
|
/**
|
|
* Internal menu flag -- menu item is the root of the menu tree.
|
|
*/
|
|
define('MENU_IS_ROOT', 0x0001);
|
|
|
|
/**
|
|
* Internal menu flag -- menu item is visible in the menu tree.
|
|
*/
|
|
define('MENU_VISIBLE_IN_TREE', 0x0002);
|
|
|
|
/**
|
|
* Internal menu flag -- menu item is visible in the breadcrumb.
|
|
*/
|
|
define('MENU_VISIBLE_IN_BREADCRUMB', 0x0004);
|
|
|
|
/**
|
|
* Internal menu flag -- menu item links back to its parnet.
|
|
*/
|
|
define('MENU_LINKS_TO_PARENT', 0x0008);
|
|
|
|
/**
|
|
* Internal menu flag -- menu item can be modified by administrator.
|
|
*/
|
|
define('MENU_MODIFIED_BY_ADMIN', 0x0020);
|
|
|
|
/**
|
|
* Internal menu flag -- menu item was created by administrator.
|
|
*/
|
|
define('MENU_CREATED_BY_ADMIN', 0x0040);
|
|
|
|
/**
|
|
* Internal menu flag -- menu item is a local task.
|
|
*/
|
|
define('MENU_IS_LOCAL_TASK', 0x0080);
|
|
|
|
/**
|
|
* Internal menu flag -- menu item is a local action.
|
|
*/
|
|
define('MENU_IS_LOCAL_ACTION', 0x0100);
|
|
|
|
/**
|
|
* @} End of "Menu flags".
|
|
*/
|
|
|
|
/**
|
|
* @name Menu item types
|
|
* @{
|
|
* Menu item definitions provide one of these constants, which are shortcuts for
|
|
* combinations of the above flags.
|
|
*/
|
|
|
|
/**
|
|
* Menu type -- A "normal" menu item that's shown in menu and breadcrumbs.
|
|
*
|
|
* Normal menu items show up in the menu tree and can be moved/hidden by
|
|
* the administrator. Use this for most menu items. It is the default value if
|
|
* no menu item type is specified.
|
|
*/
|
|
define('MENU_NORMAL_ITEM', MENU_VISIBLE_IN_TREE | MENU_VISIBLE_IN_BREADCRUMB);
|
|
|
|
/**
|
|
* Menu type -- A hidden, internal callback, typically used for API calls.
|
|
*
|
|
* Callbacks simply register a path so that the correct function is fired
|
|
* when the URL is accessed. They are not shown in the menu.
|
|
*/
|
|
define('MENU_CALLBACK', MENU_VISIBLE_IN_BREADCRUMB);
|
|
|
|
/**
|
|
* Menu type -- A normal menu item, hidden until enabled by an administrator.
|
|
*
|
|
* Modules may "suggest" menu items that the administrator may enable. They act
|
|
* just as callbacks do until enabled, at which time they act like normal items.
|
|
* Note for the value: 0x0010 was a flag which is no longer used, but this way
|
|
* the values of MENU_CALLBACK and MENU_SUGGESTED_ITEM are separate.
|
|
*/
|
|
define('MENU_SUGGESTED_ITEM', MENU_VISIBLE_IN_BREADCRUMB | 0x0010);
|
|
|
|
/**
|
|
* Menu type -- A task specific to the parent item, usually rendered as a tab.
|
|
*
|
|
* Local tasks are menu items that describe actions to be performed on their
|
|
* parent item. An example is the path "node/52/edit", which performs the
|
|
* "edit" task on "node/52".
|
|
*/
|
|
define('MENU_LOCAL_TASK', MENU_IS_LOCAL_TASK);
|
|
|
|
/**
|
|
* Menu type -- The "default" local task, which is initially active.
|
|
*
|
|
* Every set of local tasks should provide one "default" task, that links to the
|
|
* same path as its parent when clicked.
|
|
*/
|
|
define('MENU_DEFAULT_LOCAL_TASK', MENU_IS_LOCAL_TASK | MENU_LINKS_TO_PARENT);
|
|
|
|
/**
|
|
* Menu type -- An action specific to the parent, usually rendered as a link.
|
|
*
|
|
* Local actions are menu items that describe actions on the parent item such
|
|
* as adding a new user, taxonomy term, etc.
|
|
*/
|
|
define('MENU_LOCAL_ACTION', MENU_IS_LOCAL_TASK | MENU_IS_LOCAL_ACTION);
|
|
|
|
/**
|
|
* @} End of "Menu item types".
|
|
*/
|
|
|
|
/**
|
|
* @name Menu status codes
|
|
* @{
|
|
* Status codes for menu callbacks.
|
|
*/
|
|
|
|
/**
|
|
* Internal menu status code -- Menu item was found.
|
|
*/
|
|
define('MENU_FOUND', 1);
|
|
|
|
/**
|
|
* Internal menu status code -- Menu item was not found.
|
|
*/
|
|
define('MENU_NOT_FOUND', 2);
|
|
|
|
/**
|
|
* Internal menu status code -- Menu item access is denied.
|
|
*/
|
|
define('MENU_ACCESS_DENIED', 3);
|
|
|
|
/**
|
|
* Internal menu status code -- Menu item inaccessible because site is offline.
|
|
*/
|
|
define('MENU_SITE_OFFLINE', 4);
|
|
|
|
/**
|
|
* @} End of "Menu status codes".
|
|
*/
|
|
|
|
/**
|
|
* @Name Menu tree parameters
|
|
* @{
|
|
* Menu tree
|
|
*/
|
|
|
|
/**
|
|
* The maximum number of path elements for a menu callback
|
|
*/
|
|
define('MENU_MAX_PARTS', 9);
|
|
|
|
|
|
/**
|
|
* The maximum depth of a menu links tree - matches the number of p columns.
|
|
*/
|
|
define('MENU_MAX_DEPTH', 9);
|
|
|
|
|
|
/**
|
|
* @} End of "Menu tree parameters".
|
|
*/
|
|
|
|
/**
|
|
* Returns the ancestors (and relevant placeholders) for any given path.
|
|
*
|
|
* For example, the ancestors of node/12345/edit are:
|
|
* - node/12345/edit
|
|
* - node/12345/%
|
|
* - node/%/edit
|
|
* - node/%/%
|
|
* - node/12345
|
|
* - node/%
|
|
* - node
|
|
*
|
|
* To generate these, we will use binary numbers. Each bit represents a
|
|
* part of the path. If the bit is 1, then it represents the original
|
|
* value while 0 means wildcard. If the path is node/12/edit/foo
|
|
* then the 1011 bitstring represents node/%/edit/foo where % means that
|
|
* any argument matches that part. We limit ourselves to using binary
|
|
* numbers that correspond the patterns of wildcards of router items that
|
|
* actually exists. This list of 'masks' is built in menu_rebuild().
|
|
*
|
|
* @param $parts
|
|
* An array of path parts, for the above example
|
|
* array('node', '12345', 'edit').
|
|
* @return
|
|
* An array which contains the ancestors and placeholders. Placeholders
|
|
* simply contain as many '%s' as the ancestors.
|
|
*/
|
|
function menu_get_ancestors($parts) {
|
|
$number_parts = count($parts);
|
|
$ancestors = array();
|
|
$length = $number_parts - 1;
|
|
$end = (1 << $number_parts) - 1;
|
|
$masks = variable_get('menu_masks', array());
|
|
// Only examine patterns that actually exist as router items (the masks).
|
|
foreach ($masks as $i) {
|
|
if ($i > $end) {
|
|
// Only look at masks that are not longer than the path of interest.
|
|
continue;
|
|
}
|
|
elseif ($i < (1 << $length)) {
|
|
// We have exhausted the masks of a given length, so decrease the length.
|
|
--$length;
|
|
}
|
|
$current = '';
|
|
for ($j = $length; $j >= 0; $j--) {
|
|
if ($i & (1 << $j)) {
|
|
$current .= $parts[$length - $j];
|
|
}
|
|
else {
|
|
$current .= '%';
|
|
}
|
|
if ($j) {
|
|
$current .= '/';
|
|
}
|
|
}
|
|
$ancestors[] = $current;
|
|
}
|
|
return $ancestors;
|
|
}
|
|
|
|
/**
|
|
* 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();
|
|
}
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
* Replaces the statically cached item for a given path.
|
|
*
|
|
* @param $path
|
|
* The path.
|
|
* @param $router_item
|
|
* The router item. Usually you take a router entry from menu_get_item and
|
|
* set it back either modified or to a different path. This lets you modify the
|
|
* navigation block, the page title, the breadcrumb and the page help in one
|
|
* call.
|
|
*/
|
|
function menu_set_item($path, $router_item) {
|
|
menu_get_item($path, $router_item);
|
|
}
|
|
|
|
/**
|
|
* Get a router item.
|
|
*
|
|
* @param $path
|
|
* The path, for example node/5. The function will find the corresponding
|
|
* node/% item and return that.
|
|
* @param $router_item
|
|
* Internal use only.
|
|
* @return
|
|
* The router item, an associate array corresponding to one row in the
|
|
* menu_router table. The value of key map holds the loaded objects. The
|
|
* value of key access is TRUE if the current user can access this page.
|
|
* The values for key title, page_arguments, access_arguments will be
|
|
* filled in based on the database values and the objects loaded.
|
|
*/
|
|
function menu_get_item($path = NULL, $router_item = NULL) {
|
|
$router_items = &drupal_static(__FUNCTION__);
|
|
if (!isset($path)) {
|
|
$path = $_GET['q'];
|
|
}
|
|
if (isset($router_item)) {
|
|
$router_items[$path] = $router_item;
|
|
}
|
|
if (!isset($router_items[$path])) {
|
|
$original_map = arg(NULL, $path);
|
|
$parts = array_slice($original_map, 0, MENU_MAX_PARTS);
|
|
$ancestors = menu_get_ancestors($parts);
|
|
$router_item = db_select('menu_router')
|
|
->fields('menu_router')
|
|
->condition('path', $ancestors, 'IN')
|
|
->orderBy('fit', 'DESC')
|
|
->range(0, 1)
|
|
->addTag('menu_get_item')
|
|
->execute()->fetchAssoc();
|
|
if ($router_item) {
|
|
$map = _menu_translate($router_item, $original_map);
|
|
$router_item['original_map'] = $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;
|
|
}
|
|
// Rebuild if we know it's needed, or if the menu masks are missing which
|
|
// occurs rarely, likely due to a race condition of multiple rebuilds.
|
|
if (variable_get('menu_rebuild_needed', FALSE) || !variable_get('menu_masks', array())) {
|
|
menu_rebuild();
|
|
}
|
|
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.
|
|
* Names of object loading functions are placed in $item['load_functions'].
|
|
* Loaded objects are placed in $map[]; keys are the same as keys in the
|
|
* $item['load_functions'] array.
|
|
* $item['access'] is set to FALSE if an object cannot be loaded.
|
|
*/
|
|
function _menu_load_objects(&$item, &$map) {
|
|
if ($load_functions = $item['load_functions']) {
|
|
// If someone calls this function twice, then unserialize will fail.
|
|
if ($load_functions_unserialized = unserialize($load_functions)) {
|
|
$load_functions = $load_functions_unserialized;
|
|
}
|
|
$path_map = $map;
|
|
foreach ($load_functions as $index => $function) {
|
|
if ($function) {
|
|
$value = isset($path_map[$index]) ? $path_map[$index] : '';
|
|
if (is_array($function)) {
|
|
// Set up arguments for the load function. These were pulled from
|
|
// 'load arguments' in the hook_menu() entry, but they need
|
|
// some processing. In this case the $function is the key to the
|
|
// load_function array, and the value is the list of arguments.
|
|
list($function, $args) = each($function);
|
|
$load_functions[$index] = $function;
|
|
|
|
// Some arguments are placeholders for dynamic items to process.
|
|
foreach ($args as $i => $arg) {
|
|
if ($arg === '%index') {
|
|
// Pass on argument index to the load function, so multiple
|
|
// occurrences of the same placeholder can be identified.
|
|
$args[$i] = $index;
|
|
}
|
|
if ($arg === '%map') {
|
|
// Pass on menu map by reference. The accepting function must
|
|
// also declare this as a reference if it wants to modify
|
|
// the map.
|
|
$args[$i] = &$map;
|
|
}
|
|
if (is_int($arg)) {
|
|
$args[$i] = isset($path_map[$arg]) ? $path_map[$arg] : '';
|
|
}
|
|
}
|
|
array_unshift($args, $value);
|
|
$return = call_user_func_array($function, $args);
|
|
}
|
|
else {
|
|
$return = $function($value);
|
|
}
|
|
// 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;
|
|
}
|
|
}
|
|
$item['load_functions'] = $load_functions;
|
|
}
|
|
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 = empty($item['access_callback']) ? 0 : trim($item['access_callback']);
|
|
// Check for a TRUE or FALSE value.
|
|
if (is_numeric($callback)) {
|
|
$item['access'] = (bool)$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]);
|
|
}
|
|
elseif (function_exists($callback)) {
|
|
$item['access'] = call_user_func_array($callback, $arguments);
|
|
}
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Localize the router item title using t() or another callback.
|
|
*
|
|
* Translate the title and description to allow storage of English title
|
|
* strings in the database, yet display of them in the language required
|
|
* by the current user.
|
|
*
|
|
* @param $item
|
|
* A menu router item or a menu link item.
|
|
* @param $map
|
|
* The path as an array with objects already replaced. E.g., for path
|
|
* node/123 $map would be array('node', $node) where $node is the node
|
|
* object for node 123.
|
|
* @param $link_translate
|
|
* TRUE if we are translating a menu link item; FALSE if we are
|
|
* translating a menu router item.
|
|
* @return
|
|
* No return value.
|
|
* $item['title'] is localized according to $item['title_callback'].
|
|
* If an item's callback is check_plain(), $item['options']['html'] becomes
|
|
* TRUE.
|
|
* $item['description'] is translated using t().
|
|
* When doing link translation and the $item['options']['attributes']['title']
|
|
* (link title attribute) matches the description, it is translated as well.
|
|
*/
|
|
function _menu_item_localize(&$item, $map, $link_translate = FALSE) {
|
|
$callback = $item['title_callback'];
|
|
$item['localized_options'] = $item['options'];
|
|
// If we are translating the title of a menu link, and its title is the same
|
|
// as the corresponding router item, then we can use the title information
|
|
// from the router. If it's customized, then we need to use the link title
|
|
// itself; can't localize.
|
|
// If we are translating a router item (tabs, page, breadcrumb), then we
|
|
// can always use the information from the router item.
|
|
if (!$link_translate || ($item['title'] == $item['link_title'])) {
|
|
// 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'], menu_unserialize($item['title_arguments'], $map));
|
|
}
|
|
}
|
|
elseif ($callback && function_exists($callback)) {
|
|
if (empty($item['title_arguments'])) {
|
|
$item['title'] = $callback($item['title']);
|
|
}
|
|
else {
|
|
$item['title'] = call_user_func_array($callback, menu_unserialize($item['title_arguments'], $map));
|
|
}
|
|
// Avoid calling check_plain again on l() function.
|
|
if ($callback == 'check_plain') {
|
|
$item['localized_options']['html'] = TRUE;
|
|
}
|
|
}
|
|
}
|
|
elseif ($link_translate) {
|
|
$item['title'] = $item['link_title'];
|
|
}
|
|
|
|
// Translate description, see the motivation above.
|
|
if (!empty($item['description'])) {
|
|
$original_description = $item['description'];
|
|
$item['description'] = t($item['description']);
|
|
if ($link_translate && isset($item['options']['attributes']['title']) && $item['options']['attributes']['title'] == $original_description) {
|
|
$item['localized_options']['attributes']['title'] = $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) {
|
|
if ($to_arg) {
|
|
// Fill in missing path elements, such as the current uid.
|
|
_menu_link_map_translate($map, $router_item['to_arg_functions']);
|
|
}
|
|
// The $path_map saves the pieces of the path as strings, while elements in
|
|
// $map may be replaced with loaded objects.
|
|
$path_map = $map;
|
|
if (!_menu_load_objects($router_item, $map)) {
|
|
// An error occurred loading an object.
|
|
$router_item['access'] = FALSE;
|
|
return FALSE;
|
|
}
|
|
|
|
// 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);
|
|
$router_item['options'] = array();
|
|
_menu_check_access($router_item, $map);
|
|
|
|
// For performance, don't localize an item the user can't access.
|
|
if ($router_item['access']) {
|
|
_menu_item_localize($router_item, $map);
|
|
}
|
|
|
|
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(2 => 'menu_tail_to_arg'))
|
|
*/
|
|
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] : '', $map, $index);
|
|
if (!empty($map[$index]) || isset($arg)) {
|
|
$map[$index] = $arg;
|
|
}
|
|
else {
|
|
unset($map[$index]);
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
function menu_tail_to_arg($arg, $map, $index) {
|
|
return implode('/', array_slice($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.
|
|
* $item['options'] is unserialized; it is also changed within the call here
|
|
* to $item['localized_options'] by _menu_item_localize().
|
|
*/
|
|
function _menu_link_translate(&$item) {
|
|
$item['options'] = unserialize($item['options']);
|
|
if ($item['external']) {
|
|
$item['access'] = 1;
|
|
$map = array();
|
|
$item['href'] = $item['link_path'];
|
|
$item['title'] = $item['link_title'];
|
|
$item['localized_options'] = $item['options'];
|
|
}
|
|
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;
|
|
}
|
|
// menu_tree_check_access() may set this ahead of time for links to nodes.
|
|
if (!isset($item['access'])) {
|
|
if (!_menu_load_objects($item, $map)) {
|
|
// An error occurred loading an object.
|
|
$item['access'] = FALSE;
|
|
return FALSE;
|
|
}
|
|
_menu_check_access($item, $map);
|
|
}
|
|
// For performance, don't localize a link the user can't access.
|
|
if ($item['access']) {
|
|
_menu_item_localize($item, $map, TRUE);
|
|
}
|
|
}
|
|
|
|
// Allow other customizations - e.g. adding a page-specific query string to the
|
|
// options array. For performance reasons we only invoke this hook if the link
|
|
// has the 'alter' flag set in the options array.
|
|
if (!empty($item['options']['alter'])) {
|
|
drupal_alter('translated_menu_link', $item, $map);
|
|
}
|
|
|
|
return $map;
|
|
}
|
|
|
|
/**
|
|
* Get a loaded object from a router item.
|
|
*
|
|
* menu_get_object() provides access to objects loaded by the current router
|
|
* item. For example, on the page node/%node, the router loads the %node object,
|
|
* and calling menu_get_object() will return that. Normally, it is necessary to
|
|
* specify the type of object referenced, however node is the default.
|
|
* The following example tests to see whether the node being displayed is of the
|
|
* "story" content type:
|
|
* @code
|
|
* $node = menu_get_object();
|
|
* $story = $node->type == 'story';
|
|
* @endcode
|
|
*
|
|
* @param $type
|
|
* Type of the object. These appear in hook_menu definitions as %type. Core
|
|
* provides aggregator_feed, aggregator_category, contact, filter_format,
|
|
* forum_term, menu, menu_link, node, taxonomy_vocabulary, user. See the
|
|
* relevant {$type}_load function for more on each. Defaults to node.
|
|
* @param $position
|
|
* The position of the object in the path, where the first path segment is 0.
|
|
* For node/%node, the position of %node is 1, but for comment/reply/%node,
|
|
* it's 2. Defaults to 1.
|
|
* @param $path
|
|
* See menu_get_item() for more on this. Defaults to the current path.
|
|
*/
|
|
function menu_get_object($type = 'node', $position = 1, $path = NULL) {
|
|
$router_item = menu_get_item($path);
|
|
if (isset($router_item['load_functions'][$position]) && !empty($router_item['map'][$position]) && $router_item['load_functions'][$position] == $type . '_load') {
|
|
return $router_item['map'][$position];
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Render a menu tree based on the current path.
|
|
*
|
|
* 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) {
|
|
$menu_output = &drupal_static(__FUNCTION__, 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 = '';
|
|
$items = array();
|
|
|
|
// Pull out just the menu items we are going to render so that we
|
|
// get an accurate count for the first/last classes.
|
|
foreach ($tree as $data) {
|
|
if (!$data['link']['hidden']) {
|
|
$items[] = $data;
|
|
}
|
|
}
|
|
|
|
$num_items = count($items);
|
|
foreach ($items as $i => $data) {
|
|
$extra_class = array();
|
|
if ($i == 0) {
|
|
$extra_class[] = 'first';
|
|
}
|
|
if ($i == $num_items - 1) {
|
|
$extra_class[] = 'last';
|
|
}
|
|
$extra_class = implode(' ', $extra_class);
|
|
$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'], $extra_class);
|
|
}
|
|
else {
|
|
$output .= theme('menu_item', $link, $data['link']['has_children'], '', $data['link']['in_active_trail'], $extra_class);
|
|
}
|
|
}
|
|
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 $link
|
|
* 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 $max_depth
|
|
* Optional maximum depth of links to retrieve. Typically useful if only one
|
|
* or two levels of a sub tree are needed in conjunction with a non-NULL
|
|
* $link, in which case $max_depth should be greater than $link['depth'].
|
|
*
|
|
* @return
|
|
* An tree of menu links in an array, in the order they should be rendered.
|
|
*/
|
|
function menu_tree_all_data($menu_name, $link = NULL, $max_depth = NULL) {
|
|
$tree = &drupal_static(__FUNCTION__, array());
|
|
|
|
// Use $mlid as a flag for whether the data being loaded is for the whole tree.
|
|
$mlid = isset($link['mlid']) ? $link['mlid'] : 0;
|
|
// Generate a cache ID (cid) specific for this $menu_name, $item, and depth.
|
|
$cid = 'links:' . $menu_name . ':all-cid:' . $mlid . ':' . (int)$max_depth;
|
|
|
|
if (!isset($tree[$cid])) {
|
|
// If the static variable doesn't have the data, check {cache_menu}.
|
|
$cache = cache_get($cid, 'cache_menu');
|
|
if ($cache && isset($cache->data)) {
|
|
// If the cache entry exists, it will just be the cid for the actual data.
|
|
// This avoids duplication of large amounts of data.
|
|
$cache = cache_get($cache->data, 'cache_menu');
|
|
if ($cache && isset($cache->data)) {
|
|
$data = $cache->data;
|
|
}
|
|
}
|
|
// If the tree data was not in the cache, $data will be NULL.
|
|
if (!isset($data)) {
|
|
// Build the query using a LEFT JOIN since there is no match in
|
|
// {menu_router} for an external link.
|
|
$query = db_select('menu_links', 'ml', array('fetch' => PDO::FETCH_ASSOC));
|
|
$query->leftJoin('menu_router', 'm', 'm.path = ml.router_path');
|
|
$query->fields('ml');
|
|
$query->fields('m', array(
|
|
'load_functions',
|
|
'to_arg_functions',
|
|
'access_callback',
|
|
'access_arguments',
|
|
'page_callback',
|
|
'page_arguments',
|
|
'title',
|
|
'title_callback',
|
|
'title_arguments',
|
|
'type',
|
|
'description',
|
|
));
|
|
for ($i = 1; $i <= MENU_MAX_DEPTH; $i++) {
|
|
$query->orderBy('p' . $i, 'ASC');
|
|
}
|
|
$query->condition('ml.menu_name', $menu_name);
|
|
if (isset($max_depth)) {
|
|
$query->condition('ml.depth', $max_depth, '<=');
|
|
}
|
|
if ($mlid) {
|
|
// The tree is for a single item, so we need to match the values in its
|
|
// p columns and 0 (the top level) with the plid values of other links.
|
|
$args = array(0);
|
|
for ($i = 1; $i < MENU_MAX_DEPTH; $i++) {
|
|
$args[] = $link["p$i"];
|
|
}
|
|
$args = array_unique($args);
|
|
$query->condition('ml.plid', $args, 'IN');
|
|
$parents = $args;
|
|
$parents[] = $link['mlid'];
|
|
}
|
|
else {
|
|
// Get all links in this menu.
|
|
$parents = array();
|
|
}
|
|
// Select the links from the table, and build an ordered array of links
|
|
// using the query result object.
|
|
$links = array();
|
|
foreach ($query->execute() as $item) {
|
|
$links[] = $item;
|
|
}
|
|
$data['tree'] = menu_tree_data($links, $parents);
|
|
$data['node_links'] = array();
|
|
menu_tree_collect_node_links($data['tree'], $data['node_links']);
|
|
// Cache the data, if it is not already in the cache.
|
|
$tree_cid = _menu_tree_cid($menu_name, $data);
|
|
if (!cache_get($tree_cid, 'cache_menu')) {
|
|
cache_set($tree_cid, $data, 'cache_menu');
|
|
}
|
|
// Cache the cid of the (shared) data using the menu and item-specific cid.
|
|
cache_set($cid, $tree_cid, 'cache_menu');
|
|
}
|
|
// Check access for the current user to each item in the tree.
|
|
menu_tree_check_access($data['tree'], $data['node_links']);
|
|
$tree[$cid] = $data['tree'];
|
|
}
|
|
|
|
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 individual
|
|
* field, see http://drupal.org/node/141866 for more.
|
|
*
|
|
* @param $menu_name
|
|
* The named menu links to return
|
|
* @param $max_depth
|
|
* Optional maximum depth of links to retrieve.
|
|
*
|
|
* @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 subtree that has the
|
|
* same structure described for the top-level array.
|
|
*/
|
|
function menu_tree_page_data($menu_name, $max_depth = NULL) {
|
|
$tree = &drupal_static(__FUNCTION__, array());
|
|
|
|
// Load the menu item corresponding to the current page.
|
|
if ($item = menu_get_item()) {
|
|
if (isset($max_depth)) {
|
|
$max_depth = min($max_depth, MENU_MAX_DEPTH);
|
|
}
|
|
// Generate a cache ID (cid) specific for this page.
|
|
$cid = 'links:' . $menu_name . ':page-cid:' . $item['href'] . ':' . (int)$item['access'] . ':' . (int)$max_depth;
|
|
|
|
if (!isset($tree[$cid])) {
|
|
// If the static variable doesn't have the data, check {cache_menu}.
|
|
$cache = cache_get($cid, 'cache_menu');
|
|
if ($cache && isset($cache->data)) {
|
|
// If the cache entry exists, it will just be the cid for the actual data.
|
|
// This avoids duplication of large amounts of data.
|
|
$cache = cache_get($cache->data, 'cache_menu');
|
|
if ($cache && isset($cache->data)) {
|
|
$data = $cache->data;
|
|
}
|
|
}
|
|
// If the tree data was not in the cache, $data will be NULL.
|
|
if (!isset($data)) {
|
|
// Build and run the query, and build the tree.
|
|
if ($item['access']) {
|
|
// Check whether a menu link exists that corresponds to the current path.
|
|
$args[] = $item['href'];
|
|
if (drupal_is_front_page()) {
|
|
$args[] = '<front>';
|
|
}
|
|
$parents = db_select('menu_links')
|
|
->fields('menu_links', array(
|
|
'p1',
|
|
'p2',
|
|
'p3',
|
|
'p4',
|
|
'p5',
|
|
'p6',
|
|
'p7',
|
|
'p8',
|
|
))
|
|
->condition('menu_name', $menu_name)
|
|
->condition('link_path', $args, 'IN')
|
|
->execute()->fetchAssoc();
|
|
|
|
if (empty($parents)) {
|
|
// If no link exists, we may be on a local task that's not in the links.
|
|
// TODO: Handle the case like a local task on a specific node in the menu.
|
|
$parents = db_select('menu_links')
|
|
->fields('menu_links', array(
|
|
'p1',
|
|
'p2',
|
|
'p3',
|
|
'p4',
|
|
'p5',
|
|
'p6',
|
|
'p7',
|
|
'p8',
|
|
))
|
|
->condition('menu_name', $menu_name)
|
|
->condition('link_path', $item['tab_root'])
|
|
->execute()->fetchAssoc();
|
|
}
|
|
// We always want all the top-level links with plid == 0.
|
|
$parents[] = '0';
|
|
|
|
// Use array_values() so that the indices are numeric for array_merge().
|
|
$args = $parents = array_unique(array_values($parents));
|
|
$expanded = variable_get('menu_expanded', array());
|
|
// Check whether the current menu has any links set to be expanded.
|
|
if (in_array($menu_name, $expanded)) {
|
|
// Collect all the links set to be expanded, and then add all of
|
|
// their children to the list as well.
|
|
do {
|
|
$result = db_select('menu_links', NULL, array('fetch' => PDO::FETCH_ASSOC))
|
|
->fields('menu_links', array('mlid'))
|
|
->condition('menu_name', $menu_name)
|
|
->condition('expanded', 1)
|
|
->condition('has_children', 1)
|
|
->condition('plid', $args, 'IN')
|
|
->condition('mlid', $args, 'NOT IN')
|
|
->execute();
|
|
$num_rows = FALSE;
|
|
foreach ($result as $item) {
|
|
$args[] = $item['mlid'];
|
|
$num_rows = TRUE;
|
|
}
|
|
} while ($num_rows);
|
|
}
|
|
}
|
|
else {
|
|
// Show only the top-level menu items when access is denied.
|
|
$args = array(0);
|
|
$parents = array();
|
|
}
|
|
// Select the links from the table, and recursively build the tree. We
|
|
// LEFT JOIN since there is no match in {menu_router} for an external
|
|
// link.
|
|
$query = db_select('menu_links', 'ml', array('fetch' => PDO::FETCH_ASSOC));
|
|
$query->leftJoin('menu_router', 'm', 'm.path = ml.router_path');
|
|
$query->fields('ml');
|
|
$query->fields('m', array(
|
|
'load_functions',
|
|
'to_arg_functions',
|
|
'access_callback',
|
|
'access_arguments',
|
|
'page_callback',
|
|
'page_arguments',
|
|
'title',
|
|
'title_callback',
|
|
'title_arguments',
|
|
'type',
|
|
'description',
|
|
));
|
|
for ($i = 1; $i <= MENU_MAX_DEPTH; $i++) {
|
|
$query->orderBy('p' . $i, 'ASC');
|
|
}
|
|
$query->condition('ml.menu_name', $menu_name);
|
|
$query->condition('ml.plid', $args, 'IN');
|
|
if (isset($max_depth)) {
|
|
$query->condition('ml.depth', $max_depth, '<=');
|
|
}
|
|
// Build an ordered array of links using the query result object.
|
|
$links = array();
|
|
foreach ($query->execute() as $item) {
|
|
$links[] = $item;
|
|
}
|
|
$data['tree'] = menu_tree_data($links, $parents);
|
|
$data['node_links'] = array();
|
|
menu_tree_collect_node_links($data['tree'], $data['node_links']);
|
|
// Cache the data, if it is not already in the cache.
|
|
$tree_cid = _menu_tree_cid($menu_name, $data);
|
|
if (!cache_get($tree_cid, 'cache_menu')) {
|
|
cache_set($tree_cid, $data, 'cache_menu');
|
|
}
|
|
// Cache the cid of the (shared) data using the page-specific cid.
|
|
cache_set($cid, $tree_cid, 'cache_menu');
|
|
}
|
|
// Check access for the current user to each item in the tree.
|
|
menu_tree_check_access($data['tree'], $data['node_links']);
|
|
$tree[$cid] = $data['tree'];
|
|
}
|
|
return $tree[$cid];
|
|
}
|
|
|
|
return array();
|
|
}
|
|
|
|
/**
|
|
* Helper function - compute the real cache ID for menu tree data.
|
|
*/
|
|
function _menu_tree_cid($menu_name, $data) {
|
|
return 'links:' . $menu_name . ':tree-data:' . md5(serialize($data));
|
|
}
|
|
|
|
/**
|
|
* Recursive helper function - collect node links.
|
|
*
|
|
* @param $tree
|
|
* The menu tree you wish to collect node links from.
|
|
* @param $node_links
|
|
* An array in which to store the collected node links.
|
|
*/
|
|
function menu_tree_collect_node_links(&$tree, &$node_links) {
|
|
foreach ($tree as $key => $v) {
|
|
if ($tree[$key]['link']['router_path'] == 'node/%') {
|
|
$nid = substr($tree[$key]['link']['link_path'], 5);
|
|
if (is_numeric($nid)) {
|
|
$node_links[$nid][$tree[$key]['link']['mlid']] = &$tree[$key]['link'];
|
|
$tree[$key]['link']['access'] = FALSE;
|
|
}
|
|
}
|
|
if ($tree[$key]['below']) {
|
|
menu_tree_collect_node_links($tree[$key]['below'], $node_links);
|
|
}
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Check access and perform other dynamic operations for each link in the tree.
|
|
*
|
|
* @param $tree
|
|
* The menu tree you wish to operate on.
|
|
* @param $node_links
|
|
* A collection of node link references generated from $tree by
|
|
* menu_tree_collect_node_links().
|
|
*/
|
|
function menu_tree_check_access(&$tree, $node_links = array()) {
|
|
|
|
if ($node_links) {
|
|
$nids = array_keys($node_links);
|
|
$select = db_select('node');
|
|
$select->addField('node', 'nid');
|
|
$select->condition('status', 1);
|
|
$select->condition('nid', $nids, 'IN');
|
|
$select->addTag('node_access');
|
|
$nids = $select->execute()->fetchCol();
|
|
foreach ($nids as $nid) {
|
|
foreach ($node_links[$nid] as $mlid => $link) {
|
|
$node_links[$nid][$mlid]['access'] = TRUE;
|
|
}
|
|
}
|
|
}
|
|
_menu_tree_check_access($tree);
|
|
return;
|
|
}
|
|
|
|
/**
|
|
* Recursive helper function for menu_tree_check_access()
|
|
*/
|
|
function _menu_tree_check_access(&$tree) {
|
|
$new_tree = array();
|
|
foreach ($tree as $key => $v) {
|
|
$item = &$tree[$key]['link'];
|
|
_menu_link_translate($item);
|
|
if ($item['access']) {
|
|
if ($tree[$key]['below']) {
|
|
_menu_tree_check_access($tree[$key]['below']);
|
|
}
|
|
// The weights are made a uniform 5 digits by adding 50000 as an offset.
|
|
// After _menu_link_translate(), $item['title'] has the localized link title.
|
|
// Adding the mlid to the end of the index insures that it is unique.
|
|
$new_tree[(50000 + $item['weight']) . ' ' . $item['title'] . ' ' . $item['mlid']] = $tree[$key];
|
|
}
|
|
}
|
|
// Sort siblings in the tree based on the weights and localized titles.
|
|
ksort($new_tree);
|
|
$tree = $new_tree;
|
|
}
|
|
|
|
/**
|
|
* Build the data representing a menu tree.
|
|
*
|
|
* @param $links
|
|
* An array of links (associative arrays) ordered by p1..p9.
|
|
* @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 minimum depth of any link in the $links array.
|
|
* @return
|
|
* See menu_tree_page_data for a description of the data structure.
|
|
*/
|
|
function menu_tree_data(array $links, array $parents = array(), $depth = 1) {
|
|
// Reverse the array so we can use the more efficient array_pop() function.
|
|
$links = array_reverse($links);
|
|
return _menu_tree_data($links, $parents, $depth);
|
|
}
|
|
|
|
/**
|
|
* Recursive helper function to build the data representing a menu tree.
|
|
*
|
|
* The function is a bit complex because the rendering of a link depends on
|
|
* the next menu link.
|
|
*/
|
|
function _menu_tree_data(&$links, $parents, $depth) {
|
|
$tree = array();
|
|
while ($item = array_pop($links)) {
|
|
// 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);
|
|
// Add the current link to the tree.
|
|
$tree[$item['mlid']] = array(
|
|
'link' => $item,
|
|
'below' => array(),
|
|
);
|
|
// Look ahead to the next link, but leave it on the array so it's available
|
|
// to other recursive function calls if we return or build a sub-tree.
|
|
$next = end($links);
|
|
// Check whether the next link is the first in a new sub-tree.
|
|
if ($next && $next['depth'] > $depth) {
|
|
// Recursively call _menu_tree_data to build the sub-tree.
|
|
$tree[$item['mlid']]['below'] = _menu_tree_data($links, $parents, $next['depth']);
|
|
// Fetch next link after filling the sub-tree.
|
|
$next = end($links);
|
|
}
|
|
// Determine if we should exit the loop and return.
|
|
if (!$next || $next['depth'] < $depth) {
|
|
break;
|
|
}
|
|
}
|
|
return $tree;
|
|
}
|
|
|
|
/**
|
|
* Generate the HTML output for a single menu link.
|
|
*
|
|
* @ingroup themeable
|
|
*/
|
|
function theme_menu_item_link($link) {
|
|
if (empty($link['localized_options'])) {
|
|
$link['localized_options'] = array();
|
|
}
|
|
|
|
return l($link['title'], $link['href'], $link['localized_options']);
|
|
}
|
|
|
|
/**
|
|
* Generate the HTML output for a menu tree
|
|
*
|
|
* @ingroup themeable
|
|
*/
|
|
function theme_menu_tree($tree) {
|
|
return '<ul class="menu">' . $tree . '</ul>';
|
|
}
|
|
|
|
/**
|
|
* Generate the HTML output for a menu item and submenu.
|
|
*
|
|
* The menu item's LI element is given one of the following classes:
|
|
* - expanded: The menu item is showing its submenu.
|
|
* - collapsed: The menu item has a submenu which is not shown.
|
|
* - leaf: The menu item has no submenu.
|
|
*
|
|
* @ingroup themeable
|
|
*
|
|
* @param $link
|
|
* The fully-formatted link for this menu item.
|
|
* @param $has_children
|
|
* Boolean value indicating if this menu item has children.
|
|
* @param $menu
|
|
* Contains a fully-formatted submenu, if one exists for this menu item.
|
|
* Defaults to NULL.
|
|
* @param $in_active_trail
|
|
* Boolean determining if the current page is below the menu item in the
|
|
* menu system. Defaults to FALSE.
|
|
* @param $extra_class
|
|
* Extra classes that should be added to the class of the list item.
|
|
* Defaults to NULL.
|
|
*/
|
|
function theme_menu_item($link, $has_children, $menu = '', $in_active_trail = FALSE, $extra_class = NULL) {
|
|
$class = ($menu ? 'expanded' : ($has_children ? 'collapsed' : 'leaf'));
|
|
if (!empty($extra_class)) {
|
|
$class .= ' ' . $extra_class;
|
|
}
|
|
if ($in_active_trail) {
|
|
$class .= ' active-trail';
|
|
}
|
|
return '<li class="' . $class . '">' . $link . $menu . "</li>\n";
|
|
}
|
|
|
|
/**
|
|
* Generate the HTML output for a single local task link.
|
|
*
|
|
* @ingroup themeable
|
|
*/
|
|
function theme_menu_local_task($link, $active = FALSE) {
|
|
return '<li ' . ($active ? 'class="active" ' : '') . '>' . $link . "</li>\n";
|
|
}
|
|
|
|
/**
|
|
* Generate the HTML output for a single local action link.
|
|
*
|
|
* @ingroup themeable
|
|
*/
|
|
function theme_menu_local_action($link) {
|
|
return '<li>' . $link . "</li>\n";
|
|
}
|
|
|
|
/**
|
|
* Generates elements for the $arg array in the help hook.
|
|
*/
|
|
function drupal_help_arg($arg = array()) {
|
|
// Note - the number of empty elements should be > MENU_MAX_PARTS.
|
|
return $arg + array('', '', '', '', '', '', '', '', '', '', '', '');
|
|
}
|
|
|
|
/**
|
|
* Returns the help associated with the active menu item.
|
|
*/
|
|
function menu_get_active_help() {
|
|
$output = '';
|
|
$router_path = menu_tab_root_path();
|
|
// We will always have a path unless we are on a 403 or 404.
|
|
if (!$router_path) {
|
|
return '';
|
|
}
|
|
|
|
$arg = drupal_help_arg(arg(NULL));
|
|
$empty_arg = drupal_help_arg();
|
|
|
|
foreach (module_implements('help') as $module) {
|
|
$function = $module . '_help';
|
|
// Lookup help for this path.
|
|
if ($help = $function($router_path, $arg)) {
|
|
$output .= $help . "\n";
|
|
}
|
|
// Add "more help" link on admin pages if the module provides a
|
|
// standalone help page.
|
|
if ($arg[0] == "admin" && user_access('access administration pages') && module_exists('help') && $function('admin/help#' . $arg[2], $empty_arg) && $help) {
|
|
$output .= theme("more_help_link", url('admin/help/' . $arg[2]));
|
|
}
|
|
}
|
|
return $output;
|
|
}
|
|
|
|
/**
|
|
* Build a list of named menus.
|
|
*/
|
|
function menu_get_names() {
|
|
$names = &drupal_static(__FUNCTION__);
|
|
|
|
if (empty($names)) {
|
|
$names = db_select('menu_links')
|
|
->distinct()
|
|
->fields('menu_links', array('menu_name'))
|
|
->orderBy('menu_name')
|
|
->execute()->fetchCol();
|
|
}
|
|
return $names;
|
|
}
|
|
|
|
/**
|
|
* Return an array containing the names of system-defined (default) menus.
|
|
*/
|
|
function menu_list_system_menus() {
|
|
return array('navigation' => 'Navigation', 'management' => 'Management', 'user-menu' => 'User menu', 'main-menu' => 'Main menu', 'secondary-menu' => 'Secondary menu');
|
|
}
|
|
|
|
/**
|
|
* Return an array of links to be rendered as the Main menu.
|
|
*/
|
|
function menu_main_menu() {
|
|
return menu_navigation_links(variable_get('menu_main_links_source', 'main-menu'));
|
|
}
|
|
|
|
/**
|
|
* Return an array of links to be rendered as the Secondary links.
|
|
*/
|
|
function menu_secondary_menu() {
|
|
|
|
// If the secondary menu source is set as the primary menu, we display the
|
|
// second level of the primary menu.
|
|
if (variable_get('menu_secondary_links_source', 'user-menu') == variable_get('menu_main_links_source', 'main-menu')) {
|
|
return menu_navigation_links(variable_get('menu_main_links_source', 'main-menu'), 1);
|
|
}
|
|
else {
|
|
return menu_navigation_links(variable_get('menu_secondary_links_source', 'user-menu'), 0);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Return an array of links for a navigation menu.
|
|
*
|
|
* @param $menu_name
|
|
* The name of the menu.
|
|
* @param $level
|
|
* Optional, the depth of the menu to be returned.
|
|
* @return
|
|
* An array of links of the specified menu and level.
|
|
*/
|
|
function menu_navigation_links($menu_name, $level = 0) {
|
|
// Don't even bother querying the menu table if no menu is specified.
|
|
if (empty($menu_name)) {
|
|
return array();
|
|
}
|
|
|
|
// Get the menu hierarchy for the current page.
|
|
$tree = menu_tree_page_data($menu_name, $level + 1);
|
|
|
|
// Go down the active trail until the right level is reached.
|
|
while ($level-- > 0 && $tree) {
|
|
// Loop through the current level's items until we find one that is in trail.
|
|
while ($item = array_shift($tree)) {
|
|
if ($item['link']['in_active_trail']) {
|
|
// If the item is in the active trail, we continue in the subtree.
|
|
$tree = empty($item['below']) ? array() : $item['below'];
|
|
break;
|
|
}
|
|
}
|
|
}
|
|
|
|
// Create a single level of links.
|
|
$links = array();
|
|
foreach ($tree as $item) {
|
|
if (!$item['link']['hidden']) {
|
|
$class = '';
|
|
$l = $item['link']['localized_options'];
|
|
$l['href'] = $item['link']['href'];
|
|
$l['title'] = $item['link']['title'];
|
|
if ($item['link']['in_active_trail']) {
|
|
$class = ' active-trail';
|
|
}
|
|
// Keyed with the unique mlid to generate classes in theme_links().
|
|
$links['menu-' . $item['link']['mlid'] . $class] = $l;
|
|
}
|
|
}
|
|
return $links;
|
|
}
|
|
|
|
/**
|
|
* Collects the local tasks (tabs), action links, and the root path.
|
|
*
|
|
* @param $level
|
|
* The level of tasks you ask for. Primary tasks are 0, secondary are 1.
|
|
* @return
|
|
* An array containing
|
|
* - tabs: Local tasks for the requested level:
|
|
* - count: The number of local tasks.
|
|
* - output: The themed output of local tasks.
|
|
* - actions: Action links for the requested level:
|
|
* - count: The number of action links.
|
|
* - output: The themed output of action links.
|
|
* - root_path: The router path for the current page. If the current page is
|
|
* a default local task, then this corresponds to the parent tab.
|
|
*/
|
|
function menu_local_tasks($level = 0) {
|
|
$data = &drupal_static(__FUNCTION__);
|
|
$root_path = &drupal_static(__FUNCTION__ . ':root_path', '');
|
|
$empty = array(
|
|
'tabs' => array('count' => 0, 'output' => ''),
|
|
'actions' => array('count' => 0, 'output' => ''),
|
|
'root_path' => &$root_path,
|
|
);
|
|
|
|
if (!isset($data)) {
|
|
$data = array();
|
|
// Set defaults in case there are no actions or tabs.
|
|
$actions = $empty['actions'];
|
|
$tabs = array();
|
|
|
|
$router_item = menu_get_item();
|
|
if (!$router_item || !$router_item['access']) {
|
|
return $empty;
|
|
}
|
|
// Get all tabs and the root page.
|
|
$result = db_select('menu_router', NULL, array('fetch' => PDO::FETCH_ASSOC))
|
|
->fields('menu_router')
|
|
->condition('tab_root', $router_item['tab_root'])
|
|
->orderBy('weight')
|
|
->orderBy('title')
|
|
->execute();
|
|
$map = arg();
|
|
$children = array();
|
|
$tasks = array();
|
|
$root_path = $router_item['path'];
|
|
|
|
foreach ($result as $item) {
|
|
_menu_translate($item, $map, TRUE);
|
|
if ($item['tab_parent']) {
|
|
// All tabs, but not the root page.
|
|
$children[$item['tab_parent']][$item['path']] = $item;
|
|
}
|
|
// Store the translated item for later use.
|
|
$tasks[$item['path']] = $item;
|
|
}
|
|
// Find all tabs below the current path.
|
|
$path = $router_item['path'];
|
|
// Tab parenting may skip levels, so the number of parts in the path may not
|
|
// equal the depth. Thus we use the $depth counter (offset by 1000 for ksort).
|
|
$depth = 1001;
|
|
while (isset($children[$path])) {
|
|
$tabs_current = '';
|
|
$actions_current = '';
|
|
$next_path = '';
|
|
$tab_count = 0;
|
|
$action_count = 0;
|
|
foreach ($children[$path] as $item) {
|
|
if ($item['access']) {
|
|
// The default task is always active.
|
|
if ($item['type'] == MENU_DEFAULT_LOCAL_TASK) {
|
|
// Find the first parent which is not a default local task or action.
|
|
for ($p = $item['tab_parent']; $tasks[$p]['type'] == MENU_DEFAULT_LOCAL_TASK; $p = $tasks[$p]['tab_parent']);
|
|
$link = theme('menu_item_link', array('href' => $tasks[$p]['href']) + $item);
|
|
$tabs_current .= theme('menu_local_task', $link, TRUE);
|
|
$next_path = $item['path'];
|
|
$tab_count++;
|
|
}
|
|
else {
|
|
$link = theme('menu_item_link', $item);
|
|
if ($item['type'] == MENU_LOCAL_TASK) {
|
|
$tabs_current .= theme('menu_local_task', $link);
|
|
$tab_count++;
|
|
}
|
|
else {
|
|
$actions_current .= theme('menu_local_action', $link);
|
|
$action_count++;
|
|
}
|
|
}
|
|
}
|
|
}
|
|
$path = $next_path;
|
|
$tabs[$depth]['count'] = $tab_count;
|
|
$tabs[$depth]['output'] = $tabs_current;
|
|
$actions['count'] = $action_count;
|
|
$actions['output'] = $actions_current;
|
|
$depth++;
|
|
}
|
|
$data['actions'] = $actions;
|
|
// Find all tabs at the same level or above the current one.
|
|
$parent = $router_item['tab_parent'];
|
|
$path = $router_item['path'];
|
|
$current = $router_item;
|
|
$depth = 1000;
|
|
while (isset($children[$parent])) {
|
|
$tabs_current = '';
|
|
$next_path = '';
|
|
$next_parent = '';
|
|
$count = 0;
|
|
foreach ($children[$parent] as $item) {
|
|
if ($item['type'] == MENU_LOCAL_ACTION) {
|
|
continue;
|
|
}
|
|
if ($item['access']) {
|
|
$count++;
|
|
if ($item['type'] == MENU_DEFAULT_LOCAL_TASK) {
|
|
// Find the first parent which is not a default local task.
|
|
for ($p = $item['tab_parent']; $tasks[$p]['type'] == MENU_DEFAULT_LOCAL_TASK; $p = $tasks[$p]['tab_parent']);
|
|
$link = theme('menu_item_link', array('href' => $tasks[$p]['href']) + $item);
|
|
if ($item['path'] == $router_item['path']) {
|
|
$root_path = $tasks[$p]['path'];
|
|
}
|
|
}
|
|
else {
|
|
$link = theme('menu_item_link', $item);
|
|
}
|
|
// 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($tasks[$next_path])) {
|
|
$next_parent = $tasks[$next_path]['tab_parent'];
|
|
}
|
|
}
|
|
else {
|
|
$tabs_current .= theme('menu_local_task', $link);
|
|
}
|
|
}
|
|
}
|
|
$path = $next_path;
|
|
$parent = $next_parent;
|
|
$tabs[$depth]['count'] = $count;
|
|
$tabs[$depth]['output'] = $tabs_current;
|
|
$depth--;
|
|
}
|
|
// Sort by depth.
|
|
ksort($tabs);
|
|
// Remove the depth, we are interested only in their relative placement.
|
|
$tabs = array_values($tabs);
|
|
$data['tabs'] = $tabs;
|
|
}
|
|
|
|
if (isset($data['tabs'][$level])) {
|
|
return array(
|
|
'tabs' => $data['tabs'][$level],
|
|
'actions' => $data['actions'],
|
|
'root_path' => $root_path,
|
|
);
|
|
}
|
|
return $empty;
|
|
}
|
|
|
|
/**
|
|
* Returns the rendered local tasks at the top level.
|
|
*/
|
|
function menu_primary_local_tasks() {
|
|
$links = menu_local_tasks(0);
|
|
// Do not display single tabs.
|
|
return ($links['tabs']['count'] > 1 ? $links['tabs']['output'] : '');
|
|
}
|
|
|
|
/**
|
|
* Returns the rendered local tasks at the second level.
|
|
*/
|
|
function menu_secondary_local_tasks() {
|
|
$links = menu_local_tasks(1);
|
|
// Do not display single tabs.
|
|
return ($links['tabs']['count'] > 1 ? $links['tabs']['output'] : '');
|
|
}
|
|
|
|
/**
|
|
* Returns the rendered local actions at the current level.
|
|
*/
|
|
function menu_local_actions() {
|
|
$links = menu_local_tasks();
|
|
return $links['actions']['output'];
|
|
}
|
|
|
|
/**
|
|
* Returns the router path, or the path of the parent tab of a default local task.
|
|
*/
|
|
function menu_tab_root_path() {
|
|
$links = menu_local_tasks();
|
|
return $links['root_path'];
|
|
}
|
|
|
|
/**
|
|
* 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 .= "<ul class=\"tabs primary\">\n" . $primary . "</ul>\n";
|
|
}
|
|
if ($secondary = menu_secondary_local_tasks()) {
|
|
$output .= "<ul class=\"tabs secondary\">\n" . $secondary . "</ul>\n";
|
|
}
|
|
|
|
return $output;
|
|
}
|
|
|
|
/**
|
|
* Set (or get) the active menu for the current page - determines the active trail.
|
|
*/
|
|
function menu_set_active_menu_names($menu_names = NULL) {
|
|
$active = &drupal_static(__FUNCTION__);
|
|
|
|
if (isset($menu_names) && is_array($menu_names)) {
|
|
$active = $menu_names;
|
|
}
|
|
elseif (!isset($active)) {
|
|
$active = variable_get('menu_default_active_menus', array('management', 'navigation', 'user-menu', 'main-menu'));
|
|
}
|
|
return $active;
|
|
}
|
|
|
|
/**
|
|
* Get the active menu for the current page - determines the active trail.
|
|
*/
|
|
function menu_get_active_menu_names() {
|
|
return menu_set_active_menu_names();
|
|
}
|
|
|
|
/**
|
|
* Set the active path, which determines which page is loaded.
|
|
*
|
|
* @param $path
|
|
* A Drupal path - not a path alias.
|
|
*
|
|
* Note that this may not have the desired effect unless invoked very early
|
|
* in the page load, such as during hook_boot, or unless you call
|
|
* menu_execute_active_handler() to generate your page output.
|
|
*/
|
|
function menu_set_active_item($path) {
|
|
$_GET['q'] = $path;
|
|
}
|
|
|
|
/**
|
|
* Set (or get) the active trail for the current page - the path to root in the menu tree.
|
|
*/
|
|
function menu_set_active_trail($new_trail = NULL) {
|
|
$trail = &drupal_static(__FUNCTION__);
|
|
|
|
if (isset($new_trail)) {
|
|
$trail = $new_trail;
|
|
}
|
|
elseif (!isset($trail)) {
|
|
$trail = array();
|
|
$trail[] = array('title' => t('Home'), 'href' => '<front>', 'localized_options' => array(), 'type' => 0);
|
|
$item = menu_get_item();
|
|
|
|
// Check whether the current item is a local task (displayed as a tab).
|
|
if ($item['tab_parent']) {
|
|
// The title of a local task is used for the tab, never the page title.
|
|
// Thus, replace it with the item corresponding to the root path to get
|
|
// the relevant href and title. For example, the menu item corresponding
|
|
// to 'admin' is used when on the 'By module' tab at 'admin/by-module'.
|
|
$parts = explode('/', $item['tab_root']);
|
|
$args = arg();
|
|
// Replace wildcards in the root path using the current path.
|
|
foreach ($parts as $index => $part) {
|
|
if ($part == '%') {
|
|
$parts[$index] = $args[$index];
|
|
}
|
|
}
|
|
// Retrieve the menu item using the root path after wildcard replacement.
|
|
$root_item = menu_get_item(implode('/', $parts));
|
|
if ($root_item && $root_item['access']) {
|
|
$item = $root_item;
|
|
}
|
|
}
|
|
$menu_names = menu_get_active_menu_names();
|
|
$curr = FALSE;
|
|
// Determine if the current page is a link in any of the active menus.
|
|
if ($menu_names) {
|
|
$query = db_select('menu_links', 'ml');
|
|
$query->fields('ml', array('menu_name'));
|
|
$query->condition('ml.link_path', $item['href']);
|
|
$query->condition('ml.menu_name', $menu_names, 'IN');
|
|
$result = $query->execute();
|
|
$found = array();
|
|
foreach ($result as $menu) {
|
|
$found[] = $menu->menu_name;
|
|
}
|
|
// The $menu_names array is ordered, so take the first one that matches.
|
|
$name = current(array_intersect($menu_names, $found));
|
|
if ($name !== FALSE) {
|
|
$tree = menu_tree_page_data($name);
|
|
list($key, $curr) = each($tree);
|
|
}
|
|
}
|
|
|
|
while ($curr) {
|
|
// Terminate the loop when we find the current path in the active trail.
|
|
if ($curr['link']['href'] == $item['href']) {
|
|
$trail[] = $curr['link'];
|
|
$curr = FALSE;
|
|
}
|
|
else {
|
|
// Add the link if it's in the active trail, then move to the link below.
|
|
if ($curr['link']['in_active_trail']) {
|
|
$trail[] = $curr['link'];
|
|
$tree = $curr['below'] ? $curr['below'] : array();
|
|
}
|
|
list($key, $curr) = each($tree);
|
|
}
|
|
}
|
|
// Make sure the current page is in the trail (needed for the page title),
|
|
// but exclude tabs and the front page.
|
|
$last = count($trail) - 1;
|
|
if ($trail[$last]['href'] != $item['href'] && !(bool)($item['type'] & MENU_IS_LOCAL_TASK) && !drupal_is_front_page()) {
|
|
$trail[] = $item;
|
|
}
|
|
}
|
|
return $trail;
|
|
}
|
|
|
|
/**
|
|
* Get the active trail for the current page - the path to root in the menu tree.
|
|
*/
|
|
function menu_get_active_trail() {
|
|
return menu_set_active_trail();
|
|
}
|
|
|
|
/**
|
|
* Get the breadcrumb for the current page, as determined by the active trail.
|
|
*/
|
|
function menu_get_active_breadcrumb() {
|
|
$breadcrumb = array();
|
|
|
|
// No breadcrumb for the front page.
|
|
if (drupal_is_front_page()) {
|
|
return $breadcrumb;
|
|
}
|
|
|
|
$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['localized_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'] != '<front>')) {
|
|
array_pop($breadcrumb);
|
|
}
|
|
}
|
|
return $breadcrumb;
|
|
}
|
|
|
|
/**
|
|
* Get the title of the current page, as determined by the active trail.
|
|
*/
|
|
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.
|
|
*
|
|
* This function should never be called from within node_load() or any other
|
|
* function used as a menu object load function since an infinite recursion may
|
|
* occur.
|
|
*
|
|
* @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 (is_numeric($mlid)) {
|
|
$query = db_select('menu_links', 'ml');
|
|
$query->leftJoin('menu_router', 'm', 'm.path = ml.router_path');
|
|
$query->fields('ml');
|
|
$query->fields('m');
|
|
$query->condition('ml.mlid', $mlid);
|
|
if ($item = $query->execute()->fetchAssoc()) {
|
|
_menu_link_translate($item);
|
|
return $item;
|
|
}
|
|
}
|
|
return FALSE;
|
|
}
|
|
|
|
/**
|
|
* Clears the cached cached data for a single named menu.
|
|
*/
|
|
function menu_cache_clear($menu_name = 'navigation') {
|
|
$cache_cleared = &drupal_static(__FUNCTION__, array());
|
|
|
|
if (empty($cache_cleared[$menu_name])) {
|
|
cache_clear_all('links:' . $menu_name . ':', 'cache_menu', TRUE);
|
|
$cache_cleared[$menu_name] = 1;
|
|
}
|
|
elseif ($cache_cleared[$menu_name] == 1) {
|
|
register_shutdown_function('cache_clear_all', 'links:' . $menu_name . ':', 'cache_menu', TRUE);
|
|
$cache_cleared[$menu_name] = 2;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Clears all cached menu data. 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);
|
|
}
|
|
|
|
/**
|
|
* (Re)populate the database tables used by various menu functions.
|
|
*
|
|
* This function will clear and populate the {menu_router} table, add entries
|
|
* to {menu_links} for new router items, then remove stale items from
|
|
* {menu_links}. If called from update.php or install.php, it will also
|
|
* schedule a call to itself on the first real page load from
|
|
* menu_execute_active_handler(), because the maintenance page environment
|
|
* is different and leaves stale data in the menu tables.
|
|
*
|
|
* @return
|
|
* TRUE if the menu was rebuilt, FALSE if another thread was rebuilding
|
|
* in parallel and the current thread just waited for completion.
|
|
*/
|
|
function menu_rebuild() {
|
|
if (!lock_acquire('menu_rebuild')) {
|
|
// Wait for another request that is already doing this work.
|
|
// We choose to block here since otherwise the router item may not
|
|
// be available in menu_execute_active_handler() resulting in a 404.
|
|
lock_wait('menu_rebuild');
|
|
return FALSE;
|
|
}
|
|
|
|
list($menu, $masks) = menu_router_build();
|
|
_menu_router_save($menu, $masks);
|
|
_menu_navigation_links_rebuild($menu);
|
|
// Clear the menu, page and block caches.
|
|
menu_cache_clear_all();
|
|
_menu_clear_page_cache();
|
|
|
|
if (defined('MAINTENANCE_MODE')) {
|
|
variable_set('menu_rebuild_needed', TRUE);
|
|
}
|
|
else {
|
|
variable_del('menu_rebuild_needed');
|
|
}
|
|
lock_release('menu_rebuild');
|
|
return TRUE;
|
|
}
|
|
|
|
/**
|
|
* Collect and alter the menu definitions.
|
|
*/
|
|
function menu_router_build() {
|
|
// 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);
|
|
list($menu, $masks) = _menu_router_build($callbacks);
|
|
_menu_router_cache($menu);
|
|
|
|
return array($menu, $masks);
|
|
}
|
|
|
|
/**
|
|
* Helper function to store the menu router if we have it in memory.
|
|
*/
|
|
function _menu_router_cache($new_menu = NULL) {
|
|
$menu = &drupal_static(__FUNCTION__);
|
|
|
|
if (isset($new_menu)) {
|
|
$menu = $new_menu;
|
|
}
|
|
return $menu;
|
|
}
|
|
|
|
/**
|
|
* Get the menu router.
|
|
*/
|
|
function menu_get_router() {
|
|
// Check first if we have it in memory already.
|
|
$menu = _menu_router_cache();
|
|
if (empty($menu)) {
|
|
list($menu, $masks) = menu_router_build();
|
|
}
|
|
return $menu;
|
|
}
|
|
|
|
/**
|
|
* Builds a link from a router item.
|
|
*/
|
|
function _menu_link_build($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' => $item['path'],
|
|
'hidden' => 0,
|
|
'options' => empty($item['description']) ? array() : array('attributes' => array('title' => $item['description'])),
|
|
);
|
|
return $item;
|
|
}
|
|
|
|
/**
|
|
* Helper function to build menu links for the items in the menu router.
|
|
*/
|
|
function _menu_navigation_links_rebuild($menu) {
|
|
// Add normal and suggested items as links.
|
|
$menu_links = array();
|
|
foreach ($menu as $path => $item) {
|
|
if ($item['_visible']) {
|
|
$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) {
|
|
$existing_item = db_select('menu_links')
|
|
->fields('menu_links', array(
|
|
'mlid',
|
|
'menu_name',
|
|
'plid',
|
|
'customized',
|
|
'has_children',
|
|
'updated',
|
|
))
|
|
->condition('link_path', $item['path'])
|
|
->condition('module', 'system')
|
|
->execute()->fetchAssoc();
|
|
if ($existing_item) {
|
|
$item['mlid'] = $existing_item['mlid'];
|
|
// A change in hook_menu may move the link to a different menu
|
|
if (empty($item['menu_name']) || ($item['menu_name'] == $existing_item['menu_name'])) {
|
|
$item['menu_name'] = $existing_item['menu_name'];
|
|
$item['plid'] = $existing_item['plid'];
|
|
}
|
|
else {
|
|
// If it moved, put it at the top level in the new menu.
|
|
$item['plid'] = 0;
|
|
}
|
|
$item['has_children'] = $existing_item['has_children'];
|
|
$item['updated'] = $existing_item['updated'];
|
|
}
|
|
if (!$existing_item || !$existing_item['customized']) {
|
|
$item = _menu_link_build($item);
|
|
menu_link_save($item);
|
|
}
|
|
}
|
|
}
|
|
$paths = array_keys($menu);
|
|
// Updated and customized items whose router paths are gone need new ones.
|
|
$result = db_select('menu_links', NULL, array('fetch' => PDO::FETCH_ASSOC))
|
|
->fields('menu_links', array(
|
|
'link_path',
|
|
'mlid',
|
|
'router_path',
|
|
'updated',
|
|
))
|
|
->condition(db_or()
|
|
->condition('updated', 1)
|
|
->condition(db_and()
|
|
->condition('router_path', $paths, 'NOT IN')
|
|
->condition('external', 0)
|
|
->condition('customized', 1)
|
|
)
|
|
)
|
|
->execute();
|
|
foreach ($result as $item) {
|
|
$router_path = _menu_find_router_path($item['link_path']);
|
|
if (!empty($router_path) && ($router_path != $item['router_path'] || $item['updated'])) {
|
|
// If the router path and the link path matches, it's surely a working
|
|
// item, so we clear the updated flag.
|
|
$updated = $item['updated'] && $router_path != $item['link_path'];
|
|
db_update('menu_links')
|
|
->fields(array(
|
|
'router_path' => $router_path,
|
|
'updated' => (int) $updated,
|
|
))
|
|
->condition('mlid', $item['mlid'])
|
|
->execute();
|
|
}
|
|
}
|
|
// Find any item whose router path does not exist any more.
|
|
$result = db_select('menu_links')
|
|
->fields('menu_links')
|
|
->condition('router_path', $paths, 'NOT IN')
|
|
->condition('external', 0)
|
|
->condition('updated', 0)
|
|
->condition('customized', 0)
|
|
->orderBy('depth', 'DESC')
|
|
->execute();
|
|
// Remove all such items. Starting from those with the greatest depth will
|
|
// minimize the amount of re-parenting done by menu_link_delete().
|
|
foreach ($result as $item) {
|
|
_menu_delete_item($item, TRUE);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* 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_query("SELECT * FROM {menu_links} WHERE mlid = :mlid", array(':mlid' => $mlid))->fetchAssoc());
|
|
}
|
|
else {
|
|
$result = db_query("SELECT * FROM {menu_links} WHERE link_path = :link_path", array(':link_path' => $path));
|
|
foreach ($result as $link) {
|
|
_menu_delete_item($link);
|
|
}
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Helper function for menu_link_delete; deletes a single menu link.
|
|
*
|
|
* @param $item
|
|
* Item to be deleted.
|
|
* @param $force
|
|
* Forces deletion. Internal use only, setting to TRUE is discouraged.
|
|
*/
|
|
function _menu_delete_item($item, $force = FALSE) {
|
|
$item = is_object($item) ? get_object_vars($item) : $item;
|
|
if ($item && ($item['module'] != 'system' || $item['updated'] || $force)) {
|
|
// Children get re-attached to the item's parent.
|
|
if ($item['has_children']) {
|
|
$result = db_query("SELECT mlid FROM {menu_links} WHERE plid = :plid", array(':plid' => $item['mlid']));
|
|
foreach ($result as $m) {
|
|
$child = menu_link_load($m->mlid);
|
|
$child['plid'] = $item['plid'];
|
|
menu_link_save($child);
|
|
}
|
|
}
|
|
db_delete('menu_links')->condition('mlid', $item['mlid'])->execute();
|
|
|
|
// Update the has_children status of the parent.
|
|
_menu_update_parental_status($item);
|
|
menu_cache_clear($item['menu_name']);
|
|
_menu_clear_page_cache();
|
|
}
|
|
}
|
|
|
|
/**
|
|
* 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 Set to an existing value, or 0 or NULL to insert a new link.
|
|
* - plid The mlid of the parent.
|
|
* - router_path The path of the relevant router item.
|
|
* @return
|
|
* The mlid of the saved menu link, or FALSE if the menu link could not be
|
|
* saved.
|
|
*/
|
|
function menu_link_save(&$item) {
|
|
|
|
drupal_alter('menu_link', $item);
|
|
|
|
// This is the easiest way to handle the unique internal path '<front>',
|
|
// since a path marked as external does not need to match a router path.
|
|
$item['external'] = (menu_path_is_external($item['link_path']) || $item['link_path'] == '<front>') ? 1 : 0;
|
|
// Load defaults.
|
|
$item += array(
|
|
'menu_name' => 'navigation',
|
|
'weight' => 0,
|
|
'link_title' => '',
|
|
'hidden' => 0,
|
|
'has_children' => 0,
|
|
'expanded' => 0,
|
|
'options' => array(),
|
|
'module' => 'menu',
|
|
'customized' => 0,
|
|
'updated' => 0,
|
|
);
|
|
$existing_item = FALSE;
|
|
if (isset($item['mlid'])) {
|
|
if ($existing_item = db_query("SELECT * FROM {menu_links} WHERE mlid = :mlid", array(':mlid' => $item['mlid']))->fetchAssoc()) {
|
|
$existing_item['options'] = unserialize($existing_item['options']);
|
|
}
|
|
}
|
|
|
|
if (isset($item['plid'])) {
|
|
if ($item['plid']) {
|
|
$parent = db_query("SELECT * FROM {menu_links} WHERE mlid = :mlid", array(':mlid' => $item['plid']))->fetchAssoc();
|
|
}
|
|
else {
|
|
// Don't bother with the query - mlid can never equal zero..
|
|
$parent = FALSE;
|
|
}
|
|
}
|
|
else {
|
|
$query = db_select('menu_links');
|
|
// Only links derived from router items should have module == 'system', and
|
|
// we want to find the parent even if it's in a different menu.
|
|
if ($item['module'] == 'system') {
|
|
$query->condition('module', 'system');
|
|
}
|
|
else {
|
|
// If not derived from a router item, we respect the specified menu name.
|
|
$query->condition('menu_name', $item['menu_name']);
|
|
}
|
|
|
|
// Find the parent - it must be unique.
|
|
$parent_path = $item['link_path'];
|
|
do {
|
|
$parent = FALSE;
|
|
$parent_path = substr($parent_path, 0, strrpos($parent_path, '/'));
|
|
$new_query = clone $query;
|
|
$new_query->condition('link_path', $parent_path);
|
|
// Only valid if we get a unique result.
|
|
if ($new_query->countQuery()->execute()->fetchField() == 1) {
|
|
$parent = $new_query->fields('menu_links')->execute()->fetchAssoc();
|
|
}
|
|
} while ($parent === FALSE && $parent_path);
|
|
}
|
|
if ($parent !== FALSE) {
|
|
$item['menu_name'] = $parent['menu_name'];
|
|
}
|
|
$menu_name = $item['menu_name'];
|
|
// 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 (!$existing_item) {
|
|
$item['mlid'] = db_insert('menu_links')
|
|
->fields(array(
|
|
'menu_name' => $item['menu_name'],
|
|
'plid' => $item['plid'],
|
|
'link_path' => $item['link_path'],
|
|
'hidden' => $item['hidden'],
|
|
'external' => $item['external'],
|
|
'has_children' => $item['has_children'],
|
|
'expanded' => $item['expanded'],
|
|
'weight' => $item['weight'],
|
|
'module' => $item['module'],
|
|
'link_title' => $item['link_title'],
|
|
'options' => serialize($item['options']),
|
|
'customized' => $item['customized'],
|
|
'updated' => $item['updated'],
|
|
))
|
|
->execute();
|
|
}
|
|
|
|
if (!$item['plid']) {
|
|
$item['p1'] = $item['mlid'];
|
|
for ($i = 2; $i <= MENU_MAX_DEPTH; $i++) {
|
|
$item["p$i"] = 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 router_path.
|
|
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'] = _menu_find_router_path($item['link_path']);
|
|
}
|
|
}
|
|
// If every value in $existing_item is the same in the $item, there is no
|
|
// reason to run the update queries or clear the caches. We use
|
|
// array_intersect_assoc() with the $item as the first parameter because
|
|
// $item may have additional keys left over from building a router entry.
|
|
// The intersect removes the extra keys, allowing a meaningful comparison.
|
|
if (!$existing_item || (array_intersect_assoc($item, $existing_item)) != $existing_item) {
|
|
db_update('menu_links')
|
|
->fields(array(
|
|
'menu_name' => $item['menu_name'],
|
|
'plid' => $item['plid'],
|
|
'link_path' => $item['link_path'],
|
|
'router_path' => $item['router_path'],
|
|
'hidden' => $item['hidden'],
|
|
'external' => $item['external'],
|
|
'has_children' => $item['has_children'],
|
|
'expanded' => $item['expanded'],
|
|
'weight' => $item['weight'],
|
|
'depth' => $item['depth'],
|
|
'p1' => $item['p1'],
|
|
'p2' => $item['p2'],
|
|
'p3' => $item['p3'],
|
|
'p4' => $item['p4'],
|
|
'p5' => $item['p5'],
|
|
'p6' => $item['p6'],
|
|
'p7' => $item['p7'],
|
|
'p8' => $item['p8'],
|
|
'p9' => $item['p9'],
|
|
'module' => $item['module'],
|
|
'link_title' => $item['link_title'],
|
|
'options' => serialize($item['options']),
|
|
'customized' => $item['customized'],
|
|
))
|
|
->condition('mlid', $item['mlid'])
|
|
->execute();
|
|
// Check the has_children status of the parent.
|
|
_menu_update_parental_status($item);
|
|
menu_cache_clear($menu_name);
|
|
if ($existing_item && $menu_name != $existing_item['menu_name']) {
|
|
menu_cache_clear($existing_item['menu_name']);
|
|
}
|
|
|
|
_menu_clear_page_cache();
|
|
}
|
|
return $item['mlid'];
|
|
}
|
|
|
|
/**
|
|
* Helper function to clear the page and block caches at most twice per page load.
|
|
*/
|
|
function _menu_clear_page_cache() {
|
|
$cache_cleared = &drupal_static(__FUNCTION__, 0);
|
|
|
|
// Clear the page and block caches, but at most twice, including at
|
|
// the end of the page load when there are multiple links saved or deleted.
|
|
if ($cache_cleared == 0) {
|
|
cache_clear_all();
|
|
// Keep track of which menus have expanded items.
|
|
_menu_set_expanded_menus();
|
|
$cache_cleared = 1;
|
|
}
|
|
elseif ($cache_cleared == 1) {
|
|
register_shutdown_function('cache_clear_all');
|
|
// Keep track of which menus have expanded items.
|
|
register_shutdown_function('_menu_set_expanded_menus');
|
|
$cache_cleared = 2;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Helper function to update a list of menus with expanded items
|
|
*/
|
|
function _menu_set_expanded_menus() {
|
|
$names = db_query("SELECT menu_name FROM {menu_links} WHERE expanded <> 0 GROUP BY menu_name")->fetchCol();
|
|
variable_set('menu_expanded', $names);
|
|
}
|
|
|
|
/**
|
|
* Find the router path which will serve this path.
|
|
*
|
|
* @param $link_path
|
|
* The path for we are looking up its router path.
|
|
* @return
|
|
* A path from $menu keys or empty if $link_path points to a nonexisting
|
|
* place.
|
|
*/
|
|
function _menu_find_router_path($link_path) {
|
|
// $menu will only have data during a menu rebuild.
|
|
$menu = _menu_router_cache();
|
|
|
|
$router_path = $link_path;
|
|
$parts = explode('/', $link_path, MENU_MAX_PARTS);
|
|
$ancestors = menu_get_ancestors($parts);
|
|
|
|
if (empty($menu)) {
|
|
// Not during a menu rebuild, so look up in the database.
|
|
$router_path = (string) db_select('menu_router')
|
|
->fields('menu_router', array('path'))
|
|
->condition('path', $ancestors, 'IN')
|
|
->orderBy('fit', 'DESC')
|
|
->range(0, 1)
|
|
->execute()->fetchField();
|
|
}
|
|
elseif (!isset($menu[$router_path])) {
|
|
// Add an empty router path as a fallback.
|
|
$ancestors[] = '';
|
|
foreach ($ancestors as $key => $router_path) {
|
|
if (isset($menu[$router_path])) {
|
|
// Exit the loop leaving $router_path as the first match.
|
|
break;
|
|
}
|
|
}
|
|
// If we did not find the path, $router_path will be the empty string
|
|
// at the end of $ancestors.
|
|
}
|
|
return $router_path;
|
|
}
|
|
|
|
/**
|
|
* Insert, update or delete an uncustomized menu link related to a module.
|
|
*
|
|
* @param $module
|
|
* The name of the module.
|
|
* @param $op
|
|
* Operation to perform: insert, update or delete.
|
|
* @param $link_path
|
|
* The path this link points to.
|
|
* @param $link_title
|
|
* Title of the link to insert or new title to update the link to.
|
|
* Unused for delete.
|
|
* @return
|
|
* The insert op returns the mlid of the new item. Others op return NULL.
|
|
*/
|
|
function menu_link_maintain($module, $op, $link_path, $link_title) {
|
|
switch ($op) {
|
|
case 'insert':
|
|
$menu_link = array(
|
|
'link_title' => $link_title,
|
|
'link_path' => $link_path,
|
|
'module' => $module,
|
|
);
|
|
return menu_link_save($menu_link);
|
|
break;
|
|
case 'update':
|
|
db_update('menu_links')
|
|
->fields(array('link_title' => $link_title))
|
|
->condition('link_path', $link_path)
|
|
->condition('customized', 0)
|
|
->condition('module', $module)
|
|
->execute();
|
|
$result = db_select('menu_links')
|
|
->fields('menu_links', array('menu_name'))
|
|
->condition('link_path', $link_path)
|
|
->condition('customized', 0)
|
|
->condition('module', $module)
|
|
->groupBy('menu_name')
|
|
->execute()->fetchCol();
|
|
foreach ($result as $menu_name) {
|
|
menu_cache_clear($menu_name);
|
|
}
|
|
break;
|
|
case 'delete':
|
|
menu_link_delete(NULL, $link_path);
|
|
break;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* 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) {
|
|
$query = db_select('menu_links');
|
|
$query->addField('menu_links', 'depth');
|
|
$query->condition('menu_name', $item['menu_name']);
|
|
$query->orderBy('depth', 'DESC');
|
|
$query->range(0, 1);
|
|
|
|
$i = 1;
|
|
$p = 'p1';
|
|
while ($i <= MENU_MAX_DEPTH && $item[$p]) {
|
|
$query->condition($p, $item[$p]);
|
|
$p = 'p' . ++$i;
|
|
}
|
|
|
|
$max_depth = $query->execute()->fetchField();
|
|
|
|
return ($max_depth > $item['depth']) ? $max_depth - $item['depth'] : 0;
|
|
}
|
|
|
|
/**
|
|
* Update the children of a menu link that's being moved.
|
|
*
|
|
* The menu name, parents (p1 - p6), and depth are updated for all children of
|
|
* the link, and the has_children status of the previous parent is updated.
|
|
*/
|
|
function _menu_link_move_children($item, $existing_item) {
|
|
$query = db_update('menu_links');
|
|
|
|
$query->fields(array('menu_name' => $item['menu_name']));
|
|
|
|
$p = 'p1';
|
|
for ($i = 1; $i <= $item['depth']; $p = 'p' . ++$i) {
|
|
$query->fields(array($p => $item[$p]));
|
|
}
|
|
$j = $existing_item['depth'] + 1;
|
|
while ($i <= MENU_MAX_DEPTH && $j <= MENU_MAX_DEPTH) {
|
|
$query->expression('p' . $i++, 'p' . $j++);
|
|
}
|
|
while ($i <= MENU_MAX_DEPTH) {
|
|
$query->fields(array('p' . $i++ => 0));
|
|
}
|
|
|
|
$shift = $item['depth'] - $existing_item['depth'];
|
|
if ($shift < 0) {
|
|
$query->expression('depth', 'depth - :depth', array(':depth' => -$shift));
|
|
}
|
|
elseif ($shift > 0) {
|
|
$query->expression('depth', 'depth + :depth', array(':depth' => $shift));
|
|
}
|
|
|
|
$query->condition('menu_name', $existing_item['menu_name']);
|
|
$p = 'p1';
|
|
for ($i = 1; $i <= MENU_MAX_DEPTH && $existing_item[$p]; $p = 'p' . ++$i) {
|
|
$query->condition($p, $existing_item[$p]);
|
|
}
|
|
|
|
$query->execute();
|
|
|
|
// Check the has_children status of the parent, while excluding this item.
|
|
_menu_update_parental_status($existing_item, TRUE);
|
|
}
|
|
|
|
/**
|
|
* Check and update the has_children status for the parent of a link.
|
|
*/
|
|
function _menu_update_parental_status($item, $exclude = FALSE) {
|
|
// If plid == 0, there is nothing to update.
|
|
if ($item['plid']) {
|
|
// Check if at least one visible child exists in the table.
|
|
$query = db_select('menu_links');
|
|
$query->addField('menu_links', 'mlid');
|
|
$query->condition('menu_name', $item['menu_name']);
|
|
$query->condition('hidden', 0);
|
|
$query->condition('plid', $item['plid']);
|
|
$query->range(0, 1);
|
|
if ($exclude) {
|
|
$query->condition('mlid', $item['mlid'], '<>');
|
|
}
|
|
$parent_has_children = ((bool) $query->execute()->fetchField()) ? 1 : 0;
|
|
db_update('menu_links')
|
|
->fields(array('has_children' => $parent_has_children))
|
|
->condition('mlid', $item['plid'])
|
|
->execute();
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Helper function that sets the p1..p9 values for a menu link being saved.
|
|
*/
|
|
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 - p9) corresponding to the depth always equals the mlid.
|
|
$item[$p] = $item['mlid'];
|
|
while ($i <= MENU_MAX_DEPTH) {
|
|
$p = 'p' . $i++;
|
|
$item[$p] = 0;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Helper function to build the router table based on the data from hook_menu.
|
|
*/
|
|
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();
|
|
$masks = 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 load and to_arg functions.
|
|
foreach ($parts as $k => $part) {
|
|
$match = FALSE;
|
|
// Look for wildcards in the form allowed to be used in PHP functions,
|
|
// because we are using these to construct the load function names.
|
|
// See http://php.net/manual/en/language.functions.php for reference.
|
|
if (preg_match('/^%(|[a-zA-Z_\x7f-\xff][a-zA-Z0-9_\x7f-\xff]*)$/', $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')) {
|
|
$function = $matches[1] . '_load';
|
|
// Create an array of arguments that will be passed to the _load
|
|
// function when this menu path is checked, if 'load arguments'
|
|
// exists.
|
|
$load_functions[$k] = isset($item['load arguments']) ? array($function => $item['load arguments']) : $function;
|
|
$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;
|
|
}
|
|
$masks[$fit] = 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 (!$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 an access callback is not found for a default local task we use
|
|
// the callback from the parent, since we expect them to be identical.
|
|
// In all other cases, the access parameters must be specified.
|
|
if (($item['type'] == MENU_DEFAULT_LOCAL_TASK) && !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']) && isset($item['access arguments'])) {
|
|
// Default callback.
|
|
$item['access callback'] = 'user_access';
|
|
}
|
|
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' => '',
|
|
'module' => '',
|
|
);
|
|
|
|
// 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'];
|
|
}
|
|
}
|
|
|
|
// Sort the masks so they are in order of descending fit.
|
|
$masks = array_keys($masks);
|
|
rsort($masks);
|
|
|
|
return array($menu, $masks);
|
|
}
|
|
|
|
/**
|
|
* Helper function to save data from menu_router_build() to the router table.
|
|
*/
|
|
function _menu_router_save($menu, $masks) {
|
|
// Delete the existing router since we have some data to replace it.
|
|
db_delete('menu_router')->execute();
|
|
|
|
// Prepare insert object.
|
|
$insert = db_insert('menu_router')
|
|
->fields(array(
|
|
'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',
|
|
));
|
|
|
|
foreach ($menu as $path => $item) {
|
|
// Fill in insert object values.
|
|
$insert->values(array(
|
|
'path' => $item['path'],
|
|
'load_functions' => $item['load_functions'],
|
|
'to_arg_functions' => $item['to_arg_functions'],
|
|
'access_callback' => $item['access callback'],
|
|
'access_arguments' => serialize($item['access arguments']),
|
|
'page_callback' => $item['page callback'],
|
|
'page_arguments' => serialize($item['page arguments']),
|
|
'fit' => $item['_fit'],
|
|
'number_parts' => $item['_number_parts'],
|
|
'tab_parent' => $item['tab_parent'],
|
|
'tab_root' => $item['tab_root'],
|
|
'title' => $item['title'],
|
|
'title_callback' => $item['title callback'],
|
|
'title_arguments' => ($item['title arguments'] ? serialize($item['title arguments']) : ''),
|
|
'type' => $item['type'],
|
|
'block_callback' => $item['block callback'],
|
|
'description' => $item['description'],
|
|
'position' => $item['position'],
|
|
'weight' => $item['weight'],
|
|
'file' => $item['include file'],
|
|
));
|
|
}
|
|
// Execute insert object.
|
|
$insert->execute();
|
|
// Store the masks.
|
|
variable_set('menu_masks', $masks);
|
|
|
|
return $menu;
|
|
}
|
|
|
|
/**
|
|
* Returns TRUE if a path is external (e.g. http://example.com).
|
|
*/
|
|
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);
|
|
}
|
|
|
|
/**
|
|
* Checks whether the site is in maintenance mode.
|
|
*
|
|
* This function will log the current user out and redirect to front page
|
|
* if the current user has no 'access site in maintenance mode' permission.
|
|
*
|
|
* @return
|
|
* FALSE if the site is not in maintenance mode, the user login page is
|
|
* displayed, or the user has the 'access site in maintenance mode'
|
|
* permission. TRUE for anonymous users not being on the login page when the
|
|
* site is in maintenance mode.
|
|
*/
|
|
function _menu_site_is_offline() {
|
|
// Check if site is in maintenance mode.
|
|
if (variable_get('maintenance_mode', 0)) {
|
|
if (user_access('access site in maintenance mode')) {
|
|
// Ensure that the maintenance mode message is displayed only once
|
|
// (allowing for page redirects) and specifically suppress its display on
|
|
// the maintenance mode settings page.
|
|
if ($_GET['q'] != 'admin/config/development/maintenance') {
|
|
if (user_access('administer site configuration')) {
|
|
drupal_set_message(t('Operating in maintenance mode. <a href="@url">Go online.</a>', array('@url' => url('admin/config/development/maintenance'))), 'status', FALSE);
|
|
}
|
|
else {
|
|
drupal_set_message(t('Operating in maintenance mode.'), 'status', FALSE);
|
|
}
|
|
}
|
|
}
|
|
else {
|
|
// Anonymous users get a FALSE at the login prompt, TRUE otherwise.
|
|
if (user_is_anonymous()) {
|
|
return ($_GET['q'] != 'user' && $_GET['q'] != 'user/login');
|
|
}
|
|
// Logged in users are unprivileged here, so they are logged out.
|
|
require_once DRUPAL_ROOT . '/' . drupal_get_path('module', 'user') . '/user.pages.inc';
|
|
user_logout();
|
|
}
|
|
}
|
|
return FALSE;
|
|
}
|
|
|
|
/**
|
|
* Validates the path of a menu link being created or edited.
|
|
*
|
|
* @return
|
|
* TRUE if it is a valid path AND the current user has access permission,
|
|
* FALSE otherwise.
|
|
*/
|
|
function menu_valid_path($form_item) {
|
|
global $menu_admin;
|
|
$item = array();
|
|
$path = $form_item['link_path'];
|
|
// We indicate that a menu administrator is running the menu access check.
|
|
$menu_admin = TRUE;
|
|
if ($path == '<front>' || menu_path_is_external($path)) {
|
|
$item = array('access' => TRUE);
|
|
}
|
|
elseif (preg_match('/\/\%/', $path)) {
|
|
// Path is dynamic (ie 'user/%'), so check directly against menu_router table.
|
|
if ($item = db_query("SELECT * FROM {menu_router} where path = :path", array(':path' => $path))->fetchAssoc()) {
|
|
$item['link_path'] = $form_item['link_path'];
|
|
$item['link_title'] = $form_item['link_title'];
|
|
$item['external'] = FALSE;
|
|
$item['options'] = '';
|
|
_menu_link_translate($item);
|
|
}
|
|
}
|
|
else {
|
|
$item = menu_get_item($path);
|
|
}
|
|
$menu_admin = FALSE;
|
|
return $item && $item['access'];
|
|
}
|
|
|
|
/**
|
|
* @} End of "defgroup menu".
|
|
*/
|