mongrel2 0.24.0 → 0.25.0.pre.285

data/ChangeLog

@@ -1,9 +1,61 @@
+2012-06-20  Michael Granger  <ged@FaerieMUD.org>
+
+	* examples/async-upload.rb, examples/config.rb,
+	lib/mongrel2/httprequest.rb, lib/mongrel2/request.rb,
+	lib/mongrel2/testing.rb, spec/mongrel2/httprequest_spec.rb,
+	spec/mongrel2/request_spec.rb:
+	Hook up the async uploaded entity body to the request
+	[349c0049a4a1] [tip]
+
+2012-06-19  Michael Granger  <ged@FaerieMUD.org>
+
+	* examples/Procfile, examples/async-upload.rb, examples/config.rb,
+	examples/ws-echo.rb, lib/mongrel2/websocket.rb,
+	spec/mongrel2/websocket_spec.rb:
+	Fixes for the websocket frame class for the stream API, fixed some
+	examples.
+	[4202d9942c16]
+
+	* lib/mongrel2/connection.rb, lib/mongrel2/httpresponse.rb,
+	lib/mongrel2/request.rb, lib/mongrel2/response.rb,
+	lib/mongrel2/websocket.rb, spec/mongrel2/httpresponse_spec.rb,
+	spec/mongrel2/response_spec.rb, spec/mongrel2/websocket_spec.rb:
+	Convert to an IO-based request/response body
+	[96edda5cdb69]
+
+2012-06-08  Mahlon E. Smith  <mahlon@martini.nu>
+
+	* lib/mongrel2/constants.rb:
+	Add a few newer-rfc HTTP error codes.
+	[8e125eaf25ce]
+
+2012-05-31  Michael Granger  <ged@FaerieMUD.org>
+
+	* .hgtags:
+	Added tag v0.24.0 for changeset d2b1df5fc74d
+	[dbe3504c63ad]
+
+	* .hgsigs:
+	Added signature for changeset 3ed1175a2f9e
+	[d2b1df5fc74d] [v0.24.0]
+
+	* History.rdoc, lib/mongrel2.rb:
+	Bumping minor version, updating history.
+	[3ed1175a2f9e]
+
+2012-05-29  Mahlon E. Smith  <mahlon@martini.nu>
+
+	* lib/mongrel2/table.rb:
+	Take immediate objects into account when dup/cloning a
+	Mongrel2::Table.
+	[f10cba1487ea]
+
 2012-05-20  Michael Granger  <ged@FaerieMUD.org>
 
 	* .rvm.gems:
 	Comment out amalgalite rvmrc gem until
 	https://github.com/copiousfreetime/amalgalite/pull/22 is fixed
-	[b872e092ed92] [tip]
+	[b872e092ed92]
 
 2012-05-21  Michael Granger  <ged@FaerieMUD.org>
 

data/History.rdoc

@@ -1,3 +1,17 @@
+== v0.25.0 [2012-06-20] Michael Granger <ged@FaerieMUD.org>
+
+NOTE: This revision contains non-backward-compatible changes to
+Mongrel2::Request, Mongrel2::Response, and all subclasses.
+
+- Convert request and response entity bodies to IOish objects instead of
+  Strings.
+- Finished implementation of Mongrel2 async upload API -- async-uploaded
+  entity bodies now become File entity bodies of the
+  "X-Mongrel2-Upload-Done" request.
+- Add a few newer-rfc HTTP error codes.
+- Add support for Content-type charsets.
+
+
 == v0.24.0 [2012-05-31] Michael Granger <ged@FaerieMUD.org>
 
 - Fix a bug when duping a Mongrel2::Table with immediate objects as values.

data/examples/Procfile

@@ -3,4 +3,4 @@ mongrel2: ruby ../bin/m2sh.rb -c examples.sqlite start
 helloworld: ruby helloworld-handler.rb
 async_upload: ruby async-upload.rb
 request_dumper: ruby request-dumper.rb
-
+ws: ruby ws-echo.rb

data/examples/async-upload.rb

