menu.inc 116 KB
Newer Older
Dries's avatar
 
Dries committed
1
<?php
Kjartan's avatar
Kjartan committed
2

3 4 5 6 7
/**
 * @file
 * API for the Drupal menu system.
 */

8
use Drupal\Component\Utility\NestedArray;
9
use Drupal\Core\Cache\CacheBackendInterface;
10
use Drupal\Core\Template\Attribute;
11 12
use Drupal\menu_link\Plugin\Core\Entity\MenuLink;
use Drupal\menu_link\MenuLinkStorageController;
13

Dries's avatar
 
Dries committed
14 15 16
/**
 * @defgroup menu Menu system
 * @{
Dries's avatar
 
Dries committed
17
 * Define the navigation menus, and route page requests to code based on URLs.
Dries's avatar
 
Dries committed
18 19 20 21
 *
 * The Drupal menu system drives both the navigation system from a user
 * perspective and the callback system that Drupal uses to respond to URLs
 * passed from the browser. For this reason, a good understanding of the
22 23 24 25
 * menu system is fundamental to the creation of complex modules. As a note,
 * this is related to, but separate from menu.module, which allows menus
 * (which in this context are hierarchical lists of links) to be customized from
 * the Drupal administrative interface.
Dries's avatar
 
Dries committed
26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47
 *
 * Drupal's menu system follows a simple hierarchy defined by paths.
 * Implementations of hook_menu() define menu items and assign them to
 * paths (which should be unique). The menu system aggregates these items
 * and determines the menu hierarchy from the paths. For example, if the
 * paths defined were a, a/b, e, a/b/c/d, f/g, and a/b/h, the menu system
 * would form the structure:
 * - a
 *   - a/b
 *     - a/b/c/d
 *     - a/b/h
 * - e
 * - f/g
 * Note that the number of elements in the path does not necessarily
 * determine the depth of the menu item in the tree.
 *
 * When responding to a page request, the menu system looks to see if the
 * path requested by the browser is registered as a menu item with a
 * callback. If not, the system searches up the menu tree for the most
 * complete match with a callback it can find. If the path a/b/i is
 * requested in the tree above, the callback for a/b would be used.
 *
Steven Wittens's avatar
Steven Wittens committed
48
 * The found callback function is called with any arguments specified
49
 * in the "page arguments" attribute of its menu item. The
Steven Wittens's avatar
Steven Wittens committed
50 51 52 53
 * attribute must be an array. After these arguments, any remaining
 * components of the path are appended as further arguments. In this
 * way, the callback for a/b above could respond to a request for
 * a/b/i differently than a request for a/b/j.
Dries's avatar
 
Dries committed
54 55 56 57
 *
 * For an illustration of this process, see page_example.module.
 *
 * Access to the callback functions is also protected by the menu system.
58 59
 * The "access callback" with an optional "access arguments" of each menu
 * item is called before the page callback proceeds. If this returns TRUE,
60 61 62
 * then access is granted; if FALSE, then access is denied. Default local task
 * menu items (see next paragraph) may omit this attribute to use the value
 * provided by the parent item.
Dries's avatar
 
Dries committed
63 64 65 66 67 68 69 70 71 72 73 74 75
 *
 * In the default Drupal interface, you will notice many links rendered as
 * tabs. These are known in the menu system as "local tasks", and they are
 * rendered as tabs by default, though other presentations are possible.
 * Local tasks function just as other menu items in most respects. It is
 * convention that the names of these tasks should be short verbs if
 * possible. In addition, a "default" local task should be provided for
 * each set. When visiting a local task's parent menu item, the default
 * local task will be rendered as if it is selected; this provides for a
 * normal tab user experience. This default task is special in that it
 * links not to its provided path, but to its parent item's path instead.
 * The default task's path is only used to place it appropriately in the
 * menu hierarchy.
76 77 78
 *
 * Everything described so far is stored in the menu_router table. The
 * menu_links table holds the visible menu links. By default these are
79
 * derived from the same hook_menu definitions, however you are free to
80
 * add more with menu_link_save().
Dries's avatar
 
Dries committed
81 82
 */

Dries's avatar
 
Dries committed
83
/**
84
 * @defgroup menu_flags Menu flags
Dries's avatar
 
Dries committed
85
 * @{
Dries's avatar
 
Dries committed
86 87
 * Flags for use in the "type" attribute of menu items.
 */
Dries's avatar
 
Dries committed
88

89 90 91
/**
 * Internal menu flag -- menu item is the root of the menu tree.
 */
92
const MENU_IS_ROOT = 0x0001;
93 94 95 96

/**
 * Internal menu flag -- menu item is visible in the menu tree.
 */
97
const MENU_VISIBLE_IN_TREE = 0x0002;
98 99 100 101

/**
 * Internal menu flag -- menu item is visible in the breadcrumb.
 */
102
const MENU_VISIBLE_IN_BREADCRUMB = 0x0004;
103 104

