Module: ActionDispatch::Http::URL

Relationships & Source Files
Extension / Inclusion / Inheritance Descendants
Included In: `::ActionCable::Connection::TestRequest`, `::ActionController::TestRequest`, `::ActionDispatch::Request`, `::ActionDispatch::TestRequest`
Defined in:	actionpack/lib/action_dispatch/http/url.rb

Constant Summary

HOST_REGEXP =
# File 'actionpack/lib/action_dispatch/http/url.rb', line 9
```
/(^[^:]:\/\/)?(\[[^\]]\]|[^:])(?::(\d$))?/
```
IP_HOST_REGEXP =
# File 'actionpack/lib/action_dispatch/http/url.rb', line 8
```
/\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}$/
```
PROTOCOL_REGEXP =
# File 'actionpack/lib/action_dispatch/http/url.rb', line 10
```
/^([^:]+)(:)?(\/\/)?$/
```

Class Attribute Summary

.secure_protocol (also: #secure_protocol) rw
.tld_length (also: #tld_length) rw

Class Method Summary

.extract_domain(host, tld_length)

Returns the domain part of a host given the domain level.
.extract_subdomain(host, tld_length)

Returns the subdomains of a host as a ::String given the domain level.
.extract_subdomains(host, tld_length)

Returns the subdomains of a host as an ::Array given the domain level.
.full_url_for(options)
.path_for(options)
.url_for(options)
.add_anchor(path, anchor) private
.add_params(path, params) private
.build_host_url(host, port, protocol, options, path) private
.extract_domain_from(host, tld_length) private
.extract_subdomains_from(host, tld_length) private
.named_host?(host) ⇒ Boolean private
.normalize_host(_host, options) private
.normalize_port(port, protocol) private
.normalize_protocol(protocol) private

Instance Attribute Summary

#secure_protocol rw
#standard_port readonly

Returns the standard port number for this request’s protocol.
#standard_port? ⇒ Boolean readonly

Returns whether this request is using the standard port.
#tld_length rw

Instance Method Summary

#domain(tld_length = @@tld_length)

Returns the domain part of a host, such as “rubyonrails.org” in “www.rubyonrails.org”.
#host

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

Returns a host:port string for this request, such as “example.com” or “example.com:8080”.
#initialize
#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.
#port

Returns the port number of this request as an integer.
#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.
#protocol

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

Returns the host and port for this request, such as “example.com:8080”.
#server_port

Returns the requested port, such as 8080, based on SERVER_PORT.
#subdomain(tld_length = @@tld_length)

Returns all the subdomains as a string, so "dev.www" would be returned for “dev.www.rubyonrails.org”.
#subdomains(tld_length = @@tld_length)

Returns all the subdomains as an array, so ["dev", "www"] would be returned for “dev.www.rubyonrails.org”.
#url

Returns the complete URL used for this request.

Class Attribute Details

.secure_protocol (rw) Also known as: #secure_protocol

[ GitHub ]

# File 'actionpack/lib/action_dispatch/http/url.rb', line 12


mattr_accessor :secure_protocol, default: false

.tld_length (rw) Also known as: #tld_length

[ GitHub ]

# File 'actionpack/lib/action_dispatch/http/url.rb', line 13


mattr_accessor :tld_length, default: 1

Class Method Details

.add_anchor(path, anchor) (private)

[ GitHub ]

# File 'actionpack/lib/action_dispatch/http/url.rb', line 90


def add_anchor(path, anchor)
  if anchor
    path << "##{Journey::Router::Utils.escape_fragment(anchor.to_param)}"
  end
end

.add_params(path, params) (private)

[ GitHub ]

# File 'actionpack/lib/action_dispatch/http/url.rb', line 83


def add_params(path, params)
  params = { params: params } unless params.is_a?(Hash)
  params.reject! { |_, v| v.to_param.nil? }
  query = params.to_query
  path << "?#{query}" unless query.empty?
end

.build_host_url(host, port, protocol, options, path) (private)

[ GitHub ]

# File 'actionpack/lib/action_dispatch/http/url.rb', line 105


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

  protocol = normalize_protocol protocol
  host     = normalize_host(host, options)

  result = protocol.dup

  if options[:user] && options[:password]
    result << "#{Rack::Utils.escape(options[:user])}:#{Rack::Utils.escape(options[:password])}@"
  end

  result << host
  normalize_port(port, protocol) { |normalized_port|
    result << ":#{normalized_port}"
  }

  result.concat path
end

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

[ GitHub ]

# File 'actionpack/lib/action_dispatch/http/url.rb', line 22


def extract_domain(host, tld_length)
  extract_domain_from(host, tld_length) if named_host?(host)
end

.extract_domain_from(host, tld_length) (private)

[ GitHub ]

# File 'actionpack/lib/action_dispatch/http/url.rb', line 96


def extract_domain_from(host, tld_length)
  host.split(".").last(1 + tld_length).join(".")
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"

[ GitHub ]

# File 'actionpack/lib/action_dispatch/http/url.rb', line 46


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"]

[ GitHub ]

# File 'actionpack/lib/action_dispatch/http/url.rb', line 32


def extract_subdomains(host, tld_length)
  if named_host?(host)
    extract_subdomains_from(host, tld_length)
  else
    []
  end
end

.extract_subdomains_from(host, tld_length) (private)

[ GitHub ]

# File 'actionpack/lib/action_dispatch/http/url.rb', line 100


def extract_subdomains_from(host, tld_length)
  parts = host.split(".")
  parts[0..-(tld_length + 2)]
end

.full_url_for(options)

[ GitHub ]

# File 'actionpack/lib/action_dispatch/http/url.rb', line 58


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

.named_host?(host) ⇒ `Boolean` (private)

[ GitHub ]

# File 'actionpack/lib/action_dispatch/http/url.rb', line 129


def named_host?(host)
  !IP_HOST_REGEXP.match?(host)
end

.normalize_host(_host, options) (private)

[ GitHub ]

# File 'actionpack/lib/action_dispatch/http/url.rb', line 146


def normalize_host(_host, options)
  return _host unless named_host?(_host)

  tld_length = options[:tld_length] || @@tld_length
  subdomain  = options.fetch :subdomain, true
  domain     = options[:domain]

  host = +""
  if subdomain == true
    return _host if domain.nil?

    host << extract_subdomains_from(_host, tld_length).join(".")
  elsif subdomain
    host << subdomain.to_param
  end
  host << "." unless host.empty?
  host << (domain || extract_domain_from(_host, tld_length))
  host
end

.normalize_port(port, protocol) (private)

[ GitHub ]

# File 'actionpack/lib/action_dispatch/http/url.rb', line 166


def normalize_port(port, protocol)
  return unless port

  case protocol
  when "//" then yield port
  when "https://"
    yield port unless port.to_i == 443
  else
    yield port unless port.to_i == 80
  end
end

.normalize_protocol(protocol) (private)

[ GitHub ]

# File 'actionpack/lib/action_dispatch/http/url.rb', line 133


def normalize_protocol(protocol)
  case protocol
  when nil
    secure_protocol ? "https://" : "http://"
  when false, "//"
    "//"
  when PROTOCOL_REGEXP
    "#{$1}://"
  else
    raise ArgumentError, "Invalid :protocol option: #{protocol.inspect}"
  end
end

.path_for(options)

[ GitHub ]

# File 'actionpack/lib/action_dispatch/http/url.rb', line 70


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)

[ GitHub ]

# File 'actionpack/lib/action_dispatch/http/url.rb', line 50


def url_for(options)
  if options[:only_path]
    path_for options
  else
    full_url_for options
  end
end

Instance Attribute Details

#secure_protocol (rw)

[ GitHub ]

# File 'actionpack/lib/action_dispatch/http/url.rb', line 12


mattr_accessor :secure_protocol, default: false

#standard_port (readonly)

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

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

[ GitHub ]

# File 'actionpack/lib/action_dispatch/http/url.rb', line 265


def standard_port
  if "https://" == protocol
    443
  else
    80
  end
end

#standard_port? ⇒ `Boolean` (readonly)

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

[ GitHub ]

# File 'actionpack/lib/action_dispatch/http/url.rb', line 280


def standard_port?
  port == standard_port
end

#tld_length (rw)

[ GitHub ]

# File 'actionpack/lib/action_dispatch/http/url.rb', line 13


mattr_accessor :tld_length, default: 1

Instance Method Details

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

[ GitHub ]

# File 'actionpack/lib/action_dispatch/http/url.rb', line 321


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"

[ GitHub ]

# File 'actionpack/lib/action_dispatch/http/url.rb', line 226


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"

[ GitHub ]

# File 'actionpack/lib/action_dispatch/http/url.rb', line 242


def host_with_port
  "#{host}#{port_string}"
end

#initialize

[ GitHub ]

# File 'actionpack/lib/action_dispatch/http/url.rb', line 179


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

[ GitHub ]

# File 'actionpack/lib/action_dispatch/http/url.rb', line 292


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

[ GitHub ]

# File 'actionpack/lib/action_dispatch/http/url.rb', line 253


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"

[ GitHub ]

# File 'actionpack/lib/action_dispatch/http/url.rb', line 304


def port_string
  standard_port? ? "" : ":#{port}"
end

#protocol

Returns ‘https://’ if this is an ::ActionDispatch::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://"

[ GitHub ]

# File 'actionpack/lib/action_dispatch/http/url.rb', line 200


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"

[ GitHub ]

# File 'actionpack/lib/action_dispatch/http/url.rb', line 214


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

[ GitHub ]

# File 'actionpack/lib/action_dispatch/http/url.rb', line 315


def server_port
  get_header("SERVER_PORT").to_i
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”.

[ GitHub ]

# File 'actionpack/lib/action_dispatch/http/url.rb', line 337


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

[ GitHub ]

# File 'actionpack/lib/action_dispatch/http/url.rb', line 329


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"

[ GitHub ]

# File 'actionpack/lib/action_dispatch/http/url.rb', line 189


def url
  protocol + host_with_port + fullpath
end

Module: ActionDispatch::Http::URL

Constant Summary

Class Attribute Summary

Class Method Summary

Instance Attribute Summary

Instance Method Summary

Class Attribute Details

.secure_protocol (rw) Also known as: #secure_protocol

.tld_length (rw) Also known as: #tld_length

Class Method Details

.add_anchor(path, anchor) (private)

.add_params(path, params) (private)

.build_host_url(host, port, protocol, options, path) (private)

.extract_domain(host, tld_length)

.extract_domain_from(host, tld_length) (private)

.extract_subdomain(host, tld_length)

.extract_subdomains(host, tld_length)

.extract_subdomains_from(host, tld_length) (private)

.full_url_for(options)

.named_host?(host) ⇒ Boolean (private)

.normalize_host(_host, options) (private)

.normalize_port(port, protocol) (private)

.normalize_protocol(protocol) (private)

.path_for(options)

.url_for(options)

Instance Attribute Details

#secure_protocol (rw)

#standard_port (readonly)

#standard_port? ⇒ Boolean (readonly)

#tld_length (rw)

Instance Method Details

#domain(tld_length = @@tld_length)

#host

#host_with_port

#initialize

#optional_port

#port

#port_string

#protocol

#raw_host_with_port

#server_port

#subdomain(tld_length = @@tld_length)

#subdomains(tld_length = @@tld_length)

#url

.named_host?(host) ⇒ `Boolean` (private)

#standard_port? ⇒ `Boolean` (readonly)