Module: ActionDispatch::Http::URL

Included in:
Request
Defined in:
actionpack/lib/action_dispatch/http/url.rb

Constant Summary collapse

IP_HOST_REGEXP = 
/\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}$/
HOST_REGEXP = 
/(^[^:]+:\/\/)?(\[[^\]]+\]|[^:]+)(?::(\d+$))?/
PROTOCOL_REGEXP = 
/^([^:]+)(:)?(\/\/)?$/

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.extract_domain(host, tld_length) ⇒ Object

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"



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

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

.extract_subdomain(host, tld_length) ⇒ Object

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"



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

def extract_subdomain(host, tld_length)
  extract_subdomains(host, tld_length).join(".")
end

.extract_subdomains(host, tld_length) ⇒ Object

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



31
32
33
34
35
36
37
 
# File 'actionpack/lib/action_dispatch/http/url.rb', line 31

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

.full_url_for(options) ⇒ Object 



57
58
59
60
61
62
63
64
65
66
67
 
# File 'actionpack/lib/action_dispatch/http/url.rb', line 57

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

.path_for(options) ⇒ Object 



69
70
71
72
73
74
75
76
77
78
 
# File 'actionpack/lib/action_dispatch/http/url.rb', line 69

def path_for(options)
  path = options[:script_name].to_s.chomp("/")
  path << options[:path] if options.key?(:path)

  add_trailing_slash(path) if options[:trailing_slash]
  add_params(path, options[:params]) if options.key?(:params)
  add_anchor(path, options[:anchor]) if options.key?(:anchor)

  path
end

.url_for(options) ⇒ Object 



49
50
51
52
53
54
55
 
# File 'actionpack/lib/action_dispatch/http/url.rb', line 49

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

Instance Method Details

#domain(tld_length = @@tld_length) ⇒ Object

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



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

def domain(tld_length = @@tld_length)
  ActionDispatch::Http::URL.extract_domain(host, tld_length)
end

#host ⇒ Object

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

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



232
233
234
 
# File 'actionpack/lib/action_dispatch/http/url.rb', line 232

def host
  raw_host_with_port.sub(/:\d+$/, "")
end

#host_with_port ⇒ Object

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"



248
249
250
 
# File 'actionpack/lib/action_dispatch/http/url.rb', line 248

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

#initialize ⇒ Object 



185
186
187
188
189
 
# File 'actionpack/lib/action_dispatch/http/url.rb', line 185

def initialize
  super
  @protocol = nil
  @port     = nil
end

#optional_port ⇒ Object

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



299
300
301
 
# File 'actionpack/lib/action_dispatch/http/url.rb', line 299

def optional_port
  standard_port? ? nil : port
end

#port ⇒ Object

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



259
260
261
262
263
264
265
266
267
 
# File 'actionpack/lib/action_dispatch/http/url.rb', line 259

def port
  @port ||= begin
    if raw_host_with_port =~ /:(\d+)$/
      $1.to_i
    else
      standard_port
    end
  end
end

#port_string ⇒ Object

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"



311
312
313
 
# File 'actionpack/lib/action_dispatch/http/url.rb', line 311

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

#protocol ⇒ Object

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



206
207
208
 
# File 'actionpack/lib/action_dispatch/http/url.rb', line 206

def protocol
  @protocol ||= ssl? ? "https://" : "http://"
end

#raw_host_with_port ⇒ Object

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"



220
221
222
223
224
225
226
 
# File 'actionpack/lib/action_dispatch/http/url.rb', line 220

def raw_host_with_port
  if forwarded = x_forwarded_host.presence
    forwarded.split(/,\s?/).last
  else
    get_header("HTTP_HOST") || "#{server_name || server_addr}:#{get_header('SERVER_PORT')}"
  end
end

#server_port ⇒ Object

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



322
323
324
 
# File 'actionpack/lib/action_dispatch/http/url.rb', line 322

def server_port
  get_header("SERVER_PORT").to_i
end

#standard_port ⇒ Object

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

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



273
274
275
276
277
278
 
# File 'actionpack/lib/action_dispatch/http/url.rb', line 273

def standard_port
  case protocol
  when "https://" then 443
  else 80
  end
end

#standard_port? ⇒ Boolean

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

Returns:

  • (Boolean) 


287
288
289
 
# File 'actionpack/lib/action_dispatch/http/url.rb', line 287

def standard_port?
  port == standard_port
end

#subdomain(tld_length = @@tld_length) ⇒ Object

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



344
345
346
 
# File 'actionpack/lib/action_dispatch/http/url.rb', line 344

def subdomain(tld_length = @@tld_length)
  ActionDispatch::Http::URL.extract_subdomain(host, tld_length)
end

#subdomains(tld_length = @@tld_length) ⇒ Object

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



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

def subdomains(tld_length = @@tld_length)
  ActionDispatch::Http::URL.extract_subdomains(host, tld_length)
end

#url ⇒ Object

Returns the complete URL used for this request.

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



195
196
197
 
# File 'actionpack/lib/action_dispatch/http/url.rb', line 195

def url
  protocol + host_with_port + fullpath
end