класс URI::Generic
Базовый класс для всех URI классов. Реализует общий URI синтаксис согласно RFC 2396.
Константы
- COMPONENT
-
Массив доступных компонентов для
URI::Generic. - DEFAULT_PORT
-
Значение порта по умолчанию для
URI::Generic- nil.
Атрибуты
Возвращает компонент фрагмента URI.
URI("http://foo/bar/baz?search=FooBar#ponies").fragment #=> "ponies"
Возвращает компонент хоста URI.
URI("http://foo/bar/baz").host #=> "foo"
Возвращает nil, если компонент хоста отсутствует.
URI("mailto:foo@example.org").host #=> nil
Компонент не содержит номер порта.
URI("http://foo:8080/bar/baz").host #=> "foo"
Так как IPv6 адреса в URI заключены в скобки, этот метод возвращает IPv6 адреса, заключенные в скобки. Этот формат не подходит для передачи в методы сокета, такие как TCPSocket.open. Если требуются имена хостов без скобок, используйте метод hostname.
URI("http://[::1]/bar/baz").host #=> "[::1]"
URI("http://[::1]/bar/baz").hostname #=> "::1"
Возвращает неявную часть URI.
URI("mailto:foo@example.org").opaque #=> "foo@example.org"
URI("http://foo/bar/baz").opaque #=> nil
Часть пути, которая не использует слеш '/'. Путь обычно ссылается на абсолютный путь или неявную часть. (См. RFC2396 Раздел 3 и 5.2.)
Возвращает компонент пути URI.
URI("http://foo/bar/baz").path #=> "/bar/baz"
Возвращает компонент порта URI.
URI("http://foo/bar/baz").port #=> 80
URI("http://foo:8080/bar/baz").port #=> 8080
Возвращает компонент запроса URI.
URI("http://foo/bar/baz?search=FooBar").query #=> "search=FooBar"
Возвращает компонент схемы URI.
URI("http://foo/bar/baz").scheme #=> "http"
Открытые методы класса
# File lib/uri/generic.rb, line 117
def self.build(args)
if args.kind_of?(Array) &&
args.size == ::URI::Generic::COMPONENT.size
tmp = args.dup
elsif args.kind_of?(Hash)
tmp = ::URI::Generic::COMPONENT.collect do |c|
if args.include?(c)
args[c]
else
nil
end
end
else
component = self.class.component rescue ::URI::Generic::COMPONENT
raise ArgumentError,
"expected Array of or Hash of components of #{self.class} (#{component.join(', ')})"
end
tmp << nil
tmp << true
return self.new(*tmp)
end Синопсис
См. ::new.
Описание
Создает новый экземпляр URI::Generic из компонентов URI::Generic с проверкой. Компоненты: схема, имя пользователя, хост, порт, регистр, путь, неявная часть, запрос и фрагмент. Вы можете передавать аргументы как в виде массива, так и в виде хэша. См. ::new для ключей хэша или порядка элементов массива.
# File lib/uri/generic.rb, line 79
def self.build2(args)
begin
return self.build(args)
rescue InvalidComponentError
if args.kind_of?(Array)
return self.build(args.collect{|x|
if x.is_a?(String)
DEFAULT_PARSER.escape(x)
else
x
end
})
elsif args.kind_of?(Hash)
tmp = {}
args.each do |key, value|
tmp[key] = if value
DEFAULT_PARSER.escape(value)
else
value
end
end
return self.build(tmp)
end
end
end Синопсис
См. ::new.
Описание
Сначала пытается создать новый экземпляр URI::Generic с помощью URI::Generic::build. Но, если возникает исключение URI::InvalidComponentError, то выполняет URI::Escape.escape всех компонентов URI и пытается снова.
# File lib/uri/generic.rb, line 58 def self.component self::COMPONENT end
Компоненты URI в порядке.
# File lib/uri/generic.rb, line 33 def self.default_port self::DEFAULT_PORT end
Возвращает порт по умолчанию.
# File lib/uri/generic.rb, line 170
def initialize(scheme,
userinfo, host, port, registry,
path, opaque,
query,
fragment,
parser = DEFAULT_PARSER,
arg_check = false)
@scheme = nil
@user = nil
@password = nil
@host = nil
@port = nil
@path = nil
@query = nil
@opaque = nil
@fragment = nil
@parser = parser == DEFAULT_PARSER ? nil : parser
if arg_check
self.scheme = scheme
self.userinfo = userinfo
self.hostname = host
self.port = port
self.path = path
self.query = query
self.opaque = opaque
self.fragment = fragment
else
self.set_scheme(scheme)
self.set_userinfo(userinfo)
self.set_host(host)
self.set_port(port)
self.set_path(path)
self.query = query
self.set_opaque(opaque)
self.fragment=(fragment)
end
if registry
raise InvalidURIError,
"the scheme #{@scheme} does not accept registry part: #{registry} (or bad hostname?)"
end
@scheme&.freeze
self.set_path('') if !@path && !@opaque # (see RFC2396 Section 5.2)
self.set_port(self.default_port) if self.default_port && !@port
end Аргументы
-
scheme -
Схема протокола, например, 'http','ftp','mailto' и т.д.
-
userinfo -
Имя пользователя и пароль, например, 'sdmitry:bla'.
-
host -
Имя хоста сервера.
-
port -
Порт сервера.
-
registry -
Регистр имен.
-
path -
Путь на сервере.
-
opaque -
Неявная часть.
-
query -
Данные запроса.
-
fragment -
Часть
URIпосле символа '#'. -
parser -
Parserдля внутреннего использования [URI::DEFAULT_PARSER по умолчанию]. -
arg_check -
Проверять аргументы [по умолчанию false].
Описание
Создает новый экземпляр URI::Generic из компонентов “generic'' без проверки.
Методы публичного экземпляра
# File lib/uri/generic.rb, line 1373
def ==(oth)
if self.class == oth.class
self.normalize.component_ary == oth.normalize.component_ary
else
false
end
end Сравнивает два URI.
# File lib/uri/generic.rb, line 962
def absolute?
if @scheme
true
else
false
end
end Возвращает true, если URI имеет указанный схему (например, http:// или https://).
# File lib/uri/generic.rb, line 1463
def coerce(oth)
case oth
when String
oth = parser.parse(oth)
else
super
end
return oth, self
end Аргументы
Описание
Попытка парсинга другого URI oth, возвращает [parsed_oth, self].
Использование
require 'uri'
uri = URI.parse("http://my.example.com")
uri.coerce("http://foo.com")
#=> [#<URI::HTTP http://foo.com>, #<URI::HTTP http://my.example.com>]
# File lib/uri/generic.rb, line 314 def component self.class.component end
Компоненты URI в порядке.
# File lib/uri/generic.rb, line 40 def default_port self.class.default_port end
Возвращает порт по умолчанию.
# File lib/uri/generic.rb, line 1385 def eql?(oth) self.class == oth.class && parser == oth.parser && self.component_ary.eql?(oth.component_ary) end
# File lib/uri/generic.rb, line 1489
def find_proxy(env=ENV)
raise BadURIError, "relative URI: #{self}" if self.relative?
name = self.scheme.downcase + '_proxy'
proxy_uri = nil
if name == 'http_proxy' && env.include?('REQUEST_METHOD') # CGI?
# HTTP_PROXY conflicts with *_proxy for proxy settings and
# HTTP_* for header information in CGI.
# So it should be careful to use it.
pairs = env.reject {|k, v| /\Ahttp_proxy\z/i !~ k }
case pairs.length
when 0 # no proxy setting anyway.
proxy_uri = nil
when 1
k, _ = pairs.shift
if k == 'http_proxy' && env[k.upcase] == nil
# http_proxy is safe to use because ENV is case sensitive.
proxy_uri = env[name]
else
proxy_uri = nil
end
else # http_proxy is safe to use because ENV is case sensitive.
proxy_uri = env.to_hash[name]
end
if !proxy_uri
# Use CGI_HTTP_PROXY. cf. libwww-perl.
proxy_uri = env["CGI_#{name.upcase}"]
end
elsif name == 'http_proxy'
unless proxy_uri = env[name]
if proxy_uri = env[name.upcase]
warn 'The environment variable HTTP_PROXY is discouraged. Use http_proxy.', uplevel: 1
end
end
else
proxy_uri = env[name] || env[name.upcase]
end
if proxy_uri.nil? || proxy_uri.empty?
return nil
end
if self.hostname
begin
addr = IPSocket.getaddress(self.hostname)
return nil if /\A127\.|\A::1\z/ =~ addr
rescue SocketError
end
end
name = 'no_proxy'
if no_proxy = env[name] || env[name.upcase]
return nil unless URI::Generic.use_proxy?(self.hostname, addr, self.port, no_proxy)
end
URI.parse(proxy_uri)
end Возвращает прокси URI. Прокси URI получен из переменных среды, таких как http_proxy, ftp_proxy, no_proxy и т.д. Если соответствующего прокси нет, возвращается nil.
Если указан необязательный параметр env, он используется вместо ENV.
Обратите внимание, что проверяются и заглавные переменные (HTTP_PROXY, FTP_PROXY, NO_PROXY и т.д.).
Но http_proxy и HTTP_PROXY обрабатываются особым образом в среде CGI. Это связано с тем, что HTTP_PROXY может быть задан заголовком Proxy:. Поэтому HTTP_PROXY не используется. http_proxy также не используется, если переменная регистронезависима. Вместо этого можно использовать CGI_HTTP_PROXY.
# File lib/uri/generic.rb, line 919
def fragment=(v)
return @fragment = nil unless v
x = v.to_str
v = x.dup if x.equal? v
v.encode!(Encoding::UTF_8) rescue nil
v.delete!("\t\r\n")
v.force_encoding(Encoding::ASCII_8BIT)
v.gsub!(/(?!%\h\h|[!-~])./n){'%%%02X' % $&.ord}
v.force_encoding(Encoding::US_ASCII)
@fragment = v
end Проверяет компонент фрагмента v на соответствие URI::Parser Regexp для :FRAGMENT.
Аргументы
-
v
Описание
Публичный установщик для компонента фрагмента v (с валидацией).
Использование
require 'uri'
uri = URI.parse("http://my.example.com/?id=25#time=1305212049")
uri.fragment = "time=1305212086"
uri.to_s #=> "http://my.example.com/?id=25#time=1305212086"
# File lib/uri/generic.rb, line 1381 def hash self.component_ary.hash end
# File lib/uri/generic.rb, line 951
def hierarchical?
if @path
true
else
false
end
end Возвращает true, если URI иерархический.
Описание
URI содержит компоненты в порядке убывания значимости слева направо, см. RFC3986 tools.ietf.org/html/rfc3986 1.2.3.
Использование
require 'uri'
uri = URI.parse("http://my.example.com/")
uri.hierarchical?
#=> true
uri = URI.parse("mailto:joe@example.com")
uri.hierarchical?
#=> false
# File lib/uri/generic.rb, line 630 def host=(v) check_host(v) set_host(v) v end
Аргументы
-
v
Описание
Публичный установщик для компонента host v (с валидацией).
См. также URI::Generic.check_host.
Использование
require 'uri'
uri = URI.parse("http://my.example.com")
uri.host = "foo.com"
uri.to_s #=> "http://foo.com"
# File lib/uri/generic.rb, line 645 def hostname v = self.host /\A\[(.*)\]\z/ =~ v ? $1 : v end
Извлекает часть хоста URI и разворачивает скобки для IPv6-адресов.
Этот метод такой же, как URI::Generic#host, за исключением того, что скобки для IPv6 (и будущих IP)-адресов удаляются.
uri = URI("http://[::1]/bar")
uri.hostname #=> "::1"
uri.host #=> "[::1]"
# File lib/uri/generic.rb, line 662
def hostname=(v)
v = "[#{v}]" if /\A\[.*\]\z/ !~ v && /:/ =~ v
self.host = v
end Устанавливает часть хоста URI в качестве аргумента со скобками для IPv6-адресов.
Этот метод такой же, как URI::Generic#host=, за исключением того, что аргумент может быть чистым IPv6-адресом.
uri = URI("http://foo/bar")
uri.hostname = "::1"
uri.to_s #=> "http://[::1]/bar"
Если аргумент, кажется, является IPv6-адресом, он заключается в скобки.
# File lib/uri/generic.rb, line 1440
def inspect
"#<#{self.class} #{self}>"
end # File lib/uri/generic.rb, line 1099
def merge(oth)
rel = parser.send(:convert_to_uri, oth)
if rel.absolute?
#raise BadURIError, "both URI are absolute" if absolute?
# hmm... should return oth for usability?
return rel
end
unless self.absolute?
raise BadURIError, "both URI are relative"
end
base = self.dup
authority = rel.userinfo || rel.host || rel.port
# RFC2396, Section 5.2, 2)
if (rel.path.nil? || rel.path.empty?) && !authority && !rel.query
base.fragment=(rel.fragment) if rel.fragment
return base
end
base.query = nil
base.fragment=(nil)
# RFC2396, Section 5.2, 4)
if !authority
base.set_path(merge_path(base.path, rel.path)) if base.path && rel.path
else
# RFC2396, Section 5.2, 4)
base.set_path(rel.path) if rel.path
end
# RFC2396, Section 5.2, 7)
base.set_userinfo(rel.userinfo) if rel.userinfo
base.set_host(rel.host) if rel.host
base.set_port(rel.port) if rel.port
base.query = rel.query if rel.query
base.fragment=(rel.fragment) if rel.fragment
return base
end Аргументы
Описание
Объединяет два URI.
Использование
require 'uri'
uri = URI.parse("http://my.example.com")
uri.merge("/main.rbx?page=1")
# => "http://my.example.com/main.rbx?page=1"
# File lib/uri/generic.rb, line 1071
def merge!(oth)
t = merge(oth)
if self == t
nil
else
replace!(t)
self
end
end Аргументы
Описание
Деструктивная форма merge.
Использование
require 'uri'
uri = URI.parse("http://my.example.com")
uri.merge!("/main.rbx?page=1")
uri.to_s # => "http://my.example.com/main.rbx?page=1"
# File lib/uri/generic.rb, line 1309 def normalize uri = dup uri.normalize! uri end
Возвращает нормализованный URI.
require 'uri'
URI("HTTP://my.EXAMPLE.com").normalize
#=> #<URI::HTTP http://my.example.com/>
Нормализация здесь означает:
-
схема и хост преобразуются в нижний регистр,
-
пустой компонент пути устанавливается в «/».
# File lib/uri/generic.rb, line 1318
def normalize!
if path&.empty?
set_path('/')
end
if scheme && scheme != scheme.downcase
set_scheme(self.scheme.downcase)
end
if host && host != host.downcase
set_host(self.host.downcase)
end
end Деструктивная версия normalize.
# File lib/uri/generic.rb, line 891 def opaque=(v) check_opaque(v) set_opaque(v) v end
Аргументы
-
v
Описание
Публичный метод установки компонента opaque v (с валидацией).
См. также URI::Generic.check_opaque.
# File lib/uri/generic.rb, line 290
def parser
if !defined?(@parser) || !@parser
DEFAULT_PARSER
else
@parser || DEFAULT_PARSER
end
end Возвращает используемый анализатор.
Если URI::Parser не определен, используется DEFAULT_PARSER.
# File lib/uri/generic.rb, line 574 def password @password end
Возвращает компонент пароля.
# File lib/uri/generic.rb, line 499 def password=(password) check_password(password) set_password(password) # returns password end
Аргументы
-
v
Описание
Публичный метод установки компонента password (с валидацией).
См. также URI::Generic.check_password.
Использование
require 'uri'
uri = URI.parse("http://john:S3nsit1ve@my.example.com")
uri.password = "V3ry_S3nsit1ve"
uri.to_s #=> "http://john:V3ry_S3nsit1ve@my.example.com"
# File lib/uri/generic.rb, line 806 def path=(v) check_path(v) set_path(v) v end
Аргументы
-
v
Описание
Публичный метод установки компонента пути v (с валидацией).
См. также URI::Generic.check_path.
Использование
require 'uri'
uri = URI.parse("http://my.example.com/pub/files")
uri.path = "/faq/"
uri.to_s #=> "http://my.example.com/faq/"
# File lib/uri/generic.rb, line 720 def port=(v) check_port(v) set_port(v) port end
Аргументы
-
v
Описание
Публичный метод установки компонента порта v (с валидацией).
См. также URI::Generic.check_port.
Использование
require 'uri'
uri = URI.parse("http://my.example.com")
uri.port = 8080
uri.to_s #=> "http://my.example.com:8080"
# File lib/uri/generic.rb, line 830
def query=(v)
return @query = nil unless v
raise InvalidURIError, "query conflicts with opaque" if @opaque
x = v.to_str
v = x.dup if x.equal? v
v.encode!(Encoding::UTF_8) rescue nil
v.delete!("\t\r\n")
v.force_encoding(Encoding::ASCII_8BIT)
v.gsub!(/(?!%\h\h|[!$-&(-;=?-_a-~])./n.freeze){'%%%02X' % $&.ord}
v.force_encoding(Encoding::US_ASCII)
@query = v
end Аргументы
-
v
Описание
Публичный метод установки компонента запроса v.
Использование
require 'uri'
uri = URI.parse("http://my.example.com/?id=25")
uri.query = "id=1"
uri.to_s #=> "http://my.example.com/?id=1"
# File lib/uri/generic.rb, line 736 def registry=(v) raise InvalidURIError, "can not set registry" end
# File lib/uri/generic.rb, line 974 def relative? !absolute? end
Возвращает true, если у URI не указана схема (например, http:// или https://).
# File lib/uri/generic.rb, line 1252
def route_from(oth)
# you can modify `rel', but can not `oth'.
begin
oth, rel = route_from0(oth)
rescue
raise $!.class, $!.message
end
if oth == rel
return rel
end
rel.set_path(route_from_path(oth.path, self.path))
if rel.path == './' && self.query
# "./?foo" -> "?foo"
rel.set_path('')
end
return rel
end Аргументы
Описание
Вычисляет относительный путь от oth к self.
Использование
require 'uri'
uri = URI.parse('http://my.example.com/main.rbx?page=1')
uri.route_from('http://my.example.com')
#=> #<URI::Generic /main.rbx?page=1>
# File lib/uri/generic.rb, line 1292 def route_to(oth) parser.send(:convert_to_uri, oth).route_from(self) end
Аргументы
Описание
Вычисляет относительный путь к oth от self.
Использование
require 'uri'
uri = URI.parse('http://my.example.com')
uri.route_to('http://my.example.com/main.rbx?page=1')
#=> #<URI::Generic /main.rbx?page=1>
# File lib/uri/generic.rb, line 361 def scheme=(v) check_scheme(v) set_scheme(v) v end
Аргументы
-
v
Описание
Публичный метод установки компонента схемы v (с валидацией).
См. также URI::Generic.check_scheme.
Использование
require 'uri'
uri = URI.parse("http://my.example.com")
uri.scheme = "https"
uri.to_s #=> "https://my.example.com"
# File lib/uri/generic.rb, line 1429
def select(*components)
components.collect do |c|
if component.include?(c)
self.send(c)
else
raise ArgumentError,
"expected of components of #{self.class} (#{self.class.component.join(', ')})"
end
end
end Аргументы
Описание
Выбирает указанные компоненты из URI.
Использование
require 'uri'
uri = URI.parse('http://myuser:mypass@my.example.com/test.rbx')
uri.select(:userinfo, :host, :path)
# => ["myuser:mypass", "my.example.com", "/test.rbx"]
# File lib/uri/generic.rb, line 1333
def to_s
str = ''.dup
if @scheme
str << @scheme
str << ':'
end
if @opaque
str << @opaque
else
if @host || %w[file postgres].include?(@scheme)
str << '//'
end
if self.userinfo
str << self.userinfo
str << '@'
end
if @host
str << @host
end
if @port && @port != self.default_port
str << ':'
str << @port.to_s
end
str << @path
if @query
str << '?'
str << @query
end
end
if @fragment
str << '#'
str << @fragment
end
str
end # File lib/uri/generic.rb, line 569 def user @user end
Возвращает компонент пользователя.
# File lib/uri/generic.rb, line 472 def user=(user) check_user(user) set_user(user) # returns user end
Аргументы
-
v
Описание
Общедоступный метод установки значения компонента user (с валидацией).
См. также URI::Generic.check_user.
Использование
require 'uri'
uri = URI.parse("http://john:S3nsit1ve@my.example.com")
uri.user = "sam"
uri.to_s #=> "http://sam:V3ry_S3nsit1ve@my.example.com"
# File lib/uri/generic.rb, line 558
def userinfo
if @user.nil?
nil
elsif @password.nil?
@user
else
@user + ':' + @password
end
end Возвращает информацию о пользователе в формате 'user' или 'user:password'.
# File lib/uri/generic.rb, line 442
def userinfo=(userinfo)
if userinfo.nil?
return nil
end
check_userinfo(*userinfo)
set_userinfo(*userinfo)
# returns userinfo
end Устанавливает информацию о пользователе, аргумент — строка типа 'имя:пароль'.
Защищенные методы экземпляра
# File lib/uri/generic.rb, line 604 def set_host(v) @host = v end
Защищённый метод установки значения компонента хоста v.
См. также URI::Generic.host=.
# File lib/uri/generic.rb, line 873 def set_opaque(v) @opaque = v end
Защищённый метод установки значения компонента opaque v.
См. также URI::Generic.opaque=.
# File lib/uri/generic.rb, line 535 def set_password(v) @password = v # returns v end
Защищённый метод установки значения компонента password v.
См. также URI::Generic.password=.
# File lib/uri/generic.rb, line 780 def set_path(v) @path = v end
Защищённый метод установки значения компонента path v.
См. также URI::Generic.path=.
# File lib/uri/generic.rb, line 693 def set_port(v) v = v.empty? ? nil : v.to_i unless !v || v.kind_of?(Integer) @port = v end
Защищённый метод установки значения компонента port v.
См. также URI::Generic.port=.
# File lib/uri/generic.rb, line 335 def set_scheme(v) @scheme = v&.downcase end
Защищённый метод установки значения компонента scheme v.
См. также URI::Generic.scheme=.
# File lib/uri/generic.rb, line 525 def set_user(v) set_userinfo(v, @password) v end
Защищённый метод установки значения компонента user v.
См. также URI::Generic.user=.
# File lib/uri/generic.rb, line 510
def set_userinfo(user, password = nil)
unless password
user, password = split_userinfo(user)
end
@user = user
@password = password if password
[@user, @password]
end Защищённый метод установки значения компонента user и password (если доступен) с валидацией.
См. также URI::Generic.userinfo=.
Методы частного экземпляра
# File lib/uri/generic.rb, line 585
def check_host(v)
return v unless v
if @opaque
raise InvalidURIError,
"can not set host with registry or opaque"
elsif parser.regexp[:HOST] !~ v
raise InvalidComponentError,
"bad component(expected host component): #{v}"
end
return true
end Проверяет компонент хоста v на соответствие RFC2396 и по отношению к URI::Parser Regexp для :HOST.
Не может иметь определённый компонент реестра или неявного компонента, с определённым компонентом хоста.
# File lib/uri/generic.rb, line 851
def check_opaque(v)
return v unless v
# raise if both hier and opaque are not nil, because:
# absoluteURI = scheme ":" ( hier_part | opaque_part )
# hier_part = ( net_path | abs_path ) [ "?" query ]
if @host || @port || @user || @path # userinfo = @user + ':' + @password
raise InvalidURIError,
"can not set opaque with host, port, userinfo or path"
elsif v && parser.regexp[:OPAQUE] !~ v
raise InvalidComponentError,
"bad component(expected opaque component): #{v}"
end
return true
end Проверяет неявный v компонент на соответствие RFC2396 и по отношению к URI::Parser Regexp для :OPAQUE.
Не может иметь определённый компонент хоста, порта, пользователя или пути, с определённым компонентом неявного.
# File lib/uri/generic.rb, line 418
def check_password(v, user = @user)
if @opaque
raise InvalidURIError,
"can not set password with opaque"
end
return v unless v
if !user
raise InvalidURIError,
"password component depends user component"
end
if parser.regexp[:USERINFO] !~ v
raise InvalidComponentError,
"bad password component"
end
return true
end Проверяет компонент пароля v на соответствие RFC2396 и по отношению к URI::Parser Regexp для :USERINFO.
Не может иметь определённый компонент реестра или неявного компонента, с определённым компонентом пользователя.
# File lib/uri/generic.rb, line 748
def check_path(v)
# raise if both hier and opaque are not nil, because:
# absoluteURI = scheme ":" ( hier_part | opaque_part )
# hier_part = ( net_path | abs_path ) [ "?" query ]
if v && @opaque
raise InvalidURIError,
"path conflicts with opaque"
end
# If scheme is ftp, path may be relative.
# See RFC 1738 section 3.2.2, and RFC 2396.
if @scheme && @scheme != "ftp"
if v && v != '' && parser.regexp[:ABS_PATH] !~ v
raise InvalidComponentError,
"bad component(expected absolute path component): #{v}"
end
else
if v && v != '' && parser.regexp[:ABS_PATH] !~ v &&
parser.regexp[:REL_PATH] !~ v
raise InvalidComponentError,
"bad component(expected relative path component): #{v}"
end
end
return true
end Проверяет компонент пути v на соответствие RFC2396 и по отношению к URI::Parser Regexp для :ABS_PATH и :REL_PATH.
Не может иметь определённый компонент неявного, с определённым компонентом пути.
# File lib/uri/generic.rb, line 674
def check_port(v)
return v unless v
if @opaque
raise InvalidURIError,
"can not set port with registry or opaque"
elsif !v.kind_of?(Integer) && parser.regexp[:PORT] !~ v
raise InvalidComponentError,
"bad component(expected port component): #{v.inspect}"
end
return true
end Проверяет компонент порта v на соответствие RFC2396 и по отношению к URI::Parser Regexp для :PORT.
Не может иметь определённый компонент реестра или неявного компонента, с определённым компонентом порта.
# File lib/uri/generic.rb, line 321
def check_scheme(v)
if v && parser.regexp[:SCHEME] !~ v
raise InvalidComponentError,
"bad component(expected scheme component): #{v}"
end
return true
end Проверяет компонент схемы v по отношению к URI::Parser Regexp для :SCHEME.
# File lib/uri/generic.rb, line 394
def check_user(v)
if @opaque
raise InvalidURIError,
"can not set user with opaque"
end
return v unless v
if parser.regexp[:USERINFO] !~ v
raise InvalidComponentError,
"bad component(expected userinfo component or user component): #{v}"
end
return true
end Проверяет компонент пользователя v на соответствие RFC2396 и по отношению к URI::Parser Regexp для :USERINFO.
Не может иметь определённый компонент реестра или неявного компонента, с определённым компонентом пользователя.
# File lib/uri/generic.rb, line 376
def check_userinfo(user, password = nil)
if !password
user, password = split_userinfo(user)
end
check_user(user)
check_password(password, user)
return true
end Проверяет user и password.
Если password не предоставлен, то user разделяется, используя URI::Generic.split_userinfo, чтобы извлечь user и +password.
См. также URI::Generic.check_user, URI::Generic.check_password.
# File lib/uri/generic.rb, line 552 def escape_userpass(v) parser.escape(v, /[@:\/]/o) # RFC 1738 section 3.1 #/ end
Экранирует 'user:password' v на основе RFC 1738 раздела 3.1.
# File lib/uri/generic.rb, line 990
def merge_path(base, rel)
# RFC2396, Section 5.2, 5)
# RFC2396, Section 5.2, 6)
base_path = split_path(base)
rel_path = split_path(rel)
# RFC2396, Section 5.2, 6), a)
base_path << '' if base_path.last == '..'
while i = base_path.index('..')
base_path.slice!(i - 1, 2)
end
if (first = rel_path.first) and first.empty?
base_path.clear
rel_path.shift
end
# RFC2396, Section 5.2, 6), c)
# RFC2396, Section 5.2, 6), d)
rel_path.push('') if rel_path.last == '.' || rel_path.last == '..'
rel_path.delete('.')
# RFC2396, Section 5.2, 6), e)
tmp = []
rel_path.each do |x|
if x == '..' &&
!(tmp.empty? || tmp.last == '..')
tmp.pop
else
tmp << x
end
end
add_trailer_slash = !tmp.empty?
if base_path.empty?
base_path = [''] # keep '/' for root directory
elsif add_trailer_slash
base_path.pop
end
while x = tmp.shift
if x == '..'
# RFC2396, Section 4
# a .. or . in an absolute path has no special meaning
base_path.pop if base_path.size > 1
else
# if x == '..'
# valid absolute (but abnormal) path "/../..."
# else
# valid absolute path
# end
base_path << x
tmp.each {|t| base_path << t}
add_trailer_slash = false
break
end
end
base_path.push('') if add_trailer_slash
return base_path.join('/')
end Объединяет базовый путь base, с относительным путём rel, возвращает изменённый базовый путь.
# File lib/uri/generic.rb, line 300
def replace!(oth)
if self.class != oth.class
raise ArgumentError, "expected #{self.class} object"
end
component.each do |c|
self.__send__("#{c}=", oth.__send__(c))
end
end Заменяет себя другим объектом URI.
# File lib/uri/generic.rb, line 981
def split_path(path)
path.split("/", -1)
end Возвращает Array пути, разделённого по '/'.
# File lib/uri/generic.rb, line 543
def split_userinfo(ui)
return nil, nil unless ui
user, password = ui.split(':', 2)
return user, password
end Возвращает ui как [user, password], если он должным образом отформатирован как 'user:password'.
Ruby Core © 1993–2017 Yukihiro Matsumoto
Licensed under the Ruby License.
Ruby Standard Library © contributors
Licensed under their own licenses.