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)
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
.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"
# 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_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"
# 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"]
# 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
.full_url_for(options)
[ GitHub ]# File 'actionpack/lib/action_dispatch/http/url.rb', line 58
def full_url_for( ) host = [:host] protocol = [:protocol] port = [: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, , path_for( )) end
.path_for(options)
[ GitHub ]# File 'actionpack/lib/action_dispatch/http/url.rb', line 70
def path_for( ) path = [:script_name].to_s.chomp("/") path << [:path] if .key?(:path) path = "/" if [:trailing_slash] && path.blank? add_params(path, [:params]) if .key?(:params) add_anchor(path, [:anchor]) if .key?(:anchor) path end
.url_for(options)
[ GitHub ]# File 'actionpack/lib/action_dispatch/http/url.rb', line 50
def url_for( ) if [:only_path] path_for else full_url_for 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
# 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
# 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”.
# 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"
# 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"
# 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
# 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
# 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"
# 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://"
# 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"
# 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
# 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”.
# 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”.
# 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"
# File 'actionpack/lib/action_dispatch/http/url.rb', line 189
def url protocol + host_with_port + fullpath end