Project

General

Profile

Paste
Download (138 KB) Statistics
| Branch: | Revision:

root / drupal7 / includes / menu.inc @ b0dc3a2e

1
<?php
2

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

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

    
77
/**
78
 * @defgroup menu_flags Menu flags
79
 * @{
80
 * Flags for use in the "type" attribute of menu items.
81
 */
82

    
83
/**
84
 * Internal menu flag -- menu item is the root of the menu tree.
85
 */
86
define('MENU_IS_ROOT', 0x0001);
87

    
88
/**
89
 * Internal menu flag -- menu item is visible in the menu tree.
90
 */
91
define('MENU_VISIBLE_IN_TREE', 0x0002);
92

    
93
/**
94
 * Internal menu flag -- menu item is visible in the breadcrumb.
95
 */
96
define('MENU_VISIBLE_IN_BREADCRUMB', 0x0004);
97

    
98
/**
99
 * Internal menu flag -- menu item links back to its parent.
100
 */
101
define('MENU_LINKS_TO_PARENT', 0x0008);
102

    
103
/**
104
 * Internal menu flag -- menu item can be modified by administrator.
105
 */
106
define('MENU_MODIFIED_BY_ADMIN', 0x0020);
107

    
108
/**
109
 * Internal menu flag -- menu item was created by administrator.
110
 */
111
define('MENU_CREATED_BY_ADMIN', 0x0040);
112

    
113
/**
114
 * Internal menu flag -- menu item is a local task.
115
 */
116
define('MENU_IS_LOCAL_TASK', 0x0080);
117

    
118
/**
119
 * Internal menu flag -- menu item is a local action.
120
 */
121
define('MENU_IS_LOCAL_ACTION', 0x0100);
122

    
123
/**
124
 * @} End of "Menu flags".
125
 */
126

    
127
/**
128
 * @defgroup menu_item_types Menu item types
129
 * @{
130
 * Definitions for various menu item types.
131
 *
132
 * Menu item definitions provide one of these constants, which are shortcuts for
133
 * combinations of @link menu_flags Menu flags @endlink.
134
 */
135

    
136
/**
137
 * Menu type -- A "normal" menu item that's shown in menu and breadcrumbs.
138
 *
139
 * Normal menu items show up in the menu tree and can be moved/hidden by
140
 * the administrator. Use this for most menu items. It is the default value if
141
 * no menu item type is specified.
142
 */
143
define('MENU_NORMAL_ITEM', MENU_VISIBLE_IN_TREE | MENU_VISIBLE_IN_BREADCRUMB);
144

    
145
/**
146
 * Menu type -- A hidden, internal callback, typically used for API calls.
147
 *
148
 * Callbacks simply register a path so that the correct function is fired
149
 * when the URL is accessed. They do not appear in menus or breadcrumbs.
150
 */
151
define('MENU_CALLBACK', 0x0000);
152

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

    
163
/**
164
 * Menu type -- A task specific to the parent item, usually rendered as a tab.
165
 *
166
 * Local tasks are menu items that describe actions to be performed on their
167
 * parent item. An example is the path "node/52/edit", which performs the
168
 * "edit" task on "node/52".
169
 */
170
define('MENU_LOCAL_TASK', MENU_IS_LOCAL_TASK | MENU_VISIBLE_IN_BREADCRUMB);
171

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

    
180
/**
181
 * Menu type -- An action specific to the parent, usually rendered as a link.
182
 *
183
 * Local actions are menu items that describe actions on the parent item such
184
 * as adding a new user, taxonomy term, etc.
185
 */
186
define('MENU_LOCAL_ACTION', MENU_IS_LOCAL_TASK | MENU_IS_LOCAL_ACTION | MENU_VISIBLE_IN_BREADCRUMB);
187

    
188
/**
189
 * @} End of "Menu item types".
190
 */
191

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

    
198
/**
199
 * Internal menu flag: Invisible local task.
200
 *
201
 * This flag may be used for local tasks like "Delete", so custom modules and
202
 * themes can alter the default context and expose the task by altering menu.
203
 */
204
define('MENU_CONTEXT_NONE', 0x0000);
205

    
206
/**
207
 * Internal menu flag: Local task should be displayed in page context.
208
 */
209
define('MENU_CONTEXT_PAGE', 0x0001);
210

    
211
/**
212
 * Internal menu flag: Local task should be displayed inline.
213
 */
214
define('MENU_CONTEXT_INLINE', 0x0002);
215

    
216
/**
217
 * @} End of "Menu context types".
218
 */
219

    
220
/**
221
 * @defgroup menu_status_codes Menu status codes
222
 * @{
223
 * Status codes for menu callbacks.
224
 */
225

    
226
/**
227
 * Internal menu status code -- Menu item was found.
228
 */
229
define('MENU_FOUND', 1);
230

    
231
/**
232
 * Menu status code -- Not found.
233
 *
234
 * This can be used as the return value from a page callback, although it is
235
 * preferable to use a load function to accomplish this; see the hook_menu()
236
 * documentation for details.
237
 */
238
define('MENU_NOT_FOUND', 2);
239

    
240
/**
241
 * Menu status code -- Access denied.
242
 *
243
 * This can be used as the return value from a page callback, although it is
244
 * preferable to use an access callback to accomplish this; see the hook_menu()
245
 * documentation for details.
246
 */
247
define('MENU_ACCESS_DENIED', 3);
248

    
249
/**
250
 * Internal menu status code -- Menu item inaccessible because site is offline.
251
 */
252
define('MENU_SITE_OFFLINE', 4);
253

    
254
/**
255
 * Internal menu status code -- Everything is working fine.
256
 */
257
define('MENU_SITE_ONLINE', 5);
258

    
259
/**
260
 * @} End of "Menu status codes".
261
 */
262

    
263
/**
264
 * @defgroup menu_tree_parameters Menu tree parameters
265
 * @{
266
 * Parameters for a menu tree.
267
 */
268

    
269
 /**
270
 * The maximum number of path elements for a menu callback
271
 */
272
define('MENU_MAX_PARTS', 9);
273

    
274

    
275
/**
276
 * The maximum depth of a menu links tree - matches the number of p columns.
277
 */
278
define('MENU_MAX_DEPTH', 9);
279

    
280

    
281
/**
282
 * @} End of "Menu tree parameters".
283
 */
284

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

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

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

    
420

    
421

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

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

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

    
477
    if ($router_item) {
478
      // Allow modules to alter the router item before it is translated and
479
      // checked for access.
480
      drupal_alter('menu_get_item', $router_item, $path, $original_map);
481

    
482
      $map = _menu_translate($router_item, $original_map);
483
      $router_item['original_map'] = $original_map;
484
      if ($map === FALSE) {
485
        $router_items[$path] = FALSE;
486
        return FALSE;
487
      }
488
      if ($router_item['access']) {
489
        $router_item['map'] = $map;
490
        $router_item['page_arguments'] = array_merge(menu_unserialize($router_item['page_arguments'], $map), array_slice($map, $router_item['number_parts']));
491
        $router_item['theme_arguments'] = array_merge(menu_unserialize($router_item['theme_arguments'], $map), array_slice($map, $router_item['number_parts']));
492
      }
493
    }
494
    $router_items[$path] = $router_item;
495
  }
496
  return $router_items[$path];
497
}
498

    
499
/**
500
 * Execute the page callback associated with the current path.
501
 *
502
 * @param $path
503
 *   The drupal path whose handler is to be be executed. If set to NULL, then
504
 *   the current path is used.
505
 * @param $deliver
506
 *   (optional) A boolean to indicate whether the content should be sent to the
507
 *   browser using the appropriate delivery callback (TRUE) or whether to return
508
 *   the result to the caller (FALSE).
509
 */
510
function menu_execute_active_handler($path = NULL, $deliver = TRUE) {
511
  // Check if site is offline.
512
  $page_callback_result = _menu_site_is_offline() ? MENU_SITE_OFFLINE : MENU_SITE_ONLINE;
513

    
514
  // Allow other modules to change the site status but not the path because that
515
  // would not change the global variable. hook_url_inbound_alter() can be used
516
  // to change the path. Code later will not use the $read_only_path variable.
517
  $read_only_path = !empty($path) ? $path : $_GET['q'];
518
  drupal_alter('menu_site_status', $page_callback_result, $read_only_path);
519

    
520
  // Only continue if the site status is not set.
521
  if ($page_callback_result == MENU_SITE_ONLINE) {
522
    if ($router_item = menu_get_item($path)) {
523
      if ($router_item['access']) {
524
        if ($router_item['include_file']) {
525
          require_once DRUPAL_ROOT . '/' . $router_item['include_file'];
526
        }
527
        $page_callback_result = call_user_func_array($router_item['page_callback'], $router_item['page_arguments']);
528
      }
529
      else {
530
        $page_callback_result = MENU_ACCESS_DENIED;
531
      }
532
    }
533
    else {
534
      $page_callback_result = MENU_NOT_FOUND;
535
    }
536
  }
537

    
538
  // Deliver the result of the page callback to the browser, or if requested,
539
  // return it raw, so calling code can do more processing.
540
  if ($deliver) {
541
    $default_delivery_callback = (isset($router_item) && $router_item) ? $router_item['delivery_callback'] : NULL;
542
    drupal_deliver_page($page_callback_result, $default_delivery_callback);
543
  }
544
  else {
545
    return $page_callback_result;
546
  }
547
}
548

    
549
/**
550
 * Loads objects into the map as defined in the $item['load_functions'].
551
 *
552
 * @param $item
553
 *   A menu router or menu link item
554
 * @param $map
555
 *   An array of path arguments; for example, array('node', '5').
556
 *
557
 * @return
558
 *   Returns TRUE for success, FALSE if an object cannot be loaded.
559
 *   Names of object loading functions are placed in $item['load_functions'].
560
 *   Loaded objects are placed in $map[]; keys are the same as keys in the
561
 *   $item['load_functions'] array.
562
 *   $item['access'] is set to FALSE if an object cannot be loaded.
563
 */
564
function _menu_load_objects(&$item, &$map) {
565
  if ($load_functions = $item['load_functions']) {
566
    // If someone calls this function twice, then unserialize will fail.
567
    if (!is_array($load_functions)) {
568
      $load_functions = unserialize($load_functions);
569
    }
570
    $path_map = $map;
571
    foreach ($load_functions as $index => $function) {
572
      if ($function) {
573
        $value = isset($path_map[$index]) ? $path_map[$index] : '';
574
        if (is_array($function)) {
575
          // Set up arguments for the load function. These were pulled from
576
          // 'load arguments' in the hook_menu() entry, but they need
577
          // some processing. In this case the $function is the key to the
578
          // load_function array, and the value is the list of arguments.
579
          list($function, $args) = each($function);
580
          $load_functions[$index] = $function;
581

    
582
          // Some arguments are placeholders for dynamic items to process.
583
          foreach ($args as $i => $arg) {
584
            if ($arg === '%index') {
585
              // Pass on argument index to the load function, so multiple
586
              // occurrences of the same placeholder can be identified.
587
              $args[$i] = $index;
588
            }
589
            if ($arg === '%map') {
590
              // Pass on menu map by reference. The accepting function must
591
              // also declare this as a reference if it wants to modify
592
              // the map.
593
              $args[$i] = &$map;
594
            }
595
            if (is_int($arg)) {
596
              $args[$i] = isset($path_map[$arg]) ? $path_map[$arg] : '';
597
            }
598
          }
599
          array_unshift($args, $value);
600
          $return = call_user_func_array($function, $args);
601
        }
602
        else {
603
          $return = $function($value);
604
        }
605
        // If callback returned an error or there is no callback, trigger 404.
606
        if ($return === FALSE) {
607
          $item['access'] = FALSE;
608
          $map = FALSE;
609
          return FALSE;
610
        }
611
        $map[$index] = $return;
612
      }
613
    }
614
    $item['load_functions'] = $load_functions;
615
  }
616
  return TRUE;
617
}
618

    
619
/**
620
 * Checks access to a menu item using the access callback.
621
 *
622
 * @param $item
623
 *   A menu router or menu link item
624
 * @param $map
625
 *   An array of path arguments; for example, array('node', '5').
626
 *
627
 * @return
628
 *   $item['access'] becomes TRUE if the item is accessible, FALSE otherwise.
629
 */
630
function _menu_check_access(&$item, $map) {
631
  $item['access'] = FALSE;
632
  // Determine access callback, which will decide whether or not the current
633
  // user has access to this path.
634
  $callback = empty($item['access_callback']) ? 0 : trim($item['access_callback']);
635
  // Check for a TRUE or FALSE value.
636
  if (is_numeric($callback)) {
637
    $item['access'] = (bool) $callback;
638
  }
639
  else {
640
    $arguments = menu_unserialize($item['access_arguments'], $map);
641
    // As call_user_func_array is quite slow and user_access is a very common
642
    // callback, it is worth making a special case for it.
643
    if ($callback == 'user_access') {
644
      $item['access'] = (count($arguments) == 1) ? user_access($arguments[0]) : user_access($arguments[0], $arguments[1]);
645
    }
646
    elseif (function_exists($callback)) {
647
      $item['access'] = call_user_func_array($callback, $arguments);
648
    }
649
  }
650
}
651

    
652
/**
653
 * Localizes the router item title using t() or another callback.
654
 *
655
 * Translate the title and description to allow storage of English title
656
 * strings in the database, yet display of them in the language required
657
 * by the current user.
658
 *
659
 * @param $item
660
 *   A menu router item or a menu link item.
661
 * @param $map
662
 *   The path as an array with objects already replaced. E.g., for path
663
 *   node/123 $map would be array('node', $node) where $node is the node
664
 *   object for node 123.
665
 * @param $link_translate
666
 *   TRUE if we are translating a menu link item; FALSE if we are
667
 *   translating a menu router item.
668
 *
669
 * @return
670
 *   No return value.
671
 *   $item['title'] is localized according to $item['title_callback'].
672
 *   If an item's callback is check_plain(), $item['options']['html'] becomes
673
 *   TRUE.
674
 *   $item['description'] is translated using t().
675
 *   When doing link translation and the $item['options']['attributes']['title']
676
 *   (link title attribute) matches the description, it is translated as well.
677
 */
678
function _menu_item_localize(&$item, $map, $link_translate = FALSE) {
679
  $callback = $item['title_callback'];
680
  $item['localized_options'] = $item['options'];
681
  // All 'class' attributes are assumed to be an array during rendering, but
682
  // links stored in the database may use an old string value.
683
  // @todo In order to remove this code we need to implement a database update
684
  //   including unserializing all existing link options and running this code
685
  //   on them, as well as adding validation to menu_link_save().
686
  if (isset($item['options']['attributes']['class']) && is_string($item['options']['attributes']['class'])) {
687
    $item['localized_options']['attributes']['class'] = explode(' ', $item['options']['attributes']['class']);
688
  }
689
  // If we are translating the title of a menu link, and its title is the same
690
  // as the corresponding router item, then we can use the title information
691
  // from the router. If it's customized, then we need to use the link title
692
  // itself; can't localize.
693
  // If we are translating a router item (tabs, page, breadcrumb), then we
694
  // can always use the information from the router item.
695
  if (!$link_translate || ($item['title'] == $item['link_title'])) {
696
    // t() is a special case. Since it is used very close to all the time,
697
    // we handle it directly instead of using indirect, slower methods.
698
    if ($callback == 't') {
699
      if (empty($item['title_arguments'])) {
700
        $item['title'] = t($item['title']);
701
      }
702
      else {
703
        $item['title'] = t($item['title'], menu_unserialize($item['title_arguments'], $map));
704
      }
705
    }
706
    elseif ($callback && function_exists($callback)) {
707
      if (empty($item['title_arguments'])) {
708
        $item['title'] = $callback($item['title']);
709
      }
710
      else {
711
        $item['title'] = call_user_func_array($callback, menu_unserialize($item['title_arguments'], $map));
712
      }
713
      // Avoid calling check_plain again on l() function.
714
      if ($callback == 'check_plain') {
715
        $item['localized_options']['html'] = TRUE;
716
      }
717
    }
718
  }
719
  elseif ($link_translate) {
720
    $item['title'] = $item['link_title'];
721
  }
722

    
723
  // Translate description, see the motivation above.
724
  if (!empty($item['description'])) {
725
    $original_description = $item['description'];
726
    $item['description'] = t($item['description']);
727
    if ($link_translate && isset($item['options']['attributes']['title']) && $item['options']['attributes']['title'] == $original_description) {
728
      $item['localized_options']['attributes']['title'] = $item['description'];
729
    }
730
  }
731
}
732

    
733
/**
734
 * Handles dynamic path translation and menu access control.
735
 *
736
 * When a user arrives on a page such as node/5, this function determines
737
 * what "5" corresponds to, by inspecting the page's menu path definition,
738
 * node/%node. This will call node_load(5) to load the corresponding node
739
 * object.
740
 *
741
 * It also works in reverse, to allow the display of tabs and menu items which
742
 * contain these dynamic arguments, translating node/%node to node/5.
743
 *
744
 * Translation of menu item titles and descriptions are done here to
745
 * allow for storage of English strings in the database, and translation
746
 * to the language required to generate the current page.
747
 *
748
 * @param $router_item
749
 *   A menu router item
750
 * @param $map
751
 *   An array of path arguments; for example, array('node', '5').
752
 * @param $to_arg
753
 *   Execute $item['to_arg_functions'] or not. Use only if you want to render a
754
 *   path from the menu table, for example tabs.
755
 *
756
 * @return
757
 *   Returns the map with objects loaded as defined in the
758
 *   $item['load_functions']. $item['access'] becomes TRUE if the item is
759
 *   accessible, FALSE otherwise. $item['href'] is set according to the map.
760
 *   If an error occurs during calling the load_functions (like trying to load
761
 *   a non-existent node) then this function returns FALSE.
762
 */
