diff --git a/core/modules/views/src/Plugin/views/field/EntityField.php b/core/modules/views/src/Plugin/views/field/EntityField.php index 4c8032d..59b7d2d 100644 --- a/core/modules/views/src/Plugin/views/field/EntityField.php +++ b/core/modules/views/src/Plugin/views/field/EntityField.php @@ -230,7 +230,7 @@ public function query($use_groupby = FALSE) { unset($fields[$entity_type_key]); } - if ($use_groupby) { + if ($use_groupby && !empty($this->options['group_column'])) { // Add the fields that we're actually grouping on. $options = array(); if ($this->options['group_column'] != 'entity_id') { @@ -265,7 +265,7 @@ public function query($use_groupby = FALSE) { */ function add_field_table($use_groupby) { // Grouping is enabled. - if ($use_groupby) { + if ($use_groupby && !empty($this->options['group_column'])) { return TRUE; } // This a multiple value field, but "group multiple values" is not checked. @@ -344,13 +344,16 @@ protected function defineOptions() { $field_storage_definition = $this->getFieldStorageDefinition(); $field_type = $this->fieldTypePluginManager->getDefinition($field_storage_definition->getType()); $column_names = array_keys($field_storage_definition->getColumns()); - $default_column = ''; - // Try to determine a sensible default. - if (count($column_names) == 1) { - $default_column = $column_names[0]; - } - elseif (in_array('value', $column_names)) { - $default_column = 'value'; + $default_column = $field_storage_definition->getMainPropertyName() ?: ''; + // Try to determine a sensible default if none if provided by the field + // definition. + if (!$default_column) { + if (count($column_names) == 1) { + $default_column = $column_names[0]; + } + elseif (in_array('value', $column_names)) { + $default_column = 'value'; + } } // If the field has a "value" column, we probably need that one. diff --git a/core/modules/views/src/Tests/Update/EmptyFieldGroupColumnUpdateTest.php b/core/modules/views/src/Tests/Update/EmptyFieldGroupColumnUpdateTest.php new file mode 100644 index 0000000..5baf1c7 --- /dev/null +++ b/core/modules/views/src/Tests/Update/EmptyFieldGroupColumnUpdateTest.php @@ -0,0 +1,42 @@ +databaseDumpFiles = [ + __DIR__ . '/../../../../system/tests/fixtures/update/drupal-8.bare.standard.php.gz', + __DIR__ . '/../../../tests/fixtures/update/empty-field-group-column.php', + ]; + } + + /** + * Tests that empty field group column values are updated properly. + */ + public function testViewsPostUpdateEmptyFieldGroupColumn() { + $this->runUpdates(); + + // Load and initialize our test view. + $view = View::load('group_column_post_update'); + $data = $view->toArray(); + // Check that the field is using the expected default value. + $this->assertIdentical('target_id', $data['display']['default']['display_options']['fields']['field_image']['group_column']); + // Ensure existing values are not changed. + $this->assertIdentical('entity_id', $data['display']['default']['display_options']['fields']['field_image2']['group_column']); + } + +} diff --git a/core/modules/views/tests/fixtures/update/empty-field-group-column.php b/core/modules/views/tests/fixtures/update/empty-field-group-column.php new file mode 100644 index 0000000..0af1fd6 --- /dev/null +++ b/core/modules/views/tests/fixtures/update/empty-field-group-column.php @@ -0,0 +1,19 @@ +insert('config') + ->fields(array( + 'collection' => '', + 'name' => 'views.view.group_column_post_update', + 'data' => serialize(Yaml::decode(file_get_contents('core/modules/views/tests/fixtures/update/views.view.group_column_post_update.yml'))), + )) + ->execute(); diff --git a/core/modules/views/tests/fixtures/update/views.view.group_column_post_update.yml b/core/modules/views/tests/fixtures/update/views.view.group_column_post_update.yml new file mode 100644 index 0000000..9085c4e --- /dev/null +++ b/core/modules/views/tests/fixtures/update/views.view.group_column_post_update.yml @@ -0,0 +1,315 @@ +langcode: en +status: true +dependencies: + config: + - field.storage.node.field_image + module: + - image + - node + - user +id: group_column_post_update +label: 'group column post update' +module: views +description: '' +tag: '' +base_table: node_field_data +base_field: nid +core: 8.x +display: + default: + display_plugin: default + id: default + display_title: Master + position: 0 + display_options: + access: + type: perm + options: + perm: 'access content' + cache: + type: tag + options: { } + query: + type: views_query + options: + disable_sql_rewrite: false + distinct: false + replica: false + query_comment: '' + query_tags: { } + exposed_form: + type: basic + options: + submit_button: Apply + reset_button: false + reset_button_label: Reset + exposed_sorts_label: 'Sort by' + expose_sort_order: true + sort_asc_label: Asc + sort_desc_label: Desc + pager: + type: mini + options: + items_per_page: 10 + offset: 0 + id: 0 + total_pages: null + expose: + items_per_page: false + items_per_page_label: 'Items per page' + items_per_page_options: '5, 10, 25, 50' + items_per_page_options_all: false + items_per_page_options_all_label: '- All -' + offset: false + offset_label: Offset + tags: + previous: ‹‹ + next: ›› + style: + type: default + row: + type: fields + options: + default_field_elements: true + inline: { } + separator: '' + hide_empty: false + fields: + title: + id: title + table: node_field_data + field: title + entity_type: node + entity_field: title + label: '' + alter: + alter_text: false + make_link: false + absolute: false + trim: false + word_boundary: false + ellipsis: false + strip_tags: false + html: false + hide_empty: false + empty_zero: false + settings: + link_to_entity: true + plugin_id: field + relationship: none + group_type: group + admin_label: '' + exclude: false + element_type: '' + element_class: '' + element_label_type: '' + element_label_class: '' + element_label_colon: true + element_wrapper_type: '' + element_wrapper_class: '' + element_default_classes: true + empty: '' + hide_alter_empty: true + click_sort_column: value + type: string + group_column: value + group_columns: { } + group_rows: true + delta_limit: 0 + delta_offset: 0 + delta_reversed: false + delta_first_last: false + multi_type: separator + separator: ', ' + field_api_classes: false + field_image: + id: field_image + table: node__field_image + field: field_image + relationship: none + group_type: group + admin_label: '' + label: '' + exclude: false + alter: + alter_text: false + text: '' + make_link: false + path: '' + absolute: false + external: false + replace_spaces: false + path_case: none + trim_whitespace: false + alt: '' + rel: '' + link_class: '' + prefix: '' + suffix: '' + target: '' + nl2br: false + max_length: 0 + word_boundary: true + ellipsis: true + more_link: false + more_link_text: '' + more_link_path: '' + strip_tags: false + trim: false + preserve_tags: '' + html: false + element_type: '' + element_class: '' + element_label_type: '' + element_label_class: '' + element_label_colon: false + element_wrapper_type: '' + element_wrapper_class: '' + element_default_classes: true + empty: '' + hide_empty: false + empty_zero: false + hide_alter_empty: true + click_sort_column: target_id + type: image + settings: + image_style: '' + image_link: '' + group_column: '' + group_columns: { } + group_rows: true + delta_limit: 0 + delta_offset: 0 + delta_reversed: false + delta_first_last: false + multi_type: separator + separator: ', ' + field_api_classes: false + plugin_id: field + field_image2: + id: field_image2 + table: node__field_image + field: field_image + relationship: none + group_type: group + admin_label: '' + label: '' + exclude: false + alter: + alter_text: false + text: '' + make_link: false + path: '' + absolute: false + external: false + replace_spaces: false + path_case: none + trim_whitespace: false + alt: '' + rel: '' + link_class: '' + prefix: '' + suffix: '' + target: '' + nl2br: false + max_length: 0 + word_boundary: true + ellipsis: true + more_link: false + more_link_text: '' + more_link_path: '' + strip_tags: false + trim: false + preserve_tags: '' + html: false + element_type: '' + element_class: '' + element_label_type: '' + element_label_class: '' + element_label_colon: false + element_wrapper_type: '' + element_wrapper_class: '' + element_default_classes: true + empty: '' + hide_empty: false + empty_zero: false + hide_alter_empty: true + click_sort_column: target_id + type: image + settings: + image_style: '' + image_link: '' + group_column: entity_id + group_columns: { } + group_rows: true + delta_limit: 0 + delta_offset: 0 + delta_reversed: false + delta_first_last: false + multi_type: separator + separator: ', ' + field_api_classes: false + plugin_id: field + filters: + status: + value: '1' + table: node_field_data + field: status + plugin_id: boolean + entity_type: node + entity_field: status + id: status + expose: + operator: '' + group: 1 + sorts: + created: + id: created + table: node_field_data + field: created + order: DESC + entity_type: node + entity_field: created + plugin_id: date + relationship: none + group_type: group + admin_label: '' + exposed: false + expose: + label: '' + granularity: second + title: 'image post update' + header: { } + footer: { } + empty: { } + relationships: { } + arguments: { } + display_extenders: { } + cache_metadata: + max-age: -1 + contexts: + - 'languages:language_content' + - 'languages:language_interface' + - url.query_args + - 'user.node_grants:view' + - user.permissions + tags: + - 'config:field.storage.node.field_image' + page_1: + display_plugin: page + id: page_1 + display_title: Page + position: 1 + display_options: + display_extenders: { } + path: image-post-update + cache_metadata: + max-age: -1 + contexts: + - 'languages:language_content' + - 'languages:language_interface' + - url.query_args + - 'user.node_grants:view' + - user.permissions + tags: + - 'config:field.storage.node.field_image' diff --git a/core/modules/views/tests/src/Kernel/QueryGroupByTest.php b/core/modules/views/tests/src/Kernel/QueryGroupByTest.php index 594bd62..361900d 100644 --- a/core/modules/views/tests/src/Kernel/QueryGroupByTest.php +++ b/core/modules/views/tests/src/Kernel/QueryGroupByTest.php @@ -2,10 +2,14 @@ namespace Drupal\Tests\views\Kernel; +use Drupal\entity_test\Entity\EntityTest; use Drupal\entity_test\Entity\EntityTestMul; use Drupal\field\Entity\FieldConfig; use Drupal\field\Entity\FieldStorageConfig; +use Drupal\file\Entity\File; +use Drupal\image\Entity\ImageStyle; use Drupal\language\Entity\ConfigurableLanguage; +use Drupal\views\Entity\View; use Drupal\views\Views; /** @@ -20,14 +24,14 @@ class QueryGroupByTest extends ViewsKernelTestBase { * * @var array */ - public static $testViews = array('test_group_by_in_filters', 'test_aggregate_count', 'test_group_by_count', 'test_group_by_count_multicardinality', 'test_group_by_field_not_within_bundle'); + public static $testViews = array('test_group_by_in_filters', 'test_aggregate_count', 'test_group_by_count', 'test_group_by_count_multicardinality', 'test_group_by_field_not_within_bundle', 'entity_test_fields'); /** * Modules to enable. * * @var array */ - public static $modules = array('entity_test', 'system', 'field', 'user', 'language'); + public static $modules = array('entity_test', 'system', 'field', 'user', 'language', 'file', 'image'); /** * The storage for the test entity type. @@ -331,4 +335,84 @@ public function testGroupByWithFieldsNotExistingOnBundle() { $this->assertEqual('1', $view->getStyle()->getField(1, 'field_test')); } + /** + * Tests aggregation on fields with multiple columns. + */ + public function testGroupByFieldWithMultipleColumns() { + $this->installEntitySchema('entity_test'); + $this->installEntitySchema('file'); + $this->installSchema('file', 'file_usage'); + /** @var \Drupal\image\ImageStyleInterface $style */ + $style = ImageStyle::create(['name' => 'foo']); + $style->save(); + + // Create a new image field 'bar' to be used in 'entity_test_fields' view. + FieldStorageConfig::create([ + 'entity_type' => 'entity_test', + 'field_name' => 'image_field', + 'type' => 'image', + ])->save(); + FieldConfig::create([ + 'entity_type' => 'entity_test', + 'bundle' => 'entity_test', + 'field_name' => 'image_field', + 'settings' => [ + 'file_extensions' => 'jpg', + ] + ])->save(); + + /** @var \Drupal\views\ViewEntityInterface $view */ + $view = View::load('entity_test_fields'); + $display =& $view->getDisplay('default'); + + // Set the image field as the only field so it should be used for grouping + // when aggregation is enabled. + $display['display_options']['fields'] = [ + 'image_field' => [ + 'id' => 'image_field', + 'field' => 'image_field', + 'plugin_id' => 'field', + 'table' => 'entity_test__image_field', + 'entity_type' => 'entity_test', + 'entity_field' => 'image_field', + 'type' => 'image', + 'settings' => ['image_style' => 'foo', 'image_link' => ''], + ], + ]; + $display['display_options']['arguments'] = []; + $display['display_options']['sorts'] = []; + $display['display_options']['group_by'] = TRUE; + $view->save(); + + $file = File::create(array( + 'filename' => 'druplicon.jpg', + 'uri' => "public://druplicon.jpg", + 'filemime' => 'image/jpeg', + 'status' => FILE_STATUS_PERMANENT, + )); + $file_two = File::create(array( + 'filename' => 'druplicon-two.jpg', + 'uri' => "public://druplicon-two.jpg", + 'filemime' => 'image/jpeg', + 'status' => FILE_STATUS_PERMANENT, + )); + + $entity_one = EntityTest::create(); + $entity_one->set('image_field', $file); + $entity_one->save(); + + $entity_two = EntityTest::create(); + $entity_two->set('image_field', $file); + $entity_two->save(); + + $entity_three = EntityTest::create(); + $entity_three->set('image_field', $file_two); + $entity_three->save(); + + $view_executable = $view->getExecutable(); + $this->executeView($view_executable); + // By default the rows should now be grouped by target_id. + $this->assertCount(2, $view_executable->result); + } + } diff --git a/core/modules/views/tests/src/Unit/Plugin/field/FieldTest.php b/core/modules/views/tests/src/Unit/Plugin/field/FieldTest.php index 2b929f3..f658f4d 100644 --- a/core/modules/views/tests/src/Unit/Plugin/field/FieldTest.php +++ b/core/modules/views/tests/src/Unit/Plugin/field/FieldTest.php @@ -495,6 +495,71 @@ public function testQueryWithGroupByForBaseField() { /** * @covers ::query */ + public function testQueryWithGroupByForBaseFieldFailure() { + $definition = [ + 'entity_type' => 'test_entity', + 'field_name' => 'title', + ]; + $handler = new EntityField([], 'field', $definition, $this->entityManager, $this->formatterPluginManager, $this->fieldTypePluginManager, $this->languageManager, $this->renderer); + $handler->view = $this->executable; + $handler->view->field = [$handler]; + + $this->setupLanguageRenderer($handler, $definition); + + $field_storage = $this->getBaseFieldStorage(); + $this->entityManager->expects($this->any()) + ->method('getFieldStorageDefinitions') + ->with('test_entity') + ->willReturn([ + 'title' => $field_storage, + ]); + + $table_mapping = $this->getMock('Drupal\Core\Entity\Sql\TableMappingInterface'); + $table_mapping + ->expects($this->any()) + ->method('getFieldColumnName') + ->with($field_storage, 'value') + ->willReturn('title'); + $entity_storage = $this->getMock('Drupal\Core\Entity\Sql\SqlEntityStorageInterface'); + $entity_storage->expects($this->any()) + ->method('getTableMapping') + ->willReturn($table_mapping); + $this->entityManager->expects($this->any()) + ->method('getStorage') + ->with('test_entity') + ->willReturn($entity_storage); + + $options = [ + 'group_column' => NULL, + 'group_columns' => [], + 'table' => 'test_entity_table', + ]; + $handler->init($this->executable, $this->display, $options); + + $query = $this->getMockBuilder('Drupal\views\Plugin\views\query\Sql') + ->disableOriginalConstructor() + ->getMock(); + $query->expects($this->any()) + ->method('ensureTable') + ->with('test_entity_table', NULL) + ->willReturn('test_entity_table'); + // Ensure that we add the title field to the query, if we group by some + // other field in the view. + $query->expects($this->any()) + ->method('addField') + ->with('test_entity_table', 'title'); + + $this->executable->query = $query; + + $handler->query(TRUE); + + $this->assertObjectNotHasAttribute('group_fields', $handler); + $this->assertNull($handler->tableAlias); + } + + /** + * @covers ::query + */ public function testQueryWithGroupByForConfigField() { $definition = [ 'entity_type' => 'test_entity', @@ -555,6 +620,71 @@ public function testQueryWithGroupByForConfigField() { } /** + * @covers ::query + */ + public function testQueryWithGroupByForConfigFieldFailure() { + $definition = [ + 'entity_type' => 'test_entity', + 'field_name' => 'body', + ]; + $handler = new EntityField([], 'field', $definition, $this->entityManager, $this->formatterPluginManager, $this->fieldTypePluginManager, $this->languageManager, $this->renderer); + $handler->view = $this->executable; + $handler->view->field = [$handler]; + + $this->setupLanguageRenderer($handler, $definition); + + $field_storage = $this->getConfigFieldStorage(); + $this->entityManager->expects($this->any()) + ->method('getFieldStorageDefinitions') + ->with('test_entity') + ->willReturn([ + 'body' => $field_storage, + ]); + + $table_mapping = $this->getMock('Drupal\Core\Entity\Sql\TableMappingInterface'); + $table_mapping + ->expects($this->any()) + ->method('getFieldColumnName') + ->with($field_storage, 'value') + ->willReturn('body_value'); + $entity_storage = $this->getMock('Drupal\Core\Entity\Sql\SqlEntityStorageInterface'); + $entity_storage->expects($this->any()) + ->method('getTableMapping') + ->willReturn($table_mapping); + $this->entityManager->expects($this->any()) + ->method('getStorage') + ->with('test_entity') + ->willReturn($entity_storage); + + $options = [ + 'group_column' => NULL, + 'group_columns' => [], + 'table' => 'test_entity__body', + ]; + $handler->init($this->executable, $this->display, $options); + + $query = $this->getMockBuilder('Drupal\views\Plugin\views\query\Sql') + ->disableOriginalConstructor() + ->getMock(); + $query->expects($this->any()) + ->method('ensureTable') + ->with('test_entity__body', NULL) + ->willReturn('test_entity__body'); + // Ensure that we add the title field to the query, if we group by some + // other field in the view. + $query->expects($this->any()) + ->method('addField') + ->with('test_entity__body', 'body_value'); + + $this->executable->query = $query; + + $handler->query(TRUE); + + $this->assertObjectNotHasAttribute('group_fields', $handler); + $this->assertNull($handler->tableAlias); + } + + /** * @covers ::prepareItemsByDelta * * @dataProvider providerTestPrepareItemsByDelta @@ -722,6 +852,60 @@ protected function setupLanguageRenderer(EntityField $handler, $definition) { ->willReturn($entity_type); } + /** + * @covers ::add_field_table + */ + public function testAddAdditionalFieldTable() { + $definition = [ + 'entity_type' => 'test_entity', + 'field_name' => 'body', + ]; + $handler = new EntityField([], 'field', $definition, $this->entityManager, $this->formatterPluginManager, $this->fieldTypePluginManager, $this->languageManager, $this->renderer); + $handler->view = $this->executable; + $handler->view->field = [$handler]; + + $this->setupLanguageRenderer($handler, $definition); + + $field_storage = $this->getConfigFieldStorage(); + $this->entityManager->expects($this->any()) + ->method('getFieldStorageDefinitions') + ->with('test_entity') + ->willReturn([ + 'body' => $field_storage, + ]); + + $table_mapping = $this->getMock('Drupal\Core\Entity\Sql\TableMappingInterface'); + $table_mapping + ->expects($this->any()) + ->method('getFieldColumnName') + ->with($field_storage, 'value') + ->willReturn('body_value'); + $entity_storage = $this->getMock('Drupal\Core\Entity\Sql\SqlEntityStorageInterface'); + $entity_storage->expects($this->any()) + ->method('getTableMapping') + ->willReturn($table_mapping); + $this->entityManager->expects($this->any()) + ->method('getStorage') + ->with('test_entity') + ->willReturn($entity_storage); + + $options = [ + 'group_column' => NULL, + 'group_columns' => [], + 'table' => 'test_entity__body', + ]; + $handler->init($this->executable, $this->display, $options); + $handler->query = $this->getMockBuilder('Drupal\views\Plugin\views\query\Sql') + ->disableOriginalConstructor() + ->getMock(); + + $handler->additional_fields = ['alt', 'title']; + $handler->query(TRUE); + + $this->assertEmpty($handler->tableAlias); + $this->assertEmpty($handler->aliases); + } + } class FieldTestEntityField extends EntityField { diff --git a/core/modules/views/views.post_update.php b/core/modules/views/views.post_update.php index a4da940..f9cc3a4 100644 --- a/core/modules/views/views.post_update.php +++ b/core/modules/views/views.post_update.php @@ -5,6 +5,7 @@ * Post update functions for Views. */ +use Drupal\Core\Entity\EntityFieldManager; use Drupal\Core\StringTranslation\TranslatableMarkup; use Drupal\views\Entity\View; use Drupal\views\Views; @@ -239,3 +240,57 @@ function views_post_update_boolean_filter_values() { /** * @} End of "addtogroup updates-8.2.x". */ + +/** + * @addtogroup updates-8.3.x + * @{ + */ + +/** + * Fix views containing entity fields with an empty group column value set. + */ +function views_post_update_empty_entity_field_group_column() { + $views = View::loadMultiple(); + /** @var \Drupal\Core\Entity\EntityFieldManagerInterface $entity_field_manager */ + $entity_field_manager = \Drupal::service('entity_field.manager'); + + array_walk($views, function(View $view) use ($entity_field_manager) { + $save = FALSE; + $displays = $view->get('display'); + foreach ($displays as $display_name => &$display) { + if (isset($display['display_options']['fields'])) { + foreach ($display['display_options']['fields'] as $field_name => &$field) { + // Only update fields that have group_column set to an empty value. + if (!empty($field['plugin_id']) && $field['plugin_id'] == 'field' && isset($field['group_column']) && empty($field['group_column'])) { + // Attempt to load the field storage definition of the field. + $executable = $view->getExecutable(); + $executable->setDisplay($display_name); + /** @var \Drupal\views\Plugin\views\field\FieldHandlerInterface $field_handler */ + $field_handler = $executable->getDisplay()->getHandler('field', $field['id']); + if ($entity_type_id = $field_handler->getEntityType()) { + $field_storage_definitions = $entity_field_manager->getFieldStorageDefinitions($entity_type_id); + + $field_storage = NULL; + if (isset($field['field']) && isset($field_storage_definitions[$field['field']])) { + $field_storage = $field_storage_definitions[$field['field']]; + } + // If a main property is defined use that as a default. + if (!empty($field_storage) && $field_storage->getMainPropertyName()) { + $field['group_column'] = $field_storage->getMainPropertyName(); + $save = TRUE; + } + } + } + } + } + } + if ($save) { + $view->set('display', $displays); + $view->save(); + } + }); +} + +/** + * @} End of "addtogroup updates-8.3.x". + */