menu.module 26.9 KB
Newer Older
1 2
<?php

Dries's avatar
Dries committed
3 4
/**
 * @file
5 6 7 8 9 10 11
 * Allows administrators to customize the site's navigation menus.
 *
 * A menu (in this context) is a hierarchical collection of links, generally
 * used for navigation. This is not to be confused with the
 * @link menu Menu system @endlink of menu.inc and hook_menu(), which defines
 * page routing requests for Drupal, and also allows the defined page routing
 * URLs to be added to the main site navigation menu.
Dries's avatar
Dries committed
12 13
 */

14 15 16 17
/**
 * Maximum length of menu name as entered by the user. Database length is 32
 * and we add a menu- prefix.
 */
18
define('MENU_MAX_MENU_NAME_LENGTH_UI', 27);
19

20
/**
21
 * Implements hook_help().
22
 */
23 24
function menu_help($path, $arg) {
  switch ($path) {
25
    case 'admin/help#menu':
26 27
      $output = '';
      $output .= '<h3>' . t('About') . '</h3>';
28
      $output .= '<p>' . t('The Menu module provides an interface for managing menus. A menu is a hierarchical collection of links, which can be within or external to the site, generally used for navigation. Each menu is rendered in a block that can be enabled and positioned through the <a href="@blocks">Blocks administration page</a>. You can view and manage menus on the <a href="@menus">Menus administration page</a>. For more information, see the online handbook entry for the <a href="@menu">Menu module</a>.', array('@blocks' => url('admin/structure/block'), '@menus' => url('admin/structure/menu'), '@menu' => 'http://drupal.org/handbook/modules/menu/')) . '</p>';
29 30 31
      $output .= '<h3>' . t('Uses') . '</h3>';
      $output .= '<dl>';
      $output .= '<dt>' . t('Managing menus') . '</dt>';
32
      $output .= '<dd>' . t('Users with the <em>Administer menus and menu items</em> permission can add, edit and delete custom menus on the <a href="@menu">Menus administration page</a>. Custom menus can be special site menus, menus of external links, or any combination of internal and external links. You may create an unlimited number of additional menus, each of which will automatically have an associated block. By selecting <em>list links</em>, you can add, edit, or delete links for a given menu. The links listing page provides a drag-and-drop interface for controlling the order of links, and creating a hierarchy within the menu.', array('@menu' => url('admin/structure/menu'), '@add-menu' => url('admin/structure/menu/add'))) . '</dd>';
33 34 35
      $output .= '<dt>' . t('Displaying menus') . '</dt>';
      $output .= '<dd>' . t('After you have created a menu, you must enable and position the associated block on the <a href="@blocks">Blocks administration page</a>.', array('@blocks' => url('admin/structure/block'))) . '</dd>';
      $output .= '</dl>';
36
      return $output;
37
    case 'admin/structure/menu/add':
38
      return '<p>' . t('You can enable the newly-created block for this menu on the <a href="@blocks">Blocks administration page</a>.', array('@blocks' => url('admin/structure/block'))) . '</p>';
39
  }
40
  if ($path == 'admin/structure/menu' && module_exists('block')) {
41
    return '<p>' . t('Each menu has a corresponding block that is managed on the <a href="@blocks">Blocks administration page</a>.', array('@blocks' => url('admin/structure/block'))) . '</p>';
42
  }
43 44
}

45
/**
46
 * Implements hook_permission().
47
 */
48
function menu_permission() {
49
  return array(
50
    'administer menu' => array(
51
      'title' => t('Administer menus and menu items'),
52
    ),
53
  );
54 55
}

56
/**
57
 * Implements hook_menu().
58
 */
