Mercurial > defr > drupal > core

annotate modules/menu/menu.admin.inc @ 1:c1f4ac30525a 6.0

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