Merge branch 'feature/boundless'

Author: io7m

.ci

@@ -694,8 +694,10 @@
         </c:change>
       </c:changes>
     </c:release>
-    <c:release date="2025-07-09T08:12:48+00:00" is-open="true" ticket-system="org.lyrasis.jira" version="1.17.0">
-      <c:changes/>
+    <c:release date="2025-07-15T08:09:56+00:00" is-open="true" ticket-system="org.lyrasis.jira" version="1.17.0">
+      <c:changes>
+        <c:change date="2025-07-15T08:09:56+00:00" summary="Add support for Boundless DRM."/>
+      </c:changes>
     </c:release>
   </c:releases>
   <c:ticket-systems>

README-CHANGES.xml

@@ -31,10 +31,13 @@ val findawayDRM =
     propertyBooleanOptional("org.thepalaceproject.findaway.enabled", false)
 val overdriveDRM =
     propertyBooleanOptional("org.thepalaceproject.overdrive.enabled", false)
+val boundlessDRM =
+    propertyBooleanOptional("org.thepalaceproject.boundless.enabled", false)
 
 println("DRM: org.thepalaceproject.adobeDRM.enabled  : $adobeDRM")
-println("DRM: org.thepalaceproject.lcp.enabled       : $lcpDRM")
+println("DRM: org.thepalaceproject.boundless.enabled : $boundlessDRM")
 println("DRM: org.thepalaceproject.findaway.enabled  : $findawayDRM")
+println("DRM: org.thepalaceproject.lcp.enabled       : $lcpDRM")
 println("DRM: org.thepalaceproject.overdrive.enabled : $overdriveDRM")
 
 dependencyResolutionManagement {
@@ -98,6 +101,17 @@ dependencyResolutionManagement {
         )
     }
 
+    /*
+     * Conditionally enable Boundless DRM.
+     */
+
+    if (boundlessDRM && !s3RepositoryEnabled) {
+        throw GradleException(
+            "If the org.thepalaceproject.boundlessDRM.enabled property is set to true, " +
+                "the org.thepalaceproject.s3.depend property must be set to true."
+        )
+    }
+
     /*
      * The set of repositories used to resolve library dependencies. The order is significant!
      */

org.thepalaceproject.android.platform

@@ -31,6 +31,8 @@ val findawayDRM =
     project.findProperty("org.thepalaceproject.findaway.enabled") == "true"
 val overdriveDRM =
     project.findProperty("org.thepalaceproject.overdrive.enabled") == "true"
