module ActionDispatch::Http::URL

Constants

HOST_REGEXP
IP_HOST_REGEXP
PROTOCOL_REGEXP

Public Class Methods

new(env) click to toggle source
Calls superclass method
# File lib/action_dispatch/http/url.rb, line 150
def initialize(env)
  super
  @protocol = nil
  @port     = nil
end

Public Instance Methods

domain(tld_length = @@tld_length) click to toggle source

Returns the domain part of a host, such as “rubyonrails.org” in “www.rubyonrails.org”. You can specify a different tld_length, such as 2 to catch rubyonrails.co.uk in “www.rubyonrails.co.uk”.

# File lib/action_dispatch/http/url.rb, line 228
def domain(tld_length = @@tld_length)
  ActionDispatch::Http::URL.extract_domain(host, tld_length)
end
extract_domain(host, tld_length = @@tld_length) click to toggle source
# File lib/action_dispatch/http/url.rb, line 15
def extract_domain(host, tld_length = @@tld_length)
  host.split('.').last(1 + tld_length).join('.') if named_host?(host)
end
extract_subdomain(host, tld_length = @@tld_length) click to toggle source
# File lib/action_dispatch/http/url.rb, line 28
def extract_subdomain(host, tld_length = @@tld_length)
  extract_subdomains(host, tld_length).join('.')
end
extract_subdomains(host, tld_length = @@tld_length) click to toggle source
# File lib/action_dispatch/http/url.rb, line 19
def extract_subdomains(host, tld_length = @@tld_length)
  if named_host?(host)
    parts = host.split('.')
    parts[0..-(tld_length + 2)]
  else
    []
  end
end
host() click to toggle source

Returns the host for this request, such as example.com.

# File lib/action_dispatch/http/url.rb, line 176
def host
  raw_host_with_port.sub(/:\d+$/, '')
end
host_with_port() click to toggle source

Returns a host:port string for this request, such as “example.com” or “example.com:8080”.

# File lib/action_dispatch/http/url.rb, line 182
def host_with_port
  "#{host}#{port_string}"
end
optional_port() click to toggle source

Returns a number port suffix like 8080 if the port number of this request is not the default HTTP port 80 or HTTPS port 443.

# File lib/action_dispatch/http/url.rb, line 212
def optional_port
  standard_port? ? nil : port
end
port() click to toggle source

Returns the port number of this request as an integer.

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

Returns a string port suffix, including colon, like “:8080” if the port number of this request is not the default HTTP port 80 or HTTPS port 443.

# File lib/action_dispatch/http/url.rb, line 218
def port_string
  standard_port? ? '' : ":#{port}"
end
protocol() click to toggle source

Returns 'https://' if this is an SSL request and 'http://' otherwise.

# File lib/action_dispatch/http/url.rb, line 162
def protocol
  @protocol ||= ssl? ? 'https://' : 'http://'
end
raw_host_with_port() click to toggle source

Returns the host for this request, such as “example.com”.

# File lib/action_dispatch/http/url.rb, line 167
def raw_host_with_port
  if forwarded = env["HTTP_X_FORWARDED_HOST"]
    forwarded.split(/,\s?/).last
  else
    env['HTTP_HOST'] || "#{env['SERVER_NAME'] || env['SERVER_ADDR']}:#{env['SERVER_PORT']}"
  end
end
server_port() click to toggle source
# File lib/action_dispatch/http/url.rb, line 222
def server_port
  @env['SERVER_PORT'].to_i
end
standard_port() click to toggle source

Returns the standard port number for this request's protocol.

# File lib/action_dispatch/http/url.rb, line 198
def standard_port
  case protocol
    when 'https://' then 443
    else 80
  end
end
standard_port?() click to toggle source

Returns whether this request is using the standard port

# File lib/action_dispatch/http/url.rb, line 206
def standard_port?
  port == standard_port
end
subdomain(tld_length = @@tld_length) click to toggle source

Returns all the subdomains as a string, so "dev.www" would be returned for “dev.www.rubyonrails.org”. You can specify a different tld_length, such as 2 to catch "www" instead of "www.rubyonrails" in “www.rubyonrails.co.uk”.

# File lib/action_dispatch/http/url.rb, line 244
def subdomain(tld_length = @@tld_length)
  ActionDispatch::Http::URL.extract_subdomain(host, tld_length)
end
subdomains(tld_length = @@tld_length) click to toggle source

