@capacitor/filesystem 5.0.6-nightly-20230712T151609.0 → 5.1.1-nightly-20230713T150800.0

package/ios/Plugin/Filesystem.swift

@@ -1,4 +1,5 @@
 import Foundation
+import Capacitor
 
 @objc public class Filesystem: NSObject {
 
@@ -21,6 +22,8 @@ import Foundation
         }
     }
 
+    public typealias ProgressEmitter = (_ bytes: Int64, _ contentLength: Int64) -> Void
+
     public func readFile(at fileUrl: URL, with encoding: String?) throws -> String {
         if encoding != nil {
             let data = try String(contentsOf: fileUrl, encoding: .utf8)
@@ -176,4 +179,158 @@ import Foundation
             return URL(string: path)
         }
     }
+
+    // swiftlint:disable function_body_length
+    @objc public func downloadFile(call: CAPPluginCall, emitter: @escaping ProgressEmitter, config: InstanceConfiguration?) throws {
+        let directory = call.getString("directory", "DOCUMENTS")
+        guard let path = call.getString("path") else {
+            call.reject("Invalid file path")
+            return
+        }
+
+        func handleDownload(downloadLocation: URL?, response: URLResponse?, error: Error?) {
+            if let error = error {
+                CAPLog.print("Error on download file", String(describing: downloadLocation), String(describing: response), String(describing: error))
+                call.reject(error.localizedDescription, "DOWNLOAD", error, nil)
+                return
+            }
+
+            if let httpResponse = response as? HTTPURLResponse {
+                HttpRequestHandler.setCookiesFromResponse(httpResponse, config)
+            }
+
+            guard let location = downloadLocation else {
+                call.reject("Unable to get file after downloading")
+                return
+            }
+
+            let fileManager = FileManager.default
+
+            if let foundDir = getDirectory(directory: directory) {
+                let dir = fileManager.urls(for: foundDir, in: .userDomainMask).first
+
+                do {
+                    let dest = dir!.appendingPathComponent(path)
+                    CAPLog.print("Attempting to write to file destination: \(dest.absoluteString)")
+
+                    if !FileManager.default.fileExists(atPath: dest.deletingLastPathComponent().absoluteString) {
+                        try FileManager.default.createDirectory(at: dest.deletingLastPathComponent(), withIntermediateDirectories: true, attributes: nil)
+                    }
+
+                    if FileManager.default.fileExists(atPath: dest.relativePath) {
+                        do {
+                            CAPLog.print("File already exists. Attempting to remove file before writing.")
+                            try fileManager.removeItem(at: dest)
+                        } catch let error {
+                            call.reject("Unable to remove existing file: \(error.localizedDescription)")
+                            return
+                        }
+                    }
+
+                    try fileManager.moveItem(at: location, to: dest)
+                    CAPLog.print("Downloaded file successfully! \(dest.absoluteString)")
+                    call.resolve(["path": dest.absoluteString])
+                } catch let error {
+                    call.reject("Unable to download file: \(error.localizedDescription)", "DOWNLOAD", error)
+                    return
+                }
+            } else {
+                call.reject("Unable to download file. Couldn't find directory \(directory)")
+            }
+        }
+
+        guard var urlString = call.getString("url") else { throw URLError(.badURL) }
+        let method = call.getString("method", "GET")
+
+        let headers = (call.getObject("headers") ?? [:]) as [String: Any]
+        let params = (call.getObject("params") ?? [:]) as [String: Any]
+        let responseType = call.getString("responseType", "text")
+        let connectTimeout = call.getDouble("connectTimeout")
+        let readTimeout = call.getDouble("readTimeout")
+
+        if urlString == urlString.removingPercentEncoding {
+            guard let encodedUrlString = urlString.addingPercentEncoding(withAllowedCharacters: .urlQueryAllowed)  else { throw URLError(.badURL) }
+            urlString = encodedUrlString
+        }
+
+        let progress = call.getBool("progress", false)
+
+        let request = try HttpRequestHandler.CapacitorHttpRequestBuilder()
+            .setUrl(urlString)
+            .setMethod(method)
+            .setUrlParams(params)
+            .openConnection()
+            .build()
+
+        request.setRequestHeaders(headers)
+
+        // Timeouts in iOS are in seconds. So read the value in millis and divide by 1000
+        let timeout = (connectTimeout ?? readTimeout ?? 600000.0) / 1000.0
+        request.setTimeout(timeout)
+
+        if let data = call.options["data"] as? JSValue {
+            do {
+                try request.setRequestBody(data)
+            } catch {
+                // Explicitly reject if the http request body was not set successfully,
+                // so as to not send a known malformed request, and to provide the developer with additional context.
+                call.reject(error.localizedDescription, (error as NSError).domain, error, nil)
+                return
+            }
+        }
+
+        var session: URLSession!
+        var task: URLSessionDownloadTask!
+        let urlRequest = request.getUrlRequest()
+
+        if progress {
+            class ProgressDelegate: NSObject, URLSessionDataDelegate, URLSessionDownloadDelegate {
+                private var handler: (URL?, URLResponse?, Error?) -> Void
+                private var downloadLocation: URL?
+                private var response: URLResponse?
+                private var emitter: (Int64, Int64) -> Void
+                private var lastEmitTimestamp: TimeInterval = 0.0
+
+                init(downloadHandler: @escaping (URL?, URLResponse?, Error?) -> Void, progressEmitter: @escaping (Int64, Int64) -> Void) {
+                    handler = downloadHandler
+                    emitter = progressEmitter
+                }
+
+                func urlSession(_ session: URLSession, downloadTask: URLSessionDownloadTask, didWriteData bytesWritten: Int64, totalBytesWritten: Int64, totalBytesExpectedToWrite: Int64) {
+                    let currentTimestamp = Date().timeIntervalSince1970
+                    let timeElapsed = currentTimestamp - lastEmitTimestamp
+
+                    if totalBytesExpectedToWrite > 0 {
+                        if timeElapsed >= 0.1 {
+                            emitter(totalBytesWritten, totalBytesExpectedToWrite)
+                            lastEmitTimestamp = currentTimestamp
+                        }
+                    } else {
+                        emitter(totalBytesWritten, 0)
+                        lastEmitTimestamp = currentTimestamp
+                    }
+                }
+
+                func urlSession(_ session: URLSession, downloadTask: URLSessionDownloadTask, didFinishDownloadingTo location: URL) {
+                    downloadLocation = location
+                    handler(downloadLocation, downloadTask.response, downloadTask.error)
+                }
+
+                func urlSession(_ session: URLSession, task: URLSessionTask, didCompleteWithError error: Error?) {
+                    if error != nil {
+                        handler(downloadLocation, task.response, error)
+                    }
+                }
+            }
+
+            let progressDelegate = ProgressDelegate(downloadHandler: handleDownload, progressEmitter: emitter)
+            session = URLSession(configuration: .default, delegate: progressDelegate, delegateQueue: nil)
+            task = session.downloadTask(with: urlRequest)
+        } else {
+            task = URLSession.shared.downloadTask(with: urlRequest, completionHandler: handleDownload)
+        }
+
+        task.resume()
+    }
+    // swiftlint:enable function_body_length
 }

