Spec-Zone.ru › Ruby 2.4

класс URI::FTP

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

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

Этот класс будет переработан из-за различий в реализации; структура пути. черновик draft-hoffman-ftp-uri-04 является черновиком, но представляет собой хорошее резюме фактического стандарта. tools.ietf.org/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 95
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.

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

Если используется массив, компоненты должны быть переданы в порядке

userinfo, host, port, path, typecode

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

require 'uri'

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

uri2 = URI::FTP.build({:host => 'ftp.example.com',
  :path => 'ruby/src'})
puts 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 132
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

Строка

Описание

Публичный установщик значения typecode v. (с проверкой)

см. также #check_typecode

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

require 'uri'

uri = URI.parse("ftp://john@ftp.example.com/my_file.img")
#=> #<URI::FTP:0x00000000923650 URL:ftp://john@ftp.example.com/my_file.img>
uri.typecode = "i"
# =>  "i"
uri
#=> #<URI::FTP:0x00000000923650 URL: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 179
def set_typecode(v)
  @typecode = v
end

Закрытый установщик значения typecode v

см. также #typecode=

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

check_typecode(v) Показать исходный код
# File lib/uri/ftp.rb, line 165
def check_typecode(v)
  if TYPECODE.include?(v)
    return true
  else
    raise InvalidComponentError,
      "bad typecode(expected #{TYPECODE.join(', ')}): #{v}"
  end
end

Проверяет typecode v, возвращает true или false булево значение

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