danielebarchiesi@0: <?php
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * @file
danielebarchiesi@0:  * Install, update and uninstall functions for the menu module.
danielebarchiesi@0:  */
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Implements hook_schema().
danielebarchiesi@0:  */
danielebarchiesi@0: function menu_schema() {
danielebarchiesi@0:   $schema['menu_custom'] = array(
danielebarchiesi@0:     'description' => 'Holds definitions for top-level custom menus (for example, Main menu).',
danielebarchiesi@0:     'fields' => array(
danielebarchiesi@0:       'menu_name' => array(
danielebarchiesi@0:         'type' => 'varchar',
danielebarchiesi@0:         'length' => 32,
danielebarchiesi@0:         'not null' => TRUE,
danielebarchiesi@0:         'default' => '',
danielebarchiesi@0:         'description' => 'Primary Key: Unique key for menu. This is used as a block delta so length is 32.',
danielebarchiesi@0:       ),
danielebarchiesi@0:       'title' => array(
danielebarchiesi@0:         'type' => 'varchar',
danielebarchiesi@0:         'length' => 255,
danielebarchiesi@0:         'not null' => TRUE,
danielebarchiesi@0:         'default' => '',
danielebarchiesi@0:         'description' => 'Menu title; displayed at top of block.',
danielebarchiesi@0:         'translatable' => TRUE,
danielebarchiesi@0:       ),
danielebarchiesi@0:       'description' => array(
danielebarchiesi@0:         'type' => 'text',
danielebarchiesi@0:         'not null' => FALSE,
danielebarchiesi@0:         'description' => 'Menu description.',
danielebarchiesi@0:         'translatable' => TRUE,
danielebarchiesi@0:       ),
danielebarchiesi@0:     ),
danielebarchiesi@0:     'primary key' => array('menu_name'),
danielebarchiesi@0:   );
danielebarchiesi@0: 
danielebarchiesi@0:   return $schema;
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Implements hook_install().
danielebarchiesi@0:  */
danielebarchiesi@0: function menu_install() {
danielebarchiesi@0:   $system_menus = menu_list_system_menus();
danielebarchiesi@0:   $t = get_t();
danielebarchiesi@0:   $descriptions = array(
danielebarchiesi@0:     'navigation' => $t('The <em>Navigation</em> menu contains links intended for site visitors. Links are added to the <em>Navigation</em> menu automatically by some modules.'),
danielebarchiesi@0:     'user-menu' => $t("The <em>User</em> menu contains links related to the user's account, as well as the 'Log out' link."),
danielebarchiesi@0:     'management' => $t('The <em>Management</em> menu contains links for administrative tasks.'),
danielebarchiesi@0:     'main-menu' => $t('The <em>Main</em> menu is used on many sites to show the major sections of the site, often in a top navigation bar.'),
danielebarchiesi@0:   );
danielebarchiesi@0:   foreach ($system_menus as $menu_name => $title) {
danielebarchiesi@0:     $menu = array(
danielebarchiesi@0:       'menu_name' => $menu_name,
danielebarchiesi@0:       'title' => $t($title),
danielebarchiesi@0:       'description' => $descriptions[$menu_name],
danielebarchiesi@0:     );
danielebarchiesi@0:     menu_save($menu);
danielebarchiesi@0:   }
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Implements hook_uninstall().
danielebarchiesi@0:  */
danielebarchiesi@0: function menu_uninstall() {
danielebarchiesi@0:   menu_rebuild();
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * @addtogroup updates-7.x-extra
danielebarchiesi@0:  * @{
danielebarchiesi@0:  */
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Migrate the "Default menu for content" setting to individual node types.
danielebarchiesi@0:  */
danielebarchiesi@0: function menu_update_7000() {
danielebarchiesi@0:   // Act only on sites originally on Drupal 6 that have a custom "Default menu
danielebarchiesi@0:   // for content" setting.
danielebarchiesi@0:   $default_node_menu = variable_get('menu_default_node_menu');
danielebarchiesi@0:   if (isset($default_node_menu)) {
danielebarchiesi@0:     // Remove variable no longer used in Drupal 7.
danielebarchiesi@0:     variable_del('menu_default_node_menu');
danielebarchiesi@0: 
danielebarchiesi@0:     // Make sure the menu chosen as the default still exists.
danielebarchiesi@0:     $defined_menus = db_query('SELECT * FROM {menu_custom}')->fetchAllAssoc('menu_name', PDO::FETCH_ASSOC);
danielebarchiesi@0:     // If the menu does not exist, do nothing; nodes will use the default D7
danielebarchiesi@0:     // node menu settings.
danielebarchiesi@0:     if (!isset($defined_menus[$default_node_menu])) {
danielebarchiesi@0:       return;
danielebarchiesi@0:     }
danielebarchiesi@0: 
danielebarchiesi@0:     // Update the menu settings for each node type.
danielebarchiesi@0:     foreach (_update_7000_node_get_types() as $type => $type_object) {
danielebarchiesi@0:       $type_menus = variable_get('menu_options_' . $type);
danielebarchiesi@0:       // If the site already has a custom menu setting for this node type (set
danielebarchiesi@0:       // on the initial upgrade to Drupal 7.0), don't override it.
danielebarchiesi@0:       if (!isset($type_menus)) {
danielebarchiesi@0:         // Set up this node type so that the Drupal 6 "Default menu for content"
danielebarchiesi@0:         // is still available in the "Menu settings" section.
danielebarchiesi@0:         variable_set('menu_options_' . $type, array($default_node_menu));
danielebarchiesi@0:         variable_set('menu_parent_' . $type, $default_node_menu . ':0');
danielebarchiesi@0:       }
danielebarchiesi@0:     }
danielebarchiesi@0:   }
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Rename "Primary Links" and "Secondary Links" to their Drupal 7 equivalents.
danielebarchiesi@0:  */
danielebarchiesi@0: function menu_update_7001() {
danielebarchiesi@0:   // Migrate D6 menu_primary_links_source to D7 menu_main_links_source (without
danielebarchiesi@0:   // renaming).
danielebarchiesi@0:   if (variable_get('menu_primary_links_source') !== NULL) {
danielebarchiesi@0:     variable_set('menu_main_links_source', variable_get('menu_primary_links_source'));
danielebarchiesi@0:     variable_del('menu_primary_links_source');
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   // Rename each menu, and any settings that refer to the old menu name.
danielebarchiesi@0:   // - "Primary Links" has become system menu "Main menu".
danielebarchiesi@0:   // - "Secondary Links" has become a new custom menu "Secondary menu".
danielebarchiesi@0:   $rename = array(
danielebarchiesi@0:     'primary-links' => array('main-menu', 'Main menu'),
danielebarchiesi@0:     'secondary-links' => array('secondary-menu', 'Secondary menu'),
danielebarchiesi@0:   );
danielebarchiesi@0:   foreach ($rename as $from_menu => $to) {
danielebarchiesi@0:     list($to_menu, $to_title) = $to;
danielebarchiesi@0:     // Rename the menu, and links in the menu.
danielebarchiesi@0:     db_update('menu_custom')
danielebarchiesi@0:       ->fields(array('menu_name' => $to_menu, 'title' => $to_title))
danielebarchiesi@0:       ->condition('menu_name', $from_menu)
danielebarchiesi@0:       ->execute();
danielebarchiesi@0:     db_update('menu_links')
danielebarchiesi@0:       ->fields(array('menu_name' => $to_menu))
danielebarchiesi@0:       ->condition('menu_name', $from_menu)
danielebarchiesi@0:       ->execute();
danielebarchiesi@0: 
danielebarchiesi@0:     // Update any content type that used this menu as a default menu.
danielebarchiesi@0:     // Note: these variables may be unset/default, in which case we leave them
danielebarchiesi@0:     // alone. See menu_update_7000()
danielebarchiesi@0:     foreach (_update_7000_node_get_types() as $type => $type_object) {
danielebarchiesi@0:       $menu_options = variable_get('menu_options_' . $type);
danielebarchiesi@0:       if ($menu_options !== NULL) {
danielebarchiesi@0:         variable_set('menu_options_' . $type, str_replace($from_menu, $to_menu, $menu_options));
danielebarchiesi@0:         if (variable_get('menu_parent_' . $type) == $from_menu . ':0') {
danielebarchiesi@0:           variable_set('menu_parent_' . $type, $to_menu . ':0');
danielebarchiesi@0:         }
danielebarchiesi@0:       }
danielebarchiesi@0:     }
danielebarchiesi@0: 
danielebarchiesi@0:     // Update the "source for primary links" and "source for secondary links" to
danielebarchiesi@0:     // follow.
danielebarchiesi@0:     if (variable_get('menu_main_links_source') == $from_menu) {
danielebarchiesi@0:       variable_set('menu_main_links_source', $to_menu);
danielebarchiesi@0:     }
danielebarchiesi@0:     if (variable_get('menu_secondary_links_source') == $from_menu) {
danielebarchiesi@0:       variable_set('menu_secondary_links_source', $to_menu);
danielebarchiesi@0:     }
danielebarchiesi@0:   }
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Rename the primary/secondary menu blocks to match previously renamed menus.
danielebarchiesi@0:  */
danielebarchiesi@0: function menu_update_7002(&$sandbox) {
danielebarchiesi@0:   // Check for the presence of old or new table names.
danielebarchiesi@0:   if (db_table_exists('blocks') || db_table_exists('block')) {
danielebarchiesi@0:     $renamed_deltas = array(
danielebarchiesi@0:       'menu' => array(
danielebarchiesi@0:         'primary-links' => 'main-menu',
danielebarchiesi@0:         'secondary-links' => 'secondary-menu',
danielebarchiesi@0:       ),
danielebarchiesi@0:     );
danielebarchiesi@0: 
danielebarchiesi@0:     $moved_deltas = array(
danielebarchiesi@0:       'menu' => array('main-menu' => 'system'),
danielebarchiesi@0:     );
danielebarchiesi@0: 
danielebarchiesi@0:     update_fix_d7_block_deltas($sandbox, $renamed_deltas, $moved_deltas);
danielebarchiesi@0:   }
danielebarchiesi@0: }
danielebarchiesi@0: /**
danielebarchiesi@0:  * Add missing custom menus to active menus list.
danielebarchiesi@0:  */
danielebarchiesi@0: function menu_update_7003(&$sandbox) {
danielebarchiesi@0:   // Make sure all custom menus are present in the active menus variable so that
danielebarchiesi@0:   // their items may appear in the active trail.
danielebarchiesi@0:   // @see menu_set_active_menu_names()
danielebarchiesi@0:   $active_menus = variable_get('menu_default_active_menus', array_keys(menu_list_system_menus()));
danielebarchiesi@0:   $update_variable = FALSE;
danielebarchiesi@0:   foreach (menu_get_names() as $menu_name) {
danielebarchiesi@0:     if (!in_array($menu_name, $active_menus) && (strpos($menu_name, 'menu-') === 0)) {
danielebarchiesi@0:       $active_menus[] = $menu_name;
danielebarchiesi@0:       $update_variable = TRUE;
danielebarchiesi@0:     }
danielebarchiesi@0:   }
danielebarchiesi@0:   if ($update_variable) {
danielebarchiesi@0:     variable_set('menu_default_active_menus', $active_menus);
danielebarchiesi@0:   }
danielebarchiesi@0:   // Clear the menu cache.
danielebarchiesi@0:   cache_clear_all(NULL, 'cache_menu');
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * @} End of "addtogroup updates-7.x-extra".
danielebarchiesi@0:  * The next series of updates should start at 8000.
danielebarchiesi@0:  */