Class: Net::FTP

Inherits:
Protocol
  • Object
show all
Includes:
MonitorMixin, OpenSSL, SSL
Defined in:
lib/net/ftp.rb

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.
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.
  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: BufferedSSLSocket, BufferedSocket, MLSxEntry, NullSocket

Constant Summary collapse

VERSION =

:stopdoc:

"0.3.4"
FTP_PORT = 
21
CRLF = 
"\r\n"
DEFAULT_BLOCKSIZE = 
BufferedIO::BUFSIZE
CASE_DEPENDENT_PARSER = 
->(value) { value }
CASE_INDEPENDENT_PARSER = 
->(value) { value.downcase }
DECIMAL_PARSER = 
->(value) { value.to_i }
OCTAL_PARSER = 
->(value) { value.to_i(8) }
TIME_PARSER = 
->(value, local = false) {
  unless /\A(?<year>\d{4})(?<month>\d{2})(?<day>\d{2})
        (?<hour>\d{2})(?<min>\d{2})(?<sec>\d{2})
        (?:\.(?<fractions>\d{1,17}))?/x =~ value
    value = value[0, 97] + "..." if value.size > 100
    raise FTPProtoError, "invalid time-val: #{value}"
  end
  usec = ".#{fractions}".to_r * 1_000_000 if fractions
  Time.public_send(local ? :local : :utc, year, month, day, hour, min, sec, usec)
}
FACT_PARSERS = 
Hash.new(CASE_DEPENDENT_PARSER)
@@default_passive = 
true

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(host = nil, user_or_options = {}, passwd = nil, acct = nil) ⇒ FTP

:call-seq:

Net::FTP.new(host = nil, options = {})

Creates and returns a new FTP object. If a host is given, a connection is made.

options is an option hash, each key of which is a symbol.

The available options are:

port

Port number (default value is 21)

ssl

If options[:ssl] is true, then an attempt will be made to use SSL (now TLS) to connect to the server. For this to work OpenSSL [OSSL] and the Ruby OpenSSL [RSSL] extensions need to be installed. If options[:ssl] is a hash, it’s passed to OpenSSL::SSL::SSLContext#set_params as parameters.

private_data_connection

If true, TLS is used for data connections. Default: true when options[:ssl] is true.

implicit_ftps

If true, TLS is established on initial connection. Default: false

username

Username for login. If options[:username] is the string “anonymous” and the options[:password] is nil, “anonymous@” is used as a password.

password

Password for login.

account

Account information for ACCT.

passive

When true, the connection is in passive mode. Default: true.

open_timeout

Number of seconds to wait for the connection to open. See Net::FTP#open_timeout for details. Default: nil.

read_timeout

Number of seconds to wait for one block to be read. See Net::FTP#read_timeout for details. Default: 60.

ssl_handshake_timeout

Number of seconds to wait for the TLS handshake. See Net::FTP#ssl_handshake_timeout for details. Default: nil.

use_pasv_ip

When true, use the IP address in PASV responses. Otherwise, it uses the same IP address for the control connection. Default: false.

debug_mode

When true, all traffic to and from the server is written to $stdout. Default: false.



226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
 
# File 'lib/net/ftp.rb', line 226