/**
105
 * Internal menu flag -- menu item links back to its parent.
106
 */
107
const MENU_LINKS_TO_PARENT = 0x0008;
108 109 110 111

/**
 * Internal menu flag -- menu item can be modified by administrator.
 */
112
const MENU_MODIFIED_BY_ADMIN = 0x0020;
113 114 115 116

/**
 * Internal menu flag -- menu item was created by administrator.
 */
117
const MENU_CREATED_BY_ADMIN = 0x0040;
118 119 120 121

/**
 * Internal menu flag -- menu item is a local task.
 */
122
const MENU_IS_LOCAL_TASK = 0x0080;
Dries's avatar
 
Dries committed
123

124 125 126
/**
 * Internal menu flag -- menu item is a local action.
 */
127
const MENU_IS_LOCAL_ACTION = 0x0100;
128

Dries's avatar
 
Dries committed
129
/**
130
 * @} End of "defgroup menu_flags".
Dries's avatar
 
Dries committed
131 132 133
 */

/**
134
 * @defgroup menu_item_types Menu item types
Dries's avatar
 
Dries committed
135
 * @{
136
 * Definitions for various menu item types.
137
 *
Dries's avatar
 
Dries committed
138
 * Menu item definitions provide one of these constants, which are shortcuts for
139
 * combinations of @link menu_flags Menu flags @endlink.
Dries's avatar
 
Dries committed
140
 */
Dries's avatar
 
Dries committed
141

Dries's avatar
 
Dries committed
142
/**
143 144
 * Menu type -- A "normal" menu item that's shown in menu and breadcrumbs.
 *
Dries's avatar
 
Dries committed
145
 * Normal menu items show up in the menu tree and can be moved/hidden by
Dries's avatar
 
Dries committed
146 147
 * the administrator. Use this for most menu items. It is the default value if
 * no menu item type is specified.
Dries's avatar
 
Dries committed
148
 */
149
define('MENU_NORMAL_ITEM', MENU_VISIBLE_IN_TREE | MENU_VISIBLE_IN_BREADCRUMB);
150

Dries's avatar
 
Dries committed
151
/**
152 153
 * Menu type -- A hidden, internal callback, typically used for API calls.
 *
Dries's avatar
 
Dries committed
154
 * Callbacks simply register a path so that the correct function is fired
155
 * when the URL is accessed. They do not appear in menus or breadcrumbs.
Dries's avatar
 
Dries committed
156
 */
157
const MENU_CALLBACK = 0x0000;
Dries's avatar
 
Dries committed
158

Dries's avatar
 
Dries committed
159
/**
160 161
 * Menu type -- A normal menu item, hidden until enabled by an administrator.
 *
Dries's avatar
 
Dries committed
162 163
 * Modules may "suggest" menu items that the administrator may enable. They act
 * just as callbacks do until enabled, at which time they act like normal items.
164 165
 * Note for the value: 0x0010 was a flag which is no longer used, but this way
 * the values of MENU_CALLBACK and MENU_SUGGESTED_ITEM are separate.
Dries's avatar
 
Dries committed
166
 */
167
define('MENU_SUGGESTED_ITEM', MENU_VISIBLE_IN_BREADCRUMB | 0x0010);
Dries's avatar
 
Dries committed
168 169

/**
170 171 172 173 174
 * Menu type -- A task specific to the parent item, usually rendered as a tab.
 *
 * Local tasks are menu items that describe actions to be performed on their
 * parent item. An example is the path "node/52/edit", which performs the
 * "edit" task on "node/52".
Dries's avatar
 
Dries committed
175
 */
176
define('MENU_LOCAL_TASK', MENU_IS_LOCAL_TASK | MENU_VISIBLE_IN_BREADCRUMB);
Dries's avatar
 
Dries committed
177

Dries's avatar
 
Dries committed
178
/**
179 180
 * Menu type -- The "default" local task, which is initially active.
 *
Dries's avatar
 
Dries committed
181 182 183
 * Every set of local tasks should provide one "default" task, that links to the
 * same path as its parent when clicked.
 */
184
define('MENU_DEFAULT_LOCAL_TASK', MENU_IS_LOCAL_TASK | MENU_LINKS_TO_PARENT | MENU_VISIBLE_IN_BREADCRUMB);
Dries's avatar
 
Dries committed
185

186 187 188 189 190 191
/**
 * Menu type -- An action specific to the parent, usually rendered as a link.
 *
 * Local actions are menu items that describe actions on the parent item such
 * as adding a new user, taxonomy term, etc.
 */
192
define('MENU_LOCAL_ACTION', MENU_IS_LOCAL_TASK | MENU_IS_LOCAL_ACTION | MENU_VISIBLE_IN_BREADCRUMB);
193

Dries's avatar
 
Dries committed
194
/**
195
 * @} End of "defgroup menu_item_types".
Dries's avatar
 
Dries committed
196 197
 */

