Spec-Zone.ru › Ruby 2.3

класс Net::FTP

Родитель:
Объект
Включенные модули:
MonitorMixin

Этот класс реализует протокол передачи файлов File Transfer Protocol. Если вы пользовались программой FTP в командной строке и знакомы с командами, вы легко сможете использовать этот класс. Добавлены некоторые дополнительные функции, чтобы воспользоваться стилем и преимуществами Ruby.

Пример

require 'net/ftp'

Пример 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

Пример 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

Основные методы

Ниже перечислены методы, которые, скорее всего, окажутся полезными для пользователей:

  • ::open

  • getbinaryfile

  • gettextfile

  • putbinaryfile

  • puttextfile

  • chdir

  • nlst

  • size

  • rename

  • delete

Константы

CASE_DEPENDENT_PARSER
CASE_INDEPENDENT_PARSER
DECIMAL_PARSER
FACT_PARSERS
OCTAL_PARSER
TIME_PARSER

Атрибуты

binary[R]

Когда true, передачи выполняются в двоичном режиме. По умолчанию: true.

debug_mode[RW]

Когда true, весь трафик к серверу и от него записывается в +$stdout+. По умолчанию: false.

last_response[R]

Последний ответ сервера.

last_response_code[R]

Код последнего ответа сервера.

lastresp[R]

Код последнего ответа сервера.

open_timeout[RW]

Количество секунд ожидания подключения. Можно использовать любое число, включая числа с плавающей точкой для дробных секунд. Если объект FTP не может установить соединение за это время, он генерирует исключение Net::OpenTimeout. Значение по умолчанию — nil.

passive[RW]

Когда true, соединение находится в пассивном режиме. По умолчанию: true.

read_timeout[R]

Количество секунд ожидания одного блока для чтения (через один вызов read(2)). Можно использовать любое число, включая числа с плавающей точкой для дробных секунд. Если объект FTP не может прочитать данные за это время, он генерирует исключение Timeout::Error. Значение по умолчанию — 60 секунд.

resume[RW]

Устанавливает или получает статус resume, который определяет, возобновляются ли незавершенные передачи или перезапускаются. По умолчанию: false.

welcome[R]

Приветственное сообщение сервера.

Публичные методы класса

default_passive() Показать исходный код
# File lib/net/ftp.rb, line 136
def self.default_passive
  @@default_passive
end

Когда true, соединения по умолчанию находятся в пассивном режиме. По умолчанию: true.

default_passive=(value) Показать исходный код
# File lib/net/ftp.rb, line 130
def self.default_passive=(value)
  @@default_passive = value
end

Когда true, соединения по умолчанию находятся в пассивном режиме. По умолчанию: true.

new(host = nil, user = nil, passwd = nil, acct = nil) Показать исходный код
# File lib/net/ftp.rb, line 164
def initialize(host = nil, user = nil, passwd = nil, acct = nil)
  super()
  @binary = true
  @passive = @@default_passive
  @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

Создает и возвращает новый объект FTP. Если задан host, устанавливается подключение. Кроме того, если задан user, для входа используются заданное имя пользователя, пароль и (необязательно) учетная запись. См. login.

Вызывается метод суперкласса MonitorMixin.new
open(host, user = nil, passwd = nil, acct = nil) { |ftp| ... } Показать исходный код
# File lib/net/ftp.rb, line 146
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

Синоним для FTP.new, но с обязательным параметром хоста.

Если задан блок, он передается объекту FTP, который будет закрыт по завершении блока или при возникновении исключения.

Публичные методы экземпляра

abort() Show source
# File lib/net/ftp.rb, line 1097
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

Прерывает предыдущую команду (команда ABOR).

acct(account) Show source
# File lib/net/ftp.rb, line 750
def acct(account)
  cmd = "ACCT " + account
  voidcmd(cmd)
end

Отправляет команду ACCT.

Это менее распространённая команда FTP для отправки информации об учётной записи, если это требуется хостом назначения.

binary=(newmode) Show source
# File lib/net/ftp.rb, line 184
def binary=(newmode)
  if newmode != @binary
    @binary = newmode
    send_type_command if @logged_in
  end
end

Установка для переключения режимов передачи в двоичный режим. newmode может быть либо true, либо false

chdir(dirname) Show source
# File lib/net/ftp.rb, line 1018
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() Show source
# File lib/net/ftp.rb, line 1170
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

Закрывает соединение. Дальнейшие операции невозможны до тех пор, пока вы не откроете новое соединение с помощью connect.

closed?() Show source
# File lib/net/ftp.rb, line 1186
def closed?
  @sock == nil or @sock.closed?
end

Возвращает true, если соединение закрыто.

connect(host, port = FTP_PORT) Show source
# File lib/net/ftp.rb, line 258
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

Устанавливает FTP соединение с хостом, при необходимости переопределяя порт по умолчанию. Если установлена переменная окружения SOCKS_SERVER, настраивает соединение через прокси SOCKS. Вызывает исключение (обычно Errno::ECONNREFUSED) если соединение не может быть установлено.

delete(filename) Show source
# File lib/net/ftp.rb, line 1004
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

