Refactor media type sniffing

.gitignore

@@ -82,4 +82,5 @@ lint/reports/
 docs/readium
 docs/index.md
 docs/package-list
-site/
+site/
+androidTestResultsUserPreferences.xml

readium/lcp/src/main/java/org/readium/r2/lcp/LcpContentProtection.kt

@@ -9,8 +9,11 @@ package org.readium.r2.lcp
 import org.readium.r2.lcp.auth.LcpPassphraseAuthentication
 import org.readium.r2.lcp.license.model.LicenseDocument
 import org.readium.r2.shared.asset.Asset
+import org.readium.r2.shared.asset.AssetRetriever
+import org.readium.r2.shared.asset.AssetType
 import org.readium.r2.shared.error.ThrowableError
 import org.readium.r2.shared.error.Try
+import org.readium.r2.shared.error.flatMap
 import org.readium.r2.shared.error.getOrElse
 import org.readium.r2.shared.publication.Publication
 import org.readium.r2.shared.publication.encryption.encryption
@@ -27,8 +30,7 @@ import org.readium.r2.shared.util.toFile
 internal class LcpContentProtection(
     private val lcpService: LcpService,
     private val authentication: LcpAuthenticating,
-    private val resourceFactory: ResourceFactory,
-    private val archiveFactory: ArchiveFactory
+    private val assetRetriever: AssetRetriever
 ) : ContentProtection {
 
     override val scheme: ContentProtection.Scheme =
@@ -152,15 +154,13 @@ internal class LcpContentProtection(
                 )
             )
 
-        val resource = resourceFactory.create(url)
-            .getOrElse { return Try.failure(it.wrap()) }
-
-        val container = archiveFactory.create(resource, password = null)
-            .getOrElse { return Try.failure(it.wrap()) }
-
-        val publicationAsset = Asset.Container(link.mediaType, exploded = false, container)
-
-        return createResultAsset(publicationAsset, license)
+        return assetRetriever.retrieve(
+            url,
+            mediaType = link.mediaType,
+            assetType = AssetType.Archive
+        )
+            .mapFailure { Publication.OpeningException.ParsingFailed(it) }
+            .flatMap { createResultAsset(it as Asset.Container, license) }
     }
 
     private fun ResourceFactory.Error.wrap(): Publication.OpeningException =

readium/lcp/src/main/java/org/readium/r2/lcp/LcpService.kt

@@ -29,14 +29,11 @@ import org.readium.r2.lcp.service.NetworkService
 import org.readium.r2.lcp.service.PassphrasesRepository
 import org.readium.r2.lcp.service.PassphrasesService
 import org.readium.r2.shared.asset.Asset
+import org.readium.r2.shared.asset.AssetRetriever
 import org.readium.r2.shared.error.Try
 import org.readium.r2.shared.publication.protection.ContentProtection
-import org.readium.r2.shared.resource.ArchiveFactory
-import org.readium.r2.shared.resource.DefaultArchiveFactory
-import org.readium.r2.shared.resource.FileResourceFactory
-import org.readium.r2.shared.resource.ResourceFactory
 import org.readium.r2.shared.util.mediatype.MediaType