763
function _menu_translate(&$router_item, $map, $to_arg = FALSE) {
764
  if ($to_arg && !empty($router_item['to_arg_functions'])) {
765
    // Fill in missing path elements, such as the current uid.
766
    _menu_link_map_translate($map, $router_item['to_arg_functions']);
767
  }
768
  // The $path_map saves the pieces of the path as strings, while elements in
769
  // $map may be replaced with loaded objects.
770
  $path_map = $map;
771
  if (!empty($router_item['load_functions']) && !_menu_load_objects($router_item, $map)) {
772
    // An error occurred loading an object.
773
    $router_item['access'] = FALSE;
774
    return FALSE;
775
  }
776

    
777
  // Generate the link path for the page request or local tasks.
778
  $link_map = explode('/', $router_item['path']);
779
  if (isset($router_item['tab_root'])) {
780
    $tab_root_map = explode('/', $router_item['tab_root']);
781
  }
782
  if (isset($router_item['tab_parent'])) {
783
    $tab_parent_map = explode('/', $router_item['tab_parent']);
784
  }
785
  for ($i = 0; $i < $router_item['number_parts']; $i++) {
786
    if ($link_map[$i] == '%') {
787
      $link_map[$i] = $path_map[$i];
788
    }
789
    if (isset($tab_root_map[$i]) && $tab_root_map[$i] == '%') {
790
      $tab_root_map[$i] = $path_map[$i];
791
    }
792
    if (isset($tab_parent_map[$i]) && $tab_parent_map[$i] == '%') {
793
      $tab_parent_map[$i] = $path_map[$i];
794
    }
795
  }
796
  $router_item['href'] = implode('/', $link_map);
797
  $router_item['tab_root_href'] = implode('/', $tab_root_map);
798
  $router_item['tab_parent_href'] = implode('/', $tab_parent_map);
799
  $router_item['options'] = array();
800
  _menu_check_access($router_item, $map);
801

    
802
  // For performance, don't localize an item the user can't access.
803
  if ($router_item['access']) {
804
    _menu_item_localize($router_item, $map);
805
  }
806

    
807
  return $map;
808
}
809

    
810
/**
811
 * Translates the path elements in the map using any to_arg helper function.
812
 *
813
 * @param $map
814
 *   An array of path arguments; for example, array('node', '5').
815
 * @param $to_arg_functions
816
 *   An array of helper functions; for example, array(2 => 'menu_tail_to_arg').
817
 *
818
 * @see hook_menu()
819
 */
820
function _menu_link_map_translate(&$map, $to_arg_functions) {
821
  $to_arg_functions = unserialize($to_arg_functions);
822
  foreach ($to_arg_functions as $index => $function) {
823
    // Translate place-holders into real values.
824
    $arg = $function(!empty($map[$index]) ? $map[$index] : '', $map, $index);
825
    if (!empty($map[$index]) || isset($arg)) {
826
      $map[$index] = $arg;
827
    }
828
    else {
829
      unset($map[$index]);
830
    }
831
  }
832
}
833

    
834
/**
835
 * Returns a string containing the path relative to the current index.
836
 */
837
function menu_tail_to_arg($arg, $map, $index) {
838
  return implode('/', array_slice($map, $index));
839
}
840

    
841
/**
842
 * Loads the path as one string relative to the current index.
843
 *
844
 * To use this load function, you must specify the load arguments
845
 * in the router item as:
846
 * @code
847
 * $item['load arguments'] = array('%map', '%index');
848
 * @endcode
849
 *
850
 * @see search_menu().
851
 */
852
function menu_tail_load($arg, &$map, $index) {
853
  $arg = implode('/', array_slice($map, $index));
854
  $map = array_slice($map, 0, $index);
855
  return $arg;
856
}
857

    
858
/**
859
 * Provides menu link access control, translation, and argument handling.
860
 *
861
 * This function is similar to _menu_translate(), but it also does
862
 * link-specific preparation (such as always calling to_arg() functions).
863
 *
864
 * @param $item
865
 *   A menu link.
866
 * @param $translate
867
 *   (optional) Whether to try to translate a link containing dynamic path
868
 *   argument placeholders (%) based on the menu router item of the current
869
 *   path. Defaults to FALSE. Internally used for breadcrumbs.
870
 *
871
 * @return
872
 *   Returns the map of path arguments with objects loaded as defined in the
873
 *   $item['load_functions'].
874
 *   $item['access'] becomes TRUE if the item is accessible, FALSE otherwise.
875
 *   $item['href'] is generated from link_path, possibly by to_arg functions.
876
 *   $item['title'] is generated from link_title, and may be localized.
877
 *   $item['options'] is unserialized; it is also changed within the call here
878
 *   to $item['localized_options'] by _menu_item_localize().
879
 */
880
function _menu_link_translate(&$item, $translate = FALSE) {
881
  if (!is_array($item['options'])) {
882
    $item['options'] = unserialize($item['options']);
883
  }
884
  if ($item['external']) {
885
    $item['access'] = 1;
886
    $map = array();
887
    $item['href'] = $item['link_path'];
888
    $item['title'] = $item['link_title'];
889
    $item['localized_options'] = $item['options'];
890
  }
891
  else {
892
    // Complete the path of the menu link with elements from the current path,
893
    // if it contains dynamic placeholders (%).
894
    $map = explode('/', $item['link_path']);
895
    if (strpos($item['link_path'], '%') !== FALSE) {
896
      // Invoke registered to_arg callbacks.
897
      if (!empty($item['to_arg_functions'])) {
898
        _menu_link_map_translate($map, $item['to_arg_functions']);
899
      }
900
      // Or try to derive the path argument map from the current router item,
901
      // if this $item's path is within the router item's path. This means
902
      // that if we are on the current path 'foo/%/bar/%/baz', then
903
      // menu_get_item() will have translated the menu router item for the
904
      // current path, and we can take over the argument map for a link like
905
      // 'foo/%/bar'. This inheritance is only valid for breadcrumb links.
906
      // @see _menu_tree_check_access()
907
      // @see menu_get_active_breadcrumb()
908
      elseif ($translate && ($current_router_item = menu_get_item())) {
909
        // If $translate is TRUE, then this link is in the active trail.
910
        // Only translate paths within the current path.
911
        if (strpos($current_router_item['path'], $item['link_path']) === 0) {
912
          $count = count($map);
913
          $map = array_slice($current_router_item['original_map'], 0, $count);
914
          $item['original_map'] = $map;
915
          if (isset($current_router_item['map'])) {
916
            $item['map'] = array_slice($current_router_item['map'], 0, $count);
917
          }
918
          // Reset access to check it (for the first time).
919
          unset($item['access']);
920
        }
921
      }
922
    }
923
    $item['href'] = implode('/', $map);
924

    
925
    // Skip links containing untranslated arguments.
926
    if (strpos($item['href'], '%') !== FALSE) {
927
      $item['access'] = FALSE;
928
      return FALSE;
929
    }
930
    // menu_tree_check_access() may set this ahead of time for links to nodes.
931
    if (!isset($item['access'])) {
932
      if (!empty($item['load_functions']) && !_menu_load_objects($item, $map)) {
933
        // An error occurred loading an object.
934
        $item['access'] = FALSE;
935
        return FALSE;
936
      }
937
      _menu_check_access($item, $map);
938
    }
939
    // For performance, don't localize a link the user can't access.
940
    if ($item['access']) {
941
      _menu_item_localize($item, $map, TRUE);
942
    }
943
  }
944

    
945
  // Allow other customizations - e.g. adding a page-specific query string to the
946
  // options array. For performance reasons we only invoke this hook if the link
947
  // has the 'alter' flag set in the options array.
948
  if (!empty($item['options']['alter'])) {
949
    drupal_alter('translated_menu_link', $item, $map);
950
  }
951

    
952
  return $map;
953
}
954

    
955
/**
956
 * Gets a loaded object from a router item.
957
 *
958
 * menu_get_object() provides access to objects loaded by the current router
959
 * item. For example, on the page node/%node, the router loads the %node object,
960
 * and calling menu_get_object() will return that. Normally, it is necessary to
961
 * specify the type of object referenced, however node is the default.
962
 * The following example tests to see whether the node being displayed is of the
963
 * "story" content type:
964
 * @code
965
 * $node = menu_get_object();
966
 * $story = $node->type == 'story';
967
 * @endcode
968
 *
969
 * @param $type
970
 *   Type of the object. These appear in hook_menu definitions as %type. Core
971
 *   provides aggregator_feed, aggregator_category, contact, filter_format,
972
 *   forum_term, menu, menu_link, node, taxonomy_vocabulary, user. See the
973
 *   relevant {$type}_load function for more on each. Defaults to node.
974
 * @param $position
975
 *   The position of the object in the path, where the first path segment is 0.
976
 *   For node/%node, the position of %node is 1, but for comment/reply/%node,
977
 *   it's 2. Defaults to 1.
978
 * @param $path
979
 *   See menu_get_item() for more on this. Defaults to the current path.
980
 */
981
function menu_get_object($type = 'node', $position = 1, $path = NULL) {
982
  $router_item = menu_get_item($path);
983
  if (isset($router_item['load_functions'][$position]) && !empty($router_item['map'][$position]) && $router_item['load_functions'][$position] == $type . '_load') {
984
    return $router_item['map'][$position];
985
  }
986
}
987

    
988
/**
989
 * Renders a menu tree based on the current path.
990
 *
991
 * The tree is expanded based on the current path and dynamic paths are also
992
 * changed according to the defined to_arg functions (for example the 'My
993
 * account' link is changed from user/% to a link with the current user's uid).
994
 *
995
 * @param $menu_name
996
 *   The name of the menu.
997
 *
998
 * @return
999
 *   A structured array representing the specified menu on the current page, to
1000
 *   be rendered by drupal_render().
1001
 */
1002
function menu_tree($menu_name) {
1003
  $menu_output = &drupal_static(__FUNCTION__, array());
1004

    
1005
  if (!isset($menu_output[$menu_name])) {
1006
    $tree = menu_tree_page_data($menu_name);
1007
    $menu_output[$menu_name] = menu_tree_output($tree);
1008
  }
1009
  return $menu_output[$menu_name];
1010
}
1011

    
1012
/**
1013
 * Returns an output structure for rendering a menu tree.
1014
 *
1015
 * The menu item's LI element is given one of the following classes:
1016
 * - expanded: The menu item is showing its submenu.
1017
 * - collapsed: The menu item has a submenu which is not shown.
1018
 * - leaf: The menu item has no submenu.
1019
 *
1020
 * @param $tree
1021
 *   A data structure representing the tree as returned from menu_tree_data.
1022
 *
1023
 * @return
1024
 *   A structured array to be rendered by drupal_render().
1025
 */
1026
function menu_tree_output($tree) {
1027
  $build = array();
1028
  $items = array();
1029

    
1030
  // Pull out just the menu links we are going to render so that we
1031
  // get an accurate count for the first/last classes.
1032
  foreach ($tree as $data) {
1033
    if ($data['link']['access'] && !$data['link']['hidden']) {
1034
      $items[] = $data;
1035
    }
1036
  }
1037

    
1038
  $router_item = menu_get_item();
1039
  $num_items = count($items);
1040
  foreach ($items as $i => $data) {
1041
    $class = array();
1042
    if ($i == 0) {
1043
      $class[] = 'first';
1044
    }
1045
    if ($i == $num_items - 1) {
1046
      $class[] = 'last';
1047
    }
1048
    // Set a class for the <li>-tag. Since $data['below'] may contain local
1049
    // tasks, only set 'expanded' class if the link also has children within
1050
    // the current menu.
1051
    if ($data['link']['has_children'] && $data['below']) {
1052
      $class[] = 'expanded';
1053
    }
1054
    elseif ($data['link']['has_children']) {
1055
      $class[] = 'collapsed';
1056
    }
1057
    else {
1058
      $class[] = 'leaf';
1059
    }
1060
    // Set a class if the link is in the active trail.
1061
    if ($data['link']['in_active_trail']) {
1062
      $class[] = 'active-trail';
1063
      $data['link']['localized_options']['attributes']['class'][] = 'active-trail';
1064
    }
1065
    // Normally, l() compares the href of every link with $_GET['q'] and sets
1066
    // the active class accordingly. But local tasks do not appear in menu
1067
    // trees, so if the current path is a local task, and this link is its
1068
    // tab root, then we have to set the class manually.
1069
    if ($data['link']['href'] == $router_item['tab_root_href'] && $data['link']['href'] != $_GET['q']) {
1070
      $data['link']['localized_options']['attributes']['class'][] = 'active';
1071
    }
1072

    
1073
    // Allow menu-specific theme overrides.
1074
    $element['#theme'] = 'menu_link__' . strtr($data['link']['menu_name'], '-', '_');
1075
    $element['#attributes']['class'] = $class;
1076
    $element['#title'] = $data['link']['title'];
1077
    $element['#href'] = $data['link']['href'];
1078
    $element['#localized_options'] = !empty($data['link']['localized_options']) ? $data['link']['localized_options'] : array();
1079
    $element['#below'] = $data['below'] ? menu_tree_output($data['below']) : $data['below'];
1080
    $element['#original_link'] = $data['link'];
1081
    // Index using the link's unique mlid.
1082
    $build[$data['link']['mlid']] = $element;
1083
  }
1084
  if ($build) {
1085
    // Make sure drupal_render() does not re-order the links.
1086
    $build['#sorted'] = TRUE;
1087
    // Add the theme wrapper for outer markup.
1088
    // Allow menu-specific theme overrides.
1089
    $build['#theme_wrappers'][] = 'menu_tree__' . strtr($data['link']['menu_name'], '-', '_');
1090
  }
1091

    
1092
  return $build;
1093
}
1094

    
1095
/**
1096
 * Gets the data structure representing a named menu tree.
1097
 *
1098
 * Since this can be the full tree including hidden items, the data returned
1099
 * may be used for generating an an admin interface or a select.
1100
 *
1101
 * @param $menu_name
1102
 *   The named menu links to return
1103
 * @param $link
1104
 *   A fully loaded menu link, or NULL. If a link is supplied, only the
1105
 *   path to root will be included in the returned tree - as if this link
1106
 *   represented the current page in a visible menu.
1107
 * @param $max_depth
1108
 *   Optional maximum depth of links to retrieve. Typically useful if only one
1109
 *   or two levels of a sub tree are needed in conjunction with a non-NULL
1110
 *   $link, in which case $max_depth should be greater than $link['depth'].
1111
 *
1112
 * @return
1113
 *   An tree of menu links in an array, in the order they should be rendered.
1114
 */
1115
function menu_tree_all_data($menu_name, $link = NULL, $max_depth = NULL) {
1116
  $tree = &drupal_static(__FUNCTION__, array());
1117

    
1118
  // Use $mlid as a flag for whether the data being loaded is for the whole tree.
1119
  $mlid = isset($link['mlid']) ? $link['mlid'] : 0;
1120
  // Generate a cache ID (cid) specific for this $menu_name, $link, $language, and depth.
1121
  $cid = 'links:' . $menu_name . ':all:' . $mlid . ':' . $GLOBALS['language']->language . ':' . (int) $max_depth;
1122

    
1123
  if (!isset($tree[$cid])) {
1124
    // If the static variable doesn't have the data, check {cache_menu}.
1125
    $cache = cache_get($cid, 'cache_menu');
1126
    if ($cache && isset($cache->data)) {
1127
      // If the cache entry exists, it contains the parameters for
1128
      // menu_build_tree().
1129
      $tree_parameters = $cache->data;
1130
    }
1131
    // If the tree data was not in the cache, build $tree_parameters.
1132
    if (!isset($tree_parameters)) {
1133
      $tree_parameters = array(
1134
        'min_depth' => 1,
1135
        'max_depth' => $max_depth,
1136
      );
1137
      if ($mlid) {
1138
        // The tree is for a single item, so we need to match the values in its
1139
        // p columns and 0 (the top level) with the plid values of other links.
1140
        $parents = array(0);
1141
        for ($i = 1; $i < MENU_MAX_DEPTH; $i++) {
1142
          if (!empty($link["p$i"])) {
1143
            $parents[] = $link["p$i"];
1144
          }
1145
        }
1146
        $tree_parameters['expanded'] = $parents;
1147
        $tree_parameters['active_trail'] = $parents;
1148
        $tree_parameters['active_trail'][] = $mlid;
1149
      }
1150

    
1151
      // Cache the tree building parameters using the page-specific cid.
1152
      cache_set($cid, $tree_parameters, 'cache_menu');
1153
    }
1154

    
1155
    // Build the tree using the parameters; the resulting tree will be cached
1156
    // by _menu_build_tree()).
1157
    $tree[$cid] = menu_build_tree($menu_name, $tree_parameters);
1158
  }
1159

    
1160
  return $tree[$cid];
1161
}
1162

    
1163
/**
1164
 * Sets the path for determining the active trail of the specified menu tree.
1165
 *
1166
 * This path will also affect the breadcrumbs under some circumstances.
1167
 * Breadcrumbs are built using the preferred link returned by
1168
 * menu_link_get_preferred(). If the preferred link is inside one of the menus
1169
 * specified in calls to menu_tree_set_path(), the preferred link will be
1170
 * overridden by the corresponding path returned by menu_tree_get_path().
1171
 *
1172
 * Setting this path does not affect the main content; for that use
1173
 * menu_set_active_item() instead.
1174
 *
1175
 * @param $menu_name
1176
 *   The name of the affected menu tree.
1177
 * @param $path
1178
 *   The path to use when finding the active trail.
1179
 */
1180
function menu_tree_set_path($menu_name, $path = NULL) {
1181
  $paths = &drupal_static(__FUNCTION__);
1182
  if (isset($path)) {
1183
    $paths[$menu_name] = $path;
1184
  }
1185
  return isset($paths[$menu_name]) ? $paths[$menu_name] : NULL;
1186
}
1187

    
1188
/**
1189
 * Gets the path for determining the active trail of the specified menu tree.
1190
 *
1191
 * @param $menu_name
1192
 *   The menu name of the requested tree.
1193
 *
1194
 * @return
1195
 *   A string containing the path. If no path has been specified with
1196
 *   menu_tree_set_path(), NULL is returned.
1197
 */
1198
function menu_tree_get_path($menu_name) {
1199
  return menu_tree_set_path($menu_name);
1200
}
1201

    
1202
/**
1203
 * Gets the data structure for a named menu tree, based on the current page.
1204
 *
1205
 * The tree order is maintained by storing each parent in an individual
1206
 * field, see http://drupal.org/node/141866 for more.
1207
 *
1208
 * @param $menu_name
1209
 *   The named menu links to return.
1210
 * @param $max_depth
1211
 *   (optional) The maximum depth of links to retrieve.
1212
 * @param $only_active_trail
1213
 *   (optional) Whether to only return the links in the active trail (TRUE)
1214
 *   instead of all links on every level of the menu link tree (FALSE). Defaults
1215
 *   to FALSE. Internally used for breadcrumbs only.
1216
 *
1217
 * @return
1218
 *   An array of menu links, in the order they should be rendered. The array
1219
 *   is a list of associative arrays -- these have two keys, link and below.
1220
 *   link is a menu item, ready for theming as a link. Below represents the
1221
 *   submenu below the link if there is one, and it is a subtree that has the
1222
 *   same structure described for the top-level array.
1223
 */
