On this page
module ActionDispatch::Http::URL
Constants
- HOST_REGEXP
- IP_HOST_REGEXP
- PROTOCOL_REGEXP
Public Class Methods
# File actionpack/lib/action_dispatch/http/url.rb, line 15
def extract_domain(host, tld_length)
extract_domain_from(host, tld_length) if named_host?(host)
end
# File actionpack/lib/action_dispatch/http/url.rb, line 27
def extract_subdomain(host, tld_length)
extract_subdomains(host, tld_length).join('.')
end
# File actionpack/lib/action_dispatch/http/url.rb, line 19
def extract_subdomains(host, tld_length)
if named_host?(host)
extract_subdomains_from(host, tld_length)
else
[]
end
end
# File actionpack/lib/action_dispatch/http/url.rb, line 39
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
# File actionpack/lib/action_dispatch/http/url.rb, line 169
def initialize(env)
super
@protocol = nil
@port = nil
end
# File actionpack/lib/action_dispatch/http/url.rb, line 51
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
# File actionpack/lib/action_dispatch/http/url.rb, line 31
def url_for(options)
if options[:only_path]
path_for options
else
full_url_for options
end
end
Public Instance Methods
# File actionpack/lib/action_dispatch/http/url.rb, line 247
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”.
# File actionpack/lib/action_dispatch/http/url.rb, line 195
def host
raw_host_with_port.sub(/:\d+$/, '')
end
Returns the host for this request, such as example.com.
# File actionpack/lib/action_dispatch/http/url.rb, line 201
def host_with_port
"#{host}#{port_string}"
end
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 231
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.
# File actionpack/lib/action_dispatch/http/url.rb, line 206
def port
@port ||= begin
if raw_host_with_port =~ /:(\d+)$/
$1.to_i
else
standard_port
end
end
end
Returns the port number of this request as an integer.
# File actionpack/lib/action_dispatch/http/url.rb, line 237
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.
# File actionpack/lib/action_dispatch/http/url.rb, line 181
def protocol
@protocol ||= ssl? ? 'https://' : 'http://'
end
Returns 'https://' if this is an SSL request and 'http://' otherwise.
# File actionpack/lib/action_dispatch/http/url.rb, line 186
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
Returns the host for this request, such as “example.com”.
# File actionpack/lib/action_dispatch/http/url.rb, line 241
def server_port
@env['SERVER_PORT'].to_i
end
# File actionpack/lib/action_dispatch/http/url.rb, line 217
def standard_port
case protocol
when 'https://' then 443
else 80
end
end
Returns the standard port number for this request's protocol.
# File actionpack/lib/action_dispatch/http/url.rb, line 225
def standard_port?
port == standard_port
end
Returns whether this request is using the standard port
# File actionpack/lib/action_dispatch/http/url.rb, line 263
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”.
# File actionpack/lib/action_dispatch/http/url.rb, line 255
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”.
# File actionpack/lib/action_dispatch/http/url.rb, line 176
def url
protocol + host_with_port + fullpath
end
Returns the complete URL used for this request.
© 2004–2018 David Heinemeier Hansson
Licensed under the MIT License.