FTP

説明

ftp タスクは、ファイルの送受信、一覧表示、削除、ディレクトリの作成を行うことができる基本的な FTP クライアントを実装します。各タスクの実行方法の説明と例については、以下を参照してください。

注: このタスクは、Apache Ant ディストリビューションには含まれていない外部ライブラリに依存しています。詳細については、ライブラリの依存関係を参照してください。Ant での最適なサポートを受けるために、このライブラリの最新バージョンを入手してください。

ftp タスクは、FTP サーバーで使用されているファイルシステムの種類を判断しようとします。サポートされているサーバーの種類は、Unix、NT、OS2、VMS、および OS400 です。さらに、Unix スタイルでディレクトリを表示するように構成された NT および OS400 サーバーも正しくサポートされています。それ以外の場合は、システムはデフォルトで Unix 標準を使用します。remotedir は、FTP サーバーで必要な構文で指定する必要があります。サーバーで通常の Unix 規則がサポートされていない場合は、separator を使用して、代わりに使用するファイル区切り文字を設定できます。

ファイルの包含/除外がどのように機能するか、およびパターンの記述方法については、ディレクトリベースのタスクのセクションを参照してください。

このタスクは現在、<setproxy> タスクによって設定されたプロキシ情報を使用しておらず、socks 経由でファイアウォールを通過することはできません。

警告: newer 属性を使用した ftp の「get」に関して、問題が報告されています。問題は、commons-net が予期しているものと ls -l の形式が異なることが原因である可能性があります。たとえば、FTP サーバーがディレクトリ一覧に使用する言語の特性が原因である可能性があります。このような問題が発生した場合は、FTP サーバーからのサンプルディレクトリ一覧（FTP プロンプトで ls -l）を含むメールを送信してください。

接続できるがアップロードまたはダウンロードできない場合は、passive 属性を「true」に設定して、サーバーが新しい接続をセットアップしようとする代わりに、既存の（開いている）チャネルを使用してみてください。

パラメータ

remotedir 属性に関する注意

ネストされた要素として指定されたパラメータ

fileset

ftp タスクは、取得、削除、一覧表示、またはモードを変更するファイルを指定するために、任意の数のネストされた <fileset> 要素をサポートします。

fileset の followsymlinks 属性は、ローカル (put) およびリモート (get、chmod、delete、list) の fileset でサポートされています。*Ant 1.6 より前では、リモート fileset でシンボリックリンクはサポートされていませんでした。シンボリックリンクを除外する（Ant 1.5.x 以前の動作を維持する）には、followsymlinks を明示的に false に設定する必要があります。* リモート fileset では、隠しファイルがシンボリックリンクであるかどうかはチェックされません。隠しファイルは現在、シンボリックリンクではないと想定されています。

ファイルの送信

ファイルの送信方法を説明する最も簡単な方法は、いくつかの例を示すことです。

ftp.apache.org に anonymous としてログインし、htdocs/manual ディレクトリ内のすべてのファイルを、そのユーザーのデフォルトディレクトリにアップロードします。

<ftp server="ftp.apache.org"
     userid="anonymous"
     password="me@myorg.com">
    <fileset dir="htdocs/manual"/>
</ftp>

ftp.apache.org に anonymous としてログインし、htdocs/manual ディレクトリ内の新規または変更されたすべてのファイルを、anonymous のデフォルトディレクトリを基準とした incoming ディレクトリにアップロードします。

<ftp server="ftp.apache.org"
     remotedir="incoming"
     userid="anonymous"
     password="me@myorg.com"
     depends="yes">
    <fileset dir="htdocs/manual"/>
</ftp>

ポート 2121 の ftp.apache.org に、パスワード java1 を使用して coder としてログインし、htdocs/manual ディレクトリ内の新規または変更されたすべての HTML ファイルを /pub/incoming ディレクトリにアップロードします。ファイルはテキストモードで転送されます。ファイアウォールの背後からファイルを送信するために、パッシブモードがオンになっています。

<ftp server="ftp.apache.org"
     port="2121"
     remotedir="/pub/incoming"
     userid="coder"
     password="java1"
     passive="yes"
     depends="yes"
     binary="no">
    <fileset dir="htdocs/manual">
        <include name="**/*.html"/>
    </fileset>
</ftp>

ポート 2121 の Windows サーバー ftp.hypothetical.india.org に、パスワード java1 を使用して coder としてログインし、htdocs/manual ディレクトリ内の新規または変更された（タイムゾーンの違いを考慮した）すべての HTML ファイルを /pub/incoming ディレクトリにアップロードします。ファイルはテキストモードで転送されます。

<ftp server="ftp.hypothetical.india.org"
     port="2121"
     remotedir="/pub/incoming"
     userid="coder"
     password="java1"
     depends="yes"
     binary="no"
     systemTypeKey="Windows"
     serverTimeZoneConfig="India/Calcutta">
    <fileset dir="htdocs/manual">
        <include name="**/*.html"/>
    </fileset>
</ftp>

Windows ベースの ftp.nt.org に、パスワード java1 を使用して coder としてログインし、htdocs/manual ディレクトリ内のすべての HTML ファイルを c:\uploads ディレクトリにアップロードします。各ファイルのアップロード時に進行状況メッセージが表示されます。

<ftp server="ftp.nt.org"
     remotedir="c:\uploads"
     userid="coder"
     password="java1"
     separator="\"
     verbose="yes">
    <fileset dir="htdocs/manual">
        <include name="**/*.html"/>
    </fileset>
</ftp>

