passenger 1.0.5 → 2.0.1

data/lib/passenger/abstract_server.rb

@@ -1,6 +1,8 @@
 #  Phusion Passenger - http://www.modrails.com/
 #  Copyright (C) 2008  Phusion
 #
+#  Phusion Passenger is a trademark of Hongli Lai & Ninh Bui.
+#
 #  This program is free software; you can redistribute it and/or modify
 #  it under the terms of the GNU General Public License as published by
 #  the Free Software Foundation; version 2 of the License.
@@ -15,9 +17,11 @@
 #  51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 
 require 'socket'
+require 'set'
 require 'timeout'
 require 'passenger/message_channel'
 require 'passenger/utils'
+require 'passenger/native_support'
 module Passenger
 
 # An abstract base class for a server, with the following properties:
@@ -99,7 +103,7 @@ class AbstractServer
 	#
 	# Derived classes may raise additional exceptions.
 	def start
-		if !@parent_channel.nil?
+		if started?
 			raise ServerAlreadyStarted, "Server is already started"
 		end
 	
@@ -110,7 +114,24 @@ class AbstractServer
 				STDOUT.sync = true
 				STDERR.sync = true
 				@parent_socket.close
-				NativeSupport.close_all_file_descriptors([0, 1, 2, @child_socket.fileno])
+				
+				# During Passenger's early days, we used to close file descriptors based
+				# on a white list of file descriptors. That proved to be way too fragile:
+				# too many file descriptors are being left open even though they shouldn't
+				# be. So now we close file descriptors based on a black list.
+				file_descriptors_to_close = [0, 1, 2, @child_socket.fileno]
+				NativeSupport.close_all_file_descriptors(file_descriptors_to_close)
+				# In addition to closing the file descriptors, one must also close
+				# the associated IO objects. This is to prevent IO.close from
+				# double-closing already closed file descriptors.
+				close_all_io_objects_for_fds(Set.new(file_descriptors_to_close))
+				
+				# At this point, RubyGems might have open file handles for which
+				# the associated file descriptors have just been closed. This can
+				# result in mysterious 'EBADFD' errors. So we force RubyGems to
+				# clear all open file handles.
+				Gem.clear_paths
+				
 				start_synchronously(@child_socket)
 			rescue Interrupt
 				# Do nothing.
@@ -159,14 +180,14 @@ class AbstractServer
 	# When calling this method, the server must already be started. If not, a
 	# ServerNotStarted will be raised.
 	def stop
-		if @parent_channel.nil?
+		if !started?
 			raise ServerNotStarted, "Server is not started"
 		end
 		
 		@parent_socket.close
 		@parent_channel = nil
 		
-		# Wait at most 5 seconds for server to exit. If it doesn't do that,
+		# Wait at most 3 seconds for server to exit. If it doesn't do that,
 		# we kill it. If that doesn't work either, we kill it forcefully with
 		# SIGKILL.
 		begin
@@ -186,6 +207,11 @@ class AbstractServer
 		end
 	end
 	
+	# Return whether the server has been started.
+	def started?
+		return !@parent_channel.nil?
+	end
+	
 	# Return the PID of the started server. This is only valid if start() has been called.
 	def server_pid
 		return @pid
@@ -231,7 +257,7 @@ protected
 	# This method may only be called in the parent process, and not
 	# in the started server process.
 	def server
-		if @parent_channel.nil?
+		if !started?
 			raise ServerNotStarted, "Server hasn't been started yet. Please call start() first."
 		end
 		return @parent_channel

data/lib/passenger/application.rb

@@ -1,6 +1,8 @@
 #  Phusion Passenger - http://www.modrails.com/
 #  Copyright (C) 2008  Phusion
 #
+#  Phusion Passenger is a trademark of Hongli Lai & Ninh Bui.
+#
 #  This program is free software; you can redistribute it and/or modify
 #  it under the terms of the GNU General Public License as published by
 #  the Free Software Foundation; version 2 of the License.
@@ -15,23 +17,10 @@
 #  51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 
 require 'rubygems'
-require 'passenger/utils'
+require 'passenger/exceptions'
 module Passenger
 
