Da

✏️ Editing: QueryParser.html

<!DOCTYPE html>

<title>class Rack::QueryParser - rack-2.2.23 Documentation</title>

<div id="table-of-contents-navigation">
 <a href="../table_of_contents.html#pages">Pages</a>
 <a href="../table_of_contents.html#classes">Classes</a>
 <a href="../table_of_contents.html#methods">Methods</a>
 </div>
</div>

</div>

<div id="class-metadata">
 
 <div id="parent-class-section" class="nav-section">
 <h3>Parent</h3>

Object
 
</div>

<div id="method-list-section" class="nav-section">
 <h3>Methods</h3>

<ul class="link-list" role="directory">
 
 <li ><a href="#method-c-make_default">::make_default</a>
 
 <li ><a href="#method-c-new">::new</a>
 
 <li ><a href="#method-i-check_query_string">#check_query_string</a>
 
 <li ><a href="#method-i-make_params">#make_params</a>
 
 <li ><a href="#method-i-new_depth_limit">#new_depth_limit</a>
 
 <li ><a href="#method-i-new_space_limit">#new_space_limit</a>
 
 <li ><a href="#method-i-normalize_params">#normalize_params</a>
 
 <li ><a href="#method-i-params_hash_has_key-3F">#params_hash_has_key?</a>
 
 <li ><a href="#method-i-params_hash_type-3F">#params_hash_type?</a>
 
 <li ><a href="#method-i-parse_nested_query">#parse_nested_query</a>
 
 <li ><a href="#method-i-parse_query">#parse_query</a>
 
 <li ><a href="#method-i-unescape">#unescape</a>
 
 </ul>
</div>

</div>
</nav>

<main role="main" aria-labelledby="class-Rack::QueryParser">
 <h1 id="class-Rack::QueryParser" class="class">
 class Rack::QueryParser
 </h1>

<section class="constants-list">
 <header>
 <h3>Constants</h3>
 </header>
 <dl>
 
 <dt id="BYTESIZE_LIMIT">BYTESIZE_LIMIT
 
 <dd>
 
 
 <dt id="COMMON_SEP">COMMON_SEP
 
 <dd>
 
 
 <dt id="DEFAULT_SEP">DEFAULT_SEP
 
 <dd>
 
 
 <dt id="PARAMS_LIMIT">PARAMS_LIMIT
 
 <dd>
 
 
 <dt id="ParamsTooDeepError">ParamsTooDeepError
 
 <dd><a href="QueryParser/QueryLimitError.html"><code>QueryLimitError</code></a> is for errors raised when the query provided exceeds one of the query parser limits.
 
 
 </dl>
 </section>

<section class="attribute-method-details" class="method-section">
 <header>
 <h3>Attributes</h3>
 </header>

<div id="attribute-i-bytesize_limit" class="method-detail">
 <div class="method-heading attribute-method-heading">
 bytesize_limit[R]
 </div>

<div class="method-description">
 
 
 
 </div>
 </div>
 
 <div id="attribute-i-key_space_limit" class="method-detail">
 <div class="method-heading attribute-method-heading">
 key_space_limit[R]
 </div>

<div class="method-description">
 
 
 
 </div>
 </div>
 
 <div id="attribute-i-param_depth_limit" class="method-detail">
 <div class="method-heading attribute-method-heading">
 param_depth_limit[R]
 </div>

<section id="public-class-5Buntitled-5D-method-details" class="method-section">
 <header>
 <h3>Public Class Methods</h3>
 </header>

<div id="method-c-make_default" class="method-detail ">
 
 <div class="method-heading">
 make_default(key_space_limit, param_depth_limit, **options)
 
 click to toggle source
 
 </div>

<div class="method-source-code" id="make_default-source">
 <pre># File lib/rack/query_parser.rb, line 30
def self.make_default(key_space_limit, param_depth_limit, **options)
 new(Params, key_space_limit, param_depth_limit, **options)
end</pre>
 </div>
 
 </div>

</div>

<div id="method-c-new" class="method-detail ">
 
 <div class="method-heading">
 new(params_class, key_space_limit, param_depth_limit, bytesize_limit: BYTESIZE_LIMIT, params_limit: PARAMS_LIMIT)
 
 click to toggle source
 
 </div>

<div class="method-source-code" id="new-source">
 <pre># File lib/rack/query_parser.rb, line 56
def initialize(params_class, key_space_limit, param_depth_limit, bytesize_limit: BYTESIZE_LIMIT, params_limit: PARAMS_LIMIT)
 @params_class = params_class
 @key_space_limit = key_space_limit
 @param_depth_limit = param_depth_limit
 @bytesize_limit = bytesize_limit
 @params_limit = params_limit
