<?php

// $Id: menu.admin.inc,v 1.26.2.4 2009/02/25 13:15:40 goba Exp $

/**

 * @file

 * Administrative page callbaks for menu module.

 */

/**

 * Menu callback which shows an overview page of all the custom menus and their descriptions.

 */

function menu_overview_page() {

  $result = db_query("SELECT * FROM {menu_custom} ORDER BY title");

  $content = array();

  while ($menu = db_fetch_array($result)) {

    $menu['href'] = 'admin/build/menu-customize/'. $menu['menu_name'];

    $menu['localized_options'] = array();

    $content[] = $menu;

  }

  return theme('admin_block_content', $content);

}

/**

 * Form for editing an entire menu tree at once.

 *

 * Shows for one menu the menu items accessible to the current user and

 * relevant operations.

 */

function menu_overview_form(&$form_state, $menu) {

  global $menu_admin;

  $sql = "

    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.*

    FROM {menu_links} ml LEFT JOIN {menu_router} m ON m.path = ml.router_path

    WHERE ml.menu_name = '%s'

    ORDER BY p1 ASC, p2 ASC, p3 ASC, p4 ASC, p5 ASC, p6 ASC, p7 ASC, p8 ASC, p9 ASC";

  $result = db_query($sql, $menu['menu_name']);

  $tree = menu_tree_data($result);

  $node_links = array();

  menu_tree_collect_node_links($tree, $node_links);

  // We indicate that a menu administrator is running the menu access check.

  $menu_admin = TRUE;

  menu_tree_check_access($tree, $node_links);

  $menu_admin = FALSE;

  $form = _menu_overview_tree_form($tree);

  $form['#menu'] =  $menu;

  if (element_children($form)) {

    $form['submit'] = array(

      '#type' => 'submit',

      '#value' => t('Save configuration'),

    );

  }

  else {

    $form['empty_menu'] = array('#value' => t('There are no menu items yet.'));

  }

  return $form;

}

/**

 * Recursive helper function for menu_overview_form().

 */

function _menu_overview_tree_form($tree) {

  static $form = array('#tree' => TRUE);

  foreach ($tree as $data) {

    $title = '';

    $item = $data['link'];

    // Don't show callbacks; these have $item['hidden'] < 0.

    if ($item && $item['hidden'] >= 0) {

      $mlid = 'mlid:'. $item['mlid'];

      $form[$mlid]['#item'] = $item;

      $form[$mlid]['#attributes'] = $item['hidden'] ? array('class' => 'menu-disabled') : array('class' => 'menu-enabled');

      $form[$mlid]['title']['#value'] = l($item['title'], $item['href'], $item['localized_options']) . ($item['hidden'] ? ' ('. t('disabled') .')' : '');

      $form[$mlid]['hidden'] = array(

        '#type' => 'checkbox',

        '#default_value' => !$item['hidden'],

      );

      $form[$mlid]['expanded'] = array(

        '#type' => 'checkbox',

        '#default_value' => $item['expanded'],

      );

      $form[$mlid]['weight'] = array(

        '#type' => 'weight',

        '#delta' => 50,

        '#default_value' => isset($form_state[$mlid]['weight']) ? $form_state[$mlid]['weight'] : $item['weight'],

      );

      $form[$mlid]['mlid'] = array(

        '#type' => 'hidden',

        '#value' => $item['mlid'],

      );

      $form[$mlid]['plid'] = array(

        '#type' => 'textfield',

        '#default_value' => isset($form_state[$mlid]['plid']) ? $form_state[$mlid]['plid'] : $item['plid'],

        '#size' => 6,

      );

      // Build a list of operations.

      $operations = array();

      $operations['edit'] = l(t('edit'), 'admin/build/menu/item/'. $item['mlid'] .'/edit');

      // Only items created by the menu module can be deleted.

      if ($item['module'] == 'menu' || $item['updated'] == 1) {

        $operations['delete'] = l(t('delete'), 'admin/build/menu/item/'. $item['mlid'] .'/delete');

      }

      // Set the reset column.

      elseif ($item['module'] == 'system' && $item['customized']) {

        $operations['reset'] = l(t('reset'), 'admin/build/menu/item/'. $item['mlid'] .'/reset');

      }

      $form[$mlid]['operations'] = array();

      foreach ($operations as $op => $value) {

        $form[$mlid]['operations'][$op] = array('#value' => $value);

      }

    }

    if ($data['below']) {

      _menu_overview_tree_form($data['below']);

    }

  }

  return $form;

}

/**

 * Submit handler for the menu overview form.

 *

 * This function takes great care in saving parent items first, then items

 * underneath them. Saving items in the incorrect order can break the menu tree.

 *

 * @see menu_overview_form()

 */

