модуль ActionDispatch::Http::URL

Константы

HOST_REGEXP
IP_HOST_REGEXP
PROTOCOL_REGEXP

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

extract_domain (host, tld_length) Показать исходный код

# File actionpack/lib/action_dispatch/http/url.rb, line 121
def extract_domain(host, tld_length)
  extract_domain_from(host, tld_length) if named_host?(host)
end

Возвращает доменную часть хоста с учётом уровня домена.

# Top-level domain example
extract_domain('www.example.com', 1) # => "example.com"
# Second-level domain example
extract_domain('dev.www.example.co.uk', 2) # => "example.co.uk"

extract_subdomain (host, tld_length) Показать исходный код

# File actionpack/lib/action_dispatch/http/url.rb, line 145
def extract_subdomain(host, tld_length)
  extract_subdomains(host, tld_length).join(".")
end

Возвращает поддомены хоста в виде String с учётом уровня домена.

# Top-level domain example
extract_subdomain('www.example.com', 1) # => "www"
# Second-level domain example
extract_subdomain('dev.www.example.co.uk', 2) # => "dev.www"

extract_subdomains (host, tld_length) Показать исходный код

# File actionpack/lib/action_dispatch/http/url.rb, line 131
def extract_subdomains(host, tld_length)
  if named_host?(host)
    extract_subdomains_from(host, tld_length)
  else
    []
  end
end

Возвращает поддомены хоста в виде Array с учётом уровня домена.

# Top-level domain example
extract_subdomains('www.example.com', 1) # => ["www"]
# Second-level domain example
extract_subdomains('dev.www.example.co.uk', 2) # => ["dev", "www"]

full_url_for (options) Показать исходный код

# File actionpack/lib/action_dispatch/http/url.rb, line 157
def full_url_for(options)
  host     = options[:host]
  protocol = options[:protocol]
  port     = options[:port]

  unless host
    raise ArgumentError, "Missing host to link to! Please provide the :host parameter, set default_url_options[:host], or set :only_path to true"
  end

  build_host_url(host, port, protocol, options, path_for(options))
end

new () Показать исходный код

# File actionpack/lib/action_dispatch/http/url.rb, line 277
def initialize
  super
  @protocol = nil
  @port     = nil
end

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

path_for (options) Показать исходный код

# File actionpack/lib/action_dispatch/http/url.rb, line 169
def path_for(options)
  path = options[:script_name].to_s.chomp("/")
  path << options[:path] if options.key?(:path)

  path = "/" if options[:trailing_slash] && path.blank?

  add_params(path, options[:params]) if options.key?(:params)
  add_anchor(path, options[:anchor]) if options.key?(:anchor)

  path
end

url_for (options) Показать исходный код

# File actionpack/lib/action_dispatch/http/url.rb, line 149
def url_for(options)
  if options[:only_path]
    path_for options
  else
    full_url_for options
  end
end

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

domain (tld_length = @@tld_length) Показать исходный код

# File actionpack/lib/action_dispatch/http/url.rb, line 420
def domain(tld_length = @@tld_length)
  ActionDispatch::Http::URL.extract_domain(host, tld_length)
end

Возвращает доменную часть хоста, например «rubyonrails.org» в «www.rubyonrails.org». Можно указать другое tld_length, например 2, чтобы получить rubyonrails.co.uk в «www.rubyonrails.co.uk».

host () Показать исходный код

# File actionpack/lib/action_dispatch/http/url.rb, line 324
def host
  raw_host_with_port.sub(/:\d+$/, "")
end

Возвращает хост этого запроса, например «example.com».

req = ActionDispatch::Request.new 'HTTP_HOST' => 'example.com:8080'
req.host # => "example.com"

host_with_port () Показать исходный код

# File actionpack/lib/action_dispatch/http/url.rb, line 340
def host_with_port
  "#{host}#{port_string}"
end

Возвращает строку host:port для этого запроса, например «example.com» или «example.com:8080». Порт включается, только если он не является портом по умолчанию (80 или 443).

req = ActionDispatch::Request.new 'HTTP_HOST' => 'example.com'
req.host_with_port # => "example.com"

req = ActionDispatch::Request.new 'HTTP_HOST' => 'example.com:80'
req.host_with_port # => "example.com"

req = ActionDispatch::Request.new 'HTTP_HOST' => 'example.com:8080'
req.host_with_port # => "example.com:8080"

optional_port () Показать исходный код

# File actionpack/lib/action_dispatch/http/url.rb, line 390
def optional_port
  standard_port? ? nil : port
end

Возвращает числовой суффикс порта, например 8080, если номер порта этого запроса не является портом HTTP по умолчанию 80 или портом HTTPS по умолчанию 443.

req = ActionDispatch::Request.new 'HTTP_HOST' => 'example.com:80'
req.optional_port # => nil

req = ActionDispatch::Request.new 'HTTP_HOST' => 'example.com:8080'
req.optional_port # => 8080

port () Показать исходный код

