module ActionDispatch::Http::URL

Constants

HOST_REGEXP
IP_HOST_REGEXP
PROTOCOL_REGEXP

Public Class Methods

extract_domain(host, tld_length = @@tld_length) Show source

# File actionpack/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) Show source

# File actionpack/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) Show source

# File actionpack/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

new(env) Show source

Calls superclass method

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

url_for(options = {}) Show source

# File actionpack/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

Public Instance Methods

domain(tld_length = @@tld_length) Show 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 actionpack/lib/action_dispatch/http/url.rb, line 228
def domain(tld_length = @@tld_length)
  ActionDispatch::Http::URL.extract_domain(host, tld_length)
end

host() Show source

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

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

host_with_port() Show source

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

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

optional_port() Show 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 actionpack/lib/action_dispatch/http/url.rb, line 212
def optional_port
  standard_port? ? nil : port
end

port() Show source

Returns the port number of this request as an integer.

# File actionpack/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() Show 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 actionpack/lib/action_dispatch/http/url.rb, line 218
def port_string
  standard_port? ? '' : ":#{port}"
end

protocol() Show source

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

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

raw_host_with_port() Show source

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

# File actionpack/lib/action_dispatch/http/url.rb, line 167
def raw_host_with_port
  if forwarded = env["HTTP_X_FORWARDED_HOST"].presence
    forwarded.split(/,\s?/).last
  else
    env['HTTP_HOST'] || "#{env['SERVER_NAME'] || env['SERVER_ADDR']}:#{env['SERVER_PORT']}"
  end
end

server_port() Show source

# File actionpack/lib/action_dispatch/http/url.rb, line 222
def server_port
  @env['SERVER_PORT'].to_i
end

standard_port() Show source

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

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

standard_port?() Show source

Returns whether this request is using the standard port

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

subdomain(tld_length = @@tld_length) Show 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 actionpack/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) Show 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 actionpack/lib/action_dispatch/http/url.rb, line 236
def subdomains(tld_length = @@tld_length)
  ActionDispatch::Http::URL.extract_subdomains(host, tld_length)
end

url() Show source

Returns the complete URL used for this request.

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