-# Indicates that there is no Ruby on Rails version installed that satisfies
-# a given Ruby on Rails Gem version specification.
-class VersionNotFound < StandardError
-	attr_reader :gem_version_spec
-	
-	# - +message+: The exception message.
-	# - +gem_version_spec+: The Ruby on Rails Gem version specification that caused this error.
-	def initialize(message, gem_version_spec)
-		super(message)
-		@gem_version_spec = gem_version_spec
-	end
-end
-
-# Represents a single Ruby on Rails application instance.
+# Represents a single application instance.
 class Application
 	# The root directory of this application, i.e. the directory that contains
 	# 'app/', 'public/', etc.
@@ -111,7 +100,7 @@ class Application
 	# processes that have connections to this application instance, then it will
 	# shutdown as soon as possible.
 	#
-	# See also RequestHandler#owner_pipe.
+	# See also AbstractRequestHandler#owner_pipe.
 	def close
 		@owner_pipe.close rescue nil
 	end

data/lib/passenger/console_text_template.rb

@@ -1,6 +1,8 @@
 #  Phusion Passenger - http://www.modrails.com/
 #  Copyright (C) 2008  Phusion
 #
+#  Phusion Passenger is a trademark of Hongli Lai & Ninh Bui.
+#
 #  This program is free software; you can redistribute it and/or modify
 #  it under the terms of the GNU General Public License as published by
 #  the Free Software Foundation; version 2 of the License.

data/lib/passenger/constants.rb

@@ -0,0 +1,26 @@
+#  Phusion Passenger - http://www.modrails.com/
+#  Copyright (C) 2008  Phusion
+#
+#  This program is free software; you can redistribute it and/or modify
+#  it under the terms of the GNU General Public License as published by
+#  the Free Software Foundation; version 2 of the License.
+#
+#  This program is distributed in the hope that it will be useful,
+#  but WITHOUT ANY WARRANTY; without even the implied warranty of
+#  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#  GNU General Public License for more details.
+#
+#  You should have received a copy of the GNU General Public License along
+#  with this program; if not, write to the Free Software Foundation, Inc.,
+#  51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+
+module Passenger
+	FRAMEWORK_SPAWNER_MAX_IDLE_TIME = 30 * 60
+	APP_SPAWNER_MAX_IDLE_TIME       = 10 * 60
+	
+	SPAWNER_CLEAN_INTERVAL = [
+		FRAMEWORK_SPAWNER_MAX_IDLE_TIME,
+		APP_SPAWNER_MAX_IDLE_TIME
+	].min + 5
+	APP_SPAWNER_CLEAN_INTERVAL = APP_SPAWNER_MAX_IDLE_TIME + 5
+end

data/lib/passenger/dependencies.rb

@@ -1,6 +1,8 @@
 #  Phusion Passenger - http://www.modrails.com/
 #  Copyright (C) 2008  Phusion
 #
+#  Phusion Passenger is a trademark of Hongli Lai & Ninh Bui.
+#
 #  This program is free software; you can redistribute it and/or modify
 #  it under the terms of the GNU General Public License as published by
 #  the Free Software Foundation; version 2 of the License.
@@ -139,7 +141,7 @@ module Dependencies # :nodoc: all
 			dep.install_command = "make -C /usr/ports/lang/ruby18 install"
 		end
 		dep.website = "http://www.ruby-lang.org/"
-		dep.install_instructions = "Please reinstall Ruby by downloading it from <bold>#{dep.website}</b>"
+		dep.install_instructions = "Please reinstall Ruby by downloading it from <b>#{dep.website}</b>"
 	end
 	
 	Ruby_OpenSSL = Dependency.new do |dep|
@@ -157,10 +159,11 @@ module Dependencies # :nodoc: all
 			when :ubuntu, :debian
 				dep.install_command = "apt-get install libopenssl-ruby"
 			end
-		else
+		end
+		if dep.install_command.nil?
 			dep.website = "http://www.ruby-lang.org/"
 			dep.install_instructions = "Please (re)install Ruby with OpenSSL " <<
-				"support by downloading it from <bold>#{dep.website}</bold>."
+				"support by downloading it from <b>#{dep.website}</b>."
 		end
 	end
 	
@@ -284,6 +287,23 @@ module Dependencies # :nodoc: all
 		end
 		dep.install_instructions = "Please install RubyGems first, then run <b>gem install fastthread</b>"
 	end
