SearchPageTextTest.php

<?php

declare (strict_types=1);
namespace Drupal\Tests\search\Functional;

use Drupal\Component\Utility\Unicode;
use Drupal\Tests\BrowserTestBase;

/**
 * Tests the search help text and search page text.
 *
 * @group search
 */
class SearchPageTextTest extends BrowserTestBase {
    
    /**
     * {@inheritdoc}
     */
    protected static $modules = [
        'block',
        'node',
        'search',
    ];
    
    /**
     * {@inheritdoc}
     */
    protected $defaultTheme = 'stark';
    
    /**
     * A user with permission to use advanced search.
     *
     * @var \Drupal\user\UserInterface
     */
    protected $searchingUser;
    
    /**
     * {@inheritdoc}
     */
    protected function setUp() : void {
        parent::setUp();
        $this->drupalCreateContentType([
            'type' => 'page',
            'name' => 'Basic page',
        ]);
        // Create user.
        $this->searchingUser = $this->drupalCreateUser([
            'search content',
            'access user profiles',
            'use advanced search',
        ]);
        $this->drupalPlaceBlock('local_tasks_block');
        $this->drupalPlaceBlock('page_title_block');
    }
    
    /**
     * Tests for XSS in search module local task.
     *
     * This is a regression test for https://www.drupal.org/node/2338081
     */
    public function testSearchLabelXSS() : void {
        $this->drupalLogin($this->drupalCreateUser([
            'administer search',
        ]));
        $keys['label'] = '<script>alert("Don\'t Panic");</script>';
        $this->drupalGet('admin/config/search/pages/manage/node_search');
        $this->submitForm($keys, 'Save search page');
        $this->drupalLogin($this->searchingUser);
        $this->drupalGet('search/node');
        $this->assertSession()
            ->assertEscaped($keys['label']);
    }
    
