Skip to Content Skip to Search

module ActionDispatch::Http::URL

Constants

HOST_REGEXP

/(^[^:]+:\/\/)?(\[[^\]]+\]|[^:]+)(?::(\d+$))?/

IP_HOST_REGEXP

/\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}$/

PROTOCOL_REGEXP

/^([^:]+)(:)?(\/\/)?$/

Public class methods

extract_domain(host, tld_length)

Returns the domain part of a host given the domain level.

# 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"
Source code GitHub 
# File actionpack/lib/action_dispatch/http/url.rb, line 24
def extract_domain(host, tld_length)
  extract_domain_from(host, tld_length) if named_host?(host)
end

extract_subdomain(host, tld_length)

Returns the subdomains of a host as a String given the domain level.

# 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"
Source code GitHub 
# File actionpack/lib/action_dispatch/http/url.rb, line 48
def extract_subdomain(host, tld_length)
  extract_subdomains(host, tld_length).join(".")
end

extract_subdomains(host, tld_length)

Returns the subdomains of a host as an Array given the domain level.

# 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"]
Source code GitHub 
# File actionpack/lib/action_dispatch/http/url.rb, line 34
def extract_subdomains(host, tld_length)
  if named_host?(host)
    extract_subdomains_from(host, tld_length)
  else
    []
  end
end

full_url_for(options)

Source code GitHub 
# File actionpack/lib/action_dispatch/http/url.rb, line 60
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()

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

path_for(options)

Source code GitHub 
# File actionpack/lib/action_dispatch/http/url.rb, line 72
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)

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

Public instance methods

domain(tld_length = @@tld_length)

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”.

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

host()

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

req = ActionDispatch::Request.new 'HTTP_HOST' => 'example.com:8080'
req.host # => "example.com"
Source code GitHub 
# File actionpack/lib/action_dispatch/http/url.rb, line 228
def host
  raw_host_with_port.sub(/:\d+$/, "")
end

host_with_port()

Returns a host:port string for this request, such as “example.com” or “example.com:8080”. Port is only included if it is not a default port (80 or 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"
Source code GitHub 
# File actionpack/lib/action_dispatch/http/url.rb, line 244
def host_with_port
  "#{host}#{port_string}"
end

optional_port()

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.

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
Source code GitHub 
# File actionpack/lib/action_dispatch/http/url.rb, line 294
def optional_port
  standard_port? ? nil : port
end

port()

Returns the port number of this request as an integer.

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

req = ActionDispatch::Request.new 'HTTP_HOST' => 'example.com:8080'
req.port # => 8080
Source code GitHub 
# File actionpack/lib/action_dispatch/http/url.rb, line 255
def port
  @port ||= if raw_host_with_port =~ /:(\d+)$/
    $1.to_i
  else
    standard_port
  end
end

port_string()

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.

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"
Source code GitHub 
# File actionpack/lib/action_dispatch/http/url.rb, line 306
def port_string
  standard_port? ? "" : ":#{port}"
end

protocol()

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

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

req = ActionDispatch::Request.new 'HTTP_HOST' => 'example.com', 'HTTPS' => 'on'
req.protocol # => "https://"
Source code GitHub 
# File actionpack/lib/action_dispatch/http/url.rb, line 202
def protocol
  @protocol ||= ssl? ? "https://" : "http://"
end

raw_host_with_port()

Returns the host and port for this request, such as “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"
Source code GitHub 
# File actionpack/lib/action_dispatch/http/url.rb, line 216
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

server_port()

Returns the requested port, such as 8080, based on SERVER_PORT

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

req = ActionDispatch::Request.new 'SERVER_PORT' => '8080'
req.server_port # => 8080
Source code GitHub 
# File actionpack/lib/action_dispatch/http/url.rb, line 317
def server_port
  get_header("SERVER_PORT").to_i
end

standard_port()

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

req = ActionDispatch::Request.new 'HTTP_HOST' => 'example.com:8080'
req.standard_port # => 80
Source code GitHub 
# File actionpack/lib/action_dispatch/http/url.rb, line 267
def standard_port
  if "https://" == protocol
    443
  else
    80
  end
end

standard_port?()

Returns whether this request is using the standard port

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
Source code GitHub 
# File actionpack/lib/action_dispatch/http/url.rb, line 282
def standard_port?
  port == standard_port
end

subdomain(tld_length = @@tld_length)

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”.

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

subdomains(tld_length = @@tld_length)

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”.

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

url()

Returns the complete URL used for this request.

req = ActionDispatch::Request.new 'HTTP_HOST' => 'example.com'
req.url # => "http://example.com"
Source code GitHub 
# File actionpack/lib/action_dispatch/http/url.rb, line 191
def url
  protocol + host_with_port + fullpath
end

Definition files