Giter VIP home page Giter VIP logo

amsmb2's Introduction

AMSMB2

This is small Swift library for iOS, macOS and tvOS which wraps libsmb2 and allows to connect a SMB2/3 share and do file operation.

Swift Version Platform License

Build Status Release version CocoaPods version Carthage compatible Accio supported

Install

Cocoapods / Carthage

Add this line to your pods file:

pod "AMSMB2"

Or add this to Cartfile:

github "amosavian/AMSMB2"

Accio

Add the following to your Package.swift:

.package(url: "https://github.com/amosavian/AMSMB2.git", .upToNextMajor(from: "1.8.0")),

Next, add AMSMB2 to your App targets dependencies like so:

.target(
    name: "App",
    dependencies: [
        "AMSMB2",
    ]
),

Then run accio update.

Manually

To have latest updates with ease, use this command on terminal to get a clone:

git clone https://github.com/amosavian/AMSMB2

You can update your library using this command in AMSMB2 folder:

git pull

if you have a git based project, use this command in your project's directory to add this project as a submodule to your project:

git submodule add https://github.com/amosavian/AMSMB2

Then drop AMSMB2.xcodeproj to you Xcode workspace and add the framework to your Embeded Binaries in target.

Usage

Just read inline help to find what each function does. It's straightforward. It's thread safe and any queue.

To do listing files in directory and file operations you must use this template:

import AMSMB2

class SMBClient {
    /// connect to: `smb://[email protected]/share`

    let serverURL = URL(string: "smb://XXX.XXX.XX.XX")!
    let credential = URLCredential(user: "guest", password: "", persistence: URLCredential.Persistence.forSession)
    let share = "share"
    
    func connect(handler: @escaping (_ client: AMSMB2?, _ error: Error?) -> Void) {
        let client = AMSMB2(url: self.serverURL, credential: self.credential)!
        client.connectShare(name: self.share) { error in
            handler(client, error)
        }
    }
    
    func listDirectory(path: String) {
        connect { (client, error) in
            if let error = error {
                print(error)
                return
            }
            
            client?.contentOfDirectory(atPath: path,
                                       completionHandler: { (files, error) in
                if let error = error {
                    print(error)
                    return
                }
                
                for entry in files {
                    print("name: ", entry[.nameKey] as! String,
                        ", path: ", entry[.pathKey],
                        ", type: ", entry[.fileResourceTypeKey] as? URLFileResourceType,
                        ", size: ", entry[.fileSizeKey] as? Int64,
                        ", modified: ", entry[.contentModificationDateKey],
                        ", created: ", entry[.creationDateKey]
                    )
                }
            })
        }
    }
    
    func moveItem(path: String, to toPath: String) {
        self.connect { (client, error) in
            if let error = error {
                print(error)
                return
            }
            
            client?.moveItem(atPath: path, toPath: toPath) { error in
                if let error = error {
                    print(error)
                } else {
                    print("\(path) moved successfully.")
                }
                
                // Disconnecting is optional, it will be called eventually
                // when `AMSMB2` object is freed.
                // You may call it explicitly to detect errors.
                client?.disconnectShare(completionHandler: { (error) in
                    if let error = error {
                        print(error)
                    }
                })
            }
        }
    }
}

License

While source code shipped with project is MIT licensed, but it has static link to libsmb2 which is LGPL v2.1, consequently the whole project becomes LGPL v2.1.

You must link this library dynamically to your app if you intend to distribute your app on App Store.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.