198
/**
199
 * @defgroup menu_context_types Menu context types
200 201 202 203
 * @{
 * Flags for use in the "context" attribute of menu router items.
 */

204 205 206 207 208 209
/**
 * Internal menu flag: Invisible local task.
 *
 * This flag may be used for local tasks like "Delete", so custom modules and
 * themes can alter the default context and expose the task by altering menu.
 */
210
const MENU_CONTEXT_NONE = 0x0000;
211

212 213 214
/**
 * Internal menu flag: Local task should be displayed in page context.
 */
215
const MENU_CONTEXT_PAGE = 0x0001;
216 217 218 219

/**
 * Internal menu flag: Local task should be displayed inline.
 */
220
const MENU_CONTEXT_INLINE = 0x0002;
221 222

/**
223
 * @} End of "defgroup menu_context_types".
224 225
 */

Dries's avatar
 
Dries committed
226
/**
227
 * @defgroup menu_status_codes Menu status codes
Dries's avatar
 
Dries committed
228
 * @{
Dries's avatar
 
Dries committed
229 230
 * Status codes for menu callbacks.
 */
Dries's avatar
 
Dries committed
231

232 233 234
/**
 * Internal menu status code -- Menu item was not found.
 */
235
const MENU_NOT_FOUND = 404;
236 237 238 239

/**
 * Internal menu status code -- Menu item access is denied.
 */
240
const MENU_ACCESS_DENIED = 403;
241 242 243 244

/**
 * Internal menu status code -- Menu item inaccessible because site is offline.
 */
245
const MENU_SITE_OFFLINE = 4;
Dries's avatar
 
Dries committed
246

247 248 249
/**
 * Internal menu status code -- Everything is working fine.
 */
250
const MENU_SITE_ONLINE = 5;
251

Dries's avatar
 
Dries committed
252
/**
253
 * @} End of "defgroup menu_status_codes".
Dries's avatar
 
Dries committed
254
 */
255

256
/**
257
 * @defgroup menu_tree_parameters Menu tree parameters
258
 * @{
259
 * Parameters for a menu tree.
260 261
 */

262 263
 /**
 * The maximum number of path elements for a menu callback
264
 */
265
const MENU_MAX_PARTS = 9;
266

267 268

/**
269
 * The maximum depth of a menu links tree - matches the number of p columns.
270 271 272
 *
 * @todo Move this constant to MenuLinkStorageController along with all the tree
 * functionality.
273
 */
274
const MENU_MAX_DEPTH = 9;
275

276 277

/**
278
 * @} End of "defgroup menu_tree_parameters".
279 280
 */

281 282 283 284 285 286 287 288 289 290 291 292 293 294
/**
 * Reserved key to identify the most specific menu link for a given path.
 *
 * The value of this constant is a hash of the constant name. We use the hash
 * so that the reserved key is over 32 characters in length and will not
 * collide with allowed menu names:
 * @code
 * sha1('MENU_PREFERRED_LINK') = 1cf698d64d1aa4b83907cf6ed55db3a7f8e92c91
 * @endcode
 *
 * @see menu_link_get_preferred()
 */
const MENU_PREFERRED_LINK = '1cf698d64d1aa4b83907cf6ed55db3a7f8e92c91';

295
/**
296 297 298
 * Returns the ancestors (and relevant placeholders) for any given path.
 *
 * For example, the ancestors of node/12345/edit are:
299 300 301 302 303 304 305
 * - node/12345/edit
 * - node/12345/%
 * - node/%/edit
 * - node/%/%
 * - node/12345
 * - node/%
 * - node
306 307 308 309 310
 *
 * To generate these, we will use binary numbers. Each bit represents a
 * part of the path. If the bit is 1, then it represents the original
 * value while 0 means wildcard. If the path is node/12/edit/foo
 * then the 1011 bitstring represents node/%/edit/foo where % means that
311
 * any argument matches that part. We limit ourselves to using binary
312
 * numbers that correspond the patterns of wildcards of router items that
313
 * actually exists. This list of 'masks' is built in menu_router_rebuild().
314 315 316 317
 *
 * @param $parts
 *   An array of path parts, for the above example
 *   array('node', '12345', 'edit').
318
 *
319 320
 * @return
 *   An array which contains the ancestors and placeholders. Placeholders
321
 *   simply contain as many '%s' as the ancestors.
322 323
 */