    /**
     * Tests the failed search text, and various other text on the search page.
     */
    public function testSearchText() : void {
        $this->drupalLogin($this->searchingUser);
        $this->drupalGet('search/node');
        $this->assertSession()
            ->pageTextContains('Enter your keywords');
        $this->assertSession()
            ->pageTextContains('Search');
        $this->assertSession()
            ->titleEquals('Search | Drupal');
        $edit = [];
        $search_terms = 'bike shed ' . $this->randomMachineName();
        $edit['keys'] = $search_terms;
        $this->drupalGet('search/node');
        $this->submitForm($edit, 'Search');
        $this->assertSession()
            ->pageTextContains('search yielded no results');
        $this->assertSession()
            ->pageTextContains('Search');
        $this->assertSession()
            ->titleEquals('Search for ' . Unicode::truncate($search_terms, 60, TRUE, TRUE) . ' | Drupal');
        $this->assertSession()
            ->pageTextNotContains('Node');
        $this->assertSession()
            ->pageTextNotContains('Node');
        $this->assertSession()
            ->pageTextContains('Content');
        $this->clickLink('About searching');
        $this->assertSession()
            ->pageTextContains('About searching');
        $this->assertSession()
            ->pageTextContains('Use upper-case OR to get more results');
        // Search for a longer text, and see that it is in the title, truncated.
        $edit = [];
        $search_terms = 'Every word is like an unnecessary stain on silence and nothingness.';
        $edit['keys'] = $search_terms;
        $this->drupalGet('search/node');
        $this->submitForm($edit, 'Search');
        $this->assertSession()
            ->titleEquals('Search for Every word is like an unnecessary stain on silence and… | Drupal');
        // Search for a string with a lot of special characters.
        $search_terms = 'Hear nothing > "see nothing" `feel' . " '1982.";
        $edit['keys'] = $search_terms;
        $this->drupalGet('search/node');
        $this->submitForm($edit, 'Search');
        $this->assertSession()
            ->titleEquals('Search for ' . Unicode::truncate($search_terms, 60, TRUE, TRUE) . ' | Drupal');
        $edit['keys'] = $this->searchingUser
            ->getAccountName();
        $this->drupalGet('search/user');
        $this->submitForm($edit, 'Search');
        $this->assertSession()
            ->pageTextContains('Search');
        $this->assertSession()
            ->titleEquals('Search for ' . Unicode::truncate($this->searchingUser
            ->getAccountName(), 60, TRUE, TRUE) . ' | Drupal');
        $this->clickLink('About searching');
        $this->assertSession()
            ->pageTextContains('About searching');
        $this->assertSession()
            ->pageTextContains('user names and partial user names');
        // Test that search keywords containing slashes are correctly loaded
        // from the GET params and displayed in the search form.
        $arg = $this->randomMachineName() . '/' . $this->randomMachineName();
        $this->drupalGet('search/node', [
            'query' => [
                'keys' => $arg,
            ],
        ]);
        $this->assertSession()
            ->elementExists('xpath', "//input[@id='edit-keys' and @value='{$arg}']");
        // Test a search input exceeding the limit of AND/OR combinations to test
        // the Denial-of-Service protection.
        $limit = $this->config('search.settings')
            ->get('and_or_limit');
        $keys = [];
        for ($i = 0; $i < $limit + 1; $i++) {
            // Use a key of 4 characters to ensure we never generate 'AND' or 'OR'.
            $keys[] = $this->randomMachineName(4);
            if ($i % 2 == 0) {
                $keys[] = 'OR';
            }
        }
        $edit['keys'] = implode(' ', $keys);
        $this->drupalGet('search/node');
        $this->submitForm($edit, 'Search');
        $this->assertSession()
            ->statusMessageContains("Your search used too many AND/OR expressions. Only the first {$limit} terms were included in this search.", 'warning');
        // Test that a search on Node or User with no keywords entered generates
        // the "Enter some keywords" message.
        $this->drupalGet('search/node');
        $this->submitForm([], 'Search');
        $this->assertSession()
            ->statusMessageContains('Enter some keywords', 'error');
        $this->drupalGet('search/user');
        $this->submitForm([], 'Search');
        $this->assertSession()
            ->statusMessageContains('Enter some keywords', 'error');
        // Make sure the "Enter some keywords" message is NOT displayed if you use
        // "or" words or phrases in Advanced Search.
        $this->drupalGet('search/node');
        $this->submitForm([
            'or' => $this->randomMachineName() . ' ' . $this->randomMachineName(),
        ], 'edit-submit--2');
        $this->assertSession()
            ->statusMessageNotContains('Enter some keywords');
        $this->drupalGet('search/node');
        $this->submitForm([
            'phrase' => '"' . $this->randomMachineName() . '" "' . $this->randomMachineName() . '"',
        ], 'edit-submit--2');
        $this->assertSession()
            ->statusMessageNotContains('Enter some keywords');
        // Verify that if you search for a too-short keyword, you get the right
        // message, and that if after that you search for a longer keyword, you
        // do not still see the message.
        $this->drupalGet('search/node');
        $this->submitForm([
            'keys' => $this->randomMachineName(1),
        ], 'Search');
        $this->assertSession()
            ->statusMessageContains('You must include at least one keyword', 'warning');
        $this->assertSession()
            ->statusMessageNotContains('Enter some keywords');
        $this->submitForm([
            'keys' => $this->randomMachineName(),
        ], 'Search');
        $this->assertSession()
            ->statusMessageNotContains('You must include at least one keyword');
        // Test that if you search for a URL with .. in it, you still end up at
        // the search page. See issue https://www.drupal.org/node/890058.
        $this->drupalGet('search/node');
        $this->submitForm([
            'keys' => '../../admin',
        ], 'Search');
        $this->assertSession()
            ->statusCodeEquals(200);
        $this->assertSession()
            ->pageTextContains('no results');
        // Test that if you search for a URL starting with "./", you still end up
        // at the search page. See issue https://www.drupal.org/node/1421560.
        $this->drupalGet('search/node');
        $this->submitForm([
            'keys' => '.something',
        ], 'Search');
        $this->assertSession()
            ->statusCodeEquals(200);
        $this->assertSession()
            ->pageTextContains('no results');
    }

}