passenger 2.2.15 → 3.0.0.pre1

data/lib/phusion_passenger/exceptions.rb

@@ -1,5 +1,5 @@
 #  Phusion Passenger - http://www.modrails.com/
-#  Copyright (c) 2008, 2009 Phusion
+#  Copyright (c) 2010 Phusion
 #
 #  "Phusion Passenger" is a trademark of Hongli Lai & Ninh Bui.
 #
@@ -51,8 +51,8 @@ class InitializationError < StandardError
 	end
 end
 
-# Raised when Rack::ApplicationSpawner, Railz::ApplicationSpawner,
-# Railz::FrameworkSpawner or SpawnManager was unable to spawn an application,
+# Raised when Rack::ApplicationSpawner, ClassicRails::ApplicationSpawner,
+# ClassicRails::FrameworkSpawner or SpawnManager was unable to spawn an application,
 # because the application either threw an exception or called exit.
 #
 # If the application called exit, then +child_exception+ is an instance of
@@ -70,7 +70,7 @@ class AppInitError < InitializationError
 	end
 end
 
-# Raised when Railz::FrameworkSpawner or Railz::SpawnManager was unable to load a
+# Raised when ClassicRails::FrameworkSpawner or ClassicRails::SpawnManager was unable to load a
 # version of the Ruby on Rails framework. The +child_exception+ attribute is guaranteed
 # non-nil.
 class FrameworkInitError < InitializationError

data/lib/phusion_passenger/html_template.rb

@@ -1,5 +1,5 @@
 #  Phusion Passenger - http://www.modrails.com/
-#  Copyright (c) 2008, 2009 Phusion
+#  Copyright (c) 2010 Phusion
 #
 #  "Phusion Passenger" is a trademark of Hongli Lai & Ninh Bui.
 #
@@ -22,17 +22,15 @@
 #  THE SOFTWARE.
 
 require 'erb'
+require 'phusion_passenger'
 
 module PhusionPassenger
 
 # A convenience utility class for rendering our error pages.
 class HTMLTemplate
-	PASSENGER_FILE_PREFIX = File.dirname(__FILE__)
-	TEMPLATE_DIR = "#{PASSENGER_FILE_PREFIX}/templates"
-
 	def initialize(template_name, options = {})
 		@buffer = ''