function menu_get_ancestors($parts) {
324
  $number_parts = count($parts);
325
  $ancestors = array();
326 327
  $length =  $number_parts - 1;
  $end = (1 << $number_parts) - 1;
328 329
  $masks = state()->get('menu.masks');
  // If the optimized menu.masks array is not available use brute force to get
330
  // the correct $ancestors and $placeholders returned. Do not use this as the
331
  // default value of the menu.masks variable to avoid building such a big
332 333 334 335
  // array.
  if (!$masks) {
    $masks = range(511, 1);
  }
336 337 338 339 340 341 342 343 344 345
  // Only examine patterns that actually exist as router items (the masks).
  foreach ($masks as $i) {
    if ($i > $end) {
      // Only look at masks that are not longer than the path of interest.
      continue;
    }
    elseif ($i < (1 << $length)) {
      // We have exhausted the masks of a given length, so decrease the length.
      --$length;
    }
346 347
    $current = '';
    for ($j = $length; $j >= 0; $j--) {
348
      // Check the bit on the $j offset.
349
      if ($i & (1 << $j)) {
350
        // Bit one means the original value.
351 352 353
        $current .= $parts[$length - $j];
      }
      else {
354
        // Bit zero means means wildcard.
355 356
        $current .= '%';
      }
357
      // Unless we are at offset 0, add a slash.
358 359 360
      if ($j) {
        $current .= '/';
      }
Dries's avatar
 
Dries committed
361
    }
362
    $ancestors[] = $current;
363
  }
364
  return $ancestors;
Dries's avatar
 
Dries committed
365 366 367
}

/**
368
 * Unserializes menu data, using a map to replace path elements.
Dries's avatar
 
Dries committed
369
 *
370 371 372 373 374 375
 * The menu system stores various path-related information (such as the 'page
 * arguments' and 'access arguments' components of a menu item) in the database
 * using serialized arrays, where integer values in the arrays represent
 * arguments to be replaced by values from the path. This function first
 * unserializes such menu information arrays, and then does the path
 * replacement.
376
 *
377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397
 * The path replacement acts on each integer-valued element of the unserialized
 * menu data array ($data) using a map array ($map, which is typically an array
 * of path arguments) as a list of replacements. For instance, if there is an
 * element of $data whose value is the number 2, then it is replaced in $data
 * with $map[2]; non-integer values in $data are left alone.
 *
 * As an example, an unserialized $data array with elements ('node_load', 1)
 * represents instructions for calling the node_load() function. Specifically,
 * this instruction says to use the path component at index 1 as the input
 * parameter to node_load(). If the path is 'node/123', then $map will be the
 * array ('node', 123), and the returned array from this function will have
 * elements ('node_load', 123), since $map[1] is 123. This return value will
 * indicate specifically that node_load(123) is to be called to load the node
 * whose ID is 123 for this menu item.
 *
 * @param $data
 *   A serialized array of menu data, as read from the database.
 * @param $map
 *   A path argument array, used to replace integer values in $data; an integer
 *   value N in $data will be replaced by value $map[N]. Typically, the $map
 *   array is generated from a call to the arg() function.
398
 *
399
 * @return
400
 *   The unserialized $data array, with path arguments replaced.
401
 */
402 403 404 405 406 407 408 409
function menu_unserialize($data, $map) {
  if ($data = unserialize($data)) {
    foreach ($data as $k => $v) {
      if (is_int($v)) {
        $data[$k] = isset($map[$v]) ? $map[$v] : '';
      }
    }
    return $data;
410
  }
411 412
  else {
    return array();
413 414 415
  }
}

416 417


418
/**
419
 * Replaces the statically cached item for a given path.
420
 *
421
 * @param $path
422 423
 *   The path.
 * @param $router_item
424 425 426
 *   The router item. Usually a router entry from menu_get_item() is either
 *   modified or set to a different path. This allows the navigation block,
 *   the page title, the breadcrumb, and the page help to be modified in one
427
 *   call.
428
 */
429 430 431 432 433
function menu_set_item($path, $router_item) {
  menu_get_item($path, $router_item);
}

/**
434
 * Gets a router item.
435 436 437 438 439 440
 *
 * @param $path
 *   The path, for example node/5. The function will find the corresponding
 *   node/% item and return that.
 * @param $router_item
 *   Internal use only.
441
 *
442
 * @return
443 444 445 446 447 448 449
 *   The router item or, if an error occurs in _menu_translate(), FALSE. A
 *   router item is an associative array corresponding to one row in the
 *   menu_router table. The value corresponding to the key 'map' holds the
 *   loaded objects. The value corresponding to the key 'access' is TRUE if the
 *   current user can access this page. The values corresponding to the keys
 *   'title', 'page_arguments', 'access_arguments', and 'theme_arguments' will
 *   be filled in based on the database values and the objects loaded.
450 451
 */