@@ -8,6 +8,9 @@ require 'mongrel2/handler'
 # A example of how to allow Mongrel2's async uploads.
 class AsyncUploadHandler < Mongrel2::Handler
 
+	# App ID
+	ID = 'async-upload'
+
 	### Load up the ERB template from the DATA section on instantiation.
 	def initialize( * )
 		super
@@ -35,7 +38,7 @@ class AsyncUploadHandler < Mongrel2::Handler
 			[ request.uploaded_file, request.content_length, request.content_type ]
 
 		response = request.response
-		response.puts "Upload complete: %s" % [ request.uploaded_file ]
+		response.puts "Upload complete: %p" % [ request.uploaded_file ]
 		response.content_type = 'text/plain'
 
 		return response

data/examples/config.rb

@@ -45,9 +45,10 @@ server 'examples' do
 
 end
 
-setting "zeromq.threads", 1
-setting "limits.content_length", 4096
-setting "upload.temp_store", upload_dir + 'mongrel2.upload.XXXXXX'
+setting 'zeromq.threads', 1
+setting 'limits.content_length', 4096
+setting 'control_port', 'ipc://var/run/control'
+setting 'upload.temp_store', upload_dir + 'mongrel2.upload.XXXXXX'
 
 mkdir_p 'var/run'
 mkdir_p 'logs'

data/examples/request-dumper.rb

@@ -17,6 +17,7 @@ class RequestDumper < Mongrel2::Handler
 	def initialize( * )
 		super
 		@template = Inversion::Template.load( 'request-dumper.tmpl' )
+		$SAFE = 1
 	end
 
 

data/examples/request-dumper.tmpl

@@ -20,7 +20,7 @@
   </header>
 
   <section id="dump">
-		
+
 		<table>
 			<tr>
 				<th>Sender ID</th>
@@ -35,7 +35,7 @@
 				<td><?attr safelevel ?></td>
 			</tr>
 		</table>
-		
+
 		<section id="headers">
 			<header>
 				<h1>Headers</h1>
@@ -49,13 +49,14 @@
 				<?end for ?>
 			</table>
 		</section>
-		
+
 		<section id="body">
 			<header>
 				<h1>Body</h1>
 			</header>
 
-			<p><code><?escape request.body.dump ?></code></p>
+			<p><code><?escape request.body.inspect ?></code>
+				 (<?call "%0.2fKb" % request.body.size ?>, <?call request.body.external_encoding.name ?>)</p>
 		</section>
 
 		<section id="inspect">
@@ -66,7 +67,7 @@
 				</pre>
 			</header>
 		</section>
-		
+
   </section>
 
   <footer>

data/examples/ws-echo.rb

@@ -4,7 +4,6 @@
 require 'loggability'
 require 'pathname'
 require 'mongrel2/config'
-require 'mongrel2/logging'
 require 'mongrel2/handler'
 
 
@@ -99,8 +98,9 @@ class WebSocketEchoServer < Mongrel2::Handler
 			frame.opcode.to_s.upcase,
 			frame.fin? ? '' : '(cont)',
 			frame.headers.x_forwarded_for,
-			frame.payload[ 0, 20 ],
+			frame.payload.read( 20 ),
 		]
+		frame.payload.rewind
 
 		# If a client sends an invalid frame, close their connection, but politely.
 		if !frame.valid?
@@ -130,7 +130,7 @@ class WebSocketEchoServer < Mongrel2::Handler
 		# Make the response frame
 		response = frame.response
 		response.fin = frame.fin?
-		response.payload = frame.payload
+		IO.copy_stream( frame.payload, response.payload )
 
 		return response
 	end

data/lib/mongrel2.rb

@@ -20,10 +20,10 @@ module Mongrel2
 	abort "\n\n>>> Mongrel2 requires Ruby 1.9.2 or later. <<<\n\n" if RUBY_VERSION < '1.9.2'
 
 	# Library version constant
-	VERSION = '0.24.0'
+	VERSION = '0.25.0'
 
 	# Version-control revision constant
-	REVISION = %q$Revision: 3ed1175a2f9e $
+	REVISION = %q$Revision: 928743f397cc $
 
 
 	require 'mongrel2/constants'