59
function menu_menu() {
60
  $items['admin/structure/menu'] = array(
61
    'title' => 'Menus',
62
    'description' => 'Add new menus to your site, edit existing menus, and rename and reorganize menu links.',
63
    'page callback' => 'menu_overview_page',
64 65
    'access callback' => 'user_access',
    'access arguments' => array('administer menu'),
66
    'file' => 'menu.admin.inc',
67
  );
68 69 70 71 72 73
  $items['admin/structure/menu/parents'] = array(
    'title' => 'Parent menu items',
    'page callback' => 'menu_parent_options_js',
    'type' => MENU_CALLBACK,
    'access arguments' => array(TRUE),
  );
74
  $items['admin/structure/menu/list'] = array(
75
    'title' => 'List menus',
76
    'type' => MENU_DEFAULT_LOCAL_TASK,
77 78
    'weight' => -10,
  );
79
  $items['admin/structure/menu/add'] = array(
80 81 82
    'title' => 'Add menu',
    'page callback' => 'drupal_get_form',
    'page arguments' => array('menu_edit_menu', 'add'),
83
    'access arguments' => array('administer menu'),
84
    'type' => MENU_LOCAL_ACTION,
85
    'file' => 'menu.admin.inc',
86
  );
87
  $items['admin/structure/menu/settings'] = array(
88 89 90
    'title' => 'Settings',
    'page callback' => 'drupal_get_form',
    'page arguments' => array('menu_configure'),
91
    'access arguments' => array('administer menu'),
92
    'type' => MENU_LOCAL_TASK,
93
    'weight' => 5,
94
    'file' => 'menu.admin.inc',
95
  );
96
  $items['admin/structure/menu/manage/%menu'] = array(
97
    'title' => 'Customize menu',
98
    'page callback' => 'drupal_get_form',
99
    'page arguments' => array('menu_overview_form', 4),
100
    'title callback' => 'menu_overview_title',
101
    'title arguments' => array(4),
102
    'access arguments' => array('administer menu'),
103
    'file' => 'menu.admin.inc',
104
  );
105
  $items['admin/structure/menu/manage/%menu/list'] = array(
106
    'title' => 'List links',
107
    'weight' => -10,
108
    'type' => MENU_DEFAULT_LOCAL_TASK,
109
    'context' => MENU_CONTEXT_PAGE | MENU_CONTEXT_INLINE,
110
  );
111
  $items['admin/structure/menu/manage/%menu/add'] = array(
112
    'title' => 'Add link',
113
    'page callback' => 'drupal_get_form',
114
    'page arguments' => array('menu_edit_item', 'add', NULL, 4),
115
    'access arguments' => array('administer menu'),
116
    'type' => MENU_LOCAL_ACTION,
117
    'file' => 'menu.admin.inc',
118
  );
119
  $items['admin/structure/menu/manage/%menu/edit'] = array(
120 121
    'title' => 'Edit menu',
    'page callback' => 'drupal_get_form',
122
    'page arguments' => array('menu_edit_menu', 'edit', 4),
123
    'access arguments' => array('administer menu'),
124
    'type' => MENU_LOCAL_TASK,
125
    'context' => MENU_CONTEXT_PAGE | MENU_CONTEXT_INLINE,
126
    'file' => 'menu.admin.inc',
127
  );
128
  $items['admin/structure/menu/manage/%menu/delete'] = array(
129 130
    'title' => 'Delete menu',
    'page callback' => 'menu_delete_menu_page',
131
    'page arguments' => array(4),
132
    'access arguments' => array('administer menu'),
133
    'file' => 'menu.admin.inc',
134
  );
135
  $items['admin/structure/menu/item/%menu_link/edit'] = array(
136
    'title' => 'Edit menu link',
137
    'page callback' => 'drupal_get_form',
138
    'page arguments' => array('menu_edit_item', 'edit', 4, NULL),
139
    'access arguments' => array('administer menu'),
140
    'file' => 'menu.admin.inc',
141
  );
142
  $items['admin/structure/menu/item/%menu_link/reset'] = array(
143
    'title' => 'Reset menu link',
144
    'page callback' => 'drupal_get_form',
145
    'page arguments' => array('menu_reset_item_confirm', 4),
146
    'access arguments' => array('administer menu'),
147
    'file' => 'menu.admin.inc',
148
  );
149
  $items['admin/structure/menu/item/%menu_link/delete'] = array(
150
    'title' => 'Delete menu link',
151 152
    'page callback' => 'menu_item_delete_page',
    'page arguments' => array(4),
153
    'access arguments' => array('administer menu'),
154
    'file' => 'menu.admin.inc',
155
  );
156
  return $items;
157
}
158