function menu_get_item($path = NULL, $router_item = NULL) {
452
  $router_items = &drupal_static(__FUNCTION__);
453
  if (!isset($path)) {
454
    $path = current_path();
455
  }
456 457 458
  if (isset($router_item)) {
    $router_items[$path] = $router_item;
  }
459
  if (!isset($router_items[$path])) {
460 461
    // Rebuild if we know it's needed, or if the menu masks are missing which
    // occurs rarely, likely due to a race condition of multiple rebuilds.
462
    if (state()->get('menu_rebuild_needed') || !state()->get('menu.masks')) {
463
      menu_router_rebuild();
464
    }
465
    $original_map = arg(NULL, $path);
466

467 468 469 470
    $parts = array_slice($original_map, 0, MENU_MAX_PARTS);
    $ancestors = menu_get_ancestors($parts);
    $router_item = db_query_range('SELECT * FROM {menu_router} WHERE path IN (:ancestors) ORDER BY fit DESC', 0, 1, array(':ancestors' => $ancestors))->fetchAssoc();

471
    if ($router_item) {
472 473 474 475
      // Allow modules to alter the router item before it is translated and
      // checked for access.
      drupal_alter('menu_get_item', $router_item, $path, $original_map);

476
      $map = _menu_translate($router_item, $original_map);
477
      $router_item['original_map'] = $original_map;
478
      if ($map === FALSE) {
479
        $router_items[$path] = FALSE;
480
        return FALSE;
481
      }
482 483 484
      if ($router_item['access']) {
        $router_item['map'] = $map;
        $router_item['page_arguments'] = array_merge(menu_unserialize($router_item['page_arguments'], $map), array_slice($map, $router_item['number_parts']));
485
        $router_item['theme_arguments'] = array_merge(menu_unserialize($router_item['theme_arguments'], $map), array_slice($map, $router_item['number_parts']));
Dries's avatar
 
Dries committed
486 487
      }
    }
488
    $router_items[$path] = $router_item;
Dries's avatar
 
Dries committed
489
  }
490
  return $router_items[$path];
Dries's avatar
 
Dries committed
491 492
}

493
/**
494
 * Loads objects into the map as defined in the $item['load_functions'].
495
 *
496
 * @param $item
497
 *   A menu router or menu link item
498 499
 * @param $map
 *   An array of path arguments (ex: array('node', '5'))
500
 *
501
 * @return
502 503
 *   Returns TRUE for success, FALSE if an object cannot be loaded.
 *   Names of object loading functions are placed in $item['load_functions'].
504
 *   Loaded objects are placed in $map[]; keys are the same as keys in the
505 506
 *   $item['load_functions'] array.
 *   $item['access'] is set to FALSE if an object cannot be loaded.
507
 */
508 509 510
function _menu_load_objects(&$item, &$map) {
  if ($load_functions = $item['load_functions']) {
    // If someone calls this function twice, then unserialize will fail.
511 512
    if (!is_array($load_functions)) {
      $load_functions = unserialize($load_functions);
513
    }
514 515 516
    $path_map = $map;
    foreach ($load_functions as $index => $function) {
      if ($function) {
517 518 519 520 521 522 523
        $value = isset($path_map[$index]) ? $path_map[$index] : '';
        if (is_array($function)) {
          // Set up arguments for the load function. These were pulled from
          // 'load arguments' in the hook_menu() entry, but they need
          // some processing. In this case the $function is the key to the
          // load_function array, and the value is the list of arguments.
          list($function, $args) = each($function);
524
          $load_functions[$index] = $function;
525 526 527

          // Some arguments are placeholders for dynamic items to process.
          foreach ($args as $i => $arg) {
528
            if ($arg === '%index') {
529
              // Pass on argument index to the load function, so multiple
530
              // occurrences of the same placeholder can be identified.
531 532
              $args[$i] = $index;
            }
533
            if ($arg === '%map') {
534 535 536 537 538
              // Pass on menu map by reference. The accepting function must
              // also declare this as a reference if it wants to modify
              // the map.
              $args[$i] = &$map;
            }
539 540 541
            if (is_int($arg)) {
              $args[$i] = isset($path_map[$arg]) ? $path_map[$arg] : '';
            }
542 543 544 545 546 547 548
          }
          array_unshift($args, $value);
          $return = call_user_func_array($function, $args);
        }
        else {
          $return = $function($value);
        }
549 550
        // If callback returned an error or there is no callback, trigger 404.
        if ($return === FALSE) {
551
          $item['access'] = FALSE;
552
          $map = FALSE;
553
          return FALSE;
554 555 556 557
        }
        $map[$index] = $return;
      }
    }
558
    $item['load_functions'] = $load_functions;
559
  }
560 561 562 563
  return TRUE;
}

/**
564
 * Checks access to a menu item using the access callback.
565 566
 *
 * @param $item
567
 *   A menu router or menu link item
568 569
 * @param $map
 *   An array of path arguments (ex: array('node', '5'))
570
 *
571
 * @return
572
 *   $item['access'] becomes TRUE if the item is accessible, FALSE otherwise.
573 574
 */
