menu.inc

API for the Drupal menu system.

File

drupal/includes/menu.inc
View source
  1. <?php
  2. /**
  3. * @file
  4. * API for the Drupal menu system.
  5. */
  6. /**
  7. * @defgroup menu Menu system
  8. * @{
  9. * Define the navigation menus, and route page requests to code based on URLs.
  10. *
  11. * The Drupal menu system drives both the navigation system from a user
  12. * perspective and the callback system that Drupal uses to respond to URLs
  13. * passed from the browser. For this reason, a good understanding of the
  14. * menu system is fundamental to the creation of complex modules. As a note,
  15. * this is related to, but separate from menu.module, which allows menus
  16. * (which in this context are hierarchical lists of links) to be customized from
  17. * the Drupal administrative interface.
  18. *
  19. * Drupal's menu system follows a simple hierarchy defined by paths.
  20. * Implementations of hook_menu() define menu items and assign them to
  21. * paths (which should be unique). The menu system aggregates these items
  22. * and determines the menu hierarchy from the paths. For example, if the
  23. * paths defined were a, a/b, e, a/b/c/d, f/g, and a/b/h, the menu system
  24. * would form the structure:
  25. * - a
  26. * - a/b
  27. * - a/b/c/d
  28. * - a/b/h
  29. * - e
  30. * - f/g
  31. * Note that the number of elements in the path does not necessarily
  32. * determine the depth of the menu item in the tree.
  33. *
  34. * When responding to a page request, the menu system looks to see if the
  35. * path requested by the browser is registered as a menu item with a
  36. * callback. If not, the system searches up the menu tree for the most
  37. * complete match with a callback it can find. If the path a/b/i is
  38. * requested in the tree above, the callback for a/b would be used.
  39. *
  40. * The found callback function is called with any arguments specified
  41. * in the "page arguments" attribute of its menu item. The
  42. * attribute must be an array. After these arguments, any remaining
  43. * components of the path are appended as further arguments. In this
  44. * way, the callback for a/b above could respond to a request for
  45. * a/b/i differently than a request for a/b/j.
  46. *
  47. * For an illustration of this process, see page_example.module.
  48. *
  49. * Access to the callback functions is also protected by the menu system.
  50. * The "access callback" with an optional "access arguments" of each menu
  51. * item is called before the page callback proceeds. If this returns TRUE,
  52. * then access is granted; if FALSE, then access is denied. Default local task
  53. * menu items (see next paragraph) may omit this attribute to use the value
  54. * provided by the parent item.
  55. *
  56. * In the default Drupal interface, you will notice many links rendered as
  57. * tabs. These are known in the menu system as "local tasks", and they are
  58. * rendered as tabs by default, though other presentations are possible.
  59. * Local tasks function just as other menu items in most respects. It is
  60. * convention that the names of these tasks should be short verbs if
  61. * possible. In addition, a "default" local task should be provided for
  62. * each set. When visiting a local task's parent menu item, the default
  63. * local task will be rendered as if it is selected; this provides for a
  64. * normal tab user experience. This default task is special in that it
  65. * links not to its provided path, but to its parent item's path instead.
  66. * The default task's path is only used to place it appropriately in the
  67. * menu hierarchy.
  68. *
  69. * Everything described so far is stored in the menu_router table. The
  70. * menu_links table holds the visible menu links. By default these are
  71. * derived from the same hook_menu definitions, however you are free to
  72. * add more with menu_link_save().
  73. */
  74. /**
  75. * @defgroup menu_flags Menu flags
  76. * @{
  77. * Flags for use in the "type" attribute of menu items.
  78. */
  79. /**
  80. * Internal menu flag -- menu item is the root of the menu tree.
  81. */
  82. define('MENU_IS_ROOT', 0x0001);
  83. /**
  84. * Internal menu flag -- menu item is visible in the menu tree.
  85. */
  86. define('MENU_VISIBLE_IN_TREE', 0x0002);
  87. /**
  88. * Internal menu flag -- menu item is visible in the breadcrumb.
  89. */
  90. define('MENU_VISIBLE_IN_BREADCRUMB', 0x0004);
  91. /**
  92. * Internal menu flag -- menu item links back to its parent.
  93. */
  94. define('MENU_LINKS_TO_PARENT', 0x0008);
  95. /**
  96. * Internal menu flag -- menu item can be modified by administrator.
  97. */
  98. define('MENU_MODIFIED_BY_ADMIN', 0x0020);
  99. /**
  100. * Internal menu flag -- menu item was created by administrator.
  101. */
  102. define('MENU_CREATED_BY_ADMIN', 0x0040);
  103. /**
  104. * Internal menu flag -- menu item is a local task.
  105. */
  106. define('MENU_IS_LOCAL_TASK', 0x0080);
  107. /**
  108. * Internal menu flag -- menu item is a local action.
  109. */
  110. define('MENU_IS_LOCAL_ACTION', 0x0100);
  111. /**
  112. * @} End of "Menu flags".
  113. */
  114. /**
  115. * @defgroup menu_item_types Menu item types
  116. * @{
  117. * Definitions for various menu item types.
  118. *
  119. * Menu item definitions provide one of these constants, which are shortcuts for
  120. * combinations of @link menu_flags Menu flags @endlink.
  121. */
  122. /**
  123. * Menu type -- A "normal" menu item that's shown in menu and breadcrumbs.
  124. *
  125. * Normal menu items show up in the menu tree and can be moved/hidden by
  126. * the administrator. Use this for most menu items. It is the default value if
  127. * no menu item type is specified.
  128. */
  129. define('MENU_NORMAL_ITEM', MENU_VISIBLE_IN_TREE | MENU_VISIBLE_IN_BREADCRUMB);
  130. /**
  131. * Menu type -- A hidden, internal callback, typically used for API calls.
  132. *
  133. * Callbacks simply register a path so that the correct function is fired
  134. * when the URL is accessed. They do not appear in menus or breadcrumbs.
  135. */
  136. define('MENU_CALLBACK', 0x0000);
  137. /**
  138. * Menu type -- A normal menu item, hidden until enabled by an administrator.
  139. *
  140. * Modules may "suggest" menu items that the administrator may enable. They act
  141. * just as callbacks do until enabled, at which time they act like normal items.
  142. * Note for the value: 0x0010 was a flag which is no longer used, but this way
  143. * the values of MENU_CALLBACK and MENU_SUGGESTED_ITEM are separate.
  144. */
  145. define('MENU_SUGGESTED_ITEM', MENU_VISIBLE_IN_BREADCRUMB | 0x0010);
  146. /**
  147. * Menu type -- A task specific to the parent item, usually rendered as a tab.
  148. *
  149. * Local tasks are menu items that describe actions to be performed on their
  150. * parent item. An example is the path "node/52/edit", which performs the
  151. * "edit" task on "node/52".
  152. */
  153. define('MENU_LOCAL_TASK', MENU_IS_LOCAL_TASK | MENU_VISIBLE_IN_BREADCRUMB);
  154. /**
  155. * Menu type -- The "default" local task, which is initially active.
  156. *
  157. * Every set of local tasks should provide one "default" task, that links to the
  158. * same path as its parent when clicked.
  159. */
  160. define('MENU_DEFAULT_LOCAL_TASK', MENU_IS_LOCAL_TASK | MENU_LINKS_TO_PARENT | MENU_VISIBLE_IN_BREADCRUMB);
  161. /**
  162. * Menu type -- An action specific to the parent, usually rendered as a link.
  163. *
  164. * Local actions are menu items that describe actions on the parent item such
  165. * as adding a new user, taxonomy term, etc.
  166. */
  167. define('MENU_LOCAL_ACTION', MENU_IS_LOCAL_TASK | MENU_IS_LOCAL_ACTION | MENU_VISIBLE_IN_BREADCRUMB);
  168. /**
  169. * @} End of "Menu item types".
  170. */
  171. /**
  172. * @defgroup menu_context_types Menu context types
  173. * @{
  174. * Flags for use in the "context" attribute of menu router items.
  175. */
  176. /**
  177. * Internal menu flag: Invisible local task.
  178. *
  179. * This flag may be used for local tasks like "Delete", so custom modules and
  180. * themes can alter the default context and expose the task by altering menu.
  181. */
  182. define('MENU_CONTEXT_NONE', 0x0000);
  183. /**
  184. * Internal menu flag: Local task should be displayed in page context.
  185. */
  186. define('MENU_CONTEXT_PAGE', 0x0001);
  187. /**
  188. * Internal menu flag: Local task should be displayed inline.
  189. */
  190. define('MENU_CONTEXT_INLINE', 0x0002);
  191. /**
  192. * @} End of "Menu context types".
  193. */
  194. /**
  195. * @defgroup menu_status_codes Menu status codes
  196. * @{
  197. * Status codes for menu callbacks.
  198. */
  199. /**
  200. * Internal menu status code -- Menu item was found.
  201. */
  202. define('MENU_FOUND', 1);
  203. /**
  204. * Internal menu status code -- Menu item was not found.
  205. */
  206. define('MENU_NOT_FOUND', 2);
  207. /**
  208. * Internal menu status code -- Menu item access is denied.
  209. */
  210. define('MENU_ACCESS_DENIED', 3);
  211. /**
  212. * Internal menu status code -- Menu item inaccessible because site is offline.
  213. */
  214. define('MENU_SITE_OFFLINE', 4);
  215. /**
  216. * Internal menu status code -- Everything is working fine.
  217. */
  218. define('MENU_SITE_ONLINE', 5);
  219. /**
  220. * @} End of "Menu status codes".
  221. */
  222. /**
  223. * @defgroup menu_tree_parameters Menu tree parameters
  224. * @{
  225. * Parameters for a menu tree.
  226. */
  227. /**
  228. * The maximum number of path elements for a menu callback
  229. */
  230. define('MENU_MAX_PARTS', 9);
  231. /**
  232. * The maximum depth of a menu links tree - matches the number of p columns.
  233. */
  234. define('MENU_MAX_DEPTH', 9);
  235. /**
  236. * @} End of "Menu tree parameters".
  237. */
  238. /**
  239. * Reserved key to identify the most specific menu link for a given path.
  240. *
  241. * The value of this constant is a hash of the constant name. We use the hash
  242. * so that the reserved key is over 32 characters in length and will not
  243. * collide with allowed menu names:
  244. * @code
  245. * sha1('MENU_PREFERRED_LINK') = 1cf698d64d1aa4b83907cf6ed55db3a7f8e92c91
  246. * @endcode
  247. *
  248. * @see menu_link_get_preferred()
  249. */
  250. define('MENU_PREFERRED_LINK', '1cf698d64d1aa4b83907cf6ed55db3a7f8e92c91');
  251. /**
  252. * Returns the ancestors (and relevant placeholders) for any given path.
  253. *
  254. * For example, the ancestors of node/12345/edit are:
  255. * - node/12345/edit
  256. * - node/12345/%
  257. * - node/%/edit
  258. * - node/%/%
  259. * - node/12345
  260. * - node/%
  261. * - node
  262. *
  263. * To generate these, we will use binary numbers. Each bit represents a
  264. * part of the path. If the bit is 1, then it represents the original
  265. * value while 0 means wildcard. If the path is node/12/edit/foo
  266. * then the 1011 bitstring represents node/%/edit/foo where % means that
  267. * any argument matches that part. We limit ourselves to using binary
  268. * numbers that correspond the patterns of wildcards of router items that
  269. * actually exists. This list of 'masks' is built in menu_rebuild().
  270. *
  271. * @param $parts
  272. * An array of path parts, for the above example
  273. * array('node', '12345', 'edit').
  274. *
  275. * @return
  276. * An array which contains the ancestors and placeholders. Placeholders
  277. * simply contain as many '%s' as the ancestors.
  278. */
  279. function menu_get_ancestors($parts) {
  280. $number_parts = count($parts);
  281. $ancestors = array();
  282. $length = $number_parts - 1;
  283. $end = (1 << $number_parts) - 1;
  284. $masks = variable_get('menu_masks');
  285. // If the optimized menu_masks array is not available use brute force to get
  286. // the correct $ancestors and $placeholders returned. Do not use this as the
  287. // default value of the menu_masks variable to avoid building such a big
  288. // array.
  289. if (!$masks) {
  290. $masks = range(511, 1);
  291. }
  292. // Only examine patterns that actually exist as router items (the masks).
  293. foreach ($masks as $i) {
  294. if ($i > $end) {
  295. // Only look at masks that are not longer than the path of interest.
  296. continue;
  297. }
  298. elseif ($i < (1 << $length)) {
  299. // We have exhausted the masks of a given length, so decrease the length.
  300. --$length;
  301. }
  302. $current = '';
  303. for ($j = $length; $j >= 0; $j--) {
  304. // Check the bit on the $j offset.
  305. if ($i & (1 << $j)) {
  306. // Bit one means the original value.
  307. $current .= $parts[$length - $j];
  308. }
  309. else {
  310. // Bit zero means means wildcard.
  311. $current .= '%';
  312. }
  313. // Unless we are at offset 0, add a slash.
  314. if ($j) {
  315. $current .= '/';
  316. }
  317. }
  318. $ancestors[] = $current;
  319. }
  320. return $ancestors;
  321. }
  322. /**
  323. * Unserializes menu data, using a map to replace path elements.
  324. *
  325. * The menu system stores various path-related information (such as the 'page
  326. * arguments' and 'access arguments' components of a menu item) in the database
  327. * using serialized arrays, where integer values in the arrays represent
  328. * arguments to be replaced by values from the path. This function first
  329. * unserializes such menu information arrays, and then does the path
  330. * replacement.
  331. *
  332. * The path replacement acts on each integer-valued element of the unserialized
  333. * menu data array ($data) using a map array ($map, which is typically an array
  334. * of path arguments) as a list of replacements. For instance, if there is an
  335. * element of $data whose value is the number 2, then it is replaced in $data
  336. * with $map[2]; non-integer values in $data are left alone.
  337. *
  338. * As an example, an unserialized $data array with elements ('node_load', 1)
  339. * represents instructions for calling the node_load() function. Specifically,
  340. * this instruction says to use the path component at index 1 as the input
  341. * parameter to node_load(). If the path is 'node/123', then $map will be the
  342. * array ('node', 123), and the returned array from this function will have
  343. * elements ('node_load', 123), since $map[1] is 123. This return value will
  344. * indicate specifically that node_load(123) is to be called to load the node
  345. * whose ID is 123 for this menu item.
  346. *
  347. * @param $data
  348. * A serialized array of menu data, as read from the database.
  349. * @param $map
  350. * A path argument array, used to replace integer values in $data; an integer
  351. * value N in $data will be replaced by value $map[N]. Typically, the $map
  352. * array is generated from a call to the arg() function.
  353. *
  354. * @return
  355. * The unserialized $data array, with path arguments replaced.
  356. */
  357. function menu_unserialize($data, $map) {
  358. if ($data = unserialize($data)) {
  359. foreach ($data as $k => $v) {
  360. if (is_int($v)) {
  361. $data[$k] = isset($map[$v]) ? $map[$v] : '';
  362. }
  363. }
  364. return $data;
  365. }
  366. else {
  367. return array();
  368. }
  369. }
  370. /**
  371. * Replaces the statically cached item for a given path.
  372. *
  373. * @param $path
  374. * The path.
  375. * @param $router_item
  376. * The router item. Usually a router entry from menu_get_item() is either
  377. * modified or set to a different path. This allows the navigation block,
  378. * the page title, the breadcrumb, and the page help to be modified in one
  379. * call.
  380. */
  381. function menu_set_item($path, $router_item) {
  382. menu_get_item($path, $router_item);
  383. }
  384. /**
  385. * Gets a router item.
  386. *
  387. * @param $path
  388. * The path, for example node/5. The function will find the corresponding
  389. * node/% item and return that.
  390. * @param $router_item
  391. * Internal use only.
  392. *
  393. * @return
  394. * The router item or, if an error occurs in _menu_translate(), FALSE. A
  395. * router item is an associative array corresponding to one row in the
  396. * menu_router table. The value corresponding to the key 'map' holds the
  397. * loaded objects. The value corresponding to the key 'access' is TRUE if the
  398. * current user can access this page. The values corresponding to the keys
  399. * 'title', 'page_arguments', 'access_arguments', and 'theme_arguments' will
  400. * be filled in based on the database values and the objects loaded.
  401. */
  402. function menu_get_item($path = NULL, $router_item = NULL) {
  403. $router_items = &drupal_static(__FUNCTION__);
  404. if (!isset($path)) {
  405. $path = $_GET['q'];
  406. }
  407. if (isset($router_item)) {
  408. $router_items[$path] = $router_item;
  409. }
  410. if (!isset($router_items[$path])) {
  411. // Rebuild if we know it's needed, or if the menu masks are missing which
  412. // occurs rarely, likely due to a race condition of multiple rebuilds.
  413. if (variable_get('menu_rebuild_needed', FALSE) || !variable_get('menu_masks', array())) {
  414. menu_rebuild();
  415. }
  416. $original_map = arg(NULL, $path);
  417. $parts = array_slice($original_map, 0, MENU_MAX_PARTS);
  418. $ancestors = menu_get_ancestors($parts);
  419. $router_item = db_query_range('SELECT * FROM {menu_router} WHERE path IN (:ancestors) ORDER BY fit DESC', 0, 1, array(':ancestors' => $ancestors))->fetchAssoc();
  420. if ($router_item) {
  421. // Allow modules to alter the router item before it is translated and
  422. // checked for access.
  423. drupal_alter('menu_get_item', $router_item, $path, $original_map);
  424. $map = _menu_translate($router_item, $original_map);
  425. $router_item['original_map'] = $original_map;
  426. if ($map === FALSE) {
  427. $router_items[$path] = FALSE;
  428. return FALSE;
  429. }
  430. if ($router_item['access']) {
  431. $router_item['map'] = $map;
  432. $router_item['page_arguments'] = array_merge(menu_unserialize($router_item['page_arguments'], $map), array_slice($map, $router_item['number_parts']));
  433. $router_item['theme_arguments'] = array_merge(menu_unserialize($router_item['theme_arguments'], $map), array_slice($map, $router_item['number_parts']));
  434. }
  435. }
  436. $router_items[$path] = $router_item;
  437. }
  438. return $router_items[$path];
  439. }
  440. /**
  441. * Execute the page callback associated with the current path.
  442. *
  443. * @param $path
  444. * The drupal path whose handler is to be be executed. If set to NULL, then
  445. * the current path is used.
  446. * @param $deliver
  447. * (optional) A boolean to indicate whether the content should be sent to the
  448. * browser using the appropriate delivery callback (TRUE) or whether to return
  449. * the result to the caller (FALSE).
  450. */
  451. function menu_execute_active_handler($path = NULL, $deliver = TRUE) {
  452. // Check if site is offline.
  453. $page_callback_result = _menu_site_is_offline() ? MENU_SITE_OFFLINE : MENU_SITE_ONLINE;
  454. // Allow other modules to change the site status but not the path because that
  455. // would not change the global variable. hook_url_inbound_alter() can be used
  456. // to change the path. Code later will not use the $read_only_path variable.
  457. $read_only_path = !empty($path) ? $path : $_GET['q'];
  458. drupal_alter('menu_site_status', $page_callback_result, $read_only_path);
  459. // Only continue if the site status is not set.
  460. if ($page_callback_result == MENU_SITE_ONLINE) {
  461. if ($router_item = menu_get_item($path)) {
  462. if ($router_item['access']) {
  463. if ($router_item['include_file']) {
  464. require_once DRUPAL_ROOT . '/' . $router_item['include_file'];
  465. }
  466. $page_callback_result = call_user_func_array($router_item['page_callback'], $router_item['page_arguments']);
  467. }
  468. else {
  469. $page_callback_result = MENU_ACCESS_DENIED;
  470. }
  471. }
  472. else {
  473. $page_callback_result = MENU_NOT_FOUND;
  474. }
  475. }
  476. // Deliver the result of the page callback to the browser, or if requested,
  477. // return it raw, so calling code can do more processing.
  478. if ($deliver) {
  479. $default_delivery_callback = (isset($router_item) && $router_item) ? $router_item['delivery_callback'] : NULL;
  480. drupal_deliver_page($page_callback_result, $default_delivery_callback);
  481. }
  482. else {
  483. return $page_callback_result;
  484. }
  485. }
  486. /**
  487. * Loads objects into the map as defined in the $item['load_functions'].
  488. *
  489. * @param $item
  490. * A menu router or menu link item
  491. * @param $map
  492. * An array of path arguments (ex: array('node', '5'))
  493. *
  494. * @return
  495. * Returns TRUE for success, FALSE if an object cannot be loaded.
  496. * Names of object loading functions are placed in $item['load_functions'].
  497. * Loaded objects are placed in $map[]; keys are the same as keys in the
  498. * $item['load_functions'] array.
  499. * $item['access'] is set to FALSE if an object cannot be loaded.
  500. */
  501. function _menu_load_objects(&$item, &$map) {
  502. if ($load_functions = $item['load_functions']) {
  503. // If someone calls this function twice, then unserialize will fail.
  504. if (!is_array($load_functions)) {
  505. $load_functions = unserialize($load_functions);
  506. }
  507. $path_map = $map;
  508. foreach ($load_functions as $index => $function) {
  509. if ($function) {
  510. $value = isset($path_map[$index]) ? $path_map[$index] : '';
  511. if (is_array($function)) {
  512. // Set up arguments for the load function. These were pulled from
  513. // 'load arguments' in the hook_menu() entry, but they need
  514. // some processing. In this case the $function is the key to the
  515. // load_function array, and the value is the list of arguments.
  516. list($function, $args) = each($function);
  517. $load_functions[$index] = $function;
  518. // Some arguments are placeholders for dynamic items to process.
  519. foreach ($args as $i => $arg) {
  520. if ($arg === '%index') {
  521. // Pass on argument index to the load function, so multiple
  522. // occurrences of the same placeholder can be identified.
  523. $args[$i] = $index;
  524. }
  525. if ($arg === '%map') {
  526. // Pass on menu map by reference. The accepting function must
  527. // also declare this as a reference if it wants to modify
  528. // the map.
  529. $args[$i] = &$map;
  530. }
  531. if (is_int($arg)) {
  532. $args[$i] = isset($path_map[$arg]) ? $path_map[$arg] : '';
  533. }
  534. }
  535. array_unshift($args, $value);
  536. $return = call_user_func_array($function, $args);
  537. }
  538. else {
  539. $return = $function($value);
  540. }
  541. // If callback returned an error or there is no callback, trigger 404.
  542. if ($return === FALSE) {
  543. $item['access'] = FALSE;
  544. $map = FALSE;
  545. return FALSE;
  546. }
  547. $map[$index] = $return;
  548. }
  549. }
  550. $item['load_functions'] = $load_functions;
  551. }
  552. return TRUE;
  553. }
  554. /**
  555. * Checks access to a menu item using the access callback.
  556. *
  557. * @param $item
  558. * A menu router or menu link item
  559. * @param $map
  560. * An array of path arguments (ex: array('node', '5'))
  561. *
  562. * @return
  563. * $item['access'] becomes TRUE if the item is accessible, FALSE otherwise.
  564. */
  565. function _menu_check_access(&$item, $map) {
  566. $item['access'] = FALSE;
  567. // Determine access callback, which will decide whether or not the current
  568. // user has access to this path.
  569. $callback = empty($item['access_callback']) ? 0 : trim($item['access_callback']);
  570. // Check for a TRUE or FALSE value.
  571. if (is_numeric($callback)) {
  572. $item['access'] = (bool) $callback;
  573. }
  574. else {
  575. $arguments = menu_unserialize($item['access_arguments'], $map);
  576. // As call_user_func_array is quite slow and user_access is a very common
  577. // callback, it is worth making a special case for it.
  578. if ($callback == 'user_access') {
  579. $item['access'] = (count($arguments) == 1) ? user_access($arguments[0]) : user_access($arguments[0], $arguments[1]);
  580. }
  581. elseif (function_exists($callback)) {
  582. $item['access'] = call_user_func_array($callback, $arguments);
  583. }
  584. }
  585. }
  586. /**
  587. * Localizes the router item title using t() or another callback.
  588. *
  589. * Translate the title and description to allow storage of English title
  590. * strings in the database, yet display of them in the language required
  591. * by the current user.
  592. *
  593. * @param $item
  594. * A menu router item or a menu link item.
  595. * @param $map
  596. * The path as an array with objects already replaced. E.g., for path
  597. * node/123 $map would be array('node', $node) where $node is the node
  598. * object for node 123.
  599. * @param $link_translate
  600. * TRUE if we are translating a menu link item; FALSE if we are
  601. * translating a menu router item.
  602. *
  603. * @return
  604. * No return value.
  605. * $item['title'] is localized according to $item['title_callback'].
  606. * If an item's callback is check_plain(), $item['options']['html'] becomes
  607. * TRUE.
  608. * $item['description'] is translated using t().
  609. * When doing link translation and the $item['options']['attributes']['title']
  610. * (link title attribute) matches the description, it is translated as well.
  611. */
  612. function _menu_item_localize(&$item, $map, $link_translate = FALSE) {
  613. $callback = $item['title_callback'];
  614. $item['localized_options'] = $item['options'];
  615. // All 'class' attributes are assumed to be an array during rendering, but
  616. // links stored in the database may use an old string value.
  617. // @todo In order to remove this code we need to implement a database update
  618. // including unserializing all existing link options and running this code
  619. // on them, as well as adding validation to menu_link_save().
  620. if (isset($item['options']['attributes']['class']) && is_string($item['options']['attributes']['class'])) {
  621. $item['localized_options']['attributes']['class'] = explode(' ', $item['options']['attributes']['class']);
  622. }
  623. // If we are translating the title of a menu link, and its title is the same
  624. // as the corresponding router item, then we can use the title information
  625. // from the router. If it's customized, then we need to use the link title
  626. // itself; can't localize.
  627. // If we are translating a router item (tabs, page, breadcrumb), then we
  628. // can always use the information from the router item.
  629. if (!$link_translate || ($item['title'] == $item['link_title'])) {
  630. // t() is a special case. Since it is used very close to all the time,
  631. // we handle it directly instead of using indirect, slower methods.
  632. if ($callback == 't') {
  633. if (empty($item['title_arguments'])) {
  634. $item['title'] = t($item['title']);
  635. }
  636. else {
  637. $item['title'] = t($item['title'], menu_unserialize($item['title_arguments'], $map));
  638. }
  639. }
  640. elseif ($callback && function_exists($callback)) {
  641. if (empty($item['title_arguments'])) {
  642. $item['title'] = $callback($item['title']);
  643. }
  644. else {
  645. $item['title'] = call_user_func_array($callback, menu_unserialize($item['title_arguments'], $map));
  646. }
  647. // Avoid calling check_plain again on l() function.
  648. if ($callback == 'check_plain') {
  649. $item['localized_options']['html'] = TRUE;
  650. }
  651. }
  652. }
  653. elseif ($link_translate) {
  654. $item['title'] = $item['link_title'];
  655. }
  656. // Translate description, see the motivation above.
  657. if (!empty($item['description'])) {
  658. $original_description = $item['description'];
  659. $item['description'] = t($item['description']);
  660. if ($link_translate && isset($item['options']['attributes']['title']) && $item['options']['attributes']['title'] == $original_description) {
  661. $item['localized_options']['attributes']['title'] = $item['description'];
  662. }
  663. }
  664. }
  665. /**
  666. * Handles dynamic path translation and menu access control.
  667. *
  668. * When a user arrives on a page such as node/5, this function determines
  669. * what "5" corresponds to, by inspecting the page's menu path definition,
  670. * node/%node. This will call node_load(5) to load the corresponding node
  671. * object.
  672. *
  673. * It also works in reverse, to allow the display of tabs and menu items which
  674. * contain these dynamic arguments, translating node/%node to node/5.
  675. *
  676. * Translation of menu item titles and descriptions are done here to
  677. * allow for storage of English strings in the database, and translation
  678. * to the language required to generate the current page.
  679. *
  680. * @param $router_item
  681. * A menu router item
  682. * @param $map
  683. * An array of path arguments (ex: array('node', '5'))
  684. * @param $to_arg
  685. * Execute $item['to_arg_functions'] or not. Use only if you want to render a
  686. * path from the menu table, for example tabs.
  687. *
  688. * @return
  689. * Returns the map with objects loaded as defined in the
  690. * $item['load_functions']. $item['access'] becomes TRUE if the item is
  691. * accessible, FALSE otherwise. $item['href'] is set according to the map.
  692. * If an error occurs during calling the load_functions (like trying to load
  693. * a non-existent node) then this function returns FALSE.
  694. */
  695. function _menu_translate(&$router_item, $map, $to_arg = FALSE) {
  696. if ($to_arg && !empty($router_item['to_arg_functions'])) {
  697. // Fill in missing path elements, such as the current uid.
  698. _menu_link_map_translate($map, $router_item['to_arg_functions']);
  699. }
  700. // The $path_map saves the pieces of the path as strings, while elements in
  701. // $map may be replaced with loaded objects.
  702. $path_map = $map;
  703. if (!empty($router_item['load_functions']) && !_menu_load_objects($router_item, $map)) {
  704. // An error occurred loading an object.
  705. $router_item['access'] = FALSE;
  706. return FALSE;
  707. }
  708. // Generate the link path for the page request or local tasks.
  709. $link_map = explode('/', $router_item['path']);
  710. if (isset($router_item['tab_root'])) {
  711. $tab_root_map = explode('/', $router_item['tab_root']);
  712. }
  713. if (isset($router_item['tab_parent'])) {
  714. $tab_parent_map = explode('/', $router_item['tab_parent']);
  715. }
  716. for ($i = 0; $i < $router_item['number_parts']; $i++) {
  717. if ($link_map[$i] == '%') {
  718. $link_map[$i] = $path_map[$i];
  719. }
  720. if (isset($tab_root_map[$i]) && $tab_root_map[$i] == '%') {
  721. $tab_root_map[$i] = $path_map[$i];
  722. }
  723. if (isset($tab_parent_map[$i]) && $tab_parent_map[$i] == '%') {
  724. $tab_parent_map[$i] = $path_map[$i];
  725. }
  726. }
  727. $router_item['href'] = implode('/', $link_map);
  728. $router_item['tab_root_href'] = implode('/', $tab_root_map);
  729. $router_item['tab_parent_href'] = implode('/', $tab_parent_map);
  730. $router_item['options'] = array();
  731. _menu_check_access($router_item, $map);
  732. // For performance, don't localize an item the user can't access.
  733. if ($router_item['access']) {
  734. _menu_item_localize($router_item, $map);
  735. }
  736. return $map;
  737. }
  738. /**
  739. * Translates the path elements in the map using any to_arg helper function.
  740. *
  741. * @param $map
  742. * An array of path arguments (ex: array('node', '5'))
  743. * @param $to_arg_functions
  744. * An array of helper function (ex: array(2 => 'menu_tail_to_arg'))
  745. *
  746. * @see hook_menu()
  747. */
  748. function _menu_link_map_translate(&$map, $to_arg_functions) {
  749. $to_arg_functions = unserialize($to_arg_functions);
  750. foreach ($to_arg_functions as $index => $function) {
  751. // Translate place-holders into real values.
  752. $arg = $function(!empty($map[$index]) ? $map[$index] : '', $map, $index);
  753. if (!empty($map[$index]) || isset($arg)) {
  754. $map[$index] = $arg;
  755. }
  756. else {
  757. unset($map[$index]);
  758. }
  759. }
  760. }
  761. /**
  762. * Returns a string containing the path relative to the current index.
  763. */
  764. function menu_tail_to_arg($arg, $map, $index) {
  765. return implode('/', array_slice($map, $index));
  766. }
  767. /**
  768. * Loads the path as one string relative to the current index.
  769. *
  770. * To use this load function, you must specify the load arguments
  771. * in the router item as:
  772. * @code
  773. * $item['load arguments'] = array('%map', '%index');
  774. * @endcode
  775. *
  776. * @see search_menu().
  777. */
  778. function menu_tail_load($arg, &$map, $index) {
  779. $arg = implode('/', array_slice($map, $index));
  780. $map = array_slice($map, 0, $index);
  781. return $arg;
  782. }
  783. /**
  784. * Provides menu link access control, translation, and argument handling.
  785. *
  786. * This function is similar to _menu_translate(), but it also does
  787. * link-specific preparation (such as always calling to_arg() functions).
  788. *
  789. * @param $item
  790. * A menu link.
  791. * @param $translate
  792. * (optional) Whether to try to translate a link containing dynamic path
  793. * argument placeholders (%) based on the menu router item of the current
  794. * path. Defaults to FALSE. Internally used for breadcrumbs.
  795. *
  796. * @return
  797. * Returns the map of path arguments with objects loaded as defined in the
  798. * $item['load_functions'].
  799. * $item['access'] becomes TRUE if the item is accessible, FALSE otherwise.
  800. * $item['href'] is generated from link_path, possibly by to_arg functions.
  801. * $item['title'] is generated from link_title, and may be localized.
  802. * $item['options'] is unserialized; it is also changed within the call here
  803. * to $item['localized_options'] by _menu_item_localize().
  804. */
  805. function _menu_link_translate(&$item, $translate = FALSE) {
  806. if (!is_array($item['options'])) {
  807. $item['options'] = unserialize($item['options']);
  808. }
  809. if ($item['external']) {
  810. $item['access'] = 1;
  811. $map = array();
  812. $item['href'] = $item['link_path'];
  813. $item['title'] = $item['link_title'];
  814. $item['localized_options'] = $item['options'];
  815. }
  816. else {
  817. // Complete the path of the menu link with elements from the current path,
  818. // if it contains dynamic placeholders (%).
  819. $map = explode('/', $item['link_path']);
  820. if (strpos($item['link_path'], '%') !== FALSE) {
  821. // Invoke registered to_arg callbacks.
  822. if (!empty($item['to_arg_functions'])) {
  823. _menu_link_map_translate($map, $item['to_arg_functions']);
  824. }
  825. // Or try to derive the path argument map from the current router item,
  826. // if this $item's path is within the router item's path. This means
  827. // that if we are on the current path 'foo/%/bar/%/baz', then
  828. // menu_get_item() will have translated the menu router item for the
  829. // current path, and we can take over the argument map for a link like
  830. // 'foo/%/bar'. This inheritance is only valid for breadcrumb links.
  831. // @see _menu_tree_check_access()
  832. // @see menu_get_active_breadcrumb()
  833. elseif ($translate && ($current_router_item = menu_get_item())) {
  834. // If $translate is TRUE, then this link is in the active trail.
  835. // Only translate paths within the current path.
  836. if (strpos($current_router_item['path'], $item['link_path']) === 0) {
  837. $count = count($map);
  838. $map = array_slice($current_router_item['original_map'], 0, $count);
  839. $item['original_map'] = $map;
  840. if (isset($current_router_item['map'])) {
  841. $item['map'] = array_slice($current_router_item['map'], 0, $count);
  842. }
  843. // Reset access to check it (for the first time).
  844. unset($item['access']);
  845. }
  846. }
  847. }
  848. $item['href'] = implode('/', $map);
  849. // Skip links containing untranslated arguments.
  850. if (strpos($item['href'], '%') !== FALSE) {
  851. $item['access'] = FALSE;
  852. return FALSE;
  853. }
  854. // menu_tree_check_access() may set this ahead of time for links to nodes.
  855. if (!isset($item['access'])) {
  856. if (!empty($item['load_functions']) && !_menu_load_objects($item, $map)) {
  857. // An error occurred loading an object.
  858. $item['access'] = FALSE;
  859. return FALSE;
  860. }
  861. _menu_check_access($item, $map);
  862. }
  863. // For performance, don't localize a link the user can't access.
  864. if ($item['access']) {
  865. _menu_item_localize($item, $map, TRUE);
  866. }
  867. }
  868. // Allow other customizations - e.g. adding a page-specific query string to the
  869. // options array. For performance reasons we only invoke this hook if the link
  870. // has the 'alter' flag set in the options array.
  871. if (!empty($item['options']['alter'])) {
  872. drupal_alter('translated_menu_link', $item, $map);
  873. }
  874. return $map;
  875. }
  876. /**
  877. * Gets a loaded object from a router item.
  878. *
  879. * menu_get_object() provides access to objects loaded by the current router
  880. * item. For example, on the page node/%node, the router loads the %node object,
  881. * and calling menu_get_object() will return that. Normally, it is necessary to
  882. * specify the type of object referenced, however node is the default.
  883. * The following example tests to see whether the node being displayed is of the
  884. * "story" content type:
  885. * @code
  886. * $node = menu_get_object();
  887. * $story = $node->type == 'story';
  888. * @endcode
  889. *
  890. * @param $type
  891. * Type of the object. These appear in hook_menu definitions as %type. Core
  892. * provides aggregator_feed, aggregator_category, contact, filter_format,
  893. * forum_term, menu, menu_link, node, taxonomy_vocabulary, user. See the
  894. * relevant {$type}_load function for more on each. Defaults to node.
  895. * @param $position
  896. * The position of the object in the path, where the first path segment is 0.
  897. * For node/%node, the position of %node is 1, but for comment/reply/%node,
  898. * it's 2. Defaults to 1.
  899. * @param $path
  900. * See menu_get_item() for more on this. Defaults to the current path.
  901. */
  902. function menu_get_object($type = 'node', $position = 1, $path = NULL) {
  903. $router_item = menu_get_item($path);
  904. if (isset($router_item['load_functions'][$position]) && !empty($router_item['map'][$position]) && $router_item['load_functions'][$position] == $type . '_load') {
  905. return $router_item['map'][$position];
  906. }
  907. }
  908. /**
  909. * Renders a menu tree based on the current path.
  910. *
  911. * The tree is expanded based on the current path and dynamic paths are also
  912. * changed according to the defined to_arg functions (for example the 'My
  913. * account' link is changed from user/% to a link with the current user's uid).
  914. *
  915. * @param $menu_name
  916. * The name of the menu.
  917. *
  918. * @return
  919. * A structured array representing the specified menu on the current page, to
  920. * be rendered by drupal_render().
  921. */
  922. function menu_tree($menu_name) {
  923. $menu_output = &drupal_static(__FUNCTION__, array());
  924. if (!isset($menu_output[$menu_name])) {
  925. $tree = menu_tree_page_data($menu_name);
  926. $menu_output[$menu_name] = menu_tree_output($tree);
  927. }
  928. return $menu_output[$menu_name];
  929. }
  930. /**
  931. * Returns a rendered menu tree.
  932. *
  933. * The menu item's LI element is given one of the following classes:
  934. * - expanded: The menu item is showing its submenu.
  935. * - collapsed: The menu item has a submenu which is not shown.
  936. * - leaf: The menu item has no submenu.
  937. *
  938. * @param $tree
  939. * A data structure representing the tree as returned from menu_tree_data.
  940. *
  941. * @return
  942. * A structured array to be rendered by drupal_render().
  943. */
  944. function menu_tree_output($tree) {
  945. $build = array();
  946. $items = array();
  947. // Pull out just the menu links we are going to render so that we
  948. // get an accurate count for the first/last classes.
  949. foreach ($tree as $data) {
  950. if ($data['link']['access'] && !$data['link']['hidden']) {
  951. $items[] = $data;
  952. }
  953. }
  954. $router_item = menu_get_item();
  955. $num_items = count($items);
  956. foreach ($items as $i => $data) {
  957. $class = array();
  958. if ($i == 0) {
  959. $class[] = 'first';
  960. }
  961. if ($i == $num_items - 1) {
  962. $class[] = 'last';
  963. }
  964. // Set a class for the <li>-tag. Since $data['below'] may contain local
  965. // tasks, only set 'expanded' class if the link also has children within
  966. // the current menu.
  967. if ($data['link']['has_children'] && $data['below']) {
  968. $class[] = 'expanded';
  969. }
  970. elseif ($data['link']['has_children']) {
  971. $class[] = 'collapsed';
  972. }
  973. else {
  974. $class[] = 'leaf';
  975. }
  976. // Set a class if the link is in the active trail.
  977. if ($data['link']['in_active_trail']) {
  978. $class[] = 'active-trail';
  979. $data['link']['localized_options']['attributes']['class'][] = 'active-trail';
  980. }
  981. // Normally, l() compares the href of every link with $_GET['q'] and sets
  982. // the active class accordingly. But local tasks do not appear in menu
  983. // trees, so if the current path is a local task, and this link is its
  984. // tab root, then we have to set the class manually.
  985. if ($data['link']['href'] == $router_item['tab_root_href'] && $data['link']['href'] != $_GET['q']) {
  986. $data['link']['localized_options']['attributes']['class'][] = 'active';
  987. }
  988. // Allow menu-specific theme overrides.
  989. $element['#theme'] = 'menu_link__' . strtr($data['link']['menu_name'], '-', '_');
  990. $element['#attributes']['class'] = $class;
  991. $element['#title'] = $data['link']['title'];
  992. $element['#href'] = $data['link']['href'];
  993. $element['#localized_options'] = !empty($data['link']['localized_options']) ? $data['link']['localized_options'] : array();
  994. $element['#below'] = $data['below'] ? menu_tree_output($data['below']) : $data['below'];
  995. $element['#original_link'] = $data['link'];
  996. // Index using the link's unique mlid.
  997. $build[$data['link']['mlid']] = $element;
  998. }
  999. if ($build) {
  1000. // Make sure drupal_render() does not re-order the links.
  1001. $build['#sorted'] = TRUE;
  1002. // Add the theme wrapper for outer markup.
  1003. // Allow menu-specific theme overrides.
  1004. $build['#theme_wrappers'][] = 'menu_tree__' . strtr($data['link']['menu_name'], '-', '_');
  1005. }
  1006. return $build;
  1007. }
  1008. /**
  1009. * Gets the data structure representing a named menu tree.
  1010. *
  1011. * Since this can be the full tree including hidden items, the data returned
  1012. * may be used for generating an an admin interface or a select.
  1013. *
  1014. * @param $menu_name
  1015. * The named menu links to return
  1016. * @param $link
  1017. * A fully loaded menu link, or NULL. If a link is supplied, only the
  1018. * path to root will be included in the returned tree - as if this link
  1019. * represented the current page in a visible menu.
  1020. * @param $max_depth
  1021. * Optional maximum depth of links to retrieve. Typically useful if only one
  1022. * or two levels of a sub tree are needed in conjunction with a non-NULL
  1023. * $link, in which case $max_depth should be greater than $link['depth'].
  1024. *
  1025. * @return
  1026. * An tree of menu links in an array, in the order they should be rendered.
  1027. */
  1028. function menu_tree_all_data($menu_name, $link = NULL, $max_depth = NULL) {
  1029. $tree = &drupal_static(__FUNCTION__, array());
  1030. // Use $mlid as a flag for whether the data being loaded is for the whole tree.
  1031. $mlid = isset($link['mlid']) ? $link['mlid'] : 0;
  1032. // Generate a cache ID (cid) specific for this $menu_name, $link, $language, and depth.
  1033. $cid = 'links:' . $menu_name . ':all:' . $mlid . ':' . $GLOBALS['language']->language . ':' . (int) $max_depth;
  1034. if (!isset($tree[$cid])) {
  1035. // If the static variable doesn't have the data, check {cache_menu}.
  1036. $cache = cache_get($cid, 'cache_menu');
  1037. if ($cache && isset($cache->data)) {
  1038. // If the cache entry exists, it contains the parameters for
  1039. // menu_build_tree().
  1040. $tree_parameters = $cache->data;
  1041. }
  1042. // If the tree data was not in the cache, build $tree_parameters.
  1043. if (!isset($tree_parameters)) {
  1044. $tree_parameters = array(
  1045. 'min_depth' => 1,
  1046. 'max_depth' => $max_depth,
  1047. );
  1048. if ($mlid) {
  1049. // The tree is for a single item, so we need to match the values in its
  1050. // p columns and 0 (the top level) with the plid values of other links.
  1051. $parents = array(0);
  1052. for ($i = 1; $i < MENU_MAX_DEPTH; $i++) {
  1053. if (!empty($link["p$i"])) {
  1054. $parents[] = $link["p$i"];
  1055. }
  1056. }
  1057. $tree_parameters['expanded'] = $parents;
  1058. $tree_parameters['active_trail'] = $parents;
  1059. $tree_parameters['active_trail'][] = $mlid;
  1060. }
  1061. // Cache the tree building parameters using the page-specific cid.
  1062. cache_set($cid, $tree_parameters, 'cache_menu');
  1063. }
  1064. // Build the tree using the parameters; the resulting tree will be cached
  1065. // by _menu_build_tree()).
  1066. $tree[$cid] = menu_build_tree($menu_name, $tree_parameters);
  1067. }
  1068. return $tree[$cid];
  1069. }
  1070. /**
  1071. * Sets the path for determining the active trail of the specified menu tree.
  1072. *
  1073. * This path will also affect the breadcrumbs under some circumstances.
  1074. * Breadcrumbs are built using the preferred link returned by
  1075. * menu_link_get_preferred(). If the preferred link is inside one of the menus
  1076. * specified in calls to menu_tree_set_path(), the preferred link will be
  1077. * overridden by the corresponding path returned by menu_tree_get_path().
  1078. *
  1079. * Setting this path does not affect the main content; for that use
  1080. * menu_set_active_item() instead.
  1081. *
  1082. * @param $menu_name
  1083. * The name of the affected menu tree.
  1084. * @param $path
  1085. * The path to use when finding the active trail.
  1086. */
  1087. function menu_tree_set_path($menu_name, $path = NULL) {
  1088. $paths = &drupal_static(__FUNCTION__);
  1089. if (isset($path)) {
  1090. $paths[$menu_name] = $path;
  1091. }
  1092. return isset($paths[$menu_name]) ? $paths[$menu_name] : NULL;
  1093. }
  1094. /**
  1095. * Gets the path for determining the active trail of the specified menu tree.
  1096. *
  1097. * @param $menu_name
  1098. * The menu name of the requested tree.
  1099. *
  1100. * @return
  1101. * A string containing the path. If no path has been specified with
  1102. * menu_tree_set_path(), NULL is returned.
  1103. */
  1104. function menu_tree_get_path($menu_name) {
  1105. return menu_tree_set_path($menu_name);
  1106. }
  1107. /**
  1108. * Gets the data structure for a named menu tree, based on the current page.
  1109. *
  1110. * The tree order is maintained by storing each parent in an individual
  1111. * field, see http://drupal.org/node/141866 for more.
  1112. *
  1113. * @param $menu_name
  1114. * The named menu links to return.
  1115. * @param $max_depth
  1116. * (optional) The maximum depth of links to retrieve.
  1117. * @param $only_active_trail
  1118. * (optional) Whether to only return the links in the active trail (TRUE)
  1119. * instead of all links on every level of the menu link tree (FALSE). Defaults
  1120. * to FALSE. Internally used for breadcrumbs only.
  1121. *
  1122. * @return
  1123. * An array of menu links, in the order they should be rendered. The array
  1124. * is a list of associative arrays -- these have two keys, link and below.
  1125. * link is a menu item, ready for theming as a link. Below represents the
  1126. * submenu below the link if there is one, and it is a subtree that has the
  1127. * same structure described for the top-level array.
  1128. */
  1129. function menu_tree_page_data($menu_name, $max_depth = NULL, $only_active_trail = FALSE) {
  1130. $tree = &drupal_static(__FUNCTION__, array());
  1131. // Check if the active trail has been overridden for this menu tree.
  1132. $active_path = menu_tree_get_path($menu_name);
  1133. // Load the menu item corresponding to the current page.
  1134. if ($item = menu_get_item($active_path)) {
  1135. if (isset($max_depth)) {
  1136. $max_depth = min($max_depth, MENU_MAX_DEPTH);
  1137. }
  1138. // Generate a cache ID (cid) specific for this page.
  1139. $cid = 'links:' . $menu_name . ':page:' . $item['href'] . ':' . $GLOBALS['language']->language . ':' . (int) $item['access'] . ':' . (int) $max_depth;
  1140. // If we are asked for the active trail only, and $menu_name has not been
  1141. // built and cached for this page yet, then this likely means that it
  1142. // won't be built anymore, as this function is invoked from
  1143. // template_process_page(). So in order to not build a giant menu tree
  1144. // that needs to be checked for access on all levels, we simply check
  1145. // whether we have the menu already in cache, or otherwise, build a minimum
  1146. // tree containing the breadcrumb/active trail only.
  1147. // @see menu_set_active_trail()
  1148. if (!isset($tree[$cid]) && $only_active_trail) {
  1149. $cid .= ':trail';
  1150. }
  1151. if (!isset($tree[$cid])) {
  1152. // If the static variable doesn't have the data, check {cache_menu}.
  1153. $cache = cache_get($cid, 'cache_menu');
  1154. if ($cache && isset($cache->data)) {
  1155. // If the cache entry exists, it contains the parameters for
  1156. // menu_build_tree().
  1157. $tree_parameters = $cache->data;
  1158. }
  1159. // If the tree data was not in the cache, build $tree_parameters.
  1160. if (!isset($tree_parameters)) {
  1161. $tree_parameters = array(
  1162. 'min_depth' => 1,
  1163. 'max_depth' => $max_depth,
  1164. );
  1165. // Parent mlids; used both as key and value to ensure uniqueness.
  1166. // We always want all the top-level links with plid == 0.
  1167. $active_trail = array(0 => 0);
  1168. // If the item for the current page is accessible, build the tree
  1169. // parameters accordingly.
  1170. if ($item['access']) {
  1171. // Find a menu link corresponding to the current path. If $active_path
  1172. // is NULL, let menu_link_get_preferred() determine the path.
  1173. if ($active_link = menu_link_get_preferred($active_path, $menu_name)) {
  1174. // The active link may only be taken into account to build the
  1175. // active trail, if it resides in the requested menu. Otherwise,
  1176. // we'd needlessly re-run _menu_build_tree() queries for every menu
  1177. // on every page.
  1178. if ($active_link['menu_name'] == $menu_name) {
  1179. // Use all the coordinates, except the last one because there
  1180. // can be no child beyond the last column.
  1181. for ($i = 1; $i < MENU_MAX_DEPTH; $i++) {
  1182. if ($active_link['p' . $i]) {
  1183. $active_trail[$active_link['p' . $i]] = $active_link['p' . $i];
  1184. }
  1185. }
  1186. // If we are asked to build links for the active trail only, skip
  1187. // the entire 'expanded' handling.
  1188. if ($only_active_trail) {
  1189. $tree_parameters['only_active_trail'] = TRUE;
  1190. }
  1191. }
  1192. }
  1193. $parents = $active_trail;
  1194. $expanded = variable_get('menu_expanded', array());
  1195. // Check whether the current menu has any links set to be expanded.
  1196. if (!$only_active_trail && in_array($menu_name, $expanded)) {
  1197. // Collect all the links set to be expanded, and then add all of
  1198. // their children to the list as well.
  1199. do {
  1200. $result = db_select('menu_links', NULL, array('fetch' => PDO::FETCH_ASSOC))
  1201. ->fields('menu_links', array('mlid'))
  1202. ->condition('menu_name', $menu_name)
  1203. ->condition('expanded', 1)
  1204. ->condition('has_children', 1)
  1205. ->condition('plid', $parents, 'IN')
  1206. ->condition('mlid', $parents, 'NOT IN')
  1207. ->execute();
  1208. $num_rows = FALSE;
  1209. foreach ($result as $item) {
  1210. $parents[$item['mlid']] = $item['mlid'];
  1211. $num_rows = TRUE;
  1212. }
  1213. } while ($num_rows);
  1214. }
  1215. $tree_parameters['expanded'] = $parents;
  1216. $tree_parameters['active_trail'] = $active_trail;
  1217. }
  1218. // If access is denied, we only show top-level links in menus.
  1219. else {
  1220. $tree_parameters['expanded'] = $active_trail;
  1221. $tree_parameters['active_trail'] = $active_trail;
  1222. }
  1223. // Cache the tree building parameters using the page-specific cid.
  1224. cache_set($cid, $tree_parameters, 'cache_menu');
  1225. }
  1226. // Build the tree using the parameters; the resulting tree will be cached
  1227. // by _menu_build_tree().
  1228. $tree[$cid] = menu_build_tree($menu_name, $tree_parameters);
  1229. }
  1230. return $tree[$cid];
  1231. }
  1232. return array();
  1233. }
  1234. /**
  1235. * Builds a menu tree, translates links, and checks access.
  1236. *
  1237. * @param $menu_name
  1238. * The name of the menu.
  1239. * @param $parameters
  1240. * (optional) An associative array of build parameters. Possible keys:
  1241. * - expanded: An array of parent link ids to return only menu links that are
  1242. * children of one of the plids in this list. If empty, the whole menu tree
  1243. * is built, unless 'only_active_trail' is TRUE.
  1244. * - active_trail: An array of mlids, representing the coordinates of the
  1245. * currently active menu link.
  1246. * - only_active_trail: Whether to only return links that are in the active
  1247. * trail. This option is ignored, if 'expanded' is non-empty. Internally
  1248. * used for breadcrumbs.
  1249. * - min_depth: The minimum depth of menu links in the resulting tree.
  1250. * Defaults to 1, which is the default to build a whole tree for a menu
  1251. * (excluding menu container itself).
  1252. * - max_depth: The maximum depth of menu links in the resulting tree.
  1253. * - conditions: An associative array of custom database select query
  1254. * condition key/value pairs; see _menu_build_tree() for the actual query.
  1255. *
  1256. * @return
  1257. * A fully built menu tree.
  1258. */
  1259. function menu_build_tree($menu_name, array $parameters = array()) {
  1260. // Build the menu tree.
  1261. $data = _menu_build_tree($menu_name, $parameters);
  1262. // Check access for the current user to each item in the tree.
  1263. menu_tree_check_access($data['tree'], $data['node_links']);
  1264. return $data['tree'];
  1265. }
  1266. /**
  1267. * Builds a menu tree.
  1268. *
  1269. * This function may be used build the data for a menu tree only, for example
  1270. * to further massage the data manually before further processing happens.
  1271. * menu_tree_check_access() needs to be invoked afterwards.
  1272. *
  1273. * @see menu_build_tree()
  1274. */
  1275. function _menu_build_tree($menu_name, array $parameters = array()) {
  1276. // Static cache of already built menu trees.
  1277. $trees = &drupal_static(__FUNCTION__, array());
  1278. // Build the cache id; sort parents to prevent duplicate storage and remove
  1279. // default parameter values.
  1280. if (isset($parameters['expanded'])) {
  1281. sort($parameters['expanded']);
  1282. }
  1283. $tree_cid = 'links:' . $menu_name . ':tree-data:' . $GLOBALS['language']->language . ':' . hash('sha256', serialize($parameters));
  1284. // If we do not have this tree in the static cache, check {cache_menu}.
  1285. if (!isset($trees[$tree_cid])) {
  1286. $cache = cache_get($tree_cid, 'cache_menu');
  1287. if ($cache && isset($cache->data)) {
  1288. $trees[$tree_cid] = $cache->data;
  1289. }
  1290. }
  1291. if (!isset($trees[$tree_cid])) {
  1292. // Select the links from the table, and recursively build the tree. We
  1293. // LEFT JOIN since there is no match in {menu_router} for an external
  1294. // link.
  1295. $query = db_select('menu_links', 'ml', array('fetch' => PDO::FETCH_ASSOC));
  1296. $query->addTag('translatable');
  1297. $query->leftJoin('menu_router', 'm', 'm.path = ml.router_path');
  1298. $query->fields('ml');
  1299. $query->fields('m', array(
  1300. 'load_functions',
  1301. 'to_arg_functions',
  1302. 'access_callback',
  1303. 'access_arguments',
  1304. 'page_callback',
  1305. 'page_arguments',
  1306. 'delivery_callback',
  1307. 'tab_parent',
  1308. 'tab_root',
  1309. 'title',
  1310. 'title_callback',
  1311. 'title_arguments',
  1312. 'theme_callback',
  1313. 'theme_arguments',
  1314. 'type',
  1315. 'description',
  1316. ));
  1317. for ($i = 1; $i <= MENU_MAX_DEPTH; $i++) {
  1318. $query->orderBy('p' . $i, 'ASC');
  1319. }
  1320. $query->condition('ml.menu_name', $menu_name);
  1321. if (!empty($parameters['expanded'])) {
  1322. $query->condition('ml.plid', $parameters['expanded'], 'IN');
  1323. }
  1324. elseif (!empty($parameters['only_active_trail'])) {
  1325. $query->condition('ml.mlid', $parameters['active_trail'], 'IN');
  1326. }
  1327. $min_depth = (isset($parameters['min_depth']) ? $parameters['min_depth'] : 1);
  1328. if ($min_depth != 1) {
  1329. $query->condition('ml.depth', $min_depth, '>=');
  1330. }
  1331. if (isset($parameters['max_depth'])) {
  1332. $query->condition('ml.depth', $parameters['max_depth'], '<=');
  1333. }
  1334. // Add custom query conditions, if any were passed.
  1335. if (isset($parameters['conditions'])) {
  1336. foreach ($parameters['conditions'] as $column => $value) {
  1337. $query->condition($column, $value);
  1338. }
  1339. }
  1340. // Build an ordered array of links using the query result object.
  1341. $links = array();
  1342. foreach ($query->execute() as $item) {
  1343. $links[] = $item;
  1344. }
  1345. $active_trail = (isset($parameters['active_trail']) ? $parameters['active_trail'] : array());
  1346. $data['tree'] = menu_tree_data($links, $active_trail, $min_depth);
  1347. $data['node_links'] = array();
  1348. menu_tree_collect_node_links($data['tree'], $data['node_links']);
  1349. // Cache the data, if it is not already in the cache.
  1350. cache_set($tree_cid, $data, 'cache_menu');
  1351. $trees[$tree_cid] = $data;
  1352. }
  1353. return $trees[$tree_cid];
  1354. }
  1355. /**
  1356. * Collects node links from a given menu tree recursively.
  1357. *
  1358. * @param $tree
  1359. * The menu tree you wish to collect node links from.
  1360. * @param $node_links
  1361. * An array in which to store the collected node links.
  1362. */
  1363. function menu_tree_collect_node_links(&$tree, &$node_links) {
  1364. foreach ($tree as $key => $v) {
  1365. if ($tree[$key]['link']['router_path'] == 'node/%') {
  1366. $nid = substr($tree[$key]['link']['link_path'], 5);
  1367. if (is_numeric($nid)) {
  1368. $node_links[$nid][$tree[$key]['link']['mlid']] = &$tree[$key]['link'];
  1369. $tree[$key]['link']['access'] = FALSE;
  1370. }
  1371. }
  1372. if ($tree[$key]['below']) {
  1373. menu_tree_collect_node_links($tree[$key]['below'], $node_links);
  1374. }
  1375. }
  1376. }
  1377. /**
  1378. * Checks access and performs dynamic operations for each link in the tree.
  1379. *
  1380. * @param $tree
  1381. * The menu tree you wish to operate on.
  1382. * @param $node_links
  1383. * A collection of node link references generated from $tree by
  1384. * menu_tree_collect_node_links().
  1385. */
  1386. function menu_tree_check_access(&$tree, $node_links = array()) {
  1387. if ($node_links) {
  1388. $nids = array_keys($node_links);
  1389. $select = db_select('node', 'n');
  1390. $select->addField('n', 'nid');
  1391. $select->condition('n.status', 1);
  1392. $select->condition('n.nid', $nids, 'IN');
  1393. $select->addTag('node_access');
  1394. $nids = $select->execute()->fetchCol();
  1395. foreach ($nids as $nid) {
  1396. foreach ($node_links[$nid] as $mlid => $link) {
  1397. $node_links[$nid][$mlid]['access'] = TRUE;
  1398. }
  1399. }
  1400. }
  1401. _menu_tree_check_access($tree);
  1402. }
  1403. /**
  1404. * Sorts the menu tree and recursively checks access for each item.
  1405. */
  1406. function _menu_tree_check_access(&$tree) {
  1407. $new_tree = array();
  1408. foreach ($tree as $key => $v) {
  1409. $item = &$tree[$key]['link'];
  1410. _menu_link_translate($item);
  1411. if ($item['access'] || ($item['in_active_trail'] && strpos($item['href'], '%') !== FALSE)) {
  1412. if ($tree[$key]['below']) {
  1413. _menu_tree_check_access($tree[$key]['below']);
  1414. }
  1415. // The weights are made a uniform 5 digits by adding 50000 as an offset.
  1416. // After _menu_link_translate(), $item['title'] has the localized link title.
  1417. // Adding the mlid to the end of the index insures that it is unique.
  1418. $new_tree[(50000 + $item['weight']) . ' ' . $item['title'] . ' ' . $item['mlid']] = $tree[$key];
  1419. }
  1420. }
  1421. // Sort siblings in the tree based on the weights and localized titles.
  1422. ksort($new_tree);
  1423. $tree = $new_tree;
  1424. }
  1425. /**
  1426. * Sorts and returns the built data representing a menu tree.
  1427. *
  1428. * @param $links
  1429. * A flat array of menu links that are part of the menu. Each array element
  1430. * is an associative array of information about the menu link, containing the
  1431. * fields from the {menu_links} table, and optionally additional information
  1432. * from the {menu_router} table, if the menu item appears in both tables.
  1433. * This array must be ordered depth-first. See _menu_build_tree() for a sample
  1434. * query.
  1435. * @param $parents
  1436. * An array of the menu link ID values that are in the path from the current
  1437. * page to the root of the menu tree.
  1438. * @param $depth
  1439. * The minimum depth to include in the returned menu tree.
  1440. *
  1441. * @return
  1442. * An array of menu links in the form of a tree. Each item in the tree is an
  1443. * associative array containing:
  1444. * - link: The menu link item from $links, with additional element
  1445. * 'in_active_trail' (TRUE if the link ID was in $parents).
  1446. * - below: An array containing the sub-tree of this item, where each element
  1447. * is a tree item array with 'link' and 'below' elements. This array will be
  1448. * empty if the menu item has no items in its sub-tree having a depth
  1449. * greater than or equal to $depth.
  1450. */
  1451. function menu_tree_data(array $links, array $parents = array(), $depth = 1) {
  1452. // Reverse the array so we can use the more efficient array_pop() function.
  1453. $links = array_reverse($links);
  1454. return _menu_tree_data($links, $parents, $depth);
  1455. }
  1456. /**
  1457. * Builds the data representing a menu tree.
  1458. *
  1459. * The function is a bit complex because the rendering of a link depends on
  1460. * the next menu link.
  1461. */
  1462. function _menu_tree_data(&$links, $parents, $depth) {
  1463. $tree = array();
  1464. while ($item = array_pop($links)) {
  1465. // We need to determine if we're on the path to root so we can later build
  1466. // the correct active trail and breadcrumb.
  1467. $item['in_active_trail'] = in_array($item['mlid'], $parents);
  1468. // Add the current link to the tree.
  1469. $tree[$item['mlid']] = array(
  1470. 'link' => $item,
  1471. 'below' => array(),
  1472. );
  1473. // Look ahead to the next link, but leave it on the array so it's available
  1474. // to other recursive function calls if we return or build a sub-tree.
  1475. $next = end($links);
  1476. // Check whether the next link is the first in a new sub-tree.
  1477. if ($next && $next['depth'] > $depth) {
  1478. // Recursively call _menu_tree_data to build the sub-tree.
  1479. $tree[$item['mlid']]['below'] = _menu_tree_data($links, $parents, $next['depth']);
  1480. // Fetch next link after filling the sub-tree.
  1481. $next = end($links);
  1482. }
  1483. // Determine if we should exit the loop and return.
  1484. if (!$next || $next['depth'] < $depth) {
  1485. break;
  1486. }
  1487. }
  1488. return $tree;
  1489. }
  1490. /**
  1491. * Implements template_preprocess_HOOK() for theme_menu_tree().
  1492. */
  1493. function template_preprocess_menu_tree(&$variables) {
  1494. $variables['tree'] = $variables['tree']['#children'];
  1495. }
  1496. /**
  1497. * Returns HTML for a wrapper for a menu sub-tree.
  1498. *
  1499. * @param $variables
  1500. * An associative array containing:
  1501. * - tree: An HTML string containing the tree's items.
  1502. *
  1503. * @see template_preprocess_menu_tree()
  1504. * @ingroup themeable
  1505. */
  1506. function theme_menu_tree($variables) {
  1507. return '<ul class="menu">' . $variables['tree'] . '</ul>';
  1508. }
  1509. /**
  1510. * Returns HTML for a menu link and submenu.
  1511. *
  1512. * @param $variables
  1513. * An associative array containing:
  1514. * - element: Structured array data for a menu link.
  1515. *
  1516. * @ingroup themeable
  1517. */
  1518. function theme_menu_link(array $variables) {
  1519. $element = $variables['element'];
  1520. $sub_menu = '';
  1521. if ($element['#below']) {
  1522. $sub_menu = drupal_render($element['#below']);
  1523. }
  1524. $output = l($element['#title'], $element['#href'], $element['#localized_options']);
  1525. return '<li' . drupal_attributes($element['#attributes']) . '>' . $output . $sub_menu . "</li>\n";
  1526. }
  1527. /**
  1528. * Returns HTML for a single local task link.
  1529. *
  1530. * @param $variables
  1531. * An associative array containing:
  1532. * - element: A render element containing:
  1533. * - #link: A menu link array with 'title', 'href', and 'localized_options'
  1534. * keys.
  1535. * - #active: A boolean indicating whether the local task is active.
  1536. *
  1537. * @ingroup themeable
  1538. */
  1539. function theme_menu_local_task($variables) {
  1540. $link = $variables['element']['#link'];
  1541. $link_text = $link['title'];
  1542. if (!empty($variables['element']['#active'])) {
  1543. // Add text to indicate active tab for non-visual users.
  1544. $active = '<span class="element-invisible">' . t('(active tab)') . '</span>';
  1545. // If the link does not contain HTML already, check_plain() it now.
  1546. // After we set 'html'=TRUE the link will not be sanitized by l().
  1547. if (empty($link['localized_options']['html'])) {
  1548. $link['title'] = check_plain($link['title']);
  1549. }
  1550. $link['localized_options']['html'] = TRUE;
  1551. $link_text = t('!local-task-title!active', array('!local-task-title' => $link['title'], '!active' => $active));
  1552. }
  1553. return '<li' . (!empty($variables['element']['#active']) ? ' class="active"' : '') . '>' . l($link_text, $link['href'], $link['localized_options']) . "</li>\n";
  1554. }
  1555. /**
  1556. * Returns HTML for a single local action link.
  1557. *
  1558. * @param $variables
  1559. * An associative array containing:
  1560. * - element: A render element containing:
  1561. * - #link: A menu link array with 'title', 'href', and 'localized_options'
  1562. * keys.
  1563. *
  1564. * @ingroup themeable
  1565. */
  1566. function theme_menu_local_action($variables) {
  1567. $link = $variables['element']['#link'];
  1568. $output = '<li>';
  1569. if (isset($link['href'])) {
  1570. $output .= l($link['title'], $link['href'], isset($link['localized_options']) ? $link['localized_options'] : array());
  1571. }
  1572. elseif (!empty($link['localized_options']['html'])) {
  1573. $output .= $link['title'];
  1574. }
  1575. else {
  1576. $output .= check_plain($link['title']);
  1577. }
  1578. $output .= "</li>\n";
  1579. return $output;
  1580. }
  1581. /**
  1582. * Generates elements for the $arg array in the help hook.
  1583. */
  1584. function drupal_help_arg($arg = array()) {
  1585. // Note - the number of empty elements should be > MENU_MAX_PARTS.
  1586. return $arg + array('', '', '', '', '', '', '', '', '', '', '', '');
  1587. }
  1588. /**
  1589. * Returns the help associated with the active menu item.
  1590. */
  1591. function menu_get_active_help() {
  1592. $output = '';
  1593. $router_path = menu_tab_root_path();
  1594. // We will always have a path unless we are on a 403 or 404.
  1595. if (!$router_path) {
  1596. return '';
  1597. }
  1598. $arg = drupal_help_arg(arg(NULL));
  1599. foreach (module_implements('help') as $module) {
  1600. $function = $module . '_help';
  1601. // Lookup help for this path.
  1602. if ($help = $function($router_path, $arg)) {
  1603. $output .= $help . "\n";
  1604. }
  1605. }
  1606. return $output;
  1607. }
  1608. /**
  1609. * Gets the custom theme for the current page, if there is one.
  1610. *
  1611. * @param $initialize
  1612. * This parameter should only be used internally; it is set to TRUE in order
  1613. * to force the custom theme to be initialized for the current page request.
  1614. *
  1615. * @return
  1616. * The machine-readable name of the custom theme, if there is one.
  1617. *
  1618. * @see menu_set_custom_theme()
  1619. */
  1620. function menu_get_custom_theme($initialize = FALSE) {
  1621. $custom_theme = &drupal_static(__FUNCTION__);
  1622. // Skip this if the site is offline or being installed or updated, since the
  1623. // menu system may not be correctly initialized then.
  1624. if ($initialize && !_menu_site_is_offline(TRUE) && (!defined('MAINTENANCE_MODE') || (MAINTENANCE_MODE != 'update' && MAINTENANCE_MODE != 'install'))) {
  1625. // First allow modules to dynamically set a custom theme for the current
  1626. // page. Since we can only have one, the last module to return a valid
  1627. // theme takes precedence.
  1628. $custom_themes = array_filter(module_invoke_all('custom_theme'), 'drupal_theme_access');
  1629. if (!empty($custom_themes)) {
  1630. $custom_theme = array_pop($custom_themes);
  1631. }
  1632. // If there is a theme callback function for the current page, execute it.
  1633. // If this returns a valid theme, it will override any theme that was set
  1634. // by a hook_custom_theme() implementation above.
  1635. $router_item = menu_get_item();
  1636. if (!empty($router_item['access']) && !empty($router_item['theme_callback']) && function_exists($router_item['theme_callback'])) {
  1637. $theme_name = call_user_func_array($router_item['theme_callback'], $router_item['theme_arguments']);
  1638. if (drupal_theme_access($theme_name)) {
  1639. $custom_theme = $theme_name;
  1640. }
  1641. }
  1642. }
  1643. return $custom_theme;
  1644. }
  1645. /**
  1646. * Sets a custom theme for the current page, if there is one.
  1647. */
  1648. function menu_set_custom_theme() {
  1649. menu_get_custom_theme(TRUE);
  1650. }
  1651. /**
  1652. * Build a list of named menus.
  1653. */
  1654. function menu_get_names() {
  1655. $names = &drupal_static(__FUNCTION__);
  1656. if (empty($names)) {
  1657. $names = db_select('menu_links')
  1658. ->distinct()
  1659. ->fields('menu_links', array('menu_name'))
  1660. ->orderBy('menu_name')
  1661. ->execute()->fetchCol();
  1662. }
  1663. return $names;
  1664. }
  1665. /**
  1666. * Returns an array containing the names of system-defined (default) menus.
  1667. */
  1668. function menu_list_system_menus() {
  1669. return array(
  1670. 'navigation' => 'Navigation',
  1671. 'management' => 'Management',
  1672. 'user-menu' => 'User menu',
  1673. 'main-menu' => 'Main menu',
  1674. );
  1675. }
  1676. /**
  1677. * Returns an array of links to be rendered as the Main menu.
  1678. */
  1679. function menu_main_menu() {
  1680. return menu_navigation_links(variable_get('menu_main_links_source', 'main-menu'));
  1681. }
  1682. /**
  1683. * Returns an array of links to be rendered as the Secondary links.
  1684. */
  1685. function menu_secondary_menu() {
  1686. // If the secondary menu source is set as the primary menu, we display the
  1687. // second level of the primary menu.
  1688. if (variable_get('menu_secondary_links_source', 'user-menu') == variable_get('menu_main_links_source', 'main-menu')) {
  1689. return menu_navigation_links(variable_get('menu_main_links_source', 'main-menu'), 1);
  1690. }
  1691. else {
  1692. return menu_navigation_links(variable_get('menu_secondary_links_source', 'user-menu'), 0);
  1693. }
  1694. }
  1695. /**
  1696. * Returns an array of links for a navigation menu.
  1697. *
  1698. * @param $menu_name
  1699. * The name of the menu.
  1700. * @param $level
  1701. * Optional, the depth of the menu to be returned.
  1702. *
  1703. * @return
  1704. * An array of links of the specified menu and level.
  1705. */
  1706. function menu_navigation_links($menu_name, $level = 0) {
  1707. // Don't even bother querying the menu table if no menu is specified.
  1708. if (empty($menu_name)) {
  1709. return array();
  1710. }
  1711. // Get the menu hierarchy for the current page.
  1712. $tree = menu_tree_page_data($menu_name, $level + 1);
  1713. // Go down the active trail until the right level is reached.
  1714. while ($level-- > 0 && $tree) {
  1715. // Loop through the current level's items until we find one that is in trail.
  1716. while ($item = array_shift($tree)) {
  1717. if ($item['link']['in_active_trail']) {
  1718. // If the item is in the active trail, we continue in the subtree.
  1719. $tree = empty($item['below']) ? array() : $item['below'];
  1720. break;
  1721. }
  1722. }
  1723. }
  1724. // Create a single level of links.
  1725. $router_item = menu_get_item();
  1726. $links = array();
  1727. foreach ($tree as $item) {
  1728. if (!$item['link']['hidden']) {
  1729. $class = '';
  1730. $l = $item['link']['localized_options'];
  1731. $l['href'] = $item['link']['href'];
  1732. $l['title'] = $item['link']['title'];
  1733. if ($item['link']['in_active_trail']) {
  1734. $class = ' active-trail';
  1735. $l['attributes']['class'][] = 'active-trail';
  1736. }
  1737. // Normally, l() compares the href of every link with $_GET['q'] and sets
  1738. // the active class accordingly. But local tasks do not appear in menu
  1739. // trees, so if the current path is a local task, and this link is its
  1740. // tab root, then we have to set the class manually.
  1741. if ($item['link']['href'] == $router_item['tab_root_href'] && $item['link']['href'] != $_GET['q']) {
  1742. $l['attributes']['class'][] = 'active';
  1743. }
  1744. // Keyed with the unique mlid to generate classes in theme_links().
  1745. $links['menu-' . $item['link']['mlid'] . $class] = $l;
  1746. }
  1747. }
  1748. return $links;
  1749. }
  1750. /**
  1751. * Collects the local tasks (tabs), action links, and the root path.
  1752. *
  1753. * @param $level
  1754. * The level of tasks you ask for. Primary tasks are 0, secondary are 1.
  1755. *
  1756. * @return
  1757. * An array containing
  1758. * - tabs: Local tasks for the requested level:
  1759. * - count: The number of local tasks.
  1760. * - output: The themed output of local tasks.
  1761. * - actions: Action links for the requested level:
  1762. * - count: The number of action links.
  1763. * - output: The themed output of action links.
  1764. * - root_path: The router path for the current page. If the current page is
  1765. * a default local task, then this corresponds to the parent tab.
  1766. */
  1767. function menu_local_tasks($level = 0) {
  1768. $data = &drupal_static(__FUNCTION__);
  1769. $root_path = &drupal_static(__FUNCTION__ . ':root_path', '');
  1770. $empty = array(
  1771. 'tabs' => array('count' => 0, 'output' => array()),
  1772. 'actions' => array('count' => 0, 'output' => array()),
  1773. 'root_path' => &$root_path,
  1774. );
  1775. if (!isset($data)) {
  1776. $data = array();
  1777. // Set defaults in case there are no actions or tabs.
  1778. $actions = $empty['actions'];
  1779. $tabs = array();
  1780. $router_item = menu_get_item();
  1781. // If this router item points to its parent, start from the parents to
  1782. // compute tabs and actions.
  1783. if ($router_item && ($router_item['type'] & MENU_LINKS_TO_PARENT)) {
  1784. $router_item = menu_get_item($router_item['tab_parent_href']);
  1785. }
  1786. // If we failed to fetch a router item or the current user doesn't have
  1787. // access to it, don't bother computing the tabs.
  1788. if (!$router_item || !$router_item['access']) {
  1789. return $empty;
  1790. }
  1791. // Get all tabs (also known as local tasks) and the root page.
  1792. $result = db_select('menu_router', NULL, array('fetch' => PDO::FETCH_ASSOC))
  1793. ->fields('menu_router')
  1794. ->condition('tab_root', $router_item['tab_root'])
  1795. ->condition('context', MENU_CONTEXT_INLINE, '<>')
  1796. ->orderBy('weight')
  1797. ->orderBy('title')
  1798. ->execute();
  1799. $map = $router_item['original_map'];
  1800. $children = array();
  1801. $tasks = array();
  1802. $root_path = $router_item['path'];
  1803. foreach ($result as $item) {
  1804. _menu_translate($item, $map, TRUE);
  1805. if ($item['tab_parent']) {
  1806. // All tabs, but not the root page.
  1807. $children[$item['tab_parent']][$item['path']] = $item;
  1808. }
  1809. // Store the translated item for later use.
  1810. $tasks[$item['path']] = $item;
  1811. }
  1812. // Find all tabs below the current path.
  1813. $path = $router_item['path'];
  1814. // Tab parenting may skip levels, so the number of parts in the path may not
  1815. // equal the depth. Thus we use the $depth counter (offset by 1000 for ksort).
  1816. $depth = 1001;
  1817. $actions['count'] = 0;
  1818. $actions['output'] = array();
  1819. while (isset($children[$path])) {
  1820. $tabs_current = array();
  1821. $actions_current = array();
  1822. $next_path = '';
  1823. $tab_count = 0;
  1824. $action_count = 0;
  1825. foreach ($children[$path] as $item) {
  1826. // Local tasks can be normal items too, so bitmask with
  1827. // MENU_IS_LOCAL_TASK before checking.
  1828. if (!($item['type'] & MENU_IS_LOCAL_TASK)) {
  1829. // This item is not a tab, skip it.
  1830. continue;
  1831. }
  1832. if ($item['access']) {
  1833. $link = $item;
  1834. // The default task is always active. As tabs can be normal items
  1835. // too, so bitmask with MENU_LINKS_TO_PARENT before checking.
  1836. if (($item['type'] & MENU_LINKS_TO_PARENT) == MENU_LINKS_TO_PARENT) {
  1837. // Find the first parent which is not a default local task or action.
  1838. for ($p = $item['tab_parent']; ($tasks[$p]['type'] & MENU_LINKS_TO_PARENT) == MENU_LINKS_TO_PARENT; $p = $tasks[$p]['tab_parent']);
  1839. // Use the path of the parent instead.
  1840. $link['href'] = $tasks[$p]['href'];
  1841. // Mark the link as active, if the current path happens to be the
  1842. // path of the default local task itself (i.e., instead of its
  1843. // tab_parent_href or tab_root_href). Normally, links for default
  1844. // local tasks link to their parent, but the path of default local
  1845. // tasks can still be accessed directly, in which case this link
  1846. // would not be marked as active, since l() only compares the href
  1847. // with $_GET['q'].
  1848. if ($link['href'] != $_GET['q']) {
  1849. $link['localized_options']['attributes']['class'][] = 'active';
  1850. }
  1851. $tabs_current[] = array(
  1852. '#theme' => 'menu_local_task',
  1853. '#link' => $link,
  1854. '#active' => TRUE,
  1855. );
  1856. $next_path = $item['path'];
  1857. $tab_count++;
  1858. }
  1859. else {
  1860. // Actions can be normal items too, so bitmask with
  1861. // MENU_IS_LOCAL_ACTION before checking.
  1862. if (($item['type'] & MENU_IS_LOCAL_ACTION) == MENU_IS_LOCAL_ACTION) {
  1863. // The item is an action, display it as such.
  1864. $actions_current[] = array(
  1865. '#theme' => 'menu_local_action',
  1866. '#link' => $link,
  1867. );
  1868. $action_count++;
  1869. }
  1870. else {
  1871. // Otherwise, it's a normal tab.
  1872. $tabs_current[] = array(
  1873. '#theme' => 'menu_local_task',
  1874. '#link' => $link,
  1875. );
  1876. $tab_count++;
  1877. }
  1878. }
  1879. }
  1880. }
  1881. $path = $next_path;
  1882. $tabs[$depth]['count'] = $tab_count;
  1883. $tabs[$depth]['output'] = $tabs_current;
  1884. $actions['count'] += $action_count;
  1885. $actions['output'] = array_merge($actions['output'], $actions_current);
  1886. $depth++;
  1887. }
  1888. $data['actions'] = $actions;
  1889. // Find all tabs at the same level or above the current one.
  1890. $parent = $router_item['tab_parent'];
  1891. $path = $router_item['path'];
  1892. $current = $router_item;
  1893. $depth = 1000;
  1894. while (isset($children[$parent])) {
  1895. $tabs_current = array();
  1896. $next_path = '';
  1897. $next_parent = '';
  1898. $count = 0;
  1899. foreach ($children[$parent] as $item) {
  1900. // Skip local actions.
  1901. if ($item['type'] & MENU_IS_LOCAL_ACTION) {
  1902. continue;
  1903. }
  1904. if ($item['access']) {
  1905. $count++;
  1906. $link = $item;
  1907. // Local tasks can be normal items too, so bitmask with
  1908. // MENU_LINKS_TO_PARENT before checking.
  1909. if (($item['type'] & MENU_LINKS_TO_PARENT) == MENU_LINKS_TO_PARENT) {
  1910. // Find the first parent which is not a default local task.
  1911. for ($p = $item['tab_parent']; ($tasks[$p]['type'] & MENU_LINKS_TO_PARENT) == MENU_LINKS_TO_PARENT; $p = $tasks[$p]['tab_parent']);
  1912. // Use the path of the parent instead.
  1913. $link['href'] = $tasks[$p]['href'];
  1914. if ($item['path'] == $router_item['path']) {
  1915. $root_path = $tasks[$p]['path'];
  1916. }
  1917. }
  1918. // We check for the active tab.
  1919. if ($item['path'] == $path) {
  1920. // Mark the link as active, if the current path is a (second-level)
  1921. // local task of a default local task. Since this default local task
  1922. // links to its parent, l() will not mark it as active, as it only
  1923. // compares the link's href to $_GET['q'].
  1924. if ($link['href'] != $_GET['q']) {
  1925. $link['localized_options']['attributes']['class'][] = 'active';
  1926. }
  1927. $tabs_current[] = array(
  1928. '#theme' => 'menu_local_task',
  1929. '#link' => $link,
  1930. '#active' => TRUE,
  1931. );
  1932. $next_path = $item['tab_parent'];
  1933. if (isset($tasks[$next_path])) {
  1934. $next_parent = $tasks[$next_path]['tab_parent'];
  1935. }
  1936. }
  1937. else {
  1938. $tabs_current[] = array(
  1939. '#theme' => 'menu_local_task',
  1940. '#link' => $link,
  1941. );
  1942. }
  1943. }
  1944. }
  1945. $path = $next_path;
  1946. $parent = $next_parent;
  1947. $tabs[$depth]['count'] = $count;
  1948. $tabs[$depth]['output'] = $tabs_current;
  1949. $depth--;
  1950. }
  1951. // Sort by depth.
  1952. ksort($tabs);
  1953. // Remove the depth, we are interested only in their relative placement.
  1954. $tabs = array_values($tabs);
  1955. $data['tabs'] = $tabs;
  1956. // Allow modules to alter local tasks or dynamically append further tasks.
  1957. drupal_alter('menu_local_tasks', $data, $router_item, $root_path);
  1958. }
  1959. if (isset($data['tabs'][$level])) {
  1960. return array(
  1961. 'tabs' => $data['tabs'][$level],
  1962. 'actions' => $data['actions'],
  1963. 'root_path' => $root_path,
  1964. );
  1965. }
  1966. // @todo If there are no tabs, then there still can be actions; for example,
  1967. // when added via hook_menu_local_tasks_alter().
  1968. elseif (!empty($data['actions']['output'])) {
  1969. return array('actions' => $data['actions']) + $empty;
  1970. }
  1971. return $empty;
  1972. }
  1973. /**
  1974. * Retrieves contextual links for a path based on registered local tasks.
  1975. *
  1976. * This leverages the menu system to retrieve the first layer of registered
  1977. * local tasks for a given system path. All local tasks of the tab type
  1978. * MENU_CONTEXT_INLINE are taken into account.
  1979. *
  1980. * For example, when considering the following registered local tasks:
  1981. * - node/%node/view (default local task) with no 'context' defined
  1982. * - node/%node/edit with context: MENU_CONTEXT_PAGE | MENU_CONTEXT_INLINE
  1983. * - node/%node/revisions with context: MENU_CONTEXT_PAGE
  1984. * - node/%node/report-as-spam with context: MENU_CONTEXT_INLINE
  1985. *
  1986. * If the path "node/123" is passed to this function, then it will return the
  1987. * links for 'edit' and 'report-as-spam'.
  1988. *
  1989. * @param $module
  1990. * The name of the implementing module. This is used to prefix the key for
  1991. * each contextual link, which is transformed into a CSS class during
  1992. * rendering by theme_links(). For example, if $module is 'block' and the
  1993. * retrieved local task path argument is 'edit', then the resulting CSS class
  1994. * will be 'block-edit'.
  1995. * @param $parent_path
  1996. * The static menu router path of the object to retrieve local tasks for, for
  1997. * example 'node' or 'admin/structure/block/manage'.
  1998. * @param $args
  1999. * A list of dynamic path arguments to append to $parent_path to form the
  2000. * fully-qualified menu router path, for example array(123) for a certain
  2001. * node or array('system', 'navigation') for a certain block.
  2002. *
  2003. * @return
  2004. * A list of menu router items that are local tasks for the passed-in path.
  2005. *
  2006. * @see contextual_links_preprocess()
  2007. * @see hook_menu()
  2008. */
  2009. function menu_contextual_links($module, $parent_path, $args) {
  2010. static $path_empty = array();
  2011. $links = array();
  2012. // Performance: In case a previous invocation for the same parent path did not
  2013. // return any links, we immediately return here.
  2014. if (isset($path_empty[$parent_path]) && strpos($parent_path, '%') !== FALSE) {
  2015. return $links;
  2016. }
  2017. // Construct the item-specific parent path.
  2018. $path = $parent_path . '/' . implode('/', $args);
  2019. // Get the router item for the given parent link path.
  2020. $router_item = menu_get_item($path);
  2021. if (!$router_item || !$router_item['access']) {
  2022. $path_empty[$parent_path] = TRUE;
  2023. return $links;
  2024. }
  2025. $data = &drupal_static(__FUNCTION__, array());
  2026. $root_path = $router_item['path'];
  2027. // Performance: For a single, normalized path (such as 'node/%') we only query
  2028. // available tasks once per request.
  2029. if (!isset($data[$root_path])) {
  2030. // Get all contextual links that are direct children of the router item and
  2031. // not of the tab type 'view'.
  2032. $data[$root_path] = db_select('menu_router', 'm')
  2033. ->fields('m')
  2034. ->condition('tab_parent', $router_item['tab_root'])
  2035. ->condition('context', MENU_CONTEXT_NONE, '<>')
  2036. ->condition('context', MENU_CONTEXT_PAGE, '<>')
  2037. ->orderBy('weight')
  2038. ->orderBy('title')
  2039. ->execute()
  2040. ->fetchAllAssoc('path', PDO::FETCH_ASSOC);
  2041. }
  2042. $parent_length = drupal_strlen($root_path) + 1;
  2043. $map = $router_item['original_map'];
  2044. foreach ($data[$root_path] as $item) {
  2045. // Extract the actual "task" string from the path argument.
  2046. $key = drupal_substr($item['path'], $parent_length);
  2047. // Denormalize and translate the contextual link.
  2048. _menu_translate($item, $map, TRUE);
  2049. if (!$item['access']) {
  2050. continue;
  2051. }
  2052. // All contextual links are keyed by the actual "task" path argument,
  2053. // prefixed with the name of the implementing module.
  2054. $links[$module . '-' . $key] = $item;
  2055. }
  2056. // Allow modules to alter contextual links.
  2057. drupal_alter('menu_contextual_links', $links, $router_item, $root_path);
  2058. // Performance: If the current user does not have access to any links for this
  2059. // router path and no other module added further links, we assign FALSE here
  2060. // to skip the entire process the next time the same router path is requested.
  2061. if (empty($links)) {
  2062. $path_empty[$parent_path] = TRUE;
  2063. }
  2064. return $links;
  2065. }
  2066. /**
  2067. * Returns the rendered local tasks at the top level.
  2068. */
  2069. function menu_primary_local_tasks() {
  2070. $links = menu_local_tasks(0);
  2071. // Do not display single tabs.
  2072. return ($links['tabs']['count'] > 1 ? $links['tabs']['output'] : '');
  2073. }
  2074. /**
  2075. * Returns the rendered local tasks at the second level.
  2076. */
  2077. function menu_secondary_local_tasks() {
  2078. $links = menu_local_tasks(1);
  2079. // Do not display single tabs.
  2080. return ($links['tabs']['count'] > 1 ? $links['tabs']['output'] : '');
  2081. }
  2082. /**
  2083. * Returns the rendered local actions at the current level.
  2084. */
  2085. function menu_local_actions() {
  2086. $links = menu_local_tasks();
  2087. return $links['actions']['output'];
  2088. }
  2089. /**
  2090. * Returns the router path, or the path for a default local task's parent.
  2091. */
  2092. function menu_tab_root_path() {
  2093. $links = menu_local_tasks();
  2094. return $links['root_path'];
  2095. }
  2096. /**
  2097. * Returns a renderable element for the primary and secondary tabs.
  2098. */
  2099. function menu_local_tabs() {
  2100. return array(
  2101. '#theme' => 'menu_local_tasks',
  2102. '#primary' => menu_primary_local_tasks(),
  2103. '#secondary' => menu_secondary_local_tasks(),
  2104. );
  2105. }
  2106. /**
  2107. * Returns HTML for primary and secondary local tasks.
  2108. *
  2109. * @param $variables
  2110. * An associative array containing:
  2111. * - primary: (optional) An array of local tasks (tabs).
  2112. * - secondary: (optional) An array of local tasks (tabs).
  2113. *
  2114. * @ingroup themeable
  2115. * @see menu_local_tasks()
  2116. */
  2117. function theme_menu_local_tasks(&$variables) {
  2118. $output = '';
  2119. if (!empty($variables['primary'])) {
  2120. $variables['primary']['#prefix'] = '<h2 class="element-invisible">' . t('Primary tabs') . '</h2>';
  2121. $variables['primary']['#prefix'] .= '<ul class="tabs primary">';
  2122. $variables['primary']['#suffix'] = '</ul>';
  2123. $output .= drupal_render($variables['primary']);
  2124. }
  2125. if (!empty($variables['secondary'])) {
  2126. $variables['secondary']['#prefix'] = '<h2 class="element-invisible">' . t('Secondary tabs') . '</h2>';
  2127. $variables['secondary']['#prefix'] .= '<ul class="tabs secondary">';
  2128. $variables['secondary']['#suffix'] = '</ul>';
  2129. $output .= drupal_render($variables['secondary']);
  2130. }
  2131. return $output;
  2132. }
  2133. /**
  2134. * Sets (or gets) the active menu for the current page.
  2135. *
  2136. * The active menu for the page determines the active trail.
  2137. *
  2138. * @return
  2139. * An array of menu machine names, in order of preference. The
  2140. * 'menu_default_active_menus' variable may be used to assert a menu order
  2141. * different from the order of creation, or to prevent a particular menu from
  2142. * being used at all in the active trail.
  2143. * E.g., $conf['menu_default_active_menus'] = array('navigation', 'main-menu')
  2144. */
  2145. function menu_set_active_menu_names($menu_names = NULL) {
  2146. $active = &drupal_static(__FUNCTION__);
  2147. if (isset($menu_names) && is_array($menu_names)) {
  2148. $active = $menu_names;
  2149. }
  2150. elseif (!isset($active)) {
  2151. $active = variable_get('menu_default_active_menus', array_keys(menu_list_system_menus()));
  2152. }
  2153. return $active;
  2154. }
  2155. /**
  2156. * Gets the active menu for the current page.
  2157. */
  2158. function menu_get_active_menu_names() {
  2159. return menu_set_active_menu_names();
  2160. }
  2161. /**
  2162. * Sets the active path, which determines which page is loaded.
  2163. *
  2164. * Note that this may not have the desired effect unless invoked very early
  2165. * in the page load, such as during hook_boot(), or unless you call
  2166. * menu_execute_active_handler() to generate your page output.
  2167. *
  2168. * @param $path
  2169. * A Drupal path - not a path alias.
  2170. */
  2171. function menu_set_active_item($path) {
  2172. $_GET['q'] = $path;
  2173. // Since the active item has changed, the active menu trail may also be out
  2174. // of date.
  2175. drupal_static_reset('menu_set_active_trail');
  2176. }
  2177. /**
  2178. * Sets the active trail (path to the menu tree root) of the current page.
  2179. *
  2180. * Any trail set by this function will only be used for functionality that calls
  2181. * menu_get_active_trail(). Drupal core only uses trails set here for
  2182. * breadcrumbs and the page title and not for menu trees or page content.
  2183. * Additionally, breadcrumbs set by drupal_set_breadcrumb() will override any
  2184. * trail set here.
  2185. *
  2186. * To affect the trail used by menu trees, use menu_tree_set_path(). To affect
  2187. * the page content, use menu_set_active_item() instead.
  2188. *
  2189. * @param $new_trail
  2190. * Menu trail to set; the value is saved in a static variable and can be
  2191. * retrieved by menu_get_active_trail(). The format of this array should be
  2192. * the same as the return value of menu_get_active_trail().
  2193. *
  2194. * @return
  2195. * The active trail. See menu_get_active_trail() for details.
  2196. */
  2197. function menu_set_active_trail($new_trail = NULL) {
  2198. $trail = &drupal_static(__FUNCTION__);
  2199. if (isset($new_trail)) {
  2200. $trail = $new_trail;
  2201. }
  2202. elseif (!isset($trail)) {
  2203. $trail = array();
  2204. $trail[] = array(
  2205. 'title' => t('Home'),
  2206. 'href' => '<front>',
  2207. 'link_path' => '',
  2208. 'localized_options' => array(),
  2209. 'type' => 0,
  2210. );
  2211. // Try to retrieve a menu link corresponding to the current path. If more
  2212. // than one exists, the link from the most preferred menu is returned.
  2213. $preferred_link = menu_link_get_preferred();
  2214. $current_item = menu_get_item();
  2215. // There is a link for the current path.
  2216. if ($preferred_link) {
  2217. // Pass TRUE for $only_active_trail to make menu_tree_page_data() build
  2218. // a stripped down menu tree containing the active trail only, in case
  2219. // the given menu has not been built in this request yet.
  2220. $tree = menu_tree_page_data($preferred_link['menu_name'], NULL, TRUE);
  2221. list($key, $curr) = each($tree);
  2222. }
  2223. // There is no link for the current path.
  2224. else {
  2225. $preferred_link = $current_item;
  2226. $curr = FALSE;
  2227. }
  2228. while ($curr) {
  2229. $link = $curr['link'];
  2230. if ($link['in_active_trail']) {
  2231. // Add the link to the trail, unless it links to its parent.
  2232. if (!($link['type'] & MENU_LINKS_TO_PARENT)) {
  2233. // The menu tree for the active trail may contain additional links
  2234. // that have not been translated yet, since they contain dynamic
  2235. // argument placeholders (%). Such links are not contained in regular
  2236. // menu trees, and have only been loaded for the additional
  2237. // translation that happens here, so as to be able to display them in
  2238. // the breadcumb for the current page.
  2239. // @see _menu_tree_check_access()
  2240. // @see _menu_link_translate()
  2241. if (strpos($link['href'], '%') !== FALSE) {
  2242. _menu_link_translate($link, TRUE);
  2243. }
  2244. if ($link['access']) {
  2245. $trail[] = $link;
  2246. }
  2247. }
  2248. $tree = $curr['below'] ? $curr['below'] : array();
  2249. }
  2250. list($key, $curr) = each($tree);
  2251. }
  2252. // Make sure the current page is in the trail to build the page title, by
  2253. // appending either the preferred link or the menu router item for the
  2254. // current page. Exclude it if we are on the front page.
  2255. $last = end($trail);
  2256. if ($preferred_link && $last['href'] != $preferred_link['href'] && !drupal_is_front_page()) {
  2257. $trail[] = $preferred_link;
  2258. }
  2259. }
  2260. return $trail;
  2261. }
  2262. /**
  2263. * Looks up the preferred menu link for a given system path.
  2264. *
  2265. * @param $path
  2266. * The path, for example 'node/5'. The function will find the corresponding
  2267. * menu link ('node/5' if it exists, or fallback to 'node/%').
  2268. * @param $selected_menu
  2269. * The name of a menu used to restrict the search for a preferred menu link.
  2270. * If not specified, all the menus returned by menu_get_active_menu_names()
  2271. * will be used.
  2272. *
  2273. * @return
  2274. * A fully translated menu link, or FALSE if no matching menu link was
  2275. * found. The most specific menu link ('node/5' preferred over 'node/%') in
  2276. * the most preferred menu (as defined by menu_get_active_menu_names()) is
  2277. * returned.
  2278. */
  2279. function menu_link_get_preferred($path = NULL, $selected_menu = NULL) {
  2280. $preferred_links = &drupal_static(__FUNCTION__);
  2281. if (!isset($path)) {
  2282. $path = $_GET['q'];
  2283. }
  2284. if (empty($selected_menu)) {
  2285. // Use an illegal menu name as the key for the preferred menu link.
  2286. $selected_menu = MENU_PREFERRED_LINK;
  2287. }
  2288. if (!isset($preferred_links[$path])) {
  2289. // Look for the correct menu link by building a list of candidate paths,
  2290. // which are ordered by priority (translated hrefs are preferred over
  2291. // untranslated paths). Afterwards, the most relevant path is picked from
  2292. // the menus, ordered by menu preference.
  2293. $item = menu_get_item($path);
  2294. $path_candidates = array();
  2295. // 1. The current item href.
  2296. $path_candidates[$item['href']] = $item['href'];
  2297. // 2. The tab root href of the current item (if any).
  2298. if ($item['tab_parent'] && ($tab_root = menu_get_item($item['tab_root_href']))) {
  2299. $path_candidates[$tab_root['href']] = $tab_root['href'];
  2300. }
  2301. // 3. The current item path (with wildcards).
  2302. $path_candidates[$item['path']] = $item['path'];
  2303. // 4. The tab root path of the current item (if any).
  2304. if (!empty($tab_root)) {
  2305. $path_candidates[$tab_root['path']] = $tab_root['path'];
  2306. }
  2307. // Retrieve a list of menu names, ordered by preference.
  2308. $menu_names = menu_get_active_menu_names();
  2309. // Put the selected menu at the front of the list.
  2310. array_unshift($menu_names, $selected_menu);
  2311. $query = db_select('menu_links', 'ml', array('fetch' => PDO::FETCH_ASSOC));
  2312. $query->leftJoin('menu_router', 'm', 'm.path = ml.router_path');
  2313. $query->fields('ml');
  2314. // Weight must be taken from {menu_links}, not {menu_router}.
  2315. $query->addField('ml', 'weight', 'link_weight');
  2316. $query->fields('m');
  2317. $query->condition('ml.link_path', $path_candidates, 'IN');
  2318. // Sort candidates by link path and menu name.
  2319. $candidates = array();
  2320. foreach ($query->execute() as $candidate) {
  2321. $candidate['weight'] = $candidate['link_weight'];
  2322. $candidates[$candidate['link_path']][$candidate['menu_name']] = $candidate;
  2323. // Add any menus not already in the menu name search list.
  2324. if (!in_array($candidate['menu_name'], $menu_names)) {
  2325. $menu_names[] = $candidate['menu_name'];
  2326. }
  2327. }
  2328. // Store the most specific link for each menu. Also save the most specific
  2329. // link of the most preferred menu in $preferred_link.
  2330. foreach ($path_candidates as $link_path) {
  2331. if (isset($candidates[$link_path])) {
  2332. foreach ($menu_names as $menu_name) {
  2333. if (empty($preferred_links[$path][$menu_name]) && isset($candidates[$link_path][$menu_name])) {
  2334. $candidate_item = $candidates[$link_path][$menu_name];
  2335. $map = explode('/', $path);
  2336. _menu_translate($candidate_item, $map);
  2337. if ($candidate_item['access']) {
  2338. $preferred_links[$path][$menu_name] = $candidate_item;
  2339. if (empty($preferred_links[$path][MENU_PREFERRED_LINK])) {
  2340. // Store the most specific link.
  2341. $preferred_links[$path][MENU_PREFERRED_LINK] = $candidate_item;
  2342. }
  2343. }
  2344. }
  2345. }
  2346. }
  2347. }
  2348. }
  2349. return isset($preferred_links[$path][$selected_menu]) ? $preferred_links[$path][$selected_menu] : FALSE;
  2350. }
  2351. /**
  2352. * Gets the active trail (path to root menu root) of the current page.
  2353. *
  2354. * If a trail is supplied to menu_set_active_trail(), that value is returned. If
  2355. * a trail is not supplied to menu_set_active_trail(), the path to the current
  2356. * page is calculated and returned. The calculated trail is also saved as a
  2357. * static value for use by subsequent calls to menu_get_active_trail().
  2358. *
  2359. * @return
  2360. * Path to menu root of the current page, as an array of menu link items,
  2361. * starting with the site's home page. Each link item is an associative array
  2362. * with the following components:
  2363. * - title: Title of the item.
  2364. * - href: Drupal path of the item.
  2365. * - localized_options: Options for passing into the l() function.
  2366. * - type: A menu type constant, such as MENU_DEFAULT_LOCAL_TASK, or 0 to
  2367. * indicate it's not really in the menu (used for the home page item).
  2368. */
  2369. function menu_get_active_trail() {
  2370. return menu_set_active_trail();
  2371. }
  2372. /**
  2373. * Gets the breadcrumb for the current page, as determined by the active trail.
  2374. *
  2375. * @see menu_set_active_trail()
  2376. */
  2377. function menu_get_active_breadcrumb() {
  2378. $breadcrumb = array();
  2379. // No breadcrumb for the front page.
  2380. if (drupal_is_front_page()) {
  2381. return $breadcrumb;
  2382. }
  2383. $item = menu_get_item();
  2384. if (!empty($item['access'])) {
  2385. $active_trail = menu_get_active_trail();
  2386. // Allow modules to alter the breadcrumb, if possible, as that is much
  2387. // faster than rebuilding an entirely new active trail.
  2388. drupal_alter('menu_breadcrumb', $active_trail, $item);
  2389. // Don't show a link to the current page in the breadcrumb trail.
  2390. $end = end($active_trail);
  2391. if ($item['href'] == $end['href']) {
  2392. array_pop($active_trail);
  2393. }
  2394. // Remove the tab root (parent) if the current path links to its parent.
  2395. // Normally, the tab root link is included in the breadcrumb, as soon as we
  2396. // are on a local task or any other child link. However, if we are on a
  2397. // default local task (e.g., node/%/view), then we do not want the tab root
  2398. // link (e.g., node/%) to appear, as it would be identical to the current
  2399. // page. Since this behavior also needs to work recursively (i.e., on
  2400. // default local tasks of default local tasks), and since the last non-task
  2401. // link in the trail is used as page title (see menu_get_active_title()),
  2402. // this condition cannot be cleanly integrated into menu_get_active_trail().
  2403. // menu_get_active_trail() already skips all links that link to their parent
  2404. // (commonly MENU_DEFAULT_LOCAL_TASK). In order to also hide the parent link
  2405. // itself, we always remove the last link in the trail, if the current
  2406. // router item links to its parent.
  2407. if (($item['type'] & MENU_LINKS_TO_PARENT) == MENU_LINKS_TO_PARENT) {
  2408. array_pop($active_trail);
  2409. }
  2410. foreach ($active_trail as $parent) {
  2411. $breadcrumb[] = l($parent['title'], $parent['href'], $parent['localized_options']);
  2412. }
  2413. }
  2414. return $breadcrumb;
  2415. }
  2416. /**
  2417. * Gets the title of the current page, as determined by the active trail.
  2418. */
  2419. function menu_get_active_title() {
  2420. $active_trail = menu_get_active_trail();
  2421. foreach (array_reverse($active_trail) as $item) {
  2422. if (!(bool) ($item['type'] & MENU_IS_LOCAL_TASK)) {
  2423. return $item['title'];
  2424. }
  2425. }
  2426. }
  2427. /**
  2428. * Gets a translated, access-checked menu link that is ready for rendering.
  2429. *
  2430. * This function should never be called from within node_load() or any other
  2431. * function used as a menu object load function since an infinite recursion may
  2432. * occur.
  2433. *
  2434. * @param $mlid
  2435. * The mlid of the menu item.
  2436. *
  2437. * @return
  2438. * A menu link, with $item['access'] filled and link translated for
  2439. * rendering.
  2440. */
  2441. function menu_link_load($mlid) {
  2442. if (is_numeric($mlid)) {
  2443. $query = db_select('menu_links', 'ml');
  2444. $query->leftJoin('menu_router', 'm', 'm.path = ml.router_path');
  2445. $query->fields('ml');
  2446. // Weight should be taken from {menu_links}, not {menu_router}.
  2447. $query->addField('ml', 'weight', 'link_weight');
  2448. $query->fields('m');
  2449. $query->condition('ml.mlid', $mlid);
  2450. if ($item = $query->execute()->fetchAssoc()) {
  2451. $item['weight'] = $item['link_weight'];
  2452. _menu_link_translate($item);
  2453. return $item;
  2454. }
  2455. }
  2456. return FALSE;
  2457. }
  2458. /**
  2459. * Clears the cached cached data for a single named menu.
  2460. */
  2461. function menu_cache_clear($menu_name = 'navigation') {
  2462. $cache_cleared = &drupal_static(__FUNCTION__, array());
  2463. if (empty($cache_cleared[$menu_name])) {
  2464. cache_clear_all('links:' . $menu_name . ':', 'cache_menu', TRUE);
  2465. $cache_cleared[$menu_name] = 1;
  2466. }
  2467. elseif ($cache_cleared[$menu_name] == 1) {
  2468. drupal_register_shutdown_function('cache_clear_all', 'links:' . $menu_name . ':', 'cache_menu', TRUE);
  2469. $cache_cleared[$menu_name] = 2;
  2470. }
  2471. // Also clear the menu system static caches.
  2472. menu_reset_static_cache();
  2473. }
  2474. /**
  2475. * Clears all cached menu data.
  2476. *
  2477. * This should be called any time broad changes
  2478. * might have been made to the router items or menu links.
  2479. */
  2480. function menu_cache_clear_all() {
  2481. cache_clear_all('*', 'cache_menu', TRUE);
  2482. menu_reset_static_cache();
  2483. }
  2484. /**
  2485. * Resets the menu system static cache.
  2486. */
  2487. function menu_reset_static_cache() {
  2488. drupal_static_reset('_menu_build_tree');
  2489. drupal_static_reset('menu_tree');
  2490. drupal_static_reset('menu_tree_all_data');
  2491. drupal_static_reset('menu_tree_page_data');
  2492. drupal_static_reset('menu_load_all');
  2493. drupal_static_reset('menu_link_get_preferred');
  2494. }
  2495. /**
  2496. * Populates the database tables used by various menu functions.
  2497. *
  2498. * This function will clear and populate the {menu_router} table, add entries
  2499. * to {menu_links} for new router items, and then remove stale items from
  2500. * {menu_links}. If called from update.php or install.php, it will also
  2501. * schedule a call to itself on the first real page load from
  2502. * menu_execute_active_handler(), because the maintenance page environment
  2503. * is different and leaves stale data in the menu tables.
  2504. *
  2505. * @return
  2506. * TRUE if the menu was rebuilt, FALSE if another thread was rebuilding
  2507. * in parallel and the current thread just waited for completion.
  2508. */
  2509. function menu_rebuild() {
  2510. if (!lock_acquire('menu_rebuild')) {
  2511. // Wait for another request that is already doing this work.
  2512. // We choose to block here since otherwise the router item may not
  2513. // be available in menu_execute_active_handler() resulting in a 404.
  2514. lock_wait('menu_rebuild');
  2515. return FALSE;
  2516. }
  2517. $transaction = db_transaction();
  2518. try {
  2519. list($menu, $masks) = menu_router_build();
  2520. _menu_router_save($menu, $masks);
  2521. _menu_navigation_links_rebuild($menu);
  2522. // Clear the menu, page and block caches.
  2523. menu_cache_clear_all();
  2524. _menu_clear_page_cache();
  2525. if (defined('MAINTENANCE_MODE')) {
  2526. variable_set('menu_rebuild_needed', TRUE);
  2527. }
  2528. else {
  2529. variable_del('menu_rebuild_needed');
  2530. }
  2531. }
  2532. catch (Exception $e) {
  2533. $transaction->rollback();
  2534. watchdog_exception('menu', $e);
  2535. }
  2536. lock_release('menu_rebuild');
  2537. return TRUE;
  2538. }
  2539. /**
  2540. * Collects and alters the menu definitions.
  2541. */
  2542. function menu_router_build() {
  2543. // We need to manually call each module so that we can know which module
  2544. // a given item came from.
  2545. $callbacks = array();
  2546. foreach (module_implements('menu') as $module) {
  2547. $router_items = call_user_func($module . '_menu');
  2548. if (isset($router_items) && is_array($router_items)) {
  2549. foreach (array_keys($router_items) as $path) {
  2550. $router_items[$path]['module'] = $module;
  2551. }
  2552. $callbacks = array_merge($callbacks, $router_items);
  2553. }
  2554. }
  2555. // Alter the menu as defined in modules, keys are like user/%user.
  2556. drupal_alter('menu', $callbacks);
  2557. list($menu, $masks) = _menu_router_build($callbacks);
  2558. _menu_router_cache($menu);
  2559. return array($menu, $masks);
  2560. }
  2561. /**
  2562. * Stores the menu router if we have it in memory.
  2563. */
  2564. function _menu_router_cache($new_menu = NULL) {
  2565. $menu = &drupal_static(__FUNCTION__);
  2566. if (isset($new_menu)) {
  2567. $menu = $new_menu;
  2568. }
  2569. return $menu;
  2570. }
  2571. /**
  2572. * Gets the menu router.
  2573. */
  2574. function menu_get_router() {
  2575. // Check first if we have it in memory already.
  2576. $menu = _menu_router_cache();
  2577. if (empty($menu)) {
  2578. list($menu, $masks) = menu_router_build();
  2579. }
  2580. return $menu;
  2581. }
  2582. /**
  2583. * Builds a link from a router item.
  2584. */
  2585. function _menu_link_build($item) {
  2586. // Suggested items are disabled by default.
  2587. if ($item['type'] == MENU_SUGGESTED_ITEM) {
  2588. $item['hidden'] = 1;
  2589. }
  2590. // Hide all items that are not visible in the tree.
  2591. elseif (!($item['type'] & MENU_VISIBLE_IN_TREE)) {
  2592. $item['hidden'] = -1;
  2593. }
  2594. // Note, we set this as 'system', so that we can be sure to distinguish all
  2595. // the menu links generated automatically from entries in {menu_router}.
  2596. $item['module'] = 'system';
  2597. $item += array(
  2598. 'menu_name' => 'navigation',
  2599. 'link_title' => $item['title'],
  2600. 'link_path' => $item['path'],
  2601. 'hidden' => 0,
  2602. 'options' => empty($item['description']) ? array() : array('attributes' => array('title' => $item['description'])),
  2603. );
  2604. return $item;
  2605. }
  2606. /**
  2607. * Builds menu links for the items in the menu router.
  2608. */
  2609. function _menu_navigation_links_rebuild($menu) {
  2610. // Add normal and suggested items as links.
  2611. $menu_links = array();
  2612. foreach ($menu as $path => $item) {
  2613. if ($item['_visible']) {
  2614. $menu_links[$path] = $item;
  2615. $sort[$path] = $item['_number_parts'];
  2616. }
  2617. }
  2618. if ($menu_links) {
  2619. // Keep an array of processed menu links, to allow menu_link_save() to
  2620. // check this for parents instead of querying the database.
  2621. $parent_candidates = array();
  2622. // Make sure no child comes before its parent.
  2623. array_multisort($sort, SORT_NUMERIC, $menu_links);
  2624. foreach ($menu_links as $key => $item) {
  2625. $existing_item = db_select('menu_links')
  2626. ->fields('menu_links')
  2627. ->condition('link_path', $item['path'])
  2628. ->condition('module', 'system')
  2629. ->execute()->fetchAssoc();
  2630. if ($existing_item) {
  2631. $item['mlid'] = $existing_item['mlid'];
  2632. // A change in hook_menu may move the link to a different menu
  2633. if (empty($item['menu_name']) || ($item['menu_name'] == $existing_item['menu_name'])) {
  2634. $item['menu_name'] = $existing_item['menu_name'];
  2635. $item['plid'] = $existing_item['plid'];
  2636. }
  2637. else {
  2638. // It moved to a new menu. Let menu_link_save() try to find a new
  2639. // parent based on the path.
  2640. unset($item['plid']);
  2641. }
  2642. $item['has_children'] = $existing_item['has_children'];
  2643. $item['updated'] = $existing_item['updated'];
  2644. }
  2645. if ($existing_item && $existing_item['customized']) {
  2646. $parent_candidates[$existing_item['mlid']] = $existing_item;
  2647. }
  2648. else {
  2649. $item = _menu_link_build($item);
  2650. menu_link_save($item, $existing_item, $parent_candidates);
  2651. $parent_candidates[$item['mlid']] = $item;
  2652. unset($menu_links[$key]);
  2653. }
  2654. }
  2655. }
  2656. $paths = array_keys($menu);
  2657. // Updated and customized items whose router paths are gone need new ones.
  2658. $result = db_select('menu_links', NULL, array('fetch' => PDO::FETCH_ASSOC))
  2659. ->fields('menu_links', array(
  2660. 'link_path',
  2661. 'mlid',
  2662. 'router_path',
  2663. 'updated',
  2664. ))
  2665. ->condition(db_or()
  2666. ->condition('updated', 1)
  2667. ->condition(db_and()
  2668. ->condition('router_path', $paths, 'NOT IN')
  2669. ->condition('external', 0)
  2670. ->condition('customized', 1)
  2671. )
  2672. )
  2673. ->execute();
  2674. foreach ($result as $item) {
  2675. $router_path = _menu_find_router_path($item['link_path']);
  2676. if (!empty($router_path) && ($router_path != $item['router_path'] || $item['updated'])) {
  2677. // If the router path and the link path matches, it's surely a working
  2678. // item, so we clear the updated flag.
  2679. $updated = $item['updated'] && $router_path != $item['link_path'];
  2680. db_update('menu_links')
  2681. ->fields(array(
  2682. 'router_path' => $router_path,
  2683. 'updated' => (int) $updated,
  2684. ))
  2685. ->condition('mlid', $item['mlid'])
  2686. ->execute();
  2687. }
  2688. }
  2689. // Find any item whose router path does not exist any more.
  2690. $result = db_select('menu_links')
  2691. ->fields('menu_links')
  2692. ->condition('router_path', $paths, 'NOT IN')
  2693. ->condition('external', 0)
  2694. ->condition('updated', 0)
  2695. ->condition('customized', 0)
  2696. ->orderBy('depth', 'DESC')
  2697. ->execute();
  2698. // Remove all such items. Starting from those with the greatest depth will
  2699. // minimize the amount of re-parenting done by menu_link_delete().
  2700. foreach ($result as $item) {
  2701. _menu_delete_item($item, TRUE);
  2702. }
  2703. }
  2704. /**
  2705. * Clones an array of menu links.
  2706. *
  2707. * @param $links
  2708. * An array of menu links to clone.
  2709. * @param $menu_name
  2710. * (optional) The name of a menu that the links will be cloned for. If not
  2711. * set, the cloned links will be in the same menu as the original set of
  2712. * links that were passed in.
  2713. *
  2714. * @return
  2715. * An array of menu links with the same properties as the passed-in array,
  2716. * but with the link identifiers removed so that a new link will be created
  2717. * when any of them is passed in to menu_link_save().
  2718. *
  2719. * @see menu_link_save()
  2720. */
  2721. function menu_links_clone($links, $menu_name = NULL) {
  2722. foreach ($links as &$link) {
  2723. unset($link['mlid']);
  2724. unset($link['plid']);
  2725. if (isset($menu_name)) {
  2726. $link['menu_name'] = $menu_name;
  2727. }
  2728. }
  2729. return $links;
  2730. }
  2731. /**
  2732. * Returns an array containing all links for a menu.
  2733. *
  2734. * @param $menu_name
  2735. * The name of the menu whose links should be returned.
  2736. *
  2737. * @return
  2738. * An array of menu links.
  2739. */
  2740. function menu_load_links($menu_name) {
  2741. $links = db_select('menu_links', 'ml', array('fetch' => PDO::FETCH_ASSOC))
  2742. ->fields('ml')
  2743. ->condition('ml.menu_name', $menu_name)
  2744. // Order by weight so as to be helpful for menus that are only one level
  2745. // deep.
  2746. ->orderBy('weight')
  2747. ->execute()
  2748. ->fetchAll();
  2749. foreach ($links as &$link) {
  2750. $link['options'] = unserialize($link['options']);
  2751. }
  2752. return $links;
  2753. }
  2754. /**
  2755. * Deletes all links for a menu.
  2756. *
  2757. * @param $menu_name
  2758. * The name of the menu whose links will be deleted.
  2759. */
  2760. function menu_delete_links($menu_name) {
  2761. $links = menu_load_links($menu_name);
  2762. foreach ($links as $link) {
  2763. // To speed up the deletion process, we reset some link properties that
  2764. // would trigger re-parenting logic in _menu_delete_item() and
  2765. // _menu_update_parental_status().
  2766. $link['has_children'] = FALSE;
  2767. $link['plid'] = 0;
  2768. _menu_delete_item($link);
  2769. }
  2770. }
  2771. /**
  2772. * Delete one or several menu links.
  2773. *
  2774. * @param $mlid
  2775. * A valid menu link mlid or NULL. If NULL, $path is used.
  2776. * @param $path
  2777. * The path to the menu items to be deleted. $mlid must be NULL.
  2778. */
  2779. function menu_link_delete($mlid, $path = NULL) {
  2780. if (isset($mlid)) {
  2781. _menu_delete_item(db_query("SELECT * FROM {menu_links} WHERE mlid = :mlid", array(':mlid' => $mlid))->fetchAssoc());
  2782. }
  2783. else {
  2784. $result = db_query("SELECT * FROM {menu_links} WHERE link_path = :link_path", array(':link_path' => $path));
  2785. foreach ($result as $link) {
  2786. _menu_delete_item($link);
  2787. }
  2788. }
  2789. }
  2790. /**
  2791. * Deletes a single menu link.
  2792. *
  2793. * @param $item
  2794. * Item to be deleted.
  2795. * @param $force
  2796. * Forces deletion. Internal use only, setting to TRUE is discouraged.
  2797. *
  2798. * @see menu_link_delete()
  2799. */
  2800. function _menu_delete_item($item, $force = FALSE) {
  2801. $item = is_object($item) ? get_object_vars($item) : $item;
  2802. if ($item && ($item['module'] != 'system' || $item['updated'] || $force)) {
  2803. // Children get re-attached to the item's parent.
  2804. if ($item['has_children']) {
  2805. $result = db_query("SELECT mlid FROM {menu_links} WHERE plid = :plid", array(':plid' => $item['mlid']));
  2806. foreach ($result as $m) {
  2807. $child = menu_link_load($m->mlid);
  2808. $child['plid'] = $item['plid'];
  2809. menu_link_save($child);
  2810. }
  2811. }
  2812. // Notify modules we are deleting the item.
  2813. module_invoke_all('menu_link_delete', $item);
  2814. db_delete('menu_links')->condition('mlid', $item['mlid'])->execute();
  2815. // Update the has_children status of the parent.
  2816. _menu_update_parental_status($item);
  2817. menu_cache_clear($item['menu_name']);
  2818. _menu_clear_page_cache();
  2819. }
  2820. }
  2821. /**
  2822. * Saves a menu link.
  2823. *
  2824. * After calling this function, rebuild the menu cache using
  2825. * menu_cache_clear_all().
  2826. *
  2827. * @param $item
  2828. * An associative array representing a menu link item, with elements:
  2829. * - link_path: (required) The path of the menu item, which should be
  2830. * normalized first by calling drupal_get_normal_path() on it.
  2831. * - link_title: (required) Title to appear in menu for the link.
  2832. * - menu_name: (optional) The machine name of the menu for the link.
  2833. * Defaults to 'navigation'.
  2834. * - weight: (optional) Integer to determine position in menu. Default is 0.
  2835. * - expanded: (optional) Boolean that determines if the item is expanded.
  2836. * - options: (optional) An array of options, see l() for more.
  2837. * - mlid: (optional) Menu link identifier, the primary integer key for each
  2838. * menu link. Can be set to an existing value, or to 0 or NULL
  2839. * to insert a new link.
  2840. * - plid: (optional) The mlid of the parent.
  2841. * - router_path: (optional) The path of the relevant router item.
  2842. * @param $existing_item
  2843. * Optional, the current record from the {menu_links} table as an array.
  2844. * @param $parent_candidates
  2845. * Optional array of menu links keyed by mlid. Used by
  2846. * _menu_navigation_links_rebuild() only.
  2847. *
  2848. * @return
  2849. * The mlid of the saved menu link, or FALSE if the menu link could not be
  2850. * saved.
  2851. */
  2852. function menu_link_save(&$item, $existing_item = array(), $parent_candidates = array()) {
  2853. drupal_alter('menu_link', $item);
  2854. // This is the easiest way to handle the unique internal path '<front>',
  2855. // since a path marked as external does not need to match a router path.
  2856. $item['external'] = (url_is_external($item['link_path']) || $item['link_path'] == '<front>') ? 1 : 0;
  2857. // Load defaults.
  2858. $item += array(
  2859. 'menu_name' => 'navigation',
  2860. 'weight' => 0,
  2861. 'link_title' => '',
  2862. 'hidden' => 0,
  2863. 'has_children' => 0,
  2864. 'expanded' => 0,
  2865. 'options' => array(),
  2866. 'module' => 'menu',
  2867. 'customized' => 0,
  2868. 'updated' => 0,
  2869. );
  2870. if (isset($item['mlid'])) {
  2871. if (!$existing_item) {
  2872. $existing_item = db_query('SELECT * FROM {menu_links} WHERE mlid = :mlid', array('mlid' => $item['mlid']))->fetchAssoc();
  2873. }
  2874. if ($existing_item) {
  2875. $existing_item['options'] = unserialize($existing_item['options']);
  2876. }
  2877. }
  2878. else {
  2879. $existing_item = FALSE;
  2880. }
  2881. // Try to find a parent link. If found, assign it and derive its menu.
  2882. $parent = _menu_link_find_parent($item, $parent_candidates);
  2883. if (!empty($parent['mlid'])) {
  2884. $item['plid'] = $parent['mlid'];
  2885. $item['menu_name'] = $parent['menu_name'];
  2886. }
  2887. // If no corresponding parent link was found, move the link to the top-level.
  2888. else {
  2889. $item['plid'] = 0;
  2890. }
  2891. $menu_name = $item['menu_name'];
  2892. if (!$existing_item) {
  2893. $item['mlid'] = db_insert('menu_links')
  2894. ->fields(array(
  2895. 'menu_name' => $item['menu_name'],
  2896. 'plid' => $item['plid'],
  2897. 'link_path' => $item['link_path'],
  2898. 'hidden' => $item['hidden'],
  2899. 'external' => $item['external'],
  2900. 'has_children' => $item['has_children'],
  2901. 'expanded' => $item['expanded'],
  2902. 'weight' => $item['weight'],
  2903. 'module' => $item['module'],
  2904. 'link_title' => $item['link_title'],
  2905. 'options' => serialize($item['options']),
  2906. 'customized' => $item['customized'],
  2907. 'updated' => $item['updated'],
  2908. ))
  2909. ->execute();
  2910. }
  2911. // Directly fill parents for top-level links.
  2912. if ($item['plid'] == 0) {
  2913. $item['p1'] = $item['mlid'];
  2914. for ($i = 2; $i <= MENU_MAX_DEPTH; $i++) {
  2915. $item["p$i"] = 0;
  2916. }
  2917. $item['depth'] = 1;
  2918. }
  2919. // Otherwise, ensure that this link's depth is not beyond the maximum depth
  2920. // and fill parents based on the parent link.
  2921. else {
  2922. if ($item['has_children'] && $existing_item) {
  2923. $limit = MENU_MAX_DEPTH - menu_link_children_relative_depth($existing_item) - 1;
  2924. }
  2925. else {
  2926. $limit = MENU_MAX_DEPTH - 1;
  2927. }
  2928. if ($parent['depth'] > $limit) {
  2929. return FALSE;
  2930. }
  2931. $item['depth'] = $parent['depth'] + 1;
  2932. _menu_link_parents_set($item, $parent);
  2933. }
  2934. // Need to check both plid and menu_name, since plid can be 0 in any menu.
  2935. if ($existing_item && ($item['plid'] != $existing_item['plid'] || $menu_name != $existing_item['menu_name'])) {
  2936. _menu_link_move_children($item, $existing_item);
  2937. }
  2938. // Find the router_path.
  2939. if (empty($item['router_path']) || !$existing_item || ($existing_item['link_path'] != $item['link_path'])) {
  2940. if ($item['external']) {
  2941. $item['router_path'] = '';
  2942. }
  2943. else {
  2944. // Find the router path which will serve this path.
  2945. $item['parts'] = explode('/', $item['link_path'], MENU_MAX_PARTS);
  2946. $item['router_path'] = _menu_find_router_path($item['link_path']);
  2947. }
  2948. }
  2949. // If every value in $existing_item is the same in the $item, there is no
  2950. // reason to run the update queries or clear the caches. We use
  2951. // array_intersect_key() with the $item as the first parameter because
  2952. // $item may have additional keys left over from building a router entry.
  2953. // The intersect removes the extra keys, allowing a meaningful comparison.
  2954. if (!$existing_item || (array_intersect_key($item, $existing_item) != $existing_item)) {
  2955. db_update('menu_links')
  2956. ->fields(array(
  2957. 'menu_name' => $item['menu_name'],
  2958. 'plid' => $item['plid'],
  2959. 'link_path' => $item['link_path'],
  2960. 'router_path' => $item['router_path'],
  2961. 'hidden' => $item['hidden'],
  2962. 'external' => $item['external'],
  2963. 'has_children' => $item['has_children'],
  2964. 'expanded' => $item['expanded'],
  2965. 'weight' => $item['weight'],
  2966. 'depth' => $item['depth'],
  2967. 'p1' => $item['p1'],
  2968. 'p2' => $item['p2'],
  2969. 'p3' => $item['p3'],
  2970. 'p4' => $item['p4'],
  2971. 'p5' => $item['p5'],
  2972. 'p6' => $item['p6'],
  2973. 'p7' => $item['p7'],
  2974. 'p8' => $item['p8'],
  2975. 'p9' => $item['p9'],
  2976. 'module' => $item['module'],
  2977. 'link_title' => $item['link_title'],
  2978. 'options' => serialize($item['options']),
  2979. 'customized' => $item['customized'],
  2980. ))
  2981. ->condition('mlid', $item['mlid'])
  2982. ->execute();
  2983. // Check the has_children status of the parent.
  2984. _menu_update_parental_status($item);
  2985. menu_cache_clear($menu_name);
  2986. if ($existing_item && $menu_name != $existing_item['menu_name']) {
  2987. menu_cache_clear($existing_item['menu_name']);
  2988. }
  2989. // Notify modules we have acted on a menu item.
  2990. $hook = 'menu_link_insert';
  2991. if ($existing_item) {
  2992. $hook = 'menu_link_update';
  2993. }
  2994. module_invoke_all($hook, $item);
  2995. // Now clear the cache.
  2996. _menu_clear_page_cache();
  2997. }
  2998. return $item['mlid'];
  2999. }
  3000. /**
  3001. * Finds a possible parent for a given menu link.
  3002. *
  3003. * Because the parent of a given link might not exist anymore in the database,
  3004. * we apply a set of heuristics to determine a proper parent:
  3005. *
  3006. * - use the passed parent link if specified and existing.
  3007. * - else, use the first existing link down the previous link hierarchy
  3008. * - else, for system menu links (derived from hook_menu()), reparent
  3009. * based on the path hierarchy.
  3010. *
  3011. * @param $menu_link
  3012. * A menu link.
  3013. * @param $parent_candidates
  3014. * An array of menu links keyed by mlid.
  3015. *
  3016. * @return
  3017. * A menu link structure of the possible parent or FALSE if no valid parent
  3018. * has been found.
  3019. */
  3020. function _menu_link_find_parent($menu_link, $parent_candidates = array()) {
  3021. $parent = FALSE;
  3022. // This item is explicitely top-level, skip the rest of the parenting.
  3023. if (isset($menu_link['plid']) && empty($menu_link['plid'])) {
  3024. return $parent;
  3025. }
  3026. // If we have a parent link ID, try to use that.
  3027. $candidates = array();
  3028. if (isset($menu_link['plid'])) {
  3029. $candidates[] = $menu_link['plid'];
  3030. }
  3031. // Else, if we have a link hierarchy try to find a valid parent in there.
  3032. if (!empty($menu_link['depth']) && $menu_link['depth'] > 1) {
  3033. for ($depth = $menu_link['depth'] - 1; $depth >= 1; $depth--) {
  3034. $candidates[] = $menu_link['p' . $depth];
  3035. }
  3036. }
  3037. foreach ($candidates as $mlid) {
  3038. if (isset($parent_candidates[$mlid])) {
  3039. $parent = $parent_candidates[$mlid];
  3040. }
  3041. else {
  3042. $parent = db_query("SELECT * FROM {menu_links} WHERE mlid = :mlid", array(':mlid' => $mlid))->fetchAssoc();
  3043. }
  3044. if ($parent) {
  3045. return $parent;
  3046. }
  3047. }
  3048. // If everything else failed, try to derive the parent from the path
  3049. // hierarchy. This only makes sense for links derived from menu router
  3050. // items (ie. from hook_menu()).
  3051. if ($menu_link['module'] == 'system') {
  3052. $query = db_select('menu_links');
  3053. $query->condition('module', 'system');
  3054. // We always respect the link's 'menu_name'; inheritance for router items is
  3055. // ensured in _menu_router_build().
  3056. $query->condition('menu_name', $menu_link['menu_name']);
  3057. // Find the parent - it must be unique.
  3058. $parent_path = $menu_link['link_path'];
  3059. do {
  3060. $parent = FALSE;
  3061. $parent_path = substr($parent_path, 0, strrpos($parent_path, '/'));
  3062. $new_query = clone $query;
  3063. $new_query->condition('link_path', $parent_path);
  3064. // Only valid if we get a unique result.
  3065. if ($new_query->countQuery()->execute()->fetchField() == 1) {
  3066. $parent = $new_query->fields('menu_links')->execute()->fetchAssoc();
  3067. }
  3068. } while ($parent === FALSE && $parent_path);
  3069. }
  3070. return $parent;
  3071. }
  3072. /**
  3073. * Clears the page and block caches at most twice per page load.
  3074. */
  3075. function _menu_clear_page_cache() {
  3076. $cache_cleared = &drupal_static(__FUNCTION__, 0);
  3077. // Clear the page and block caches, but at most twice, including at
  3078. // the end of the page load when there are multiple links saved or deleted.
  3079. if ($cache_cleared == 0) {
  3080. cache_clear_all();
  3081. // Keep track of which menus have expanded items.
  3082. _menu_set_expanded_menus();
  3083. $cache_cleared = 1;
  3084. }
  3085. elseif ($cache_cleared == 1) {
  3086. drupal_register_shutdown_function('cache_clear_all');
  3087. // Keep track of which menus have expanded items.
  3088. drupal_register_shutdown_function('_menu_set_expanded_menus');
  3089. $cache_cleared = 2;
  3090. }
  3091. }
  3092. /**
  3093. * Updates a list of menus with expanded items.
  3094. */
  3095. function _menu_set_expanded_menus() {
  3096. $names = db_query("SELECT menu_name FROM {menu_links} WHERE expanded <> 0 GROUP BY menu_name")->fetchCol();
  3097. variable_set('menu_expanded', $names);
  3098. }
  3099. /**
  3100. * Finds the router path which will serve this path.
  3101. *
  3102. * @param $link_path
  3103. * The path for we are looking up its router path.
  3104. *
  3105. * @return
  3106. * A path from $menu keys or empty if $link_path points to a nonexisting
  3107. * place.
  3108. */
  3109. function _menu_find_router_path($link_path) {
  3110. // $menu will only have data during a menu rebuild.
  3111. $menu = _menu_router_cache();
  3112. $router_path = $link_path;
  3113. $parts = explode('/', $link_path, MENU_MAX_PARTS);
  3114. $ancestors = menu_get_ancestors($parts);
  3115. if (empty($menu)) {
  3116. // Not during a menu rebuild, so look up in the database.
  3117. $router_path = (string) db_select('menu_router')
  3118. ->fields('menu_router', array('path'))
  3119. ->condition('path', $ancestors, 'IN')
  3120. ->orderBy('fit', 'DESC')
  3121. ->range(0, 1)
  3122. ->execute()->fetchField();
  3123. }
  3124. elseif (!isset($menu[$router_path])) {
  3125. // Add an empty router path as a fallback.
  3126. $ancestors[] = '';
  3127. foreach ($ancestors as $key => $router_path) {
  3128. if (isset($menu[$router_path])) {
  3129. // Exit the loop leaving $router_path as the first match.
  3130. break;
  3131. }
  3132. }
  3133. // If we did not find the path, $router_path will be the empty string
  3134. // at the end of $ancestors.
  3135. }
  3136. return $router_path;
  3137. }
  3138. /**
  3139. * Inserts, updates, or deletes an uncustomized menu link related to a module.
  3140. *
  3141. * @param $module
  3142. * The name of the module.
  3143. * @param $op
  3144. * Operation to perform: insert, update or delete.
  3145. * @param $link_path
  3146. * The path this link points to.
  3147. * @param $link_title
  3148. * Title of the link to insert or new title to update the link to.
  3149. * Unused for delete.
  3150. *
  3151. * @return
  3152. * The insert op returns the mlid of the new item. Others op return NULL.
  3153. */
  3154. function menu_link_maintain($module, $op, $link_path, $link_title) {
  3155. switch ($op) {
  3156. case 'insert':
  3157. $menu_link = array(
  3158. 'link_title' => $link_title,
  3159. 'link_path' => $link_path,
  3160. 'module' => $module,
  3161. );
  3162. return menu_link_save($menu_link);
  3163. break;
  3164. case 'update':
  3165. $result = db_query("SELECT * FROM {menu_links} WHERE link_path = :link_path AND module = :module AND customized = 0", array(':link_path' => $link_path, ':module' => $module))->fetchAll(PDO::FETCH_ASSOC);
  3166. foreach ($result as $link) {
  3167. $link['link_title'] = $link_title;
  3168. $link['options'] = unserialize($link['options']);
  3169. menu_link_save($link);
  3170. }
  3171. break;
  3172. case 'delete':
  3173. menu_link_delete(NULL, $link_path);
  3174. break;
  3175. }
  3176. }
  3177. /**
  3178. * Finds the depth of an item's children relative to its depth.
  3179. *
  3180. * For example, if the item has a depth of 2, and the maximum of any child in
  3181. * the menu link tree is 5, the relative depth is 3.
  3182. *
  3183. * @param $item
  3184. * An array representing a menu link item.
  3185. *
  3186. * @return
  3187. * The relative depth, or zero.
  3188. *
  3189. */
  3190. function menu_link_children_relative_depth($item) {
  3191. $query = db_select('menu_links');
  3192. $query->addField('menu_links', 'depth');
  3193. $query->condition('menu_name', $item['menu_name']);
  3194. $query->orderBy('depth', 'DESC');
  3195. $query->range(0, 1);
  3196. $i = 1;
  3197. $p = 'p1';
  3198. while ($i <= MENU_MAX_DEPTH && $item[$p]) {
  3199. $query->condition($p, $item[$p]);
  3200. $p = 'p' . ++$i;
  3201. }
  3202. $max_depth = $query->execute()->fetchField();
  3203. return ($max_depth > $item['depth']) ? $max_depth - $item['depth'] : 0;
  3204. }
  3205. /**
  3206. * Updates the children of a menu link that is being moved.
  3207. *
  3208. * The menu name, parents (p1 - p6), and depth are updated for all children of
  3209. * the link, and the has_children status of the previous parent is updated.
  3210. */
  3211. function _menu_link_move_children($item, $existing_item) {
  3212. $query = db_update('menu_links');
  3213. $query->fields(array('menu_name' => $item['menu_name']));
  3214. $p = 'p1';
  3215. $expressions = array();
  3216. for ($i = 1; $i <= $item['depth']; $p = 'p' . ++$i) {
  3217. $expressions[] = array($p, ":p_$i", array(":p_$i" => $item[$p]));
  3218. }
  3219. $j = $existing_item['depth'] + 1;
  3220. while ($i <= MENU_MAX_DEPTH && $j <= MENU_MAX_DEPTH) {
  3221. $expressions[] = array('p' . $i++, 'p' . $j++, array());
  3222. }
  3223. while ($i <= MENU_MAX_DEPTH) {
  3224. $expressions[] = array('p' . $i++, 0, array());
  3225. }
  3226. $shift = $item['depth'] - $existing_item['depth'];
  3227. if ($shift > 0) {
  3228. // The order of expressions must be reversed so the new values don't
  3229. // overwrite the old ones before they can be used because "Single-table
  3230. // UPDATE assignments are generally evaluated from left to right"
  3231. // see: http://dev.mysql.com/doc/refman/5.0/en/update.html
  3232. $expressions = array_reverse($expressions);
  3233. }
  3234. foreach ($expressions as $expression) {
  3235. $query->expression($expression[0], $expression[1], $expression[2]);
  3236. }
  3237. $query->expression('depth', 'depth + :depth', array(':depth' => $shift));
  3238. $query->condition('menu_name', $existing_item['menu_name']);
  3239. $p = 'p1';
  3240. for ($i = 1; $i <= MENU_MAX_DEPTH && $existing_item[$p]; $p = 'p' . ++$i) {
  3241. $query->condition($p, $existing_item[$p]);
  3242. }
  3243. $query->execute();
  3244. // Check the has_children status of the parent, while excluding this item.
  3245. _menu_update_parental_status($existing_item, TRUE);
  3246. }
  3247. /**
  3248. * Checks and updates the 'has_children' status for the parent of a link.
  3249. */
  3250. function _menu_update_parental_status($item, $exclude = FALSE) {
  3251. // If plid == 0, there is nothing to update.
  3252. if ($item['plid']) {
  3253. // Check if at least one visible child exists in the table.
  3254. $query = db_select('menu_links');
  3255. $query->addField('menu_links', 'mlid');
  3256. $query->condition('menu_name', $item['menu_name']);
  3257. $query->condition('hidden', 0);
  3258. $query->condition('plid', $item['plid']);
  3259. $query->range(0, 1);
  3260. if ($exclude) {
  3261. $query->condition('mlid', $item['mlid'], '<>');
  3262. }
  3263. $parent_has_children = ((bool) $query->execute()->fetchField()) ? 1 : 0;
  3264. db_update('menu_links')
  3265. ->fields(array('has_children' => $parent_has_children))
  3266. ->condition('mlid', $item['plid'])
  3267. ->execute();
  3268. }
  3269. }
  3270. /**
  3271. * Sets the p1 through p9 values for a menu link being saved.
  3272. */
  3273. function _menu_link_parents_set(&$item, $parent) {
  3274. $i = 1;
  3275. while ($i < $item['depth']) {
  3276. $p = 'p' . $i++;
  3277. $item[$p] = $parent[$p];
  3278. }
  3279. $p = 'p' . $i++;
  3280. // The parent (p1 - p9) corresponding to the depth always equals the mlid.
  3281. $item[$p] = $item['mlid'];
  3282. while ($i <= MENU_MAX_DEPTH) {
  3283. $p = 'p' . $i++;
  3284. $item[$p] = 0;
  3285. }
  3286. }
  3287. /**
  3288. * Builds the router table based on the data from hook_menu().
  3289. */
  3290. function _menu_router_build($callbacks) {
  3291. // First pass: separate callbacks from paths, making paths ready for
  3292. // matching. Calculate fitness, and fill some default values.
  3293. $menu = array();
  3294. $masks = array();
  3295. foreach ($callbacks as $path => $item) {
  3296. $load_functions = array();
  3297. $to_arg_functions = array();
  3298. $fit = 0;
  3299. $move = FALSE;
  3300. $parts = explode('/', $path, MENU_MAX_PARTS);
  3301. $number_parts = count($parts);
  3302. // We store the highest index of parts here to save some work in the fit
  3303. // calculation loop.
  3304. $slashes = $number_parts - 1;
  3305. // Extract load and to_arg functions.
  3306. foreach ($parts as $k => $part) {
  3307. $match = FALSE;
  3308. // Look for wildcards in the form allowed to be used in PHP functions,
  3309. // because we are using these to construct the load function names.
  3310. if (preg_match('/^%(|' . DRUPAL_PHP_FUNCTION_PATTERN . ')$/', $part, $matches)) {
  3311. if (empty($matches[1])) {
  3312. $match = TRUE;
  3313. $load_functions[$k] = NULL;
  3314. }
  3315. else {
  3316. if (function_exists($matches[1] . '_to_arg')) {
  3317. $to_arg_functions[$k] = $matches[1] . '_to_arg';
  3318. $load_functions[$k] = NULL;
  3319. $match = TRUE;
  3320. }
  3321. if (function_exists($matches[1] . '_load')) {
  3322. $function = $matches[1] . '_load';
  3323. // Create an array of arguments that will be passed to the _load
  3324. // function when this menu path is checked, if 'load arguments'
  3325. // exists.
  3326. $load_functions[$k] = isset($item['load arguments']) ? array($function => $item['load arguments']) : $function;
  3327. $match = TRUE;
  3328. }
  3329. }
  3330. }
  3331. if ($match) {
  3332. $parts[$k] = '%';
  3333. }
  3334. else {
  3335. $fit |= 1 << ($slashes - $k);
  3336. }
  3337. }
  3338. if ($fit) {
  3339. $move = TRUE;
  3340. }
  3341. else {
  3342. // If there is no %, it fits maximally.
  3343. $fit = (1 << $number_parts) - 1;
  3344. }
  3345. $masks[$fit] = 1;
  3346. $item['_load_functions'] = $load_functions;
  3347. $item['to_arg_functions'] = empty($to_arg_functions) ? '' : serialize($to_arg_functions);
  3348. $item += array(
  3349. 'title' => '',
  3350. 'weight' => 0,
  3351. 'type' => MENU_NORMAL_ITEM,
  3352. 'module' => '',
  3353. '_number_parts' => $number_parts,
  3354. '_parts' => $parts,
  3355. '_fit' => $fit,
  3356. );
  3357. $item += array(
  3358. '_visible' => (bool) ($item['type'] & MENU_VISIBLE_IN_BREADCRUMB),
  3359. '_tab' => (bool) ($item['type'] & MENU_IS_LOCAL_TASK),
  3360. );
  3361. if ($move) {
  3362. $new_path = implode('/', $item['_parts']);
  3363. $menu[$new_path] = $item;
  3364. $sort[$new_path] = $number_parts;
  3365. }
  3366. else {
  3367. $menu[$path] = $item;
  3368. $sort[$path] = $number_parts;
  3369. }
  3370. }
  3371. array_multisort($sort, SORT_NUMERIC, $menu);
  3372. // Apply inheritance rules.
  3373. foreach ($menu as $path => $v) {
  3374. $item = &$menu[$path];
  3375. if (!$item['_tab']) {
  3376. // Non-tab items.
  3377. $item['tab_parent'] = '';
  3378. $item['tab_root'] = $path;
  3379. }
  3380. // If not specified, assign the default tab type for local tasks.
  3381. elseif (!isset($item['context'])) {
  3382. $item['context'] = MENU_CONTEXT_PAGE;
  3383. }
  3384. for ($i = $item['_number_parts'] - 1; $i; $i--) {
  3385. $parent_path = implode('/', array_slice($item['_parts'], 0, $i));
  3386. if (isset($menu[$parent_path])) {
  3387. $parent = &$menu[$parent_path];
  3388. // If we have no menu name, try to inherit it from parent items.
  3389. if (!isset($item['menu_name'])) {
  3390. // If the parent item of this item does not define a menu name (and no
  3391. // previous iteration assigned one already), try to find the menu name
  3392. // of the parent item in the currently stored menu links.
  3393. if (!isset($parent['menu_name'])) {
  3394. $menu_name = db_query("SELECT menu_name FROM {menu_links} WHERE router_path = :router_path AND module = 'system'", array(':router_path' => $parent_path))->fetchField();
  3395. if ($menu_name) {
  3396. $parent['menu_name'] = $menu_name;
  3397. }
  3398. }
  3399. // If the parent item defines a menu name, inherit it.
  3400. if (!empty($parent['menu_name'])) {
  3401. $item['menu_name'] = $parent['menu_name'];
  3402. }
  3403. }
  3404. if (!isset($item['tab_parent'])) {
  3405. // Parent stores the parent of the path.
  3406. $item['tab_parent'] = $parent_path;
  3407. }
  3408. if (!isset($item['tab_root']) && !$parent['_tab']) {
  3409. $item['tab_root'] = $parent_path;
  3410. }
  3411. // If an access callback is not found for a default local task we use
  3412. // the callback from the parent, since we expect them to be identical.
  3413. // In all other cases, the access parameters must be specified.
  3414. if (($item['type'] == MENU_DEFAULT_LOCAL_TASK) && !isset($item['access callback']) && isset($parent['access callback'])) {
  3415. $item['access callback'] = $parent['access callback'];
  3416. if (!isset($item['access arguments']) && isset($parent['access arguments'])) {
  3417. $item['access arguments'] = $parent['access arguments'];
  3418. }
  3419. }
  3420. // Same for page callbacks.
  3421. if (!isset($item['page callback']) && isset($parent['page callback'])) {
  3422. $item['page callback'] = $parent['page callback'];
  3423. if (!isset($item['page arguments']) && isset($parent['page arguments'])) {
  3424. $item['page arguments'] = $parent['page arguments'];
  3425. }
  3426. if (!isset($item['file path']) && isset($parent['file path'])) {
  3427. $item['file path'] = $parent['file path'];
  3428. }
  3429. if (!isset($item['file']) && isset($parent['file'])) {
  3430. $item['file'] = $parent['file'];
  3431. if (empty($item['file path']) && isset($item['module']) && isset($parent['module']) && $item['module'] != $parent['module']) {
  3432. $item['file path'] = drupal_get_path('module', $parent['module']);
  3433. }
  3434. }
  3435. }
  3436. // Same for delivery callbacks.
  3437. if (!isset($item['delivery callback']) && isset($parent['delivery callback'])) {
  3438. $item['delivery callback'] = $parent['delivery callback'];
  3439. }
  3440. // Same for theme callbacks.
  3441. if (!isset($item['theme callback']) && isset($parent['theme callback'])) {
  3442. $item['theme callback'] = $parent['theme callback'];
  3443. if (!isset($item['theme arguments']) && isset($parent['theme arguments'])) {
  3444. $item['theme arguments'] = $parent['theme arguments'];
  3445. }
  3446. }
  3447. // Same for load arguments: if a loader doesn't have any explict
  3448. // arguments, try to find arguments in the parent.
  3449. if (!isset($item['load arguments'])) {
  3450. foreach ($item['_load_functions'] as $k => $function) {
  3451. // This loader doesn't have any explict arguments...
  3452. if (!is_array($function)) {
  3453. // ... check the parent for a loader at the same position
  3454. // using the same function name and defining arguments...
  3455. if (isset($parent['_load_functions'][$k]) && is_array($parent['_load_functions'][$k]) && key($parent['_load_functions'][$k]) === $function) {
  3456. // ... and inherit the arguments on the child.
  3457. $item['_load_functions'][$k] = $parent['_load_functions'][$k];
  3458. }
  3459. }
  3460. }
  3461. }
  3462. }
  3463. }
  3464. if (!isset($item['access callback']) && isset($item['access arguments'])) {
  3465. // Default callback.
  3466. $item['access callback'] = 'user_access';
  3467. }
  3468. if (!isset($item['access callback']) || empty($item['page callback'])) {
  3469. $item['access callback'] = 0;
  3470. }
  3471. if (is_bool($item['access callback'])) {
  3472. $item['access callback'] = intval($item['access callback']);
  3473. }
  3474. $item['load_functions'] = empty($item['_load_functions']) ? '' : serialize($item['_load_functions']);
  3475. $item += array(
  3476. 'access arguments' => array(),
  3477. 'access callback' => '',
  3478. 'page arguments' => array(),
  3479. 'page callback' => '',
  3480. 'delivery callback' => '',
  3481. 'title arguments' => array(),
  3482. 'title callback' => 't',
  3483. 'theme arguments' => array(),
  3484. 'theme callback' => '',
  3485. 'description' => '',
  3486. 'position' => '',
  3487. 'context' => 0,
  3488. 'tab_parent' => '',
  3489. 'tab_root' => $path,
  3490. 'path' => $path,
  3491. 'file' => '',
  3492. 'file path' => '',
  3493. 'include file' => '',
  3494. );
  3495. // Calculate out the file to be included for each callback, if any.
  3496. if ($item['file']) {
  3497. $file_path = $item['file path'] ? $item['file path'] : drupal_get_path('module', $item['module']);
  3498. $item['include file'] = $file_path . '/' . $item['file'];
  3499. }
  3500. }
  3501. // Sort the masks so they are in order of descending fit.
  3502. $masks = array_keys($masks);
  3503. rsort($masks);
  3504. return array($menu, $masks);
  3505. }
  3506. /**
  3507. * Saves data from menu_router_build() to the router table.
  3508. */
  3509. function _menu_router_save($menu, $masks) {
  3510. // Delete the existing router since we have some data to replace it.
  3511. db_truncate('menu_router')->execute();
  3512. // Prepare insert object.
  3513. $insert = db_insert('menu_router')
  3514. ->fields(array(
  3515. 'path',
  3516. 'load_functions',
  3517. 'to_arg_functions',
  3518. 'access_callback',
  3519. 'access_arguments',
  3520. 'page_callback',
  3521. 'page_arguments',
  3522. 'delivery_callback',
  3523. 'fit',
  3524. 'number_parts',
  3525. 'context',
  3526. 'tab_parent',
  3527. 'tab_root',
  3528. 'title',
  3529. 'title_callback',
  3530. 'title_arguments',
  3531. 'theme_callback',
  3532. 'theme_arguments',
  3533. 'type',
  3534. 'description',
  3535. 'position',
  3536. 'weight',
  3537. 'include_file',
  3538. ));
  3539. $num_records = 0;
  3540. foreach ($menu as $path => $item) {
  3541. // Fill in insert object values.
  3542. $insert->values(array(
  3543. 'path' => $item['path'],
  3544. 'load_functions' => $item['load_functions'],
  3545. 'to_arg_functions' => $item['to_arg_functions'],
  3546. 'access_callback' => $item['access callback'],
  3547. 'access_arguments' => serialize($item['access arguments']),
  3548. 'page_callback' => $item['page callback'],
  3549. 'page_arguments' => serialize($item['page arguments']),
  3550. 'delivery_callback' => $item['delivery callback'],
  3551. 'fit' => $item['_fit'],
  3552. 'number_parts' => $item['_number_parts'],
  3553. 'context' => $item['context'],
  3554. 'tab_parent' => $item['tab_parent'],
  3555. 'tab_root' => $item['tab_root'],
  3556. 'title' => $item['title'],
  3557. 'title_callback' => $item['title callback'],
  3558. 'title_arguments' => ($item['title arguments'] ? serialize($item['title arguments']) : ''),
  3559. 'theme_callback' => $item['theme callback'],
  3560. 'theme_arguments' => serialize($item['theme arguments']),
  3561. 'type' => $item['type'],
  3562. 'description' => $item['description'],
  3563. 'position' => $item['position'],
  3564. 'weight' => $item['weight'],
  3565. 'include_file' => $item['include file'],
  3566. ));
  3567. // Execute in batches to avoid the memory overhead of all of those records
  3568. // in the query object.
  3569. if (++$num_records == 20) {
  3570. $insert->execute();
  3571. $num_records = 0;
  3572. }
  3573. }
  3574. // Insert any remaining records.
  3575. $insert->execute();
  3576. // Store the masks.
  3577. variable_set('menu_masks', $masks);
  3578. return $menu;
  3579. }
  3580. /**
  3581. * Checks whether the site is in maintenance mode.
  3582. *
  3583. * This function will log the current user out and redirect to front page
  3584. * if the current user has no 'access site in maintenance mode' permission.
  3585. *
  3586. * @param $check_only
  3587. * If this is set to TRUE, the function will perform the access checks and
  3588. * return the site offline status, but not log the user out or display any
  3589. * messages.
  3590. *
  3591. * @return
  3592. * FALSE if the site is not in maintenance mode, the user login page is
  3593. * displayed, or the user has the 'access site in maintenance mode'
  3594. * permission. TRUE for anonymous users not being on the login page when the
  3595. * site is in maintenance mode.
  3596. */
  3597. function _menu_site_is_offline($check_only = FALSE) {
  3598. // Check if site is in maintenance mode.
  3599. if (variable_get('maintenance_mode', 0)) {
  3600. if (user_access('access site in maintenance mode')) {
  3601. // Ensure that the maintenance mode message is displayed only once
  3602. // (allowing for page redirects) and specifically suppress its display on
  3603. // the maintenance mode settings page.
  3604. if (!$check_only && $_GET['q'] != 'admin/config/development/maintenance') {
  3605. if (user_access('administer site configuration')) {
  3606. drupal_set_message(t('Operating in maintenance mode. <a href="@url">Go online.</a>', array('@url' => url('admin/config/development/maintenance'))), 'status', FALSE);
  3607. }
  3608. else {
  3609. drupal_set_message(t('Operating in maintenance mode.'), 'status', FALSE);
  3610. }
  3611. }
  3612. }
  3613. else {
  3614. return TRUE;
  3615. }
  3616. }
  3617. return FALSE;
  3618. }
  3619. /**
  3620. * @} End of "defgroup menu".
  3621. */

