menu_editor.admin.inc in Menu Editor 6.3

File

menu_editor.admin.inc

<?php

/**
 * 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_editor_overview_form(&$form_state, $menu) {
  global $menu_admin;
  $sql = "\n    SELECT\n      m.load_functions, m.to_arg_functions, m.access_callback, m.access_arguments,\n      m.page_callback, m.page_arguments, m.title, m.title_callback, m.title_arguments,\n      m.type, m.description, ml.*\n    FROM {menu_links} ml\n    LEFT JOIN {menu_router} m ON m.path = ml.router_path\n    WHERE ml.menu_name = '%s'\n    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 = array(
    '#tree' => TRUE,
  );
  if (module_exists('i18nmenu')) {
    $language_options = array(
      '' => t('All languages'),
    ) + locale_language_list('name');
    $form['#_language_options'] = $language_options;
  }
  $max_root_weight = _menu_editor_overview_tree_form($form, $form_state, $tree, $language_options);

  // default values for all new menu items..
  $default_values = array(
    'link_title' => '',
    'link_path' => '<front>',
    'description' => '',
    'hidden' => true,
    'expanded' => false,
    'weight' => 0,
    // 'mlid' => NULL,  // this is different for every single one
    'plid' => 0,
    'language' => '',
  );
  foreach (menu_editor_get_placeholders($menu) as $placeholder_code => $placeholder_path) {

    // take the first placeholder as default link path instead of <front>
    $default_values['link_path'] = $placeholder_code;
    break;
  }
  for ($i = 0; $i < 8; ++$i) {

    // new menu item
    $default_values['mlid'] = 'new' . $i;
    $item_key = 'mlid-new' . $i;
    $form[$item_key] = _menu_editor_overview_tree_form_item($menu, 'new' . $i, $default_values, $language_options);
    $form[$item_key]['weight']['#default_value'] = $max_root_weight + $i + 1;
    $form[$item_key]['#item'] = array();
    $form[$item_key]['#attributes'] = array(
      'class' => 'menu-new',
    );
    $form[$item_key]['drag']['#value'] = t('New menu item');
  }
  $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_editor_overview_tree_form(&$form, &$form_state, $tree, $language_options) {
  $max_root_weight = 0;
  $menu = $form['#menu'];
  foreach ($tree as $data) {
    $title = '';
    $item = $data['link'];

    // Don't show callbacks; these have $item['hidden'] < 0.
    if ($item && $item['hidden'] >= 0) {
      $item_key = 'mlid-' . $item['mlid'];
      $weight = isset($form_state[$item_key]['weight']) ? $form_state[$item_key]['weight'] : $item['weight'];
      $plid = isset($form_state[$item_key]['plid']) ? $form_state[$item_key]['plid'] : $item['plid'];
      if (!$plid && $weight > $max_root_weight) {

        // this is a root level item
        $max_root_weight = $weight;
      }
      $path = $item['link_path'];
      if (isset($item['options']['query'])) {
        $path .= '?' . $item['options']['query'];
      }
      if (isset($item['options']['fragment'])) {
        $path .= '#' . $item['options']['fragment'];
      }
      $default_values = array(
        'link_title' => $item['link_title'],
        'link_path' => $path,
        'description' => isset($item['options']['attributes']['title']) ? $item['options']['attributes']['title'] : '',
        'hidden' => !$item['hidden'],
        'expanded' => $item['expanded'],
        'weight' => $weight,
        'plid' => $plid,
        'language' => '' . @$item['options']['langcode'],
      );
      $form[$item_key] = _menu_editor_overview_tree_form_item($menu, $item['mlid'], $default_values, $language_options);
      $form[$item_key]['#item'] = $item;
      $form[$item_key]['#attributes'] = $item['hidden'] ? array(
        'class' => 'menu-disabled',
      ) : array(
        'class' => 'menu-enabled',
      );
      $form[$item_key]['drag']['#value'] = l($item['title'], $item['href'], $item['localized_options']) . ($item['hidden'] ? ' (' . t('disabled') . ')' : '');

      // Only items created by the menu module can be deleted.
      if ($item['module'] == 'menu' || $item['updated'] == 1) {
        $form[$item_key]['delete'] = array(
          '#type' => 'checkbox',
          '#title' => t('delete'),
          '#default_value' => false,
        );
      }
    }

    // process child elements
    if ($data['below']) {
      _menu_editor_overview_tree_form($form, $form_data, $data['below'], $language_options);
    }
  }
  return $max_root_weight;
}
function _menu_editor_overview_tree_form_item($menu, $item_mlid, $default_values, $language_options = NULL) {
  foreach (menu_editor_get_placeholders($menu) as $code => $path) {
    if (is_string($path) && str_replace('%mlid', $item_mlid, $path) == $default_values['link_path']) {
      $default_values['link_path'] = $code;
    }
  }
  $element = array();
  $element['link_title'] = array(
    '#type' => 'textfield',
    '#size' => 25,
  );
  $element['link_path'] = array(
    '#type' => 'textfield',
    '#size' => 25,
  );
  $element['description'] = array(
    '#type' => 'textfield',
    '#maxlength' => null,
    '#size' => 10,
  );
  $element['hidden'] = array(
    '#type' => 'checkbox',
  );
  $element['expanded'] = array(
    '#type' => 'checkbox',
  );
  $element['weight'] = array(
    '#type' => 'weight',
    '#delta' => 50,
  );
  $element['mlid'] = array(
    '#type' => 'hidden',
    '#value' => $item_mlid,
  );
  $element['plid'] = array(
    '#type' => 'textfield',
    '#size' => 6,
  );
  if ($language_options) {
    $element['language'] = array(
      '#type' => 'select',
      '#options' => $language_options,
    );
  }
  foreach ($default_values as $key => $value) {
    if (isset($element[$key])) {
      $element[$key]['#default_value'] = $value;
    }
  }
  return $element;
}
function menu_editor_overview_form_validate($form, &$form_state) {
  $form_values =& $form_state['values'];
  $menu = $form['#menu'];

  // Check existing items.
  foreach (element_children($form) as $item_key) {
    $element =& $form[$item_key];
    if (isset($element['link_path'])) {
      menu_editor_validate_item($menu, $element, $element['link_path']['#value'], $item_key . '][');
    }
  }

  // allow new items to be dynamically added via javascript,
  // that have not been in the form originally.
  foreach ($form['#post'] as $item_key => $item) {
    if (preg_match('/^mlid-new\\d+$/', $item_key)) {
      if (menu_editor_overview_form_validate_new_item($item)) {
        $form_values[$item_key] = $item;
      }
    }
  }
}

/**
 * Validate form values for a menu link being added or edited.
 */