1224
function menu_tree_page_data($menu_name, $max_depth = NULL, $only_active_trail = FALSE) {
1225
  $tree = &drupal_static(__FUNCTION__, array());
1226

    
1227
  // Check if the active trail has been overridden for this menu tree.
1228
  $active_path = menu_tree_get_path($menu_name);
1229
  // Load the menu item corresponding to the current page.
1230
  if ($item = menu_get_item($active_path)) {
1231
    if (isset($max_depth)) {
1232
      $max_depth = min($max_depth, MENU_MAX_DEPTH);
1233
    }
1234
    // Generate a cache ID (cid) specific for this page.
1235
    $cid = 'links:' . $menu_name . ':page:' . $item['href'] . ':' . $GLOBALS['language']->language . ':' . (int) $item['access'] . ':' . (int) $max_depth;
1236
    // If we are asked for the active trail only, and $menu_name has not been
1237
    // built and cached for this page yet, then this likely means that it
1238
    // won't be built anymore, as this function is invoked from
1239
    // template_process_page(). So in order to not build a giant menu tree
1240
    // that needs to be checked for access on all levels, we simply check
1241
    // whether we have the menu already in cache, or otherwise, build a minimum
1242
    // tree containing the breadcrumb/active trail only.
1243
    // @see menu_set_active_trail()
1244
    if (!isset($tree[$cid]) && $only_active_trail) {
1245
      $cid .= ':trail';
1246
    }
1247

    
1248
    if (!isset($tree[$cid])) {
1249
      // If the static variable doesn't have the data, check {cache_menu}.
1250
      $cache = cache_get($cid, 'cache_menu');
1251
      if ($cache && isset($cache->data)) {
1252
        // If the cache entry exists, it contains the parameters for
1253
        // menu_build_tree().
1254
        $tree_parameters = $cache->data;
1255
      }
1256
      // If the tree data was not in the cache, build $tree_parameters.
1257
      if (!isset($tree_parameters)) {
1258
        $tree_parameters = array(
1259
          'min_depth' => 1,
1260
          'max_depth' => $max_depth,
1261
        );
1262
        // Parent mlids; used both as key and value to ensure uniqueness.
1263
        // We always want all the top-level links with plid == 0.
1264
        $active_trail = array(0 => 0);
1265

    
1266
        // If the item for the current page is accessible, build the tree
1267
        // parameters accordingly.
1268
        if ($item['access']) {
1269
          // Find a menu link corresponding to the current path. If $active_path
1270
          // is NULL, let menu_link_get_preferred() determine the path.
1271
          if ($active_link = menu_link_get_preferred($active_path, $menu_name)) {
1272
            // The active link may only be taken into account to build the
1273
            // active trail, if it resides in the requested menu. Otherwise,
1274
            // we'd needlessly re-run _menu_build_tree() queries for every menu
1275
            // on every page.
1276
            if ($active_link['menu_name'] == $menu_name) {
1277
              // Use all the coordinates, except the last one because there
1278
              // can be no child beyond the last column.
1279
              for ($i = 1; $i < MENU_MAX_DEPTH; $i++) {
1280
                if ($active_link['p' . $i]) {
1281
                  $active_trail[$active_link['p' . $i]] = $active_link['p' . $i];
1282
                }
1283
              }
1284
              // If we are asked to build links for the active trail only, skip
1285
              // the entire 'expanded' handling.
1286
              if ($only_active_trail) {
1287
                $tree_parameters['only_active_trail'] = TRUE;
1288
              }
1289
            }
1290
          }
1291
          $parents = $active_trail;
1292

    
1293
          $expanded = variable_get('menu_expanded', array());
1294
          // Check whether the current menu has any links set to be expanded.
1295
          if (!$only_active_trail && in_array($menu_name, $expanded)) {
1296
            // Collect all the links set to be expanded, and then add all of
1297
            // their children to the list as well.
1298
            do {
1299
              $result = db_select('menu_links', NULL, array('fetch' => PDO::FETCH_ASSOC))
1300
                ->fields('menu_links', array('mlid'))
1301
                ->condition('menu_name', $menu_name)
1302
                ->condition('expanded', 1)
1303
                ->condition('has_children', 1)
1304
                ->condition('plid', $parents, 'IN')
1305
                ->condition('mlid', $parents, 'NOT IN')
1306
                ->execute();
1307
              $num_rows = FALSE;
1308
              foreach ($result as $item) {
1309
                $parents[$item['mlid']] = $item['mlid'];
1310
                $num_rows = TRUE;
1311
              }
1312
            } while ($num_rows);
1313
          }
1314
          $tree_parameters['expanded'] = $parents;
1315
          $tree_parameters['active_trail'] = $active_trail;
1316
        }
1317
        // If access is denied, we only show top-level links in menus.
1318
        else {
1319
          $tree_parameters['expanded'] = $active_trail;
1320
          $tree_parameters['active_trail'] = $active_trail;
1321
        }
1322
        // Cache the tree building parameters using the page-specific cid.
1323
        cache_set($cid, $tree_parameters, 'cache_menu');
1324
      }
1325

    
1326
      // Build the tree using the parameters; the resulting tree will be cached
1327
      // by _menu_build_tree().
1328
      $tree[$cid] = menu_build_tree($menu_name, $tree_parameters);
1329
    }
1330
    return $tree[$cid];
1331
  }
1332

    
1333
  return array();
1334
}
1335

    
1336
/**
1337
 * Builds a menu tree, translates links, and checks access.
1338
 *
1339
 * @param $menu_name
1340
 *   The name of the menu.
1341
 * @param $parameters
1342
 *   (optional) An associative array of build parameters. Possible keys:
1343
 *   - expanded: An array of parent link ids to return only menu links that are
1344
 *     children of one of the plids in this list. If empty, the whole menu tree
1345
 *     is built, unless 'only_active_trail' is TRUE.
1346
 *   - active_trail: An array of mlids, representing the coordinates of the
1347
 *     currently active menu link.
1348
 *   - only_active_trail: Whether to only return links that are in the active
1349
 *     trail. This option is ignored, if 'expanded' is non-empty. Internally
1350
 *     used for breadcrumbs.
1351
 *   - min_depth: The minimum depth of menu links in the resulting tree.
1352
 *     Defaults to 1, which is the default to build a whole tree for a menu
1353
 *     (excluding menu container itself).
1354
 *   - max_depth: The maximum depth of menu links in the resulting tree.
1355
 *   - conditions: An associative array of custom database select query
1356
 *     condition key/value pairs; see _menu_build_tree() for the actual query.
1357
 *
1358
 * @return
1359
 *   A fully built menu tree.
1360
 */
1361
function menu_build_tree($menu_name, array $parameters = array()) {
1362
  // Build the menu tree.
1363
  $data = _menu_build_tree($menu_name, $parameters);
1364
  // Check access for the current user to each item in the tree.
1365
  menu_tree_check_access($data['tree'], $data['node_links']);
1366
  return $data['tree'];
1367
}
1368

    
1369
/**
1370
 * Builds a menu tree.
1371
 *
1372
 * This function may be used build the data for a menu tree only, for example
1373
 * to further massage the data manually before further processing happens.
1374
 * menu_tree_check_access() needs to be invoked afterwards.
1375
 *
1376
 * @see menu_build_tree()
1377
 */
1378
function _menu_build_tree($menu_name, array $parameters = array()) {
1379
  // Static cache of already built menu trees.
1380
  $trees = &drupal_static(__FUNCTION__, array());
1381

    
1382
  // Build the cache id; sort parents to prevent duplicate storage and remove
1383
  // default parameter values.
1384
  if (isset($parameters['expanded'])) {
1385
    sort($parameters['expanded']);
1386
  }
1387
  $tree_cid = 'links:' . $menu_name . ':tree-data:' . $GLOBALS['language']->language . ':' . hash('sha256', serialize($parameters));
1388

    
1389
  // If we do not have this tree in the static cache, check {cache_menu}.
1390
  if (!isset($trees[$tree_cid])) {
1391
    $cache = cache_get($tree_cid, 'cache_menu');
1392
    if ($cache && isset($cache->data)) {
1393
      $trees[$tree_cid] = $cache->data;
1394
    }
1395
  }
1396

    
1397
  if (!isset($trees[$tree_cid])) {
1398
    // Select the links from the table, and recursively build the tree. We
1399
    // LEFT JOIN since there is no match in {menu_router} for an external
1400
    // link.
1401
    $query = db_select('menu_links', 'ml', array('fetch' => PDO::FETCH_ASSOC));
1402
    $query->addTag('translatable');
1403
    $query->leftJoin('menu_router', 'm', 'm.path = ml.router_path');
1404
    $query->fields('ml');
1405
    $query->fields('m', array(
1406
      'load_functions',
1407
      'to_arg_functions',
1408
      'access_callback',
1409
      'access_arguments',
1410
      'page_callback',
1411
      'page_arguments',
1412
      'delivery_callback',
1413
      'tab_parent',
1414
      'tab_root',
1415
      'title',
1416
      'title_callback',
1417
      'title_arguments',
1418
      'theme_callback',
1419
      'theme_arguments',
1420
      'type',
1421
      'description',
1422
    ));
1423
    for ($i = 1; $i <= MENU_MAX_DEPTH; $i++) {
1424
      $query->orderBy('p' . $i, 'ASC');
1425
    }
1426
    $query->condition('ml.menu_name', $menu_name);
1427
    if (!empty($parameters['expanded'])) {
1428
      $query->condition('ml.plid', $parameters['expanded'], 'IN');
1429
    }
1430
    elseif (!empty($parameters['only_active_trail'])) {
1431
      $query->condition('ml.mlid', $parameters['active_trail'], 'IN');
1432
    }
1433
    $min_depth = (isset($parameters['min_depth']) ? $parameters['min_depth'] : 1);
1434
    if ($min_depth != 1) {
1435
      $query->condition('ml.depth', $min_depth, '>=');
1436
    }
1437
    if (isset($parameters['max_depth'])) {
1438
      $query->condition('ml.depth', $parameters['max_depth'], '<=');
1439
    }
1440
    // Add custom query conditions, if any were passed.
1441
    if (isset($parameters['conditions'])) {
1442
      foreach ($parameters['conditions'] as $column => $value) {
1443
        $query->condition($column, $value);
1444
      }
1445
    }
1446

    
1447
    // Build an ordered array of links using the query result object.
1448
    $links = array();
1449
    foreach ($query->execute() as $item) {
1450
      $links[] = $item;
1451
    }
1452
    $active_trail = (isset($parameters['active_trail']) ? $parameters['active_trail'] : array());
1453
    $data['tree'] = menu_tree_data($links, $active_trail, $min_depth);
1454
    $data['node_links'] = array();
1455
    menu_tree_collect_node_links($data['tree'], $data['node_links']);
1456

    
1457
    // Cache the data, if it is not already in the cache.
1458
    cache_set($tree_cid, $data, 'cache_menu');
1459
    $trees[$tree_cid] = $data;
1460
  }
1461

    
1462
  return $trees[$tree_cid];
1463
}
1464

    
1465
/**
1466
 * Collects node links from a given menu tree recursively.
1467
 *
1468
 * @param $tree
1469
 *   The menu tree you wish to collect node links from.
1470
 * @param $node_links
1471
 *   An array in which to store the collected node links.
1472
 */
1473
function menu_tree_collect_node_links(&$tree, &$node_links) {
1474
  foreach ($tree as $key => $v) {
1475
    if ($tree[$key]['link']['router_path'] == 'node/%') {
1476
      $nid = substr($tree[$key]['link']['link_path'], 5);
1477
      if (is_numeric($nid)) {
1478
        $node_links[$nid][$tree[$key]['link']['mlid']] = &$tree[$key]['link'];
1479
        $tree[$key]['link']['access'] = FALSE;
1480
      }
1481
    }
1482
    if ($tree[$key]['below']) {
1483
      menu_tree_collect_node_links($tree[$key]['below'], $node_links);
1484
    }
1485
  }
1486
}
1487

    
1488
/**
1489
 * Checks access and performs dynamic operations for each link in the tree.
1490
 *
1491
 * @param $tree
1492
 *   The menu tree you wish to operate on.
1493
 * @param $node_links
1494
 *   A collection of node link references generated from $tree by
1495
 *   menu_tree_collect_node_links().
1496
 */
1497
function menu_tree_check_access(&$tree, $node_links = array()) {
1498
  if ($node_links && (user_access('access content') || user_access('bypass node access'))) {
1499
    $nids = array_keys($node_links);
1500
    $select = db_select('node', 'n');
1501
    $select->addField('n', 'nid');
1502
    $select->condition('n.status', 1);
1503
    $select->condition('n.nid', $nids, 'IN');
1504
    $select->addTag('node_access');
1505
    $nids = $select->execute()->fetchCol();
1506
    foreach ($nids as $nid) {
1507
      foreach ($node_links[$nid] as $mlid => $link) {
1508
        $node_links[$nid][$mlid]['access'] = TRUE;
1509
      }
1510
    }
1511
  }
1512
  _menu_tree_check_access($tree);
1513
}
1514

    
1515
/**
1516
 * Sorts the menu tree and recursively checks access for each item.
1517
 */
1518
function _menu_tree_check_access(&$tree) {
1519
  $new_tree = array();
1520
  foreach ($tree as $key => $v) {
1521
    $item = &$tree[$key]['link'];
1522
    _menu_link_translate($item);
1523
    if ($item['access'] || ($item['in_active_trail'] && strpos($item['href'], '%') !== FALSE)) {
1524
      if ($tree[$key]['below']) {
1525
        _menu_tree_check_access($tree[$key]['below']);
1526
      }
1527
      // The weights are made a uniform 5 digits by adding 50000 as an offset.
1528
      // After _menu_link_translate(), $item['title'] has the localized link title.
1529
      // Adding the mlid to the end of the index insures that it is unique.
1530
      $new_tree[(50000 + $item['weight']) . ' ' . $item['title'] . ' ' . $item['mlid']] = $tree[$key];
1531
    }
1532
  }
1533
  // Sort siblings in the tree based on the weights and localized titles.
1534
  ksort($new_tree);
1535
  $tree = $new_tree;
1536
}
1537

    
1538
/**
1539
 * Sorts and returns the built data representing a menu tree.
1540
 *
1541
 * @param $links
1542
 *   A flat array of menu links that are part of the menu. Each array element
1543
 *   is an associative array of information about the menu link, containing the
1544
 *   fields from the {menu_links} table, and optionally additional information
1545
 *   from the {menu_router} table, if the menu item appears in both tables.
1546
 *   This array must be ordered depth-first. See _menu_build_tree() for a sample
1547
 *   query.
1548
 * @param $parents
1549
 *   An array of the menu link ID values that are in the path from the current
1550
 *   page to the root of the menu tree.
1551
 * @param $depth
1552
 *   The minimum depth to include in the returned menu tree.
1553
 *
1554
 * @return
1555
 *   An array of menu links in the form of a tree. Each item in the tree is an
1556
 *   associative array containing:
1557
 *   - link: The menu link item from $links, with additional element
1558
 *     'in_active_trail' (TRUE if the link ID was in $parents).
1559
 *   - below: An array containing the sub-tree of this item, where each element
1560
 *     is a tree item array with 'link' and 'below' elements. This array will be
1561
 *     empty if the menu item has no items in its sub-tree having a depth
1562
 *     greater than or equal to $depth.
1563
 */
1564
function menu_tree_data(array $links, array $parents = array(), $depth = 1) {
1565
  // Reverse the array so we can use the more efficient array_pop() function.
1566
  $links = array_reverse($links);
1567
  return _menu_tree_data($links, $parents, $depth);
1568
}
1569

    
1570
/**
1571
 * Builds the data representing a menu tree.
1572
 *
1573
 * The function is a bit complex because the rendering of a link depends on
1574
 * the next menu link.
1575
 */
1576
function _menu_tree_data(&$links, $parents, $depth) {
1577
  $tree = array();
1578
  while ($item = array_pop($links)) {
1579
    // We need to determine if we're on the path to root so we can later build
1580
    // the correct active trail and breadcrumb.
1581
    $item['in_active_trail'] = in_array($item['mlid'], $parents);
1582
    // Add the current link to the tree.
1583
    $tree[$item['mlid']] = array(
1584
      'link' => $item,
1585
      'below' => array(),
1586
    );
1587
    // Look ahead to the next link, but leave it on the array so it's available
1588
    // to other recursive function calls if we return or build a sub-tree.
1589
    $next = end($links);
1590
    // Check whether the next link is the first in a new sub-tree.
1591
    if ($next && $next['depth'] > $depth) {
1592
      // Recursively call _menu_tree_data to build the sub-tree.
1593
      $tree[$item['mlid']]['below'] = _menu_tree_data($links, $parents, $next['depth']);
1594
      // Fetch next link after filling the sub-tree.
1595
      $next = end($links);
1596
    }
1597
    // Determine if we should exit the loop and return.
1598
    if (!$next || $next['depth'] < $depth) {
1599
      break;
1600
    }
1601
  }
1602
  return $tree;
1603
}
1604

    
1605
/**
1606
 * Implements template_preprocess_HOOK() for theme_menu_tree().
1607
 */
1608
function template_preprocess_menu_tree(&$variables) {
1609
  $variables['tree'] = $variables['tree']['#children'];
1610
}
1611

    
1612
/**
1613
 * Returns HTML for a wrapper for a menu sub-tree.
1614
 *
1615
 * @param $variables
1616
 *   An associative array containing:
1617
 *   - tree: An HTML string containing the tree's items.
1618
 *
1619
 * @see template_preprocess_menu_tree()
1620
 * @ingroup themeable
1621
 */
1622
function theme_menu_tree($variables) {
1623
  return '<ul class="menu">' . $variables['tree'] . '</ul>';
1624
}
1625

    
1626
/**
1627
 * Returns HTML for a menu link and submenu.
1628
 *
1629
 * @param $variables
1630
 *   An associative array containing:
1631
 *   - element: Structured array data for a menu link.
1632
 *
1633
 * @ingroup themeable
1634
 */
1635
function theme_menu_link(array $variables) {
1636
  $element = $variables['element'];
1637
  $sub_menu = '';
1638

    
1639
  if ($element['#below']) {
1640
    $sub_menu = drupal_render($element['#below']);
1641
  }
1642
  $output = l($element['#title'], $element['#href'], $element['#localized_options']);
1643
  return '<li' . drupal_attributes($element['#attributes']) . '>' . $output . $sub_menu . "</li>\n";
1644
}
1645

    
1646
/**
1647
 * Returns HTML for a single local task link.
1648
 *
1649
 * @param $variables
1650
 *   An associative array containing:
1651
 *   - element: A render element containing:
1652
 *     - #link: A menu link array with 'title', 'href', and 'localized_options'
1653
 *       keys.
1654
 *     - #active: A boolean indicating whether the local task is active.
1655
 *
1656
 * @ingroup themeable
1657
 */