package/ios/Plugin/FilesystemPlugin.m

@@ -17,4 +17,5 @@ CAP_PLUGIN(FilesystemPlugin, "Filesystem",
            CAP_PLUGIN_METHOD(copy, CAPPluginReturnPromise);
            CAP_PLUGIN_METHOD(checkPermissions, CAPPluginReturnPromise);
            CAP_PLUGIN_METHOD(requestPermissions, CAPPluginReturnPromise);
+           CAP_PLUGIN_METHOD(downloadFile, CAPPluginReturnPromise);
 )

package/ios/Plugin/FilesystemPlugin.swift

@@ -345,6 +345,23 @@ public class FilesystemPlugin: CAPPlugin {
         ])
     }
 
+    @objc func downloadFile(_ call: CAPPluginCall) {
+        guard let url = call.getString("url") else { return call.reject("Must provide a URL") }
+        let progressEmitter: Filesystem.ProgressEmitter = { bytes, contentLength in
+            self.notifyListeners("progress", data: [
+                "url": url,
+                "bytes": bytes,
+                "contentLength": contentLength
+            ])
+        }
+
+        do {
+            try implementation.downloadFile(call: call, emitter: progressEmitter, config: bridge?.config)
+        } catch let error {
+            call.reject(error.localizedDescription)
+        }
+    }
+
     /**
      * Helper for handling errors
      */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@capacitor/filesystem",
-  "version": "5.0.6-nightly-20230712T151609.0",
+  "version": "5.1.1-nightly-20230713T150800.0",
   "description": "The Filesystem API provides a NodeJS-like API for working with files on the device.",
   "main": "dist/plugin.cjs.js",
   "module": "dist/esm/index.js",
@@ -45,10 +45,10 @@
     "publish:cocoapod": "pod trunk push ./CapacitorFilesystem.podspec --allow-warnings"
   },
   "devDependencies": {
-    "@capacitor/android": "^5.0.0",
-    "@capacitor/core": "^5.0.0",
+    "@capacitor/android": "^5.1.1",
+    "@capacitor/core": "^5.1.1",
     "@capacitor/docgen": "0.2.0",
-    "@capacitor/ios": "^5.0.0",
+    "@capacitor/ios": "^5.1.1",
     "@ionic/eslint-config": "^0.3.0",
     "@ionic/prettier-config": "~1.0.1",
     "@ionic/swiftlint-config": "^1.1.2",
@@ -61,7 +61,7 @@
     "typescript": "~4.1.5"
   },
   "peerDependencies": {
-    "@capacitor/core": "^5.0.0"
+    "@capacitor/core": "^5.1.1"
   },
   "prettier": "@ionic/prettier-config",
   "swiftlint": "@ionic/swiftlint-config",