def initialize(host = nil, user_or_options = {}, passwd = nil, acct = nil)
  super()
  begin
    options = user_or_options.to_hash
  rescue NoMethodError
    # for backward compatibility
    options = {}
    options[:username] = user_or_options
    options[:password] = passwd
    options[:account] = acct
  end
  @host = nil
  if options[:ssl]
    unless defined?(OpenSSL::SSL)
      raise "SSL extension not installed"
    end
    ssl_params = options[:ssl] == true ? {} : options[:ssl]
    @ssl_context = SSLContext.new
    @ssl_context.set_params(ssl_params)
    if defined?(VerifyCallbackProc)
      @ssl_context.verify_callback = VerifyCallbackProc
    end
    @ssl_context.session_cache_mode =
      OpenSSL::SSL::SSLContext::SESSION_CACHE_CLIENT |
      OpenSSL::SSL::SSLContext::SESSION_CACHE_NO_INTERNAL_STORE
    @ssl_context.session_new_cb = proc {|sock, sess| @ssl_session = sess }
    @ssl_session = nil
    if options[:private_data_connection].nil?
      @private_data_connection = true
    else
      @private_data_connection = options[:private_data_connection]
    end
    if options[:implicit_ftps].nil?
      @implicit_ftps = false
    else
      @implicit_ftps = options[:implicit_ftps]
    end
  else
    @ssl_context = nil
    if options[:private_data_connection]
      raise ArgumentError,
        "private_data_connection can be set to true only when ssl is enabled"
    end
    @private_data_connection = false
    if options[:implicit_ftps]
      raise ArgumentError,
            "implicit_ftps can be set to true only when ssl is enabled"
    end
    @implicit_ftps = false
  end
  @binary = true
  if options[:passive].nil?
    @passive = @@default_passive
  else
    @passive = options[:passive]
  end
  if options[:debug_mode].nil?
    @debug_mode = false
  else
    @debug_mode = options[:debug_mode]
  end
  @debug_output = $stdout
  @resume = false
  @bare_sock = @sock = NullSocket.new
  @logged_in = false
  @open_timeout = options[:open_timeout]
  @ssl_handshake_timeout = options[:ssl_handshake_timeout]
  @read_timeout = options[:read_timeout] || 60
  @use_pasv_ip = options[:use_pasv_ip] || false
  if host
    connect(host, options[:port] || FTP_PORT)
    if options[:username]
      (options[:username], options[:password], options[:account])
    end
  end
end

Instance Attribute Details

#binary ⇒ Object

When true, transfers are performed in binary mode. Default: true.



96
97
98
 
# File 'lib/net/ftp.rb', line 96

def binary
  @binary
end

#debug_mode ⇒ Object

When true, all traffic to and from the server is written to $stdout. Default: false.



107
108
109
 
# File 'lib/net/ftp.rb', line 107

def debug_mode
  @debug_mode
end

#debug_output ⇒ Object

Sets or retrieves the output stream for debugging. Output stream will be used only when debug_mode is set to true. The default value is $stdout.



112
113
114
 
# File 'lib/net/ftp.rb', line 112

def debug_output
  @debug_output
end

#last_response ⇒ Object (readonly)

The server’s last response.



151
152
153
 
# File 'lib/net/ftp.rb', line 151

def last_response
  @last_response
end

#last_response_code ⇒ Object (readonly) Also known as: lastresp

The server’s last response code.



147
148
149
 
# File 'lib/net/ftp.rb', line 147

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.



122
123
124
 
# File 'lib/net/ftp.rb', line 122

def open_timeout
  @open_timeout
end

#passive ⇒ Object

When true, the connection is in passive mode. Default: true.



99
100
101
 
# File 'lib/net/ftp.rb', line 99

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 Timeout::Error exception. The default value is 60 seconds.



135
136
137
 
# File 'lib/net/ftp.rb', line 135

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.



116
117
118
 
# File 'lib/net/ftp.rb', line 116

def resume
  @resume
end

#ssl_handshake_timeout ⇒ Object

Number of seconds to wait for the TLS handshake. Any number may be used, including Floats for fractional seconds. If the FTP object cannot complete the TLS handshake in this many seconds, it raises a Net::OpenTimeout exception. The default value is nil. If ssl_handshake_timeout is nil, open_timeout is used instead.



129
130
131
 
# File 'lib/net/ftp.rb', line 129

def ssl_handshake_timeout
  @ssl_handshake_timeout
end

#use_pasv_ip ⇒ Object

When true, use the IP address in PASV responses. Otherwise, it uses the same IP address for the control connection. Default: false.



