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

Константы

HOST_REGEXP
IP_HOST_REGEXP
PROTOCOL_REGEXP

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

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

# File actionpack/lib/action_dispatch/http/url.rb, line 20
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 44
def extract_subdomain(host, tld_length)
  extract_subdomains(host, tld_length).join('.')
end

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

# 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 30
def extract_subdomains(host, tld_length)
  if named_host?(host)
    extract_subdomains_from(host, tld_length)
  else
    []
  end
end

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

# 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 56
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 187
def initialize
  super
  @protocol = nil
  @port     = nil
end

Вызывает метод родительского класса

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

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

  add_trailing_slash(path) if options[:trailing_slash]
  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 48
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 356
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 247
def host
  raw_host_with_port.sub(/:\d+$/, ''.freeze)
end

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

class Request < Rack::Request
  include ActionDispatch::Http::URL
end

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

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

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

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

class Request < Rack::Request
  include ActionDispatch::Http::URL
end

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

req = 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 330
def optional_port
  standard_port? ? nil : port
end

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

class Request < Rack::Request
  include ActionDispatch::Http::URL
end

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

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

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

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

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

class Request < Rack::Request
  include ActionDispatch::Http::URL
end

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

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

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

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

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

class Request < Rack::Request
  include ActionDispatch::Http::URL
end

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

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

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

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

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

class Request < Rack::Request
  include ActionDispatch::Http::URL
end

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

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

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

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

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

class Request < Rack::Request
  include ActionDispatch::Http::URL
end

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

req = 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 350
def server_port
  get_header('SERVER_PORT').to_i
end

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

# File actionpack/lib/action_dispatch/http/url.rb, line 296
def standard_port
  case protocol
    when 'https://' then 443
    else 80
  end
end

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

class Request < Rack::Request
  include ActionDispatch::Http::URL
end

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

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

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

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

class Request < Rack::Request
  include ActionDispatch::Http::URL
end

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

req = 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 372
def subdomain(tld_length = @@tld_length)
  ActionDispatch::Http::URL.extract_subdomain(host, tld_length)
end

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

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

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

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

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

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

Возвращает полный URL запроса.

class Request < Rack::Request
  include ActionDispatch::Http::URL
end

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