Add Url.fromLegacyHref()

readium · Sep 28, 2023 · 744793f · 744793f
1 parent 482ab0c
commit 744793f
Show file tree

Hide file tree

Showing 2 changed files with 38 additions and 2 deletions.
diff --git a/readium/shared/src/main/java/org/readium/r2/shared/util/Url.kt b/readium/shared/src/main/java/org/readium/r2/shared/util/Url.kt
@@ -34,6 +34,9 @@ public sealed class Url : Parcelable {
         public fun fromDecodedPath(path: String): RelativeUrl? =
             RelativeUrl(path.percentEncodedPath())
 
+        public fun fromLegacyHref(href: String): Url? =
+            AbsoluteUrl(href) ?: fromDecodedPath(href.removePrefix("/"))
+
         /**
          * Creates a [Url] from its encoded string representation.
          */
@@ -286,7 +289,6 @@ public class RelativeUrl private constructor(override val uri: Uri) : Url() {
         internal operator fun invoke(uri: Uri): RelativeUrl? =
             tryOrNull {
                 require(uri.isRelative)
-                require(uri.isHierarchical)
                 RelativeUrl(uri)
             }
     }

diff --git a/readium/shared/src/test/java/org/readium/r2/shared/util/UrlTest.kt b/readium/shared/src/test/java/org/readium/r2/shared/util/UrlTest.kt
@@ -4,6 +4,8 @@ import android.net.Uri
 import java.io.File
 import java.net.URI
 import java.net.URL
+import kotlin.test.assertIs
+import kotlin.test.assertNotNull
 import org.junit.Assert.assertEquals
 import org.junit.Assert.assertNull
 import org.junit.Test
@@ -34,8 +36,40 @@ class UrlTest {
         assertEquals(RelativeUrl(Uri.parse("foo/bar")), Url("foo/bar"))
         assertEquals(RelativeUrl(Uri.parse("../bar")), Url("../bar"))
 
+        // Special characters valid in a path.
+        assertEquals("$&+,/=@", RelativeUrl("$&+,/=@")?.path)
+
         // Used in the EPUB parser
-        assertEquals(RelativeUrl(Uri.parse("#")), Url("#"))
+        val url = Url("#") as? RelativeUrl
+        assertNotNull(url)
+        assertEquals(null, url.path)
+        assertEquals(null, url.fragment)
+    }
+
+    @Test
+    fun createFromLegacyHref() {
+        testLegacy<RelativeUrl>("dir/chapter.xhtml", "dir/chapter.xhtml")
+        // Starting slash is removed.
+        testLegacy<RelativeUrl>("/dir/chapter.xhtml", "dir/chapter.xhtml")
+        // Special characters are percent-encoded.
+        testLegacy<RelativeUrl>("/dir/per%cent.xhtml", "dir/per%25cent.xhtml")
+        testLegacy<RelativeUrl>("/barré.xhtml", "barr%C3%A9.xhtml")
+        testLegacy<RelativeUrl>("/spa ce.xhtml", "spa%20ce.xhtml")
+        // We assume that a relative path is percent-decoded.
+        testLegacy<RelativeUrl>("/spa%20ce.xhtml", "spa%2520ce.xhtml")
+        // Some special characters are authorized in a path.
+        testLegacy<RelativeUrl>("/$&+,/=@", "$&+,/=@")
+        // Valid absolute URL are left untouched.
+        testLegacy<AbsoluteUrl>("http://domain.com/a%20book?page=3", "http://domain.com/a%20book?page=3")
+        // Invalid absolute URL.
+        assertNull(Url.fromLegacyHref("http://domain.com/a book"))
+    }
+
+    private inline fun <reified T : Url> testLegacy(href: String, expected: String) {
+        val url = Url.fromLegacyHref(href)
+        assertNotNull(url)
+        assertIs<T>(url)
+        assertEquals(expected, url.toString())
     }
 
     @Test