159
/**
160
 * Implements hook_theme().
161 162 163 164
 */
function menu_theme() {
  return array(
    'menu_overview_form' => array(
165
      'file' => 'menu.admin.inc',
166
      'render element' => 'form',
167
    ),
168
    'menu_admin_overview' => array(
169
      'file' => 'menu.admin.inc',
170
      'variables' => array('title' => NULL, 'name' => NULL, 'description' => NULL),
171
    ),
172 173 174
  );
}

175
/**
176
 * Implements hook_enable().
177
 *
178
 * Add a link for each custom menu.
179 180 181
 */
function menu_enable() {
  menu_rebuild();
182
  $base_link = db_query("SELECT mlid AS plid, menu_name FROM {menu_links} WHERE link_path = 'admin/structure/menu' AND module = 'system'")->fetchAssoc();
183
  $base_link['router_path'] = 'admin/structure/menu/manage/%';
184
  $base_link['module'] = 'menu';
185 186
  $result = db_query("SELECT * FROM {menu_custom}", array(), array('fetch' => PDO::FETCH_ASSOC));
  foreach ($result as $menu) {
187 188
    // $link is passed by reference to menu_link_save(), so we make a copy of $base_link.
    $link = $base_link;
189 190
    $link['mlid'] = 0;
    $link['link_title'] = $menu['title'];
191
    $link['link_path'] = 'admin/structure/menu/manage/' . $menu['menu_name'];
192 193 194 195 196 197
    $menu_link = db_query("SELECT mlid FROM {menu_links} WHERE link_path = :path AND plid = :plid", array(
      ':path' => $link['link_path'],
      ':plid' => $link['plid']
    ))
    ->fetchField();
    if (!$menu_link) {
198 199
      menu_link_save($link);
    }
200
  }
201
  menu_cache_clear_all();
202 203
}

204 205 206 207
/**
 * Title callback for the menu overview page and links.
 */
function menu_overview_title($menu) {
Dries's avatar
Dries committed
208
  return $menu['title'];
209 210
}

211 212
/**
 * Load the data for a single custom menu.
213 214 215
 *
 * @param $menu_name
 *   The unique name of a custom menu to load.
216 217
 * @return
 *   Array defining the custom menu, or FALSE if the menu doesn't exist.
218 219
 */
function menu_load($menu_name) {
220 221 222 223 224 225 226 227 228 229 230 231 232
  $all_menus = menu_load_all();
  return isset($all_menus[$menu_name]) ? $all_menus[$menu_name] : FALSE;
}

/**
 * Load all custom menu data.
 *
 * @return
 *   Array of custom menu data.
 */
function menu_load_all() {
  $custom_menus = &drupal_static(__FUNCTION__);
  if (!isset($custom_menus)) {
233
    if ($cached = cache('menu')->get('menu_custom')) {
234 235 236 237
      $custom_menus = $cached->data;
    }
    else {
      $custom_menus = db_query('SELECT * FROM {menu_custom}')->fetchAllAssoc('menu_name', PDO::FETCH_ASSOC);
238
      cache('menu')->set('menu_custom', $custom_menus);
239 240 241
    }
  }
  return $custom_menus;
242 243
}

244 245 246 247 248
/**
 * Save a custom menu.
 *
 * @param $menu
 *   An array representing a custom menu:
249 250
 *   - menu_name: The unique name of the custom menu (composed of lowercase
 *     letters, numbers, and hyphens).
251 252 253 254 255 256 257 258 259
 *   - title: The human readable menu title.
 *   - description: The custom menu description.
 *
 * Modules should always pass a fully populated $menu when saving a custom
 * menu, so other modules are able to output proper status or watchdog messages.
 *
 * @see menu_load()
 */