data/lib/mongrel2/connection.rb

@@ -105,7 +105,7 @@ class Mongrel2::Connection
 
 		self.log.debug "Fetching next request (PULL)"
 		data = self.request_sock.recv
-		self.log.debug "  got request data: %p" % [ data ]
+		self.log.debug "  got %s request data: %p" % [ data.encoding.name, data ]
 		return data
 	end
 
@@ -131,7 +131,9 @@ class Mongrel2::Connection
 
 	### Write the specified +response+ (Mongrel::Response object) to the requester.
 	def reply( response )
-		self.send( response.sender_id, response.conn_id, response.to_s )
+		response.each_chunk do |data|
+			self.send( response.sender_id, response.conn_id, data )
+		end
 	end
 
 

data/lib/mongrel2/constants.rb

@@ -65,6 +65,10 @@ module Mongrel2::Constants
 		UNPROCESSABLE_ENTITY          = 422
 		LOCKED                        = 423
 		FAILED_DEPENDENCY             = 424
+		UPGRADE_REQUIRED              = 426
+		RECONDITION_REQUIRED          = 428
+		TOO_MANY_REQUESTS             = 429
+		REQUEST_HEADERS_TOO_LARGE     = 431
 
 		SERVER_ERROR                  = 500
 		NOT_IMPLEMENTED               = 501
@@ -140,6 +144,9 @@ module Mongrel2::Constants
 		    424 => "Failed Dependency",
 		    425 => "No code",
 		    426 => "Upgrade Required",
+		    428 => "Precondition Required",
+		    429 => "Too Many Requests",
+		    431 => "Request Headers too Large",
 		    500 => "Internal Server Error",
 		    501 => "Method Not Implemented",
 		    502 => "Bad Gateway",

data/lib/mongrel2/httprequest.rb

@@ -100,48 +100,6 @@ class Mongrel2::HTTPRequest < Mongrel2::Request
 	end
 
 
-	#
-	# :section: Async Upload Support
-	# See http://mongrel2.org/static/book-finalch6.html#x8-810005.5 for details.
-	#
-
-	### The Pathname, relative to Mongrel2's chroot path, of the uploaded entity body.
-	def uploaded_file
-		raise Mongrel2::UploadError, "invalid upload: upload headers don't match" unless
-			self.upload_headers_match?
-		return Pathname( self.headers.x_mongrel2_upload_done )
-	end
-
-
-	### Returns +true+ if this request is an 'asynchronous upload started' notification.
-	def upload_started?
-		return self.headers.member?( :x_mongrel2_upload_start ) &&
-		       !self.headers.member?( :x_mongrel2_upload_done )
-	end
-
-
-	### Returns +true+ if this request is an 'asynchronous upload done' notification.
-	def upload_done?
-		return self.headers.member?( :x_mongrel2_upload_start ) &&
-		       self.headers.member?( :x_mongrel2_upload_done )
-	end
-
-
-	### Returns +true+ if this request is an 'asynchronous upload done' notification
-	### and the two headers match (trivial guard against forgery)
-	def upload_headers_match?
-		return self.upload_done? &&
-		       self.headers.x_mongrel2_upload_start == self.headers.x_mongrel2_upload_done
-	end
-
-
-	### Returns true if this request is an asynchronous upload, and the filename of the
-	### finished request matches the one from the starting notification.
-	def valid_upload?
-		return self.upload_done? && self.upload_headers_match?
-	end
-
-
 	#########
 	protected
 	#########

data/lib/mongrel2/httpresponse.rb

@@ -37,7 +37,7 @@ class Mongrel2::HTTPResponse < Mongrel2::Response
 
 		@headers = Mongrel2::Table.new
 		@status = nil
-		self.reset
+		self.set_defaults
 
 		@headers.merge!( headers )
 	end
@@ -55,12 +55,18 @@ class Mongrel2::HTTPResponse < Mongrel2::Response
 	attr_accessor :status
 
 
