Class: Net::FTP

Inherits:
Object show all
Includes:
MonitorMixin
Defined in:
lib/extensions/net-http/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('ftp.netlab.co.jp')
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('ftp.netlab.co.jp') 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: NullSocket

Constant Summary collapse

FTP_PORT =

:stopdoc:

21
CRLF = 
"\r\n"
DEFAULT_BLOCKSIZE = 
4096
MDTM_REGEXP =

:nodoc:

/^(\d\d\d\d)(\d\d)(\d\d)(\d\d)(\d\d)(\d\d)/

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from MonitorMixin

extend_object, #mon_enter, #mon_exit, #mon_synchronize, #mon_try_enter, #new_cond

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.



130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
 
# File 'lib/extensions/net-http/net/ftp.rb', line 130

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
  if host
	connect(host)
	if user
	  (user, passwd, acct)
	end
  end
end

Instance Attribute Details

#binary ⇒ Object

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



83
84
85
 
# File 'lib/extensions/net-http/net/ftp.rb', line 83

def binary
  @binary
end

#debug_mode ⇒ Object

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



90
91
92
 
# File 'lib/extensions/net-http/net/ftp.rb', line 90

def debug_mode
  @debug_mode
end

#last_response ⇒ Object (readonly)

The server’s last response.



104
105
106
 
# File 'lib/extensions/net-http/net/ftp.rb', line 104

def last_response
  @last_response
end

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

The server’s last response code.



100
101
102
 
# File 'lib/extensions/net-http/net/ftp.rb', line 100

def last_response_code
  @last_response_code
end

#passive ⇒ Object

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



86
87
88
 
# File 'lib/extensions/net-http/net/ftp.rb', line 86

def passive
  @passive
end

#resume ⇒ Object

Sets or retrieves the resume status, which decides whether incomplete transfers are resumed or restarted. Default: false.



94
95
96
 
# File 'lib/extensions/net-http/net/ftp.rb', line 94

def resume
  @resume
end

#welcome ⇒ Object (readonly)

The server’s welcome message.



97
98
99
 
# File 'lib/extensions/net-http/net/ftp.rb', line 97

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.



112
113
114
115
116
117
118
119
120
121
122
123
 
# File 'lib/extensions/net-http/net/ftp.rb', line 112

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



797
798
799
800
801
802
803
804
805
806
 
# File 'lib/extensions/net-http/net/ftp.rb', line 797

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. TODO: more info.



649
650
651
652
 
# File 'lib/extensions/net-http/net/ftp.rb', line 649

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

#chdir(dirname) ⇒ Object

Changes the (remote) directory.



719
720
721
722
723
724
725
726
727
728
729
730
731
732
 
# File 'lib/extensions/net-http/net/ftp.rb', line 719

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.



865
866
867
 
# File 'lib/extensions/net-http/net/ftp.rb', line 865

def close
  @sock.close if @sock and not @sock.closed?
end

#closed? ⇒ Boolean

Returns true iff the connection is closed.

Returns:

  • (Boolean) 


872
873
874
 
# File 'lib/extensions/net-http/net/ftp.rb', line 872

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.



200
201
202
203
204
205
206
207
208
 
# File 'lib/extensions/net-http/net/ftp.rb', line 200

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.



705
706
707
708
709
710
711
712
713
714
 
# File 'lib/extensions/net-http/net/ftp.rb', line 705

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.



581
582
583
584
585
586
587
588
 
# File 'lib/extensions/net-http/net/ftp.rb', line 581

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.



523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
 
# File 'lib/extensions/net-http/net/ftp.rb', line 523

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.



557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
 
# File 'lib/extensions/net-http/net/ftp.rb', line 557

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.



831
832
833
834
835
836
837
 
# File 'lib/extensions/net-http/net/ftp.rb', line 831

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.



673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
 
# File 'lib/extensions/net-http/net/ftp.rb', line 673

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



386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
 
