Merge pull request #143 from readium/fix/alpha

Various alpha fixes
readium · Oct 26, 2020 · e658b69 · e658b69
2 parents 228795f + bbeb1c3
commit e658b69
Show file tree

Hide file tree

Showing 6 changed files with 38 additions and 19 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -6,6 +6,20 @@ All notable changes to this project will be documented in this file.
 
 ## [Unreleased]
 
+### Added
+
+* Support for the new `Publication` model using the [Content Protection](https://readium.org/architecture/proposals/006-content-protection) for DRM rights and the [Fetcher](https://readium.org/architecture/proposals/002-composite-fetcher-api) for resource access.
+  * This replaces the `Container` and `DRMLicense` objects which were needed by the navigator before.
+
+### Fixed
+
+* Layout of right-to–left EPUB.
+* [Various EPUB navigation issues](https://github.com/readium/r2-navigator-swift/pull/142):
+  * Prevent breaking initial location when calling `updateUserSettings` too soon.
+  * Fix weird scrolling behavior when double tapping on the edges to turn pages.
+  * Don't send intermediate incorrect locators when loading a pending locator.
+* Optimize positions calculation for LCP protected PDF.
+
 ## [2.0.0-alpha.1]
 
 ### Added

diff --git a/r2-navigator-swift.xcodeproj/project.pbxproj b/r2-navigator-swift.xcodeproj/project.pbxproj
@@ -259,7 +259,7 @@
 			isa = PBXProject;
 			attributes = {
 				LastSwiftUpdateCheck = 0830;
-				LastUpgradeCheck = 1020;
+				LastUpgradeCheck = 1200;
 				ORGANIZATIONNAME = Readium;
 				TargetAttributes = {
 					F3E7D3C21F4D83B000DF166D = {
@@ -373,6 +373,7 @@
 				CLANG_WARN_OBJC_IMPLICIT_RETAIN_SELF = YES;
 				CLANG_WARN_OBJC_LITERAL_CONVERSION = YES;
 				CLANG_WARN_OBJC_ROOT_CLASS = YES_ERROR;
+				CLANG_WARN_QUOTED_INCLUDE_IN_FRAMEWORK_HEADER = YES;
 				CLANG_WARN_RANGE_LOOP_ANALYSIS = YES;
 				CLANG_WARN_STRICT_PROTOTYPES = YES;
 				CLANG_WARN_SUSPICIOUS_MOVE = YES;
@@ -438,6 +439,7 @@
 				CLANG_WARN_OBJC_IMPLICIT_RETAIN_SELF = YES;
 				CLANG_WARN_OBJC_LITERAL_CONVERSION = YES;
 				CLANG_WARN_OBJC_ROOT_CLASS = YES_ERROR;
+				CLANG_WARN_QUOTED_INCLUDE_IN_FRAMEWORK_HEADER = YES;
 				CLANG_WARN_RANGE_LOOP_ANALYSIS = YES;
 				CLANG_WARN_STRICT_PROTOTYPES = YES;
 				CLANG_WARN_SUSPICIOUS_MOVE = YES;

diff --git a/r2-navigator-swift.xcodeproj/xcshareddata/xcschemes/r2-navigator-swift.xcscheme b/r2-navigator-swift.xcodeproj/xcshareddata/xcschemes/r2-navigator-swift.xcscheme
@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <Scheme
-   LastUpgradeVersion = "1020"
+   LastUpgradeVersion = "1200"
    version = "1.3">
    <BuildAction
       parallelizeBuildables = "YES"
@@ -27,6 +27,15 @@
       selectedDebuggerIdentifier = "Xcode.DebuggerFoundation.Debugger.LLDB"
       selectedLauncherIdentifier = "Xcode.DebuggerFoundation.Launcher.LLDB"
       shouldUseLaunchSchemeArgsEnv = "YES">
+      <MacroExpansion>
+         <BuildableReference
+            BuildableIdentifier = "primary"
+            BlueprintIdentifier = "F3E7D3C21F4D83B000DF166D"
+            BuildableName = "R2Navigator.framework"
+            BlueprintName = "r2-navigator-swift"
+            ReferencedContainer = "container:r2-navigator-swift.xcodeproj">
+         </BuildableReference>
+      </MacroExpansion>
       <Testables>
          <TestableReference
             skipped = "NO">
@@ -39,17 +48,6 @@
             </BuildableReference>
          </TestableReference>
       </Testables>
-      <MacroExpansion>
-         <BuildableReference
-            BuildableIdentifier = "primary"
-            BlueprintIdentifier = "F3E7D3C21F4D83B000DF166D"
-            BuildableName = "R2Navigator.framework"
-            BlueprintName = "r2-navigator-swift"
-            ReferencedContainer = "container:r2-navigator-swift.xcodeproj">
-         </BuildableReference>
-      </MacroExpansion>
-      <AdditionalOptions>
-      </AdditionalOptions>
    </TestAction>
    <LaunchAction
       buildConfiguration = "Debug"
@@ -70,8 +68,6 @@
             ReferencedContainer = "container:r2-navigator-swift.xcodeproj">
          </BuildableReference>
       </MacroExpansion>
-      <AdditionalOptions>
-      </AdditionalOptions>
    </LaunchAction>
    <ProfileAction
       buildConfiguration = "Release"

diff --git a/r2-navigator-swift/CBZ/CBZNavigatorViewController.swift b/r2-navigator-swift/CBZ/CBZNavigatorViewController.swift
@@ -27,6 +27,8 @@ open class CBZNavigatorViewController: UIViewController, VisualNavigator, Loggab
     private let pageViewController: UIPageViewController
 
     public init(publication: Publication, initialLocation: Locator? = nil) {
+        assert(!publication.isRestricted, "The provided publication is restricted. Check that any DRM was properly unlocked using a Content Protection.")
+
         self.publication = publication
         self.initialIndex = {
             guard let initialLocation = initialLocation, let initialIndex = publication.readingOrder.firstIndex(withHREF: initialLocation.href) else {

diff --git a/r2-navigator-swift/EPUB/EPUBNavigatorViewController.swift b/r2-navigator-swift/EPUB/EPUBNavigatorViewController.swift
@@ -178,6 +178,8 @@ open class EPUBNavigatorViewController: UIViewController, VisualNavigator, Logga
     private let resourcesURL: URL?
 
     public init(publication: Publication, initialLocation: Locator? = nil, resourcesServer: ResourcesServer, config: Configuration = .init()) {
+        assert(!publication.isRestricted, "The provided publication is restricted. Check that any DRM was properly unlocked using a Content Protection.")
+
         self.publication = publication
         self.editingActions = EditingActionsController(actions: config.editingActions, rights: publication.rights)
         self.userSettings = UserSettings()
@@ -662,7 +664,7 @@ extension EPUBNavigatorViewController: PaginationViewDelegate {
 @available(*, deprecated, renamed: "EPUBNavigatorViewController")
 public typealias NavigatorViewController = EPUBNavigatorViewController
 
-@available(*, deprecated, message: "Use the `animated` parameter of `goTo` functions instead")
+@available(*, unavailable, message: "Use the `animated` parameter of `goTo` functions instead")
 public enum PageTransition {
     case none
     case animated
@@ -672,7 +674,7 @@ extension EPUBNavigatorViewController {
 
     /// This initializer is deprecated.
     /// `license` is not needed anymore.
-    @available(*, unavailable, renamed: "init(publication:license:initialLocation:resourcesServer:config:)")
+    @available(*, unavailable, renamed: "init(publication:initialLocation:resourcesServer:config:)")
     public convenience init(publication: Publication, license: DRMLicense?, initialLocation: Locator? = nil, resourcesServer: ResourcesServer, config: Configuration = .init()) {
         self.init(publication: publication, initialLocation: initialLocation, resourcesServer: resourcesServer, config: config)
     }
@@ -681,7 +683,7 @@ extension EPUBNavigatorViewController {
     /// Replace `pageTransition` by the `animated` property of the `goTo` functions.
     /// Replace `disableDragAndDrop` by `EditingAction.copy`, since drag and drop is equivalent to copy.
     /// Replace `initialIndex` and `initialProgression` by `initialLocation`.
-    @available(*, deprecated, renamed: "init(publication:license:initialLocation:resourcesServer:config:)")
+    @available(*, unavailable, renamed: "init(publication:initialLocation:resourcesServer:config:)")
     public convenience init(for publication: Publication, license: DRMLicense? = nil, initialIndex: Int, initialProgression: Double?, pageTransition: PageTransition = .none, disableDragAndDrop: Bool = false, editingActions: [EditingAction] = EditingAction.defaultActions, contentInset: [UIUserInterfaceSizeClass: EPUBContentInsets]? = nil) {
         fatalError("This initializer is not available anymore.")
     }
@@ -698,7 +700,7 @@ extension EPUBNavigatorViewController {
         self.init(publication: publication, initialLocation: initialLocation, resourcesServer: resourcesServer, config: config)
     }
 
-    @available(*, deprecated, message: "Use the `animated` parameter of `goTo` functions instead")
+    @available(*, unavailable, message: "Use the `animated` parameter of `goTo` functions instead")
     public var pageTransition: PageTransition {
         get { return .none }
         set {}

diff --git a/r2-navigator-swift/PDF/PDFNavigatorViewController.swift b/r2-navigator-swift/PDF/PDFNavigatorViewController.swift
@@ -45,6 +45,8 @@ open class PDFNavigatorViewController: UIViewController, VisualNavigator, Loggab
     private var tapGestureController: PDFTapGestureController?
 
     public init(publication: Publication, initialLocation: Locator? = nil, editingActions: [EditingAction] = EditingAction.defaultActions) {
+        assert(!publication.isRestricted, "The provided publication is restricted. Check that any DRM was properly unlocked using a Content Protection.")
+
         self.publication = publication
         self.initialLocation = initialLocation
         self.editingActions = EditingActionsController(actions: editingActions, rights: publication.rights)
@@ -361,6 +363,7 @@ extension PDFNavigatorViewController {
 
     /// This initializer is deprecated.
     /// `license` is not needed anymore.
+    @available(*, unavailable, renamed: "init(publication:initialLocation:editingActions:)")
     public convenience init(publication: Publication, license: DRMLicense?, initialLocation: Locator? = nil, editingActions: [EditingAction] = EditingAction.defaultActions) {
         self.init(publication: publication, initialLocation: initialLocation, editingActions: editingActions)
     }