[Bug] Streaming publication using LCPL file

[KaramYaaqba]

Describe the bug

I am trying to implement streaming for books and audiobooks using the Readium 3.0 toolkit, following the instructions in the documentation (https://github.com/readium/kotlin-toolkit/blob/develop/docs/guides/lcp.md) under the "Streaming an LCP protected package" section. However, I am getting a "Format Not Supported" error, which does not occur when I load the book from the LCPL file instead of streaming:

org.readium.r2.streamer.PublicationOpener$OpenError$FormatNotSupported@c128feb

Here is the code snippet I am using:

`
suspend fun importPublicationFromStorage(uri: Uri) {
// Instantiate the required components.
val context = app.applicationContext.applicationContext
val httpClient = DefaultHttpClient()
val assetRetriever = AssetRetriever(
contentResolver = context.contentResolver,
httpClient = httpClient
)
val publicationOpener = PublicationOpener(
publicationParser = DefaultPublicationParser(
context,
httpClient = httpClient,
assetRetriever = assetRetriever,
pdfFactory = PdfiumDocumentFactory(context)
)
)
val asset =
assetRetriever.retrieve(uri.toAbsoluteUrl()!!).getOrElse {
null
}

    // Open a `Publication` from the `Asset` which is LCPL file in this case.
    val publication = publicationOpener.open(asset!!, allowUserInteraction = true)
        .getOrElse {
            print("error" + it)
                    }

    print("Opened ${publication}")
}

`

How to reproduce?

1- Load the LCPL file using the provided code.
2- An exception will occur when you do so.

Readium version

3.0

Android API version

35

Additional context

No response

[qnga]

Please try to reproduce this on the testapp (I can't do it). I can help you enable LCP support on Slack if you need it.

[qnga]

Note that you don't pass aLcpContentProtection to the PublicationOpener, which is likely to result in a FormatNotSupported error, but that should happen when you open a downloaded book too.

NB: I agree that the documentation is a bit misleading, we'll fix it.

[KaramYaaqba]

@qnga I need your help to enable LCP streaming, what is the best way to connect with you on Slack?

[qnga]

I sent to you instructions on the Readium Slack, as you seem to have access to it.

[hishampro5]

@qnga we are encounter same issue.
We are confused about the error FormatNotSupported why and how can fix it.

[hishampro5]

@KaramYaaqba did you get why this error occur

[KaramYaaqba]

@hishampro5, the first issue in my case is that our backend server does not support the HEAD method. We are fixing it, but until then, we cannot stream publications.

[mickael-menu]

Also don't forget to pass the LCP content protection when initializing the PublicationOpener, otherwise you might get this error as LCP files won't be recognized.

See the documentation for that: https://github.com/readium/kotlin-toolkit/blob/3.0.3/docs/guides/lcp.md#initializing-the-publicationopener

[qnga]

Any update on this?

[hishampro5]

i did same as doc but i get error => An error occurred while attempting to decode the content

on fun **doOpen()**
// Instantiate the required components.
val httpClient = DefaultHttpClient()
val assetRetriever = AssetRetriever(
  contentResolver = activity.contentResolver,
  httpClient = httpClient
)
val publicationOpener = PublicationOpener(
  publicationParser = DefaultPublicationParser(
   activity,
   httpClient = httpClient,
   assetRetriever = assetRetriever,
   null
  )
)

val url = File("/storage/emulated/0/Download/hisham-488150.lcpl").toUrl()
//		val url = File("/storage/emulated/0/Download/Steremingbook.lcpl").toUrl()
//		val url = File("/storage/emulated/0/Download/Steremingbook.lcpl").toUrl()
//		val url = File("/data/user/0/com.samawy.readerapp/files/encryptedFile.lcpl").toUrl()
//		val file = File(activity.filesDir, "encryptedFile.lcpl")
//		val url = file.toUrl()

		// get assetFile from url
		val asset = readium.assetRetriever.retrieve(
			url,
			book.mediaType
		).getOrElse {
			return Try.failure(
				OpeningError.PublicationError(
					com.samawy.readerapp.readium.testapp.domain.PublicationError(it)
				)
			)
		}

		val publication = publicationOpener.open(
			asset,
			allowUserInteraction = true,
			credentials = credentials
		).getOrElse {
			return Try.failure(
				OpeningError.PublicationError(
					com.samawy.readerapp.readium.testapp.domain.PublicationError(it)
				)
			)
		}

		// The publication is protected with a DRM and not unlocked.
		if (publication.isRestricted) {
			return Try.failure(
				OpeningError.RestrictedPublication(
					publication.protectionError
						?: DebugError("Publication is restricted.")
				)
			)
		}

		val initialLocator = book.progression
			?.let { Locator.fromJSON(JSONObject(it)) }

		val readerInitData = when {
			publication.conformsTo(Publication.Profile.AUDIOBOOK) ->
				openAudio(bookId, publication, initialLocator)

			publication.conformsTo(Publication.Profile.EPUB) || publication.readingOrder.allAreHtml ->
				openEpub(bookId, publication, initialLocator)

			publication.conformsTo(Publication.Profile.PDF) ->
				openPdf(bookId, publication, initialLocator)

			publication.conformsTo(Publication.Profile.DIVINA) ->
				openImage(bookId, publication, initialLocator)

			else ->
				Try.failure(
					OpeningError.CannotRender(
						DebugError("No navigator supports this publication.")
					)
				)
		}

		return readerInitData.map { it ->
			repository[bookId] = it

//			if (it is MediaReaderInitData) {
//				mediaServiceFacade.openSession(bookId, it.mediaNavigator)
//			}
		}

[qnga]

Once again, doc is misleading. You can't hope for that to work if you don't pass a ContentProtection to your PublicationOpener.

[mickael-menu]

I fixed the documentation here: #645

But did you read the full LCP guide or just the streaming section? It was explained in details how to initialize the PublicationOpener in the section I shared before:
https://github.com/readium/kotlin-toolkit/blob/develop/docs/guides/lcp.md#initializing-the-publicationopener