Extract the LCP persistence layer (#442)

Author: mickael-menu

CHANGELOG.md

@@ -26,6 +26,10 @@ All notable changes to this project will be documented in this file. Take a look
 
 * EPUB: The `scroll` preference is now forced to `true` when rendering vertical text (e.g. CJK vertical). [See this discussion for the rationale](https://github.com/readium/swift-toolkit/discussions/370).
 
+#### LCP
+
+* The Readium LCP persistence layer was extracted to allow applications to provide their own implementations. Take a look at [the migration guide](Documentation/Migration%20Guide.md) for guidance.
+
 ### Fixed
 
 #### Navigator

Cartfile

@@ -4,5 +4,5 @@ github "krzyzanowskim/CryptoSwift" == 1.5.1 # From 1.6.0, the build fails in Git
 github "ra1028/DifferenceKit" ~> 1.3.0
 github "readium/GCDWebServer" ~> 4.0.0
 github "scinfu/SwiftSoup" == 2.5.3 # 2.6.0 requires Xcode 14
-github "stephencelis/SQLite.swift" == 0.13.3 # 0.14 introduces a breaking change
+github "stephencelis/SQLite.swift" ~> 0.15.3
 github "weichsel/ZIPFoundation" == 0.9.11 # 0.9.12 requires iOS 12+

Documentation/Guides/Getting Started.md

@@ -28,6 +28,7 @@ The toolkit has been designed following these core tenets:
 ### Adapters to third-party dependencies
 
 * `ReadiumAdapterGCDWebServer` provides an HTTP server built with [GCDWebServer](https://github.com/swisspol/GCDWebServer).
+* `ReadiumAdapterLCPSQLite` provides implementations of the `ReadiumLCP` license and passphrase repositories using [SQLite.swift](https://github.com/stephencelis/SQLite.swift).
 
 ## Overview of the shared models (`R2Shared`)
 

Documentation/Migration Guide.md

@@ -8,6 +8,36 @@ All migration steps necessary in reading apps to upgrade to major versions of th
 
 Plenty of completion-based APIs were changed to use `async` functions instead. Follow the deprecation warnings to update your codebase.
 
+### Readium LCP SQLite adapter
+
+The Readium LCP persistence layer was extracted to allow applications to provide their own implementations. The previous implementation is now part of a new package, `ReadiumAdapterLCPSQLite`, which you need to use to maintain the same behavior as before.
+
+To use `ReadiumAdapterLCPSQLite`, you must update your imports and the dependencies included in your project:
+
+* Swift Package Manager:
+    * Add the `ReadiumAdapterLCPSQLite` package to your project dependencies.
+* Carthage:
+    * Update the Carthage dependencies and make sure the new `ReadiumAdapterLCPSQLite.xcframework` was built.
+    * Add this new framework to your project dependencies.
+* CocoaPods:
+    * Update the `pod` statements in your `Podfile` with the following, before running `pod install`:
+        ```
+        pod 'ReadiumAdapterLCPSQLite', podspec: 'https://raw.githubusercontent.com/readium/swift-toolkit/3.0.0/Support/CocoaPods/ReadiumAdapterLCPSQLite.podspec'
+        ```
+Then, provide the adapters when initializing the `LCPService`.
+
+```swift
+import ReadiumAdapterLCPSQLite
+import ReadiumLCP
+
+let lcpService = LCPService(
+    client: LCPClient(),
+    licenseRepository: LCPSQLiteLicenseRepository(),
+    passphraseRepository: LCPSQLitePassphraseRepository(),
+    httpClient: DefaultHTTPClient()
+)
+```
+
 
 ## 3.0.0-alpha.1
 

Package.swift

@@ -20,6 +20,7 @@ let package = Package(
 
         // Adapters to third-party dependencies.
         .library(name: "ReadiumAdapterGCDWebServer", targets: ["ReadiumAdapterGCDWebServer"]),
+        .library(name: "ReadiumAdapterLCPSQLite", targets: ["ReadiumAdapterLCPSQLite"]),
     ],
     dependencies: [
         .package(url: "https://github.com/cezheng/Fuzi.git", from: "3.1.3"),
@@ -30,8 +31,7 @@ let package = Package(
         .package(url: "https://github.com/readium/GCDWebServer.git", from: "4.0.0"),
         // From 2.6.0, Xcode 14 is required
         .package(url: "https://github.com/scinfu/SwiftSoup.git", "2.5.3" ..< "2.6.0"),
-        // 0.14 introduced a breaking change
-        .package(url: "https://github.com/stephencelis/SQLite.swift.git", "0.12.0" ..< "0.13.3"),
+        .package(url: "https://github.com/stephencelis/SQLite.swift.git", from: "0.15.3"),
         // 0.9.12 requires iOS 12+
         .package(url: "https://github.com/weichsel/ZIPFoundation.git", "0.9.0" ..< "0.9.12"),
     ],
@@ -130,7 +130,6 @@ let package = Package(
                 "CryptoSwift",
                 "ZIPFoundation",
                 "ReadiumShared",
-                .product(name: "SQLite", package: "SQLite.swift"),
             ],
             path: "Sources/LCP",
             resources: [
@@ -157,6 +156,15 @@ let package = Package(
             path: "Sources/Adapters/GCDWebServer"
         ),
 
+        .target(
+            name: "ReadiumAdapterLCPSQLite",
+            dependencies: [
+                .product(name: "SQLite", package: "SQLite.swift"),
+                "ReadiumLCP",
+            ],
+            path: "Sources/Adapters/LCPSQLite"
+        ),
+
         .target(
             name: "ReadiumInternal",
             path: "Sources/Internal"

README.md

@@ -54,18 +54,18 @@ Note that Carthage will build all Readium modules and their dependencies, but yo
 
 Refer to the following table to know which dependencies are required for each Readium library.
 
-|                       |   `ReadiumShared`  |  `ReadiumStreamer` | `ReadiumNavigator` |    `ReadiumOPDS`   |    `ReadiumLCP`    |
-|-----------------------|:------------------:|:------------------:|:------------------:|:------------------:|:------------------:|
-| **`ReadiumShared`**   |                    | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: |
-| **`ReadiumInternal`** | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: |
-| `CryptoSwift`         |                    | :heavy_check_mark: |                    |                    | :heavy_check_mark: |
-| `DifferenceKit`       |                    |                    | :heavy_check_mark: |                    |                    |
-| `Fuzi`                | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: |
-| `Minizip`             | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: |
-| `ReadiumGCDWebServer` |                    | :heavy_check_mark: |                    |                    |                    |
-| `SQLite.swift`        |                    |                    |                    |                    | :heavy_check_mark: |
-| `SwiftSoup`           | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: |
-| `ZIPFoundation`       |                    |                    |                    |                    | :heavy_check_mark: |
+|                       |   `ReadiumShared`  |  `ReadiumStreamer` | `ReadiumNavigator` |    `ReadiumOPDS`   |    `ReadiumLCP`    | `ReadiumAdapterGCDWebServer` | `ReadiumAdapterLCPSQLite` |
+|-----------------------|:------------------:|:------------------:|:------------------:|:------------------:|:------------------:|------------------------------|---------------------------|
+| **`ReadiumShared`**   |                    | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark:           | :heavy_check_mark:        |
+| **`ReadiumInternal`** | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: |                              |                           |
+| `CryptoSwift`         |                    | :heavy_check_mark: |                    |                    | :heavy_check_mark: |                              |                           |
+| `DifferenceKit`       |                    |                    | :heavy_check_mark: |                    |                    |                              |                           |
+| `Fuzi`                | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: |                              |                           |
+| `Minizip`             | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: |                              |                           |
+| `ReadiumGCDWebServer` |                    |                    |                    |                    |                    | :heavy_check_mark:           |                           |
+| `SQLite.swift`        |                    |                    |                    |                    |                    |                              | :heavy_check_mark:        |
+| `SwiftSoup`           | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: |                              |                           |
+| `ZIPFoundation`       |                    |                    |                    |                    | :heavy_check_mark: |                              |                           |
 
 ### CocoaPods
 
@@ -79,7 +79,7 @@ pod 'ReadiumOPDS', podspec: 'https://raw.githubusercontent.com/readium/swift-too
 pod 'ReadiumLCP', podspec: 'https://raw.githubusercontent.com/readium/swift-toolkit/3.0.0-alpha.1/Support/CocoaPods/ReadiumLCP.podspec'
 pod 'ReadiumInternal', podspec: 'https://raw.githubusercontent.com/readium/swift-toolkit/3.0.0-alpha.1/Support/CocoaPods/ReadiumInternal.podspec'
 
-# Required if you use ReadiumStreamer.
+# Required if you use ReadiumAdapterGCDWebServer.
 pod 'ReadiumGCDWebServer', podspec: 'https://raw.githubusercontent.com/readium/GCDWebServer/4.0.0/GCDWebServer.podspec'
 ```
 
@@ -102,3 +102,4 @@ Finally, add the Readium libraries you want to use to your app target from the *
 ### Building with Readium LCP
 
 Using the toolkit with Readium LCP requires additional dependencies, including the framework `R2LCPClient.framework` provided by EDRLab. [Contact EDRLab](mailto:[email protected]) to request your private `R2LCPClient.framework` and the setup instructions.
+

Sources/LCP/Persistence/Database.swift renamed to Sources/Adapters/LCPSQLite/Database.swift

@@ -5,9 +5,10 @@
 //
 
 import Foundation
+import ReadiumLCP
 import SQLite
 
-public class SQLiteLCPLicenseRepository: LCPLicenseRepository {
+public class LCPSQLiteLicenseRepository: LCPLicenseRepository {
     let licenses = Table("Licenses")
     let id = Expression<String>("id")
     let printsLeft = Expression<Int?>("printsLeft")
@@ -55,8 +56,7 @@ public class SQLiteLCPLicenseRepository: LCPLicenseRepository {
 
     public func isDeviceRegistered(for id: LicenseDocument.ID) async throws -> Bool {
         try checkExists(id)
-        let query = licenses.filter(self.id == id && registered == true)
-        let count = try db.count(query)
+        let count = try db.scalar(licenses.filter(self.id == id && registered == true).count)
         return count != 0
     }
 
@@ -94,7 +94,7 @@ public class SQLiteLCPLicenseRepository: LCPLicenseRepository {
     }
 
     private func exists(_ licenseID: LicenseDocument.ID) -> Bool {
-        ((try? db.count(licenses.filter(id == licenseID))) ?? 0) != 0
+        ((try? db.scalar(licenses.filter(id == licenseID).count)) ?? 0) != 0
     }
 
     private func get(_ column: Expression<Int?>, for licenseId: String) throws -> Int? {

Sources/LCP/Persistence/SQLiteLCPLicenseRepository.swift renamed to Sources/Adapters/LCPSQLite/SQLiteLCPLicenseRepository.swift

@@ -5,10 +5,11 @@
 //
 
 import Foundation
+import ReadiumLCP
 import ReadiumShared
 import SQLite
 
-public class SQLiteLCPPassphraseRepository: LCPPassphraseRepository, Loggable {
+public class LCPSQLitePassphraseRepository: LCPPassphraseRepository, Loggable {
     let transactions = Table("Transactions")
     let licenseId = Expression<String>("licenseId")
     let provider = Expression<String>("origin")

Sources/LCP/Persistence/SQLiteLCPPassphraseRepository.swift renamed to Sources/Adapters/LCPSQLite/SQLiteLCPPassphraseRepository.swift

@@ -181,7 +181,7 @@ final class LCPDialogViewController: UIViewController {
         present(browser, animated: true)
     }
 
-    /// Makes sure the form contents in scrollable when the keyboard is visible.
+    /// Makes sure the form contents is scrollable when the keyboard is visible.
     @objc func keyboardWillChangeFrame(_ note: Notification) {
         guard let window = UIApplication.shared.keyWindow, let scrollView = scrollView, let scrollViewSuperview = scrollView.superview, let info = note.userInfo else {
             return

Sources/LCP/Authentications/LCPDialogViewController.swift

@@ -18,6 +18,13 @@
         }
       }
     },
+    "ReadiumAdapterLCPSQLite" : {
+      "build" : {
+        "targets" : {
+          "ReadiumAdapterLCPSQLite" : "all"
+        }
+      }
+    },
     "ReadiumInternal" : {
       "build" : {
         "targets" : {
@@ -87,6 +94,31 @@
       ],
       "type" : "framework"
     },
+    "ReadiumAdapterLCPSQLite" : {
+      "dependencies" : [
+        {
+          "framework" : "..\/..\/Carthage\/Build\/SQLite.xcframework"
+        },
+        {
+          "target" : "ReadiumShared"
+        },
+        {
+          "target" : "ReadiumLCP"
+        }
+      ],
+      "deploymentTarget" : "13.0",
+      "platform" : "iOS",
+      "settings" : {
+        "INFOPLIST_FILE" : "Info.plist",
+        "PRODUCT_BUNDLE_IDENTIFIER" : "org.readium.swift-toolkit.adapter.lcpsqlite"
+      },
+      "sources" : [
+        {
+          "path" : "..\/..\/Sources\/Adapters\/LCPSQLite"
+        }
+      ],
+      "type" : "framework"
+    },
     "ReadiumInternal" : {
       "deploymentTarget" : "13.0",
       "platform" : "iOS",
@@ -112,9 +144,6 @@
         {
           "framework" : "..\/..\/Carthage\/Build\/Minizip.xcframework"
         },
-        {
-          "framework" : "..\/..\/Carthage\/Build\/SQLite.xcframework"
-        },
         {
           "framework" : "..\/..\/Carthage\/Build\/ZIPFoundation.xcframework"
         },
@@ -290,6 +319,10 @@
 ../../Sources/Adapters/GCDWebServer
 ../../Sources/Adapters/GCDWebServer/GCDHTTPServer.swift
 ../../Sources/Adapters/GCDWebServer/ResourceResponse.swift
+../../Sources/Adapters/LCPSQLite
+../../Sources/Adapters/LCPSQLite/Database.swift
+../../Sources/Adapters/LCPSQLite/SQLiteLCPLicenseRepository.swift
+../../Sources/Adapters/LCPSQLite/SQLiteLCPPassphraseRepository.swift
 ../../Sources/Internal
 ../../Sources/Internal/Extensions
 ../../Sources/Internal/Extensions/Array.swift
@@ -349,11 +382,6 @@
 ../../Sources/LCP/License/Model/Components/LSD/PotentialRights.swift
 ../../Sources/LCP/License/Model/LicenseDocument.swift
 ../../Sources/LCP/License/Model/StatusDocument.swift
-../../Sources/LCP/Persistence
-../../Sources/LCP/Persistence/Connection.swift
-../../Sources/LCP/Persistence/Database.swift
-../../Sources/LCP/Persistence/SQLiteLCPLicenseRepository.swift
-../../Sources/LCP/Persistence/SQLiteLCPPassphraseRepository.swift
 ../../Sources/LCP/Resources
 ../../Sources/LCP/Resources/en.lproj
 ../../Sources/LCP/Resources/en.lproj/Localizable.strings