Module: ActionDispatch::Http::URL

Defined in:

actionpack/lib/action_dispatch/http/url.rb

Instance Method Summary (collapse)

• - (Object) domain(tld_length = 1)

  Returns the domain part of a host, such as "rubyonrails.org" in "www.rubyonrails.org".

• - (Object) host

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

• - (Object) host_with_port

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

• - (Object) port

  Returns the port number of this request as an integer.

• - (Object) port_string

  Returns a port suffix like ":8080" if the port number of this request is not the default HTTP port 80 or HTTPS port 443.

• - (Object) protocol

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

• - (Object) raw_host_with_port

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

• - (Object) request_uri

  Returns the request URI, accounting for server idiosyncrasies.

• - (Object) scheme

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

• - (Object) server_port
• - (Boolean) ssl?

  Is this an SSL request?.

• - (Object) standard_port

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

• - (Boolean) standard_port?

  Returns whether this request is using the standard port.

• - (Object) subdomain(tld_length = 1)
• - (Object) subdomains(tld_length = 1)

  Returns all the subdomains as an array, so ["dev", "www"] would be returned for "dev.www.rubyonrails.org".

• - (Object) url

  Returns the complete URL used for this request.

78
79
80
81
82

# File 'actionpack/lib/action_dispatch/http/url.rb', line 78

def domain(tld_length = 1)
  return nil unless named_host?(host)

  host.split('.').last(1 + tld_length).join('.')
end

34
35
36

# File 'actionpack/lib/action_dispatch/http/url.rb', line 34

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

40
41
42

# File 'actionpack/lib/action_dispatch/http/url.rb', line 40

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

45
46
47
48
49
50
51

# File 'actionpack/lib/action_dispatch/http/url.rb', line 45

def port
  if raw_host_with_port =~ /:(\d+)$/
    $1.to_i
  else
    standard_port
  end
end

68
69
70

# File 'actionpack/lib/action_dispatch/http/url.rb', line 68

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

15
16
17

# File 'actionpack/lib/action_dispatch/http/url.rb', line 15

def protocol
  ssl? ? 'https://' : 'http://'
end

25
26
27
28
29
30
31

# File 'actionpack/lib/action_dispatch/http/url.rb', line 25

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

100
101
102
103

# File 'actionpack/lib/action_dispatch/http/url.rb', line 100

def request_uri
  ActiveSupport::Deprecation.warn "Using #request_uri is deprecated. Use fullpath instead.", caller
  fullpath
end

10
11
12

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

def scheme
  ssl? ? 'https' : 'http'
end

72
73
74

# File 'actionpack/lib/action_dispatch/http/url.rb', line 72

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

20
21
22

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

def ssl?
  @env['HTTPS'] == 'on' || @env['HTTP_X_FORWARDED_PROTO'] == 'https'
end

54
55
56
57
58
59

# File 'actionpack/lib/action_dispatch/http/url.rb', line 54

def standard_port
  case protocol
    when 'https://' then 443
    else 80
  end
end

62
63
64

# File 'actionpack/lib/action_dispatch/http/url.rb', line 62

def standard_port?
  port == standard_port
end

94
95
96

# File 'actionpack/lib/action_dispatch/http/url.rb', line 94

def subdomain(tld_length = 1)
  subdomains(tld_length).join('.')
end

88
89
90
91
92

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

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

5
6
7

# File 'actionpack/lib/action_dispatch/http/url.rb', line 5

def url
  protocol + host_with_port + fullpath
end