Various URL API changes

Author: mickael-menu

Sources/Adapters/GCDWebServer/GCDHTTPServer.swift

@@ -113,7 +113,7 @@ public class GCDHTTPServer: HTTPServer, Loggable {
         }
 
         queue.async { [self] in
-            guard let url = HTTPURL(url: request.url) else {
+            guard let url = request.url.httpURL else {
                 completion(FailureResource(link: Link(href: request.url.absoluteString), error: .notFound(nil)))
                 return
             }
@@ -130,7 +130,7 @@ public class GCDHTTPServer: HTTPServer, Loggable {
             }
 
             for (endpoint, handler) in handlers {
-                if endpoint == url.removingQuery()?.removingFragment() {
+                if endpoint == url.removingQuery().removingFragment() {
                     let resource = handler(HTTPServerRequest(url: url, href: nil))
                     completion(transform(resource: resource, at: endpoint))
                     return
@@ -243,7 +243,7 @@ public class GCDHTTPServer: HTTPServer, Loggable {
             throw GCDHTTPServerError.failedToStartServer(cause: error)
         }
 
-        guard let baseURL = server.serverURL.flatMap(HTTPURL.init(url:)) else {
+        guard let baseURL = server.serverURL?.httpURL else {
             stop()
             throw GCDHTTPServerError.nullServerURL
         }

Sources/LCP/LCPRenewDelegate.swift

@@ -21,7 +21,7 @@ public protocol LCPRenewDelegate {
     ///
     /// You should present the URL in a `SFSafariViewController` and call the `completion` callback when the browser
     /// is dismissed by the user.
-    func presentWebPage(url: URL, completion: @escaping (CancellableResult<Void, Error>) -> Void)
+    func presentWebPage(url: HTTPURL, completion: @escaping (CancellableResult<Void, Error>) -> Void)
 }
 
 /// Default `LCPRenewDelegate` implementation using standard views.
@@ -41,8 +41,8 @@ public class LCPDefaultRenewDelegate: NSObject, LCPRenewDelegate {
         completion(.success(nil))
     }
 
-    public func presentWebPage(url: URL, completion: @escaping (CancellableResult<Void, Error>) -> Void) {
-        let safariVC = SFSafariViewController(url: url)
+    public func presentWebPage(url: HTTPURL, completion: @escaping (CancellableResult<Void, Error>) -> Void) {
+        let safariVC = SFSafariViewController(url: url.url)
         safariVC.modalPresentationStyle = modalPresentationStyle
         safariVC.presentationController?.delegate = self
         safariVC.delegate = self

Sources/LCP/License/License.swift

@@ -192,7 +192,7 @@ extension License: LCPLicense {
         func renewWithWebPage(_ link: Link) throws -> Deferred<Data, Error> {
             guard
                 let statusURL = try? license.url(for: .status, preferredType: .lcpStatusDocument),
-                let url = link.url
+                let url = link.url()
             else {
                 throw LCPError.licenseInteractionNotAvailable
             }
@@ -216,13 +216,13 @@ extension License: LCPLicense {
                     : Deferred.success(nil)
             }
 
-            func makeRenewURL(from endDate: Date?) throws -> URL {
+            func makeRenewURL(from endDate: Date?) throws -> HTTPURL {
                 var params = device.asQueryParameters
                 if let end = endDate {
                     params["end"] = end.iso8601
                 }
 
-                guard let url = link.url(with: params) else {
+                guard let url = link.url(parameters: params) else {
                     throw LCPError.licenseInteractionNotAvailable
                 }
                 return url
@@ -263,8 +263,13 @@ extension License: LCPLicense {
     }
 
     func returnPublication(completion: @escaping (LCPError?) -> Void) {
-        guard let status = documents.status,
-              let url = try? status.url(for: .return, preferredType: .lcpStatusDocument, with: device.asQueryParameters)
+        guard
+            let status = documents.status,
+            let url = try? status.url(
+                for: .return,
+                preferredType: .lcpStatusDocument,
+                parameters: device.asQueryParameters
+            )
         else {
             completion(LCPError.licenseInteractionNotAvailable)
             return
@@ -299,7 +304,7 @@ public extension LCPRenewDelegate {
         Deferred { preferredEndDate(maximum: maximum, completion: $0) }
     }
 
-    func presentWebPage(url: URL) -> Deferred<Void, Error> {
+    func presentWebPage(url: HTTPURL) -> Deferred<Void, Error> {
         Deferred { presentWebPage(url: url, completion: $0) }
     }
 }

Sources/LCP/License/Model/Components/Link.swift

@@ -50,20 +50,19 @@ public struct Link {
 
     /// Gets the valid URL if possible, applying the given template context as query parameters if the link is templated.
     /// eg. http://url{?id,name} + [id: x, name: y] -> http://url?id=x&name=y
-    func url(with parameters: [String: LosslessStringConvertible]) -> URL? {
+    func url(parameters: [String: LosslessStringConvertible] = [:]) -> HTTPURL? {
         var href = href
 
         if templated {
             href = URITemplate(href).expand(with: parameters.mapValues { String(describing: $0) })
         }
 
-        return URL(string: href)
+        return HTTPURL(string: href)
     }
 
     /// Expands the href without any template context.
-    var url: URL? {
-        url(with: [:])
-    }
+    @available(*, unavailable, message: "Use url() instead")
+    var url: URL? { fatalError() }
 
     var mediaType: MediaType {
         type.flatMap { MediaType.of(mediaType: $0) } ?? .binary

Sources/LCP/License/Model/LicenseDocument.swift

@@ -99,11 +99,11 @@ public struct LicenseDocument {
     /// are found, the first link with the `rel` and an empty `type` will be returned.
     ///
     /// - Throws: `LCPError.invalidLink` if the URL can't be built.
-    func url(for rel: Rel, preferredType: MediaType? = nil, with parameters: [String: LosslessStringConvertible] = [:]) throws -> URL {
+    func url(for rel: Rel, preferredType: MediaType? = nil, parameters: [String: LosslessStringConvertible] = [:]) throws -> HTTPURL {
         let link = link(for: rel, type: preferredType)
             ?? links.firstWithRelAndNoType(rel.rawValue)
 
-        guard let url = link?.url(with: parameters) else {
+        guard let url = link?.url(parameters: parameters) else {
             throw ParsingError.url(rel: rel.rawValue)
         }
 

Sources/LCP/License/Model/StatusDocument.swift

@@ -104,11 +104,11 @@ public struct StatusDocument {
     /// are found, the first link with the `rel` and an empty `type` will be returned.
     ///
     /// - Throws: `LCPError.invalidLink` if the URL can't be built.
-    func url(for rel: Rel, preferredType: MediaType? = nil, with parameters: [String: LosslessStringConvertible] = [:]) throws -> URL {
+    func url(for rel: Rel, preferredType: MediaType? = nil, parameters: [String: LosslessStringConvertible] = [:]) throws -> HTTPURL {
         let link = link(for: rel, type: preferredType)
             ?? linkWithNoType(for: rel)
 
-        guard let url = link?.url(with: parameters) else {
+        guard let url = link?.url(parameters: parameters) else {
             throw ParsingError.url(rel: rel.rawValue)
         }
 

Sources/LCP/Services/CRLService.swift

@@ -44,7 +44,7 @@ final class CRLService {
 
     /// Fetches the updated Certificate Revocation List from EDRLab.
     private func fetch(timeout: TimeInterval? = nil) -> Deferred<String, Error> {
-        let url = URL(string: "http://crl.edrlab.telesec.de/rl/EDRLab_CA.crl")!
+        let url = HTTPURL(string: "http://crl.edrlab.telesec.de/rl/EDRLab_CA.crl")!
 
         return httpClient.fetch(HTTPRequest(url: url, timeoutInterval: timeout))
             .mapError { _ in LCPError.crlFetching }

Sources/LCP/Services/DeviceService.swift

@@ -50,7 +50,7 @@ final class DeviceService {
             guard !registered else {
                 return .success(nil)
             }
-            guard let url = link.url(with: self.asQueryParameters) else {
+            guard let url = link.url(parameters: self.asQueryParameters) else {
                 throw LCPError.licenseInteractionNotAvailable
             }
 

Sources/Navigator/EPUB/CSS/ReadiumCSS.swift

@@ -114,17 +114,17 @@ extension ReadiumCSS: HTMLInjectable {
         let hasStyles = hasStyles(html)
         var stylesheetsFolder = baseURL
         if let folder = layout.stylesheets.folder {
-            stylesheetsFolder = stylesheetsFolder.appendingPath(folder, isDirectory: true)!
+            stylesheetsFolder = stylesheetsFolder.appendingPath(folder, isDirectory: true)
         }
 
         inj.append(.stylesheetLink(
-            href: stylesheetsFolder.appendingPath("ReadiumCSS-before.css")!.string,
+            href: stylesheetsFolder.appendingPath("ReadiumCSS-before.css", isDirectory: false).string,
             prepend: true
         ))
         if !hasStyles {
-            inj.append(.stylesheetLink(href: stylesheetsFolder.appendingPath("ReadiumCSS-default.css")!.string))
+            inj.append(.stylesheetLink(href: stylesheetsFolder.appendingPath("ReadiumCSS-default.css", isDirectory: false).string))
         }
-        inj.append(.stylesheetLink(href: stylesheetsFolder.appendingPath("ReadiumCSS-after.css")!.string))
+        inj.append(.stylesheetLink(href: stylesheetsFolder.appendingPath("ReadiumCSS-after.css", isDirectory: false).string))
 
         // Fix Readium CSS issue with the positioning of <audio> elements.
         // https://github.com/readium/readium-css/issues/94

Sources/Navigator/EPUB/EPUBNavigatorViewModel.swift

@@ -58,12 +58,15 @@ final class EPUBNavigatorViewModel: Loggable {
             )
         }
 
+        let resourceURL = Bundle.module.resourceURL!.fileURL!
+
         // FIXME: Remove in Readium 3.0
         // Serve the fonts under the /fonts endpoint as the Streamer's
         // EPUBHTMLInjector is expecting it there.
-        if let fontsURL = (Bundle.module.resourceURL?.appendingPathComponent("Assets/Static/fonts")).flatMap(FileURL.init(url:)) {
-            try httpServer.serve(at: "fonts", contentsOf: fontsURL)
-        }
+        try httpServer.serve(
+            at: "fonts",
+            contentsOf: resourceURL.appendingPath("Assets/Static/fonts", isDirectory: true)
+        )
 
         try self.init(
             publication: publication,
@@ -73,7 +76,7 @@ final class EPUBNavigatorViewModel: Loggable {
             publicationBaseURL: baseURL,
             assetsURL: httpServer.serve(
                 at: "readium",
-                contentsOf: FileURL(url: Bundle.module.resourceURL!.appendingPathComponent("Assets/Static"))!
+                contentsOf: resourceURL.appendingPath("Assets/Static", isDirectory: true)
             ),
             useLegacySettings: false
         )
@@ -105,25 +108,25 @@ final class EPUBNavigatorViewModel: Loggable {
     ) {
         var config = config
 
-        if let fontsDir = Bundle.module.resourceURL.flatMap(FileURL.init(url:))?.appendingPath("Assets/Static/fonts") {
+        if let fontsDir = Bundle.module.resourceURL?.fileURL?.appendingPath("Assets/Static/fonts", isDirectory: true) {
             config.fontFamilyDeclarations.append(
                 CSSFontFamilyDeclaration(
                     fontFamily: .openDyslexic,
                     fontFaces: [
                         CSSFontFace(
-                            file: fontsDir.appendingPath("OpenDyslexic-Regular.otf")!,
+                            file: fontsDir.appendingPath("OpenDyslexic-Regular.otf", isDirectory: false),
                             style: .normal, weight: .standard(.normal)
                         ),
                         CSSFontFace(
-                            file: fontsDir.appendingPath("OpenDyslexic-Italic.otf")!,
+                            file: fontsDir.appendingPath("OpenDyslexic-Italic.otf", isDirectory: false),
                             style: .italic, weight: .standard(.normal)
                         ),
                         CSSFontFace(
-                            file: fontsDir.appendingPath("OpenDyslexic-Bold.otf")!,
+                            file: fontsDir.appendingPath("OpenDyslexic-Bold.otf", isDirectory: false),
                             style: .normal, weight: .standard(.bold)
                         ),
                         CSSFontFace(
-                            file: fontsDir.appendingPath("OpenDyslexic-BoldItalic.otf")!,
+                            file: fontsDir.appendingPath("OpenDyslexic-BoldItalic.otf", isDirectory: false),
                             style: .italic, weight: .standard(.bold)
                         ),
                     ]
@@ -150,7 +153,7 @@ final class EPUBNavigatorViewModel: Loggable {
         css = ReadiumCSS(
             layout: CSSLayout(),
             rsProperties: config.readiumCSSRSProperties,
-            baseURL: assetsURL.appendingPath("readium-css/")!,
+            baseURL: assetsURL.appendingPath("readium-css", isDirectory: true),
             fontFamilyDeclarations: config.fontFamilyDeclarations
         )