Chris@0: <?php
Chris@0: 
Chris@0: namespace Drupal\Tests\path\Functional;
Chris@0: 
Chris@0: use Drupal\Core\Cache\Cache;
Chris@0: use Drupal\Core\Database\Database;
Chris@17: use Drupal\Core\Url;
Chris@0: 
Chris@0: /**
Chris@0:  * Add, edit, delete, and change alias and verify its consistency in the
Chris@0:  * database.
Chris@0:  *
Chris@0:  * @group path
Chris@0:  */
Chris@0: class PathAliasTest extends PathTestBase {
Chris@0: 
Chris@0:   /**
Chris@0:    * Modules to enable.
Chris@0:    *
Chris@0:    * @var array
Chris@0:    */
Chris@0:   public static $modules = ['path'];
Chris@0: 
Chris@0:   protected function setUp() {
Chris@0:     parent::setUp();
Chris@0: 
Chris@0:     // Create test user and log in.
Chris@17:     $web_user = $this->drupalCreateUser(['create page content', 'edit own page content', 'administer url aliases', 'create url aliases', 'access content overview']);
Chris@0:     $this->drupalLogin($web_user);
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * Tests the path cache.
Chris@0:    */
Chris@0:   public function testPathCache() {
Chris@0:     // Create test node.
Chris@0:     $node1 = $this->drupalCreateNode();
Chris@0: 
Chris@0:     // Create alias.
Chris@0:     $edit = [];
Chris@0:     $edit['source'] = '/node/' . $node1->id();
Chris@0:     $edit['alias'] = '/' . $this->randomMachineName(8);
Chris@0:     $this->drupalPostForm('admin/config/search/path/add', $edit, t('Save'));
Chris@0: 
Chris@0:     // Check the path alias whitelist cache.
Chris@0:     $whitelist = \Drupal::cache('bootstrap')->get('path_alias_whitelist');
Chris@0:     $this->assertTrue($whitelist->data['node']);
Chris@0:     $this->assertFalse($whitelist->data['admin']);
Chris@0: 
Chris@0:     // Visit the system path for the node and confirm a cache entry is
Chris@0:     // created.
Chris@0:     \Drupal::cache('data')->deleteAll();
Chris@0:     // Make sure the path is not converted to the alias.
Chris@0:     $this->drupalGet(trim($edit['source'], '/'), ['alias' => TRUE]);
Chris@0:     $this->assertTrue(\Drupal::cache('data')->get('preload-paths:' . $edit['source']), 'Cache entry was created.');
Chris@0: 
Chris@0:     // Visit the alias for the node and confirm a cache entry is created.
Chris@0:     \Drupal::cache('data')->deleteAll();
Chris@0:     // @todo Remove this once https://www.drupal.org/node/2480077 lands.
Chris@0:     Cache::invalidateTags(['rendered']);
Chris@0:     $this->drupalGet(trim($edit['alias'], '/'));
Chris@0:     $this->assertTrue(\Drupal::cache('data')->get('preload-paths:' . $edit['source']), 'Cache entry was created.');
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * Tests alias functionality through the admin interfaces.
Chris@0:    */
Chris@0:   public function testAdminAlias() {
Chris@0:     // Create test node.
Chris@0:     $node1 = $this->drupalCreateNode();
Chris@0: 
Chris@0:     // Create alias.
Chris@0:     $edit = [];
Chris@0:     $edit['source'] = '/node/' . $node1->id();
Chris@0:     $edit['alias'] = '/' . $this->getRandomGenerator()->word(8);
Chris@0:     $this->drupalPostForm('admin/config/search/path/add', $edit, t('Save'));
Chris@0: 
Chris@0:     // Confirm that the alias works.
Chris@0:     $this->drupalGet($edit['alias']);
Chris@0:     $this->assertText($node1->label(), 'Alias works.');
Chris@0:     $this->assertResponse(200);
Chris@0:     // Confirm that the alias works in a case-insensitive way.
Chris@0:     $this->assertTrue(ctype_lower(ltrim($edit['alias'], '/')));
Chris@0:     $this->drupalGet($edit['alias']);
Chris@0:     $this->assertText($node1->label(), 'Alias works lower case.');
Chris@0:     $this->assertResponse(200);
Chris@17:     $this->drupalGet(mb_strtoupper($edit['alias']));
Chris@0:     $this->assertText($node1->label(), 'Alias works upper case.');
Chris@0:     $this->assertResponse(200);
Chris@0: 
Chris@0:     // Change alias to one containing "exotic" characters.
Chris@0:     $pid = $this->getPID($edit['alias']);
Chris@0: 
Chris@0:     $previous = $edit['alias'];
Chris@0:     // Lower-case letters.
Chris@0:     $edit['alias'] = '/alias' .
Chris@0:       // "Special" ASCII characters.
Chris@0:       "- ._~!$'\"()*@[]?&+%#,;=:" .
Chris@0:       // Characters that look like a percent-escaped string.
Chris@0:       "%23%25%26%2B%2F%3F" .
Chris@0:       // Characters from various non-ASCII alphabets.
Chris@0:       "中國書۞";
Chris@0:     $connection = Database::getConnection();
Chris@0:     if ($connection->databaseType() != 'sqlite') {
Chris@0:       // When using LIKE for case-insensitivity, the SQLite driver is
Chris@0:       // currently unable to find the upper-case versions of non-ASCII
Chris@0:       // characters.
Chris@0:       // @todo fix this in https://www.drupal.org/node/2607432
Chris@0:       $edit['alias'] .= "ïвβéø";
Chris@0:     }
Chris@0:     $this->drupalPostForm('admin/config/search/path/edit/' . $pid, $edit, t('Save'));
Chris@0: 
Chris@0:     // Confirm that the alias works.
Chris@17:     $this->drupalGet(mb_strtoupper($edit['alias']));
Chris@0:     $this->assertText($node1->label(), 'Changed alias works.');
Chris@0:     $this->assertResponse(200);
Chris@0: 
Chris@0:     $this->container->get('path.alias_manager')->cacheClear();
Chris@0:     // Confirm that previous alias no longer works.
Chris@0:     $this->drupalGet($previous);
Chris@0:     $this->assertNoText($node1->label(), 'Previous alias no longer works.');
Chris@0:     $this->assertResponse(404);
Chris@0: 
Chris@0:     // Create second test node.
Chris@0:     $node2 = $this->drupalCreateNode();
Chris@0: 
Chris@0:     // Set alias to second test node.
Chris@0:     $edit['source'] = '/node/' . $node2->id();
Chris@0:     // leave $edit['alias'] the same
Chris@0:     $this->drupalPostForm('admin/config/search/path/add', $edit, t('Save'));
Chris@0: 
Chris@0:     // Confirm no duplicate was created.
Chris@0:     $this->assertRaw(t('The alias %alias is already in use in this language.', ['%alias' => $edit['alias']]), 'Attempt to move alias was rejected.');
Chris@0: 
Chris@0:     $edit_upper = $edit;
Chris@17:     $edit_upper['alias'] = mb_strtoupper($edit['alias']);
Chris@0:     $this->drupalPostForm('admin/config/search/path/add', $edit_upper, t('Save'));
Chris@0:     $this->assertRaw(t('The alias %alias could not be added because it is already in use in this language with different capitalization: %stored_alias.', [
Chris@0:       '%alias' => $edit_upper['alias'],
Chris@0:       '%stored_alias' => $edit['alias'],
Chris@0:     ]), 'Attempt to move upper-case alias was rejected.');
Chris@0: 
Chris@0:     // Delete alias.
Chris@0:     $this->drupalGet('admin/config/search/path/edit/' . $pid);
Chris@0:     $this->clickLink(t('Delete'));
Chris@0:     $this->assertRaw(t('Are you sure you want to delete path alias %name?', ['%name' => $edit['alias']]));
Chris@0:     $this->drupalPostForm(NULL, [], t('Confirm'));
Chris@0: 
Chris@0:     // Confirm that the alias no longer works.
Chris@0:     $this->drupalGet($edit['alias']);
Chris@0:     $this->assertNoText($node1->label(), 'Alias was successfully deleted.');
Chris@0:     $this->assertResponse(404);
Chris@0: 
Chris@0:     // Create a really long alias.
Chris@0:     $edit = [];
Chris@0:     $edit['source'] = '/node/' . $node1->id();
Chris@0:     $alias = '/' . $this->randomMachineName(128);
Chris@0:     $edit['alias'] = $alias;
Chris@0:     // The alias is shortened to 50 characters counting the ellipsis.
Chris@0:     $truncated_alias = substr($alias, 0, 47);
Chris@0:     $this->drupalPostForm('admin/config/search/path/add', $edit, t('Save'));
Chris@0:     $this->assertNoText($alias, 'The untruncated alias was not found.');
Chris@0:     // The 'truncated' alias will always be found.
Chris@0:     $this->assertText($truncated_alias, 'The truncated alias was found.');
Chris@0: 
Chris@0:     // Create third test node.
Chris@0:     $node3 = $this->drupalCreateNode();
Chris@0: 
Chris@0:     // Create absolute path alias.
Chris@0:     $edit = [];
Chris@0:     $edit['source'] = '/node/' . $node3->id();
Chris@0:     $node3_alias = '/' . $this->randomMachineName(8);
Chris@0:     $edit['alias'] = $node3_alias;
Chris@0:     $this->drupalPostForm('admin/config/search/path/add', $edit, t('Save'));
Chris@0: 
Chris@0:     // Create fourth test node.
Chris@0:     $node4 = $this->drupalCreateNode();
Chris@0: 
Chris@0:     // Create alias with trailing slash.
Chris@0:     $edit = [];
Chris@0:     $edit['source'] = '/node/' . $node4->id();
Chris@0:     $node4_alias = '/' . $this->randomMachineName(8);
Chris@0:     $edit['alias'] = $node4_alias . '/';
Chris@0:     $this->drupalPostForm('admin/config/search/path/add', $edit, t('Save'));
Chris@0: 
Chris@0:     // Confirm that the alias with trailing slash is not found.
Chris@0:     $this->assertNoText($edit['alias'], 'The absolute alias was not found.');
Chris@0:     // The alias without trailing flash is found.
Chris@0:     $this->assertText(trim($edit['alias'], '/'), 'The alias without trailing slash was found.');
Chris@0: 
Chris@0:     // Update an existing alias to point to a different source.
Chris@0:     $pid = $this->getPID($node4_alias);
Chris@0:     $edit = [];
Chris@0:     $edit['alias'] = $node4_alias;
Chris@0:     $edit['source'] = '/node/' . $node2->id();
Chris@0:     $this->drupalPostForm('admin/config/search/path/edit/' . $pid, $edit, t('Save'));
Chris@0:     $this->assertText('The alias has been saved.');
Chris@0:     $this->drupalGet($edit['alias']);
Chris@0:     $this->assertNoText($node4->label(), 'Previous alias no longer works.');
Chris@0:     $this->assertText($node2->label(), 'Alias works.');
Chris@0:     $this->assertResponse(200);
Chris@0: 
Chris@0:     // Update an existing alias to use a duplicate alias.
Chris@0:     $pid = $this->getPID($node3_alias);
Chris@0:     $edit = [];
Chris@0:     $edit['alias'] = $node4_alias;
Chris@0:     $edit['source'] = '/node/' . $node3->id();
Chris@0:     $this->drupalPostForm('admin/config/search/path/edit/' . $pid, $edit, t('Save'));
Chris@0:     $this->assertRaw(t('The alias %alias is already in use in this language.', ['%alias' => $edit['alias']]));
Chris@0: 
Chris@0:     // Create an alias without a starting slash.
Chris@0:     $node5 = $this->drupalCreateNode();
Chris@0: 
Chris@0:     $edit = [];
Chris@0:     $edit['source'] = 'node/' . $node5->id();
Chris@0:     $node5_alias = $this->randomMachineName(8);
Chris@0:     $edit['alias'] = $node5_alias . '/';
Chris@0:     $this->drupalPostForm('admin/config/search/path/add', $edit, t('Save'));
Chris@0: 
Chris@0:     $this->assertUrl('admin/config/search/path/add');
Chris@0:     $this->assertText('The source path has to start with a slash.');
Chris@0:     $this->assertText('The alias path has to start with a slash.');
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * Tests alias functionality through the node interfaces.
Chris@0:    */
Chris@0:   public function testNodeAlias() {
Chris@0:     // Create test node.
Chris@0:     $node1 = $this->drupalCreateNode();
Chris@0: 
Chris@0:     // Create alias.
Chris@0:     $edit = [];
Chris@0:     $edit['path[0][alias]'] = '/' . $this->randomMachineName(8);
Chris@0:     $this->drupalPostForm('node/' . $node1->id() . '/edit', $edit, t('Save'));
Chris@0: 
Chris@0:     // Confirm that the alias works.
Chris@0:     $this->drupalGet($edit['path[0][alias]']);
Chris@0:     $this->assertText($node1->label(), 'Alias works.');
Chris@0:     $this->assertResponse(200);
Chris@0: 
Chris@0:     // Confirm the 'canonical' and 'shortlink' URLs.
Chris@0:     $elements = $this->xpath("//link[contains(@rel, 'canonical') and contains(@href, '" . $edit['path[0][alias]'] . "')]");
Chris@0:     $this->assertTrue(!empty($elements), 'Page contains canonical link URL.');
Chris@0:     $elements = $this->xpath("//link[contains(@rel, 'shortlink') and contains(@href, 'node/" . $node1->id() . "')]");
Chris@0:     $this->assertTrue(!empty($elements), 'Page contains shortlink URL.');
Chris@0: 
Chris@0:     $previous = $edit['path[0][alias]'];
Chris@0:     // Change alias to one containing "exotic" characters.
Chris@0:     // Lower-case letters.
Chris@0:     $edit['path[0][alias]'] = '/alias' .
Chris@0:       // "Special" ASCII characters.
Chris@0:       "- ._~!$'\"()*@[]?&+%#,;=:" .
Chris@0:       // Characters that look like a percent-escaped string.
Chris@0:       "%23%25%26%2B%2F%3F" .
Chris@0:       // Characters from various non-ASCII alphabets.
Chris@0:       "中國書۞";
Chris@0:     $connection = Database::getConnection();
Chris@0:     if ($connection->databaseType() != 'sqlite') {
Chris@0:       // When using LIKE for case-insensitivity, the SQLite driver is
Chris@0:       // currently unable to find the upper-case versions of non-ASCII
Chris@0:       // characters.
Chris@0:       // @todo fix this in https://www.drupal.org/node/2607432
Chris@0:       $edit['path[0][alias]'] .= "ïвβéø";
Chris@0:     }
Chris@0:     $this->drupalPostForm('node/' . $node1->id() . '/edit', $edit, t('Save'));
Chris@0: 
Chris@0:     // Confirm that the alias works.
Chris@17:     $this->drupalGet(mb_strtoupper($edit['path[0][alias]']));
Chris@0:     $this->assertText($node1->label(), 'Changed alias works.');
Chris@0:     $this->assertResponse(200);
Chris@0: 
Chris@0:     // Make sure that previous alias no longer works.
Chris@0:     $this->drupalGet($previous);
Chris@0:     $this->assertNoText($node1->label(), 'Previous alias no longer works.');
Chris@0:     $this->assertResponse(404);
Chris@0: 
Chris@0:     // Create second test node.
Chris@0:     $node2 = $this->drupalCreateNode();
Chris@0: 
Chris@0:     // Set alias to second test node.
Chris@0:     // Leave $edit['path[0][alias]'] the same.
Chris@0:     $this->drupalPostForm('node/' . $node2->id() . '/edit', $edit, t('Save'));
Chris@0: 
Chris@0:     // Confirm that the alias didn't make a duplicate.
Chris@0:     $this->assertText(t('The alias is already in use.'), 'Attempt to moved alias was rejected.');
Chris@0: 
Chris@0:     // Delete alias.
Chris@0:     $this->drupalPostForm('node/' . $node1->id() . '/edit', ['path[0][alias]' => ''], t('Save'));
Chris@0: 
Chris@0:     // Confirm that the alias no longer works.
Chris@0:     $this->drupalGet($edit['path[0][alias]']);
Chris@0:     $this->assertNoText($node1->label(), 'Alias was successfully deleted.');
Chris@0:     $this->assertResponse(404);
Chris@0: 
Chris@0:     // Create third test node.
Chris@0:     $node3 = $this->drupalCreateNode();
Chris@0: 
Chris@0:     // Set its path alias to an absolute path.
Chris@0:     $edit = ['path[0][alias]' => '/' . $this->randomMachineName(8)];
Chris@0:     $this->drupalPostForm('node/' . $node3->id() . '/edit', $edit, t('Save'));
Chris@0: 
Chris@0:     // Confirm that the alias was converted to a relative path.
Chris@0:     $this->drupalGet(trim($edit['path[0][alias]'], '/'));
Chris@0:     $this->assertText($node3->label(), 'Alias became relative.');
Chris@0:     $this->assertResponse(200);
Chris@0: 
Chris@0:     // Create fourth test node.
Chris@0:     $node4 = $this->drupalCreateNode();
Chris@0: 
Chris@0:     // Set its path alias to have a trailing slash.
Chris@0:     $edit = ['path[0][alias]' => '/' . $this->randomMachineName(8) . '/'];
Chris@0:     $this->drupalPostForm('node/' . $node4->id() . '/edit', $edit, t('Save'));
Chris@0: 
Chris@0:     // Confirm that the alias was converted to a relative path.
Chris@0:     $this->drupalGet(trim($edit['path[0][alias]'], '/'));
Chris@0:     $this->assertText($node4->label(), 'Alias trimmed trailing slash.');
Chris@0:     $this->assertResponse(200);
Chris@0: 
Chris@0:     // Create fifth test node.
Chris@0:     $node5 = $this->drupalCreateNode();
Chris@0: 
Chris@0:     // Set a path alias.
Chris@0:     $edit = ['path[0][alias]' => '/' . $this->randomMachineName(8)];
Chris@0:     $this->drupalPostForm('node/' . $node5->id() . '/edit', $edit, t('Save'));
Chris@0: 
Chris@0:     // Delete the node and check that the path alias is also deleted.
Chris@0:     $node5->delete();
Chris@0:     $path_alias = \Drupal::service('path.alias_storage')->lookupPathAlias('/node/' . $node5->id(), $node5->language()->getId());
Chris@0:     $this->assertFalse($path_alias, 'Alias was successfully deleted when the referenced node was deleted.');
Chris@17: 
Chris@17:     // Create sixth test node.
Chris@17:     $node6 = $this->drupalCreateNode();
Chris@17: 
Chris@17:     // Create an invalid alias with two leading slashes and verify that the
Chris@17:     // extra slash is removed when the link is generated. This ensures that URL
Chris@17:     // aliases cannot be used to inject external URLs.
Chris@17:     // @todo The user interface should either display an error message or
Chris@17:     //   automatically trim these invalid aliases, rather than allowing them to
Chris@17:     //   be silently created, at which point the functional aspects of this
Chris@17:     //   test will need to be moved elsewhere and switch to using a
Chris@17:     //   programmatically-created alias instead.
Chris@17:     $alias = $this->randomMachineName(8);
Chris@17:     $edit = ['path[0][alias]' => '//' . $alias];
Chris@17:     $this->drupalPostForm($node6->toUrl('edit-form'), $edit, t('Save'));
Chris@17:     $this->drupalGet(Url::fromRoute('system.admin_content'));
Chris@17:     // This checks the link href before clicking it, rather than using
Chris@17:     // \Drupal\Tests\BrowserTestBase::assertSession()->addressEquals() after
Chris@17:     // clicking it, because the test browser does not always preserve the
Chris@17:     // correct number of slashes in the URL when it visits internal links;
Chris@17:     // using \Drupal\Tests\BrowserTestBase::assertSession()->addressEquals()
Chris@17:     // would actually make the test pass unconditionally on the testbot (or
Chris@17:     // anywhere else where Drupal is installed in a subdirectory).
Chris@17:     $link_xpath = $this->xpath('//a[normalize-space(text())=:label]', [':label' => $node6->getTitle()]);
Chris@17:     $link_href = $link_xpath[0]->getAttribute('href');
Chris@17:     $this->assertEquals($link_href, base_path() . $alias);
Chris@17:     $this->clickLink($node6->getTitle());
Chris@17:     $this->assertResponse(404);
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * Returns the path ID.
Chris@0:    *
Chris@0:    * @param string $alias
Chris@0:    *   A string containing an aliased path.
Chris@0:    *
Chris@0:    * @return int
Chris@0:    *   Integer representing the path ID.
Chris@0:    */
Chris@0:   public function getPID($alias) {
Chris@0:     return db_query("SELECT pid FROM {url_alias} WHERE alias = :alias", [':alias' => $alias])->fetchField();
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * Tests that duplicate aliases fail validation.
Chris@0:    */
Chris@0:   public function testDuplicateNodeAlias() {
Chris@0:     // Create one node with a random alias.
Chris@0:     $node_one = $this->drupalCreateNode();
Chris@0:     $edit = [];
Chris@0:     $edit['path[0][alias]'] = '/' . $this->randomMachineName();
Chris@0:     $this->drupalPostForm('node/' . $node_one->id() . '/edit', $edit, t('Save'));
Chris@0: 
Chris@0:     // Now create another node and try to set the same alias.
Chris@0:     $node_two = $this->drupalCreateNode();
Chris@0:     $this->drupalPostForm('node/' . $node_two->id() . '/edit', $edit, t('Save'));
Chris@0:     $this->assertText(t('The alias is already in use.'));
Chris@0:     $this->assertFieldByXPath("//input[@name='path[0][alias]' and contains(@class, 'error')]", $edit['path[0][alias]'], 'Textfield exists and has the error class.');
Chris@0: 
Chris@0:     // Behavior here differs with the inline_form_errors module enabled.
Chris@0:     // Enable the inline_form_errors module and try this again. This module
Chris@0:     // improves validation with a link in the error message(s) to the fields
Chris@0:     // which have invalid input.
Chris@0:     $this->assertTrue($this->container->get('module_installer')->install(['inline_form_errors'], TRUE), 'Installed inline_form_errors.');
Chris@0:     // Attempt to edit the second node again, as before.
Chris@0:     $this->drupalPostForm('node/' . $node_two->id() . '/edit', $edit, t('Preview'));
Chris@0:     // This error should still be present next to the field.
Chris@0:     $this->assertSession()->pageTextContains(t('The alias is already in use.'), 'Field error found with expected text.');
Chris@0:     // The validation error set for the page should include this text.
Chris@0:     $this->assertSession()->pageTextContains(t('1 error has been found: URL alias'), 'Form error found with expected text.');
Chris@0:     // The text 'URL alias' should be a link.
Chris@0:     $this->assertSession()->linkExists('URL alias');
Chris@0:     // The link should be to the ID of the URL alias field.
Chris@0:     $this->assertSession()->linkByHrefExists('#edit-path-0-alias');
Chris@0:   }
Chris@0: 
Chris@0: }