function menu_editor_validate_item($menu, &$element, $link_path, $error_key_prefix) {
  $placeholders = menu_editor_get_placeholders($menu);
  if (isset($placeholders[$link_path])) {

    // it would be hard to check access,
    // because we don't necessarily know the mlid.
    // Thus, we simply grant access for all placeholders.
    return;
  }
  if ($element['link_path']['#default_value'] == $link_path) {

    // link_path is the only field that we check,
    // and we don't complain about existing link paths.
    return;
  }
  $item = $element['#item'];
  $normal_path = drupal_get_normal_path($link_path);
  $item['link_path'] = $normal_path;
  if (!menu_path_is_external($normal_path)) {
    $parsed_link = parse_url($normal_path);
    if (isset($parsed_link['query'])) {
      $item['options']['query'] = $parsed_link['query'];
    }
    if (isset($parsed_link['fragment'])) {
      $item['options']['fragment'] = $parsed_link['fragment'];
    }
    $item['link_path'] = $parsed_link['path'];
  }
  if (!trim($item['link_path']) || !menu_valid_path($item)) {
    form_set_error($error_key_prefix . 'link_path', t("The path '@link_path' is either invalid or you do not have access to it.", array(
      '@link_path' => $item['link_path'],
    )));
  }
}

/**
 * validate a menu item that was dynamically added through javascript
 * 
 * @param unknown_type $item
 */
function menu_editor_overview_form_validate_new_item($item) {

  // TODO: add some sanity checks
  return true;
}

