cgi_methods.rb 4.8 KB
Newer Older
D
Initial  
David Heinemeier Hansson 已提交
1
require 'cgi'
2
require 'action_controller/vendor/xml_simple'
D
Initial  
David Heinemeier Hansson 已提交
3 4 5 6 7 8 9 10 11 12 13

# Static methods for parsing the query and request parameters that can be used in
# a CGI extension class or testing in isolation.
class CGIMethods #:nodoc:
  public
    # Returns a hash with the pairs from the query string. The implicit hash construction that is done in
    # parse_request_params is not done here.
    def CGIMethods.parse_query_parameters(query_string)
      parsed_params = {}
  
      query_string.split(/[&;]/).each { |p| 
14
        k, v = p.split('=',2)
15
        v = nil if (v && v.empty?)
D
Initial  
David Heinemeier Hansson 已提交
16

17 18
        k = CGI.unescape(k) if k
        v = CGI.unescape(v) if v
D
Initial  
David Heinemeier Hansson 已提交
19

20 21 22 23 24 25 26 27 28 29 30
        unless k.include?(?[)
          parsed_params[k] = v
        else
          keys = split_key(k)
          last_key = keys.pop
          last_key = keys.pop if (use_array = last_key.empty?)
          parent = keys.inject(parsed_params) {|h, k| h[k] ||= {}}
          
          if use_array then (parent[last_key] ||= []) << v
          else parent[last_key] = v
          end
D
Initial  
David Heinemeier Hansson 已提交
31 32 33
        end
      }
  
34
      parsed_params
D
Initial  
David Heinemeier Hansson 已提交
35
    end
36

D
Initial  
David Heinemeier Hansson 已提交
37 38 39 40 41 42 43 44
    # Returns the request (POST/GET) parameters in a parsed form where pairs such as "customer[address][street]" / 
    # "Somewhere cool!" are translated into a full hash hierarchy, like
    # { "customer" => { "address" => { "street" => "Somewhere cool!" } } }
    def CGIMethods.parse_request_parameters(params)
      parsed_params = {}

      for key, value in params
        value = [value] if key =~ /.*\[\]$/
45 46 47 48 49 50 51
        unless key.include?('[')
          # much faster to test for the most common case first (GET)
          # and avoid the call to build_deep_hash
          parsed_params[key] = get_typed_value(value[0])
        else
          build_deep_hash(get_typed_value(value[0]), parsed_params, get_levels(key))
        end
D
Initial  
David Heinemeier Hansson 已提交
52 53
      end
    
54
      parsed_params
D
Initial  
David Heinemeier Hansson 已提交
55 56
    end

57 58 59 60 61 62 63 64 65 66 67 68
    def self.parse_formatted_request_parameters(format, raw_post_data)
      case format
        when :xml
          return XmlSimple.xml_in(raw_post_data, 'ForceArray' => false)
        when :yaml
          return YAML.load(raw_post_data)
      end
    rescue Object => e
      { "exception" => "#{e.message} (#{e.class})", "backtrace" => e.backtrace, 
        "raw_post_data" => raw_post_data, "format" => format }
    end

D
Initial  
David Heinemeier Hansson 已提交
69
  private
70 71 72 73 74 75 76 77 78 79 80

    # Splits the given key into several pieces. Example keys are 'name', 'person[name]',
    # 'person[name][first]', and 'people[]'. In each instance, an Array instance is returned.
    # 'person[name][first]' produces ['person', 'name', 'first']; 'people[]' produces ['people', '']
    def CGIMethods.split_key(key)
      if /^([^\[]+)((?:\[[^\]]*\])+)$/ =~ key
        keys = [$1]
        
        keys.concat($2[1..-2].split(']['))
        keys << '' if key[-2..-1] == '[]' # Have to add it since split will drop empty strings
        
81
        keys
82
      else
83
        [key]
84 85 86
      end
    end
    
D
Initial  
David Heinemeier Hansson 已提交
87
    def CGIMethods.get_typed_value(value)
88 89 90
      # test most frequent case first
      if value.is_a?(String)
        value
91
      elsif value.respond_to?(:content_type)
D
Initial  
David Heinemeier Hansson 已提交
92
        # Uploaded file
93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112
        unless value.respond_to?(:full_original_filename)
          class << value
            alias_method :full_original_filename, :original_filename

            # Take the basename of the upload's original filename.
            # This handles the full Windows paths given by Internet Explorer
            # (and perhaps other broken user agents) without affecting
            # those which give the lone filename.
            # The Windows regexp is adapted from Perl's File::Basename.
            def original_filename
              if md = /^(?:.*[:\\\/])?(.*)/m.match(full_original_filename)
                md.captures.first
              else
                File.basename full_original_filename
              end
            end
          end
        end

        # Return the same value after overriding original_filename.
D
Initial  
David Heinemeier Hansson 已提交
113
        value
114

D
Initial  
David Heinemeier Hansson 已提交
115 116 117 118
      elsif value.respond_to?(:read)
        # Value as part of a multipart request
        value.read
      elsif value.class == Array
119
        value.collect { |v| CGIMethods.get_typed_value(v) }
D
Initial  
David Heinemeier Hansson 已提交
120
      else
121
        # other value (neither string nor a multipart request)
D
Initial  
David Heinemeier Hansson 已提交
122 123 124 125
        value.to_s
      end
    end
  
126 127 128 129 130 131 132 133 134 135 136
    PARAMS_HASH_RE = /^([^\[]+)(\[.*\])?(.)?.*$/
    def CGIMethods.get_levels(key)
      all, main, bracketed, trailing = PARAMS_HASH_RE.match(key).to_a
      if main.nil?
        []
      elsif trailing
        [key]
      elsif bracketed
        [main] + bracketed.slice(1...-1).split('][')
      else
        [main]
D
Initial  
David Heinemeier Hansson 已提交
137 138
      end
    end
139

D
Initial  
David Heinemeier Hansson 已提交
140 141
    def CGIMethods.build_deep_hash(value, hash, levels)
      if levels.length == 0
142
        value
D
Initial  
David Heinemeier Hansson 已提交
143 144 145 146 147 148
      elsif hash.nil?
        { levels.first => CGIMethods.build_deep_hash(value, nil, levels[1..-1]) }
      else
        hash.update({ levels.first => CGIMethods.build_deep_hash(value, hash[levels.first], levels[1..-1]) })
      end
    end
149
end