module ActionDispatch::Http::URL

Constants

HOST_REGEXP
IP_HOST_REGEXP
PROTOCOL_REGEXP

Public Class Methods

Source

# File lib/action_dispatch/http/url.rb, line 121
def extract_domain(host, tld_length)
  extract_domain_from(host, tld_length) if named_host?(host)
end

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"

extract_subdomain (host, tld_length)

Source

# File lib/action_dispatch/http/url.rb, line 145
def extract_subdomain(host, tld_length)
  extract_subdomains(host, tld_length).join(".")
end

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"

extract_subdomains (host, tld_length)

Source

# File lib/action_dispatch/http/url.rb, line 131
def extract_subdomains(host, tld_length)
  if named_host?(host)
    extract_subdomains_from(host, tld_length)
  else
    []
  end
end

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

full_url_for (options)

Source

# File lib/action_dispatch/http/url.rb, line 157
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

# File lib/action_dispatch/http/url.rb, line 277
def initialize
  super
  @protocol = nil
  @port     = nil
end

Calls superclass method

path_for (options)

Source

# File lib/action_dispatch/http/url.rb, line 169
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

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

Private Class Methods

add_anchor (path, anchor)

Source

# File lib/action_dispatch/http/url.rb, line 189
def add_anchor(path, anchor)
  if anchor
    path << "##{Journey::Router::Utils.escape_fragment(anchor.to_param)}"
  end
end

add_params (path, params)

Source

# File lib/action_dispatch/http/url.rb, line 182
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)

Source

# File lib/action_dispatch/http/url.rb, line 203
def build_host_url(host, port, protocol, options, path)
  if match = host.match(HOST_REGEXP)
    protocol_from_host = match[1] if protocol.nil?
    host               = match[2]
    port               = match[3] unless options.key? :port
  end

  protocol = protocol_from_host || normalize_protocol(protocol).dup
  host     = normalize_host(host, options)
  port     = normalize_port(port, protocol)

  result = protocol

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

  result << host

  result << ":" << port.to_s if port

  result.concat path
end

extract_domain_from (host, tld_length)

Source

# File lib/action_dispatch/http/url.rb, line 195
def extract_domain_from(host, tld_length)
  domain_extractor.domain_from(host, tld_length)
end

extract_subdomains_from (host, tld_length)

Source

# File lib/action_dispatch/http/url.rb, line 199
def extract_subdomains_from(host, tld_length)
  domain_extractor.subdomains_from(host, tld_length)
end

named_host? (host)

Source

# File lib/action_dispatch/http/url.rb, line 227
def named_host?(host)
  !IP_HOST_REGEXP.match?(host)
end

normalize_host (_host, options)

Source

# File lib/action_dispatch/http/url.rb, line 244
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)

Source

# File lib/action_dispatch/http/url.rb, line 264
def normalize_port(port, protocol)
  return unless port

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

normalize_protocol (protocol)

Source

# File lib/action_dispatch/http/url.rb, line 231
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

Public Instance Methods

domain (tld_length = @@tld_length)

Source

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

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

host ()

Source

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

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

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

host_with_port ()

Source

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

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"

optional_port ()

Source

# File lib/action_dispatch/http/url.rb, line 390
def optional_port
  standard_port? ? nil : port
end

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

port ()

Source

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

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

port_string ()

Source

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

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"

protocol ()

Source

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

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://"

raw_host_with_port ()

Source

# File lib/action_dispatch/http/url.rb, line 312
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

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"

server_port ()

Source

# File lib/action_dispatch/http/url.rb, line 413
def server_port
  get_header("SERVER_PORT").to_i
end

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

standard_port ()

Source

# File lib/action_dispatch/http/url.rb, line 363
def standard_port
  if "https://" == protocol
    443
  else
    80
  end
end

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

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

standard_port? ()

Source

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

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

subdomain (tld_length = @@tld_length)

Source

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

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

subdomains (tld_length = @@tld_length)

Source

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

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

url ()

Source

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

Returns the complete URL used for this request.

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