/**
 * 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_editor_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
  $item_keys = array_flip(array_keys($form['#post']));

  // Get the $_POST order.
  $form_values = array_merge($item_keys, $form_state['values']);

  // Update our original form with the new order.
  $menu_name = $form['#menu']['menu_name'];
  $submitEngine = new _menu_editor_SubmitEngine($form['#_language_options'], $form['#menu']['menu_name']);
  foreach ($form_values as $item_key => $v) {
    if (isset($form[$item_key]['#item'])) {
      $element = $form[$item_key];
      $submitEngine
        ->submitElement($element, $v, $item_key);
    }
  }
  $items = $submitEngine
    ->getItems();
  $updated_items = $submitEngine
    ->getUpdatedItems();

  // Save all our changed items to the database,
  // and notify any listeners.
  $saveEngine = new _menu_editor_SaveEngine($form['#menu']);
  $notifyEngine = new _menu_editor_NotifyEngine($form['#menu']);
  foreach ($items as $item_key => &$item) {
    $item_needs_update = isset($updated_items[$item_key]);
    if ($item_needs_update) {
      $mlid = $saveEngine
        ->saveItem($item, $item_key);
    }
    $mlid = $item['mlid'];
    $notifyEngine
      ->notifyItem($item, $mlid, $item_needs_update);
  }
  $notifyEngine
    ->flush();
  $errors = $saveEngine
    ->getErrors();
  if (!empty($errors)) {
    drupal_set_message(t('There were errors saving the following menu links:<br/>' . implode('<br/>', $errors)), 'error');
  }

  // Now we have a collection of items with
}
class _menu_editor_NotifyEngine {
  protected $_trail = array();
  protected $_listeners = array();
  public function __construct($menu) {
    foreach (menu_editor_module_implements_class('menu_editor_Listener') as $module => $classname) {
      if (method_exists($classname, 'construct')) {

        // Use the factory method.
        // This method could return NULL in some cases.
        $listener = call_user_func("{$classname}::construct", $menu);
      }
      else {

        // use the normal constructor
        $listener = new $classname($menu);
      }
      if (is_object($listener)) {
        foreach (get_class_methods($listener) as $methodname) {
          $this->_listeners[$methodname][$module] = $listener;
        }
      }
    }
  }
  public function notifyItem(&$item) {
    while (TRUE) {
      $last_item = end($this->_trail);
      if (!$last_item || $last_item['mlid'] === $item['plid']) {
        $this->_trail[$item['mlid']] = $item;
        break;
      }
      array_pop($this->_trail);
    }
    $module_run = array();
    foreach (array(
      'notifyItem__' . preg_replace('/[^a-z0-9]/', '_', strtolower($item['router_path'])),
      'notifyItem',
    ) as $method) {
      if (isset($this->_listeners[$method])) {
        foreach ($this->_listeners[$method] as $module => $listener) {
          if (!isset($module_run[$module])) {
            $listener
              ->{$method}($item, $this->_trail);
            $module_run[$module] = TRUE;
          }
        }
      }
    }
  }
  public function flush() {
    foreach ($this->_listeners['flush'] as $module => $listener) {
      $listener
        ->flush();
    }
  }

}
class _menu_editor_SubmitEngine {
  protected $_items = array();
  protected $_updated_items = array();
  protected $_fields = array(
    'expanded',
    'weight',
    'plid',
    'link_title',
    'link_path',
    'description',
  );
  protected $_language_options;
  protected $_menu_name;
  public function __construct($language_options, $menu_name) {
    $this->_language_options = $language_options;
    $this->_menu_name = $menu_name;
  }
  public function getItems() {
    return $this->_items;
  }
  public function getUpdatedItems() {
    return $this->_updated_items;
  }
  public function submitElement(&$element, $v, $item_key) {
    if (TRUE) {
      $item =& $element['#item'];
      $item_needs_update = false;
      if (!is_numeric($v['mlid'])) {

        // add new item
        unset($v['mlid']);
        if (!is_string($v['link_title']) || empty($v['link_title'])) {
          return;
        }
        if (!is_string($v['link_path']) || empty($v['link_path'])) {
          return;
        }
        $item['menu_name'] = $this->_menu_name;

        // Set all fields in this menu item.
        foreach ($this->_fields as $field) {
          $item[$field] = $v[$field];
        }
        $item_needs_update = true;
      }
      else {
        if ($v['delete']) {

          // delete existing item
          if (is_numeric($v['mlid'])) {
            menu_link_delete($v['mlid']);
            if (module_exists('i18nmenu')) {

              // See http://drupal.org/node/786230#comment-2911158
              _i18nmenu_delete_item($v['mlid']);
            }
          }
          return;
        }
        else {

          // update existing item
          // Update any fields that have changed in this menu item.
          foreach ($this->_fields as $field) {
            if ($v[$field] != $element[$field]['#default_value']) {
              $item[$field] = $v[$field];
              $item_needs_update = true;
            }
          }
        }
      }

      // Hidden is a special case, the value needs to be reversed.
      if ($v['hidden'] != $element['hidden']['#default_value']) {
        $item['hidden'] = !$v['hidden'];
        $item_needs_update = true;
      }

      // langcode is a special case as well
      if ($this->_language_options) {
        if ($v['language'] != $element['language']['#default_value']) {
          $item['options']['langcode'] = $v['language'];
          $item_needs_update = true;
        }
      }

      // description is a special case
      if (isset($item['description'])) {
        $item['options']['attributes']['title'] = $item['description'];
      }

      // put the item in our list
      $item['#update'] = $item_needs_update;
      $this->_items[$item_key] = $item;

      // if the item has been modified..
      if ($item_needs_update) {
        $this->_updated_items[$item_key] =& $this->_items[$item_key];
      }
    }
  }

}
class _menu_editor_SaveEngine {
  protected $_placeholders = array();
  protected $_mlids = array();
  protected $_errors = array();
  public function __construct($menu) {
    $this->_placeholders = menu_editor_get_placeholders($menu);
  }
  public function getErrors() {
    return $this->_errors;
  }
  public function saveItem(&$item, $item_key) {
    $item['customized'] = 1;

    // check the link path
    $link_path =& $item['link_path'];

    // set the parent link id
    if ($item['plid'] && !is_numeric($item['plid'])) {
      if (isset($this->_mlids["mlid-{$item['plid']}"])) {
        $item['plid'] = $this->_mlids["mlid-{$item['plid']}"];
      }
      else {
        unset($item['plid']);
      }
    }

    // placeholders
    $link_path_placeholder = NULL;
    if (isset($this->_placeholders[$link_path])) {
      $link_path_placeholder = $this->_placeholders[$link_path];
      if (is_numeric($item['mlid'])) {

        // existing menu item
        $link_path = _menu_editor_get_path_for_placeholder($link_path_placeholder, $item);
        $link_path_placeholder = NULL;
      }
      else {

        // new menu item
        // use a dummy link path,
        // until we know the correct mlid.
        $link_path = '<front>';
      }
    }

    // clean the link path
    if (isset($link_path)) {
      $link_path = drupal_get_normal_path($link_path);
      if (!menu_path_is_external($link_path)) {
        $parsed_link = parse_url($link_path);
        if (isset($parsed_link['query'])) {
          $item['options']['query'] = $parsed_link['query'];
        }
        else {
          unset($item['options']['query']);
        }
        if (isset($parsed_link['fragment'])) {
          $item['options']['fragment'] = $parsed_link['fragment'];
        }
        else {
          unset($item['options']['fragment']);
        }
        if ($link_path != $parsed_link['path']) {
          $link_path = $parsed_link['path'];
        }
      }
      if (!trim($link_path) || !menu_valid_path($item)) {

        // invalid link path, discard this item
        continue;
      }
    }

    // update the item, or create it if
    $mlid = menu_link_save($item);
    if (is_numeric($mlid)) {

      // remember as a plid for child items
      $this->_mlids[$item_key] = $mlid;
      if (isset($link_path_placeholder)) {

        // overwrite the dummy link path
        $link_path = _menu_editor_get_path_for_placeholder($link_path_placeholder, $item);
        menu_link_save($item);
      }
      if (module_exists('i18nmenu')) {

        // See http://drupal.org/node/786230#comment-2911038
        $item['parent'] = $item['menu_name'] . ':' . $item['plid'];

        // Ensure we have a menu item to work with.
        _i18nmenu_update_item($item);
      }
      return $mlid;
    }
    else {
      $this->_errors[] = $item_key;
      return NULL;
    }
  }

}
function _menu_editor_get_path_for_placeholder($pl_path, $item) {
  if (is_object($pl_path)) {
    return $pl_path
      ->createPath($item);
  }
  else {
    if (is_string($pl_path)) {
      return str_replace('%mlid', $item['mlid'], $pl_path);
    }
    else {
      return NULL;
    }
  }
}

/**
 * Theme the menu overview form into a table.
 *
 * @ingroup themeable
 */