103
104
105
 
# File 'lib/net/ftp.rb', line 103

def use_pasv_ip
  @use_pasv_ip
end

#welcome ⇒ Object (readonly)

The server’s welcome message.



144
145
146
 
# File 'lib/net/ftp.rb', line 144

def welcome
  @welcome
end

Class Method Details

.default_passive ⇒ Object

When true, connections are in passive mode per default. Default: true.



161
162
163
 
# File 'lib/net/ftp.rb', line 161

def self.default_passive
  @@default_passive
end

.default_passive=(value) ⇒ Object

When true, connections are in passive mode per default. Default: true.



155
156
157
 
# File 'lib/net/ftp.rb', line 155

def self.default_passive=(value)
  @@default_passive = value
end

.open(host, *args) ⇒ 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.



171
172
173
174
175
176
177
178
179
180
181
182
 
# File 'lib/net/ftp.rb', line 171

def FTP.open(host, *args)
  if block_given?
    ftp = new(host, *args)
    begin
      yield ftp
    ensure
      ftp.close
    end
  else
    new(host, *args)
  end
end

Instance Method Details

#abort ⇒ Object

Aborts the previous command (ABOR command).



1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
 
# File 'lib/net/ftp.rb', line 1259

def abort
  line = "ABOR" + CRLF
  debug_print "put: ABOR"
  @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.



911
912
913
914
 
# File 'lib/net/ftp.rb', line 911

def acct()
  cmd = "ACCT " + 
  voidcmd(cmd)
end

#chdir(dirname) ⇒ Object

Changes the (remote) directory.



1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
 
# File 'lib/net/ftp.rb', line 1180

def chdir(dirname)
  if dirname == ".."
    begin
      voidcmd("CDUP")
      return
    rescue FTPPermError => e
      if e.message[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.



1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
 
# File 'lib/net/ftp.rb', line 1373

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 if and only if the connection is closed.

Returns:

  • (Boolean) 


1389
1390
1391
 
# File 'lib/net/ftp.rb', line 1389

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.



393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
 
# File 'lib/net/ftp.rb', line 393

def connect(host, port = FTP_PORT)
  debug_print "connect: #{host}:#{port}"
  synchronize do
    @host = host
    @bare_sock = open_socket(host, port)
    if @ssl_context
      begin
        unless @implicit_ftps
          set_socket(BufferedSocket.new(@bare_sock, read_timeout: @read_timeout))
          voidcmd("AUTH TLS")
        end
        set_socket(BufferedSSLSocket.new(start_tls_session(@bare_sock), read_timeout: @read_timeout), @implicit_ftps)
        if @private_data_connection
          voidcmd("PBSZ 0")
          voidcmd("PROT P")
        end
      rescue OpenSSL::SSL::SSLError, OpenTimeout
        @sock.close
        raise
      end
    else
      set_socket(BufferedSocket.new(@bare_sock, read_timeout: @read_timeout))
    end
  end
end

#debug_print(msg) ⇒ Object

Writes debug message to the debug output stream



1464
1465
1466
 
# File 'lib/net/ftp.rb', line 1464

def debug_print(msg)
  @debug_output << msg + "\n" if @debug_mode && @debug_output
end

#delete(filename) ⇒ Object

Deletes a file on the server.



1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
 
# File 'lib/net/ftp.rb', line 1166

def delete(filename)
  resp = sendcmd("DELE #{filename}")
  if resp.start_with?("250")
    return
  elsif resp.start_with?("5")
    raise FTPPermError, resp
  else
    raise FTPReplyError, resp
  end
end

#features ⇒ Object

Issues a FEAT command

Returns an array of supported optional features



1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
 
# File 'lib/net/ftp.rb', line 1339

def features
  resp = sendcmd("FEAT")
  if !resp.start_with?("211")
    raise FTPReplyError, resp
  end

  feats = []
  resp.split("\n").each do |line|
    next if !line.start_with?(' ') # skip status lines

    feats << line.strip
  end

  return feats
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.



840
841
842
843
844
845
846
847
 
# File 'lib/net/ftp.rb', line 840

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, &block) ⇒ 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.



