menu.inc 123 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\Language\Language;
11
use Drupal\Core\Template\Attribute;
12 13
use Drupal\menu_link\Plugin\Core\Entity\MenuLink;
use Drupal\menu_link\MenuLinkStorageController;
14 15
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;
16
use Symfony\Component\Routing\Route;
17

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

Dries's avatar
 
Dries committed
87
/**
88
 * @defgroup menu_flags Menu flags
Dries's avatar
 
Dries committed
89
 * @{
Dries's avatar
 
Dries committed
90 91
 * Flags for use in the "type" attribute of menu items.
 */
Dries's avatar
 
Dries committed
92

93 94 95
/**
 * Internal menu flag -- menu item is the root of the menu tree.
 */
96
const MENU_IS_ROOT = 0x0001;
97 98 99 100

/**
 * Internal menu flag -- menu item is visible in the menu tree.
 */
101
const MENU_VISIBLE_IN_TREE = 0x0002;
102 103 104 105

/**
 * Internal menu flag -- menu item is visible in the breadcrumb.
 */
106
const MENU_VISIBLE_IN_BREADCRUMB = 0x0004;
107 108

/**
109
 * Internal menu flag -- menu item links back to its parent.
110
 */
111
const MENU_LINKS_TO_PARENT = 0x0008;
112 113 114 115

/**
 * Internal menu flag -- menu item can be modified by administrator.
 */
116
const MENU_MODIFIED_BY_ADMIN = 0x0020;
117 118 119 120

/**
 * Internal menu flag -- menu item was created by administrator.
 */
121
const MENU_CREATED_BY_ADMIN = 0x0040;
122 123 124 125

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

128 129 130
/**
 * Internal menu flag -- menu item is a local action.
 */
131
const MENU_IS_LOCAL_ACTION = 0x0100;
132

Dries's avatar
 
Dries committed
133
/**
134
 * @} End of "defgroup menu_flags".
Dries's avatar
 
Dries committed
135 136 137
 */

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

Dries's avatar
 
Dries committed
146
/**
147 148
 * Menu type -- A "normal" menu item that's shown in menu and breadcrumbs.
 *
Dries's avatar
 
Dries committed
149
 * Normal menu items show up in the menu tree and can be moved/hidden by
Dries's avatar
 
Dries committed
150 151
 * 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
152
 */
153
define('MENU_NORMAL_ITEM', MENU_VISIBLE_IN_TREE | MENU_VISIBLE_IN_BREADCRUMB);
154

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

Dries's avatar
 
Dries committed
163
/**
164 165
 * Menu type -- A normal menu item, hidden until enabled by an administrator.
 *
Dries's avatar
 
Dries committed
166 167
 * 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.
168 169
 * 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
170
 */
171
define('MENU_SUGGESTED_ITEM', MENU_VISIBLE_IN_BREADCRUMB | 0x0010);
Dries's avatar
 
Dries committed
172 173

/**
174 175 176 177 178
 * 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
179
 */
180
define('MENU_LOCAL_TASK', MENU_IS_LOCAL_TASK | MENU_VISIBLE_IN_BREADCRUMB);
Dries's avatar
 
Dries committed
181

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

190 191 192 193 194 195
/**
 * 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.
 */
196
define('MENU_LOCAL_ACTION', MENU_IS_LOCAL_TASK | MENU_IS_LOCAL_ACTION | MENU_VISIBLE_IN_BREADCRUMB);
197

198 199 200 201 202 203 204 205
/**
 * Menu type -- A task specific to the parent, which is never rendered.
 *
 * Sibling local tasks are not rendered themselves, but affect the breadcrumb
 * trail and need their sibling tasks rendered as tabs.
 */
define('MENU_SIBLING_LOCAL_TASK', MENU_IS_LOCAL_TASK | MENU_IS_LOCAL_ACTION | MENU_VISIBLE_IN_BREADCRUMB);

Dries's avatar
 
Dries committed
206
/**
207
 * @} End of "defgroup menu_item_types".
Dries's avatar
 
Dries committed
208 209
 */

210
/**
211
 * @defgroup menu_context_types Menu context types
212 213 214 215
 * @{
 * Flags for use in the "context" attribute of menu router items.
 */

216 217 218 219 220 221
/**
 * 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.
 */
222
const MENU_CONTEXT_NONE = 0x0000;
223

224 225 226
/**
 * Internal menu flag: Local task should be displayed in page context.
 */
227
const MENU_CONTEXT_PAGE = 0x0001;
228 229 230 231