ファイルの取得

FTP サーバーからファイルを取得する方法は、ファイルを送信する方法とほぼ同じです。唯一の違いは、ネストされた fileset が remotedir 属性を FTP サーバー上のファイルのベースディレクトリとして使用し、dir 属性をファイルを配置するローカルディレクトリとして使用することです。 FTP サイトからのファイル構造は、ローカルマシンに保持されます。

ftp.apache.org に anonymous としてログインし、そのユーザーのデフォルトディレクトリからすべての .html ファイルをローカルマシンの htdocs/manual ディレクトリに再帰的にダウンロードします。

<ftp action="get"
     server="ftp.apache.org"
     userid="anonymous"
     password="me@myorg.com">
    <fileset dir="htdocs/manual">
        <include name="**/*.html"/>
    </fileset>
</ftp>

apache.org が、タイムスタンプに新しいすべて数字の形式を使用する Unix FTP サーバーに切り替えた場合、このバージョンが必要になります。前の例と同じ機能を実現しますが、数値のタイムスタンプを正常に処理します。systemTypeKey はここでは必須ではありませんが、何が起こっているのかを明確にするのに役立ちます。

<ftp action="get"
     server="ftp.apache.org"
     userid="anonymous"
     password="me@myorg.com"
     systemTypeKey="UNIX"
     defaultDateFormatConfig="yyyy-MM-dd HH:mm">
    <fileset dir="htdocs/manual">
        <include name="**/*.html"/>
    </fileset>
</ftp>

日付を標準的なヨーロッパ形式のフランス語名で表示する UNIX FTP サーバー ftp.hypothetical.fr に anonymous としてログインし、そのユーザーのデフォルトディレクトリからすべての .html ファイルをローカルマシンの htdocs/manual ディレクトリに再帰的にダウンロードします。

<ftp action="get"
     server="ftp.hypthetical.fr"
     userid="anonymous"
     password="me@myorg.com"
     defaultDateFormatConfig="d MMM yyyy"
     recentDateFormatConfig="d MMM HH:mm"
     serverLanguageCodeConfig="fr">
    <fileset dir="htdocs/manual">
        <include name="**/*.html"/>
    </fileset>
</ftp>

ファイルの削除

おそらくもうお分かりのように、ネストされた fileset 要素を使用して、リモート FTP サーバーから削除するファイルを選択します。繰り返しますが、fileset はローカルディレクトリではなく、リモートディレクトリを基準としています。実際、fileset の dir 属性は完全に無視されます。

ftp.apache.org に anonymous としてログインし、そのユーザーのデフォルトディレクトリからすべての *.tmp ファイルを削除してみます。ファイルの削除権限がない場合は、BuildException がスローされます。

<ftp action="del"
     server="ftp.apache.org"
     userid="anonymous"
     password="me@myorg.com">
    <fileset>
        <include name="**/*.tmp"/>
    </fileset>
</ftp>

ファイルの一覧表示

anonymous ユーザーのデフォルトディレクトリを基準とした FTP サーバー上のすべてのファイルのファイルリストを data/ftp.listing に取得します。リストは、FTP サーバーが通常ファイルをリストする形式です。

<ftp action="list"
     server="ftp.apache.org"
     userid="anonymous"
     password="me@myorg.com"
     listing="data/ftp.listing">
    <fileset>
        <include name="**"/>
    </fileset>
</ftp>

ディレクトリの作成

mkdir アクションでは、作成するディレクトリは remotedir 属性を使用して指定することに注意してください。

デフォルトのルートディレクトリの下に some/remote/dir ディレクトリを作成します。他のすべてのアクションと同様に、ディレクトリ区切り文字は FTP サーバーの要件に従って正しい必要があります。

<ftp action="mkdir"
     server="ftp.apache.org"
     userid="anonymous"
     password="me@myorg.com"
     remotedir="some/remote/dir"/>

ディレクトリの削除

このアクションは、ネストされた fileset 要素を使用して、リモート FTP サーバーから削除するディレクトリを選択します。 fileset はローカルディレクトリではなく、リモートディレクトリを基準としています。 fileset の dir 属性は完全に無視されます。削除するディレクトリは空であるか、fileset パターンによって削除対象として選択された他のディレクトリのみを含んでいる必要があります。そうでない場合、BuildException がスローされます。また、ディレクトリの削除権限がない場合も、BuildException がスローされます。

ftp.apache.org に anonymous としてログインし、/somedir/dira ディレクトリと、/somedir/dirb から始まるすべてのディレクトリツリーを削除してみます。/somedir/dirb ツリーを削除する場合、タスクはリーフからルートに向かって開始されるため、ディレクトリを削除しようとするときに、その下のすべてのディレクトリが既に削除されていることが確実になります。明らかに、ツリー内のすべてのファイルは既に削除されている必要があります。

<ftp action="rmdir"
     server="ftp.apache.org"
     userid="anonymous"
     password="me@myorg.com"
     remotedir="/somedir" >
    <fileset>
        <include name="dira"/>
        <include name="dirb/**"/>
    </fileset>
</ftp>

例として、/somedir に含まれるすべてを削除する場合、最初に action=delete で <ftp> タスクを呼び出し、次に action=rmdir で remotedir=/somedir を指定し、

<fileset>
    <include name="**"/>
</fileset>

remotedir パラメータで指定されたディレクトリは削除対象として選択されることはないため、削除する必要がある場合は、remotedir パラメータでその親ディレクトリを指定し、somedir/** のように <fileset> パターンに含めます。