end</pre>
 </div>
 
 </div>

</div>

</section>
 
 <section id="public-instance-5Buntitled-5D-method-details" class="method-section">
 <header>
 <h3>Public Instance Methods</h3>
 </header>

<div id="method-i-make_params" class="method-detail ">
 
 <div class="method-heading">
 make_params()
 
 click to toggle source
 
 </div>

<div class="method-source-code" id="make_params-source">
 <pre># File lib/rack/query_parser.rb, line 157
def make_params
 @params_class.new @key_space_limit
end</pre>
 </div>
 
 </div>

</div>

<div id="method-i-new_depth_limit" class="method-detail ">
 
 <div class="method-heading">
 new_depth_limit(param_depth_limit)
 
 click to toggle source
 
 </div>

<div class="method-source-code" id="new_depth_limit-source">
 <pre># File lib/rack/query_parser.rb, line 165
def new_depth_limit(param_depth_limit)
 self.class.new @params_class, key_space_limit, param_depth_limit
end</pre>
 </div>
 
 </div>

</div>

<div id="method-i-new_space_limit" class="method-detail ">
 
 <div class="method-heading">
 new_space_limit(key_space_limit)
 
 click to toggle source
 
 </div>

<div class="method-source-code" id="new_space_limit-source">
 <pre># File lib/rack/query_parser.rb, line 161
def new_space_limit(key_space_limit)
 self.class.new @params_class, key_space_limit, param_depth_limit
end</pre>
 </div>
 
 </div>

</div>

<div id="method-i-normalize_params" class="method-detail ">
 
 <div class="method-heading">
 normalize_params(params, name, v, depth)
 
 click to toggle source
 
 </div>

<div class="method-description">
 
 <a href="QueryParser.html#method-i-normalize_params"><code>normalize_params</code></a> recursively expands parameters into structural types. If the structural types represented by two different parameter names are in conflict, a <a href="QueryParser/ParameterTypeError.html"><code>ParameterTypeError</code></a> is raised.

<div class="method-source-code" id="normalize_params-source">
 <pre># File lib/rack/query_parser.rb, line 116
def normalize_params(params, name, v, depth)
 raise ParamsTooDeepError if depth &lt;= 0

name =~ %r(\A[\[\]]*([^\[\]]+)\]*)
 k = $1 || &#39;&#39;
 after = $&#39; || &#39;&#39;

if k.empty?
 if !v.nil? &amp;&amp; name == &quot;[]&quot;
 return Array(v)
 else
 return
 end
 end