/**
 * Internal menu flag: Local task should be displayed inline.
 */
232
const MENU_CONTEXT_INLINE = 0x0002;
233 234

/**
235
 * @} End of "defgroup menu_context_types".
236 237
 */

Dries's avatar
 
Dries committed
238
/**
239
 * @defgroup menu_status_codes Menu status codes
Dries's avatar
 
Dries committed
240
 * @{
Dries's avatar
 
Dries committed
241 242
 * Status codes for menu callbacks.
 */
Dries's avatar
 
Dries committed
243

244 245 246
/**
 * Internal menu status code -- Menu item was not found.
 */
247
const MENU_NOT_FOUND = 404;
248 249 250 251

/**
 * Internal menu status code -- Menu item access is denied.
 */
252
const MENU_ACCESS_DENIED = 403;
253 254 255 256

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

259 260 261
/**
 * Internal menu status code -- Everything is working fine.
 */
262
const MENU_SITE_ONLINE = 5;
263

Dries's avatar
 
Dries committed
264
/**
265
 * @} End of "defgroup menu_status_codes".
Dries's avatar
 
Dries committed
266
 */
267

268
/**
269
 * @defgroup menu_tree_parameters Menu tree parameters
270
 * @{
271
 * Parameters for a menu tree.
272 273
 */

274 275
 /**
 * The maximum number of path elements for a menu callback
276
 */
277
const MENU_MAX_PARTS = 9;
278

279 280

/**
281
 * The maximum depth of a menu links tree - matches the number of p columns.
282 283 284
 *
 * @todo Move this constant to MenuLinkStorageController along with all the tree
 * functionality.
285
 */
286
const MENU_MAX_DEPTH = 9;
287

288 289

/**
290
 * @} End of "defgroup menu_tree_parameters".
291 292
 */

293 294 295 296 297 298 299 300 301 302 303 304 305 306
/**
 * 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';

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

/**
380
 * Unserializes menu data, using a map to replace path elements.
Dries's avatar
 
Dries committed
381
 *
382 383 384 385 386 387
 * 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.
388
 *
389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409
 * 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.
410
 *
411
 * @return
412
 *   The unserialized $data array, with path arguments replaced.
413
 */
414 415 416 417 418 419 420 421
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;
422
  }
423 424
  else {
    return array();
425 426 427
  }
}

428 429


430
/**
431
 * Replaces the statically cached item for a given path.
432
 *
433
 * @param $path
434 435
 *   The path.
 * @param $router_item
436 437 438
 *   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
439
 *   call.
440
 */
441 442 443 444 445
function menu_set_item($path, $router_item) {
  menu_get_item($path, $router_item);
}

/**
446
 * Gets a router item.
447 448
 *
 * @param $path
449
 *   The path; for example, 'node/5'. The function will find the corresponding
450 451 452
 *   node/% item and return that.
 * @param $router_item
 *   Internal use only.
453
 *
454
 * @return
455 456 457 458 459 460 461
 *   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.
462 463
 */
function menu_get_item($path = NULL, $router_item = NULL) {
464
  $router_items = &drupal_static(__FUNCTION__);
465
  if (!isset($path)) {
466
    $path = current_path();
467
  }
468 469 470
  if (isset($router_item)) {
    $router_items[$path] = $router_item;
  }
471
  if (!isset($router_items[$path])) {
472 473
    // 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.
474
    if (Drupal::state()->get('menu_rebuild_needed') || !Drupal::state()->get('menu.masks')) {
475
      menu_router_rebuild();
476
    }
477
    $original_map = arg(NULL, $path);
478

479 480 481 482
    $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();

483
    if ($router_item) {
484 485 486 487
      // 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);

488
      $map = _menu_translate($router_item, $original_map);
489
      $router_item['original_map'] = $original_map;
490
      if ($map === FALSE) {
491
        $router_items[$path] = FALSE;
492
        return FALSE;
493
      }
494 495 496
      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']));
497
        $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
498 499
      }
    }
500
    $router_items[$path] = $router_item;
Dries's avatar
 
Dries committed
501
  }
502
  return $router_items[$path];
Dries's avatar
 
Dries committed
503 504
}

