Last Piece Hacktivist Crew

Editing: Parser.html

<!DOCTYPE html>

<title>class Rack::Multipart::Parser - 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-new">::new</a>
 
 <li ><a href="#method-c-parse">::parse</a>
 
 <li ><a href="#method-c-parse_boundary">::parse_boundary</a>
 
 <li ><a href="#method-i-consume_boundary">#consume_boundary</a>
 
 <li ><a href="#method-i-full_boundary">#full_boundary</a>
 
 <li ><a href="#method-i-get_filename">#get_filename</a>
 
 <li ><a href="#method-i-handle_consume_token">#handle_consume_token</a>
 
 <li ><a href="#method-i-handle_empty_content-21">#handle_empty_content!</a>
 
 <li ><a href="#method-i-handle_fast_forward">#handle_fast_forward</a>
 
 <li ><a href="#method-i-handle_mime_body">#handle_mime_body</a>
 
 <li ><a href="#method-i-handle_mime_head">#handle_mime_head</a>
 
 <li ><a href="#method-i-on_read">#on_read</a>
 
 <li ><a href="#method-i-result">#result</a>
 
 <li ><a href="#method-i-run_parser">#run_parser</a>
 
 <li ><a href="#method-i-tag_multipart_encoding">#tag_multipart_encoding</a>
 
 <li ><a href="#method-i-update_retained_size">#update_retained_size</a>
 
 </ul>
</div>

</div>
</nav>

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

<section class="constants-list">
 <header>
 <h3>Constants</h3>
 </header>
 <dl>
 
 <dt id="BOUNDARY_REGEX">BOUNDARY_REGEX
 
 <dd>
 
 
 <dt id="BOUNDARY_START_LIMIT">BOUNDARY_START_LIMIT
 
 <dd>
 
 
 <dt id="BUFFERED_UPLOAD_BYTESIZE_LIMIT">BUFFERED_UPLOAD_BYTESIZE_LIMIT
 
 <dd>
 
 
 <dt id="BUFSIZE">BUFSIZE
 
 <dd>
 
 
 <dt id="CHARSET">CHARSET
 
 <dd>
 
 
 <dt id="EMPTY">EMPTY
 
 <dd>
 
 
 <dt id="MIME_HEADER_BYTESIZE_LIMIT">MIME_HEADER_BYTESIZE_LIMIT
 
 <dd>
 
 
 <dt id="MultipartInfo">MultipartInfo
 
 <dd>
 
 
 <dt id="PARSER_BYTESIZE_LIMIT">PARSER_BYTESIZE_LIMIT
 
 <dd>
 
 
 <dt id="TEMPFILE_FACTORY">TEMPFILE_FACTORY
 
 <dd>
 
 
 <dt id="TEXT_PLAIN">TEXT_PLAIN
 
 <dd>
 
 
 </dl>
 </section>

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

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

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

<div id="method-c-new" class="method-detail ">
 
 <div class="method-heading">
 new(boundary, tempfile, bufsize, query_parser)
 
 click to toggle source
 
 </div>

<div class="method-source-code" id="new-source">
 <pre># File lib/rack/multipart/parser.rb, line 217
def initialize(boundary, tempfile, bufsize, query_parser)
 @query_parser = query_parser
 @params = query_parser.make_params
 @boundary = &quot;--#{boundary}&quot;
 @bufsize = bufsize

@full_boundary = @boundary
 @end_boundary = @boundary + &#39;--&#39;
 @state = :FAST_FORWARD
 @mime_index = 0
 @body_retained = nil
 @retained_size = 0
 @total_bytes_read = (0 if PARSER_BYTESIZE_LIMIT)
 @collector = Collector.new tempfile