+	### Set up response default headers, etc.
+	def set_defaults
+		@headers[:server] = Mongrel2.version_string( true )
+	end
+
+
 	### Stringify the response
 	def to_s
 		return [
 			self.status_line,
 			self.header_data,
-			self.bodiless? ? '' : self.body
+			self.bodiless? ? '' : super
 		].join( "\r\n" )
 	end
 
@@ -69,8 +75,8 @@ class Mongrel2::HTTPResponse < Mongrel2::Response
 	def status_line
 		self.log.debug "Building status line for status: %p" % [ self.status ]
 
-		st = self.status ||
-		     ((self.body.nil? || self.body.empty?) ? HTTP::NO_CONTENT : HTTP::OK)
+		st = self.status || (self.body.size.zero? ? HTTP::NO_CONTENT : HTTP::OK)
+
 		return STATUS_LINE_FORMAT % [ st, HTTP::STATUS_NAME[st] ]
 	end
 
@@ -141,9 +147,10 @@ class Mongrel2::HTTPResponse < Mongrel2::Response
 	### Clear any existing headers and body and restore them to their defaults
 	def reset
 		@headers.clear
-		@headers[:server] = Mongrel2.version_string( true )
+		@body.truncate( 0 )
 		@status = nil
-		@body = ''
+
+		self.set_defaults
 
 		return true
 	end
@@ -174,25 +181,15 @@ class Mongrel2::HTTPResponse < Mongrel2::Response
 	end
 
 
-	### Get the length of the body, either by calling its #length method if it has
-	### one, or using #seek and #tell if it implements those. If neither of those are
-	### possible, an exception is raised.
+	### Get the length of the body IO. If the IO's offset is somewhere other than
+	### the beginning or end, the size of the remainder is used.
 	def get_content_length
 		if self.bodiless?
 			return 0
-		elsif self.body.respond_to?( :bytesize )
-			return self.body.bytesize
-		elsif self.body.respond_to?( :seek ) && self.body.respond_to?( :tell )
-			starting_pos = self.body.tell
-			self.body.seek( 0, IO::SEEK_END )
-			length = self.body.tell - starting_pos
-			self.body.seek( starting_pos, IO::SEEK_SET )
-
-			return length
+		elsif self.body.pos.nonzero? && !self.body.eof?
+			return self.body.size - self.body.pos
 		else
-			raise Mongrel2::ResponseError,
-				"No way to calculate the content length of the response (a %s)." %
-				[ self.body.class.name ]
+			return self.body.size
 		end
 	end
 
@@ -219,10 +216,11 @@ class Mongrel2::HTTPResponse < Mongrel2::Response
 
 	### Return the details to include in the contents of the #inspected object.
 	def inspect_details