505
/**
506
 * Loads objects into the map as defined in the $item['load_functions'].
507
 *
508
 * @param $item
509
 *   A menu router or menu link item
510
 * @param $map
511
 *   An array of path arguments; for example, array('node', '5').
512
 *
513
 * @return
514 515
 *   Returns TRUE for success, FALSE if an object cannot be loaded.
 *   Names of object loading functions are placed in $item['load_functions'].
516
 *   Loaded objects are placed in $map[]; keys are the same as keys in the
517 518
 *   $item['load_functions'] array.
 *   $item['access'] is set to FALSE if an object cannot be loaded.
519
 */
520 521 522
function _menu_load_objects(&$item, &$map) {
  if ($load_functions = $item['load_functions']) {
    // If someone calls this function twice, then unserialize will fail.
523 524
    if (!is_array($load_functions)) {
      $load_functions = unserialize($load_functions);
525
    }
526 527 528
    $path_map = $map;
    foreach ($load_functions as $index => $function) {
      if ($function) {
529 530 531 532 533 534 535
        $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);
536
          $load_functions[$index] = $function;
537 538 539

          // Some arguments are placeholders for dynamic items to process.
          foreach ($args as $i => $arg) {
540
            if ($arg === '%index') {
541
              // Pass on argument index to the load function, so multiple
542
              // occurrences of the same placeholder can be identified.
543 544
              $args[$i] = $index;
            }
545
            if ($arg === '%map') {
546 547 548 549 550
              // 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;
            }
551 552 553
            if (is_int($arg)) {
              $args[$i] = isset($path_map[$arg]) ? $path_map[$arg] : '';
            }
554 555 556 557 558 559 560
          }
          array_unshift($args, $value);
          $return = call_user_func_array($function, $args);
        }
        else {
          $return = $function($value);
        }
561
        // If callback returned an error or there is no callback, trigger 404.
562
        if (empty($return)) {
563
          $item['access'] = FALSE;
564
          $map = FALSE;
565
          return FALSE;
566 567 568 569
        }
        $map[$index] = $return;
      }
    }
570
    $item['load_functions'] = $load_functions;
571
  }
572 573 574 575
  return TRUE;
}

/**
576
 * Checks access to a menu item using the access callback.
577 578
 *
 * @param $item
579
 *   A menu router or menu link item
580
 * @param $map
581
 *   An array of path arguments; for example, array('node', '5').
582
 *
583
 * @return
584
 *   $item['access'] becomes TRUE if the item is accessible, FALSE otherwise.
585 586
 */
function _menu_check_access(&$item, $map) {
587 588
  // Determine access callback, which will decide whether or not the current
  // user has access to this path.
589
  $callback = empty($item['access_callback']) ? 0 : trim($item['access_callback']);
590
  // Check for a TRUE or FALSE value.
591
  if (is_numeric($callback)) {
592
    $item['access'] = (bool) $callback;
Dries's avatar
 
Dries committed
593
  }
594
  else {
595
    $arguments = menu_unserialize($item['access_arguments'], $map);
596 597 598
    // 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') {
599
      $item['access'] = (count($arguments) == 1) ? user_access($arguments[0]) : user_access($arguments[0], $arguments[1]);
600
    }
601
    else {
602
      $item['access'] = call_user_func_array($callback, $arguments);
603
    }
Dries's avatar
 
Dries committed
604
  }
605
}
606

607
/**
608
 * Localizes the router item title using t() or another callback.
609
 *
610 611 612 613 614 615 616 617 618 619 620 621 622
 * 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.
623
 *
624 625 626
 * @return
 *   No return value.
 *   $item['title'] is localized according to $item['title_callback'].
627
 *   If an item's callback is check_plain(), $item['options']['html'] becomes
628
 *   TRUE.
629 630
 *   $item['description'] is computed using $item['description_callback'] if
 *   specified; otherwise it is translated using t().
631
 *   When doing link translation and the $item['options']['attributes']['title']
632
 *   (link title attribute) matches the description, it is translated as well.
633 634
 */
function _menu_item_localize(&$item, $map, $link_translate = FALSE) {
635
  $title_callback = $item['title_callback'];
636
  $item['localized_options'] = $item['options'];
637 638 639 640 641 642 643 644
  // 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']);
  }
645 646 647 648 649 650 651
  // 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'])) {
652 653
    // 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.
654
    if ($title_callback == 't') {
655 656 657 658 659 660
      if (empty($item['title_arguments'])) {
        $item['title'] = t($item['title']);
      }
      else {
        $item['title'] = t($item['title'], menu_unserialize($item['title_arguments'], $map));
      }
661
    }
