libc-eventmachine 0.12.5.42

data/lib/protocols/buftok.rb

@@ -0,0 +1,127 @@
+# BufferedTokenizer - Statefully split input data by a specifiable token
+#
+# Authors:: Tony Arcieri, Martin Emde
+#
+#----------------------------------------------------------------------------
+#
+# Copyright (C) 2006-07 by Tony Arcieri and Martin Emde
+# 
+# Distributed under the Ruby license (http://www.ruby-lang.org/en/LICENSE.txt)
+#
+#---------------------------------------------------------------------------
+#
+
+# (C)2006 Tony Arcieri, Martin Emde
+# Distributed under the Ruby license (http://www.ruby-lang.org/en/LICENSE.txt)
+
+# BufferedTokenizer takes a delimiter upon instantiation, or acts line-based
+# by default.  It allows input to be spoon-fed from some outside source which
+# receives arbitrary length datagrams which may-or-may-not contain the token
+# by which entities are delimited.
+
+class BufferedTokenizer
+  # New BufferedTokenizers will operate on lines delimited by "\n" by default
+  # or allow you to specify any delimiter token you so choose, which will then
+  # be used by String#split to tokenize the input data
+  def initialize(delimiter = "\n", size_limit = nil)
+    # Store the specified delimiter
+    @delimiter = delimiter
+
+    # Store the specified size limitation
+    @size_limit = size_limit
+
+    # The input buffer is stored as an array.  This is by far the most efficient
+    # approach given language constraints (in C a linked list would be a more
+    # appropriate data structure).  Segments of input data are stored in a list
+    # which is only joined when a token is reached, substantially reducing the
+    # number of objects required for the operation.
+    @input = []
+
+    # Size of the input buffer
+    @input_size = 0
+  end
+
+  # Extract takes an arbitrary string of input data and returns an array of
+  # tokenized entities, provided there were any available to extract.  This
+  # makes for easy processing of datagrams using a pattern like:
+  #
+  #   tokenizer.extract(data).map { |entity| Decode(entity) }.each do ...
+  def extract(data)
+    # Extract token-delimited entities from the input string with the split command.
+    # There's a bit of craftiness here with the -1 parameter.  Normally split would
+    # behave no differently regardless of if the token lies at the very end of the 
+    # input buffer or not (i.e. a literal edge case)  Specifying -1 forces split to
+    # return "" in this case, meaning that the last entry in the list represents a
+    # new segment of data where the token has not been encountered
+    entities = data.split @delimiter, -1
+
+    # Check to see if the buffer has exceeded capacity, if we're imposing a limit
+    if @size_limit
+      raise 'input buffer full' if @input_size + entities.first.size > @size_limit
+      @input_size += entities.first.size
+    end
+    
+    # Move the first entry in the resulting array into the input buffer.  It represents
+    # the last segment of a token-delimited entity unless it's the only entry in the list.
+    @input << entities.shift
+
+    # If the resulting array from the split is empty, the token was not encountered
+    # (not even at the end of the buffer).  Since we've encountered no token-delimited
+    # entities this go-around, return an empty array.
+    return [] if entities.empty?
+
+    # At this point, we've hit a token, or potentially multiple tokens.  Now we can bring
+    # together all the data we've buffered from earlier calls without hitting a token,
+    # and add it to our list of discovered entities.
+    entities.unshift @input.join
+
+=begin
+	# Note added by FC, 10Jul07. This paragraph contains a regression. It breaks
+	# empty tokens. Think of the empty line that delimits an HTTP header. It will have
+	# two "\n" delimiters in a row, and this code mishandles the resulting empty token.
+	# It someone figures out how to fix the problem, we can re-enable this code branch.
+    # Multi-character token support.
+    # Split any tokens that were incomplete on the last iteration buf complete now.
+    entities.map! do |e|
+      e.split @delimiter, -1
+    end
+    # Flatten the resulting array.  This has the side effect of removing the empty
+    # entry at the end that was produced by passing -1 to split.  Add it again if
+    # necessary.
+    if (entities[-1] == [])
+      entities.flatten! << []
+    else
+      entities.flatten!
+    end
+=end
+
+    # Now that we've hit a token, joined the input buffer and added it to the entities
+    # list, we can go ahead and clear the input buffer.  All of the segments that were
+    # stored before the join can now be garbage collected.
+    @input.clear
+    
+    # The last entity in the list is not token delimited, however, thanks to the -1
+    # passed to split.  It represents the beginning of a new list of as-yet-untokenized  
+    # data, so we add it to the start of the list.
+    @input << entities.pop
+    
+    # Set the new input buffer size, provided we're keeping track
+    @input_size = @input.first.size if @size_limit
+
+    # Now we're left with the list of extracted token-delimited entities we wanted
+    # in the first place.  Hooray!
+    entities
+  end
+  
+  # Flush the contents of the input buffer, i.e. return the input buffer even though
+  # a token has not yet been encountered
+  def flush
+    buffer = @input.join
+    @input.clear
+    buffer
+  end
+
+  def empty?
+    @input.empty?
+  end
+end