+
+	Rack = Dependency.new do |dep|
+		dep.name = "rack"
+		dep.define_checker do |result|
+			begin
+				begin
+					require 'rubygems'
+				rescue LoadError
+				end
+				require 'rack'
+				result.found
+			rescue LoadError
+				result.not_found
+			end
+		end
+		dep.install_instructions = "Please install RubyGems first, then run <b>gem install rack</b>"
+	end
 end
 
 end # module Passenger

data/lib/passenger/exceptions.rb

@@ -0,0 +1,91 @@
+#  Phusion Passenger - http://www.modrails.com/
+#  Copyright (C) 2008  Phusion
+#
+#  Phusion Passenger is a trademark of Hongli Lai & Ninh Bui.
+#
+#  This program is free software; you can redistribute it and/or modify
+#  it under the terms of the GNU General Public License as published by
+#  the Free Software Foundation; version 2 of the License.
+#
+#  This program is distributed in the hope that it will be useful,
+#  but WITHOUT ANY WARRANTY; without even the implied warranty of
+#  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#  GNU General Public License for more details.
+#
+#  You should have received a copy of the GNU General Public License along
+#  with this program; if not, write to the Free Software Foundation, Inc.,
+#  51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+
+module Passenger
+
+# Indicates that there is no Ruby on Rails version installed that satisfies
+# a given Ruby on Rails Gem version specification.
+class VersionNotFound < StandardError
+	attr_reader :gem_version_spec
+	
+	# - +message+: The exception message.
+	# - +gem_version_spec+: The Ruby on Rails Gem version specification that caused this error.
+	def initialize(message, gem_version_spec)
+		super(message)
+		@gem_version_spec = gem_version_spec
+	end
+end
+
+# An abstract base class for AppInitError and FrameworkInitError. This represents
+# the failure when initializing something.
+class InitializationError < StandardError
+	# The exception that caused initialization to fail. This may be nil.
+	attr_accessor :child_exception
+
+	# Create a new InitializationError. +message+ is the error message,
+	# and +child_exception+ is the exception that caused initialization
+	# to fail.
+	def initialize(message, child_exception = nil)
+		super(message)
+		@child_exception = child_exception
+	end
+end
+
+# Raised when Rack::ApplicationSpawner, Railz::ApplicationSpawner,
+# Railz::FrameworkSpawner or SpawnManager was unable to spawn an application,
+# because the application either threw an exception or called exit.
+#
+# If the +child_exception+ attribute is nil, then it means that the application
+# called exit.
+class AppInitError < InitializationError
+	attr_accessor :app_type
+	
+	def initialize(message, child_exception = nil, app_type = "rails")
+		super(message, child_exception)
+		@app_type = app_type
+	end
+end
+
+# Raised when Railz::FrameworkSpawner or Railz::SpawnManager was unable to load a
+# version of the Ruby on Rails framework. The +child_exception+ attribute is guaranteed
+# non-nil.
+class FrameworkInitError < InitializationError
+	attr_reader :vendor
+	attr_reader :version
+	
+	def initialize(message, child_exception, options)
+		super(message, child_exception)
+		if options[:vendor]
+			@vendor = options[:vendor]
+		else
+			@version = options[:version]
+		end
+	end
+end
+
+class UnknownError < StandardError
+	attr_accessor :real_class_name
+	
+	def initialize(message, class_name, backtrace)
+		super("#{message} (#{class_name})")
+		set_backtrace(backtrace)
+		@real_class_name = class_name
+	end
+end
+
+end # module Passenger

data/lib/passenger/html_template.rb

@@ -1,6 +1,8 @@
 #  Phusion Passenger - http://www.modrails.com/
 #  Copyright (C) 2008  Phusion
 #
+#  Phusion Passenger is a trademark of Hongli Lai & Ninh Bui.
+#
 #  This program is free software; you can redistribute it and/or modify
 #  it under the terms of the GNU General Public License as published by
 #  the Free Software Foundation; version 2 of the License.

data/lib/passenger/message_channel.rb

@@ -1,6 +1,8 @@
 #  Phusion Passenger - http://www.modrails.com/
 #  Copyright (C) 2008  Phusion
 #
+#  Phusion Passenger is a trademark of Hongli Lai & Ninh Bui.
+#
 #  This program is free software; you can redistribute it and/or modify
 #  it under the terms of the GNU General Public License as published by
 #  the Free Software Foundation; version 2 of the License.