+val boundlessDRM =
+    project.findProperty("org.thepalaceproject.boundless.enabled") == "true"
 
 if (adobeDRM) {
     palaceAssetsRequired.setProperty(
@@ -39,7 +41,7 @@ if (adobeDRM) {
     )
 }
 
-if (adobeDRM || lcpDRM || findawayDRM || overdriveDRM) {
+if (adobeDRM || lcpDRM || findawayDRM || overdriveDRM || boundlessDRM) {
     palaceAssetsRequired.setProperty(
         "assets/secrets.conf",
         "221db5c8c1ce1ddbc4f4c1a017f5b63271518d2adf6991010c2831a58b7f88ed",
@@ -380,6 +382,16 @@ dependencies {
         implementation(libs.palace.overdrive)
     }
 
+    /*
+     * Dependencies conditional upon Boundless DRM support.
+     */
+
+    if (boundlessDRM) {
+        implementation(libs.palace.drm.boundless.core)
+        implementation(libs.palace.drm.boundless.readium)
+        implementation(libs.palace.drm.boundless.service)
+    }
+
     /*
      * Dependencies needed for Feedbooks JWT handling. Always enabled.
      */

settings.gradle.kts

@@ -1,10 +1,12 @@
 package org.nypl.simplified.books.api
 
 import android.app.Application
+import org.nypl.drm.core.BoundlessServiceType
 import org.nypl.drm.core.ContentProtectionProvider
 import org.nypl.simplified.lcp.LCPContentProtectionProvider
 import org.readium.r2.shared.publication.protection.ContentProtection
 import org.slf4j.LoggerFactory
+import java.time.OffsetDateTime
 
 object BookContentProtections {
 
@@ -13,40 +15,79 @@ object BookContentProtections {
 
   /*
    * Instantiate any content protections that might be needed for DRM...
+   *
+   * XXX: This interface needs to be replaced with something else. It's messy and is trying to
+   * squash multiple different interfaces into a single method.
    */
 
   fun create(
     context: Application,
     contentProtectionProviders: List<ContentProtectionProvider>,
+    boundless: BoundlessServiceType?,
+    format: BookFormat,
     drmInfo: BookDRMInformation,
     isManualPassphraseEnabled: Boolean = false,
     onLCPDialogDismissed: () -> Unit = {}
   ): List<ContentProtection> {
-    return contentProtectionProviders.mapNotNull { provider ->
-      this.logger.debug("instantiating content protection provider {}", provider.javaClass.canonicalName)
-
-      /*
-       * XXX: It's unpleasant to have to special-case like this, but we don't control the
-       * org.nypl.drm.core.ContentProtectionProvider interface. When LCP is implemented upstream,
-       * all of those interfaces can be upgraded to properly support passing in credentials.
-       */
-
-      if (provider is LCPContentProtectionProvider) {
-        when (drmInfo) {
-          is BookDRMInformation.LCP -> {
-            provider.passphrase = drmInfo.hashedPassphrase
-            provider.isManualPassphraseEnabled = isManualPassphraseEnabled
-            provider.onLcpDialogDismissed = onLCPDialogDismissed
+    return try {
+      when (drmInfo) {
+        /*
+         * ACS doesn't require any special handling. Just instantiate the one provider if it exists.
+         */
+
+        is BookDRMInformation.ACS -> {
+          contentProtectionProviders.mapNotNull { provider -> provider.create(context) }
+        }
+
+        /*
+         * Boundless only works for EPUB files, and requires a bit of information up-front.
+         */
+        is BookDRMInformation.Boundless -> {
+          if (boundless != null) {
+            if (format is BookFormat.BookFormatEPUB) {
+              listOf(
+                boundless.createContentProtection(
+                  epubFile = format.file!!,
+                  licenseFile = drmInfo.license!!,
+                  tempDirectory = context.cacheDir,
+                  inMemorySizeThreshold = 10_000_000UL,
+                  currentTime = OffsetDateTime.now()
+                )
+              )
+            } else {
+              listOf()
+            }
+          } else {
+            listOf()
           }
+        }
 
-          is BookDRMInformation.ACS,
-          is BookDRMInformation.AXIS,
-          BookDRMInformation.None -> {
-            // do nothing
+        /*
+         * LCP requires data up front.
+         */
+        is BookDRMInformation.LCP -> {
+          val lcpProvider =
+            contentProtectionProviders.filter { provider -> provider is LCPContentProtectionProvider }
+              .map { provider -> provider as LCPContentProtectionProvider }
+              .firstOrNull()
+
+          if (lcpProvider != null) {
+            lcpProvider.passphrase = drmInfo.hashedPassphrase
+            lcpProvider.isManualPassphraseEnabled = isManualPassphraseEnabled
+            lcpProvider.onLcpDialogDismissed = onLCPDialogDismissed
+            listOfNotNull(lcpProvider.create(context))
+          } else {
+            listOf()
           }
         }
+
+        BookDRMInformation.None -> {
+          listOf()
+        }
       }
-      provider.create(context)
+    } catch (e: Throwable) {
+      this.logger.error("Failed to handle DRM providers: ", e)
+      listOf()
     }
   }
 }

simplified-app-palace/build.gradle.kts

@@ -81,30 +81,18 @@ sealed class BookDRMInformation : Serializable {
     override val kind: BookDRMKind = BookDRMKind.LCP
   }
 
-  /**
-   * The AXIS information associated with a book.
-   */
-
-  data class AXIS(
-
+  data class Boundless(
     /**
      * The license file. This is only present if an attempt has been made to fulfill the book.
      */
 
-    val license: File?,
-
-    /**
-     * The file containing the key used to fulfill the book. This is only present
-     * if an attempt has been made to fulfill the book.
-     */
-
-    val userKey: File?
+    val license: File?
   ) : BookDRMInformation() {
     override fun playerCredentials(): PlayerBookCredentialsType {
       return PlayerBookCredentialsNone
     }
 
-    override val kind: BookDRMKind = BookDRMKind.AXIS
+    override val kind: BookDRMKind = BookDRMKind.BOUNDLESS
   }
 
   /**

simplified-books-api/src/main/java/org/nypl/simplified/books/api/BookContentProtections.kt

@@ -25,8 +25,8 @@ enum class BookDRMKind {
   ACS,
 
   /**
-   * See [BookDRMInformation.AXIS]
+   * See [BookDRMInformation.Boundless]
    */
 
-  AXIS
+  BOUNDLESS
 }

simplified-books-api/src/main/java/org/nypl/simplified/books/api/BookDRMInformation.kt

@@ -12,6 +12,7 @@ dependencies {
     implementation(project(":simplified-books-formats-api"))
     implementation(project(":simplified-books-registry-api"))
     implementation(project(":simplified-content-api"))
+    implementation(project(":simplified-links"))
     implementation(project(":simplified-opds-core"))
     implementation(project(":simplified-presentableerror-api"))
     implementation(project(":simplified-profiles-api"))
@@ -44,4 +45,5 @@ dependencies {
     implementation(libs.rxjava)
     implementation(libs.rxjava2)
     implementation(libs.slf4j)
+    implementation(libs.stduritemplate)
 }

simplified-books-api/src/main/java/org/nypl/simplified/books/api/BookDRMKind.kt

@@ -5,7 +5,7 @@ import org.joda.time.Instant
 import org.librarysimplified.http.api.LSHTTPClientType
 import org.librarysimplified.services.api.ServiceDirectoryType
 import org.nypl.drm.core.AdobeAdeptExecutorType
-import org.nypl.drm.core.AxisNowServiceType
+import org.nypl.drm.core.BoundlessServiceType
 import org.nypl.simplified.accounts.database.api.AccountType
 import org.nypl.simplified.books.api.Book
 import org.nypl.simplified.books.audio.AudioBookManifestStrategiesType
@@ -16,6 +16,7 @@ import org.nypl.simplified.books.borrowing.subtasks.BorrowSubtaskException.Borro
 import org.nypl.simplified.books.borrowing.subtasks.BorrowSubtaskException.BorrowSubtaskFailed
 import org.nypl.simplified.books.bundled.api.BundledContentResolverType
 import org.nypl.simplified.content.api.ContentResolverType
+import org.nypl.simplified.links.Link
 import org.nypl.simplified.opds.core.OPDSAcquisitionFeedEntry
 import org.nypl.simplified.opds.core.OPDSAcquisitionPath
 import org.nypl.simplified.opds.core.OPDSAcquisitionPathElement
@@ -33,7 +34,7 @@ interface BorrowContextType {
   val application: Application
   val account: AccountType
   val adobeExecutor: AdobeAdeptExecutorType?
-  val axisNowService: AxisNowServiceType?
+  val boundlessService: BoundlessServiceType?
   val audioBookManifestStrategies: AudioBookManifestStrategiesType
   val bundledContent: BundledContentResolverType
   val clock: () -> Instant
@@ -80,15 +81,15 @@ interface BorrowContextType {
    * The current acquisition path element. This will be updated once for each subtask.
    */
 
-  fun currentURI(): URI?
+  fun currentURI(): Link?
 
   /**
    * Check that the current URI is non-null. If the current URI is null, log an error
    * to the task recorder and throw [BorrowSubtaskFailed].
    */
 
   @Throws(BorrowSubtaskFailed::class)
-  fun currentURICheck(): URI {
+  fun currentLinkCheck(): Link {
     val uri = this.currentURI()
     if (uri == null) {
       this.logError("no current URI")
@@ -102,11 +103,31 @@ interface BorrowContextType {
     return uri
   }
 
+  /**
+   * Perform all of the checks of [currentLinkCheck] and additionally check that the link
+   * has a valid non-null URI.
+   */
+
+  @Throws(BorrowSubtaskFailed::class)
+  fun currentURICheck(): URI {
+    val link = this.currentLinkCheck()
+    if (link.hrefURI == null) {
+      this.logError("no current URI")
+      this.taskRecorder.currentStepFailed(
+        message = "A required URI is missing.",
+        errorCode = BorrowErrorCodes.requiredURIMissing,
+        extraMessages = listOf()
+      )
+      throw BorrowSubtaskFailed()
+    }
+    return link.hrefURI!!
+  }
+
   /**
    * The current subtask has received a new URI that can be used by the next subtask.
    */
 
-  fun receivedNewURI(uri: URI)
+  fun receivedNewURI(uri: Link)
 
   /**
    * The current acquisition path element. This will be updated once for each subtask.
@@ -238,7 +259,7 @@ interface BorrowContextType {
    * Choose a new acquisition path to follow based on the given received entry.
    */
 
-  fun chooseNewAcquisitionPath(entry: OPDSAcquisitionFeedEntry): URI
+  fun chooseNewAcquisitionPath(entry: OPDSAcquisitionFeedEntry): Link
 
   /**
    * Information about the current SAML download, if one is in progress.