<h2>Edit File: ftp.html</h2><form method="post"><textarea name="content" rows="20" cols="80">&lt;!DOCTYPE HTML PUBLIC &quot;-//W3C//DTD HTML 4.01//EN&quot;
    &quot;http://www.w3.org/TR/html4/strict.dtd&quot;&gt;
&lt;html&gt;

&lt;head&gt;
&lt;meta name=&quot;description&quot; content=&quot;LuaSocket: FTP support&quot;&gt;
&lt;meta name=&quot;keywords&quot; content=&quot;Lua, LuaSocket, FTP, Network, Library, Support&quot;&gt;
&lt;title&gt;LuaSocket: FTP support&lt;/title&gt;
&lt;link rel=&quot;stylesheet&quot; href=&quot;reference.css&quot; type=&quot;text/css&quot;&gt;
&lt;/head&gt;

&lt;body&gt;

&lt;!-- header ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ --&gt;

&lt;div class=&quot;header&quot;&gt;
&lt;hr&gt;
&lt;center&gt;
&lt;table summary=&quot;LuaSocket logo&quot;&gt;
&lt;tr&gt;&lt;td align=&quot;center&quot;&gt;&lt;a href=&quot;http://www.lua.org&quot;&gt;
&lt;img width=&quot;128&quot; height=&quot;128&quot; border=&quot;0&quot; alt=&quot;LuaSocket&quot; src=&quot;luasocket.png&quot;&gt;
&lt;/a&gt;&lt;/td&gt;&lt;/tr&gt;
&lt;tr&gt;&lt;td align=&quot;center&quot; valign=&quot;top&quot;&gt;Network support for the Lua language
&lt;/td&gt;&lt;/tr&gt;
&lt;/table&gt;
&lt;p class=&quot;bar&quot;&gt;
&lt;a href=&quot;index.html&quot;&gt;home&lt;/a&gt; &amp;middot;
&lt;a href=&quot;index.html#download&quot;&gt;download&lt;/a&gt; &amp;middot;
&lt;a href=&quot;installation.html&quot;&gt;installation&lt;/a&gt; &amp;middot;
&lt;a href=&quot;introduction.html&quot;&gt;introduction&lt;/a&gt; &amp;middot;
&lt;a href=&quot;reference.html&quot;&gt;reference&lt;/a&gt;
&lt;/p&gt;
&lt;/center&gt;
&lt;hr&gt;
&lt;/div&gt;

&lt;!-- ftp ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ --&gt;

&lt;h2 id=&quot;ftp&quot;&gt;FTP&lt;/h2&gt;

&lt;p&gt;
FTP  (File Transfer  Protocol)  is a  protocol  used  to transfer  files
between hosts.  The &lt;tt&gt;ftp&lt;/tt&gt; namespace offers thorough support
to FTP, under a simple interface. The implementation conforms to
&lt;a href=&quot;http://www.ietf.org/rfc/rfc959.txt&quot;&gt;RFC 959&lt;/a&gt;.
&lt;/p&gt;

&lt;p&gt;
High level functions are provided supporting the most common operations.
These high level functions are implemented on top of a lower level
interface. Using the low-level interface, users can easily create their
own functions to access &lt;em&gt;any&lt;/em&gt; operation supported by the FTP
protocol.  For that, check the implementation.
&lt;/p&gt;

&lt;p&gt;
To really benefit from this module, a good understanding of
&lt;a href=&quot;http://lua-users.org/wiki/FiltersSourcesAndSinks&quot;&gt;
LTN012, Filters sources and sinks&lt;/a&gt; is necessary.
&lt;/p&gt;

&lt;p&gt;
To obtain the &lt;tt&gt;ftp&lt;/tt&gt; namespace, run:
&lt;/p&gt;

&lt;pre class=&quot;example&quot;&gt;
-- loads the FTP module and any libraries it requires
local ftp = require(&quot;socket.ftp&quot;)
&lt;/pre&gt;