-		return %Q{%s -- %d headers, %0.2fK body} % [
+		return %Q{%s -- %d headers, %0.2fK body (%p)} % [
 			self.status_line,
 			self.headers.length,
 			(self.get_content_length / 1024.0),
+			self.body,
 		]
 	end
 

data/lib/mongrel2/request.rb

@@ -1,5 +1,6 @@
 #!/usr/bin/ruby
 
+require 'stringio'
 require 'tnetstring'
 require 'yajl'
 require 'loggability'
@@ -110,13 +111,14 @@ class Mongrel2::Request
 	### and +body+. The optional +nil+ is for the raw request content, which can be useful
 	### later for debugging.
 	def initialize( sender_id, conn_id, path, headers, body='', raw=nil )
+
 		@sender_id = sender_id
 		@conn_id   = Integer( conn_id )
 		@path      = path
 		@headers   = Mongrel2::Table.new( headers )
-		@body      = body
 		@raw       = raw
 
+		@body      = self.make_entity_body( body )
 		@response  = nil
 	end
 
@@ -131,7 +133,7 @@ class Mongrel2::Request
 	# The listener ID on the server
 	attr_reader :conn_id
 
-	# The path component of the requested URL in HTTP, or the equivalent 
+	# The path component of the requested URL in HTTP, or the equivalent
 	# for other request types
 	attr_reader :path
 
@@ -139,7 +141,7 @@ class Mongrel2::Request
 	attr_reader :headers
 	alias_method :header, :headers
 
-	# The request body data, if there is any, as a String
+	# The request body data, if there is any, as an IO object
 	attr_reader :body
 
 	# The raw request content, if the request was parsed from mongrel2
@@ -161,6 +163,69 @@ class Mongrel2::Request
 	end
 
 
+	#
+	# :section: Async Upload Support
+	# See http://mongrel2.org/static/book-finalch6.html#x8-810005.5 for details.
+	#
+
+	### The Pathname, relative to Mongrel2's chroot path, of the uploaded entity body.
+	def uploaded_file
+		raise Mongrel2::UploadError, "invalid upload: upload headers don't match" unless
+			self.upload_headers_match?
+
+		server = Mongrel2::Config::Server.by_uuid( self.sender_id ).first or
+			raise Mongrel2::UploadError, "couldn't find the server %p in the config DB" %
+			[ self.sender_id ]
+
+		relpath = Pathname( self.headers.x_mongrel2_upload_done )
+		chrooted = Pathname( server.chroot ) + relpath
+
+		if chrooted.exist?
+			return chrooted
+		elsif relpath.exist?
+			return relpath
+		else
+			self.log.error "uploaded body %s not found: tried relative to cwd and server chroot (%s)" %
+				[ relpath, server.chroot ]
+			raise Mongrel2::UploadError,
+				"couldn't find the path to uploaded body."
+		end
+	end
+
+
+	### Returns +true+ if this request is an 'asynchronous upload started' notification.
+	def upload_started?
+		return self.headers.member?( :x_mongrel2_upload_start ) &&
+		       !self.headers.member?( :x_mongrel2_upload_done )
+	end
+
+
+	### Returns +true+ if this request is an 'asynchronous upload done' notification.
+	def upload_done?
+		return self.headers.member?( :x_mongrel2_upload_start ) &&
+		       self.headers.member?( :x_mongrel2_upload_done )
+	end
+
+
+	### Returns +true+ if this request is an 'asynchronous upload done' notification
+	### and the two headers match (trivial guard against forgery)
+	def upload_headers_match?
+		return self.upload_done? &&
+		       self.headers.x_mongrel2_upload_start == self.headers.x_mongrel2_upload_done
+	end
+
+
+	### Returns true if this request is an asynchronous upload, and the filename of the
+	### finished request matches the one from the starting notification.
+	def valid_upload?
+		return self.upload_done? && self.upload_headers_match?
+	end
+
+
+	#
+	# :section: Introspection Methods
+	#
+
 	### Returns a string containing a human-readable representation of the Request,
 	### suitable for debugging.
 	def inspect
@@ -178,6 +243,35 @@ class Mongrel2::Request
 	protected
 	#########
 
+	### Convert the entity +body+ into an IOish object, wrapping it in a StringIO if
+	### it doesn't already respond to :read, :pos, and :seek. If the request has
+	### valid 'X-Mongrel2-Upload-*' headers (the async upload API), a File object
+	### opened to the spool file will be returned instead.
+	def make_entity_body( body )
+		# :TODO: Handle Content-Encoding, too.
+
+		enc = self.headers.content_type[ /\bcharset=(\S+)/, 1 ] if self.headers.content_type
+
+		if self.valid_upload?
+			enc ||= Encoding::ASCII_8BIT
+			spoolfile = self.uploaded_file
+			self.log.info "Using async %s spool file %s as request entity body." % [ enc, spoolfile ]
+			return spoolfile.open( 'r', encoding: enc )
+
+		elsif !( body.respond_to?(:read) && body.respond_to?(:pos) && body.respond_to?(:seek) )
+			self.log.info "Wrapping non-IO (%p) body in a StringIO" % [ body.class ]
+
+			# Get the object as a String, set the encoding
+			str = body.to_s
+			str.force_encoding( enc ) if enc && str.encoding == Encoding::ASCII_8BIT
+
+			return StringIO.new( str, 'r+' )
+		else
+			return body
+		end
+	end
+
+
 	### Return the details to include in the contents of the #inspected object. This
 	### method allows other request types to provide their own details while keeping
 	### the form somewhat consistent.