1658
function theme_menu_local_task($variables) {
1659
  $link = $variables['element']['#link'];
1660
  $link_text = $link['title'];
1661

    
1662
  if (!empty($variables['element']['#active'])) {
1663
    // Add text to indicate active tab for non-visual users.
1664
    $active = '<span class="element-invisible">' . t('(active tab)') . '</span>';
1665

    
1666
    // If the link does not contain HTML already, check_plain() it now.
1667
    // After we set 'html'=TRUE the link will not be sanitized by l().
1668
    if (empty($link['localized_options']['html'])) {
1669
      $link['title'] = check_plain($link['title']);
1670
    }
1671
    $link['localized_options']['html'] = TRUE;
1672
    $link_text = t('!local-task-title!active', array('!local-task-title' => $link['title'], '!active' => $active));
1673
  }
1674

    
1675
  return '<li' . (!empty($variables['element']['#active']) ? ' class="active"' : '') . '>' . l($link_text, $link['href'], $link['localized_options']) . "</li>\n";
1676
}
1677

    
1678
/**
1679
 * Returns HTML for a single local action link.
1680
 *
1681
 * @param $variables
1682
 *   An associative array containing:
1683
 *   - element: A render element containing:
1684
 *     - #link: A menu link array with 'title', 'href', and 'localized_options'
1685
 *       keys.
1686
 *
1687
 * @ingroup themeable
1688
 */
1689
function theme_menu_local_action($variables) {
1690
  $link = $variables['element']['#link'];
1691

    
1692
  $output = '<li>';
1693
  if (isset($link['href'])) {
1694
    $output .= l($link['title'], $link['href'], isset($link['localized_options']) ? $link['localized_options'] : array());
1695
  }
1696
  elseif (!empty($link['localized_options']['html'])) {
1697
    $output .= $link['title'];
1698
  }
1699
  else {
1700
    $output .= check_plain($link['title']);
1701
  }
1702
  $output .= "</li>\n";
1703

    
1704
  return $output;
1705
}
1706

    
1707
/**
1708
 * Generates elements for the $arg array in the help hook.
1709
 */
1710
function drupal_help_arg($arg = array()) {
1711
  // Note - the number of empty elements should be > MENU_MAX_PARTS.
1712
  return $arg + array('', '', '', '', '', '', '', '', '', '', '', '');
1713
}
1714

    
1715
/**
1716
 * Returns the help associated with the active menu item.
1717
 */
1718
function menu_get_active_help() {
1719
  $output = '';
1720
  $router_path = menu_tab_root_path();
1721
  // We will always have a path unless we are on a 403 or 404.
1722
  if (!$router_path) {
1723
    return '';
1724
  }
1725

    
1726
  $arg = drupal_help_arg(arg(NULL));
1727

    
1728
  foreach (module_implements('help') as $module) {
1729
    $function = $module . '_help';
1730
    // Lookup help for this path.
1731
    if ($help = $function($router_path, $arg)) {
1732
      $output .= $help . "\n";
1733
    }
1734
  }
1735
  return $output;
1736
}
1737

    
1738
/**
1739
 * Gets the custom theme for the current page, if there is one.
1740
 *
1741
 * @param $initialize
1742
 *   This parameter should only be used internally; it is set to TRUE in order
1743
 *   to force the custom theme to be initialized for the current page request.
1744
 *
1745
 * @return
1746
 *   The machine-readable name of the custom theme, if there is one.
1747
 *
1748
 * @see menu_set_custom_theme()
1749
 */
1750
function menu_get_custom_theme($initialize = FALSE) {
1751
  $custom_theme = &drupal_static(__FUNCTION__);
1752
  // Skip this if the site is offline or being installed or updated, since the
1753
  // menu system may not be correctly initialized then.
1754
  if ($initialize && !_menu_site_is_offline(TRUE) && (!defined('MAINTENANCE_MODE') || (MAINTENANCE_MODE != 'update' && MAINTENANCE_MODE != 'install'))) {
1755
    // First allow modules to dynamically set a custom theme for the current
1756
    // page. Since we can only have one, the last module to return a valid
1757
    // theme takes precedence.
1758
    $custom_themes = array_filter(module_invoke_all('custom_theme'), 'drupal_theme_access');
1759
    if (!empty($custom_themes)) {
1760
      $custom_theme = array_pop($custom_themes);
1761
    }
1762
    // If there is a theme callback function for the current page, execute it.
1763
    // If this returns a valid theme, it will override any theme that was set
1764
    // by a hook_custom_theme() implementation above.
1765
    $router_item = menu_get_item();
1766
    if (!empty($router_item['access']) && !empty($router_item['theme_callback']) && function_exists($router_item['theme_callback'])) {
1767
      $theme_name = call_user_func_array($router_item['theme_callback'], $router_item['theme_arguments']);
1768
      if (drupal_theme_access($theme_name)) {
1769
        $custom_theme = $theme_name;
1770
      }
1771
    }
1772
  }
1773
  return $custom_theme;
1774
}
1775

    
1776
/**
1777
 * Sets a custom theme for the current page, if there is one.
1778
 */
1779
function menu_set_custom_theme() {
1780
  menu_get_custom_theme(TRUE);
1781
}
1782

    
1783
/**
1784
 * Build a list of named menus.
1785
 */
1786
function menu_get_names() {
1787
  $names = &drupal_static(__FUNCTION__);
1788

    
1789
  if (empty($names)) {
1790
    $names = db_select('menu_links')
1791
      ->distinct()
1792
      ->fields('menu_links', array('menu_name'))
1793
      ->orderBy('menu_name')
1794
      ->execute()->fetchCol();
1795
  }
1796
  return $names;
1797
}
1798

    
1799
/**
1800
 * Returns an array containing the names of system-defined (default) menus.
1801
 */
1802
function menu_list_system_menus() {
1803
  return array(
1804
    'navigation' => 'Navigation',
1805
    'management' => 'Management',
1806
    'user-menu' => 'User menu',
1807
    'main-menu' => 'Main menu',
1808
  );
1809
}
1810

    
1811
/**
1812
 * Returns an array of links to be rendered as the Main menu.
1813
 */
1814
function menu_main_menu() {
1815
  return menu_navigation_links(variable_get('menu_main_links_source', 'main-menu'));
1816
}
1817

    
1818
/**
1819
 * Returns an array of links to be rendered as the Secondary links.
1820
 */
1821
function menu_secondary_menu() {
1822

    
1823
  // If the secondary menu source is set as the primary menu, we display the
1824
  // second level of the primary menu.
1825
  if (variable_get('menu_secondary_links_source', 'user-menu') == variable_get('menu_main_links_source', 'main-menu')) {
1826
    return menu_navigation_links(variable_get('menu_main_links_source', 'main-menu'), 1);
1827
  }
1828
  else {
1829
    return menu_navigation_links(variable_get('menu_secondary_links_source', 'user-menu'), 0);
1830
  }
1831
}
1832

    
1833
/**
1834
 * Returns an array of links for a navigation menu.
1835
 *
1836
 * @param $menu_name
1837
 *   The name of the menu.
1838
 * @param $level
1839
 *   Optional, the depth of the menu to be returned.
1840
 *
1841
 * @return
1842
 *   An array of links of the specified menu and level.
1843
 */
1844
function menu_navigation_links($menu_name, $level = 0) {
1845
  // Don't even bother querying the menu table if no menu is specified.
1846
  if (empty($menu_name)) {
1847
    return array();
1848
  }
1849

    
1850
  // Get the menu hierarchy for the current page.
1851
  $tree = menu_tree_page_data($menu_name, $level + 1);
1852

    
1853
  // Go down the active trail until the right level is reached.
1854
  while ($level-- > 0 && $tree) {
1855
    // Loop through the current level's items until we find one that is in trail.
1856
    while ($item = array_shift($tree)) {
1857
      if ($item['link']['in_active_trail']) {
1858
        // If the item is in the active trail, we continue in the subtree.
1859
        $tree = empty($item['below']) ? array() : $item['below'];
1860
        break;
1861
      }
1862
    }
1863
  }
1864

    
1865
  // Create a single level of links.
1866
  $router_item = menu_get_item();
1867
  $links = array();
1868
  foreach ($tree as $item) {
1869
    if (!$item['link']['hidden']) {
1870
      $class = '';
1871
      $l = $item['link']['localized_options'];
1872
      $l['href'] = $item['link']['href'];
1873
      $l['title'] = $item['link']['title'];
1874
      if ($item['link']['in_active_trail']) {
1875
        $class = ' active-trail';
1876
        $l['attributes']['class'][] = 'active-trail';
1877
      }
1878
      // Normally, l() compares the href of every link with $_GET['q'] and sets
1879
      // the active class accordingly. But local tasks do not appear in menu
1880
      // trees, so if the current path is a local task, and this link is its
1881
      // tab root, then we have to set the class manually.
1882
      if ($item['link']['href'] == $router_item['tab_root_href'] && $item['link']['href'] != $_GET['q']) {
1883
        $l['attributes']['class'][] = 'active';
1884
      }
1885
      // Keyed with the unique mlid to generate classes in theme_links().
1886
      $links['menu-' . $item['link']['mlid'] . $class] = $l;
1887
    }
1888
  }
1889
  return $links;
1890
}
1891

    
1892
/**
1893
 * Collects the local tasks (tabs), action links, and the root path.
1894
 *
1895
 * @param $level
1896
 *   The level of tasks you ask for. Primary tasks are 0, secondary are 1.
1897
 *
1898
 * @return
1899
 *   An array containing
1900
 *   - tabs: Local tasks for the requested level:
1901
 *     - count: The number of local tasks.
1902
 *     - output: The themed output of local tasks.
1903
 *   - actions: Action links for the requested level:
1904
 *     - count: The number of action links.
1905
 *     - output: The themed output of action links.
1906
 *   - root_path: The router path for the current page. If the current page is
1907
 *     a default local task, then this corresponds to the parent tab.
1908
 */
1909
function menu_local_tasks($level = 0) {
1910
  $data = &drupal_static(__FUNCTION__);
1911
  $root_path = &drupal_static(__FUNCTION__ . ':root_path', '');
1912
  $empty = array(
1913
    'tabs' => array('count' => 0, 'output' => array()),
1914
    'actions' => array('count' => 0, 'output' => array()),
1915
    'root_path' => &$root_path,
1916
  );
1917

    
1918
  if (!isset($data)) {
1919
    $data = array();
1920
    // Set defaults in case there are no actions or tabs.
1921
    $actions = $empty['actions'];
1922
    $tabs = array();
1923

    
1924
    $router_item = menu_get_item();
1925

    
1926
    // If this router item points to its parent, start from the parents to
1927
    // compute tabs and actions.
1928
    if ($router_item && ($router_item['type'] & MENU_LINKS_TO_PARENT)) {
1929
      $router_item = menu_get_item($router_item['tab_parent_href']);
1930
    }
1931

    
1932
    // If we failed to fetch a router item or the current user doesn't have
1933
    // access to it, don't bother computing the tabs.
1934
    if (!$router_item || !$router_item['access']) {
1935
      return $empty;
1936
    }
1937

    
1938
    // Get all tabs (also known as local tasks) and the root page.
1939
    $cid = 'local_tasks:' . $router_item['tab_root'];
1940
    if ($cache = cache_get($cid, 'cache_menu')) {
1941
      $result = $cache->data;
1942
    }
1943
    else {
1944
      $result = db_select('menu_router', NULL, array('fetch' => PDO::FETCH_ASSOC))
1945
        ->fields('menu_router')
1946
        ->condition('tab_root', $router_item['tab_root'])
1947
        ->condition('context', MENU_CONTEXT_INLINE, '<>')
1948
        ->orderBy('weight')
1949
        ->orderBy('title')
1950
        ->execute()
1951
        ->fetchAll();
1952
      cache_set($cid, $result, 'cache_menu');
1953
    }
1954
    $map = $router_item['original_map'];
1955
    $children = array();
1956
    $tasks = array();
1957
    $root_path = $router_item['path'];
1958

    
1959
    foreach ($result as $item) {
1960
      _menu_translate($item, $map, TRUE);
1961
      if ($item['tab_parent']) {
1962
        // All tabs, but not the root page.
1963
        $children[$item['tab_parent']][$item['path']] = $item;
1964
      }
1965
      // Store the translated item for later use.
1966
      $tasks[$item['path']] = $item;
1967
    }
1968

    
1969
    // Find all tabs below the current path.
1970
    $path = $router_item['path'];
1971
    // Tab parenting may skip levels, so the number of parts in the path may not
1972
    // equal the depth. Thus we use the $depth counter (offset by 1000 for ksort).
1973
    $depth = 1001;
1974
    $actions['count'] = 0;
1975
    $actions['output'] = array();
1976
    while (isset($children[$path])) {
1977
      $tabs_current = array();
1978
      $actions_current = array();
1979
      $next_path = '';
1980
      $tab_count = 0;
1981
      $action_count = 0;
1982
      foreach ($children[$path] as $item) {
1983
        // Local tasks can be normal items too, so bitmask with
1984
        // MENU_IS_LOCAL_TASK before checking.
1985
        if (!($item['type'] & MENU_IS_LOCAL_TASK)) {
1986
          // This item is not a tab, skip it.
1987
          continue;
1988
        }
1989
        if ($item['access']) {
1990
          $link = $item;
1991
          // The default task is always active. As tabs can be normal items
1992
          // too, so bitmask with MENU_LINKS_TO_PARENT before checking.
1993
          if (($item['type'] & MENU_LINKS_TO_PARENT) == MENU_LINKS_TO_PARENT) {
1994
            // Find the first parent which is not a default local task or action.
1995
            for ($p = $item['tab_parent']; ($tasks[$p]['type'] & MENU_LINKS_TO_PARENT) == MENU_LINKS_TO_PARENT; $p = $tasks[$p]['tab_parent']);
1996
            // Use the path of the parent instead.
1997
            $link['href'] = $tasks[$p]['href'];
1998
            // Mark the link as active, if the current path happens to be the
1999
            // path of the default local task itself (i.e., instead of its
2000
            // tab_parent_href or tab_root_href). Normally, links for default
2001
            // local tasks link to their parent, but the path of default local
2002
            // tasks can still be accessed directly, in which case this link
2003
            // would not be marked as active, since l() only compares the href
2004
            // with $_GET['q'].
2005
            if ($link['href'] != $_GET['q']) {
2006
              $link['localized_options']['attributes']['class'][] = 'active';
2007
            }
2008
            $tabs_current[] = array(
2009
              '#theme' => 'menu_local_task',
2010
              '#link' => $link,
2011
              '#active' => TRUE,
2012
            );
2013
            $next_path = $item['path'];
2014
            $tab_count++;
2015
          }
2016
          else {
2017
            // Actions can be normal items too, so bitmask with
2018
            // MENU_IS_LOCAL_ACTION before checking.
2019
            if (($item['type'] & MENU_IS_LOCAL_ACTION) == MENU_IS_LOCAL_ACTION) {
2020
              // The item is an action, display it as such.
2021
              $actions_current[] = array(
2022
                '#theme' => 'menu_local_action',
2023
                '#link' => $link,
2024
              );
2025
              $action_count++;
2026
            }
2027
            else {
2028
              // Otherwise, it's a normal tab.
2029
              $tabs_current[] = array(
2030
                '#theme' => 'menu_local_task',
2031
                '#link' => $link,
2032
              );
2033
              $tab_count++;
2034
            }
2035
          }
2036
        }
2037
      }
2038
      $path = $next_path;
2039
      $tabs[$depth]['count'] = $tab_count;
2040
      $tabs[$depth]['output'] = $tabs_current;
2041
      $actions['count'] += $action_count;
2042
      $actions['output'] = array_merge($actions['output'], $actions_current);
2043
      $depth++;
2044
    }
2045
    $data['actions'] = $actions;
2046
    // Find all tabs at the same level or above the current one.
2047
    $parent = $router_item['tab_parent'];
2048
    $path = $router_item['path'];
2049
    $current = $router_item;
2050
    $depth = 1000;
2051
    while (isset($children[$parent])) {
2052
      $tabs_current = array();
2053
      $next_path = '';
2054
      $next_parent = '';
2055
      $count = 0;
2056
      foreach ($children[$parent] as $item) {
2057
        // Skip local actions.
2058
        if ($item['type'] & MENU_IS_LOCAL_ACTION) {
2059
          continue;
2060
        }
2061
        if ($item['access']) {
2062
          $count++;
2063
          $link = $item;
2064
          // Local tasks can be normal items too, so bitmask with
2065
          // MENU_LINKS_TO_PARENT before checking.
2066
          if (($item['type'] & MENU_LINKS_TO_PARENT) == MENU_LINKS_TO_PARENT) {
2067
            // Find the first parent which is not a default local task.
2068
            for ($p = $item['tab_parent']; ($tasks[$p]['type'] & MENU_LINKS_TO_PARENT) == MENU_LINKS_TO_PARENT; $p = $tasks[$p]['tab_parent']);
2069
            // Use the path of the parent instead.
2070
            $link['href'] = $tasks[$p]['href'];
2071
            if ($item['path'] == $router_item['path']) {
2072
              $root_path = $tasks[$p]['path'];
2073
            }
2074
          }
2075
          // We check for the active tab.
2076
          if ($item['path'] == $path) {
2077
            // Mark the link as active, if the current path is a (second-level)
2078
            // local task of a default local task. Since this default local task
2079
            // links to its parent, l() will not mark it as active, as it only
2080
            // compares the link's href to $_GET['q'].
2081
            if ($link['href'] != $_GET['q']) {
2082
              $link['localized_options']['attributes']['class'][] = 'active';
2083
            }
2084
            $tabs_current[] = array(
2085
              '#theme' => 'menu_local_task',
2086
              '#link' => $link,
2087
              '#active' => TRUE,
2088
            );
2089
            $next_path = $item['tab_parent'];
2090
            if (isset($tasks[$next_path])) {
2091
              $next_parent = $tasks[$next_path]['tab_parent'];
2092
            }
2093
          }
2094
          else {
2095
            $tabs_current[] = array(
2096
              '#theme' => 'menu_local_task',
2097
              '#link' => $link,
2098
            );
2099
          }
2100
        }
2101
      }
2102
      $path = $next_path;
2103
      $parent = $next_parent;
2104
      $tabs[$depth]['count'] = $count;
2105
      $tabs[$depth]['output'] = $tabs_current;
2106
      $depth--;
2107
    }
2108
    // Sort by depth.
2109
    ksort($tabs);
2110
    // Remove the depth, we are interested only in their relative placement.
2111
    $tabs = array_values($tabs);
2112
    $data['tabs'] = $tabs;
2113

    
2114
    // Allow modules to alter local tasks or dynamically append further tasks.
2115
    drupal_alter('menu_local_tasks', $data, $router_item, $root_path);
2116
  }
2117

    
2118
  if (isset($data['tabs'][$level])) {
2119
    return array(
2120
      'tabs' => $data['tabs'][$level],
2121
      'actions' => $data['actions'],
2122
      'root_path' => $root_path,
2123
    );
2124
  }
2125
  // @todo If there are no tabs, then there still can be actions; for example,
2126
  //   when added via hook_menu_local_tasks_alter().
2127
  elseif (!empty($data['actions']['output'])) {
2128
    return array('actions' => $data['actions']) + $empty;
2129
  }
2130
  return $empty;
2131
}
2132

    
2133
/**
2134
 * Retrieves contextual links for a path based on registered local tasks.
2135
 *
2136
 * This leverages the menu system to retrieve the first layer of registered
2137
 * local tasks for a given system path. All local tasks of the tab type
2138
 * MENU_CONTEXT_INLINE are taken into account.
2139
 *
2140
 * For example, when considering the following registered local tasks:
2141
 * - node/%node/view (default local task) with no 'context' defined
2142
 * - node/%node/edit with context: MENU_CONTEXT_PAGE | MENU_CONTEXT_INLINE
2143
 * - node/%node/revisions with context: MENU_CONTEXT_PAGE
2144
 * - node/%node/report-as-spam with context: MENU_CONTEXT_INLINE
2145
 *
2146
 * If the path "node/123" is passed to this function, then it will return the
2147
 * links for 'edit' and 'report-as-spam'.
2148
 *
2149
 * @param $module
2150
 *   The name of the implementing module. This is used to prefix the key for
2151
 *   each contextual link, which is transformed into a CSS class during
2152
 *   rendering by theme_links(). For example, if $module is 'block' and the
2153
 *   retrieved local task path argument is 'edit', then the resulting CSS class
2154
 *   will be 'block-edit'.
2155
 * @param $parent_path
2156
 *   The static menu router path of the object to retrieve local tasks for, for
2157
 *   example 'node' or 'admin/structure/block/manage'.
2158
 * @param $args
2159
 *   A list of dynamic path arguments to append to $parent_path to form the
2160
 *   fully-qualified menu router path; for example, array(123) for a certain
2161
 *   node or array('system', 'navigation') for a certain block.
2162
 *
2163
 * @return
2164
 *   A list of menu router items that are local tasks for the passed-in path.
2165
 *
2166
 * @see contextual_links_preprocess()
2167
 * @see hook_menu()
2168
 */