Удаляет файл на сервере.

dir(*args)
Псевдоним для: list
get(remotefile, localfile = File.basename(remotefile), blocksize = DEFAULT_BLOCKSIZE) { |data| ... } Show source
# File lib/net/ftp.rb, line 679
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

Извлекает remotefile в любом режиме, установленном для сессии (текстовый или двоичный). См. gettextfile и getbinaryfile.

getbinaryfile(remotefile, localfile = File.basename(remotefile), blocksize = DEFAULT_BLOCKSIZE) { |data| ... } Show source
# File lib/net/ftp.rb, line 618
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

Извлекает remotefile в двоичном режиме, сохраняя результат в localfile. Если localfile равно nil, возвращает полученные данные. Если предоставлен блок, ему передаются полученные данные в виде блоков по blocksize.

getdir()
Псевдоним для: pwd
gettextfile(remotefile, localfile = File.basename(remotefile)) { |line| ... } Show source
# File lib/net/ftp.rb, line 653
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

Извлекает remotefile в режиме ASCII (текстовом), сохраняя результат в localfile. Если localfile равно nil, возвращает полученные данные. Если предоставлен блок, ему передаются полученные данные построчно.

help(arg = nil) Show source
# File lib/net/ftp.rb, line 1134
def help(arg = nil)
  cmd = "HELP"
  if arg
    cmd = cmd + " " + arg
  end
  sendcmd(cmd)
end

Выполняет команду HELP.

list(*args) { |line| ... } Show source
# File lib/net/ftp.rb, line 774
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

Возвращает массив информации о файлах в каталоге (вывод похож на `ls -l`). Если предоставлен блок, он итерирует по списку.

Также является псевдонимом для: ls, dir
login(user = "anonymous", passwd = nil, acct = nil) Show source
# File lib/net/ftp.rb, line 469
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.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

Авторизуется на удалённом хосте. Сессия должна быть предварительно подключена. Если user — строка «anonymous», а password — nil, то в качестве пароля используется «anonymous@». Если параметр acct не nil, после успешной авторизации отправляется команда FTP ACCT. Вызывает исключение при ошибке (обычно Net::FTPPermError).

ls(*args)
Псевдоним для: list
mdtm(filename) Show source
# File lib/net/ftp.rb, line 1124
def mdtm(filename)
  resp = sendcmd("MDTM #{filename}")
  if resp.start_with?("213")
    return get_body(resp)
  end
end

Возвращает необработанное время последнего изменения (удаленного) файла в формате “YYYYMMDDhhmmss” (команда MDTM).

Используйте mtime, если вам нужен разобранный экземпляр Time.

mkdir(dirname) Show source
# File lib/net/ftp.rb, line 1062
def mkdir(dirname)
  resp = sendcmd("MKD #{dirname}")
  return parse257(resp)
end

Создает удалённый каталог.

mlsd(pathname = nil) { |entry| ... } Show source
# File lib/net/ftp.rb, line 978
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

Возвращает массив записей каталога, указанного pathname. Каждая запись содержит данные (например, размер, время последнего изменения и т.д.) и имя пути. Если предоставлен блок, он итерирует по списку. Если pathname пропущен, предполагается текущий каталог.

mlst(pathname = nil) Show source
# File lib/net/ftp.rb, line 956
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

Возвращает данные (например, размер, время последнего изменения, тип записи и т.д.) о файле или каталоге, указанном pathname. Если pathname пропущен, предполагается текущий каталог.

mtime(filename, local = false) Show source
# File lib/net/ftp.rb, line 1055
def mtime(filename, local = false)
  return TIME_PARSER.(mdtm(filename), local)
end

Возвращает время последнего изменения (удаленного) файла. Если local — true, оно возвращается как локальное время, в противном случае — как время UTC.

nlst(dir = nil) Show source
# File lib/net/ftp.rb, line 758
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() Show source
# File lib/net/ftp.rb, line 1154
def noop
  voidcmd("NOOP")
end

Выполняет команду NOOP.

Ничего не делает, кроме возвращения ответа.

put(localfile, remotefile = File.basename(localfile), blocksize = DEFAULT_BLOCKSIZE, &block) Show source
# File lib/net/ftp.rb, line 735
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

Перемещает localfile на сервер в том режиме, в котором установлен сеанс (текстовый или двоичный). См. puttextfile и putbinaryfile.

putbinaryfile(localfile, remotefile = File.basename(localfile), blocksize = DEFAULT_BLOCKSIZE) { |data| ... } Show source
# File lib/net/ftp.rb, line 693
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

Перемещает localfile на сервер в двоичном режиме, сохраняя результат в remotefile. Если предоставлен блок, вызывает его, передавая переданные данные в blocksize фрагментах.

puttextfile(localfile, remotefile = File.basename(localfile)) { |line| ... } Show source
# File lib/net/ftp.rb, line 722
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

Перемещает localfile на сервер в режиме ASCII (текст), сохраняя результат в remotefile. Если предоставлен обратный вызов или связанный блок, вызывает его, передавая переданные данные построчно.

pwd() Show source
# File lib/net/ftp.rb, line 1077
def pwd
  resp = sendcmd("PWD")
  return parse257(resp)
