menu.install

<?php
/**
 * @file
 * Install, update and uninstall functions for the menu module.
 */

/**
 * Implements hook_install().
 */
function menu_install() {
  $system_menus = menu_list_system_menus();
  $t = get_t();
  $descriptions = array(
    'main-menu' => $t('The <em>Primary navigation</em> menu is used on many sites to show the major sections of the site, often in a top navigation bar.'),
    'management' => $t('The <em>Administration</em> menu contains links for administrative tasks and content entry.'),
    'user-menu' => $t("The <em>Account</em> menu contains links related to each user's account, as well as links to 'Log in' and 'Log out'."),
  );
  foreach ($system_menus as $menu_name => $title) {
    $menu = array(
      'menu_name' => $menu_name,
      'title' => $t($title),
      'description' => $descriptions[$menu_name],
    );
    menu_save($menu);
  }
}

/**
 * Implements hook_uninstall().
 */
function menu_uninstall() {
  menu_rebuild();
}

/**
 * Implements hook_update_dependencies().
 */
function menu_update_dependencies() {
  // menu_update_1001() updates menu variables to save into the node type config
  // files, which are created in node_update_1005().
  $dependencies['menu'][1001] = array(
    'node' => 1005,
  );
  return $dependencies;
}

/**
 * @addtogroup updates-7.x-to-1.x
 * @{
 */

/**
 * Moves menu settings from variables to config.
 */
function menu_update_1000() {
  // Migrate variables to config.
  $config = config('menu.settings');
  $config->set('menu_main_links', update_variable_get('menu_main_links_source', 'main-menu'));
  $config->set('menu_secondary_links_source', update_variable_get('menu_main_links_source', 'user-menu'));
  $config->save();

  // Delete variables.
  update_variable_del('menu_main_links_source');
  update_variable_del('menu_secondary_links_source');
}

/**
 * Move menu content type settings into configuration files.
 */
function menu_update_1001() {
  // Ensure module-provided code is loaded.
  backdrop_load('module', 'node');
  backdrop_load('module', 'entity');

  $node_types = node_type_get_types();
  foreach ($node_types as $node_type) {
    // Move the menu variables into each node type's config.
    $settings = array(
      'menu_options' => update_variable_get('menu_options_' . $node_type->type, array('main-menu')),
      'menu_parent' => update_variable_get('menu_parent_' . $node_type->type, 'main-menu:0'),
    );
    $node_type->settings = array_merge($node_type->settings, $settings);
    node_type_save($node_type);

    // Delete the migrated variables.
    update_variable_del('menu_options_' . $node_type->type);
    update_variable_del('menu_parent_' . $node_type->type);
  }
}

/**
 * Move individual menus into config files.
 */
function menu_update_1002() {
  if (!db_table_exists('menu_custom')) {
    return;
  }

  $menus = db_query("SELECT * FROM {menu_custom}")->fetchAllAssoc('menu_name');
  foreach ($menus as $menu) {
    $menu = (array) $menu;
    $config = config('menu.menu.' . $menu['menu_name']);
    $config->setData($menu);
    $config->save();
  }

  db_drop_table('menu_custom');
}

/**
 * Delete primary and secondary menu settings.
 */
function menu_update_1003() {
  $config = config('menu.settings');
  $config->delete('menu.settings');
}

/**
 * Add new default config values.
 */
function menu_update_1004() {
  $config = config('menu.settings');
  if ($config->get('menu_breakpoint') == NULL) {
    $config->set('menu_breakpoint', 'default');
    $config->set('menu_breakpoint_custom', '');
    $config->save();
  }
}

/**
 * Clean up duplicate user/login menu item entries.
 */
function menu_update_1005() {
  // Empty for sites that already patched with PR to remove user/login:
  // @see https://github.com/backdrop/backdrop-issues/issues/5460
}

/**
 * Clean up duplicate system menu item entries.
 */
function menu_update_1006() {
  // With MIN() we make sure, we get the lowest mlid, which is the valid one of
  // duplicates.
  $query = 'SELECT MIN(mlid) as min_mlid, link_path, menu_name, plid, depth FROM {menu_links}';
  // Paths appearing more than once, limited to "system" entries.
  $query .= " WHERE module = 'system' GROUP BY link_path, menu_name, plid, depth HAVING count(link_path) > 1";
  $candidates = db_query($query)->fetchAllAssoc('link_path');

  // Sites updating from versions before 1.21.0 won't have duplicates.
  if (!empty($candidates)) {
    foreach ($candidates as $path => $values) {
      // Additionally to "link_path" and "module" columns, we compare more
      // values to make sure, we really only delete duplicates, not valid
      // records. We only delete items with an id higher than the lowest one
      // from the previous query.
      db_delete('menu_links')
        ->condition('link_path', $path)
        ->condition('module', 'system')
        ->condition('menu_name', $values->menu_name)
        ->condition('plid', $values->plid)
        ->condition('depth', $values->depth)
        ->condition('mlid', $values->min_mlid, '>')
        ->execute();
    }
  }
}

/**
 * @} End of "addtogroup updates-7.x-to-1.x"
 * The next series of updates should start at 2000.
 */