Functions

Namesort descending Description
drupal_help_arg Generates elements for the $arg array in the help hook.
menu_build_tree Builds a menu tree, translates links, and checks access.
menu_cache_clear Clears the cached cached data for a single named menu.
menu_cache_clear_all Clears all cached menu data.
menu_contextual_links Retrieves contextual links for a path based on registered local tasks.
menu_delete_links Deletes all links for a menu.
menu_execute_active_handler Execute the page callback associated with the current path.
menu_get_active_breadcrumb Gets the breadcrumb for the current page, as determined by the active trail.
menu_get_active_help Returns the help associated with the active menu item.
menu_get_active_menu_names Gets the active menu for the current page.
menu_get_active_title Gets the title of the current page, as determined by the active trail.
menu_get_active_trail Gets the active trail (path to root menu root) of the current page.
menu_get_ancestors Returns the ancestors (and relevant placeholders) for any given path.
menu_get_custom_theme Gets the custom theme for the current page, if there is one.
menu_get_item Gets a router item.
menu_get_names Build a list of named menus.
menu_get_object Gets a loaded object from a router item.
menu_get_router Gets the menu router.
menu_links_clone Clones an array of menu links.
menu_link_children_relative_depth Finds the depth of an item's children relative to its depth.
menu_link_delete Delete one or several menu links.
menu_link_get_preferred Looks up the preferred menu link for a given system path.
menu_link_load Gets a translated, access-checked menu link that is ready for rendering.
menu_link_maintain Inserts, updates, or deletes an uncustomized menu link related to a module.
menu_link_save Saves a menu link.
menu_list_system_menus Returns an array containing the names of system-defined (default) menus.
menu_load_links Returns an array containing all links for a menu.
menu_local_actions Returns the rendered local actions at the current level.
menu_local_tabs Returns a renderable element for the primary and secondary tabs.
menu_local_tasks Collects the local tasks (tabs), action links, and the root path.
menu_main_menu Returns an array of links to be rendered as the Main menu.
menu_navigation_links Returns an array of links for a navigation menu.
menu_primary_local_tasks Returns the rendered local tasks at the top level.
menu_rebuild Populates the database tables used by various menu functions.
menu_reset_static_cache Resets the menu system static cache.
menu_router_build Collects and alters the menu definitions.
menu_secondary_local_tasks Returns the rendered local tasks at the second level.
menu_secondary_menu Returns an array of links to be rendered as the Secondary links.
menu_set_active_item Sets the active path, which determines which page is loaded.
menu_set_active_menu_names Sets (or gets) the active menu for the current page.
menu_set_active_trail Sets the active trail (path to the menu tree root) of the current page.
menu_set_custom_theme Sets a custom theme for the current page, if there is one.
menu_set_item Replaces the statically cached item for a given path.
menu_tab_root_path Returns the router path, or the path for a default local task's parent.
menu_tail_load Loads the path as one string relative to the current index.
menu_tail_to_arg Returns a string containing the path relative to the current index.
menu_tree Renders a menu tree based on the current path.
menu_tree_all_data Gets the data structure representing a named menu tree.
menu_tree_check_access Checks access and performs dynamic operations for each link in the tree.
menu_tree_collect_node_links Collects node links from a given menu tree recursively.
menu_tree_data Sorts and returns the built data representing a menu tree.
menu_tree_get_path Gets the path for determining the active trail of the specified menu tree.
menu_tree_output Returns a rendered menu tree.
menu_tree_page_data Gets the data structure for a named menu tree, based on the current page.
menu_tree_set_path Sets the path for determining the active trail of the specified menu tree.
menu_unserialize Unserializes menu data, using a map to replace path elements.
template_preprocess_menu_tree Implements template_preprocess_HOOK() for theme_menu_tree().
theme_menu_link Returns HTML for a menu link and submenu.
theme_menu_local_action Returns HTML for a single local action link.
theme_menu_local_task Returns HTML for a single local task link.
theme_menu_local_tasks Returns HTML for primary and secondary local tasks.
theme_menu_tree Returns HTML for a wrapper for a menu sub-tree.
_menu_build_tree Builds a menu tree.
_menu_check_access Checks access to a menu item using the access callback.
_menu_clear_page_cache Clears the page and block caches at most twice per page load.
_menu_delete_item Deletes a single menu link.
_menu_find_router_path Finds the router path which will serve this path.
_menu_item_localize Localizes the router item title using t() or another callback.
_menu_link_build Builds a link from a router item.
_menu_link_find_parent Finds a possible parent for a given menu link.
_menu_link_map_translate Translates the path elements in the map using any to_arg helper function.
_menu_link_move_children Updates the children of a menu link that is being moved.
_menu_link_parents_set Sets the p1 through p9 values for a menu link being saved.
_menu_link_translate Provides menu link access control, translation, and argument handling.
_menu_load_objects Loads objects into the map as defined in the $item['load_functions'].
_menu_navigation_links_rebuild Builds menu links for the items in the menu router.
_menu_router_build Builds the router table based on the data from hook_menu().
_menu_router_cache Stores the menu router if we have it in memory.
_menu_router_save Saves data from menu_router_build() to the router table.
_menu_set_expanded_menus Updates a list of menus with expanded items.
_menu_site_is_offline Checks whether the site is in maintenance mode.
_menu_translate Handles dynamic path translation and menu access control.
_menu_tree_check_access Sorts the menu tree and recursively checks access for each item.
_menu_tree_data Builds the data representing a menu tree.
_menu_update_parental_status Checks and updates the 'has_children' status for the parent of a link.

