url.rb 7.8 KB
Newer Older
1 2 3
require 'active_support/core_ext/module/attribute_accessors'
require 'active_support/core_ext/hash/slice'

4 5 6
module ActionDispatch
  module Http
    module URL
7 8 9
      IP_HOST_REGEXP  = /\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}$/
      HOST_REGEXP     = /(^.*:\/\/)?([^:]+)(?::(\d+$))?/
      PROTOCOL_REGEXP = /^([^:]+)(:)?(\/\/)?$/
10

11
      mattr_accessor :tld_length
12
      self.tld_length = 1
13

J
José Valim 已提交
14 15
      class << self
        def extract_domain(host, tld_length = @@tld_length)
16
          host.split('.').last(1 + tld_length).join('.') if named_host?(host)
J
José Valim 已提交
17
        end
18

J
José Valim 已提交
19
        def extract_subdomains(host, tld_length = @@tld_length)
20 21 22 23 24 25
          if named_host?(host)
            parts = host.split('.')
            parts[0..-(tld_length + 2)]
          else
            []
          end
J
José Valim 已提交
26
        end
27

J
José Valim 已提交
28 29
        def extract_subdomain(host, tld_length = @@tld_length)
          extract_subdomains(host, tld_length).join('.')
30 31
        end

32
        def url_for(options)
A
Aaron Patterson 已提交
33 34 35 36
          unless options[:host] || options[:only_path]
            raise ArgumentError, 'Missing host to link to! Please provide the :host parameter, set default_url_options[:host], or set :only_path to true'
          end

37 38
          path  = options[:script_name].to_s.chomp("/")
          path << options[:path].to_s
39

40
          add_trailing_slash(path) if options[:trailing_slash]
41

42 43 44 45 46
          result = path

          unless options[:only_path]
            result.prepend build_host_url(options)
          end
47

48 49 50 51 52 53 54 55 56
          if options.key? :params
            params = options[:params].is_a?(Hash) ?
                                 options[:params] :
                                 { params: options[:params] }

            params.reject! { |_,v| v.to_param.nil? }
            result << "?#{params.to_query}" unless params.empty?
          end

57 58
          result << "##{Journey::Router::Utils.escape_fragment(options[:anchor].to_param.to_s)}" if options[:anchor]
          result
J
José Valim 已提交
59
        end
60 61 62

        private

63 64 65 66 67 68 69 70 71 72 73 74
        def add_trailing_slash(path)
          # includes querysting
          if path.include?('?')
            path.sub!(/\?/, '/\&')
          # does not have a .format
          elsif !path.include?(".")
            path.sub!(/[^\/]\z|\A\z/, '\&/')
          end

          path
        end

75
        def build_host_url(options)
A
Aaron Patterson 已提交
76 77 78 79 80
          if match = options[:host].match(HOST_REGEXP)
            options[:protocol] ||= match[1] unless options[:protocol] == false
            options[:host]       = match[2]
            options[:port]       = match[3] unless options.key?(:port)
          end
81

A
Aaron Patterson 已提交
82 83 84
          options[:protocol] = normalize_protocol(options)
          options[:host]     = normalize_host(options)
          options[:port]     = normalize_port(options)
85

A
Aaron Patterson 已提交
86
          result = options[:protocol]
87

A
Aaron Patterson 已提交
88 89 90
          if options[:user] && options[:password]
            result << "#{Rack::Utils.escape(options[:user])}:#{Rack::Utils.escape(options[:password])}@"
          end
91

A
Aaron Patterson 已提交
92 93
          result << options[:host]
          result << ":#{options[:port]}" if options[:port]
94

95 96 97
          result
        end

J
José Valim 已提交
98
        def named_host?(host)
99
          host && IP_HOST_REGEXP !~ host
J
José Valim 已提交
100 101
        end

102 103 104 105 106 107 108 109 110 111 112 113 114 115
        def same_host?(options)
          (options[:subdomain] == true || !options.key?(:subdomain)) && options[:domain].nil?
        end

        def normalize_protocol(options)
          case options[:protocol]
          when nil
            "http://"
          when false, "//"
            "//"
          when PROTOCOL_REGEXP
            "#{$1}://"
          else
            raise ArgumentError, "Invalid :protocol option: #{options[:protocol].inspect}"
