DisplayPathTest.php

<?php

namespace Drupal\Tests\views_ui\Functional;

use Drupal\Core\Menu\MenuTreeParameters;
use Drupal\menu_link_content\Entity\MenuLinkContent;
use Drupal\Tests\system\Functional\Cache\AssertPageCacheContextsAndTagsTrait;

/**
 * Tests the UI of generic display path plugin.
 *
 * @group views_ui
 * @see \Drupal\views\Plugin\views\display\PathPluginBase
 */
class DisplayPathTest extends UITestBase {
    use AssertPageCacheContextsAndTagsTrait;
    protected function setUp($import_test_views = TRUE) {
        parent::setUp($import_test_views);
        $this->placeBlock('page_title_block');
    }
    
    /**
     * {@inheritdoc}
     */
    public static $modules = [
        'menu_ui',
    ];
    
    /**
     * {@inheritdoc}
     */
    protected $defaultTheme = 'stark';
    
    /**
     * Views used by this test.
     *
     * @var array
     */
    public static $testViews = [
        'test_view',
        'test_page_display_menu',
    ];
    
    /**
     * Runs the tests.
     */
    public function testPathUI() {
        $this->doBasicPathUITest();
        $this->doAdvancedPathsValidationTest();
        $this->doPathXssFilterTest();
    }
    
    /**
     * Tests basic functionality in configuring a view.
     */
    protected function doBasicPathUITest() {
        $this->drupalGet('admin/structure/views/view/test_view');
        // Add a new page display and check the appearing text.
        $this->drupalPostForm(NULL, [], 'Add Page');
        $this->assertText(t('No path is set'), 'The right text appears if no path was set.');
        $this->assertSession()
            ->linkNotExists(t('View @display', [
            '@display' => 'page',
        ]), 'No view page link found on the page.');
        // Save a path and make sure the summary appears as expected.
        $random_path = $this->randomMachineName();
        // @todo Once https://www.drupal.org/node/2351379 is resolved, Views will no
        //   longer use Url::fromUri(), and this path will be able to contain ':'.
        $random_path = str_replace(':', '', $random_path);
        $this->drupalPostForm('admin/structure/views/nojs/display/test_view/page_1/path', [
            'path' => $random_path,
        ], t('Apply'));
        $this->assertText('/' . $random_path, 'The custom path appears in the summary.');
        $display_link_text = t('View @display', [
            '@display' => 'Page',
        ]);
        $this->assertSession()
            ->linkExists($display_link_text, 0, 'view page link found on the page.');
        $this->clickLink($display_link_text);
        $this->assertUrl($random_path);
    }
    
    /**
     * Tests that View paths are properly filtered for XSS.
     */
    public function doPathXssFilterTest() {
        $this->drupalGet('admin/structure/views/view/test_view');
        $this->drupalPostForm(NULL, [], 'Add Page');
        $this->drupalPostForm('admin/structure/views/nojs/display/test_view/page_2/path', [
            'path' => '<object>malformed_path</object>',
        ], t('Apply'));
        $this->drupalPostForm(NULL, [], 'Add Page');
        $this->drupalPostForm('admin/structure/views/nojs/display/test_view/page_3/path', [
            'path' => '<script>alert("hello");</script>',
        ], t('Apply'));
        $this->drupalPostForm(NULL, [], 'Add Page');
        $this->drupalPostForm('admin/structure/views/nojs/display/test_view/page_4/path', [
            'path' => '<script>alert("hello I have placeholders %");</script>',
        ], t('Apply'));
        $this->drupalPostForm('admin/structure/views/view/test_view', [], t('Save'));
        $this->drupalGet('admin/structure/views');
        // The anchor text should be escaped.
        $this->assertEscaped('/<object>malformed_path</object>');
        $this->assertEscaped('/<script>alert("hello");</script>');
        $this->assertEscaped('/<script>alert("hello I have placeholders %");</script>');
        // Links should be url-encoded.
        $this->assertRaw('/%3Cobject%3Emalformed_path%3C/object%3E');
        $this->assertRaw('/%3Cscript%3Ealert%28%22hello%22%29%3B%3C/script%3E');
    }
    
    /**
     * Tests a couple of invalid path patterns.
     */
    protected function doAdvancedPathsValidationTest() {
        $url = 'admin/structure/views/nojs/display/test_view/page_1/path';
        $this->drupalPostForm($url, [
            'path' => '%/magrathea',
        ], t('Apply'));
        $this->assertUrl($url);
        $this->assertText('"%" may not be used for the first segment of a path.');
        $this->drupalPostForm($url, [
            'path' => 'user/%1/example',
        ], t('Apply'));
        $this->assertUrl($url);
        $this->assertText("Numeric placeholders may not be used. Please use plain placeholders (%).");
    }
    
    /**
     * Tests deleting a page display that has no path.
     */
    public function testDeleteWithNoPath() {
        $this->drupalGet('admin/structure/views/view/test_view');
        $this->drupalPostForm(NULL, [], t('Add Page'));
        $this->drupalPostForm(NULL, [], t('Delete Page'));
        $this->drupalPostForm(NULL, [], t('Save'));
        $this->assertRaw(t('The view %view has been saved.', [
            '%view' => 'Test view',
        ]));
    }
    