2169
function menu_contextual_links($module, $parent_path, $args) {
2170
  static $path_empty = array();
2171

    
2172
  $links = array();
2173
  // Performance: In case a previous invocation for the same parent path did not
2174
  // return any links, we immediately return here.
2175
  if (isset($path_empty[$parent_path]) && strpos($parent_path, '%') !== FALSE) {
2176
    return $links;
2177
  }
2178
  // Construct the item-specific parent path.
2179
  $path = $parent_path . '/' . implode('/', $args);
2180

    
2181
  // Get the router item for the given parent link path.
2182
  $router_item = menu_get_item($path);
2183
  if (!$router_item || !$router_item['access']) {
2184
    $path_empty[$parent_path] = TRUE;
2185
    return $links;
2186
  }
2187
  $data = &drupal_static(__FUNCTION__, array());
2188
  $root_path = $router_item['path'];
2189

    
2190
  // Performance: For a single, normalized path (such as 'node/%') we only query
2191
  // available tasks once per request.
2192
  if (!isset($data[$root_path])) {
2193
    // Get all contextual links that are direct children of the router item and
2194
    // not of the tab type 'view'.
2195
    $data[$root_path] = db_select('menu_router', 'm')
2196
      ->fields('m')
2197
      ->condition('tab_parent', $router_item['tab_root'])
2198
      ->condition('context', MENU_CONTEXT_NONE, '<>')
2199
      ->condition('context', MENU_CONTEXT_PAGE, '<>')
2200
      ->orderBy('weight')
2201
      ->orderBy('title')
2202
      ->execute()
2203
      ->fetchAllAssoc('path', PDO::FETCH_ASSOC);
2204
  }
2205
  $parent_length = drupal_strlen($root_path) + 1;
2206
  $map = $router_item['original_map'];
2207
  foreach ($data[$root_path] as $item) {
2208
    // Extract the actual "task" string from the path argument.
2209
    $key = drupal_substr($item['path'], $parent_length);
2210

    
2211
    // Denormalize and translate the contextual link.
2212
    _menu_translate($item, $map, TRUE);
2213
    if (!$item['access']) {
2214
      continue;
2215
    }
2216
    // All contextual links are keyed by the actual "task" path argument,
2217
    // prefixed with the name of the implementing module.
2218
    $links[$module . '-' . $key] = $item;
2219
  }
2220

    
2221
  // Allow modules to alter contextual links.
2222
  drupal_alter('menu_contextual_links', $links, $router_item, $root_path);
2223

    
2224
  // Performance: If the current user does not have access to any links for this
2225
  // router path and no other module added further links, we assign FALSE here
2226
  // to skip the entire process the next time the same router path is requested.
2227
  if (empty($links)) {
2228
    $path_empty[$parent_path] = TRUE;
2229
  }
2230

    
2231
  return $links;
2232
}
2233

    
2234
/**
2235
 * Returns the rendered local tasks at the top level.
2236
 */
2237
function menu_primary_local_tasks() {
2238
  $links = menu_local_tasks(0);
2239
  // Do not display single tabs.
2240
  return ($links['tabs']['count'] > 1 ? $links['tabs']['output'] : '');
2241
}
2242

    
2243
/**
2244
 * Returns the rendered local tasks at the second level.
2245
 */
2246
function menu_secondary_local_tasks() {
2247
  $links = menu_local_tasks(1);
2248
  // Do not display single tabs.
2249
  return ($links['tabs']['count'] > 1 ? $links['tabs']['output'] : '');
2250
}
2251

    
2252
/**
2253
 * Returns the rendered local actions at the current level.
2254
 */
2255
function menu_local_actions() {
2256
  $links = menu_local_tasks();
2257
  return $links['actions']['output'];
2258
}
2259

    
2260
/**
2261
 * Returns the router path, or the path for a default local task's parent.
2262
 */
2263
function menu_tab_root_path() {
2264
  $links = menu_local_tasks();
2265
  return $links['root_path'];
2266
}
2267

    
2268
/**
2269
 * Returns a renderable element for the primary and secondary tabs.
2270
 */
2271
function menu_local_tabs() {
2272
  return array(
2273
    '#theme' => 'menu_local_tasks',
2274
    '#primary' => menu_primary_local_tasks(),
2275
    '#secondary' => menu_secondary_local_tasks(),
2276
  );
2277
}
2278

    
2279
/**
2280
 * Returns HTML for primary and secondary local tasks.
2281
 *
2282
 * @param $variables
2283
 *   An associative array containing:
2284
 *     - primary: (optional) An array of local tasks (tabs).
2285
 *     - secondary: (optional) An array of local tasks (tabs).
2286
 *
2287
 * @ingroup themeable
2288
 * @see menu_local_tasks()
2289
 */
2290
function theme_menu_local_tasks(&$variables) {
2291
  $output = '';
2292

    
2293
  if (!empty($variables['primary'])) {
2294
    $variables['primary']['#prefix'] = '<h2 class="element-invisible">' . t('Primary tabs') . '</h2>';
2295
    $variables['primary']['#prefix'] .= '<ul class="tabs primary">';
2296
    $variables['primary']['#suffix'] = '</ul>';
2297
    $output .= drupal_render($variables['primary']);
2298
  }
2299
  if (!empty($variables['secondary'])) {
2300
    $variables['secondary']['#prefix'] = '<h2 class="element-invisible">' . t('Secondary tabs') . '</h2>';
2301
    $variables['secondary']['#prefix'] .= '<ul class="tabs secondary">';
2302
    $variables['secondary']['#suffix'] = '</ul>';
2303
    $output .= drupal_render($variables['secondary']);
2304
  }
2305

    
2306
  return $output;
2307
}
2308

    
2309
/**
2310
 * Sets (or gets) the active menu for the current page.
2311
 *
2312
 * The active menu for the page determines the active trail.
2313
 *
2314
 * @return
2315
 *   An array of menu machine names, in order of preference. The
2316
 *   'menu_default_active_menus' variable may be used to assert a menu order
2317
 *   different from the order of creation, or to prevent a particular menu from
2318
 *   being used at all in the active trail.
2319
 *   E.g., $conf['menu_default_active_menus'] = array('navigation', 'main-menu')
2320
 */
2321
function menu_set_active_menu_names($menu_names = NULL) {
2322
  $active = &drupal_static(__FUNCTION__);
2323

    
2324
  if (isset($menu_names) && is_array($menu_names)) {
2325
    $active = $menu_names;
2326
  }
2327
  elseif (!isset($active)) {
2328
    $active = variable_get('menu_default_active_menus', array_keys(menu_list_system_menus()));
2329
  }
2330
  return $active;
2331
}
2332

    
2333
/**
2334
 * Gets the active menu for the current page.
2335
 */
2336
function menu_get_active_menu_names() {
2337
  return menu_set_active_menu_names();
2338
}
2339

    
2340
/**
2341
 * Sets the active path, which determines which page is loaded.
2342
 *
2343
 * Note that this may not have the desired effect unless invoked very early
2344
 * in the page load, such as during hook_boot(), or unless you call
2345
 * menu_execute_active_handler() to generate your page output.
2346
 *
2347
 * @param $path
2348
 *   A Drupal path - not a path alias.
2349
 */
2350
function menu_set_active_item($path) {
2351
  $_GET['q'] = $path;
2352
  // Since the active item has changed, the active menu trail may also be out
2353
  // of date.
2354
  drupal_static_reset('menu_set_active_trail');
2355
}
2356

    
2357
/**
2358
 * Sets the active trail (path to the menu tree root) of the current page.
2359
 *
2360
 * Any trail set by this function will only be used for functionality that calls
2361
 * menu_get_active_trail(). Drupal core only uses trails set here for
2362
 * breadcrumbs and the page title and not for menu trees or page content.
2363
 * Additionally, breadcrumbs set by drupal_set_breadcrumb() will override any
2364
 * trail set here.
2365
 *
2366
 * To affect the trail used by menu trees, use menu_tree_set_path(). To affect
2367
 * the page content, use menu_set_active_item() instead.
2368
 *
2369
 * @param $new_trail
2370
 *   Menu trail to set; the value is saved in a static variable and can be
2371
 *   retrieved by menu_get_active_trail(). The format of this array should be
2372
 *   the same as the return value of menu_get_active_trail().
2373
 *
2374
 * @return
2375
 *   The active trail. See menu_get_active_trail() for details.
2376
 */
2377
function menu_set_active_trail($new_trail = NULL) {
2378
  $trail = &drupal_static(__FUNCTION__);
2379

    
2380
  if (isset($new_trail)) {
2381
    $trail = $new_trail;
2382
  }
2383
  elseif (!isset($trail)) {
2384
    $trail = array();
2385
    $trail[] = array(
2386
      'title' => t('Home'),
2387
      'href' => '<front>',
2388
      'link_path' => '',
2389
      'localized_options' => array(),
2390
      'type' => 0,
2391
    );
2392

    
2393
    // Try to retrieve a menu link corresponding to the current path. If more
2394
    // than one exists, the link from the most preferred menu is returned.
2395
    $preferred_link = menu_link_get_preferred();
2396
    $current_item = menu_get_item();
2397

    
2398
    // There is a link for the current path.
2399
    if ($preferred_link) {
2400
      // Pass TRUE for $only_active_trail to make menu_tree_page_data() build
2401
      // a stripped down menu tree containing the active trail only, in case
2402
      // the given menu has not been built in this request yet.
2403
      $tree = menu_tree_page_data($preferred_link['menu_name'], NULL, TRUE);
2404
      list($key, $curr) = each($tree);
2405
    }
2406
    // There is no link for the current path.
2407
    else {
2408
      $preferred_link = $current_item;
2409
      $curr = FALSE;
2410
    }
2411

    
2412
    while ($curr) {
2413
      $link = $curr['link'];
2414
      if ($link['in_active_trail']) {
2415
        // Add the link to the trail, unless it links to its parent.
2416
        if (!($link['type'] & MENU_LINKS_TO_PARENT)) {
2417
          // The menu tree for the active trail may contain additional links
2418
          // that have not been translated yet, since they contain dynamic
2419
          // argument placeholders (%). Such links are not contained in regular
2420
          // menu trees, and have only been loaded for the additional
2421
          // translation that happens here, so as to be able to display them in
2422
          // the breadcrumb for the current page.
2423
          // @see _menu_tree_check_access()
2424
          // @see _menu_link_translate()
2425
          if (strpos($link['href'], '%') !== FALSE) {
2426
            _menu_link_translate($link, TRUE);
2427
          }
2428
          if ($link['access']) {
2429
            $trail[] = $link;
2430
          }
2431
        }
2432
        $tree = $curr['below'] ? $curr['below'] : array();
2433
      }
2434
      list($key, $curr) = each($tree);
2435
    }
2436
    // Make sure the current page is in the trail to build the page title, by
2437
    // appending either the preferred link or the menu router item for the
2438
    // current page. Exclude it if we are on the front page.
2439
    $last = end($trail);
2440
    if ($preferred_link && $last['href'] != $preferred_link['href'] && !drupal_is_front_page()) {
2441
      $trail[] = $preferred_link;
2442
    }
2443
  }
2444
  return $trail;
2445
}
2446

    
2447
/**
2448
 * Looks up the preferred menu link for a given system path.
2449
 *
2450
 * @param $path
2451
 *   The path; for example, 'node/5'. The function will find the corresponding
2452
 *   menu link ('node/5' if it exists, or fallback to 'node/%').
2453
 * @param $selected_menu
2454
 *   The name of a menu used to restrict the search for a preferred menu link.
2455
 *   If not specified, all the menus returned by menu_get_active_menu_names()
2456
 *   will be used.
2457
 *
2458
 * @return
2459
 *   A fully translated menu link, or FALSE if no matching menu link was
2460
 *   found. The most specific menu link ('node/5' preferred over 'node/%') in
2461
 *   the most preferred menu (as defined by menu_get_active_menu_names()) is
2462
 *   returned.
2463
 */
2464
function menu_link_get_preferred($path = NULL, $selected_menu = NULL) {
2465
  $preferred_links = &drupal_static(__FUNCTION__);
2466

    
2467
  if (!isset($path)) {
2468
    $path = $_GET['q'];
2469
  }
2470

    
2471
  if (empty($selected_menu)) {
2472
    // Use an illegal menu name as the key for the preferred menu link.
2473
    $selected_menu = MENU_PREFERRED_LINK;
2474
  }
2475

    
2476
  if (!isset($preferred_links[$path])) {
2477
    // Look for the correct menu link by building a list of candidate paths,
2478
    // which are ordered by priority (translated hrefs are preferred over
2479
    // untranslated paths). Afterwards, the most relevant path is picked from
2480
    // the menus, ordered by menu preference.
2481
    $item = menu_get_item($path);
2482
    $path_candidates = array();
2483
    // 1. The current item href.
2484
    $path_candidates[$item['href']] = $item['href'];
2485
    // 2. The tab root href of the current item (if any).
2486
    if ($item['tab_parent'] && ($tab_root = menu_get_item($item['tab_root_href']))) {
2487
      $path_candidates[$tab_root['href']] = $tab_root['href'];
2488
    }
2489
    // 3. The current item path (with wildcards).
2490
    $path_candidates[$item['path']] = $item['path'];
2491
    // 4. The tab root path of the current item (if any).
2492
    if (!empty($tab_root)) {
2493
      $path_candidates[$tab_root['path']] = $tab_root['path'];
2494
    }
2495

    
2496
    // Retrieve a list of menu names, ordered by preference.
2497
    $menu_names = menu_get_active_menu_names();
2498
    // Put the selected menu at the front of the list.
2499
    array_unshift($menu_names, $selected_menu);
2500

    
2501
    $query = db_select('menu_links', 'ml', array('fetch' => PDO::FETCH_ASSOC));
2502
    $query->leftJoin('menu_router', 'm', 'm.path = ml.router_path');
2503
    $query->fields('ml');
2504
    // Weight must be taken from {menu_links}, not {menu_router}.
2505
    $query->addField('ml', 'weight', 'link_weight');
2506
    $query->fields('m');
2507
    $query->condition('ml.link_path', $path_candidates, 'IN');
2508
    $query->addTag('preferred_menu_links');
2509

    
2510
    // Sort candidates by link path and menu name.
2511
    $candidates = array();
2512
    foreach ($query->execute() as $candidate) {
2513
      $candidate['weight'] = $candidate['link_weight'];
2514
      $candidates[$candidate['link_path']][$candidate['menu_name']] = $candidate;
2515
      // Add any menus not already in the menu name search list.
2516
      if (!in_array($candidate['menu_name'], $menu_names)) {
2517
        $menu_names[] = $candidate['menu_name'];
2518
      }
2519
    }
2520

    
2521
    // Store the most specific link for each menu. Also save the most specific
2522
    // link of the most preferred menu in $preferred_link.
2523
    foreach ($path_candidates as $link_path) {
2524
      if (isset($candidates[$link_path])) {
2525
        foreach ($menu_names as $menu_name) {
2526
          if (empty($preferred_links[$path][$menu_name]) && isset($candidates[$link_path][$menu_name])) {
2527
            $candidate_item = $candidates[$link_path][$menu_name];
2528
            $map = explode('/', $path);
2529
            _menu_translate($candidate_item, $map);
2530
            if ($candidate_item['access']) {
2531
              $preferred_links[$path][$menu_name] = $candidate_item;
2532
              if (empty($preferred_links[$path][MENU_PREFERRED_LINK])) {
2533
                // Store the most specific link.
2534
                $preferred_links[$path][MENU_PREFERRED_LINK] = $candidate_item;
2535
              }
2536
            }
2537
          }
2538
        }
2539
      }
2540
    }
2541
  }
2542

    
2543
  return isset($preferred_links[$path][$selected_menu]) ? $preferred_links[$path][$selected_menu] : FALSE;
2544
}
2545

    
2546
/**
2547
 * Gets the active trail (path to root menu root) of the current page.
2548
 *
2549
 * If a trail is supplied to menu_set_active_trail(), that value is returned. If
2550
 * a trail is not supplied to menu_set_active_trail(), the path to the current
2551
 * page is calculated and returned. The calculated trail is also saved as a
2552
 * static value for use by subsequent calls to menu_get_active_trail().
2553
 *
2554
 * @return
2555
 *   Path to menu root of the current page, as an array of menu link items,
2556
 *   starting with the site's home page. Each link item is an associative array
2557
 *   with the following components:
2558
 *   - title: Title of the item.
2559
 *   - href: Drupal path of the item.
2560
 *   - localized_options: Options for passing into the l() function.
2561
 *   - type: A menu type constant, such as MENU_DEFAULT_LOCAL_TASK, or 0 to
2562
 *     indicate it's not really in the menu (used for the home page item).
2563
 */
