URL-encode URLs

src/Sitemap/Url/GoogleImage.php

@@ -177,7 +177,7 @@ public function toXML(): string
     {
         $xml = '<image:image>';
 
-        $xml .= '<image:loc>' . Utils::encode($this->getLocation()) . '</image:loc>';
+        $xml .= '<image:loc>' . Utils::encodeUrl($this->getLocation()) . '</image:loc>';
 
         if ($this->getCaption()) {
             $xml .= '<image:caption>' . Utils::cdata($this->getCaption()) . '</image:caption>';

src/Sitemap/Url/GoogleMultilangUrlDecorator.php

@@ -65,7 +65,7 @@ protected function generateLinkXml(string $href, string $hreflang, string $rel =
 
         return '<xhtml:link rel="' . $rel
             . '" hreflang="' . $hreflang
-            . '" href="' . Utils::encode($href) . '" />';
+            . '" href="' . Utils::encodeUrl($href) . '" />';
     }
 
     /**

src/Sitemap/Url/GoogleVideo.php

@@ -941,7 +941,7 @@ public function toXml(): string
 
         //----------------------
         // required fields
-        $videoXml .= '<video:thumbnail_loc>' . Utils::encode($this->getThumbnailLocation()) . '</video:thumbnail_loc>';
+        $videoXml .= '<video:thumbnail_loc>' . Utils::encodeUrl($this->getThumbnailLocation()) . '</video:thumbnail_loc>';
         $videoXml .= '<video:title>' . Utils::cdata($this->getTitle()) . '</video:title>';
         $videoXml .= '<video:description>' . Utils::cdata($this->getDescription()) . '</video:description>';
 
@@ -952,7 +952,7 @@ public function toXml(): string
             $videoXml .= '<video:category>' . Utils::cdata($category) . '</video:category>';
         }
         if ($location = $this->getContentLocation()) {
-            $videoXml .= '<video:content_loc>' . Utils::encode($location) . '</video:content_loc>';
+            $videoXml .= '<video:content_loc>' . Utils::encodeUrl($location) . '</video:content_loc>';
         }
         if ($duration = $this->getDuration()) {
             $videoXml .= '<video:duration>' . $duration . '</video:duration>';

src/Sitemap/Url/UrlConcrete.php

@@ -199,7 +199,7 @@ public function getPriority(): ?float
      */
     public function toXml(): string
     {
-        $xml = '<url><loc>' . Utils::encode($this->getLoc()) . '</loc>';
+        $xml = '<url><loc>' . Utils::encodeUrl($this->getLoc()) . '</loc>';
 
         $lastmod = $this->getLastmod();
         if ($lastmod) {

src/Sitemap/Utils.php

@@ -39,4 +39,44 @@
     {
         return htmlspecialchars($string, ENT_QUOTES | ENT_SUBSTITUTE, 'UTF-8');
     }
+
+    /**
+     * Encode URL
+     *
+     * @param string $string
+     *
+     * @return string
+     */
+    public static function encodeUrl(string $url): string
+    {
+        $parts = parse_url($url);
+
+        // Optional but we only sanitize URLs with scheme and host defined
+        if ($parts === false || empty($parts['scheme']) || empty($parts['host'])) {
+            return $url;
+        }
+
+        $sanitizedPath = null;
+        if (!empty($parts['path'])) {
+            $pathParts = explode('/', $parts['path']);
+            foreach ($pathParts as $pathPart) {
+                if (empty($pathPart)) {
+                    continue;
+                }
+                // The Path part might already be urlencoded
+                $sanitizedPath .= '/'.rawurlencode(rawurldecode($pathPart));
+            }
+        }
+
+        // Build the url
+        $targetUrl = $parts['scheme'].'://'.
+            ((!empty($parts['user']) && !empty($parts['pass'])) ? $parts['user'].':'.$parts['pass'].'@' : '').
+            $parts['host'].
+            (!empty($parts['port']) ? ':'.$parts['port'] : '').
+            (!empty($sanitizedPath) ? $sanitizedPath : '').
+            (!empty($parts['query']) ? '?'.self::encode($parts['query']) : '').
+            (!empty($parts['fragment']) ? '#'.$parts['fragment'] : '');
+
+        return $targetUrl;
+    }
 }

tests/Unit/Sitemap/Url/UrlConcreteTest.php

@@ -31,6 +31,8 @@ public function toXmlProvider(): array
             ['<url><loc>http://example.com/</loc></url>', 'http://example.com/'],
             ['<url><loc>http://example.com/abcd</loc></url>', 'http://example.com/abcd'],
             ['<url><loc>http://example.com/abcd/?a=1&amp;b=cdf</loc></url>', 'http://example.com/abcd/?a=1&b=cdf'],
+            ['<url><loc>http://example.com/%C3%A4</loc></url>', 'http://example.com/ä'],
+            ['<url><loc>http://example.com/folder/%C3%A4</loc></url>', 'http://example.com/folder/ä'],
             [
                 '<url><loc>http://example.com/</loc><lastmod>2012-12-29T10:39:12+00:00</lastmod></url>',
                 'http://example.com/',

tests/Unit/Sitemap/UtilsTest.php

@@ -27,4 +27,10 @@ public function testEncode(): void
         $actual = Utils::encode('data & spécial chars>');
         self::assertEquals('data & spécial chars>', $actual);
     }
+
+    public function testEncodeUrl(): void
+    {
+        $actual = Utils::encodeUrl('http://example.org/test_ä');
+        self::assertEquals('http://example.org/test_%C3%A4', $actual);
+    }
 }