    /**
     * Tests the menu and tab option form.
     */
    public function testMenuOptions() {
        $this->container
            ->get('module_installer')
            ->install([
            'menu_ui',
        ]);
        $this->drupalGet('admin/structure/views/view/test_view');
        // Add a new page display.
        $this->drupalPostForm(NULL, [], 'Add Page');
        // Add an invalid path (only fragment).
        $this->drupalPostForm('admin/structure/views/nojs/display/test_view/page_1/path', [
            'path' => '#foo',
        ], t('Apply'));
        $this->assertText('Path is empty');
        // Add an invalid path with a query.
        $this->drupalPostForm('admin/structure/views/nojs/display/test_view/page_1/path', [
            'path' => 'foo?bar',
        ], t('Apply'));
        $this->assertText('No query allowed.');
        // Add an invalid path with just a query.
        $this->drupalPostForm('admin/structure/views/nojs/display/test_view/page_1/path', [
            'path' => '?bar',
        ], t('Apply'));
        $this->assertText('Path is empty');
        // Provide a random, valid path string.
        $random_string = $this->randomMachineName();
        // Save a path.
        $this->drupalPostForm('admin/structure/views/nojs/display/test_view/page_1/path', [
            'path' => $random_string,
        ], t('Apply'));
        $this->drupalGet('admin/structure/views/view/test_view');
        $this->drupalPostForm('admin/structure/views/nojs/display/test_view/page_1/menu', [
            'menu[type]' => 'default tab',
            'menu[title]' => 'Test tab title',
        ], t('Apply'));
        $this->assertSession()
            ->statusCodeEquals(200);
        $this->assertUrl('admin/structure/views/nojs/display/test_view/page_1/tab_options');
        $this->drupalPostForm(NULL, [
            'tab_options[type]' => 'tab',
            'tab_options[title]' => $this->randomString(),
        ], t('Apply'));
        $this->assertSession()
            ->statusCodeEquals(200);
        $this->assertUrl('admin/structure/views/view/test_view/edit/page_1');
        $this->drupalGet('admin/structure/views/view/test_view');
        $this->assertSession()
            ->linkExists(t('Tab: @title', [
            '@title' => 'Test tab title',
        ]));
        // If it's a default tab, it should also have an additional settings link.
        $this->assertLinkByHref('admin/structure/views/nojs/display/test_view/page_1/tab_options');
        // Ensure that you can select a parent in case the parent does not exist.
        $this->drupalGet('admin/structure/views/nojs/display/test_page_display_menu/page_5/menu');
        $this->assertSession()
            ->statusCodeEquals(200);
        $menu_parent = $this->xpath('//select[@id="edit-menu-parent"]');
        $menu_options = (array) $menu_parent[0]->findAll('css', 'option');
        unset($menu_options['@attributes']);
        // Convert array to make the next assertion possible.
        $menu_options = array_map(function ($element) {
            return $element->getText();
        }, $menu_options);
        $this->assertEqual([
            '<User account menu>',
            '-- My account',
            '-- Log out',
            '<Administration>',
            '<Footer>',
            '<Main navigation>',
            '<Tools>',
            '-- Compose tips (disabled)',
            '-- Test menu link',
        ], $menu_options);
        // The cache contexts associated with the (in)accessible menu links are
        // bubbled.
        $this->assertCacheContext('user.permissions');
    }
    
    /**
     * Tests the regression in https://www.drupal.org/node/2532490.
     */
    public function testDefaultMenuTabRegression() {
        $this->container
            ->get('module_installer')
            ->install([
            'menu_ui',
            'menu_link_content',
            'toolbar',
            'system',
        ]);
        $admin_user = $this->drupalCreateUser([
            'administer views',
            'administer blocks',
            'bypass node access',
            'access user profiles',
            'view all revisions',
            'administer permissions',
            'administer menu',
            'link to any page',
            'access toolbar',
        ]);
        $this->drupalLogin($admin_user);
        $edit = [
            'title[0][value]' => 'Menu title',
            'link[0][uri]' => '/admin/foo',
            'menu_parent' => 'admin:system.admin',
        ];
        $this->drupalPostForm('admin/structure/menu/manage/admin/add', $edit, t('Save'));
        $menu_items = \Drupal::entityTypeManager()->getStorage('menu_link_content')
            ->getQuery()
            ->sort('id', 'DESC')
            ->pager(1)
            ->execute();
        $menu_item = end($menu_items);
        
        /** @var \Drupal\menu_link_content\MenuLinkContentInterface $menu_link_content */
        $menu_link_content = MenuLinkContent::load($menu_item);
        $edit = [];
        $edit['label'] = $this->randomMachineName(16);
        $view_id = $edit['id'] = strtolower($this->randomMachineName(16));
        $edit['description'] = $this->randomMachineName(16);
        $edit['page[create]'] = TRUE;
        $edit['page[path]'] = 'admin/foo';
        $this->drupalPostForm('admin/structure/views/add', $edit, t('Save and edit'));
        $parameters = new MenuTreeParameters();
        $parameters->addCondition('id', $menu_link_content->getPluginId());
        $result = \Drupal::menuTree()->load('admin', $parameters);
        $plugin_definition = end($result)->link
            ->getPluginDefinition();
        $this->assertEqual('view.' . $view_id . '.page_1', $plugin_definition['route_name']);
        $this->clickLink(t('No menu'));
        $this->drupalPostForm(NULL, [
            'menu[type]' => 'default tab',
            'menu[title]' => 'Menu title',
        ], t('Apply'));
        $this->assertText('Default tab options');
        $this->drupalPostForm(NULL, [
            'tab_options[type]' => 'normal',
            'tab_options[title]' => 'Parent title',
        ], t('Apply'));
        $this->drupalPostForm(NULL, [], t('Save'));
        // Assert that saving the view will not cause an exception.
        $this->assertSession()
            ->statusCodeEquals(200);
    }

}