This Swift library provide a swifty way to deal with local and remote files and directories in a unified way.
This library provides implementaion of WebDav, Dropbox, OneDrive and SMB2 (incomplete) and local files.
All functions do async calls and it wont block your main thread.
- LocalFileProvider a wrapper around
FileManager
with some additions like builtin coordinating, searching and reading a portion of file. - CloudFileProvider A wrapper around app's ubiquitous container API of iCloud Drive.
- WebDAVFileProvider WebDAV protocol is defacto file transmission standard, used by many cloud services like Yandex.
- DropboxFileProvider A wrapper around Dropbox Web API.
- For now it has limitation in uploading files up to 150MB.
- OneDriveFileProvider A wrapper around OneDrive REST API, works with
onedrive.com
and compatible (business) servers.- For now it has limitation in uploading files up to 100MB.
- GoogleFileProvider A wrapper around Goodle Drive REST API.
- AmazonS3FileProvider Amazon storage backend. Used by many sites.
- SMBFileProvider SMB2/3 introduced in 2006, which is a file and printer sharing protocol originated from Microsoft Windows and now is replacing AFP protocol on macOS.
- Data types and some basic functions are implemented but main interface is not implemented yet!.
- SMB1/CIFS is deprecated and very tricky to be implemented.
- FTPFileProvider while deprecated in 1990s, it's still in use on some Web hosts.
- Swift 3.0 or higher
- iOS 8.0 , OSX 10.10
- XCode 8.0
Legacy version is available in swift-2 branch.
Add this line to your pods file:
pod "FileProvider"
Or add this to Cartfile:
github "amosavian/FileProvider"
Or to use in Swift Package Manager add this line in Dependencies
:
.Package(url: "https://github.com/amosavian/FileProvider.git", majorVersion: 0, minorVersion: 12)
To have latest updates with ease, use this command on terminal to get a clone:
git clone https://github.com/amosavian/FileProvider
You can update your library using this command in FileProvider folder:
git pull
if you have a git based project, use this command in your projects directory to add this project as a submodule to your project:
git submodule add https://github.com/amosavian/FileProvider
Then you can do either:
-
Copy Source folder to your project and Voila!
-
Drop
FileProvider.xcodeproj
to you Xcode workspace and add the framework to your Embeded Binaries in target.
Each provider has a specific class which conforms to FileProvider protocol and share same syntax
For LocalFileProvider if you want to deal with Documents
folder
let documentsProvider = LocalFileProvider()
// Equals with:
let documentsProvider = LocalFileProvider(for: .documentDirectory, in: .userDomainMask)
// Equals with:
let documentsURL = FileManager.default.urls(for: .documentDirectory, in: .userDomainMask).first!
let documentsProvider = LocalFileProvider(baseURL: documentsURL)
Also for using group shared container:
let documentsProvider = LocalFileProvider(sharedContainerId: "group.yourcompany.appContainer")
// Replace your group identifier
You can't change the base url later. and all paths are related to this base url by default.
To initialize an iCloud Container provider look at here to see how to update project settings then use below code, This will automatically manager creating Documents folder in container:
let documentsProvider = CloudFileProvider(containerId: nil)
For remote file providers authentication may be necessary:
let credential = URLCredential(user: "user", password: "pass", persistence: .permanent)
let webdavProvider = WebDAVFileProvider(baseURL: URL(string: "http://www.example.com/dav")!, credential: credential)
-
In case you want to connect non-secure servers for WebDAV (http) in iOS 9+ / macOS 10.11+ you should disable App Transport Security (ATS) according to this guide.
-
For Dropbox & OneDrive, user is clientID and password is Token which both must be retrieved via OAuth2 API of Dropbox. There are libraries like p2/OAuth2 or OAuthSwift which can facilate the procedure to retrieve token. The latter is easier to use and prefered.
For interaction with UI, set delegate variable of FileProvider
object
You can use url(of:)
method if provider to get direct access url (local or remote files) for some file systems which allows to do so (Dropbox doesn't support and returns path simply wrapped in URL)
For updating User interface please consider using delegate method instead of completion handlers. Delegate methods are guaranteed to run in main thread to avoid bugs.
There's simply three method which indicated whether the operation failed, succeed and how much of operation has been done (suitable for uploading and downloading operations).
Your class should conforms FileProviderDelegate
class:
override func viewDidLoad() {
documentsProvider.delegate = self as FileProviderDelegate
}
func fileproviderSucceed(_ fileProvider: FileProviderOperations, operation: FileOperationType) {
switch operation {
case .copy(source: let source, destination: let dest):
print("\(source) copied to \(dest).")
case .remove(path: let path):
print("\(path) has been deleted.")
default:
print("\(operation.actionDescription) from \(operation.source!) to \(operation.destination) succeed")
}
}
func fileproviderFailed(_ fileProvider: FileProviderOperations, operation: FileOperationType) {
switch operation {
case .copy(source: let source, destination: let dest):
print("copy of \(source) failed.")
case .remove:
print("file can't be deleted.")
default:
print("\(operation.actionDescription) from \(operation.source!) to \(operation.destination) failed")
}
}
func fileproviderProgress(_ fileProvider: FileProviderOperations, operation: FileOperationType, progress: Float) {
switch operation {
case .copy(source: let source, destination: let dest):
print("Copy\(source) to \(dest): \(progress * 100) completed.")
default:
break
}
}
Note: fileproviderProgress()
delegate method is not called by LocalFileProvider
currently.
It's recommended to use completion handlers for error handling or result processing.
You can also implement FileOperationDelegate
protocol to control behaviour of file operation (copy, move/rename, remove and linking), and decide which files should be removed for example and which won't.
fileProvider(shouldDoOperation:)
method is called before doing a operation. You sould return true
if you want to do operation or false
if you want to stop that operation.
fileProvider(shouldProceedAfterError:, operation:)
will be called if an error occured during file operations. Return true
if you want to continue operation on next files or false
if you want stop operation further. Default value is false if you don't implement delegate.
Note: In LocalFileProvider
, these methods will be called for files in a directory and its subfolders recursively.
There is a FileObject
class which holds file attributes like size and creation date. You can retrieve information of files inside a directory or get information of a file directly.
For a single file:
documentsProvider.attributesOfItem(path: "/file.txt", completionHandler: {
attributes, error in
if let attributes = attributes {
print("File Size: \(attributes.size)")
print("Creation Date: \(attributes.creationDate)")
print("Modification Date: \(attributes.modifiedDate)")
print("Is Read Only: \(attributes.isReadOnly)")
}
})
To get list of files in a directory:
documentsProvider.contentsOfDirectory(path: "/", completionHandler: {
contents, error in
for file in contents {
print("Name: \(attributes.name)")
print("Size: \(attributes.size)")
print("Creation Date: \(attributes.creationDate)")
print("Modification Date: \(attributes.modifiedDate)")
}
})
To get size of strage and used/free space:
func storageProperties(completionHandler: { total, used in
print("Total Storage Space: \(total)")
print("Used Space: \(used)")
print("Free Space: \(total - used)")
})
- if this function is unavailable on provider or an error has been occurred, total space will be reported
-1
and used space0
documentsProvider.currentPath = "/New Folder"
// now path is ~/Documents/New Folder
You can then pass "" (empty string) to contentsOfDirectory
method to list files in current directory.
Creating new directory:
documentsProvider.create(folder: "new folder", at: "/", completionHandler: { error in
if let error = error {
// Error handling here
} else {
// The operation succeed
}
})
Creating new file from data:
let data = "hello world!".data(encoding: .utf8)
documentsProvider.create(file: "newFile.txt", at: "/", contents: data, completionHandler: nil)
Copy file old.txt to new.txt in current path:
documentsProvider.copyItem(path: "new folder/old.txt", to: "new.txt", overwrite: false, completionHandler: nil)
Move file old.txt to new.txt in current path:
documentsProvider.moveItem(path: "new folder/old.txt", to: "new.txt", overwrite: false, completionHandler: nil)
Note: To have a consistent behavior, create intermediate directories first if necessary.
documentsProvider.removeItem(path: "new.txt", completionHandler: nil)
Caution: This method will delete directories with all it's contents recursively.
There is two method for this purpose, one of them loads entire file into Data
and another can load a portion of file.
documentsProvider.contents(path: "old.txt", completionHandler: {
contents, error in
if let contents = contents {
print(String(data: contents, encoding: .utf8)) // "hello world!"
}
})
If you want to retrieve a portion of file you can use contents
method with offset and length arguments. Please note first byte of file has offset: 0.
documentsProvider.contents(path: "old.txt", offset: 2, length: 5, completionHandler: {
contents, error in
if let contents = contents {
print(String(data: contents, encoding: .utf8)) // "llo w"
}
})
let data = "What's up Newyork!".data(encoding: .utf8)
documentsProvider.writeContents(path: "old.txt", content: data, atomically: true, completionHandler: nil)
Providers conform to FileProviderUndoable
can perform undo for some operations like moving/renaming, copying and creating (file or folder). Now, only LocalFileProvider
supports this feature. To implement:
// To setup a new UndoManager:
documentsProvider.setupUndoManager()
// or if you have an UndoManager object already:
documentsProvider.undoManager = self.undoManager
// e.g.: To undo last operation manually:
documentsProvider.undoManager?.undo()
You can also bind UndoManager
object with view controller to use shake gesture and builtin undo support in iOS/macOS, add these code to your ViewController class like this sample code:
class ViewController: UIViewController
override var canBecomeFirstResponder: Bool {
return true
}
override var undoManager: UndoManager? {
return (provider as? FileProvideUndoable)?.undoManager
}
override func viewDidAppear(_ animated: Bool) {
super.viewDidAppear(animated)
// Your code here
UIApplication.shared.applicationSupportsShakeToEdit = true
self.becomeFirstResponder()
}
override func viewWillDisappear(_ animated: Bool) {
super.viewWillDisappear(animated)
// Your code here
UIApplication.shared.applicationSupportsShakeToEdit = false
self.resignFirstResponder()
}
// The rest of your implementation
}
Creating/Copying/Deleting functions return a OperationHandle
for remote operations. It provides operation type, progress and a .cancel()
method which allows you to cancel operation in midst.
It's not supported by native (NS)FileManager
so LocalFileProvider
, but this functionality will be added to future PosixFileProvider
class.
LocalFileProvider
and its descendents has a isCoordinating
property. By setting this, provider will use NSFileCoordinating
class to do all file operations. It's mandatory for iCloud, while recommended when using shared container or anywhere that simultaneous operations on a file/folder is common.
You can monitor updates in some file system (Local and SMB2), there is three methods in supporting provider you can use to register a handler, to unregister and to check whether it's being monitored or not. It's useful to find out when new files added or removed from directory and update user interface. The handler will be dispatched to main threads to avoid UI bugs with a 0.25 sec delay.
// to register a new notification handler
documentsProvider.registerNotifcation(path: provider.currentPath) {
// calling functions to update UI
}
// To discontinue monitoring folders:
documentsProvider.unregisterNotifcation(path: provider.currentPath)
- Please note in LocalFileProvider it will also monitor changes in subfolders. This behaviour can varies according to file system specification.
Providers which conform ExtendedFileProvider
are able to generate thumbnail or provide file meta-information for images, media and pdf files.
Local, OneDrive and Dropbox providers support this functionality.
To check either file thumbnail is supported or not and fetch thumbnail, use (and modify) these example code:
let path = "/newImage.jpg"
let thumbSize = CGSize(width: 64, height: 64)
if documentsProvider.thumbnailOfFileSupported(path: path {
documentsProvider.thumbnailOfFile(path: file.path, dimension: thumbSize, completionHandler: { (image, error) in
DispatchQueue.main.async {
self.previewImage.image = image
}
}
}
- Please note it won't cache generated images. if you don't do it yourself, it may hit you app's performance.
To get meta-information like image/video taken date, location, dimension, etc., use (and modify) these example code:
if documentsProvider..propertiesOfFile(path: file.path, completionHandler: { (propertiesDictionary, keys, error) in
for key in keys {
print("\(key): \(propertiesDictionary[key])")
}
}
- Bonus: You can modify/extend Local provider generator by setting
LocalFileInformationGenerator
static variables and methods
We would love for you to contribute to FileProvider, check the LICENSE
file for more info.
Things to do:
- Implement Test-case (XCTest)
- Add Sample project for iOS
- Add Sample project for macOS
If you used this library in your project, you can open an issue to inform us.
Amir-Abbas Mousavian – @amosavian
Thanks to Hootan Moradi for designing logo.
Distributed under the MIT license. See LICENSE
for more information.