Module: ActionDispatch::Http::URL

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

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.extract_domain(host, tld_length = @@tld_length) ⇒ Object


8
9
10
11
# File 'actionpack/lib/action_dispatch/http/url.rb', line 8

def extract_domain(host, tld_length = @@tld_length)
  return nil unless named_host?(host)
  host.split('.').last(1 + tld_length).join('.')
end

.extract_subdomain(host, tld_length = @@tld_length) ⇒ Object


19
20
21
# File 'actionpack/lib/action_dispatch/http/url.rb', line 19

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

.extract_subdomains(host, tld_length = @@tld_length) ⇒ Object


13
14
15
16
17
# File 'actionpack/lib/action_dispatch/http/url.rb', line 13

def extract_subdomains(host, tld_length = @@tld_length)
  return [] unless named_host?(host)
  parts = host.split('.')
  parts[0..-(tld_length+2)]
end

.url_for(options = {}) ⇒ Object


23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
# File 'actionpack/lib/action_dispatch/http/url.rb', line 23

def url_for(options = {})
  unless options[:host].present? || options[:only_path].present?
    raise ArgumentError, 'Missing host to link to! Please provide the :host parameter, set default_url_options[:host], or set :only_path to true'
  end

  rewritten_url = ""

  unless options[:only_path]
    unless options[:protocol] == false
      rewritten_url << (options[:protocol] || "http")
      rewritten_url << ":" unless rewritten_url.match(%r{:|//})
    end
    rewritten_url << "//" unless rewritten_url.match("//")
    rewritten_url << rewrite_authentication(options)
    rewritten_url << host_or_subdomain_and_domain(options)
    rewritten_url << ":#{options.delete(:port)}" if options[:port]
  end

  path = options.delete(:path) || ''

  params = options[:params] || {}
  params.reject! {|k,v| v.to_param.nil? }

  rewritten_url << (options[:trailing_slash] ? path.sub(/\?|\z/) { "/" + $& } : path)
  rewritten_url << "?#{params.to_query}" unless params.empty?
  rewritten_url << "##{Journey::Router::Utils.escape_fragment(options[:anchor].to_param.to_s)}" if options[:anchor]
  rewritten_url
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”.


153
154
155
# File 'actionpack/lib/action_dispatch/http/url.rb', line 153

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.


101
102
103
# File 'actionpack/lib/action_dispatch/http/url.rb', line 101

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


107
108
109
# File 'actionpack/lib/action_dispatch/http/url.rb', line 107

def host_with_port
  "#{host}#{port_string}"
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.


137
138
139
# File 'actionpack/lib/action_dispatch/http/url.rb', line 137

def optional_port
  standard_port? ? nil : port
end

#portObject

Returns the port number of this request as an integer.


112
113
114
115
116
117
118
119
120
# File 'actionpack/lib/action_dispatch/http/url.rb', line 112

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.


143
144
145
# File 'actionpack/lib/action_dispatch/http/url.rb', line 143

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

#protocolObject

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


87
88
89
# File 'actionpack/lib/action_dispatch/http/url.rb', line 87

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

#raw_host_with_portObject

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


92
93
94
95
96
97
98
# File 'actionpack/lib/action_dispatch/http/url.rb', line 92

def raw_host_with_port
  if forwarded = env["HTTP_X_FORWARDED_HOST"]
    forwarded.split(/,\s?/).last
  else
    env['HTTP_HOST'] || "#{env['SERVER_NAME'] || env['SERVER_ADDR']}:#{env['SERVER_PORT']}"
  end
end

#server_portObject


147
148
149
# File 'actionpack/lib/action_dispatch/http/url.rb', line 147

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

#standard_portObject

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


123
124
125
126
127
128
# File 'actionpack/lib/action_dispatch/http/url.rb', line 123

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)

131
132
133
# File 'actionpack/lib/action_dispatch/http/url.rb', line 131

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


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

def subdomain(tld_length = @@tld_length)
  subdomains(tld_length).join(".")
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”.


161
162
163
# File 'actionpack/lib/action_dispatch/http/url.rb', line 161

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

#urlObject

Returns the complete URL used for this request.


82
83
84
# File 'actionpack/lib/action_dispatch/http/url.rb', line 82

def url
  protocol + host_with_port + fullpath
end