Chris@16: <?php
Chris@16: 
Chris@16: namespace Drupal\Tests\image\Functional;
Chris@16: 
Chris@16: use Drupal\Core\Entity\Entity\EntityViewDisplay;
Chris@16: use Drupal\field\Entity\FieldConfig;
Chris@16: use Drupal\file\Entity\File;
Chris@16: use Drupal\field\Entity\FieldStorageConfig;
Chris@16: use Drupal\Tests\EntityViewTrait;
Chris@16: use Drupal\Tests\TestFileCreationTrait;
Chris@16: 
Chris@16: /**
Chris@16:  * Tests setting up default images both to the field and field storage.
Chris@16:  *
Chris@16:  * @group image
Chris@16:  */
Chris@16: class ImageFieldDefaultImagesTest extends ImageFieldTestBase {
Chris@16: 
Chris@16:   use TestFileCreationTrait {
Chris@16:     getTestFiles as drupalGetTestFiles;
Chris@16:     compareFiles as drupalCompareFiles;
Chris@16:   }
Chris@16:   use EntityViewTrait {
Chris@16:     buildEntityView as drupalBuildEntityView;
Chris@16:   }
Chris@16: 
Chris@16:   /**
Chris@16:    * Modules to enable.
Chris@16:    *
Chris@16:    * @var array
Chris@16:    */
Chris@16:   public static $modules = ['field_ui'];
Chris@16: 
Chris@16:   /**
Chris@16:    * Tests CRUD for fields and field storages with default images.
Chris@16:    */
Chris@16:   public function testDefaultImages() {
Chris@16:     $node_storage = $this->container->get('entity.manager')->getStorage('node');
Chris@16:     // Create files to use as the default images.
Chris@16:     $files = $this->drupalGetTestFiles('image');
Chris@16:     // Create 10 files so the default image fids are not a single value.
Chris@16:     for ($i = 1; $i <= 10; $i++) {
Chris@16:       $filename = $this->randomMachineName() . "$i";
Chris@16:       $desired_filepath = 'public://' . $filename;
Chris@18:       \Drupal::service('file_system')->copy($files[0]->uri, $desired_filepath, FILE_EXISTS_ERROR);
Chris@16:       $file = File::create(['uri' => $desired_filepath, 'filename' => $filename, 'name' => $filename]);
Chris@16:       $file->save();
Chris@16:     }
Chris@16:     $default_images = [];
Chris@16:     foreach (['field_storage', 'field', 'field2', 'field_storage_new', 'field_new', 'field_storage_private', 'field_private'] as $image_target) {
Chris@16:       $file = File::create((array) array_pop($files));
Chris@16:       $file->save();
Chris@16:       $default_images[$image_target] = $file;
Chris@16:     }
Chris@16: 
Chris@16:     // Create an image field storage and add a field to the article content
Chris@16:     // type.
Chris@16:     $field_name = strtolower($this->randomMachineName());
Chris@16:     $storage_settings['default_image'] = [
Chris@16:       'uuid' => $default_images['field_storage']->uuid(),
Chris@16:       'alt' => '',
Chris@16:       'title' => '',
Chris@16:       'width' => 0,
Chris@16:       'height' => 0,
Chris@16:     ];
Chris@16:     $field_settings['default_image'] = [
Chris@16:       'uuid' => $default_images['field']->uuid(),
Chris@16:       'alt' => '',
Chris@16:       'title' => '',
Chris@16:       'width' => 0,
Chris@16:       'height' => 0,
Chris@16:     ];
Chris@16:     $widget_settings = [
Chris@16:       'preview_image_style' => 'medium',
Chris@16:     ];
Chris@16:     $field = $this->createImageField($field_name, 'article', $storage_settings, $field_settings, $widget_settings);
Chris@16: 
Chris@16:     // The field default image id should be 2.
Chris@16:     $this->assertEqual($field->getSetting('default_image')['uuid'], $default_images['field']->uuid());
Chris@16: 
Chris@16:     // Also test \Drupal\field\Entity\FieldConfig::getSettings().
Chris@16:     $this->assertEqual($field->getSettings()['default_image']['uuid'], $default_images['field']->uuid());
Chris@16: 
Chris@16:     $field_storage = $field->getFieldStorageDefinition();
Chris@16: 
Chris@16:     // The field storage default image id should be 1.
Chris@16:     $this->assertEqual($field_storage->getSetting('default_image')['uuid'], $default_images['field_storage']->uuid());
Chris@16: 
Chris@16:     // Also test \Drupal\field\Entity\FieldStorageConfig::getSettings().
Chris@16:     $this->assertEqual($field_storage->getSettings()['default_image']['uuid'], $default_images['field_storage']->uuid());
Chris@16: 
Chris@16:     // Add another field with another default image to the page content type.
Chris@16:     $field2 = FieldConfig::create([
Chris@16:       'field_storage' => $field_storage,
Chris@16:       'bundle' => 'page',
Chris@16:       'label' => $field->label(),
Chris@16:       'required' => $field->isRequired(),
Chris@16:       'settings' => [
Chris@16:         'default_image' => [
Chris@16:           'uuid' => $default_images['field2']->uuid(),
Chris@16:           'alt' => '',
Chris@16:           'title' => '',
Chris@16:           'width' => 0,
Chris@16:           'height' => 0,
Chris@16:         ],
Chris@16:       ],
Chris@16:     ]);
Chris@16:     $field2->save();
Chris@16: 
Chris@16:     $widget_settings = entity_get_form_display('node', $field->getTargetBundle(), 'default')->getComponent($field_name);
Chris@16:     entity_get_form_display('node', 'page', 'default')
Chris@16:       ->setComponent($field_name, $widget_settings)
Chris@16:       ->save();
Chris@16:     entity_get_display('node', 'page', 'default')
Chris@16:       ->setComponent($field_name)
Chris@16:       ->save();
Chris@16: 
Chris@16:     // Confirm the defaults are present on the article field storage settings
Chris@16:     // form.
Chris@16:     $field_id = $field->id();
Chris@16:     $this->drupalGet("admin/structure/types/manage/article/fields/$field_id/storage");
Chris@16:     $this->assertFieldByXpath(
Chris@16:       '//input[@name="settings[default_image][uuid][fids]"]',
Chris@16:       $default_images['field_storage']->id(),
Chris@16:       format_string(
Chris@16:         'Article image field storage default equals expected file ID of @fid.',
Chris@16:         ['@fid' => $default_images['field_storage']->id()]
Chris@16:       )
Chris@16:     );
Chris@16:     // Confirm the defaults are present on the article field edit form.
Chris@16:     $this->drupalGet("admin/structure/types/manage/article/fields/$field_id");
Chris@16:     $this->assertFieldByXpath(
Chris@16:       '//input[@name="settings[default_image][uuid][fids]"]',
Chris@16:       $default_images['field']->id(),
Chris@16:       format_string(
Chris@16:         'Article image field default equals expected file ID of @fid.',
Chris@16:         ['@fid' => $default_images['field']->id()]
Chris@16:       )
Chris@16:     );
Chris@16: 
Chris@16:     // Confirm the defaults are present on the page field storage settings form.
Chris@16:     $this->drupalGet("admin/structure/types/manage/page/fields/$field_id/storage");
Chris@16:     $this->assertFieldByXpath(
Chris@16:       '//input[@name="settings[default_image][uuid][fids]"]',
Chris@16:       $default_images['field_storage']->id(),
Chris@16:       format_string(
Chris@16:         'Page image field storage default equals expected file ID of @fid.',
Chris@16:         ['@fid' => $default_images['field_storage']->id()]
Chris@16:       )
Chris@16:     );
Chris@16:     // Confirm the defaults are present on the page field edit form.
Chris@16:     $field2_id = $field2->id();
Chris@16:     $this->drupalGet("admin/structure/types/manage/page/fields/$field2_id");
Chris@16:     $this->assertFieldByXpath(
Chris@16:       '//input[@name="settings[default_image][uuid][fids]"]',
Chris@16:       $default_images['field2']->id(),
Chris@16:       format_string(
Chris@16:         'Page image field default equals expected file ID of @fid.',
Chris@16:         ['@fid' => $default_images['field2']->id()]
Chris@16:       )
Chris@16:     );
Chris@16: 
Chris@16:     // Confirm that the image default is shown for a new article node.
Chris@16:     $article = $this->drupalCreateNode(['type' => 'article']);
Chris@16:     $article_built = $this->drupalBuildEntityView($article);
Chris@16:     $this->assertEqual(
Chris@16:       $article_built[$field_name][0]['#item']->target_id,
Chris@16:       $default_images['field']->id(),
Chris@16:       format_string(
Chris@16:         'A new article node without an image has the expected default image file ID of @fid.',
Chris@16:         ['@fid' => $default_images['field']->id()]
Chris@16:       )
Chris@16:     );
Chris@16: 
Chris@16:     // Also check that the field renders without warnings when the label is
Chris@16:     // hidden.
Chris@16:     EntityViewDisplay::load('node.article.default')
Chris@16:       ->setComponent($field_name, ['label' => 'hidden', 'type' => 'image'])
Chris@16:       ->save();
Chris@16:     $this->drupalGet('node/' . $article->id());
Chris@16: 
Chris@16:     // Confirm that the image default is shown for a new page node.
Chris@16:     $page = $this->drupalCreateNode(['type' => 'page']);
Chris@16:     $page_built = $this->drupalBuildEntityView($page);
Chris@16:     $this->assertEqual(
Chris@16:       $page_built[$field_name][0]['#item']->target_id,
Chris@16:       $default_images['field2']->id(),
Chris@16:       format_string(
Chris@16:         'A new page node without an image has the expected default image file ID of @fid.',
Chris@16:         ['@fid' => $default_images['field2']->id()]
Chris@16:       )
Chris@16:     );
Chris@16: 
Chris@16:     // Upload a new default for the field storage.
Chris@16:     $default_image_settings = $field_storage->getSetting('default_image');
Chris@16:     $default_image_settings['uuid'] = $default_images['field_storage_new']->uuid();
Chris@16:     $field_storage->setSetting('default_image', $default_image_settings);
Chris@16:     $field_storage->save();
Chris@16: 
Chris@16:     // Confirm that the new default is used on the article field storage
Chris@16:     // settings form.
Chris@16:     $this->drupalGet("admin/structure/types/manage/article/fields/$field_id/storage");
Chris@16:     $this->assertFieldByXpath(
Chris@16:       '//input[@name="settings[default_image][uuid][fids]"]',
Chris@16:       $default_images['field_storage_new']->id(),
Chris@16:       format_string(
Chris@16:         'Updated image field storage default equals expected file ID of @fid.',
Chris@16:         ['@fid' => $default_images['field_storage_new']->id()]
Chris@16:       )
Chris@16:     );
Chris@16: 
Chris@16:     // Reload the nodes and confirm the field defaults are used.
Chris@16:     $node_storage->resetCache([$article->id(), $page->id()]);
Chris@16:     $article_built = $this->drupalBuildEntityView($article = $node_storage->load($article->id()));
Chris@16:     $page_built = $this->drupalBuildEntityView($page = $node_storage->load($page->id()));
Chris@16:     $this->assertEqual(
Chris@16:       $article_built[$field_name][0]['#item']->target_id,
Chris@16:       $default_images['field']->id(),
Chris@16:       format_string(
Chris@16:         'An existing article node without an image has the expected default image file ID of @fid.',
Chris@16:         ['@fid' => $default_images['field']->id()]
Chris@16:       )
Chris@16:     );
Chris@16:     $this->assertEqual(
Chris@16:       $page_built[$field_name][0]['#item']->target_id,
Chris@16:       $default_images['field2']->id(),
Chris@16:       format_string(
Chris@16:         'An existing page node without an image has the expected default image file ID of @fid.',
Chris@16:         ['@fid' => $default_images['field2']->id()]
Chris@16:       )
Chris@16:     );
Chris@16: 
Chris@16:     // Upload a new default for the article's field.
Chris@16:     $default_image_settings = $field->getSetting('default_image');
Chris@16:     $default_image_settings['uuid'] = $default_images['field_new']->uuid();
Chris@16:     $field->setSetting('default_image', $default_image_settings);
Chris@16:     $field->save();
Chris@16: 
Chris@16:     // Confirm the new field default is used on the article field admin form.
Chris@16:     $this->drupalGet("admin/structure/types/manage/article/fields/$field_id");
Chris@16:     $this->assertFieldByXpath(
Chris@16:       '//input[@name="settings[default_image][uuid][fids]"]',
Chris@16:       $default_images['field_new']->id(),
Chris@16:       format_string(
Chris@16:         'Updated article image field default equals expected file ID of @fid.',
Chris@16:         ['@fid' => $default_images['field_new']->id()]
Chris@16:       )
Chris@16:     );
Chris@16: 
Chris@16:     // Reload the nodes.
Chris@16:     $node_storage->resetCache([$article->id(), $page->id()]);
Chris@16:     $article_built = $this->drupalBuildEntityView($article = $node_storage->load($article->id()));
Chris@16:     $page_built = $this->drupalBuildEntityView($page = $node_storage->load($page->id()));
Chris@16: 
Chris@16:     // Confirm the article uses the new default.
Chris@16:     $this->assertEqual(
Chris@16:       $article_built[$field_name][0]['#item']->target_id,
Chris@16:       $default_images['field_new']->id(),
Chris@16:       format_string(
Chris@16:         'An existing article node without an image has the expected default image file ID of @fid.',
Chris@16:         ['@fid' => $default_images['field_new']->id()]
Chris@16:       )
Chris@16:     );
Chris@16:     // Confirm the page remains unchanged.
Chris@16:     $this->assertEqual(
Chris@16:       $page_built[$field_name][0]['#item']->target_id,
Chris@16:       $default_images['field2']->id(),
Chris@16:       format_string(
Chris@16:         'An existing page node without an image has the expected default image file ID of @fid.',
Chris@16:         ['@fid' => $default_images['field2']->id()]
Chris@16:       )
Chris@16:     );
Chris@16: 
Chris@16:     // Confirm the default image is shown on the node form.
Chris@16:     $file = File::load($default_images['field_new']->id());
Chris@16:     $this->drupalGet('node/add/article');
Chris@16:     $this->assertRaw($file->getFilename());
Chris@16: 
Chris@16:     // Remove the field default from articles.
Chris@16:     $default_image_settings = $field->getSetting('default_image');
Chris@16:     $default_image_settings['uuid'] = 0;
Chris@16:     $field->setSetting('default_image', $default_image_settings);
Chris@16:     $field->save();
Chris@16: 
Chris@16:     // Confirm the article field default has been removed.
Chris@16:     $this->drupalGet("admin/structure/types/manage/article/fields/$field_id");
Chris@16:     $this->assertFieldByXpath(
Chris@16:       '//input[@name="settings[default_image][uuid][fids]"]',
Chris@16:       '',
Chris@16:       'Updated article image field default has been successfully removed.'
Chris@16:     );
Chris@16: 
Chris@16:     // Reload the nodes.
Chris@16:     $node_storage->resetCache([$article->id(), $page->id()]);
Chris@16:     $article_built = $this->drupalBuildEntityView($article = $node_storage->load($article->id()));
Chris@16:     $page_built = $this->drupalBuildEntityView($page = $node_storage->load($page->id()));
Chris@16:     // Confirm the article uses the new field storage (not field) default.
Chris@16:     $this->assertEqual(
Chris@16:       $article_built[$field_name][0]['#item']->target_id,
Chris@16:       $default_images['field_storage_new']->id(),
Chris@16:       format_string(
Chris@16:         'An existing article node without an image has the expected default image file ID of @fid.',
Chris@16:         ['@fid' => $default_images['field_storage_new']->id()]
Chris@16:       )
Chris@16:     );
Chris@16:     // Confirm the page remains unchanged.
Chris@16:     $this->assertEqual(
Chris@16:       $page_built[$field_name][0]['#item']->target_id,
Chris@16:       $default_images['field2']->id(),
Chris@16:       format_string(
Chris@16:         'An existing page node without an image has the expected default image file ID of @fid.',
Chris@16:         ['@fid' => $default_images['field2']->id()]
Chris@16:       )
Chris@16:     );
Chris@16: 
Chris@16:     $non_image = $this->drupalGetTestFiles('text');
Chris@16:     $this->drupalPostForm(NULL, ['files[settings_default_image_uuid]' => \Drupal::service('file_system')->realpath($non_image[0]->uri)], t("Upload"));
Chris@16:     $this->assertText('The specified file text-0.txt could not be uploaded.');
Chris@16:     $this->assertText('Only files with the following extensions are allowed: png gif jpg jpeg.');
Chris@16: 
Chris@16:     // Confirm the default image is shown on the node form.
Chris@16:     $file = File::load($default_images['field_storage_new']->id());
Chris@16:     $this->drupalGet('node/add/article');
Chris@16:     $this->assertRaw($file->getFilename());
Chris@16: 
Chris@16:     // Change the default image for the field storage and also change the upload
Chris@16:     // destination to the private filesystem at the same time.
Chris@16:     $default_image_settings = $field_storage->getSetting('default_image');
Chris@16:     $default_image_settings['uuid'] = $default_images['field_storage_private']->uuid();
Chris@16:     $field_storage->setSetting('default_image', $default_image_settings);
Chris@16:     $field_storage->setSetting('uri_scheme', 'private');
Chris@16:     $field_storage->save();
Chris@16: 
Chris@16:     // Confirm that the new default is used on the article field storage
Chris@16:     // settings form.
Chris@16:     $this->drupalGet("admin/structure/types/manage/article/fields/$field_id/storage");
Chris@16:     $this->assertFieldByXpath(
Chris@16:       '//input[@name="settings[default_image][uuid][fids]"]',
Chris@16:       $default_images['field_storage_private']->id(),
Chris@16:       format_string(
Chris@16:         'Updated image field storage default equals expected file ID of @fid.',
Chris@16:         ['@fid' => $default_images['field_storage_private']->id()]
Chris@16:       )
Chris@16:     );
Chris@16: 
Chris@16:     // Upload a new default for the article's field after setting the field
Chris@16:     // storage upload destination to 'private'.
Chris@16:     $default_image_settings = $field->getSetting('default_image');
Chris@16:     $default_image_settings['uuid'] = $default_images['field_private']->uuid();
Chris@16:     $field->setSetting('default_image', $default_image_settings);
Chris@16:     $field->save();
Chris@16: 
Chris@16:     // Confirm the new field field default is used on the article field
Chris@16:     // admin form.
Chris@16:     $this->drupalGet("admin/structure/types/manage/article/fields/$field_id");
Chris@16:     $this->assertFieldByXpath(
Chris@16:       '//input[@name="settings[default_image][uuid][fids]"]',
Chris@16:       $default_images['field_private']->id(),
Chris@16:       format_string(
Chris@16:         'Updated article image field default equals expected file ID of @fid.',
Chris@16:         ['@fid' => $default_images['field_private']->id()]
Chris@16:       )
Chris@16:     );
Chris@16:   }
Chris@16: 
Chris@16:   /**
Chris@16:    * Tests image field and field storage having an invalid default image.
Chris@16:    */
Chris@16:   public function testInvalidDefaultImage() {
Chris@16:     $field_storage = FieldStorageConfig::create([
Chris@17:       'field_name' => mb_strtolower($this->randomMachineName()),
Chris@16:       'entity_type' => 'node',
Chris@16:       'type' => 'image',
Chris@16:       'settings' => [
Chris@16:         'default_image' => [
Chris@16:           'uuid' => 100000,
Chris@17:         ],
Chris@16:       ],
Chris@16:     ]);
Chris@16:     $field_storage->save();
Chris@16:     $settings = $field_storage->getSettings();
Chris@16:     // The non-existent default image should not be saved.
Chris@16:     $this->assertNull($settings['default_image']['uuid']);
Chris@16: 
Chris@16:     $field = FieldConfig::create([
Chris@16:       'field_storage' => $field_storage,
Chris@16:       'bundle' => 'page',
Chris@16:       'label' => $this->randomMachineName(),
Chris@16:       'settings' => [
Chris@16:         'default_image' => [
Chris@16:           'uuid' => 100000,
Chris@17:         ],
Chris@16:       ],
Chris@16:     ]);
Chris@16:     $field->save();
Chris@16:     $settings = $field->getSettings();
Chris@16:     // The non-existent default image should not be saved.
Chris@16:     $this->assertNull($settings['default_image']['uuid']);
Chris@16:   }
Chris@16: 
Chris@16: }