779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
 
# File 'lib/net/ftp.rb', line 779

def getbinaryfile(remotefile, localfile = File.basename(remotefile),
                  blocksize = DEFAULT_BLOCKSIZE, &block) # :yield: data
  f = nil
  result = nil
  if localfile
    if @resume
      rest_offset = File.size?(localfile)
      f = File.open(localfile, "a")
    else
      rest_offset = nil
      f = File.open(localfile, "w")
    end
  elsif !block_given?
    result = String.new
  end
  begin
    f&.binmode
    retrbinary("RETR #{remotefile}", blocksize, rest_offset) do |data|
      f&.write(data)
      block&.(data)
      result&.concat(data)
    end
    return result
  ensure
    f&.close
  end
end

#gettextfile(remotefile, localfile = File.basename(remotefile), &block) ⇒ 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.



814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
 
# File 'lib/net/ftp.rb', line 814

def gettextfile(remotefile, localfile = File.basename(remotefile),
                &block) # :yield: line
  f = nil
  result = nil
  if localfile
    f = File.open(localfile, "w")
  elsif !block_given?
    result = String.new
  end
  begin
    retrlines("RETR #{remotefile}") do |line, newline|
      l = newline ? line + "\n" : line
      f&.print(l)
      block&.(line, newline)
      result&.concat(l)
    end
    return result
  ensure
    f&.close
  end
end

#help(arg = nil) ⇒ Object

Issues the HELP command.



1302
1303
1304
1305
1306
1307
1308
 
# File 'lib/net/ftp.rb', line 1302

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.



935
936
937
938
939
940
941
942
943
944
945
946
947
948
 
# File 'lib/net/ftp.rb', line 935

def list(*args, &block) # :yield: line
  cmd = "LIST"
  args.each do |arg|
    cmd = "#{cmd} #{arg}"
  end
  lines = []
  retrlines(cmd) do |line|
    lines << line
  end
  if block
    lines.each(&block)
  end
  return lines
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, “anonymous@” is used as a password. 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).



626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
 
# File 'lib/net/ftp.rb', line 626

