diff --git a/migrate.info b/migrate.info index 3f1f87b..4e43baa 100644 --- a/migrate.info +++ b/migrate.info @@ -25,6 +25,8 @@ files[] = plugins/destinations/fields.inc files[] = plugins/destinations/poll.inc files[] = plugins/destinations/table.inc files[] = plugins/destinations/table_copy.inc +files[] = plugins/destinations/menu.inc +files[] = plugins/destinations/menu_links.inc files[] = plugins/sources/csv.inc files[] = plugins/sources/files.inc files[] = plugins/sources/json.inc diff --git a/plugins/destinations/menu.inc b/plugins/destinations/menu.inc new file mode 100644 index 0000000..2cd7bd4 --- /dev/null +++ b/plugins/destinations/menu.inc @@ -0,0 +1,184 @@ + array( + 'type' => 'varchar', + 'length' => 32, + 'not null' => TRUE, + 'default' => '', + 'description' => 'Primary Key: Unique key for menu. This is used as a block delta so length is 32.', + ), + ); + } + + public function __toString() { + $output = t('Menu'); + return $output; + } + + public function fields() { + $fields = array( + 'menu_name' => t('The menu name. Primary key.'), + 'title' => t('The human-readable name of the menu.'), + 'description' => t('A description of the menu'), + ); + return $fields; + } + + /** + * Import a single row. + * + * @param $object + * Object object to build. Prefilled with any fields mapped in the Migration. + * @param $row + * Raw source data object - passed through to prepare/complete handlers. + * @return array + * Array of key fields of the object that was saved if + * successful. FALSE on failure. + */ + public function import(stdClass $object, stdClass $row) { + // Updating previously-migrated content? + $migration = Migration::currentMigration(); + + // Invoke migration prepare handlers + // @todo can we use arrays here? + $this->prepare($object, $row); + + // Menus are handled as arrays, so clone the object to an array. + $menu = clone $object; + $menu = (array) $menu; + + migrate_instrument_start('menu_save'); + + // Check to see if this is a new menu. + $update = FALSE; + if ($data = menu_load($menu['menu_name'])) { + $update = TRUE; + } + + // menu_save() provides no return callback, so we can't really test this + // without running a menu_load() check. + menu_save($menu); + + // Return the new id or FALSE on failure. + if ($data = menu_load($menu['menu_name'])) { + // Increment the count if the save succeeded. + if ($update) { + $this->numUpdated++; + } + else { + $this->numCreated++; + } + // Return the primary key to the mapping table. + $return = array($data['menu_name']); + } + else { + $return = FALSE; + } + + migrate_instrument_stop('menu_save'); + + // Invoke migration complete handlers. + // @todo can we use arrays here? + $object = (object) $data; + $this->complete($object, $row); + + return $return; + } + + public function prepare($object, stdClass $row) { + // We do nothing here but allow child classes to act. + $migration = Migration::currentMigration(); + $object->migrate = array( + 'machineName' => $migration->getMachineName(), + ); + + // Call any general handlers. + migrate_handler_invoke_all('menu', 'prepare', $object, $row); + // Then call any prepare handler for this specific Migration. + if (method_exists($migration, 'prepare')) { + $migration->prepare($object, $row); + } + } + + public function complete($object, stdClass $row) { + // We do nothing here but allow child classes to act. + $migration = Migration::currentMigration(); + $object->migrate = array( + 'machineName' => $migration->getMachineName(), + ); + // Call any general handlers. + migrate_handler_invoke_all('menu', 'complete', $object, $row); + // Then call any complete handler for this specific Migration. + if (method_exists($migration, 'complete')) { + $migration->complete($object, $row); + } + } + + /** + * Delete a single menu. + * + * @param $id + * Array of fields representing the key (in this case, just menu_name). + */ + public function rollback(array $id) { + $menu_name = reset($id); + + migrate_instrument_start('menu_delete'); + $this->prepareRollback($menu_name); + if ($menu = menu_load($menu_name)) { + menu_delete($menu); + } + $this->completeRollback($menu_name); + migrate_instrument_stop('menu_delete'); + } + + /** + * Give handlers a shot at cleaning up before a menu has been rolled back. + * + * @param $menu_name + * ID of the menu about to be deleted.. + */ + public function prepareRollback($menu_name) { + // We do nothing here but allow child classes to act. + $migration = Migration::currentMigration(); + // Call any general handlers. + migrate_handler_invoke_all('menu', 'prepareRollback', $menu_name); + // Then call any complete handler for this specific Migration. + if (method_exists($migration, 'prepareRollback')) { + $migration->prepareRollback($menu_name); + } + } + + /** + * Give handlers a shot at cleaning up after a menu has been rolled back. + * + * @param $menu_name + * ID of the menu which has been deleted. + */ + public function completeRollback($menu_name) { + // We do nothing here but allow child classes to act. + $migration = Migration::currentMigration(); + // Call any general handlers. + migrate_handler_invoke_all('menu', 'completeRollback', $menu_name); + // Then call any complete handler for this specific Migration. + if (method_exists($migration, 'completeRollback')) { + $migration->completeRollback($menu_name); + } + } + +} diff --git a/plugins/destinations/menu_links.inc b/plugins/destinations/menu_links.inc new file mode 100644 index 0000000..6445a38 --- /dev/null +++ b/plugins/destinations/menu_links.inc @@ -0,0 +1,201 @@ + array( + 'type' => 'int', + 'unsigned' => TRUE, + 'not null' => TRUE, + 'description' => 'ID of destination link', + ), + ); + } + public function __construct() { + parent::__construct(); + } + + public function __toString() { + $output = t('Menu links'); + return $output; + } + + public function fields() { + $fields = array( + 'menu_name' => t('The menu name. All links with the same menu name (such as \'navigation\') are part of the same menu.'), + 'mlid' => t('The menu link ID (mlid) is the integer primary key.'), + 'plid' => t('The parent link ID (plid) is the mlid of the link above in the hierarchy, or zero if the link is at the top level in its menu.'), + 'link_path' => t('The Drupal path or external path this link points to.'), + 'router_path' => t('For links corresponding to a Drupal path (external = 0), this connects the link to a {menu_router}.path for joins.'), + 'link_title' => t('The text displayed for the link, which may be modified by a title callback stored in {menu_router}.'), + 'options' => t('A serialized array of options to be passed to the url() or l() function, such as a query string or HTML attributes.'), + 'module' => t('The name of the module that generated this link.'), + 'hidden' => t('A flag for whether the link should be rendered in menus. (1 = a disabled menu item that may be shown on admin screens, -1 = a menu callback, 0 = a normal, visible link)'), + 'external' => t('A flag to indicate if the link points to a full URL starting with a protocol, like http:// (1 = external, 0 = internal).'), + 'has_children' => t('Flag indicating whether any links have this link as a parent (1 = children exist, 0 = no children).'), + 'expanded' => t('Flag for whether this link should be rendered as expanded in menus - expanded links always have their child links displayed, instead of only when the link is in the active trail (1 = expanded, 0 = not expanded)'), + 'weight' => t('Link weight among links in the same menu at the same depth.'), + 'depth' => t('The depth relative to the top level. A link with plid == 0 will have depth == 1.'), + 'customized' => t('A flag to indicate that the user has manually created or edited the link (1 = customized, 0 = not customized).'), + 'p1' => t('The first mlid in the materialized path. If N = depth, then pN must equal the mlid. If depth > 1 then p(N-1) must equal the plid. All pX where X > depth must equal zero. The columns p1 .. p9 are also called the parents.'), + 'p2' => t('The second mlid in the materialized path. See p1.'), + 'p3' => t('The third mlid in the materialized path. See p1.'), + 'p4' => t('The fourth mlid in the materialized path. See p1.'), + 'p5' => t('The fifth mlid in the materialized path. See p1.'), + 'p6' => t('The sixth mlid in the materialized path. See p1.'), + 'p7' => t('The seventh mlid in the materialized path. See p1.'), + 'p8' => t('The eighth mlid in the materialized path. See p1.'), + 'p9' => t('The ninth mlid in the materialized path. See p1.'), + 'updated' => t('Flag that indicates that this link was generated during the update from Drupal 5.'), + ); + return $fields; + } + + /** + * Import a single row. + * + * @param $object + * Object object to build. Prefilled with any fields mapped in the Migration. + * @param $row + * Raw source data object - passed through to prepare/complete handlers. + * @return array + * Array of key fields of the object that was saved if + * successful. FALSE on failure. + */ + public function import(stdClass $object, stdClass $row) { + // Updating previously-migrated content + $migration = Migration::currentMigration(); + if (isset($row->migrate_map_destid1)) { + $object->mlid = $row->migrate_map_destid1; + } + + // Invoke migration prepare handlers + // @todo can we use arrays here? + // @todo derive existing mlids? + $this->prepare($object, $row); + + // Menus are handled as arrays, so clone the object to an array. + $item = clone $object; + $item = (array) $item; + + migrate_instrument_start('menu_link_save'); + + // Check to see if this is a new menu item. + $update = FALSE; + if (isset($item['mlid'])) { + $update = TRUE; + $mlid = menu_link_save($item); + } + else { + // menu_link_save() should return an mlid integer. + $mlid = menu_link_save($item); + } + + // Return the new id or FALSE on failure. + if (!empty($mlid)) { + // Increment the count if the save succeeded. + if ($update) { + $this->numUpdated++; + } + else { + $this->numCreated++; + } + // Return the primary key to the mapping table. + $return = array($mlid); + } + else { + $return = FALSE; + } + + migrate_instrument_stop('menu_link_save'); + + // Invoke migration complete handlers. + // @todo can we use arrays here? + $object = (object) menu_link_load($mlid); + $this->complete($object, $row); + + return $return; + } + + public function prepare($object, stdClass $row) { + // We do nothing here but allow child classes to act. + $migration = Migration::currentMigration(); + $object->migrate = array( + 'machineName' => $migration->getMachineName(), + ); + + // Call any general handlers. + migrate_handler_invoke_all('menu_links', 'prepare', $object, $row); + // Then call any prepare handler for this specific Migration. + if (method_exists($migration, 'prepare')) { + $migration->prepare($object, $row); + } + } + + public function complete($object, stdClass $row) { + // We do nothing here but allow child classes to act. + $migration = Migration::currentMigration(); + $object->migrate = array( + 'machineName' => $migration->getMachineName(), + ); + // Call any general handlers. + migrate_handler_invoke_all('menu_links', 'complete', $object, $row); + // Then call any complete handler for this specific Migration. + if (method_exists($migration, 'complete')) { + $migration->complete($object, $row); + } + // Now clear the cache. + menu_cache_clear_all(); + } + + public function prepareRollback(array $mlids) { + // We do nothing here but allow child classes to act. + $migration = Migration::currentMigration(); + // Call any general handlers. + migrate_handler_invoke_all('menu_links', 'prepareRollback', $mlids); + // Then call any complete handler for this specific Migration. + if (method_exists($migration, 'prepareRollback')) { + $migration->prepareRollback($mlids); + } + } + + public function completeRollback(array $mlids) { + // We do nothing here but allow child classes to act. + $migration = Migration::currentMigration(); + // Call any general handlers. + migrate_handler_invoke_all('menu_links', 'completeRollback', $mlids); + // Then call any complete handler for this specific Migration. + if (method_exists($migration, 'completeRollback')) { + $migration->completeRollback($mlids); + } + // Now clear the cache. + menu_cache_clear_all(); + } + + /** + * Delete a batch of custom menus at once. + * + * @param $mlids + * Array of menu links ids to be deleted. + */ + public function bulkRollback(array $mlids) { + migrate_instrument_start('menu_link_delete_multiple'); + // @todo: should this be a full item? + $this->prepareRollback($mlids); + foreach ($mlids as $mlid) { + menu_link_delete($mlid); + } + // @todo: is this useful here? + $this->completeRollback($mlids); + migrate_instrument_stop('menu_link_delete_multiple'); + } + +}