@sbuf = StringScanner.new(&quot;&quot;.dup)
 @body_regex = /(?:#{EOL})?#{Regexp.quote(@boundary)}(?:#{EOL}|--)/m
 @end_boundary_size = boundary.bytesize + 6 # (-- at start, -- at finish, EOL at end)
 @rx_max_size = EOL.size + @boundary.bytesize + [EOL.size, &#39;--&#39;.size].max
 @head_regex = /(.*?#{EOL})#{EOL}/m
end</pre>
 </div>
 
 </div>

</div>

<div id="method-c-parse" class="method-detail ">
 
 <div class="method-heading">
 parse(io, content_length, content_type, tmpfile, bufsize, qp)
 
 click to toggle source
 
 </div>

<div class="method-source-code" id="parse-source">
 <pre># File lib/rack/multipart/parser.rb, line 99
def self.parse(io, content_length, content_type, tmpfile, bufsize, qp)
 return EMPTY if 0 == content_length

boundary = parse_boundary content_type
 return EMPTY unless boundary

if PARSER_BYTESIZE_LIMIT &amp;&amp; content_length &amp;&amp; content_length &gt; PARSER_BYTESIZE_LIMIT
 raise EOFError, &quot;multipart Content-Length #{content_length} exceeds limit of #{PARSER_BYTESIZE_LIMIT} bytes&quot;
 end

io = BoundedIO.new(io, content_length) if content_length
 outbuf = String.new

parser = new(boundary, tmpfile, bufsize, qp)
 parser.on_read io.read(bufsize, outbuf)

loop do
 break if parser.state == :DONE
 parser.on_read io.read(bufsize, outbuf)
 end

io.rewind
 parser.result
end</pre>
 </div>
 
 </div>

</div>

<div id="method-c-parse_boundary" class="method-detail ">
 
 <div class="method-heading">
 parse_boundary(content_type)
 
 click to toggle source
 
 </div>

<div class="method-source-code" id="parse_boundary-source">
 <pre># File lib/rack/multipart/parser.rb, line 84
def self.parse_boundary(content_type)
 return unless content_type
 data = content_type.match(MULTIPART)
 return unless data

unless data[1].empty?
 raise EOFError, &quot;whitespace between boundary parameter name and equal sign&quot;
 end
 if data.post_match =~ /boundary\s*=/i
 raise EOFError, &quot;multiple boundary parameters found in multipart content type&quot;
 end

data[2]
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-on_read" class="method-detail ">
 
 <div class="method-heading">
 on_read(content)
 
 click to toggle source
 
 </div>

<div class="method-source-code" id="on_read-source">
 <pre># File lib/rack/multipart/parser.rb, line 239
def on_read(content)
 handle_empty_content!(content)
 if @total_bytes_read
 @total_bytes_read += content.bytesize
 if @total_bytes_read &gt; PARSER_BYTESIZE_LIMIT
 raise EOFError, &quot;multipart upload exceeds limit of #{PARSER_BYTESIZE_LIMIT} bytes&quot;
 end
 end
 @sbuf.concat content
 run_parser
end</pre>
 </div>
 
 </div>

</div>

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

<div class="method-source-code" id="result-source">
 <pre># File lib/rack/multipart/parser.rb, line 251
def result
 @collector.each do |part|
 part.get_data do |data|
 tag_multipart_encoding(part.filename, part.content_type, part.name, data)
 @query_parser.normalize_params(@params, part.name, data, @query_parser.param_depth_limit)
 end
 end
 MultipartInfo.new @params.to_params_hash, @collector.find_all(&amp;:file?).map(&amp;:body)
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-consume_boundary" class="method-detail ">
 
 <div class="method-heading">
 consume_boundary()
 
 click to toggle source
 
 </div>

<div class="method-description">
 
 Scan until the we find the start or end of the boundary. If we find it, return the appropriate symbol for the start or end of the boundary. If we don&#39;t find the start or end of the boundary, clear the buffer and return nil.

<div class="method-source-code" id="consume_boundary-source">
 <pre># File lib/rack/multipart/parser.rb, line 381
def consume_boundary
 while read_buffer = @sbuf.scan_until(BOUNDARY_REGEX)
 case read_buffer.strip
 when full_boundary then return :BOUNDARY
 when @end_boundary then return :END_BOUNDARY
 end
 return if @sbuf.eos?
 end
end</pre>
 </div>
 
 </div>

</div>

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

<div class="method-source-code" id="full_boundary-source">
 <pre># File lib/rack/multipart/parser.rb, line 368
def full_boundary; @full_boundary; end</pre>
 </div>
 
 </div>

</div>

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

<div class="method-source-code" id="get_filename-source">
 <pre># File lib/rack/multipart/parser.rb, line 391
def get_filename(head)
 filename = nil
 case head
 when RFC2183
 params = Hash[*head.scan(DISPPARM).flat_map(&amp;:compact)]

if filename = params[&#39;filename&#39;]
 filename = $1 if filename =~ /^&quot;(.*)&quot;$/
 elsif filename = params[&#39;filename*&#39;]
 encoding, _, filename = filename.split(&quot;&#39;&quot;, 3)
 end
 when BROKEN
 filename = $1
 filename = $1 if filename =~ /^&quot;(.*)&quot;$/
 end

return unless filename

if filename.scan(/%.?.?/).all? { |s| /%[0-9a-fA-F]{2}/.match?(s) }
 filename = Utils.unescape_path(filename)
 end

filename.scrub!

if filename !~ /\\[^\\&quot;]/
 filename = filename.gsub(/\\(.)/, &#39;\1&#39;)
 end

if encoding
 filename.force_encoding ::Encoding.find(encoding)
 end

filename
end</pre>
 </div>
 
 </div>

</div>

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

<div class="method-source-code" id="handle_consume_token-source">
 <pre># File lib/rack/multipart/parser.rb, line 300
def handle_consume_token
 tok = consume_boundary
 # break if we&#39;re at the end of a buffer, but not if it is the end of a field
 @state = if tok == :END_BOUNDARY || (@sbuf.eos? &amp;&amp; tok != :BOUNDARY)
 :DONE
 else
 :MIME_HEAD
 end
end</pre>
 </div>
 
 </div>

</div>

<div id="method-i-handle_empty_content-21" class="method-detail ">
 
 <div class="method-heading">
 handle_empty_content!(content)
 
 click to toggle source
 
 </div>

<div class="method-source-code" id="handle_empty_content-21-source">
 <pre># File lib/rack/multipart/parser.rb, line 456
def handle_empty_content!(content)
 if content.nil? || content.empty?
 raise EOFError
 end
end</pre>
 </div>
 
 </div>

</div>

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

<div class="method-source-code" id="handle_fast_forward-source">
 <pre># File lib/rack/multipart/parser.rb, line 280
def handle_fast_forward
 tok = consume_boundary

if tok == :END_BOUNDARY &amp;&amp; @sbuf.pos == @end_boundary_size &amp;&amp; @sbuf.eos?
 # stop parsing a buffer if a buffer is only an end boundary.
 @state = :DONE
 elsif tok
 @state = :MIME_HEAD
 else
 raise EOFError, &quot;bad content body&quot; if @sbuf.rest_size &gt;= @bufsize

# We raise if we don&#39;t find the multipart boundary, to avoid unbounded memory
 # buffering. Note that the actual limit is the higher of 16KB and the buffer size (1MB by default)
 raise EOFError, &quot;multipart boundary not found within limit&quot; if @sbuf.string.bytesize &gt; BOUNDARY_START_LIMIT

# no boundary found, keep reading data
 return :want_read
 end
end</pre>
 </div>
 
 </div>

</div>

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

<div class="method-source-code" id="handle_mime_body-source">
 <pre># File lib/rack/multipart/parser.rb, line 346
def handle_mime_body
 if (body_with_boundary = @sbuf.check_until(@body_regex)) # check but do not advance the pointer yet
 body = body_with_boundary.sub(/#{@body_regex}\z/m, &#39;&#39;) # remove the boundary from the string
 update_retained_size(body.bytesize) if @body_retained
 @collector.on_mime_body @mime_index, body
 @sbuf.pos += body.length + 2 # skip \r\n after the content
 @state = :CONSUME_TOKEN
 @mime_index += 1
 else
 # Save what we have so far
 if @rx_max_size &lt; @sbuf.rest_size
 delta = @sbuf.rest_size - @rx_max_size
 body = @sbuf.peek(delta)
 update_retained_size(body.bytesize) if @body_retained
 @collector.on_mime_body @mime_index, body
 @sbuf.pos += delta
 @sbuf.string = @sbuf.rest
 end
 :want_read
 end
end</pre>
 </div>
 
 </div>

</div>

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

<div class="method-source-code" id="handle_mime_head-source">
 <pre># File lib/rack/multipart/parser.rb, line 310
def handle_mime_head
 if @sbuf.scan_until(@head_regex)
 head = @sbuf[1]
 content_type = head[MULTIPART_CONTENT_TYPE, 1]
 if name = head[MULTIPART_CONTENT_DISPOSITION, 1]
 name = Rack::Auth::Digest::Params::dequote(name)
 else
 name = head[MULTIPART_CONTENT_ID, 1]
 end

filename = get_filename(head)

if name.nil? || name.empty?
 name = filename || &quot;#{content_type || TEXT_PLAIN}[]&quot;.dup
 end

# Mime part head data is retained for both TempfilePart and BufferPart
 # for the entireity of the parse, even though it isn&#39;t used for BufferPart.
 update_retained_size(head.bytesize)

# If a filename is given, a TempfilePart will be used, so the body will
 # not be buffered in memory. However, if a filename is not given, a BufferPart
 # will be used, and the body will be buffered in memory.
 @body_retained = !filename

@collector.on_mime_head @mime_index, head, filename, content_type, name
 @state = :MIME_BODY
 else
 # We raise if the mime part header is too large, to avoid unbounded memory
 # buffering. Note that the actual limit is the higher of 64KB and the buffer size (1MB by default)
 raise EOFError, &quot;multipart mime part header too large&quot; if @sbuf.rest.bytesize &gt; MIME_HEADER_BYTESIZE_LIMIT

return :want_read
 end
end</pre>
 </div>
 
 </div>

</div>

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

<div class="method-source-code" id="run_parser-source">
 <pre># File lib/rack/multipart/parser.rb, line 263
def run_parser
 loop do
 case @state
 when :FAST_FORWARD
 break if handle_fast_forward == :want_read
 when :CONSUME_TOKEN
 break if handle_consume_token == :want_read
 when :MIME_HEAD
 break if handle_mime_head == :want_read
 when :MIME_BODY
 break if handle_mime_body == :want_read
 when :DONE
 break
 end
 end
end</pre>
 </div>
 
 </div>

</div>

<div id="method-i-tag_multipart_encoding" class="method-detail ">
 
 <div class="method-heading">
 tag_multipart_encoding(filename, content_type, name, body)
 
 click to toggle source
 
 </div>

<div class="method-source-code" id="tag_multipart_encoding-source">
 <pre># File lib/rack/multipart/parser.rb, line 428
def tag_multipart_encoding(filename, content_type, name, body)
 name = name.to_s
 encoding = Encoding::UTF_8

name.force_encoding(encoding)

return if filename

if content_type
 list = content_type.split(&#39;;&#39;)
 type_subtype = list.first
 type_subtype.strip!
 if TEXT_PLAIN == type_subtype
 rest = list.drop 1
 rest.each do |param|
 k, v = param.split(&#39;=&#39;, 2)
 k.strip!
 v.strip!
 v = v[1..-2] if v.start_with?(&#39;&quot;&#39;) &amp;&amp; v.end_with?(&#39;&quot;&#39;)
 encoding = Encoding.find v if k == CHARSET
 end
 end
 end

name.force_encoding(encoding)
 body.force_encoding(encoding)
end</pre>
 </div>
 
 </div>

</div>

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

<div class="method-source-code" id="update_retained_size-source">
 <pre># File lib/rack/multipart/parser.rb, line 370
def update_retained_size(size)
 @retained_size += size
 if @retained_size &gt; BUFFERED_UPLOAD_BYTESIZE_LIMIT
 raise EOFError, &quot;multipart data over retained size limit&quot;
 end
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>

Cancel