-		@template = ERB.new(File.read("#{TEMPLATE_DIR}/#{template_name}.html.erb"),
+		@template = ERB.new(File.read("#{TEMPLATES_DIR}/#{template_name}.html.erb"),
 			nil, nil, '@buffer')
 		options.each_pair do |name, value|
 			self[name] = value
@@ -59,7 +57,7 @@ private
 		options.each_pair do |name, value|
 			self[name] = value
 		end
-		layout_template = ERB.new(File.read("#{TEMPLATE_DIR}/#{template_name}.html.erb"))
+		layout_template = ERB.new(File.read("#{TEMPLATES_DIR}/#{template_name}.html.erb"))
 		b = get_binding do
 			old_size = @buffer.size
 			yield
@@ -69,7 +67,7 @@ private
 	end
 	
 	def include(filename)
-		return File.read("#{TEMPLATE_DIR}/#{filename}")
+		return File.read("#{TEMPLATES_DIR}/#{filename}")
 	end
 	
 	def backtrace_html_for(error)
@@ -85,7 +83,7 @@ private
 		in_passenger = false
 		error.backtrace.each_with_index do |item, i|
 			filename, line, location = item.split(':', 3)
-			in_passenger ||= starts_with(filename, PASSENGER_FILE_PREFIX)
+			in_passenger ||= starts_with(filename, "#{LIBDIR}/phusion_passenger")
 			class_names = in_passenger ? "passenger" : "framework"
 			class_names << ((i & 1 == 0) ? " uneven" : " even")
 			html << %Q{

data/lib/phusion_passenger/message_channel.rb

@@ -1,6 +1,6 @@
 # encoding: binary
 #  Phusion Passenger - http://www.modrails.com/
-#  Copyright (c) 2008, 2009 Phusion
+#  Copyright (c) 2010 Phusion
 #
 #  "Phusion Passenger" is a trademark of Hongli Lai & Ninh Bui.
 #
@@ -75,13 +75,20 @@ class MessageChannel
 	HEADER_SIZE = 2                  # :nodoc:
 	DELIMITER = "\0"                 # :nodoc:
 	DELIMITER_NAME = "null byte"     # :nodoc:
+	UINT16_PACK_FORMAT = "n"         # :nodoc:
+	UINT32_PACK_FORMAT = "N"         # :nodoc:
+	
+	class InvalidHashError < StandardError
+	end
 	
 	# The wrapped IO object.
-	attr_reader :io
+	attr_accessor :io
 
 	# Create a new MessageChannel by wrapping the given IO object.
-	def initialize(io)
+	def initialize(io = nil)
 		@io = io
+		# Make it binary just in case.
+		@io.binmode if @io
 	end
 	
 	# Read an array message from the underlying file descriptor.
@@ -91,15 +98,30 @@ class MessageChannel
 	# Might raise SystemCallError, IOError or SocketError when something
 	# goes wrong.
 	def read
-		buffer = ''
+		buffer = new_buffer
+		if !@io.read(HEADER_SIZE, buffer)
+			return nil
+		end
 		while buffer.size < HEADER_SIZE
-			buffer << @io.readpartial(HEADER_SIZE - buffer.size)
+			tmp = @io.read(HEADER_SIZE - buffer.size)
+			if tmp.empty?
+				return nil
+			else
+				buffer << tmp
+			end
 		end
 		
-		chunk_size = buffer.unpack('n')[0]
-		buffer = ''
+		chunk_size = buffer.unpack(UINT16_PACK_FORMAT)[0]
+		if !@io.read(chunk_size, buffer)
+			return nil
+		end
 		while buffer.size < chunk_size
-			buffer << @io.readpartial(chunk_size - buffer.size)
+			tmp = @io.read(chunk_size - buffer.size)
+			if tmp.empty?
+				return nil
+			else
+				buffer << tmp
+			end
 		end
 		
 		message = []
@@ -117,7 +139,68 @@ class MessageChannel
 		return message
 	rescue Errno::ECONNRESET
 		return nil
-	rescue EOFError
+	end
+	
+	# Read an array message from the underlying file descriptor and return the
+	# result as a hash instead of an array. This assumes that the array message
+	# has an even number of elements.
+	# Returns nil when end-of-stream has been reached.
+	#
+	# Might raise SystemCallError, IOError or SocketError when something
+	# goes wrong.
+	def read_hash
+		buffer = new_buffer
+		if !@io.read(HEADER_SIZE, buffer)
+			return nil
+		end
+		while buffer.size < HEADER_SIZE
+			tmp = @io.read(HEADER_SIZE - buffer.size)
+			if tmp.empty?
+				return nil
+			else
+				buffer << tmp
+			end
+		end
+		
+		chunk_size = buffer.unpack(UINT16_PACK_FORMAT)[0]
+		if !@io.read(chunk_size, buffer)
+			return nil
+		end
+		while buffer.size < chunk_size
+			tmp = @io.read(chunk_size - buffer.size)
+			if tmp.empty?
+				return nil
+			else
+				buffer << tmp
+			end
+		end
+		
+		result = {}
+		offset = 0
+		delimiter_pos = buffer.index(DELIMITER, offset)
+		while !delimiter_pos.nil?
+			if delimiter_pos == 0
+				name = ""
+			else
+				name = buffer[offset .. delimiter_pos - 1]
+			end
+			
+			offset = delimiter_pos + 1
+			delimiter_pos = buffer.index(DELIMITER, offset)
+			if delimiter_pos.nil?
+				raise InvalidHashError
+			elsif delimiter_pos == 0
+				value = ""
+			else
+				value = buffer[offset .. delimiter_pos - 1]
+			end
+			
+			result[name] = value
+			offset = delimiter_pos + 1
+			delimiter_pos = buffer.index(DELIMITER, offset)
+		end
+		return result
+	rescue Errno::ECONNRESET
 		return nil
 	end
 
@@ -127,34 +210,52 @@ class MessageChannel
 	# Might raise SystemCallError, IOError or SocketError when something
 	# goes wrong.
 	#
+	# The +buffer+ argument specifies a buffer in which #read_scalar
+	# stores the read data. It is good practice to reuse existing buffers
+	# in order to minimize stress on the garbage collector.
+	#
 	# The +max_size+ argument allows one to specify the maximum allowed
 	# size for the scalar message. If the received scalar message's size
 	# is larger than +max_size+, then a SecurityError will be raised.
-	def read_scalar(max_size = nil)
-		buffer = ''
-		temp = ''
+	def read_scalar(buffer = new_buffer, max_size = nil)
+		if !@io.read(4, buffer)
+			return nil
+		end
 		while buffer.size < 4
-			buffer << @io.readpartial(4 - buffer.size, temp)
+			tmp = @io.read(4 - buffer.size)
+			if tmp.empty?
+				return nil
+			else
+				buffer << tmp
+			end
 		end
-		size = buffer.unpack('N')[0]
+		
+		size = buffer.unpack(UINT32_PACK_FORMAT)[0]
 		if size == 0
-			return ''
+			buffer.replace('')
+			return buffer
 		else
 			if !max_size.nil? && size > max_size
 				raise SecurityError, "Scalar message size (#{size}) " <<
 					"exceeds maximum allowed size (#{max_size})."
 			end
-			buffer = ''
-			while buffer.size < size
-				temp = '' # JRuby doesn't clear the buffer. TODO: remove this when JRuby has been fixed.
-				buffer << @io.readpartial(size - buffer.size, temp)
+			if !@io.read(size, buffer)
+				return nil
+			end
+			if buffer.size < size
+				tmp = ''
+				while buffer.size < size
+					if !@io.read(size - buffer.size, tmp)
+						return nil
+					else
+						buffer << tmp
+					end
+				end
 			end
 			return buffer
 		end
 	rescue Errno::ECONNRESET
 		return nil
-	rescue EOFError
-		return nil
 	end
 	
 	# Send an array message, which consists of the given elements, over the underlying
@@ -259,6 +360,11 @@ class MessageChannel
 	def close
 		@io.close
 	end
+	
+	# Checks whether the underlying IO stream is closed.
+	def closed?
+		return @io.closed?
+	end
 
 private
 	def check_argument(arg)
@@ -266,6 +372,16 @@ private
 			raise ArgumentError, "Message name and arguments may not contain #{DELIMITER_NAME}."
 		end
 	end
+	
+	if defined?(ByteString)
+		def new_buffer
+			return ByteString.new
+		end
+	else
+		def new_buffer
+			return ""
+		end
+	end
 end
 
 end # module PhusionPassenger

data/lib/phusion_passenger/message_client.rb

@@ -0,0 +1,173 @@
+# encoding: binary
+#  Phusion Passenger - http://www.modrails.com/
+#  Copyright (c) 2010 Phusion
+#
+#  "Phusion Passenger" is a trademark of Hongli Lai & Ninh Bui.
+#
+#  Permission is hereby granted, free of charge, to any person obtaining a copy
+#  of this software and associated documentation files (the "Software"), to deal
+#  in the Software without restriction, including without limitation the rights
+#  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+#  copies of the Software, and to permit persons to whom the Software is
+#  furnished to do so, subject to the following conditions:
+#
+#  The above copyright notice and this permission notice shall be included in
+#  all copies or substantial portions of the Software.
+#
+#  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+#  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+#  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+#  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+#  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+#  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+#  THE SOFTWARE.
+
+require 'socket'
+require 'phusion_passenger/message_channel'
+require 'phusion_passenger/utils'
+require 'phusion_passenger/utils/tmpdir'
+
+module PhusionPassenger
+
+# A convenience class for communicating with MessageServer servers,
+# for example the ApplicationPool server.
+class MessageClient
+	include Utils
+	
+	# Connect to the given server. By default it connects to the current
+	# generation's helper server.
+	def initialize(username, password, address = "unix:#{Utils.passenger_tmpdir}/socket")
+		@socket = connect_to_server(address)
+		begin
+			@channel = MessageChannel.new(@socket)
+			
+			result = @channel.read
+			if result.nil?
+				raise EOFError
+			elsif result.size != 2 || result[0] != "version"
+				raise IOError, "The message server didn't sent a valid version identifier"
+			elsif result[1] != "1"
+				raise IOError, "Unsupported message server protocol version #{result[1]}"
+			end
+			
+			@channel.write_scalar(username)
+			@channel.write_scalar(password)
+		
+			result = @channel.read
+			if result.nil?
+				raise EOFError
+			elsif result[0] != "ok"
+				raise SecurityError, result[0]
+			end
+		rescue Exception
+			@socket.close
+			raise
+		end
+	end
+	
+	def close
+		@socket.close if @socket
+		@channel = @socket = nil
+	end
+	
+	def connected?
+		return !!@channel
+	end
+	
+	### ApplicationPool::Server methods ###
+	
+	def detach(detach_key)
+		write("detach", detach_key)
+		check_security_response
+		result = read
+		if result.nil?
+			raise EOFError
+		else
+			return result.first == "true"
+		end
+	end
+	
+	def status
+		write("inspect")
+		check_security_response
+		return read_scalar
+	rescue
+		auto_disconnect
+		raise
+	end
+	
+	def xml
+		write("toXml", true)
+		check_security_response
+		return read_scalar
+	end
+	
+	### BacktracesServer methods ###
+	
+	def backtraces
+		write("backtraces")
+		check_security_response
+		return read_scalar
+	end
+	
+	### Low level I/O methods ###
+	
+	def read
+		return @channel.read
+	rescue
+		auto_disconnect
+		raise
+	end
+	
+	def write(*args)
+		@channel.write(*args)
+	rescue
+		auto_disconnect
+		raise
+	end
+	
+	def write_scalar(*args)
+		@channel.write_scalar(*args)
+	rescue
+		auto_disconnect
+		raise
+	end
+	
+	def read_scalar
+		return @channel.read_scalar
+	rescue
+		auto_disconnect
+		raise
+	end
+	
+	def recv_io(klass = IO, negotiate = true)
+		return @channel.recv_io(klass, negotiate)
+	rescue
+		auto_disconnect
+		raise
+	end
+	
+	def check_security_response
+		begin
+			result = @channel.read
+		rescue
+			auto_disconnect
+			raise
+		end
+		if result.nil?
+			raise EOFError
+		elsif result[0] != "Passed security"
+			raise SecurityError, result[0]
+		end
+	end
+
+private
+	def auto_disconnect
+		if @channel
+			@socket.close rescue nil
+			@socket = @channel = nil
+		end
+	end
+end
+
+end # module PhusionPassenger