From ac6dcafa87ccee1a80d6b4db49a8a9835954e33c Mon Sep 17 00:00:00 2001 From: Florent Torregrosa Date: Fri, 11 Dec 2020 09:44:02 +0100 Subject: [PATCH] Issue #2889486 by Grimreaper, aleevas, andersen_ti, vacho: "Has taxonomy term" contextual filter does not take the language value into account --- .../optional/views.view.taxonomy_term.yml | 40 ++++++ .../taxonomy/src/TermStorageSchema.php | 11 +- core/modules/taxonomy/src/TermViewsData.php | 11 ++ core/modules/taxonomy/taxonomy.install | 101 ++++++++++++++ core/modules/taxonomy/taxonomy.module | 17 ++- .../modules/taxonomy/taxonomy.post_update.php | 53 ++++++++ .../drupal-8.taxonomy-index-2889486.php | 127 ++++++++++++++++++ .../tests/src/Functional/TermIndexTest.php | 109 +++++++++++++++ .../Update/TaxonomyIndexUpdateTest.php | 66 +++++++++ .../Functional/Views/TaxonomyTermViewTest.php | 19 +++ 10 files changed, 546 insertions(+), 8 deletions(-) create mode 100644 core/modules/taxonomy/tests/fixtures/update/drupal-8.taxonomy-index-2889486.php create mode 100644 core/modules/taxonomy/tests/src/Functional/Update/TaxonomyIndexUpdateTest.php diff --git a/core/modules/taxonomy/config/optional/views.view.taxonomy_term.yml b/core/modules/taxonomy/config/optional/views.view.taxonomy_term.yml index 92da5368f0..bcd2acf0a5 100644 --- a/core/modules/taxonomy/config/optional/views.view.taxonomy_term.yml +++ b/core/modules/taxonomy/config/optional/views.view.taxonomy_term.yml @@ -213,6 +213,46 @@ display: default_group_multiple: { } group_items: { } plugin_id: boolean + langcode_1: + id: langcode_1 + table: taxonomy_index + field: langcode + relationship: none + group_type: group + admin_label: '' + operator: in + value: + '***LANGUAGE_language_content***': '***LANGUAGE_language_content***' + group: 1 + exposed: false + expose: + operator_id: '' + label: '' + description: '' + use_operator: false + operator: '' + operator_limit_selection: false + operator_list: { } + identifier: '' + required: false + remember: false + multiple: false + remember_roles: + authenticated: authenticated + reduce: false + is_grouped: false + group_info: + label: '' + description: '' + identifier: '' + optional: true + widget: select + multiple: false + remember: false + default_group: All + default_group_multiple: { } + group_items: { } + plugin_id: language style: type: default options: diff --git a/core/modules/taxonomy/src/TermStorageSchema.php b/core/modules/taxonomy/src/TermStorageSchema.php index 0aa097bcf7..ea1663285e 100644 --- a/core/modules/taxonomy/src/TermStorageSchema.php +++ b/core/modules/taxonomy/src/TermStorageSchema.php @@ -60,10 +60,17 @@ protected function getEntitySchema(ContentEntityTypeInterface $entity_type, $res 'not null' => TRUE, 'default' => 0, ], + 'langcode' => [ + 'description' => 'The langcode of the node.', + 'type' => 'varchar_ascii', + 'length' => 12, + 'not null' => TRUE, + 'default' => '', + ], ], - 'primary key' => ['nid', 'tid'], + 'primary key' => ['nid', 'tid', 'langcode'], 'indexes' => [ - 'term_node' => ['tid', 'status', 'sticky', 'created'], + 'term_node' => ['tid', 'status', 'sticky', 'created', 'langcode'], ], 'foreign keys' => [ 'tracked_node' => [ diff --git a/core/modules/taxonomy/src/TermViewsData.php b/core/modules/taxonomy/src/TermViewsData.php index 7ea6758ba0..ec3c538011 100644 --- a/core/modules/taxonomy/src/TermViewsData.php +++ b/core/modules/taxonomy/src/TermViewsData.php @@ -212,6 +212,17 @@ public function getViewsData() { ], ]; + $data['taxonomy_index']['langcode'] = [ + 'title' => $this->t('Node language'), + 'help' => $this->t('The langcode of the node.'), + 'filter' => [ + 'id' => 'language', + ], + 'sort' => [ + 'id' => 'standard', + ], + ]; + $data['taxonomy_index']['created'] = [ 'title' => $this->t('Post date'), 'help' => $this->t('The date the content related to a term was posted.'), diff --git a/core/modules/taxonomy/taxonomy.install b/core/modules/taxonomy/taxonomy.install index b03fda2ac4..245336fe8e 100644 --- a/core/modules/taxonomy/taxonomy.install +++ b/core/modules/taxonomy/taxonomy.install @@ -5,9 +5,110 @@ * Install, update and uninstall functions for the taxonomy module. */ +use Drupal\Core\Database\Database; + /** * Implements hook_update_last_removed(). */ function taxonomy_update_last_removed() { return 8702; } + +/** + * Add 'langcode' field to 'taxonomy_index' entities. + * + * Content needs to be updated. + */ +function taxonomy_update_9201() { + if (!Database::getConnection()->schema()->fieldExists('taxonomy_index', 'langcode')) { + Database::getConnection() + ->schema() + ->addField('taxonomy_index', 'langcode', [ + 'description' => 'The langcode of the node.', + 'type' => 'varchar_ascii', + 'length' => 12, + 'not null' => TRUE, + 'default' => '', + ]); + + Database::getConnection()->schema()->dropPrimaryKey('taxonomy_index'); + Database::getConnection()->schema()->addPrimaryKey( + 'taxonomy_index', + ['nid', 'tid', 'langcode'] + ); + } + + // Recreate the index to be sure it has the correct configuration. + if (Database::getConnection()->schema()->indexExists('taxonomy_index', 'term_node')) { + Database::getConnection()->schema()->dropIndex('taxonomy_index', 'term_node'); + } + + Database::getConnection()->schema()->addIndex( + 'taxonomy_index', + 'term_node', + ['tid', 'status', 'sticky', 'created', 'langcode'], + [ + 'description' => 'Maintains denormalized information about node/term relationships.', + 'fields' => [ + 'nid' => [ + 'description' => 'The {node}.nid this record tracks.', + 'type' => 'int', + 'unsigned' => TRUE, + 'not null' => TRUE, + 'default' => 0, + ], + 'tid' => [ + 'description' => 'The term ID.', + 'type' => 'int', + 'unsigned' => TRUE, + 'not null' => TRUE, + 'default' => 0, + ], + 'status' => [ + 'description' => 'Boolean indicating whether the node is published (visible to nonadministrators).', + 'type' => 'int', + 'not null' => TRUE, + 'default' => 1, + ], + 'sticky' => [ + 'description' => 'Boolean indicating whether the node is sticky.', + 'type' => 'int', + 'not null' => FALSE, + 'default' => 0, + 'size' => 'tiny', + ], + 'created' => [ + 'description' => 'The Unix timestamp when the node was created.', + 'type' => 'int', + 'not null' => TRUE, + 'default' => 0, + ], + 'langcode' => [ + 'description' => 'The langcode of the node.', + 'type' => 'varchar_ascii', + 'length' => 12, + 'not null' => TRUE, + ], + ], + 'primary key' => ['nid', 'tid', 'langcode'], + 'indexes' => [ + 'term_node' => ['tid', 'status', 'sticky', 'created', 'langcode'], + ], + 'foreign keys' => [ + 'tracked_node' => [ + 'table' => 'node', + 'columns' => ['nid' => 'nid'], + ], + 'term' => [ + 'table' => 'taxonomy_term_data', + 'columns' => ['tid' => 'tid'], + ], + ], + ] + ); + + // See https://www.drupal.org/node/3034742. + $definition_update_manager = \Drupal::entityDefinitionUpdateManager(); + $entity_type = $definition_update_manager->getEntityType('taxonomy_term'); + $definition_update_manager->updateEntityType($entity_type); +} diff --git a/core/modules/taxonomy/taxonomy.module b/core/modules/taxonomy/taxonomy.module index 34dd8bcc6f..821669bdc8 100644 --- a/core/modules/taxonomy/taxonomy.module +++ b/core/modules/taxonomy/taxonomy.module @@ -346,7 +346,7 @@ function taxonomy_build_node_index($node) { foreach ($node->getTranslationLanguages() as $language) { foreach ($node->getTranslation($language->getId())->$field_name as $item) { if (!$item->isEmpty()) { - $tid_all[$item->target_id] = $item->target_id; + $tid_all[$item->target_id][$language->getId()] = $item->target_id; } } } @@ -355,11 +355,13 @@ function taxonomy_build_node_index($node) { // Insert index entries for all the node's terms. if (!empty($tid_all)) { $connection = \Drupal::database(); - foreach ($tid_all as $tid) { - $connection->merge('taxonomy_index') - ->key(['nid' => $node->id(), 'tid' => $tid, 'status' => $node->isPublished()]) - ->fields(['sticky' => $sticky, 'created' => $node->getCreatedTime()]) - ->execute(); + foreach ($tid_all as $tid_info) { + foreach ($tid_info as $langcode => $tid) { + $connection->merge('taxonomy_index') + ->key(['nid' => $node->id(), 'tid' => $tid, 'status' => $node->isPublished(), 'langcode' => $langcode]) + ->fields(['sticky' => $sticky, 'created' => $node->getCreatedTime()]) + ->execute(); + } } } } @@ -394,6 +396,9 @@ function taxonomy_node_predelete(EntityInterface $node) { */ function taxonomy_delete_node_index(EntityInterface $node) { if (\Drupal::config('taxonomy.settings')->get('maintain_index_table')) { + // Since taxonomy_node_update() will handle the deletions of specific + // translations, we only need to handle the case where the whole node is + // deleted. \Drupal::database()->delete('taxonomy_index')->condition('nid', $node->id())->execute(); } } diff --git a/core/modules/taxonomy/taxonomy.post_update.php b/core/modules/taxonomy/taxonomy.post_update.php index 2e18d17ad8..b7f9b305d2 100644 --- a/core/modules/taxonomy/taxonomy.post_update.php +++ b/core/modules/taxonomy/taxonomy.post_update.php @@ -18,3 +18,56 @@ function taxonomy_removed_post_updates() { 'taxonomy_post_update_configure_status_field_widget' => '9.0.0', ]; } + +/** + * Populate taxonomy index new langcode column. + */ +function taxonomy_post_update_populate_taxonomy_index_langcode(&$sandbox = NULL) { + /** @var \Drupal\node\NodeStorageInterface $node_storage */ + $node_storage = \Drupal::entityTypeManager()->getStorage('node'); + $database = \Drupal::database(); + + if (!isset($sandbox['max'])) { + $sandbox['max'] = $database->select('taxonomy_index') + ->fields('taxonomy_index', ['nid']) + ->distinct() + ->countQuery() + ->execute() + ->fetchField(); + $sandbox['progress'] = 0; + $sandbox['current_node'] = 0; + $sandbox['limit'] = 50; + + // Handle the case of 0 node to process. + if ($sandbox['max'] == 0) { + $sandbox['#finished'] = 1; + return; + } + } + + // Retrieve the next group. + $entity_ids = $database->select('taxonomy_index') + ->fields('taxonomy_index', ['nid']) + ->condition('nid', $sandbox['current_node'], '>') + ->distinct() + ->range(NULL, $sandbox['limit']) + ->execute() + ->fetchCol(); + $nodes = $node_storage->loadMultiple($entity_ids); + + foreach ($nodes as $node) { + taxonomy_delete_node_index($node); + taxonomy_build_node_index($node); + + // Update our progress information. + $sandbox['progress']++; + $sandbox['current_node'] = $node->id(); + } + + if ($sandbox['progress'] != $sandbox['max']) { + $sandbox['#finished'] = ($sandbox['progress'] >= $sandbox['max']); + } + else { + $sandbox['#finished'] = 1; + } +} diff --git a/core/modules/taxonomy/tests/fixtures/update/drupal-8.taxonomy-index-2889486.php b/core/modules/taxonomy/tests/fixtures/update/drupal-8.taxonomy-index-2889486.php new file mode 100644 index 0000000000..2409b38447 --- /dev/null +++ b/core/modules/taxonomy/tests/fixtures/update/drupal-8.taxonomy-index-2889486.php @@ -0,0 +1,127 @@ +insert('node_field_data') + ->fields([ + 'nid', + 'vid', + 'type', + 'langcode', + 'title', + 'uid', + 'status', + 'created', + 'changed', + 'promote', + 'sticky', + 'revision_translation_affected', + 'default_langcode', + 'content_translation_source', + 'content_translation_outdated', + ]) + ->values([ + 'nid' => 1, + 'vid' => 2, + 'type' => 'article', + 'langcode' => 'es', + 'title' => 'Test Article - New title', + 'uid' => 1, + 'status' => 1, + 'created' => 1439730300, + 'changed' => 1439730369, + 'promote' => 1, + 'sticky' => 1, + 'revision_translation_affected' => 1, + 'default_langcode' => 0, + 'content_translation_source' => 'en', + 'content_translation_outdated' => 0, + ]) + ->execute(); + +$connection->insert('node_field_revision') + ->fields([ + 'nid', + 'vid', + 'langcode', + 'title', + 'uid', + 'status', + 'created', + 'changed', + 'promote', + 'sticky', + 'revision_translation_affected', + 'default_langcode', + 'content_translation_source', + 'content_translation_outdated', + ]) + ->values([ + 'nid' => 1, + 'vid' => 2, + 'langcode' => 'es', + 'title' => 'Test Article - New title', + 'uid' => 1, + 'status' => 1, + 'created' => 1439730300, + 'changed' => 1439730369, + 'promote' => 1, + 'sticky' => 1, + 'revision_translation_affected' => 1, + 'default_langcode' => 0, + 'content_translation_source' => 'en', + 'content_translation_outdated' => 0, + ]) + ->execute(); + +$connection->insert('node__field_tags') + ->fields([ + 'bundle', + 'deleted', + 'entity_id', + 'revision_id', + 'langcode', + 'delta', + 'field_tags_target_id', + ]) + ->values([ + 'bundle' => 'article', + 'deleted' => 0, + 'entity_id' => 1, + 'revision_id' => 2, + 'langcode' => 'es', + 'delta' => 0, + 'field_tags_target_id' => 5, + ]) + ->execute(); + +$connection->insert('node_revision__field_tags') + ->fields([ + 'bundle', + 'deleted', + 'entity_id', + 'revision_id', + 'langcode', + 'delta', + 'field_tags_target_id', + ]) + ->values([ + 'bundle' => 'article', + 'deleted' => 0, + 'entity_id' => 1, + 'revision_id' => 2, + 'langcode' => 'es', + 'delta' => 0, + 'field_tags_target_id' => 5, + ]) + ->execute(); diff --git a/core/modules/taxonomy/tests/src/Functional/TermIndexTest.php b/core/modules/taxonomy/tests/src/Functional/TermIndexTest.php index 43b97f8e54..24535bd4fd 100644 --- a/core/modules/taxonomy/tests/src/Functional/TermIndexTest.php +++ b/core/modules/taxonomy/tests/src/Functional/TermIndexTest.php @@ -5,6 +5,7 @@ use Drupal\Core\Link; use Drupal\Core\Database\Database; use Drupal\Core\Field\FieldStorageDefinitionInterface; +use Drupal\language\Entity\ConfigurableLanguage; /** * Tests the hook implementations that maintain the taxonomy index. @@ -230,6 +231,92 @@ public function testTaxonomyIndex() { $this->assertEqual(0, $index_count, 'Term 2 is not indexed.'); } + /** + * Tests that the taxonomy index is maintained properly. + */ + public function testTaxonomyIndexMultilingual() { + \Drupal::service('module_installer')->install(['language', 'content_translation']); + ConfigurableLanguage::createFromLangcode('ur')->save(); + ConfigurableLanguage::createFromLangcode('fr')->save(); + // Enable translation for the article content type and ensure the change is + // picked up. + \Drupal::service('content_translation.manager')->setEnabled('node', 'article', TRUE); + + /** @var \Drupal\node\NodeStorageInterface $node_storage */ + $node_storage = \Drupal::entityTypeManager()->getStorage('node'); + // Create term in the vocabulary. + $term_1 = $this->createTerm($this->vocabulary); + + // Create an article. + /** @var \Drupal\node\NodeInterface $node */ + $node = $node_storage->create([ + 'type' => 'article', + 'title' => $this->randomMachineName(), + 'langcode' => 'en', + $this->fieldName1 => [ + $term_1->id(), + ], + ]); + $node->save(); + $nid = $node->id(); + + // Reload the node to be sure every modification had been taken into + // account. + $node = $node_storage->load($nid); + $node->addTranslation('ur', [ + 'title' => $this->randomMachineName(), + $this->fieldName1 => [ + $term_1->id(), + ], + ]); + $node->save(); + + $node = $node_storage->load($nid); + $node->addTranslation('fr', [ + 'title' => $this->randomMachineName(), + ]); + $node->save(); + + // Check taxonomy index entries after translation creation. + $this->checkNumberOfEntriesPerLanguage($nid, $term_1->id(), [ + 'en' => 1, + 'ur' => 1, + 'fr' => 0, + ]); + + // Add a reference to the term in fr. + $node = $node_storage->load($nid); + $translation = $node->getTranslation('fr'); + $translation->set($this->fieldName1, [ + $term_1->id(), + ]); + $translation->save(); + $this->checkNumberOfEntriesPerLanguage($nid, $term_1->id(), [ + 'en' => 1, + 'ur' => 1, + 'fr' => 1, + ]); + + // Delete ur translation. + $node = $node_storage->load($nid); + $node->removeTranslation('ur'); + $node->save(); + $this->checkNumberOfEntriesPerLanguage($nid, $term_1->id(), [ + 'en' => 1, + 'ur' => 0, + 'fr' => 1, + ]); + + // Delete the whole node. + $node = $node_storage->load($nid); + $node->delete(); + $this->checkNumberOfEntriesPerLanguage($nid, $term_1->id(), [ + 'en' => 0, + 'ur' => 0, + 'fr' => 0, + ]); + } + /** * Tests that there is a link to the parent term on the child term page. */ @@ -248,4 +335,26 @@ public function testTaxonomyTermHierarchyBreadcrumbs() { $this->assertRaw(Link::fromTextAndUrl($term2->getName(), $term2->toUrl('canonical', ['language' => NULL]))->toString()); } + /** + * Helper function. + * + * @param int $nid + * The node ID. + * @param int $tid + * The taxonomy term ID. + * @param array $expected_numbers + * The expected number of entries keyed by the langcode. + */ + protected function checkNumberOfEntriesPerLanguage($nid, $tid, array $expected_numbers) { + $connection = Database::getConnection(); + foreach ($expected_numbers as $langcode => $expected_number) { + $index_count = $connection->query('SELECT COUNT(*) FROM {taxonomy_index} WHERE nid = :nid AND tid = :tid AND langcode = :langcode', [ + ':nid' => $nid, + ':tid' => $tid, + ':langcode' => $langcode, + ])->fetchField(); + $this->assertEquals($expected_number, $index_count, 'The actual number of entry ' . $index_count . ' for langcode ' . $langcode . ' is matching the expected number of ' . $expected_number); + } + } + } diff --git a/core/modules/taxonomy/tests/src/Functional/Update/TaxonomyIndexUpdateTest.php b/core/modules/taxonomy/tests/src/Functional/Update/TaxonomyIndexUpdateTest.php new file mode 100644 index 0000000000..68bdcb8d0b --- /dev/null +++ b/core/modules/taxonomy/tests/src/Functional/Update/TaxonomyIndexUpdateTest.php @@ -0,0 +1,66 @@ +db = $this->container->get('database'); + } + + /** + * {@inheritdoc} + */ + protected function setDatabaseDumpFiles() { + $this->databaseDumpFiles = [ + __DIR__ . '/../../../../../system/tests/fixtures/update/drupal-8.8.0.filled.standard.php.gz', + __DIR__ . '/../../../../../taxonomy/tests/fixtures/update/drupal-8.taxonomy-index-2889486.php', + ]; + } + + /** + * Tests taxonomy term parents update. + * + * @see taxonomy_update_8703() + * @see taxonomy_post_update_populate_taxonomy_index_langcode() + */ + public function testTaxonomyIndexLangcodeUpdate() { + $this->assertFalse($this->db->schema()->fieldExists('taxonomy_index', 'langcode'), 'The taxonomy_index table does not have a langcode column.'); + $index_count = $this->db->query('SELECT COUNT(*) FROM {taxonomy_index} WHERE nid = :nid AND tid = :tid', [ + ':nid' => 1, + ':tid' => 5, + ])->fetchField(); + $this->assertEquals(1, $index_count, '1 entry while two translations reference the same tid.'); + + // Run updates. + $this->runUpdates(); + + $this->assertTrue($this->db->schema()->fieldExists('taxonomy_index', 'langcode'), 'The taxonomy_index table has a langcode column.'); + $index_count = $this->db->query('SELECT COUNT(*) FROM {taxonomy_index} WHERE nid = :nid AND tid = :tid', [ + ':nid' => 1, + ':tid' => 5, + ])->fetchField(); + $this->assertEquals(2, $index_count, '2 entries after the update, one for each translation.'); + } + +} diff --git a/core/modules/taxonomy/tests/src/Functional/Views/TaxonomyTermViewTest.php b/core/modules/taxonomy/tests/src/Functional/Views/TaxonomyTermViewTest.php index a147681cef..335b256695 100644 --- a/core/modules/taxonomy/tests/src/Functional/Views/TaxonomyTermViewTest.php +++ b/core/modules/taxonomy/tests/src/Functional/Views/TaxonomyTermViewTest.php @@ -115,15 +115,34 @@ public function testTaxonomyTermView() { $this->drupalPostForm('node/' . $node->id() . '/translations/add/en/ur', $edit, 'Save (this translation)'); + // Create a second term that will not reference the term in one of its + // language. + $edit = []; + $edit['title[0][value]'] = $original_title_2 = $this->randomMachineName(); + $edit['body[0][value]'] = $this->randomMachineName(); + $edit["{$this->fieldName1}[]"] = $term->id(); + $this->drupalPostForm('node/add/article', $edit, 'Save'); + $node_2 = $this->drupalGetNodeByTitle($edit['title[0][value]']); + + $edit['title[0][value]'] = $translated_title_2 = $this->randomMachineName(); + $edit["{$this->fieldName1}[]"] = '_none'; + $this->drupalPostForm('node/' . $node_2->id() . '/translations/add/en/ur', $edit, 'Save (this translation)'); + $this->drupalGet('taxonomy/term/' . $term->id()); $this->assertText($term->label()); $this->assertText($original_title); $this->assertNoText($translated_title); + $this->assertText($original_title_2); + $this->assertNoText($translated_title_2); $this->drupalGet('ur/taxonomy/term/' . $term->id()); $this->assertText($term->label()); $this->assertNoText($original_title); $this->assertText($translated_title); + // As node 2 do not reference the term, it should not appear on the + // translated term page. + $this->assertNoText($original_title_2); + $this->assertNoText($translated_title_2); // Uninstall language module and ensure that the language is not part of the // query anymore. -- 2.17.1