feature #28035 [DomCrawler] Allow using non-absolute base URIs (javie…

…reguiluz) This PR was squashed before being merged into the 4.2-dev branch (closes #28035). Discussion ---------- [DomCrawler] Allow using non-absolute base URIs | Q | A | ------------- | --- | Branch? | 2.8 | Bug fix? | yes | New feature? | no | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | #12318 | License | MIT | Doc PR | - @xabbuh @stof I implemented in this PR your comments from #12318 Commits ------- 130119f [DomCrawler] Allow using non-absolute base URIs
symfony · Aug 2, 2018 · 924f7f9 · 924f7f9
2 parents fbe4bc1 + 130119f
commit 924f7f9
Show file tree

Hide file tree

Showing 5 changed files with 47 additions and 8 deletions.
diff --git a/src/Symfony/Component/DomCrawler/AbstractUriElement.php b/src/Symfony/Component/DomCrawler/AbstractUriElement.php
@@ -40,15 +40,17 @@ abstract class AbstractUriElement
      *
      * @throws \InvalidArgumentException if the node is not a link
      */
-    public function __construct(\DOMElement $node, string $currentUri, ?string $method = 'GET')
+    public function __construct(\DOMElement $node, string $currentUri = null, ?string $method = 'GET')
     {
-        if (!\in_array(strtolower(substr($currentUri, 0, 4)), array('http', 'file'))) {
-            throw new \InvalidArgumentException(sprintf('Current URI must be an absolute URL ("%s").', $currentUri));
-        }
-
         $this->setNode($node);
         $this->method = $method ? strtoupper($method) : null;
         $this->currentUri = $currentUri;
+
+        $elementUriIsRelative = null === parse_url(trim($this->getRawUri()), PHP_URL_SCHEME);
+        $baseUriIsAbsolute = \in_array(strtolower(substr($this->currentUri, 0, 4)), array('http', 'file'));
+        if ($elementUriIsRelative && !$baseUriIsAbsolute) {
+            throw new \InvalidArgumentException(sprintf('The URL of the element is relative, so you must define its base URI passing an absolute URL to the constructor of the %s class ("%s" was passed).', __CLASS__, $this->currentUri));
+        }
     }
 
     /**

diff --git a/src/Symfony/Component/DomCrawler/CHANGELOG.md b/src/Symfony/Component/DomCrawler/CHANGELOG.md
@@ -1,6 +1,12 @@
 CHANGELOG
 =========
 
+4.2.0
+-----
+
+* The `$currentUri` constructor argument of the `AbstractUriElement`, `Link` and
+  `Image` classes is now optional.
+
 3.1.0
 -----
 

diff --git a/src/Symfony/Component/DomCrawler/Image.php b/src/Symfony/Component/DomCrawler/Image.php
@@ -16,7 +16,7 @@
  */
 class Image extends AbstractUriElement
 {
-    public function __construct(\DOMElement $node, string $currentUri)
+    public function __construct(\DOMElement $node, string $currentUri = null)
     {
         parent::__construct($node, $currentUri, 'GET');
     }

diff --git a/src/Symfony/Component/DomCrawler/Tests/ImageTest.php b/src/Symfony/Component/DomCrawler/Tests/ImageTest.php
@@ -27,6 +27,27 @@ public function testConstructorWithANonImgTag()
         new Image($dom->getElementsByTagName('div')->item(0), 'http://www.example.com/');
     }
 
+    public function testBaseUriIsOptionalWhenImageUrlIsAbsolute()
+    {
+        $dom = new \DOMDocument();
+        $dom->loadHTML('<html><img alt="foo" src="https://example.com/foo" /></html>');
+
+        $image = new Image($dom->getElementsByTagName('img')->item(0));
+        $this->assertSame('https://example.com/foo', $image->getUri());
+    }
+
+    /**
+     * @expectedException \InvalidArgumentException
+     */
+    public function testAbsoluteBaseUriIsMandatoryWhenImageUrlIsRelative()
+    {
+        $dom = new \DOMDocument();
+        $dom->loadHTML('<html><img alt="foo" src="/foo" /></html>');
+
+        $image = new Image($dom->getElementsByTagName('img')->item(0), 'example.com');
+        $image->getUri();
+    }
+
     /**
      * @dataProvider getGetUriTests
      */

diff --git a/src/Symfony/Component/DomCrawler/Tests/LinkTest.php b/src/Symfony/Component/DomCrawler/Tests/LinkTest.php
@@ -27,15 +27,25 @@ public function testConstructorWithANonATag()
         new Link($dom->getElementsByTagName('div')->item(0), 'http://www.example.com/');
     }
 
+    public function testBaseUriIsOptionalWhenLinkUrlIsAbsolute()
+    {
+        $dom = new \DOMDocument();
+        $dom->loadHTML('<html><a href="https://example.com/foo">foo</a></html>');
+
+        $link = new Link($dom->getElementsByTagName('a')->item(0));
+        $this->assertSame('https://example.com/foo', $link->getUri());
+    }
+
     /**
      * @expectedException \InvalidArgumentException
      */
-    public function testConstructorWithAnInvalidCurrentUri()
+    public function testAbsoluteBaseUriIsMandatoryWhenLinkUrlIsRelative()
     {
         $dom = new \DOMDocument();
         $dom->loadHTML('<html><a href="/foo">foo</a></html>');
 
-        new Link($dom->getElementsByTagName('a')->item(0), 'example.com');
+        $link = new Link($dom->getElementsByTagName('a')->item(0), 'example.com');
+        $link->getUri();
     }
 
     public function testGetNode()