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
9
use Drupal\Core\Template\Attribute;

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

263
264

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

269
270

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

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

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

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

409
410


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

/**
427
 * Gets a router item.
428
429
430
431
432
433
 *
 * @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.
434
 *
435
436
437
438
 * @return
 *   The router item, an associate array corresponding to one row in the
 *   menu_router table. The value of key map holds the loaded objects. The
 *   value of key access is TRUE if the current user can access this page.
439
440
441
 *   The values for key title, page_arguments, access_arguments, and
 *   theme_arguments will be filled in based on the database values and the
 *   objects loaded.
442
443
 */
function menu_get_item($path = NULL, $router_item = NULL) {
444
  $router_items = &drupal_static(__FUNCTION__);
445
  if (!isset($path)) {
446
    $path = current_path();
447
  }
448
449
450
  if (isset($router_item)) {
    $router_items[$path] = $router_item;
  }
451
  if (!isset($router_items[$path])) {
452
453
    // 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.
454
    if (state()->get('menu_rebuild_needed') || !variable_get('menu_masks', array())) {
455
      menu_router_rebuild();
456
    }
457
    $original_map = arg(NULL, $path);
458

459
460
461
462
    $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();

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

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

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

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

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

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

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

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

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

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

  return $map;
}

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

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

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

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

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

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

911
  return $map;
Dries's avatar
   
Dries committed
912
913
}

914
/**
915
 * Gets a loaded object from a router item.
916
 *
917
918
919
920
921
922
923
924
925
926
 * 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
927
928
 *
 * @param $type
929
 *   Type of the object. These appear in hook_menu definitions as %type. Core
930
931
932
933
 *   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
934
935
936
 *   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.
937
 * @param $path
938
 *   See menu_get_item() for more on this. Defaults to the current path.
939
940
941
 */
function menu_get_object($type = 'node', $position = 1, $path = NULL) {
  $router_item = menu_get_item($path);
942
  if (isset($router_item['load_functions'][$position]) && !empty($router_item['map'][$position]) && $router_item['load_functions'][$position] == $type . '_load') {
943
944
945
946
    return $router_item['map'][$position];
  }
}

947
/**
948
 * Renders a menu tree based on the current path.
949
950
 *
 * The tree is expanded based on the current path and dynamic paths are also
951
 * changed according to the defined to_arg functions (for example the 'My
952
 * account' link is changed from user/% to a link with the current user's uid).
953
954
955
 *
 * @param $menu_name
 *   The name of the menu.
956
 *
957
 * @return
958
959
 *   A structured array representing the specified menu on the current page, to
 *   be rendered by drupal_render().
960
 */
961
function menu_tree($menu_name) {
962
  $menu_output = &drupal_static(__FUNCTION__, array());
963
964

  if (!isset($menu_output[$menu_name])) {
965
    $tree = menu_tree_page_data($menu_name);
966
967
968
969
970
    $menu_output[$menu_name] = menu_tree_output($tree);
  }
  return $menu_output[$menu_name];
}

Dries's avatar
   
Dries committed
971
/**
972
 * Returns a rendered menu tree.
973
 *
974
975
976
977
978
 * The menu item's LI element is given one of the following classes:
 * - expanded: The menu item is showing its submenu.
 * - collapsed: The menu item has a submenu which is not shown.
 * - leaf: The menu item has no submenu.
 *
979
980
 * @param $tree
 *   A data structure representing the tree as returned from menu_tree_data.
981
 *
982
 * @return
983
 *   A structured array to be rendered by drupal_render().
Dries's avatar
   
Dries committed
984
 */
985
function menu_tree_output($tree) {
986
  $build = array();