function menu_save($menu) {
260
  $status = db_merge('menu_custom')
261 262 263 264 265 266
    ->key(array('menu_name' => $menu['menu_name']))
    ->fields(array(
      'title' => $menu['title'],
      'description' => $menu['description'],
    ))
    ->execute();
267
  menu_cache_clear_all();
268

269 270 271 272 273 274 275 276
  switch ($status) {
    case SAVED_NEW:
      module_invoke_all('menu_insert', $menu);
      break;

    case SAVED_UPDATED:
      module_invoke_all('menu_update', $menu);
      break;
277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299
  }
}

/**
 * Delete a custom menu and all contained links.
 *
 * Note that this function deletes all menu links in a custom menu. While menu
 * links derived from router paths may be restored by rebuilding the menu, all
 * customized and custom links will be irreversibly gone. Therefore, this
 * function should usually be called from a user interface (form submit) handler
 * only, which allows the user to confirm the action.
 *
 * @param $menu
 *   An array representing a custom menu:
 *   - menu_name: The unique name of the custom menu.
 *   - title: The human readable menu title.
 *   - description: The custom menu description.
 *
 * Modules should always pass a fully populated $menu when deleting a custom
 * menu, so other modules are able to output proper status or watchdog messages.
 *
 * @see menu_load()
 *
300
 * menu_delete_links() will take care of clearing the page cache. Other modules
301 302 303 304 305
 * should take care of their menu-related data by implementing
 * hook_menu_delete().
 */
function menu_delete($menu) {
  // Delete all links from the menu.
306
  menu_delete_links($menu['menu_name']);
307 308 309 310 311 312

  // Delete the custom menu.
  db_delete('menu_custom')
    ->condition('menu_name', $menu['menu_name'])
    ->execute();

313
  menu_cache_clear_all();
314 315 316
  module_invoke_all('menu_delete', $menu);
}

317
/**
318
 * Return a list of menu items that are valid possible parents for the given menu item.
319
 *
320 321
 * @param $menus
 *   An array of menu names and titles, such as from menu_get_menus().
322
 * @param $item
323
 *   The menu item or the node type for which to generate a list of parents.
324
 *   If $item['mlid'] == 0 then the complete tree is returned.
325 326 327
 * @param $type
 *   The node type for which to generate a list of parents.
 *   If $item itself is a node type then $type is ignored.
328
 * @return
329 330
 *   An array of menu link titles keyed on the a string containing the menu name
 *   and mlid. The list excludes the given item and its children.
331 332 333
 *
 * @todo This has to be turned into a #process form element callback. The
 *   'menu_override_parent_selector' variable is entirely superfluous.
334
 */
335
function menu_parent_options($menus, $item, $type = '') {
336 337 338 339 340 341 342
  // The menu_links table can be practically any size and we need a way to
  // allow contrib modules to provide more scalable pattern choosers.
  // hook_form_alter is too late in itself because all the possible parents are
  // retrieved here, unless menu_override_parent_selector is set to TRUE.
  if (variable_get('menu_override_parent_selector', FALSE)) {
    return array();
  }
343 344

  $available_menus = array();
345 346 347 348 349 350 351 352
  if (!is_array($item)) {
    // If $item is not an array then it is a node type.
    // Use it as $type and prepare a dummy menu item for _menu_get_options().
    $type = $item;
    $item = array('mlid' => 0);
  }
  if (empty($type)) {
    // If no node type is set, use all menus given to this function.
353 354 355
    $available_menus = $menus;
  }
  else {
356 357
    // If a node type is set, use all available menus for this type.
    $type_menus = variable_get('menu_options_' . $type, array('main-menu' => 'main-menu'));
358 359 360 361 362 363 364 365 366 367
    foreach ($type_menus as $menu) {
      $available_menus[$menu] = $menu;
    }
  }

  return _menu_get_options($menus, $available_menus, $item);
}

/**
 * Page callback.
368
 * Get all the available menus and menu items as a JavaScript array.
369 370 371 372 373 374 375 376 377
 */