# File 'lib/extensions/net-http/net/ftp.rb', line 386

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[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

Issues the MDTM command. TODO: more info.



821
822
823
824
825
826
 
# File 'lib/extensions/net-http/net/ftp.rb', line 821

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.



762
763
764
765
 
# File 'lib/extensions/net-http/net/ftp.rb', line 762

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.



753
754
755
756
757
 
# File 'lib/extensions/net-http/net/ftp.rb', line 753

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.



657
658
659
660
661
662
663
664
665
666
667
 
# File 'lib/extensions/net-http/net/ftp.rb', line 657

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.



849
850
851
 
# File 'lib/extensions/net-http/net/ftp.rb', line 849

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.



637
638
639
640
641
642
643
644
 
# File 'lib/extensions/net-http/net/ftp.rb', line 637

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.



595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
 
# File 'lib/extensions/net-http/net/ftp.rb', line 595

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.



624
625
626
627
628
629
630
631
 
# File 'lib/extensions/net-http/net/ftp.rb', line 624

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.



777
778
779
780
 
# File 'lib/extensions/net-http/net/ftp.rb', line 777

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

#quit ⇒ Object

Exits the FTP session.



842
843
844
 
# File 'lib/extensions/net-http/net/ftp.rb', line 842

def quit
  voidcmd("QUIT")
end

#rename(fromname, toname) ⇒ Object

Renames a file on the server.



694
695
696
697
698
699
700
 
# File 'lib/extensions/net-http/net/ftp.rb', line 694

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



417
418
419
420
421
422
423
424
425
426
427
428
429
430
 
# File 'lib/extensions/net-http/net/ftp.rb', line 417

def retrbinary(cmd, blocksize, rest_offset = nil) # :yield: data
  synchronize do
	with_binary(true) do
      conn = transfercmd(cmd, rest_offset)
      loop do
        data = conn.read(blocksize)
        break if data == nil
        yield(data)
      end
      conn.close
      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”).



438
439
440
441
442
443
444
445
446
447
448
449
450
451
 
# File 'lib/extensions/net-http/net/ftp.rb', line 438

def retrlines(cmd) # :yield: line
  synchronize do
	with_binary(false) do
      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.close
      voidresp
    end
  end
end

#return_code ⇒ Object

Obsolete



174
175
176
177
 
# File 'lib/extensions/net-http/net/ftp.rb', line 174

def return_code
  $stderr.puts("warning: Net::FTP#return_code is obsolete and do nothing")
  return "\n"
end

#return_code=(s) ⇒ Object

Obsolete



180
181
182
 
# File 'lib/extensions/net-http/net/ftp.rb', line 180

def return_code=(s)
  $stderr.puts("warning: Net::FTP#return_code= is obsolete and do nothing")
end

#rmdir(dirname) ⇒ Object

Removes a remote directory.



770
771
772
 
# File 'lib/extensions/net-http/net/ftp.rb', line 770

def rmdir(dirname)
  voidcmd("RMD " + dirname)
end

#sendcmd(cmd) ⇒ Object

Sends a command and returns the response.



291
292
293
294
295
296
 
# File 'lib/extensions/net-http/net/ftp.rb', line 291

def sendcmd(cmd)
  synchronize do
	putline(cmd)
	return getresp
  end
end

#set_socket(sock, get_greeting = true) ⇒ Object

WRITEME or make private



213
214
215
216
217
218
219
220
 
# File 'lib/extensions/net-http/net/ftp.rb', line 213

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.



856
857
858
859
 
# File 'lib/extensions/net-http/net/ftp.rb', line 856

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

#size(filename) ⇒ Object

Returns the size of the given (remote) filename.



737
738
739
740
741
742
743
744
745
 
# File 'lib/extensions/net-http/net/ftp.rb', line 737

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



811
812
813
814
815
816
 
# File 'lib/extensions/net-http/net/ftp.rb', line 811

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



459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
 
# File 'lib/extensions/net-http/net/ftp.rb', line 459

def storbinary(cmd, file, blocksize, rest_offset = nil, &block) # :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
      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, &block) ⇒ 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.



491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
 
# File 'lib/extensions/net-http/net/ftp.rb', line 491

def storlines(cmd, file, &block) # :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
      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.



786
787
788
789
790
791
792
 
# File 'lib/extensions/net-http/net/ftp.rb', line 786

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



301
302
303
304
305
306
 
# File 'lib/extensions/net-http/net/ftp.rb', line 301

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