' . format_plural($num_relations, + 'The %label relation type is used by 1 relation on your site. If you remove this relation type, you will not be able to edit %label relations and they may not display correctly.', + 'The %label relation type is used by @count relations on your site. If you remove %label, you will not be able to edit %label relations and they may not display correctly.', + array('%label' => $relation_type->label, '@count' => $num_relations)) . '
'; + } + + $caption .= '' . t('This action cannot be undone.') . '
'; + + return confirm_form($form, $message, 'admin/structure/relation', $caption, t('Delete')); +} + +/** + * Process relation type delete confirm submissions. + */ +function relation_ui_type_delete_confirm_submit($form, &$form_state) { + relation_type_delete($form_state['values']['relation_type']); + + $t_args = array('%label' => $form_state['values']['label']); + drupal_set_message(t('The %label relation type has been deleted.', $t_args)); + watchdog('relation', 'Deleted the %label relation type.', $t_args, WATCHDOG_NOTICE); + + // @TODO: relation_types_rebuild() ?; + menu_rebuild(); + + $form_state['redirect'] = 'admin/structure/relation'; + return; +} + +/** + * Generate relations + */ +function relation_ui_generate_form($form, &$form_state) { + $types = relation_get_types(); + + if (empty($types)) { + $form['explanation']['#markup'] = t("Before you can generate relations, you need to define one or more !link.", array("!link" => l(t('relation types'), 'admin/structure/relation'))); + return $form; + } + foreach ($types as $id => $type) { + $types[$id] = $type->label; + } + + $form['relation_types'] = array( + '#type' => 'checkboxes', + '#title' => t('Relation types'), + '#description' => t('Select relation types to create relations from. If no types are selected, relations will be generated for all types.'), + '#options' => $types, + ); + $form['relation_number'] = array( + '#type' => 'textfield', + '#title' => t('How many relations would you like to generate of each type?'), + '#default_value' => 10, + '#size' => 10, + ); + $form['relation_kill'] = array( + '#type' => 'checkbox', + '#title' => t('Kill all existing relations first.'), + ); + + $form['submit'] = array( + '#type' => 'submit', + '#value' => t('Generate'), + ); + return $form; +} + +function relation_ui_generate_form_submit($form, &$form_state) { + $number = $form_state['values']['relation_number']; + $types = $form_state['values']['relation_types']; + $kill = $form_state['values']['relation_kill']; + if (is_numeric($number) && $number > 0) { + include_once drupal_get_path('module', 'relation') . '/relation.drush.inc'; + $types = array_keys(array_filter($types)); + $rids = relation_generate_relations($number, $types, $kill); + } +} + +/** + * Menu callback for admin/content/relation. Displays all relations on the site. + */ +function relation_ui_admin_content() { + // Set up header row. + $header = array( + 'label' => array('data' => t('Title'), 'field' => 'r.rid', 'sort' => 'asc'), + 'type' => array('data' => t('Type'), 'field' => 'r.relation_type'), + t('Relation'), + 'operations' => array('data' => t('Operations'), 'colspan' => '2'), + ); + + // Grab all relations. + $query = db_select('relation', 'r')->extend('PagerDefault')->extend('TableSort'); + $query->join('relation_type', 'rt', 'r.relation_type = rt.relation_type'); + $query->fields('r', array('rid', 'relation_type')) + ->fields('rt', array('directional')) + ->limit(50) + ->orderByHeader($header); + $relations = $query->execute(); + + return theme('relation_ui_admin_content', array('relations' => $relations, 'header' => $header)); +} + +/** + * Generate a table of all relations on this site. + */ +function theme_relation_ui_admin_content($variables) { + $relations = $variables['relations']; + $header = $variables['header']; + + $rows = array(); + if (empty($relations)) { + // Give a message if there are no relations returned. + $message = t('There are currently no relations on your site.'); + + $rows[] = array( + array('data' => $message, 'colspan' => 5), + ); + } + else { + foreach ($relations as $relation) { + // Load the relation. + $r = relation_load($relation->rid); + // Get the endpoints for this relation. + $endpoints = field_get_items('relation', $r, 'endpoints'); + + $relation_entities = array(); + if (!empty($endpoints)) { + foreach ($endpoints as $endpoint) { + $entities = entity_load($endpoint['entity_type'], array($endpoint['entity_id'])); + $entity = reset($entities); + $title = entity_label($endpoint['entity_type'], $entity); + $path = entity_uri($endpoint['entity_type'], $entity); + + // Logic to process how the different entities return a uri. + // see this issue: http://drupal.org/node/1057242 + if ($endpoint['entity_type'] == 'file') { + $path = array('path' => file_create_url($path)); + } + if ($endpoint['entity_type'] == 'taxonomy_vocabulary') { + $path = array('path' => 'admin/structure/taxonomy/' . $entity->machine_name); + } + $relation_entities[] = array('title' => $title, 'path' => $path['path']); + } + } + + // Build the column for the relation entities. + $relation_column = array(); + foreach ($relation_entities as $entity) { + $relation_column[] = l($entity['title'], $entity['path']); + } + + // Build the rows to pass to the table theme function. + // Directional is implemented, not sure how well it works. + $rows[] = array( + l(t('Relation') . ' ' . $relation->rid, 'relation/' . $relation->rid), + $relation->relation_type, + implode(($relation->directional) ? " -> " : " -- ", $relation_column), + user_access('edit relations') ? l(t('Edit'), 'relation/' . $relation->rid . '/edit') : '', + user_access('delete relations') ? l(t('Delete'), 'relation/' . $relation->rid . '/delete') : '', + ); + } + } + + return theme('table', array('header' => $header, 'rows' => $rows)) . theme('pager'); +} + +/** + * Page callback to import a relation. + */ +function relation_ui_type_import($form) { + $form['name'] = array( + '#type' => 'textfield', + '#title' => t('Relation type name'), + '#description' => t('Enter the machine name to use for this relation type if it is different from the relation type to be imported. Leave blank to use the name of the relation type below.'), + ); + $form['relation_type'] = array( + '#type' => 'textarea', + '#rows' => 10, + ); + $form['import'] = array( + '#type' => 'submit', + '#value' => t('Import'), + ); + return $form; +} + +function relation_ui_type_import_validate($form, &$form_state) { + if (drupal_substr($form_state['values']['relation_type'], 0, 5) == 'relation_type = $form_state['values']['name']; + } + + if (relation_type_load($relation_type->relation_type)) { + form_set_error('name', t('A relation type by that name already exists; please choose a different name')); + } + $form_state['relation_type'] = $relation_type; +} + +function relation_ui_type_import_submit($form, &$form_state) { + relation_type_save($form_state['relation_type']); + $relation_type = $form_state['relation_type']->relation_type; + drupal_set_message(t('Successfully imported @relation_type', array('@relation_type' => $relation_type))); + $form_state['redirect'] = 'admin/structure/relation/manage/' . $relation_type; +} + +/** + * Relation display page title callback. + */ +function relation_ui_page_title($relation) { + return 'Relation ' . $relation->rid; +} + +/** + * Implements hook_theme(). + */ +function relation_ui_theme() { + $theme = array( + 'relation_ui_admin_content' => array( + 'variables' => array('relations' => NULL) + ), + ); + return $theme; +} \ No newline at end of file diff --git a/tests/relation_ui.test b/tests/relation_ui.test new file mode 100644 index 0000000..f3d7f42 --- /dev/null +++ b/tests/relation_ui.test @@ -0,0 +1,174 @@ + 'Relation UI test', + 'description' => 'Tests Relation UI.', + 'group' => 'Relation', + ); + } + + function setUp() { + // This is necessary for the ->propertyOrderBy('created', 'DESC') test. + $this->sleep = TRUE; + parent::setUp('relation_ui'); + } + + /** + * Tests deletion of a relation. + */ + function testRelationDelete() { + $relations = relation_query('node', $this->node1->nid) + ->propertyOrderBy('created', 'DESC') + ->execute(); + $relation = $relations[$this->rid_directional]; + + $this->drupalPost("relation/$relation->rid/delete", array(), t('Delete')); + $arg = array(':rid' => $relation->rid); + $this->assertFalse((bool) db_query_range('SELECT * FROM {relation} WHERE rid = :rid', 0, 1, $arg)->fetchField(), 'Nothing in relation table after delete.'); + $this->assertFalse((bool) db_query_range('SELECT * FROM {relation_revision} WHERE rid = :rid', 0, 1, $arg)->fetchField(), 'Nothing in relation revision table after delete.'); + $skeleton_relation = entity_create_stub_entity('relation', array($relation->rid, $relation->vid, $relation->relation_type)); + field_attach_load('relation', array($relation->rid => $skeleton_relation)); + $this->assertIdentical($skeleton_relation->endpoints, array(), t('Field data not present after delete')); + + // Try deleting the content types. + $this->drupalGet("admin/structure/relation/manage/$this->relation_type_symmetric/delete"); + $num_relations = 1; + // See relation_type_delete_confirm() in relation_ui.module + $this->assertRaw(format_plural($num_relations, 'The %label relation type is used by 1 relation on your site. If you remove this relation type, you will not be able to edit %label relations and they may not display correctly.', 'The %label relation type is used by @count relations on your site. If you remove %label, you will not be able to edit %label relations and they may not display correctly.', array('%label' => $this->relation_types['symmetric']['label'], '@count' => $num_relations)), 'Correct number of relations found (1) for ' . $this->relation_types['symmetric']['label'] . ' relation type.'); + } + + /** + * Tests importing method. + */ + function testRelationImport() { + // Tests navigate to import page and all fields are available. + $this->drupalGet('admin/structure/relation'); + $this->clickLink(t('Import relation type')); + $this->assertFieldByName('name'); + $this->assertFieldByName('relation_type'); + $this->assertFieldByName('op', t('Import')); + + // Tests import a relation. The relation name is coming from source. So + // first imports a simple relation without adding a different name, check + // status message and return to the relations listing page to check the + // imported relation is available. + $post = array( + 'relation_type' => ' + $relation_type = new stdClass(); + $relation_type->disabled = FALSE; /* Edit this to true to make a default relation_type disabled initially */ + $relation_type->api_version = 1; + $relation_type->relation_type = \'is_similar_to\'; + $relation_type->label = \'is similar to\'; + $relation_type->reverse_label = \'is similar to\'; + $relation_type->directional = 0; + $relation_type->transitive = 1; + $relation_type->r_unique = 1; + $relation_type->min_arity = 4; + $relation_type->max_arity = 5; + $relation_type->source_bundles = array( + 0 => \'node:*\', + ); + $relation_type->target_bundles = array(); + ', + ); + $this->drupalPost(NULL, $post, t('Import')); + $this->assertText(t('Successfully imported is_similar_to')); + $this->drupalGet('admin/structure/relation'); + $this->assertLink('is similar to', 0, t('The imported relation is exist')); + + // Navaigates to edit page, checks machine name and the imported data. The + // imported data contains the following field checks: + // - the selected bundle + // - directional checkbox + // - transivite checkbox + // - unique checkbox + // - minimum and maximum arity select lists + $this->clickLink('is similar to'); + // Checks the corect url. + $this->assertUrl('admin/structure/relation/manage/is_similar_to', array(), t('The imported machine name is correct.')); + // Checks that only the correct bundle is selected. + $bundle_options = $this->xpath('//select[@id=:id]//option', array(':id' => 'edit-source-bundles')); + foreach ($bundle_options as $option) { + $this->assertIdentical((string) $option['value'] == 'node:*', isset($option['selected'])); + } + // Checks other datas. + $this->assertNoFieldChecked('edit-directional', t('Directional data is imported correct.')); + $this->assertFieldChecked('edit-advanced-transitive', t('Transitive data is imported correct.')); + $this->assertFieldChecked('edit-advanced-r-unique', t('Unique data is imported correct.')); + $this->assertOptionSelected('edit-advanced-min-arity', '4', t('Minimum arity data is imported correct.')); + $this->assertOptionSelected('edit-advanced-max-arity', '5', t('Maximum arity data is imported correct.')); + + // Tests validation of duplication import. + $post = array( + 'relation_type' => ' + $relation_type = new stdClass(); + $relation_type->disabled = FALSE; /* Edit this to true to make a default relation_type disabled initially */ + $relation_type->api_version = 1; + $relation_type->relation_type = \'is_similar_to\'; + $relation_type->label = \'is similar to\'; + $relation_type->reverse_label = \'is similar to\'; + $relation_type->directional = 0; + $relation_type->transitive = 1; + $relation_type->r_unique = 1; + $relation_type->min_arity = 4; + $relation_type->max_arity = 5; + $relation_type->source_bundles = array( + 0 => \'node:*\', + ); + $relation_type->target_bundles = array(); + ', + ); + $this->drupalPost('admin/structure/relation/import', $post, t('Import')); + $this->assertNoText(t('Successfully imported is_similar_to')); + $this->assertText(t('A relation type by that name already exists; please choose a different name')); + + // Delete unused relation. + relation_type_delete('is_similar_to'); + + // Tests importing with overridden machine name. So after imporing check + // the status message, check that the imported relation is available and + // check the modified machine name. + $post = array( + 'name' => 'overridden_import_test', + 'relation_type' => ' + $relation_type = new stdClass(); + $relation_type->disabled = FALSE; /* Edit this to true to make a default relation_type disabled initially */ + $relation_type->api_version = 1; + $relation_type->relation_type = \'is_similar_to\'; + $relation_type->label = \'is similar to\'; + $relation_type->reverse_label = \'is similar to\'; + $relation_type->directional = 0; + $relation_type->transitive = 1; + $relation_type->r_unique = 1; + $relation_type->min_arity = 4; + $relation_type->max_arity = 5; + $relation_type->source_bundles = array( + 0 => \'node:*\', + ); + $relation_type->target_bundles = array(); + ', + ); + $this->drupalPost('admin/structure/relation/import', $post, t('Import')); + $this->assertText(t('Successfully imported overridden_import_test')); + $this->drupalGet('admin/structure/relation'); + $this->assertLink('is similar to', 0, t('The imported relation is exist')); + $this->clickLink('is similar to'); + $this->assertUrl('admin/structure/relation/manage/overridden_import_test', array(), t('The imported machine name is correct.')); + + // Delete unused relation. + relation_type_delete('is_similar_to'); + } +}