function _menu_check_access(&$item, $map) {
575 576
  // Determine access callback, which will decide whether or not the current
  // user has access to this path.
577
  $callback = empty($item['access_callback']) ? 0 : trim($item['access_callback']);
578
  // Check for a TRUE or FALSE value.
579
  if (is_numeric($callback)) {
580
    $item['access'] = (bool) $callback;
Dries's avatar
 
Dries committed
581
  }
582
  else {
583
    $arguments = menu_unserialize($item['access_arguments'], $map);
584 585 586
    // As call_user_func_array is quite slow and user_access is a very common
    // callback, it is worth making a special case for it.
    if ($callback == 'user_access') {
587
      $item['access'] = (count($arguments) == 1) ? user_access($arguments[0]) : user_access($arguments[0], $arguments[1]);
588
    }
589
    else {
590
      $item['access'] = call_user_func_array($callback, $arguments);
591
    }
Dries's avatar
 
Dries committed
592
  }
593
}
594

595
/**
596
 * Localizes the router item title using t() or another callback.
597
 *
598 599 600 601 602 603 604 605 606 607 608 609 610
 * Translate the title and description to allow storage of English title
 * strings in the database, yet display of them in the language required
 * by the current user.
 *
 * @param $item
 *   A menu router item or a menu link item.
 * @param $map
 *   The path as an array with objects already replaced. E.g., for path
 *   node/123 $map would be array('node', $node) where $node is the node
 *   object for node 123.
 * @param $link_translate
 *   TRUE if we are translating a menu link item; FALSE if we are
 *   translating a menu router item.
611
 *
612 613 614
 * @return
 *   No return value.
 *   $item['title'] is localized according to $item['title_callback'].
615
 *   If an item's callback is check_plain(), $item['options']['html'] becomes
616
 *   TRUE.
617 618
 *   $item['description'] is computed using $item['description_callback'] if
 *   specified; otherwise it is translated using t().
619
 *   When doing link translation and the $item['options']['attributes']['title']
620
 *   (link title attribute) matches the description, it is translated as well.
621 622
 */
function _menu_item_localize(&$item, $map, $link_translate = FALSE) {
623
  $title_callback = $item['title_callback'];
624
  $item['localized_options'] = $item['options'];
625 626 627 628 629 630 631 632
  // All 'class' attributes are assumed to be an array during rendering, but
  // links stored in the database may use an old string value.
  // @todo In order to remove this code we need to implement a database update
  //   including unserializing all existing link options and running this code
  //   on them, as well as adding validation to menu_link_save().
  if (isset($item['options']['attributes']['class']) && is_string($item['options']['attributes']['class'])) {
    $item['localized_options']['attributes']['class'] = explode(' ', $item['options']['attributes']['class']);
  }
633 634 635 636 637 638 639
  // If we are translating the title of a menu link, and its title is the same
  // as the corresponding router item, then we can use the title information
  // from the router. If it's customized, then we need to use the link title
  // itself; can't localize.
  // If we are translating a router item (tabs, page, breadcrumb), then we
  // can always use the information from the router item.
  if (!$link_translate || ($item['title'] == $item['link_title'])) {
640 641
    // t() is a special case. Since it is used very close to all the time,
    // we handle it directly instead of using indirect, slower methods.
642
    if ($title_callback == 't') {
643 644 645 646 647 648
      if (empty($item['title_arguments'])) {
        $item['title'] = t($item['title']);
      }
      else {
        $item['title'] = t($item['title'], menu_unserialize($item['title_arguments'], $map));
      }
649
    }
650
    elseif ($title_callback) {
651
      if (empty($item['title_arguments'])) {
652
        $item['title'] = $title_callback($item['title']);
653 654
      }
      else {
655
        $item['title'] = call_user_func_array($title_callback, menu_unserialize($item['title_arguments'], $map));
656
      }
657
      // Avoid calling check_plain again on l() function.
658
      if ($title_callback == 'check_plain') {
659
        $item['localized_options']['html'] = TRUE;
660
      }
661 662
    }
  }
663 664
  elseif ($link_translate) {
    $item['title'] = $item['link_title'];
665 666 667
  }

  // Translate description, see the motivation above.
668
  if (!empty($item['description'])) {
669
    $original_description = $item['description'];
670 671 672 673 674 675 676 677 678 679 680
  }
  if (!empty($item['description_arguments']) || !empty($item['description'])) {
    $description_callback = $item['description_callback'];
    // If the description callback is t(), call it directly.
    if ($description_callback == 't') {
      if (empty($item['description_arguments'])) {
        $item['description'] = t($item['description']);
      }
      else {
        $item['description'] = t($item['description'], menu_unserialize($item['description_arguments'], $map));
      }
681
    }
682 683 684 685 686 687 688 689 690 691 692 693 694 695 696
    elseif ($description_callback) {
      // If there are no arguments, call the description callback directly.
      if (empty($item['description_arguments'])) {
        $item['description'] = $description_callback($item['description']);
      }
      // Otherwise, use call_user_func_array() to pass the arguments.
      else {
        $item['description'] = call_user_func_array($description_callback, menu_unserialize($item['description_arguments'], $map));
      }
    }
  }
  // If the title and description are the same, use the translated description
  // as a localized title.
  if ($link_translate && isset($original_description) && isset($item['options']['attributes']['title']) && $item['options']['attributes']['title'] == $original_description) {
    $item['localized_options']['attributes']['title'] = $item['description'];
697
  }
698 699 700 701 702 703 704 705 706 707 708 709 710 711 712
}