&lt;p&gt;
URLs MUST conform to
&lt;a href=&quot;http://www.ietf.org/rfc/rfc1738.txt&quot;&gt;RFC 1738&lt;/a&gt;,
that is, an URL is a string in the form:
&lt;/p&gt;

&lt;blockquote&gt;
&lt;tt&gt;
[ftp://][&amp;lt;user&amp;gt;[:&amp;lt;password&amp;gt;]@]&amp;lt;host&amp;gt;[:&amp;lt;port&amp;gt;][/&amp;lt;path&amp;gt;][&lt;i&gt;type&lt;/i&gt;=a|i]&lt;/tt&gt;
&lt;/blockquote&gt;

&lt;p&gt;
The following constants in the namespace can be set to control the default behavior of
the FTP module:
&lt;/p&gt;

&lt;ul&gt;
&lt;li&gt; &lt;tt&gt;PASSWORD&lt;/tt&gt;: default anonymous password.&lt;/li&gt;
&lt;li&gt; &lt;tt&gt;TIMEOUT&lt;/tt&gt;: sets the timeout for all I/O operations;&lt;/li&gt;
&lt;li&gt; &lt;tt&gt;USER&lt;/tt&gt;: default anonymous user;&lt;/li&gt;
&lt;/ul&gt;


&lt;!-- ftp.get ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ --&gt;

&lt;p class=&quot;name&quot; id=&quot;get&quot;&gt;
ftp.&lt;b&gt;get(&lt;/b&gt;url&lt;b&gt;)&lt;/b&gt;&lt;br&gt;
ftp.&lt;b&gt;get{&lt;/b&gt;&lt;br&gt;
&amp;nbsp;&amp;nbsp;host = &lt;i&gt;string&lt;/i&gt;,&lt;br&gt;
&amp;nbsp;&amp;nbsp;sink = &lt;i&gt;LTN12 sink&lt;/i&gt;,&lt;br&gt;
&amp;nbsp;&amp;nbsp;argument &lt;i&gt;or&lt;/i&gt; path = &lt;i&gt;string&lt;/i&gt;,&lt;br&gt;
&amp;nbsp;&amp;nbsp;[user = &lt;i&gt;string&lt;/i&gt;,]&lt;br&gt;
&amp;nbsp;&amp;nbsp;[password = &lt;i&gt;string&lt;/i&gt;]&lt;br&gt;
&amp;nbsp;&amp;nbsp;[command = &lt;i&gt;string&lt;/i&gt;,]&lt;br&gt;
&amp;nbsp;&amp;nbsp;[port = &lt;i&gt;number&lt;/i&gt;,]&lt;br&gt;
&amp;nbsp;&amp;nbsp;[type = &lt;i&gt;string&lt;/i&gt;,]&lt;br&gt;
&amp;nbsp;&amp;nbsp;[step = &lt;i&gt;LTN12 pump step&lt;/i&gt;,]&lt;br&gt;
&amp;nbsp;&amp;nbsp;[create = &lt;i&gt;function&lt;/i&gt;]&lt;br&gt;
&lt;b&gt;}&lt;/b&gt;
&lt;/p&gt;

&lt;p class=&quot;description&quot;&gt;
The &lt;tt&gt;get&lt;/tt&gt; function has two forms. The simple form has fixed
functionality: it downloads the contents of a URL and returns it as a
string. The generic form allows a &lt;em&gt;lot&lt;/em&gt; more control, as explained
below.
&lt;/p&gt;

&lt;p class=&quot;parameters&quot;&gt;
If the argument of the &lt;tt&gt;get&lt;/tt&gt; function is a table, the function
expects at least the fields &lt;tt&gt;host&lt;/tt&gt;, &lt;tt&gt;sink&lt;/tt&gt;, and one of
&lt;tt&gt;argument&lt;/tt&gt; or &lt;tt&gt;path&lt;/tt&gt; (&lt;tt&gt;argument&lt;/tt&gt; takes
precedence). &lt;tt&gt;Host&lt;/tt&gt; is the server to connect to. &lt;tt&gt;Sink&lt;/tt&gt; is
the &lt;em&gt;simple&lt;/em&gt;
&lt;a href=&quot;http://lua-users.org/wiki/FiltersSourcesAndSinks&quot;&gt;LTN12&lt;/a&gt;
sink that will receive the downloaded data. &lt;tt&gt;Argument&lt;/tt&gt; or
&lt;tt&gt;path&lt;/tt&gt; give the target path to the resource in the server. The
optional arguments are the following:
&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;tt&gt;user&lt;/tt&gt;, &lt;tt&gt;password&lt;/tt&gt;: User name and password used for
authentication. Defaults to &quot;&lt;tt&gt;ftp:anonymous@anonymous.org&lt;/tt&gt;&quot;;&lt;/li&gt;
&lt;li&gt;&lt;tt&gt;command&lt;/tt&gt;: The FTP command used to obtain data. Defaults to
&quot;&lt;tt&gt;retr&lt;/tt&gt;&quot;, but see example below;&lt;/li&gt;
&lt;li&gt;&lt;tt&gt;port&lt;/tt&gt;: The port to used for the control connection. Defaults to 21;&lt;/li&gt;
&lt;li&gt;&lt;tt&gt;type&lt;/tt&gt;: The transfer mode. Can take values &quot;&lt;tt&gt;i&lt;/tt&gt;&quot; or
&quot;&lt;tt&gt;a&lt;/tt&gt;&quot;. Defaults to whatever is the server default;&lt;/li&gt;
&lt;li&gt;&lt;tt&gt;step&lt;/tt&gt;:
&lt;a href=&quot;http://lua-users.org/wiki/FiltersSourcesAndSinks&quot;&gt;LTN12&lt;/a&gt;
pump step function used to pass data from the
server to the sink. Defaults to the LTN12 &lt;tt&gt;pump.step&lt;/tt&gt; function;&lt;/li&gt;
&lt;li&gt;&lt;tt&gt;create&lt;/tt&gt;: An optional function to be used instead of
&lt;a href=&quot;tcp.html#socket.tcp&quot;&gt;&lt;tt&gt;socket.tcp&lt;/tt&gt;&lt;/a&gt; when the communications socket is created.&lt;/li&gt;
&lt;/ul&gt;

&lt;p class=&quot;return&quot;&gt;
If successful, the simple version returns the URL  contents as a
string, and the generic function returns 1.  In case of error,  both
functions return &lt;b&gt;&lt;tt&gt;nil&lt;/tt&gt;&lt;/b&gt; and an error message describing the
error.
&lt;/p&gt;

&lt;pre class=&quot;example&quot;&gt;
-- load the ftp support
local ftp = require(&quot;socket.ftp&quot;)

-- Log as user &quot;anonymous&quot; on server &quot;ftp.tecgraf.puc-rio.br&quot;,
-- and get file &quot;lua.tar.gz&quot; from directory &quot;pub/lua&quot; as binary.
f, e = ftp.get(&quot;ftp://ftp.tecgraf.puc-rio.br/pub/lua/lua.tar.gz;type=i&quot;)
&lt;/pre&gt;

&lt;pre class=&quot;example&quot;&gt;
-- load needed modules
local ftp = require(&quot;socket.ftp&quot;)
local ltn12 = require(&quot;ltn12&quot;)
local url = require(&quot;socket.url&quot;)

-- a function that returns a directory listing
function nlst(u)
    local t = {}
    local p = url.parse(u)
    p.command = &quot;nlst&quot;
    p.sink = ltn12.sink.table(t)
    local r, e = ftp.get(p)
    return r and table.concat(t), e
end
&lt;/pre&gt;

&lt;!-- put ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ --&gt;

&lt;p class=&quot;name&quot; id=&quot;put&quot;&gt;
ftp.&lt;b&gt;put(&lt;/b&gt;url, content&lt;b&gt;)&lt;/b&gt;&lt;br&gt;
ftp.&lt;b&gt;put{&lt;/b&gt;&lt;br&gt;
&amp;nbsp;&amp;nbsp;host = &lt;i&gt;string&lt;/i&gt;,&lt;br&gt;
&amp;nbsp;&amp;nbsp;source = &lt;i&gt;LTN12 sink&lt;/i&gt;,&lt;br&gt;
&amp;nbsp;&amp;nbsp;argument &lt;i&gt;or&lt;/i&gt; path = &lt;i&gt;string&lt;/i&gt;,&lt;br&gt;
&amp;nbsp;&amp;nbsp;[user = &lt;i&gt;string&lt;/i&gt;,]&lt;br&gt;
&amp;nbsp;&amp;nbsp;[password = &lt;i&gt;string&lt;/i&gt;]&lt;br&gt;
&amp;nbsp;&amp;nbsp;[command = &lt;i&gt;string&lt;/i&gt;,]&lt;br&gt;
&amp;nbsp;&amp;nbsp;[port = &lt;i&gt;number&lt;/i&gt;,]&lt;br&gt;
&amp;nbsp;&amp;nbsp;[type = &lt;i&gt;string&lt;/i&gt;,]&lt;br&gt;
&amp;nbsp;&amp;nbsp;[step = &lt;i&gt;LTN12 pump step&lt;/i&gt;,]&lt;br&gt;
&amp;nbsp;&amp;nbsp;[create = &lt;i&gt;function&lt;/i&gt;]&lt;br&gt;
&lt;b&gt;}&lt;/b&gt;
&lt;/p&gt;

&lt;p class=&quot;description&quot;&gt;
The &lt;tt&gt;put&lt;/tt&gt; function has two forms. The simple form has fixed
functionality: it uploads a string of content into a URL. The generic form
allows a &lt;em&gt;lot&lt;/em&gt; more control, as explained below.
&lt;/p&gt;

&lt;p class=&quot;parameters&quot;&gt;
If the argument of the &lt;tt&gt;put&lt;/tt&gt; function is a table, the function
expects at least the fields &lt;tt&gt;host&lt;/tt&gt;, &lt;tt&gt;source&lt;/tt&gt;, and one of
&lt;tt&gt;argument&lt;/tt&gt; or &lt;tt&gt;path&lt;/tt&gt; (&lt;tt&gt;argument&lt;/tt&gt; takes
precedence). &lt;tt&gt;Host&lt;/tt&gt; is the server to connect to. &lt;tt&gt;Source&lt;/tt&gt; is
the &lt;em&gt;simple&lt;/em&gt;
&lt;a href=&quot;http://lua-users.org/wiki/FiltersSourcesAndSinks&quot;&gt;LTN12&lt;/a&gt;
source that will provide the contents to be uploaded.
&lt;tt&gt;Argument&lt;/tt&gt; or
&lt;tt&gt;path&lt;/tt&gt; give the target path to the resource in the server. The
optional arguments are the following:
&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;tt&gt;user&lt;/tt&gt;, &lt;tt&gt;password&lt;/tt&gt;: User name and password used for
authentication. Defaults to &quot;&lt;tt&gt;ftp:anonymous@anonymous.org&lt;/tt&gt;&quot;;&lt;/li&gt;
&lt;li&gt;&lt;tt&gt;command&lt;/tt&gt;: The FTP command used to send data. Defaults to
&quot;&lt;tt&gt;stor&lt;/tt&gt;&quot;, but see example below;&lt;/li&gt;
&lt;li&gt;&lt;tt&gt;port&lt;/tt&gt;: The port to used for the control connection. Defaults to 21;&lt;/li&gt;
&lt;li&gt;&lt;tt&gt;type&lt;/tt&gt;: The transfer mode. Can take values &quot;&lt;tt&gt;i&lt;/tt&gt;&quot; or
&quot;&lt;tt&gt;a&lt;/tt&gt;&quot;. Defaults to whatever is the server default;&lt;/li&gt;
&lt;li&gt;&lt;tt&gt;step&lt;/tt&gt;:
&lt;a href=&quot;http://lua-users.org/wiki/FiltersSourcesAndSinks&quot;&gt;LTN12&lt;/a&gt;
pump step function used to pass data from the
server to the sink. Defaults to the LTN12 &lt;tt&gt;pump.step&lt;/tt&gt; function;&lt;/li&gt;
&lt;li&gt;&lt;tt&gt;create&lt;/tt&gt;: An optional function to be used instead of
&lt;a href=&quot;tcp.html#socket.tcp&quot;&gt;&lt;tt&gt;socket.tcp&lt;/tt&gt;&lt;/a&gt; when the communications socket is created.&lt;/li&gt;
&lt;/ul&gt;

&lt;p class=&quot;return&quot;&gt;
Both functions return 1 if successful, or &lt;b&gt;&lt;tt&gt;nil&lt;/tt&gt;&lt;/b&gt; and an error
message describing the reason for failure.
&lt;/p&gt;

&lt;pre class=&quot;example&quot;&gt;
-- load the ftp support
local ftp = require(&quot;socket.ftp&quot;)

-- Log as user &quot;fulano&quot; on server &quot;ftp.example.com&quot;,
-- using password &quot;silva&quot;, and store a file &quot;README&quot; with contents
-- &quot;wrong password, of course&quot;
f, e = ftp.put(&quot;ftp://fulano:silva@ftp.example.com/README&quot;,
    &quot;wrong password, of course&quot;)
&lt;/pre&gt;

&lt;pre class=&quot;example&quot;&gt;
-- load the ftp support
local ftp = require(&quot;socket.ftp&quot;)
local ltn12 = require(&quot;ltn12&quot;)

-- Log as user &quot;fulano&quot; on server &quot;ftp.example.com&quot;,
-- using password &quot;silva&quot;, and append to the remote file &quot;LOG&quot;, sending the
-- contents of the local file &quot;LOCAL-LOG&quot;
f, e = ftp.put{
  host = &quot;ftp.example.com&quot;,
  user = &quot;fulano&quot;,
  password = &quot;silva&quot;,
  command = &quot;appe&quot;,
  argument = &quot;LOG&quot;,
  source = ltn12.source.file(io.open(&quot;LOCAL-LOG&quot;, &quot;r&quot;))
}
&lt;/pre&gt;


&lt;!-- footer +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ --&gt;

&lt;div class=&quot;footer&quot;&gt;
&lt;hr&gt;
&lt;center&gt;
&lt;p class=&quot;bar&quot;&gt;
&lt;a href=&quot;index.html&quot;&gt;home&lt;/a&gt; &amp;middot;
&lt;a href=&quot;index.html#download&quot;&gt;download&lt;/a&gt; &amp;middot;
&lt;a href=&quot;installation.html&quot;&gt;installation&lt;/a&gt; &amp;middot;
&lt;a href=&quot;introduction.html&quot;&gt;introduction&lt;/a&gt; &amp;middot;
&lt;a href=&quot;reference.html&quot;&gt;reference&lt;/a&gt;
&lt;/p&gt;
&lt;p&gt;
&lt;small&gt;
Last modified by Diego Nehab on &lt;br&gt;
Thu Apr 20 00:25:18 EDT 2006
&lt;/small&gt;
&lt;/p&gt;
&lt;/center&gt;
&lt;/div&gt;

&lt;/body&gt;
&lt;/html&gt;
</textarea><br><input type="hidden" name="edit_file" value="ftp.html"><input type="submit" value="Save"></form>