2564
function menu_get_active_trail() {
2565
  return menu_set_active_trail();
2566
}
2567

    
2568
/**
2569
 * Gets the breadcrumb for the current page, as determined by the active trail.
2570
 *
2571
 * @see menu_set_active_trail()
2572
 */
2573
function menu_get_active_breadcrumb() {
2574
  $breadcrumb = array();
2575

    
2576
  // No breadcrumb for the front page.
2577
  if (drupal_is_front_page()) {
2578
    return $breadcrumb;
2579
  }
2580

    
2581
  $item = menu_get_item();
2582
  if (!empty($item['access'])) {
2583
    $active_trail = menu_get_active_trail();
2584

    
2585
    // Allow modules to alter the breadcrumb, if possible, as that is much
2586
    // faster than rebuilding an entirely new active trail.
2587
    drupal_alter('menu_breadcrumb', $active_trail, $item);
2588

    
2589
    // Don't show a link to the current page in the breadcrumb trail.
2590
    $end = end($active_trail);
2591
    if ($item['href'] == $end['href']) {
2592
      array_pop($active_trail);
2593
    }
2594

    
2595
    // Remove the tab root (parent) if the current path links to its parent.
2596
    // Normally, the tab root link is included in the breadcrumb, as soon as we
2597
    // are on a local task or any other child link. However, if we are on a
2598
    // default local task (e.g., node/%/view), then we do not want the tab root
2599
    // link (e.g., node/%) to appear, as it would be identical to the current
2600
    // page. Since this behavior also needs to work recursively (i.e., on
2601
    // default local tasks of default local tasks), and since the last non-task
2602
    // link in the trail is used as page title (see menu_get_active_title()),
2603
    // this condition cannot be cleanly integrated into menu_get_active_trail().
2604
    // menu_get_active_trail() already skips all links that link to their parent
2605
    // (commonly MENU_DEFAULT_LOCAL_TASK). In order to also hide the parent link
2606
    // itself, we always remove the last link in the trail, if the current
2607
    // router item links to its parent.
2608
    if (($item['type'] & MENU_LINKS_TO_PARENT) == MENU_LINKS_TO_PARENT) {
2609
      array_pop($active_trail);
2610
    }
2611

    
2612
    foreach ($active_trail as $parent) {
2613
      $breadcrumb[] = l($parent['title'], $parent['href'], $parent['localized_options']);
2614
    }
2615
  }
2616
  return $breadcrumb;
2617
}
2618

    
2619
/**
2620
 * Gets the title of the current page, as determined by the active trail.
2621
 */
2622
function menu_get_active_title() {
2623
  $active_trail = menu_get_active_trail();
2624
  $local_task_title = NULL;
2625

    
2626
  foreach (array_reverse($active_trail) as $item) {
2627
    // Local task titles are displayed as tabs and therefore should not be
2628
    // repeated as the page title. However, if the local task appears in a
2629
    // top-level menu, it is no longer a "local task" anymore (the front page
2630
    // of the site does not have tabs) so it is better to use the local task
2631
    // title in that case than to fall back on the front page link in the
2632
    // active trail (which is usually "Home" and would not make sense in this
2633
    // context).
2634
    if ((bool) ($item['type'] & MENU_IS_LOCAL_TASK)) {
2635
      // A local task title is being skipped; track it in case it needs to be
2636
      // used later.
2637
      $local_task_title = $item['title'];
2638
    }
2639
    else {
2640
      // This is not a local task, so use it for the page title (unless the
2641
      // conditions described above are met).
2642
      if (isset($local_task_title) && isset($item['href']) && $item['href'] == '<front>') {
2643
        return $local_task_title;
2644
      }
2645
      else {
2646
        return $item['title'];
2647
      }
2648
    }
2649
  }
2650
}
2651

    
2652
/**
2653
 * Gets a translated, access-checked menu link that is ready for rendering.
2654
 *
2655
 * This function should never be called from within node_load() or any other
2656
 * function used as a menu object load function since an infinite recursion may
2657
 * occur.
2658
 *
2659
 * @param $mlid
2660
 *   The mlid of the menu item.
2661
 *
2662
 * @return
2663
 *   A menu link, with $item['access'] filled and link translated for
2664
 *   rendering.
2665
 */
2666
function menu_link_load($mlid) {
2667
  if (is_numeric($mlid)) {
2668
    $query = db_select('menu_links', 'ml');
2669
    $query->leftJoin('menu_router', 'm', 'm.path = ml.router_path');
2670
    $query->fields('ml');
2671
    // Weight should be taken from {menu_links}, not {menu_router}.
2672
    $query->addField('ml', 'weight', 'link_weight');
2673
    $query->fields('m');
2674
    $query->condition('ml.mlid', $mlid);
2675
    if ($item = $query->execute()->fetchAssoc()) {
2676
      $item['weight'] = $item['link_weight'];
2677
      _menu_link_translate($item);
2678
      return $item;
2679
    }
2680
  }
2681
  return FALSE;
2682
}
2683

    
2684
/**
2685
 * Clears the cached cached data for a single named menu.
2686
 */
2687
function menu_cache_clear($menu_name = 'navigation') {
2688
  $cache_cleared = &drupal_static(__FUNCTION__, array());
2689

    
2690
  if (empty($cache_cleared[$menu_name])) {
2691
    cache_clear_all('links:' . $menu_name . ':', 'cache_menu', TRUE);
2692
    $cache_cleared[$menu_name] = 1;
2693
  }
2694
  elseif ($cache_cleared[$menu_name] == 1) {
2695
    drupal_register_shutdown_function('cache_clear_all', 'links:' . $menu_name . ':', 'cache_menu', TRUE);
2696
    $cache_cleared[$menu_name] = 2;
2697
  }
2698

    
2699
  // Also clear the menu system static caches.
2700
  menu_reset_static_cache();
2701
}
2702

    
2703
/**
2704
 * Clears all cached menu data.
2705
 *
2706
 * This should be called any time broad changes
2707
 * might have been made to the router items or menu links.
2708
 */
2709
function menu_cache_clear_all() {
2710
  cache_clear_all('*', 'cache_menu', TRUE);
2711
  menu_reset_static_cache();
2712
}
2713

    
2714
/**
2715
 * Resets the menu system static cache.
2716
 */
2717
function menu_reset_static_cache() {
2718
  drupal_static_reset('_menu_build_tree');
2719
  drupal_static_reset('menu_tree');
2720
  drupal_static_reset('menu_tree_all_data');
2721
  drupal_static_reset('menu_tree_page_data');
2722
  drupal_static_reset('menu_load_all');
2723
  drupal_static_reset('menu_link_get_preferred');
2724
}
2725

    
2726
/**
2727
 * Checks whether a menu_rebuild() is necessary.
2728
 */
2729
function _menu_check_rebuild() {
2730
  // To absolutely ensure that the menu rebuild is required, re-load the
2731
  // variables in case they were set by another process.
2732
  $variables = variable_initialize();
2733
  if (empty($variables['menu_rebuild_needed']) && !empty($variables['menu_masks'])) {
2734
    unset($GLOBALS['conf']['menu_rebuild_needed']);
2735
    $GLOBALS['conf']['menu_masks'] = $variables['menu_masks'];
2736
    return FALSE;
2737
  }
2738
  return TRUE;
2739
}
2740

    
2741
/**
2742
 * Populates the database tables used by various menu functions.
2743
 *
2744
 * This function will clear and populate the {menu_router} table, add entries
2745
 * to {menu_links} for new router items, and then remove stale items from
2746
 * {menu_links}. If called from update.php or install.php, it will also
2747
 * schedule a call to itself on the first real page load from
2748
 * menu_execute_active_handler(), because the maintenance page environment
2749
 * is different and leaves stale data in the menu tables.
2750
 *
2751
 * @return
2752
 *   TRUE if the menu was rebuilt, FALSE if another thread was rebuilding
2753
 *   in parallel and the current thread just waited for completion.
2754
 */
2755
function menu_rebuild() {
2756
  if (!lock_acquire('menu_rebuild')) {
2757
    // Wait for another request that is already doing this work.
2758
    // We choose to block here since otherwise the router item may not
2759
    // be available in menu_execute_active_handler() resulting in a 404.
2760
    lock_wait('menu_rebuild');
2761

    
2762
    if (_menu_check_rebuild()) {
2763
      // If we get here and menu_masks was not set, then it is possible a menu
2764
      // is being reloaded, or that the process rebuilding the menu was unable
2765
      // to complete successfully. A missing menu_masks variable could result
2766
      // in a 404, so re-run the function.
2767
      return menu_rebuild();
2768
    }
2769
    return FALSE;
2770
  }
2771

    
2772
  $transaction = db_transaction();
2773

    
2774
  try {
2775
    list($menu, $masks) = menu_router_build();
2776
    _menu_router_save($menu, $masks);
2777
    _menu_navigation_links_rebuild($menu);
2778
    // Clear the menu, page and block caches.
2779
    menu_cache_clear_all();
2780
    _menu_clear_page_cache();
2781

    
2782
    if (defined('MAINTENANCE_MODE')) {
2783
      variable_set('menu_rebuild_needed', TRUE);
2784
    }
2785
    else {
2786
      variable_del('menu_rebuild_needed');
2787
    }
2788
  }
2789
  catch (Exception $e) {
2790
    $transaction->rollback();
2791
    watchdog_exception('menu', $e);
2792
  }
2793
  // Explicitly commit the transaction now; this ensures that the database
2794
  // operations during the menu rebuild are committed before the lock is made
2795
  // available again, since locks may not always reside in the same database
2796
  // connection. The lock is acquired outside of the transaction so should also
2797
  // be released outside of it.
2798
  unset($transaction);
2799

    
2800
  lock_release('menu_rebuild');
2801
  return TRUE;
2802
}
2803

    
2804
/**
2805
 * Collects and alters the menu definitions.
2806
 */
2807
function menu_router_build() {
2808
  // We need to manually call each module so that we can know which module
2809
  // a given item came from.
2810
  $callbacks = array();
2811
  foreach (module_implements('menu') as $module) {
2812
    $router_items = call_user_func($module . '_menu');
2813
    if (isset($router_items) && is_array($router_items)) {
2814
      foreach (array_keys($router_items) as $path) {
2815
        $router_items[$path]['module'] = $module;
2816
      }
2817
      $callbacks = array_merge($callbacks, $router_items);
2818
    }
2819
  }
2820
  // Alter the menu as defined in modules, keys are like user/%user.
2821
  drupal_alter('menu', $callbacks);
2822
  list($menu, $masks) = _menu_router_build($callbacks);
2823
  _menu_router_cache($menu);
2824

    
2825
  return array($menu, $masks);
2826
}
2827

    
2828
/**
2829
 * Stores the menu router if we have it in memory.
2830
 */
2831
function _menu_router_cache($new_menu = NULL) {
2832
  $menu = &drupal_static(__FUNCTION__);
2833

    
2834
  if (isset($new_menu)) {
2835
    $menu = $new_menu;
2836
  }
2837
  return $menu;
2838
}
2839

    
2840
/**
2841
 * Gets the menu router.
2842
 */
2843
function menu_get_router() {
2844
  // Check first if we have it in memory already.
2845
  $menu = _menu_router_cache();
2846
  if (empty($menu)) {
2847
    list($menu, $masks) = menu_router_build();
2848
  }
2849
  return $menu;
2850
}
2851

    
2852
/**
2853
 * Builds a link from a router item.
2854
 */
2855
function _menu_link_build($item) {
2856
  // Suggested items are disabled by default.
2857
  if ($item['type'] == MENU_SUGGESTED_ITEM) {
2858
    $item['hidden'] = 1;
2859
  }
2860
  // Hide all items that are not visible in the tree.
2861
  elseif (!($item['type'] & MENU_VISIBLE_IN_TREE)) {
2862
    $item['hidden'] = -1;
2863
  }
2864
  // Note, we set this as 'system', so that we can be sure to distinguish all
2865
  // the menu links generated automatically from entries in {menu_router}.
2866
  $item['module'] = 'system';
2867
  $item += array(
2868
    'menu_name' => 'navigation',
2869
    'link_title' => $item['title'],
2870
    'link_path' => $item['path'],
2871
    'hidden' => 0,
2872
    'options' => empty($item['description']) ? array() : array('attributes' => array('title' => $item['description'])),
2873
  );
2874
  return $item;
2875
}
2876

    
2877
/**
2878
 * Builds menu links for the items in the menu router.
2879
 */
2880
function _menu_navigation_links_rebuild($menu) {
2881
  // Add normal and suggested items as links.
2882
  $menu_links = array();
2883
  foreach ($menu as $path => $item) {
2884
    if ($item['_visible']) {
2885
      $menu_links[$path] = $item;
2886
      $sort[$path] = $item['_number_parts'];
2887
    }
2888
  }
2889
  if ($menu_links) {
2890
    // Keep an array of processed menu links, to allow menu_link_save() to
2891
    // check this for parents instead of querying the database.
2892
    $parent_candidates = array();
2893
    // Make sure no child comes before its parent.
2894
    array_multisort($sort, SORT_NUMERIC, $menu_links);
2895

    
2896
    foreach ($menu_links as $key => $item) {
2897
      $existing_item = db_select('menu_links')
2898
        ->fields('menu_links')
2899
        ->condition('link_path', $item['path'])
2900
        ->condition('module', 'system')
2901
        ->execute()->fetchAssoc();
2902
      if ($existing_item) {
2903
        $item['mlid'] = $existing_item['mlid'];
2904
        // A change in hook_menu may move the link to a different menu
2905
        if (empty($item['menu_name']) || ($item['menu_name'] == $existing_item['menu_name'])) {
2906
          $item['menu_name'] = $existing_item['menu_name'];
2907
          $item['plid'] = $existing_item['plid'];
2908
        }
2909
        else {
2910
          // It moved to a new menu. Let menu_link_save() try to find a new
2911
          // parent based on the path.
2912
          unset($item['plid']);
2913
        }
2914
        $item['has_children'] = $existing_item['has_children'];
2915
        $item['updated'] = $existing_item['updated'];
2916
      }
2917
      if ($existing_item && $existing_item['customized']) {
2918
        $parent_candidates[$existing_item['mlid']] = $existing_item;
2919
      }
2920
      else {
2921
        $item = _menu_link_build($item);
2922
        menu_link_save($item, $existing_item, $parent_candidates);
2923
        $parent_candidates[$item['mlid']] = $item;
2924
        unset($menu_links[$key]);
2925
      }
2926
    }
2927
  }
2928
  $paths = array_keys($menu);
2929
  // Updated and customized items whose router paths are gone need new ones.
2930
  $result = db_select('menu_links', NULL, array('fetch' => PDO::FETCH_ASSOC))
2931
    ->fields('menu_links', array(
2932
      'link_path',
2933
      'mlid',
2934
      'router_path',
2935
      'updated',
2936
    ))
2937
    ->condition(db_or()
2938
      ->condition('updated', 1)
2939
      ->condition(db_and()
2940
        ->condition('router_path', $paths, 'NOT IN')
2941
        ->condition('external', 0)
2942
        ->condition('customized', 1)
2943
      )
2944
    )
2945
    ->execute();
2946
  foreach ($result as $item) {
2947
    $router_path = _menu_find_router_path($item['link_path']);
2948
    if (!empty($router_path) && ($router_path != $item['router_path'] || $item['updated'])) {
2949
      // If the router path and the link path matches, it's surely a working
2950
      // item, so we clear the updated flag.
2951
      $updated = $item['updated'] && $router_path != $item['link_path'];
2952
      db_update('menu_links')
2953
        ->fields(array(
2954
          'router_path' => $router_path,
2955
          'updated' => (int) $updated,
2956
        ))
2957
        ->condition('mlid', $item['mlid'])
2958
        ->execute();
2959
    }
2960
  }
2961
  // Find any item whose router path does not exist any more.
2962
  $result = db_select('menu_links')
2963
    ->fields('menu_links')
2964
    ->condition('router_path', $paths, 'NOT IN')
2965
    ->condition('external', 0)
2966
    ->condition('updated', 0)
2967
    ->condition('customized', 0)
2968
    ->orderBy('depth', 'DESC')
2969
    ->execute();
2970
  // Remove all such items. Starting from those with the greatest depth will
2971
  // minimize the amount of re-parenting done by menu_link_delete().
2972
  foreach ($result as $item) {
2973
    _menu_delete_item($item, TRUE);
2974
  }
2975
}
2976

    
2977
/**
2978
 * Clones an array of menu links.
2979
 *
2980
 * @param $links
2981
 *   An array of menu links to clone.
2982
 * @param $menu_name
2983
 *   (optional) The name of a menu that the links will be cloned for. If not
2984
 *   set, the cloned links will be in the same menu as the original set of
2985
 *   links that were passed in.
2986
 *
2987
 * @return
2988
 *   An array of menu links with the same properties as the passed-in array,
2989
 *   but with the link identifiers removed so that a new link will be created
2990
 *   when any of them is passed in to menu_link_save().
2991
 *
2992
 * @see menu_link_save()
2993
 */
2994
function menu_links_clone($links, $menu_name = NULL) {
2995
  foreach ($links as &$link) {
2996
    unset($link['mlid']);
2997
    unset($link['plid']);
2998
    if (isset($menu_name)) {
2999
      $link['menu_name'] = $menu_name;
3000
    }
3001
  }
3002
  return $links;
3003
}
3004

    
3005
/**
3006
 * Returns an array containing all links for a menu.
3007
 *
3008
 * @param $menu_name
3009
 *   The name of the menu whose links should be returned.
3010
 *
3011
 * @return
3012
 *   An array of menu links.
3013
 */
3014
function menu_load_links($menu_name) {
3015
  $links = db_select('menu_links', 'ml', array('fetch' => PDO::FETCH_ASSOC))
3016
    ->fields('ml')
3017
    ->condition('ml.menu_name', $menu_name)
3018
    // Order by weight so as to be helpful for menus that are only one level
3019
    // deep.
3020
    ->orderBy('weight')
3021
    ->execute()
3022
    ->fetchAll();
3023

    
3024
  foreach ($links as &$link) {
3025
    $link['options'] = unserialize($link['options']);
3026
  }
3027
  return $links;
3028
}
3029

    
3030
/**
3031
 * Deletes all links for a menu.
3032
 *
3033
 * @param $menu_name
3034
 *   The name of the menu whose links will be deleted.
3035
 */
