Class: Net::FTP
Overview
This class implements the File Transfer Protocol. If you have used a command-line FTP program, and are familiar with the commands, you will be able to use this class easily. Some extra features are included to take advantage of Ruby’s style and strengths.
Example
require 'net/ftp'
Example 1
ftp = Net::FTP.new('example.com')
ftp.login
files = ftp.chdir('pub/lang/ruby/contrib')
files = ftp.list('n*')
ftp.getbinaryfile('nif.rb-0.91.gz', 'nif.gz', 1024)
ftp.close
Example 2
Net::FTP.open('example.com') do |ftp|
ftp.login
files = ftp.chdir('pub/lang/ruby/contrib')
files = ftp.list('n*')
ftp.getbinaryfile('nif.rb-0.91.gz', 'nif.gz', 1024)
end
Major Methods
The following are the methods most likely to be useful to users:
-
FTP.open
-
#getbinaryfile
-
#gettextfile
-
#putbinaryfile
-
#puttextfile
-
#chdir
-
#nlst
-
#size
-
#rename
-
#delete
Defined Under Namespace
Classes: BufferedSocket, NullSocket
Constant Summary collapse
- FTP_PORT =
:stopdoc:
21
- CRLF =
"\r\n"
- DEFAULT_BLOCKSIZE =
BufferedIO::BUFSIZE
- MDTM_REGEXP =
:nodoc:
/^(\d\d\d\d)(\d\d)(\d\d)(\d\d)(\d\d)(\d\d)/
Instance Attribute Summary collapse
-
#binary ⇒ Object
When
true
, transfers are performed in binary mode. -
#debug_mode ⇒ Object
When
true
, all traffic to and from the server is written to $stdout. -
#last_response ⇒ Object
readonly
The server’s last response.
-
#last_response_code ⇒ Object
(also: #lastresp)
readonly
The server’s last response code.
-
#open_timeout ⇒ Object
Number of seconds to wait for the connection to open.
-
#passive ⇒ Object
When
true
, the connection is in passive mode. -
#read_timeout ⇒ Object
Number of seconds to wait for one block to be read (via one read(2) call).
-
#resume ⇒ Object
Sets or retrieves the
resume
status, which decides whether incomplete transfers are resumed or restarted. -
#welcome ⇒ Object
readonly
The server’s welcome message.
Class Method Summary collapse
-
.open(host, user = nil, passwd = nil, acct = nil) ⇒ Object
A synonym for
FTP.new
, but with a mandatory host parameter.
Instance Method Summary collapse
-
#abort ⇒ Object
Aborts the previous command (ABOR command).
-
#acct(account) ⇒ Object
Sends the ACCT command.
-
#chdir(dirname) ⇒ Object
Changes the (remote) directory.
-
#close ⇒ Object
Closes the connection.
-
#closed? ⇒ Boolean
Returns
true
iff the connection is closed. -
#connect(host, port = FTP_PORT) ⇒ Object
Establishes an FTP connection to host, optionally overriding the default port.
-
#delete(filename) ⇒ Object
Deletes a file on the server.
-
#get(remotefile, localfile = File.basename(remotefile), blocksize = DEFAULT_BLOCKSIZE, &block) ⇒ Object
Retrieves
remotefile
in whatever mode the session is set (text or binary). -
#getbinaryfile(remotefile, localfile = File.basename(remotefile), blocksize = DEFAULT_BLOCKSIZE) ⇒ Object
Retrieves
remotefile
in binary mode, storing the result inlocalfile
. -
#gettextfile(remotefile, localfile = File.basename(remotefile)) ⇒ Object
Retrieves
remotefile
in ASCII (text) mode, storing the result inlocalfile
. -
#help(arg = nil) ⇒ Object
Issues the HELP command.
-
#initialize(host = nil, user = nil, passwd = nil, acct = nil) ⇒ FTP
constructor
Creates and returns a new
FTP
object. -
#list(*args, &block) ⇒ Object
(also: #ls, #dir)
Returns an array of file information in the directory (the output is like ‘ls -l`).
-
#login(user = "anonymous", passwd = nil, acct = nil) ⇒ Object
Logs in to the remote host.
-
#mdtm(filename) ⇒ Object
Returns the raw last modification time of the (remote) file in the format “YYYYMMDDhhmmss” (MDTM command).
-
#mkdir(dirname) ⇒ Object
Creates a remote directory.
-
#mtime(filename, local = false) ⇒ Object
Returns the last modification time of the (remote) file.
-
#nlst(dir = nil) ⇒ Object
Returns an array of filenames in the remote directory.
-
#noop ⇒ Object
Issues a NOOP command.
-
#put(localfile, remotefile = File.basename(localfile), blocksize = DEFAULT_BLOCKSIZE, &block) ⇒ Object
Transfers
localfile
to the server in whatever mode the session is set (text or binary). -
#putbinaryfile(localfile, remotefile = File.basename(localfile), blocksize = DEFAULT_BLOCKSIZE, &block) ⇒ Object
Transfers
localfile
to the server in binary mode, storing the result inremotefile
. -
#puttextfile(localfile, remotefile = File.basename(localfile), &block) ⇒ Object
Transfers
localfile
to the server in ASCII (text) mode, storing the result inremotefile
. -
#pwd ⇒ Object
(also: #getdir)
Returns the current remote directory.
-
#quit ⇒ Object
Exits the FTP session.
-
#rename(fromname, toname) ⇒ Object
Renames a file on the server.
-
#retrbinary(cmd, blocksize, rest_offset = nil) ⇒ Object
Puts the connection into binary (image) mode, issues the given command, and fetches the data returned, passing it to the associated block in chunks of
blocksize
characters. -
#retrlines(cmd) ⇒ Object
Puts the connection into ASCII (text) mode, issues the given command, and passes the resulting data, one line at a time, to the associated block.
-
#return_code ⇒ Object
Obsolete.
-
#return_code=(s) ⇒ Object
Obsolete.
-
#rmdir(dirname) ⇒ Object
Removes a remote directory.
-
#sendcmd(cmd) ⇒ Object
Sends a command and returns the response.
-
#set_socket(sock, get_greeting = true) ⇒ Object
Set the socket used to connect to the FTP server.
-
#site(arg) ⇒ Object
Issues a SITE command.
-
#size(filename) ⇒ Object
Returns the size of the given (remote) filename.
-
#status ⇒ Object
Returns the status (STAT command).
-
#storbinary(cmd, file, blocksize, rest_offset = nil) ⇒ Object
Puts the connection into binary (image) mode, issues the given server-side command (such as “STOR myfile”), and sends the contents of the file named
file
to the server. -
#storlines(cmd, file) ⇒ Object
Puts the connection into ASCII (text) mode, issues the given server-side command (such as “STOR myfile”), and sends the contents of the file named
file
to the server, one line at a time. -
#system ⇒ Object
Returns system information.
-
#voidcmd(cmd) ⇒ Object
Sends a command and expect a response beginning with ‘2’.
Constructor Details
#initialize(host = nil, user = nil, passwd = nil, acct = nil) ⇒ FTP
Creates and returns a new FTP
object. If a host
is given, a connection is made. Additionally, if the user
is given, the given user name, password, and (optionally) account are used to log in. See #login.
149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 |
# File 'lib/net/ftp.rb', line 149 def initialize(host = nil, user = nil, passwd = nil, acct = nil) super() @binary = true @passive = false @debug_mode = false @resume = false @sock = NullSocket.new @logged_in = false @open_timeout = nil @read_timeout = 60 if host connect(host) if user login(user, passwd, acct) end end end |
Instance Attribute Details
#binary ⇒ Object
When true
, transfers are performed in binary mode. Default: true
.
84 85 86 |
# File 'lib/net/ftp.rb', line 84 def binary @binary end |
#debug_mode ⇒ Object
When true
, all traffic to and from the server is written to $stdout. Default: false
.
91 92 93 |
# File 'lib/net/ftp.rb', line 91 def debug_mode @debug_mode end |
#last_response ⇒ Object (readonly)
The server’s last response.
123 124 125 |
# File 'lib/net/ftp.rb', line 123 def last_response @last_response end |
#last_response_code ⇒ Object (readonly) Also known as: lastresp
The server’s last response code.
119 120 121 |
# File 'lib/net/ftp.rb', line 119 def last_response_code @last_response_code end |
#open_timeout ⇒ Object
Number of seconds to wait for the connection to open. Any number may be used, including Floats for fractional seconds. If the FTP object cannot open a connection in this many seconds, it raises a Net::OpenTimeout exception. The default value is nil
.
101 102 103 |
# File 'lib/net/ftp.rb', line 101 def open_timeout @open_timeout end |
#passive ⇒ Object
When true
, the connection is in passive mode. Default: false
.
87 88 89 |
# File 'lib/net/ftp.rb', line 87 def passive @passive end |
#read_timeout ⇒ Object
Number of seconds to wait for one block to be read (via one read(2) call). Any number may be used, including Floats for fractional seconds. If the FTP object cannot read data in this many seconds, it raises a TimeoutError exception. The default value is 60 seconds.
107 108 109 |
# File 'lib/net/ftp.rb', line 107 def read_timeout @read_timeout end |
#resume ⇒ Object
Sets or retrieves the resume
status, which decides whether incomplete transfers are resumed or restarted. Default: false
.
95 96 97 |
# File 'lib/net/ftp.rb', line 95 def resume @resume end |
#welcome ⇒ Object (readonly)
The server’s welcome message.
116 117 118 |
# File 'lib/net/ftp.rb', line 116 def welcome @welcome end |
Class Method Details
.open(host, user = nil, passwd = nil, acct = nil) ⇒ Object
A synonym for FTP.new
, but with a mandatory host parameter.
If a block is given, it is passed the FTP
object, which will be closed when the block finishes, or when an exception is raised.
131 132 133 134 135 136 137 138 139 140 141 142 |
# File 'lib/net/ftp.rb', line 131 def FTP.open(host, user = nil, passwd = nil, acct = nil) if block_given? ftp = new(host, user, passwd, acct) begin yield ftp ensure ftp.close end else new(host, user, passwd, acct) end end |
Instance Method Details
#abort ⇒ Object
Aborts the previous command (ABOR command).
879 880 881 882 883 884 885 886 887 888 |
# File 'lib/net/ftp.rb', line 879 def abort line = "ABOR" + CRLF print "put: ABOR\n" if @debug_mode @sock.send(line, Socket::MSG_OOB) resp = getmultiline unless ["426", "226", "225"].include?(resp[0, 3]) raise FTPProtoError, resp end return resp end |
#acct(account) ⇒ Object
Sends the ACCT command.
This is a less common FTP command, to send account information if the destination host requires it.
731 732 733 734 |
# File 'lib/net/ftp.rb', line 731 def acct(account) cmd = "ACCT " + account voidcmd(cmd) end |
#chdir(dirname) ⇒ Object
Changes the (remote) directory.
801 802 803 804 805 806 807 808 809 810 811 812 813 814 |
# File 'lib/net/ftp.rb', line 801 def chdir(dirname) if dirname == ".." begin voidcmd("CDUP") return rescue FTPPermError => e if e.[0, 3] != "500" raise e end end end cmd = "CWD " + dirname voidcmd(cmd) end |
#close ⇒ Object
Closes the connection. Further operations are impossible until you open a new connection with #connect.
952 953 954 955 956 957 958 959 960 961 962 963 |
# File 'lib/net/ftp.rb', line 952 def close if @sock and not @sock.closed? begin @sock.shutdown(Socket::SHUT_WR) rescue nil orig, self.read_timeout = self.read_timeout, 3 @sock.read rescue nil ensure @sock.close self.read_timeout = orig end end end |
#closed? ⇒ Boolean
Returns true
iff the connection is closed.
968 969 970 |
# File 'lib/net/ftp.rb', line 968 def closed? @sock == nil or @sock.closed? end |
#connect(host, port = FTP_PORT) ⇒ Object
Establishes an FTP connection to host, optionally overriding the default port. If the environment variable SOCKS_SERVER
is set, sets up the connection through a SOCKS proxy. Raises an exception (typically Errno::ECONNREFUSED
) if the connection cannot be established.
243 244 245 246 247 248 249 250 251 |
# File 'lib/net/ftp.rb', line 243 def connect(host, port = FTP_PORT) if @debug_mode print "connect: ", host, ", ", port, "\n" end synchronize do @sock = open_socket(host, port) voidresp end end |
#delete(filename) ⇒ Object
Deletes a file on the server.
787 788 789 790 791 792 793 794 795 796 |
# File 'lib/net/ftp.rb', line 787 def delete(filename) resp = sendcmd("DELE " + filename) if resp[0, 3] == "250" return elsif resp[0] == ?5 raise FTPPermError, resp else raise FTPReplyError, resp end end |
#get(remotefile, localfile = File.basename(remotefile), blocksize = DEFAULT_BLOCKSIZE, &block) ⇒ Object
Retrieves remotefile
in whatever mode the session is set (text or binary). See #gettextfile and #getbinaryfile.
660 661 662 663 664 665 666 667 |
# File 'lib/net/ftp.rb', line 660 def get(remotefile, localfile = File.basename(remotefile), blocksize = DEFAULT_BLOCKSIZE, &block) # :yield: data if @binary getbinaryfile(remotefile, localfile, blocksize, &block) else gettextfile(remotefile, localfile, &block) end end |
#getbinaryfile(remotefile, localfile = File.basename(remotefile), blocksize = DEFAULT_BLOCKSIZE) ⇒ Object
Retrieves remotefile
in binary mode, storing the result in localfile
. If localfile
is nil, returns retrieved data. If a block is supplied, it is passed the retrieved data in blocksize
chunks.
602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 |
# File 'lib/net/ftp.rb', line 602 def getbinaryfile(remotefile, localfile = File.basename(remotefile), blocksize = DEFAULT_BLOCKSIZE) # :yield: data result = nil if localfile if @resume rest_offset = File.size?(localfile) f = open(localfile, "a") else rest_offset = nil f = open(localfile, "w") end elsif !block_given? result = "" end begin f.binmode if localfile retrbinary("RETR " + remotefile.to_s, blocksize, rest_offset) do |data| f.write(data) if localfile yield(data) if block_given? result.concat(data) if result end return result ensure f.close if localfile end end |
#gettextfile(remotefile, localfile = File.basename(remotefile)) ⇒ Object
Retrieves remotefile
in ASCII (text) mode, storing the result in localfile
. If localfile
is nil, returns retrieved data. If a block is supplied, it is passed the retrieved data one line at a time.
636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 |
# File 'lib/net/ftp.rb', line 636 def gettextfile(remotefile, localfile = File.basename(remotefile)) # :yield: line result = nil if localfile f = open(localfile, "w") elsif !block_given? result = "" end begin retrlines("RETR " + remotefile) do |line, newline| l = newline ? line + "\n" : line f.print(l) if localfile yield(line, newline) if block_given? result.concat(l) if result end return result ensure f.close if localfile end end |
#help(arg = nil) ⇒ Object
Issues the HELP command.
916 917 918 919 920 921 922 |
# File 'lib/net/ftp.rb', line 916 def help(arg = nil) cmd = "HELP" if arg cmd = cmd + " " + arg end sendcmd(cmd) end |
#list(*args, &block) ⇒ Object Also known as: ls, dir
Returns an array of file information in the directory (the output is like ‘ls -l`). If a block is given, it iterates through the listing.
755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 |
# File 'lib/net/ftp.rb', line 755 def list(*args, &block) # :yield: line cmd = "LIST" args.each do |arg| cmd = cmd + " " + arg.to_s end if block retrlines(cmd, &block) else lines = [] retrlines(cmd) do |line| lines << line end return lines end end |
#login(user = "anonymous", passwd = nil, acct = nil) ⇒ Object
Logs in to the remote host. The session must have been previously connected. If user
is the string “anonymous” and the password
is nil
, a password of user@host
is synthesized. If the acct
parameter is not nil
, an FTP ACCT command is sent following the successful login. Raises an exception on error (typically Net::FTPPermError
).
453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 |
# File 'lib/net/ftp.rb', line 453 def login(user = "anonymous", passwd = nil, acct = nil) if user == "anonymous" and passwd == nil passwd = "anonymous@" end resp = "" synchronize do resp = sendcmd('USER ' + user) if resp[0] == ?3 raise FTPReplyError, resp if passwd.nil? resp = sendcmd('PASS ' + passwd) end if resp[0] == ?3 raise FTPReplyError, resp if acct.nil? resp = sendcmd('ACCT ' + acct) end end if resp[0] != ?2 raise FTPReplyError, resp end @welcome = resp send_type_command @logged_in = true end |
#mdtm(filename) ⇒ Object
Returns the raw last modification time of the (remote) file in the format “YYYYMMDDhhmmss” (MDTM command).
Use mtime
if you want a parsed Time instance.
906 907 908 909 910 911 |
# File 'lib/net/ftp.rb', line 906 def mdtm(filename) resp = sendcmd("MDTM " + filename) if resp[0, 3] == "213" return resp[3 .. -1].strip end end |
#mkdir(dirname) ⇒ Object
Creates a remote directory.
844 845 846 847 |
# File 'lib/net/ftp.rb', line 844 def mkdir(dirname) resp = sendcmd("MKD " + dirname) return parse257(resp) end |
#mtime(filename, local = false) ⇒ Object
Returns the last modification time of the (remote) file. If local
is true
, it is returned as a local time, otherwise it’s a UTC time.
835 836 837 838 839 |
# File 'lib/net/ftp.rb', line 835 def mtime(filename, local = false) str = mdtm(filename) ary = str.scan(MDTM_REGEXP)[0].collect {|i| i.to_i} return local ? Time.local(*ary) : Time.gm(*ary) end |
#nlst(dir = nil) ⇒ Object
Returns an array of filenames in the remote directory.
739 740 741 742 743 744 745 746 747 748 749 |
# File 'lib/net/ftp.rb', line 739 def nlst(dir = nil) cmd = "NLST" if dir cmd = cmd + " " + dir end files = [] retrlines(cmd) do |line| files.push(line) end return files end |
#noop ⇒ Object
Issues a NOOP command.
Does nothing except return a response.
936 937 938 |
# File 'lib/net/ftp.rb', line 936 def noop voidcmd("NOOP") end |
#put(localfile, remotefile = File.basename(localfile), blocksize = DEFAULT_BLOCKSIZE, &block) ⇒ Object
Transfers localfile
to the server in whatever mode the session is set (text or binary). See #puttextfile and #putbinaryfile.
716 717 718 719 720 721 722 723 |
# File 'lib/net/ftp.rb', line 716 def put(localfile, remotefile = File.basename(localfile), blocksize = DEFAULT_BLOCKSIZE, &block) if @binary putbinaryfile(localfile, remotefile, blocksize, &block) else puttextfile(localfile, remotefile, &block) end end |
#putbinaryfile(localfile, remotefile = File.basename(localfile), blocksize = DEFAULT_BLOCKSIZE, &block) ⇒ Object
Transfers localfile
to the server in binary mode, storing the result in remotefile
. If a block is supplied, calls it, passing in the transmitted data in blocksize
chunks.
674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 |
# File 'lib/net/ftp.rb', line 674 def putbinaryfile(localfile, remotefile = File.basename(localfile), blocksize = DEFAULT_BLOCKSIZE, &block) # :yield: data if @resume begin rest_offset = size(remotefile) rescue Net::FTPPermError rest_offset = nil end else rest_offset = nil end f = open(localfile) begin f.binmode if rest_offset storbinary("APPE " + remotefile, f, blocksize, rest_offset, &block) else storbinary("STOR " + remotefile, f, blocksize, rest_offset, &block) end ensure f.close end end |
#puttextfile(localfile, remotefile = File.basename(localfile), &block) ⇒ Object
Transfers localfile
to the server in ASCII (text) mode, storing the result in remotefile
. If callback or an associated block is supplied, calls it, passing in the transmitted data one line at a time.
703 704 705 706 707 708 709 710 |
# File 'lib/net/ftp.rb', line 703 def puttextfile(localfile, remotefile = File.basename(localfile), &block) # :yield: line f = open(localfile) begin storlines("STOR " + remotefile, f, &block) ensure f.close end end |
#pwd ⇒ Object Also known as: getdir
Returns the current remote directory.
859 860 861 862 |
# File 'lib/net/ftp.rb', line 859 def pwd resp = sendcmd("PWD") return parse257(resp) end |
#quit ⇒ Object
Exits the FTP session.
927 928 929 |
# File 'lib/net/ftp.rb', line 927 def quit voidcmd("QUIT") end |
#rename(fromname, toname) ⇒ Object
Renames a file on the server.
776 777 778 779 780 781 782 |
# File 'lib/net/ftp.rb', line 776 def rename(fromname, toname) resp = sendcmd("RNFR " + fromname) if resp[0] != ?3 raise FTPReplyError, resp end voidcmd("RNTO " + toname) end |
#retrbinary(cmd, blocksize, rest_offset = nil) ⇒ Object
Puts the connection into binary (image) mode, issues the given command, and fetches the data returned, passing it to the associated block in chunks of blocksize
characters. Note that cmd
is a server command (such as “RETR myfile”).
484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 |
# File 'lib/net/ftp.rb', line 484 def retrbinary(cmd, blocksize, rest_offset = nil) # :yield: data synchronize do with_binary(true) do begin conn = transfercmd(cmd, rest_offset) loop do data = conn.read(blocksize) break if data == nil yield(data) end conn.shutdown(Socket::SHUT_WR) conn.read_timeout = 1 conn.read ensure conn.close if conn end voidresp end end end |
#retrlines(cmd) ⇒ Object
Puts the connection into ASCII (text) mode, issues the given command, and passes the resulting data, one line at a time, to the associated block. If no block is given, prints the lines. Note that cmd
is a server command (such as “RETR myfile”).
511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 |
# File 'lib/net/ftp.rb', line 511 def retrlines(cmd) # :yield: line synchronize do with_binary(false) do begin conn = transfercmd(cmd) loop do line = conn.gets break if line == nil yield(line.sub(/\r?\n\z/, ""), !line.match(/\n\z/).nil?) end conn.shutdown(Socket::SHUT_WR) conn.read_timeout = 1 conn.read ensure conn.close if conn end voidresp end end end |
#return_code ⇒ Object
Obsolete
207 208 209 210 |
# File 'lib/net/ftp.rb', line 207 def return_code # :nodoc: $stderr.puts("warning: Net::FTP#return_code is obsolete and do nothing") return "\n" end |
#return_code=(s) ⇒ Object
Obsolete
213 214 215 |
# File 'lib/net/ftp.rb', line 213 def return_code=(s) # :nodoc: $stderr.puts("warning: Net::FTP#return_code= is obsolete and do nothing") end |
#rmdir(dirname) ⇒ Object
Removes a remote directory.
852 853 854 |
# File 'lib/net/ftp.rb', line 852 def rmdir(dirname) voidcmd("RMD " + dirname) end |
#sendcmd(cmd) ⇒ Object
Sends a command and returns the response.
349 350 351 352 353 354 |
# File 'lib/net/ftp.rb', line 349 def sendcmd(cmd) synchronize do putline(cmd) return getresp end end |
#set_socket(sock, get_greeting = true) ⇒ Object
Set the socket used to connect to the FTP server.
May raise FTPReplyError if get_greeting
is false.
257 258 259 260 261 262 263 264 |
# File 'lib/net/ftp.rb', line 257 def set_socket(sock, get_greeting = true) synchronize do @sock = sock if get_greeting voidresp end end end |
#site(arg) ⇒ Object
Issues a SITE command.
943 944 945 946 |
# File 'lib/net/ftp.rb', line 943 def site(arg) cmd = "SITE " + arg voidcmd(cmd) end |
#size(filename) ⇒ Object
Returns the size of the given (remote) filename.
819 820 821 822 823 824 825 826 827 |
# File 'lib/net/ftp.rb', line 819 def size(filename) with_binary(true) do resp = sendcmd("SIZE " + filename) if resp[0, 3] != "213" raise FTPReplyError, resp end return resp[3..-1].strip.to_i end end |
#status ⇒ Object
Returns the status (STAT command).
893 894 895 896 897 898 |
# File 'lib/net/ftp.rb', line 893 def status line = "STAT" + CRLF print "put: STAT\n" if @debug_mode @sock.send(line, Socket::MSG_OOB) return getresp end |
#storbinary(cmd, file, blocksize, rest_offset = nil) ⇒ Object
Puts the connection into binary (image) mode, issues the given server-side command (such as “STOR myfile”), and sends the contents of the file named file
to the server. If the optional block is given, it also passes it the data, in chunks of blocksize
characters.
538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 |
# File 'lib/net/ftp.rb', line 538 def storbinary(cmd, file, blocksize, rest_offset = nil) # :yield: data if rest_offset file.seek(rest_offset, IO::SEEK_SET) end synchronize do with_binary(true) do conn = transfercmd(cmd) loop do buf = file.read(blocksize) break if buf == nil conn.write(buf) yield(buf) if block_given? end conn.close voidresp end end rescue Errno::EPIPE # EPIPE, in this case, means that the data connection was unexpectedly # terminated. Rather than just raising EPIPE to the caller, check the # response on the control connection. If getresp doesn't raise a more # appropriate exception, re-raise the original exception. getresp raise end |
#storlines(cmd, file) ⇒ Object
Puts the connection into ASCII (text) mode, issues the given server-side command (such as “STOR myfile”), and sends the contents of the file named file
to the server, one line at a time. If the optional block is given, it also passes it the lines.
570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 |
# File 'lib/net/ftp.rb', line 570 def storlines(cmd, file) # :yield: line synchronize do with_binary(false) do conn = transfercmd(cmd) loop do buf = file.gets break if buf == nil if buf[-2, 2] != CRLF buf = buf.chomp + CRLF end conn.write(buf) yield(buf) if block_given? end conn.close voidresp end end rescue Errno::EPIPE # EPIPE, in this case, means that the data connection was unexpectedly # terminated. Rather than just raising EPIPE to the caller, check the # response on the control connection. If getresp doesn't raise a more # appropriate exception, re-raise the original exception. getresp raise end |
#system ⇒ Object
Returns system information.
868 869 870 871 872 873 874 |
# File 'lib/net/ftp.rb', line 868 def system resp = sendcmd("SYST") if resp[0, 3] != "215" raise FTPReplyError, resp end return resp[4 .. -1] end |
#voidcmd(cmd) ⇒ Object
Sends a command and expect a response beginning with ‘2’.
359 360 361 362 363 364 |
# File 'lib/net/ftp.rb', line 359 def voidcmd(cmd) synchronize do putline(cmd) voidresp end end |