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


15
16
17
# 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

.extract_subdomain(host, tld_length) ⇒ Object


27
28
29
# File 'actionpack/lib/action_dispatch/http/url.rb', line 27

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

.extract_subdomains(host, tld_length) ⇒ Object


19
20
21
22
23
24
25
# 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

.full_url_for(options) ⇒ Object


39
40
41
42
43
44
45
46
47
48
49
# 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

.path_for(options) ⇒ Object


51
52
53
54
55
56
57
58
59
60
# 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

.url_for(options) ⇒ Object


31
32
33
34
35
36
37
# 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

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


247
248
249
# 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

#hostObject

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


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

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

#host_with_portObject

Returns a host:port string for this request, such as “example.com” or “example.com:8080”.


201
202
203
# File 'actionpack/lib/action_dispatch/http/url.rb', line 201

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

#initialize(env) ⇒ Object


169
170
171
172
173
# File 'actionpack/lib/action_dispatch/http/url.rb', line 169

def initialize(env)
  super
  @protocol = nil
  @port     = nil
end

#optional_portObject

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.


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

def optional_port
  standard_port? ? nil : port
end

#portObject

Returns the port number of this request as an integer.


206
207
208
209
210
211
212
213
214
# 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

#port_stringObject

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.


237
238
239
# File 'actionpack/lib/action_dispatch/http/url.rb', line 237

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

#protocolObject

Returns 'https://' if this is an SSL request and 'http://' otherwise.


181
182
183
# File 'actionpack/lib/action_dispatch/http/url.rb', line 181

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

#raw_host_with_portObject

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


186
187
188
189
190
191
192
# 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

#server_portObject


241
242
243
# File 'actionpack/lib/action_dispatch/http/url.rb', line 241

def server_port
  @env['SERVER_PORT'].to_i
end

#standard_portObject

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


217
218
219
220
221
222
# File 'actionpack/lib/action_dispatch/http/url.rb', line 217

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

Returns:

  • (Boolean)

225
226
227
# File 'actionpack/lib/action_dispatch/http/url.rb', line 225

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


263
264
265
# 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

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


255
256
257
# 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

#urlObject

Returns the complete URL used for this request.


176
177
178
# File 'actionpack/lib/action_dispatch/http/url.rb', line 176

def url
  protocol + host_with_port + fullpath
end