Module: ActionDispatch::Http::URL
- Included in:
- Request
- Defined in:
- 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
- .extract_domain(host, tld_length = @@tld_length) ⇒ Object
- .extract_subdomain(host, tld_length = @@tld_length) ⇒ Object
- .extract_subdomains(host, tld_length = @@tld_length) ⇒ Object
- .url_for(options = {}) ⇒ Object
Instance Method Summary collapse
-
#domain(tld_length = @@tld_length) ⇒ Object
Returns the domain part of a host, such as “rubyonrails.org” in “www.rubyonrails.org”.
-
#host ⇒ Object
Returns the host for this request, such as example.com.
-
#host_with_port ⇒ Object
Returns a host:port string for this request, such as “example.com” or “example.com:8080”.
- #initialize(env) ⇒ Object
-
#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.
-
#port ⇒ Object
Returns the port number of this request as an integer.
-
#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.
-
#protocol ⇒ Object
Returns ‘https://’ if this is an SSL request and ‘http://’ otherwise.
-
#raw_host_with_port ⇒ Object
Returns the host for this request, such as “example.com”.
- #server_port ⇒ Object
-
#standard_port ⇒ Object
Returns the standard port number for this request’s protocol.
-
#standard_port? ⇒ Boolean
Returns whether this request is using the standard port.
-
#subdomain(tld_length = @@tld_length) ⇒ Object
Returns all the subdomains as a string, so
"dev.www"
would be returned for “dev.www.rubyonrails.org”. -
#subdomains(tld_length = @@tld_length) ⇒ Object
Returns all the subdomains as an array, so
["dev", "www"]
would be returned for “dev.www.rubyonrails.org”. -
#url ⇒ Object
Returns the complete URL used for this request.
Class Method Details
.extract_domain(host, tld_length = @@tld_length) ⇒ Object
15 16 17 |
# File 'lib/action_dispatch/http/url.rb', line 15 def extract_domain(host, tld_length = @@tld_length) host.split('.').last(1 + tld_length).join('.') if named_host?(host) end |
.extract_subdomain(host, tld_length = @@tld_length) ⇒ Object
28 29 30 |
# File 'lib/action_dispatch/http/url.rb', line 28 def extract_subdomain(host, tld_length = @@tld_length) extract_subdomains(host, tld_length).join('.') end |
.extract_subdomains(host, tld_length = @@tld_length) ⇒ Object
19 20 21 22 23 24 25 26 |
# File 'lib/action_dispatch/http/url.rb', line 19 def extract_subdomains(host, tld_length = @@tld_length) if named_host?(host) parts = host.split('.') parts[0..-(tld_length + 2)] else [] end end |
.url_for(options = {}) ⇒ Object
32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 |
# File 'lib/action_dispatch/http/url.rb', line 32 def url_for( = {}) = .dup path = .delete(:script_name).to_s.chomp("/") path << .delete(:path).to_s add_trailing_slash(path) if [:trailing_slash] params = [:params].is_a?(Hash) ? [:params] : .slice(:params) params.reject! { |_,v| v.to_param.nil? } result = build_host_url() result << path result << "?#{params.to_query}" unless params.empty? result << "##{Journey::Router::Utils.escape_fragment([:anchor].to_param.to_s)}" if [:anchor] result 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”.
228 229 230 |
# File 'lib/action_dispatch/http/url.rb', line 228 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.
176 177 178 |
# File 'lib/action_dispatch/http/url.rb', line 176 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”.
182 183 184 |
# File 'lib/action_dispatch/http/url.rb', line 182 def host_with_port "#{host}#{port_string}" end |
#initialize(env) ⇒ Object
150 151 152 153 154 |
# File 'lib/action_dispatch/http/url.rb', line 150 def initialize(env) 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.
212 213 214 |
# File 'lib/action_dispatch/http/url.rb', line 212 def optional_port standard_port? ? nil : port end |
#port ⇒ Object
Returns the port number of this request as an integer.
187 188 189 190 191 192 193 194 195 |
# File 'lib/action_dispatch/http/url.rb', line 187 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.
218 219 220 |
# File 'lib/action_dispatch/http/url.rb', line 218 def port_string standard_port? ? '' : ":#{port}" end |
#protocol ⇒ Object
Returns ‘https://’ if this is an SSL request and ‘http://’ otherwise.
162 163 164 |
# File 'lib/action_dispatch/http/url.rb', line 162 def protocol @protocol ||= ssl? ? 'https://' : 'http://' end |
#raw_host_with_port ⇒ Object
Returns the host for this request, such as “example.com”.
167 168 169 170 171 172 173 |
# File 'lib/action_dispatch/http/url.rb', line 167 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 |
#server_port ⇒ Object
222 223 224 |
# File 'lib/action_dispatch/http/url.rb', line 222 def server_port @env['SERVER_PORT'].to_i end |
#standard_port ⇒ Object
Returns the standard port number for this request’s protocol.
198 199 200 201 202 203 |
# File 'lib/action_dispatch/http/url.rb', line 198 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
206 207 208 |
# File 'lib/action_dispatch/http/url.rb', line 206 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”.
244 245 246 |
# File 'lib/action_dispatch/http/url.rb', line 244 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”.
236 237 238 |
# File 'lib/action_dispatch/http/url.rb', line 236 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.
157 158 159 |
# File 'lib/action_dispatch/http/url.rb', line 157 def url protocol + host_with_port + fullpath end |