cms/drupal/modules/menu/menu.admin.inc
changeset 541 e756a8c72c3d
equal deleted inserted replaced
540:07239de796bb 541:e756a8c72c3d
       
     1 <?php
       
     2 
       
     3 /**
       
     4  * @file
       
     5  * Administrative page callbacks for menu module.
       
     6  */
       
     7 
       
     8 /**
       
     9  * Menu callback which shows an overview page of all the custom menus and their descriptions.
       
    10  */
       
    11 function menu_overview_page() {
       
    12   $result = db_query("SELECT * FROM {menu_custom} ORDER BY title", array(), array('fetch' => PDO::FETCH_ASSOC));
       
    13   $header = array(t('Title'), array('data' => t('Operations'), 'colspan' => '3'));
       
    14   $rows = array();
       
    15   foreach ($result as $menu) {
       
    16     $row = array(theme('menu_admin_overview', array('title' => $menu['title'], 'name' => $menu['menu_name'], 'description' => $menu['description'])));
       
    17     $row[] = array('data' => l(t('list links'), 'admin/structure/menu/manage/' . $menu['menu_name']));
       
    18     $row[] = array('data' => l(t('edit menu'), 'admin/structure/menu/manage/' . $menu['menu_name'] . '/edit'));
       
    19     $row[] = array('data' => l(t('add link'), 'admin/structure/menu/manage/' . $menu['menu_name'] . '/add'));
       
    20     $rows[] = $row;
       
    21   }
       
    22 
       
    23   return theme('table', array('header' => $header, 'rows' => $rows));
       
    24 }
       
    25 
       
    26 /**
       
    27  * Returns HTML for a menu title and description for the menu overview page.
       
    28  *
       
    29  * @param $variables
       
    30  *   An associative array containing:
       
    31  *   - title: The menu's title.
       
    32  *   - description: The menu's description.
       
    33  *
       
    34  * @ingroup themeable
       
    35  */
       
    36 function theme_menu_admin_overview($variables) {
       
    37   $output = check_plain($variables['title']);
       
    38   $output .= '<div class="description">' . filter_xss_admin($variables['description']) . '</div>';
       
    39 
       
    40   return $output;
       
    41 }
       
    42 
       
    43 /**
       
    44  * Form for editing an entire menu tree at once.
       
    45  *
       
    46  * Shows for one menu the menu links accessible to the current user and
       
    47  * relevant operations.
       
    48  */
       
    49 function menu_overview_form($form, &$form_state, $menu) {
       
    50   global $menu_admin;
       
    51   $form['#attached']['css'] = array(drupal_get_path('module', 'menu') . '/menu.css');
       
    52   $sql = "
       
    53     SELECT m.load_functions, m.to_arg_functions, m.access_callback, m.access_arguments, m.page_callback, m.page_arguments, m.delivery_callback, m.title, m.title_callback, m.title_arguments, m.type, m.description, ml.*
       
    54     FROM {menu_links} ml LEFT JOIN {menu_router} m ON m.path = ml.router_path
       
    55     WHERE ml.menu_name = :menu
       
    56     ORDER BY p1 ASC, p2 ASC, p3 ASC, p4 ASC, p5 ASC, p6 ASC, p7 ASC, p8 ASC, p9 ASC";
       
    57   $result = db_query($sql, array(':menu' => $menu['menu_name']), array('fetch' => PDO::FETCH_ASSOC));
       
    58   $links = array();
       
    59   foreach ($result as $item) {
       
    60     $links[] = $item;
       
    61   }
       
    62   $tree = menu_tree_data($links);
       
    63   $node_links = array();
       
    64   menu_tree_collect_node_links($tree, $node_links);
       
    65   // We indicate that a menu administrator is running the menu access check.
       
    66   $menu_admin = TRUE;
       
    67   menu_tree_check_access($tree, $node_links);
       
    68   $menu_admin = FALSE;
       
    69 
       
    70   $form = array_merge($form, _menu_overview_tree_form($tree));
       
    71   $form['#menu'] =  $menu;
       
    72 
       
    73   if (element_children($form)) {
       
    74     $form['actions'] = array('#type' => 'actions');
       
    75     $form['actions']['submit'] = array(
       
    76       '#type' => 'submit',
       
    77       '#value' => t('Save configuration'),
       
    78     );
       
    79   }
       
    80   else {
       
    81     $form['#empty_text'] = t('There are no menu links yet. <a href="@link">Add link</a>.', array('@link' => url('admin/structure/menu/manage/'. $form['#menu']['menu_name'] .'/add')));
       
    82   }
       
    83   return $form;
       
    84 }
       
    85 
       
    86 /**
       
    87  * Recursive helper function for menu_overview_form().
       
    88  *
       
    89  * @param $tree
       
    90  *   The menu_tree retrieved by menu_tree_data.
       
    91  */
       
    92 function _menu_overview_tree_form($tree) {
       
    93   $form = &drupal_static(__FUNCTION__, array('#tree' => TRUE));
       
    94   foreach ($tree as $data) {
       
    95     $title = '';
       
    96     $item = $data['link'];
       
    97     // Don't show callbacks; these have $item['hidden'] < 0.
       
    98     if ($item && $item['hidden'] >= 0) {
       
    99       $mlid = 'mlid:' . $item['mlid'];
       
   100       $form[$mlid]['#item'] = $item;
       
   101       $form[$mlid]['#attributes'] = $item['hidden'] ? array('class' => array('menu-disabled')) : array('class' => array('menu-enabled'));
       
   102       $form[$mlid]['title']['#markup'] = l($item['title'], $item['href'], $item['localized_options']);
       
   103       if ($item['hidden']) {
       
   104         $form[$mlid]['title']['#markup'] .= ' (' . t('disabled') . ')';
       
   105       }
       
   106       elseif ($item['link_path'] == 'user' && $item['module'] == 'system') {
       
   107         $form[$mlid]['title']['#markup'] .= ' (' . t('logged in users only') . ')';
       
   108       }
       
   109 
       
   110       $form[$mlid]['hidden'] = array(
       
   111         '#type' => 'checkbox',
       
   112         '#title' => t('Enable @title menu link', array('@title' => $item['title'])),
       
   113         '#title_display' => 'invisible',
       
   114         '#default_value' => !$item['hidden'],
       
   115       );
       
   116       $form[$mlid]['weight'] = array(
       
   117         '#type' => 'weight',
       
   118         '#delta' => 50,
       
   119         '#default_value' => $item['weight'],
       
   120         '#title_display' => 'invisible',
       
   121         '#title' => t('Weight for @title', array('@title' => $item['title'])),
       
   122       );
       
   123       $form[$mlid]['mlid'] = array(
       
   124         '#type' => 'hidden',
       
   125         '#value' => $item['mlid'],
       
   126       );
       
   127       $form[$mlid]['plid'] = array(
       
   128         '#type' => 'hidden',
       
   129         '#default_value' => $item['plid'],
       
   130       );
       
   131       // Build a list of operations.
       
   132       $operations = array();
       
   133       $operations['edit'] = array('#type' => 'link', '#title' => t('edit'), '#href' => 'admin/structure/menu/item/' . $item['mlid'] . '/edit');
       
   134       // Only items created by the menu module can be deleted.
       
   135       if ($item['module'] == 'menu' || $item['updated'] == 1) {
       
   136         $operations['delete'] = array('#type' => 'link', '#title' => t('delete'), '#href' => 'admin/structure/menu/item/' . $item['mlid'] . '/delete');
       
   137       }
       
   138       // Set the reset column.
       
   139       elseif ($item['module'] == 'system' && $item['customized']) {
       
   140         $operations['reset'] = array('#type' => 'link', '#title' => t('reset'), '#href' => 'admin/structure/menu/item/' . $item['mlid'] . '/reset');
       
   141       }
       
   142       $form[$mlid]['operations'] = $operations;
       
   143     }
       
   144 
       
   145     if ($data['below']) {
       
   146       _menu_overview_tree_form($data['below']);
       
   147     }
       
   148   }
       
   149   return $form;
       
   150 }
       
   151 
       
   152 /**
       
   153  * Submit handler for the menu overview form.
       
   154  *
       
   155  * This function takes great care in saving parent items first, then items
       
   156  * underneath them. Saving items in the incorrect order can break the menu tree.
       
   157  *
       
   158  * @see menu_overview_form()
       
   159  */
       
   160 function menu_overview_form_submit($form, &$form_state) {
       
   161   // When dealing with saving menu items, the order in which these items are
       
   162   // saved is critical. If a changed child item is saved before its parent,
       
   163   // the child item could be saved with an invalid path past its immediate
       
   164   // parent. To prevent this, save items in the form in the same order they
       
   165   // are sent by $_POST, ensuring parents are saved first, then their children.
       
   166   // See http://drupal.org/node/181126#comment-632270
       
   167   $order = array_flip(array_keys($form_state['input'])); // Get the $_POST order.
       
   168   $form = array_merge($order, $form); // Update our original form with the new order.
       
   169 
       
   170   $updated_items = array();
       
   171   $fields = array('weight', 'plid');
       
   172   foreach (element_children($form) as $mlid) {
       
   173     if (isset($form[$mlid]['#item'])) {
       
   174       $element = $form[$mlid];
       
   175       // Update any fields that have changed in this menu item.
       
   176       foreach ($fields as $field) {
       
   177         if ($element[$field]['#value'] != $element[$field]['#default_value']) {
       
   178           $element['#item'][$field] = $element[$field]['#value'];
       
   179           $updated_items[$mlid] = $element['#item'];
       
   180         }
       
   181       }
       
   182       // Hidden is a special case, the value needs to be reversed.
       
   183       if ($element['hidden']['#value'] != $element['hidden']['#default_value']) {
       
   184         // Convert to integer rather than boolean due to PDO cast to string.
       
   185         $element['#item']['hidden'] = $element['hidden']['#value'] ? 0 : 1;
       
   186         $updated_items[$mlid] = $element['#item'];
       
   187       }
       
   188     }
       
   189   }
       
   190 
       
   191   // Save all our changed items to the database.
       
   192   foreach ($updated_items as $item) {
       
   193     $item['customized'] = 1;
       
   194     menu_link_save($item);
       
   195   }
       
   196   drupal_set_message(t('Your configuration has been saved.'));
       
   197 }
       
   198 
       
   199 /**
       
   200  * Returns HTML for the menu overview form into a table.
       
   201  *
       
   202  * @param $variables
       
   203  *   An associative array containing:
       
   204  *   - form: A render element representing the form.
       
   205  *
       
   206  * @ingroup themeable
       
   207  */
       
   208 function theme_menu_overview_form($variables) {
       
   209   $form = $variables['form'];
       
   210 
       
   211   drupal_add_tabledrag('menu-overview', 'match', 'parent', 'menu-plid', 'menu-plid', 'menu-mlid', TRUE, MENU_MAX_DEPTH - 1);
       
   212   drupal_add_tabledrag('menu-overview', 'order', 'sibling', 'menu-weight');
       
   213 
       
   214   $header = array(
       
   215     t('Menu link'),
       
   216     array('data' => t('Enabled'), 'class' => array('checkbox')),
       
   217     t('Weight'),
       
   218     array('data' => t('Operations'), 'colspan' => '3'),
       
   219   );
       
   220 
       
   221   $rows = array();
       
   222   foreach (element_children($form) as $mlid) {
       
   223     if (isset($form[$mlid]['hidden'])) {
       
   224       $element = &$form[$mlid];
       
   225       // Build a list of operations.
       
   226       $operations = array();
       
   227       foreach (element_children($element['operations']) as $op) {
       
   228         $operations[] = array('data' => drupal_render($element['operations'][$op]), 'class' => array('menu-operations'));
       
   229       }
       
   230       while (count($operations) < 2) {
       
   231         $operations[] = '';
       
   232       }
       
   233 
       
   234       // Add special classes to be used for tabledrag.js.
       
   235       $element['plid']['#attributes']['class'] = array('menu-plid');
       
   236       $element['mlid']['#attributes']['class'] = array('menu-mlid');
       
   237       $element['weight']['#attributes']['class'] = array('menu-weight');
       
   238 
       
   239       // Change the parent field to a hidden. This allows any value but hides the field.
       
   240       $element['plid']['#type'] = 'hidden';
       
   241 
       
   242       $row = array();
       
   243       $row[] = theme('indentation', array('size' => $element['#item']['depth'] - 1)) . drupal_render($element['title']);
       
   244       $row[] = array('data' => drupal_render($element['hidden']), 'class' => array('checkbox', 'menu-enabled'));
       
   245       $row[] = drupal_render($element['weight']) . drupal_render($element['plid']) . drupal_render($element['mlid']);
       
   246       $row = array_merge($row, $operations);
       
   247 
       
   248       $row = array_merge(array('data' => $row), $element['#attributes']);
       
   249       $row['class'][] = 'draggable';
       
   250       $rows[] = $row;
       
   251     }
       
   252   }
       
   253   $output = '';
       
   254   if (empty($rows)) {
       
   255     $rows[] = array(array('data' => $form['#empty_text'], 'colspan' => '7'));
       
   256   }
       
   257   $output .= theme('table', array('header' => $header, 'rows' => $rows, 'attributes' => array('id' => 'menu-overview')));
       
   258   $output .= drupal_render_children($form);
       
   259   return $output;
       
   260 }
       
   261 
       
   262 /**
       
   263  * Menu callback; Build the menu link editing form.
       
   264  */
       
   265 function menu_edit_item($form, &$form_state, $type, $item, $menu) {
       
   266   if ($type == 'add' || empty($item)) {
       
   267     // This is an add form, initialize the menu link.
       
   268     $item = array('link_title' => '', 'mlid' => 0, 'plid' => 0, 'menu_name' => $menu['menu_name'], 'weight' => 0, 'link_path' => '', 'options' => array(), 'module' => 'menu', 'expanded' => 0, 'hidden' => 0, 'has_children' => 0);
       
   269   }
       
   270   else {
       
   271     // Get the human-readable menu title from the given menu name.
       
   272     $titles = menu_get_menus();
       
   273     $current_title = $titles[$item['menu_name']];
       
   274 
       
   275     // Get the current breadcrumb and add a link to that menu's overview page.
       
   276     $breadcrumb = menu_get_active_breadcrumb();
       
   277     $breadcrumb[] = l($current_title, 'admin/structure/menu/manage/' . $item['menu_name']);
       
   278     drupal_set_breadcrumb($breadcrumb);
       
   279   }
       
   280   $form['actions'] = array('#type' => 'actions');
       
   281   $form['link_title'] = array(
       
   282     '#type' => 'textfield',
       
   283     '#title' => t('Menu link title'),
       
   284     '#maxlength' => 255,
       
   285     '#default_value' => $item['link_title'],
       
   286     '#description' => t('The text to be used for this link in the menu.'),
       
   287     '#required' => TRUE,
       
   288   );
       
   289   foreach (array('link_path', 'mlid', 'module', 'has_children', 'options') as $key) {
       
   290     $form[$key] = array('#type' => 'value', '#value' => $item[$key]);
       
   291   }
       
   292   // Any item created or edited via this interface is considered "customized".
       
   293   $form['customized'] = array('#type' => 'value', '#value' => 1);
       
   294   $form['original_item'] = array('#type' => 'value', '#value' => $item);
       
   295 
       
   296   $path = $item['link_path'];
       
   297   if (isset($item['options']['query'])) {
       
   298     $path .= '?' . drupal_http_build_query($item['options']['query']);
       
   299   }
       
   300   if (isset($item['options']['fragment'])) {
       
   301     $path .= '#' . $item['options']['fragment'];
       
   302   }
       
   303   if ($item['module'] == 'menu') {
       
   304     $form['link_path'] = array(
       
   305       '#type' => 'textfield',
       
   306       '#title' => t('Path'),
       
   307       '#maxlength' => 255,
       
   308       '#default_value' => $path,
       
   309       '#description' => t('The path for this menu link. This can be an internal path such as %add-node or an external URL such as %example. Enter %front to link to the front page.', array('%front' => '<front>', '%add-node' => 'node/add', '%example' => 'http://example.com')),
       
   310       '#required' => TRUE,
       
   311     );
       
   312     $form['actions']['delete'] = array(
       
   313       '#type' => 'submit',
       
   314       '#value' => t('Delete'),
       
   315       '#access' => $item['mlid'],
       
   316       '#submit' => array('menu_item_delete_submit'),
       
   317       '#weight' => 10,
       
   318     );
       
   319   }
       
   320   else {
       
   321     $form['_path'] = array(
       
   322       '#type' => 'item',
       
   323       '#title' => t('Path'),
       
   324       '#description' => l($item['link_title'], $item['href'], $item['options']),
       
   325     );
       
   326   }
       
   327   $form['description'] = array(
       
   328     '#type' => 'textarea',
       
   329     '#title' => t('Description'),
       
   330     '#default_value' => isset($item['options']['attributes']['title']) ? $item['options']['attributes']['title'] : '',
       
   331     '#rows' => 1,
       
   332     '#description' => t('Shown when hovering over the menu link.'),
       
   333   );
       
   334   $form['enabled'] = array(
       
   335     '#type' => 'checkbox',
       
   336     '#title' => t('Enabled'),
       
   337     '#default_value' => !$item['hidden'],
       
   338     '#description' => t('Menu links that are not enabled will not be listed in any menu.'),
       
   339   );
       
   340   $form['expanded'] = array(
       
   341     '#type' => 'checkbox',
       
   342     '#title' => t('Show as expanded'),
       
   343     '#default_value' => $item['expanded'],
       
   344     '#description' => t('If selected and this menu link has children, the menu will always appear expanded.'),
       
   345   );
       
   346 
       
   347   // Generate a list of possible parents (not including this link or descendants).
       
   348   $options = menu_parent_options(menu_get_menus(), $item);
       
   349   $default = $item['menu_name'] . ':' . $item['plid'];
       
   350   if (!isset($options[$default])) {
       
   351     $default = 'navigation:0';
       
   352   }
       
   353   $form['parent'] = array(
       
   354     '#type' => 'select',
       
   355     '#title' => t('Parent link'),
       
   356     '#default_value' => $default,
       
   357     '#options' => $options,
       
   358     '#description' => t('The maximum depth for a link and all its children is fixed at !maxdepth. Some menu links may not be available as parents if selecting them would exceed this limit.', array('!maxdepth' => MENU_MAX_DEPTH)),
       
   359     '#attributes' => array('class' => array('menu-title-select')),
       
   360   );
       
   361   $form['weight'] = array(
       
   362     '#type' => 'weight',
       
   363     '#title' => t('Weight'),
       
   364     '#delta' => 50,
       
   365     '#default_value' => $item['weight'],
       
   366     '#description' => t('Optional. In the menu, the heavier links will sink and the lighter links will be positioned nearer the top.'),
       
   367   );
       
   368   $form['actions']['submit'] = array('#type' => 'submit', '#value' => t('Save'));
       
   369 
       
   370   return $form;
       
   371 }
       
   372 
       
   373 /**
       
   374  * Validate form values for a menu link being added or edited.
       
   375  */
       
   376 function menu_edit_item_validate($form, &$form_state) {
       
   377   $item = &$form_state['values'];
       
   378   $normal_path = drupal_get_normal_path($item['link_path']);
       
   379   if ($item['link_path'] != $normal_path) {
       
   380     drupal_set_message(t('The menu system stores system paths only, but will use the URL alias for display. %link_path has been stored as %normal_path', array('%link_path' => $item['link_path'], '%normal_path' => $normal_path)));
       
   381     $item['link_path'] = $normal_path;
       
   382   }
       
   383   if (!url_is_external($item['link_path'])) {
       
   384     $parsed_link = parse_url($item['link_path']);
       
   385     if (isset($parsed_link['query'])) {
       
   386       $item['options']['query'] = drupal_get_query_array($parsed_link['query']);
       
   387     }
       
   388     else {
       
   389       // Use unset() rather than setting to empty string
       
   390       // to avoid redundant serialized data being stored.
       
   391       unset($item['options']['query']);
       
   392     }
       
   393     if (isset($parsed_link['fragment'])) {
       
   394       $item['options']['fragment'] = $parsed_link['fragment'];
       
   395     }
       
   396     else {
       
   397       unset($item['options']['fragment']);
       
   398     }
       
   399     if (isset($parsed_link['path']) && $item['link_path'] != $parsed_link['path']) {
       
   400       $item['link_path'] = $parsed_link['path'];
       
   401     }
       
   402   }
       
   403   if (!trim($item['link_path']) || !drupal_valid_path($item['link_path'], TRUE)) {
       
   404     form_set_error('link_path', t("The path '@link_path' is either invalid or you do not have access to it.", array('@link_path' => $item['link_path'])));
       
   405   }
       
   406 }
       
   407 
       
   408 /**
       
   409  * Submit function for the delete button on the menu item editing form.
       
   410  */
       
   411 function menu_item_delete_submit($form, &$form_state) {
       
   412   $form_state['redirect'] = 'admin/structure/menu/item/' . $form_state['values']['mlid'] . '/delete';
       
   413 }
       
   414 
       
   415 /**
       
   416  * Process menu and menu item add/edit form submissions.
       
   417  */
       
   418 function menu_edit_item_submit($form, &$form_state) {
       
   419   $item = &$form_state['values'];
       
   420 
       
   421   // The value of "hidden" is the opposite of the value
       
   422   // supplied by the "enabled" checkbox.
       
   423   $item['hidden'] = (int) !$item['enabled'];
       
   424   unset($item['enabled']);
       
   425 
       
   426   $item['options']['attributes']['title'] = $item['description'];
       
   427   list($item['menu_name'], $item['plid']) = explode(':', $item['parent']);
       
   428   if (!menu_link_save($item)) {
       
   429     drupal_set_message(t('There was an error saving the menu link.'), 'error');
       
   430   }
       
   431   else {
       
   432     drupal_set_message(t('Your configuration has been saved.'));
       
   433   }
       
   434   $form_state['redirect'] = 'admin/structure/menu/manage/' . $item['menu_name'];
       
   435 }
       
   436 
       
   437 /**
       
   438  * Menu callback; Build the form that handles the adding/editing of a custom menu.
       
   439  */
       
   440 function menu_edit_menu($form, &$form_state, $type, $menu = array()) {
       
   441   $system_menus = menu_list_system_menus();
       
   442   $menu += array(
       
   443     'menu_name' => '',
       
   444     'old_name' => !empty($menu['menu_name']) ? $menu['menu_name'] : '',
       
   445     'title' => '',
       
   446     'description' => '',
       
   447   );
       
   448   // Allow menu_edit_menu_submit() and other form submit handlers to determine
       
   449   // whether the menu already exists.
       
   450   $form['#insert'] = empty($menu['old_name']);
       
   451   $form['old_name'] = array(
       
   452     '#type' => 'value',
       
   453     '#value' => $menu['old_name'],
       
   454   );
       
   455 
       
   456   $form['title'] = array(
       
   457     '#type' => 'textfield',
       
   458     '#title' => t('Title'),
       
   459     '#default_value' => $menu['title'],
       
   460     '#required' => TRUE,
       
   461     // The title of a system menu cannot be altered.
       
   462     '#access' => !isset($system_menus[$menu['menu_name']]),
       
   463   );
       
   464 
       
   465   $form['menu_name'] = array(
       
   466     '#type' => 'machine_name',
       
   467     '#title' => t('Menu name'),
       
   468     '#default_value' => $menu['menu_name'],
       
   469     '#maxlength' => MENU_MAX_MENU_NAME_LENGTH_UI,
       
   470     '#description' => t('A unique name to construct the URL for the menu. It must only contain lowercase letters, numbers and hyphens.'),
       
   471     '#machine_name' => array(
       
   472       'exists' => 'menu_edit_menu_name_exists',
       
   473       'source' => array('title'),
       
   474       'replace_pattern' => '[^a-z0-9-]+',
       
   475       'replace' => '-',
       
   476     ),
       
   477     // A menu's machine name cannot be changed.
       
   478     '#disabled' => !empty($menu['old_name']) || isset($system_menus[$menu['menu_name']]),
       
   479   );
       
   480 
       
   481   $form['description'] = array(
       
   482     '#type' => 'textarea',
       
   483     '#title' => t('Description'),
       
   484     '#default_value' => $menu['description'],
       
   485   );
       
   486   $form['actions'] = array('#type' => 'actions');
       
   487   $form['actions']['submit'] = array(
       
   488     '#type' => 'submit',
       
   489     '#value' => t('Save'),
       
   490   );
       
   491   // Only custom menus may be deleted.
       
   492   $form['actions']['delete'] = array(
       
   493     '#type' => 'submit',
       
   494     '#value' => t('Delete'),
       
   495     '#access' => $type == 'edit' && !isset($system_menus[$menu['menu_name']]),
       
   496     '#submit' => array('menu_custom_delete_submit'),
       
   497   );
       
   498 
       
   499   return $form;
       
   500 }
       
   501 
       
   502 /**
       
   503  * Submit function for the 'Delete' button on the menu editing form.
       
   504  */
       
   505 function menu_custom_delete_submit($form, &$form_state) {
       
   506   $form_state['redirect'] = 'admin/structure/menu/manage/' . $form_state['values']['menu_name'] . '/delete';
       
   507 }
       
   508 
       
   509 /**
       
   510  * Menu callback; check access and get a confirm form for deletion of a custom menu.
       
   511  */
       
   512 function menu_delete_menu_page($menu) {
       
   513   // System-defined menus may not be deleted.
       
   514   $system_menus = menu_list_system_menus();
       
   515   if (isset($system_menus[$menu['menu_name']])) {
       
   516     return MENU_ACCESS_DENIED;
       
   517   }
       
   518   return drupal_get_form('menu_delete_menu_confirm', $menu);
       
   519 }
       
   520 
       
   521 /**
       
   522  * Build a confirm form for deletion of a custom menu.
       
   523  */
       
   524 function menu_delete_menu_confirm($form, &$form_state, $menu) {
       
   525   $form['#menu'] = $menu;
       
   526   $caption = '';
       
   527   $num_links = db_query("SELECT COUNT(*) FROM {menu_links} WHERE menu_name = :menu", array(':menu' => $menu['menu_name']))->fetchField();
       
   528   if ($num_links) {
       
   529     $caption .= '<p>' . format_plural($num_links, '<strong>Warning:</strong> There is currently 1 menu link in %title. It will be deleted (system-defined items will be reset).', '<strong>Warning:</strong> There are currently @count menu links in %title. They will be deleted (system-defined links will be reset).', array('%title' => $menu['title'])) . '</p>';
       
   530   }
       
   531   $caption .= '<p>' . t('This action cannot be undone.') . '</p>';
       
   532   return confirm_form($form, t('Are you sure you want to delete the custom menu %title?', array('%title' => $menu['title'])), 'admin/structure/menu/manage/' . $menu['menu_name'], $caption, t('Delete'));
       
   533 }
       
   534 
       
   535 /**
       
   536  * Delete a custom menu and all links in it.
       
   537  */
       
   538 function menu_delete_menu_confirm_submit($form, &$form_state) {
       
   539   $menu = $form['#menu'];
       
   540   $form_state['redirect'] = 'admin/structure/menu';
       
   541 
       
   542   // System-defined menus may not be deleted - only menus defined by this module.
       
   543   $system_menus = menu_list_system_menus();
       
   544   if (isset($system_menus[$menu['menu_name']])  || !(db_query("SELECT 1 FROM {menu_custom} WHERE menu_name = :menu", array(':menu' => $menu['menu_name']))->fetchField())) {
       
   545     return;
       
   546   }
       
   547 
       
   548   // Reset all the menu links defined by the system via hook_menu().
       
   549   $result = db_query("SELECT * FROM {menu_links} ml INNER JOIN {menu_router} m ON ml.router_path = m.path WHERE ml.menu_name = :menu AND ml.module = 'system' ORDER BY m.number_parts ASC", array(':menu' => $menu['menu_name']), array('fetch' => PDO::FETCH_ASSOC));
       
   550   foreach ($result as $link) {
       
   551     menu_reset_item($link);
       
   552   }
       
   553 
       
   554   // Delete all links to the overview page for this menu.
       
   555   $result = db_query("SELECT mlid FROM {menu_links} ml WHERE ml.link_path = :link", array(':link' => 'admin/structure/menu/manage/' . $menu['menu_name']), array('fetch' => PDO::FETCH_ASSOC));
       
   556   foreach ($result as $link) {
       
   557     menu_link_delete($link['mlid']);
       
   558   }
       
   559 
       
   560   // Delete the custom menu and all its menu links.
       
   561   menu_delete($menu);
       
   562 
       
   563   $t_args = array('%title' => $menu['title']);
       
   564   drupal_set_message(t('The custom menu %title has been deleted.', $t_args));
       
   565   watchdog('menu', 'Deleted custom menu %title and all its menu links.', $t_args, WATCHDOG_NOTICE);
       
   566 }
       
   567 
       
   568 /**
       
   569  * Returns whether a menu name already exists.
       
   570  *
       
   571  * @see menu_edit_menu()
       
   572  * @see form_validate_machine_name()
       
   573  */
       
   574 function menu_edit_menu_name_exists($value) {
       
   575   // 'menu-' is added to the menu name to avoid name-space conflicts.
       
   576   $value = 'menu-' . $value;
       
   577   $custom_exists = db_query_range('SELECT 1 FROM {menu_custom} WHERE menu_name = :menu', 0, 1, array(':menu' => $value))->fetchField();
       
   578   $link_exists = db_query_range("SELECT 1 FROM {menu_links} WHERE menu_name = :menu", 0, 1, array(':menu' => $value))->fetchField();
       
   579 
       
   580   return $custom_exists || $link_exists;
       
   581 }
       
   582 
       
   583 /**
       
   584  * Submit function for adding or editing a custom menu.
       
   585  */
       
   586 function menu_edit_menu_submit($form, &$form_state) {
       
   587   $menu = $form_state['values'];
       
   588   $path = 'admin/structure/menu/manage/';
       
   589   if ($form['#insert']) {
       
   590     // Add 'menu-' to the menu name to help avoid name-space conflicts.
       
   591     $menu['menu_name'] = 'menu-' . $menu['menu_name'];
       
   592     $link['link_title'] = $menu['title'];
       
   593     $link['link_path'] = $path . $menu['menu_name'];
       
   594     $link['router_path'] = $path . '%';
       
   595     $link['module'] = 'menu';
       
   596     $link['plid'] = db_query("SELECT mlid FROM {menu_links} WHERE link_path = :link AND module = :module", array(
       
   597       ':link' => 'admin/structure/menu',
       
   598       ':module' => 'system'
       
   599     ))
       
   600     ->fetchField();
       
   601 
       
   602     menu_link_save($link);
       
   603     menu_save($menu);
       
   604   }
       
   605   else {
       
   606     menu_save($menu);
       
   607     $result = db_query("SELECT mlid FROM {menu_links} WHERE link_path = :path", array(':path' => $path . $menu['menu_name']), array('fetch' => PDO::FETCH_ASSOC));
       
   608     foreach ($result as $m) {
       
   609       $link = menu_link_load($m['mlid']);
       
   610       $link['link_title'] = $menu['title'];
       
   611       menu_link_save($link);
       
   612     }
       
   613   }
       
   614   drupal_set_message(t('Your configuration has been saved.'));
       
   615   $form_state['redirect'] = $path . $menu['menu_name'];
       
   616 }
       
   617 
       
   618 /**
       
   619  * Menu callback; Check access and present a confirm form for deleting a menu link.
       
   620  */
       
   621 function menu_item_delete_page($item) {
       
   622   // Links defined via hook_menu may not be deleted. Updated items are an
       
   623   // exception, as they can be broken.
       
   624   if ($item['module'] == 'system' && !$item['updated']) {
       
   625     return MENU_ACCESS_DENIED;
       
   626   }
       
   627   return drupal_get_form('menu_item_delete_form', $item);
       
   628 }
       
   629 
       
   630 /**
       
   631  * Build a confirm form for deletion of a single menu link.
       
   632  */
       
   633 function menu_item_delete_form($form, &$form_state, $item) {
       
   634   $form['#item'] = $item;
       
   635   return confirm_form($form, t('Are you sure you want to delete the custom menu link %item?', array('%item' => $item['link_title'])), 'admin/structure/menu/manage/' . $item['menu_name']);
       
   636 }
       
   637 
       
   638 /**
       
   639  * Process menu delete form submissions.
       
   640  */
       
   641 function menu_item_delete_form_submit($form, &$form_state) {
       
   642   $item = $form['#item'];
       
   643   menu_link_delete($item['mlid']);
       
   644   $t_args = array('%title' => $item['link_title']);
       
   645   drupal_set_message(t('The menu link %title has been deleted.', $t_args));
       
   646   watchdog('menu', 'Deleted menu link %title.', $t_args, WATCHDOG_NOTICE);
       
   647   $form_state['redirect'] = 'admin/structure/menu/manage/' . $item['menu_name'];
       
   648 }
       
   649 
       
   650 /**
       
   651  * Menu callback; reset a single modified menu link.
       
   652  */
       
   653 function menu_reset_item_confirm($form, &$form_state, $item) {
       
   654   $form['item'] = array('#type' => 'value', '#value' => $item);
       
   655   return confirm_form($form, t('Are you sure you want to reset the link %item to its default values?', array('%item' => $item['link_title'])), 'admin/structure/menu/manage/' . $item['menu_name'], t('Any customizations will be lost. This action cannot be undone.'), t('Reset'));
       
   656 }
       
   657 
       
   658 /**
       
   659  * Process menu reset item form submissions.
       
   660  */
       
   661 function menu_reset_item_confirm_submit($form, &$form_state) {
       
   662   $item = $form_state['values']['item'];
       
   663   $new_item = menu_reset_item($item);
       
   664   drupal_set_message(t('The menu link was reset to its default settings.'));
       
   665   $form_state['redirect'] = 'admin/structure/menu/manage/' . $new_item['menu_name'];
       
   666 }
       
   667 
       
   668 /**
       
   669  * Menu callback; Build the form presenting menu configuration options.
       
   670  */
       
   671 function menu_configure() {
       
   672   $form['intro'] = array(
       
   673     '#type' => 'item',
       
   674     '#markup' => t('The menu module allows on-the-fly creation of menu links in the content authoring forms. To configure these settings for a particular content type, visit the <a href="@content-types">Content types</a> page, click the <em>edit</em> link for the content type, and go to the <em>Menu settings</em> section.', array('@content-types' => url('admin/structure/types'))),
       
   675   );
       
   676 
       
   677   $menu_options = menu_get_menus();
       
   678 
       
   679   $main = variable_get('menu_main_links_source', 'main-menu');
       
   680   $form['menu_main_links_source'] = array(
       
   681     '#type' => 'select',
       
   682     '#title' => t('Source for the Main links'),
       
   683     '#default_value' => variable_get('menu_main_links_source', 'main-menu'),
       
   684     '#empty_option' => t('No Main links'),
       
   685     '#options' => $menu_options,
       
   686     '#tree' => FALSE,
       
   687     '#description' => t('Select what should be displayed as the Main links (typically at the top of the page).'),
       
   688   );
       
   689 
       
   690   $form['menu_secondary_links_source'] = array(
       
   691     '#type' => 'select',
       
   692     '#title' => t('Source for the Secondary links'),
       
   693     '#default_value' => variable_get('menu_secondary_links_source', 'user-menu'),
       
   694     '#empty_option' => t('No Secondary links'),
       
   695     '#options' => $menu_options,
       
   696     '#tree' => FALSE,
       
   697     '#description' => t('Select the source for the Secondary links. An advanced option allows you to use the same source for both Main links (currently %main) and Secondary links: if your source menu has two levels of hierarchy, the top level menu links will appear in the Main links, and the children of the active link will appear in the Secondary links.', array('%main' => $main ? $menu_options[$main] : t('none'))),
       
   698   );
       
   699 
       
   700   return system_settings_form($form);
       
   701 }