function menu_overview_form_submit($form, &$form_state) {

  // When dealing with saving menu items, the order in which these items are

  // saved is critical. If a changed child item is saved before its parent,

  // the child item could be saved with an invalid path past its immediate

  // parent. To prevent this, save items in the form in the same order they

  // are sent by $_POST, ensuring parents are saved first, then their children.

  // See http://drupal.org/node/181126#comment-632270

  $order = array_flip(array_keys($form['#post'])); // Get the $_POST order.

  $form = array_merge($order, $form); // Update our original form with the new order.

  $updated_items = array();

  $fields = array('expanded', 'weight', 'plid');

  foreach (element_children($form) as $mlid) {

    if (isset($form[$mlid]['#item'])) {

      $element = $form[$mlid];

      // Update any fields that have changed in this menu item.

      foreach ($fields as $field) {

        if ($element[$field]['#value'] != $element[$field]['#default_value']) {

          $element['#item'][$field] = $element[$field]['#value'];

          $updated_items[$mlid] = $element['#item'];

        }

      }

      // Hidden is a special case, the value needs to be reversed.

      if ($element['hidden']['#value'] != $element['hidden']['#default_value']) {

        $element['#item']['hidden'] = !$element['hidden']['#value'];

        $updated_items[$mlid] = $element['#item'];

      }

    }

  }

  // Save all our changed items to the database.

  foreach ($updated_items as $item) {

    $item['customized'] = 1;

    menu_link_save($item);

  }

}

/**

 * Theme the menu overview form into a table.

 *

 * @ingroup themeable

 */

function theme_menu_overview_form($form) {

  drupal_add_tabledrag('menu-overview', 'match', 'parent', 'menu-plid', 'menu-plid', 'menu-mlid', TRUE, MENU_MAX_DEPTH - 1);

  drupal_add_tabledrag('menu-overview', 'order', 'sibling', 'menu-weight');

  $header = array(

    t('Menu item'),

    array('data' => t('Enabled'), 'class' => 'checkbox'),

    array('data' => t('Expanded'), 'class' => 'checkbox'),

    t('Weight'),

    array('data' => t('Operations'), 'colspan' => '3'),

  );

  $rows = array();

  foreach (element_children($form) as $mlid) {

    if (isset($form[$mlid]['hidden'])) {

      $element = &$form[$mlid];

      // Build a list of operations.

      $operations = array();

      foreach (element_children($element['operations']) as $op) {

        $operations[] = drupal_render($element['operations'][$op]);

      }

      while (count($operations) < 2) {

        $operations[] = '';

      }

      // Add special classes to be used for tabledrag.js.

      $element['plid']['#attributes']['class'] = 'menu-plid';

      $element['mlid']['#attributes']['class'] = 'menu-mlid';

      $element['weight']['#attributes']['class'] = 'menu-weight';

      // Change the parent field to a hidden. This allows any value but hides the field.

      $element['plid']['#type'] = 'hidden';

      $row = array();

      $row[] = theme('indentation', $element['#item']['depth'] - 1) . drupal_render($element['title']);

      $row[] = array('data' => drupal_render($element['hidden']), 'class' => 'checkbox');

      $row[] = array('data' => drupal_render($element['expanded']), 'class' => 'checkbox');

      $row[] = drupal_render($element['weight']) . drupal_render($element['plid']) . drupal_render($element['mlid']);

      $row = array_merge($row, $operations);

      $row = array_merge(array('data' => $row), $element['#attributes']);

      $row['class'] = !empty($row['class']) ? $row['class'] .' draggable' : 'draggable';

      $rows[] = $row;

    }

  }

  $output = '';

  if ($rows) {

    $output .= theme('table', $header, $rows, array('id' => 'menu-overview'));

  }

  $output .= drupal_render($form);

  return $output;

}

/**

 * Menu callback; Build the menu link editing form.

 */

