SwiftのFTPでファイルを削除する。 - プログラムを書こう！

この記事は2018年10月01日に投稿しました。

f:id:paveway:20190914064630j:plain

1. はじめに

こんにちは、iOSのエディタアプリPWEditorの開発者の二俣です。
今回はSwiftのFTPでファイルを削除してみます。

PWEditorでは、SwiftでFTPを操作するため、

BlackRaccoonライブラリ

を使用しています。

目次へ

2. 前提

下記の記事を参考にBlackRaccoonライブラリを使用できる状態にしておいてください。

paveway.hatenablog.com

目次へ

3. ファイル削除処理

SwiftのFTPでファイルを削除するには、BlackRaccoonライブラリのFTPデリート(BRRequestDelete)オブジェクトを使用します。
このオブジェクトで、ディレクトリも削除できます。
ディレクトリを削除した場合、その配下のディレクトリやファイルも一緒に削除されます。

以下に手順を示します。

FTPファイルを削除するViewControllerにBRReqeuestDelegateを設定します。
FTPファイル削除行うFTPデリート(BRRequestDelete)オブジェクトをインスタンス変数で用意します。
FTPデリート(BRRequestDelete)オブジェクトを生成し、FTPで接続するパラメータ(ホスト名、ユーザ名、パスワード、パス名)を設定します。
- ホスト名は、IPアドレス形式またはURL形式で指定可能です。
- ホスト名、ユーザ名、パスワードに使用できる文字は1バイト文字のみです。 2バイト文字の場合、クラッシュします。
- パス名に、削除するファイルパス名またはディレクトリパス名を指定します。
FTPデリート(BRRequestDelete)オブジェクトのstartメソッドを実行し、ファイル削除を開始します。
ファイルデータ取得の結果は、以下のメソッドでコールバックされます。
- 正常な場合はrequestCompletedメソッド
- エラーの場合はrequestFaildメソッド
- ファイルの更新許可を判定する場合はshouldOverwriteFileWithRequestメソッド
requestDataAvailableメソッド以外のコールバックメソッドはドキュメントをみるとわかるように、他のファイル操作を行った場合も呼び出されます。
そのため引数requestがFTPデリート(BRRequestDelete)オブジェクトと等しいかチェックして、FTPデリートの結果としてコールバックメソッドが呼び出されたか判断しています。

shouldOverwriteFileWithRequestメソッドは、おそらくFTPアップロードの時にだけ必要なメソッドで、既存のファイルを上書きしてよいかどうかを返却します。
そのためFTPアップロードの時はtrue、それ以外はfalseを返却するようにしています。
最後に2重起動防止のため、FTPデリート(BRRequestDelete)オブジェクトをクリアします。

実装例

class FtpFileDeleteViewController: UIViewController, BRRequestDelegate {

    // 2. FTPデリートオブジェクト
    var ftpDelete: BRRequestDelete!

    /**
     FTPでファイル削除を開始します。
     */
    func startDeleteFile(_ pathName: String) {
        if ftpDelete != nil {
            // FTPデリートオブジェクトが有効な場合、2重起動防止のため処理を終了します。
            return
        }

        // 3. FTPデリートオブジェクトを生成し、FTPで接続するパラメータを設定します。
        ftpDelete = BRRequestDelete(delegate: self)
        ftpDelete.hostname = <ホスト名>
        ftpDelete.username = <ユーザ名>
        ftpDelete.password = <パスワード>
        ftpDelete.path = pathName
        
        // 4. ファイル削除を開始します。
        ftpDelete.start()
    }
    
    /**
     5. FTPのリクエストが完了した時に呼び出されます。

     - Parameter request: FTPリクエスト
     */
    func requestCompleted(_ request: BRRequest) {
        if let request == ftpDelete {
            // FTPリクエストがFTPデリートオブジェクトと等しい場合
            // 正常終了の場合の処理を記述してください。
            
            // 6. 2重起動防止のため、FTPデリートオブジェクトをクリアします。
            ftpDelete = nil
        }
    }
    
    /**
     5. FTPリクエストがエラーした時に呼び出されます。

     - Parameter request: FTPリクエスト
     */
    func requestFailed(_ request: BRRequest) {
        if let request == ftpDelete {
            // FTPリクエストがFTPデリートオブジェクトと等しい場合
            // エラー終了の場合の処理を記述してください。
            
            // 6. 2重起動防止のため、FTPデリートオブジェクトをクリアします。
            ftpDelete = nil
        }
    }
    
    /**
     5. 上書きリクエスト時に呼び出されます。

     - Parameter request: FTPリクエスト
     */
    func shouldOverwriteFileWithRequest(_ request: BRRequest) -> Bool {
        // 上書きを禁止します。
        return false
    }
}

目次へ

4. おわりに

BlackRaccoonライブラリでコピーと移動はサポートされていないため、今回でFTPのファイル操作の紹介は終わります。

D-SCHOOLオンライン

たった2日でマスターできる iOSアプリ開発集中講座 Xcode 9/Swift 4対応

作者: 藤治仁,小林加奈子,小林由憲
出版社/メーカー: ソシム
発売日: 2017/11/30
メディア: 単行本
この商品を含むブログを見る

紹介している一部の記事のコードはGitlabで公開しています。
興味のある方は覗いてみてください。

目次へ

私が勤務しているニューラルでは、主に組み込み系ソフトの開発を行っております。
弊社製品のハイブリッドOS Bi-OSは高い技術力を評価されており、特に制御系や通信系を得意としています。
私自身はiOSモバイルアプリやウィンドウズアプリを得意としております。
ソフトウェア開発に関して相談などございましたら、お気軽にご連絡ください。

また一緒に働きたい技術者の方も随時募集中です。
興味がありましたらご連絡ください。

EMAIL : info-nr@newral.co.jp / m-futamata@newral.co.jp
TEL : 042-523-3663
FAX : 042-540-1688

目次へ