menu.inc 134 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\Core\Cache\CacheBackendInterface;
9 10
use Drupal\Core\Template\Attribute;

Dries's avatar
 
Dries committed
11 12 13
/**
 * @defgroup menu Menu system
 * @{
Dries's avatar
 
Dries committed
14
 * Define the navigation menus, and route page requests to code based on URLs.
Dries's avatar
 
Dries committed
15 16 17 18
 *
 * 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
19 20 21 22
 * 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
23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44
 *
 * 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
45
 * The found callback function is called with any arguments specified
46
 * in the "page arguments" attribute of its menu item. The
Steven Wittens's avatar
Steven Wittens committed
47 48 49 50
 * 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
51 52 53 54
 *
 * For an illustration of this process, see page_example.module.
 *
 * Access to the callback functions is also protected by the menu system.
55 56
 * The "access callback" with an optional "access arguments" of each menu
 * item is called before the page callback proceeds. If this returns TRUE,
57 58 59
 * 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
60 61 62 63 64 65 66 67 68 69 70 71 72
 *
 * 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.
73 74 75
 *
 * Everything described so far is stored in the menu_router table. The
 * menu_links table holds the visible menu links. By default these are
76
 * derived from the same hook_menu definitions, however you are free to
77
 * add more with menu_link_save().
Dries's avatar
 
Dries committed
78 79
 */

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

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

/**
 * Internal menu flag -- menu item is visible in the menu tree.
 */
94
const MENU_VISIBLE_IN_TREE = 0x0002;
95 96 97 98

/**
 * Internal menu flag -- menu item is visible in the breadcrumb.
 */
99
const MENU_VISIBLE_IN_BREADCRUMB = 0x0004;
100 101

/**
102
 * Internal menu flag -- menu item links back to its parent.
103
 */
104
const MENU_LINKS_TO_PARENT = 0x0008;
105 106 107 108

/**
 * Internal menu flag -- menu item can be modified by administrator.
 */
109
const MENU_MODIFIED_BY_ADMIN = 0x0020;
110 111 112 113

/**
 * Internal menu flag -- menu item was created by administrator.
 */
114
const MENU_CREATED_BY_ADMIN = 0x0040;
115 116 117 118

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

121 122 123
/**
 * Internal menu flag -- menu item is a local action.
 */
124
const MENU_IS_LOCAL_ACTION = 0x0100;
125

Dries's avatar
 
Dries committed
126
/**
127
 * @} End of "defgroup menu_flags".
Dries's avatar
 
Dries committed
128 129 130
 */

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

Dries's avatar
 
Dries committed
139
/**
140 141
 * Menu type -- A "normal" menu item that's shown in menu and breadcrumbs.
 *
Dries's avatar
 
Dries committed
142
 * Normal menu items show up in the menu tree and can be moved/hidden by
Dries's avatar
 
Dries committed
143 144
 * 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
145
 */
146
define('MENU_NORMAL_ITEM', MENU_VISIBLE_IN_TREE | MENU_VISIBLE_IN_BREADCRUMB);
147

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

Dries's avatar
 
Dries committed
156
/**
157 158
 * Menu type -- A normal menu item, hidden until enabled by an administrator.
 *
Dries's avatar
 
Dries committed
159 160
 * 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.
161 162
 * 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
163
 */
164
define('MENU_SUGGESTED_ITEM', MENU_VISIBLE_IN_BREADCRUMB | 0x0010);
Dries's avatar
 
Dries committed
165 166

/**
167 168 169 170 171
 * 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
172
 */
173
define('MENU_LOCAL_TASK', MENU_IS_LOCAL_TASK | MENU_VISIBLE_IN_BREADCRUMB);
Dries's avatar
 
Dries committed
174

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

183 184 185 186 187 188
/**
 * 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.
 */
189
define('MENU_LOCAL_ACTION', MENU_IS_LOCAL_TASK | MENU_IS_LOCAL_ACTION | MENU_VISIBLE_IN_BREADCRUMB);
190

Dries's avatar
 
Dries committed
191
/**
192
 * @} End of "defgroup menu_item_types".
Dries's avatar
 
Dries committed
193 194
 */

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

201 202 203 204 205 206
/**
 * 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.
 */
207
const MENU_CONTEXT_NONE = 0x0000;
208

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

/**
 * Internal menu flag: Local task should be displayed inline.
 */
217
const MENU_CONTEXT_INLINE = 0x0002;
218 219

/**
220
 * @} End of "defgroup menu_context_types".
221 222
 */

Dries's avatar
 
Dries committed
223
/**
224
 * @defgroup menu_status_codes Menu status codes
Dries's avatar
 
Dries committed
225
 * @{
Dries's avatar
 
Dries committed
226 227
 * Status codes for menu callbacks.
 */