3036
function menu_delete_links($menu_name) {
3037
  $links = menu_load_links($menu_name);
3038
  foreach ($links as $link) {
3039
    // To speed up the deletion process, we reset some link properties that
3040
    // would trigger re-parenting logic in _menu_delete_item() and
3041
    // _menu_update_parental_status().
3042
    $link['has_children'] = FALSE;
3043
    $link['plid'] = 0;
3044
    _menu_delete_item($link);
3045
  }
3046
}
3047

    
3048
/**
3049
 * Delete one or several menu links.
3050
 *
3051
 * @param $mlid
3052
 *   A valid menu link mlid or NULL. If NULL, $path is used.
3053
 * @param $path
3054
 *   The path to the menu items to be deleted. $mlid must be NULL.
3055
 */
3056
function menu_link_delete($mlid, $path = NULL) {
3057
  if (isset($mlid)) {
3058
    _menu_delete_item(db_query("SELECT * FROM {menu_links} WHERE mlid = :mlid", array(':mlid' => $mlid))->fetchAssoc());
3059
  }
3060
  else {
3061
    $result = db_query("SELECT * FROM {menu_links} WHERE link_path = :link_path", array(':link_path' => $path));
3062
    foreach ($result as $link) {
3063
      _menu_delete_item($link);
3064
    }
3065
  }
3066
}
3067

    
3068
/**
3069
 * Deletes a single menu link.
3070
 *
3071
 * @param $item
3072
 *   Item to be deleted.
3073
 * @param $force
3074
 *   Forces deletion. Internal use only, setting to TRUE is discouraged.
3075
 *
3076
 * @see menu_link_delete()
3077
 */
3078
function _menu_delete_item($item, $force = FALSE) {
3079
  $item = is_object($item) ? get_object_vars($item) : $item;
3080
  if ($item && ($item['module'] != 'system' || $item['updated'] || $force)) {
3081
    // Children get re-attached to the item's parent.
3082
    if ($item['has_children']) {
3083
      $result = db_query("SELECT mlid FROM {menu_links} WHERE plid = :plid", array(':plid' => $item['mlid']));
3084
      foreach ($result as $m) {
3085
        $child = menu_link_load($m->mlid);
3086
        $child['plid'] = $item['plid'];
3087
        menu_link_save($child);
3088
      }
3089
    }
3090

    
3091
    // Notify modules we are deleting the item.
3092
    module_invoke_all('menu_link_delete', $item);
3093

    
3094
    db_delete('menu_links')->condition('mlid', $item['mlid'])->execute();
3095

    
3096
    // Update the has_children status of the parent.
3097
    _menu_update_parental_status($item);
3098
    menu_cache_clear($item['menu_name']);
3099
    _menu_clear_page_cache();
3100
  }
3101
}
3102

    
3103
/**
3104
 * Saves a menu link.
3105
 *
3106
 * After calling this function, rebuild the menu cache using
3107
 * menu_cache_clear_all().
3108
 *
3109
 * @param $item
3110
 *   An associative array representing a menu link item, with elements:
3111
 *   - link_path: (required) The path of the menu item, which should be
3112
 *     normalized first by calling drupal_get_normal_path() on it.
3113
 *   - link_title: (required) Title to appear in menu for the link.
3114
 *   - menu_name: (optional) The machine name of the menu for the link.
3115
 *     Defaults to 'navigation'.
3116
 *   - weight: (optional) Integer to determine position in menu. Default is 0.
3117
 *   - expanded: (optional) Boolean that determines if the item is expanded.
3118
 *   - options: (optional) An array of options, see l() for more.
3119
 *   - mlid: (optional) Menu link identifier, the primary integer key for each
3120
 *     menu link. Can be set to an existing value, or to 0 or NULL
3121
 *     to insert a new link.
3122
 *   - plid: (optional) The mlid of the parent.
3123
 *   - router_path: (optional) The path of the relevant router item.
3124
 * @param $existing_item
3125
 *   Optional, the current record from the {menu_links} table as an array.
3126
 * @param $parent_candidates
3127
 *   Optional array of menu links keyed by mlid. Used by
3128
 *   _menu_navigation_links_rebuild() only.
3129
 *
3130
 * @return
3131
 *   The mlid of the saved menu link, or FALSE if the menu link could not be
3132
 *   saved.
3133
 */
3134
function menu_link_save(&$item, $existing_item = array(), $parent_candidates = array()) {
3135
  drupal_alter('menu_link', $item);
3136

    
3137
  // This is the easiest way to handle the unique internal path '<front>',
3138
  // since a path marked as external does not need to match a router path.
3139
  $item['external'] = (url_is_external($item['link_path'])  || $item['link_path'] == '<front>') ? 1 : 0;
3140
  // Load defaults.
3141
  $item += array(
3142
    'menu_name' => 'navigation',
3143
    'weight' => 0,
3144
    'link_title' => '',
3145
    'hidden' => 0,
3146
    'has_children' => 0,
3147
    'expanded' => 0,
3148
    'options' => array(),
3149
    'module' => 'menu',
3150
    'customized' => 0,
3151
    'updated' => 0,
3152
  );
3153
  if (isset($item['mlid'])) {
3154
    if (!$existing_item) {
3155
      $existing_item = db_query('SELECT * FROM {menu_links} WHERE mlid = :mlid', array('mlid' => $item['mlid']))->fetchAssoc();
3156
    }
3157
    if ($existing_item) {
3158
      $existing_item['options'] = unserialize($existing_item['options']);
3159
    }
3160
  }
3161
  else {
3162
    $existing_item = FALSE;
3163
  }
3164

    
3165
  // Try to find a parent link. If found, assign it and derive its menu.
3166
  $parent = _menu_link_find_parent($item, $parent_candidates);
3167
  if (!empty($parent['mlid'])) {
3168
    $item['plid'] = $parent['mlid'];
3169
    $item['menu_name'] = $parent['menu_name'];
3170
  }
3171
  // If no corresponding parent link was found, move the link to the top-level.
3172
  else {
3173
    $item['plid'] = 0;
3174
  }
3175
  $menu_name = $item['menu_name'];
3176

    
3177
  if (!$existing_item) {
3178
    $item['mlid'] = db_insert('menu_links')
3179
      ->fields(array(
3180
        'menu_name' => $item['menu_name'],
3181
        'plid' => $item['plid'],
3182
        'link_path' => $item['link_path'],
3183
        'hidden' => $item['hidden'],
3184
        'external' => $item['external'],
3185
        'has_children' => $item['has_children'],
3186
        'expanded' => $item['expanded'],
3187
        'weight' => $item['weight'],
3188
        'module' => $item['module'],
3189
        'link_title' => $item['link_title'],
3190
        'options' => serialize($item['options']),
3191
        'customized' => $item['customized'],
3192
        'updated' => $item['updated'],
3193
      ))
3194
      ->execute();
3195
  }
3196

    
3197
  // Directly fill parents for top-level links.
3198
  if ($item['plid'] == 0) {
3199
    $item['p1'] = $item['mlid'];
3200
    for ($i = 2; $i <= MENU_MAX_DEPTH; $i++) {
3201
      $item["p$i"] = 0;
3202
    }
3203
    $item['depth'] = 1;
3204
  }
3205
  // Otherwise, ensure that this link's depth is not beyond the maximum depth
3206
  // and fill parents based on the parent link.
3207
  else {
3208
    if ($item['has_children'] && $existing_item) {
3209
      $limit = MENU_MAX_DEPTH - menu_link_children_relative_depth($existing_item) - 1;
3210
    }
3211
    else {
3212
      $limit = MENU_MAX_DEPTH - 1;
3213
    }
3214
    if ($parent['depth'] > $limit) {
3215
      return FALSE;
3216
    }
3217
    $item['depth'] = $parent['depth'] + 1;
3218
    _menu_link_parents_set($item, $parent);
3219
  }
3220
  // Need to check both plid and menu_name, since plid can be 0 in any menu.
3221
  if ($existing_item && ($item['plid'] != $existing_item['plid'] || $menu_name != $existing_item['menu_name'])) {
3222
    _menu_link_move_children($item, $existing_item);
3223
  }
3224
  // Find the router_path.
3225
  if (empty($item['router_path'])  || !$existing_item || ($existing_item['link_path'] != $item['link_path'])) {
3226
    if ($item['external']) {
3227
      $item['router_path'] = '';
3228
    }
3229
    else {
3230
      // Find the router path which will serve this path.
3231
      $item['parts'] = explode('/', $item['link_path'], MENU_MAX_PARTS);
3232
      $item['router_path'] = _menu_find_router_path($item['link_path']);
3233
    }
3234
  }
3235
  // If every value in $existing_item is the same in the $item, there is no
3236
  // reason to run the update queries or clear the caches. We use
3237
  // array_intersect_key() with the $item as the first parameter because
3238
  // $item may have additional keys left over from building a router entry.
3239
  // The intersect removes the extra keys, allowing a meaningful comparison.
3240
  if (!$existing_item || (array_intersect_key($item, $existing_item) != $existing_item)) {
3241
    db_update('menu_links')
3242
      ->fields(array(
3243
        'menu_name' => $item['menu_name'],
3244
        'plid' => $item['plid'],
3245
        'link_path' => $item['link_path'],
3246
        'router_path' => $item['router_path'],
3247
        'hidden' => $item['hidden'],
3248
        'external' => $item['external'],
3249
        'has_children' => $item['has_children'],
3250
        'expanded' => $item['expanded'],
3251
        'weight' => $item['weight'],
3252
        'depth' => $item['depth'],
3253
        'p1' => $item['p1'],
3254
        'p2' => $item['p2'],
3255
        'p3' => $item['p3'],
3256
        'p4' => $item['p4'],
3257
        'p5' => $item['p5'],
3258
        'p6' => $item['p6'],
3259
        'p7' => $item['p7'],
3260
        'p8' => $item['p8'],
3261
        'p9' => $item['p9'],
3262
        'module' => $item['module'],
3263
        'link_title' => $item['link_title'],
3264
        'options' => serialize($item['options']),
3265
        'customized' => $item['customized'],
3266
      ))
3267
      ->condition('mlid', $item['mlid'])
3268
      ->execute();
3269
    // Check the has_children status of the parent.
3270
    _menu_update_parental_status($item);
3271
    menu_cache_clear($menu_name);
3272
    if ($existing_item && $menu_name != $existing_item['menu_name']) {
3273
      menu_cache_clear($existing_item['menu_name']);
3274
    }
3275
    // Notify modules we have acted on a menu item.
3276
    $hook = 'menu_link_insert';
3277
    if ($existing_item) {
3278
      $hook = 'menu_link_update';
3279
    }
3280
    module_invoke_all($hook, $item);
3281
    // Now clear the cache.
3282
    _menu_clear_page_cache();
3283
  }
3284
  return $item['mlid'];
3285
}
3286

    
3287
/**
3288
 * Finds a possible parent for a given menu link.
3289
 *
3290
 * Because the parent of a given link might not exist anymore in the database,
3291
 * we apply a set of heuristics to determine a proper parent:
3292
 *
3293
 *  - use the passed parent link if specified and existing.
3294
 *  - else, use the first existing link down the previous link hierarchy
3295
 *  - else, for system menu links (derived from hook_menu()), reparent
3296
 *    based on the path hierarchy.
3297
 *
3298
 * @param $menu_link
3299
 *   A menu link.
3300
 * @param $parent_candidates
3301
 *   An array of menu links keyed by mlid.
3302
 *
3303
 * @return
3304
 *   A menu link structure of the possible parent or FALSE if no valid parent
3305
 *   has been found.
3306
 */
3307
function _menu_link_find_parent($menu_link, $parent_candidates = array()) {
3308
  $parent = FALSE;
3309

    
3310
  // This item is explicitely top-level, skip the rest of the parenting.
3311
  if (isset($menu_link['plid']) && empty($menu_link['plid'])) {
3312
    return $parent;
3313
  }
3314

    
3315
  // If we have a parent link ID, try to use that.
3316
  $candidates = array();
3317
  if (isset($menu_link['plid'])) {
3318
    $candidates[] = $menu_link['plid'];
3319
  }
3320

    
3321
  // Else, if we have a link hierarchy try to find a valid parent in there.
3322
  if (!empty($menu_link['depth']) && $menu_link['depth'] > 1) {
3323
    for ($depth = $menu_link['depth'] - 1; $depth >= 1; $depth--) {
3324
      $candidates[] = $menu_link['p' . $depth];
3325
    }
3326
  }
3327

    
3328
  foreach ($candidates as $mlid) {
3329
    if (isset($parent_candidates[$mlid])) {
3330
      $parent = $parent_candidates[$mlid];
3331
    }
3332
    else {
3333
      $parent = db_query("SELECT * FROM {menu_links} WHERE mlid = :mlid", array(':mlid' => $mlid))->fetchAssoc();
3334
    }
3335
    if ($parent) {
3336
      return $parent;
3337
    }
3338
  }
3339

    
3340
  // If everything else failed, try to derive the parent from the path
3341
  // hierarchy. This only makes sense for links derived from menu router
3342
  // items (ie. from hook_menu()).
3343
  if ($menu_link['module'] == 'system') {
3344
    $query = db_select('menu_links');
3345
    $query->condition('module', 'system');
3346
    // We always respect the link's 'menu_name'; inheritance for router items is
3347
    // ensured in _menu_router_build().
3348
    $query->condition('menu_name', $menu_link['menu_name']);
3349

    
3350
    // Find the parent - it must be unique.
3351
    $parent_path = $menu_link['link_path'];
3352
    do {
3353
      $parent = FALSE;
3354
      $parent_path = substr($parent_path, 0, strrpos($parent_path, '/'));
3355
      $new_query = clone $query;
3356
      $new_query->condition('link_path', $parent_path);
3357
      // Only valid if we get a unique result.
3358
      if ($new_query->countQuery()->execute()->fetchField() == 1) {
3359
        $parent = $new_query->fields('menu_links')->execute()->fetchAssoc();
3360
      }
3361
    } while ($parent === FALSE && $parent_path);
3362
  }
3363

    
3364
  return $parent;
3365
}
3366

    
3367
/**
3368
 * Clears the page and block caches at most twice per page load.
3369
 */
3370
function _menu_clear_page_cache() {
3371
  $cache_cleared = &drupal_static(__FUNCTION__, 0);
3372

    
3373
  // Clear the page and block caches, but at most twice, including at
3374
  //  the end of the page load when there are multiple links saved or deleted.
3375
  if ($cache_cleared == 0) {
3376
    cache_clear_all();
3377
    // Keep track of which menus have expanded items.
3378
    _menu_set_expanded_menus();
3379
    $cache_cleared = 1;
3380
  }
3381
  elseif ($cache_cleared == 1) {
3382
    drupal_register_shutdown_function('cache_clear_all');
3383
    // Keep track of which menus have expanded items.
3384
    drupal_register_shutdown_function('_menu_set_expanded_menus');
3385
    $cache_cleared = 2;
3386
  }
3387
}
3388

    
3389
/**
3390
 * Updates a list of menus with expanded items.
3391
 */
3392
function _menu_set_expanded_menus() {
3393
  $names = db_query("SELECT menu_name FROM {menu_links} WHERE expanded <> 0 GROUP BY menu_name")->fetchCol();
3394
  variable_set('menu_expanded', $names);
3395
}
3396

    
3397
/**
3398
 * Finds the router path which will serve this path.
3399
 *
3400
 * @param $link_path
3401
 *  The path for we are looking up its router path.
3402
 *
3403
 * @return
3404
 *  A path from $menu keys or empty if $link_path points to a nonexisting
3405
 *  place.
3406
 */
3407
function _menu_find_router_path($link_path) {
3408
  // $menu will only have data during a menu rebuild.
3409
  $menu = _menu_router_cache();
3410

    
3411
  $router_path = $link_path;
3412
  $parts = explode('/', $link_path, MENU_MAX_PARTS);
3413
  $ancestors = menu_get_ancestors($parts);
3414

    
3415
  if (empty($menu)) {
3416
    // Not during a menu rebuild, so look up in the database.
3417
    $router_path = (string) db_select('menu_router')
3418
      ->fields('menu_router', array('path'))
3419
      ->condition('path', $ancestors, 'IN')
3420
      ->orderBy('fit', 'DESC')
3421
      ->range(0, 1)
3422
      ->execute()->fetchField();
3423
  }
3424
  elseif (!isset($menu[$router_path])) {
3425
    // Add an empty router path as a fallback.
3426
    $ancestors[] = '';
3427
    foreach ($ancestors as $key => $router_path) {
3428
      if (isset($menu[$router_path])) {
3429
        // Exit the loop leaving $router_path as the first match.
3430
        break;
3431
      }
3432
    }
3433
    // If we did not find the path, $router_path will be the empty string
3434
    // at the end of $ancestors.
3435
  }
3436
  return $router_path;
3437
}
3438

    
3439
/**
3440
 * Inserts, updates, or deletes an uncustomized menu link related to a module.
3441
 *
3442
 * @param $module
3443
 *   The name of the module.
3444
 * @param $op
3445
 *   Operation to perform: insert, update or delete.
3446
 * @param $link_path
3447
 *   The path this link points to.
3448
 * @param $link_title
3449
 *   Title of the link to insert or new title to update the link to.
3450
 *   Unused for delete.
3451
 *
3452
 * @return
3453
 *   The insert op returns the mlid of the new item. Others op return NULL.
3454
 */
3455
function menu_link_maintain($module, $op, $link_path, $link_title) {
3456
  switch ($op) {
3457
    case 'insert':
3458
      $menu_link = array(
3459
        'link_title' => $link_title,
3460
        'link_path' => $link_path,
3461
        'module' => $module,
3462
      );
3463
      return menu_link_save($menu_link);
3464
      break;
3465
    case 'update':
3466
      $result = db_query("SELECT * FROM {menu_links} WHERE link_path = :link_path AND module = :module AND customized = 0", array(':link_path' => $link_path, ':module' => $module))->fetchAll(PDO::FETCH_ASSOC);
3467
      foreach ($result as $link) {
3468
        $link['link_title'] = $link_title;
3469
        $link['options'] = unserialize($link['options']);
3470
        menu_link_save($link);
3471
      }
3472
      break;
3473
    case 'delete':
3474
      menu_link_delete(NULL, $link_path);
3475
      break;
3476
  }
3477
}
3478

    
3479
/**
3480
 * Finds the depth of an item's children relative to its depth.
3481
 *
3482
 * For example, if the item has a depth of 2, and the maximum of any child in
3483
 * the menu link tree is 5, the relative depth is 3.
3484
 *
3485
 * @param $item
3486
 *   An array representing a menu link item.
3487
 *
3488
 * @return
3489
 *   The relative depth, or zero.
3490
 *
3491
 */