function theme_menu_editor_overview_form($form) {
  drupal_add_css(drupal_get_path('module', 'menu_editor') . '/menu_editor.css');
  drupal_add_js(drupal_get_path('module', 'menu_editor') . '/menu_editor.js');
  global $language;
  $i18nmenu = module_exists('i18nmenu');
  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();
  $header[] = t('Menu item');
  $header[] = t('Title');
  $header[] = t('Path');
  $header[] = t('Descr.');
  $header[] = array(
    'data' => t('En.'),
    'class' => 'checkbox',
  );
  $header[] = array(
    'data' => t('Exp.'),
    'class' => 'checkbox',
  );
  $header[] = t('Weight');
  if ($i18nmenu) {
    $header[] = t('Language');
  }
  $header[] = array(
    'data' => t('Delete'),
    'class' => 'delete-checkbox',
  );
  $rows = array();
  $items = array();
  foreach (element_children($form['sections']) as $section_key) {
    foreach (element_children($form['sections'][$section_key]) as $item_key) {
      $element = $form['sections'][$item_key];
    }
  }
  foreach (element_children($form) as $item_key) {
    if (isset($form[$item_key]['hidden'])) {
      $element =& $form[$item_key];

      // 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';

      // Adjust tab index to allow vertical tabbing
      foreach (array(
        'link_title',
        'link_path',
        'description',
        'hidden',
        'expanded',
      ) as $i => $key) {
        $element[$key]['#attributes']['tabindex'] = $i + 2;
      }
      $element['link_path']['#attributes']['tabindex'] = 2;
      $cells = array();
      $cells['drag'] = array(
        'data' => theme('indentation', $element['#item']['depth'] - 1) . drupal_render($element['drag']),
        'class' => 'drag',
      );
      $cells['link_title'] = array(
        'data' => drupal_render($element['link_title']),
        'class' => 'title-edit',
      );
      $cells['link_path'] = array(
        'data' => drupal_render($element['link_path']),
        'class' => 'path-edit',
      );
      $cells['description'] = array(
        'data' => drupal_render($element['description']),
        'class' => 'description',
      );
      $cells['hidden'] = array(
        'data' => drupal_render($element['hidden']),
        'class' => 'checkbox',
      );
      $cells['expanded'] = array(
        'data' => drupal_render($element['expanded']),
        'class' => 'checkbox',
      );
      $cells['mlid'] = drupal_render($element['weight']) . drupal_render($element['plid']) . drupal_render($element['mlid']);
      if ($i18nmenu) {
        $cells['language'] = array(
          'data' => drupal_render($element['language']),
          'class' => 'select',
        );
      }
      $cells['delete'] = array(
        'data' => drupal_render($element['delete']),
        'class' => 'delete-checkbox',
      );
      $row = array_merge(array(
        'data' => $cells,
      ), $element['#attributes']);
      $row['class'] = !empty($row['class']) ? $row['class'] . ' draggable' : 'draggable';
      if ($i18nmenu) {
        $langcode = $element['language']['#default_value'];
        $row['class'] .= $langcode ? ' langcode-' . $langcode : ' all-languages';
        $row['class'] .= $langcode == $language->language ? ' active-language' : '';
      }
      $rows[$item_key] = $row;
      if (isset($element['#item'])) {
        $items[$item_key] = $element['#item'];
      }
    }
  }
  $output = '';
  if ($rows) {

    // allow other modules to change the table data.
    foreach (module_implements('menu_editor_overview_table_alter') as $module) {
      $function = $module . '_menu_editor_overview_table_alter';
      $function($header, $rows, $items);
    }
    $output .= theme('table', $header, $rows, array(
      'id' => 'menu-overview',
    ));
  }
  $output .= drupal_render($form);
  return $output;
}

Functions

Name	Description
menu_editor_overview_form	Form for editing an entire menu tree at once.
menu_editor_overview_form_submit	Submit handler for the menu overview form.
menu_editor_overview_form_validate
menu_editor_overview_form_validate_new_item	validate a menu item that was dynamically added through javascript
menu_editor_validate_item	Validate form values for a menu link being added or edited.
theme_menu_editor_overview_form	Theme the menu overview form into a table.
_menu_editor_get_path_for_placeholder
_menu_editor_overview_tree_form	Recursive helper function for menu_overview_form().
_menu_editor_overview_tree_form_item

Classes

Name	Description
_menu_editor_NotifyEngine
_menu_editor_SaveEngine
_menu_editor_SubmitEngine