Replace the Fetcher by Container and refactor media type sniffing

.gitignore

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

CHANGELOG.md

@@ -26,6 +26,11 @@ All notable changes to this project will be documented in this file. Take a look
 
 * Readium resources are now prefixed with `readium_`. Take care of updating any overridden resource by following [the migration guide](docs/migration-guide.md#300).
 
+#### Shared
+
+* `Publication.localizedTitle` is nullable, as we cannot guarantee that all publication sources offer a title.
+* The `MediaType` sniffing helpers are deprecated in favor of `MediaTypeRetriever` (for media type and file extension hints and raw content) and `AssetRetriever` (for URLs). 
+
 #### Navigator
 
 * `EpubNavigatorFragment.firstVisibleElementLocator()` now returns the first *block* element that is visible on the screen, even if it starts on previous pages.
@@ -39,6 +44,10 @@ All notable changes to this project will be documented in this file. Take a look
 
 * All the navigator `Activity` are deprecated in favor of the `Fragment` variants.
 
+#### Streamer
+
+* The `Fetcher` interface was deprecated in favor of the `Container` one in `readium-shared`.
+
 ### Fixed
 
 #### Navigator

readium/adapters/pdfium/pdfium-document/src/main/java/org/readium/adapters/pdfium/document/PdfiumDocument.kt

@@ -19,9 +19,10 @@ import org.readium.r2.shared.InternalReadiumApi
 import org.readium.r2.shared.error.getOrThrow
 import org.readium.r2.shared.extensions.md5
 import org.readium.r2.shared.extensions.tryOrNull
-import org.readium.r2.shared.fetcher.Fetcher
+import org.readium.r2.shared.resource.Resource
 import org.readium.r2.shared.util.pdf.PdfDocument
 import org.readium.r2.shared.util.pdf.PdfDocumentFactory
+import org.readium.r2.shared.util.toFile
 import org.readium.r2.shared.util.use
 import timber.log.Timber
 
@@ -87,26 +88,29 @@ public class PdfiumDocumentFactory(context: Context) : PdfDocumentFactory<Pdfium
     override suspend fun open(file: File, password: String?): PdfiumDocument =
         core.fromFile(file, password)
 
-    override suspend fun open(resource: Fetcher.Resource, password: String?): PdfiumDocument {
+    override suspend fun open(resource: Resource, password: String?): PdfiumDocument {
         // First try to open the resource as a file on the FS for performance improvement, as
         // PDFium requires the whole PDF document to be loaded in memory when using raw bytes.
         return resource.openAsFile(password)
             ?: resource.openBytes(password)
     }
 
-    private suspend fun Fetcher.Resource.openAsFile(password: String?): PdfiumDocument? =
-        file?.let {
-            tryOrNull { open(it, password) }
+    private suspend fun Resource.openAsFile(password: String?): PdfiumDocument? =
+        tryOrNull {
+            source?.toFile()?.let { open(it, password) }
         }
 
-    private suspend fun Fetcher.Resource.openBytes(password: String?): PdfiumDocument =
+    private suspend fun Resource.openBytes(password: String?): PdfiumDocument =
         use {
             core.fromBytes(read().getOrThrow(), password)
         }
 
     private fun PdfiumCore.fromFile(file: File, password: String?): PdfiumDocument =
         fromDocument(
-            newDocument(ParcelFileDescriptor.open(file, ParcelFileDescriptor.MODE_READ_ONLY), password),
+            newDocument(
+                ParcelFileDescriptor.open(file, ParcelFileDescriptor.MODE_READ_ONLY),
+                password
+            ),
             identifier = file.md5()
         )
 

readium/adapters/pdfium/pdfium-navigator/src/main/java/org/readium/adapters/pdfium/navigator/PdfiumDefaults.kt

@@ -19,5 +19,5 @@ import org.readium.r2.shared.ExperimentalReadiumApi
 @ExperimentalReadiumApi
 public data class PdfiumDefaults(
     val pageSpacing: Double? = null,
-    val readingProgression: ReadingProgression? = null,
+    val readingProgression: ReadingProgression? = null
 )

readium/adapters/pdfium/pdfium-navigator/src/main/java/org/readium/adapters/pdfium/navigator/PdfiumDocumentFragment.kt

@@ -79,7 +79,6 @@ public class PdfiumDocumentFragment internal constructor(
         val context = context?.applicationContext ?: return
 
         viewLifecycleOwner.lifecycleScope.launch {
-
             try {
                 val document = PdfiumDocumentFactory(context)
                     // PDFium crashes when reusing the same PdfDocument, so we must not cache it.
@@ -141,8 +140,11 @@ public class PdfiumDocumentFragment internal constructor(
     override val pageIndex: Int get() = viewPageIndex ?: initialPageIndex
 
     private val viewPageIndex: Int? get() =
-        if (pdfView.isRecycled) null
-        else convertPageIndexFromView(pdfView.currentPage)
+        if (pdfView.isRecycled) {
+            null
+        } else {
+            convertPageIndexFromView(pdfView.currentPage)
+        }
 
     override fun goToPageIndex(index: Int, animated: Boolean): Boolean {
         if (!isValidPageIndex(index)) {

readium/adapters/pdfium/pdfium-navigator/src/main/java/org/readium/adapters/pdfium/navigator/PdfiumPreferences.kt

@@ -27,7 +27,7 @@ public data class PdfiumPreferences(
     val fit: Fit? = null,
     val pageSpacing: Double? = null,
     val readingProgression: ReadingProgression? = null,
-    val scrollAxis: Axis? = null,
+    val scrollAxis: Axis? = null
 ) : Configurable.Preferences<PdfiumPreferences> {
 
     init {
@@ -40,6 +40,6 @@ public data class PdfiumPreferences(
             fit = other.fit ?: fit,
             pageSpacing = other.pageSpacing ?: pageSpacing,
             readingProgression = other.readingProgression ?: readingProgression,
-            scrollAxis = other.scrollAxis ?: scrollAxis,
+            scrollAxis = other.scrollAxis ?: scrollAxis
         )
 }

readium/adapters/pdfium/pdfium-navigator/src/main/java/org/readium/adapters/pdfium/navigator/PdfiumPreferencesEditor.kt

@@ -22,7 +22,7 @@ import org.readium.r2.shared.publication.Metadata
 public class PdfiumPreferencesEditor internal constructor(
     initialPreferences: PdfiumPreferences,
     publicationMetadata: Metadata,
-    defaults: PdfiumDefaults,
+    defaults: PdfiumDefaults
 ) : PreferencesEditor<PdfiumPreferences> {
 
     private data class State(
@@ -55,7 +55,7 @@ public class PdfiumPreferencesEditor internal constructor(
             getEffectiveValue = { state.settings.fit },
             getIsEffective = { true },
             updateValue = { value -> updateValues { it.copy(fit = value) } },
-            supportedValues = listOf(Fit.CONTAIN, Fit.WIDTH),
+            supportedValues = listOf(Fit.CONTAIN, Fit.WIDTH)
         )
 
     /**
@@ -69,7 +69,7 @@ public class PdfiumPreferencesEditor internal constructor(
             updateValue = { value -> updateValues { it.copy(pageSpacing = value) } },
             supportedRange = 0.0..50.0,
             progressionStrategy = DoubleIncrement(5.0),
-            valueFormatter = { "${it.format(1)} dp" },
+            valueFormatter = { "${it.format(1)} dp" }
         )
 
     /**
@@ -81,7 +81,7 @@ public class PdfiumPreferencesEditor internal constructor(
             getEffectiveValue = { state.settings.readingProgression },
             getIsEffective = { true },
             updateValue = { value -> updateValues { it.copy(readingProgression = value) } },
-            supportedValues = listOf(ReadingProgression.LTR, ReadingProgression.RTL),
+            supportedValues = listOf(ReadingProgression.LTR, ReadingProgression.RTL)
         )
 
     /**
@@ -93,7 +93,7 @@ public class PdfiumPreferencesEditor internal constructor(
             getEffectiveValue = { state.settings.scrollAxis },
             getIsEffective = { true },
             updateValue = { value -> updateValues { it.copy(scrollAxis = value) } },
-            supportedValues = listOf(Axis.VERTICAL, Axis.HORIZONTAL),
+            supportedValues = listOf(Axis.VERTICAL, Axis.HORIZONTAL)
         )
 
     private fun updateValues(updater: (PdfiumPreferences) -> PdfiumPreferences) {

readium/adapters/pdfium/pdfium-navigator/src/main/java/org/readium/adapters/pdfium/navigator/PdfiumPreferencesFilters.kt

@@ -17,7 +17,7 @@ public object PdfiumSharedPreferencesFilter : PreferencesFilter<PdfiumPreference
 
     override fun filter(preferences: PdfiumPreferences): PdfiumPreferences =
         preferences.copy(
-            readingProgression = null,
+            readingProgression = null
         )
 }
 
@@ -29,6 +29,6 @@ public object PdfiumPublicationPreferencesFilter : PreferencesFilter<PdfiumPrefe
 
     override fun filter(preferences: PdfiumPreferences): PdfiumPreferences =
         PdfiumPreferences(
-            readingProgression = preferences.readingProgression,
+            readingProgression = preferences.readingProgression
         )
 }

readium/adapters/pdfium/pdfium-navigator/src/main/java/org/readium/adapters/pdfium/navigator/PdfiumSettings.kt

@@ -19,5 +19,5 @@ public data class PdfiumSettings(
     val fit: Fit,
     val pageSpacing: Double,
     val readingProgression: ReadingProgression,
-    val scrollAxis: Axis,
+    val scrollAxis: Axis
 ) : Configurable.Settings

readium/adapters/pdfium/pdfium-navigator/src/main/java/org/readium/adapters/pdfium/navigator/PdfiumSettingsResolver.kt

@@ -48,7 +48,7 @@ internal class PdfiumSettingsResolver(
             fit = fit,
             pageSpacing = pageSpacing,
             readingProgression = readingProgression,
-            scrollAxis = scrollAxis,
+            scrollAxis = scrollAxis
         )
     }
 }

readium/adapters/pspdfkit/pspdfkit-document/src/main/java/org/readium/adapters/pspdfkit/document/PsPdfKitDocument.kt

@@ -19,8 +19,8 @@ import java.io.File
 import kotlin.reflect.KClass
 import kotlinx.coroutines.Dispatchers
 import kotlinx.coroutines.withContext
-import org.readium.r2.shared.fetcher.Fetcher
 import org.readium.r2.shared.publication.ReadingProgression
+import org.readium.r2.shared.resource.Resource
 import org.readium.r2.shared.util.pdf.PdfDocument
 import org.readium.r2.shared.util.pdf.PdfDocumentFactory
 import timber.log.Timber
@@ -33,7 +33,7 @@ public class PsPdfKitDocumentFactory(context: Context) : PdfDocumentFactory<PsPd
     override suspend fun open(file: File, password: String?): PsPdfKitDocument =
         open(context, DocumentSource(file.toUri(), password))
 
-    override suspend fun open(resource: Fetcher.Resource, password: String?): PsPdfKitDocument =
+    override suspend fun open(resource: Resource, password: String?): PsPdfKitDocument =
         open(context, DocumentSource(ResourceDataProvider(resource), password))
 
     private suspend fun open(context: Context, documentSource: DocumentSource): PsPdfKitDocument =

readium/adapters/pspdfkit/pspdfkit-document/src/main/java/org/readium/adapters/pspdfkit/document/ResourceDataProvider.kt

@@ -10,14 +10,13 @@ import com.pspdfkit.document.providers.DataProvider
 import java.util.*
 import kotlinx.coroutines.runBlocking
 import org.readium.r2.shared.error.getOrElse
-import org.readium.r2.shared.fetcher.Fetcher
-import org.readium.r2.shared.fetcher.synchronized
 import org.readium.r2.shared.resource.Resource
+import org.readium.r2.shared.resource.synchronized
 import org.readium.r2.shared.util.isLazyInitialized
 import timber.log.Timber
 
 internal class ResourceDataProvider(
-    resource: Fetcher.Resource,
+    resource: Resource,
     private val onResourceError: (Resource.Exception) -> Unit = { Timber.e(it) }
 ) : DataProvider {
 

readium/adapters/pspdfkit/pspdfkit-navigator/src/main/java/org/readium/adapters/pspdfkit/navigator/PsPdfKitDefaults.kt

@@ -23,5 +23,5 @@ public data class PsPdfKitDefaults(
     val pageSpacing: Double? = null,
     val readingProgression: ReadingProgression? = null,
     val scroll: Boolean? = null,
-    val spread: Spread? = null,
+    val spread: Spread? = null
 )

readium/adapters/pspdfkit/pspdfkit-navigator/src/main/java/org/readium/adapters/pspdfkit/navigator/PsPdfKitDocumentFragment.kt

@@ -123,8 +123,11 @@ internal class PsPdfKitDocumentFragment(
             .pagePadding(settings.pageSpacing.roundToInt())
             .restoreLastViewedPage(false)
             .scrollDirection(
-                if (!settings.scroll) PageScrollDirection.HORIZONTAL
-                else settings.scrollAxis.scrollDirection
+                if (!settings.scroll) {
+                    PageScrollDirection.HORIZONTAL
+                } else {
+                    settings.scrollAxis.scrollDirection
+                }
             )
             .scrollMode(settings.scroll.scrollMode)
             .scrollOnEdgeTapEnabled(false)
@@ -185,7 +188,9 @@ internal class PsPdfKitDocumentFragment(
             if (
                 pagePosition == null || clickedAnnotation is LinkAnnotation ||
                 clickedAnnotation is SoundAnnotation
-            ) return false
+            ) {
+                return false
+            }
 
             pdfFragment.viewProjection.toViewPoint(pagePosition, pageIndex)
             return listener?.onTap(pagePosition) ?: false

readium/adapters/pspdfkit/pspdfkit-navigator/src/main/java/org/readium/adapters/pspdfkit/navigator/PsPdfKitEngineProvider.kt

@@ -34,7 +34,6 @@ public class PsPdfKitEngineProvider(
     override suspend fun createDocumentFragment(
         input: PdfDocumentFragmentInput<PsPdfKitSettings>
     ): PdfDocumentFragment<PsPdfKitSettings> {
-
         val publication = input.publication
         val document = PsPdfKitDocumentFactory(context)
             .cachedIn(publication)

readium/adapters/pspdfkit/pspdfkit-navigator/src/main/java/org/readium/adapters/pspdfkit/navigator/PsPdfKitPreferences.kt

@@ -30,7 +30,7 @@ public data class PsPdfKitPreferences(
     val readingProgression: ReadingProgression? = null,
     val scroll: Boolean? = null,
     val scrollAxis: Axis? = null,
-    val spread: Spread? = null,
+    val spread: Spread? = null
 ) : Configurable.Preferences<PsPdfKitPreferences> {
 
     init {
@@ -46,6 +46,6 @@ public data class PsPdfKitPreferences(
             readingProgression = other.readingProgression ?: readingProgression,
             scroll = other.scroll ?: scroll,
             scrollAxis = other.scrollAxis ?: scrollAxis,
-            spread = other.spread ?: spread,
+            spread = other.spread ?: spread
         )
 }

readium/adapters/pspdfkit/pspdfkit-navigator/src/main/java/org/readium/adapters/pspdfkit/navigator/PsPdfKitPreferencesEditor.kt

@@ -33,7 +33,7 @@ import org.readium.r2.shared.publication.Metadata
 public class PsPdfKitPreferencesEditor internal constructor(
     initialPreferences: PsPdfKitPreferences,
     publicationMetadata: Metadata,
-    defaults: PsPdfKitDefaults,
+    defaults: PsPdfKitDefaults
 ) : PreferencesEditor<PsPdfKitPreferences> {
 
     private data class State(
@@ -66,7 +66,7 @@ public class PsPdfKitPreferencesEditor internal constructor(
             getEffectiveValue = { state.settings.fit },
             getIsEffective = { true },
             updateValue = { value -> updateValues { it.copy(fit = value) } },
-            supportedValues = listOf(Fit.CONTAIN, Fit.WIDTH),
+            supportedValues = listOf(Fit.CONTAIN, Fit.WIDTH)
         )
 
     /**
@@ -81,7 +81,7 @@ public class PsPdfKitPreferencesEditor internal constructor(
             getValue = { preferences.offsetFirstPage },
             getEffectiveValue = { state.settings.offsetFirstPage },
             getIsEffective = { !state.settings.scroll && state.settings.spread != Spread.NEVER },
-            updateValue = { value -> updateValues { it.copy(offsetFirstPage = value) } },
+            updateValue = { value -> updateValues { it.copy(offsetFirstPage = value) } }
         )
 
     /**
@@ -95,7 +95,7 @@ public class PsPdfKitPreferencesEditor internal constructor(
             updateValue = { value -> updateValues { it.copy(pageSpacing = value) } },
             supportedRange = 0.0..50.0,
             progressionStrategy = DoubleIncrement(5.0),
-            valueFormatter = { "${it.format(1)} dp" },
+            valueFormatter = { "${it.format(1)} dp" }
         )
 
     /**
@@ -107,7 +107,7 @@ public class PsPdfKitPreferencesEditor internal constructor(
             getEffectiveValue = { state.settings.readingProgression },
             getIsEffective = { true },
             updateValue = { value -> updateValues { it.copy(readingProgression = value) } },
-            supportedValues = listOf(ReadingProgression.LTR, ReadingProgression.RTL),
+            supportedValues = listOf(ReadingProgression.LTR, ReadingProgression.RTL)
         )
 
     /**
@@ -118,7 +118,7 @@ public class PsPdfKitPreferencesEditor internal constructor(
             getValue = { preferences.scroll },
             getEffectiveValue = { state.settings.scroll },
             getIsEffective = { true },
-            updateValue = { value -> updateValues { it.copy(scroll = value) } },
+            updateValue = { value -> updateValues { it.copy(scroll = value) } }
         )
 
     /**
@@ -132,7 +132,7 @@ public class PsPdfKitPreferencesEditor internal constructor(
             getEffectiveValue = { state.settings.scrollAxis },
             getIsEffective = { state.settings.scroll },
             updateValue = { value -> updateValues { it.copy(scrollAxis = value) } },
-            supportedValues = listOf(Axis.VERTICAL, Axis.HORIZONTAL),
+            supportedValues = listOf(Axis.VERTICAL, Axis.HORIZONTAL)
         )
 
     /**
@@ -146,7 +146,7 @@ public class PsPdfKitPreferencesEditor internal constructor(
             getEffectiveValue = { state.settings.spread },
             getIsEffective = { !state.settings.scroll },
             updateValue = { value -> updateValues { it.copy(spread = value) } },
-            supportedValues = listOf(Spread.AUTO, Spread.NEVER, Spread.ALWAYS),
+            supportedValues = listOf(Spread.AUTO, Spread.NEVER, Spread.ALWAYS)
         )
 
     private fun updateValues(updater: (PsPdfKitPreferences) -> PsPdfKitPreferences) {

readium/adapters/pspdfkit/pspdfkit-navigator/src/main/java/org/readium/adapters/pspdfkit/navigator/PsPdfKitPreferencesFilters.kt

@@ -19,7 +19,7 @@ public object PsPdfKitSharedPreferencesFilter : PreferencesFilter<PsPdfKitPrefer
         preferences.copy(
             readingProgression = null,
             offsetFirstPage = null,
-            spread = null,
+            spread = null
         )
 }
 
@@ -33,6 +33,6 @@ public object PsPdfKitPublicationPreferencesFilter : PreferencesFilter<PsPdfKitP
         PsPdfKitPreferences(
             readingProgression = preferences.readingProgression,
             offsetFirstPage = preferences.offsetFirstPage,
-            spread = preferences.spread,
+            spread = preferences.spread
         )
 }

readium/adapters/pspdfkit/pspdfkit-navigator/src/main/java/org/readium/adapters/pspdfkit/navigator/PsPdfKitSettings.kt

@@ -22,5 +22,5 @@ public data class PsPdfKitSettings(
     val readingProgression: ReadingProgression,
     val scroll: Boolean,
     val scrollAxis: Axis,
-    val spread: Spread,
+    val spread: Spread
 ) : Configurable.Settings