function menu_parent_options_js() {
  $available_menus = array();
  if (isset($_POST['menus']) && count($_POST['menus'])) {
    foreach ($_POST['menus'] as $menu) {
      $available_menus[$menu] = $menu;
    }
  }
  $options = _menu_get_options(menu_get_menus(), $available_menus, array('mlid' => 0));
378 379

  drupal_json_output($options);
380 381 382 383 384 385
}

/**
 * Helper function to get the items of the given menu.
 */
function _menu_get_options($menus, $available_menus, $item) {
386
  // If the item has children, there is an added limit to the depth of valid parents.
387 388 389 390 391 392
  if (isset($item['parent_depth_limit'])) {
    $limit = $item['parent_depth_limit'];
  }
  else {
    $limit = _menu_parent_depth_limit($item);
  }
393

394
  $options = array();
395
  foreach ($menus as $menu_name => $title) {
396 397 398 399 400
    if (isset($available_menus[$menu_name])) {
      $tree = menu_tree_all_data($menu_name, NULL);
      $options[$menu_name . ':0'] = '<' . $title . '>';
      _menu_parents_recurse($tree, $menu_name, '--', $options, $item['mlid'], $limit);
    }
401
  }
402
  return $options;
403 404 405
}

/**
406
 * Recursive helper function for menu_parent_options().
407
 */
408
function _menu_parents_recurse($tree, $menu_name, $indent, &$options, $exclude, $depth_limit) {
409
  foreach ($tree as $data) {
410 411 412 413
    if ($data['link']['depth'] > $depth_limit) {
      // Don't iterate through any links on this level.
      break;
    }
414
    if ($data['link']['mlid'] != $exclude && $data['link']['hidden'] >= 0) {
415
      $title = $indent . ' ' . truncate_utf8($data['link']['title'], 30, TRUE, FALSE);
416
      if ($data['link']['hidden']) {
417
        $title .= ' (' . t('disabled') . ')';
418
      }
419
      $options[$menu_name . ':' . $data['link']['mlid']] = $title;
420
      if ($data['below']) {
421
        _menu_parents_recurse($data['below'], $menu_name, $indent . '--', $options, $exclude, $depth_limit);
422 423 424
      }
    }
  }
425 426
}

427
/**
428
 * Reset a system-defined menu link.
429
 */
430 431 432 433 434 435 436 437 438 439
function menu_reset_item($link) {
  // To reset the link to its original values, we need to retrieve its
  // definition from hook_menu(). Otherwise, for example, the link's menu would
  // not be reset, because properties like the original 'menu_name' are not
  // stored anywhere else. Since resetting a link happens rarely and this is a
  // one-time operation, retrieving the full menu router does no harm.
  $menu = menu_get_router();
  $router_item = $menu[$link['router_path']];
  $new_link = _menu_link_build($router_item);
  // Merge existing menu link's ID and 'has_children' property.
440
  foreach (array('mlid', 'has_children') as $key) {
441
    $new_link[$key] = $link[$key];
442
  }
443 444
  menu_link_save($new_link);
  return $new_link;
445 446
}

447
/**
448
 * Implements hook_block_info().
449
 */
450
function menu_block_info() {
451
  $menus = menu_get_menus(FALSE);
452 453 454 455 456 457 458

  $blocks = array();
  foreach ($menus as $name => $title) {
    // Default "Navigation" block is handled by user.module.
    $blocks[$name]['info'] = check_plain($title);
    // Menu blocks can't be cached because each menu item can have
    // a custom access callback. menu.inc manages its own caching.
459
    $blocks[$name]['cache'] = DRUPAL_NO_CACHE;
460
  }
461 462 463 464
  return $blocks;
}

/**
465
 * Implements hook_block_view().
466 467
 */
function menu_block_view($delta = '') {
468
  $menus = menu_get_menus(FALSE);
469 470
  $data['subject'] = check_plain($menus[$delta]);
  $data['content'] = menu_tree($delta);
471 472
  // Add contextual links for this block.
  if (!empty($data['content'])) {
473
    $data['content']['#contextual_links']['menu'] = array('admin/structure/menu/manage', array($delta));
474
  }
475
  return $data;
476
}
477