if after == &#39;&#39;
 params[k] = v
 elsif after == &quot;[&quot;
 params[name] = v
 elsif after == &quot;[]&quot;
 params[k] ||= []
 raise ParameterTypeError, &quot;expected Array (got #{params[k].class.name}) for param `#{k}&#39;&quot; unless params[k].is_a?(Array)
 params[k] &lt;&lt; v
 elsif after =~ %r(^\[\]\[([^\[\]]+)\]$) || after =~ %r(^\[\](.+)$)
 child_key = $1
 params[k] ||= []
 raise ParameterTypeError, &quot;expected Array (got #{params[k].class.name}) for param `#{k}&#39;&quot; unless params[k].is_a?(Array)
 if params_hash_type?(params[k].last) &amp;&amp; !params_hash_has_key?(params[k].last, child_key)
 normalize_params(params[k].last, child_key, v, depth - 1)
 else
 params[k] &lt;&lt; normalize_params(make_params, child_key, v, depth - 1)
 end
 else
 params[k] ||= make_params
 raise ParameterTypeError, &quot;expected Hash (got #{params[k].class.name}) for param `#{k}&#39;&quot; unless params_hash_type?(params[k])
 params[k] = normalize_params(params[k], after, v, depth - 1)
 end

params
end</pre>
 </div>
 
 </div>

</div>

<div id="method-i-parse_nested_query" class="method-detail ">
 
 <div class="method-heading">
 parse_nested_query(qs, d = nil)
 
 click to toggle source
 
 </div>

<div class="method-description">
 
 <a href="QueryParser.html#method-i-parse_nested_query"><code>parse_nested_query</code></a> expands a query string into structural types. Supported types are Arrays, Hashes and basic value types. It is possible to supply query strings with parameters of conflicting types, in this case a <a href="QueryParser/ParameterTypeError.html"><code>ParameterTypeError</code></a> is raised. Users are encouraged to return a 400 in this case.

<div class="method-source-code" id="parse_nested_query-source">
 <pre># File lib/rack/query_parser.rb, line 97
def parse_nested_query(qs, d = nil)
 params = make_params

unless qs.nil? || qs.empty?
 check_query_string(qs, d).split(d ? (COMMON_SEP[d] || /[#{d}] */n) : DEFAULT_SEP).each do |p|
 k, v = p.split(&#39;=&#39;, 2).map! { |s| unescape(s) }

normalize_params(params, k, v, param_depth_limit)
 end
 end

return params.to_h
rescue ArgumentError =&gt; e
 raise InvalidParameterError, e.message, e.backtrace
end</pre>
 </div>
 
 </div>

</div>

<div id="method-i-parse_query" class="method-detail ">
 
 <div class="method-heading">
 parse_query(qs, d = nil, &amp;unescaper)
 
 click to toggle source
 
 </div>

<div class="method-description">
 
 Stolen from Mongrel, with some small modifications: Parses a query string by breaking it up at the &#39;&amp;&#39; and &#39;;&#39; characters. You can also use this to parse cookies by changing the characters used in the second parameter (which defaults to &#39;&amp;;&#39;).

<div class="method-source-code" id="parse_query-source">
 <pre># File lib/rack/query_parser.rb, line 69
def parse_query(qs, d = nil, &amp;unescaper)
 unescaper ||= method(:unescape)

params = make_params

check_query_string(qs, d).split(d ? (COMMON_SEP[d] || /[#{d}] */n) : DEFAULT_SEP).each do |p|
 next if p.empty?
 k, v = p.split(&#39;=&#39;, 2).map!(&amp;unescaper)

if cur = params[k]
 if cur.class == Array
 params[k] &lt;&lt; v
 else
 params[k] = [cur, v]
 end
 else
 params[k] = v
 end
 end

return params.to_h
end</pre>
 </div>
 
 </div>

</div>

</section>
 
 <section id="private-instance-5Buntitled-5D-method-details" class="method-section">
 <header>
 <h3>Private Instance Methods</h3>
 </header>

<div id="method-i-check_query_string" class="method-detail ">
 
 <div class="method-heading">
 check_query_string(qs, sep)
 
 click to toggle source
 
 </div>

<div class="method-source-code" id="check_query_string-source">
 <pre># File lib/rack/query_parser.rb, line 187
def check_query_string(qs, sep)
 if qs
 if qs.bytesize &gt; @bytesize_limit
 raise QueryLimitError, &quot;total query size exceeds limit (#{@bytesize_limit})&quot;
 end

if (param_count = qs.count(sep.is_a?(String) ? sep : &#39;&amp;;&#39;)) &gt;= @params_limit
 raise QueryLimitError, &quot;total number of query parameters (#{param_count+1}) exceeds limit (#{@params_limit})&quot;
 end

qs
 else
 &#39;&#39;
 end
end</pre>
 </div>
 
 </div>

</div>

<div id="method-i-params_hash_has_key-3F" class="method-detail ">
 
 <div class="method-heading">
 params_hash_has_key?(hash, key)
 
 click to toggle source
 
 </div>

<div class="method-source-code" id="params_hash_has_key-3F-source">
 <pre># File lib/rack/query_parser.rb, line 175
def params_hash_has_key?(hash, key)
 return false if /\[\]/.match?(key)

key.split(/[\[\]]+/).inject(hash) do |h, part|
 next h if part == &#39;&#39;
 return false unless params_hash_type?(h) &amp;&amp; h.key?(part)
 h[part]
 end

true
end</pre>
 </div>
 
 </div>

</div>

<div id="method-i-params_hash_type-3F" class="method-detail ">
 
 <div class="method-heading">
 params_hash_type?(obj)
 
 click to toggle source
 
 </div>

<div class="method-source-code" id="params_hash_type-3F-source">
 <pre># File lib/rack/query_parser.rb, line 171
def params_hash_type?(obj)
 obj.kind_of?(@params_class)
end</pre>
 </div>
 
 </div>

</div>

<div id="method-i-unescape" class="method-detail ">
 
 <div class="method-heading">
 unescape(string)
 
 click to toggle source
 
 </div>

<div class="method-source-code" id="unescape-source">
 <pre># File lib/rack/query_parser.rb, line 203
def unescape(string)
 Utils.unescape(string)
end</pre>
 </div>
 
 </div>

</div>

</section>
 
 </section>

</main>

<footer id="validator-badges" role="contentinfo">
 <a href="https://validator.w3.org/check/referer">Validate</a>
 Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.2.1.1.
 Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
</footer>

📁 Sid Gifari File Manager