/**
 * Handles dynamic path translation and menu access control.
 *
 * When a user arrives on a page such as node/5, this function determines
 * what "5" corresponds to, by inspecting the page's menu path definition,
 * node/%node. This will call node_load(5) to load the corresponding node
 * object.
 *
 * It also works in reverse, to allow the display of tabs and menu items which
 * contain these dynamic arguments, translating node/%node to node/5.
 *
 * Translation of menu item titles and descriptions are done here to
 * allow for storage of English strings in the database, and translation
713
 * to the language required to generate the current page.
714
 *
715 716
 * @param $router_item
 *   A menu router item
717 718 719
 * @param $map
 *   An array of path arguments (ex: array('node', '5'))
 * @param $to_arg
720
 *   Execute $item['to_arg_functions'] or not. Use only if you want to render a
721
 *   path from the menu table, for example tabs.
722
 *
723 724
 * @return
 *   Returns the map with objects loaded as defined in the
725
 *   $item['load_functions']. $item['access'] becomes TRUE if the item is
726
 *   accessible, FALSE otherwise. $item['href'] is set according to the map.
727
 *   If an error occurs during calling the load_functions (like trying to load
728
 *   a non-existent node) then this function returns FALSE.
729
 */
730
function _menu_translate(&$router_item, $map, $to_arg = FALSE) {
731
  if ($to_arg && !empty($router_item['to_arg_functions'])) {
732 733 734 735 736
    // Fill in missing path elements, such as the current uid.
    _menu_link_map_translate($map, $router_item['to_arg_functions']);
  }
  // The $path_map saves the pieces of the path as strings, while elements in
  // $map may be replaced with loaded objects.
737
  $path_map = $map;
738
  if (!empty($router_item['load_functions']) && !_menu_load_objects($router_item, $map)) {
739
    // An error occurred loading an object.
740
    $router_item['access'] = FALSE;
741 742 743 744
    return FALSE;
  }

  // Generate the link path for the page request or local tasks.
745
  $link_map = explode('/', $router_item['path']);
746 747 748 749 750 751
  if (isset($router_item['tab_root'])) {
    $tab_root_map = explode('/', $router_item['tab_root']);
  }
  if (isset($router_item['tab_parent'])) {
    $tab_parent_map = explode('/', $router_item['tab_parent']);
  }
752
  for ($i = 0; $i < $router_item['number_parts']; $i++) {
753 754 755
    if ($link_map[$i] == '%') {
      $link_map[$i] = $path_map[$i];
    }
756 757 758 759 760 761
    if (isset($tab_root_map[$i]) && $tab_root_map[$i] == '%') {
      $tab_root_map[$i] = $path_map[$i];
    }
    if (isset($tab_parent_map[$i]) && $tab_parent_map[$i] == '%') {
      $tab_parent_map[$i] = $path_map[$i];
    }
762
  }
763
  $router_item['href'] = implode('/', $link_map);
764 765
  $router_item['tab_root_href'] = implode('/', $tab_root_map);
  $router_item['tab_parent_href'] = implode('/', $tab_parent_map);
766
  $router_item['options'] = array();
767
  _menu_check_access($router_item, $map);
768

769 770 771 772
  // For performance, don't localize an item the user can't access.
  if ($router_item['access']) {
    _menu_item_localize($router_item, $map);
  }
773 774 775 776 777

  return $map;
}

/**
778
 * Translates the path elements in the map using any to_arg helper function.
779
 *
780
 * @param $map
781 782
 *   An array of path arguments (ex: array('node', '5'))
 * @param $to_arg_functions
783
 *   An array of helper function (ex: array(2 => 'menu_tail_to_arg'))
784 785
 *
 * @see hook_menu()
786 787
 */
function _menu_link_map_translate(&$map, $to_arg_functions) {
788 789 790 791 792 793 794 795 796
  $to_arg_functions = unserialize($to_arg_functions);
  foreach ($to_arg_functions as $index => $function) {
    // Translate place-holders into real values.
    $arg = $function(!empty($map[$index]) ? $map[$index] : '', $map, $index);
    if (!empty($map[$index]) || isset($arg)) {
      $map[$index] = $arg;
    }
    else {
      unset($map[$index]);
797 798 799 800
    }
  }
}

801
/**
802
 * Returns a string containing the path relative to the current index.
803
 */
804 805 806 807
function menu_tail_to_arg($arg, $map, $index) {
  return implode('/', array_slice($map, $index));
}

808
/**
809
 * Loads the path as one string relative to the current index.
810 811 812 813 814 815 816 817 818 819 820 821 822 823 824
 *
 * To use this load function, you must specify the load arguments
 * in the router item as:
 * @code
 * $item['load arguments'] = array('%map', '%index');
 * @endcode
 *
 * @see search_menu().
 */