662
    elseif ($title_callback) {
663
      if (empty($item['title_arguments'])) {
664
        $item['title'] = $title_callback($item['title']);
665 666
      }
      else {
667
        $item['title'] = call_user_func_array($title_callback, menu_unserialize($item['title_arguments'], $map));
668
      }
669
      // Avoid calling check_plain again on l() function.
670
      if ($title_callback == 'check_plain') {
671
        $item['localized_options']['html'] = TRUE;
672
      }
673 674
    }
  }
675 676
  elseif ($link_translate) {
    $item['title'] = $item['link_title'];
677 678 679
  }

  // Translate description, see the motivation above.
680
  if (!empty($item['description'])) {
681
    $original_description = $item['description'];
682 683 684 685 686 687 688 689 690 691 692
  }
  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));
      }
693
    }
694 695 696 697 698 699 700 701 702 703 704 705 706 707 708
    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'];
709
  }
710 711 712 713 714 715 716 717 718 719 720 721 722 723 724
}

/**
 * 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
725
 * to the language required to generate the current page.
726
 *
727 728
 * @param $router_item
 *   A menu router item
729
 * @param $map
730
 *   An array of path arguments; for example, array('node', '5').
731
 * @param $to_arg
732
 *   Execute $item['to_arg_functions'] or not. Use only if you want to render a
733
 *   path from the menu table, for example tabs.
734
 *
735 736
 * @return
 *   Returns the map with objects loaded as defined in the
737
 *   $item['load_functions']. $item['access'] becomes TRUE if the item is
738
 *   accessible, FALSE otherwise. $item['href'] is set according to the map.
739
 *   If an error occurs during calling the load_functions (like trying to load
740
 *   a non-existent node) then this function returns FALSE.
741
 */
742
function _menu_translate(&$router_item, $map, $to_arg = FALSE) {
743
  if ($to_arg && !empty($router_item['to_arg_functions'])) {
744 745 746 747 748
    // 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.
749
  $path_map = $map;
750
  if (!empty($router_item['load_functions']) && !_menu_load_objects($router_item, $map)) {
751
    // An error occurred loading an object.
752
    $router_item['access'] = FALSE;
753 754 755 756
    return FALSE;
  }

  // Generate the link path for the page request or local tasks.
757
  $link_map = explode('/', $router_item['path']);
758 759 760 761 762 763
  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']);
  }
764
  for ($i = 0; $i < $router_item['number_parts']; $i++) {
765 766 767
    if ($link_map[$i] == '%') {
      $link_map[$i] = $path_map[$i];
    }
768 769 770 771 772 773
    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];
    }
774
  }
775
  $router_item['href'] = implode('/', $link_map);
776 777
  $router_item['tab_root_href'] = implode('/', $tab_root_map);
  $router_item['tab_parent_href'] = implode('/', $tab_parent_map);
778
  $router_item['options'] = array();
779
  if (!empty($router_item['route_name'])) {
780 781 782 783
    // Route-provided menu items do not have menu loaders, so replace the map
    // with the link map.
    $map = $link_map;

784 785
    $route_provider = Drupal::getContainer()->get('router.route_provider');
    $route = $route_provider->getRouteByName($router_item['route_name']);
786
    $router_item['access'] = menu_item_route_access($route, $router_item['href'], $map);
787 788 789 790 791
  }
  else {
    // @todo: Remove once all routes are converted.
    _menu_check_access($router_item, $map);
  }
792

793 794 795 796
  // For performance, don't localize an item the user can't access.
  if ($router_item['access']) {
    _menu_item_localize($router_item, $map);
  }
797 798 799 800 801

  return $map;
}

/**
802
 * Translates the path elements in the map using any to_arg helper function.
803
 *
804
 * @param $map
805
 *   An array of path arguments; for example, array('node', '5').
806
 * @param $to_arg_functions
807
 *   An array of helper functions; for example, array(2 => 'menu_tail_to_arg').
808 809
 *
 * @see hook_menu()
810 811
 */
function _menu_link_map_translate(&$map, $to_arg_functions) {
812 813 814 815 816 817 818 819 820
  $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]);
821 822 823 824
    }
  }
}

825
/**
826
 * Returns a string containing the path relative to the current index.
827
 */
828 829 830 831
function menu_tail_to_arg($arg, $map, $index) {
  return implode('/', array_slice($map, $index));
}

832
/**
833
 * Loads the path as one string relative to the current index.
834 835 836 837 838 839 840 841 842 843 844 845 846 847 848
 *
 * 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;
}

849
/**
850 851 852 853
 * 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).
854 855
 *
 * @param $item