класс URI::FTP

Включенные модули:: OpenURI::OpenRead

FTP URI синтаксис определён в RFC1738 разделе 3.2.

Этот класс будет переработан из-за различий в реализациях; структура его пути. черновик draft-hoffman-ftp-uri-04 является черновиком, но является хорошим обзором фактического спецификации. datatracker.ietf.org/doc/html/draft-hoffman-ftp-uri-04

Константы

COMPONENT

Список доступных компонентов для URI::FTP.

DEFAULT_PORT

По умолчанию порт 21 для URI::FTP.

TYPECODE

Код типа — “a”, “i” или “d”.

“a” указывает на текстовый файл (команда FTP была ASCII)
“i” указывает на двоичный файл (команда FTP IMAGE)
“d” указывает, что содержимое каталога должно быть отображено

TYPECODE_PREFIX

Префикс кода типа “;type=”.

Атрибуты

typecode [R]

Доступ к типу.

См. URI::FTP::COMPONENT.

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

build (args)

Исходный код

# File lib/uri/ftp.rb, line 96
def self.build(args)

  # Fix the incoming path to be generic URL syntax
  # FTP path  ->  URL path
  # foo/bar       /foo/bar
  # /foo/bar      /%2Ffoo/bar
  #
  if args.kind_of?(Array)
    args[3] = '/' + args[3].sub(/^\//, '%2F')
  else
    args[:path] = '/' + args[:path].sub(/^\//, '%2F')
  end

  tmp = Util::make_components_hash(self, args)

  if tmp[:typecode]
    if tmp[:typecode].size == 1
      tmp[:typecode] = TYPECODE_PREFIX + tmp[:typecode]
    end
    tmp[:path] << tmp[:typecode]
  end

  return super(tmp)
end

Описание

Создаёт новый объект URI::FTP из компонентов, с проверкой синтаксиса.

Принимаемые компоненты: userinfo, host, port, path, и typecode.

Компоненты должны быть предоставлены либо как Array, либо как Hash с ключами, образованными из имён компонентов, предваряемых двоеточием.

Если используется Array, компоненты должны быть переданы в порядке [userinfo, host, port, path, typecode].

Если путь абсолютный, он будет экранирован, чтобы сделать его абсолютным в URI.

Примеры:

require 'uri'

uri1 = URI::FTP.build(['user:password', 'ftp.example.com', nil,
  '/path/file.zip', 'i'])
uri1.to_s  # => "ftp://user:password@ftp.example.com/%2Fpath/file.zip;type=i"

uri2 = URI::FTP.build({:host => 'ftp.example.com',
  :path => 'ruby/src'})
uri2.to_s  # => "ftp://ftp.example.com/ruby/src"

Вызов метода суперкласса

new (scheme, userinfo, host, port, registry, path, opaque, query, fragment, parser = nil, arg_check = false)

Исходный код

# File lib/uri/ftp.rb, line 133
def initialize(scheme,
               userinfo, host, port, registry,
               path, opaque,
               query,
               fragment,
               parser = nil,
               arg_check = false)
  raise InvalidURIError unless path
  path = path.sub(/^\//,'')
  path.sub!(/^%2F/,'/')
  super(scheme, userinfo, host, port, registry, path, opaque,
        query, fragment, parser, arg_check)
  @typecode = nil
  if tmp = @path.index(TYPECODE_PREFIX)
    typecode = @path[tmp + TYPECODE_PREFIX.size..-1]
    @path = @path[0..tmp - 1]

    if arg_check
      self.typecode = typecode
    else
      self.set_typecode(typecode)
    end
  end
end

Описание

Создаёт новый объект URI::FTP из общих компонентов URL без проверки синтаксиса.

В отличие от build(), этот метод не экранирует компонент пути, как требуется RFC1738; вместо этого он обрабатывается согласно RFC2396.

Аргументы: scheme, userinfo, host, port, registry, path, opaque, query, и fragment, в указанном порядке.

Вызов метода суперкласса

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

path ()

Исходный код

# File lib/uri/ftp.rb, line 240
def path
  return @path.sub(/^\//,'').sub(/^%2F/,'/')
end

Возвращает путь из FTP URI.

RFC 1738 чётко указывает, что путь для FTP URI не включает /, который разделяет путь URI от хоста URI. Пример:

ftp://ftp.example.com/pub/ruby

Указанный URI означает, что клиент должен подключиться к ftp.example.com и затем перейти в каталог pub/ruby из каталога по умолчанию при входе.

Если нужно перейти в абсолютный каталог, необходимо включить экранированную / (%2F) в пути. Пример:

ftp://ftp.example.com/%2Fpub/ruby

Этот метод вернёт “/pub/ruby”.

to_s ()

Исходный код

# File lib/uri/ftp.rb, line 251
def to_s
  save_path = nil
  if @typecode
    save_path = @path
    @path = @path + TYPECODE_PREFIX + @typecode
  end
  str = super
  if @typecode
    @path = save_path
  end

  return str
end

Возвращает строковое представление URI::FTP.

Вызов метода суперкласса

typecode= (typecode)

Исходный код

# File lib/uri/ftp.rb, line 208
def typecode=(typecode)
  check_typecode(typecode)
  set_typecode(typecode)
  typecode
end

Аргументы

v: String

Описание

Установка кода типа v (с валидацией).

См. также URI::FTP.check_typecode.

Использование

require 'uri'

uri = URI.parse("ftp://john@ftp.example.com/my_file.img")
#=> #<URI::FTP ftp://john@ftp.example.com/my_file.img>
uri.typecode = "i"
uri
#=> #<URI::FTP ftp://john@ftp.example.com/my_file.img;type=i>

Защищённые методы экземпляра

set_path (v)

Исходный код

# File lib/uri/ftp.rb, line 245
def set_path(v)
  super("/" + v.sub(/^\//, "%2F"))
end

Приватный установщик пути для URI::FTP.

Вызов метода суперкласса

set_typecode (v)

Исходный код

# File lib/uri/ftp.rb, line 180
def set_typecode(v)
  @typecode = v
end

Приватный установщик кода типа v.

См. также URI::FTP.typecode=.

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

check_typecode (v)

Исходный код

# File lib/uri/ftp.rb, line 166
def check_typecode(v)
  if TYPECODE.include?(v)
    return true
  else
    raise InvalidComponentError,
      "bad typecode(expected #{TYPECODE.join(', ')}): #{v}"
  end
end

Валидирует код типа v, возвращает true или false.

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