function menu_tail_load($arg, &$map, $index) {
  $arg = implode('/', array_slice($map, $index));
  $map = array_slice($map, 0, $index);
  return $arg;
}

825
/**
826 827 828 829
 * Provides menu link access control, translation, and argument handling.
 *
 * This function is similar to _menu_translate(), but it also does
 * link-specific preparation (such as always calling to_arg() functions).
830 831
 *
 * @param $item
832 833 834 835 836
 *   A menu link.
 * @param $translate
 *   (optional) Whether to try to translate a link containing dynamic path
 *   argument placeholders (%) based on the menu router item of the current
 *   path. Defaults to FALSE. Internally used for breadcrumbs.
837
 *
838 839
 * @return
 *   Returns the map of path arguments with objects loaded as defined in the
840 841 842 843
 *   $item['load_functions'].
 *   $item['access'] becomes TRUE if the item is accessible, FALSE otherwise.
 *   $item['href'] is generated from link_path, possibly by to_arg functions.
 *   $item['title'] is generated from link_title, and may be localized.
844
 *   $item['options'] is unserialized; it is also changed within the call here
845
 *   to $item['localized_options'] by _menu_item_localize().
846
 */
847 848 849 850
function _menu_link_translate(&$item, $translate = FALSE) {
  if (!is_array($item['options'])) {
    $item['options'] = unserialize($item['options']);
  }
851 852
  if ($item['external']) {
    $item['access'] = 1;
853
    $map = array();
854 855
    $item['href'] = $item['link_path'];
    $item['title'] = $item['link_title'];
856
    $item['localized_options'] = $item['options'];
857 858
  }
  else {
859 860
    // Complete the path of the menu link with elements from the current path,
    // if it contains dynamic placeholders (%).
861
    $map = explode('/', $item['link_path']);
862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888
    if (strpos($item['link_path'], '%') !== FALSE) {
      // Invoke registered to_arg callbacks.
      if (!empty($item['to_arg_functions'])) {
        _menu_link_map_translate($map, $item['to_arg_functions']);
      }
      // Or try to derive the path argument map from the current router item,
      // if this $item's path is within the router item's path. This means
      // that if we are on the current path 'foo/%/bar/%/baz', then
      // menu_get_item() will have translated the menu router item for the
      // current path, and we can take over the argument map for a link like
      // 'foo/%/bar'. This inheritance is only valid for breadcrumb links.
      // @see _menu_tree_check_access()
      // @see menu_get_active_breadcrumb()
      elseif ($translate && ($current_router_item = menu_get_item())) {
        // If $translate is TRUE, then this link is in the active trail.
        // Only translate paths within the current path.
        if (strpos($current_router_item['path'], $item['link_path']) === 0) {
          $count = count($map);
          $map = array_slice($current_router_item['original_map'], 0, $count);
          $item['original_map'] = $map;
          if (isset($current_router_item['map'])) {
            $item['map'] = array_slice($current_router_item['map'], 0, $count);
          }
          // Reset access to check it (for the first time).
          unset($item['access']);
        }
      }
889
    }
890
    $item['href'] = implode('/', $map);
891

892
    // Skip links containing untranslated arguments.
893 894
    if (strpos($item['href'], '%') !== FALSE) {
      $item['access'] = FALSE;
895 896
      return FALSE;
    }
897
    // menu_tree_check_access() may set this ahead of time for links to nodes.
898
    if (!isset($item['access'])) {
899
      if (!empty($item['load_functions']) && !_menu_load_objects($item, $map)) {
900
        // An error occurred loading an object.
901 902 903
        $item['access'] = FALSE;
        return FALSE;
      }
904 905
      _menu_check_access($item, $map);
    }
906 907 908 909
    // For performance, don't localize a link the user can't access.
    if ($item['access']) {
      _menu_item_localize($item, $map, TRUE);
    }
910
  }
911

912 913 914 915 916 917
  // Allow other customizations - e.g. adding a page-specific query string to the
  // options array. For performance reasons we only invoke this hook if the link
  // has the 'alter' flag set in the options array.
  if (!empty($item['options']['alter'])) {
    drupal_alter('translated_menu_link', $item, $map);
  }
918

919
  return $map;
Dries's avatar
 
Dries committed
920 921
}

922
/**
923
 * Gets a loaded object from a router item.
924
 *
925 926 927 928 929 930 931 932 933 934
 * menu_get_object() provides access to objects loaded by the current router
 * item. For example, on the page node/%node, the router loads the %node object,
 * and calling menu_get_object() will return that. Normally, it is necessary to
 * specify the type of object referenced, however node is the default.
 * The following example tests to see whether the node being displayed is of the
 * "story" content type:
 * @code
 * $node = menu_get_object();
 * $story = $node->type == 'story';
 * @endcode
935 936
 *
 * @param $type
937
 *   Type of the object. These appear in hook_menu definitions as %type. Core
938 939