def (user = "anonymous", passwd = nil, acct = nil)
  if user == "anonymous" and passwd == nil
    passwd = "anonymous@"
  end

  resp = ""
  synchronize do
    resp = sendcmd('USER ' + user)
    if resp.start_with?("3")
      raise FTPReplyError, resp if passwd.nil?
      resp = sendcmd('PASS ' + passwd)
    end
    if resp.start_with?("3")
      raise FTPReplyError, resp if acct.nil?
      resp = sendcmd('ACCT ' + acct)
    end
  end
  if !resp.start_with?("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.



1292
1293
1294
1295
1296
1297
 
# File 'lib/net/ftp.rb', line 1292

def mdtm(filename)
  resp = sendcmd("MDTM #{filename}")
  if resp.start_with?("213")
    return get_body(resp)
  end
end

#mkdir(dirname) ⇒ Object

Creates a remote directory.



1224
1225
1226
1227
 
# File 'lib/net/ftp.rb', line 1224

def mkdir(dirname)
  resp = sendcmd("MKD #{dirname}")
  return parse257(resp)
end

#mlsd(pathname = nil, &block) ⇒ Object

Returns an array of the entries of the directory specified by pathname. Each entry has the facts (e.g., size, last modification time, etc.) and the pathname. If a block is given, it iterates through the listing. If pathname is omitted, the current directory is assumed.



1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
 
# File 'lib/net/ftp.rb', line 1140

def mlsd(pathname = nil, &block) # :yield: entry
  cmd = pathname ? "MLSD #{pathname}" : "MLSD"
  entries = []
  retrlines(cmd) do |line|
    entries << parse_mlsx_entry(line)
  end
  if block
    entries.each(&block)
  end
  return entries
end

#mlst(pathname = nil) ⇒ Object

Returns data (e.g., size, last modification time, entry type, etc.) about the file or directory specified by pathname. If pathname is omitted, the current directory is assumed.



1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
 
# File 'lib/net/ftp.rb', line 1118

def mlst(pathname = nil)
  cmd = pathname ? "MLST #{pathname}" : "MLST"
  resp = sendcmd(cmd)
  if !resp.start_with?("250")
    raise FTPReplyError, resp
  end
  line = resp.lines[1]
  unless line
    raise FTPProtoError, resp
  end
  entry = line.sub(/\A(250-| *)/, "")
  return parse_mlsx_entry(entry)
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.



1217
1218
1219
 
# File 'lib/net/ftp.rb', line 1217

def mtime(filename, local = false)
  return TIME_PARSER.(mdtm(filename), local)
end

#nlst(dir = nil) ⇒ Object

Returns an array of filenames in the remote directory.



919
920
921
922
923
924
925
926
927
928
929
 
# File 'lib/net/ftp.rb', line 919

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.



1322
1323
1324
 
# File 'lib/net/ftp.rb', line 1322

def noop
  voidcmd("NOOP")
end

#option(name, params = nil) ⇒ Object

Issues an OPTS command

  • name Should be the name of the option to set

  • params is any optional parameters to supply with the option

example: option(‘UTF8’, ‘ON’) => ‘OPTS UTF8 ON’



1362
1363
1364
1365
1366
1367
 
# File 'lib/net/ftp.rb', line 1362

def option(name, params = nil)
  cmd = "OPTS #{name}"
  cmd += " #{params}" if params

  voidcmd(cmd)
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.



896
897
898
899
900
901
902
903
 
# File 'lib/net/ftp.rb', line 896

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.



854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
 
# File 'lib/net/ftp.rb', line 854

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 = File.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.



883
884
885
886
887
888
889
890
 
# File 'lib/net/ftp.rb', line 883

def puttextfile(localfile, remotefile = File.basename(localfile), &block) # :yield: line
  f = File.open(localfile)
  begin
    storlines("STOR #{remotefile}", f, &block)
  ensure
    f.close
  end
end

#pwd ⇒ Object Also known as: getdir

Returns the current remote directory.



1239
1240
1241
1242
 
# File 'lib/net/ftp.rb', line 1239

def pwd
  resp = sendcmd("PWD")
  return parse257(resp)
end

#quit ⇒ Object

Exits the FTP session.



1313
1314
1315
 
# File 'lib/net/ftp.rb', line 1313

def quit
  voidcmd("QUIT")
end

#rename(fromname, toname) ⇒ Object

Renames a file on the server.



1155
1156
1157
1158
1159
1160
1161
 
# File 'lib/net/ftp.rb', line 1155

def rename(fromname, toname)
  resp = sendcmd("RNFR #{fromname}")
  if !resp.start_with?("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”).



657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
 
# File 'lib/net/ftp.rb', line 657

def retrbinary(cmd, blocksize, rest_offset = nil) # :yield: data
  synchronize do
    with_binary(true) do
      begin
        conn = transfercmd(cmd, rest_offset)
        while data = conn.read(blocksize)
          yield(data)
        end
        conn.shutdown(Socket::SHUT_WR) rescue nil
        conn.read_timeout = 1
        conn.read rescue nil
      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”).



682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
 
# File 'lib/net/ftp.rb', line 682

def retrlines(cmd) # :yield: line
  synchronize do
    with_binary(false) do
      begin
        conn = transfercmd(cmd)
        while line = conn.gets
          yield(line.sub(/\r?\n\z/, ""), !line.match(/\n\z/).nil?)
        end
        conn.shutdown(Socket::SHUT_WR) rescue nil
        conn.read_timeout = 1
        conn.read rescue nil
      ensure
        conn.close if conn
      end
      voidresp
    end
  end
end

#return_code ⇒ Object

Obsolete



343
344
345
346
 
# File 'lib/net/ftp.rb', line 343

def return_code # :nodoc:
  warn("Net::FTP#return_code is obsolete and do nothing", uplevel: 1)
  return "\n"
end

#return_code=(s) ⇒ Object

Obsolete



349
350
351
 
# File 'lib/net/ftp.rb', line 349

def return_code=(s) # :nodoc:
  warn("Net::FTP#return_code= is obsolete and do nothing", uplevel: 1)
end

#rmdir(dirname) ⇒ Object

Removes a remote directory.



1232
1233
1234
 
# File 'lib/net/ftp.rb', line 1232

def rmdir(dirname)
  voidcmd("RMD #{dirname}")
end

#sendcmd(cmd) ⇒ Object

Sends a command and returns the response.



514
515
516
517
518
519
 
# File 'lib/net/ftp.rb', line 514

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.



423
424
425
426
427
428
429
430
 
# File 'lib/net/ftp.rb', line 423

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.



1329
1330
1331
1332
 
# File 'lib/net/ftp.rb', line 1329

def site(arg)
  cmd = "SITE " + arg
  voidcmd(cmd)
end

#size(filename) ⇒ Object

Returns the size of the given (remote) filename.



1203
1204
1205
1206
1207
1208
1209
1210
1211
 
# File 'lib/net/ftp.rb', line 1203

def size(filename)
  with_binary(true) do
    resp = sendcmd("SIZE #{filename}")
    if !resp.start_with?("213")
      raise FTPReplyError, resp
    end
    return get_body(resp).to_i
  end
end

#status(pathname = nil) ⇒ Object

Returns the status (STAT command).

pathname

when stat is invoked with pathname as a parameter it acts like list but a lot faster and over the same tcp session.



1276
1277
1278
1279
1280
1281
1282
1283
1284
 
# File 'lib/net/ftp.rb', line 1276

def status(pathname = nil)
  line = pathname ? "STAT #{pathname}" : "STAT"
  if /[\r\n]/ =~ line
    raise ArgumentError, "A line must not contain CR or LF"
  end
  debug_print "put: #{line}"
  @sock.send(line + CRLF, 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.



707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
 
# File 'lib/net/ftp.rb', line 707

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
      begin
        conn = transfercmd(cmd)
        while buf = file.read(blocksize)
          conn.write(buf)
          yield(buf) if block_given?
        end
        conn.shutdown(Socket::SHUT_WR) rescue nil
        conn.read_timeout = 1
        conn.read rescue nil
      ensure
        conn.close if conn
      end
      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.



743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
 
# File 'lib/net/ftp.rb', line 743

def storlines(cmd, file) # :yield: line
  synchronize do
    with_binary(false) do
      begin
        conn = transfercmd(cmd)
        while buf = file.gets
          if buf[-2, 2] != CRLF
            buf = buf.chomp + CRLF
          end
          conn.write(buf)
          yield(buf) if block_given?
        end
        conn.shutdown(Socket::SHUT_WR) rescue nil
        conn.read_timeout = 1
        conn.read rescue nil
      ensure
        conn.close if conn
      end
      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.



1248
1249
1250
1251
1252
1253
1254
 
# File 'lib/net/ftp.rb', line 1248

def system
  resp = sendcmd("SYST")
  if !resp.start_with?("215")
    raise FTPReplyError, resp
  end
  return get_body(resp)
end

#voidcmd(cmd) ⇒ Object

Sends a command and expect a response beginning with ‘2’.



524
525
526
527
528
529
 
# File 'lib/net/ftp.rb', line 524

def voidcmd(cmd)
  synchronize do
    putline(cmd)
    voidresp
  end
end