Dries's avatar
 
Dries committed
228

229 230 231
/**
 * Internal menu status code -- Menu item was not found.
 */
232
const MENU_NOT_FOUND = 404;
233 234 235 236

/**
 * Internal menu status code -- Menu item access is denied.
 */
237
const MENU_ACCESS_DENIED = 403;
238 239 240 241

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

244 245 246
/**
 * Internal menu status code -- Everything is working fine.
 */
247
const MENU_SITE_ONLINE = 5;
248

Dries's avatar
 
Dries committed
249
/**
250
 * @} End of "defgroup menu_status_codes".
Dries's avatar
 
Dries committed
251
 */
252

253
/**
254
 * @defgroup menu_tree_parameters Menu tree parameters
255
 * @{
256
 * Parameters for a menu tree.
257 258
 */

259 260
 /**
 * The maximum number of path elements for a menu callback
261
 */
262
const MENU_MAX_PARTS = 9;
263

264 265

/**
266
 * The maximum depth of a menu links tree - matches the number of p columns.
267
 */
268
const MENU_MAX_DEPTH = 9;
269

270 271

/**
272
 * @} End of "defgroup menu_tree_parameters".
273 274
 */

275 276 277 278 279 280 281 282 283 284 285 286 287 288
/**
 * 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';

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

/**
362
 * Unserializes menu data, using a map to replace path elements.
Dries's avatar
 
Dries committed
363
 *
364 365 366 367 368 369
 * 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.
370
 *
371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391
 * 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.
392
 *
393
 * @return
394
 *   The unserialized $data array, with path arguments replaced.
395
 */
396 397 398 399 400 401 402 403
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;
404
  }
405 406
  else {
    return array();
407 408 409
  }
}

410 411


412
/**
413
 * Replaces the statically cached item for a given path.
414
 *
415
 * @param $path
416 417
 *   The path.
 * @param $router_item
418 419 420
 *   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
421
 *   call.
422
 */
423 424 425 426 427
function menu_set_item($path, $router_item) {
  menu_get_item($path, $router_item);
}

/**
428
 * Gets a router item.
429 430 431 432 433 434
 *
 * @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.
435
 *
436
 * @return
437 438 439 440 441 442 443
 *   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.
444 445
 */
function menu_get_item($path = NULL, $router_item = NULL) {
446
  $router_items = &drupal_static(__FUNCTION__);
447
  if (!isset($path)) {
448
    $path = current_path();
449
  }
450 451 452
  if (isset($router_item)) {
    $router_items[$path] = $router_item;
  }
453
  if (!isset($router_items[$path])) {
454 455
    // 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.
456
    if (state()->get('menu_rebuild_needed') || !state()->get('menu.masks')) {
457
      menu_router_rebuild();
458
    }
459
    $original_map = arg(NULL, $path);
460

461 462 463 464
    $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();

465
    if ($router_item) {
466 467 468 469
      // 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);

470
      $map = _menu_translate($router_item, $original_map);
471
      $router_item['original_map'] = $original_map;
472
      if ($map === FALSE) {
473
        $router_items[$path] = FALSE;
474
        return FALSE;
475
      }
476 477 478
      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']));
479
        $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
480 481
      }
    }
482
    $router_items[$path] = $router_item;
Dries's avatar
 
Dries committed
483
  }
484
  return $router_items[$path];
Dries's avatar
 
Dries committed
485 486
}

487
/**
488
 * Loads objects into the map as defined in the $item['load_functions'].
489
 *
490
 * @param $item
491
 *   A menu router or menu link item
492 493
 * @param $map
 *   An array of path arguments (ex: array('node', '5'))
494
 *
495
 * @return
496 497
 *   Returns TRUE for success, FALSE if an object cannot be loaded.
 *   Names of object loading functions are placed in $item['load_functions'].
498
 *   Loaded objects are placed in $map[]; keys are the same as keys in the
499 500
 *   $item['load_functions'] array.
 *   $item['access'] is set to FALSE if an object cannot be loaded.
501
 */