# File actionpack/lib/action_dispatch/http/url.rb, line 351
def port
  @port ||= if raw_host_with_port =~ /:(\d+)$/
    $1.to_i
  else
    standard_port
  end
end

Возвращает номер порта этого запроса в виде целого числа.

req = ActionDispatch::Request.new 'HTTP_HOST' => 'example.com'
req.port # => 80

req = ActionDispatch::Request.new 'HTTP_HOST' => 'example.com:8080'
req.port # => 8080

port_string () Показать исходный код

# File actionpack/lib/action_dispatch/http/url.rb, line 402
def port_string
  standard_port? ? "" : ":#{port}"
end

Возвращает строковый суффикс порта, включая двоеточие, например «:8080», если номер порта этого запроса не является портом HTTP по умолчанию 80 или портом HTTPS по умолчанию 443.

req = ActionDispatch::Request.new 'HTTP_HOST' => 'example.com:80'
req.port_string # => ""

req = ActionDispatch::Request.new 'HTTP_HOST' => 'example.com:8080'
req.port_string # => ":8080"

protocol () Показать исходный код

# File actionpack/lib/action_dispatch/http/url.rb, line 298
def protocol
  @protocol ||= ssl? ? "https://" : "http://"
end

Возвращает «https://», если это запрос SSL, и «http://» в противном случае.

req = ActionDispatch::Request.new 'HTTP_HOST' => 'example.com'
req.protocol # => "http://"

req = ActionDispatch::Request.new 'HTTP_HOST' => 'example.com', 'HTTPS' => 'on'
req.protocol # => "https://"

raw_host_with_port () Показать исходный код

# File actionpack/lib/action_dispatch/http/url.rb, line 312
def raw_host_with_port
  if forwarded = x_forwarded_host.presence
    forwarded.split(/,\s?/).last
  else
    get_header("HTTP_HOST") || "#{server_name}:#{get_header('SERVER_PORT')}"
  end
end

Возвращает хост и порт этого запроса, например «example.com:8080».

req = ActionDispatch::Request.new 'HTTP_HOST' => 'example.com'
req.raw_host_with_port # => "example.com"

req = ActionDispatch::Request.new 'HTTP_HOST' => 'example.com:80'
req.raw_host_with_port # => "example.com:80"

req = ActionDispatch::Request.new 'HTTP_HOST' => 'example.com:8080'
req.raw_host_with_port # => "example.com:8080"

server_port () Показать исходный код

# File actionpack/lib/action_dispatch/http/url.rb, line 413
def server_port
  get_header("SERVER_PORT").to_i
end

Возвращает запрошенный порт, например 8080, на основе SERVER_PORT.

req = ActionDispatch::Request.new 'SERVER_PORT' => '80'
req.server_port # => 80

req = ActionDispatch::Request.new 'SERVER_PORT' => '8080'
req.server_port # => 8080

standard_port () Показать исходный код

# File actionpack/lib/action_dispatch/http/url.rb, line 363
def standard_port
  if "https://" == protocol
    443
  else
    80
  end
end

Возвращает стандартный номер порта для протокола этого запроса.

req = ActionDispatch::Request.new 'HTTP_HOST' => 'example.com:8080'
req.standard_port # => 80

standard_port? () Показать исходный код

# File actionpack/lib/action_dispatch/http/url.rb, line 378
def standard_port?
  port == standard_port
end

Возвращает, использует ли этот запрос стандартный порт.

req = ActionDispatch::Request.new 'HTTP_HOST' => 'example.com:80'
req.standard_port? # => true

req = ActionDispatch::Request.new 'HTTP_HOST' => 'example.com:8080'
req.standard_port? # => false

subdomain (tld_length = @@tld_length) Показать исходный код

# File actionpack/lib/action_dispatch/http/url.rb, line 435
def subdomain(tld_length = @@tld_length)
  ActionDispatch::Http::URL.extract_subdomain(host, tld_length)
end

Возвращает все поддомены в виде строки, поэтому для «dev.www.rubyonrails.org» будет возвращено "dev.www". Можно указать другое tld_length, например 2, чтобы получить "www" вместо "www.rubyonrails" для «www.rubyonrails.co.uk».

subdomains (tld_length = @@tld_length) Показать исходный код

# File actionpack/lib/action_dispatch/http/url.rb, line 428
def subdomains(tld_length = @@tld_length)
  ActionDispatch::Http::URL.extract_subdomains(host, tld_length)
end

Возвращает все поддомены в виде массива, поэтому для «dev.www.rubyonrails.org» будет возвращено ["dev", "www"]. Можно указать другое tld_length, например 2, чтобы получить ["www"] вместо ["www", "rubyonrails"] для «www.rubyonrails.co.uk».

url () Показать исходный код

# File actionpack/lib/action_dispatch/http/url.rb, line 287
def url
  protocol + host_with_port + fullpath
end

Возвращает полный URL, используемый для этого запроса.

req = ActionDispatch::Request.new 'HTTP_HOST' => 'example.com'
req.url # => "http://example.com"