3492
function menu_link_children_relative_depth($item) {
3493
  $query = db_select('menu_links');
3494
  $query->addField('menu_links', 'depth');
3495
  $query->condition('menu_name', $item['menu_name']);
3496
  $query->orderBy('depth', 'DESC');
3497
  $query->range(0, 1);
3498

    
3499
  $i = 1;
3500
  $p = 'p1';
3501
  while ($i <= MENU_MAX_DEPTH && $item[$p]) {
3502
    $query->condition($p, $item[$p]);
3503
    $p = 'p' . ++$i;
3504
  }
3505

    
3506
  $max_depth = $query->execute()->fetchField();
3507

    
3508
  return ($max_depth > $item['depth']) ? $max_depth - $item['depth'] : 0;
3509
}
3510

    
3511
/**
3512
 * Updates the children of a menu link that is being moved.
3513
 *
3514
 * The menu name, parents (p1 - p6), and depth are updated for all children of
3515
 * the link, and the has_children status of the previous parent is updated.
3516
 */
3517
function _menu_link_move_children($item, $existing_item) {
3518
  $query = db_update('menu_links');
3519

    
3520
  $query->fields(array('menu_name' => $item['menu_name']));
3521

    
3522
  $p = 'p1';
3523
  $expressions = array();
3524
  for ($i = 1; $i <= $item['depth']; $p = 'p' . ++$i) {
3525
    $expressions[] = array($p, ":p_$i", array(":p_$i" => $item[$p]));
3526
  }
3527
  $j = $existing_item['depth'] + 1;
3528
  while ($i <= MENU_MAX_DEPTH && $j <= MENU_MAX_DEPTH) {
3529
    $expressions[] = array('p' . $i++, 'p' . $j++, array());
3530
  }
3531
  while ($i <= MENU_MAX_DEPTH) {
3532
    $expressions[] = array('p' . $i++, 0, array());
3533
  }
3534

    
3535
  $shift = $item['depth'] - $existing_item['depth'];
3536
  if ($shift > 0) {
3537
    // The order of expressions must be reversed so the new values don't
3538
    // overwrite the old ones before they can be used because "Single-table
3539
    // UPDATE assignments are generally evaluated from left to right"
3540
    // see: http://dev.mysql.com/doc/refman/5.0/en/update.html
3541
    $expressions = array_reverse($expressions);
3542
  }
3543
  foreach ($expressions as $expression) {
3544
    $query->expression($expression[0], $expression[1], $expression[2]);
3545
  }
3546

    
3547
  $query->expression('depth', 'depth + :depth', array(':depth' => $shift));
3548
  $query->condition('menu_name', $existing_item['menu_name']);
3549
  $p = 'p1';
3550
  for ($i = 1; $i <= MENU_MAX_DEPTH && $existing_item[$p]; $p = 'p' . ++$i) {
3551
    $query->condition($p, $existing_item[$p]);
3552
  }
3553

    
3554
  $query->execute();
3555

    
3556
  // Check the has_children status of the parent, while excluding this item.
3557
  _menu_update_parental_status($existing_item, TRUE);
3558
}
3559

    
3560
/**
3561
 * Checks and updates the 'has_children' status for the parent of a link.
3562
 */
3563
function _menu_update_parental_status($item, $exclude = FALSE) {
3564
  // If plid == 0, there is nothing to update.
3565
  if ($item['plid']) {
3566
    // Check if at least one visible child exists in the table.
3567
    $query = db_select('menu_links');
3568
    $query->addField('menu_links', 'mlid');
3569
    $query->condition('menu_name', $item['menu_name']);
3570
    $query->condition('hidden', 0);
3571
    $query->condition('plid', $item['plid']);
3572
    $query->range(0, 1);
3573
    if ($exclude) {
3574
      $query->condition('mlid', $item['mlid'], '<>');
3575
    }
3576
    $parent_has_children = ((bool) $query->execute()->fetchField()) ? 1 : 0;
3577
    db_update('menu_links')
3578
      ->fields(array('has_children' => $parent_has_children))
3579
      ->condition('mlid', $item['plid'])
3580
      ->execute();
3581
  }
3582
}
3583

    
3584
/**
3585
 * Sets the p1 through p9 values for a menu link being saved.
3586
 */
3587
function _menu_link_parents_set(&$item, $parent) {
3588
  $i = 1;
3589
  while ($i < $item['depth']) {
3590
    $p = 'p' . $i++;
3591
    $item[$p] = $parent[$p];
3592
  }
3593
  $p = 'p' . $i++;
3594
  // The parent (p1 - p9) corresponding to the depth always equals the mlid.
3595
  $item[$p] = $item['mlid'];
3596
  while ($i <= MENU_MAX_DEPTH) {
3597
    $p = 'p' . $i++;
3598
    $item[$p] = 0;
3599
  }
3600
}
3601

    
3602
/**
3603
 * Builds the router table based on the data from hook_menu().
3604
 */
3605
function _menu_router_build($callbacks) {
3606
  // First pass: separate callbacks from paths, making paths ready for
3607
  // matching. Calculate fitness, and fill some default values.
3608
  $menu = array();
3609
  $masks = array();
3610
  foreach ($callbacks as $path => $item) {
3611
    $load_functions = array();
3612
    $to_arg_functions = array();
3613
    $fit = 0;
3614
    $move = FALSE;
3615

    
3616
    $parts = explode('/', $path, MENU_MAX_PARTS);
3617
    $number_parts = count($parts);
3618
    // We store the highest index of parts here to save some work in the fit
3619
    // calculation loop.
3620
    $slashes = $number_parts - 1;
3621
    // Extract load and to_arg functions.
3622
    foreach ($parts as $k => $part) {
3623
      $match = FALSE;
3624
      // Look for wildcards in the form allowed to be used in PHP functions,
3625
      // because we are using these to construct the load function names.
3626
      if (preg_match('/^%(|' . DRUPAL_PHP_FUNCTION_PATTERN . ')$/', $part, $matches)) {
3627
        if (empty($matches[1])) {
3628
          $match = TRUE;
3629
          $load_functions[$k] = NULL;
3630
        }
3631
        else {
3632
          if (function_exists($matches[1] . '_to_arg')) {
3633
            $to_arg_functions[$k] = $matches[1] . '_to_arg';
3634
            $load_functions[$k] = NULL;
3635
            $match = TRUE;
3636
          }
3637
          if (function_exists($matches[1] . '_load')) {
3638
            $function = $matches[1] . '_load';
3639
            // Create an array of arguments that will be passed to the _load
3640
            // function when this menu path is checked, if 'load arguments'
3641
            // exists.
3642
            $load_functions[$k] = isset($item['load arguments']) ? array($function => $item['load arguments']) : $function;
3643
            $match = TRUE;
3644
          }
3645
        }
3646
      }
3647
      if ($match) {
3648
        $parts[$k] = '%';
3649
      }
3650
      else {
3651
        $fit |=  1 << ($slashes - $k);
3652
      }
3653
    }
3654
    if ($fit) {
3655
      $move = TRUE;
3656
    }
3657
    else {
3658
      // If there is no %, it fits maximally.
3659
      $fit = (1 << $number_parts) - 1;
3660
    }
3661
    $masks[$fit] = 1;
3662
    $item['_load_functions'] = $load_functions;
3663
    $item['to_arg_functions'] = empty($to_arg_functions) ? '' : serialize($to_arg_functions);
3664
    $item += array(
3665
      'title' => '',
3666
      'weight' => 0,
3667
      'type' => MENU_NORMAL_ITEM,
3668
      'module' => '',
3669
      '_number_parts' => $number_parts,
3670
      '_parts' => $parts,
3671
      '_fit' => $fit,
3672
    );
3673
    $item += array(
3674
      '_visible' => (bool) ($item['type'] & MENU_VISIBLE_IN_BREADCRUMB),
3675
      '_tab' => (bool) ($item['type'] & MENU_IS_LOCAL_TASK),
3676
    );
3677
    if ($move) {
3678
      $new_path = implode('/', $item['_parts']);
3679
      $menu[$new_path] = $item;
3680
      $sort[$new_path] = $number_parts;
3681
    }
3682
    else {
3683
      $menu[$path] = $item;
3684
      $sort[$path] = $number_parts;
3685
    }
3686
  }
3687
  array_multisort($sort, SORT_NUMERIC, $menu);
3688
  // Apply inheritance rules.
3689
  foreach ($menu as $path => $v) {
3690
    $item = &$menu[$path];
3691
    if (!$item['_tab']) {
3692
      // Non-tab items.
3693
      $item['tab_parent'] = '';
3694
      $item['tab_root'] = $path;
3695
    }
3696
    // If not specified, assign the default tab type for local tasks.
3697
    elseif (!isset($item['context'])) {
3698
      $item['context'] = MENU_CONTEXT_PAGE;
3699
    }
3700
    for ($i = $item['_number_parts'] - 1; $i; $i--) {
3701
      $parent_path = implode('/', array_slice($item['_parts'], 0, $i));
3702
      if (isset($menu[$parent_path])) {
3703

    
3704
        $parent = &$menu[$parent_path];
3705

    
3706
        // If we have no menu name, try to inherit it from parent items.
3707
        if (!isset($item['menu_name'])) {
3708
          // If the parent item of this item does not define a menu name (and no
3709
          // previous iteration assigned one already), try to find the menu name
3710
          // of the parent item in the currently stored menu links.
3711
          if (!isset($parent['menu_name'])) {
3712
            $menu_name = db_query("SELECT menu_name FROM {menu_links} WHERE router_path = :router_path AND module = 'system'", array(':router_path' => $parent_path))->fetchField();
3713
            if ($menu_name) {
3714
              $parent['menu_name'] = $menu_name;
3715
            }
3716
          }
3717
          // If the parent item defines a menu name, inherit it.
3718
          if (!empty($parent['menu_name'])) {
3719
            $item['menu_name'] = $parent['menu_name'];
3720
          }
3721
        }
3722
        if (!isset($item['tab_parent'])) {
3723
          // Parent stores the parent of the path.
3724
          $item['tab_parent'] = $parent_path;
3725
        }
3726
        if (!isset($item['tab_root']) && !$parent['_tab']) {
3727
          $item['tab_root'] = $parent_path;
3728
        }
3729
        // If an access callback is not found for a default local task we use
3730
        // the callback from the parent, since we expect them to be identical.
3731
        // In all other cases, the access parameters must be specified.
3732
        if (($item['type'] == MENU_DEFAULT_LOCAL_TASK) && !isset($item['access callback']) && isset($parent['access callback'])) {
3733
          $item['access callback'] = $parent['access callback'];
3734
          if (!isset($item['access arguments']) && isset($parent['access arguments'])) {
3735
            $item['access arguments'] = $parent['access arguments'];
3736
          }
3737
        }
3738
        // Same for page callbacks.
3739
        if (!isset($item['page callback']) && isset($parent['page callback'])) {
3740
          $item['page callback'] = $parent['page callback'];
3741
          if (!isset($item['page arguments']) && isset($parent['page arguments'])) {
3742
            $item['page arguments'] = $parent['page arguments'];
3743
          }
3744
          if (!isset($item['file path']) && isset($parent['file path'])) {
3745
            $item['file path'] = $parent['file path'];
3746
          }
3747
          if (!isset($item['file']) && isset($parent['file'])) {
3748
            $item['file'] = $parent['file'];
3749
            if (empty($item['file path']) && isset($item['module']) && isset($parent['module']) && $item['module'] != $parent['module']) {
3750
              $item['file path'] = drupal_get_path('module', $parent['module']);
3751
            }
3752
          }
3753
        }
3754
        // Same for delivery callbacks.
3755
        if (!isset($item['delivery callback']) && isset($parent['delivery callback'])) {
3756
          $item['delivery callback'] = $parent['delivery callback'];
3757
        }
3758
        // Same for theme callbacks.
3759
        if (!isset($item['theme callback']) && isset($parent['theme callback'])) {
3760
          $item['theme callback'] = $parent['theme callback'];
3761
          if (!isset($item['theme arguments']) && isset($parent['theme arguments'])) {
3762
            $item['theme arguments'] = $parent['theme arguments'];
3763
          }
3764
        }
3765
        // Same for load arguments: if a loader doesn't have any explict
3766
        // arguments, try to find arguments in the parent.
3767
        if (!isset($item['load arguments'])) {
3768
          foreach ($item['_load_functions'] as $k => $function) {
3769
            // This loader doesn't have any explict arguments...
3770
            if (!is_array($function)) {
3771
              // ... check the parent for a loader at the same position
3772
              // using the same function name and defining arguments...
3773
              if (isset($parent['_load_functions'][$k]) && is_array($parent['_load_functions'][$k]) && key($parent['_load_functions'][$k]) === $function) {
3774
                // ... and inherit the arguments on the child.
3775
                $item['_load_functions'][$k] = $parent['_load_functions'][$k];
3776
              }
3777
            }
3778
          }
3779
        }
3780
      }
3781
    }
3782
    if (!isset($item['access callback']) && isset($item['access arguments'])) {
3783
      // Default callback.
3784
      $item['access callback'] = 'user_access';
3785
    }
3786
    if (!isset($item['access callback']) || empty($item['page callback'])) {
3787
      $item['access callback'] = 0;
3788
    }
3789
    if (is_bool($item['access callback'])) {
3790
      $item['access callback'] = intval($item['access callback']);
3791
    }
3792

    
3793
    $item['load_functions'] = empty($item['_load_functions']) ? '' : serialize($item['_load_functions']);
3794
    $item += array(
3795
      'access arguments' => array(),
3796
      'access callback' => '',
3797
      'page arguments' => array(),
3798
      'page callback' => '',
3799
      'delivery callback' => '',
3800
      'title arguments' => array(),
3801
      'title callback' => 't',
3802
      'theme arguments' => array(),
3803
      'theme callback' => '',
3804
      'description' => '',
3805
      'position' => '',
3806
      'context' => 0,
3807
      'tab_parent' => '',
3808
      'tab_root' => $path,
3809
      'path' => $path,
3810
      'file' => '',
3811
      'file path' => '',
3812
      'include file' => '',
3813
    );
3814

    
3815
    // Calculate out the file to be included for each callback, if any.
3816
    if ($item['file']) {
3817
      $file_path = $item['file path'] ? $item['file path'] : drupal_get_path('module', $item['module']);
3818
      $item['include file'] = $file_path . '/' . $item['file'];
3819
    }
3820
  }
3821

    
3822
  // Sort the masks so they are in order of descending fit.
3823
  $masks = array_keys($masks);
3824
  rsort($masks);
3825

    
3826
  return array($menu, $masks);
3827
}
3828

    
3829
/**
3830
 * Saves data from menu_router_build() to the router table.
3831
 */
3832
function _menu_router_save($menu, $masks) {
3833
  // Delete the existing router since we have some data to replace it.
3834
  db_truncate('menu_router')->execute();
3835

    
3836
  // Prepare insert object.
3837
  $insert = db_insert('menu_router')
3838
    ->fields(array(
3839
      'path',
3840
      'load_functions',
3841
      'to_arg_functions',
3842
      'access_callback',
3843
      'access_arguments',
3844
      'page_callback',
3845
      'page_arguments',
3846
      'delivery_callback',
3847
      'fit',
3848
      'number_parts',
3849
      'context',
3850
      'tab_parent',
3851
      'tab_root',
3852
      'title',
3853
      'title_callback',
3854
      'title_arguments',
3855
      'theme_callback',
3856
      'theme_arguments',
3857
      'type',
3858
      'description',
3859
      'position',
3860
      'weight',
3861
      'include_file',
3862
    ));
3863

    
3864
  $num_records = 0;
3865

    
3866
  foreach ($menu as $path => $item) {
3867
    // Fill in insert object values.
3868
    $insert->values(array(
3869
      'path' => $item['path'],
3870
      'load_functions' => $item['load_functions'],
3871
      'to_arg_functions' => $item['to_arg_functions'],
3872
      'access_callback' => $item['access callback'],
3873
      'access_arguments' => serialize($item['access arguments']),
3874
      'page_callback' => $item['page callback'],
3875
      'page_arguments' => serialize($item['page arguments']),
3876
      'delivery_callback' => $item['delivery callback'],
3877
      'fit' => $item['_fit'],
3878
      'number_parts' => $item['_number_parts'],
3879
      'context' => $item['context'],
3880
      'tab_parent' => $item['tab_parent'],
3881
      'tab_root' => $item['tab_root'],
3882
      'title' => $item['title'],
3883
      'title_callback' => $item['title callback'],
3884
      'title_arguments' => ($item['title arguments'] ? serialize($item['title arguments']) : ''),
3885
      'theme_callback' => $item['theme callback'],
3886
      'theme_arguments' => serialize($item['theme arguments']),
3887
      'type' => $item['type'],
3888
      'description' => $item['description'],
3889
      'position' => $item['position'],
3890
      'weight' => $item['weight'],
3891
      'include_file' => $item['include file'],
3892
    ));
3893

    
3894
    // Execute in batches to avoid the memory overhead of all of those records
3895
    // in the query object.
3896
    if (++$num_records == 20) {
3897
      $insert->execute();
3898
      $num_records = 0;
3899
    }
3900
  }
3901
  // Insert any remaining records.
3902
  $insert->execute();
3903
  // Store the masks.
3904
  variable_set('menu_masks', $masks);
3905

    
3906
  return $menu;
3907
}
3908

    
3909
/**
3910
 * Checks whether the site is in maintenance mode.
3911
 *
3912
 * This function will log the current user out and redirect to front page
3913
 * if the current user has no 'access site in maintenance mode' permission.
3914
 *
3915
 * @param $check_only
3916
 *   If this is set to TRUE, the function will perform the access checks and
3917
 *   return the site offline status, but not log the user out or display any
3918
 *   messages.
3919
 *
3920
 * @return
3921
 *   FALSE if the site is not in maintenance mode, the user login page is
3922
 *   displayed, or the user has the 'access site in maintenance mode'
3923
 *   permission. TRUE for anonymous users not being on the login page when the
3924
 *   site is in maintenance mode.
3925
 */
3926
function _menu_site_is_offline($check_only = FALSE) {
3927
  // Check if site is in maintenance mode.
3928
  if (variable_get('maintenance_mode', 0)) {
3929
    if (user_access('access site in maintenance mode')) {
3930
      // Ensure that the maintenance mode message is displayed only once
3931
      // (allowing for page redirects) and specifically suppress its display on
3932
      // the maintenance mode settings page.
3933
      if (!$check_only && $_GET['q'] != 'admin/config/development/maintenance') {
3934
        if (user_access('administer site configuration')) {
3935
          drupal_set_message(t('Operating in maintenance mode. <a href="@url">Go online.</a>', array('@url' => url('admin/config/development/maintenance'))), 'status', FALSE);
3936
        }
3937
        else {
3938
          drupal_set_message(t('Operating in maintenance mode.'), 'status', FALSE);
3939
        }
3940
      }
3941
    }
3942
    else {
3943
      return TRUE;
3944
    }
3945
  }
3946
  return FALSE;
3947
}
3948

    
3949
/**
3950
 * @} End of "defgroup menu".
3951
 */