Returns all the subdomains as an array, so ["dev", "www"] would be returned for “dev.www.rubyonrails.org”. You can specify a different tld_length, such as 2 to catch ["www"] instead of ["www", "rubyonrails"] in “www.rubyonrails.co.uk”.

# File lib/action_dispatch/http/url.rb, line 236
def subdomains(tld_length = @@tld_length)
  ActionDispatch::Http::URL.extract_subdomains(host, tld_length)
end
url() click to toggle source

Returns the complete URL used for this request.

# File lib/action_dispatch/http/url.rb, line 157
def url
  protocol + host_with_port + fullpath
end
url_for(options = {}) click to toggle source
# File lib/action_dispatch/http/url.rb, line 32
def url_for(options = {})
  options = options.dup
  path  = options.delete(:script_name).to_s.chomp("/")
  path << options.delete(:path).to_s

  add_trailing_slash(path) if options[:trailing_slash]

  params = options[:params].is_a?(Hash) ? options[:params] : options.slice(:params)
  params.reject! { |_,v| v.to_param.nil? }

  result = build_host_url(options)

  result << path

  result << "?#{params.to_query}" unless params.empty?
  result << "##{Journey::Router::Utils.escape_fragment(options[:anchor].to_param.to_s)}" if options[:anchor]
  result
end

Private Instance Methods

add_trailing_slash(path) click to toggle source
# File lib/action_dispatch/http/url.rb, line 53
def add_trailing_slash(path)
  # includes querysting
  if path.include?('?')
    path.sub!(/\?/, '/\&')
  # does not have a .format
  elsif !path.include?(".")
    path.sub!(/[^\/]\z|\A\z/, '\&/')
  end

  path
end
build_host_url(options) click to toggle source
# File lib/action_dispatch/http/url.rb, line 65
def build_host_url(options)
  if options[:host].blank? && options[:only_path].blank?
    raise ArgumentError, 'Missing host to link to! Please provide the :host parameter, set default_url_options[:host], or set :only_path to true'
  end

  result = ""

  unless options[:only_path]
    if match = options[:host].match(HOST_REGEXP)
      options[:protocol] ||= match[1] unless options[:protocol] == false
      options[:host]       = match[2]
      options[:port]       = match[3] unless options.key?(:port)
    end

    options[:protocol] = normalize_protocol(options)
    options[:host]     = normalize_host(options)
    options[:port]     = normalize_port(options)

    result << options[:protocol]
    result << rewrite_authentication(options)
    result << options[:host]
    result << ":#{options[:port]}" if options[:port]
  end
  result
end
named_host?(host) click to toggle source
# File lib/action_dispatch/http/url.rb, line 91
def named_host?(host)
  host && IP_HOST_REGEXP !~ host
end
normalize_host(options) click to toggle source
# File lib/action_dispatch/http/url.rb, line 120
def normalize_host(options)
  return options[:host] if !named_host?(options[:host]) || same_host?(options)

  tld_length = options[:tld_length] || @@tld_length

  host = ""
  if options[:subdomain] == true || !options.key?(:subdomain)
    host << extract_subdomain(options[:host], tld_length).to_param
  elsif options[:subdomain].present?
    host << options[:subdomain].to_param
  end
  host << "." unless host.empty?
  host << (options[:domain] || extract_domain(options[:host], tld_length))
  host
end
normalize_port(options) click to toggle source
# File lib/action_dispatch/http/url.rb, line 136
def normalize_port(options)
  return nil if options[:port].nil? || options[:port] == false

  case options[:protocol]
  when "//"
    options[:port]
  when "https://"
    options[:port].to_i == 443 ? nil : options[:port]
  else
    options[:port].to_i == 80 ? nil : options[:port]
  end
end
normalize_protocol(options) click to toggle source
# File lib/action_dispatch/http/url.rb, line 107
def normalize_protocol(options)
  case options[:protocol]
  when nil
    "http://"
  when false, "//"
    "//"
  when PROTOCOL_REGEXP
    "#{$1}://"
  else
    raise ArgumentError, "Invalid :protocol option: #{options[:protocol].inspect}"
  end
end
rewrite_authentication(options) click to toggle source
# File lib/action_dispatch/http/url.rb, line 99
def rewrite_authentication(options)
  if options[:user] && options[:password]
    "#{Rack::Utils.escape(options[:user])}:#{Rack::Utils.escape(options[:password])}@"
  else
    ""
  end
end
same_host?(options) click to toggle source
# File lib/action_dispatch/http/url.rb, line 95
def same_host?(options)
  (options[:subdomain] == true || !options.key?(:subdomain)) && options[:domain].nil?
end