478
/**
479
 * Implements hook_block_view_alter().
480 481 482 483 484 485
 */
function menu_block_view_alter(&$data, $block) {
  // Add contextual links for system menu blocks.
  if ($block->module == 'system' && !empty($data['content'])) {
    $system_menus = menu_list_system_menus();
    if (isset($system_menus[$block->delta])) {
486
      $data['content']['#contextual_links']['menu'] = array('admin/structure/menu/manage', array($block->delta));
487 488 489 490
    }
  }
}

491
/**
492
 * Implements hook_node_insert().
493
 */
494
function menu_node_insert($node) {
495
  menu_node_save($node);
496 497 498
}

/**
499
 * Implements hook_node_update().
500
 */
501
function menu_node_update($node) {
502 503 504 505 506 507
  menu_node_save($node);
}

/**
 * Helper for hook_node_insert() and hook_node_update().
 */
508
function menu_node_save($node) {
509
  if (isset($node->menu)) {
510 511 512 513 514
    $link = &$node->menu;
    if (empty($link['enabled'])) {
      if (!empty($link['mlid'])) {
        menu_link_delete($link['mlid']);
      }
515
    }
516 517 518
    elseif (trim($link['link_title'])) {
      $link['link_title'] = trim($link['link_title']);
      $link['link_path'] = "node/$node->nid";
519 520 521 522 523 524 525
      if (trim($link['description'])) {
        $link['options']['attributes']['title'] = trim($link['description']);
      }
      else {
        // If the description field was left empty, remove the title attribute
        // from the menu link.
        unset($link['options']['attributes']['title']);
526
      }
527
      if (!menu_link_save($link)) {
528
        drupal_set_message(t('There was an error saving the menu link.'), 'error');
529
      }
530 531 532 533 534
    }
  }
}

/**
535
 * Implements hook_node_delete().
536
 */
537
function menu_node_delete($node) {
538
  // Delete all menu module links that point to this node.
539
  $result = db_query("SELECT mlid FROM {menu_links} WHERE link_path = :path AND module = 'menu'", array(':path' => 'node/' . $node->nid), array('fetch' => PDO::FETCH_ASSOC));
540
  foreach ($result as $m) {
541 542 543 544 545
    menu_link_delete($m['mlid']);
  }
}

/**
546
 * Implements hook_node_prepare().
547
 */
548
function menu_node_prepare($node) {
549 550
  if (empty($node->menu)) {
    // Prepare the node for the edit form so that $node->menu always exists.
551
    $menu_name = strtok(variable_get('menu_parent_' . $node->type, 'main-menu:0'), ':');
552 553
    $item = array();
    if (isset($node->nid)) {
554
      $mlid = FALSE;
555
      // Give priority to the default menu
556 557 558
      $type_menus = variable_get('menu_options_' . $node->type, array('main-menu' => 'main-menu'));
      if (in_array($menu_name, $type_menus)) {
        $mlid = db_query_range("SELECT mlid FROM {menu_links} WHERE link_path = :path AND menu_name = :menu_name AND module = 'menu' ORDER BY mlid ASC", 0, 1, array(
559
          ':path' => 'node/' . $node->nid,
560 561 562 563 564 565 566 567
          ':menu_name' => $menu_name,
        ))->fetchField();
      }
      // Check all allowed menus if a link does not exist in the default menu.
      if (!$mlid && !empty($type_menus)) {
        $mlid = db_query_range("SELECT mlid FROM {menu_links} WHERE link_path = :path AND module = 'menu' AND menu_name IN (:type_menus) ORDER BY mlid ASC", 0, 1, array(
          ':path' => 'node/' . $node->nid,
          ':type_menus' => array_values($type_menus),
568
        ))->fetchField();
569 570 571 572 573 574
      }
      if ($mlid) {
        $item = menu_link_load($mlid);
      }
    }
    // Set default values.
575 576 577 578 579 580 581 582 583 584 585 586 587
    $node->menu = $item + array(
      'link_title' => '',
      'mlid' => 0,
      'plid' => 0,
      'menu_name' => $menu_name,
      'weight' => 0,
      'options' => array(),
      'module' => 'menu',
      'expanded' => 0,
      'hidden' => 0,
      'has_children' => 0,
      'customized' => 0,
    );
588 589 590 591
  }
  // Find the depth limit for the parent select.
  if (!isset($node->menu['parent_depth_limit'])) {
    $node->menu['parent_depth_limit'] = _menu_parent_depth_limit($node->menu);
592 593 594
  }
}

