класс URI::FTP
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='
Атрибуты
Доступ к коду типа
см. URI::FTP::COMPONENT
Публичные методы класса
# 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=a uri2 = URI::FTP.build({:host => 'ftp.example.com', :path => 'ruby/src'}) puts uri2.to_s -> ftp://ftp.example.com/ruby/src
# 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, в этом порядке.
Публичные методы экземпляра
# File lib/uri/ftp.rb, line 240 def path return @path.sub(/^\//,'').sub(/^%2F/,'/') end
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»
# 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
# File lib/uri/ftp.rb, line 208 def typecode=(typecode) check_typecode(typecode) set_typecode(typecode) typecode end
Аргументы
-
v -
Строка
Описание
Публичный метод установки кода типа 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>
Защищённые методы экземпляра
# File lib/uri/ftp.rb, line 245
def set_path(v)
super("/" + v.sub(/^\//, "%2F"))
end Приватный метод установки пути URI::FTP
# File lib/uri/ftp.rb, line 179 def set_typecode(v) @typecode = v end
Приватный метод установки кода типа v
См. также #typecode=
Приватные методы экземпляра
# 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 Проверяет код типа v, возвращает булево значение true или false
Ruby Core © 1993–2017 Yukihiro Matsumoto
Licensed under the Ruby License.
Ruby Standard Library © contributors
Licensed under their own licenses.