116 117 118
          end
        end

119 120
        def normalize_host(options)
          return options[:host] if !named_host?(options[:host]) || same_host?(options)
121 122 123 124

          tld_length = options[:tld_length] || @@tld_length

          host = ""
125 126 127 128
          if options[:subdomain] == true || !options.key?(:subdomain)
            host << extract_subdomain(options[:host], tld_length).to_param
          elsif options[:subdomain].present?
            host << options[:subdomain].to_param
129
          end
130
          host << "." unless host.empty?
J
José Valim 已提交
131
          host << (options[:domain] || extract_domain(options[:host], tld_length))
132 133
          host
        end
134 135 136 137 138

        def normalize_port(options)
          return nil if options[:port].nil? || options[:port] == false

          case options[:protocol]
139 140
          when "//"
            options[:port]
141 142 143 144 145 146
          when "https://"
            options[:port].to_i == 443 ? nil : options[:port]
          else
            options[:port].to_i == 80 ? nil : options[:port]
          end
        end
147 148
      end

A
Aaron Patterson 已提交
149 150 151 152 153 154
      def initialize(env)
        super
        @protocol = nil
        @port     = nil
      end

155
      # Returns the complete URL used for this request.
156
      def url
157
        protocol + host_with_port + fullpath
158 159 160 161
      end

      # Returns 'https://' if this is an SSL request and 'http://' otherwise.
      def protocol
162
        @protocol ||= ssl? ? 'https://' : 'http://'
163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181
      end

      # Returns the \host for this request, such as "example.com".
      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

      # Returns the host for this request, such as example.com.
      def host
        raw_host_with_port.sub(/:\d+$/, '')
      end

      # Returns a \host:\port string for this request, such as "example.com" or
      # "example.com:8080".
      def host_with_port
182
        "#{host}#{port_string}"
183 184 185 186
      end

      # Returns the port number of this request as an integer.
      def port
187 188 189 190 191 192
        @port ||= begin
          if raw_host_with_port =~ /:(\d+)$/
            $1.to_i
          else
            standard_port
          end
193 194 195 196 197 198 199 200 201 202 203
        end
      end

      # Returns the standard \port number for this request's protocol.
      def standard_port
        case protocol
          when 'https://' then 443
          else 80
        end
      end

204 205 206 207 208
      # Returns whether this request is using the standard port
      def standard_port?
        port == standard_port
      end

209
      # Returns a number \port suffix like 8080 if the \port number of this request
210
      # is not the default HTTP \port 80 or HTTPS \port 443.
211 212
      def optional_port
        standard_port? ? nil : port
213 214
      end

215 216 217 218 219 220
      # 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.
      def port_string
        standard_port? ? '' : ":#{port}"
      end

221 222 223 224 225 226
      def server_port
        @env['SERVER_PORT'].to_i
      end

      # Returns the \domain part of a \host, such as "rubyonrails.org" in "www.rubyonrails.org". You can specify
      # a different <tt>tld_length</tt>, such as 2 to catch rubyonrails.co.uk in "www.rubyonrails.co.uk".
227
      def domain(tld_length = @@tld_length)
228
        ActionDispatch::Http::URL.extract_domain(host, tld_length)
229 230 231 232 233 234
      end

      # Returns all the \subdomains as an array, so <tt>["dev", "www"]</tt> would be
      # returned for "dev.www.rubyonrails.org". You can specify a different <tt>tld_length</tt>,
      # such as 2 to catch <tt>["www"]</tt> instead of <tt>["www", "rubyonrails"]</tt>
      # in "www.rubyonrails.co.uk".
235
      def subdomains(tld_length = @@tld_length)
236
        ActionDispatch::Http::URL.extract_subdomains(host, tld_length)
237 238
      end

239 240
      # Returns all the \subdomains as a string, so <tt>"dev.www"</tt> would be
      # returned for "dev.www.rubyonrails.org". You can specify a different <tt>tld_length</tt>,
241
      # such as 2 to catch <tt>"www"</tt> instead of <tt>"www.rubyonrails"</tt>
242
      # in "www.rubyonrails.co.uk".
243
      def subdomain(tld_length = @@tld_length)
244
        ActionDispatch::Http::URL.extract_subdomain(host, tld_length)
245
      end
246 247
    end
  end
248
end