595 596 597 598 599 600 601
/**
 * Find the depth limit for items in the parent select.
 */
function _menu_parent_depth_limit($item) {
  return MENU_MAX_DEPTH - 1 - (($item['mlid'] && $item['has_children']) ? menu_link_children_relative_depth($item) : 0);
}

602
/**
603 604 605 606 607
 * Implements hook_form_BASE_FORM_ID_alter().
 *
 * Adds menu item fields to the node form.
 *
 * @see menu_node_submit()
608
 */
609
function menu_form_node_form_alter(&$form, $form_state) {
610
  // Generate a list of possible parents (not including this link or descendants).
611
  // @todo This must be handled in a #process handler.
612
  $link = $form['#node']->menu;
613
  $type = $form['#node']->type;
614 615 616 617
  // menu_parent_options() is goofy and can actually handle either a menu link
  // or a node type both as second argument. Pick based on whether there is
  // a link already (menu_node_prepare() sets mlid default to 0).
  $options = menu_parent_options(menu_get_menus(), $link['mlid'] ? $link : $type);
618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647
  // If no possible parent menu items were found, there is nothing to display.
  if (empty($options)) {
    return;
  }

  $form['menu'] = array(
    '#type' => 'fieldset',
    '#title' => t('Menu settings'),
    '#access' => user_access('administer menu'),
    '#collapsible' => TRUE,
    '#collapsed' => !$link['link_title'],
    '#group' => 'additional_settings',
    '#attached' => array(
      'js' => array(drupal_get_path('module', 'menu') . '/menu.js'),
    ),
    '#tree' => TRUE,
    '#weight' => -2,
    '#attributes' => array('class' => array('menu-link-form')),
  );
  $form['menu']['enabled'] = array(
    '#type' => 'checkbox',
    '#title' => t('Provide a menu link'),
    '#default_value' => (int) (bool) $link['mlid'],
  );
  $form['menu']['link'] = array(
    '#type' => 'container',
    '#parents' => array('menu'),
    '#states' => array(
      'invisible' => array(
        'input[name="menu[enabled]"]' => array('checked' => FALSE),
648
      ),
649 650
    ),
  );
651

652 653 654 655
  // Populate the element with the link data.
  foreach (array('mlid', 'module', 'hidden', 'has_children', 'customized', 'options', 'expanded', 'hidden', 'parent_depth_limit') as $key) {
    $form['menu']['link'][$key] = array('#type' => 'value', '#value' => $link[$key]);
  }
656

657 658 659 660 661
  $form['menu']['link']['link_title'] = array(
    '#type' => 'textfield',
    '#title' => t('Menu link title'),
    '#default_value' => $link['link_title'],
  );
662

663 664 665 666 667 668 669
  $form['menu']['link']['description'] = array(
    '#type' => 'textarea',
    '#title' => t('Description'),
    '#default_value' => isset($link['options']['attributes']['title']) ? $link['options']['attributes']['title'] : '',
    '#rows' => 1,
    '#description' => t('Shown when hovering over the menu link.'),
  );
670

671
  $default = ($link['mlid'] ? $link['menu_name'] . ':' . $link['plid'] : variable_get('menu_parent_' . $type, 'main-menu:0'));
672 673 674 675
  // If the current parent menu item is not present in options, use the first
  // available option as default value.
  // @todo User should not be allowed to access menu link settings in such a
  // case.
676
  if (!isset($options[$default])) {
677 678
    $array = array_keys($options);
    $default = reset($array);
679
  }
680 681 682 683 684 685 686 687 688 689 690 691 692 693
  $form['menu']['link']['parent'] = array(
    '#type' => 'select',
    '#title' => t('Parent item'),
    '#default_value' => $default,
    '#options' => $options,
    '#attributes' => array('class' => array('menu-parent-select')),
  );
  $form['menu']['link']['weight'] = array(
    '#type' => 'weight',
    '#title' => t('Weight'),
    '#delta' => 50,
    '#default_value' => $link['weight'],
    '#description' => t('Menu links with smaller weights are displayed before links with larger weights.'),
  );
694 695
}