@@ -14,7 +16,6 @@
 #  with this program; if not, write to the Free Software Foundation, Inc.,
 #  51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 
-require 'passenger/utils'
 module Passenger
 
 # This class provides convenience methods for:

data/lib/passenger/platform_info.rb

@@ -1,6 +1,8 @@
 #  Phusion Passenger - http://www.modrails.com/
 #  Copyright (C) 2008  Phusion
 #
+#  Phusion Passenger is a trademark of Hongli Lai & Ninh Bui.
+#
 #  This program is free software; you can redistribute it and/or modify
 #  it under the terms of the GNU General Public License as published by
 #  the Free Software Foundation; version 2 of the License.

data/lib/passenger/rack/application_spawner.rb

@@ -0,0 +1,108 @@
+#  Phusion Passenger - http://www.modrails.com/
+#  Copyright (C) 2008  Phusion
+#
+#  This program is free software; you can redistribute it and/or modify
+#  it under the terms of the GNU General Public License as published by
+#  the Free Software Foundation; version 2 of the License.
+#
+#  This program is distributed in the hope that it will be useful,
+#  but WITHOUT ANY WARRANTY; without even the implied warranty of
+#  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#  GNU General Public License for more details.
+#
+#  You should have received a copy of the GNU General Public License along
+#  with this program; if not, write to the Free Software Foundation, Inc.,
+#  51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+
+require 'rack'
+require 'socket'
+require 'passenger/application'
+require 'passenger/message_channel'
+require 'passenger/abstract_request_handler'
+require 'passenger/utils'
+require 'passenger/rack/request_handler'
+module Passenger
+module Rack
+
+# Class for spawning Rack applications.
+class ApplicationSpawner
+	include Utils
+	
+	def self.spawn_application(*args)
+		@@instance ||= ApplicationSpawner.new
+		@@instance.spawn_application(*args)
+	end
+	
+	# Spawn an instance of the given Rack application. When successful, an
+	# Application object will be returned, which represents the spawned
+	# application.
+	#
+	# Raises:
+	# - AppInitError: The Rack application raised an exception or called
+	#   exit() during startup.
+	# - SystemCallError, IOError, SocketError: Something went wrong.
+	def spawn_application(app_root, lower_privilege = true, lowest_user = "nobody", environment = "production")
+		a, b = UNIXSocket.pair
+		# Double fork in order to prevent zombie processes.
+		pid = safe_fork(self.class.to_s) do
+			safe_fork(self.class.to_s) do
+				a.close
+				run(MessageChannel.new(b), app_root, lower_privilege, lowest_user, environment)
+			end
+		end
+		b.close
+		Process.waitpid(pid) rescue nil
+		
+		channel = MessageChannel.new(a)
+		unmarshal_and_raise_errors(channel, "rack")
+		
+		# No exception was raised, so spawning succeeded.
+		pid, socket_name, using_abstract_namespace = channel.read
+		if pid.nil?
+			raise IOError, "Connection closed"
+		end
+		owner_pipe = channel.recv_io
+		return Application.new(@app_root, pid, socket_name,
+			using_abstract_namespace == "true", owner_pipe)
+	end
+
+private
+	
+	def run(channel, app_root, lower_privilege, lowest_user, environment)
+		$0 = "Rack: #{app_root}"
+		app = nil
+		success = report_app_init_status(channel) do
+			ENV['RACK_ENV'] = environment
+			Dir.chdir(app_root)
+			if lower_privilege
+				lower_privilege('config.ru', lowest_user)
+			end
+			app = load_rack_app
+		end
+		
+		if success
+			reader, writer = IO.pipe
+			begin
+				handler = RequestHandler.new(reader, app)
+				channel.write(Process.pid, handler.socket_name,
+					handler.using_abstract_namespace?)
+				channel.send_io(writer)
+				writer.close
+				channel.close
+				handler.main_loop
+			ensure
+				channel.close rescue nil
+				writer.close rescue nil
+				handler.cleanup rescue nil
+			end
+		end
+	end
+
+	def load_rack_app
+		rackup_code = File.read("config.ru")
+		eval("Rack::Builder.new {( #{rackup_code}\n )}.to_app", TOPLEVEL_BINDING, "config.ru")
+	end
+end
+
+end # module Rack
+end # module Passenger