comparison core/tests/Drupal/Tests/Component/Utility/UrlHelperTest.php @ 0:4c8ae668cc8c

Initial import (non-working)

+<?php
+
+namespace Drupal\Tests\Component\Utility;
+
+use Drupal\Component\Utility\UrlHelper;
+use PHPUnit\Framework\TestCase;
+
+/**
+ * @group Utility
+ *
+ * @coversDefaultClass \Drupal\Component\Utility\UrlHelper
+ */
+class UrlHelperTest extends TestCase {
+
+  /**
+   * Provides test data for testBuildQuery().
+   *
+   * @return array
+   */
+  public function providerTestBuildQuery() {
+    return [
+      [['a' => ' &#//+%20@۞'], 'a=%20%26%23//%2B%2520%40%DB%9E', 'Value was properly encoded.'],
+      [[' &#//+%20@۞' => 'a'], '%20%26%23%2F%2F%2B%2520%40%DB%9E=a', 'Key was properly encoded.'],
+      [['a' => '1', 'b' => '2', 'c' => '3'], 'a=1&b=2&c=3', 'Multiple values were properly concatenated.'],
+      [['a' => ['b' => '2', 'c' => '3'], 'd' => 'foo'], 'a%5Bb%5D=2&a%5Bc%5D=3&d=foo', 'Nested array was properly encoded.'],
+      [['foo' => NULL], 'foo', 'Simple parameters are properly added.'],
+    ];
+  }
+
+  /**
+   * Tests query building.
+   *
+   * @dataProvider providerTestBuildQuery
+   * @covers ::buildQuery
+   *
+   * @param array $query
+   *   The array of query parameters.
+   * @param string $expected
+   *   The expected query string.
+   * @param string $message
+   *   The assertion message.
+   */
+  public function testBuildQuery($query, $expected, $message) {
+    $this->assertEquals(UrlHelper::buildQuery($query), $expected, $message);
+  }
+
+  /**
+   * Data provider for testValidAbsolute().
+   *
+   * @return array
+   */
+  public function providerTestValidAbsoluteData() {
+    $urls = [
+      'example.com',
+      'www.example.com',
+      'ex-ample.com',
+      '3xampl3.com',
+      'example.com/parenthesis',
+      'example.com/index.html#pagetop',
+      'example.com:8080',
+      'subdomain.example.com',
+      'example.com/index.php/node',
+      'example.com/index.php/node?param=false',
+      '[e-mail]',
+      'user:[e-mail]:8080/login.php?do=login&style=%23#pagetop',
+      '127.0.0.1',
+      'example.org?',
+      'john%20doe:secret:[e-mail]/',
+      'example.org/~,$\'*;',
+      'caf%C3%A9.example.org',
+      '[FEDC:BA98:7654:3210:FEDC:BA98:7654:3210]:80/index.html',
+    ];
+
+    return $this->dataEnhanceWithScheme($urls);
+  }
+
+  /**
+   * Tests valid absolute URLs.
+   *
+   * @dataProvider providerTestValidAbsoluteData
+   * @covers ::isValid
+   *
+   * @param string $url
+   *   The url to test.
+   * @param string $scheme
+   *   The scheme to test.
+   */
+  public function testValidAbsolute($url, $scheme) {
+    $test_url = $scheme . '://' . $url;
+    $valid_url = UrlHelper::isValid($test_url, TRUE);
+    $this->assertTrue($valid_url, $test_url . ' is a valid URL.');
+  }
+
+  /**
+   * Provides data for testInvalidAbsolute().
+   *
+   * @return array
+   */
+  public function providerTestInvalidAbsolute() {
+    $data = [
+      '',
+      'ex!ample.com',
+      'ex%ample.com',
+    ];
+    return $this->dataEnhanceWithScheme($data);
+  }
+
+  /**
+   * Tests invalid absolute URLs.
+   *
+   * @dataProvider providerTestInvalidAbsolute
+   * @covers ::isValid
+   *
+   * @param string $url
+   *   The url to test.
+   * @param string $scheme
+   *   The scheme to test.
+   */
+  public function testInvalidAbsolute($url, $scheme) {
+    $test_url = $scheme . '://' . $url;
+    $valid_url = UrlHelper::isValid($test_url, TRUE);
+    $this->assertFalse($valid_url, $test_url . ' is NOT a valid URL.');
+  }
+
+  /**
+   * Provides data for testValidRelative().
+   *
+   * @return array
+   */
+  public function providerTestValidRelativeData() {
+    $data = [
+      'paren(the)sis',
+      'index.html#pagetop',
+      'index.php/node',
+      'index.php/node?param=false',
+      'login.php?do=login&style=%23#pagetop',
+    ];
+
+    return $this->dataEnhanceWithPrefix($data);
+  }
+
+  /**
+   * Tests valid relative URLs.
+   *
+   * @dataProvider providerTestValidRelativeData
+   * @covers ::isValid
+   *
+   * @param string $url
+   *   The url to test.
+   * @param string $prefix
+   *   The prefix to test.
+   */
+  public function testValidRelative($url, $prefix) {
+    $test_url = $prefix . $url;
+    $valid_url = UrlHelper::isValid($test_url);
+    $this->assertTrue($valid_url, $test_url . ' is a valid URL.');
+  }
+
+  /**
+   * Provides data for testInvalidRelative().
+   *
+   * @return array
+   */
+  public function providerTestInvalidRelativeData() {
+    $data = [
+      'ex^mple',
+      'example<>',
+      'ex%ample',
+    ];
+    return $this->dataEnhanceWithPrefix($data);
+  }
+
+  /**
+   * Tests invalid relative URLs.
+   *
+   * @dataProvider providerTestInvalidRelativeData
+   * @covers ::isValid
+   *
+   * @param string $url
+   *   The url to test.
+   * @param string $prefix
+   *   The prefix to test.
+   */
+  public function testInvalidRelative($url, $prefix) {
+    $test_url = $prefix . $url;
+    $valid_url = UrlHelper::isValid($test_url);
+    $this->assertFalse($valid_url, $test_url . ' is NOT a valid URL.');
+  }
+
+  /**
+   * Tests query filtering.
+   *
+   * @dataProvider providerTestFilterQueryParameters
+   * @covers ::filterQueryParameters
+   *
+   * @param array $query
+   *   The array of query parameters.
+   * @param array $exclude
+   *   A list of $query array keys to remove. Use "parent[child]" to exclude
+   *   nested items.
+   * @param array $expected
+   *   An array containing query parameters.
+   */
+  public function testFilterQueryParameters($query, $exclude, $expected) {
+    $filtered = UrlHelper::filterQueryParameters($query, $exclude);
+    $this->assertEquals($expected, $filtered, 'The query was not properly filtered.');
+  }
+
+  /**
+   * Provides data to self::testFilterQueryParameters().
+   *
+   * @return array
+   */
+  public static function providerTestFilterQueryParameters() {
+    return [
+      // Test without an exclude filter.
+      [
+        'query' => ['a' => ['b' => 'c']],
+        'exclude' => [],
+        'expected' => ['a' => ['b' => 'c']],
+      ],
+      // Exclude the 'b' element.
+      [
+        'query' => ['a' => ['b' => 'c', 'd' => 'e']],
+        'exclude' => ['a[b]'],
+        'expected' => ['a' => ['d' => 'e']],
+      ],
+    ];
+  }
+
+  /**
+   * Tests url parsing.
+   *
+   * @dataProvider providerTestParse
+   * @covers ::parse
+   *
+   * @param string $url
+   *   URL to test.
+   * @param array $expected
+   *   Associative array with expected parameters.
+   */
+  public function testParse($url, $expected) {
+    $parsed = UrlHelper::parse($url);
+    $this->assertEquals($expected, $parsed, 'The URL was not properly parsed.');
+  }
+
+  /**
+   * Provides data for self::testParse().
+   *
+   * @return array
+   */
+  public static function providerTestParse() {
+    return [
+      [
+        'http://www.example.com/my/path',
+        [
+          'path' => 'http://www.example.com/my/path',
+          'query' => [],
+          'fragment' => '',
+        ],
+      ],
+      [
+        'http://www.example.com/my/path?destination=home#footer',
+        [
+          'path' => 'http://www.example.com/my/path',
+          'query' => [
+            'destination' => 'home',
+          ],
+          'fragment' => 'footer',
+        ],
+      ],
+      'absolute fragment, no query' => [
+        'http://www.example.com/my/path#footer',
+        [
+          'path' => 'http://www.example.com/my/path',
+          'query' => [],
+          'fragment' => 'footer',
+        ],
+      ],
+      [
+        'http://',
+        [
+          'path' => '',
+          'query' => [],
+          'fragment' => '',
+        ],
+      ],
+      [
+        'https://',
+        [
+          'path' => '',
+          'query' => [],
+          'fragment' => '',
+        ],
+      ],
+      [
+        '/my/path?destination=home#footer',
+        [
+          'path' => '/my/path',
+          'query' => [
+            'destination' => 'home',
+          ],
+          'fragment' => 'footer',
+        ],
+      ],
+      'relative fragment, no query' => [
+        '/my/path#footer',
+        [
+          'path' => '/my/path',
+          'query' => [],
+          'fragment' => 'footer',
+        ],
+      ],
+    ];
+  }
+
+  /**
+   * Tests path encoding.
+   *
+   * @dataProvider providerTestEncodePath
+   * @covers ::encodePath
+   *
+   * @param string $path
+   *   A path to encode.
+   * @param string $expected
+   *   The expected encoded path.
+   */
+  public function testEncodePath($path, $expected) {
+    $encoded = UrlHelper::encodePath($path);
+    $this->assertEquals($expected, $encoded);
+  }
+
+  /**
+   * Provides data for self::testEncodePath().
+   *
+   * @return array
+   */
+  public static function providerTestEncodePath() {
+    return [
+      ['unencoded path with spaces', 'unencoded%20path%20with%20spaces'],
+      ['slashes/should/be/preserved', 'slashes/should/be/preserved'],
+    ];
+  }
+
+  /**
+   * Tests external versus internal paths.
+   *
+   * @dataProvider providerTestIsExternal
+   * @covers ::isExternal
+   *
+   * @param string $path
+   *   URL or path to test.
+   * @param bool $expected
+   *   Expected result.
+   */
+  public function testIsExternal($path, $expected) {
+    $isExternal = UrlHelper::isExternal($path);
+    $this->assertEquals($expected, $isExternal);
+  }
+
+  /**
+   * Provides data for self::testIsExternal().
+   *
+   * @return array
+   */
+  public static function providerTestIsExternal() {
+    return [
+      ['/internal/path', FALSE],
+      ['https://example.com/external/path', TRUE],
+      ['javascript://fake-external-path', FALSE],
+      // External URL without an explicit protocol.
+      ['//www.drupal.org/foo/bar?foo=bar&bar=baz&baz#foo', TRUE],
+      // Internal URL starting with a slash.
+      ['/www.drupal.org', FALSE],
+      // Simple external URLs.
+      ['http://example.com', TRUE],
+      ['https://example.com', TRUE],
+      ['http://drupal.org/foo/bar?foo=bar&bar=baz&baz#foo', TRUE],
+      ['//drupal.org', TRUE],
+      // Some browsers ignore or strip leading control characters.
+      ["\x00//www.example.com", TRUE],
+      ["\x08//www.example.com", TRUE],
+      ["\x1F//www.example.com", TRUE],
+      ["\n//www.example.com", TRUE],
+      // JSON supports decoding directly from UTF-8 code points.
+      [json_decode('"\u00AD"') . "//www.example.com", TRUE],
+      [json_decode('"\u200E"') . "//www.example.com", TRUE],
+      [json_decode('"\uE0020"') . "//www.example.com", TRUE],
+      [json_decode('"\uE000"') . "//www.example.com", TRUE],
+      // Backslashes should be normalized to forward.
+      ['\\\\example.com', TRUE],
+      // Local URLs.
+      ['node', FALSE],
+      ['/system/ajax', FALSE],
+      ['?q=foo:bar', FALSE],
+      ['node/edit:me', FALSE],
+      ['/drupal.org', FALSE],
+      ['<front>', FALSE],
+    ];
+  }
+
+  /**
+   * Tests bad protocol filtering and escaping.
+   *
+   * @dataProvider providerTestFilterBadProtocol
+   * @covers ::setAllowedProtocols
+   * @covers ::filterBadProtocol
+   *
+   * @param string $uri
+   *   Protocol URI.
+   * @param string $expected
+   *   Expected escaped value.
+   * @param array $protocols
+   *   Protocols to allow.
+   */
+  public function testFilterBadProtocol($uri, $expected, $protocols) {
+    UrlHelper::setAllowedProtocols($protocols);
+    $this->assertEquals($expected, UrlHelper::filterBadProtocol($uri));
+    // Multiple calls to UrlHelper::filterBadProtocol() do not cause double
+    // escaping.
+    $this->assertEquals($expected, UrlHelper::filterBadProtocol(UrlHelper::filterBadProtocol($uri)));
+  }
+
+  /**
+   * Provides data for self::testTestFilterBadProtocol().
+   *
+   * @return array
+   */
+  public static function providerTestFilterBadProtocol() {
+    return [
+      ['javascript://example.com?foo&bar', '//example.com?foo&amp;bar', ['http', 'https']],
+      // Test custom protocols.
+      ['http://example.com?foo&bar', '//example.com?foo&amp;bar', ['https']],
+      // Valid protocol.
+      ['http://example.com?foo&bar', 'http://example.com?foo&amp;bar', ['https', 'http']],
+      // Colon not part of the URL scheme.
+      ['/test:8888?foo&bar', '/test:8888?foo&amp;bar', ['http']],
+    ];
+  }
+
+  /**
+   * Tests dangerous url protocol filtering.
+   *
+   * @dataProvider providerTestStripDangerousProtocols
+   * @covers ::setAllowedProtocols
+   * @covers ::stripDangerousProtocols
+   *
+   * @param string $uri
+   *   Protocol URI.
+   * @param string $expected
+   *   Expected escaped value.
+   * @param array $protocols
+   *   Protocols to allow.
+   */
+  public function testStripDangerousProtocols($uri, $expected, $protocols) {
+    UrlHelper::setAllowedProtocols($protocols);
+    $stripped = UrlHelper::stripDangerousProtocols($uri);
+    $this->assertEquals($expected, $stripped);
+  }
+
+  /**
+   * Provides data for self::testStripDangerousProtocols().
+   *
+   * @return array
+   */
+  public static function providerTestStripDangerousProtocols() {
+    return [
+      ['javascript://example.com', '//example.com', ['http', 'https']],
+      // Test custom protocols.
+      ['http://example.com', '//example.com', ['https']],
+      // Valid protocol.
+      ['http://example.com', 'http://example.com', ['https', 'http']],
+      // Colon not part of the URL scheme.
+      ['/test:8888', '/test:8888', ['http']],
+    ];
+  }
+
+  /**
+   * Enhances test urls with schemes
+   *
+   * @param array $urls
+   *   The list of urls.
+   *
+   * @return array
+   *   A list of provider data with schemes.
+   */
+  protected function dataEnhanceWithScheme(array $urls) {
+    $url_schemes = ['http', 'https', 'ftp'];
+    $data = [];
+    foreach ($url_schemes as $scheme) {
+      foreach ($urls as $url) {
+        $data[] = [$url, $scheme];
+      }
+    }
+    return $data;
+  }
+
+  /**
+   * Enhances test urls with prefixes.
+   *
+   * @param array $urls
+   *   The list of urls.
+   *
+   * @return array
+   *   A list of provider data with prefixes.
+   */
+  protected function dataEnhanceWithPrefix(array $urls) {
+    $prefixes = ['', '/'];
+    $data = [];
+    foreach ($prefixes as $prefix) {
+      foreach ($urls as $url) {
+        $data[] = [$url, $prefix];
+      }
+    }
+    return $data;
+  }
+
+  /**
+   * Test detecting external urls that point to local resources.
+   *
+   * @param string $url
+   *   The external url to test.
+   * @param string $base_url
+   *   The base url.
+   * @param bool $expected
+   *   TRUE if an external URL points to this installation as determined by the
+   *   base url.
+   *
+   * @covers ::externalIsLocal
+   * @dataProvider providerTestExternalIsLocal
+   */
+  public function testExternalIsLocal($url, $base_url, $expected) {
+    $this->assertSame($expected, UrlHelper::externalIsLocal($url, $base_url));
+  }
+
+  /**
+   * Provider for local external url detection.
+   *
+   * @see \Drupal\Tests\Component\Utility\UrlHelperTest::testExternalIsLocal()
+   */
+  public function providerTestExternalIsLocal() {
+    return [
+      // Different mixes of trailing slash.
+      ['http://example.com', 'http://example.com', TRUE],
+      ['http://example.com/', 'http://example.com', TRUE],
+      ['http://example.com', 'http://example.com/', TRUE],
+      ['http://example.com/', 'http://example.com/', TRUE],
+      // Sub directory of site.
+      ['http://example.com/foo', 'http://example.com/', TRUE],
+      ['http://example.com/foo/bar', 'http://example.com/foo', TRUE],
+      ['http://example.com/foo/bar', 'http://example.com/foo/', TRUE],
+      // Different sub-domain.
+      ['http://example.com', 'http://www.example.com/', FALSE],
+      ['http://example.com/', 'http://www.example.com/', FALSE],
+      ['http://example.com/foo', 'http://www.example.com/', FALSE],
+      // Different TLD.
+      ['http://example.com', 'http://example.ca', FALSE],
+      ['http://example.com', 'http://example.ca/', FALSE],
+      ['http://example.com/', 'http://example.ca/', FALSE],
+      ['http://example.com/foo', 'http://example.ca', FALSE],
+      ['http://example.com/foo', 'http://example.ca/', FALSE],
+      // Different site path.
+      ['http://example.com/foo', 'http://example.com/bar', FALSE],
+      ['http://example.com', 'http://example.com/bar', FALSE],
+      ['http://example.com/bar', 'http://example.com/bar/', FALSE],
+    ];
+  }
+
+  /**
+   * Test invalid url arguments.
+   *
+   * @param string $url
+   *   The url to test.
+   * @param string $base_url
+   *   The base url.
+   *
+   * @covers ::externalIsLocal
+   * @dataProvider providerTestExternalIsLocalInvalid
+   */
+  public function testExternalIsLocalInvalid($url, $base_url) {
+    $this->setExpectedException(\InvalidArgumentException::class);
+    UrlHelper::externalIsLocal($url, $base_url);
+  }
+
+  /**
+   * Provides invalid argument data for local external url detection.
+   *
+   * @see \Drupal\Tests\Component\Utility\UrlHelperTest::testExternalIsLocalInvalid()
+   */
+  public function providerTestExternalIsLocalInvalid() {
+    return [
+      ['http://example.com/foo', ''],
+      ['http://example.com/foo', 'bar'],
+      ['http://example.com/foo', 'http://'],
+      // Invalid destination urls.
+      ['', 'http://example.com/foo'],
+      ['bar', 'http://example.com/foo'],
+      ['/bar', 'http://example.com/foo'],
+      ['bar/', 'http://example.com/foo'],
+      ['http://', 'http://example.com/foo'],
+    ];
+  }
+
+}