', + ], + 'label' => [ + '#type' => 'item', + '#prefix' => '', + '#markup' => \Drupal::translation()->translate('It is not possible to save this @entity_type_label.', ['@entity_type_label' => $entity->getEntityType()->getLabel()]), + '#suffix' => '', + ], + 'message' => [ + '#type' => 'item', + '#markup' => \Drupal::translation()->translate('Publish or delete the latest draft revision to allow all workflow transitions.', ['@latest_revision_edit_url' => $latest_revision->toUrl('edit-form', ['language' => $latest_revision->language()])->toString(), '@latest_revision_delete_url' => $latest_revision->toUrl('delete-form', ['language' => $latest_revision->language()])->toString()]), + ], + '#weight' => 999, + '#no_valid_transitions' => TRUE, + ]; + } + // Submit handler to redirect to the latest version, if available. $form['actions']['submit']['#submit'][] = [EntityTypeInfo::class, 'bundleFormRedirect']; } @@ -366,6 +334,23 @@ public function formAlter(array &$form, FormStateInterface $form_state, $form_id } /** + * @param \Drupal\Core\Entity\EntityInterface $entity + * @return \Drupal\Core\Entity\EntityInterface + */ + protected function getTranslationAffectedRevision(EntityInterface $entity) { + if ($entity->isRevisionTranslationAffected()) { + return $entity; + } + /** @var \Drupal\Core\Language\LanguageInterface $language */ + foreach ($entity->getTranslationLanguages() as $language) { + $translation = $entity->getTranslation($language->getId()); + if ($translation->isRevisionTranslationAffected()) { + return $translation; + } + } + } + + /** * Redirect content entity edit forms on save, if there is a forward revision. * * When saving their changes, editors should see those changes displayed on diff --git a/core/modules/content_moderation/src/Form/BundleModerationConfigurationForm.php b/core/modules/content_moderation/src/Form/BundleModerationConfigurationForm.php deleted file mode 100644 index 917ec5deda..0000000000 --- a/core/modules/content_moderation/src/Form/BundleModerationConfigurationForm.php +++ /dev/null @@ -1,155 +0,0 @@ -entityTypeManager = $entity_type_manager; - } - - /** - * {@inheritdoc} - */ - public static function create(ContainerInterface $container) { - return new static($container->get('entity_type.manager')); - } - - /** - * {@inheritdoc} - * - * Blank out the base form ID so that form alters that use the base form ID to - * target both add and edit forms don't pick up this form. - */ - public function getBaseFormId() { - return NULL; - } - - /** - * {@inheritdoc} - */ - public function form(array $form, FormStateInterface $form_state) { - /* @var \Drupal\Core\Config\Entity\ConfigEntityInterface $bundle */ - $bundle = $this->getEntity(); - $bundle_of_entity_type = $this->entityTypeManager->getDefinition($bundle->getEntityType()->getBundleOf()); - /* @var \Drupal\workflows\WorkflowInterface[] $workflows */ - $workflows = $this->entityTypeManager->getStorage('workflow')->loadMultiple(); - - $options = array_map(function (WorkflowInterface $workflow) { - return $workflow->label(); - }, array_filter($workflows, function (WorkflowInterface $workflow) { - return $workflow->status() && $workflow->getTypePlugin() instanceof ContentModeration; - })); - - $selected_workflow = array_reduce($workflows, function ($carry, WorkflowInterface $workflow) use ($bundle_of_entity_type, $bundle) { - $plugin = $workflow->getTypePlugin(); - if ($plugin instanceof ContentModeration && $plugin->appliesToEntityTypeAndBundle($bundle_of_entity_type->id(), $bundle->id())) { - return $workflow->id(); - } - return $carry; - }); - $form['workflow'] = [ - '#type' => 'select', - '#title' => $this->t('Select the workflow to apply'), - '#default_value' => $selected_workflow, - '#options' => $options, - '#required' => FALSE, - '#empty_value' => '', - ]; - - $form['original_workflow'] = [ - '#type' => 'value', - '#value' => $selected_workflow, - ]; - - $form['bundle'] = [ - '#type' => 'value', - '#value' => $bundle->id(), - ]; - - $form['entity_type'] = [ - '#type' => 'value', - '#value' => $bundle_of_entity_type->id(), - ]; - - // Add a special message when moderation is being disabled. - if ($selected_workflow) { - $form['enable_workflow_note'] = [ - '#type' => 'item', - '#description' => $this->t('After disabling moderation, any existing forward drafts will be accessible via the "Revisions" tab.'), - '#access' => !empty($selected_workflow) - ]; - } - - return parent::form($form, $form_state); - } - - /** - * {@inheritdoc} - */ - public function submitForm(array &$form, FormStateInterface $form_state) { - // If moderation is enabled, revisions MUST be enabled as well. Otherwise we - // can't have forward revisions. - drupal_set_message($this->t('Your settings have been saved.')); - } - - /** - * {@inheritdoc} - */ - public function save(array $form, FormStateInterface $form_state) { - $entity_type_id = $form_state->getValue('entity_type'); - $bundle_id = $form_state->getValue('bundle'); - $new_workflow_id = $form_state->getValue('workflow'); - $original_workflow_id = $form_state->getValue('original_workflow'); - if ($new_workflow_id === $original_workflow_id) { - // Nothing to do. - return; - } - if ($original_workflow_id) { - /* @var \Drupal\workflows\WorkflowInterface $workflow */ - $workflow = $this->entityTypeManager->getStorage('workflow')->load($original_workflow_id); - $workflow->getTypePlugin()->removeEntityTypeAndBundle($entity_type_id, $bundle_id); - $workflow->save(); - } - if ($new_workflow_id) { - /* @var \Drupal\workflows\WorkflowInterface $workflow */ - $workflow = $this->entityTypeManager->getStorage('workflow')->load($new_workflow_id); - $workflow->getTypePlugin()->addEntityTypeAndBundle($entity_type_id, $bundle_id); - $workflow->save(); - } - } - - /** - * {@inheritdoc} - */ - protected function actions(array $form, FormStateInterface $form_state) { - $actions['submit'] = [ - '#type' => 'submit', - '#value' => $this->t('Save'), - '#submit' => ['::submitForm', '::save'], - ]; - - return $actions; - } - -} diff --git a/core/modules/content_moderation/src/Form/WorkflowTypeEditForm.php b/core/modules/content_moderation/src/Form/WorkflowTypeEditForm.php new file mode 100644 index 0000000000..b1fe98cfde --- /dev/null +++ b/core/modules/content_moderation/src/Form/WorkflowTypeEditForm.php @@ -0,0 +1,201 @@ +get('entity_type.manager'), + $container->get('entity_type.bundle.info'), + $container->get('content_moderation.moderation_information') + ); + } + + /** + * {@inheritdoc} + */ + public function __construct(EntityTypeManagerInterface $entity_type_manager, EntityTypeBundleInfoInterface $bundle_info , ModerationInformationInterface $moderation_information) { + $this->entityTypeManager = $entity_type_manager; + $this->bundleInfo = $bundle_info; + $this->moderationInformation = $moderation_information; + } + + /** + * {@inheritdoc} + */ + public function getFormId() { + return 'workflow_type_edit_form'; + } + + /** + * {@inheritdoc} + */ + public function buildForm(array $form, FormStateInterface $form_state, WorkflowInterface $workflow = NULL, $entity_type_id = NULL) { + $this->workflow = $workflow; + try { + $this->entityType = $this->entityTypeManager->getDefinition($entity_type_id); + } + catch (PluginNotFoundException $e) { + throw new NotFoundHttpException(); + } + + $options = $defaults = []; + foreach ($this->bundleInfo->getBundleInfo($this->entityType->id()) as $bundle_id => $bundle) { + // Check if moderation is enabled for this bundle on any workflow. + $moderation_enabled = $this->moderationInformation->shouldModerateEntitiesOfBundle($this->entityType, $bundle_id); + // Check if moderation is enabled for this bundle on this workflow. + $workflow_moderation_enabled = $this->workflow->getTypePlugin()->appliesToEntityTypeAndBundle($this->entityType->id(), $bundle_id); + // Only show bundles that are not enabled anywhere, or enabled on this + // workflow. + if (!$moderation_enabled || $workflow_moderation_enabled) { + // Add the bundle to the options if it's not enabled on a workflow, + // unless the workflow it's enabled on is this one. + $options[$bundle_id] = [ + 'type' => $bundle['label'], + ]; + // Add the bundle to the list of default values if it's enabled on this + // workflow. + $defaults[$bundle_id] = $workflow_moderation_enabled; + } + } + + if (!empty($options)) { + $bundles_header = $this->t('All @entity_type types', ['@entity_type' => $this->entityType->getLabel()]); + if ($bundle_entity_type_id = $this->entityType->getBundleEntityType()) { + $bundles_header = $this->t('All @entity_type_plural_label', ['@entity_type_plural_label' => $this->entityTypeManager->getDefinition($bundle_entity_type_id)->getPluralLabel()]); + } + $form['bundles'] = [ + '#type' => 'tableselect', + '#header' => [ + 'type' => $bundles_header, + ], + '#options' => $options, + '#default_value' => $defaults, + '#attributes' => ['class' => ['no-highlight']], + ]; + } + + $form['actions'] = ['#type' => 'actions']; + $form['actions']['submit'] = [ + '#type' => 'submit', + '#button_type' => 'primary', + '#value' => $this->t('Save'), + '#ajax' => [ + 'callback' => [$this, 'ajaxcallback'], + ], + ]; + $form['actions']['cancel'] = [ + '#type' => 'button', + '#value' => $this->t('Cancel'), + '#ajax' => [ + 'callback' => [$this, 'ajaxcallback'], + ], + ]; + + return $form; + } + + /** + * {@inheritdoc} + */ + public function submitForm(array &$form, FormStateInterface $form_state) { + foreach ($form_state->getValue('bundles') as $bundle_id => $checked) { + if ($checked) { + $this->workflow->getTypePlugin()->addEntityTypeAndBundle($this->entityType->id(), $bundle_id); + } + else { + $this->workflow->getTypePlugin()->removeEntityTypeAndBundle($this->entityType->id(), $bundle_id); + } + } + $this->workflow->save(); + } + + /** + * Ajax callback to close the modal and update the selected text. + * + * @return \Drupal\Core\Ajax\AjaxResponse + * An ajax response object. + */ + public function ajaxCallback() { + $selected_bundles = []; + foreach ($this->bundleInfo->getBundleInfo($this->entityType->id()) as $bundle_id => $bundle) { + if ($this->workflow->getTypePlugin()->appliesToEntityTypeAndBundle($this->entityType->id(), $bundle_id)) { + $selected_bundles[$bundle_id] = $bundle['label']; + } + } + $response = new AjaxResponse(); + $response->addCommand(new CloseDialogCommand()); + $response->addCommand(new HtmlCommand('#selected-' . $this->entityType->id(), !empty($selected_bundles) ? implode(', ', $selected_bundles) : $this->t('none'))); + return $response; + } + + /** + * Route title callback. + */ + public function getTitle(WorkflowInterface $workflow = NULL, $entity_type_id) { + $this->entityType = $this->entityTypeManager->getDefinition($entity_type_id); + + $title = $this->t('Select the @entity_type types for the @workflow', ['@entity_type' => $this->entityType->getLabel(), '@workflow' => $workflow->label()]); + if ($bundle_entity_type_id = $this->entityType->getBundleEntityType()) { + $title = $this->t('Select the @entity_type_plural_label for the @workflow', ['@entity_type_plural_label' => $this->entityTypeManager->getDefinition($bundle_entity_type_id)->getPluralLabel(), '@workflow' => $workflow->label()]); + } + + return $title; + } + +} diff --git a/core/modules/content_moderation/src/ParamConverter/EntityRevisionConverter.php b/core/modules/content_moderation/src/ParamConverter/EntityRevisionConverter.php index eac1913fca..786d45f23d 100644 --- a/core/modules/content_moderation/src/ParamConverter/EntityRevisionConverter.php +++ b/core/modules/content_moderation/src/ParamConverter/EntityRevisionConverter.php @@ -92,13 +92,12 @@ public function convert($value, $definition, $name, array $defaults) { $entity_type_id = $this->getEntityTypeFromDefaults($definition, $name, $defaults); $latest_revision = $this->moderationInformation->getLatestRevision($entity_type_id, $value); - // If the entity type is translatable, ensure we return the proper - // translation object for the current context. - if ($latest_revision instanceof EntityInterface && $entity instanceof TranslatableInterface) { - $latest_revision = $this->entityManager->getTranslationFromContext($latest_revision, NULL, ['operation' => 'entity_upcast']); - } - - if ($latest_revision instanceof EntityInterface && $latest_revision->isRevisionTranslationAffected()) { + if ($latest_revision instanceof EntityInterface) { + // If the entity type is translatable, ensure we return the proper + // translation object for the current context. + if ($entity instanceof TranslatableInterface) { + $latest_revision = $this->entityManager->getTranslationFromContext($latest_revision, NULL, ['operation' => 'entity_upcast']); + } $entity = $latest_revision; } } diff --git a/core/modules/content_moderation/src/Plugin/Derivative/DynamicLocalTasks.php b/core/modules/content_moderation/src/Plugin/Derivative/DynamicLocalTasks.php index 7ff1fa5da5..9f09a9a890 100644 --- a/core/modules/content_moderation/src/Plugin/Derivative/DynamicLocalTasks.php +++ b/core/modules/content_moderation/src/Plugin/Derivative/DynamicLocalTasks.php @@ -76,19 +76,6 @@ public static function create(ContainerInterface $container, $base_plugin_id) { public function getDerivativeDefinitions($base_plugin_definition) { $this->derivatives = []; - foreach ($this->entityTypeManager->getDefinitions() as $entity_type_id => $entity_type) { - if ($this->moderationInfo->canModerateEntitiesOfEntityType($entity_type)) { - $bundle_id = $entity_type->getBundleEntityType(); - $this->derivatives["$bundle_id.moderation_tab"] = [ - 'route_name' => "entity.$bundle_id.moderation", - 'title' => $this->t('Manage moderation'), - // @todo - are we sure they all have an edit_form? - 'base_route' => "entity.$bundle_id.edit_form", - 'weight' => 30, - ] + $base_plugin_definition; - } - } - $latest_version_entities = array_filter($this->entityTypeManager->getDefinitions(), function (EntityTypeInterface $type) { return $this->moderationInfo->canModerateEntitiesOfEntityType($type) && $type->hasLinkTemplate('latest-version'); }); diff --git a/core/modules/content_moderation/src/Plugin/Field/FieldWidget/ModerationStateWidget.php b/core/modules/content_moderation/src/Plugin/Field/FieldWidget/ModerationStateWidget.php index ab5a561360..74e305209c 100644 --- a/core/modules/content_moderation/src/Plugin/Field/FieldWidget/ModerationStateWidget.php +++ b/core/modules/content_moderation/src/Plugin/Field/FieldWidget/ModerationStateWidget.php @@ -110,7 +110,6 @@ public function formElement(FieldItemListInterface $items, $delta, array $elemen $entity = $items->getEntity(); /* @var \Drupal\Core\Config\Entity\ConfigEntityInterface $bundle_entity */ - $bundle_entity = $this->entityTypeManager->getStorage($entity->getEntityType()->getBundleEntityType())->load($entity->bundle()); if (!$this->moderationInformation->isModeratedEntity($entity)) { // @todo https://www.drupal.org/node/2779933 write a test for this. return $element + ['#access' => FALSE]; @@ -118,9 +117,6 @@ public function formElement(FieldItemListInterface $items, $delta, array $elemen $workflow = $this->moderationInformation->getWorkflowForEntity($entity); $default = $items->get($delta)->value ? $workflow->getState($items->get($delta)->value) : $workflow->getTypePlugin()->getInitialState($workflow, $entity); - if (!$default) { - throw new \UnexpectedValueException(sprintf('The %s bundle has an invalid moderation state configuration, moderation states are enabled but no default is set.', $bundle_entity->label())); - } /** @var \Drupal\workflows\Transition[] $transitions */ $transitions = $this->validator->getValidTransitions($entity, $this->currentUser); diff --git a/core/modules/content_moderation/src/Plugin/WorkflowType/ContentModeration.php b/core/modules/content_moderation/src/Plugin/WorkflowType/ContentModeration.php index 51605d5383..4a416312ea 100644 --- a/core/modules/content_moderation/src/Plugin/WorkflowType/ContentModeration.php +++ b/core/modules/content_moderation/src/Plugin/WorkflowType/ContentModeration.php @@ -2,7 +2,10 @@ namespace Drupal\content_moderation\Plugin\WorkflowType; +use Drupal\Component\Serialization\Json; +use Drupal\content_moderation\ModerationInformationInterface; use Drupal\Core\Access\AccessResult; +use Drupal\Core\Entity\EntityTypeBundleInfoInterface; use Drupal\Core\Entity\EntityTypeManagerInterface; use Drupal\Core\Entity\EntityPublishedInterface; use Drupal\Core\Form\FormStateInterface; @@ -10,7 +13,8 @@ use Drupal\Core\Session\AccountInterface; use Drupal\Core\StringTranslation\StringTranslationTrait; use Drupal\content_moderation\ContentModerationState; -use Drupal\workflows\Plugin\WorkflowTypeBase; +use Drupal\Core\Url; +use Drupal\workflows\Plugin\WorkflowTypeFormBase; use Drupal\workflows\StateInterface; use Drupal\workflows\WorkflowInterface; use Symfony\Component\DependencyInjection\ContainerInterface; @@ -27,7 +31,7 @@ * }, * ) */ -class ContentModeration extends WorkflowTypeBase implements ContainerFactoryPluginInterface { +class ContentModeration extends WorkflowTypeFormBase implements ContainerFactoryPluginInterface { use StringTranslationTrait; @@ -39,11 +43,38 @@ class ContentModeration extends WorkflowTypeBase implements ContainerFactoryPlug protected $entityTypeManager; /** - * Creates an instance of the ContentModeration WorkflowType plugin. + * The entity type bundle info service. + * + * @var \Drupal\Core\Entity\EntityTypeBundleInfoInterface + */ + protected $entityTypeBundleInfo; + + /** + * The moderation information service. + * + * @var \Drupal\content_moderation\ModerationInformationInterface */ - public function __construct(array $configuration, $plugin_id, $plugin_definition, EntityTypeManagerInterface $entity_type_manager) { + protected $moderationInfo; + + /** + * Constructs a ContentModeration object. + * + * @param array $configuration + * A configuration array containing information about the plugin instance. + * @param string $plugin_id + * The plugin_id for the plugin instance. + * @param mixed $plugin_definition + * The plugin implementation definition. + * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager + * The entity type manager. + * @param \Drupal\content_moderation\ModerationInformationInterface $moderation_info + * Moderation information service. + */ + public function __construct(array $configuration, $plugin_id, $plugin_definition, EntityTypeManagerInterface $entity_type_manager, EntityTypeBundleInfoInterface $entity_type_bundle_info, ModerationInformationInterface $moderation_info) { parent::__construct($configuration, $plugin_id, $plugin_definition); $this->entityTypeManager = $entity_type_manager; + $this->entityTypeBundleInfo = $entity_type_bundle_info; + $this->moderationInfo = $moderation_info; } /** @@ -54,7 +85,9 @@ public static function create(ContainerInterface $container, array $configuratio $configuration, $plugin_id, $plugin_definition, - $container->get('entity_type.manager') + $container->get('entity_type.manager'), + $container->get('entity_type.bundle.info'), + $container->get('content_moderation.moderation_information') ); } @@ -173,6 +206,9 @@ public function appliesToEntityTypeAndBundle($entity_type_id, $bundle_id) { * The bundle ID to remove. */ public function removeEntityTypeAndBundle($entity_type_id, $bundle_id) { + if (!isset($this->configuration['entity_types'][$entity_type_id])) { + return; + } $key = array_search($bundle_id, $this->configuration['entity_types'][$entity_type_id], TRUE); if ($key !== FALSE) { unset($this->configuration['entity_types'][$entity_type_id][$key]); @@ -204,7 +240,7 @@ public function addEntityTypeAndBundle($entity_type_id, $bundle_id) { } /** - * {@inheritDoc} + * {@inheritdoc} */ public function defaultConfiguration() { // This plugin does not store anything per transition. @@ -300,4 +336,68 @@ public function getInitialState(WorkflowInterface $workflow, $entity = NULL) { return parent::getInitialState($workflow); } + /** + * {@inheritdoc} + */ + public function buildConfigurationForm(array $form, FormStateInterface $form_state, WorkflowInterface $workflow = NULL) { + $header = [ + 'type' => $this->t('Items'), + 'operations' => $this->t('Operations') + ]; + $form['entity_types_container'] = [ + '#type' => 'details', + '#title' => $this->t('This workflow applies to:'), + '#open' => TRUE, + ]; + $form['entity_types_container']['entity_types'] = [ + '#type' => 'table', + '#header' => $header, + '#empty' => $this->t('There are no entity types.'), + ]; + + $entity_types = $this->entityTypeManager->getDefinitions(); + foreach ($entity_types as $entity_type) { + if (!$this->moderationInfo->canModerateEntitiesOfEntityType($entity_type)) { + continue; + } + + $selected_bundles = []; + foreach ($this->entityTypeBundleInfo->getBundleInfo($entity_type->id()) as $bundle_id => $bundle) { + if ($this->appliesToEntityTypeAndBundle($entity_type->id(), $bundle_id)) { + $selected_bundles[$bundle_id] = $bundle['label']; + } + } + + $form['entity_types_container']['entity_types'][$entity_type->id()] = [ + 'type' => [ + 'label' => ['#markup' => '' . $this->t('@bundle types', ['@bundle' => $entity_type->getLabel()]) . ''], + 'selected' => [ + '#prefix' => '
', + '#markup' => !empty($selected_bundles) ? implode(', ', $selected_bundles) : $this->t('none'), + '#suffix' => '', + ], + ], + 'operations' => [ + '#type' => 'operations', + '#links' => [ + 'select' => [ + 'title' => $this->t('Select'), + 'url' => Url::fromRoute('content_moderation.workflow_type_edit_form', ['workflow' => $workflow->id(), 'entity_type_id' => $entity_type->id()]), + 'attributes' => [ + 'aria-label' => $this->t('Select'), + 'class' => ['use-ajax'], + 'data-dialog-type' => 'modal', + 'data-dialog-options' => Json::encode([ + 'width' => 700, + ]), + ], + ], + ], + ], + ]; + } + + return $form; + } + } diff --git a/core/modules/content_moderation/src/Routing/EntityTypeModerationRouteProvider.php b/core/modules/content_moderation/src/Routing/EntityTypeModerationRouteProvider.php deleted file mode 100644 index d1dcd2b11f..0000000000 --- a/core/modules/content_moderation/src/Routing/EntityTypeModerationRouteProvider.php +++ /dev/null @@ -1,59 +0,0 @@ -getModerationFormRoute($entity_type)) { - $entity_type_id = $entity_type->id(); - $collection->add("entity.{$entity_type_id}.moderation", $moderation_route); - } - - return $collection; - } - - /** - * Gets the moderation-form route. - * - * @param \Drupal\Core\Entity\EntityTypeInterface $entity_type - * The entity type. - * - * @return \Symfony\Component\Routing\Route|null - * The generated route, if available. - */ - protected function getModerationFormRoute(EntityTypeInterface $entity_type) { - if ($entity_type->hasLinkTemplate('moderation-form') && $entity_type->getFormClass('moderation')) { - $entity_type_id = $entity_type->id(); - - $route = new Route($entity_type->getLinkTemplate('moderation-form')); - - // @todo Come up with a new permission. - $route - ->setDefaults([ - '_entity_form' => "{$entity_type_id}.moderation", - '_title' => 'Moderation', - ]) - ->setRequirement('_permission', 'administer content moderation') - ->setOption('parameters', [ - $entity_type_id => ['type' => 'entity:' . $entity_type_id], - ]); - - return $route; - } - } - -} diff --git a/core/modules/content_moderation/tests/src/Functional/ModerationFormTest.php b/core/modules/content_moderation/tests/src/Functional/ModerationFormTest.php index 9cf92ba4dd..746fbee5dd 100644 --- a/core/modules/content_moderation/tests/src/Functional/ModerationFormTest.php +++ b/core/modules/content_moderation/tests/src/Functional/ModerationFormTest.php @@ -2,6 +2,8 @@ namespace Drupal\Tests\content_moderation\Functional; +use Drupal\workflows\Entity\Workflow; + /** * Tests the moderation form, specifically on nodes. * @@ -9,6 +11,19 @@ */ class ModerationFormTest extends ModerationStateTestBase { + + /** + * Modules to enable. + * + * @var array + */ + public static $modules = [ + 'node', + 'content_moderation', + 'locale', + 'content_translation', + ]; + /** * {@inheritdoc} */ @@ -115,4 +130,217 @@ public function testModerationForm() { $this->assertResponse(403); } + /** + * Test moderation non-bundle entity type. + */ + public function testNonBundleModerationForm() { + $this->drupalLogin($this->rootUser); + $workflow = Workflow::load('editorial'); + $workflow->getTypePlugin()->addEntityTypeAndBundle('entity_test_mulrevpub', 'entity_test_mulrevpub'); + $workflow->save(); + + // Create new moderated content in draft. + $this->drupalPostForm('entity_test_mulrevpub/add', [], t('Save and Create New Draft')); + + // The latest version page should not show, because there is no forward + // revision. + $this->drupalGet('/entity_test_mulrevpub/manage/1/latest'); + $this->assertResponse(403); + + // Update the draft. + $this->drupalPostForm('entity_test_mulrevpub/manage/1/edit', [], t('Save and Create New Draft')); + + // The latest version page should not show, because there is still no + // forward revision. + $this->drupalGet('/entity_test_mulrevpub/manage/1/latest'); + $this->assertResponse(403); + + // Publish the draft. + $this->drupalPostForm('entity_test_mulrevpub/manage/1/edit', [], t('Save and Publish')); + + // The published view should not have a moderation form, because it is the + // default revision. + $this->drupalGet('entity_test_mulrevpub/manage/1'); + $this->assertResponse(200); + $this->assertNoText('Status', 'The node view page has no moderation form.'); + + // The latest version page should not show, because there is still no + // forward revision. + $this->drupalGet('entity_test_mulrevpub/manage/1/latest'); + $this->assertResponse(403); + + // Make a forward revision. + $this->drupalPostForm('entity_test_mulrevpub/manage/1/edit', [], t('Save and Create New Draft')); + + // The published view should not have a moderation form, because it is the + // default revision. + $this->drupalGet('entity_test_mulrevpub/manage/1'); + $this->assertResponse(200); + $this->assertNoText('Status', 'The node view page has no moderation form.'); + + // The latest version page should show the moderation form and have "Draft" + // status, because the forward revision is in "Draft". + $this->drupalGet('entity_test_mulrevpub/manage/1/latest'); + $this->assertResponse(200); + $this->assertText('Status', 'Form text found on the latest-version page.'); + $this->assertText('Draft', 'Correct status found on the latest-version page.'); + + // Submit the moderation form to change status to published. + $this->drupalPostForm('entity_test_mulrevpub/manage/1/latest', [ + 'new_state' => 'published', + ], t('Apply')); + + // The latest version page should not show, because there is no + // forward revision. + $this->drupalGet('entity_test_mulrevpub/manage/1/latest'); + $this->assertResponse(403); + } + + public function testContentTranslationNodeForm() { + $this->drupalLogin($this->rootUser); + + // Add French language. + $edit = [ + 'predefined_langcode' => 'fr', + ]; + $this->drupalPostForm('admin/config/regional/language/add', $edit, t('Add language')); + + // Enable content translation on articles. + $this->drupalGet('admin/config/regional/content-language'); + $edit = [ + 'entity_types[node]' => TRUE, + 'settings[node][moderated_content][translatable]' => TRUE, + 'settings[node][moderated_content][settings][language][language_alterable]' => TRUE, + ]; + $this->drupalPostForm(NULL, $edit, t('Save configuration')); + + // Adding languages requires a container rebuild in the test running + // environment so that multilingual services are used. + $this->rebuildContainer(); + + // Create new moderated content in draft (revision 1). + $this->drupalPostForm('node/add/moderated_content', [ + 'title[0][value]' => 'Some moderated content', + 'body[0][value]' => 'First version of the content.', + ], t('Save and Create New Draft')); + + $node = $this->drupalGetNodeByTitle('Some moderated content'); + $this->assertTrue($node->language(), 'en'); + $edit_path = sprintf('node/%d/edit', $node->id()); + $translate_path = sprintf('node/%d/translations/add/en/fr', $node->id()); + + // Add french translation (revision 2). + $this->drupalGet($translate_path); + $this->assertTrue($this->xpath('//input[@value="Save and Create New Draft (this translation)"]')); + $this->assertTrue($this->xpath('//input[@value="Save and Publish (this translation)"]')); + $this->assertFalse($this->xpath('//input[@value="Save and Archive (this translation)"]')); + $this->drupalPostForm(NULL, [ + 'body[0][value]' => 'Second version of the content.', + ], t('Save and Publish (this translation)')); + + // Add french forward revision (revision 3). + $this->drupalGet('fr/' . $edit_path); + $this->assertTrue($this->xpath('//input[@value="Save and Create New Draft (this translation)"]')); + $this->assertTrue($this->xpath('//input[@value="Save and Publish (this translation)"]')); + $this->assertTrue($this->xpath('//input[@value="Save and Archive (this translation)"]')); + $this->drupalPostForm(NULL, [ + 'body[0][value]' => 'Third version of the content.', + ], t('Save and Create New Draft (this translation)')); + + // It should not be possible to add a new english revision. + $this->drupalGet($edit_path); + $this->assertFalse($this->xpath('//input[@value="Save and Create New Draft (this translation)"]')); + $this->assertFalse($this->xpath('//input[@value="Save and Publish (this translation)"]')); + $this->assertFalse($this->xpath('//input[@value="Save and Archive (this translation)"]')); + $this->assertText('It is not possible to save this Content.'); + + // Publish the french forward revision (revision 4). + $this->drupalGet('fr/' . $edit_path); + $this->assertTrue($this->xpath('//input[@value="Save and Create New Draft (this translation)"]')); + $this->assertTrue($this->xpath('//input[@value="Save and Publish (this translation)"]')); + $this->assertFalse($this->xpath('//input[@value="Save and Archive (this translation)"]')); + $this->drupalPostForm(NULL, [ + 'body[0][value]' => 'Fifth version of the content.', + ], t('Save and Publish (this translation)')); + + // Now we can publish the english (revision 5). + $this->drupalGet($edit_path); + $this->assertTrue($this->xpath('//input[@value="Save and Create New Draft (this translation)"]')); + $this->assertTrue($this->xpath('//input[@value="Save and Publish (this translation)"]')); + $this->assertFalse($this->xpath('//input[@value="Save and Archive (this translation)"]')); + $this->drupalPostForm(NULL, [ + 'body[0][value]' => 'Sixth version of the content.', + ], t('Save and Publish (this translation)')); + + // Make sure we're allowed to create a forward french revision. + $this->drupalGet('fr/' . $edit_path); + $this->assertTrue($this->xpath('//input[@value="Save and Create New Draft (this translation)"]')); + $this->assertTrue($this->xpath('//input[@value="Save and Publish (this translation)"]')); + $this->assertTrue($this->xpath('//input[@value="Save and Archive (this translation)"]')); + + // Add a english forward revision (revision 6). + $this->drupalGet($edit_path); + $this->assertTrue($this->xpath('//input[@value="Save and Create New Draft (this translation)"]')); + $this->assertTrue($this->xpath('//input[@value="Save and Publish (this translation)"]')); + $this->assertTrue($this->xpath('//input[@value="Save and Archive (this translation)"]')); + $this->drupalPostForm(NULL, [ + 'body[0][value]' => 'Seventh version of the content.', + ], t('Save and Create New Draft (this translation)')); + + // Make sure we're not allowed to create a forward french revision. + $this->drupalGet('fr/' . $edit_path); + $this->assertFalse($this->xpath('//input[@value="Save and Create New Draft (this translation)"]')); + $this->assertFalse($this->xpath('//input[@value="Save and Publish (this translation)"]')); + $this->assertFalse($this->xpath('//input[@value="Save and Archive (this translation)"]')); + $this->assertText('It is not possible to save this Content.'); + + // We should be able to publish the english forward revision (revision 7) + $this->drupalGet($edit_path); + $this->assertTrue($this->xpath('//input[@value="Save and Create New Draft (this translation)"]')); + $this->assertTrue($this->xpath('//input[@value="Save and Publish (this translation)"]')); + $this->assertFalse($this->xpath('//input[@value="Save and Archive (this translation)"]')); + $this->drupalPostForm(NULL, [ + 'body[0][value]' => 'Eighth version of the content.', + ], t('Save and Publish (this translation)')); + + // Make sure we're allowed to create a forward french revision. + $this->drupalGet('fr/' . $edit_path); + $this->assertTrue($this->xpath('//input[@value="Save and Create New Draft (this translation)"]')); + $this->assertTrue($this->xpath('//input[@value="Save and Publish (this translation)"]')); + $this->assertTrue($this->xpath('//input[@value="Save and Archive (this translation)"]')); + + // Make sure we're allowed to create a forward english revision. + $this->drupalGet($edit_path); + $this->assertTrue($this->xpath('//input[@value="Save and Create New Draft (this translation)"]')); + $this->assertTrue($this->xpath('//input[@value="Save and Publish (this translation)"]')); + $this->assertTrue($this->xpath('//input[@value="Save and Archive (this translation)"]')); + + // Create new moderated content in draft (revision 1). + $this->drupalPostForm('node/add/moderated_content', [ + 'title[0][value]' => 'Second moderated content', + 'body[0][value]' => 'First version of the content.', + ], t('Save and Publish')); + + $node = $this->drupalGetNodeByTitle('Second moderated content'); + $this->assertTrue($node->language(), 'en'); + $edit_path = sprintf('node/%d/edit', $node->id()); + $translate_path = sprintf('node/%d/translations/add/en/fr', $node->id()); + + // Add a forward revision (revision 2). + $this->drupalGet($edit_path); + $this->assertTrue($this->xpath('//input[@value="Save and Create New Draft (this translation)"]')); + $this->assertTrue($this->xpath('//input[@value="Save and Publish (this translation)"]')); + $this->assertTrue($this->xpath('//input[@value="Save and Archive (this translation)"]')); + $this->drupalPostForm(NULL, [ + 'body[0][value]' => 'Second version of the content.', + ], t('Save and Create New Draft (this translation)')); + + // It shouldn't be possible to translate as we have a forward revision. + $this->drupalGet($translate_path); + $this->assertFalse($this->xpath('//input[@value="Save and Create New Draft (this translation)"]')); + $this->assertFalse($this->xpath('//input[@value="Save and Publish (this translation)"]')); + $this->assertFalse($this->xpath('//input[@value="Save and Archive (this translation)"]')); + $this->assertText('It is not possible to save this Content.'); + } + } diff --git a/core/modules/content_moderation/tests/src/Functional/ModerationLocaleTest.php b/core/modules/content_moderation/tests/src/Functional/ModerationLocaleTest.php index a9d95f0b9f..7b506136c2 100644 --- a/core/modules/content_moderation/tests/src/Functional/ModerationLocaleTest.php +++ b/core/modules/content_moderation/tests/src/Functional/ModerationLocaleTest.php @@ -144,17 +144,12 @@ public function testTranslateModeratedContent() { $this->assertTrue($french_node->isPublished()); $this->assertEqual($french_node->getTitle(), 'Translated node', 'The default revision of the published translation remains the same.'); - // Publish the draft. - $edit = [ - 'new_state' => 'published', - ]; - $this->drupalPostForm('fr/node/' . $english_node->id() . '/latest', $edit, t('Apply')); - $this->assertText(t('The moderation state has been updated.')); + // Publish the French article before testing the archive transition. + $this->drupalPostForm('fr/node/' . $english_node->id() . '/edit', [], t('Save and Publish (this translation)')); + $this->assertText(t('Article New draft of translated node has been updated.')); $english_node = $this->drupalGetNodeByTitle('Another node', TRUE); $french_node = $english_node->getTranslation('fr'); $this->assertEqual($french_node->moderation_state->value, 'published'); - $this->assertTrue($french_node->isPublished()); - $this->assertEqual($french_node->getTitle(), 'New draft of translated node', 'The draft has replaced the published revision.'); // Publish the English article before testing the archive transition. $this->drupalPostForm('node/' . $english_node->id() . '/edit', [], t('Save and Publish (this translation)')); @@ -173,43 +168,6 @@ public function testTranslateModeratedContent() { $this->assertFalse($english_node->isPublished()); $this->assertEqual($french_node->moderation_state->value, 'archived'); $this->assertFalse($french_node->isPublished()); - - // Create another article with its translation. This time publishing english - // after creating a forward french revision. - $edit = [ - 'title[0][value]' => 'An english node', - ]; - $this->drupalPostForm('node/add/article', $edit, t('Save and Create New Draft')); - $this->assertText(t('Article An english node has been created.')); - $english_node = $this->drupalGetNodeByTitle('An english node'); - $this->assertFalse($english_node->isPublished()); - - // Add a French translation. - $this->drupalGet('node/' . $english_node->id() . '/translations'); - $this->clickLink(t('Add')); - $edit = [ - 'title[0][value]' => 'A french node', - ]; - $this->drupalPostForm(NULL, $edit, t('Save and Publish (this translation)')); - $english_node = $this->drupalGetNodeByTitle('An english node', TRUE); - $french_node = $english_node->getTranslation('fr'); - $this->assertTrue($french_node->isPublished()); - $this->assertFalse($english_node->isPublished()); - - // Create a forward revision - $this->drupalPostForm('fr/node/' . $english_node->id() . '/edit', [], t('Save and Create New Draft (this translation)')); - $english_node = $this->drupalGetNodeByTitle('An english node', TRUE); - $french_node = $english_node->getTranslation('fr'); - $this->assertTrue($french_node->isPublished()); - $this->assertFalse($english_node->isPublished()); - - // Publish the english node and the default french node not the latest - // french node should be used. - $this->drupalPostForm('/node/' . $english_node->id() . '/edit', [], t('Save and Publish (this translation)')); - $english_node = $this->drupalGetNodeByTitle('An english node', TRUE); - $french_node = $english_node->getTranslation('fr'); - $this->assertTrue($french_node->isPublished()); - $this->assertTrue($english_node->isPublished()); } } diff --git a/core/modules/content_moderation/tests/src/Functional/ModerationRevisionRevertTest.php b/core/modules/content_moderation/tests/src/Functional/ModerationRevisionRevertTest.php new file mode 100644 index 0000000000..7dac15667f --- /dev/null +++ b/core/modules/content_moderation/tests/src/Functional/ModerationRevisionRevertTest.php @@ -0,0 +1,90 @@ +createContentType(['type' => 'moderated_bundle']); + $moderated_bundle->save(); + + $workflow = Workflow::load('editorial'); + $workflow->getTypePlugin()->addEntityTypeAndBundle('node', 'moderated_bundle'); + $workflow->save(); + + $admin = $this->drupalCreateUser([ + 'access content overview', + 'administer nodes', + 'bypass node access', + 'view all revisions', + 'view content moderation', + 'use editorial transition create_new_draft', + 'use editorial transition publish', + ]); + $this->drupalLogin($admin); + } + + /** + * Test that reverting a revision works. + */ + public function testEditingAfterRevertRevision() { + // Create a draft. + $this->drupalPostForm('node/add/moderated_bundle', ['title[0][value]' => 'First draft node'], t('Save and Create New Draft')); + + // Now make it published. + $this->drupalPostForm('node/1/edit', ['title[0][value]' => 'Published node'], t('Save and Publish')); + + // Check the editing form that show the published title. + $this->drupalGet('node/1/edit'); + $this->assertSession() + ->pageTextContains('Published node'); + + // Revert the first revision. + $revision_url = 'node/1/revisions/1/revert'; + $this->drupalGet($revision_url); + $this->assertSession()->elementExists('css', '.form-submit'); + $this->click('.form-submit'); + + // Check that it reverted. + $this->drupalGet('node/1/edit'); + $this->assertSession() + ->pageTextContains('First draft node'); + // Try to save the node. + $this->click('.moderation-state-draft > input'); + + // Check if the submission passed the EntityChangedConstraintValidator. + $this->assertSession() + ->pageTextNotContains('The content has either been modified by another user, or you have already submitted modifications. As a result, your changes cannot be saved.'); + + // Check the node has been saved. + $this->assertSession() + ->pageTextContains('moderated_bundle First draft node has been updated'); + } + +} diff --git a/core/modules/content_moderation/tests/src/Functional/ModerationStateAccessTest.php b/core/modules/content_moderation/tests/src/Functional/ModerationStateAccessTest.php index 7d2f74666e..868049944f 100644 --- a/core/modules/content_moderation/tests/src/Functional/ModerationStateAccessTest.php +++ b/core/modules/content_moderation/tests/src/Functional/ModerationStateAccessTest.php @@ -69,7 +69,6 @@ public function testViewShowsCorrectStates() { $permissions = [ 'access content', 'view all revisions', - 'administer content moderation', ]; $admin1 = $this->drupalCreateUser($permissions); $this->drupalLogin($admin1); diff --git a/core/modules/content_moderation/tests/src/Functional/ModerationStateBlockTest.php b/core/modules/content_moderation/tests/src/Functional/ModerationStateBlockTest.php index d45fb7b337..1a8f78c504 100644 --- a/core/modules/content_moderation/tests/src/Functional/ModerationStateBlockTest.php +++ b/core/modules/content_moderation/tests/src/Functional/ModerationStateBlockTest.php @@ -51,17 +51,9 @@ protected function setUp() { public function testCustomBlockModeration() { $this->drupalLogin($this->rootUser); - $this->drupalGet('admin/structure/block/block-content/types'); - $this->assertLinkByHref('admin/structure/block/block-content/manage/basic/moderation'); - $this->drupalGet('admin/structure/block/block-content/manage/basic'); - $this->assertLinkByHref('admin/structure/block/block-content/manage/basic/moderation'); - $this->drupalGet('admin/structure/block/block-content/manage/basic/moderation'); - - // Enable moderation for custom blocks at - // admin/structure/block/block-content/manage/basic/moderation. - $edit = ['workflow' => 'editorial']; - $this->drupalPostForm(NULL, $edit, t('Save')); - $this->assertText(t('Your settings have been saved.')); + // Enable moderation for custom blocks. + $edit['bundles[basic]'] = TRUE; + $this->drupalPostForm('admin/config/workflow/workflows/manage/editorial/type/block_content', $edit, t('Save')); // Create a custom block at block/add and save it as draft. $body = 'Body of moderated block'; diff --git a/core/modules/content_moderation/tests/src/Functional/ModerationStateNodeTest.php b/core/modules/content_moderation/tests/src/Functional/ModerationStateNodeTest.php index 7579afa4e6..74129a1980 100644 --- a/core/modules/content_moderation/tests/src/Functional/ModerationStateNodeTest.php +++ b/core/modules/content_moderation/tests/src/Functional/ModerationStateNodeTest.php @@ -52,9 +52,8 @@ public function testCreatingContent() { $this->assertText(t('The Moderated content moderated content has been deleted.')); // Disable content moderation. - $this->drupalPostForm('admin/structure/types/manage/moderated_content/moderation', ['workflow' => ''], t('Save')); - $this->drupalGet('admin/structure/types/manage/moderated_content/moderation'); - $this->assertOptionSelected('edit-workflow', ''); + $edit['bundles[moderated_content]'] = FALSE; + $this->drupalPostForm('admin/config/workflow/workflows/manage/editorial/type/node', $edit, t('Save'));; // Ensure the parent environment is up-to-date. // @see content_moderation_workflow_insert() \Drupal::service('entity_type.bundle.info')->clearCachedBundles(); diff --git a/core/modules/content_moderation/tests/src/Functional/ModerationStateNodeTypeTest.php b/core/modules/content_moderation/tests/src/Functional/ModerationStateNodeTypeTest.php index 8391dd0aae..de4a7c29a2 100644 --- a/core/modules/content_moderation/tests/src/Functional/ModerationStateNodeTypeTest.php +++ b/core/modules/content_moderation/tests/src/Functional/ModerationStateNodeTypeTest.php @@ -30,7 +30,7 @@ public function testNotModerated() { */ public function testEnablingOnExistingContent() { $editor_permissions = [ - 'administer content moderation', + 'administer workflows', 'access administration pages', 'administer content types', 'administer nodes', @@ -56,17 +56,8 @@ public function testEnablingOnExistingContent() { ], t('Save and publish')); $this->assertText('Not moderated Test has been created.'); - // Now enable moderation state, ensuring all the expected links and tabs are - // present. - $this->drupalGet('admin/structure/types'); - $this->assertLinkByHref('admin/structure/types/manage/not_moderated/moderation'); - $this->drupalGet('admin/structure/types/manage/not_moderated'); - $this->assertLinkByHref('admin/structure/types/manage/not_moderated/moderation'); - $this->drupalGet('admin/structure/types/manage/not_moderated/moderation'); - $this->assertOptionSelected('edit-workflow', ''); - $this->assertNoLink('Delete'); - $edit['workflow'] = 'editorial'; - $this->drupalPostForm(NULL, $edit, t('Save')); + // Now enable moderation state. + $this->enableModerationThroughUi('not_moderated'); // And make sure it works. $nodes = \Drupal::entityTypeManager()->getStorage('node') diff --git a/core/modules/content_moderation/tests/src/Functional/ModerationStateTestBase.php b/core/modules/content_moderation/tests/src/Functional/ModerationStateTestBase.php index 1319ecae1e..8a3a2d0cea 100644 --- a/core/modules/content_moderation/tests/src/Functional/ModerationStateTestBase.php +++ b/core/modules/content_moderation/tests/src/Functional/ModerationStateTestBase.php @@ -29,7 +29,7 @@ * @var array */ protected $permissions = [ - 'administer content moderation', + 'administer workflows', 'access administration pages', 'administer content types', 'administer nodes', @@ -50,6 +50,7 @@ 'block', 'block_content', 'node', + 'entity_test', ]; /** @@ -112,9 +113,11 @@ protected function createContentTypeFromUi($content_type_name, $content_type_id, * @param string $workflow_id * The workflow to attach to the bundle. */ - protected function enableModerationThroughUi($content_type_id, $workflow_id = 'editorial') { - $edit['workflow'] = $workflow_id; - $this->drupalPostForm('admin/structure/types/manage/' . $content_type_id . '/moderation', $edit, t('Save')); + public function enableModerationThroughUi($content_type_id, $workflow_id = 'editorial') { + $this->drupalGet('/admin/config/workflow/workflows'); + $this->assertLinkByHref('admin/config/workflow/workflows/manage/' . $workflow_id); + $edit['bundles[' . $content_type_id . ']'] = TRUE; + $this->drupalPostForm('admin/config/workflow/workflows/manage/' . $workflow_id . '/type/node', $edit, t('Save')); // Ensure the parent environment is up-to-date. // @see content_moderation_workflow_insert() \Drupal::service('entity_type.bundle.info')->clearCachedBundles(); diff --git a/core/modules/content_moderation/tests/src/Functional/NodeAccessTest.php b/core/modules/content_moderation/tests/src/Functional/NodeAccessTest.php index f3c27146d4..00e847d3a7 100644 --- a/core/modules/content_moderation/tests/src/Functional/NodeAccessTest.php +++ b/core/modules/content_moderation/tests/src/Functional/NodeAccessTest.php @@ -28,7 +28,7 @@ class NodeAccessTest extends ModerationStateTestBase { * @var array */ protected $permissions = [ - 'administer content moderation', + 'administer workflows', 'access administration pages', 'administer content types', 'administer nodes', diff --git a/core/modules/content_moderation/tests/src/Kernel/ContentModerationWorkflowTypeApiTest.php b/core/modules/content_moderation/tests/src/Kernel/ContentModerationWorkflowTypeApiTest.php index c2ea8c576d..220ac5d5a6 100644 --- a/core/modules/content_moderation/tests/src/Kernel/ContentModerationWorkflowTypeApiTest.php +++ b/core/modules/content_moderation/tests/src/Kernel/ContentModerationWorkflowTypeApiTest.php @@ -101,4 +101,26 @@ public function testAddEntityTypeAndBundle() { ); } + /** + * @covers ::addEntityTypeAndBundle + * @covers ::removeEntityTypeAndBundle + */ + public function testRemoveEntityTypeAndBundle() { + /** @var \Drupal\content_moderation\Plugin\WorkflowType\ContentModeration $workflow_plugin */ + $workflow_plugin = $this->workflow->getTypePlugin(); + + // There should be no bundles for fake_node to start with. + $this->assertEquals([], $workflow_plugin->getBundlesForEntityType('fake_node')); + // Removing a bundle which is not set on the workflow should not throw an + // error and should still result in none being returned. + $workflow_plugin->removeEntityTypeAndBundle('fake_node', 'fake_page'); + $this->assertEquals([], $workflow_plugin->getBundlesForEntityType('fake_node')); + // Adding a bundle for fake_node should result it in being returned, but + // then removing it will return no bundles for fake_node. + $workflow_plugin->addEntityTypeAndBundle('fake_node', 'fake_page'); + $this->assertEquals(['fake_page'], $workflow_plugin->getBundlesForEntityType('fake_node')); + $workflow_plugin->removeEntityTypeAndBundle('fake_node', 'fake_page'); + $this->assertEquals([], $workflow_plugin->getBundlesForEntityType('fake_node')); + } + } diff --git a/core/modules/content_moderation/tests/src/Kernel/EntityTypeInfoTest.php b/core/modules/content_moderation/tests/src/Kernel/EntityTypeInfoTest.php index 1c45721d03..a5791c8840 100644 --- a/core/modules/content_moderation/tests/src/Kernel/EntityTypeInfoTest.php +++ b/core/modules/content_moderation/tests/src/Kernel/EntityTypeInfoTest.php @@ -20,6 +20,7 @@ class EntityTypeInfoTest extends KernelTestBase { */ public static $modules = [ 'content_moderation', + 'workflows', 'entity_test', ]; diff --git a/core/modules/content_moderation/tests/src/Unit/ContentPreprocessTest.php b/core/modules/content_moderation/tests/src/Unit/ContentPreprocessTest.php index 5de0b2a977..8084716346 100644 --- a/core/modules/content_moderation/tests/src/Unit/ContentPreprocessTest.php +++ b/core/modules/content_moderation/tests/src/Unit/ContentPreprocessTest.php @@ -5,13 +5,14 @@ use Drupal\content_moderation\ContentPreprocess; use Drupal\Core\Routing\CurrentRouteMatch; use Drupal\node\Entity\Node; +use Drupal\Tests\UnitTestCase; /** * @coversDefaultClass \Drupal\content_moderation\ContentPreprocess * * @group content_moderation */ -class ContentPreprocessTest extends \PHPUnit_Framework_TestCase { +class ContentPreprocessTest extends UnitTestCase { /** * @covers ::isLatestVersionPage diff --git a/core/modules/content_moderation/tests/src/Unit/LatestRevisionCheckTest.php b/core/modules/content_moderation/tests/src/Unit/LatestRevisionCheckTest.php index 1f8838b774..412a0eacea 100644 --- a/core/modules/content_moderation/tests/src/Unit/LatestRevisionCheckTest.php +++ b/core/modules/content_moderation/tests/src/Unit/LatestRevisionCheckTest.php @@ -9,13 +9,14 @@ use Drupal\node\Entity\Node; use Drupal\content_moderation\Access\LatestRevisionCheck; use Drupal\content_moderation\ModerationInformation; +use Drupal\Tests\UnitTestCase; use Symfony\Component\Routing\Route; /** * @coversDefaultClass \Drupal\content_moderation\Access\LatestRevisionCheck * @group content_moderation */ -class LatestRevisionCheckTest extends \PHPUnit_Framework_TestCase { +class LatestRevisionCheckTest extends UnitTestCase { /** * Test the access check of the LatestRevisionCheck service. diff --git a/core/modules/content_moderation/tests/src/Unit/ModerationInformationTest.php b/core/modules/content_moderation/tests/src/Unit/ModerationInformationTest.php index 8d319ef319..57fe761ce1 100644 --- a/core/modules/content_moderation/tests/src/Unit/ModerationInformationTest.php +++ b/core/modules/content_moderation/tests/src/Unit/ModerationInformationTest.php @@ -10,13 +10,14 @@ use Drupal\Core\Entity\EntityTypeManagerInterface; use Drupal\Core\Session\AccountInterface; use Drupal\content_moderation\ModerationInformation; +use Drupal\Tests\UnitTestCase; use Drupal\workflows\WorkflowInterface; /** * @coversDefaultClass \Drupal\content_moderation\ModerationInformation * @group content_moderation */ -class ModerationInformationTest extends \PHPUnit_Framework_TestCase { +class ModerationInformationTest extends UnitTestCase { /** * Builds a mock user. diff --git a/core/modules/content_moderation/tests/src/Unit/StateTransitionValidationTest.php b/core/modules/content_moderation/tests/src/Unit/StateTransitionValidationTest.php index 2e03447787..b7c3942d83 100644 --- a/core/modules/content_moderation/tests/src/Unit/StateTransitionValidationTest.php +++ b/core/modules/content_moderation/tests/src/Unit/StateTransitionValidationTest.php @@ -7,6 +7,7 @@ use Drupal\Core\Entity\ContentEntityInterface; use Drupal\Core\Session\AccountInterface; use Drupal\content_moderation\StateTransitionValidation; +use Drupal\Tests\UnitTestCase; use Drupal\workflows\Entity\Workflow; use Drupal\workflows\WorkflowTypeInterface; use Drupal\workflows\WorkflowTypeManager; @@ -16,7 +17,7 @@ * @coversDefaultClass \Drupal\content_moderation\StateTransitionValidation * @group content_moderation */ -class StateTransitionValidationTest extends \PHPUnit_Framework_TestCase { +class StateTransitionValidationTest extends UnitTestCase { /** * Verifies user-aware transition validation. @@ -62,6 +63,9 @@ protected function setUpModerationInformation(ContentEntityInterface $entity) { // mocked. $container = new ContainerBuilder(); $workflow_type = $this->prophesize(WorkflowTypeInterface::class); + $workflow_type->setConfiguration(Argument::any())->will(function ($arguments) { + $this->getConfiguration()->willReturn($arguments[0]); + }); $workflow_type->decorateState(Argument::any())->willReturnArgument(0); $workflow_type->decorateTransition(Argument::any())->willReturnArgument(0); $workflow_manager = $this->prophesize(WorkflowTypeManager::class); diff --git a/core/modules/contextual/contextual.module b/core/modules/contextual/contextual.module index cf20318cb1..a814c391f1 100644 --- a/core/modules/contextual/contextual.module +++ b/core/modules/contextual/contextual.module @@ -36,6 +36,7 @@ function contextual_toolbar() { '#attributes' => [ 'class' => ['toolbar-icon', 'toolbar-icon-edit'], 'aria-pressed' => 'false', + 'type' => 'button', ], ], '#wrapper_attributes' => [ diff --git a/core/modules/contextual/src/ContextualController.php b/core/modules/contextual/src/ContextualController.php index b1fe245c04..0451a10e21 100644 --- a/core/modules/contextual/src/ContextualController.php +++ b/core/modules/contextual/src/ContextualController.php @@ -2,8 +2,9 @@ namespace Drupal\contextual; -use Symfony\Component\DependencyInjection\ContainerAwareInterface; -use Symfony\Component\DependencyInjection\ContainerAwareTrait; +use Drupal\Core\DependencyInjection\ContainerInjectionInterface; +use Drupal\Core\Render\RendererInterface; +use Symfony\Component\DependencyInjection\ContainerInterface; use Symfony\Component\HttpFoundation\JsonResponse; use Symfony\Component\HttpFoundation\Request; use Symfony\Component\HttpKernel\Exception\BadRequestHttpException; @@ -11,9 +12,32 @@ /** * Returns responses for Contextual module routes. */ -class ContextualController implements ContainerAwareInterface { +class ContextualController implements ContainerInjectionInterface { - use ContainerAwareTrait; + /** + * The renderer. + * @var \Drupal\Core\Render\RendererInterface + */ + protected $render; + + /** + * Constructors a new ContextualController + * + * @param \Drupal\Core\Render\RendererInterface $renderer + * The renderer. + */ + public function __construct(RendererInterface $renderer) { + $this->renderer = $renderer; + } + + /** + * {@inheritdoc} + */ + public static function create(ContainerInterface $container) { + return new static( + $container->get('renderer') + ); + } /** * Returns the requested rendered contextual links. @@ -38,7 +62,7 @@ public function render(Request $request) { '#type' => 'contextual_links', '#contextual_links' => _contextual_id_to_links($id), ]; - $rendered[$id] = $this->container->get('renderer')->renderRoot($element); + $rendered[$id] = $this->renderer->renderRoot($element); } return new JsonResponse($rendered); diff --git a/core/modules/datetime/src/Plugin/Field/FieldFormatter/DateTimeCustomFormatter.php b/core/modules/datetime/src/Plugin/Field/FieldFormatter/DateTimeCustomFormatter.php index 445b7ee706..984423d07f 100644 --- a/core/modules/datetime/src/Plugin/Field/FieldFormatter/DateTimeCustomFormatter.php +++ b/core/modules/datetime/src/Plugin/Field/FieldFormatter/DateTimeCustomFormatter.php @@ -32,30 +32,18 @@ public static function defaultSettings() { * {@inheritdoc} */ public function viewElements(FieldItemListInterface $items, $langcode) { + // @todo Evaluate removing this method in + // https://www.drupal.org/node/2793143 to determine if the behavior and + // markup in the base class implementation can be used instead. $elements = []; foreach ($items as $delta => $item) { - $output = ''; if (!empty($item->date)) { /** @var \Drupal\Core\Datetime\DrupalDateTime $date */ $date = $item->date; - if ($this->getFieldSetting('datetime_type') == 'date') { - // A date without time will pick up the current time, use the default. - datetime_date_default_time($date); - } - $this->setTimeZone($date); - - $output = $this->formatDate($date); + $elements[$delta] = $this->buildDate($date); } - $elements[$delta] = [ - '#markup' => $output, - '#cache' => [ - 'contexts' => [ - 'timezone', - ], - ], - ]; } return $elements; diff --git a/core/modules/datetime/src/Plugin/Field/FieldFormatter/DateTimeDefaultFormatter.php b/core/modules/datetime/src/Plugin/Field/FieldFormatter/DateTimeDefaultFormatter.php index 7ddecec551..0b75b4e57a 100644 --- a/core/modules/datetime/src/Plugin/Field/FieldFormatter/DateTimeDefaultFormatter.php +++ b/core/modules/datetime/src/Plugin/Field/FieldFormatter/DateTimeDefaultFormatter.php @@ -3,7 +3,6 @@ namespace Drupal\datetime\Plugin\Field\FieldFormatter; use Drupal\Core\Datetime\DrupalDateTime; -use Drupal\Core\Field\FieldItemListInterface; use Drupal\Core\Form\FormStateInterface; /** @@ -31,59 +30,6 @@ public static function defaultSettings() { /** * {@inheritdoc} */ - public function viewElements(FieldItemListInterface $items, $langcode) { - $elements = []; - - foreach ($items as $delta => $item) { - $output = ''; - $iso_date = ''; - - if ($item->date) { - /** @var \Drupal\Core\Datetime\DrupalDateTime $date */ - $date = $item->date; - - if ($this->getFieldSetting('datetime_type') == 'date') { - // A date without time will pick up the current time, use the default. - datetime_date_default_time($date); - } - - // Create the ISO date in Universal Time. - $iso_date = $date->format("Y-m-d\TH:i:s") . 'Z'; - - $this->setTimeZone($date); - - $output = $this->formatDate($date); - } - - // Display the date using theme datetime. - $elements[$delta] = [ - '#cache' => [ - 'contexts' => [ - 'timezone', - ], - ], - '#theme' => 'time', - '#text' => $output, - '#html' => FALSE, - '#attributes' => [ - 'datetime' => $iso_date, - ], - ]; - if (!empty($item->_attributes)) { - $elements[$delta]['#attributes'] += $item->_attributes; - // Unset field item attributes since they have been included in the - // formatter output and should not be rendered in the field template. - unset($item->_attributes); - } - } - - return $elements; - - } - - /** - * {@inheritdoc} - */ protected function formatDate($date) { $format_type = $this->getSetting('format_type'); $timezone = $this->getSetting('timezone_override') ?: $date->getTimezone()->getName(); diff --git a/core/modules/datetime/src/Plugin/Field/FieldFormatter/DateTimeFormatterBase.php b/core/modules/datetime/src/Plugin/Field/FieldFormatter/DateTimeFormatterBase.php index f4e5ff5353..71b94670f4 100644 --- a/core/modules/datetime/src/Plugin/Field/FieldFormatter/DateTimeFormatterBase.php +++ b/core/modules/datetime/src/Plugin/Field/FieldFormatter/DateTimeFormatterBase.php @@ -6,6 +6,7 @@ use Drupal\Core\Datetime\DrupalDateTime; use Drupal\Core\Entity\EntityStorageInterface; use Drupal\Core\Field\FieldDefinitionInterface; +use Drupal\Core\Field\FieldItemListInterface; use Drupal\Core\Field\FormatterBase; use Drupal\Core\Form\FormStateInterface; use Drupal\Core\Plugin\ContainerFactoryPluginInterface; @@ -118,6 +119,30 @@ public function settingsSummary() { } /** + * {@inheritdoc} + */ + public function viewElements(FieldItemListInterface $items, $langcode) { + $elements = []; + + foreach ($items as $delta => $item) { + if ($item->date) { + /** @var \Drupal\Core\Datetime\DrupalDateTime $date */ + $date = $item->date; + $elements[$delta] = $this->buildDateWithIsoAttribute($date); + + if (!empty($item->_attributes)) { + $elements[$delta]['#attributes'] += $item->_attributes; + // Unset field item attributes since they have been included in the + // formatter output and should not be rendered in the field template. + unset($item->_attributes); + } + } + } + + return $elements; + } + + /** * Creates a formatted date value as a string. * * @param object $date @@ -167,4 +192,69 @@ protected function getFormatSettings() { return $settings; } + /** + * Creates a render array from a date object. + * + * @param \Drupal\Core\Datetime\DrupalDateTime $date + * A date object. + * + * @return array + * A render array. + */ + protected function buildDate(DrupalDateTime $date) { + if ($this->getFieldSetting('datetime_type') == DateTimeItem::DATETIME_TYPE_DATE) { + // A date without time will pick up the current time, use the default. + datetime_date_default_time($date); + } + $this->setTimeZone($date); + + $build = [ + '#markup' => $this->formatDate($date), + '#cache' => [ + 'contexts' => [ + 'timezone', + ], + ], + ]; + + return $build; + } + + /** + * Creates a render array from a date object with ISO date attribute. + * + * @param \Drupal\Core\Datetime\DrupalDateTime $date + * A date object. + * + * @return array + * A render array. + */ + protected function buildDateWithIsoAttribute(DrupalDateTime $date) { + if ($this->getFieldSetting('datetime_type') == DateTimeItem::DATETIME_TYPE_DATE) { + // A date without time will pick up the current time, use the default. + datetime_date_default_time($date); + } + + // Create the ISO date in Universal Time. + $iso_date = $date->format("Y-m-d\TH:i:s") . 'Z'; + + $this->setTimeZone($date); + + $build = [ + '#theme' => 'time', + '#text' => $this->formatDate($date), + '#html' => FALSE, + '#attributes' => [ + 'datetime' => $iso_date, + ], + '#cache' => [ + 'contexts' => [ + 'timezone', + ], + ], + ]; + + return $build; + } + } diff --git a/core/modules/datetime/src/Plugin/Field/FieldFormatter/DateTimePlainFormatter.php b/core/modules/datetime/src/Plugin/Field/FieldFormatter/DateTimePlainFormatter.php index d35d3801da..7f0dee2c31 100644 --- a/core/modules/datetime/src/Plugin/Field/FieldFormatter/DateTimePlainFormatter.php +++ b/core/modules/datetime/src/Plugin/Field/FieldFormatter/DateTimePlainFormatter.php @@ -25,27 +25,12 @@ public function viewElements(FieldItemListInterface $items, $langcode) { $elements = []; foreach ($items as $delta => $item) { - $output = ''; if (!empty($item->date)) { /** @var \Drupal\Core\Datetime\DrupalDateTime $date */ $date = $item->date; - if ($this->getFieldSetting('datetime_type') == 'date') { - // A date without time will pick up the current time, use the default. - datetime_date_default_time($date); - } - $this->setTimeZone($date); - - $output = $this->formatDate($date); + $elements[$delta] = $this->buildDate($date); } - $elements[$delta] = [ - '#cache' => [ - 'contexts' => [ - 'timezone', - ], - ], - '#markup' => $output, - ]; } return $elements; diff --git a/core/modules/datetime/src/Plugin/Field/FieldType/DateTimeItem.php b/core/modules/datetime/src/Plugin/Field/FieldType/DateTimeItem.php index f5c06e6e5d..330782b0d6 100644 --- a/core/modules/datetime/src/Plugin/Field/FieldType/DateTimeItem.php +++ b/core/modules/datetime/src/Plugin/Field/FieldType/DateTimeItem.php @@ -17,7 +17,8 @@ * description = @Translation("Create and store date values."), * default_widget = "datetime_default", * default_formatter = "datetime_default", - * list_class = "\Drupal\datetime\Plugin\Field\FieldType\DateTimeFieldItemList" + * list_class = "\Drupal\datetime\Plugin\Field\FieldType\DateTimeFieldItemList", + * constraints = {"DateTimeFormat" = {}} * ) */ class DateTimeItem extends FieldItemBase { diff --git a/core/modules/datetime/src/Plugin/Validation/Constraint/DateTimeFormatConstraint.php b/core/modules/datetime/src/Plugin/Validation/Constraint/DateTimeFormatConstraint.php new file mode 100644 index 0000000000..5ed340d44a --- /dev/null +++ b/core/modules/datetime/src/Plugin/Validation/Constraint/DateTimeFormatConstraint.php @@ -0,0 +1,38 @@ +getValue()['value']; + if (!is_string($value)) { + $this->context->addViolation($constraint->badType); + } + else { + $datetime_type = $item->getFieldDefinition()->getSetting('datetime_type'); + $format = $datetime_type === DateTimeItem::DATETIME_TYPE_DATE ? DATETIME_DATE_STORAGE_FORMAT : DATETIME_DATETIME_STORAGE_FORMAT; + $date = NULL; + try { + $date = DateTimePlus::createFromFormat($format, $value, new \DateTimeZone(DATETIME_STORAGE_TIMEZONE)); + } + catch (\InvalidArgumentException $e) { + $this->context->addViolation($constraint->badFormat, [ + '@value' => $value, + '@format' => $format, + ]); + return; + } + catch (\UnexpectedValueException $e) { + $this->context->addViolation($constraint->badValue, [ + '@value' => $value, + '@format' => $format, + ]); + return; + } + if ($date === NULL || $date->hasErrors()) { + $this->context->addViolation($constraint->badFormat, [ + '@value' => $value, + '@format' => $format, + ]); + } + } + } + } + +} diff --git a/core/modules/datetime/src/Tests/Views/DateTimeHandlerTestBase.php b/core/modules/datetime/src/Tests/Views/DateTimeHandlerTestBase.php index 42f309d6d7..0f068ab9ee 100644 --- a/core/modules/datetime/src/Tests/Views/DateTimeHandlerTestBase.php +++ b/core/modules/datetime/src/Tests/Views/DateTimeHandlerTestBase.php @@ -2,6 +2,8 @@ namespace Drupal\datetime\Tests\Views; +@trigger_error('\Drupal\datetime\Tests\Views\DateTimeHandlerTestBase is deprecated in Drupal 8.4.0 and will be removed before Drupal 9.0.0. Instead, use \Drupal\Tests\BrowserTestBase', E_USER_DEPRECATED); + use Drupal\datetime\Plugin\Field\FieldType\DateTimeItem; use Drupal\field\Entity\FieldConfig; use Drupal\node\Entity\NodeType; @@ -11,6 +13,9 @@ /** * Base class for testing datetime handlers. + * + * @deprecated in Drupal 8.4.0 and will be removed before Drupal 9.0.0. + * Use \Drupal\Tests\BrowserTestBase. */ abstract class DateTimeHandlerTestBase extends HandlerTestBase { diff --git a/core/modules/datetime/tests/src/Functional/EntityResource/EntityTest/EntityTestDateonlyTest.php b/core/modules/datetime/tests/src/Functional/EntityResource/EntityTest/EntityTestDateonlyTest.php new file mode 100644 index 0000000000..1051ce45ff --- /dev/null +++ b/core/modules/datetime/tests/src/Functional/EntityResource/EntityTest/EntityTestDateonlyTest.php @@ -0,0 +1,154 @@ + static::$fieldName, + 'type' => 'datetime', + 'entity_type' => static::$entityTypeId, + 'settings' => ['datetime_type' => DateTimeItem::DATETIME_TYPE_DATE], + ]) + ->save(); + + FieldConfig::create([ + 'field_name' => static::$fieldName, + 'entity_type' => static::$entityTypeId, + 'bundle' => $this->entity->bundle(), + 'settings' => ['default_value' => static::$dateString], + ]) + ->save(); + + // Reload entity so that it has the new field. + $this->entity = $this->entityStorage->load($this->entity->id()); + $this->entity->set(static::$fieldName, ['value' => static::$dateString]); + $this->entity->save(); + } + + /** + * {@inheritdoc} + */ + protected function createEntity() { + $entity_test = EntityTest::create([ + 'name' => 'Llama', + 'type' => static::$entityTypeId, + static::$fieldName => static::$dateString, + ]); + $entity_test->setOwnerId(0); + $entity_test->save(); + + return $entity_test; + } + + /** + * {@inheritdoc} + */ + protected function getExpectedNormalizedEntity() { + return parent::getExpectedNormalizedEntity() + [ + static::$fieldName => [ + [ + 'value' => $this->entity->get(static::$fieldName)->value, + ], + ], + ]; + } + + /** + * {@inheritdoc} + */ + protected function getNormalizedPostEntity() { + return parent::getNormalizedPostEntity() + [ + static::$fieldName => [ + [ + 'value' => static::$dateString, + ], + ], + ]; + } + + /** + * {@inheritdoc} + */ + protected function assertNormalizationEdgeCases($method, Url $url, array $request_options) { + parent::assertNormalizationEdgeCases($method, $url, $request_options); + + if ($this->entity->getEntityType()->hasKey('bundle')) { + $fieldName = static::$fieldName; + + // DX: 422 when date type is incorrect. + $normalization = $this->getNormalizedPostEntity(); + $normalization[static::$fieldName][0]['value'] = [ + '2017', '03', '01', + ]; + + $request_options[RequestOptions::BODY] = $this->serializer->encode($normalization, static::$format); + $response = $this->request($method, $url, $request_options); + $message = "Unprocessable Entity: validation failed.\n{$fieldName}.0: The datetime value must be a string.\n{$fieldName}.0.value: This value should be of the correct primitive type.\n"; + $this->assertResourceErrorResponse(422, $message, $response); + + // DX: 422 when date format is incorrect. + $normalization = $this->getNormalizedPostEntity(); + $value = '2017-03-01T01:02:03'; + $normalization[static::$fieldName][0]['value'] = $value; + + $request_options[RequestOptions::BODY] = $this->serializer->encode($normalization, static::$format); + $response = $this->request($method, $url, $request_options); + $message = "Unprocessable Entity: validation failed.\n{$fieldName}.0: The datetime value '{$value}' is invalid for the format 'Y-m-d'\n"; + $this->assertResourceErrorResponse(422, $message, $response); + + // DX: 422 when value is not a valid date. + $normalization = $this->getNormalizedPostEntity(); + $value = '2017-13-55'; + $normalization[static::$fieldName][0]['value'] = $value; + + $request_options[RequestOptions::BODY] = $this->serializer->encode($normalization, static::$format); + $response = $this->request($method, $url, $request_options); + $message = "Unprocessable Entity: validation failed.\n{$fieldName}.0: The datetime value '{$value}' did not parse properly for the format 'Y-m-d'\n{$fieldName}.0.value: This value should be of the correct primitive type.\n"; + $this->assertResourceErrorResponse(422, $message, $response); + } + } + +} diff --git a/core/modules/datetime/tests/src/Functional/EntityResource/EntityTest/EntityTestDatetimeTest.php b/core/modules/datetime/tests/src/Functional/EntityResource/EntityTest/EntityTestDatetimeTest.php new file mode 100644 index 0000000000..ffce48c340 --- /dev/null +++ b/core/modules/datetime/tests/src/Functional/EntityResource/EntityTest/EntityTestDatetimeTest.php @@ -0,0 +1,154 @@ + static::$fieldName, + 'type' => 'datetime', + 'entity_type' => static::$entityTypeId, + 'settings' => ['datetime_type' => DateTimeItem::DATETIME_TYPE_DATETIME], + ]) + ->save(); + + FieldConfig::create([ + 'field_name' => static::$fieldName, + 'entity_type' => static::$entityTypeId, + 'bundle' => $this->entity->bundle(), + 'settings' => ['default_value' => static::$dateString], + ]) + ->save(); + + // Reload entity so that it has the new field. + $this->entity = $this->entityStorage->load($this->entity->id()); + $this->entity->set(static::$fieldName, ['value' => static::$dateString]); + $this->entity->save(); + } + + /** + * {@inheritdoc} + */ + protected function createEntity() { + $entity_test = EntityTest::create([ + 'name' => 'Llama', + 'type' => static::$entityTypeId, + static::$fieldName => static::$dateString, + ]); + $entity_test->setOwnerId(0); + $entity_test->save(); + + return $entity_test; + } + + /** + * {@inheritdoc} + */ + protected function getExpectedNormalizedEntity() { + return parent::getExpectedNormalizedEntity() + [ + static::$fieldName => [ + [ + 'value' => $this->entity->get(static::$fieldName)->value, + ], + ], + ]; + } + + /** + * {@inheritdoc} + */ + protected function getNormalizedPostEntity() { + return parent::getNormalizedPostEntity() + [ + static::$fieldName => [ + [ + 'value' => static::$dateString, + ], + ], + ]; + } + + /** + * {@inheritdoc} + */ + protected function assertNormalizationEdgeCases($method, Url $url, array $request_options) { + parent::assertNormalizationEdgeCases($method, $url, $request_options); + + if ($this->entity->getEntityType()->hasKey('bundle')) { + $fieldName = static::$fieldName; + + // DX: 422 when date type is incorrect. + $normalization = $this->getNormalizedPostEntity(); + $normalization[static::$fieldName][0]['value'] = [ + '2017', '03', '01', '21', '53', '00', + ]; + + $request_options[RequestOptions::BODY] = $this->serializer->encode($normalization, static::$format); + $response = $this->request($method, $url, $request_options); + $message = "Unprocessable Entity: validation failed.\n{$fieldName}.0: The datetime value must be a string.\n{$fieldName}.0.value: This value should be of the correct primitive type.\n"; + $this->assertResourceErrorResponse(422, $message, $response); + + // DX: 422 when date format is incorrect. + $normalization = $this->getNormalizedPostEntity(); + $value = '2017-03-01'; + $normalization[static::$fieldName][0]['value'] = $value; + + $request_options[RequestOptions::BODY] = $this->serializer->encode($normalization, static::$format); + $response = $this->request($method, $url, $request_options); + $message = "Unprocessable Entity: validation failed.\n{$fieldName}.0: The datetime value '{$value}' is invalid for the format 'Y-m-d\\TH:i:s'\n"; + $this->assertResourceErrorResponse(422, $message, $response); + + // DX: 422 when date format is incorrect. + $normalization = $this->getNormalizedPostEntity(); + $value = '2017-13-55T20:02:00'; + $normalization[static::$fieldName][0]['value'] = $value; + + $request_options[RequestOptions::BODY] = $this->serializer->encode($normalization, static::$format); + $response = $this->request($method, $url, $request_options); + $message = "Unprocessable Entity: validation failed.\n{$fieldName}.0: The datetime value '{$value}' did not parse properly for the format 'Y-m-d\\TH:i:s'\n{$fieldName}.0.value: This value should be of the correct primitive type.\n"; + $this->assertResourceErrorResponse(422, $message, $response); + } + } + +} diff --git a/core/modules/datetime/tests/src/Kernel/DateTimeItemTest.php b/core/modules/datetime/tests/src/Kernel/DateTimeItemTest.php index e28667f072..98840078cb 100644 --- a/core/modules/datetime/tests/src/Kernel/DateTimeItemTest.php +++ b/core/modules/datetime/tests/src/Kernel/DateTimeItemTest.php @@ -80,16 +80,19 @@ public function testDateTime() { $this->assertTrue($entity->field_datetime[0] instanceof FieldItemInterface, 'Field item implements interface.'); $this->assertEqual($entity->field_datetime->value, $value); $this->assertEqual($entity->field_datetime[0]->value, $value); + $this->assertEquals(DATETIME_STORAGE_TIMEZONE, $entity->field_datetime->date->getTimeZone()->getName()); // Verify changing the date value. $new_value = '2016-11-04T00:21:00'; $entity->field_datetime->value = $new_value; $this->assertEqual($entity->field_datetime->value, $new_value); + $this->assertEquals(DATETIME_STORAGE_TIMEZONE, $entity->field_datetime->date->getTimeZone()->getName()); // Read changed entity and assert changed values. $this->entityValidateAndSave($entity); $entity = EntityTest::load($id); $this->assertEqual($entity->field_datetime->value, $new_value); + $this->assertEquals(DATETIME_STORAGE_TIMEZONE, $entity->field_datetime->date->getTimeZone()->getName()); // Test the generateSampleValue() method. $entity = EntityTest::create(); @@ -118,16 +121,19 @@ public function testDateOnly() { $this->assertTrue($entity->field_datetime[0] instanceof FieldItemInterface, 'Field item implements interface.'); $this->assertEqual($entity->field_datetime->value, $value); $this->assertEqual($entity->field_datetime[0]->value, $value); + $this->assertEquals(DATETIME_STORAGE_TIMEZONE, $entity->field_datetime->date->getTimeZone()->getName()); // Verify changing the date value. $new_value = '2016-11-04'; $entity->field_datetime->value = $new_value; $this->assertEqual($entity->field_datetime->value, $new_value); + $this->assertEquals(DATETIME_STORAGE_TIMEZONE, $entity->field_datetime->date->getTimeZone()->getName()); // Read changed entity and assert changed values. $this->entityValidateAndSave($entity); $entity = EntityTest::load($id); $this->assertEqual($entity->field_datetime->value, $new_value); + $this->assertEquals(DATETIME_STORAGE_TIMEZONE, $entity->field_datetime->date->getTimeZone()->getName()); // Test the generateSampleValue() method. $entity = EntityTest::create(); @@ -152,6 +158,7 @@ public function testSetValue() { $id = $entity->id(); $entity = EntityTest::load($id); $this->assertEqual($entity->field_datetime[0]->value, $value, 'DateTimeItem::setValue() works with string value.'); + $this->assertEquals(DATETIME_STORAGE_TIMEZONE, $entity->field_datetime->date->getTimeZone()->getName()); // Test DateTimeItem::setValue() using property array. $entity = EntityTest::create(); @@ -162,6 +169,7 @@ public function testSetValue() { $id = $entity->id(); $entity = EntityTest::load($id); $this->assertEqual($entity->field_datetime[0]->value, $value, 'DateTimeItem::setValue() works with array value.'); + $this->assertEquals(DATETIME_STORAGE_TIMEZONE, $entity->field_datetime->date->getTimeZone()->getName()); // Test a date-only field. $this->fieldStorage->setSetting('datetime_type', DateTimeItem::DATETIME_TYPE_DATE); @@ -176,6 +184,7 @@ public function testSetValue() { $id = $entity->id(); $entity = EntityTest::load($id); $this->assertEqual($entity->field_datetime[0]->value, $value, 'DateTimeItem::setValue() works with string value.'); + $this->assertEquals(DATETIME_STORAGE_TIMEZONE, $entity->field_datetime->date->getTimeZone()->getName()); // Test DateTimeItem::setValue() using property array. $entity = EntityTest::create(); @@ -186,6 +195,7 @@ public function testSetValue() { $id = $entity->id(); $entity = EntityTest::load($id); $this->assertEqual($entity->field_datetime[0]->value, $value, 'DateTimeItem::setValue() works with array value.'); + $this->assertEquals(DATETIME_STORAGE_TIMEZONE, $entity->field_datetime->date->getTimeZone()->getName()); } /** @@ -205,6 +215,7 @@ public function testSetValueProperty() { $id = $entity->id(); $entity = EntityTest::load($id); $this->assertEqual($entity->field_datetime[0]->value, $value, '"Value" property can be set directly.'); + $this->assertEquals(DATETIME_STORAGE_TIMEZONE, $entity->field_datetime->date->getTimeZone()->getName()); // Test Date::setValue() with a date-only field. // Test a date+time field. @@ -219,6 +230,107 @@ public function testSetValueProperty() { $id = $entity->id(); $entity = EntityTest::load($id); $this->assertEqual($entity->field_datetime[0]->value, $value, '"Value" property can be set directly.'); + $this->assertEquals(DATETIME_STORAGE_TIMEZONE, $entity->field_datetime->date->getTimeZone()->getName()); + } + + /** + * Tests the constraint validations for fields with date and time. + * + * @dataProvider datetimeValidationProvider + */ + public function testDatetimeValidation($value) { + $this->setExpectedException(\PHPUnit_Framework_AssertionFailedError::class); + + $this->fieldStorage->setSetting('datetime_type', DateTimeItem::DATETIME_TYPE_DATETIME); + $this->fieldStorage->save(); + $entity = EntityTest::create(); + + $entity->set('field_datetime', $value); + $this->entityValidateAndSave($entity); + } + + /** + * Provider for testDatetimeValidation(). + */ + public function datetimeValidationProvider() { + return [ + // Valid ISO 8601 dates, but unsupported by DateTimeItem. + ['2014-01-01T20:00:00Z'], + ['2014-01-01T20:00:00+04:00'], + ['2014-01-01T20:00:00+0400'], + ['2014-01-01T20:00:00+04'], + ['2014-01-01T20:00:00.123'], + ['2014-01-01T200000'], + ['2014-01-01T2000'], + ['2014-01-01T20'], + ['20140101T20:00:00'], + ['2014-01T20:00:00'], + ['2014-001T20:00:00'], + ['2014001T20:00:00'], + // Valid date strings, but unsupported by DateTimeItem. + ['2016-11-03 20:52:00'], + ['Thu, 03 Nov 2014 20:52:00 -0400'], + ['Thursday, November 3, 2016 - 20:52'], + ['Thu, 11/03/2016 - 20:52'], + ['11/03/2016 - 20:52'], + // Invalid date strings. + ['YYYY-01-01T20:00:00'], + ['2014-MM-01T20:00:00'], + ['2014-01-DDT20:00:00'], + ['2014-01-01Thh:00:00'], + ['2014-01-01T20:mm:00'], + ['2014-01-01T20:00:ss'], + // Invalid dates. + ['2014-13-13T20:00:00'], + ['2014-01-55T20:00:00'], + ['2014-01-01T25:00:00'], + ['2014-01-01T00:70:00'], + ['2014-01-01T00:00:70'], + // Proper format for different field setting. + ['2014-01-01'], + // Wrong input type. + [['2014', '01', '01', '00', '00', '00']], + ]; + } + + /** + * Tests the constraint validations for fields with date only. + * + * @dataProvider dateonlyValidationProvider + */ + public function testDateonlyValidation($value) { + $this->setExpectedException(\PHPUnit_Framework_AssertionFailedError::class); + + $this->fieldStorage->setSetting('datetime_type', DateTimeItem::DATETIME_TYPE_DATE); + $this->fieldStorage->save(); + $entity = EntityTest::create(); + + $entity->set('field_datetime', $value); + $this->entityValidateAndSave($entity); + } + + /** + * Provider for testDatetimeValidation(). + */ + public function dateonlyValidationProvider() { + return [ + // Valid date strings, but unsupported by DateTimeItem. + ['Thu, 03 Nov 2014'], + ['Thursday, November 3, 2016'], + ['Thu, 11/03/2016'], + ['11/03/2016'], + // Invalid date strings. + ['YYYY-01-01'], + ['2014-MM-01'], + ['2014-01-DD'], + // Invalid dates. + ['2014-13-01'], + ['2014-01-55'], + // Proper format for different field setting. + ['2014-01-01T20:00:00'], + // Wrong input type. + [['2014', '01', '01']], + ]; } } diff --git a/core/modules/datetime/src/Tests/Views/ArgumentDateTimeTest.php b/core/modules/datetime/tests/src/Kernel/Views/ArgumentDateTimeTest.php similarity index 94% rename from core/modules/datetime/src/Tests/Views/ArgumentDateTimeTest.php rename to core/modules/datetime/tests/src/Kernel/Views/ArgumentDateTimeTest.php index e3a17bb9c4..6145483958 100644 --- a/core/modules/datetime/src/Tests/Views/ArgumentDateTimeTest.php +++ b/core/modules/datetime/tests/src/Kernel/Views/ArgumentDateTimeTest.php @@ -1,7 +1,8 @@ nodes[] = $this->drupalCreateNode([ + $node = Node::create([ + 'title' => $this->randomMachineName(8), + 'type' => 'page', 'field_date' => [ 'value' => $date, ] ]); + $node->save(); + $this->nodes[] = $node; } } diff --git a/core/modules/datetime/tests/src/Kernel/Views/DateTimeHandlerTestBase.php b/core/modules/datetime/tests/src/Kernel/Views/DateTimeHandlerTestBase.php new file mode 100644 index 0000000000..f0c9c78614 --- /dev/null +++ b/core/modules/datetime/tests/src/Kernel/Views/DateTimeHandlerTestBase.php @@ -0,0 +1,79 @@ +installEntitySchema('node'); + $this->installEntitySchema('user'); + + // Add a date field to page nodes. + $node_type = NodeType::create([ + 'type' => 'page', + 'name' => 'page' + ]); + $node_type->save(); + $fieldStorage = FieldStorageConfig::create([ + 'field_name' => static::$field_name, + 'entity_type' => 'node', + 'type' => 'datetime', + 'settings' => ['datetime_type' => DateTimeItem::DATETIME_TYPE_DATETIME], + ]); + $fieldStorage->save(); + $field = FieldConfig::create([ + 'field_storage' => $fieldStorage, + 'bundle' => 'page', + 'required' => TRUE, + ]); + $field->save(); + + // Views needs to be aware of the new field. + $this->container->get('views.views_data')->clear(); + + // Set column map. + $this->map = [ + 'nid' => 'nid', + ]; + + // Load test views. + ViewTestData::createTestViews(get_class($this), ['datetime_test']); + } + +} diff --git a/core/modules/datetime/src/Tests/Views/FilterDateTest.php b/core/modules/datetime/tests/src/Kernel/Views/FilterDateTest.php similarity index 90% rename from core/modules/datetime/src/Tests/Views/FilterDateTest.php rename to core/modules/datetime/tests/src/Kernel/Views/FilterDateTest.php index 2a8d7cdb29..566285e256 100644 --- a/core/modules/datetime/src/Tests/Views/FilterDateTest.php +++ b/core/modules/datetime/tests/src/Kernel/Views/FilterDateTest.php @@ -1,8 +1,10 @@ nodes[] = $this->drupalCreateNode([ + $node = Node::create([ + 'title' => $this->randomMachineName(8), + 'type' => 'page', 'field_date' => [ 'value' => $date, ] ]); + $node->save(); + $this->nodes[] = $node; } } diff --git a/core/modules/datetime/src/Tests/Views/FilterDateTimeTest.php b/core/modules/datetime/tests/src/Kernel/Views/FilterDateTimeTest.php similarity index 94% rename from core/modules/datetime/src/Tests/Views/FilterDateTimeTest.php rename to core/modules/datetime/tests/src/Kernel/Views/FilterDateTimeTest.php index a15263d57d..1e8e929f33 100644 --- a/core/modules/datetime/src/Tests/Views/FilterDateTimeTest.php +++ b/core/modules/datetime/tests/src/Kernel/Views/FilterDateTimeTest.php @@ -1,7 +1,8 @@ format(static::$date, 'custom', DATETIME_DATETIME_STORAGE_FORMAT, DATETIME_STORAGE_TIMEZONE), ]; foreach ($dates as $date) { - $this->nodes[] = $this->drupalCreateNode([ + $node = Node::create([ + 'title' => $this->randomMachineName(8), + 'type' => 'page', 'field_date' => [ 'value' => $date, ] ]); + $node->save(); + $this->nodes[] = $node; } } diff --git a/core/modules/datetime/src/Tests/Views/SortDateTimeTest.php b/core/modules/datetime/tests/src/Kernel/Views/SortDateTimeTest.php similarity index 91% rename from core/modules/datetime/src/Tests/Views/SortDateTimeTest.php rename to core/modules/datetime/tests/src/Kernel/Views/SortDateTimeTest.php index c1f23a04c2..7375c4db29 100644 --- a/core/modules/datetime/src/Tests/Views/SortDateTimeTest.php +++ b/core/modules/datetime/tests/src/Kernel/Views/SortDateTimeTest.php @@ -1,7 +1,8 @@ nodes[] = $this->drupalCreateNode([ + $node = Node::create([ + 'title' => $this->randomMachineName(8), + 'type' => 'page', 'field_date' => [ 'value' => $date, ] ]); + $node->save(); + $this->nodes[] = $node; } } diff --git a/core/modules/datetime_range/src/DateTimeRangeTrait.php b/core/modules/datetime_range/src/DateTimeRangeTrait.php index 5a34f2c182..3f05b82189 100644 --- a/core/modules/datetime_range/src/DateTimeRangeTrait.php +++ b/core/modules/datetime_range/src/DateTimeRangeTrait.php @@ -2,8 +2,7 @@ namespace Drupal\datetime_range; -use Drupal\Core\Datetime\DrupalDateTime; -use Drupal\datetime\Plugin\Field\FieldType\DateTimeItem; +use Drupal\Core\Field\FieldItemListInterface; /** * Provides friendly methods for datetime range. @@ -11,68 +10,40 @@ trait DateTimeRangeTrait { /** - * Creates a render array from a date object. - * - * @param \Drupal\Core\Datetime\DrupalDateTime $date - * A date object. - * - * @return array - * A render array. + * {@inheritdoc} */ - protected function buildDate(DrupalDateTime $date) { - if ($this->getFieldSetting('datetime_type') == DateTimeItem::DATETIME_TYPE_DATE) { - // A date without time will pick up the current time, use the default. - datetime_date_default_time($date); + public function viewElements(FieldItemListInterface $items, $langcode) { + $elements = []; + $separator = $this->getSetting('separator'); + + foreach ($items as $delta => $item) { + if (!empty($item->start_date) && !empty($item->end_date)) { + /** @var \Drupal\Core\Datetime\DrupalDateTime $start_date */ + $start_date = $item->start_date; + /** @var \Drupal\Core\Datetime\DrupalDateTime $end_date */ + $end_date = $item->end_date; + + if ($start_date->getTimestamp() !== $end_date->getTimestamp()) { + $elements[$delta] = [ + 'start_date' => $this->buildDateWithIsoAttribute($start_date), + 'separator' => ['#plain_text' => ' ' . $separator . ' '], + 'end_date' => $this->buildDateWithIsoAttribute($end_date), + ]; + } + else { + $elements[$delta] = $this->buildDateWithIsoAttribute($start_date); + + if (!empty($item->_attributes)) { + $elements[$delta]['#attributes'] += $item->_attributes; + // Unset field item attributes since they have been included in the + // formatter output and should not be rendered in the field template. + unset($item->_attributes); + } + } + } } - $this->setTimeZone($date); - $build = [ - '#plain_text' => $this->formatDate($date), - '#cache' => [ - 'contexts' => [ - 'timezone', - ], - ], - ]; - - return $build; - } - - /** - * Creates a render array from a date object with ISO date attribute. - * - * @param \Drupal\Core\Datetime\DrupalDateTime $date - * A date object. - * - * @return array - * A render array. - */ - protected function buildDateWithIsoAttribute(DrupalDateTime $date) { - if ($this->getFieldSetting('datetime_type') == DateTimeItem::DATETIME_TYPE_DATE) { - // A date without time will pick up the current time, use the default. - datetime_date_default_time($date); - } - - // Create the ISO date in Universal Time. - $iso_date = $date->format("Y-m-d\TH:i:s") . 'Z'; - - $this->setTimeZone($date); - - $build = [ - '#theme' => 'time', - '#text' => $this->formatDate($date), - '#html' => FALSE, - '#attributes' => [ - 'datetime' => $iso_date, - ], - '#cache' => [ - 'contexts' => [ - 'timezone', - ], - ], - ]; - - return $build; + return $elements; } } diff --git a/core/modules/datetime_range/src/Plugin/Field/FieldFormatter/DateRangeCustomFormatter.php b/core/modules/datetime_range/src/Plugin/Field/FieldFormatter/DateRangeCustomFormatter.php index a26bbef9ab..78aa8aafe2 100644 --- a/core/modules/datetime_range/src/Plugin/Field/FieldFormatter/DateRangeCustomFormatter.php +++ b/core/modules/datetime_range/src/Plugin/Field/FieldFormatter/DateRangeCustomFormatter.php @@ -38,6 +38,9 @@ public static function defaultSettings() { * {@inheritdoc} */ public function viewElements(FieldItemListInterface $items, $langcode) { + // @todo Evaluate removing this method in + // https://www.drupal.org/node/2793143 to determine if the behavior and + // markup in the base class implementation can be used instead. $elements = []; $separator = $this->getSetting('separator'); diff --git a/core/modules/datetime_range/src/Plugin/Field/FieldFormatter/DateRangeDefaultFormatter.php b/core/modules/datetime_range/src/Plugin/Field/FieldFormatter/DateRangeDefaultFormatter.php index f07e834325..b93851bbd0 100644 --- a/core/modules/datetime_range/src/Plugin/Field/FieldFormatter/DateRangeDefaultFormatter.php +++ b/core/modules/datetime_range/src/Plugin/Field/FieldFormatter/DateRangeDefaultFormatter.php @@ -2,7 +2,6 @@ namespace Drupal\datetime_range\Plugin\Field\FieldFormatter; -use Drupal\Core\Field\FieldItemListInterface; use Drupal\Core\Form\FormStateInterface; use Drupal\datetime\Plugin\Field\FieldFormatter\DateTimeDefaultFormatter; use Drupal\datetime_range\DateTimeRangeTrait; @@ -38,42 +37,6 @@ public static function defaultSettings() { /** * {@inheritdoc} */ - public function viewElements(FieldItemListInterface $items, $langcode) { - $elements = []; - $separator = $this->getSetting('separator'); - - foreach ($items as $delta => $item) { - if (!empty($item->start_date) && !empty($item->end_date)) { - /** @var \Drupal\Core\Datetime\DrupalDateTime $start_date */ - $start_date = $item->start_date; - /** @var \Drupal\Core\Datetime\DrupalDateTime $end_date */ - $end_date = $item->end_date; - - if ($start_date->getTimestamp() !== $end_date->getTimestamp()) { - $elements[$delta] = [ - 'start_date' => $this->buildDateWithIsoAttribute($start_date), - 'separator' => ['#plain_text' => ' ' . $separator . ' '], - 'end_date' => $this->buildDateWithIsoAttribute($end_date), - ]; - } - else { - $elements[$delta] = $this->buildDateWithIsoAttribute($start_date); - if (!empty($item->_attributes)) { - $elements[$delta]['#attributes'] += $item->_attributes; - // Unset field item attributes since they have been included in the - // formatter output and should not be rendered in the field template. - unset($item->_attributes); - } - } - } - } - - return $elements; - } - - /** - * {@inheritdoc} - */ public function settingsForm(array $form, FormStateInterface $form_state) { $form = parent::settingsForm($form, $form_state); diff --git a/core/modules/datetime_range/src/Plugin/Field/FieldFormatter/DateRangePlainFormatter.php b/core/modules/datetime_range/src/Plugin/Field/FieldFormatter/DateRangePlainFormatter.php index 1fb4702cd0..0f74fba644 100644 --- a/core/modules/datetime_range/src/Plugin/Field/FieldFormatter/DateRangePlainFormatter.php +++ b/core/modules/datetime_range/src/Plugin/Field/FieldFormatter/DateRangePlainFormatter.php @@ -57,6 +57,13 @@ public function viewElements(FieldItemListInterface $items, $langcode) { } else { $elements[$delta] = $this->buildDate($start_date); + + if (!empty($item->_attributes)) { + $elements[$delta]['#attributes'] += $item->_attributes; + // Unset field item attributes since they have been included in the + // formatter output and should not be rendered in the field template. + unset($item->_attributes); + } } } } diff --git a/core/modules/datetime_range/tests/src/Functional/DateRangeFieldTest.php b/core/modules/datetime_range/tests/src/Functional/DateRangeFieldTest.php index ebeb4b8f2b..23ba8fab03 100644 --- a/core/modules/datetime_range/tests/src/Functional/DateRangeFieldTest.php +++ b/core/modules/datetime_range/tests/src/Functional/DateRangeFieldTest.php @@ -170,6 +170,16 @@ public function testDateRangeField() { $output = $this->renderTestEntity($id); $this->assertContains($expected, $output, new FormattableMarkup('Formatted date field using daterange_custom format displayed as %expected.', ['%expected' => $expected])); + // Test that allowed markup in custom format is preserved and XSS is + // removed. + $this->displayOptions['settings']['date_format'] = '\\<\\s\\t\\r\\o\\n\\g\\>m/d/Y\\<\\/\\s\\t\\r\\o\\n\\g\\>\\<\\s\\c\\r\\i\\p\\t\\>\\a\\l\\e\\r\\t\\(\\S\\t\\r\\i\\n\\g\\.\\f\\r\\o\\m\\C\\h\\a\\r\\C\\o\\d\\e\\(\\8\\8\\,\\8\\3\\,\\8\\3\\)\\)\\<\\/\\s\\c\\r\\i\\p\\t\\>'; + entity_get_display($this->field->getTargetEntityTypeId(), $this->field->getTargetBundle(), 'full') + ->setComponent($field_name, $this->displayOptions) + ->save(); + $expected = '' . $start_date->format('m/d/Y') . 'alert(String.fromCharCode(88,83,83)) - ' . $end_date->format('m/d/Y') . 'alert(String.fromCharCode(88,83,83))'; + $output = $this->renderTestEntity($id); + $this->assertContains($expected, $output, new FormattableMarkup('Formatted date field using daterange_custom format displayed as %expected.', ['%expected' => $expected])); + // Test formatters when start date and end date are the same $this->drupalGet('entity_test/add'); $value = '2012-12-31 00:00:00'; diff --git a/core/modules/dblog/config/schema/dblog.views.schema.yml b/core/modules/dblog/config/schema/dblog.views.schema.yml index e504364e0e..a2e09af385 100644 --- a/core/modules/dblog/config/schema/dblog.views.schema.yml +++ b/core/modules/dblog/config/schema/dblog.views.schema.yml @@ -11,3 +11,7 @@ views.field.dblog_message: views.field.dblog_operations: type: views_field label: 'Operation link markup' + +views.filter.dblog_types: + type: 'views.filter.in_operator' + label: 'Types' diff --git a/core/modules/dblog/dblog.install b/core/modules/dblog/dblog.install index f226ed04d9..8da830b310 100644 --- a/core/modules/dblog/dblog.install +++ b/core/modules/dblog/dblog.install @@ -90,3 +90,69 @@ function dblog_schema() { return $schema; } + +/** + * Use standard plugin for wid and uid fields. Use dblog_types for type filter. + */ +function dblog_update_8400() { + $config_factory = \Drupal::configFactory(); + + foreach ($config_factory->listAll('views.view.') as $view_config_name) { + $view = $config_factory->getEditable($view_config_name); + if ($view->get('base_table') != 'watchdog') { + continue; + } + + $save = FALSE; + foreach ($view->get('display') as $display_name => $display) { + // Iterate through all the fields of watchdog views based tables. + if (isset($display['display_options']['fields'])) { + foreach ($display['display_options']['fields'] as $field_name => $field) { + // We are only interested in wid and uid fields from the watchdog + // table that still use the numeric id. + if (isset($field['table']) && + $field['table'] === 'watchdog' && + $field['plugin_id'] == 'numeric' && + in_array($field['field'], ['wid', 'uid'])) { + + $save = TRUE; + $new_value = $field; + $new_value['plugin_id'] = 'standard'; + + // Delete all the attributes related to numeric fields. + unset( + $new_value['set_precision'], + $new_value['precision'], + $new_value['decimal'], + $new_value['separator'], + $new_value['format_plural'], + $new_value['format_plural_string'], + $new_value['prefix'], + $new_value['suffix'] + ); + $view->set("display.$display_name.display_options.fields.$field_name", $new_value); + } + } + } + + // Iterate all filters looking for type filters to update. + if (isset($display['display_options']['filters'])) { + foreach ($display['display_options']['filters'] as $filter_name => $filter) { + if (isset($filter['table']) && + $filter['table'] === 'watchdog' && + $filter['plugin_id'] == 'in_operator' && + $filter['field'] == 'type') { + + $save = TRUE; + $filter['plugin_id'] = 'dblog_types'; + $view->set("display.$display_name.display_options.filters.$filter_name", $filter); + } + } + } + } + + if ($save) { + $view->save(); + } + } +} diff --git a/core/modules/dblog/dblog.module b/core/modules/dblog/dblog.module index ed92d6c8f2..f33f74902f 100644 --- a/core/modules/dblog/dblog.module +++ b/core/modules/dblog/dblog.module @@ -12,6 +12,7 @@ use Drupal\Core\Form\FormStateInterface; use Drupal\Core\Routing\RouteMatchInterface; use Drupal\Core\StringTranslation\TranslatableMarkup; +use Drupal\views\ViewEntityInterface; /** * Implements hook_help(). @@ -115,3 +116,74 @@ function dblog_form_system_logging_settings_alter(&$form, FormStateInterface $fo function dblog_logging_settings_submit($form, FormStateInterface $form_state) { \Drupal::configFactory()->getEditable('dblog.settings')->set('row_limit', $form_state->getValue('dblog_row_limit'))->save(); } + +/** + * Implements hook_ENTITY_TYPE_presave() for views entities. + * + * This hook ensures there are no views based that are using a wrong plugin for + * wid and uid fields on views that use watchdog as base table. + * + * @deprecated in Drupal 8.4.x and will be removed before 9.0.0. + * + * @see https://www.drupal.org/node/2876378 + */ +function dblog_view_presave(ViewEntityInterface $view) { + // Only interested in watchdog based views. + if ($view->get('base_table') != 'watchdog') { + return; + } + + $displays = $view->get('display'); + $update = FALSE; + foreach ($displays as $display_name => $display) { + + // Iterate through all the fields of watchdog views based tables. + if (isset($display['display_options']['fields'])) { + foreach ($display['display_options']['fields'] as $field_name => $field) { + // We are only interested in wid and uid fields from the watchdog table + // that still use the numeric id. + if (isset($field['table']) && + $field['table'] === 'watchdog' && + $field['plugin_id'] == 'numeric' && + in_array($field['field'], ['wid', 'uid'], TRUE)) { + + $displays[$display_name]['display_options']['fields'][$field_name]['plugin_id'] = 'standard'; + + // Delete all the attributes related to numeric fields. + unset( + $displays[$display_name]['display_options']['fields'][$field_name]['set_precision'], + $displays[$display_name]['display_options']['fields'][$field_name]['precision'], + $displays[$display_name]['display_options']['fields'][$field_name]['decimal'], + $displays[$display_name]['display_options']['fields'][$field_name]['separator'], + $displays[$display_name]['display_options']['fields'][$field_name]['format_plural'], + $displays[$display_name]['display_options']['fields'][$field_name]['format_plural_string'], + $displays[$display_name]['display_options']['fields'][$field_name]['prefix'], + $displays[$display_name]['display_options']['fields'][$field_name]['suffix'] + ); + + $update = TRUE; + @trigger_error("The numeric plugin for watchdog.$field_name field is deprecated in Drupal 8.4.0 and will be removed before Drupal 9.0.0. Must use standard plugin instead. See https://www.drupal.org/node/2876378.", E_USER_DEPRECATED); + } + } + } + + // Iterate all filters looking for type filters to update. + if (isset($display['display_options']['filters'])) { + foreach ($display['display_options']['filters'] as $filter_name => $filter) { + if (isset($filter['table']) && + $filter['table'] === 'watchdog' && + $filter['plugin_id'] == 'in_operator' && + $filter['field'] == 'type') { + + $displays[$display_name]['display_options']['filters'][$filter_name]['plugin_id'] = 'dblog_types'; + $update = TRUE; + @trigger_error("The in_operator plugin for watchdog.type filter is deprecated in Drupal 8.4.0 and will be removed before Drupal 9.0.0. Must use dblog_types plugin instead. See https://www.drupal.org/node/2876378.", E_USER_DEPRECATED); + } + } + } + } + + if ($update) { + $view->set('display', $displays); + } +} diff --git a/core/modules/dblog/dblog.views.inc b/core/modules/dblog/dblog.views.inc index 20ad9ceb29..6ad9e68ce4 100644 --- a/core/modules/dblog/dblog.views.inc +++ b/core/modules/dblog/dblog.views.inc @@ -24,7 +24,7 @@ function dblog_views_data() { 'title' => t('WID'), 'help' => t('Unique watchdog event ID.'), 'field' => [ - 'id' => 'numeric', + 'id' => 'standard', ], 'filter' => [ 'id' => 'numeric', @@ -39,9 +39,9 @@ function dblog_views_data() { $data['watchdog']['uid'] = [ 'title' => t('UID'), - 'help' => t('The user ID of the user on which the log entry was written..'), + 'help' => t('The user ID of the user on which the log entry was written.'), 'field' => [ - 'id' => 'numeric', + 'id' => 'standard', ], 'filter' => [ 'id' => 'numeric', @@ -52,7 +52,7 @@ function dblog_views_data() { 'relationship' => [ 'title' => t('User'), 'help' => t('The user on which the log entry as written.'), - 'base' => 'users', + 'base' => 'users_field_data', 'base field' => 'uid', 'id' => 'standard', ], @@ -68,8 +68,7 @@ function dblog_views_data() { 'id' => 'string', ], 'filter' => [ - 'id' => 'in_operator', - 'options callback' => '_dblog_get_message_types', + 'id' => 'dblog_types', ], 'sort' => [ 'id' => 'standard', @@ -120,7 +119,7 @@ function dblog_views_data() { ], 'filter' => [ 'id' => 'in_operator', - 'options callback' => 'Drupal\dblog\Controller\DbLogController::getLogLevelClassMap', + 'options callback' => 'Drupal\Core\Logger\RfcLogLevel::getLevels', ], 'sort' => [ 'id' => 'standard', diff --git a/core/modules/dblog/src/Plugin/views/filter/DblogTypes.php b/core/modules/dblog/src/Plugin/views/filter/DblogTypes.php new file mode 100644 index 0000000000..23ea736ea9 --- /dev/null +++ b/core/modules/dblog/src/Plugin/views/filter/DblogTypes.php @@ -0,0 +1,24 @@ +valueOptions)) { + $this->valueOptions = _dblog_get_message_types(); + } + return $this->valueOptions; + } + +} diff --git a/core/modules/dblog/src/Tests/Update/DblogFiltersAndFieldsUpgradeTest.php b/core/modules/dblog/src/Tests/Update/DblogFiltersAndFieldsUpgradeTest.php new file mode 100644 index 0000000000..d988d71e9d --- /dev/null +++ b/core/modules/dblog/src/Tests/Update/DblogFiltersAndFieldsUpgradeTest.php @@ -0,0 +1,77 @@ +databaseDumpFiles = [ + __DIR__ . '/../../../../system/tests/fixtures/update/drupal-8.bare.standard.php.gz', + __DIR__ . '/../../../tests/fixtures/update/dblog-2851293.php', + ]; + } + + /** + * Tests that field and filter handlers are updated properly. + */ + public function testDblogUpgradePath() { + + $this->runUpdates(); + + $view = Views::getView('dblog_2851293'); + $data = $view->storage->toArray(); + $fields = $data['display']['default']['display_options']['fields']; + + // The 'wid' and 'uid' fields should use the standard plugin now. + $this->assertEqual('standard', $fields['wid']['plugin_id']); + $this->assertEqual('standard', $fields['uid']['plugin_id']); + + $filters = $data['display']['default']['display_options']['filters']; + // The 'type' filter should use the dblog_types plugin now. + $this->assertEqual('dblog_types', $filters['type']['plugin_id']); + + // Now that the view had been converted, try the same approach but using + // dblog_view_presave() + $config_factory = \Drupal::configFactory(); + $config_view = $config_factory->getEditable('views.view.dblog_2851293'); + $config_view->setData(Yaml::decode(file_get_contents('core/modules/dblog/tests/modules/dblog_test_views/test_views/views.view.dblog_2851293.yml'))); + $config_view->save(); + + // Make sure we have a not upgraded view. + $view = Views::getView('dblog_2851293'); + $data = $view->storage->toArray(); + $fields = $data['display']['default']['display_options']['fields']; + $filters = $data['display']['default']['display_options']['filters']; + + $this->assertEqual('numeric', $fields['wid']['plugin_id']); + $this->assertEqual('numeric', $fields['uid']['plugin_id']); + $this->assertEqual('in_operator', $filters['type']['plugin_id']); + + // Now save the view. This trigger dblog_view_presave(). + $view->save(); + + // Finally check the same convertion proccess ran. + $data = $view->storage->toArray(); + $fields = $data['display']['default']['display_options']['fields']; + $filters = $data['display']['default']['display_options']['filters']; + + $this->assertEqual('standard', $fields['wid']['plugin_id']); + $this->assertEqual('standard', $fields['uid']['plugin_id']); + $this->assertEqual('dblog_types', $filters['type']['plugin_id']); + } + +} diff --git a/core/modules/dblog/tests/fixtures/update/dblog-2851293.php b/core/modules/dblog/tests/fixtures/update/dblog-2851293.php new file mode 100644 index 0000000000..0a26031748 --- /dev/null +++ b/core/modules/dblog/tests/fixtures/update/dblog-2851293.php @@ -0,0 +1,19 @@ +insert('config') + ->fields([ + 'collection' => '', + 'name' => 'views.view.dblog_2851293', + 'data' => serialize(Yaml::decode(file_get_contents('core/modules/dblog/tests/modules/dblog_test_views/test_views/views.view.dblog_2851293.yml'))), + ]) + ->execute(); diff --git a/core/modules/dblog/tests/modules/dblog_test_views/test_views/views.view.dblog_2851293.yml b/core/modules/dblog/tests/modules/dblog_test_views/test_views/views.view.dblog_2851293.yml new file mode 100644 index 0000000000..470a1f0251 --- /dev/null +++ b/core/modules/dblog/tests/modules/dblog_test_views/test_views/views.view.dblog_2851293.yml @@ -0,0 +1,148 @@ +langcode: en +status: true +dependencies: + module: + - user +id: dblog_2851293 +label: dblog_2851293 +module: views +description: 'Base view to test upgrade from issue #2851293' +tag: '' +base_table: watchdog +base_field: wid +core: 8.x +display: + default: + display_plugin: default + id: default + display_title: Master + position: 0 + display_options: + access: + type: perm + options: + perm: 'access site reports' + cache: + type: none + 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: Filter + 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: some + options: + items_per_page: 10 + offset: 0 + style: + type: default + options: + grouping: { } + row_class: '' + default_row_class: true + uses_fields: false + row: + type: fields + options: + inline: { } + separator: '' + hide_empty: false + default_field_elements: true + fields: + wid: + table: watchdog + field: wid + id: wid + entity_type: null + entity_field: null + plugin_id: numeric + relationship: none + group_type: group + admin_label: '' + label: '' + exclude: false + empty: '' + hide_empty: false + empty_zero: false + hide_alter_empty: true + set_precision: false + precision: 0 + decimal: . + separator: ',' + format_plural: false + format_plural_string: "1\x03@count" + prefix: '' + suffix: '' + uid: + id: uid + table: watchdog + field: uid + relationship: none + group_type: group + admin_label: '' + label: '' + exclude: false + empty: '' + hide_empty: false + empty_zero: false + hide_alter_empty: true + set_precision: false + precision: 0 + decimal: . + separator: ',' + format_plural: false + format_plural_string: "1\x03@count" + prefix: '' + suffix: '' + plugin_id: numeric + filters: + type: + id: type + table: watchdog + field: type + relationship: none + group_type: group + admin_label: '' + operator: in + value: { } + group: 1 + exposed: true + expose: + operator_id: type_op + label: Type + description: '' + use_operator: false + operator: type_op + identifier: type + required: false + remember: false + multiple: true + reduce: false + plugin_id: in_operator + sorts: { } + header: { } + footer: { } + empty: { } + relationships: { } + arguments: { } + display_extenders: { } + cache_metadata: + max-age: -1 + contexts: + - 'languages:language_interface' + - user.permissions + tags: { } diff --git a/core/modules/dblog/tests/modules/dblog_test_views/test_views/views.view.dblog_integration_test.yml b/core/modules/dblog/tests/modules/dblog_test_views/test_views/views.view.dblog_integration_test.yml new file mode 100644 index 0000000000..5e701ab081 --- /dev/null +++ b/core/modules/dblog/tests/modules/dblog_test_views/test_views/views.view.dblog_integration_test.yml @@ -0,0 +1,505 @@ +langcode: en +status: true +dependencies: + module: + - dblog + - user +id: dblog_integration_test +label: dblog_integration_test +module: views +description: '' +tag: '' +base_table: watchdog +base_field: wid +core: 8.x +display: + default: + display_plugin: default + id: default + display_title: Master + position: 0 + display_options: + access: + type: perm + options: + perm: 'access site reports' + 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: Filter + 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 + fields: + wid: + table: watchdog + field: wid + id: wid + entity_type: null + entity_field: null + plugin_id: standard + 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: true + element_wrapper_type: '' + element_wrapper_class: '' + element_default_classes: true + empty: '' + hide_empty: false + empty_zero: false + hide_alter_empty: true + message: + id: message + table: watchdog + field: message + 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 + replace_variables: true + plugin_id: dblog_message + link: + id: link + table: watchdog + field: link + 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 + plugin_id: dblog_operations + severity: + id: severity + table: watchdog + field: severity + 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 + machine_name: false + plugin_id: machine_name + type: + id: type + table: watchdog + field: type + 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 + plugin_id: standard + name: + id: name + table: users_field_data + field: name + relationship: uid + 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: value + type: user_name + settings: + link_to_entity: true + 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 + entity_type: user + entity_field: name + plugin_id: field + filters: + severity: + id: severity + table: watchdog + field: severity + relationship: none + group_type: group + admin_label: '' + operator: in + value: { } + group: 1 + exposed: true + expose: + operator_id: severity_op + label: 'Severity level' + description: '' + use_operator: false + operator: severity_op + identifier: severity + required: false + remember: false + multiple: true + remember_roles: + authenticated: authenticated + anonymous: '0' + administrator: '0' + 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: in_operator + type: + id: type + table: watchdog + field: type + relationship: none + group_type: group + admin_label: '' + operator: in + value: { } + group: 1 + exposed: true + expose: + operator_id: type_op + label: Type + description: '' + use_operator: false + operator: type_op + identifier: type + required: false + remember: false + multiple: true + remember_roles: + authenticated: authenticated + anonymous: '0' + administrator: '0' + 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: dblog_types + sorts: { } + title: dblog_integration_test + header: { } + footer: { } + empty: { } + relationships: + uid: + id: uid + table: watchdog + field: uid + relationship: none + group_type: group + admin_label: uid + required: false + plugin_id: standard + arguments: { } + display_extenders: { } + cache_metadata: + max-age: -1 + contexts: + - 'languages:language_content' + - 'languages:language_interface' + - url + - url.query_args + - user.permissions + tags: { } + page_1: + display_plugin: page + id: page_1 + display_title: Page + position: 1 + display_options: + display_extenders: { } + path: dblog-integration-test + cache_metadata: + max-age: -1 + contexts: + - 'languages:language_content' + - 'languages:language_interface' + - url + - url.query_args + - user.permissions + tags: { } diff --git a/core/modules/dblog/tests/src/Kernel/Views/ViewsIntegrationTest.php b/core/modules/dblog/tests/src/Kernel/Views/ViewsIntegrationTest.php index 7b63394d52..67d693fb8b 100644 --- a/core/modules/dblog/tests/src/Kernel/Views/ViewsIntegrationTest.php +++ b/core/modules/dblog/tests/src/Kernel/Views/ViewsIntegrationTest.php @@ -18,41 +18,161 @@ class ViewsIntegrationTest extends ViewsKernelTestBase { /** - * Views used by this test. - * - * @var array + * {@inheritdoc} */ - public static $testViews = ['test_dblog']; + public static $testViews = ['test_dblog', 'dblog_integration_test']; /** - * Modules to enable. - * - * @var array + * {@inheritdoc} */ public static $modules = ['dblog', 'dblog_test_views', 'user']; /** * {@inheritdoc} */ + protected $columnMap = ['watchdog_message' => 'message']; + + /** + * {@inheritdoc} + */ protected function setUp($import_test_views = TRUE) { parent::setUp(); - // Rebuild the router, otherwise we can't generate links. - $this->container->get('router.builder')->rebuild(); - + $this->installEntitySchema('user'); $this->installSchema('dblog', ['watchdog']); ViewTestData::createTestViews(get_class($this), ['dblog_test_views']); } /** - * Tests the integration. + * Tests the messages escaping functionality. + */ + public function testMessages() { + + // Remove the watchdog entries added by the potential batch process. + $this->container->get('database')->truncate('watchdog')->execute(); + + $entries = $this->createLogEntries(); + + $view = Views::getView('test_dblog'); + $this->executeView($view); + $view->initStyle(); + + foreach ($entries as $index => $entry) { + if (!isset($entry['variables'])) { + continue; + } + $this->assertEqual($view->style_plugin->getField($index, 'message'), SafeMarkup::format($entry['message'], $entry['variables'])); + $link_field = $view->style_plugin->getField($index, 'link'); + // The 3rd entry contains some unsafe markup that needs to get filtered. + if ($index == 2) { + // Make sure that unsafe link differs from the rendered link, so we know + // that some filtering actually happened. + $this->assertNotEqual($link_field, $entry['variables']['link']); + } + $this->assertEqual($link_field, Xss::filterAdmin($entry['variables']['link'])); + } + + // Disable replacing variables and check that the tokens aren't replaced. + $view->destroy(); + $view->storage->invalidateCaches(); + $view->initHandlers(); + $this->executeView($view); + $view->initStyle(); + $view->field['message']->options['replace_variables'] = FALSE; + foreach ($entries as $index => $entry) { + $this->assertEqual($view->style_plugin->getField($index, 'message'), $entry['message']); + } + } + + /** + * Tests the relationship with the users_field_data table. */ - public function testIntegration() { + public function testRelationship() { + $view = Views::getView('dblog_integration_test'); + $view->setDisplay('page_1'); + // The uid relationship should now join to the {users_field_data} table. + $tables = array_keys($view->getBaseTables()); + $this->assertTrue(in_array('users_field_data', $tables)); + $this->assertFalse(in_array('users', $tables)); + $this->assertTrue(in_array('watchdog', $tables)); + } + /** + * Test views can be filtered by severity and log type. + */ + public function testFiltering() { // Remove the watchdog entries added by the potential batch process. $this->container->get('database')->truncate('watchdog')->execute(); + $this->createLogEntries(); + + $view = Views::getView('dblog_integration_test'); + + $filters = [ + 'severity' => [ + 'id' => 'severity', + 'table' => 'watchdog', + 'field' => 'severity', + 'relationship' => 'none', + 'group_type' => 'group', + 'admin_label' => '', + 'operator' => 'in', + 'value' => [ + RfcLogLevel::WARNING, + ], + 'group' => 1, + 'exposed' => FALSE, + 'plugin_id' => 'in_operator', + ], + ]; + + $view->setDisplay('page_1'); + $view->displayHandlers->get('page_1')->overrideOption('filters', $filters); + $view->save(); + + $this->executeView($view); + + $resultset = [['message' => 'Warning message']]; + $this->assertIdenticalResultset($view, $resultset, $this->columnMap); + + $view = Views::getView('dblog_integration_test'); + + $filters = [ + 'type' => [ + 'id' => 'type', + 'table' => 'watchdog', + 'field' => 'type', + 'relationship' => 'none', + 'group_type' => 'group', + 'admin_label' => '', + 'operator' => 'in', + 'value' => [ + 'my-module' => 'my-module', + ], + 'group' => '1', + 'exposed' => FALSE, + 'is_grouped' => FALSE, + 'plugin_id' => 'dblog_types', + ], + ]; + + $view->setDisplay('page_1'); + $view->displayHandlers->get('page_1')->overrideOption('filters', $filters); + $view->save(); + + $this->executeView($view); + + $resultset = [['message' => 'My module message']]; + $this->assertIdenticalResultset($view, $resultset, $this->columnMap); + } + /** + * Create a set of log entries. + * + * @return array + * An array of data used to create the log entries. + */ + protected function createLogEntries() { $entries = []; // Setup a watchdog entry without tokens. $entries[] = [ @@ -76,41 +196,28 @@ public function testIntegration() { 'link' => '', ], ]; + // Setup a watchdog entry with severity WARNING. + $entries[] = [ + 'message' => 'Warning message', + 'severity' => RfcLogLevel::WARNING, + ]; + // Setup a watchdog entry with a different module. + $entries[] = [ + 'message' => 'My module message', + 'severity' => RfcLogLevel::INFO, + 'type' => 'my-module', + ]; + $logger_factory = $this->container->get('logger.factory'); foreach ($entries as $entry) { $entry += [ 'type' => 'test-views', 'severity' => RfcLogLevel::NOTICE, + 'variables' => [], ]; $logger_factory->get($entry['type'])->log($entry['severity'], $entry['message'], $entry['variables']); } - - $view = Views::getView('test_dblog'); - $this->executeView($view); - $view->initStyle(); - - foreach ($entries as $index => $entry) { - $this->assertEqual($view->style_plugin->getField($index, 'message'), SafeMarkup::format($entry['message'], $entry['variables'])); - $link_field = $view->style_plugin->getField($index, 'link'); - // The 3rd entry contains some unsafe markup that needs to get filtered. - if ($index == 2) { - // Make sure that unsafe link differs from the rendered link, so we know - // that some filtering actually happened. - $this->assertNotEqual($link_field, $entry['variables']['link']); - } - $this->assertEqual($link_field, Xss::filterAdmin($entry['variables']['link'])); - } - - // Disable replacing variables and check that the tokens aren't replaced. - $view->destroy(); - $view->storage->invalidateCaches(); - $view->initHandlers(); - $this->executeView($view); - $view->initStyle(); - $view->field['message']->options['replace_variables'] = FALSE; - foreach ($entries as $index => $entry) { - $this->assertEqual($view->style_plugin->getField($index, 'message'), $entry['message']); - } + return $entries; } } diff --git a/core/modules/dynamic_page_cache/src/EventSubscriber/DynamicPageCacheSubscriber.php b/core/modules/dynamic_page_cache/src/EventSubscriber/DynamicPageCacheSubscriber.php index 22a1f2c2ce..8316470876 100644 --- a/core/modules/dynamic_page_cache/src/EventSubscriber/DynamicPageCacheSubscriber.php +++ b/core/modules/dynamic_page_cache/src/EventSubscriber/DynamicPageCacheSubscriber.php @@ -82,7 +82,7 @@ class DynamicPageCacheSubscriber implements EventSubscriberInterface { // may be returning a domain object that a KernelEvents::VIEW subscriber // must turn into an actual response, but perhaps a format is being // requested that the subscriber does not support. - // @see \Drupal\Core\EventSubscriber\AcceptNegotiation406::onViewDetect406() + // @see \Drupal\Core\EventSubscriber\RenderArrayNonHtmlSubscriber::onResponse() 'request_format', ], 'bin' => 'dynamic_page_cache', diff --git a/core/modules/editor/src/Tests/QuickEditIntegrationLoadingTest.php b/core/modules/editor/src/Tests/QuickEditIntegrationLoadingTest.php index 7141687bc7..a4515d5673 100644 --- a/core/modules/editor/src/Tests/QuickEditIntegrationLoadingTest.php +++ b/core/modules/editor/src/Tests/QuickEditIntegrationLoadingTest.php @@ -89,12 +89,12 @@ public function testUsersWithoutPermission() { $response = $this->drupalPost('editor/' . 'node/1/body/en/full', '', [], ['query' => [MainContentViewSubscriber::WRAPPER_FORMAT => 'drupal_ajax']]); $this->assertResponse(403); if (!$user->hasPermission('access in-place editing')) { - $message = "A fatal error occurred: The 'access in-place editing' permission is required."; - $this->assertIdentical(Json::encode(['message' => $message]), $response); + $message = "The 'access in-place editing' permission is required."; } else { - $this->assertIdentical('{}', $response); + $message = ''; } + $this->assertIdentical(Json::encode(['message' => $message]), $response); } } diff --git a/core/modules/editor/tests/src/Kernel/QuickEditIntegrationTest.php b/core/modules/editor/tests/src/Kernel/QuickEditIntegrationTest.php index 256d271778..276f559225 100644 --- a/core/modules/editor/tests/src/Kernel/QuickEditIntegrationTest.php +++ b/core/modules/editor/tests/src/Kernel/QuickEditIntegrationTest.php @@ -9,7 +9,7 @@ use Drupal\entity_test\Entity\EntityTest; use Drupal\quickedit\MetadataGenerator; use Drupal\Tests\quickedit\Kernel\QuickEditTestBase; -use Drupal\quickedit_test\MockEditEntityFieldAccessCheck; +use Drupal\quickedit_test\MockQuickEditEntityFieldAccessCheck; use Drupal\editor\EditorController; use Symfony\Component\HttpFoundation\Request; use Symfony\Component\HttpKernel\Event\FilterResponseEvent; @@ -52,7 +52,7 @@ class QuickEditIntegrationTest extends QuickEditTestBase { /** * The access checker object to be used by the metadata generator object. * - * @var \Drupal\quickedit\Access\EditEntityFieldAccessCheckInterface + * @var \Drupal\quickedit\Access\QuickEditEntityFieldAccessCheckInterface */ protected $accessChecker; @@ -165,7 +165,7 @@ public function testEditorSelection() { */ public function testMetadata() { $this->editorManager = $this->container->get('plugin.manager.quickedit.editor'); - $this->accessChecker = new MockEditEntityFieldAccessCheck(); + $this->accessChecker = new MockQuickEditEntityFieldAccessCheck(); $this->editorSelector = $this->container->get('quickedit.editor.selector'); $this->metadataGenerator = new MetadataGenerator($this->accessChecker, $this->editorSelector, $this->editorManager); diff --git a/core/modules/field/src/Entity/FieldStorageConfig.php b/core/modules/field/src/Entity/FieldStorageConfig.php index a63e54f98b..78b3d602b6 100644 --- a/core/modules/field/src/Entity/FieldStorageConfig.php +++ b/core/modules/field/src/Entity/FieldStorageConfig.php @@ -18,6 +18,7 @@ * id = "field_storage_config", * label = @Translation("Field storage"), * handlers = { + * "access" = "Drupal\field\FieldStorageConfigAccessControlHandler", * "storage" = "Drupal\field\FieldStorageConfigStorage" * }, * config_prefix = "storage", @@ -627,7 +628,17 @@ public function getDescription() { * {@inheritdoc} */ public function getCardinality() { - return $this->cardinality; + /** @var \Drupal\Core\Field\FieldTypePluginManager $field_type_manager */ + $field_type_manager = \Drupal::service('plugin.manager.field.field_type'); + $definition = $field_type_manager->getDefinition($this->getType()); + $enforced_cardinality = isset($definition['cardinality']) ? $definition['cardinality'] : NULL; + + // Enforced cardinality is a positive integer or -1. + if ($enforced_cardinality !== NULL && $enforced_cardinality < 1 && $enforced_cardinality !== FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED) { + throw new FieldException("Invalid enforced cardinality '$enforced_cardinality'. Allowed values: a positive integer or -1."); + } + + return $enforced_cardinality ?: $this->cardinality; } /** diff --git a/core/modules/field/src/FieldConfigAccessControlHandler.php b/core/modules/field/src/FieldConfigAccessControlHandler.php index e27f99cce6..6ee0e05cb6 100644 --- a/core/modules/field/src/FieldConfigAccessControlHandler.php +++ b/core/modules/field/src/FieldConfigAccessControlHandler.php @@ -2,13 +2,12 @@ namespace Drupal\field; -use Drupal\Core\Access\AccessResult; use Drupal\Core\Entity\EntityAccessControlHandler; use Drupal\Core\Entity\EntityInterface; use Drupal\Core\Session\AccountInterface; /** - * Defines the access control handler for the field entity type. + * Defines the access control handler for the field config entity type. * * @see \Drupal\field\Entity\FieldConfig */ @@ -18,16 +17,16 @@ class FieldConfigAccessControlHandler extends EntityAccessControlHandler { * {@inheritdoc} */ protected function checkAccess(EntityInterface $entity, $operation, AccountInterface $account) { - if ($operation == 'delete') { - $field_storage_entity = $entity->getFieldStorageDefinition(); - if ($field_storage_entity->isLocked()) { - return AccessResult::forbidden()->addCacheableDependency($field_storage_entity); - } - else { - return AccessResult::allowedIfHasPermission($account, 'administer ' . $entity->getTargetEntityTypeId() . ' fields')->addCacheableDependency($field_storage_entity); - } - } - return AccessResult::allowedIfHasPermission($account, 'administer ' . $entity->getTargetEntityTypeId() . ' fields'); + // Delegate access control to the underlying field storage config entity: + // the field config entity merely handles configuration for a particular + // bundle of an entity type, the bulk of the logic and configuration is with + // the field storage config entity. Therefore, if an operation is allowed on + // a certain field storage config entity, it should also be allowed for all + // associated field config entities. + // @see \Drupal\Core\Field\FieldDefinitionInterface + /** \Drupal\field\FieldConfigInterface $entity */ + $field_storage_entity = $entity->getFieldStorageDefinition(); + return $field_storage_entity->access($operation, $account, TRUE); } } diff --git a/core/modules/field/src/FieldStorageConfigAccessControlHandler.php b/core/modules/field/src/FieldStorageConfigAccessControlHandler.php new file mode 100644 index 0000000000..da48556fab --- /dev/null +++ b/core/modules/field/src/FieldStorageConfigAccessControlHandler.php @@ -0,0 +1,33 @@ +isLocked()) { + return AccessResult::forbidden()->addCacheableDependency($entity); + } + else { + return AccessResult::allowedIfHasPermission($account, 'administer ' . $entity->getTargetEntityTypeId() . ' fields')->addCacheableDependency($entity); + } + } + return AccessResult::allowedIfHasPermission($account, 'administer ' . $entity->getTargetEntityTypeId() . ' fields'); + } + +} diff --git a/core/modules/field/tests/src/Kernel/EntityReference/Views/EntityReferenceRelationshipTest.php b/core/modules/field/tests/src/Kernel/EntityReference/Views/EntityReferenceRelationshipTest.php index 31d6503795..2b0be855dd 100644 --- a/core/modules/field/tests/src/Kernel/EntityReference/Views/EntityReferenceRelationshipTest.php +++ b/core/modules/field/tests/src/Kernel/EntityReference/Views/EntityReferenceRelationshipTest.php @@ -34,7 +34,7 @@ class EntityReferenceRelationshipTest extends ViewsKernelTestBase { 'test_entity_reference_entity_test_mul_view', 'test_entity_reference_reverse_entity_test_mul_view', 'test_entity_reference_group_by_empty_relationships', - ]; + ]; /** * Modules to install. diff --git a/core/modules/field/tests/src/Kernel/Timestamp/TimestampItemTest.php b/core/modules/field/tests/src/Kernel/Timestamp/TimestampItemTest.php new file mode 100644 index 0000000000..0aaa8d3414 --- /dev/null +++ b/core/modules/field/tests/src/Kernel/Timestamp/TimestampItemTest.php @@ -0,0 +1,91 @@ +fieldStorage = FieldStorageConfig::create([ + 'field_name' => 'field_timestamp', + 'type' => 'timestamp', + 'entity_type' => 'entity_test', + ]); + $this->fieldStorage->save(); + $this->field = FieldConfig::create([ + 'field_storage' => $this->fieldStorage, + 'bundle' => 'entity_test', + ]); + $this->field->save(); + } + + /** + * Tests using entity fields of the datetime field type. + */ + public function testDateTime() { + // Verify entity creation. + $entity = EntityTest::create(); + $value = 1488914208; + $entity->field_timestamp = $value; + $entity->name->value = $this->randomMachineName(); + $this->entityValidateAndSave($entity); + + // Verify entity has been created properly. + $id = $entity->id(); + $entity = EntityTest::load($id); + $this->assertTrue($entity->field_timestamp instanceof FieldItemListInterface, 'Field implements interface.'); + $this->assertTrue($entity->field_timestamp[0] instanceof FieldItemInterface, 'Field item implements interface.'); + $this->assertEquals($entity->field_timestamp->value, $value); + $this->assertEquals($entity->field_timestamp[0]->value, $value); + + // Verify changing the date value. + $new_value = 1488914000; + $entity->field_timestamp->value = $new_value; + $this->assertEquals($entity->field_timestamp->value, $new_value); + + // Read changed entity and assert changed values. + $this->entityValidateAndSave($entity); + $entity = EntityTest::load($id); + $this->assertEquals($entity->field_timestamp->value, $new_value); + + // Test sample item generation. + $entity = EntityTest::create(); + $entity->field_timestamp->generateSampleItems(); + $this->entityValidateAndSave($entity); + + // Ensure there is sample value a generated for the field. + $this->assertNotNull($entity->field_timestamp->value); + } + +} diff --git a/core/modules/field/tests/src/Unit/FieldConfigAccessControlHandlerTest.php b/core/modules/field/tests/src/Unit/FieldConfigAccessControlHandlerTest.php new file mode 100644 index 0000000000..0ad8265f89 --- /dev/null +++ b/core/modules/field/tests/src/Unit/FieldConfigAccessControlHandlerTest.php @@ -0,0 +1,43 @@ +entity = new FieldConfig([ + 'field_name' => $this->fieldStorage->getName(), + 'entity_type' => 'node', + 'fieldStorage' => $this->fieldStorage, + 'bundle' => 'test_bundle', + 'field_type' => 'test_field', + ], 'node'); + + $this->accessControlHandler = new FieldConfigAccessControlHandler($this->entity->getEntityType()); + $this->accessControlHandler->setModuleHandler($this->moduleHandler); + } + + /** + * Ensures field config access is working properly. + */ + public function testAccess() { + $this->assertAllowOperations([], $this->anon); + $this->assertAllowOperations(['view', 'update', 'delete'], $this->member); + } + +} diff --git a/core/modules/field/tests/src/Unit/FieldStorageConfigAccessControlHandlerTest.php b/core/modules/field/tests/src/Unit/FieldStorageConfigAccessControlHandlerTest.php new file mode 100644 index 0000000000..4ed7512333 --- /dev/null +++ b/core/modules/field/tests/src/Unit/FieldStorageConfigAccessControlHandlerTest.php @@ -0,0 +1,200 @@ +anon = $this->getMock(AccountInterface::class); + $this->anon + ->expects($this->any()) + ->method('hasPermission') + ->will($this->returnValue(FALSE)); + $this->anon + ->expects($this->any()) + ->method('id') + ->will($this->returnValue(0)); + + $this->member = $this->getMock(AccountInterface::class); + $this->member + ->expects($this->any()) + ->method('hasPermission') + ->will($this->returnValueMap([ + ['administer node fields', TRUE], + ])); + $this->member + ->expects($this->any()) + ->method('id') + ->will($this->returnValue(2)); + + $storageType = $this->getMock(ConfigEntityTypeInterface::class); + $storageType + ->expects($this->any()) + ->method('getProvider') + ->will($this->returnValue('field')); + $storageType + ->expects($this->any()) + ->method('getConfigPrefix') + ->will($this->returnValue('field.storage')); + + $entityType = $this->getMock(ConfigEntityTypeInterface::class); + $entityType + ->expects($this->any()) + ->method('getProvider') + ->will($this->returnValue('node')); + $entityType + ->expects($this->any()) + ->method('getConfigPrefix') + ->willReturn('node'); + + $this->moduleHandler = $this->getMock(ModuleHandlerInterface::class); + $this->moduleHandler + ->expects($this->any()) + ->method('getImplementations') + ->will($this->returnValue([])); + $this->moduleHandler + ->expects($this->any()) + ->method('invokeAll') + ->will($this->returnValue([])); + + $storage_access_control_handler = new FieldStorageConfigAccessControlHandler($storageType); + $storage_access_control_handler->setModuleHandler($this->moduleHandler); + + $entityManager = $this->getMock(EntityManagerInterface::class); + $entityManager + ->expects($this->any()) + ->method('getDefinition') + ->willReturnMap([ + ['field_storage_config', TRUE, $storageType], + ['node', TRUE, $entityType], + ]); + $entityManager + ->expects($this->any()) + ->method('getStorage') + ->willReturnMap([ + ['field_storage_config', $this->getMock(EntityStorageInterface::class)], + ]); + $entityManager + ->expects($this->any()) + ->method('getAccessControlHandler') + ->willReturnMap([ + ['field_storage_config', $storage_access_control_handler], + ]); + + $container = new Container(); + $container->set('entity.manager', $entityManager); + $container->set('uuid', $this->getMock(UuidInterface::class)); + $container->set('cache_contexts_manager', $this->prophesize(CacheContextsManager::class)); + \Drupal::setContainer($container); + + $this->fieldStorage = new FieldStorageConfig([ + 'field_name' => 'test_field', + 'entity_type' => 'node', + 'type' => 'boolean', + 'id' => 'node.test_field', + 'uuid' => '6f2f259a-f3c7-42ea-bdd5-111ad1f85ed1', + ]); + + $this->entity = $this->fieldStorage; + $this->accessControlHandler = $storage_access_control_handler; + } + + /** + * Assert method to verify the access by operations. + * + * @param array $allow_operations + * A list of allowed operations. + * @param \Drupal\Core\Session\AccountInterface $user + * The account to use for get access. + */ + public function assertAllowOperations(array $allow_operations, AccountInterface $user) { + foreach (['view', 'update', 'delete'] as $operation) { + $expected = in_array($operation, $allow_operations); + $actual = $this->accessControlHandler->access($this->entity, $operation, $user); + $this->assertSame($expected, $actual, "Access problem with '$operation' operation."); + } + } + + /** + * Ensures field storage config access is working properly. + */ + public function testAccess() { + $this->assertAllowOperations([], $this->anon); + $this->assertAllowOperations(['view', 'update', 'delete'], $this->member); + + $this->fieldStorage->setLocked(TRUE)->save(); + // Unfortunately, EntityAccessControlHandler has a static cache, which we + // therefore must reset manually. + $this->accessControlHandler->resetCache(); + + $this->assertAllowOperations([], $this->anon); + $this->assertAllowOperations(['view', 'update'], $this->member); + } + +} diff --git a/core/modules/field/tests/src/Unit/FieldStorageConfigEntityUnitTest.php b/core/modules/field/tests/src/Unit/FieldStorageConfigEntityUnitTest.php index 13ba3cf93d..89b73963ba 100644 --- a/core/modules/field/tests/src/Unit/FieldStorageConfigEntityUnitTest.php +++ b/core/modules/field/tests/src/Unit/FieldStorageConfigEntityUnitTest.php @@ -8,6 +8,7 @@ namespace Drupal\Tests\field\Unit; use Drupal\Core\DependencyInjection\ContainerBuilder; +use Drupal\Core\Field\FieldException; use Drupal\Core\Field\FieldStorageDefinitionInterface; use Drupal\Core\Field\FieldTypePluginManagerInterface; use Drupal\field\Entity\FieldStorageConfig; @@ -110,6 +111,104 @@ public function testCalculateDependencies() { $this->assertEquals(['stark'], $dependencies['theme']); } + /** + * Tests stored cardinality. + * + * @covers ::getCardinality + */ + public function testStoredCardinality() { + $this->fieldTypeManager->expects($this->any()) + ->method('getDefinition') + ->with('test_field_type') + ->willReturn([ + 'class' => TestFieldType::class, + // The field type definition has no enforced cardinality. + 'cardinality' => NULL, + ]); + + $field_storage = new FieldStorageConfig([ + 'entity_type' => 'entity_test', + 'field_name' => 'test_field', + 'type' => 'test_field_type', + 'module' => 'test_module', + ]); + $field_storage->setCardinality(8); + + // Check that the stored cardinality is returned. + $this->assertEquals(8, $field_storage->getCardinality()); + } + + /** + * Tests enforced cardinality. + * + * @covers ::getCardinality + */ + public function testEnforcedCardinality() { + $this->fieldTypeManager->expects($this->any()) + ->method('getDefinition') + ->with('test_field_type') + ->willReturn([ + 'class' => TestFieldType::class, + // This field type defines an enforced cardinality. + 'cardinality' => 21, + ]); + + $field_storage = new FieldStorageConfig([ + 'entity_type' => 'entity_test', + 'field_name' => 'test_field', + 'type' => 'test_field_type', + 'module' => 'test_module', + ]); + // Custom cardinality tentative. + $field_storage->setCardinality(8); + + // Check that the enforced cardinality is returned. + $this->assertEquals(21, $field_storage->getCardinality()); + } + + /** + * Tests invalid enforced cardinality. + * + * @covers ::getCardinality + * @dataProvider providerInvalidEnforcedCardinality + * + * @param mixed $enforced_cardinality + * Enforced cardinality + */ + public function testInvalidEnforcedCardinality($enforced_cardinality) { + $this->fieldTypeManager->expects($this->any()) + ->method('getDefinition') + ->with('test_field_type') + ->willReturn([ + 'class' => TestFieldType::class, + 'cardinality' => $enforced_cardinality, + ]); + + $field_storage = new FieldStorageConfig([ + 'entity_type' => 'entity_test', + 'field_name' => 'test_field', + 'type' => 'test_field_type', + 'module' => 'test_module', + ]); + + $this->setExpectedException(FieldException::class, "Invalid enforced cardinality '$enforced_cardinality'. Allowed values: a positive integer or -1."); + $field_storage->getCardinality(); + } + + /** + * Data provider for ::testInvalidEnforcedCardinality() + * + * @return array + * Test cases. + */ + public function providerInvalidEnforcedCardinality() { + return [ + 'zero' => [0], + 'negative_other_than_-1' => [-70], + 'non_numeric' => ['abc%$#@!'], + ]; + } + } /** diff --git a/core/modules/field_layout/tests/src/Functional/FieldLayoutTest.php b/core/modules/field_layout/tests/src/Functional/FieldLayoutTest.php index a12ae18ac0..058e6c361a 100644 --- a/core/modules/field_layout/tests/src/Functional/FieldLayoutTest.php +++ b/core/modules/field_layout/tests/src/Functional/FieldLayoutTest.php @@ -50,7 +50,7 @@ public function testNodeView() { // By default, the one-column layout is used. $this->drupalGet('node/1'); $this->assertSession()->elementExists('css', '.layout--onecol'); - $this->assertSession()->elementExists('css', '.layout-region--content .field--name-body'); + $this->assertSession()->elementExists('css', '.layout__region--content .field--name-body'); $this->drupalGet('admin/structure/types/manage/article/display'); $this->assertEquals(['Content', 'Disabled'], $this->getRegionTitles()); diff --git a/core/modules/field_layout/tests/src/FunctionalJavascript/FieldLayoutTest.php b/core/modules/field_layout/tests/src/FunctionalJavascript/FieldLayoutTest.php index a0fd13c0fa..8ddbeafa0d 100644 --- a/core/modules/field_layout/tests/src/FunctionalJavascript/FieldLayoutTest.php +++ b/core/modules/field_layout/tests/src/FunctionalJavascript/FieldLayoutTest.php @@ -47,9 +47,9 @@ protected function setUp() { public function testEntityViewModes() { // By default, the field is not visible. $this->drupalGet('entity_test/1/test'); - $this->assertSession()->elementNotExists('css', '.layout-region--content .field--name-field-test-text'); + $this->assertSession()->elementNotExists('css', '.layout__region--content .field--name-field-test-text'); $this->drupalGet('entity_test/1'); - $this->assertSession()->elementNotExists('css', '.layout-region--content .field--name-field-test-text'); + $this->assertSession()->elementNotExists('css', '.layout__region--content .field--name-field-test-text'); // Change the layout for the "test" view mode. See // core.entity_view_mode.entity_test.test.yml. @@ -65,9 +65,9 @@ public function testEntityViewModes() { // Each view mode has a different layout. $this->drupalGet('entity_test/1/test'); - $this->assertSession()->elementExists('css', '.layout-region--content .field--name-field-test-text'); + $this->assertSession()->elementExists('css', '.layout__region--content .field--name-field-test-text'); $this->drupalGet('entity_test/1'); - $this->assertSession()->elementNotExists('css', '.layout-region--content .field--name-field-test-text'); + $this->assertSession()->elementNotExists('css', '.layout__region--content .field--name-field-test-text'); } /** @@ -90,46 +90,46 @@ public function testEntityForm() { // The field is moved to the default region for the new layout. $this->assertSession()->pageTextContains('Your settings have been saved.'); - $this->assertEquals(['Top', 'Left', 'Right', 'Bottom', 'Disabled'], $this->getRegionTitles()); + $this->assertEquals(['Top', 'First', 'Second', 'Bottom', 'Disabled'], $this->getRegionTitles()); $this->drupalGet('entity_test/manage/1/edit'); // No fields are visible, and the regions don't display when empty. - $this->assertFieldInRegion('field_test_text[0][value]', 'left'); - $this->assertSession()->elementExists('css', '.layout-region--left .field--name-field-test-text'); + $this->assertFieldInRegion('field_test_text[0][value]', 'first'); + $this->assertSession()->elementExists('css', '.layout__region--first .field--name-field-test-text'); // After a refresh the new regions are still there. $this->drupalGet('entity_test/structure/entity_test/form-display'); - $this->assertEquals(['Top', 'Left', 'Right', 'Bottom', 'Disabled'], $this->getRegionTitles()); + $this->assertEquals(['Top', 'First', 'Second', 'Bottom', 'Disabled'], $this->getRegionTitles()); - // Drag the field to the right region. + // Drag the field to the second region. $field_test_text_row = $this->getSession()->getPage()->find('css', '#field-test-text'); - $right_region_row = $this->getSession()->getPage()->find('css', '.region-right-message'); - $field_test_text_row->find('css', '.handle')->dragTo($right_region_row); + $second_region_row = $this->getSession()->getPage()->find('css', '.region-second-message'); + $field_test_text_row->find('css', '.handle')->dragTo($second_region_row); $this->assertSession()->assertWaitOnAjaxRequest(); $this->submitForm([], 'Save'); $this->assertSession()->pageTextContains('Your settings have been saved.'); // The new layout is used. $this->drupalGet('entity_test/manage/1/edit'); - $this->assertSession()->elementExists('css', '.layout-region--right .field--name-field-test-text'); - $this->assertFieldInRegion('field_test_text[0][value]', 'right'); + $this->assertSession()->elementExists('css', '.layout__region--second .field--name-field-test-text'); + $this->assertFieldInRegion('field_test_text[0][value]', 'second'); - // Move the field to the right region without tabledrag. + // Move the field to the second region without tabledrag. $this->drupalGet('entity_test/structure/entity_test/form-display'); $this->getSession()->getPage()->pressButton('Show row weights'); - $this->getSession()->getPage()->selectFieldOption('fields[field_test_text][region]', 'right'); + $this->getSession()->getPage()->selectFieldOption('fields[field_test_text][region]', 'second'); $this->assertSession()->assertWaitOnAjaxRequest(); $this->submitForm([], 'Save'); $this->assertSession()->pageTextContains('Your settings have been saved.'); // The updated region is used. $this->drupalGet('entity_test/manage/1/edit'); - $this->assertFieldInRegion('field_test_text[0][value]', 'right'); + $this->assertFieldInRegion('field_test_text[0][value]', 'second'); // The layout is still in use without Field UI. $this->container->get('module_installer')->uninstall(['field_ui']); $this->drupalGet('entity_test/manage/1/edit'); - $this->assertFieldInRegion('field_test_text[0][value]', 'right'); + $this->assertFieldInRegion('field_test_text[0][value]', 'second'); } /** @@ -147,23 +147,23 @@ public function testEntityView() { $this->submitForm([], 'Save'); $this->assertSession()->pageTextContains('Your settings have been saved.'); - $this->assertEquals(['Top', 'Left', 'Right', 'Bottom', 'Disabled'], $this->getRegionTitles()); + $this->assertEquals(['Top', 'First', 'Second', 'Bottom', 'Disabled'], $this->getRegionTitles()); $this->drupalGet('entity_test/1'); // No fields are visible, and the regions don't display when empty. $this->assertSession()->elementNotExists('css', '.layout--twocol'); - $this->assertSession()->elementNotExists('css', '.layout-region'); + $this->assertSession()->elementNotExists('css', '.layout__region'); $this->assertSession()->elementNotExists('css', '.field--name-field-test-text'); // After a refresh the new regions are still there. $this->drupalGet('entity_test/structure/entity_test/display'); - $this->assertEquals(['Top', 'Left', 'Right', 'Bottom', 'Disabled'], $this->getRegionTitles()); + $this->assertEquals(['Top', 'First', 'Second', 'Bottom', 'Disabled'], $this->getRegionTitles()); - // Drag the field to the left region. + // Drag the field to the first region. $this->assertTrue($this->assertSession()->optionExists('fields[field_test_text][region]', 'hidden')->isSelected()); $field_test_text_row = $this->getSession()->getPage()->find('css', '#field-test-text'); - $left_region_row = $this->getSession()->getPage()->find('css', '.region-left-message'); - $field_test_text_row->find('css', '.handle')->dragTo($left_region_row); + $first_region_row = $this->getSession()->getPage()->find('css', '.region-first-message'); + $field_test_text_row->find('css', '.handle')->dragTo($first_region_row); $this->assertSession()->assertWaitOnAjaxRequest(); $this->assertFalse($this->assertSession()->optionExists('fields[field_test_text][region]', 'hidden')->isSelected()); $this->submitForm([], 'Save'); @@ -172,25 +172,25 @@ public function testEntityView() { // The new layout is used. $this->drupalGet('entity_test/1'); $this->assertSession()->elementExists('css', '.layout--twocol'); - $this->assertSession()->elementExists('css', '.layout-region--left .field--name-field-test-text'); + $this->assertSession()->elementExists('css', '.layout__region--first .field--name-field-test-text'); - // Move the field to the right region without tabledrag. + // Move the field to the second region without tabledrag. $this->drupalGet('entity_test/structure/entity_test/display'); $this->getSession()->getPage()->pressButton('Show row weights'); - $this->getSession()->getPage()->selectFieldOption('fields[field_test_text][region]', 'right'); + $this->getSession()->getPage()->selectFieldOption('fields[field_test_text][region]', 'second'); $this->assertSession()->assertWaitOnAjaxRequest(); $this->submitForm([], 'Save'); $this->assertSession()->pageTextContains('Your settings have been saved.'); // The updated region is used. $this->drupalGet('entity_test/1'); - $this->assertSession()->elementExists('css', '.layout-region--right .field--name-field-test-text'); + $this->assertSession()->elementExists('css', '.layout__region--second .field--name-field-test-text'); // The layout is still in use without Field UI. $this->container->get('module_installer')->uninstall(['field_ui']); $this->drupalGet('entity_test/1'); $this->assertSession()->elementExists('css', '.layout--twocol'); - $this->assertSession()->elementExists('css', '.layout-region--right .field--name-field-test-text'); + $this->assertSession()->elementExists('css', '.layout__region--second .field--name-field-test-text'); } /** @@ -258,7 +258,7 @@ protected function getRegionTitles() { * The machine name of the region. */ protected function assertFieldInRegion($field_selector, $region_name) { - $region_element = $this->getSession()->getPage()->find('css', ".layout-region--$region_name"); + $region_element = $this->getSession()->getPage()->find('css', ".layout__region--$region_name"); $this->assertNotNull($region_element); $this->assertSession()->fieldExists($field_selector, $region_element); } diff --git a/core/modules/field_ui/src/Form/FieldStorageConfigEditForm.php b/core/modules/field_ui/src/Form/FieldStorageConfigEditForm.php index a0c1294d9d..49a45e1cd9 100644 --- a/core/modules/field_ui/src/Form/FieldStorageConfigEditForm.php +++ b/core/modules/field_ui/src/Form/FieldStorageConfigEditForm.php @@ -89,9 +89,20 @@ public function form(array $form, FormStateInterface $form_state) { $item = $items->first() ?: $items->appendItem(); $form['settings'] += $item->storageSettingsForm($form, $form_state, $this->entity->hasData()); - // Build the configurable field values. - $cardinality = $this->entity->getCardinality(); - $form['cardinality_container'] = [ + // Add the cardinality sub-form. + $form['cardinality_container'] = $this->getCardinalityForm(); + + return $form; + } + + /** + * Builds the cardinality form. + * + * @return array + * The cardinality form render array. + */ + protected function getCardinalityForm() { + $form = [ // Reset #parents so the additional container does not appear. '#parents' => [], '#type' => 'fieldset', @@ -99,35 +110,49 @@ public function form(array $form, FormStateInterface $form_state) { '#attributes' => ['class' => [ 'container-inline', 'fieldgroup', - 'form-composite' + 'form-composite', ]], ]; - $form['cardinality_container']['cardinality'] = [ - '#type' => 'select', - '#title' => $this->t('Allowed number of values'), - '#title_display' => 'invisible', - '#options' => [ - 'number' => $this->t('Limited'), - FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED => $this->t('Unlimited'), - ], - '#default_value' => ($cardinality == FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED) ? FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED : 'number', - ]; - $form['cardinality_container']['cardinality_number'] = [ - '#type' => 'number', - '#default_value' => $cardinality != FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED ? $cardinality : 1, - '#min' => 1, - '#title' => $this->t('Limit'), - '#title_display' => 'invisible', - '#size' => 2, - '#states' => [ - 'visible' => [ - ':input[name="cardinality"]' => ['value' => 'number'], + + if ($enforced_cardinality = $this->getEnforcedCardinality()) { + if ($enforced_cardinality === FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED) { + $markup = $this->t("This field cardinality is set to unlimited and cannot be configured."); + } + else { + $markup = $this->t("This field cardinality is set to @cardinality and cannot be configured.", ['@cardinality' => $enforced_cardinality]); + } + $form['cardinality'] = ['#markup' => $markup]; + } + else { + $form['#element_validate'][] = '::validateCardinality'; + $cardinality = $this->entity->getCardinality(); + $form['cardinality'] = [ + '#type' => 'select', + '#title' => $this->t('Allowed number of values'), + '#title_display' => 'invisible', + '#options' => [ + 'number' => $this->t('Limited'), + FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED => $this->t('Unlimited'), ], - 'disabled' => [ - ':input[name="cardinality"]' => ['value' => FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED], + '#default_value' => ($cardinality == FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED) ? FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED : 'number', + ]; + $form['cardinality_number'] = [ + '#type' => 'number', + '#default_value' => $cardinality != FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED ? $cardinality : 1, + '#min' => 1, + '#title' => $this->t('Limit'), + '#title_display' => 'invisible', + '#size' => 2, + '#states' => [ + 'visible' => [ + ':input[name="cardinality"]' => ['value' => 'number'], + ], + 'disabled' => [ + ':input[name="cardinality"]' => ['value' => FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED], + ], ], - ], - ]; + ]; + } return $form; } @@ -143,16 +168,19 @@ protected function actions(array $form, FormStateInterface $form_state) { } /** - * {@inheritdoc} + * Validates the cardinality. + * + * @param array $element + * The cardinality form render array. + * @param \Drupal\Core\Form\FormStateInterface $form_state + * The form state. */ - public function validateForm(array &$form, FormStateInterface $form_state) { - parent::validateForm($form, $form_state); - + public function validateCardinality(array &$element, FormStateInterface $form_state) { $field_storage_definitions = \Drupal::service('entity_field.manager')->getFieldStorageDefinitions($this->entity->getTargetEntityTypeId()); // Validate field cardinality. if ($form_state->getValue('cardinality') === 'number' && !$form_state->getValue('cardinality_number')) { - $form_state->setErrorByName('cardinality_number', $this->t('Number of values is required.')); + $form_state->setError($element['cardinality_number'], $this->t('Number of values is required.')); } // If a specific cardinality is used, validate that there are no entities // with a higher delta. @@ -166,7 +194,7 @@ public function validateForm(array &$form, FormStateInterface $form_state) { ->count() ->execute(); if ($entities_with_higher_delta) { - $form_state->setErrorByName('cardinality_number', $this->formatPlural($entities_with_higher_delta, 'There is @count entity with @delta or more values in this field.', 'There are @count entities with @delta or more values in this field.', ['@delta' => $form_state->getValue('cardinality') + 1])); + $form_state->setError($element['cardinality_number'], $this->formatPlural($entities_with_higher_delta, 'There is @count entity with @delta or more values in this field.', 'There are @count entities with @delta or more values in this field.', ['@delta' => $form_state->getValue('cardinality') + 1])); } } } @@ -176,7 +204,7 @@ public function validateForm(array &$form, FormStateInterface $form_state) { */ public function buildEntity(array $form, FormStateInterface $form_state) { // Save field cardinality. - if ($form_state->getValue('cardinality') === 'number' && $form_state->getValue('cardinality_number')) { + if (!$this->getEnforcedCardinality() && $form_state->getValue('cardinality') === 'number' && $form_state->getValue('cardinality_number')) { $form_state->setValue('cardinality', $form_state->getValue('cardinality_number')); } @@ -205,4 +233,19 @@ public function save(array $form, FormStateInterface $form_state) { } } + /** + * Returns the cardinality enforced by the field type. + * + * Some field types choose to enforce a fixed cardinality. This method + * returns that cardinality or NULL if no cardinality has been enforced. + * + * @return int|null + */ + protected function getEnforcedCardinality() { + /** @var \Drupal\Core\Field\FieldTypePluginManager $field_type_manager */ + $field_type_manager = \Drupal::service('plugin.manager.field.field_type'); + $definition = $field_type_manager->getDefinition($this->entity->getType()); + return isset($definition['cardinality']) ? $definition['cardinality'] : NULL; + } + } diff --git a/core/modules/field_ui/src/Tests/FieldUIDeleteTest.php b/core/modules/field_ui/src/Tests/FieldUIDeleteTest.php index 2704157304..631d3368d0 100644 --- a/core/modules/field_ui/src/Tests/FieldUIDeleteTest.php +++ b/core/modules/field_ui/src/Tests/FieldUIDeleteTest.php @@ -5,6 +5,7 @@ use Drupal\field\Entity\FieldConfig; use Drupal\field\Entity\FieldStorageConfig; use Drupal\simpletest\WebTestBase; +use Drupal\views\Entity\View; use Drupal\views\Tests\ViewTestData; /** @@ -74,6 +75,13 @@ public function testDeleteField() { \Drupal::service('module_installer')->install(['views']); ViewTestData::createTestViews(get_class($this), ['field_test_views']); + $view = View::load('test_view_field_delete'); + $this->assertNotNull($view); + $this->assertTrue($view->status()); + // Test that the View depends on the field. + $dependencies = $view->getDependencies() + ['config' => []]; + $this->assertTrue(in_array("field.storage.node.$field_name", $dependencies['config'])); + // Check the config dependencies of the first field, the field storage must // not be shown as being deleted yet. $this->drupalGet("$bundle_path1/fields/node.$type_name1.$field_name/delete"); @@ -91,13 +99,13 @@ public function testDeleteField() { // Check the config dependencies of the first field. $this->drupalGet("$bundle_path2/fields/node.$type_name2.$field_name/delete"); - $this->assertText(t('The listed configuration will be deleted.')); + $this->assertText(t('The listed configuration will be updated.')); $this->assertText(t('View')); $this->assertText('test_view_field_delete'); $xml = $this->cssSelect('#edit-entity-deletes'); - // Remove the wrapping HTML. - $this->assertIdentical(FALSE, strpos($xml[0]->asXml(), $field_label), 'The currently being deleted field is not shown in the entity deletions.'); + // Test that nothing is scheduled for deletion. + $this->assertFalse(isset($xml[0]), 'The field currently being deleted is not shown in the entity deletions.'); // Delete the second field. $this->fieldUIDeleteField($bundle_path2, "node.$type_name2.$field_name", $field_label, $type_name2); @@ -106,6 +114,14 @@ public function testDeleteField() { $this->assertNull(FieldConfig::loadByName('node', $type_name2, $field_name), 'Field was deleted.'); // Check that the field storage was deleted too. $this->assertNull(FieldStorageConfig::loadByName('node', $field_name), 'Field storage was deleted.'); + + // Test that the View isn't deleted and has been disabled. + $view = View::load('test_view_field_delete'); + $this->assertNotNull($view); + $this->assertFalse($view->status()); + // Test that the View no longer depends on the deleted field. + $dependencies = $view->getDependencies() + ['config' => []]; + $this->assertFalse(in_array("field.storage.node.$field_name", $dependencies['config'])); } } diff --git a/core/modules/file/config/optional/views.view.files.yml b/core/modules/file/config/optional/views.view.files.yml index e5edee2e40..053b72df45 100644 --- a/core/modules/file/config/optional/views.view.files.yml +++ b/core/modules/file/config/optional/views.view.files.yml @@ -565,7 +565,7 @@ display: decimal: . separator: ',' format_plural: true - format_plural_string: "1 place\x03@count places" + format_plural_string: !!binary MSBwbGFjZQNAY291bnQgcGxhY2Vz prefix: '' suffix: '' plugin_id: numeric @@ -1007,7 +1007,7 @@ display: decimal: . separator: ',' format_plural: false - format_plural_string: "1\x03@count" + format_plural_string: !!binary MQNAY291bnQ= prefix: '' suffix: '' plugin_id: numeric diff --git a/core/modules/file/tests/src/Functional/FileFieldTestBase.php b/core/modules/file/tests/src/Functional/FileFieldTestBase.php index 9ed447aaf2..d6096874d6 100644 --- a/core/modules/file/tests/src/Functional/FileFieldTestBase.php +++ b/core/modules/file/tests/src/Functional/FileFieldTestBase.php @@ -259,7 +259,7 @@ public function replaceNodeFile($file, $field_name, $nid, $new_revision = TRUE) /** * Asserts that a file exists physically on disk. * - * Overrides PHPUnit_Framework_Assert::assertFileExists() to also work with + * Overrides PHPUnit\Framework\Assert::assertFileExists() to also work with * file entities. * * @param \Drupal\File\FileInterface|string $file @@ -286,7 +286,7 @@ public function assertFileEntryExists($file, $message = NULL) { /** * Asserts that a file does not exist on disk. * - * Overrides PHPUnit_Framework_Assert::assertFileExists() to also work with + * Overrides PHPUnit\Framework\Assert::assertFileExists() to also work with * file entities. * * @param \Drupal\File\FileInterface|string $file diff --git a/core/modules/forum/src/Form/ContainerForm.php b/core/modules/forum/src/Form/ContainerForm.php index d12d0982a3..0b01124574 100644 --- a/core/modules/forum/src/Form/ContainerForm.php +++ b/core/modules/forum/src/Form/ContainerForm.php @@ -20,9 +20,8 @@ class ContainerForm extends ForumForm { * {@inheritdoc} */ public function form(array $form, FormStateInterface $form_state) { - $taxonomy_term = $this->entity; // Build the bulk of the form from the parent forum form. - $form = parent::form($form, $form_state, $taxonomy_term); + $form = parent::form($form, $form_state); // Set the title and description of the name field. $form['name']['#title'] = $this->t('Container name'); diff --git a/core/modules/forum/src/Form/ForumForm.php b/core/modules/forum/src/Form/ForumForm.php index ed0a7683a5..9e5895d0db 100644 --- a/core/modules/forum/src/Form/ForumForm.php +++ b/core/modules/forum/src/Form/ForumForm.php @@ -29,9 +29,8 @@ class ForumForm extends TermForm { * {@inheritdoc} */ public function form(array $form, FormStateInterface $form_state) { - $taxonomy_term = $this->entity; // Build the bulk of the form from the parent taxonomy term form. - $form = parent::form($form, $form_state, $taxonomy_term); + $form = parent::form($form, $form_state); // Set the title and description of the name field. $form['name']['#title'] = $this->t('Forum name'); @@ -48,7 +47,7 @@ public function form(array $form, FormStateInterface $form_state) { // Our parent field is different to the taxonomy term. $form['parent']['#tree'] = TRUE; - $form['parent'][0] = $this->forumParentSelect($taxonomy_term->id(), $this->t('Parent')); + $form['parent'][0] = $this->forumParentSelect($this->entity->id(), $this->t('Parent')); $form['#theme_wrappers'] = ['form__forum']; $this->forumFormType = $this->t('forum'); diff --git a/core/modules/hal/src/Normalizer/FieldNormalizer.php b/core/modules/hal/src/Normalizer/FieldNormalizer.php index a4e175323a..167499a26f 100644 --- a/core/modules/hal/src/Normalizer/FieldNormalizer.php +++ b/core/modules/hal/src/Normalizer/FieldNormalizer.php @@ -11,9 +11,7 @@ class FieldNormalizer extends SerializationFieldNormalizer { /** - * The formats that the Normalizer can handle. - * - * @var array + * {@inheritdoc} */ protected $format = ['hal_json']; diff --git a/core/modules/hal/src/Normalizer/NormalizerBase.php b/core/modules/hal/src/Normalizer/NormalizerBase.php index 43a5a07161..8b18985b8b 100644 --- a/core/modules/hal/src/Normalizer/NormalizerBase.php +++ b/core/modules/hal/src/Normalizer/NormalizerBase.php @@ -11,35 +11,21 @@ abstract class NormalizerBase extends SerializationNormalizerBase implements DenormalizerInterface { /** - * The formats that the Normalizer can handle. - * - * @var array - */ - protected $formats = ['hal_json']; - - /** * {@inheritdoc} */ - public function supportsNormalization($data, $format = NULL) { - return in_array($format, $this->formats) && parent::supportsNormalization($data, $format); - } + protected $format = ['hal_json']; /** * {@inheritdoc} */ - public function supportsDenormalization($data, $type, $format = NULL) { - if (in_array($format, $this->formats) && (class_exists($this->supportedInterfaceOrClass) || interface_exists($this->supportedInterfaceOrClass))) { - $target = new \ReflectionClass($type); - $supported = new \ReflectionClass($this->supportedInterfaceOrClass); - if ($supported->isInterface()) { - return $target->implementsInterface($this->supportedInterfaceOrClass); - } - else { - return ($target->getName() == $this->supportedInterfaceOrClass || $target->isSubclassOf($this->supportedInterfaceOrClass)); - } + protected function checkFormat($format = NULL) { + if (isset($this->formats)) { + @trigger_error('::formats is deprecated in Drupal 8.4.0 and will be removed before Drupal 9.0.0. Use ::$format instead. See https://www.drupal.org/node/2868275', E_USER_DEPRECATED); + + $this->format = $this->formats; } - return FALSE; + return parent::checkFormat($format); } } diff --git a/core/modules/hal/tests/src/Functional/EntityResource/FieldStorageConfig/FieldStorageConfigHalJsonAnonTest.php b/core/modules/hal/tests/src/Functional/EntityResource/FieldStorageConfig/FieldStorageConfigHalJsonAnonTest.php new file mode 100644 index 0000000000..1b9019342a --- /dev/null +++ b/core/modules/hal/tests/src/Functional/EntityResource/FieldStorageConfig/FieldStorageConfigHalJsonAnonTest.php @@ -0,0 +1,30 @@ +serializer->encode($normalization, static::$format); - // DX: 400 when incorrect entity type bundle is specified. + // DX: 422 when incorrect entity type bundle is specified. $response = $this->request($method, $url, $request_options); - $this->assertResourceErrorResponse(400, 'No entity type(s) specified', $response); + $this->assertResourceErrorResponse(422, 'No entity type(s) specified', $response); unset($normalization['_links']['type']); $request_options[RequestOptions::BODY] = $this->serializer->encode($normalization, static::$format); - // DX: 400 when no entity type bundle is specified. + // DX: 422 when no entity type bundle is specified. $response = $this->request($method, $url, $request_options); - $this->assertResourceErrorResponse(400, 'The type link relation must be specified.', $response); + $this->assertResourceErrorResponse(422, 'The type link relation must be specified.', $response); } } diff --git a/core/modules/hal/tests/src/Functional/EntityResource/Node/NodeHalJsonAnonTest.php b/core/modules/hal/tests/src/Functional/EntityResource/Node/NodeHalJsonAnonTest.php index e92a3d6643..d4ed47c37c 100644 --- a/core/modules/hal/tests/src/Functional/EntityResource/Node/NodeHalJsonAnonTest.php +++ b/core/modules/hal/tests/src/Functional/EntityResource/Node/NodeHalJsonAnonTest.php @@ -59,20 +59,20 @@ protected function getExpectedNormalizedEntity() { 'type' => [ 'href' => $this->baseUrl . '/rest/type/node/camelids', ], - $this->baseUrl . '/rest/relation/node/camelids/uid' => [ + $this->baseUrl . '/rest/relation/node/camelids/revision_uid' => [ [ 'href' => $this->baseUrl . '/user/' . $author->id() . '?_format=hal_json', - 'lang' => 'en', ], ], - $this->baseUrl . '/rest/relation/node/camelids/revision_uid' => [ + $this->baseUrl . '/rest/relation/node/camelids/uid' => [ [ 'href' => $this->baseUrl . '/user/' . $author->id() . '?_format=hal_json', + 'lang' => 'en', ], ], ], '_embedded' => [ - $this->baseUrl . '/rest/relation/node/camelids/uid' => [ + $this->baseUrl . '/rest/relation/node/camelids/revision_uid' => [ [ '_links' => [ 'self' => [ @@ -85,10 +85,9 @@ protected function getExpectedNormalizedEntity() { 'uuid' => [ ['value' => $author->uuid()] ], - 'lang' => 'en', ], ], - $this->baseUrl . '/rest/relation/node/camelids/revision_uid' => [ + $this->baseUrl . '/rest/relation/node/camelids/uid' => [ [ '_links' => [ 'self' => [ @@ -101,6 +100,7 @@ protected function getExpectedNormalizedEntity() { 'uuid' => [ ['value' => $author->uuid()] ], + 'lang' => 'en', ], ], ], diff --git a/core/modules/hal/tests/src/Functional/EntityResource/ShortcutSet/ShortcutSetHalJsonAnonTest.php b/core/modules/hal/tests/src/Functional/EntityResource/ShortcutSet/ShortcutSetHalJsonAnonTest.php new file mode 100644 index 0000000000..a1cdf2773c --- /dev/null +++ b/core/modules/hal/tests/src/Functional/EntityResource/ShortcutSet/ShortcutSetHalJsonAnonTest.php @@ -0,0 +1,30 @@ + $dimensions['width'], '#height' => $dimensions['height'], '#attributes' => $variables['attributes'], - '#uri' => $style->buildUrl($variables['uri']), '#style_name' => $variables['style_name'], ]; + // If the current image toolkit supports this file type, prepare the URI for + // the derivative image. If not, just use the original image resized to the + // dimensions specified by the style. + if ($style->supportsUri($variables['uri'])) { + $variables['image']['#uri'] = $style->buildUrl($variables['uri']); + } + else { + $variables['image']['#uri'] = $variables['uri']; + // Don't render the image by default, but allow other preprocess functions + // to override that if they need to. + $variables['image']['#access'] = FALSE; + + // Inform the site builders why their image didn't work. + \Drupal::logger('image')->warning('Could not apply @style image style to @uri because the style does not support it.', [ + '@style' => $style->label(), + '@uri' => $variables['uri'], + ]); + } + if (isset($variables['alt']) || array_key_exists('alt', $variables)) { $variables['image']['#alt'] = $variables['alt']; } diff --git a/core/modules/image/src/Entity/ImageStyle.php b/core/modules/image/src/Entity/ImageStyle.php index fb096a7fdb..dd261248a7 100644 --- a/core/modules/image/src/Entity/ImageStyle.php +++ b/core/modules/image/src/Entity/ImageStyle.php @@ -14,9 +14,11 @@ use Drupal\image\ImageStyleInterface; use Drupal\Component\Utility\Crypt; use Drupal\Component\Utility\UrlHelper; +use Drupal\Component\Utility\Unicode; use Drupal\Core\StreamWrapper\StreamWrapperInterface; use Symfony\Component\DependencyInjection\Exception\ServiceNotFoundException; use Drupal\Core\Entity\Entity\EntityViewDisplay; + /** * Defines an image style configuration entity. * @@ -274,9 +276,8 @@ public function flush($path = NULL) { * {@inheritdoc} */ public function createDerivative($original_uri, $derivative_uri) { - // If the source file doesn't exist, return FALSE without creating folders. - $image = \Drupal::service('image.factory')->get($original_uri); + $image = $this->getImageFactory()->get($original_uri); if (!$image->isValid()) { return FALSE; } @@ -343,6 +344,18 @@ public function deleteImageEffect(ImageEffectInterface $effect) { /** * {@inheritdoc} */ + public function supportsUri($uri) { + // Only support the URI if its extension is supported by the current image + // toolkit. + return in_array( + Unicode::strtolower(pathinfo($uri, PATHINFO_EXTENSION)), + $this->getImageFactory()->getSupportedExtensions() + ); + } + + /** + * {@inheritdoc} + */ public function getEffect($effect) { return $this->getEffects()->get($effect); } @@ -409,6 +422,16 @@ protected function getImageEffectPluginManager() { } /** + * Returns the image factory. + * + * @return \Drupal\Core\Image\ImageFactory + * The image factory. + */ + protected function getImageFactory() { + return \Drupal::service('image.factory'); + } + + /** * Gets the Drupal private key. * * @return string diff --git a/core/modules/image/src/ImageStyleInterface.php b/core/modules/image/src/ImageStyleInterface.php index 89fd060a28..7dec361075 100644 --- a/core/modules/image/src/ImageStyleInterface.php +++ b/core/modules/image/src/ImageStyleInterface.php @@ -194,4 +194,15 @@ public function addImageEffect(array $configuration); */ public function deleteImageEffect(ImageEffectInterface $effect); + /** + * Determines if this style can be applied to a given image. + * + * @param string $uri + * The URI of the image. + * + * @return bool + * TRUE if the image is supported, FALSE otherwise. + */ + public function supportsUri($uri); + } diff --git a/core/modules/image/tests/src/Kernel/ImageFormatterTest.php b/core/modules/image/tests/src/Kernel/ImageFormatterTest.php index f001743509..e994f12e27 100644 --- a/core/modules/image/tests/src/Kernel/ImageFormatterTest.php +++ b/core/modules/image/tests/src/Kernel/ImageFormatterTest.php @@ -7,6 +7,8 @@ use Drupal\entity_test\Entity\EntityTest; use Drupal\field\Entity\FieldConfig; use Drupal\field\Entity\FieldStorageConfig; +use Drupal\file\Entity\File; +use Drupal\image\Entity\ImageStyle; use Drupal\Tests\field\Kernel\FieldKernelTestBase; /** @@ -99,4 +101,89 @@ public function testImageFormatterCacheTags() { $this->assertEquals($entity->{$this->fieldName}[1]->entity->getCacheTags(), $build[$this->fieldName][1]['#cache']['tags'], 'Second image cache tags is as expected'); } + /** + * Tests ImageFormatter's handling of SVG images. + * + * @requires extension gd + */ + public function testImageFormatterSvg() { + // Install the default image styles. + $this->installConfig(['image']); + + /** @var \Drupal\Core\Render\RendererInterface $renderer */ + $renderer = $this->container->get('renderer'); + + $png = File::create([ + 'uri' => 'public://test-image.png', + ]); + $png->save(); + + // We need to create an actual empty PNG, or the GD toolkit will not + // consider the image valid. + $png_resource = imagecreate(300, 300); + imagefill($png_resource, 0, 0, imagecolorallocate($png_resource, 0, 0, 0)); + imagepng($png_resource, $png->getFileUri()); + + $svg = File::create([ + 'uri' => 'public://test-image.svg', + ]); + $svg->save(); + // We don't have to put any real SVG data in here, because the GD toolkit + // won't be able to load it anyway. + touch($svg->getFileUri()); + + $entity = EntityTest::create([ + 'name' => $this->randomMachineName(), + $this->fieldName => [$png, $svg], + ]); + $entity->save(); + + // Ensure that the display is using the medium image style. + $component = $this->display->getComponent($this->fieldName); + $component['settings']['image_style'] = 'medium'; + $this->display->setComponent($this->fieldName, $component)->save(); + + $build = $this->display->build($entity); + + // The first image is a PNG, so it is supported by the GD image toolkit. + // The image style should be applied with its cache tags, image derivative + // computed with its URI and dimensions. + $this->assertCacheTags($build[$this->fieldName][0], ImageStyle::load('medium')->getCacheTags()); + $renderer->renderRoot($build[$this->fieldName][0]); + $this->assertEquals('medium', $build[$this->fieldName][0]['#image_style']); + // We check that the image URL contains the expected style directory + // structure. + $this->assertTrue(strpos($build[$this->fieldName][0]['#markup'], 'styles/medium/public/test-image.png') !== FALSE); + $this->assertTrue(strpos($build[$this->fieldName][0]['#markup'], 'width="220"') !== FALSE); + $this->assertTrue(strpos($build[$this->fieldName][0]['#markup'], 'height="220"') !== FALSE); + + // The second image is an SVG, which is not supported by the GD toolkit. + // The image style should still be applied with its cache tags, but image + // derivative will not be available so
- {{ content.content }}
+
+
-
{% endif %}
diff --git a/core/modules/layout_discovery/layouts/onecol/onecol.css b/core/modules/layout_discovery/layouts/onecol/onecol.css
index 040b7f10c1..e2283c5888 100644
--- a/core/modules/layout_discovery/layouts/onecol/onecol.css
+++ b/core/modules/layout_discovery/layouts/onecol/onecol.css
@@ -1,3 +1,7 @@
-.layout--onecol .layout-region {
+/*
+ * @file
+ * Provides the layout styles for layout_onecol.
+ */
+.layout--onecol .layout__region {
width: 100%;
}
diff --git a/core/modules/layout_discovery/layouts/threecol_25_50_25/layout--threecol-25-50-25.html.twig b/core/modules/layout_discovery/layouts/threecol_25_50_25/layout--threecol-25-50-25.html.twig
index 78db2b4b32..85255252ce 100644
--- a/core/modules/layout_discovery/layouts/threecol_25_50_25/layout--threecol-25-50-25.html.twig
+++ b/core/modules/layout_discovery/layouts/threecol_25_50_25/layout--threecol-25-50-25.html.twig
@@ -14,34 +14,41 @@
*/
#}
{%
-set classes = [
-'layout--threecol',
-]
+ set classes = [
+ 'layout',
+ 'layout--threecol-25-50-25',
+ ]
%}
{% if content %}
-
+ {{ content.content }}
+
- {{ content.top }}
-
- {% endif %}
+
+ {{ content.top }}
+
+ {% endif %}
-
- {{ content.left }}
-
+ {% if content.first %}
+
+ {{ content.first }}
+
+ {% endif %}
-
- {{ content.middle }}
-
+ {% if content.second %}
+
+ {{ content.second }}
+
+ {% endif %}
-
- {{ content.right }}
-
+ {% if content.third %}
+
+ {{ content.third }}
+
+ {% endif %}
- {% if content.bottom %}
-
- {{ content.bottom }}
-
- {% endif %}
-
+ {% if content.bottom %}
+
+ {{ content.bottom }}
+
+ {% endif %}
+
{% endif %}
diff --git a/core/modules/layout_discovery/layouts/threecol_25_50_25/threecol_25_50_25.css b/core/modules/layout_discovery/layouts/threecol_25_50_25/threecol_25_50_25.css
index 7472d55d66..1f41f46054 100644
--- a/core/modules/layout_discovery/layouts/threecol_25_50_25/threecol_25_50_25.css
+++ b/core/modules/layout_discovery/layouts/threecol_25_50_25/threecol_25_50_25.css
@@ -1,17 +1,26 @@
-.layout--threecol {
+/*
+ * @file
+ * Provides the layout styles for layout_threecol_25_50_25.
+ *
+ * @todo Using display: flex requires https://www.drupal.org/node/2842298 to be
+ * in before this can be marked as stable.
+ */
+.layout--threecol-25-50-25 {
display: flex;
flex-wrap: wrap;
- justify-content: space-between;
}
-.layout--threecol > .layout-region {
- flex: 0 1 25%;
-}
-
-.layout--threecol > .layout-region--fullwidth {
+.layout--threecol-25-50-25 > .layout__region,
+.layout--threecol-25-50-25 > .layout__region--second {
flex: 0 1 100%;
}
-.layout--threecol > .layout-region--middle {
- flex: 0 1 50%;
+@media screen and (min-width: 40em) {
+ .layout--threecol-25-50-25 > .layout__region--first,
+ .layout--threecol-25-50-25 > .layout__region--third {
+ flex: 0 1 25%;
+ }
+ .layout--threecol-25-50-25 > .layout__region--second {
+ flex: 0 1 50%;
+ }
}
diff --git a/core/modules/layout_discovery/layouts/threecol_33_34_33/layout--threecol-33-34-33.html.twig b/core/modules/layout_discovery/layouts/threecol_33_34_33/layout--threecol-33-34-33.html.twig
index 59461f42c2..5eabb04078 100644
--- a/core/modules/layout_discovery/layouts/threecol_33_34_33/layout--threecol-33-34-33.html.twig
+++ b/core/modules/layout_discovery/layouts/threecol_33_34_33/layout--threecol-33-34-33.html.twig
@@ -14,34 +14,41 @@
*/
#}
{%
-set classes = [
-'layout--threecol-33',
-]
+ set classes = [
+ 'layout',
+ 'layout--threecol-33-34-33',
+ ]
%}
{% if content %}
-
- {{ content.top }}
-
- {% endif %}
+
+ {{ content.top }}
+
+ {% endif %}
-
- {{ content.left }}
-
+ {% if content.first %}
+
+ {{ content.first }}
+
+ {% endif %}
-
- {{ content.middle }}
-
+ {% if content.second %}
+
+ {{ content.second }}
+
+ {% endif %}
-
- {{ content.right }}
-
+ {% if content.third %}
+
+ {{ content.third }}
+
+ {% endif %}
- {% if content.bottom %}
-
- {{ content.bottom }}
+ {% if content.bottom %}
+
- {% endif %}
-
{% endif %}
diff --git a/core/modules/layout_discovery/layouts/threecol_33_34_33/threecol_33_34_33.css b/core/modules/layout_discovery/layouts/threecol_33_34_33/threecol_33_34_33.css
index 7091416fdf..29a816fce5 100644
--- a/core/modules/layout_discovery/layouts/threecol_33_34_33/threecol_33_34_33.css
+++ b/core/modules/layout_discovery/layouts/threecol_33_34_33/threecol_33_34_33.css
@@ -1,13 +1,24 @@
-.layout--threecol-33 {
+/*
+ * @file
+ * Provides the layout styles for layout_threecol_33_34_33.
+ *
+ * @todo Using display: flex requires https://www.drupal.org/node/2842298 to be
+ * in before this can be marked as stable.
+ */
+
+.layout--threecol-33-34-33 {
display: flex;
flex-wrap: wrap;
- justify-content: space-between;
}
-.layout--threecol-33 > .layout-region {
- flex: 0 1 33%;
+.layout--threecol-33-34-33 > .layout__region {
+ flex: 0 1 100%;
}
-.layout--threecol-33 > .layout-region--fullwidth {
- flex: 0 1 100%;
+@media screen and (min-width: 40em) {
+ .layout--threecol-33-34-33 > .layout__region--first,
+ .layout--threecol-33-34-33 > .layout__region--second,
+ .layout--threecol-33-34-33 > .layout__region--third {
+ flex: 0 1 33%;
+ }
}
diff --git a/core/modules/layout_discovery/layouts/twocol/layout--twocol.html.twig b/core/modules/layout_discovery/layouts/twocol/layout--twocol.html.twig
index efebf0f95e..b416cbd471 100644
--- a/core/modules/layout_discovery/layouts/twocol/layout--twocol.html.twig
+++ b/core/modules/layout_discovery/layouts/twocol/layout--twocol.html.twig
@@ -11,26 +11,35 @@
*/
#}
{%
-set classes = [
-'layout--twocol',
-]
+ set classes = [
+ 'layout',
+ 'layout--twocol',
+ ]
%}
{% if content %}
+ {{ content.bottom }}
+
+ {% endif %}
- {{ content.top }}
-
+ {% if content.top %}
+
+ {{ content.top }}
+
+ {% endif %}
-
- {{ content.left }}
-
+ {% if content.first %}
+
+ {{ content.first }}
+
+ {% endif %}
-
- {{ content.right }}
-
+ {% if content.second %}
+
+ {{ content.second }}
+
+ {% endif %}
-
- {{ content.bottom }}
-
+ {% if content.bottom %}
+
+ {{ content.bottom }}
+
+ {% endif %}
{% endif %}
diff --git a/core/modules/layout_discovery/layouts/twocol/twocol.css b/core/modules/layout_discovery/layouts/twocol/twocol.css
index 41e8883ddf..be9b59bb73 100644
--- a/core/modules/layout_discovery/layouts/twocol/twocol.css
+++ b/core/modules/layout_discovery/layouts/twocol/twocol.css
@@ -1,13 +1,23 @@
+/*
+ * @file
+ * Provides the layout styles for layout_twocol.
+ *
+ * @todo Using display: flex requires https://www.drupal.org/node/2842298 to be
+ * in before this can be marked as stable.
+ */
+
.layout--twocol {
display: flex;
flex-wrap: wrap;
- justify-content: space-between;
}
-.layout--twocol > .layout-region {
- flex: 0 1 50%;
+.layout--twocol > .layout__region {
+ flex: 0 1 100%;
}
-.layout--twocol > .layout-region--fullwidth {
- flex: 0 1 100%;
+@media screen and (min-width: 40em) {
+ .layout--twocol > .layout__region--first,
+ .layout--twocol > .layout__region--second {
+ flex: 0 1 50%;
+ }
}
diff --git a/core/modules/layout_discovery/layouts/twocol_bricks/layout--twocol-bricks.html.twig b/core/modules/layout_discovery/layouts/twocol_bricks/layout--twocol-bricks.html.twig
index 9c6231b8b5..10995771bf 100644
--- a/core/modules/layout_discovery/layouts/twocol_bricks/layout--twocol-bricks.html.twig
+++ b/core/modules/layout_discovery/layouts/twocol_bricks/layout--twocol-bricks.html.twig
@@ -14,38 +14,53 @@
*/
#}
{%
-set classes = [
-'layout--twocol-bricks',
-]
+ set classes = [
+ 'layout',
+ 'layout--twocol-bricks',
+ ]
%}
{% if content %}
-
- {{ content.top }}
-
+
+ {{ content.top }}
+
+ {% endif %}
-
- {{ content.left_above }}
-
+ {% if content.first_above %}
+
+ {{ content.first_above }}
+
+ {% endif %}
-
- {{ content.right_above }}
-
+ {% if content.second_above %}
+
+ {{ content.second_above }}
+
+ {% endif %}
-
- {{ content.middle }}
-
+ {% if content.middle %}
+
+ {{ content.middle }}
+
+ {% endif %}
-
- {{ content.left_below }}
-
+ {% if content.first_below %}
+
+ {{ content.first_below }}
+
+ {% endif %}
-
- {{ content.right_below }}
-
+ {% if content.second_below %}
+
+ {{ content.second_below }}
+
+ {% endif %}
-
- {{ content.bottom }}
+ {% if content.bottom %}
+
-
{% endif %}
diff --git a/core/modules/layout_discovery/layouts/twocol_bricks/twocol_bricks.css b/core/modules/layout_discovery/layouts/twocol_bricks/twocol_bricks.css
index aef887a4ac..c8466aff7d 100644
--- a/core/modules/layout_discovery/layouts/twocol_bricks/twocol_bricks.css
+++ b/core/modules/layout_discovery/layouts/twocol_bricks/twocol_bricks.css
@@ -1,13 +1,25 @@
+/*
+ * @file
+ * Provides the layout styles for layout_twocol_bricks.
+ *
+ * @todo Using display: flex requires https://www.drupal.org/node/2842298 to be
+ * in before this can be marked as stable.
+ */
+
.layout--twocol-bricks {
display: flex;
flex-wrap: wrap;
- justify-content: space-between;
}
-.layout--twocol-bricks > .layout-region {
- flex: 0 1 50%;
+.layout--twocol-bricks > .layout__region {
+ flex: 0 1 100%;
}
-.layout--twocol-bricks > .layout-region--fullwidth {
- flex: 0 1 100%;
+@media screen and (min-width: 40em) {
+ .layout--twocol-bricks > .layout__region--first-above,
+ .layout--twocol-bricks > .layout__region--second-above,
+ .layout--twocol-bricks > .layout__region--first-below,
+ .layout--twocol-bricks > .layout__region--second-below {
+ flex: 0 1 50%;
+ }
}
diff --git a/core/modules/layout_discovery/templates/layout.html.twig b/core/modules/layout_discovery/templates/layout.html.twig
index 88ea7457d4..6ba96d5ecd 100644
--- a/core/modules/layout_discovery/templates/layout.html.twig
+++ b/core/modules/layout_discovery/templates/layout.html.twig
@@ -4,15 +4,20 @@
* Template for a generic layout.
*/
#}
-{% set classes = [
- 'layout--' ~ layout.id|clean_class,
-] %}
+{%
+ set classes = [
+ 'layout',
+ 'layout--' ~ layout.id|clean_class,
+ ]
+%}
{% if content %}
-
+ {{ content.bottom }}
+
+ {% endif %}
- {{ content[region] }}
+
+ {% for region in layout.getRegionNames %}
+ {% if content[region] %}
+
-{% endfor %}
-
{% endif %}
diff --git a/core/modules/layout_discovery/tests/src/Kernel/LayoutTest.php b/core/modules/layout_discovery/tests/src/Kernel/LayoutTest.php
index 9d4c446d3c..fa8fdd6563 100644
--- a/core/modules/layout_discovery/tests/src/Kernel/LayoutTest.php
+++ b/core/modules/layout_discovery/tests/src/Kernel/LayoutTest.php
@@ -38,12 +38,11 @@ protected function setUp() {
*
* @dataProvider renderLayoutData
*/
- public function testRenderLayout($layout_id, $config, $regions, $html) {
+ public function testRenderLayout($layout_id, $config, $regions, array $html) {
$layout = $this->layoutPluginManager->createInstance($layout_id, $config);
$built['layout'] = $layout->build($regions);
- $built['layout']['#prefix'] = 'Test prefix';
- $built['layout']['#suffix'] = 'Test suffix';
- $html = 'Test prefix' . $html . "\n" . 'Test suffix';
+ $built['layout']['#prefix'] = 'Test prefix' . "\n";
+ $built['layout']['#suffix'] = 'Test suffix' . "\n";
// Assume each layout is contained by a form, in order to ensure the
// building of the layout does not interfere with form processing.
@@ -53,14 +52,40 @@ public function testRenderLayout($layout_id, $config, $regions, $html) {
$form_builder->processForm('the_form_id', $built, $form_state);
$this->render($built);
- $this->assertRaw($html);
- $this->assertRaw('');
+
+ // Add in the wrapping form elements and prefix/suffix.
+ array_unshift($html, 'Test prefix');
+ array_unshift($html, '';
+
+ // Match the HTML to the full form element.
+ $this->assertSame(implode("\n", $html), $this->cssSelect('#the-form-id')[0]->asXML());
+ }
+
+ /**
+ * {@inheritdoc}
+ */
+ protected function render(array &$elements) {
+ $content = parent::render($elements);
+ // Strip leading whitespace from every line.
+ $this->content = preg_replace('/^\s+/m', '', $content);
+ return $this->content;
}
/**
* Data provider for testRenderLayout().
*/
public function renderLayoutData() {
+ $html = [];
+ $html[] = '
+ {{ content[region] }}
+
+ {% endif %}
+ {% endfor %}
';
+ $html[] = '
';
$data['layout_onecol'] = [
'layout_onecol',
[],
@@ -69,7 +94,18 @@ public function renderLayoutData() {
'#markup' => 'This is the content',
],
],
+ $html,
];
+
+ $html = [];
+ $html[] = '';
+ $html[] = 'This is the content';
+ $html[] = '
';
+ $html[] = '';
+ $html[] = '
';
$data['layout_test_1col_with_form'] = [
'layout_test_1col',
[],
@@ -81,8 +117,18 @@ public function renderLayoutData() {
'#markup' => 'This is the bottom',
],
],
+ $html,
];
+ $html = [];
+ $html[] = '';
+ $html[] = 'This string added by #process.';
+ $html[] = '
';
+ $html[] = '';
+ $html[] = 'This is the bottom';
+ $html[] = '
';
+ $html[] = '';
+ $html[] = '
';
$data['layout_test_1col'] = [
'layout_test_1col',
[],
@@ -94,8 +140,18 @@ public function renderLayoutData() {
'#markup' => 'This is the bottom',
],
],
+ $html,
];
+ $html = [];
+ $html[] = '';
+ $html[] = 'This is the top';
+ $html[] = '
';
+ $html[] = '';
+ $html[] = 'This is the bottom';
+ $html[] = '
';
+ $html[] = '';
+ $html[] = '
';
$data['layout_test_1col_no_template'] = [
'layout_test_1col_no_template',
[],
@@ -107,8 +163,18 @@ public function renderLayoutData() {
'#markup' => 'This is the bottom',
],
],
+ $html,
];
+ $html = [];
+ $html[] = '';
+ $html[] = 'This is the top';
+ $html[] = '
';
+ $html[] = '';
+ $html[] = 'This is the bottom';
+ $html[] = '
';
+ $html[] = '';
+ $html[] = '
';
$data['layout_test_2col'] = [
'layout_test_2col',
[],
@@ -120,8 +186,19 @@ public function renderLayoutData() {
'#markup' => 'This is the right',
],
],
+ $html,
];
+ $html = [];
+ $html[] = '';
+ $html[] = 'This is the left';
+ $html[] = '
';
+ $html[] = '';
+ $html[] = 'This is the right';
+ $html[] = '
';
+ $html[] = '';
+ $html[] = '
';
$data['layout_test_plugin'] = [
'layout_test_plugin',
[
@@ -132,72 +209,9 @@ public function renderLayoutData() {
'#markup' => 'Main region',
],
],
+ $html,
];
- $data['layout_onecol'][] = <<<'EOD'
-';
+ $html[] = 'Blah: ';
+ $html[] = 'Config value';
+ $html[] = '
';
+ $html[] = '';
+ $html[] = 'Main region';
+ $html[] = '
';
+ $html[] = '
-
-EOD;
-
- $data['layout_test_1col_with_form'][] = <<<'EOD'
-
- This is the content
-
-
-
-EOD;
-
- $data['layout_test_1col'][] = <<<'EOD'
-
- This string added by #process.
-
-
- This is the bottom
-
-
-
-EOD;
-
- $data['layout_test_1col_no_template'][] = <<<'EOD'
-
- This is the top
-
-
- This is the bottom
-
-
-
-EOD;
-
- $data['layout_test_2col'][] = <<<'EOD'
-
- This is the top
-
-
- This is the bottom
-
-
-
-EOD;
-
- $data['layout_test_plugin'][] = <<<'EOD'
-
- This is the left
-
-
- This is the right
-
-
-
-EOD;
-
return $data;
}
diff --git a/core/modules/link/src/Plugin/Field/FieldWidget/LinkWidget.php b/core/modules/link/src/Plugin/Field/FieldWidget/LinkWidget.php
index fd17a64c95..1319dc3d22 100644
--- a/core/modules/link/src/Plugin/Field/FieldWidget/LinkWidget.php
+++ b/core/modules/link/src/Plugin/Field/FieldWidget/LinkWidget.php
@@ -176,6 +176,7 @@ public function formElement(FieldItemListInterface $items, $delta, array $elemen
'#element_validate' => [[get_called_class(), 'validateUriElement']],
'#maxlength' => 2048,
'#required' => $element['#required'],
+ '#link_type' => $this->getFieldSetting('link_type'),
];
// If the field is configured to support internal links, it cannot use the
diff --git a/core/modules/link/tests/src/Functional/LinkFieldTest.php b/core/modules/link/tests/src/Functional/LinkFieldTest.php
index 67aee9c3b9..c99ad0a931 100644
--- a/core/modules/link/tests/src/Functional/LinkFieldTest.php
+++ b/core/modules/link/tests/src/Functional/LinkFieldTest.php
@@ -606,6 +606,49 @@ public function testLinkSeparateFormatter() {
}
}
+ /**
+ * Test '#link_type' property exists on 'link_default' widget.
+ *
+ * Make sure the 'link_default' widget exposes a '#link_type' property on
+ * its element. Modules can use it to understand if a text form element is
+ * a link and also which LinkItemInterface::LINK_* is (EXTERNAL, GENERIC,
+ * INTERNAL).
+ */
+ public function testLinkTypeOnLinkWidget() {
+
+ $link_type = LinkItemInterface::LINK_EXTERNAL;
+ $field_name = Unicode::strtolower($this->randomMachineName());
+
+ // Create a field with settings to validate.
+ $this->fieldStorage = FieldStorageConfig::create([
+ 'field_name' => $field_name,
+ 'entity_type' => 'entity_test',
+ 'type' => 'link',
+ 'cardinality' => 1,
+ ]);
+ $this->fieldStorage->save();
+ FieldConfig::create([
+ 'field_storage' => $this->fieldStorage,
+ 'label' => 'Read more about this entity',
+ 'bundle' => 'entity_test',
+ 'settings' => [
+ 'title' => DRUPAL_OPTIONAL,
+ 'link_type' => $link_type,
+ ],
+ ])->save();
+
+ $this->container->get('entity.manager')
+ ->getStorage('entity_form_display')
+ ->load('entity_test.entity_test.default')
+ ->setComponent($field_name, [
+ 'type' => 'link_default',
+ ])
+ ->save();
+
+ $form = \Drupal::service('entity.form_builder')->getForm(EntityTest::create());
+ $this->assertEqual($form[$field_name]['widget'][0]['uri']['#link_type'], $link_type);
+ }
+
/**
* Tests editing a link to a non-node entity.
diff --git a/core/modules/locale/src/LocaleConfigManager.php b/core/modules/locale/src/LocaleConfigManager.php
index e67f3bc4a2..18f335c10b 100644
--- a/core/modules/locale/src/LocaleConfigManager.php
+++ b/core/modules/locale/src/LocaleConfigManager.php
@@ -140,9 +140,7 @@ public function getTranslatableDefaultConfig($name) {
if ($this->isSupported($name)) {
// Create typed configuration wrapper based on install storage data.
$data = $this->defaultConfigStorage->read($name);
- $type_definition = $this->typedConfigManager->getDefinition($name);
- $data_definition = $this->typedConfigManager->buildDataDefinition($type_definition, $data);
- $typed_config = $this->typedConfigManager->create($data_definition, $data);
+ $typed_config = $this->typedConfigManager->createFromNameAndData($name, $data);
if ($typed_config instanceof TraversableTypedDataInterface) {
return $this->getTranslatableData($typed_config);
}
diff --git a/core/modules/locale/src/StringDatabaseStorage.php b/core/modules/locale/src/StringDatabaseStorage.php
index 57358dc32a..45bf41d1ff 100644
--- a/core/modules/locale/src/StringDatabaseStorage.php
+++ b/core/modules/locale/src/StringDatabaseStorage.php
@@ -3,6 +3,7 @@
namespace Drupal\locale;
use Drupal\Core\Database\Connection;
+use Drupal\Core\Database\Query\Condition;
/**
* Defines a class to store localized strings in the database.
@@ -416,7 +417,7 @@ protected function dbStringSelect(array $conditions, array $options = []) {
elseif ($table_alias == 't' && $join === 'leftJoin') {
// Conditions for target fields when doing an outer join only make
// sense if we add also OR field IS NULL.
- $query->condition(db_or()
+ $query->condition((new Condition('OR'))
->condition($field_alias, (array) $value, 'IN')
->isNull($field_alias)
);
@@ -429,7 +430,7 @@ protected function dbStringSelect(array $conditions, array $options = []) {
// Process other options, string filter, query limit, etc.
if (!empty($options['filters'])) {
if (count($options['filters']) > 1) {
- $filter = db_or();
+ $filter = new Condition('OR');
$query->condition($filter);
}
else {
diff --git a/core/modules/migrate/src/Plugin/MigrateIdMapInterface.php b/core/modules/migrate/src/Plugin/MigrateIdMapInterface.php
index eafac29662..7ba0168ee6 100644
--- a/core/modules/migrate/src/Plugin/MigrateIdMapInterface.php
+++ b/core/modules/migrate/src/Plugin/MigrateIdMapInterface.php
@@ -213,6 +213,8 @@ public function lookupSourceID(array $destination_id_values);
*
* @deprecated in Drupal 8.1.x, will be removed before Drupal 9.0.x. Use
* lookupDestinationIds() instead.
+ *
+ * @see https://www.drupal.org/node/2725809
*/
public function lookupDestinationId(array $source_id_values);
diff --git a/core/modules/migrate/src/Plugin/Migration.php b/core/modules/migrate/src/Plugin/Migration.php
index 13092e7775..c7457b2025 100644
--- a/core/modules/migrate/src/Plugin/Migration.php
+++ b/core/modules/migrate/src/Plugin/Migration.php
@@ -312,6 +312,8 @@ public function label() {
*
* @deprecated in Drupal 8.1.x, will be removed before Drupal 9.0.x. Use
* more specific getters instead.
+ *
+ * @see https://www.drupal.org/node/2873795
*/
public function get($property) {
return isset($this->$property) ? $this->$property : NULL;
diff --git a/core/modules/migrate/src/Plugin/migrate/process/DedupeBase.php b/core/modules/migrate/src/Plugin/migrate/process/DedupeBase.php
index 910058eb0f..90801ebdcb 100644
--- a/core/modules/migrate/src/Plugin/migrate/process/DedupeBase.php
+++ b/core/modules/migrate/src/Plugin/migrate/process/DedupeBase.php
@@ -17,6 +17,8 @@
*
* @deprecated in Drupal 8.4.x and will be removed in Drupal 9.0.x. Use
* \Drupal\migrate\Plugin\migrate\process\MakeUniqueBase instead.
+ *
+ * @see https://www.drupal.org/node/2873762
*/
abstract class DedupeBase extends MakeUniqueBase {
}
diff --git a/core/modules/migrate/src/Plugin/migrate/process/DedupeEntity.php b/core/modules/migrate/src/Plugin/migrate/process/DedupeEntity.php
index afa31455d4..eda44b755c 100644
--- a/core/modules/migrate/src/Plugin/migrate/process/DedupeEntity.php
+++ b/core/modules/migrate/src/Plugin/migrate/process/DedupeEntity.php
@@ -19,5 +19,7 @@
*
* @deprecated in Drupal 8.4.x and will be removed in Drupal 9.0.x. Use
* \Drupal\migrate\Plugin\migrate\process\MakeUniqueEntityField instead.
+ *
+ * @see https://www.drupal.org/node/2873762
*/
class DedupeEntity extends MakeUniqueEntityField { }
diff --git a/core/modules/migrate/tests/src/Unit/Event/EventBaseTest.php b/core/modules/migrate/tests/src/Unit/Event/EventBaseTest.php
index 6a52ed6efe..b712d318b2 100644
--- a/core/modules/migrate/tests/src/Unit/Event/EventBaseTest.php
+++ b/core/modules/migrate/tests/src/Unit/Event/EventBaseTest.php
@@ -3,12 +3,13 @@
namespace Drupal\Tests\migrate\Unit\Event;
use Drupal\migrate\Event\EventBase;
+use Drupal\Tests\UnitTestCase;
/**
* @coversDefaultClass \Drupal\migrate\Event\EventBase
* @group migrate
*/
-class EventBaseTest extends \PHPUnit_Framework_TestCase {
+class EventBaseTest extends UnitTestCase {
/**
* Test getMigration method.
diff --git a/core/modules/migrate/tests/src/Unit/Event/MigrateImportEventTest.php b/core/modules/migrate/tests/src/Unit/Event/MigrateImportEventTest.php
index 480fe85a70..d281433e03 100644
--- a/core/modules/migrate/tests/src/Unit/Event/MigrateImportEventTest.php
+++ b/core/modules/migrate/tests/src/Unit/Event/MigrateImportEventTest.php
@@ -3,12 +3,13 @@
namespace Drupal\Tests\migrate\Unit\Event;
use Drupal\migrate\Event\MigrateImportEvent;
+use Drupal\Tests\UnitTestCase;
/**
* @coversDefaultClass \Drupal\migrate\Event\MigrateImportEvent
* @group migrate
*/
-class MigrateImportEventTest extends \PHPUnit_Framework_TestCase {
+class MigrateImportEventTest extends UnitTestCase {
/**
* Test getMigration method.
diff --git a/core/modules/migrate/tests/src/Unit/process/DedupeEntityTest.php b/core/modules/migrate/tests/src/Unit/process/DedupeEntityTest.php
index a5daa72032..377533465f 100644
--- a/core/modules/migrate/tests/src/Unit/process/DedupeEntityTest.php
+++ b/core/modules/migrate/tests/src/Unit/process/DedupeEntityTest.php
@@ -2,9 +2,6 @@
namespace Drupal\Tests\migrate\Unit\process;
-@trigger_error('The ' . __NAMESPACE__ . '\DedupeEntityTest is deprecated in
-Drupal 8.4.0 and will be removed before Drupal 9.0.0. Instead, use ' . __NAMESPACE__ . '\MakeUniqueEntityFieldTest', E_USER_DEPRECATED);
-
use Drupal\Core\Entity\EntityStorageInterface;
use Drupal\Core\Entity\EntityTypeManagerInterface;
use Drupal\Core\Entity\Query\QueryInterface;
@@ -14,6 +11,7 @@
/**
* @coversDefaultClass \Drupal\migrate\Plugin\migrate\process\DedupeEntity
* @group migrate
+ * @group legacy
*/
class DedupeEntityTest extends MigrateProcessTestCase {
diff --git a/core/modules/migrate/tests/src/Unit/process/MigrationTest.php b/core/modules/migrate/tests/src/Unit/process/MigrationTest.php
index 843d1e558b..cade905a4d 100644
--- a/core/modules/migrate/tests/src/Unit/process/MigrationTest.php
+++ b/core/modules/migrate/tests/src/Unit/process/MigrationTest.php
@@ -2,9 +2,6 @@
namespace Drupal\Tests\migrate\Unit\process;
-@trigger_error('The ' . __NAMESPACE__ . '\MigrationTest is deprecated in
-Drupal 8.4.0 and will be removed before Drupal 9.0.0. Instead, use ' . __NAMESPACE__ . '\MigrationLookupTest', E_USER_DEPRECATED);
-
use Drupal\Core\Entity\EntityStorageInterface;
use Drupal\migrate\MigrateSkipProcessException;
use Drupal\migrate\Plugin\MigrationInterface;
@@ -17,11 +14,9 @@
use Prophecy\Argument;
/**
- * @deprecated in Drupal 8.4.x, to be removed before Drupal 9.0.x. Use
- * \Drupal\Tests\migrate\Unit\process\MigrationLookupTest instead.
- *
* @coversDefaultClass \Drupal\migrate\Plugin\migrate\process\Migration
* @group migrate
+ * @group legacy
*/
class MigrationTest extends MigrateProcessTestCase {
diff --git a/core/modules/migrate_drupal/src/Plugin/MigrateCckFieldInterface.php b/core/modules/migrate_drupal/src/Plugin/MigrateCckFieldInterface.php
index c64738f563..49f41a3817 100644
--- a/core/modules/migrate_drupal/src/Plugin/MigrateCckFieldInterface.php
+++ b/core/modules/migrate_drupal/src/Plugin/MigrateCckFieldInterface.php
@@ -13,6 +13,8 @@
*
* @deprecated in Drupal 8.3.x, to be removed before Drupal 9.0.x. Use
* \Drupal\migrate_drupal\Annotation\MigrateField instead.
+ *
+ * @see https://www.drupal.org/node/2751897
*/
interface MigrateCckFieldInterface extends MigrateFieldInterface {
diff --git a/core/modules/node/content_types.js b/core/modules/node/content_types.js
index eed93f01c9..4ec34aa05e 100644
--- a/core/modules/node/content_types.js
+++ b/core/modules/node/content_types.js
@@ -26,7 +26,7 @@
});
$context.find('#edit-workflow').drupalSetSummary(function (context) {
var vals = [];
- $(context).find('input[name^="options"]:checked').parent().each(function () {
+ $(context).find('input[name^="options"]:checked').next('label').each(function () {
vals.push(Drupal.checkPlain($(this).text()));
});
if (!$(context).find('#edit-options-status').is(':checked')) {
diff --git a/core/modules/node/node.install b/core/modules/node/node.install
index 4e2c24098e..6469245c49 100644
--- a/core/modules/node/node.install
+++ b/core/modules/node/node.install
@@ -74,7 +74,7 @@ function node_schema() {
'default' => 0,
],
'realm' => [
- 'description' => 'The realm in which the user must possess the grant ID. Each node access node can define one or more realms.',
+ 'description' => 'The realm in which the user must possess the grant ID. Modules can define one or more realms by implementing hook_node_grants().',
'type' => 'varchar_ascii',
'length' => 255,
'not null' => TRUE,
@@ -246,3 +246,12 @@ function node_update_8301() {
$entity_type->set('entity_keys', $keys);
$definition_update_manager->updateEntityType($entity_type);
}
+
+/**
+ * Fix realm column description on the node_access table.
+ */
+function node_update_8400() {
+ $schema = drupal_get_module_schema('node', 'node_access');
+ $schema['fields']['realm']['description'] = 'The realm in which the user must possess the grant ID. Modules can define one or more realms by implementing hook_node_grants().';
+ Database::getConnection()->schema()->changeField('node_access', 'realm', 'realm', $schema['fields']['realm']);
+}
diff --git a/core/modules/node/node.module b/core/modules/node/node.module
index 40e5b4e293..466f510001 100644
--- a/core/modules/node/node.module
+++ b/core/modules/node/node.module
@@ -1099,7 +1099,7 @@ function node_query_node_access_alter(AlterableInterface $query) {
// context.
$request = \Drupal::requestStack()->getCurrentRequest();
$renderer = \Drupal::service('renderer');
- if ($request->isMethodSafe() && $renderer->hasRenderContext()) {
+ if ($request->isMethodCacheable() && $renderer->hasRenderContext()) {
$build = ['#cache' => ['contexts' => ['user.node_grants:' . $op]]];
$renderer->render($build);
}
diff --git a/core/modules/node/node.permissions.yml b/core/modules/node/node.permissions.yml
index 753ed40147..289227c71a 100644
--- a/core/modules/node/node.permissions.yml
+++ b/core/modules/node/node.permissions.yml
@@ -18,12 +18,13 @@ view own unpublished content:
title: 'View own unpublished content'
view all revisions:
title: 'View all revisions'
+ description: 'To view a revision, you also need permission to view the content item.'
revert all revisions:
title: 'Revert all revisions'
- description: 'Role requires permission view revisions and edit rights for nodes in question or administer nodes.'
+ description: 'To revert a revision, you also need permission to edit the content item.'
delete all revisions:
title: 'Delete all revisions'
- description: 'Role requires permission to view revisions and delete rights for nodes in question or administer nodes.'
+ description: 'To delete a revision, you also need permission to delete the content item.'
permission_callbacks:
- \Drupal\node\NodePermissions::nodeTypePermissions
diff --git a/core/modules/node/src/Entity/Node.php b/core/modules/node/src/Entity/Node.php
index 4f8efe3c53..74a7c0bc3e 100644
--- a/core/modules/node/src/Entity/Node.php
+++ b/core/modules/node/src/Entity/Node.php
@@ -2,9 +2,7 @@
namespace Drupal\node\Entity;
-use Drupal\Core\Entity\ContentEntityBase;
-use Drupal\Core\Entity\EntityChangedTrait;
-use Drupal\Core\Entity\EntityPublishedTrait;
+use Drupal\Core\Entity\EditorialContentEntityBase;
use Drupal\Core\Entity\EntityStorageInterface;
use Drupal\Core\Entity\EntityTypeInterface;
use Drupal\Core\Field\BaseFieldDefinition;
@@ -61,6 +59,11 @@
* "published" = "status",
* "uid" = "uid",
* },
+ * revision_metadata_keys = {
+ * "revision_user" = "revision_uid",
+ * "revision_created" = "revision_timestamp",
+ * "revision_log_message" = "revision_log"
+ * },
* bundle_entity_type = "node_type",
* field_ui_base_route = "entity.node_type.edit_form",
* common_reference_target = TRUE,
@@ -71,13 +74,11 @@
* "edit-form" = "/node/{node}/edit",
* "version-history" = "/node/{node}/revisions",
* "revision" = "/node/{node}/revisions/{node_revision}/view",
+ * "create" = "/node",
* }
* )
*/
-class Node extends ContentEntityBase implements NodeInterface {
-
- use EntityChangedTrait;
- use EntityPublishedTrait;
+class Node extends EditorialContentEntityBase implements NodeInterface {
/**
* Whether the node is being previewed or not.
@@ -281,21 +282,6 @@ public function setOwner(UserInterface $account) {
/**
* {@inheritdoc}
*/
- public function getRevisionCreationTime() {
- return $this->get('revision_timestamp')->value;
- }
-
- /**
- * {@inheritdoc}
- */
- public function setRevisionCreationTime($timestamp) {
- $this->set('revision_timestamp', $timestamp);
- return $this;
- }
-
- /**
- * {@inheritdoc}
- */
public function getRevisionAuthor() {
return $this->getRevisionUser();
}
@@ -303,13 +289,6 @@ public function getRevisionAuthor() {
/**
* {@inheritdoc}
*/
- public function getRevisionUser() {
- return $this->get('revision_uid')->entity;
- }
-
- /**
- * {@inheritdoc}
- */
public function setRevisionAuthorId($uid) {
$this->setRevisionUserId($uid);
return $this;
@@ -318,47 +297,8 @@ public function setRevisionAuthorId($uid) {
/**
* {@inheritdoc}
*/
- public function setRevisionUser(UserInterface $user) {
- $this->set('revision_uid', $user);
- return $this;
- }
-
- /**
- * {@inheritdoc}
- */
- public function getRevisionUserId() {
- return $this->get('revision_uid')->entity->id();
- }
-
- /**
- * {@inheritdoc}
- */
- public function setRevisionUserId($user_id) {
- $this->set('revision_uid', $user_id);
- return $this;
- }
-
- /**
- * {@inheritdoc}
- */
- public function getRevisionLogMessage() {
- return $this->get('revision_log')->value;
- }
-
- /**
- * {@inheritdoc}
- */
- public function setRevisionLogMessage($revision_log_message) {
- $this->set('revision_log', $revision_log_message);
- return $this;
- }
-
- /**
- * {@inheritdoc}
- */
public static function baseFieldDefinitions(EntityTypeInterface $entity_type) {
$fields = parent::baseFieldDefinitions($entity_type);
- $fields += static::publishedBaseFieldDefinitions($entity_type);
$fields['title'] = BaseFieldDefinition::create('string')
->setLabel(t('Title'))
@@ -450,32 +390,6 @@ public static function baseFieldDefinitions(EntityTypeInterface $entity_type) {
])
->setDisplayConfigurable('form', TRUE);
- $fields['revision_timestamp'] = BaseFieldDefinition::create('created')
- ->setLabel(t('Revision timestamp'))
- ->setDescription(t('The time that the current revision was created.'))
- ->setQueryable(FALSE)
- ->setRevisionable(TRUE);
-
- $fields['revision_uid'] = BaseFieldDefinition::create('entity_reference')
- ->setLabel(t('Revision user ID'))
- ->setDescription(t('The user ID of the author of the current revision.'))
- ->setSetting('target_type', 'user')
- ->setQueryable(FALSE)
- ->setRevisionable(TRUE);
-
- $fields['revision_log'] = BaseFieldDefinition::create('string_long')
- ->setLabel(t('Revision log message'))
- ->setDescription(t('Briefly describe the changes you have made.'))
- ->setRevisionable(TRUE)
- ->setDefaultValue('')
- ->setDisplayOptions('form', [
- 'type' => 'string_textarea',
- 'weight' => 25,
- 'settings' => [
- 'rows' => 4,
- ],
- ]);
-
$fields['revision_translation_affected'] = BaseFieldDefinition::create('boolean')
->setLabel(t('Revision translation affected'))
->setDescription(t('Indicates if the last edit of a translation belongs to current revision.'))
diff --git a/core/modules/node/src/Form/NodeRevisionRevertForm.php b/core/modules/node/src/Form/NodeRevisionRevertForm.php
index 09aab6f543..8137c3f4fa 100644
--- a/core/modules/node/src/Form/NodeRevisionRevertForm.php
+++ b/core/modules/node/src/Form/NodeRevisionRevertForm.php
@@ -2,6 +2,7 @@
namespace Drupal\node\Form;
+use Drupal\Component\Datetime\TimeInterface;
use Drupal\Core\Datetime\DateFormatterInterface;
use Drupal\Core\Entity\EntityStorageInterface;
use Drupal\Core\Form\ConfirmFormBase;
@@ -37,16 +38,26 @@ class NodeRevisionRevertForm extends ConfirmFormBase {
protected $dateFormatter;
/**
+ * The time service.
+ *
+ * @var \Drupal\Component\Datetime\TimeInterface
+ */
+ protected $time;
+
+ /**
* Constructs a new NodeRevisionRevertForm.
*
* @param \Drupal\Core\Entity\EntityStorageInterface $node_storage
* The node storage.
* @param \Drupal\Core\Datetime\DateFormatterInterface $date_formatter
* The date formatter service.
+ * @param \Drupal\Component\Datetime\TimeInterface $time
+ * The time service.
*/
- public function __construct(EntityStorageInterface $node_storage, DateFormatterInterface $date_formatter) {
+ public function __construct(EntityStorageInterface $node_storage, DateFormatterInterface $date_formatter, TimeInterface $time) {
$this->nodeStorage = $node_storage;
$this->dateFormatter = $date_formatter;
+ $this->time = $time;
}
/**
@@ -55,7 +66,8 @@ public function __construct(EntityStorageInterface $node_storage, DateFormatterI
public static function create(ContainerInterface $container) {
return new static(
$container->get('entity.manager')->getStorage('node'),
- $container->get('date.formatter')
+ $container->get('date.formatter'),
+ $container->get('datetime.time')
);
}
@@ -114,6 +126,8 @@ public function submitForm(array &$form, FormStateInterface $form_state) {
$this->revision = $this->prepareRevertedRevision($this->revision, $form_state);
$this->revision->revision_log = t('Copy of the revision from %date.', ['%date' => $this->dateFormatter->format($original_revision_timestamp)]);
+ $this->revision->setRevisionCreationTime($this->time->getRequestTime());
+ $this->revision->setChangedTime($this->time->getRequestTime());
$this->revision->save();
$this->logger('content')->notice('@type: reverted %title revision %revision.', ['@type' => $this->revision->bundle(), '%title' => $this->revision->label(), '%revision' => $this->revision->getRevisionId()]);
diff --git a/core/modules/node/src/Form/NodeRevisionRevertTranslationForm.php b/core/modules/node/src/Form/NodeRevisionRevertTranslationForm.php
index fd20dadce1..d5da697abe 100644
--- a/core/modules/node/src/Form/NodeRevisionRevertTranslationForm.php
+++ b/core/modules/node/src/Form/NodeRevisionRevertTranslationForm.php
@@ -2,6 +2,7 @@
namespace Drupal\node\Form;
+use Drupal\Component\Datetime\TimeInterface;
use Drupal\Core\Datetime\DateFormatterInterface;
use Drupal\Core\Entity\EntityStorageInterface;
use Drupal\Core\Form\FormStateInterface;
@@ -37,9 +38,11 @@ class NodeRevisionRevertTranslationForm extends NodeRevisionRevertForm {
* The date formatter service.
* @param \Drupal\Core\Language\LanguageManagerInterface $language_manager
* The language manager.
+ * @param \Drupal\Component\Datetime\TimeInterface $time
+ * The time service.
*/
- public function __construct(EntityStorageInterface $node_storage, DateFormatterInterface $date_formatter, LanguageManagerInterface $language_manager) {
- parent::__construct($node_storage, $date_formatter);
+ public function __construct(EntityStorageInterface $node_storage, DateFormatterInterface $date_formatter, LanguageManagerInterface $language_manager, TimeInterface $time) {
+ parent::__construct($node_storage, $date_formatter, $time);
$this->languageManager = $language_manager;
}
@@ -50,7 +53,8 @@ public static function create(ContainerInterface $container) {
return new static(
$container->get('entity.manager')->getStorage('node'),
$container->get('date.formatter'),
- $container->get('language_manager')
+ $container->get('language_manager'),
+ $container->get('datetime.time')
);
}
diff --git a/core/modules/node/src/NodePermissions.php b/core/modules/node/src/NodePermissions.php
index 5754d71eac..1996360ae1 100644
--- a/core/modules/node/src/NodePermissions.php
+++ b/core/modules/node/src/NodePermissions.php
@@ -62,14 +62,15 @@ protected function buildPermissions(NodeType $type) {
],
"view $type_id revisions" => [
'title' => $this->t('%type_name: View revisions', $type_params),
+ 'description' => t('To view a revision, you also need permission to view the content item.'),
],
"revert $type_id revisions" => [
'title' => $this->t('%type_name: Revert revisions', $type_params),
- 'description' => t('Role requires permission view revisions and edit rights for nodes in question, or administer nodes.'),
+ 'description' => t('To revert a revision, you also need permission to edit the content item.'),
],
"delete $type_id revisions" => [
'title' => $this->t('%type_name: Delete revisions', $type_params),
- 'description' => $this->t('Role requires permission to view revisions and delete rights for nodes in question, or administer nodes.'),
+ 'description' => $this->t('To delete a revision, you also need permission to delete the content item.'),
],
];
}
diff --git a/core/modules/node/src/Plugin/views/filter/Access.php b/core/modules/node/src/Plugin/views/filter/Access.php
index 73844e11d1..10ae9227ae 100644
--- a/core/modules/node/src/Plugin/views/filter/Access.php
+++ b/core/modules/node/src/Plugin/views/filter/Access.php
@@ -2,6 +2,7 @@
namespace Drupal\node\Plugin\views\filter;
+use Drupal\Core\Database\Query\Condition;
use Drupal\Core\Form\FormStateInterface;
use Drupal\views\Plugin\views\filter\FilterPluginBase;
@@ -27,10 +28,10 @@ public function query() {
$account = $this->view->getUser();
if (!$account->hasPermission('bypass node access')) {
$table = $this->ensureMyTable();
- $grants = db_or();
+ $grants = new Condition('OR');
foreach (node_access_grants('view', $account) as $realm => $gids) {
foreach ($gids as $gid) {
- $grants->condition(db_and()
+ $grants->condition((new Condition('AND'))
->condition($table . '.gid', $gid)
->condition($table . '.realm', $realm)
);
diff --git a/core/modules/node/tests/src/FunctionalJavascript/TestSettingSummariesContentType.php b/core/modules/node/tests/src/FunctionalJavascript/TestSettingSummariesContentType.php
new file mode 100644
index 0000000000..4760ee6509
--- /dev/null
+++ b/core/modules/node/tests/src/FunctionalJavascript/TestSettingSummariesContentType.php
@@ -0,0 +1,49 @@
+drupalCreateUser(['administer content types']);
+ $this->drupalLogin($admin_user);
+ $this->drupalCreateContentType(['type' => 'test']);
+ }
+
+ /**
+ * Test a vertical tab 'Workflow' summary.
+ */
+ public function testWorkflowSummary() {
+ $this->drupalGet('admin/structure/types/manage/test');
+ $page = $this->getSession()->getPage();
+ $page->findField('options[status]')->uncheck();
+ $page->findField('options[sticky]')->check();
+ $page->findField('options[promote]')->check();
+ $page->findField('options[revision]')->check();
+ $locator = '[href="#edit-workflow"] .vertical-tabs__menu-item-summary';
+ $page->waitFor(10, function () use ($page, $locator) {
+ $summary = $page->find('css', $locator)->getText();
+ return strpos('Not published', $summary) !== FALSE;
+ });
+ $summary = $page->find('css', $locator)->getText();
+ $this->assertEquals('Not published, Promoted to front page, Sticky at top of lists, Create new revision', $summary);
+ }
+
+}
diff --git a/core/modules/quickedit/quickedit.services.yml b/core/modules/quickedit/quickedit.services.yml
index 692ba2f489..3d7d934378 100644
--- a/core/modules/quickedit/quickedit.services.yml
+++ b/core/modules/quickedit/quickedit.services.yml
@@ -3,7 +3,7 @@ services:
class: Drupal\quickedit\Plugin\InPlaceEditorManager
parent: default_plugin_manager
access_check.quickedit.entity_field:
- class: Drupal\quickedit\Access\EditEntityFieldAccessCheck
+ class: Drupal\quickedit\Access\QuickEditEntityFieldAccessCheck
tags:
- { name: access_check, applies_to: _access_quickedit_entity_field }
quickedit.editor.selector:
diff --git a/core/modules/quickedit/src/Access/EditEntityFieldAccessCheck.php b/core/modules/quickedit/src/Access/EditEntityFieldAccessCheck.php
index 7b3883833c..f93790863b 100644
--- a/core/modules/quickedit/src/Access/EditEntityFieldAccessCheck.php
+++ b/core/modules/quickedit/src/Access/EditEntityFieldAccessCheck.php
@@ -2,61 +2,9 @@
namespace Drupal\quickedit\Access;
-use Drupal\Core\Access\AccessResult;
-use Drupal\Core\Routing\Access\AccessInterface;
-use Drupal\Core\Session\AccountInterface;
-use Drupal\Core\Entity\EntityInterface;
-
/**
- * Access check for editing entity fields.
+ * @deprecated in Drupal 8.4.x and will be removed before Drupal 9.0.0.
*/
-class EditEntityFieldAccessCheck implements AccessInterface, EditEntityFieldAccessCheckInterface {
-
- /**
- * Checks Quick Edit access to the field.
- *
- * @param \Drupal\Core\Entity\EntityInterface $entity
- * The entity containing the field.
- * @param string $field_name
- * The field name.
- * @param string $langcode
- * The langcode.
- * @param \Drupal\Core\Session\AccountInterface $account
- * The currently logged in account.
- *
- * @return \Drupal\Core\Access\AccessResultInterface
- * The access result.
- *
- * @todo Use the $account argument: https://www.drupal.org/node/2266809.
- */
- public function access(EntityInterface $entity, $field_name, $langcode, AccountInterface $account) {
- if (!$this->validateRequestAttributes($entity, $field_name, $langcode)) {
- return AccessResult::forbidden();
- }
-
- return $this->accessEditEntityField($entity, $field_name);
- }
-
- /**
- * {@inheritdoc}
- */
- public function accessEditEntityField(EntityInterface $entity, $field_name) {
- return $entity->access('update', NULL, TRUE)->andIf($entity->get($field_name)->access('edit', NULL, TRUE));
- }
-
- /**
- * Validates request attributes.
- */
- protected function validateRequestAttributes(EntityInterface $entity, $field_name, $langcode) {
- // Validate the field name and language.
- if (!$field_name || !$entity->hasField($field_name)) {
- return FALSE;
- }
- if (!$langcode || !$entity->hasTranslation($langcode)) {
- return FALSE;
- }
-
- return TRUE;
- }
+class EditEntityFieldAccessCheck extends QuickEditEntityFieldAccessCheck {
}
diff --git a/core/modules/quickedit/src/Access/EditEntityFieldAccessCheckInterface.php b/core/modules/quickedit/src/Access/EditEntityFieldAccessCheckInterface.php
index c7f14e261a..cfdb32df57 100644
--- a/core/modules/quickedit/src/Access/EditEntityFieldAccessCheckInterface.php
+++ b/core/modules/quickedit/src/Access/EditEntityFieldAccessCheckInterface.php
@@ -2,24 +2,9 @@
namespace Drupal\quickedit\Access;
-use Drupal\Core\Entity\EntityInterface;
-
/**
- * Access check for editing entity fields.
+ * @deprecated in Drupal 8.4.x and will be removed before Drupal 9.0.0.
*/
-interface EditEntityFieldAccessCheckInterface {
-
- /**
- * Checks access to edit the requested field of the requested entity.
- *
- * @param \Drupal\Core\Entity\EntityInterface $entity
- * The entity.
- * @param string $field_name
- * The field name.
- *
- * @return \Drupal\Core\Access\AccessResultInterface
- * The access result.
- */
- public function accessEditEntityField(EntityInterface $entity, $field_name);
+interface EditEntityFieldAccessCheckInterface extends QuickEditEntityFieldAccessCheckInterface {
}
diff --git a/core/modules/quickedit/src/Access/QuickEditEntityFieldAccessCheck.php b/core/modules/quickedit/src/Access/QuickEditEntityFieldAccessCheck.php
new file mode 100644
index 0000000000..5404b04885
--- /dev/null
+++ b/core/modules/quickedit/src/Access/QuickEditEntityFieldAccessCheck.php
@@ -0,0 +1,62 @@
+validateRequestAttributes($entity, $field_name, $langcode)) {
+ return AccessResult::forbidden();
+ }
+
+ return $this->accessEditEntityField($entity, $field_name);
+ }
+
+ /**
+ * {@inheritdoc}
+ */
+ public function accessEditEntityField(EntityInterface $entity, $field_name) {
+ return $entity->access('update', NULL, TRUE)->andIf($entity->get($field_name)->access('edit', NULL, TRUE));
+ }
+
+ /**
+ * Validates request attributes.
+ */
+ protected function validateRequestAttributes(EntityInterface $entity, $field_name, $langcode) {
+ // Validate the field name and language.
+ if (!$field_name || !$entity->hasField($field_name)) {
+ return FALSE;
+ }
+ if (!$langcode || !$entity->hasTranslation($langcode)) {
+ return FALSE;
+ }
+
+ return TRUE;
+ }
+
+}
diff --git a/core/modules/quickedit/src/Access/QuickEditEntityFieldAccessCheckInterface.php b/core/modules/quickedit/src/Access/QuickEditEntityFieldAccessCheckInterface.php
new file mode 100644
index 0000000000..1428b4829a
--- /dev/null
+++ b/core/modules/quickedit/src/Access/QuickEditEntityFieldAccessCheckInterface.php
@@ -0,0 +1,25 @@
+accessChecker = $access_checker;
$this->editorSelector = $editor_selector;
$this->editorManager = $editor_manager;
diff --git a/core/modules/quickedit/src/Tests/QuickEditLoadingTest.php b/core/modules/quickedit/src/Tests/QuickEditLoadingTest.php
index a6705f41e8..41f26a841f 100644
--- a/core/modules/quickedit/src/Tests/QuickEditLoadingTest.php
+++ b/core/modules/quickedit/src/Tests/QuickEditLoadingTest.php
@@ -115,12 +115,12 @@ public function testUserWithoutPermission() {
$this->assertIdentical(Json::encode(['message' => "The 'access in-place editing' permission is required."]), $response);
$this->assertResponse(403);
- // Quick Edit's JavaScript would SearchRankingTestnever hit these endpoints if the metadata
+ // Quick Edit's JavaScript would never hit these endpoints if the metadata
// was empty as above, but we need to make sure that malicious users aren't
// able to use any of the other endpoints either.
$post = ['editors[0]' => 'form'] + $this->getAjaxPageStatePostData();
$response = $this->drupalPost('quickedit/attachments', '', $post, ['query' => [MainContentViewSubscriber::WRAPPER_FORMAT => 'drupal_ajax']]);
- $message = Json::encode(['message' => "A fatal error occurred: The 'access in-place editing' permission is required."]);
+ $message = Json::encode(['message' => "The 'access in-place editing' permission is required."]);
$this->assertIdentical($message, $response);
$this->assertResponse(403);
$post = ['nocssjs' => 'true'] + $this->getAjaxPageStatePostData();
diff --git a/core/modules/quickedit/tests/modules/src/MockEditEntityFieldAccessCheck.php b/core/modules/quickedit/tests/modules/src/MockEditEntityFieldAccessCheck.php
index b5d94564b1..7596aa87c3 100644
--- a/core/modules/quickedit/tests/modules/src/MockEditEntityFieldAccessCheck.php
+++ b/core/modules/quickedit/tests/modules/src/MockEditEntityFieldAccessCheck.php
@@ -2,19 +2,9 @@
namespace Drupal\quickedit_test;
-use Drupal\Core\Entity\EntityInterface;
-use Drupal\quickedit\Access\EditEntityFieldAccessCheckInterface;
-
/**
- * Access check for editing entity fields.
+ * @deprecated in Drupal 8.4.x and will be removed before Drupal 9.0.0.
*/
-class MockEditEntityFieldAccessCheck implements EditEntityFieldAccessCheckInterface {
-
- /**
- * {@inheritdoc}
- */
- public function accessEditEntityField(EntityInterface $entity, $field_name) {
- return TRUE;
- }
+class MockEditEntityFieldAccessCheck extends MockQuickEditEntityFieldAccessCheck {
}
diff --git a/core/modules/quickedit/tests/modules/src/MockQuickEditEntityFieldAccessCheck.php b/core/modules/quickedit/tests/modules/src/MockQuickEditEntityFieldAccessCheck.php
new file mode 100644
index 0000000000..2459c50f08
--- /dev/null
+++ b/core/modules/quickedit/tests/modules/src/MockQuickEditEntityFieldAccessCheck.php
@@ -0,0 +1,20 @@
+editorManager = $this->container->get('plugin.manager.quickedit.editor');
- $this->accessChecker = new MockEditEntityFieldAccessCheck();
+ $this->accessChecker = new MockQuickEditEntityFieldAccessCheck();
$this->editorSelector = new EditorSelector($this->editorManager, $this->container->get('plugin.manager.field.formatter'));
$this->metadataGenerator = new MetadataGenerator($this->accessChecker, $this->editorSelector, $this->editorManager);
}
diff --git a/core/modules/quickedit/tests/src/Unit/Access/EditEntityFieldAccessCheckTest.php b/core/modules/quickedit/tests/src/Unit/Access/QuickEditEntityFieldAccessCheckTest.php
similarity index 91%
rename from core/modules/quickedit/tests/src/Unit/Access/EditEntityFieldAccessCheckTest.php
rename to core/modules/quickedit/tests/src/Unit/Access/QuickEditEntityFieldAccessCheckTest.php
index 7e7e0bbb99..0827436982 100644
--- a/core/modules/quickedit/tests/src/Unit/Access/EditEntityFieldAccessCheckTest.php
+++ b/core/modules/quickedit/tests/src/Unit/Access/QuickEditEntityFieldAccessCheckTest.php
@@ -5,21 +5,21 @@
use Drupal\Core\Access\AccessResult;
use Drupal\Core\Cache\Context\CacheContextsManager;
use Drupal\Core\DependencyInjection\Container;
-use Drupal\quickedit\Access\EditEntityFieldAccessCheck;
+use Drupal\quickedit\Access\QuickEditEntityFieldAccessCheck;
use Drupal\Tests\UnitTestCase;
use Drupal\Core\Language\LanguageInterface;
/**
- * @coversDefaultClass \Drupal\quickedit\Access\EditEntityFieldAccessCheck
+ * @coversDefaultClass \Drupal\quickedit\Access\QuickEditEntityFieldAccessCheck
* @group Access
* @group quickedit
*/
-class EditEntityFieldAccessCheckTest extends UnitTestCase {
+class QuickEditEntityFieldAccessCheckTest extends UnitTestCase {
/**
* The tested access checker.
*
- * @var \Drupal\quickedit\Access\EditEntityFieldAccessCheck
+ * @var \Drupal\quickedit\Access\QuickEditEntityFieldAccessCheck
*/
protected $editAccessCheck;
@@ -27,7 +27,7 @@ class EditEntityFieldAccessCheckTest extends UnitTestCase {
* {@inheritdoc}
*/
protected function setUp() {
- $this->editAccessCheck = new EditEntityFieldAccessCheck();
+ $this->editAccessCheck = new QuickEditEntityFieldAccessCheck();
$cache_contexts_manager = $this->prophesize(CacheContextsManager::class);
$cache_contexts_manager->assertValidTokens()->willReturn(TRUE);
@@ -40,7 +40,7 @@ protected function setUp() {
/**
* Provides test data for testAccess().
*
- * @see \Drupal\Tests\edit\Unit\quickedit\Access\EditEntityFieldAccessCheckTest::testAccess()
+ * @see \Drupal\Tests\edit\Unit\quickedit\Access\QuickEditEntityFieldAccessCheckTest::testAccess()
*/
public function providerTestAccess() {
$data = [];
diff --git a/core/modules/responsive_image/src/Tests/ResponsiveImageAdminUITest.php b/core/modules/responsive_image/tests/src/Functional/ResponsiveImageAdminUITest.php
similarity index 95%
rename from core/modules/responsive_image/src/Tests/ResponsiveImageAdminUITest.php
rename to core/modules/responsive_image/tests/src/Functional/ResponsiveImageAdminUITest.php
index 0439771b19..eeaf793fa0 100644
--- a/core/modules/responsive_image/src/Tests/ResponsiveImageAdminUITest.php
+++ b/core/modules/responsive_image/tests/src/Functional/ResponsiveImageAdminUITest.php
@@ -1,15 +1,15 @@
assertFieldByName('keyed_styles[responsive_image_test_module.' . $case[0] . '][' . $case[1] . '][image_mapping_type]', '');
+ $this->assertFieldByName('keyed_styles[responsive_image_test_module.' . $case[0] . '][' . $case[1] . '][image_mapping_type]', NULL);
// Check if the image style dropdowns are present.
- $this->assertFieldByName('keyed_styles[responsive_image_test_module.' . $case[0] . '][' . $case[1] . '][image_style]', '');
+ $this->assertFieldByName('keyed_styles[responsive_image_test_module.' . $case[0] . '][' . $case[1] . '][image_style]', NULL);
// Check if the sizes textfields are present.
- $this->assertFieldByName('keyed_styles[responsive_image_test_module.' . $case[0] . '][' . $case[1] . '][sizes]', '');
+ $this->assertFieldByName('keyed_styles[responsive_image_test_module.' . $case[0] . '][' . $case[1] . '][sizes]', NULL);
foreach ($image_styles as $image_style_name) {
// Check if the image styles are available in the dropdowns.
diff --git a/core/modules/rest/rest.module b/core/modules/rest/rest.module
index afdb9ffe3c..edd74b9985 100644
--- a/core/modules/rest/rest.module
+++ b/core/modules/rest/rest.module
@@ -15,13 +15,13 @@ function rest_help($route_name, RouteMatchInterface $route_match) {
case 'help.page.rest':
$output = '';
$output .= '
- Blah:
- Config value
-
-
- Main region
-
-' . t('About') . '
'; - $output .= '' . t('The RESTful Web Services module provides a framework for exposing REST resources on your site. It provides support for content entities (see the Field module help page for more information about entities) such as content, users, taxonomy terms, etc.; REST support for content items of the Node module is enabled by default, and support for other types of content entities can be enabled. Other modules may add support for other types of REST resources. For more information, see the online documentation for the RESTful Web Services module.', [':rest' => 'https://www.drupal.org/documentation/modules/rest', ':field' => (\Drupal::moduleHandler()->moduleExists('field')) ? \Drupal::url('help.page', ['name' => 'field']) : '#']) . '
'; + $output .= '' . t('The RESTful Web Services module provides a framework for exposing REST resources on your site. It provides support for content entity types such as the main site content, comments, custom blocks, taxonomy terms, and user accounts, etc. (see the Field module help page for more information about entities). REST support for content items of the Node module is enabled by default, and support for other types of content entities can be enabled. Other modules may add support for other types of REST resources. For more information, see the online documentation for the RESTful Web Services module.', [':rest' => 'https://www.drupal.org/documentation/modules/rest', ':field' => (\Drupal::moduleHandler()->moduleExists('field')) ? \Drupal::url('help.page', ['name' => 'field']) : '#']) . '
'; $output .= '' . t('Uses') . '
'; $output .= '- ';
$output .= '
- ' . t('Installing supporting modules') . ' '; $output .= '
- ' . t('In order to use REST on a web site, you need to install modules that provide serialization and authentication services. You can use the Core module HAL for serialization and HTTP Basic Authentication for authentication, or install a contributed or custom module.', [':hal' => (\Drupal::moduleHandler()->moduleExists('hal')) ? \Drupal::url('help.page', ['name' => 'hal']) : '#', ':basic_auth' => (\Drupal::moduleHandler()->moduleExists('basic_auth')) ? \Drupal::url('help.page', ['name' => 'basic_auth']) : '#']) . ' '; $output .= '
- ' . t('Enabling REST support for an entity type') . ' '; - $output .= '
- ' . t('REST support for content items of the Node module is enabled by default, and support for other types of content entities can be enabled. To enable support, you can use a process based on configuration editing or the contributed Rest UI module.', [':config' => 'https://www.drupal.org/documentation/modules/rest', ':restui' => 'https://www.drupal.org/project/restui']) . ' '; + $output .= '
- ' . t('REST support for content types (provided by the Node module) is enabled by default. To enable support for other content entity types, you can use a process based on configuration editing or the contributed REST UI module.', [':node' => (\Drupal::moduleHandler()->moduleExists('node')) ? \Drupal::url('help.page', ['name' => 'node']) : '#', ':config' => 'https://www.drupal.org/documentation/modules/rest', ':restui' => 'https://www.drupal.org/project/restui']) . ' '; $output .= '
- ' . t('You will also need to grant anonymous users permission to perform each of the REST operations you want to be available, and set up authentication properly to authorize web requests.') . ' '; $output .= '
tags for the HTML output by // SimpletestUiPrinter. - $this->assertEqual($output[18], 'HTML output was generated
'); + $this->assertEqual($output[19], 'HTML output was generated
'); // Check that URLs are printed as HTML links. - $this->assertIdentical(strpos($output[19], 'databaseDumpFiles = [ + __DIR__ . '/../../../../system/tests/fixtures/update/drupal-8.filled.standard.php.gz', + ]; + } + + /** + * Tests that syslog.settings.facility has been converted from string to int. + * + * @see syslog_update_8400() + */ + public function testSyslogSettingsFacilityDataType() { + $config = $this->config('syslog.settings'); + $this->assertIdentical('128', $config->get('facility')); + + // Run updates. + $this->runUpdates(); + + $config = $this->config('syslog.settings'); + $this->assertIdentical(128, $config->get('facility')); + } + +} diff --git a/core/modules/syslog/syslog.install b/core/modules/syslog/syslog.install index e3377c8aeb..f0ce5cc68a 100644 --- a/core/modules/syslog/syslog.install +++ b/core/modules/syslog/syslog.install @@ -13,3 +13,12 @@ function syslog_install() { // to be set dynamically during installation. \Drupal::configFactory()->getEditable('syslog.settings')->set('facility', defined('LOG_LOCAL0') ? LOG_LOCAL0 : LOG_USER)->save(); } + +/** + * Convert syslog.settings.facility to an integer. + */ +function syslog_update_8400() { + $config = \Drupal::configFactory()->getEditable('syslog.settings'); + $facility = (int) $config->get('facility'); + $config->set('facility', $facility)->save(TRUE); +} diff --git a/core/modules/syslog/tests/src/Kernel/Migrate/d6/MigrateSyslogConfigsTest.php b/core/modules/syslog/tests/src/Kernel/Migrate/d6/MigrateSyslogConfigsTest.php index aa66203113..935af8d8aa 100644 --- a/core/modules/syslog/tests/src/Kernel/Migrate/d6/MigrateSyslogConfigsTest.php +++ b/core/modules/syslog/tests/src/Kernel/Migrate/d6/MigrateSyslogConfigsTest.php @@ -33,7 +33,7 @@ protected function setUp() { public function testSyslogSettings() { $config = $this->config('syslog.settings'); $this->assertIdentical('drupal', $config->get('identity')); - $this->assertIdentical('128', $config->get('facility')); + $this->assertIdentical(128, $config->get('facility')); $this->assertConfigSchema(\Drupal::service('config.typed'), 'syslog.settings', $config->get()); } diff --git a/core/modules/syslog/tests/src/Kernel/Migrate/d7/MigrateSyslogConfigsTest.php b/core/modules/syslog/tests/src/Kernel/Migrate/d7/MigrateSyslogConfigsTest.php index 2996b42419..ef5d8c305d 100644 --- a/core/modules/syslog/tests/src/Kernel/Migrate/d7/MigrateSyslogConfigsTest.php +++ b/core/modules/syslog/tests/src/Kernel/Migrate/d7/MigrateSyslogConfigsTest.php @@ -36,7 +36,7 @@ protected function setUp() { public function testSyslogSettings() { $config = $this->config('syslog.settings'); // 8 == LOG_USER - $this->assertIdentical('8', $config->get('facility')); + $this->assertIdentical(8, $config->get('facility')); $this->assertIdentical('!base_url|!timestamp|!type|!ip|!request_uri|!referer|!uid|!link|!message', $config->get('format')); $this->assertIdentical('drupal', $config->get('identity')); } diff --git a/core/modules/system/config/schema/system.schema.yml b/core/modules/system/config/schema/system.schema.yml index c23ed7e0ae..021840c256 100644 --- a/core/modules/system/config/schema/system.schema.yml +++ b/core/modules/system/config/schema/system.schema.yml @@ -5,8 +5,11 @@ system.site: label: 'Site information' mapping: uuid: - type: string + type: uuid label: 'Site UUID' + constraints: + Uuid: [] + NotNull: [] name: type: label label: 'Site name' diff --git a/core/modules/system/src/Controller/Http4xxController.php b/core/modules/system/src/Controller/Http4xxController.php index f8c97e4f54..ee8a9776d4 100644 --- a/core/modules/system/src/Controller/Http4xxController.php +++ b/core/modules/system/src/Controller/Http4xxController.php @@ -10,6 +10,18 @@ class Http4xxController extends ControllerBase { /** + * The default 4xx error content. + * + * @return array + * A render array containing the message to display for 4xx errors. + */ + public function on4xx() { + return [ + '#markup' => $this->t('A client error happened'), + ]; + } + + /** * The default 401 content. * * @return array diff --git a/core/modules/system/src/Form/CronForm.php b/core/modules/system/src/Form/CronForm.php index d4726aac57..0779c15fa8 100644 --- a/core/modules/system/src/Form/CronForm.php +++ b/core/modules/system/src/Form/CronForm.php @@ -131,7 +131,7 @@ public function buildForm(array $form, FormStateInterface $form_state) { '#type' => 'checkbox', '#title' => t('Detailed cron logging'), '#default_value' => $this->config('system.cron')->get('logging'), - '#description' => 'Run times of individual cron jobs will be written to watchdog', + '#description' => $this->t('Run times of individual cron jobs will be written to watchdog'), ]; $form['actions']['#type'] = 'actions'; diff --git a/core/modules/system/src/Plugin/Block/SystemMenuBlock.php b/core/modules/system/src/Plugin/Block/SystemMenuBlock.php index c142c86c8e..52daa098e4 100644 --- a/core/modules/system/src/Plugin/Block/SystemMenuBlock.php +++ b/core/modules/system/src/Plugin/Block/SystemMenuBlock.php @@ -5,7 +5,6 @@ use Drupal\Core\Block\BlockBase; use Drupal\Core\Cache\Cache; use Drupal\Core\Form\FormStateInterface; -use Drupal\Core\Menu\MenuActiveTrailInterface; use Drupal\Core\Menu\MenuLinkTreeInterface; use Drupal\Core\Plugin\ContainerFactoryPluginInterface; use Symfony\Component\DependencyInjection\ContainerInterface; @@ -30,13 +29,6 @@ class SystemMenuBlock extends BlockBase implements ContainerFactoryPluginInterfa protected $menuTree; /** - * The active menu trail service. - * - * @var \Drupal\Core\Menu\MenuActiveTrailInterface - */ - protected $menuActiveTrail; - - /** * Constructs a new SystemMenuBlock. * * @param array $configuration @@ -47,13 +39,10 @@ class SystemMenuBlock extends BlockBase implements ContainerFactoryPluginInterfa * The plugin implementation definition. * @param \Drupal\Core\Menu\MenuLinkTreeInterface $menu_tree * The menu tree service. - * @param \Drupal\Core\Menu\MenuActiveTrailInterface $menu_active_trail - * The active menu trail service. */ - public function __construct(array $configuration, $plugin_id, $plugin_definition, MenuLinkTreeInterface $menu_tree, MenuActiveTrailInterface $menu_active_trail) { + public function __construct(array $configuration, $plugin_id, $plugin_definition, MenuLinkTreeInterface $menu_tree) { parent::__construct($configuration, $plugin_id, $plugin_definition); $this->menuTree = $menu_tree; - $this->menuActiveTrail = $menu_active_trail; } /** @@ -64,8 +53,7 @@ public static function create(ContainerInterface $container, array $configuratio $configuration, $plugin_id, $plugin_definition, - $container->get('menu.link_tree'), - $container->get('menu.active_trail') + $container->get('menu.link_tree') ); } diff --git a/core/modules/system/src/Tests/Entity/Update/MoveRevisionMetadataFieldsUpdateTest.php b/core/modules/system/src/Tests/Entity/Update/MoveRevisionMetadataFieldsUpdateTest.php new file mode 100644 index 0000000000..ba7e028ae0 --- /dev/null +++ b/core/modules/system/src/Tests/Entity/Update/MoveRevisionMetadataFieldsUpdateTest.php @@ -0,0 +1,83 @@ +databaseDumpFiles = [ + __DIR__ . '/../../../../tests/fixtures/update/drupal-8.2.0.bare.standard_with_entity_test_revlog_enabled.php.gz', + __DIR__ . '/../../../../tests/fixtures/update/drupal-8.entity-data-revision-metadata-fields-2248983.php', + __DIR__ . '/../../../../tests/fixtures/update/drupal-8.views-revision-metadata-fields-2248983.php', + ]; + } + + /** + * Tests that the revision metadata fields are moved correctly. + */ + public function testSystemUpdate8400() { + $this->runUpdates(); + + foreach (['entity_test_revlog', 'entity_test_mul_revlog'] as $entity_type_id) { + /** @var \Drupal\Core\Entity\ContentEntityStorageInterface $storage */ + $storage = \Drupal::entityTypeManager()->getStorage($entity_type_id); + /** @var \Drupal\Core\Entity\ContentEntityTypeInterface $entity_type */ + $entity_type = $storage->getEntityType(); + $revision_metadata_field_names = $entity_type->getRevisionMetadataKeys(); + + $database_schema = \Drupal::database()->schema(); + + // Test that the revision metadata fields are present only in the + // revision table. + foreach ($revision_metadata_field_names as $revision_metadata_field_name) { + if ($entity_type->isTranslatable()) { + $this->assertFalse($database_schema->fieldExists($entity_type->getDataTable(), $revision_metadata_field_name)); + $this->assertFalse($database_schema->fieldExists($entity_type->getRevisionDataTable(), $revision_metadata_field_name)); + } + else { + $this->assertFalse($database_schema->fieldExists($entity_type->getBaseTable(), $revision_metadata_field_name)); + } + $this->assertTrue($database_schema->fieldExists($entity_type->getRevisionTable(), $revision_metadata_field_name)); + } + + // Test that the revision metadata values have been transferred correctly + // and that the moved fields are accessible. + /** @var \Drupal\Core\Entity\RevisionLogInterface $entity_rev_first */ + $entity_rev_first = $storage->loadRevision(1); + $this->assertEqual($entity_rev_first->getRevisionUserId(), '1'); + $this->assertEqual($entity_rev_first->getRevisionLogMessage(), 'first revision'); + $this->assertEqual($entity_rev_first->getRevisionCreationTime(), '1476268517'); + + /** @var \Drupal\Core\Entity\RevisionLogInterface $entity_rev_second */ + $entity_rev_second = $storage->loadRevision(2); + $this->assertEqual($entity_rev_second->getRevisionUserId(), '1'); + $this->assertEqual($entity_rev_second->getRevisionLogMessage(), 'second revision'); + $this->assertEqual($entity_rev_second->getRevisionCreationTime(), '1476268518'); + + + // Test that the views using revision metadata fields are updated + // properly. + $view = View::load($entity_type_id . '_for_2248983'); + $displays = $view->get('display'); + foreach ($displays as $display => $display_data) { + foreach ($display_data['display_options']['fields'] as $property_data) { + if (in_array($property_data['field'], $revision_metadata_field_names)) { + $this->assertEqual($property_data['table'], $entity_type->getRevisionTable()); + } + } + } + } + } + +} diff --git a/core/modules/system/src/Tests/Entity/Update/SqlContentEntityStorageSchemaConverterTest.php b/core/modules/system/src/Tests/Entity/Update/SqlContentEntityStorageSchemaConverterTest.php new file mode 100644 index 0000000000..3a0aca2aef --- /dev/null +++ b/core/modules/system/src/Tests/Entity/Update/SqlContentEntityStorageSchemaConverterTest.php @@ -0,0 +1,262 @@ +entityManager = \Drupal::entityManager(); + $this->entityDefinitionUpdateManager = \Drupal::entityDefinitionUpdateManager(); + $this->lastInstalledSchemaRepository = \Drupal::service('entity.last_installed_schema.repository'); + $this->installedStorageSchema = \Drupal::keyValue('entity.storage_schema.sql'); + $this->state = \Drupal::state(); + } + + /** + * {@inheritdoc} + */ + protected function setDatabaseDumpFiles() { + $this->databaseDumpFiles = [ + __DIR__ . '/../../../../tests/fixtures/update/drupal-8.0.0-rc1-filled.standard.entity_test_update_mul.php.gz', + __DIR__ . '/../../../../tests/fixtures/update/drupal-8.entity-test-schema-converter-enabled.php', + ]; + } + + /** + * Tests the conversion of an entity type to revisionable. + */ + public function testMakeRevisionable() { + // Check that entity type is not revisionable prior to running the update + // process. + $entity_test_update = $this->lastInstalledSchemaRepository->getLastInstalledDefinition('entity_test_update'); + $this->assertFalse($entity_test_update->isRevisionable()); + + // Make the entity type revisionable and translatable and run the updates. + $this->updateEntityTypeToRevisionableAndTranslatable(); + + $this->runUpdates(); + + /** @var \Drupal\Core\Entity\EntityTypeInterface $entity_test_update */ + $entity_test_update = $this->lastInstalledSchemaRepository->getLastInstalledDefinition('entity_test_update'); + $this->assertTrue($entity_test_update->isRevisionable()); + + /** @var \Drupal\Core\Entity\Sql\SqlEntityStorageInterface $storage */ + $storage = \Drupal::entityTypeManager()->getStorage('entity_test_update'); + $this->assertEqual(count($storage->loadMultiple()), 102, 'All test entities were found.'); + + // Check that each field value was copied correctly to the revision tables. + for ($i = 1; $i <= 102; $i++) { + /** @var \Drupal\Core\Entity\ContentEntityInterface $revision */ + $revision = $storage->loadRevision($i); + + $this->assertEqual($i, $revision->id()); + $this->assertEqual($i, $revision->getRevisionId()); + + $this->assertEqual($i . ' - test single property', $revision->test_single_property->value); + + $this->assertEqual($i . ' - test multiple properties - value1', $revision->test_multiple_properties->value1); + $this->assertEqual($i . ' - test multiple properties - value2', $revision->test_multiple_properties->value2); + + $this->assertEqual($i . ' - test single property multiple values 0', $revision->test_single_property_multiple_values->value); + $this->assertEqual($i . ' - test single property multiple values 1', $revision->test_single_property_multiple_values[1]->value); + + $this->assertEqual($i . ' - test multiple properties multiple values - value1 0', $revision->test_multiple_properties_multiple_values[0]->value1); + $this->assertEqual($i . ' - test multiple properties multiple values - value2 0', $revision->test_multiple_properties_multiple_values[0]->value2); + $this->assertEqual($i . ' - test multiple properties multiple values - value1 1', $revision->test_multiple_properties_multiple_values[1]->value1); + $this->assertEqual($i . ' - test multiple properties multiple values - value2 1', $revision->test_multiple_properties_multiple_values[1]->value2); + + $this->assertEqual($i . ' - field test configurable field - value1 0', $revision->field_test_configurable_field[0]->value1); + $this->assertEqual($i . ' - field test configurable field - value2 0', $revision->field_test_configurable_field[0]->value2); + $this->assertEqual($i . ' - field test configurable field - value1 1', $revision->field_test_configurable_field[1]->value1); + $this->assertEqual($i . ' - field test configurable field - value2 1', $revision->field_test_configurable_field[1]->value2); + + $this->assertEqual($i . ' - test entity base field info', $revision->test_entity_base_field_info->value); + + // Do the same checks for translated field values. + $translation = $revision->getTranslation('ro'); + + $this->assertEqual($i . ' - test single property - ro', $translation->test_single_property->value); + + $this->assertEqual($i . ' - test multiple properties - value1 - ro', $translation->test_multiple_properties->value1); + $this->assertEqual($i . ' - test multiple properties - value2 - ro', $translation->test_multiple_properties->value2); + + $this->assertEqual($i . ' - test single property multiple values 0 - ro', $translation->test_single_property_multiple_values[0]->value); + $this->assertEqual($i . ' - test single property multiple values 1 - ro', $translation->test_single_property_multiple_values[1]->value); + + $this->assertEqual($i . ' - test multiple properties multiple values - value1 0 - ro', $translation->test_multiple_properties_multiple_values[0]->value1); + $this->assertEqual($i . ' - test multiple properties multiple values - value2 0 - ro', $translation->test_multiple_properties_multiple_values[0]->value2); + $this->assertEqual($i . ' - test multiple properties multiple values - value1 1 - ro', $translation->test_multiple_properties_multiple_values[1]->value1); + $this->assertEqual($i . ' - test multiple properties multiple values - value2 1 - ro', $translation->test_multiple_properties_multiple_values[1]->value2); + + $this->assertEqual($i . ' - field test configurable field - value1 0 - ro', $translation->field_test_configurable_field[0]->value1); + $this->assertEqual($i . ' - field test configurable field - value2 0 - ro', $translation->field_test_configurable_field[0]->value2); + $this->assertEqual($i . ' - field test configurable field - value1 1 - ro', $translation->field_test_configurable_field[1]->value1); + $this->assertEqual($i . ' - field test configurable field - value2 1 - ro', $translation->field_test_configurable_field[1]->value2); + + $this->assertEqual($i . ' - test entity base field info - ro', $translation->test_entity_base_field_info->value); + } + + // Check that temporary tables have been removed at the end of the process. + $schema = \Drupal::database()->schema(); + foreach ($storage->getTableMapping()->getTableNames() as $table_name) { + $this->assertFalse($schema->tableExists(TemporaryTableMapping::getTempTableName($table_name))); + } + + // Check that backup tables have been removed at the end of the process. + $schema = \Drupal::database()->schema(); + foreach ($storage->getTableMapping()->getTableNames() as $table_name) { + $this->assertFalse($schema->tableExists(TemporaryTableMapping::getTempTableName($table_name, 'old_'))); + } + } + + /** + * Tests that a failed "make revisionable" update preserves the existing data. + */ + public function testMakeRevisionableErrorHandling() { + $original_entity_type = $this->lastInstalledSchemaRepository->getLastInstalledDefinition('entity_test_update'); + $original_storage_definitions = $this->lastInstalledSchemaRepository->getLastInstalledFieldStorageDefinitions('entity_test_update'); + + $original_entity_schema_data = $this->installedStorageSchema->get('entity_test_update.entity_schema_data', []); + foreach ($original_storage_definitions as $storage_definition) { + $original_field_schema_data[$storage_definition->getName()] = $this->installedStorageSchema->get('entity_test_update.field_schema_data.' . $storage_definition->getName(), []); + } + + // Check that entity type is not revisionable prior to running the update + // process. + $this->assertFalse($original_entity_type->isRevisionable()); + + // Make the update throw an exception during the entity save process. + \Drupal::state()->set('entity_test_update.throw_exception', TRUE); + + // Since the update process is interrupted by the exception thrown above, + // we can not do the full post update testing offered by UpdatePathTestBase. + $this->checkFailedUpdates = FALSE; + + // Make the entity type revisionable and run the updates. + $this->updateEntityTypeToRevisionableAndTranslatable(); + + $this->runUpdates(); + + // Check that the update failed. + $this->assertRaw('' . t('Failed:') . ''); + + // Check that the last installed entity type definition is kept as + // non-revisionable. + $new_entity_type = $this->lastInstalledSchemaRepository->getLastInstalledDefinition('entity_test_update'); + $this->assertFalse($new_entity_type->isRevisionable(), 'The entity type is kept unchanged.'); + + // Check that the last installed field storage definitions did not change by + // looking at the 'langcode' field, which is updated automatically. + $new_storage_definitions = $this->lastInstalledSchemaRepository->getLastInstalledFieldStorageDefinitions('entity_test_update'); + $langcode_key = $original_entity_type->getKey('langcode'); + $this->assertEqual($original_storage_definitions[$langcode_key]->isRevisionable(), $new_storage_definitions[$langcode_key]->isRevisionable(), "The 'langcode' field is kept unchanged."); + + /** @var \Drupal\Core\Entity\Sql\SqlEntityStorageInterface $storage */ + $storage = \Drupal::entityTypeManager()->getStorage('entity_test_update'); + + // Check that installed storage schema did not change. + $new_entity_schema_data = $this->installedStorageSchema->get('entity_test_update.entity_schema_data', []); + $this->assertEqual($original_entity_schema_data, $new_entity_schema_data); + + foreach ($new_storage_definitions as $storage_definition) { + $new_field_schema_data[$storage_definition->getName()] = $this->installedStorageSchema->get('entity_test_update.field_schema_data.' . $storage_definition->getName(), []); + } + $this->assertEqual($original_field_schema_data, $new_field_schema_data); + + // Check that temporary tables have been removed. + $schema = \Drupal::database()->schema(); + foreach ($storage->getTableMapping()->getTableNames() as $table_name) { + $this->assertFalse($schema->tableExists(TemporaryTableMapping::getTempTableName($table_name))); + } + + // Check that the original tables still exist and their data is intact. + $this->assertTrue($schema->tableExists('entity_test_update')); + $this->assertTrue($schema->tableExists('entity_test_update_data')); + + $base_table_count = \Drupal::database()->select('entity_test_update') + ->countQuery() + ->execute() + ->fetchField(); + $this->assertEqual($base_table_count, 102); + + $data_table_count = \Drupal::database()->select('entity_test_update_data') + ->countQuery() + ->execute() + ->fetchField(); + // There are two records for each entity, one for English and one for + // Romanian. + $this->assertEqual($data_table_count, 204); + + $base_table_row = \Drupal::database()->select('entity_test_update') + ->fields('entity_test_update') + ->condition('id', 1, '=') + ->condition('langcode', 'en', '=') + ->execute() + ->fetchAllAssoc('id'); + $this->assertEqual('843e9ac7-3351-4cc1-a202-2dbffffae21c', $base_table_row[1]->uuid); + + $data_table_row = \Drupal::database()->select('entity_test_update_data') + ->fields('entity_test_update_data') + ->condition('id', 1, '=') + ->condition('langcode', 'en', '=') + ->execute() + ->fetchAllAssoc('id'); + $this->assertEqual('1 - test single property', $data_table_row[1]->test_single_property); + $this->assertEqual('1 - test multiple properties - value1', $data_table_row[1]->test_multiple_properties__value1); + $this->assertEqual('1 - test multiple properties - value2', $data_table_row[1]->test_multiple_properties__value2); + $this->assertEqual('1 - test entity base field info', $data_table_row[1]->test_entity_base_field_info); + } + +} diff --git a/core/modules/system/system.install b/core/modules/system/system.install index 61b2650ad0..614ad9e340 100644 --- a/core/modules/system/system.install +++ b/core/modules/system/system.install @@ -12,6 +12,9 @@ use Drupal\Core\Path\AliasStorage; use Drupal\Core\Url; use Drupal\Core\Database\Database; +use Drupal\Core\Entity\ContentEntityTypeInterface; +use Drupal\Core\Entity\EntityTypeInterface; +use Drupal\Core\Entity\FieldableEntityInterface; use Drupal\Core\DrupalKernel; use Drupal\Core\Site\Settings; use Drupal\Core\StreamWrapper\PrivateStream; @@ -1789,3 +1792,138 @@ function system_update_8301() { ->set('profile', \Drupal::installProfile()) ->save(); } + +/** + * Move revision metadata fields to the revision table. + */ +function system_update_8400(&$sandbox) { + // Due to the fields from RevisionLogEntityTrait not being explicitly + // mentioned in the storage they might have been installed wrongly in the base + // table for revisionable untranslatable entities and in the data and revision + // data tables for revisionable and translatable entities. + $entity_definition_update_manager = \Drupal::entityDefinitionUpdateManager(); + $database = \Drupal::database(); + $database_schema = $database->schema(); + + if (!isset($sandbox['current'])) { + // This must be the first run. Initialize the sandbox. + $sandbox['current'] = 0; + + $definitions = array_filter(\Drupal::entityTypeManager()->getDefinitions(), function (EntityTypeInterface $entity_type) use ($entity_definition_update_manager) { + if ($entity_type = $entity_definition_update_manager->getEntityType($entity_type->id())) { + return is_subclass_of($entity_type->getClass(), FieldableEntityInterface::class) && ($entity_type instanceof ContentEntityTypeInterface) && $entity_type->isRevisionable(); + } + return FALSE; + }); + $sandbox['entity_type_ids'] = array_keys($definitions); + $sandbox['max'] = count($sandbox['entity_type_ids']); + } + + $current_entity_type_key = $sandbox['current']; + for ($i = $current_entity_type_key; ($i < $current_entity_type_key + 1) && ($i < $sandbox['max']); $i++) { + $entity_type_id = $sandbox['entity_type_ids'][$i]; + /** @var \Drupal\Core\Entity\ContentEntityTypeInterface $entity_type */ + $entity_type = $entity_definition_update_manager->getEntityType($entity_type_id); + + $base_fields = \Drupal::service('entity_field.manager')->getBaseFieldDefinitions($entity_type_id); + $revision_metadata_fields = $entity_type->getRevisionMetadataKeys(); + $fields_to_update = array_intersect_key($base_fields, array_flip($revision_metadata_fields)); + + if (!empty($fields_to_update)) { + // Initialize the entity table names. + // @see \Drupal\Core\Entity\Sql\SqlContentEntityStorage::initTableLayout() + $base_table = $entity_type->getBaseTable() ?: $entity_type_id; + $data_table = $entity_type->getDataTable() ?: $entity_type_id . '_field_data'; + $revision_table = $entity_type->getRevisionTable() ?: $entity_type_id . '_revision'; + $revision_data_table = $entity_type->getRevisionDataTable() ?: $entity_type_id . '_field_revision'; + $revision_field = $entity_type->getKey('revision'); + + // No data needs to be migrated if the entity type is not translatable. + if ($entity_type->isTranslatable()) { + if (!isset($sandbox[$entity_type_id])) { + // This must be the first run for this entity type. Initialize the + // sub-sandbox for it. + + // Calculate the number of revisions to process. + $count = \Drupal::entityQuery($entity_type_id) + ->allRevisions() + ->count() + ->accessCheck(FALSE) + ->execute(); + + $sandbox[$entity_type_id]['current'] = 0; + $sandbox[$entity_type_id]['max'] = $count; + } + // Define the step size. + $steps = Settings::get('entity_update_batch_size', 50); + + // Collect the revision IDs to process. + $revisions = \Drupal::entityQuery($entity_type_id) + ->allRevisions() + ->range($sandbox[$entity_type_id]['current'], $sandbox[$entity_type_id]['current'] + $steps) + ->sort($revision_field, 'ASC') + ->accessCheck(FALSE) + ->execute(); + $revisions = array_keys($revisions); + + foreach ($fields_to_update as $revision_metadata_field_name => $definition) { + // If the revision metadata field is present in the data and the + // revision data table, install its definition again with the updated + // storage code in order for the field to be installed in the + // revision table. Afterwards, copy over the field values and remove + // the field from the data and the revision data tables. + if ($database_schema->fieldExists($data_table, $revision_metadata_field_name) && $database_schema->fieldExists($revision_data_table, $revision_metadata_field_name)) { + // Install the field in the revision table. + if (!isset($sandbox[$entity_type_id]['storage_definition_installed'][$revision_metadata_field_name])) { + $entity_definition_update_manager->installFieldStorageDefinition($revision_metadata_field_name, $entity_type_id, $entity_type->getProvider(), $definition); + $sandbox[$entity_type_id]['storage_definition_installed'][$revision_metadata_field_name] = TRUE; + } + + // Apply the field value from the revision data table to the + // revision table. + foreach ($revisions as $rev_id) { + $field_value = $database->select($revision_data_table, 't') + ->fields('t', [$revision_metadata_field_name]) + ->condition($revision_field, $rev_id) + ->execute() + ->fetchField(); + $database->update($revision_table) + ->condition($revision_field, $rev_id) + ->fields([$revision_metadata_field_name => $field_value]) + ->execute(); + } + } + } + + $sandbox[$entity_type_id]['current'] += count($revisions); + $sandbox[$entity_type_id]['finished'] = ($sandbox[$entity_type_id]['current'] == $sandbox[$entity_type_id]['max']) || empty($revisions); + + if ($sandbox[$entity_type_id]['finished']) { + foreach ($fields_to_update as $revision_metadata_field_name => $definition) { + // Drop the field from the data and revision data tables. + $database_schema->dropField($data_table, $revision_metadata_field_name); + $database_schema->dropField($revision_data_table, $revision_metadata_field_name); + } + $sandbox['current']++; + } + } + else { + foreach ($fields_to_update as $revision_metadata_field_name => $definition) { + if ($database_schema->fieldExists($base_table, $revision_metadata_field_name)) { + // Install the field in the revision table. + $entity_definition_update_manager->installFieldStorageDefinition($revision_metadata_field_name, $entity_type_id, $entity_type->getProvider(), $definition); + // Drop the field from the base table. + $database_schema->dropField($base_table, $revision_metadata_field_name); + } + } + $sandbox['current']++; + } + } + else { + $sandbox['current']++; + } + + } + + $sandbox['#finished'] = $sandbox['current'] == $sandbox['max']; +} diff --git a/core/modules/system/system.post_update.php b/core/modules/system/system.post_update.php index b96d3e3b3b..36039dff0d 100644 --- a/core/modules/system/system.post_update.php +++ b/core/modules/system/system.post_update.php @@ -65,3 +65,19 @@ function system_post_update_hashes_clear_cache() { function system_post_update_timestamp_plugins() { // Empty post-update hook. } + +/** + * Clear caches to ensure Classy's message library is always added. + */ +function system_post_update_classy_message_library() { + // Empty post-update hook. +} + +/** + * Force field type plugin definitions to be cleared. + * + * @see https://www.drupal.org/node/2403703 + */ +function system_post_update_field_type_plugins() { + // Empty post-update hook. +} diff --git a/core/modules/system/system.routing.yml b/core/modules/system/system.routing.yml index ee9afc1516..9cfe2ca54c 100644 --- a/core/modules/system/system.routing.yml +++ b/core/modules/system/system.routing.yml @@ -22,6 +22,14 @@ system.404: requirements: _access: 'TRUE' +system.4xx: + path: '/system/4xx' + defaults: + _controller: '\Drupal\system\Controller\Http4xxController:on4xx' + _title: 'Client error' + requirements: + _access: 'TRUE' + system.admin: path: '/admin' defaults: diff --git a/core/modules/system/tests/fixtures/update/drupal-8.2.0.bare.standard_with_entity_test_revlog_enabled.php.gz b/core/modules/system/tests/fixtures/update/drupal-8.2.0.bare.standard_with_entity_test_revlog_enabled.php.gz new file mode 100644 index 0000000000..19772649a9 --- /dev/null +++ b/core/modules/system/tests/fixtures/update/drupal-8.2.0.bare.standard_with_entity_test_revlog_enabled.php.gz @@ -0,0 +1,517 @@ + ‹ŠRX drupal-8.2.0.bare.standard_with_entity_test_revlog_enabled.php ì]is⺶ýÞ¿‚Jݪ>}ê(ǃ<¥ß=ï&IIHB n%[28ÛØfÊûߟŒÍ3&ýŽ¿t¬akkí¥½·dñ?ÿë4œoþ™ú—fcê—|daäb/_·l—d “|ûó÷ß¿¥~OýK>Ð?ÎSùHE I!ZÊó -…;-'¥ÛnÊ'ô³UO9 ×±=âÒA¥§†á¥‚R=ä¥êÄ".ò N©ƒ”ß ©ŒÛq™’O™VoÛ¦wJ%Kyšk8~ÐÈŸß¾u¼qÁ§©pÿΌĘüñóÛ·h¶eÍ7l+õÏÔøÁÙYøéÉ“ß~Ì—yZƒ´Ðo?À_šK¨`OH5ÉoßUÓÖš5ZÐ'–ÿýr]4øí[*õ]7ˆ‰½ï©þ5ý’~màèWôKàá×ß=âÈüþÇø‰eû)«cšÃ§OÏ—“'žñ>ªCç¡5[§cyFÝ"8RçGøßw—t Ž©ö(F0 ¥rdÏoK{dÒÕ* ºÈÕÈ!O3Œ8:1‰U÷aežû>ß]§óÁ€wêŽåäH&²êÔf8DvnˆÃ¾;®ÑBî Õ$ƒeØ›ìXF»C‚r‹ CumˆäZ-Ð_ÖEfgÙ†ÚWÀ|+µõ¸›}º0(äObÊ(—þ‹\jÑk0¾ÐIkàµÍZ0Hó‰[óˆ ª¹ãërK…´Æh¡VSm<ˆCjÇÂæA#O«`¢£Ž9cdê01‰O¶å‡
' . $this->randomMachineName() . '
'; - - $xpath = '//div[contains(@class, :class)]'; - - // Verify that the empty header and footer sections have not been rendered. - $output = $view->preview(); - $html = $this->container->get('renderer')->renderRoot($output); - $this->setRawContent($html); - $this->assertEqual(0, count($this->xpath($xpath, [':class' => 'view-header']))); - $this->assertEqual(0, count($this->xpath($xpath, [':class' => 'view-footer']))); - - // Set example header text. - $view->header['test_example']->options['string'] = '' . $this->randomMachineName() . '
'; - $view->header['test_example']->options['empty'] = TRUE; - - // Set example footer text. - $view->footer['test_example']->options['string'] = '' . $this->randomMachineName() . '
'; - $view->footer['test_example']->options['empty'] = TRUE; - - // Verify that the header and footer sections have been rendered. - $output = $view->preview(); - $html = $this->container->get('renderer')->renderRoot($output); - $this->setRawContent($html); - $this->assertEqual(1, count($this->xpath($xpath, [':class' => 'view-header']))); - $this->assertEqual(1, count($this->xpath($xpath, [':class' => 'view-footer']))); - } - - /** * Tests the access for an area. */ public function testAreaAccess() { diff --git a/core/modules/views/src/Tests/Handler/AreaTitleWebTest.php b/core/modules/views/tests/src/Functional/Handler/AreaTitleWebTest.php similarity index 91% rename from core/modules/views/src/Tests/Handler/AreaTitleWebTest.php rename to core/modules/views/tests/src/Functional/Handler/AreaTitleWebTest.php index afae1eb8ec..9e1fcfad23 100644 --- a/core/modules/views/src/Tests/Handler/AreaTitleWebTest.php +++ b/core/modules/views/tests/src/Functional/Handler/AreaTitleWebTest.php @@ -1,9 +1,9 @@ enableViewsTestModule(); } diff --git a/core/modules/views/src/Tests/Handler/ArgumentStringTest.php b/core/modules/views/tests/src/Functional/Handler/ArgumentStringTest.php similarity index 89% rename from core/modules/views/src/Tests/Handler/ArgumentStringTest.php rename to core/modules/views/tests/src/Functional/Handler/ArgumentStringTest.php index 0682892e89..17ece944c5 100644 --- a/core/modules/views/src/Tests/Handler/ArgumentStringTest.php +++ b/core/modules/views/tests/src/Functional/Handler/ArgumentStringTest.php @@ -1,7 +1,8 @@ drupalCreateUser(['access content overview', 'administer nodes', 'bypass node access']); $this->drupalLogin($admin_user); @@ -48,7 +50,7 @@ public function testDropbutton() { foreach ($nodes as $node) { $result = $this->xpath('//ul[contains(@class, dropbutton)]/li/a[contains(@href, :path) and text()=:title]', [':path' => '/node/' . $node->id(), ':title' => $node->label()]); $this->assertEqual(count($result), 1, 'Just one node title link was found.'); - $result = $this->xpath('//ul[contains(@class, dropbutton)]/li/a[contains(@href, :path) and text()=:title]', [':path' => '/node/' . $node->id(), ':title' => t('Custom Text')]); + $result = $this->xpath('//ul[contains(@class, dropbutton)]/li/a[contains(@href, :path) and text()=:title]', [':path' => '/node/' . $node->id(), ':title' => 'Custom Text']); $this->assertEqual(count($result), 1, 'Just one custom link was found.'); } diff --git a/core/modules/views/src/Tests/Handler/FieldEntityOperationsTest.php b/core/modules/views/tests/src/Functional/Handler/FieldEntityOperationsTest.php similarity index 92% rename from core/modules/views/src/Tests/Handler/FieldEntityOperationsTest.php rename to core/modules/views/tests/src/Functional/Handler/FieldEntityOperationsTest.php index 7efd1d7414..653ce11527 100644 --- a/core/modules/views/src/Tests/Handler/FieldEntityOperationsTest.php +++ b/core/modules/views/tests/src/Functional/Handler/FieldEntityOperationsTest.php @@ -1,17 +1,18 @@ drupalCreateContentType(['type' => 'article', 'name' => 'Article']); @@ -72,7 +73,7 @@ public function testEntityOperations() { $this->assertTrue(count($operations) > 0, 'There are operations.'); foreach ($operations as $operation) { $expected_destination = Url::fromUri('internal:/test-entity-operations')->toString(); - $result = $this->xpath('//ul[contains(@class, dropbutton)]/li/a[@href=:path and text()=:title]', [':path' => $operation['url']->toString() . '?destination=' . $expected_destination, ':title' => $operation['title']]); + $result = $this->xpath('//ul[contains(@class, dropbutton)]/li/a[@href=:path and text()=:title]', [':path' => $operation['url']->toString() . '?destination=' . $expected_destination, ':title' => (string) $operation['title']]); $this->assertEqual(count($result), 1, t('Found entity @operation link with destination parameter.', ['@operation' => $operation['title']])); // Entities which were created in Hungarian should link to the Hungarian // edit form, others to the English one (which has no path prefix here). diff --git a/core/modules/views/src/Tests/Handler/FieldGroupRowsTest.php b/core/modules/views/tests/src/Functional/Handler/FieldGroupRowsTest.php similarity index 92% rename from core/modules/views/src/Tests/Handler/FieldGroupRowsTest.php rename to core/modules/views/tests/src/Functional/Handler/FieldGroupRowsTest.php index 2521e6329e..d38ba41792 100644 --- a/core/modules/views/src/Tests/Handler/FieldGroupRowsTest.php +++ b/core/modules/views/tests/src/Functional/Handler/FieldGroupRowsTest.php @@ -1,10 +1,11 @@ drupalCreateContentType(['type' => 'page', 'name' => 'Basic page']); diff --git a/core/modules/views/src/Tests/Handler/FieldGroupRowsWebTest.php b/core/modules/views/tests/src/Functional/Handler/FieldGroupRowsWebTest.php similarity index 90% rename from core/modules/views/src/Tests/Handler/FieldGroupRowsWebTest.php rename to core/modules/views/tests/src/Functional/Handler/FieldGroupRowsWebTest.php index 646cb12242..275960cb0d 100644 --- a/core/modules/views/src/Tests/Handler/FieldGroupRowsWebTest.php +++ b/core/modules/views/tests/src/Functional/Handler/FieldGroupRowsWebTest.php @@ -1,11 +1,11 @@ nodeType = $this->drupalCreateContentType(['type' => 'page', 'name' => 'Basic page']); @@ -98,7 +98,7 @@ public function testGroupRows() { $rendered_value = []; foreach ($result as $row) { - $rendered_value[] = (string) $row[0]; + $rendered_value[] = $row->getText(); } $this->assertEqual(['a, b, c'], $rendered_value); } @@ -111,7 +111,7 @@ public function testUngroupedRows() { $result = $this->cssSelect('div.views-field-field-views-testing-group- div'); $rendered_value = []; foreach ($result as $row) { - $rendered_value[] = (string) $row[0]; + $rendered_value[] = $row->getText(); } $this->assertEqual(['a', 'b', 'c'], $rendered_value); } diff --git a/core/modules/views/src/Tests/Handler/FieldWebTest.php b/core/modules/views/tests/src/Functional/Handler/FieldWebTest.php similarity index 99% rename from core/modules/views/src/Tests/Handler/FieldWebTest.php rename to core/modules/views/tests/src/Functional/Handler/FieldWebTest.php index 31de7be7e6..318be3f902 100644 --- a/core/modules/views/src/Tests/Handler/FieldWebTest.php +++ b/core/modules/views/tests/src/Functional/Handler/FieldWebTest.php @@ -1,6 +1,6 @@ 'name', ]; - protected function setUp() { - parent::setUp(); + protected function setUp($import_test_views = TRUE) { + parent::setUp($import_test_views); $this->enableViewsTestModule(); } @@ -99,7 +100,7 @@ protected function clickSortLoadIdsFromOutput() { $fields = $this->xpath("//td[contains(@class, 'views-field-id')]"); $ids = []; foreach ($fields as $field) { - $ids[] = (int) $field[0]; + $ids[] = (int) $field->getText(); } return $ids; } diff --git a/core/modules/views/src/Tests/Handler/FilterDateTest.php b/core/modules/views/tests/src/Functional/Handler/FilterDateTest.php similarity index 89% rename from core/modules/views/src/Tests/Handler/FilterDateTest.php rename to core/modules/views/tests/src/Functional/Handler/FilterDateTest.php index f81e753d60..ec3b52385f 100644 --- a/core/modules/views/src/Tests/Handler/FilterDateTest.php +++ b/core/modules/views/tests/src/Functional/Handler/FilterDateTest.php @@ -1,11 +1,12 @@ assertFieldByName($name, $value); if (strpos($name, '[value][type]')) { $radio = $this->cssSelect('input[name="' . $name . '"][checked="checked"][type="radio"]'); - $this->assertEqual((string) $radio[0]['value'], $value); + $this->assertEqual($radio[0]->getAttribute('value'), $value); } } @@ -221,22 +222,27 @@ protected function _testFilterDateUI() { $this->assertConfigSchemaByName('views.view.test_filter_date_between'); // Test that the exposed filter works as expected. - $this->drupalGet('admin/structure/views/view/test_filter_date_between/edit'); - $this->drupalPostForm(NULL, [], t('Update preview')); + $path = 'test_filter_date_between-path'; + $this->drupalPostForm('admin/structure/views/view/test_filter_date_between/edit', [], 'Add Page'); + $this->drupalPostForm('admin/structure/views/nojs/display/test_filter_date_between/page_1/path', ['path' => $path], 'Apply'); + $this->drupalPostForm(NULL, [], t('Save')); + + $this->drupalGet($path); + $this->drupalPostForm(NULL, [], 'Apply'); $results = $this->cssSelect('.view-content .field-content'); $this->assertEqual(count($results), 4); - $this->drupalPostForm(NULL, ['created' => '1'], t('Update preview')); + $this->drupalPostForm(NULL, ['created' => '1'], 'Apply'); $results = $this->cssSelect('.view-content .field-content'); $this->assertEqual(count($results), 1); - $this->assertEqual((string) $results[0], $this->nodes[3]->id()); - $this->drupalPostForm(NULL, ['created' => '2'], t('Update preview')); + $this->assertEqual($results[0]->getText(), $this->nodes[3]->id()); + $this->drupalPostForm(NULL, ['created' => '2'], 'Apply'); $results = $this->cssSelect('.view-content .field-content'); $this->assertEqual(count($results), 1); - $this->assertEqual((string) $results[0], $this->nodes[3]->id()); - $this->drupalPostForm(NULL, ['created' => '3'], t('Update preview')); + $this->assertEqual($results[0]->getText(), $this->nodes[3]->id()); + $this->drupalPostForm(NULL, ['created' => '3'], 'Apply'); $results = $this->cssSelect('.view-content .field-content'); $this->assertEqual(count($results), 1); - $this->assertEqual((string) $results[0], $this->nodes[1]->id()); + $this->assertEqual($results[0]->getText(), $this->nodes[1]->id()); // Change the filter to a single filter to test the schema when the operator // is not exposed. @@ -250,15 +256,15 @@ protected function _testFilterDateUI() { $this->assertConfigSchemaByName('views.view.test_filter_date_between'); // Test that the filter works as expected. - $this->drupalPostForm(NULL, [], t('Update preview')); + $this->drupalGet($path); $results = $this->cssSelect('.view-content .field-content'); $this->assertEqual(count($results), 1); - $this->assertEqual((string) $results[0], $this->nodes[3]->id()); - $this->drupalPostForm(NULL, ['created' => format_date(250000, 'custom', 'Y-m-d H:i:s')], t('Update preview')); + $this->assertEqual($results[0]->getText(), $this->nodes[3]->id()); + $this->drupalPostForm(NULL, ['created' => format_date(250000, 'custom', 'Y-m-d H:i:s')], 'Apply'); $results = $this->cssSelect('.view-content .field-content'); $this->assertEqual(count($results), 2); - $this->assertEqual((string) $results[0], $this->nodes[2]->id()); - $this->assertEqual((string) $results[1], $this->nodes[3]->id()); + $this->assertEqual($results[0]->getText(), $this->nodes[2]->id()); + $this->assertEqual($results[1]->getText(), $this->nodes[3]->id()); } /** diff --git a/core/modules/views/src/Tests/Handler/HandlerAllTest.php b/core/modules/views/tests/src/Functional/Handler/HandlerAllTest.php similarity index 95% rename from core/modules/views/src/Tests/Handler/HandlerAllTest.php rename to core/modules/views/tests/src/Functional/Handler/HandlerAllTest.php index 565437657e..1a37ce8307 100644 --- a/core/modules/views/src/Tests/Handler/HandlerAllTest.php +++ b/core/modules/views/tests/src/Functional/Handler/HandlerAllTest.php @@ -1,8 +1,9 @@ drupalCreateContentType(['type' => 'page']); $this->addDefaultCommentField('node', 'page'); $this->enableViewsTestModule(); @@ -260,13 +260,12 @@ public function testRelationshipUI() { $this->assertFieldByName($relationship_name); // Check for available options. - $xpath = $this->constructFieldXpath('name', $relationship_name); - $fields = $this->xpath($xpath); + $fields = $this->getSession()->getPage()->findAll('named_exact', ['field', $relationship_name]); $options = []; foreach ($fields as $field) { - $items = $this->getAllOptions($field); + $items = $field->findAll('css', 'option'); foreach ($items as $item) { - $options[] = $item->attributes()->value; + $options[] = $item->getAttribute('value'); } } $expected_options = ['none', 'nid']; diff --git a/core/modules/views/src/Tests/Plugin/AccessTest.php b/core/modules/views/tests/src/Functional/Plugin/AccessTest.php similarity index 91% rename from core/modules/views/src/Tests/Plugin/AccessTest.php rename to core/modules/views/tests/src/Functional/Plugin/AccessTest.php index 7a4eb1a5b3..41aa6ec53a 100644 --- a/core/modules/views/src/Tests/Plugin/AccessTest.php +++ b/core/modules/views/tests/src/Functional/Plugin/AccessTest.php @@ -1,7 +1,8 @@ enableViewsTestModule(); diff --git a/core/modules/views/src/Tests/Plugin/ArgumentDefaultTest.php b/core/modules/views/tests/src/Functional/Plugin/ArgumentDefaultTest.php similarity index 93% rename from core/modules/views/src/Tests/Plugin/ArgumentDefaultTest.php rename to core/modules/views/tests/src/Functional/Plugin/ArgumentDefaultTest.php index a4e82172e0..b3956de8ea 100644 --- a/core/modules/views/src/Tests/Plugin/ArgumentDefaultTest.php +++ b/core/modules/views/tests/src/Functional/Plugin/ArgumentDefaultTest.php @@ -1,10 +1,11 @@ enableViewsTestModule(); } @@ -161,9 +162,9 @@ public function testArgumentDefaultNode() { $this->drupalPlaceBlock("views_block:test_argument_default_node-block_1", ['id' => $id]); $xpath = '//*[@id="block-' . $id . '"]'; $this->drupalGet('node/' . $node1->id()); - $this->assertTrue(strpos($this->xpath($xpath)[0]->asXml(), $node1->getTitle())); + $this->assertTrue(strpos($this->xpath($xpath)[0]->getText(), $node1->getTitle())); $this->drupalGet('node/' . $node2->id()); - $this->assertTrue(strpos($this->xpath($xpath)[0]->asXml(), $node2->getTitle())); + $this->assertTrue(strpos($this->xpath($xpath)[0]->getText(), $node2->getTitle())); } /** diff --git a/core/modules/views/src/Tests/Plugin/CacheTagTest.php b/core/modules/views/tests/src/Functional/Plugin/CacheTagTest.php similarity index 96% rename from core/modules/views/src/Tests/Plugin/CacheTagTest.php rename to core/modules/views/tests/src/Functional/Plugin/CacheTagTest.php index 72d94f3cf3..1d78204db9 100644 --- a/core/modules/views/src/Tests/Plugin/CacheTagTest.php +++ b/core/modules/views/tests/src/Functional/Plugin/CacheTagTest.php @@ -1,8 +1,9 @@ drupalCreateContentType(['type' => 'page', 'name' => 'Basic page']); $this->drupalCreateContentType(['type' => 'article', 'name' => 'Article']); diff --git a/core/modules/views/src/Tests/Plugin/CacheWebTest.php b/core/modules/views/tests/src/Functional/Plugin/CacheWebTest.php similarity index 91% rename from core/modules/views/src/Tests/Plugin/CacheWebTest.php rename to core/modules/views/tests/src/Functional/Plugin/CacheWebTest.php index 7786606376..40bf60189c 100644 --- a/core/modules/views/src/Tests/Plugin/CacheWebTest.php +++ b/core/modules/views/tests/src/Functional/Plugin/CacheWebTest.php @@ -1,8 +1,9 @@ enableViewsTestModule(); } diff --git a/core/modules/views/src/Tests/Plugin/ContextualFiltersBlockContextTest.php b/core/modules/views/tests/src/Functional/Plugin/ContextualFiltersBlockContextTest.php similarity index 96% rename from core/modules/views/src/Tests/Plugin/ContextualFiltersBlockContextTest.php rename to core/modules/views/tests/src/Functional/Plugin/ContextualFiltersBlockContextTest.php index 7fb70580a2..567e1c930a 100644 --- a/core/modules/views/src/Tests/Plugin/ContextualFiltersBlockContextTest.php +++ b/core/modules/views/tests/src/Functional/Plugin/ContextualFiltersBlockContextTest.php @@ -1,10 +1,10 @@ enableViewsTestModule(); diff --git a/core/modules/views/src/Tests/Plugin/DisabledDisplayTest.php b/core/modules/views/tests/src/Functional/Plugin/DisabledDisplayTest.php similarity index 86% rename from core/modules/views/src/Tests/Plugin/DisabledDisplayTest.php rename to core/modules/views/tests/src/Functional/Plugin/DisabledDisplayTest.php index cb43946913..708ac55030 100644 --- a/core/modules/views/src/Tests/Plugin/DisabledDisplayTest.php +++ b/core/modules/views/tests/src/Functional/Plugin/DisabledDisplayTest.php @@ -1,6 +1,8 @@ enableViewsTestModule(); @@ -56,7 +58,7 @@ public function testDisabledDisplays() { // Enabled page display should return content. $this->drupalGet('test-disabled-display'); $result = $this->xpath('//h1[@class="page-title"]'); - $this->assertEqual($result[0], 'test_disabled_display', 'The enabled page_1 display is accessible.'); + $this->assertEqual($result[0]->getText(), 'test_disabled_display', 'The enabled page_1 display is accessible.'); // Disabled page view should 404. $this->drupalGet('test-disabled-display-2'); @@ -75,7 +77,7 @@ public function testDisabledDisplays() { // Check that the originally disabled page_2 display is now enabled. $this->drupalGet('test-disabled-display-2'); $result = $this->xpath('//h1[@class="page-title"]'); - $this->assertEqual($result[0], 'test_disabled_display', 'The enabled page_2 display is accessible.'); + $this->assertEqual($result[0]->getText(), 'test_disabled_display', 'The enabled page_2 display is accessible.'); // Disable each disabled display and save the view. foreach ($display_ids as $display_id) { diff --git a/core/modules/views/src/Tests/Plugin/DisplayAttachmentTest.php b/core/modules/views/tests/src/Functional/Plugin/DisplayAttachmentTest.php similarity index 93% rename from core/modules/views/src/Tests/Plugin/DisplayAttachmentTest.php rename to core/modules/views/tests/src/Functional/Plugin/DisplayAttachmentTest.php index 16c0680b36..8c326baa05 100644 --- a/core/modules/views/src/Tests/Plugin/DisplayAttachmentTest.php +++ b/core/modules/views/tests/src/Functional/Plugin/DisplayAttachmentTest.php @@ -1,7 +1,8 @@ enableViewsTestModule(); diff --git a/core/modules/views/src/Tests/Plugin/DisplayEntityReferenceTest.php b/core/modules/views/tests/src/Functional/Plugin/DisplayEntityReferenceTest.php similarity index 97% rename from core/modules/views/src/Tests/Plugin/DisplayEntityReferenceTest.php rename to core/modules/views/tests/src/Functional/Plugin/DisplayEntityReferenceTest.php index ac7209c284..a081ad7d97 100644 --- a/core/modules/views/src/Tests/Plugin/DisplayEntityReferenceTest.php +++ b/core/modules/views/tests/src/Functional/Plugin/DisplayEntityReferenceTest.php @@ -1,11 +1,12 @@ drupalLogin($this->drupalCreateUser(['administer views'])); diff --git a/core/modules/views/src/Tests/Plugin/DisplayPageWebTest.php b/core/modules/views/tests/src/Functional/Plugin/DisplayPageWebTest.php similarity index 84% rename from core/modules/views/src/Tests/Plugin/DisplayPageWebTest.php rename to core/modules/views/tests/src/Functional/Plugin/DisplayPageWebTest.php index b5c853faec..3d2aca6639 100644 --- a/core/modules/views/src/Tests/Plugin/DisplayPageWebTest.php +++ b/core/modules/views/tests/src/Functional/Plugin/DisplayPageWebTest.php @@ -1,8 +1,9 @@ enableViewsTestModule(); $this->drupalPlaceBlock('local_tasks_block'); @@ -55,13 +56,13 @@ public function testArguments() { $this->assertCacheContexts(['languages:language_interface', 'route', 'theme', 'url']); $result = $this->xpath('//span[@class="field-content"]'); $this->assertEqual(count($result), 1, 'Ensure that just the filtered entry was returned.'); - $this->assertEqual((string) $result[0], 1, 'The passed ID was returned.'); + $this->assertEqual($result[0]->getText(), 1, 'The passed ID was returned.'); $this->drupalGet('test_route_with_suffix/1/suffix'); $this->assertResponse(200); $result = $this->xpath('//span[@class="field-content"]'); $this->assertEqual(count($result), 1, 'Ensure that just the filtered entry was returned.'); - $this->assertEqual((string) $result[0], 1, 'The passed ID was returned.'); + $this->assertEqual($result[0]->getText(), 1, 'The passed ID was returned.'); $this->drupalGet('test_route_with_suffix_and_argument/1/suffix/2'); $this->assertResponse(200); @@ -72,13 +73,13 @@ public function testArguments() { $this->assertResponse(200); $result = $this->xpath('//span[@class="field-content"]'); $this->assertEqual(count($result), 1, 'Ensure that just the filtered entry was returned.'); - $this->assertEqual((string) $result[0], 1, 'The passed ID was returned.'); + $this->assertEqual($result[0]->getText(), 1, 'The passed ID was returned.'); $this->drupalGet('test_route_with_long_argument/1'); $this->assertResponse(200); $result = $this->xpath('//span[@class="field-content"]'); $this->assertEqual(count($result), 1, 'Ensure that just the filtered entry was returned.'); - $this->assertEqual((string) $result[0], 1, 'The passed ID was returned.'); + $this->assertEqual($result[0]->getText(), 1, 'The passed ID was returned.'); } /** @@ -88,11 +89,11 @@ public function testPageDisplayMenu() { // Check local tasks. $this->drupalGet('test_page_display_menu'); $this->assertResponse(200); - $element = $this->xpath('//ul[contains(@class, :ul_class)]//a[contains(@class, :a_class)]', [ + $element = $this->xpath('//ul[contains(@class, :ul_class)]//a[contains(@class, :a_class)]/child::text()', [ ':ul_class' => 'tabs primary', ':a_class' => 'is-active', ]); - $this->assertEqual((string) $element[0], t('Test default tab')); + $this->assertEqual($element[0]->getText(), t('Test default tab')); $this->assertTitle(t('Test default page | Drupal')); $this->drupalGet('test_page_display_menu/default'); @@ -100,11 +101,11 @@ public function testPageDisplayMenu() { $this->drupalGet('test_page_display_menu/local'); $this->assertResponse(200); - $element = $this->xpath('//ul[contains(@class, :ul_class)]//a[contains(@class, :a_class)]', [ + $element = $this->xpath('//ul[contains(@class, :ul_class)]//a[contains(@class, :a_class)]/child::text()', [ ':ul_class' => 'tabs primary', ':a_class' => 'is-active', ]); - $this->assertEqual((string) $element[0], t('Test local tab')); + $this->assertEqual($element[0]->getText(), t('Test local tab')); $this->assertTitle(t('Test local page | Drupal')); // Check an ordinary menu link. @@ -114,7 +115,7 @@ public function testPageDisplayMenu() { $this->drupalGet('Executed view: ' . ((string) $view->build_info['query']) . ''; + if ($view->build_info['query'] instanceof SelectInterface) { + $verbose_message .= '
Arguments: ' . print_r($view->build_info['query']->getArguments(), TRUE) . ''; + } + $this->verbose($verbose_message); + } + + /** + * Returns the schema definition. + */ + protected function schemaDefinition() { + return ViewTestData::schemaDefinition(); + } + + /** + * Returns the views data definition. + */ + protected function viewsData() { + return ViewTestData::viewsData(); + } + + /** + * Returns a very simple test dataset. + */ + protected function dataSet() { + return ViewTestData::dataSet(); + } + +} diff --git a/core/modules/views/src/Tests/ViewsEscapingTest.php b/core/modules/views/tests/src/Functional/ViewsEscapingTest.php similarity index 94% rename from core/modules/views/src/Tests/ViewsEscapingTest.php rename to core/modules/views/tests/src/Functional/ViewsEscapingTest.php index 1ec3a9f3d0..80a8398722 100644 --- a/core/modules/views/src/Tests/ViewsEscapingTest.php +++ b/core/modules/views/tests/src/Functional/ViewsEscapingTest.php @@ -1,6 +1,6 @@ enableViewsTestModule(); } diff --git a/core/modules/views/src/Tests/ViewsFormMultipleTest.php b/core/modules/views/tests/src/Functional/ViewsFormMultipleTest.php similarity index 81% rename from core/modules/views/src/Tests/ViewsFormMultipleTest.php rename to core/modules/views/tests/src/Functional/ViewsFormMultipleTest.php index 844a1b10c9..03d5bcee8c 100644 --- a/core/modules/views/src/Tests/ViewsFormMultipleTest.php +++ b/core/modules/views/tests/src/Functional/ViewsFormMultipleTest.php @@ -1,6 +1,6 @@ enableViewsTestModule(); } @@ -51,9 +51,9 @@ public function testViewsFormMultiple() { // Submit the forms, validate argument returned in message set by handler. // @note There is not a way to specify a specific index for a submit button. So // the row index returned is always the last occurrence. - $this->drupalPostForm(NULL, [], t('Test Button'), [], [], 'views-form-test-form-multiple-default-arg2'); + $this->getSession()->getPage()->pressButton('edit-field-form-button-test-4--2'); $this->assertText('The test button at row 4 for test_form_multiple (default) View with args: arg2 was submitted.'); - $this->drupalPostForm(NULL, [], t('Test Button'), [], [], 'views-form-test-form-multiple-default-arg1'); + $this->getSession()->getPage()->pressButton('edit-field-form-button-test-4'); $this->assertText('The test button at row 4 for test_form_multiple (default) View with args: arg1 was submitted.'); } diff --git a/core/modules/views/src/Tests/ViewsTemplateTest.php b/core/modules/views/tests/src/Functional/ViewsTemplateTest.php similarity index 88% rename from core/modules/views/src/Tests/ViewsTemplateTest.php rename to core/modules/views/tests/src/Functional/ViewsTemplateTest.php index 4a06908296..8f7de40184 100644 --- a/core/modules/views/src/Tests/ViewsTemplateTest.php +++ b/core/modules/views/tests/src/Functional/ViewsTemplateTest.php @@ -1,7 +1,8 @@ enableViewsTestModule(); diff --git a/core/modules/views/src/Tests/ViewsThemeIntegrationTest.php b/core/modules/views/tests/src/Functional/ViewsThemeIntegrationTest.php similarity index 95% rename from core/modules/views/src/Tests/ViewsThemeIntegrationTest.php rename to core/modules/views/tests/src/Functional/ViewsThemeIntegrationTest.php index 1fe836a82e..9bdb405b86 100644 --- a/core/modules/views/src/Tests/ViewsThemeIntegrationTest.php +++ b/core/modules/views/tests/src/Functional/ViewsThemeIntegrationTest.php @@ -1,6 +1,6 @@ enableViewsTestModule(); } diff --git a/core/modules/views/src/Tests/Wizard/BasicTest.php b/core/modules/views/tests/src/Functional/Wizard/BasicTest.php similarity index 94% rename from core/modules/views/src/Tests/Wizard/BasicTest.php rename to core/modules/views/tests/src/Functional/Wizard/BasicTest.php index 7394991d23..eb2ddbbb67 100644 --- a/core/modules/views/src/Tests/Wizard/BasicTest.php +++ b/core/modules/views/tests/src/Functional/Wizard/BasicTest.php @@ -1,6 +1,6 @@ drupalPlaceBlock('page_title_block'); } @@ -80,7 +80,9 @@ public function testViewsWizardAndListing() { $elements = $this->cssSelect('link[href="' . Url::fromRoute('view.' . $view2['id'] . '.feed_1', [], ['absolute' => TRUE])->toString() . '"]'); $this->assertEqual(count($elements), 1, 'Feed found.'); $this->drupalGet($view2['page[feed_properties][path]']); - $this->assertTrue(!empty($this->cssSelect('rss[version="2.0"]'))); + // Because the response is XML we can't use the page which depends on an + // HTML tag being present. + $this->assertEquals('2.0', $this->getSession()->getDriver()->getAttribute('//rss', 'version')); // The feed should have the same title and nodes as the page. $this->assertText($view2['page[title]']); $this->assertRaw($node1->url('canonical', ['absolute' => TRUE])); @@ -134,7 +136,7 @@ public function testViewsWizardAndListing() { // Confirm that the block is available in the block administration UI. $this->drupalGet('admin/structure/block/list/' . $this->config('system.theme')->get('default')); - $this->clickLinkPartialName('Place block'); + $this->clickLink('Place block'); $this->assertText($view3['label']); // Place the block. @@ -164,7 +166,7 @@ public function testViewsWizardAndListing() { // Check that the REST export path works. $this->drupalGet($view4['rest_export[path]']); $this->assertResponse(200); - $data = Json::decode($this->content); + $data = Json::decode($this->getSession()->getPage()->getContent()); $this->assertEqual(count($data), 1, 'Only the node of type page is exported.'); $node = reset($data); $this->assertEqual($node['nid'][0]['value'], $node1->id(), 'The node of type page is exported.'); diff --git a/core/modules/views/src/Tests/Wizard/ItemsPerPageTest.php b/core/modules/views/tests/src/Functional/Wizard/ItemsPerPageTest.php similarity index 95% rename from core/modules/views/src/Tests/Wizard/ItemsPerPageTest.php rename to core/modules/views/tests/src/Functional/Wizard/ItemsPerPageTest.php index 58f22a8424..c480ba94c7 100644 --- a/core/modules/views/src/Tests/Wizard/ItemsPerPageTest.php +++ b/core/modules/views/tests/src/Functional/Wizard/ItemsPerPageTest.php @@ -1,6 +1,6 @@ drupalPlaceBlock('page_title_block'); } @@ -72,7 +72,7 @@ public function testItemsPerPage() { // Confirm that the block is listed in the block administration UI. $this->drupalGet('admin/structure/block/list/' . $this->config('system.theme')->get('default')); - $this->clickLinkPartialName('Place block'); + $this->clickLink('Place block'); $this->assertText($view['label']); // Place the block, visit a page that displays the block, and check that the diff --git a/core/modules/views/src/Tests/Wizard/MenuTest.php b/core/modules/views/tests/src/Functional/Wizard/MenuTest.php similarity index 97% rename from core/modules/views/src/Tests/Wizard/MenuTest.php rename to core/modules/views/tests/src/Functional/Wizard/MenuTest.php index 0805de6168..853c0692d0 100644 --- a/core/modules/views/src/Tests/Wizard/MenuTest.php +++ b/core/modules/views/tests/src/Functional/Wizard/MenuTest.php @@ -1,6 +1,6 @@ drupalPlaceBlock('page_title_block'); } diff --git a/core/modules/views/src/Tests/Wizard/TaggedWithTest.php b/core/modules/views/tests/src/Functional/Wizard/TaggedWithTest.php similarity index 98% rename from core/modules/views/src/Tests/Wizard/TaggedWithTest.php rename to core/modules/views/tests/src/Functional/Wizard/TaggedWithTest.php index f723950419..680d64496e 100644 --- a/core/modules/views/src/Tests/Wizard/TaggedWithTest.php +++ b/core/modules/views/tests/src/Functional/Wizard/TaggedWithTest.php @@ -1,6 +1,6 @@ drupalCreateUser(['administer views', 'administer blocks', 'bypass node access', 'access user profiles', 'view all revisions']); + $this->drupalLogin($views_admin); + $this->drupalPlaceBlock('local_actions_block'); + } + +} diff --git a/core/modules/views/tests/src/Kernel/Handler/AreaEmptyTest.php b/core/modules/views/tests/src/Kernel/Handler/AreaEmptyTest.php new file mode 100644 index 0000000000..0f209cac2e --- /dev/null +++ b/core/modules/views/tests/src/Kernel/Handler/AreaEmptyTest.php @@ -0,0 +1,94 @@ +installEntitySchema('node'); + } + + /** + * {@inheritdoc} + */ + protected function viewsData() { + $data = parent::viewsData(); + $data['views']['test_example'] = [ + 'title' => 'Test Example area', + 'help' => 'A area handler which just exists for tests.', + 'area' => [ + 'id' => 'test_example' + ] + ]; + + return $data; + } + + /** + * Views used by this test. + * + * @var array + */ + public static $testViews = ['test_example_area']; + + /** + * Tests that the header and footer areas are not rendered if empty. + */ + public function testRenderEmptyHeaderFooter() { + $view = Views::getView('test_example_area'); + $view->initHandlers(); + + // Set example empty text. + $empty_text = $this->randomMachineName(); + $empty_header = $this->randomMachineName(); + $empty_footer = $this->randomMachineName(); + + // Set empty text. + $view->empty['test_example']->options['string'] = '
' . $empty_text . '
'; + // Set example header text. + $view->header['test_example']->options['string'] = '' . $empty_header . '
'; + // Set example footer text. + $view->footer['test_example']->options['string'] = '' . $empty_footer . '
'; + + // Verify that the empty header and footer sections have not been rendered. + $view->setDisplay('default'); + $this->executeView($view); + $output = $view->render(); + $output = \Drupal::service('renderer')->renderRoot($output); + $this->setRawContent($output); + $this->assertText($empty_text); + $this->assertNoText($empty_header); + $this->assertNoText($empty_footer); + + // Enable displaying the header and footer when the View is empty. + $view->header['test_example']->options['empty'] = TRUE; + $view->footer['test_example']->options['empty'] = TRUE; + + // Verify that the header and footer sections have been rendered. + $this->executeView($view); + $output = $view->render(); + $output = \Drupal::service('renderer')->renderRoot($output); + $this->setRawContent($output); + $this->assertText($empty_header); + $this->assertText($empty_footer); + } + +} diff --git a/core/modules/views/src/Tests/Plugin/DisplayExtenderTest.php b/core/modules/views/tests/src/Kernel/Plugin/DisplayExtenderTest.php similarity index 88% rename from core/modules/views/src/Tests/Plugin/DisplayExtenderTest.php rename to core/modules/views/tests/src/Kernel/Plugin/DisplayExtenderTest.php index 896b1348dd..6f7154d10c 100644 --- a/core/modules/views/src/Tests/Plugin/DisplayExtenderTest.php +++ b/core/modules/views/tests/src/Kernel/Plugin/DisplayExtenderTest.php @@ -1,7 +1,8 @@ enableViewsTestModule(); - } - /** * Test display extenders. */ diff --git a/core/modules/views/tests/src/Kernel/Plugin/DisplayPageTest.php b/core/modules/views/tests/src/Kernel/Plugin/DisplayPageTest.php index 8aaaa2dd5d..3232ecb815 100644 --- a/core/modules/views/tests/src/Kernel/Plugin/DisplayPageTest.php +++ b/core/modules/views/tests/src/Kernel/Plugin/DisplayPageTest.php @@ -4,6 +4,7 @@ use Drupal\Core\Menu\MenuTreeParameters; use Drupal\Core\Session\AnonymousUserSession; +use Drupal\views\Entity\View; use Drupal\views\Views; use Drupal\Tests\views\Kernel\ViewsKernelTestBase; use Symfony\Component\HttpFoundation\Request; @@ -22,7 +23,7 @@ class DisplayPageTest extends ViewsKernelTestBase { * * @var array */ - public static $testViews = ['test_page_display', 'test_page_display_route', 'test_page_display_menu']; + public static $testViews = ['test_page_display', 'test_page_display_route', 'test_page_display_menu', 'test_display_more']; /** * Modules to enable. @@ -149,4 +150,71 @@ public function testDependencies() { $this->assertIdentical($expected, $view->getDependencies()); } + /** + * Tests the readmore functionality. + */ + public function testReadMore() { + /** @var \Drupal\Core\Render\RendererInterface $renderer */ + $renderer = $this->container->get('renderer'); + + $expected_more_text = 'custom more text'; + + $view = Views::getView('test_display_more'); + $this->executeView($view); + + $output = $view->preview(); + $output = $renderer->renderRoot($output); + + $this->setRawContent($output); + $result = $this->xpath('//div[@class=:class]/a', [':class' => 'more-link']); + $this->assertEqual($result[0]->attributes()->href, \Drupal::url('view.test_display_more.page_1'), 'The right more link is shown.'); + $this->assertEqual(trim($result[0][0]), $expected_more_text, 'The right link text is shown.'); + + // Test the renderMoreLink method directly. This could be directly unit + // tested. + $more_link = $view->display_handler->renderMoreLink(); + $more_link = $renderer->renderRoot($more_link); + $this->setRawContent($more_link); + $result = $this->xpath('//div[@class=:class]/a', [':class' => 'more-link']); + $this->assertEqual($result[0]->attributes()->href, \Drupal::url('view.test_display_more.page_1'), 'The right more link is shown.'); + $this->assertEqual(trim($result[0][0]), $expected_more_text, 'The right link text is shown.'); + + // Test the useMoreText method directly. This could be directly unit + // tested. + $more_text = $view->display_handler->useMoreText(); + $this->assertEqual($more_text, $expected_more_text, 'The right more text is chosen.'); + + $view = Views::getView('test_display_more'); + $view->setDisplay(); + $view->display_handler->setOption('use_more', 0); + $this->executeView($view); + $output = $view->preview(); + $output = $renderer->renderRoot($output); + $this->setRawContent($output); + $result = $this->xpath('//div[@class=:class]/a', [':class' => 'more-link']); + $this->assertTrue(empty($result), 'The more link is not shown.'); + + $view = Views::getView('test_display_more'); + $view->setDisplay(); + $view->display_handler->setOption('use_more', 0); + $view->display_handler->setOption('use_more_always', 0); + $view->display_handler->setOption('pager', [ + 'type' => 'some', + 'options' => [ + 'items_per_page' => 1, + 'offset' => 0, + ], + ]); + $this->executeView($view); + $output = $view->preview(); + $output = $renderer->renderRoot($output); + $this->setRawContent($output); + $result = $this->xpath('//div[@class=:class]/a', [':class' => 'more-link']); + $this->assertTrue(empty($result), 'The more link is not shown when view has more records.'); + + // Test the default value of use_more_always. + $view = View::create()->getExecutable(); + $this->assertTrue($view->getDisplay()->getOption('use_more_always'), 'Always display the more link by default.'); + } + } diff --git a/core/modules/views/tests/src/Kernel/Plugin/ExposedFormRenderTest.php b/core/modules/views/tests/src/Kernel/Plugin/ExposedFormRenderTest.php new file mode 100644 index 0000000000..6767fffe3c --- /dev/null +++ b/core/modules/views/tests/src/Kernel/Plugin/ExposedFormRenderTest.php @@ -0,0 +1,55 @@ +installEntitySchema('node'); + } + + /** + * Tests the exposed form markup. + */ + public function testExposedFormRender() { + $view = Views::getView('test_exposed_form_buttons'); + $this->executeView($view); + $exposed_form = $view->display_handler->getPlugin('exposed_form'); + $output = $exposed_form->renderExposedForm(); + $this->setRawContent(\Drupal::service('renderer')->renderRoot($output)); + + $this->assertFieldByXpath('//form/@id', Html::cleanCssIdentifier('views-exposed-form-' . $view->storage->id() . '-' . $view->current_display), 'Expected form ID found.'); + + $view->setDisplay('page_1'); + $expected_action = $view->display_handler->getUrlInfo()->toString(); + $this->assertFieldByXPath('//form/@action', $expected_action, 'The expected value for the action attribute was found.'); + // Make sure the description is shown. + $result = $this->xpath('//form//div[contains(@id, :id) and normalize-space(text())=:description]', [':id' => 'edit-type--description', ':description' => t('Exposed description')]); + $this->assertEqual(count($result), 1, 'Filter description was found.'); + } + +} diff --git a/core/modules/views/tests/src/Kernel/TestViewsTest.php b/core/modules/views/tests/src/Kernel/TestViewsTest.php index f9aa673421..dcd1859be3 100644 --- a/core/modules/views/tests/src/Kernel/TestViewsTest.php +++ b/core/modules/views/tests/src/Kernel/TestViewsTest.php @@ -34,7 +34,8 @@ public function testDefaultConfig() { \Drupal::service('config.storage'), new TestInstallStorage(InstallStorage::CONFIG_SCHEMA_DIRECTORY), \Drupal::service('cache.discovery'), - \Drupal::service('module_handler') + \Drupal::service('module_handler'), + \Drupal::service('class_resolver') ); // Create a configuration storage with access to default configuration in diff --git a/core/modules/views/tests/src/Kernel/ViewsConfigDependenciesIntegrationTest.php b/core/modules/views/tests/src/Kernel/ViewsConfigDependenciesIntegrationTest.php index f5a2e39aa0..294bb0f44c 100644 --- a/core/modules/views/tests/src/Kernel/ViewsConfigDependenciesIntegrationTest.php +++ b/core/modules/views/tests/src/Kernel/ViewsConfigDependenciesIntegrationTest.php @@ -5,6 +5,7 @@ use Drupal\field\Entity\FieldConfig; use Drupal\field\Entity\FieldStorageConfig; use Drupal\image\Entity\ImageStyle; +use Drupal\user\Entity\Role; use Drupal\views\Entity\View; /** @@ -17,7 +18,7 @@ class ViewsConfigDependenciesIntegrationTest extends ViewsKernelTestBase { /** * {@inheritdoc} */ - public static $modules = ['field', 'file', 'image', 'entity_test']; + public static $modules = ['field', 'file', 'image', 'entity_test', 'user', 'text']; /** * {@inheritdoc} @@ -25,6 +26,16 @@ class ViewsConfigDependenciesIntegrationTest extends ViewsKernelTestBase { public static $testViews = ['entity_test_fields']; /** + * {@inheritdoc} + */ + protected function setUp($import_test_views = TRUE) { + parent::setUp($import_test_views); + + $this->installEntitySchema('user'); + $this->installSchema('user', ['users_data']); + } + + /** * Tests integration with image module. */ public function testImage() { @@ -69,7 +80,81 @@ public function testImage() { // Delete the 'foo' image style. $style->delete(); + $view = View::load('entity_test_fields'); + + // Checks that the view has not been deleted too. + $this->assertNotNull(View::load('entity_test_fields')); + + // Checks that the image field was removed from the View. + $display = $view->getDisplay('default'); + $this->assertFalse(isset($display['display_options']['fields']['bar'])); + + // Checks that the view has been disabled. + $this->assertFalse($view->status()); + + $dependencies = $view->getDependencies() + ['config' => []]; + // Checks that the dependency on style 'foo' has been removed. + $this->assertFalse(in_array('image.style.foo', $dependencies['config'])); + } + + /** + * Tests removing a config dependency that deletes the View. + */ + public function testConfigRemovalRole() { + // Create a role we can add to the View and delete. + $role = Role::create([ + 'id' => 'dummy', + 'label' => 'dummy', + ]); + + $role->save(); + + /** @var \Drupal\views\ViewEntityInterface $view */ + $view = View::load('entity_test_fields'); + $display = &$view->getDisplay('default'); + + // Set the access to be restricted by the dummy role. + $display['display_options']['access'] = [ + 'type' => 'role', + 'options' => [ + 'role' => [ + $role->id() => $role->id(), + ], + ], + ]; + $view->save(); + + // Check that the View now has a dependency on the Role. + $dependencies = $view->getDependencies() + ['config' => []]; + $this->assertTrue(in_array('user.role.dummy', $dependencies['config'])); + + // Delete the role. + $role->delete(); + + $view = View::load('entity_test_fields'); + // Checks that the view has been deleted too. + $this->assertNull($view); + } + + /** + * Tests uninstalling a module that provides a base table for a View. + */ + public function testConfigRemovalBaseTable() { + // Find all the entity types provided by the entity_test module and install + // the schema for them so we can uninstall them. + $entities = \Drupal::entityTypeManager()->getDefinitions(); + foreach ($entities as $entity_type_id => $definition) { + if ($definition->getProvider() == 'entity_test') { + $this->installEntitySchema($entity_type_id); + }; + } + + // Check that removing the module that provides the base table for a View, + // deletes the View. + $this->assertNotNull(View::load('entity_test_fields')); + $this->container->get('module_installer')->uninstall(['entity_test']); + // Check that the View has been deleted. $this->assertNull(View::load('entity_test_fields')); } diff --git a/core/modules/views/tests/src/Unit/EntityViewsDataTest.php b/core/modules/views/tests/src/Unit/EntityViewsDataTest.php index 195e3d4e9f..74bcc083e1 100644 --- a/core/modules/views/tests/src/Unit/EntityViewsDataTest.php +++ b/core/modules/views/tests/src/Unit/EntityViewsDataTest.php @@ -9,7 +9,6 @@ use Drupal\Core\Config\Entity\ConfigEntityType; use Drupal\Core\Entity\ContentEntityType; -use Drupal\Core\Entity\EntityType; use Drupal\Core\Entity\EntityTypeInterface; use Drupal\Core\Entity\Sql\DefaultTableMapping; use Drupal\Core\Field\BaseFieldDefinition; @@ -1087,7 +1086,7 @@ public function setEntityType(EntityTypeInterface $entity_type) { } -class TestEntityType extends EntityType { +class TestEntityType extends ContentEntityType { /** * Sets a specific entity key. diff --git a/core/modules/views/views.post_update.php b/core/modules/views/views.post_update.php index a278034c8a..e09159e7e0 100644 --- a/core/modules/views/views.post_update.php +++ b/core/modules/views/views.post_update.php @@ -201,3 +201,15 @@ function views_post_update_boolean_filter_values() { function views_post_update_grouped_filters() { // Empty update to cause a cache rebuild so that the schema changes are read. } + +/** + * Fix table names for revision metadata fields. + */ +function views_post_update_revision_metadata_fields() { + // The table names are fixed automatically in + // \Drupal\views\Entity\View::preSave(), so we just need to re-save all views. + $views = View::loadMultiple(); + array_walk($views, function(View $view) { + $view->save(); + }); +} diff --git a/core/modules/workflows/src/Form/WorkflowEditForm.php b/core/modules/workflows/src/Form/WorkflowEditForm.php index 6b01920ada..764c0c9bc5 100644 --- a/core/modules/workflows/src/Form/WorkflowEditForm.php +++ b/core/modules/workflows/src/Form/WorkflowEditForm.php @@ -2,6 +2,8 @@ namespace Drupal\workflows\Form; +use Drupal\Core\Form\SubformState; +use Drupal\workflows\WorkflowTypeFormInterface; use Drupal\workflows\Entity\Workflow; use Drupal\workflows\State; use Drupal\Core\Entity\EntityForm; @@ -180,18 +182,42 @@ public function form(array $form, FormStateInterface $form_state) { '#markup' => $workflow->toLink($this->t('Add a new transition'), 'add-transition-form')->toString(), ]; + if ($workflow->getTypePlugin() instanceof WorkflowTypeFormInterface) { + $form['type_settings'] = [ + '#tree' => TRUE, + ]; + $subform_state = SubformState::createForSubform($form['type_settings'], $form, $form_state); + $form['type_settings'] += $workflow->getTypePlugin()->buildConfigurationForm($form['type_settings'], $subform_state, $workflow); + } + return $form; } /** * {@inheritdoc} */ + public function validateForm(array &$form, FormStateInterface $form_state) { + /* @var \Drupal\workflows\WorkflowInterface $workflow */ + $workflow = $this->entity; + if ($workflow->getTypePlugin() instanceof WorkflowTypeFormInterface) { + $subform_state = SubformState::createForSubform($form['type_settings'], $form, $form_state); + $workflow->getTypePlugin()->validateConfigurationForm($form['type_settings'], $subform_state); + } + } + + /** + * {@inheritdoc} + */ public function save(array $form, FormStateInterface $form_state) { /* @var \Drupal\workflows\WorkflowInterface $workflow */ $workflow = $this->entity; + if ($workflow->getTypePlugin() instanceof WorkflowTypeFormInterface) { + $subform_state = SubformState::createForSubform($form['type_settings'], $form, $form_state); + $workflow->getTypePlugin()->submitConfigurationForm($form['type_settings'], $subform_state); + } $workflow->save(); + drupal_set_message($this->t('Saved the %label Workflow.', ['%label' => $workflow->label()])); - $form_state->setRedirectUrl($workflow->toUrl('collection')); } /** diff --git a/core/modules/workflows/src/Plugin/WorkflowTypeBase.php b/core/modules/workflows/src/Plugin/WorkflowTypeBase.php index e87e4d7945..34af735e3d 100644 --- a/core/modules/workflows/src/Plugin/WorkflowTypeBase.php +++ b/core/modules/workflows/src/Plugin/WorkflowTypeBase.php @@ -56,28 +56,28 @@ public function checkWorkflowAccess(WorkflowInterface $entity, $operation, Accou } /** - * {@inheritDoc} + * {@inheritdoc} */ public function decorateState(StateInterface $state) { return $state; } /** - * {@inheritDoc} + * {@inheritdoc} */ public function deleteState($state_id) { unset($this->configuration['states'][$state_id]); } /** - * {@inheritDoc} + * {@inheritdoc} */ public function decorateTransition(TransitionInterface $transition) { return $transition; } /** - * {@inheritDoc} + * {@inheritdoc} */ public function deleteTransition($transition_id) { unset($this->configuration['transitions'][$transition_id]); @@ -98,14 +98,14 @@ public function buildTransitionConfigurationForm(FormStateInterface $form_state, } /** - * {@inheritDoc} + * {@inheritdoc} */ public function getConfiguration() { return $this->configuration; } /** - * {@inheritDoc} + * {@inheritdoc} */ public function setConfiguration(array $configuration) { $this->configuration = NestedArray::mergeDeep( @@ -122,7 +122,7 @@ public function getRequiredStates() { } /** - * {@inheritDoc} + * {@inheritdoc} */ public function defaultConfiguration() { return [ @@ -132,7 +132,7 @@ public function defaultConfiguration() { } /** - * {@inheritDoc} + * {@inheritdoc} */ public function calculateDependencies() { return []; diff --git a/core/modules/workflows/src/Plugin/WorkflowTypeFormBase.php b/core/modules/workflows/src/Plugin/WorkflowTypeFormBase.php new file mode 100644 index 0000000000..942c2d6ef4 --- /dev/null +++ b/core/modules/workflows/src/Plugin/WorkflowTypeFormBase.php @@ -0,0 +1,30 @@ + '', + ]; + } + + /** + * {@inheritdoc} + */ + public function buildConfigurationForm(array $form, FormStateInterface $form_state) { + $form['example_setting'] = [ + '#type' => 'textfield', + '#title' => $this->t('Example global workflow setting'), + '#description' => $this->t('Extra information added to the workflow'), + '#default_value' => $this->configuration['example_setting'], + ]; + return $form; + } + + /** + * {@inheritdoc} + */ + public function submitConfigurationForm(array &$form, FormStateInterface $form_state) { + $this->configuration['example_setting'] = $form_state->getValue('example_setting'); + } + } diff --git a/core/modules/workflows/tests/src/Functional/WorkflowUiTest.php b/core/modules/workflows/tests/src/Functional/WorkflowUiTest.php index 077501cd6e..0411915716 100644 --- a/core/modules/workflows/tests/src/Functional/WorkflowUiTest.php +++ b/core/modules/workflows/tests/src/Functional/WorkflowUiTest.php @@ -176,9 +176,8 @@ public function testWorkflowCreation() { $workflow = $workflow_storage->loadUnchanged('test'); $this->assertEquals('draft', $workflow->getTypePlugin()->getInitialState($workflow)->id()); - // This will take us to the list of workflows, so we need to edit the - // workflow again. - $this->clickLink('Edit'); + // Verify that we are still on the workflow edit page. + $this->assertSession()->addressEquals('admin/config/workflow/workflows/manage/test'); // Ensure that weight changes the transition ordering. $this->assertEquals(['publish', 'create_new_draft'], array_keys($workflow->getTransitions())); @@ -187,9 +186,8 @@ public function testWorkflowCreation() { $workflow = $workflow_storage->loadUnchanged('test'); $this->assertEquals(['create_new_draft', 'publish'], array_keys($workflow->getTransitions())); - // This will take us to the list of workflows, so we need to edit the - // workflow again. - $this->clickLink('Edit'); + // Verify that we are still on the workflow edit page. + $this->assertSession()->addressEquals('admin/config/workflow/workflows/manage/test'); // Ensure that a delete link for the published state exists before deleting // the draft state. @@ -253,6 +251,28 @@ public function testWorkflowCreation() { } /** + * Test the workflow configuration form. + */ + public function testWorkflowConfigurationForm() { + $workflow = Workflow::create(['id' => 'test', 'type' => 'workflow_type_complex_test', 'label' => 'Test']); + $workflow + ->addState('published', 'Published') + ->addTransition('publish', 'Publish', ['published'], 'published') + ->save(); + + $this->drupalLogin($this->createUser(['administer workflows'])); + + // Add additional information to the workflow via the configuration form. + $this->drupalGet('admin/config/workflow/workflows/manage/test'); + $this->assertSession()->pageTextContains('Example global workflow setting'); + $this->submitForm(['type_settings[example_setting]' => 'Extra global settings'], 'Save'); + + $workflow_storage = $this->container->get('entity_type.manager')->getStorage('workflow'); + $workflow = $workflow_storage->loadUnchanged('test'); + $this->assertEquals('Extra global settings', $workflow->getTypePlugin()->getConfiguration()['example_setting']); + } + + /** * Tests that workflow types can add form fields to states and transitions. */ public function testWorkflowDecoration() { diff --git a/core/modules/workflows/tests/src/Unit/StateTest.php b/core/modules/workflows/tests/src/Unit/StateTest.php index 82feca3462..ae9fc46202 100644 --- a/core/modules/workflows/tests/src/Unit/StateTest.php +++ b/core/modules/workflows/tests/src/Unit/StateTest.php @@ -27,6 +27,9 @@ protected function setUp() { // mocked. $container = new ContainerBuilder(); $workflow_type = $this->prophesize(WorkflowTypeInterface::class); + $workflow_type->setConfiguration(Argument::any())->will(function ($arguments) { + $this->getConfiguration()->willReturn($arguments[0]); + }); $workflow_type->decorateState(Argument::any())->willReturnArgument(0); $workflow_type->decorateTransition(Argument::any())->willReturnArgument(0); $workflow_type->deleteState(Argument::any())->willReturn(NULL); diff --git a/core/modules/workflows/tests/src/Unit/TransitionTest.php b/core/modules/workflows/tests/src/Unit/TransitionTest.php index 3202e8a466..c343fed927 100644 --- a/core/modules/workflows/tests/src/Unit/TransitionTest.php +++ b/core/modules/workflows/tests/src/Unit/TransitionTest.php @@ -27,6 +27,9 @@ protected function setUp() { // mocked. $container = new ContainerBuilder(); $workflow_type = $this->prophesize(WorkflowTypeInterface::class); + $workflow_type->setConfiguration(Argument::any())->will(function ($arguments) { + $this->getConfiguration()->willReturn($arguments[0]); + }); $workflow_type->decorateState(Argument::any())->willReturnArgument(0); $workflow_type->decorateTransition(Argument::any())->willReturnArgument(0); $workflow_manager = $this->prophesize(WorkflowTypeManager::class); diff --git a/core/modules/workflows/tests/src/Unit/WorkflowTest.php b/core/modules/workflows/tests/src/Unit/WorkflowTest.php index e2f2db7be3..51cb912070 100644 --- a/core/modules/workflows/tests/src/Unit/WorkflowTest.php +++ b/core/modules/workflows/tests/src/Unit/WorkflowTest.php @@ -27,6 +27,9 @@ protected function setUp() { // mocked. $container = new ContainerBuilder(); $workflow_type = $this->prophesize(WorkflowTypeInterface::class); + $workflow_type->setConfiguration(Argument::any())->will(function ($arguments) { + $this->getConfiguration()->willReturn($arguments[0]); + }); $workflow_type->decorateState(Argument::any())->willReturnArgument(0); $workflow_type->decorateTransition(Argument::any())->willReturnArgument(0); $workflow_manager = $this->prophesize(WorkflowTypeManager::class); @@ -215,6 +218,9 @@ public function testDeleteState() { // correctly. $container = new ContainerBuilder(); $workflow_type = $this->prophesize(WorkflowTypeInterface::class); + $workflow_type->setConfiguration(Argument::any())->will(function ($arguments) { + $this->getConfiguration()->willReturn($arguments[0]); + }); $workflow_type->decorateState(Argument::any())->willReturnArgument(0); $workflow_type->decorateTransition(Argument::any())->willReturnArgument(0); $workflow_type->deleteState('draft')->shouldBeCalled(); @@ -617,6 +623,9 @@ public function testDeleteTransition() { // correctly. $container = new ContainerBuilder(); $workflow_type = $this->prophesize(WorkflowTypeInterface::class); + $workflow_type->setConfiguration(Argument::any())->will(function ($arguments) { + $this->getConfiguration()->willReturn($arguments[0]); + }); $workflow_type->decorateState(Argument::any())->willReturnArgument(0); $workflow_type->decorateTransition(Argument::any())->willReturnArgument(0); $workflow_type->deleteTransition('publish')->shouldBeCalled(); diff --git a/core/package.json b/core/package.json index b168cb374d..0ea5c8a247 100644 --- a/core/package.json +++ b/core/package.json @@ -5,19 +5,39 @@ "private": true, "scripts": { "build:js": "node ./scripts/js/babel-es6-build.js", - "watch:js": "node ./scripts/js/babel-es6-watch.js", - "lint:js": "eslint . || exit 0" + "watch:js": "cross-env NODE_ENV=development node ./scripts/js/babel-es6-watch.js", + "lint:core-js": "node ./node_modules/eslint/bin/eslint.js --ext=.es6.js . --fix || exit 0" }, "devDependencies": { - "babel-core": "6.17.0", - "babel-preset-es2015": "6.16.0", - "chokidar": "1.6.0", - "eslint": "3.8.1", - "glob": "^7.1.1" + "babel-core": "6.24.1", + "babel-preset-env": "1.4.0", + "chokidar": "1.6.1", + "cross-env": "^4.0.0", + "eslint": "3.19.0", + "eslint-config-airbnb": "14.1.0", + "eslint-plugin-import": "2.2.0", + "eslint-plugin-jsx-a11y": "4.0.0", + "eslint-plugin-react": "6.10.3", + "glob": "7.1.1" }, "babel": { "presets": [ - "es2015" + [ + "env", + { + "modules": false, + "targets": { + "browsers": [ + "ie >= 9", + "edge >= 13", + "firefox >= 5", + "opera >= 12", + "safari >= 5", + "chrome >= 56" + ] + } + } + ] ] } } diff --git a/core/phpunit.xml.dist b/core/phpunit.xml.dist index ef1ae3b6fa..c85258d77f 100644 --- a/core/phpunit.xml.dist +++ b/core/phpunit.xml.dist @@ -45,6 +45,8 @@