696
/**
697
 * Implements hook_node_submit().
698 699
 *
 * @see menu_form_node_form_alter()
700
 */
701
function menu_node_submit($node, $form, $form_state) {
702 703 704
  // Decompose the selected menu parent option into 'menu_name' and 'plid', if
  // the form used the default parent selection widget.
  if (!empty($form_state['values']['menu']['parent'])) {
705
    list($node->menu['menu_name'], $node->menu['plid']) = explode(':', $form_state['values']['menu']['parent']);
706 707 708
  }
}

709
/**
710 711
 * Implements hook_form_FORM_ID_alter().
 *
712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729
 * Adds menu options to the node type form.
 */
function menu_form_node_type_form_alter(&$form, $form_state) {
  $menu_options = menu_get_menus();
  $type = $form['#node_type'];
  $form['menu'] = array(
    '#type' => 'fieldset',
    '#title' => t('Menu settings'),
    '#collapsible' => TRUE,
    '#collapsed' => TRUE,
    '#attached' => array(
      'js' => array(drupal_get_path('module', 'menu') . '/menu.admin.js'),
    ),
    '#group' => 'additional_settings',
  );
  $form['menu']['menu_options'] = array(
    '#type' => 'checkboxes',
    '#title' => t('Available menus'),
730
    '#default_value' => variable_get('menu_options_' . $type->type, array('main-menu')),
731 732 733 734 735 736
    '#options' => $menu_options,
    '#description' => t('The menus available to place links in for this content type.'),
  );
  // To avoid an 'illegal option' error after saving the form we have to load
  // all available menu items.
  // Otherwise it is not possible to dynamically add options to the list.
737
  // @todo Convert menu_parent_options() into a #process callback.
738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755
  $options = menu_parent_options(menu_get_menus(), array('mlid' => 0));
  $form['menu']['menu_parent'] = array(
    '#type' => 'select',
    '#title' => t('Default parent item'),
    '#default_value' => variable_get('menu_parent_' . $type->type, 'main-menu:0'),
    '#options' => $options,
    '#description' => t('Choose the menu item to be the default parent for a new link in the content authoring form.'),
    '#attributes' => array('class' => array('menu-title-select')),
  );

  // Call Drupal.menu_update_parent_list() to filter the list of
  // available default parent menu items based on the selected menus.
  drupal_add_js(
    '(function ($) { Drupal.menu_update_parent_list(); })(jQuery);',
    array('scope' => 'footer', 'type' => 'inline')
  );
}

756 757 758 759 760 761 762 763 764 765
/**
 * Return an associative array of the custom menus names.
 *
 * @param $all
 *   If FALSE return only user-added menus, or if TRUE also include
 *   the menus defined by the system.
 * @return
 *   An array with the machine-readable names as the keys, and human-readable
 *   titles as the values.
 */
766
function menu_get_menus($all = TRUE) {
767 768 769 770 771 772 773 774
  if ($custom_menus = menu_load_all()) {
    if (!$all) {
      $custom_menus = array_diff_key($custom_menus, menu_list_system_menus());
    }
    foreach ($custom_menus as $menu_name => $menu) {
      $custom_menus[$menu_name] = t($menu['title']);
    }
    asort($custom_menus);
775
  }
776
  return $custom_menus;
777
}