Constants

Namesort descending Description
MENU_ACCESS_DENIED Internal menu status code -- Menu item access is denied.
MENU_CALLBACK Menu type -- A hidden, internal callback, typically used for API calls.
MENU_CONTEXT_INLINE Internal menu flag: Local task should be displayed inline.
MENU_CONTEXT_NONE Internal menu flag: Invisible local task.
MENU_CONTEXT_PAGE Internal menu flag: Local task should be displayed in page context.
MENU_CREATED_BY_ADMIN Internal menu flag -- menu item was created by administrator.
MENU_DEFAULT_LOCAL_TASK Menu type -- The "default" local task, which is initially active.
MENU_FOUND Internal menu status code -- Menu item was found.
MENU_IS_LOCAL_ACTION Internal menu flag -- menu item is a local action.
MENU_IS_LOCAL_TASK Internal menu flag -- menu item is a local task.
MENU_IS_ROOT Internal menu flag -- menu item is the root of the menu tree.
MENU_LINKS_TO_PARENT Internal menu flag -- menu item links back to its parent.
MENU_LOCAL_ACTION Menu type -- An action specific to the parent, usually rendered as a link.
MENU_LOCAL_TASK Menu type -- A task specific to the parent item, usually rendered as a tab.
MENU_MAX_DEPTH The maximum depth of a menu links tree - matches the number of p columns.
MENU_MAX_PARTS The maximum number of path elements for a menu callback
MENU_MODIFIED_BY_ADMIN Internal menu flag -- menu item can be modified by administrator.
MENU_NORMAL_ITEM Menu type -- A "normal" menu item that's shown in menu and breadcrumbs.
MENU_NOT_FOUND Internal menu status code -- Menu item was not found.
MENU_PREFERRED_LINK Reserved key to identify the most specific menu link for a given path.
MENU_SITE_OFFLINE Internal menu status code -- Menu item inaccessible because site is offline.
MENU_SITE_ONLINE Internal menu status code -- Everything is working fine.
MENU_SUGGESTED_ITEM Menu type -- A normal menu item, hidden until enabled by an administrator.
MENU_VISIBLE_IN_BREADCRUMB Internal menu flag -- menu item is visible in the breadcrumb.
MENU_VISIBLE_IN_TREE Internal menu flag -- menu item is visible in the menu tree.