123456789_123456789_123456789_123456789_123456789_

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

Class Attribute Summary

Class Method Summary

Instance Attribute Summary

Instance Method Summary

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"


  



  [ GitHub ]


  

  


# 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"


  



  [ GitHub ]


  

  


# 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"]


  



  [ GitHub ]


  

  


# 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(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)  
  

  [ GitHub ]


  

  


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



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)  
  

  [ GitHub ]


  

  


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



def url_for(options)
  if options[:only_path]
    path_for options
  else
    full_url_for options
  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


  



  [ GitHub ]


  

  


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



def standard_port
  case protocol
  when "https://" then 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


  





  


  [ GitHub ]


  

  


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



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


  



  [ GitHub ]


  

  


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



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"


  



  [ GitHub ]


  

  


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



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"


  



  [ GitHub ]


  

  


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



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


  








  

    #initialize  
  

  [ GitHub ]


  

  


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



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


  



  [ GitHub ]


  

  


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



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


  



  [ GitHub ]


  

  


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



def port
  @port ||= begin
    if raw_host_with_port =~ /:(\d+)$/
      $1.to_i
    else
      standard_port
    end
  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"


  



  [ GitHub ]


  

  


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



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://"


  



  [ GitHub ]


  

  


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



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"


  



  [ GitHub ]


  

  


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



def raw_host_with_port
  if forwarded = x_forwarded_host.presence
    forwarded.split(/,\s?/).last
  else
    get_header("HTTP_HOST") || "#{server_name || server_addr}:#{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


  



  [ GitHub ]


  

  


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



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


  



  [ GitHub ]


  

  


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



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


  



  [ GitHub ]


  

  


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



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"


  



  [ GitHub ]


  

  


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



def url
  protocol + host_with_port + fullpath
end