-
-
' + filter_html_help: true + filter_html_nofollow: false diff --git a/core/modules/config_help/config/optional/editor.editor.help.yml b/core/modules/config_help/config/optional/editor.editor.help.yml new file mode 100644 index 0000000..66c2f58 --- /dev/null +++ b/core/modules/config_help/config/optional/editor.editor.help.yml @@ -0,0 +1,52 @@ +langcode: en +status: true +dependencies: + config: + - filter.format.help + module: + - ckeditor +format: help +editor: ckeditor +settings: + toolbar: + rows: + - + - + name: Formatting + items: + - Bold + - Italic + - + name: Links + items: + - DrupalLink + - DrupalUnlink + - + name: Lists + items: + - BulletedList + - NumberedList + - Indent + - Outdent + - Table + - + name: Media + items: + - DrupalImage + - + name: Tools + items: + - Source + plugins: + stylescombo: + styles: '' + language: + language_list: un +image_upload: + status: false + scheme: public + directory: inline-images + max_size: '' + max_dimensions: + width: null + height: null diff --git a/core/modules/config_help/config/schema/config_help.schema.yml b/core/modules/config_help/config/schema/config_help.schema.yml new file mode 100644 index 0000000..576ca10 --- /dev/null +++ b/core/modules/config_help/config/schema/config_help.schema.yml @@ -0,0 +1,47 @@ +config_help.topic.*: + type: config_entity + label: 'Help topic' + mapping: + id: + type: string + label: 'Machine-readable name' + label: + type: label + label: 'Title' + top_level: + type: boolean + label: 'Top-level topic' + locked: + type: boolean + label: 'Locked' + related: + type: sequence + label: 'Related topics' + sequence: + type: string + list_on: + type: sequence + label: 'List on topics' + sequence: + type: string + body: + type: sequence + label: 'Body' + sequence: + type: config_help_text + body_format: + type: string + label: 'Body format' + +config_help_text: + type: mapping + mapping: + prefix_tags: + type: string + label: 'Prefix tags' + text: + type: text + label: 'Text' + suffix_tags: + type: string + label: 'Suffix tags' diff --git a/core/modules/config_help/config_help.info.yml b/core/modules/config_help/config_help.info.yml new file mode 100644 index 0000000..fbbffad --- /dev/null +++ b/core/modules/config_help/config_help.info.yml @@ -0,0 +1,10 @@ +name: Configurable Help +type: module +description: 'Provides a configurable help system' +core: 8.x +package: Core (Experimental) +configure: entity.help_topic.collection +version: VERSION +dependencies: + - drupal:help + - drupal:filter diff --git a/core/modules/config_help/config_help.links.action.yml b/core/modules/config_help/config_help.links.action.yml new file mode 100644 index 0000000..b4432d3 --- /dev/null +++ b/core/modules/config_help/config_help.links.action.yml @@ -0,0 +1,5 @@ +entity.help_topic.add_form: + route_name: entity.help_topic.add_form + title: 'Add new help topic' + appears_on: + - entity.help_topic.collection diff --git a/core/modules/config_help/config_help.links.menu.yml b/core/modules/config_help/config_help.links.menu.yml new file mode 100644 index 0000000..f62c4fb --- /dev/null +++ b/core/modules/config_help/config_help.links.menu.yml @@ -0,0 +1,5 @@ +entity.help_topic.collection: + title: Help topics + description: Add, delete, and edit help topics. + route_name: entity.help_topic.collection + parent: system.admin_config_development diff --git a/core/modules/config_help/config_help.links.task.yml b/core/modules/config_help/config_help.links.task.yml new file mode 100644 index 0000000..4dafd75 --- /dev/null +++ b/core/modules/config_help/config_help.links.task.yml @@ -0,0 +1,16 @@ +entity.help_topic.canonical: + title: View + route_name: entity.help_topic.canonical + base_route: entity.help_topic.edit_form + weight: -10 + +entity.help_topic.edit_form: + title: Edit + route_name: entity.help_topic.edit_form + base_route: entity.help_topic.edit_form + +entity.help_topic.delete_form: + route_name: entity.help_topic.delete_form + base_route: entity.help_topic.edit_form + title: Delete + weight: 10 diff --git a/core/modules/config_help/config_help.module b/core/modules/config_help/config_help.module new file mode 100644 index 0000000..b7e2319 --- /dev/null +++ b/core/modules/config_help/config_help.module @@ -0,0 +1,48 @@ +' . t('About') . ''; + $output .= ' ' . t('The Configurable Help module adds configurable help topics to the module-provided help from the core Help module. For more information, see the online documentation for the Configurable Help module.', [':online' => 'https://www.drupal.org/modules/config_help']) . '
'; + $output .= '' . t('Uses') . '
'; + $output .= '- ';
+ $output .= '
- ' . t('Configuring help topics') . ' '; + $output .= '
- ' . t('You can add, edit, delete, and translate configure help topics on the Help topics administration page. The help topics that are listed in the Module help section of the main Help page cannot be edited or deleted. See the Building a help system topic for more information on configuring help topics.', [ + ':topic_admin' => Url::fromRoute('entity.help_topic.collection')->toString(), + ':main_topic' => Url::fromRoute('entity.help_topic.canonical', ['help_topic' => 'config_help'])->toString(), + ]) . ' '; + $output .= '
- ' . t('Viewing configurable help topics') . ' '; + $output .= '
- ' . t('The top-level configured help topics are listed on the main Help page.', [':help_page' => Url::fromRoute('help.main')->toString()]) . ' '; + $output .= '
- ' . t('Updating help topics') . ' '; + $output .= '
- ' . t('Help topics provided by modules and themes may be updated when a module or theme is updated, or new topics may be added. However, help topics are only imported into your site configuration when you first install the module or theme. The contributed Configuration Update Manager module can be used to check for updates, see differences, and import or update topics that have been added or have changed. It is advisable not to edit module- or theme-provided topics, to make updates easier.', [':config_update' => 'https://www.drupal.org/project/config_update']) . ' '; + $output .= '
')); + $breadcrumb->addLink(Link::createFromRoute($this->t('Administration'), 'system.admin')); + $breadcrumb->addLink(Link::createFromRoute($this->t('Help'), 'help.main')); + $breadcrumb->addCacheContexts(['route.name']); + + return $breadcrumb; + } + +} diff --git a/core/modules/config_help/src/HelpListBuilder.php b/core/modules/config_help/src/HelpListBuilder.php new file mode 100644 index 0000000..cb68c4c --- /dev/null +++ b/core/modules/config_help/src/HelpListBuilder.php @@ -0,0 +1,102 @@ + $this->t('Title'), + 'id' => $this->t('Machine name'), + 'top_level' => [ + 'data' => $this->t('Top level'), + 'class' => [RESPONSIVE_PRIORITY_MEDIUM], + ], + 'locked' => [ + 'data' => $this->t('Locked'), + 'class' => [RESPONSIVE_PRIORITY_MEDIUM], + ], + ]; + + return $header + parent::buildHeader(); + } + + /** + * {@inheritdoc} + */ + public function buildRow(EntityInterface $entity) { + $row = []; + + $row['label']['data'] = [ + '#type' => 'link', + '#title' => $this->getLabel($entity), + '#url' => $entity->urlInfo('canonical'), + ]; + + $row['id'] = $entity->id(); + + $row['top_level'] = ($entity->isTopLevel()) ? $this->t('Yes') : $this->t('No'); + $row['locked'] = ($entity->isLocked()) ? $this->t('Yes') : $this->t('No'); + + return $row + parent::buildRow($entity); + } + + /** + * {@inheritdoc} + */ + protected function getEntityIds() { + // Override the default method to sort by label, since the paged table + // is eventually sorted by label within each page. + $query = $this->getStorage()->getQuery() + ->sort($this->entityType->getKey('label')); + + if ($this->limit) { + $query->pager($this->limit); + } + + return $query->execute(); + } + + /** + * {@inheritdoc} + */ + public function getDefaultOperations(EntityInterface $entity) { + $operations = parent::getDefaultOperations($entity); + + // The default operations from the parent are edit and delete. Add + // view, lock, and unlock (if allowed). + if ($entity->access('view')) { + $operations['view'] = [ + 'title' => $this->t('View'), + 'weight' => 20, + 'url' => $entity->urlInfo('canonical'), + ]; + } + if ($entity->access('lock')) { + $operations['lock'] = [ + 'title' => $this->t('Lock'), + 'weight' => 30, + 'url' => $entity->urlInfo('lock-form'), + ]; + } + if ($entity->access('unlock')) { + $operations['unlock'] = [ + 'title' => $this->t('Unlock'), + 'weight' => 30, + 'url' => $entity->urlInfo('unlock-form'), + ]; + } + + return $operations; + } + +} diff --git a/core/modules/config_help/src/HelpTopicInterface.php b/core/modules/config_help/src/HelpTopicInterface.php new file mode 100644 index 0000000..80b669d --- /dev/null +++ b/core/modules/config_help/src/HelpTopicInterface.php @@ -0,0 +1,140 @@ +setDefaults([ + '_entity_form' => 'help_topic.unlock', + '_title' => 'Unlock help topic', + ]) + ->setRequirement('_entity_access', 'help_topic.unlock'); + $collection->add('entity.help_topic.unlock_form', $route); + + $route = (new Route('/admin/config/development/help/manage/{help_topic}/lock')) + ->setDefaults([ + '_entity_form' => 'help_topic.lock', + '_title' => 'Lock help topic', + ]) + ->setRequirement('_entity_access', 'help_topic.lock'); + $collection->add('entity.help_topic.lock_form', $route); + + return $collection; + } + + /** + * {@inheritdoc} + */ + protected function getCanonicalRoute(EntityTypeInterface $entity_type) { + $route = (new Route('/admin/help-topic/{help_topic}')) + ->setDefaults([ + '_entity_view' => 'help_topic.full', + '_title' => 'Help', + ]) + ->setRequirement('_entity_access', 'help_topic.view') + ->setOption('parameters', [ + 'help_topic' => [ + 'type' => 'entity:help_topic', + // Force load in current interface language. + 'with_config_overrides' => TRUE, + ], + ]); + + return $route; + } + +} diff --git a/core/modules/config_help/src/HelpViewBuilder.php b/core/modules/config_help/src/HelpViewBuilder.php new file mode 100644 index 0000000..c7a928a --- /dev/null +++ b/core/modules/config_help/src/HelpViewBuilder.php @@ -0,0 +1,132 @@ +entityTypeId = $entity_type->id(); + $this->entityType = $entity_type; + // Parent class is using deprecated entity manager. + $this->entityManager = $entity_manager; + $this->helpStorage = $entity_manager->getStorage('help_topic'); + $this->languageManager = $language_manager; + $this->token = $token; + $this->themeRegistry = $theme_registry; + } + + /** + * {@inheritdoc} + */ + public static function createInstance(ContainerInterface $container, EntityTypeInterface $entity_type) { + return new static($entity_type, + $container->get('entity.manager'), + $container->get('language_manager'), + $container->get('token'), + $container->get('theme.registry') + ); + } + + /** + * {@inheritdoc} + */ + public function viewMultiple(array $entities = [], $view_mode = 'full', $langcode = NULL) { + $output = []; + + /** @var \Drupal\config_help\HelpTopicInterface[] $entities */ + foreach ($entities as $entity_id => $help_topic) { + // Get the cache information and other build defaults. + $build = $this->getBuildDefaults($help_topic, $view_mode); + $build['#langcode'] = $langcode; + $build['#title'] = $help_topic->label(); + + // Add in the body, with token replacement. + $bubbleable_metadata = new BubbleableMetadata(); + $build['#body'] = [ + '#type' => 'processed_text', + '#text' => $this->token->replace($help_topic->getBody(), [], [], $bubbleable_metadata), + '#format' => $help_topic->getBodyFormat(), + ]; + $bubbleable_metadata->applyTo($build['#body']); + + // Figure out which topics to list as related, including topics this + // entity lists as related, plus topics that have said "Add me to this + // topic's related list" using the list on field. + $related = $help_topic->getRelated() + + $this->helpStorage->getQuery() + ->condition('list_on.*', $help_topic->id()) + ->execute(); + + $links = []; + + foreach ($related as $other_id) { + if ($other_id != $help_topic->id()) { + $topic = $this->helpStorage->load($other_id); + if ($topic) { + $links[$other_id] = [ + 'title' => $topic->label(), + 'url' => $topic->urlInfo('canonical'), + ]; + } + } + } + + if (count($links)) { + ksort($links); + $build['#related'] = [ + '#theme' => 'links', + '#heading' => [ + 'text' => $this->t('Related topics'), + 'level' => 'h2', + ], + '#links' => $links, + ]; + } + + $output[$entity_id] = $build; + } + + return $output; + } + +} diff --git a/core/modules/config_help/src/Plugin/HelpSection/ConfigHelpSection.php b/core/modules/config_help/src/Plugin/HelpSection/ConfigHelpSection.php new file mode 100644 index 0000000..f6a4dc8 --- /dev/null +++ b/core/modules/config_help/src/Plugin/HelpSection/ConfigHelpSection.php @@ -0,0 +1,96 @@ +entityTypeManager = $entity_type_manager; + } + + /** + * {@inheritdoc} + */ + public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) { + return new static( + $configuration, + $plugin_id, + $plugin_definition, + $container->get('entity_type.manager') + ); + } + + /** + * {@inheritdoc} + */ + public function getCacheTags() { + // The list of topics depends on the list cache tag for the topic entity. + return $this->entityTypeManager->getDefinition('help_topic')->getListCacheTags(); + } + + /** + * {@inheritdoc} + */ + public function getCacheContexts() { + // The links are checked for user access, so we need the user permissions + // context. + return ['user.permissions']; + } + + /** + * {@inheritdoc} + */ + public function listTopics() { + /** @var \Drupal\Core\Entity\EntityStorageInterface $tour_storage */ + $help_storage = $this->entityTypeManager->getStorage('help_topic'); + /** @var \Drupal\config_help\Entity\HelpTopic[] $entities */ + $entities = $help_storage->loadMultiple(); + uasort($entities, [HelpTopic::class, 'sort']); + + $topics = []; + foreach ($entities as $entity) { + if ($entity->isTopLevel() && $entity->access('view')) { + $topics[$entity->id()] = $entity->toLink(); + } + } + + return $topics; + } + +} diff --git a/core/modules/config_help/templates/help-topic.html.twig b/core/modules/config_help/templates/help-topic.html.twig new file mode 100644 index 0000000..49c8f25 --- /dev/null +++ b/core/modules/config_help/templates/help-topic.html.twig @@ -0,0 +1,16 @@ +{# +/** + * @file + * Default theme implementation to display a help topic. + * + * Available variables: + * - body: The body of the topic. + * - related: List of related topic links. + * + * @ingroup themeable + */ +#} + + {{ body }} + {{ related }} + diff --git a/core/modules/config_help/tests/modules/config_help_test/config/optional/config_help.topic.help_test.yml b/core/modules/config_help/tests/modules/config_help_test/config/optional/config_help.topic.help_test.yml new file mode 100644 index 0000000..9ea5642 --- /dev/null +++ b/core/modules/config_help/tests/modules/config_help_test/config/optional/config_help.topic.help_test.yml @@ -0,0 +1,21 @@ +langcode: en +status: true +dependencies: + enforced: + module: + - config_help_test + theme: { } +id: help_test +label: 'ABC Help Test module' +top_level: true +locked: false +related: + - config_help + - help_test_linked +list_on: { } +body: + - + text: 'This is a test. It should link to the Help module topic, and it should link to the help admin page. Also there should be a related topic link below to the Help module topic page and the linked topic.' + prefix_tags: '' + suffix_tags: '
' +body_format: help diff --git a/core/modules/config_help/tests/modules/config_help_test/config/optional/config_help.topic.help_test_additional.yml b/core/modules/config_help/tests/modules/config_help_test/config/optional/config_help.topic.help_test_additional.yml new file mode 100644 index 0000000..6bc550a --- /dev/null +++ b/core/modules/config_help/tests/modules/config_help_test/config/optional/config_help.topic.help_test_additional.yml @@ -0,0 +1,20 @@ +langcode: en +status: true +dependencies: + enforced: + module: + - config_help_test + theme: { } +id: help_test_additional +label: 'Additional topic' +top_level: false +locked: false +related: { } +list_on: + - help_test +body: + - + text: 'This topic should get listed automatically on the Help test topic.' + prefix_tags: '' + suffix_tags: '
' +body_format: help diff --git a/core/modules/config_help/tests/modules/config_help_test/config/optional/config_help.topic.help_test_linked.yml b/core/modules/config_help/tests/modules/config_help_test/config/optional/config_help.topic.help_test_linked.yml new file mode 100644 index 0000000..43ba6ee --- /dev/null +++ b/core/modules/config_help/tests/modules/config_help_test/config/optional/config_help.topic.help_test_linked.yml @@ -0,0 +1,19 @@ +langcode: en +status: true +dependencies: + enforced: + module: + - config_help_test + theme: { } +id: help_test_linked +label: 'Linked topic' +top_level: false +locked: false +related: { } +list_on: { } +body: + - + text: 'This topic is not supposed to be top-level.' + prefix_tags: '' + suffix_tags: '
' +body_format: help diff --git a/core/modules/config_help/tests/modules/config_help_test/config/optional/config_help.topic.help_test_locked.yml b/core/modules/config_help/tests/modules/config_help_test/config/optional/config_help.topic.help_test_locked.yml new file mode 100644 index 0000000..2a608fb --- /dev/null +++ b/core/modules/config_help/tests/modules/config_help_test/config/optional/config_help.topic.help_test_locked.yml @@ -0,0 +1,19 @@ +langcode: en +status: true +dependencies: + enforced: + module: + - config_help_test + theme: { } +id: help_test_locked +label: 'Locked topic' +top_level: false +locked: true +related: { } +list_on: { } +body: + - + text: 'This topic is supposed to be locked to editing.' + prefix_tags: '' + suffix_tags: '
' +body_format: help diff --git a/core/modules/config_help/tests/modules/config_help_test/config_help_test.info.yml b/core/modules/config_help/tests/modules/config_help_test/config_help_test.info.yml new file mode 100644 index 0000000..155c43d --- /dev/null +++ b/core/modules/config_help/tests/modules/config_help_test/config_help_test.info.yml @@ -0,0 +1,7 @@ +# The name of this module is deliberately different from its machine +# name to test the presented order of help topics. +name: 'ABC Help Test' +type: module +description: 'Support module for help testing.' +package: Testing +core: 8.x diff --git a/core/modules/config_help/tests/modules/config_help_test/config_help_test.module b/core/modules/config_help/tests/modules/config_help_test/config_help_test.module new file mode 100644 index 0000000..2cc5143 --- /dev/null +++ b/core/modules/config_help/tests/modules/config_help_test/config_help_test.module @@ -0,0 +1,18 @@ +adminUser = $this->createUser([ + 'access administration pages', + 'administer help topics', + 'use text format help', + 'view help topics', + 'administer help topic locking', + ]); + $this->nonLockingUser = $this->createUser([ + 'access administration pages', + 'administer help topics', + 'use text format help', + 'view help topics', + ]); + $this->nonAdminUser = $this->createUser(['access administration pages']); + + // Make sure page title, help, and local tasks are showing. + $this->placeBlock('local_tasks_block'); + $this->placeBlock('local_actions_block'); + $this->placeBlock('page_title_block'); + $this->placeBlock('help_block'); + } + + /** + * Logs in users, tests help admin pages. + */ + public function testHelpAdmin() { + $this->drupalLogin($this->nonLockingUser); + $this->verifyHelpLockingAdmin(403); + + $this->drupalLogin($this->adminUser); + $this->verifyHelpLockingAdmin(); + $this->verifyHelpAdmin(); + + $this->drupalLogin($this->nonAdminUser); + $this->verifyHelpAdmin(403); + } + + /** + * Verifies the logged in user has the correct access to locking admin. + * + * @param int $response + * (optional) The HTTP response code to test for. If it's 200 (default), + * the test verifies the user has access; if it's not, it verifies they + * are denied access. Note: Generic admin access for help topics is assumed + * but not verified in this method. + */ + protected function verifyHelpLockingAdmin($response = 200) { + $this->drupalGet('admin/config/development/help'); + + // Verify that a user without locking permissions cannot lock or unlock + // any topic, and that a user with the permission can get to the forms, + // but only to lock an unlocked topic and vice versa. + $pages = [ + 'admin/config/development/help/manage/help_test/lock' => TRUE, + 'admin/config/development/help/manage/help_test_locked/lock' => FALSE, + 'admin/config/development/help/manage/help_test/unlock' => FALSE, + 'admin/config/development/help/manage/help_test_locked/unlock' => TRUE, + ]; + foreach ($pages as $page => $allowed) { + $this->drupalGet($page); + $session = $this->assertSession(); + if (!$allowed) { + $session->statusCodeEquals(403); + } + else { + $session->statusCodeEquals($response); + } + } + + // Return at this point if testing for 403. + if ($response == 403) { + return; + } + + // Verify that locked pages cannot be edited or deleted. Editing and + // deleting of unlocked pages is tested elsewhere. Note that the URL + // for editing has no suffix. + foreach (['', '/delete'] as $action) { + $this->drupalGet('admin/config/development/help/manage/help_test_locked' . $action); + $session = $this->assertSession(); + $session->statusCodeEquals(403); + } + + // Unlock the page, and verify it can then be edited/deleted, but not + // unlocked. + $this->drupalGet('admin/config/development/help/manage/help_test_locked/unlock'); + $session = $this->assertSession(); + $session->pageTextContains('Locked topics are typically provided by modules'); + $session->pageTextContains('Are you sure you want to unlock the topic'); + $session->pageTextContains('Locked topic'); + $this->drupalPostForm(NULL, [], 'Unlock'); + $session = $this->assertSession(); + $session->pageTextContains('Unlocked help topic'); + // The '' action is actually edit. + foreach (['', '/delete', '/lock'] as $action) { + $this->drupalGet('admin/config/development/help/manage/help_test_locked' . $action); + $session = $this->assertSession(); + $session->statusCodeEquals(200); + } + $this->drupalGet('admin/config/development/help/manage/help_test_locked/unlock'); + $session = $this->assertSession(); + $session->statusCodeEquals(403); + + // Lock it up again, and verify again. + $this->drupalGet('admin/config/development/help/manage/help_test_locked/lock'); + $session = $this->assertSession(); + $session->pageTextContains('Locked topics cannot be edited or deleted until they are unlocked'); + $session->pageTextContains('Are you sure you want to lock the topic'); + $session->pageTextContains('Locked topic'); + $this->drupalPostForm(NULL, [], 'Lock'); + $session = $this->assertSession(); + $session->pageTextContains('Locked help topic'); + // The '' action is actually edit. + foreach (['', '/delete', '/lock'] as $action) { + $this->drupalGet('admin/config/development/help/manage/help_test_locked' . $action); + $session = $this->assertSession(); + $session->statusCodeEquals(403); + } + $this->drupalGet('admin/config/development/help/manage/help_test_locked/unlock'); + $session = $this->assertSession(); + $session->statusCodeEquals(200); + } + + /** + * Verifies the logged in user has the correct access to help admin. + * + * @param int $response + * (optional) The HTTP response code to test for. If it's 200 (default), + * the test verifies the user has access; if it's not, it verifies they + * are denied access. + */ + protected function verifyHelpAdmin($response = 200) { + // Verify admin links. + foreach ([ + 'admin/config', + 'admin/config/development', + 'admin/index', + ] as $page) { + $this->drupalGet($page); + $session = $this->assertSession(); + if ($response == 200) { + $session->pageTextContains('Add, delete, and edit help topics'); + $session->linkExists('Help topics'); + } + else { + $session->pageTextNotContains('Add, delete, and edit help topics'); + $session->linkNotExists('Help topics'); + } + } + + // Verify CRUD and listing page. + $this->drupalGet('admin/config/development/help'); + $session = $this->assertSession(); + $session->statusCodeEquals($response); + if ($response == 200) { + $session->linkExists('Add new help topic'); + $session->pageTextContains('Help topics'); + $session->pageTextContains('Title'); + $session->pageTextContains('Machine name'); + $session->pageTextContains('Operations'); + } + + $this->drupalGet('admin/config/development/help/add'); + $session = $this->assertSession(); + $session->statusCodeEquals($response); + + // Verify autocomplete page. + $this->drupalGet('config-help/autocomplete-topic'); + $session = $this->assertSession(); + $session->statusCodeEquals($response); + + // Everything after this point, just do for the admin user. + if ($response != 200) { + return; + } + + // Create a new help topic from the UI. + $body = 'This text is for the foo topic'; + $title = 'Foo topic'; + $id = 'foo'; + $this->drupalPostForm('admin/config/development/help/add', [ + 'label' => $title, + 'id' => $id, + 'top_level' => TRUE, + 'body[value]' => $body, + ], 'Save'); + $session = $this->assertSession(); + $session->pageTextContains('Help topic added'); + + // Click to view the topic and verify the edit link works too. + $this->clickLink($title); + $session = $this->assertSession(); + $session->pageTextContains($title); + $session->pageTextContains($body); + + $this->clickLink('Edit'); + $new_title = 'Foo longer topic'; + $new_id = 'foo2'; + $this->drupalPostForm(NULL, [ + 'label' => $new_title, + 'id' => $new_id, + ], 'Save'); + $session = $this->assertSession(); + $session->pageTextContains('Help topic updated'); + $session->linkExists($new_title); + + // Test a few autocomplete values. + $autocompletes = [ + // ID of a topic we just added. + $new_id => [$new_title, $new_id], + // Title word of a topic we just edited. + 'longer' => [$new_title, $new_id], + 'help_test' => [ + 'Additional topic', + 'help_test_additional', + 'Help Test module', + ], + ]; + + foreach ($autocompletes as $query => $texts) { + $this->drupalGet('config-help/autocomplete-topic', ['query' => ['q' => $query]]); + $session = $this->assertSession(); + $session->statusCodeEquals($response); + foreach ($texts as $text) { + $session->responseContains($text); + } + } + + // Verify the link is on the Help page. + $this->drupalGet('admin/help'); + $session = $this->assertSession(); + $session->linkExists($new_title); + + // Test deleting. + $this->drupalGet('admin/config/development/help/manage/' . $new_id . '/delete'); + $session = $this->assertSession(); + $session->pageTextContains('This action cannot be undone.'); + $session->pageTextContains('Are you sure you want to delete the help topic'); + $session->pageTextContains($new_title); + $this->drupalPostForm(NULL, [], 'Delete'); + $session = $this->assertSession(); + $session->pageTextContains('The help topic'); + $session->pageTextContains('has been deleted.'); + $session->pageTextContains($new_title); + // Verfiy we are back on the admin page and there is no longer a link + // to the topic we just deleted. + $session->linkExists('Add new help topic'); + $session = $this->assertSession(); + $session->pageTextContains('Help topics'); + $session->pageTextContains('Title'); + $session->pageTextContains('Machine name'); + $session->pageTextContains('Operations'); + $session->linkNotExists($new_title); + // Verify the topic is not on admin/help any more either. + $this->drupalGet('admin/help'); + $session = $this->assertSession(); + $session->linkNotExists($new_title); + + // Test form validation. + $this->drupalGet('admin/config/development/help/add'); + $this->drupalPostForm(NULL, [ + 'label' => $title, + 'id' => 'foobar', + 'top_level' => TRUE, + 'body[value]' => $body, + 'related' => 'invalid.text', + ], 'Save'); + $session = $this->assertSession(); + $session->pageTextNotContains('Help topic added'); + $session->pageTextContains('Must be a comma-separated list of existing topic machine names'); + + // Fix form and add dependency field. + $this->drupalPostForm(NULL, [ + 'related' => '', + 'modules' => 'color', + ], 'Save'); + $session = $this->assertSession(); + $session->pageTextContains('Help topic added'); + $session->linkExists($title); + $this->drupalGet('admin/help'); + $session = $this->assertSession(); + $session->linkExists($title); + + // Disable the color module and verify dependent topics go away. + $this->container->get('module_installer')->uninstall(['color']); + $this->drupalGet('admin/help'); + $session = $this->assertSession(); + $session->linkExists('Building a help system'); + $session->linkNotExists($title); + } + + /** + * Tests tabs on topic view page. + */ + public function testTabsVisible() { + // Install config translation module to test translation tab. + $this->container->get('module_installer') + ->install(['config_translation', 'locale', 'language']); + ConfigurableLanguage::createFromLangcode('es')->save(); + + $user = $this->createUser([ + 'access administration pages', + 'administer help topics', + 'use text format help', + 'view help topics', + 'administer help topic locking', + 'translate configuration', + ]); + $this->drupalLogin($user); + foreach (['View', 'Edit', 'Delete', 'Translate help topic'] as $label) { + $this->drupalGet('admin/help-topic/help_test'); + $this->clickLink($label); + $session = $this->assertSession(); + $session->statusCodeEquals(200); + } + } + + /** + * Tests autocomplete for topics, modules & themes. + */ + public function testAutocomplete() { + $path = 'config-help/autocomplete-'; + $cases = [ + 'topic' => [ + '|' => '[]', + 'Writing good' => '[{"value":"config_help_writing","label":"Writing good help (config_help_writing)"}]', + 'config_' => '[{"value":"config_help","label":"Building a help system (config_help)"},{"value":"config_basic","label":"Changing basic site settings (config_basic)"},{"value":"config_error","label":"Configuring error responses, including 403\/404 pages (config_error)"},{"value":"config_help_form","label":"Help topic editing form (config_help_form)"},{"value":"config_help_writing","label":"Writing good help (config_help_writing)"}]', + ], + 'module' => [ + '|' => '[]', + 'ABC' => '[{"value":"config_help_test","label":"ABC Help Test (config_help_test)"}]', + 'config' => '[{"value":"config_help","label":"Configurable Help (config_help)"},{"value":"config_help_test","label":"ABC Help Test (config_help_test)"}]', + ], + 'theme' => [ + '|' => '[]', + 'Stab' => '[{"value":"stable","label":"Stable (stable)"}]', + 'a' => '[{"value":"stable","label":"Stable (stable)"},{"value":"classy","label":"Classy (classy)"}]', + ], + ]; + // Test that non-admin user has no access to autocomplete routes. + $this->drupalLogin($this->nonAdminUser); + foreach (array_keys($cases) as $part) { + $this->drupalGet($path . $part); + $session = $this->assertSession(); + $session->statusCodeEquals(403); + } + // Test output of autocomplete. + $this->drupalLogin($this->adminUser); + foreach ($cases as $part => $test) { + foreach ($test as $query => $expected) { + $this->drupalGet($path . $part, ['query' => ['q' => $query]]); + $session = $this->assertSession(); + $session->statusCodeEquals(200); + $this->assertEquals($expected, $this->getSession()->getPage()->getContent()); + } + } + // Make sure results are limited. + $this->drupalGet($path . 'topic', ['query' => ['q' => 'o']]); + $matches = Json::decode($this->getSession()->getPage()->getContent()); + $this->assertEquals(10, count($matches)); + $this->container->get('module_installer') + ->install(['contextual', 'dblog', 'hal', 'field', 'link']); + system_rebuild_module_data(); + $this->drupalGet($path . 'module', ['query' => ['q' => 'l']]); + $matches = Json::decode($this->getSession()->getPage()->getContent()); + $this->assertEquals(10, count($matches)); + } + +} diff --git a/core/modules/config_help/tests/src/Functional/HelpTopicTest.php b/core/modules/config_help/tests/src/Functional/HelpTopicTest.php new file mode 100644 index 0000000..b690837 --- /dev/null +++ b/core/modules/config_help/tests/src/Functional/HelpTopicTest.php @@ -0,0 +1,337 @@ +install(['seven']); + \Drupal::service('config.factory')->getEditable('system.theme')->set('admin', 'seven')->save(); + + // Place various blocks. + $settings = [ + 'theme' => 'seven', + 'region' => 'help', + ]; + $this->placeBlock('help_block', $settings); + $this->placeBlock('local_tasks_block', $settings); + $this->placeBlock('local_actions_block', $settings); + $this->placeBlock('page_title_block', $settings); + + // Create users. + $this->adminUser = $this->createUser([ + 'access administration pages', + 'view the administration theme', + 'administer permissions', + 'administer help topics', + 'view help topics', + ]); + $this->anyUser = $this->createUser([]); + } + + /** + * Tests the main help page and individual pages for topics. + */ + public function testHelp() { + // Log in the regular user. + $this->drupalLogin($this->anyUser); + $this->verifyHelp(403, FALSE); + + // Log in the admin user. + $this->drupalLogin($this->adminUser); + $this->verifyHelp(); + $this->verifyHelpLinks(); + + // Verify that help topics text appears on admin/help. + $this->drupalGet('admin/help'); + $session = $this->assertSession(); + $session->responseContains('Configured topics
'); + $session->pageTextContains('Configured topics can be provided by modules, themes'); + + // Verify the cache tag for the list of topics is present, as well as + // the cache context for user permissions. + $this->assertCacheTag('config:help_topic_list'); + $this->assertCacheContext('user.permissions'); + + // Verify links for for configurable topics, and order. + $page_text = $this->getTextContent(); + $start = strpos($page_text, 'Configured topics'); + $pos = $start; + foreach ($this->getTopicList() as $info) { + $name = $info['name']; + $session->linkExists($name); + $new_pos = strpos($page_text, $name, $start); + $this->assertTrue($new_pos > $pos, 'Order of ' . $name . ' is correct on page'); + $pos = $new_pos; + } + + // Uninstall the test module and verify the topics are gone, after + // reloading page. + $this->container->get('module_installer')->uninstall(['config_help_test']); + $this->drupalGet('admin/help'); + $session = $this->assertSession(); + $session->linkNotExists('ABC Help Test module'); + $session->linkNotExists('ABC Help Test'); + } + + /** + * Tests export and import of help topics, and topic create from array. + */ + public function testTopicExportImport() { + // Create a help topic entity. + $values = [ + 'id' => 'foo', + 'label' => 'Foo', + 'body' => [ + [ + 'text' => 'Greetings', + 'prefix_tags' => '', + 'suffix_tags' => '
', + ], + [ + 'text' => 'Hello, world!', + 'prefix_tags' => '', + 'suffix_tags' => '
', + ], + ], + 'top_level' => TRUE, + 'locked' => TRUE, + 'related' => ['config_help'], + 'list_on' => ['config_help_form'], + ]; + // Set the dependecies after creation, because it's an odd bit of the + // configuration. + $dependencies = [ + 'module' => ['config_help', 'filter'], + 'theme' => ['classy', 'bartik'], + ]; + + /** @var \Drupal\config_help\HelpTopicInterface $foo */ + $foo = HelpTopic::create($values); + $foo->setEnforcedDependencies($dependencies); + + // Export and import the topic. + $foo_export = Yaml::encode($foo->toArray()); + $bar = HelpTopic::create(Yaml::decode($foo_export)); + + // Verify that everything is OK. + $to_check = [ + // This is an array of method name => component in $values, except + // dependencies and body, which are checked separately. + 'id' => 'id', + 'label' => 'label', + 'getBody' => FALSE, + 'isTopLevel' => 'top_level', + 'isLocked' => 'locked', + 'getRelated' => 'related', + 'getListOn' => 'list_on', + 'getEnforcedDependencies' => FALSE, + ]; + + // Verify that the initial create got the right values, and that after + // export/import, the values are the same. + foreach ($to_check as $method => $component) { + if ($component) { + $this->assertEqual(call_user_func([$foo, $method]), $values[$component], 'Data for ' . $component . ' is the same as method ' . $method); + } + $this->assertEqual(call_user_func([$foo, $method]), call_user_func([$bar, $method]), 'Method ' . $method . ' is the same before and after export/import'); + } + + // Check that the getEnforcedDepenencies() method works correctly. The + // getBody() and setBody() methods are checked in a different test method. + $this->assertEqual($foo->getEnforcedDependencies(), $dependencies, 'Data for dependencies is the same as method getEnforcedDependencies'); + + } + + /** + * Tests the help topic body get and set functions. + */ + public function testTopicBodyGetSet() { + $topic = HelpTopic::create(); + + $body = '' . + 'A paragraph with attributes
' . + 'A heading
' . + 'A sub-heading
' . + '- Bullet 1
- Bullet 2
- Number 1
- Number 2
' . + 'Col 1 Col 2 Data 1 Data 2 - Item 1
- Definition 1
- Item 2
- Definition 2
' . $name . '
'); + // Check the cache tags. + foreach ($info['cache_tags'] as $tag) { + $this->assertCacheTag($tag); + } + } + elseif ($check_tags) { + // Check that the cache tags are there. + foreach ($info['cache_tags'] as $tag) { + $this->assertCacheTag($tag); + } + } + } + } + + /** + * Verifies links on the test help topic page and other pages. + * + * Assumes an admin user is logged in. + */ + protected function verifyHelpLinks() { + // Verify links on the test top-level page. + $page = 'admin/help-topic/help_test'; + $links = [ + 'link to the Help module topic' => 'Building a help system', + 'link to the help admin page' => 'Add new help topic', + 'Building a help system' => 'Building a help system', + 'Linked topic' => 'This topic is not supposed to be top-level', + 'Additional topic' => 'This topic should get listed automatically', + ]; + foreach ($links as $link_text => $page_text) { + $this->drupalGet($page); + $this->clickLink($link_text); + $session = $this->assertSession(); + $session->pageTextContains($page_text); + } + + // Verify that the non-top-level topics do not appear on the Help page. + $this->drupalGet('admin/help'); + $session = $this->assertSession(); + $session->linkNotExists('Linked topic'); + $session->linkNotExists('Additional topic'); + } + + /** + * Gets a list of topic IDs to test. + * + * @return array + * A list of topics to test, in the order in which they should appear. The + * keys are the machine names of the topics. The values are arrays with the + * following elements: + * - name: Displayed name. + * - cache_tags: Cache tags to verify are present on the topic display page. + */ + protected function getTopicList() { + return [ + 'help_test' => [ + 'name' => 'ABC Help Test module', + 'cache_tags' => [ + 'config:config_help.topic.help_test', + 'config:config_help.topic.config_help', + 'config:config_help.topic.help_test_linked', + ], + ], + 'config_help' => [ + 'name' => 'Building a help system', + 'cache_tags' => [ + 'config:config_help.topic.config_help', + ], + ], + ]; + } + + /** + * Asserts that a given cache context exists. + * + * This was part of the Simpletest base class, but doesn't exist in + * BrowserTestBase. + */ + protected function assertCacheContext($expected_cache_context) { + $contexts = explode(' ', $this->getSession()->getResponseHeader('X-Drupal-Cache-Contexts')); + $this->assertTrue(in_array($expected_cache_context, $contexts), "'" . $expected_cache_context . "' is present in the X-Drupal-Cache-Contexts header."); + } + + /** + * Asserts that a given cache tag exists. + * + * This was part of the Simpletest base class, but doesn't exist in + * BrowserTestBase except in a legacy trait. + */ + protected function assertCacheTag($expected_cache_tag) { + $tags = explode(' ', $this->getSession()->getResponseHeader('X-Drupal-Cache-Tags')); + $this->assertTrue(in_array($expected_cache_tag, $tags), "'" . $expected_cache_tag . "' is present in the X-Drupal-Cache-Tags header."); + } + +} diff --git a/core/modules/config_help/tests/src/Functional/HelpTopicTranslateTest.php b/core/modules/config_help/tests/src/Functional/HelpTopicTranslateTest.php new file mode 100644 index 0000000..7784372 --- /dev/null +++ b/core/modules/config_help/tests/src/Functional/HelpTopicTranslateTest.php @@ -0,0 +1,152 @@ +adminUser = $this->createUser([ + 'access administration pages', + 'administer help topics', + 'view help topics', + 'use text format help', + 'translate configuration', + 'administer languages', + 'administer site configuration', + ]); + + // Add a language. + ConfigurableLanguage::createFromLangcode('es')->save(); + } + + /** + * Logs in users, tests help translation. + */ + public function testHelpTranslation() { + $this->drupalLogin($this->adminUser); + + // Verify that the help topics admin page has translate links. + $this->drupalGet('admin/config/development/help'); + $session = $this->assertSession(); + $session->linkExists('Translate'); + + // Translate a topic. + $es_body = 'This is the fake Spanish body'; + $es_title = 'This is the fake Spanish title'; + $this->drupalGet('admin/config/development/help/manage/help_test/translate'); + $this->clickLink('Add'); + $this->drupalPostForm(NULL, [ + 'translation[config_names][config_help.topic.help_test][label]' => $es_title, + 'translation[config_names][config_help.topic.help_test][body][0][text]' => $es_body, + ], 'Save translation'); + + // Visit the page in English and verify. + $this->drupalGet('admin/help-topic/help_test'); + $session = $this->assertSession(); + $session->pageTextContains('ABC Help Test module'); + $session->pageTextContains('This is a test.'); + $session->pageTextNotContains($es_title); + $session->pageTextNotContains($es_body); + + // Visit the page in Spanish and verify. + $this->drupalGet('es/admin/help-topic/help_test'); + $session = $this->assertSession(); + $session->pageTextNotContains('ABC Help Test module'); + $session->pageTextNotContains('This is a test.'); + $session->pageTextContains($es_title); + $session->pageTextContains($es_body); + + // Add a new topic sourced in Spanish. + $second_en_title = 'Second Test'; + $second_es_title = 'Segunda Prueba'; + $second_en_body = 'Second body'; + $second_es_body = 'Segunda cuerpo'; + + $this->drupalPostForm('admin/config/development/help/add', [ + 'langcode' => 'es', + 'label' => $second_es_title, + 'id' => 'foo', + 'top_level' => TRUE, + 'body[value]' => $second_es_body, + ], 'Save'); + + // Translate it into English. + $this->drupalGet('admin/config/development/help/manage/foo/translate'); + $this->clickLink('Add'); + $this->drupalPostForm(NULL, [ + 'translation[config_names][config_help.topic.foo][label]' => $second_en_title, + 'translation[config_names][config_help.topic.foo][body][0][text]' => $second_en_body, + ], 'Save translation'); + + // Visit the page in English and verify. + $this->drupalGet('admin/help-topic/foo'); + $session = $this->assertSession(); + $session->pageTextContains($second_en_title); + $session->pageTextContains($second_en_body); + $session->pageTextNotContains($second_es_title); + $session->pageTextNotContains($second_es_body); + + // Visit the page in Spanish and verify. + $this->drupalGet('es/admin/help-topic/foo'); + $session = $this->assertSession(); + $session->pageTextNotContains($second_en_title); + $session->pageTextNotContains($second_en_body); + $session->pageTextContains($second_es_title); + $session->pageTextContains($second_es_body); + + // Visit the help landing page and verify correct title links are shown + // in both languages. + $this->drupalGet('admin/help'); + $session = $this->assertSession(); + $session->linkExists('ABC Help Test module'); + $session->linkNotExists($es_title); + $session->linkExists($second_en_title); + $session->linkNotExists($second_es_title); + + $this->drupalGet('es/admin/help'); + $session = $this->assertSession(); + $session->linkNotExists('ABC Help Test module'); + $session->linkExists($es_title); + $session->linkNotExists($second_en_title); + $session->linkExists($second_es_title); + } + +} diff --git a/core/modules/config_help/tests/src/Kernel/HelpTopicTokensTest.php b/core/modules/config_help/tests/src/Kernel/HelpTopicTokensTest.php new file mode 100644 index 0000000..d8c32e4 --- /dev/null +++ b/core/modules/config_help/tests/src/Kernel/HelpTopicTokensTest.php @@ -0,0 +1,64 @@ +installSchema('system', ['router', 'sequences']); + $this->installConfig(['config_help']); + \Drupal::service('router.builder')->rebuild(); + } + + /** + * Tests that help topic tokens work. + */ + public function testHelpTopicTokens() { + // Verify a URL token for a help topic. + $bubbleable_metadata = new BubbleableMetadata(); + $text = 'This should Link to help topic'; + $replaced = \Drupal::token()->replace($text, [], [], $bubbleable_metadata); + $this->assertTrue(strpos($replaced, 'assertTrue(in_array('config:config_help.topic.config_help', $bubbleable_metadata->getCacheTags()), 'Cache tag for the linked topic was added'); + + $text = 'This should Not link to help topic'; + $replaced = \Drupal::token()->replace($text); + $this->assertTrue(strpos($replaced, '[help_topic:url:nonexistent]') !== FALSE, 'Nonexistent help topic did not get replaced'); + } + + /** + * Tests that route tokens work. + */ + public function testRouteTokens() { + $text = 'This should Link to admin'; + $replaced = \Drupal::token()->replace($text); + $this->assertTrue(strpos($replaced, 'replace($text); + $this->assertTrue(strpos($replaced, '[route:url:system.nonexistent]') !== FALSE, 'Nonexistent route was not replaced'); + } + +}