Refactoring

Author: mickael-menu

Sources/Shared/Toolkit/Extensions/URL.swift

@@ -63,6 +63,7 @@ extension URL: Loggable {
     /// Returns the first available URL by appending the given `pathComponent`.
     ///
     /// If `pathComponent` is already taken, then it appends a number to it.
+    // FIXME: Move to Internal
     public func appendingUniquePathComponent(_ pathComponent: String? = nil) -> URL {
         /// Returns the first path component matching the given `validation` closure.
         /// Numbers are appended to the path component until a valid candidate is found.

TestApp/Sources/App/AppModule.swift

@@ -29,8 +29,8 @@ final class AppModule {
     init() throws {
         let httpClient = DefaultHTTPClient()
 
-        let file = Paths.library.appendingPathComponent("database.db")
-        let db = try Database(file: file)
+        let file = Paths.library.appendingPath("database.db", isDirectory: false)
+        let db = try Database(file: file.url)
         print("Created database at \(file.path)")
 
         let books = BookRepository(db: db)
@@ -86,7 +86,9 @@ extension AppModule: ReaderModuleDelegate {}
 
 extension AppModule: OPDSModuleDelegate {
     func opdsDownloadPublication(_ publication: Publication?, at link: Link, sender: UIViewController) async throws -> Book {
-        let url = try link.url(relativeTo: publication?.baseURL)
-        return try await library.importPublication(from: url.url, sender: sender)
+        guard let url = try link.url(relativeTo: publication?.baseURL).absoluteURL else {
+            throw OPDSError.invalidURL(link.href)
+        }
+        return try await library.importPublication(from: url, sender: sender)
     }
 }

TestApp/Sources/AppDelegate.swift

@@ -5,6 +5,7 @@
 //
 
 import Combine
+import ReadiumShared
 import UIKit
 
 @UIApplicationMain
@@ -52,9 +53,14 @@ class AppDelegate: UIResponder, UIApplicationDelegate {
     }
 
     func application(_ application: UIApplication, open url: URL, options: [UIApplication.OpenURLOptionsKey: Any] = [:]) -> Bool {
+        guard let url = url.absoluteURL else {
+            return false
+        }
+
         Task {
             try! await app.library.importPublication(from: url, sender: window!.rootViewController!)
         }
+
         return true
     }
 }

TestApp/Sources/Common/Paths.swift

@@ -11,27 +11,27 @@ import ReadiumShared
 final class Paths {
     private init() {}
 
-    static let home: URL =
-        .init(fileURLWithPath: NSHomeDirectory(), isDirectory: true)
+    static let home: FileURL =
+        URL(fileURLWithPath: NSHomeDirectory(), isDirectory: true).fileURL!
 
-    static let temporary: URL =
-        .init(fileURLWithPath: NSTemporaryDirectory(), isDirectory: true)
+    static let temporary: FileURL =
+        URL(fileURLWithPath: NSTemporaryDirectory(), isDirectory: true).fileURL!
 
-    static let documents: URL =
-        FileManager.default.urls(for: .documentDirectory, in: .userDomainMask).first!
+    static let documents: FileURL =
+        FileManager.default.urls(for: .documentDirectory, in: .userDomainMask).first!.fileURL!
 
-    static let library: URL =
-        FileManager.default.urls(for: .libraryDirectory, in: .userDomainMask).first!
+    static let library: FileURL =
+        FileManager.default.urls(for: .libraryDirectory, in: .userDomainMask).first!.fileURL!
 
-    static let covers: URL = {
-        let url = library.appendingPathComponent("Covers")
-        try! FileManager.default.createDirectory(at: url, withIntermediateDirectories: true)
+    static let covers: FileURL = {
+        let url = library.appendingPath("Covers", isDirectory: true)
+        try! FileManager.default.createDirectory(at: url.url, withIntermediateDirectories: true)
         return url
     }()
 
-    static func makeDocumentURL(for source: URL? = nil, title: String?, mediaType: MediaType) -> URL {
+    static func makeDocumentURL(for source: FileURL? = nil, title: String?, mediaType: MediaType) -> FileURL {
         // Is the file already in Documents/?
-        if let source = source, source.standardizedFileURL.deletingLastPathComponent() == documents.standardizedFileURL {
+        if let source = source, documents.isParent(of: source) {
             return source
         } else {
             let title = title.takeIf { !$0.isEmpty } ?? UUID().uuidString
@@ -41,12 +41,42 @@ final class Paths {
         }
     }
 
-    static func makeTemporaryURL() -> URL {
+    static func makeTemporaryURL() -> FileURL {
         temporary.appendingUniquePathComponent()
     }
 
     /// Returns whether the given `url` locates a file that is under the app's home directory.
-    static func isAppFile(at url: URL) -> Bool {
-        home.isParentOf(url)
+    static func isAppFile(at url: FileURL) -> Bool {
+        home.isParent(of: url)
+    }
+}
+
+extension FileURL {
+    func appendingUniquePathComponent(_ pathComponent: String? = nil) -> FileURL {
+        /// Returns the first path component matching the given `validation` closure.
+        /// Numbers are appended to the path component until a valid candidate is found.
+        func uniquify(_ pathComponent: String?, validation: (String) -> Bool) -> String {
+            let pathComponent = pathComponent ?? UUID().uuidString
+            var ext = (pathComponent as NSString).pathExtension
+            if !ext.isEmpty {
+                ext = ".\(ext)"
+            }
+            let pathComponentWithoutExtension = (pathComponent as NSString).deletingPathExtension
+
+            var candidate = pathComponent
+            var i = 0
+            while !validation(candidate) {
+                i += 1
+                candidate = "\(pathComponentWithoutExtension) \(i)\(ext)"
+            }
+            return candidate
+        }
+
+        let pathComponent = uniquify(pathComponent) { candidate in
+            let destination = appendingPath(candidate, isDirectory: false)
+            return !((try? destination.url.checkResourceIsReachable()) ?? false)
+        }
+
+        return appendingPath(pathComponent, isDirectory: false)
     }
 }

TestApp/Sources/Common/Toolkit/Extensions/HTTPClient.swift

@@ -65,8 +65,8 @@ struct Book: Codable {
         self.preferencesJSON = preferencesJSON
     }
 
-    var cover: URL? {
-        coverPath.map { Paths.covers.appendingPathComponent($0) }
+    var cover: FileURL? {
+        coverPath.map { Paths.covers.appendingPath($0, isDirectory: false) }
     }
 
     func preferences<P: Decodable>() throws -> P? {

TestApp/Sources/Data/Book.swift

@@ -9,7 +9,7 @@ import Foundation
 import ReadiumShared
 
 struct DRMFulfilledPublication {
-    let localURL: URL
+    let localURL: FileURL
     let suggestedFilename: String
 }
 
@@ -19,8 +19,8 @@ protocol DRMLibraryService {
     var contentProtection: ContentProtection? { get }
 
     /// Returns whether this DRM can fulfill the given file into a protected publication.
-    func canFulfill(_ file: URL) -> Bool
+    func canFulfill(_ file: FileURL) -> Bool
 
     /// Fulfills the given file to the fully protected publication.
-    func fulfill(_ file: URL) async throws -> DRMFulfilledPublication?
+    func fulfill(_ file: FileURL) async throws -> DRMFulfilledPublication?
 }

TestApp/Sources/Library/DRM/DRMLibraryService.swift

@@ -23,20 +23,20 @@
 
         lazy var contentProtection: ContentProtection? = lcpService.contentProtection()
 
-        func canFulfill(_ file: URL) -> Bool {
-            file.pathExtension.lowercased() == "lcpl"
+        func canFulfill(_ file: FileURL) -> Bool {
+            file.pathExtension?.lowercased() == "lcpl"
         }
 
-        func fulfill(_ file: URL) async throws -> DRMFulfilledPublication? {
-            let pub = try await lcpService.acquirePublication(from: FileURL(url: file)!).get()
+        func fulfill(_ file: FileURL) async throws -> DRMFulfilledPublication? {
+            let pub = try await lcpService.acquirePublication(from: file).get()
             // Removes the license file, but only if it's in the App directory (e.g. Inbox/).
             // Otherwise we might delete something from a shared location (e.g. iCloud).
             if Paths.isAppFile(at: file) {
-                try? FileManager.default.removeItem(at: file)
+                try? FileManager.default.removeItem(at: file.url)
             }
 
             return DRMFulfilledPublication(
-                localURL: pub.localURL.url,
+                localURL: pub.localURL,
                 suggestedFilename: pub.suggestedFilename
             )
         }

TestApp/Sources/Library/DRM/LCPLibraryService.swift

@@ -13,7 +13,7 @@ enum LibraryError: LocalizedError {
     case bookDeletionFailed(Error?)
     case importFailed(Error)
     case openFailed(Error)
-    case downloadFailed(Error)
+    case downloadFailed(Error?)
     case cancelled
 
     var errorDescription: String? {
@@ -27,7 +27,7 @@ enum LibraryError: LocalizedError {
         case let .openFailed(error):
             return String(format: NSLocalizedString("library_error_openFailed", comment: "Error message used when a low-level error occured while opening a publication"), error.localizedDescription)
         case let .downloadFailed(error):
-            return String(format: NSLocalizedString("library_error_downloadFailed", comment: "Error message when the download of a publication failed"), error.localizedDescription)
+            return String(format: NSLocalizedString("library_error_downloadFailed", comment: "Error message when the download of a publication failed"), error?.localizedDescription ?? "None")
         default:
             return nil
         }

TestApp/Sources/Library/LibraryError.swift

@@ -21,7 +21,7 @@ protocol LibraryModuleAPI {
     /// Imports a new publication to the library, either from:
     /// - a local file URL
     /// - a remote URL which will be downloaded
-    func importPublication(from url: URL, sender: UIViewController) async throws -> Book
+    func importPublication(from url: AbsoluteURL, sender: UIViewController) async throws -> Book
 }
 
 protocol LibraryModuleDelegate: ModuleDelegate {
@@ -50,7 +50,7 @@ final class LibraryModule: LibraryModuleAPI {
         return library
     }()
 
-    func importPublication(from url: URL, sender: UIViewController) async throws -> Book {
+    func importPublication(from url: AbsoluteURL, sender: UIViewController) async throws -> Book {
         try await library.importPublication(from: url, sender: sender)
     }
 }