502 503 504
function _menu_load_objects(&$item, &$map) {
  if ($load_functions = $item['load_functions']) {
    // If someone calls this function twice, then unserialize will fail.
505 506
    if (!is_array($load_functions)) {
      $load_functions = unserialize($load_functions);
507
    }
508 509 510
    $path_map = $map;
    foreach ($load_functions as $index => $function) {
      if ($function) {
511 512 513 514 515 516 517
        $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);
518
          $load_functions[$index] = $function;
519 520 521

          // Some arguments are placeholders for dynamic items to process.
          foreach ($args as $i => $arg) {
522
            if ($arg === '%index') {
523
              // Pass on argument index to the load function, so multiple
524
              // occurrences of the same placeholder can be identified.
525 526
              $args[$i] = $index;
            }
527
            if ($arg === '%map') {
528 529 530 531 532
              // 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;
            }
533 534 535
            if (is_int($arg)) {
              $args[$i] = isset($path_map[$arg]) ? $path_map[$arg] : '';
            }
536 537 538 539 540 541 542
          }
          array_unshift($args, $value);
          $return = call_user_func_array($function, $args);
        }
        else {
          $return = $function($value);
        }
543 544
        // If callback returned an error or there is no callback, trigger 404.
        if ($return === FALSE) {
545
          $item['access'] = FALSE;
546
          $map = FALSE;
547
          return FALSE;
548 549 550 551
        }
        $map[$index] = $return;
      }
    }
552
    $item['load_functions'] = $load_functions;
553
  }
554 555 556 557
  return TRUE;
}

/**
558
 * Checks access to a menu item using the access callback.
559 560
 *
 * @param $item
561
 *   A menu router or menu link item
562 563
 * @param $map
 *   An array of path arguments (ex: array('node', '5'))
564
 *
565
 * @return
566
 *   $item['access'] becomes TRUE if the item is accessible, FALSE otherwise.
567 568
 */
function _menu_check_access(&$item, $map) {
569 570
  // Determine access callback, which will decide whether or not the current
  // user has access to this path.
571
  $callback = empty($item['access_callback']) ? 0 : trim($item['access_callback']);
572
  // Check for a TRUE or FALSE value.
573
  if (is_numeric($callback)) {
574
    $item['access'] = (bool) $callback;
Dries's avatar
 
Dries committed
575
  }
576
  else {
577
    $arguments = menu_unserialize($item['access_arguments'], $map);
578 579 580
    // 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') {
581
      $item['access'] = (count($arguments) == 1) ? user_access($arguments[0]) : user_access($arguments[0], $arguments[1]);
582
    }
583
    else {
584
      $item['access'] = call_user_func_array($callback, $arguments);
585
    }
Dries's avatar
 
Dries committed
586
  }
587
}
588

589
/**
590
 * Localizes the router item title using t() or another callback.
591
 *
592 593 594 595 596 597 598 599 600 601 602 603 604
 * 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.
605
 *
606 607 608
 * @return
 *   No return value.
 *   $item['title'] is localized according to $item['title_callback'].
609
 *   If an item's callback is check_plain(), $item['options']['html'] becomes
610
 *   TRUE.
611 612
 *   $item['description'] is computed using $item['description_callback'] if
 *   specified; otherwise it is translated using t().
613
 *   When doing link translation and the $item['options']['attributes']['title']
614
 *   (link title attribute) matches the description, it is translated as well.
615 616
 */
function _menu_item_localize(&$item, $map, $link_translate = FALSE) {
617
  $title_callback = $item['title_callback'];
618
  $item['localized_options'] = $item['options'];
619 620 621 622 623 624 625 626
  // 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']);
  }
627 628 629 630 631 632 633
  // 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'])) {
634 635
    // 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.
636
    if ($title_callback == 't') {
637 638 639 640 641 642
      if (empty($item['title_arguments'])) {
        $item['title'] = t($item['title']);
      }
      else {
        $item['title'] = t($item['title'], menu_unserialize($item['title_arguments'], $map));
      }
643
    }
644
    elseif ($title_callback) {
645
      if (empty($item['title_arguments'])) {
646
        $item['title'] = $title_callback($item['title']);
647 648
      }
      else {
649
        $item['title'] = call_user_func_array($title_callback, menu_unserialize($item['title_arguments'], $map));
650
      }
651
      // Avoid calling check_plain again on l() function.
652
      if ($title_callback == 'check_plain') {
653
        $item['localized_options']['html'] = TRUE;
654
      }
655 656
    }
  }
657 658
  elseif ($link_translate) {
    $item['title'] = $item['link_title'];
659 660 661
  }

  // Translate description, see the motivation above.
662
  if (!empty($item['description'])) {
663
    $original_description = $item['description'];
664 665 666 667 668 669 670 671 672 673 674
  }
  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));
      }
675
    }
676 677 678 679 680 681 682 683 684 685 686 687 688 689 690
    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'];
691
  }
692 693 694 695 696 697 698 699 700 701 702 703 704 705 706
}