end

Возвращает текущий удалённый каталог.

Также известен как: getdir
quit() Show source
# File lib/net/ftp.rb, line 1145
def quit
  voidcmd("QUIT")
end

Завершает сеанс FTP.

read_timeout=(sec) Show source
# File lib/net/ftp.rb, line 113
def read_timeout=(sec)
  @sock.read_timeout = sec
  @read_timeout = sec
end

Установка атрибута #read_timeout.

rename(fromname, toname) Show source
# File lib/net/ftp.rb, line 993
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) { |data| ... } Show source
# File lib/net/ftp.rb, line 500
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

Переводит соединение в двоичный (графический) режим, выполняет заданную команду и извлекает возвращенные данные, передавая их в связанный блок фрагментами по blocksize символов. Обратите внимание, что cmd — это команда сервера (например, «RETR myfile»).

retrlines(cmd) { |line| ... } Show source
# File lib/net/ftp.rb, line 527
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

Переводит соединение в режим ASCII (текст), выполняет заданную команду и передаёт результирующие данные построчно в связанный блок. Если блок не указан, печатает строки. Обратите внимание, что cmd — это команда сервера (например, «RETR myfile»).

rmdir(dirname) Show source
# File lib/net/ftp.rb, line 1070
def rmdir(dirname)
  voidcmd("RMD #{dirname}")
end

Удаляет удалённый каталог.

sendcmd(cmd) Show source
# File lib/net/ftp.rb, line 367
def sendcmd(cmd)
  synchronize do
    putline(cmd)
    return getresp
  end
end

Отправляет команду и возвращает ответ.

set_socket(sock, get_greeting = true) Show source
# File lib/net/ftp.rb, line 272
def set_socket(sock, get_greeting = true)
  synchronize do
    @sock = sock
    if get_greeting
      voidresp
    end
  end
end

Устанавливает сокет, используемый для подключения к серверу FTP.

Может вызвать FTPReplyError, если get_greeting равно false.

site(arg) Show source
# File lib/net/ftp.rb, line 1161
def site(arg)
  cmd = "SITE " + arg
  voidcmd(cmd)
end

Выполняет команду SITE.

size(filename) Show source
# File lib/net/ftp.rb, line 1041
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() Show source
# File lib/net/ftp.rb, line 1111
def status
  line = "STAT" + CRLF
  print "put: STAT\n" if @debug_mode
  @sock.send(line, Socket::MSG_OOB)
  return getresp
end

Возвращает статус (команда STAT).

storbinary(cmd, file, blocksize, rest_offset = nil) { |data| ... } Show source
# File lib/net/ftp.rb, line 554
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

Переводит соединение в двоичный (графический) режим, выполняет заданную команду на стороне сервера (например, «STOR myfile») и отправляет содержимое файла с именем file на сервер. Если указан необязательный блок, он также передаёт ему данные фрагментами по blocksize символов.

storlines(cmd, file) { |line| ... } Show source
# File lib/net/ftp.rb, line 586
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

Переводит соединение в режим ASCII (текст), выполняет заданную команду на стороне сервера (например, «STOR myfile») и отправляет содержимое файла с именем file на сервер построчно. Если указан необязательный блок, он также передаёт ему строки.

system() Show source
# File lib/net/ftp.rb, line 1086
def system
  resp = sendcmd("SYST")
  if !resp.start_with?("215")
    raise FTPReplyError, resp
  end
  return get_body(resp)
end

Возвращает информацию о системе.

voidcmd(cmd) Show source
# File lib/net/ftp.rb, line 377
def voidcmd(cmd)
  synchronize do
    putline(cmd)
    voidresp
  end
end

Отправляет команду и ожидает ответ, начинающийся с '2'.

Приватные методы экземпляра

parse_mlsx_entry(entry) Show source
# File lib/net/ftp.rb, line 936
def parse_mlsx_entry(entry)
  facts, pathname = entry.chomp.split(/ /, 2)
  unless pathname
    raise FTPProtoError, entry
  end
  return MLSxEntry.new(
    facts.scan(/(.*?)=(.*?);/).each_with_object({}) {
      |(factname, value), h|
      name = factname.downcase
      h[name] = FACT_PARSERS[name].(value)
    },
    pathname)
end
parse_pasv_ipv4_host(s) Show source
# File lib/net/ftp.rb, line 1224
def parse_pasv_ipv4_host(s)
  return s.tr(",", ".")
end
parse_pasv_ipv6_host(s) Show source
# File lib/net/ftp.rb, line 1229
def parse_pasv_ipv6_host(s)
  return s.split(/,/).map { |i|
    "%02x" % i.to_i
  }.each_slice(2).map(&:join).join(":")
end
parse_pasv_port(s) Show source
# File lib/net/ftp.rb, line 1236
def parse_pasv_port(s)
  return s.split(/,/).map(&:to_i).inject { |x, y|
    (x << 8) + y
  }
end

Ruby Core © 1993–2017 Yukihiro Matsumoto
Licensed under the Ruby License.
Ruby Standard Library © contributors
Licensed under their own licenses.

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API