data/lib/protocols/header_and_content.rb

@@ -0,0 +1,129 @@
+# $Id$
+#
+# Author:: Francis Cianfrocca (gmail: blackhedd)
+# Homepage::  http://rubyeventmachine.com
+# Date:: 15 Nov 2006
+# 
+# See EventMachine and EventMachine::Connection for documentation and
+# usage examples.
+#
+#----------------------------------------------------------------------------
+#
+# Copyright (C) 2006-07 by Francis Cianfrocca. All Rights Reserved.
+# Gmail: blackhedd
+# 
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of either: 1) the GNU General Public License
+# as published by the Free Software Foundation; either version 2 of the
+# License, or (at your option) any later version; or 2) Ruby's License.
+# 
+# See the file COPYING for complete licensing information.
+#
+#---------------------------------------------------------------------------
+#
+# 
+
+
+
+module EventMachine
+    module Protocols
+
+	# Originally, this subclassed LineAndTextProtocol, which in
+	# turn relies on BufferedTokenizer, which doesn't gracefully
+	# handle the transitions between lines and binary text.
+	# Changed 13Sep08 by FCianfrocca.
+	class HeaderAndContentProtocol < Connection
+	    include LineText2
+	
+
+	    ContentLengthPattern = /Content-length:\s*(\d+)/i
+
+	    def initialize *args
+		super
+		init_for_request
+	    end
+
+	    def receive_line line
+		case @hc_mode
+		when :discard_blanks
+		    unless line == ""
+			@hc_mode = :headers
+			receive_line line
+		    end
+		when :headers
+		    if line == ""
+			raise "unrecognized state" unless @hc_headers.length > 0
+			if respond_to?(:receive_headers)
+			    receive_headers @hc_headers
+			end
+			# @hc_content_length will be nil, not 0, if there was no content-length header.
+			if @hc_content_length.to_i > 0
+			    set_binary_mode @hc_content_length
+			else
+			    dispatch_request
+			end
+		    else
+			@hc_headers << line
+			if ContentLengthPattern =~ line
+			    # There are some attacks that rely on sending multiple content-length
+			    # headers. This is a crude protection, but needs to become tunable.
+			    raise "extraneous content-length header" if @hc_content_length
+			    @hc_content_length = $1.to_i
+			end
+			if @hc_headers.length == 1 and respond_to?(:receive_first_header_line)
+			    receive_first_header_line line
+			end
+		    end
+		else
+		    raise "internal error, unsupported mode"
+		end
+	    end
+
+	    def receive_binary_data text
+		@hc_content = text
+		dispatch_request
+	    end
+
+	    def dispatch_request
+		if respond_to?(:receive_request)
+		    receive_request @hc_headers, @hc_content
+		end
+		init_for_request
+	    end
+	    private :dispatch_request
+
+	    def init_for_request
+		@hc_mode = :discard_blanks
+		@hc_headers = []
+		# originally was @hc_headers ||= []; @hc_headers.clear to get a performance
+		# boost, but it's counterproductive because a subclassed handler will have to
+		# call dup to use the header array we pass in receive_headers.
+
+		@hc_content_length = nil
+		@hc_content = ""
+	    end
+	    private :init_for_request
+
+	    # Basically a convenience method. We might create a subclass that does this
+	    # automatically. But it's such a performance killer.
+	    def headers_2_hash hdrs
+		self.class.headers_2_hash hdrs
+	    end
+
+	    class << self
+		def headers_2_hash hdrs
+		    hash = {}
+		    hdrs.each {|h|
+			if /\A([^\s:]+)\s*:\s*/ =~ h
+			    tail = $'.dup
+			    hash[ $1.downcase.gsub(/-/,"_").intern ] = tail
+			end
+		    }
+		    hash
+		end
+	    end
+
+	end
+    end
+end
+