/**
 * 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
707
 * to the language required to generate the current page.
708
 *
709 710
 * @param $router_item
 *   A menu router item
711 712 713
 * @param $map
 *   An array of path arguments (ex: array('node', '5'))
 * @param $to_arg
714
 *   Execute $item['to_arg_functions'] or not. Use only if you want to render a
715
 *   path from the menu table, for example tabs.
716
 *
717 718
 * @return
 *   Returns the map with objects loaded as defined in the
719
 *   $item['load_functions']. $item['access'] becomes TRUE if the item is
720
 *   accessible, FALSE otherwise. $item['href'] is set according to the map.
721
 *   If an error occurs during calling the load_functions (like trying to load
722
 *   a non-existent node) then this function returns FALSE.
723
 */
724
function _menu_translate(&$router_item, $map, $to_arg = FALSE) {
725
  if ($to_arg && !empty($router_item['to_arg_functions'])) {
726 727 728 729 730
    // 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.
731
  $path_map = $map;
732
  if (!empty($router_item['load_functions']) && !_menu_load_objects($router_item, $map)) {
733
    // An error occurred loading an object.
734
    $router_item['access'] = FALSE;
735 736 737 738
    return FALSE;
  }

  // Generate the link path for the page request or local tasks.
739
  $link_map = explode('/', $router_item['path']);
740 741 742 743 744 745
  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']);
  }
746
  for ($i = 0; $i < $router_item['number_parts']; $i++) {
747 748 749
    if ($link_map[$i] == '%') {
      $link_map[$i] = $path_map[$i];
    }
750 751 752 753 754 755
    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];
    }
756
  }
757
  $router_item['href'] = implode('/', $link_map);
758 759
  $router_item['tab_root_href'] = implode('/', $tab_root_map);
  $router_item['tab_parent_href'] = implode('/', $tab_parent_map);
760
  $router_item['options'] = array();
761
  _menu_check_access($router_item, $map);
762

763 764 765 766
  // For performance, don't localize an item the user can't access.
  if ($router_item['access']) {
    _menu_item_localize($router_item, $map);
  }
767 768 769 770 771

  return $map;
}

/**
772
 * Translates the path elements in the map using any to_arg helper function.
773
 *
774
 * @param $map
775 776
 *   An array of path arguments (ex: array('node', '5'))
 * @param $to_arg_functions
777
 *   An array of helper function (ex: array(2 => 'menu_tail_to_arg'))
778 779
 *
 * @see hook_menu()
780 781
 */
function _menu_link_map_translate(&$map, $to_arg_functions) {
782 783 784 785 786 787 788 789 790
  $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]);
791 792 793 794
    }
  }
}

795
/**
796
 * Returns a string containing the path relative to the current index.
797
 */
798 799 800 801
function menu_tail_to_arg($arg, $map, $index) {
  return implode('/', array_slice($map, $index));
}

802
/**
803
 * Loads the path as one string relative to the current index.
804 805 806 807 808 809 810 811 812 813 814 815 816 817 818
 *
 * 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;
}

819
/**
820 821 822 823
 * 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).
824 825
 *
 * @param $item
826 827 828 829 830
 *   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.
831
 *
832 833
 * @return
 *   Returns the map of path arguments with objects loaded as defined in the
834 835 836 837
 *   $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.
838
 *   $item['options'] is unserialized; it is also changed within the call here
839
 *   to $item['localized_options'] by _menu_item_localize().
840
 */
841 842 843 844
function _menu_link_translate(&$item, $translate = FALSE) {
  if (!is_array($item['options'])) {
    $item['options'] = unserialize($item['options']);
  }
845 846
  if ($item['external']) {
    $item['access'] = 1;
847
    $map = array();
848 849
    $item['href'] = $item['link_path'];
    $item['title'] = $item['link_title'];
850
    $item['localized_options'] = $item['options'];
851 852
  }
  else {
853 854
    // Complete the path of the menu link with elements from the current path,
    // if it contains dynamic placeholders (%).
855
    $map = explode('/', $item['link_path']);
856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882
    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']);
        }
      }
883
    }
884
    $item['href'] = implode('/', $map);
885

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

906 907 908 909 910 911
  // 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);
  }
912

913
  return $map;
Dries's avatar
 
Dries committed
914 915
}

916
/**
917
 * Gets a loaded object from a router item.
918
 *
919 920 921 922 923 924 925 926 927 928
 * 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
929 930
 *
 * @param $type
931
 *   Type of the object. These appear in hook_menu definitions as %type. Core
932 933 934 935
 *   provides aggregator_feed, aggregator_category, contact, filter_format,
 *   forum_term, menu, menu_link, node, taxonomy_vocabulary, user. See the
 *   relevant {$type}_load function for more on each. Defaults to node.
 * @param $position
936 937 938
 *   The position of the object in the path, where the first path segment is 0.
 *   For node/%node, the position of %node is 1, but for comment/reply/%node,
 *   it's 2. Defaults to 1.
939
 * @param $path
940
 *   See menu_get_item() for more on this. Defaults to the current path.