-import org.readium.r2.shared.util.mediatype.MediaTypeRetriever
+import org.readium.r2.shared.util.mediatype.MediaTypeSniffer
 
 /**
  * Service used to acquire and open publications protected with LCP.
@@ -159,9 +156,8 @@ public interface LcpService {
          */
         public operator fun invoke(
             context: Context,
-            mediaTypeRetriever: MediaTypeRetriever = MediaTypeRetriever(),
-            resourceFactory: ResourceFactory = FileResourceFactory(),
-            archiveFactory: ArchiveFactory = DefaultArchiveFactory()
+            assetRetriever: AssetRetriever,
+            mediaTypeSniffer: MediaTypeSniffer
         ): LcpService? {
             if (!LcpClient.isAvailable()) {
                 return null
@@ -171,7 +167,7 @@ public interface LcpService {
             val deviceRepository = DeviceRepository(db)
             val passphraseRepository = PassphrasesRepository(db)
             val licenseRepository = LicensesRepository(db)
-            val network = NetworkService(mediaTypeRetriever = mediaTypeRetriever)
+            val network = NetworkService(mediaTypeSniffer)
             val device = DeviceService(
                 repository = deviceRepository,
                 network = network,
@@ -186,18 +182,17 @@ public interface LcpService {
                 network = network,
                 passphrases = passphrases,
                 context = context,
-                mediaTypeRetriever = mediaTypeRetriever,
-                resourceFactory = resourceFactory,
-                archiveFactory = archiveFactory
+                assetRetriever = assetRetriever
             )
         }
 
+        @Suppress("UNUSED_PARAMETER")
         @Deprecated(
             "Use `LcpService()` instead",
-            ReplaceWith("LcpService(context)"),
+            ReplaceWith("LcpService(context, AssetRetriever(), DefaultMediaTypeSniffer())"),
             level = DeprecationLevel.ERROR
         )
-        public fun create(context: Context): LcpService? = invoke(context)
+        public fun create(context: Context): LcpService? = throw NotImplementedError()
     }
 
     @Deprecated(
@@ -235,13 +230,14 @@ public interface LcpService {
     }
 }
 
+@Suppress("UNUSED_PARAMETER")
 @Deprecated(
     "Renamed to `LcpService()`",
     replaceWith = ReplaceWith("LcpService(context)"),
     level = DeprecationLevel.ERROR
 )
 public fun R2MakeLCPService(context: Context): LcpService =
-    LcpService(context) ?: throw Exception("liblcp is missing on the classpath")
+    throw NotImplementedError()
 
 @Deprecated(
     "Renamed to `LcpService.AcquiredPublication`",

readium/lcp/src/main/java/org/readium/r2/lcp/license/model/components/Link.kt

@@ -69,7 +69,7 @@ public data class Link(val json: JSONObject) {
         get() = url(parameters = emptyMap())
 
     val mediaType: MediaType
-        get() = type?.let { MediaType.parse(it) } ?: MediaType.BINARY
+        get() = type?.let { MediaType(it) } ?: MediaType.BINARY
 
     /**
      * List of URI template parameter keys, if the [Link] is templated.

readium/lcp/src/main/java/org/readium/r2/lcp/public/Deprecated.kt

@@ -75,5 +75,6 @@ public typealias LCPError = LcpException
     ReplaceWith("LcpService()"),
     level = DeprecationLevel.ERROR
 )
+@Suppress("UNUSED_PARAMETER")
 public fun R2MakeLCPService(context: Context): LcpService? =
-    LcpService(context)
+    throw NotImplementedError()

readium/lcp/src/main/java/org/readium/r2/lcp/service/LicensesService.kt

@@ -30,13 +30,11 @@ import org.readium.r2.lcp.license.container.LicenseContainer
 import org.readium.r2.lcp.license.container.createLicenseContainer
 import org.readium.r2.lcp.license.model.LicenseDocument
 import org.readium.r2.shared.asset.Asset
+import org.readium.r2.shared.asset.AssetRetriever
 import org.readium.r2.shared.error.Try
 import org.readium.r2.shared.extensions.tryOr
 import org.readium.r2.shared.publication.protection.ContentProtection
-import org.readium.r2.shared.resource.ArchiveFactory
-import org.readium.r2.shared.resource.ResourceFactory
 import org.readium.r2.shared.util.mediatype.MediaType
-import org.readium.r2.shared.util.mediatype.MediaTypeRetriever
 import timber.log.Timber
 
 internal class LicensesService(
@@ -46,17 +44,13 @@ internal class LicensesService(
     private val network: NetworkService,
     private val passphrases: PassphrasesService,
     private val context: Context,
-    private val mediaTypeRetriever: MediaTypeRetriever,
-    private val resourceFactory: ResourceFactory,
-    private val archiveFactory: ArchiveFactory
+    private val assetRetriever: AssetRetriever
 ) : LcpService, CoroutineScope by MainScope() {
 
-    override suspend fun isLcpProtected(file: File): Boolean =
-        tryOr(false) {
-            val mediaType = mediaTypeRetriever.retrieve(file) ?: return false
-            createLicenseContainer(file, mediaType).read()
-            true
-        }
+    override suspend fun isLcpProtected(file: File): Boolean {
+        val asset = assetRetriever.retrieve(file) ?: return false
+        return isLcpProtected(asset)
+    }
 
     override suspend fun isLcpProtected(asset: Asset): Boolean =
         tryOr(false) {
@@ -73,7 +67,7 @@ internal class LicensesService(
     override fun contentProtection(
         authentication: LcpAuthenticating
     ): ContentProtection =
-        LcpContentProtection(this, authentication, resourceFactory, archiveFactory)
+        LcpContentProtection(this, authentication, assetRetriever)
 
     override suspend fun acquirePublication(lcpl: ByteArray, onProgress: (Double) -> Unit): Try<LcpService.AcquiredPublication, LcpException> =
         try {
@@ -251,9 +245,7 @@ internal class LicensesService(
             destination,
             mediaType = link.type,
             onProgress = onProgress
-        )
-            ?: mediaTypeRetriever.retrieve(mediaType = link.type)
-            ?: MediaType.EPUB
+        ) ?: link.mediaType
 
         // Saves the License Document into the downloaded publication
         val container = createLicenseContainer(destination, mediaType)
@@ -266,4 +258,14 @@ internal class LicensesService(
             licenseDocument = license
         )
     }
+
+    private val MediaType.fileExtension: String get() =
+        when {
+            matches(MediaType.DIVINA) -> "divina"
+            matches(MediaType.EPUB) -> "epub"
+            matches(MediaType.LCP_PROTECTED_PDF) -> "pdf"
+            matches(MediaType.READIUM_AUDIOBOOK) -> "audiobook"
+            matches(MediaType.READIUM_WEBPUB) -> "webpub"
+            else -> "epub"
+        }
 }

readium/lcp/src/main/java/org/readium/r2/lcp/service/NetworkService.kt

@@ -21,9 +21,11 @@ import kotlinx.coroutines.Dispatchers
 import kotlinx.coroutines.withContext
 import org.readium.r2.lcp.LcpException
 import org.readium.r2.shared.error.Try
-import org.readium.r2.shared.util.http.retrieve
+import org.readium.r2.shared.format.FormatHints
+import org.readium.r2.shared.util.http.invoke
+import org.readium.r2.shared.util.mediatype.HintMediaTypeSnifferContext
 import org.readium.r2.shared.util.mediatype.MediaType
-import org.readium.r2.shared.util.mediatype.MediaTypeRetriever
+import org.readium.r2.shared.util.mediatype.MediaTypeSniffer
 import timber.log.Timber
 
 internal typealias URLParameters = Map<String, String?>
@@ -34,7 +36,7 @@ internal class NetworkException(val status: Int?, cause: Throwable? = null) : Ex
 )
 
 internal class NetworkService(
-    private val mediaTypeRetriever: MediaTypeRetriever
+    private val mediaTypeSniffer: MediaTypeSniffer
 ) {
     enum class Method(val value: String) {
         GET("GET"), POST("POST"), PUT("PUT");
@@ -138,9 +140,10 @@ internal class NetworkService(
                 }
             }
 
-            mediaTypeRetriever.retrieve(
-                connection = connection,
-                mediaType = mediaType
+            mediaTypeSniffer.sniff(
+                HintMediaTypeSnifferContext(
+                    hints = FormatHints(connection, mediaType = mediaType)
+                )
             )
         } catch (e: Exception) {
             Timber.e(e)

readium/opds/src/main/java/org/readium/r2/opds/OPDS1Parser.kt

@@ -20,7 +20,6 @@ import org.readium.r2.shared.parser.xml.XmlParser
 import org.readium.r2.shared.publication.*
 import org.readium.r2.shared.toJSON
 import org.readium.r2.shared.util.Href
-import org.readium.r2.shared.util.http.DefaultHttpClient
 import org.readium.r2.shared.util.http.HttpClient
 import org.readium.r2.shared.util.http.HttpRequest
 import org.readium.r2.shared.util.http.fetchWithDecoder
@@ -46,15 +45,15 @@ public object Namespaces {
 public class OPDS1Parser {
     public companion object {
 
-        public suspend fun parseUrlString(url: String, client: HttpClient = DefaultHttpClient()): Try<ParseData, Exception> {
+        public suspend fun parseUrlString(url: String, client: HttpClient): Try<ParseData, Exception> {
             return client.fetchWithDecoder(HttpRequest(url)) {
                 this.parse(it.body, URL(url))
             }
         }
 
         public suspend fun parseRequest(
             request: HttpRequest,
-            client: HttpClient = DefaultHttpClient()
+            client: HttpClient
         ): Try<ParseData, Exception> {
             return client.fetchWithDecoder(request) {
                 this.parse(it.body, URL(request.url))
@@ -186,7 +185,7 @@ public class OPDS1Parser {
         }
 
         @Suppress("unused")
-        public suspend fun retrieveOpenSearchTemplate(feed: Feed): Try<String?, Exception> {
+        public suspend fun retrieveOpenSearchTemplate(feed: Feed, client: HttpClient): Try<String?, Exception> {
             var openSearchURL: URL? = null
             var selfMimeType: String? = null
 
@@ -204,7 +203,7 @@ public class OPDS1Parser {
                 return@let it
             }
 
-            return DefaultHttpClient().fetchWithDecoder(HttpRequest(unwrappedURL.toString())) {
+            return client.fetchWithDecoder(HttpRequest(unwrappedURL.toString())) {
                 val document = XmlParser().parse(it.body.inputStream())
 
                 val urls = document.get("Url", Namespaces.Search)

readium/opds/src/main/java/org/readium/r2/opds/OPDS2Parser.kt

@@ -20,7 +20,6 @@ import org.readium.r2.shared.publication.Link
 import org.readium.r2.shared.publication.Manifest
 import org.readium.r2.shared.publication.Publication
 import org.readium.r2.shared.util.Href
-import org.readium.r2.shared.util.http.DefaultHttpClient
 import org.readium.r2.shared.util.http.HttpClient
 import org.readium.r2.shared.util.http.HttpRequest
 import org.readium.r2.shared.util.http.fetchWithDecoder
@@ -39,15 +38,15 @@ public class OPDS2Parser {
 
         private lateinit var feed: Feed
 
-        public suspend fun parseUrlString(url: String, client: HttpClient = DefaultHttpClient()): Try<ParseData, Exception> {
+        public suspend fun parseUrlString(url: String, client: HttpClient): Try<ParseData, Exception> {
             return client.fetchWithDecoder(HttpRequest(url)) {
                 this.parse(it.body, URL(url))
             }
         }
 
         public suspend fun parseRequest(
             request: HttpRequest,
-            client: HttpClient = DefaultHttpClient()
+            client: HttpClient
         ): Try<ParseData, Exception> {
             return client.fetchWithDecoder(request) {
                 this.parse(it.body, URL(request.url))

readium/shared/src/main/java/org/readium/r2/shared/asset/Asset.kt

@@ -6,6 +6,7 @@
 
 package org.readium.r2.shared.asset
 
+import org.readium.r2.shared.resource.Resource as SharedResource
 import org.readium.r2.shared.util.mediatype.MediaType
 
 /**
@@ -14,14 +15,14 @@ import org.readium.r2.shared.util.mediatype.MediaType
 public sealed class Asset {
 
     /**
-     * Media type of the asset.
+     * Type of the asset source.
      */
-    public abstract val mediaType: MediaType
+    public abstract val assetType: AssetType
 
     /**
-     * Type of the asset source.
+     * Media type of the asset.
      */
-    public abstract val assetType: AssetType
+    public abstract val mediaType: MediaType
 
     /**
      * Releases in-memory resources related to this asset.
@@ -36,7 +37,7 @@ public sealed class Asset {
      */
     public class Resource(
         override val mediaType: MediaType,
-        public val resource: org.readium.r2.shared.resource.Resource
+        public val resource: SharedResource
     ) : Asset() {
 
         override val assetType: AssetType =