function menu_edit_item(&$form_state, $type, $item, $menu) {

  $form['menu'] = array(

    '#type' => 'fieldset',

    '#title' => t('Menu settings'),

    '#collapsible' => FALSE,

    '#tree' => TRUE,

    '#weight' => -2,

    '#attributes' => array('class' => 'menu-item-form'),

    '#item' => $item,

  );

  if ($type == 'add' || empty($item)) {

    // This is an add form, initialize the menu link.

    $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);

  }

  foreach (array('link_path', 'mlid', 'module', 'has_children', 'options') as $key) {

    $form['menu'][$key] = array('#type' => 'value', '#value' => $item[$key]);

  }

  // Any item created or edited via this interface is considered "customized".

  $form['menu']['customized'] = array('#type' => 'value', '#value' => 1);

  $form['menu']['original_item'] = array('#type' => 'value', '#value' => $item);

  $path = $item['link_path'];

  if (isset($item['options']['query'])) {

    $path .= '?'. $item['options']['query'];

  }

  if (isset($item['options']['fragment'])) {

    $path .= '#'. $item['options']['fragment'];

  }

  if ($item['module'] == 'menu') {

    $form['menu']['link_path'] = array(

      '#type' => 'textfield',

      '#title' => t('Path'),

      '#default_value' => $path,

      '#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')),

      '#required' => TRUE,

    );

    $form['delete'] = array(

      '#type' => 'submit',

      '#value' => t('Delete'),

      '#access' => $item['mlid'],

      '#submit' => array('menu_item_delete_submit'),

      '#weight' => 10,

    );

  }

  else {

    $form['menu']['_path'] = array(

      '#type' => 'item',

      '#title' => t('Path'),

      '#description' => l($item['link_title'], $item['href'], $item['options']),

    );

  }

  $form['menu']['link_title'] = array('#type' => 'textfield',

    '#title' => t('Menu link title'),

    '#default_value' => $item['link_title'],

    '#description' => t('The link text corresponding to this item that should appear in the menu.'),

    '#required' => TRUE,

  );

  $form['menu']['description'] = array(

    '#type' => 'textarea',

    '#title' => t('Description'),

    '#default_value' => isset($item['options']['attributes']['title']) ? $item['options']['attributes']['title'] : '',

    '#rows' => 1,

    '#description' => t('The description displayed when hovering over a menu item.'),

  );

  $form['menu']['enabled'] = array(

    '#type' => 'checkbox',

    '#title' => t('Enabled'),

    '#default_value' => !$item['hidden'],

    '#description' => t('Menu items that are not enabled will not be listed in any menu.'),

  );

  $form['menu']['expanded'] = array(

    '#type' => 'checkbox',

    '#title' => t('Expanded'),

    '#default_value' => $item['expanded'],

    '#description' => t('If selected and this menu item has children, the menu will always appear expanded.'),

  );

  // Generate a list of possible parents (not including this item or descendants).

  $options = menu_parent_options(menu_get_menus(), $item);

  $default = $item['menu_name'] .':'. $item['plid'];

  if (!isset($options[$default])) {

    $default = 'navigation:0';

  }

  $form['menu']['parent'] = array(

    '#type' => 'select',

    '#title' => t('Parent item'),

    '#default_value' => $default,

    '#options' => $options,

    '#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)),

    '#attributes' => array('class' => 'menu-title-select'),

  );

  $form['menu']['weight'] = array(

    '#type' => 'weight',

    '#title' => t('Weight'),

    '#delta' => 50,

    '#default_value' => $item['weight'],

    '#description' => t('Optional. In the menu, the heavier items will sink and the lighter items will be positioned nearer the top.'),

  );

  $form['submit'] = array('#type' => 'submit', '#value' => t('Save'));

  return $form;

}

/**

 * Validate form values for a menu link being added or edited.

 */

function menu_edit_item_validate($form, &$form_state) {

  $item = &$form_state['values']['menu'];

  $normal_path = drupal_get_normal_path($item['link_path']);

  if ($item['link_path'] != $normal_path) {

    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)));

    $item['link_path'] = $normal_path;

  }

  if (!menu_path_is_external($item['link_path'])) {

    $parsed_link = parse_url($item['link_path']);

    if (isset($parsed_link['query'])) {

      $item['options']['query'] = $parsed_link['query'];

    }

    if (isset($parsed_link['fragment'])) {

      $item['options']['fragment'] = $parsed_link['fragment'];

    }

    if ($item['link_path'] != $parsed_link['path']) {

      $item['link_path'] = $parsed_link['path'];

    }

  }

  if (!trim($item['link_path']) || !menu_valid_path($item)) {

    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'])));

  }

}

/**

 * Submit function for the delete button on the menu item editing form.

 */

function menu_item_delete_submit($form, &$form_state) {

  $form_state['redirect'] = 'admin/build/menu/item/'. $form_state['values']['menu']['mlid'] .'/delete';

}

/**

 * Process menu and menu item add/edit form submissions.

 */

function menu_edit_item_submit($form, &$form_state) {

  $item = &$form_state['values']['menu'];

  // The value of "hidden" is the opposite of the value

  // supplied by the "enabled" checkbox.

  $item['hidden'] = (int) !$item['enabled'];

  unset($item['enabled']);

  $item['options']['attributes']['title'] = $item['description'];

  list($item['menu_name'], $item['plid']) = explode(':', $item['parent']);

  if (!menu_link_save($item)) {

    drupal_set_message(t('There was an error saving the menu link.'), 'error');

  }

  $form_state['redirect'] = 'admin/build/menu-customize/'. $item['menu_name'];

}