Class: Net::FTP

Inherits:
Protocol 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

FTP_PORT =

:stopdoc:

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+))?/x =~ value
    raise FTPProtoError, "invalid time-val: #{value}"
  end
  usec = fractions.to_i * 10 ** (6 - fractions.to_s.size)
  Time.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 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 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 is true.

username

Username for login. If options is the string “anonymous” and the options 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.

debug_mode

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



211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
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
 
# File 'lib/net/ftp.rb', line 211

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
  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
  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
  @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
  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.



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

def binary
  @binary
end

#debug_mode ⇒ Object

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



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

def debug_mode
  @debug_mode
end

#last_response ⇒ Object (readonly)

The server’s last response.



141
142
143
 
# File 'lib/net/ftp.rb', line 141

def last_response
  @last_response
end

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

The server’s last response code.



137
138
139
 
# File 'lib/net/ftp.rb', line 137

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.



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

def open_timeout
  @open_timeout
end

#passive ⇒ Object

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



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

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.



125
126
127
 
# File 'lib/net/ftp.rb', line 125

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.



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

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.



119
120
121
 
# File 'lib/net/ftp.rb', line 119

def ssl_handshake_timeout
  @ssl_handshake_timeout
end

#welcome ⇒ Object (readonly)

The server’s welcome message.



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

def welcome
  @welcome
end

Class Method Details

.default_passive ⇒ Object

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



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

def self.default_passive
  @@default_passive
end

.default_passive=(value) ⇒ Object

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



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

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.



161
162
163
164
165
166
167
168
169
170
171
172
 
# File 'lib/net/ftp.rb', line 161

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).



1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
 
# File 'lib/net/ftp.rb', line 1230

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.



883
884
885
886
 
# File 'lib/net/ftp.rb', line 883

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

#chdir(dirname) ⇒ Object

Changes the (remote) directory.



1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
 
# File 'lib/net/ftp.rb', line 1151

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.



1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
 
# File 'lib/net/ftp.rb', line 1344

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.

Returns:

  • (Boolean) 


1360
1361
1362
 
# File 'lib/net/ftp.rb', line 1360

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.



366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
 
# File 'lib/net/ftp.rb', line 366

def connect(host, port = FTP_PORT)
  if @debug_mode
    print "connect: ", host, ", ", port, "\n"
  end
  synchronize do
    @host = host
    @bare_sock = open_socket(host, port)
    @sock = BufferedSocket.new(@bare_sock, read_timeout: @read_timeout)
    voidresp
    if @ssl_context
      begin
        voidcmd("AUTH TLS")
        ssl_sock = start_tls_session(@bare_sock)
        @sock = BufferedSSLSocket.new(ssl_sock, read_timeout: @read_timeout)
        if @private_data_connection
          voidcmd("PBSZ 0")
          voidcmd("PROT P")
        end
      rescue OpenSSL::SSL::SSLError, OpenTimeout
        @sock.close
        raise
      end
    end
  end
end

#delete(filename) ⇒ Object

Deletes a file on the server.



1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
 
# File 'lib/net/ftp.rb', line 1137

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



1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
 
# File 'lib/net/ftp.rb', line 1310

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.



812
813
814
815
816
817
818
819
 
# File 'lib/net/ftp.rb', line 812

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.



751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
 
# File 'lib/net/ftp.rb', line 751

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.



786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
 
# File 'lib/net/ftp.rb', line 786

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.



1273
1274
1275
1276
1277
1278
1279
 
# File 'lib/net/ftp.rb', line 1273

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.



907
908
909
910
911
912
913
914
915
916
917
918
919
920
 
# File 'lib/net/ftp.rb', line 907

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).



598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
 
# File 'lib/net/ftp.rb', line 598

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.



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

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.



1195
1196
1197
1198
 
# File 'lib/net/ftp.rb', line 1195

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.



1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
 
# File 'lib/net/ftp.rb', line 1111

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.



1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
 
# File 'lib/net/ftp.rb', line 1089

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.



1188
1189
1190
 
# File 'lib/net/ftp.rb', line 1188

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.



891
892
893
894
895
896
897
898
899
900
901
 
# File 'lib/net/ftp.rb', line 891

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.



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

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’



1333
1334
1335
1336
1337
1338
 
# File 'lib/net/ftp.rb', line 1333

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.



868
869
870
871
872
873
874
875
 
# File 'lib/net/ftp.rb', line 868

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.



826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
 
# File 'lib/net/ftp.rb', line 826

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.



855
856
857
858
859
860
861
862
 
# File 'lib/net/ftp.rb', line 855

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.



1210
1211
1212
1213
 
# File 'lib/net/ftp.rb', line 1210

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

#quit ⇒ Object

Exits the FTP session.



1284
1285
1286
 
# File 'lib/net/ftp.rb', line 1284

def quit
  voidcmd("QUIT")
end

#rename(fromname, toname) ⇒ Object

Renames a file on the server.



1126
1127
1128
1129
1130
1131
1132
 
# File 'lib/net/ftp.rb', line 1126

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”).



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

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)
        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”).



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

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)
        conn.read_timeout = 1
        conn.read
      ensure
        conn.close if conn
      end
      voidresp
    end
  end
end

#return_code ⇒ Object

Obsolete



316
317
318
319
 
# File 'lib/net/ftp.rb', line 316

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

#return_code=(s) ⇒ Object

Obsolete



322
323
324
 
# File 'lib/net/ftp.rb', line 322

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.



1203
1204
1205
 
# File 'lib/net/ftp.rb', line 1203

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

#sendcmd(cmd) ⇒ Object

Sends a command and returns the response.



491
492
493
494
495
496
 
# File 'lib/net/ftp.rb', line 491

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.



396
397
398
399
400
401
402
403
 
# File 'lib/net/ftp.rb', line 396

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.



1300
1301
1302
1303
 
# File 'lib/net/ftp.rb', line 1300

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

#size(filename) ⇒ Object

Returns the size of the given (remote) filename.



1174
1175
1176
1177
1178
1179
1180
1181
1182
 
# File 'lib/net/ftp.rb', line 1174

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.



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

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



679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
 
# File 'lib/net/ftp.rb', line 679

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)
        conn.read_timeout = 1
        conn.read
      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.



715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
 
# File 'lib/net/ftp.rb', line 715

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)
        conn.read_timeout = 1
        conn.read
      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.



1219
1220
1221
1222
1223
1224
1225
 
# File 'lib/net/ftp.rb', line 1219

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’.



501
502
503
504
505
506
 
# File 'lib/net/ftp.rb', line 501

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