passenger 4.0.30 → 4.0.31

data/helper-scripts/classic-rails-loader.rb

@@ -58,14 +58,13 @@ module App
 	end
 	
 	def self.init_passenger
-		$LOAD_PATH.unshift(options["ruby_libdir"])
-		require 'phusion_passenger'
+		require "#{options["ruby_libdir"]}/phusion_passenger"
 		PhusionPassenger.locate_directories(options["passenger_root"])
-		require 'phusion_passenger/native_support'
-		require 'phusion_passenger/ruby_core_enhancements'
-		require 'phusion_passenger/utils/tmpdir'
-		require 'phusion_passenger/loader_shared_helpers'
-		require 'phusion_passenger/request_handler'
+		PhusionPassenger.require_passenger_lib 'native_support'
+		PhusionPassenger.require_passenger_lib 'ruby_core_enhancements'
+		PhusionPassenger.require_passenger_lib 'utils/tmpdir'
+		PhusionPassenger.require_passenger_lib 'loader_shared_helpers'
+		PhusionPassenger.require_passenger_lib 'request_handler'
 		LoaderSharedHelpers.init
 		@@options = LoaderSharedHelpers.sanitize_spawn_options(@@options)
 		Utils.passenger_tmpdir = options["generation_dir"]
@@ -118,11 +117,11 @@ module App
 		LoaderSharedHelpers.after_loading_app_code(options)
 
 		if Rails::VERSION::STRING >= '2.3.0'
-			require 'phusion_passenger/rack/thread_handler_extension'
+			PhusionPassenger.require_passenger_lib 'rack/thread_handler_extension'
 			RequestHandler::ThreadHandler.send(:include, Rack::ThreadHandlerExtension)
 			app = ActionController::Dispatcher.new
 		else
-			require 'phusion_passenger/classic_rails/thread_handler_extension'
+			PhusionPassenger.require_passenger_lib 'classic_rails/thread_handler_extension'
 			RequestHandler::ThreadHandler.send(:include, ClassicRails::ThreadHandlerExtension)
 			app = nil
 		end
@@ -150,7 +149,7 @@ module App
 	handshake_and_read_startup_request
 	init_passenger
 	handler = load_app
-	puts "!> Ready"
+	LoaderSharedHelpers.advertise_readiness
 	LoaderSharedHelpers.advertise_sockets(STDOUT, handler)
 	puts "!> "
 	handler.main_loop

data/helper-scripts/classic-rails-preloader.rb

@@ -61,15 +61,14 @@ module App
 	end
 	
 	def self.init_passenger
-		$LOAD_PATH.unshift(options["ruby_libdir"])
-		require 'phusion_passenger'
+		require "#{options["ruby_libdir"]}/phusion_passenger"
 		PhusionPassenger.locate_directories(options["passenger_root"])
-		require 'phusion_passenger/native_support'
-		require 'phusion_passenger/ruby_core_enhancements'
-		require 'phusion_passenger/utils/tmpdir'
-		require 'phusion_passenger/preloader_shared_helpers'
-		require 'phusion_passenger/loader_shared_helpers'
-		require 'phusion_passenger/request_handler'
+		PhusionPassenger.require_passenger_lib 'native_support'
+		PhusionPassenger.require_passenger_lib 'ruby_core_enhancements'
+		PhusionPassenger.require_passenger_lib 'utils/tmpdir'
+		PhusionPassenger.require_passenger_lib 'preloader_shared_helpers'
+		PhusionPassenger.require_passenger_lib 'loader_shared_helpers'
+		PhusionPassenger.require_passenger_lib 'request_handler'
 		LoaderSharedHelpers.init
 		PreloaderSharedHelpers.init
 		@@options = LoaderSharedHelpers.sanitize_spawn_options(@@options)
@@ -147,11 +146,11 @@ module App
 			
 			LoaderSharedHelpers.before_handling_requests(true, options)
 			if Rails::VERSION::STRING >= '2.3.0'
-				require 'phusion_passenger/rack/thread_handler_extension'
+				PhusionPassenger.require_passenger_lib 'rack/thread_handler_extension'
 				RequestHandler::ThreadHandler.send(:include, Rack::ThreadHandlerExtension)
 				app = ActionController::Dispatcher.new
 			else
-				require 'phusion_passenger/classic_rails/thread_handler_extension'
+				PhusionPassenger.require_passenger_lib 'classic_rails/thread_handler_extension'
 				RequestHandler::ThreadHandler.send(:include, ClassicRails::ThreadHandlerExtension)
 				app = nil
 			end
@@ -164,7 +163,7 @@ module App
 			exit exit_code_for_exception(e)
 		end
 
-		puts "!> Ready"
+		LoaderSharedHelpers.advertise_readiness
 		LoaderSharedHelpers.advertise_sockets(STDOUT, handler)
 		puts "!> "
 		return handler

data/helper-scripts/node-loader.js

@@ -159,7 +159,8 @@ function installServer() {
 			"This means that the first http.Server object for which listen() is called, " +
 			"is automatically installed as the Phusion Passenger request handler. " +
 			"If you want to create and listen on multiple http.Server object then " +
-			"you should disable auto-install mode.");
+			"you should disable auto-install mode. Please read " +
+			"http://stackoverflow.com/questions/20645231/phusion-passenger-error-http-server-listen-was-called-more-than-once/20645549");
 	}
 }
 
@@ -168,7 +169,7 @@ function listenAndMaybeInstall(port) {
 		if (!PhusionPassenger._appInstalled) {
 			return installServer.apply(this, arguments);
 		} else {
-			throw new Error("You may only call listen('passenger') once");
+			throw new Error("You may only call listen('passenger') once. Please read http://stackoverflow.com/questions/20645231/phusion-passenger-error-http-server-listen-was-called-more-than-once/20645549");
 		}
 	} else {
 		return this.originalListen.apply(this, arguments);

data/helper-scripts/rack-loader.rb

@@ -40,15 +40,14 @@ module App
 	end
 	
 	def self.init_passenger
-		$LOAD_PATH.unshift(options["ruby_libdir"])
-		require 'phusion_passenger'
+		require "#{options["ruby_libdir"]}/phusion_passenger"
 		PhusionPassenger.locate_directories(options["passenger_root"])
-		require 'phusion_passenger/native_support'
-		require 'phusion_passenger/ruby_core_enhancements'
-		require 'phusion_passenger/utils/tmpdir'
-		require 'phusion_passenger/loader_shared_helpers'
-		require 'phusion_passenger/request_handler'
-		require 'phusion_passenger/rack/thread_handler_extension'
+		PhusionPassenger.require_passenger_lib 'native_support'
+		PhusionPassenger.require_passenger_lib 'ruby_core_enhancements'
+		PhusionPassenger.require_passenger_lib 'utils/tmpdir'
+		PhusionPassenger.require_passenger_lib 'loader_shared_helpers'
+		PhusionPassenger.require_passenger_lib 'request_handler'
+		PhusionPassenger.require_passenger_lib 'rack/thread_handler_extension'
 		LoaderSharedHelpers.init
 		@@options = LoaderSharedHelpers.sanitize_spawn_options(@@options)
 		Utils.passenger_tmpdir = options["generation_dir"]
@@ -99,7 +98,7 @@ module App
 	load_app
 	LoaderSharedHelpers.before_handling_requests(false, options)
 	handler = RequestHandler.new(STDIN, options.merge("app" => app))
-	puts "!> Ready"
+	LoaderSharedHelpers.advertise_readiness
 	LoaderSharedHelpers.advertise_sockets(STDOUT, handler)
 	puts "!> "
 	handler.main_loop

data/helper-scripts/rack-preloader.rb

@@ -65,16 +65,15 @@ module App
 	end
 	
 	def self.init_passenger
-		$LOAD_PATH.unshift(options["ruby_libdir"])
-		require 'phusion_passenger'
+		require "#{options["ruby_libdir"]}/phusion_passenger"
 		PhusionPassenger.locate_directories(options["passenger_root"])
-		require 'phusion_passenger/native_support'
-		require 'phusion_passenger/ruby_core_enhancements'
-		require 'phusion_passenger/utils/tmpdir'
-		require 'phusion_passenger/preloader_shared_helpers'
-		require 'phusion_passenger/loader_shared_helpers'
-		require 'phusion_passenger/request_handler'
-		require 'phusion_passenger/rack/thread_handler_extension'
+		PhusionPassenger.require_passenger_lib 'native_support'
+		PhusionPassenger.require_passenger_lib 'ruby_core_enhancements'
+		PhusionPassenger.require_passenger_lib 'utils/tmpdir'
+		PhusionPassenger.require_passenger_lib 'preloader_shared_helpers'
+		PhusionPassenger.require_passenger_lib 'loader_shared_helpers'
+		PhusionPassenger.require_passenger_lib 'request_handler'
+		PhusionPassenger.require_passenger_lib 'rack/thread_handler_extension'
 		LoaderSharedHelpers.init
 		PreloaderSharedHelpers.init
 		@@options = LoaderSharedHelpers.sanitize_spawn_options(@@options)
@@ -138,7 +137,7 @@ module App
 			exit exit_code_for_exception(e)
 		end
 
-		puts "!> Ready"
+		LoaderSharedHelpers.advertise_readiness
 		LoaderSharedHelpers.advertise_sockets(STDOUT, handler)
 		puts "!> "
 		return handler

data/lib/phusion_passenger.rb

@@ -30,7 +30,7 @@ module PhusionPassenger
 	
 	PACKAGE_NAME = 'passenger'
 	# Run 'rake ext/common/Constants.h' after changing this number.
-	VERSION_STRING = '4.0.30'
+	VERSION_STRING = '4.0.31'
 	
 	PREFERRED_NGINX_VERSION = '1.4.4'
 	NGINX_SHA256_CHECKSUM = '7c989a58e5408c9593da0bebcd0e4ffc3d892d1316ba5042ddb0be5b0b4102b9'
@@ -71,7 +71,10 @@ module PhusionPassenger
 	OPTIONAL_LOCATIONS_INI_FIELDS = [
 		# Directory in which downloaded Phusion Passenger binaries are stored.
 		# Only available when originally packaged.
-		:download_cache_dir
+		:download_cache_dir,
+		# Directory in which the build system's output is stored, e.g.
+		# the compiled agent executables. Only available when originally packaged.
+		:buildout_dir
 	].freeze
 	
 	# Follows the logic of ext/common/ResourceLocator.h, so don't forget to modify that too.
@@ -83,13 +86,22 @@ module PhusionPassenger
 			filename = root_or_file
 			options  = parse_ini_file(filename)
 			
-			@natively_packaged     = get_bool_option(filename, options, 'natively_packaged')
+			@natively_packaged       = get_bool_option(filename, options, 'natively_packaged')
+			if natively_packaged?
+				@native_packaging_method = get_option(filename, options, 'native_packaging_method')
+			end
 			REQUIRED_LOCATIONS_INI_FIELDS.each do |field|
 				instance_variable_set("@#{field}", get_option(filename, options, field.to_s).freeze)
 			end
 			OPTIONAL_LOCATIONS_INI_FIELDS.each do |field|
 				instance_variable_set("@#{field}", get_option(filename, options, field.to_s, false).freeze)
 			end
+			if !originally_packaged?
+				# Since these options are only supposed to be available when
+				# originally packaged, force them to be nil when natively packaged.
+				@download_cache_dir = nil
+				@buildout_dir = nil
+			end
 		else
 			@source_root           = File.dirname(File.dirname(FILE_LOCATION))
 			@natively_packaged     = false
@@ -106,6 +118,7 @@ module PhusionPassenger
 			@ruby_extension_source_dir = "#{@source_root}/ext/ruby"
 			@nginx_module_source_dir   = "#{@source_root}/ext/nginx"
 			@download_cache_dir    = "#{@source_root}/download_cache"
+			@buildout_dir          = "#{@source_root}/buildout"
 			REQUIRED_LOCATIONS_INI_FIELDS.each do |field|
 				if instance_variable_get("@#{field}").nil?
 					raise "BUG: @#{field} not set"
@@ -124,6 +137,12 @@ module PhusionPassenger
 		return @natively_packaged
 	end
 
+	# If Phusion Passenger is natively packaged, returns which packaging
+	# method was used. Can be 'deb' or 'rpm'.
+	def self.native_packaging_method
+		return @native_packaging_method
+	end
+
 	# Whether the current Phusion Passenger installation is installed
 	# from a release package, e.g. an official gem or official tarball.
 	# Retruns false if e.g. the gem was built by the user, or if this
@@ -140,7 +159,6 @@ module PhusionPassenger
 
 	# Generate getters for the directory types in locations.ini.
 	getters_code = ""
-	@ruby_libdir = File.dirname(FILE_LOCATION)
 	(REQUIRED_LOCATIONS_INI_FIELDS + OPTIONAL_LOCATIONS_INI_FIELDS).each do |field|
 		getters_code << %Q{
 			def self.#{field}
@@ -180,9 +198,20 @@ module PhusionPassenger
 	end
 	
 	
-	if !$LOAD_PATH.include?(ruby_libdir)
-		$LOAD_PATH.unshift(ruby_libdir)
-		$LOAD_PATH.uniq!
+	# Instead of calling `require 'phusion_passenger/foo'`, you should call
+	# `PhusionPassenger.require_passenger_lib 'foo'`. This is because when Phusion
+	# Passenger is natively packaged, it may still be run with arbitrary Ruby
+	# interpreters. Adding ruby_libdir to $LOAD_PATH is then dangerous because ruby_libdir
+	# may be the distribution's Ruby's vendor_ruby directory, which may be incompatible
+	# with the active Ruby interpreter. This method looks up the exact filename directly.
+	# 
+	# Using this method also has two more advantages:
+	# 
+	#  1. It is immune to Bundler's load path mangling code.
+	#  2. It is faster than plan require() because it doesn't need to
+	#     scan the entire load path.
+	def self.require_passenger_lib(name)
+		require("#{ruby_libdir}/phusion_passenger/#{name}")
 	end
 
 

data/lib/phusion_passenger/abstract_installer.rb

@@ -21,13 +21,12 @@
 #  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 #  THE SOFTWARE.
 
-require 'phusion_passenger'
-require 'phusion_passenger/constants'
-require 'phusion_passenger/console_text_template'
-require 'phusion_passenger/platform_info'
-require 'phusion_passenger/platform_info/operating_system'
-require 'phusion_passenger/utils/ansi_colors'
-require 'phusion_passenger/utils/download'
+PhusionPassenger.require_passenger_lib 'constants'
+PhusionPassenger.require_passenger_lib 'console_text_template'
+PhusionPassenger.require_passenger_lib 'platform_info'
+PhusionPassenger.require_passenger_lib 'platform_info/operating_system'
+PhusionPassenger.require_passenger_lib 'utils/ansi_colors'
+PhusionPassenger.require_passenger_lib 'utils/download'
 require 'fileutils'
 require 'logger'
 require 'etc'
@@ -132,7 +131,7 @@ protected
 		puts "<banner>Checking for required software...</banner>"
 		puts
 		
-		require 'phusion_passenger/platform_info/depcheck'
+		PhusionPassenger.require_passenger_lib 'platform_info/depcheck'
 		specs, ids = dependencies
 		runner = PlatformInfo::Depcheck::ConsoleRunner.new
 
@@ -257,7 +256,7 @@ protected
 			puts "We're sorry, but it looks like this installer ran into an unexpected problem.\n" +
 				"Please visit the following website for support. We'll do our best to help you.\n\n" +
 				"  <b>#{SUPPORT_URL}</b>\n\n" +
-				"When submitting a support inquiry, please copy and paste the entire installler\n" +
+				"When submitting a support inquiry, please copy and paste the entire installer\n" +
 				"output."
 		rescue Exception => e2
 			# Raise original exception so that it doesn't get lost.
@@ -399,7 +398,7 @@ protected
 	end
 	
 	def rake(*args)
-		require 'phusion_passenger/platform_info/ruby'
+		PhusionPassenger.require_passenger_lib 'platform_info/ruby'
 		if !PlatformInfo.rake_command
 			puts_error 'Cannot find Rake.'
 			raise Abort
@@ -408,7 +407,7 @@ protected
 	end
 
 	def rake!(*args)
-		require 'phusion_passenger/platform_info/ruby'
+		PhusionPassenger.require_passenger_lib 'platform_info/ruby'
 		if !PlatformInfo.rake_command
 			puts_error 'Cannot find Rake.'
 			raise Abort
@@ -417,10 +416,12 @@ protected
 	end
 	
 	def download(url, output, options = {})
-		logger = Logger.new(STDOUT)
-		logger.level = Logger::WARN
-		logger.formatter = proc { |severity, datetime, progname, msg| "*** #{msg}\n" }
-		options[:logger] = logger
+		options[:logger] ||= begin
+			logger = Logger.new(STDOUT)
+			logger.level = Logger::WARN
+			logger.formatter = proc { |severity, datetime, progname, msg| "*** #{msg}\n" }
+			logger
+		end
 		return PhusionPassenger::Utils::Download.download(url, output, options)
 	end
 

data/lib/phusion_passenger/active_support3_extensions/init.rb

@@ -21,7 +21,7 @@
 #  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 #  THE SOFTWARE.
 
-require 'phusion_passenger/constants'
+PhusionPassenger.require_passenger_lib 'constants'
 require 'digest/md5'
 
 module PhusionPassenger

data/lib/phusion_passenger/admin_tools/memory_stats.rb

@@ -21,8 +21,8 @@
 #  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 #  THE SOFTWARE.
 
-require 'phusion_passenger/platform_info/apache'
-require 'phusion_passenger/platform_info/operating_system'
+PhusionPassenger.require_passenger_lib 'platform_info/apache'
+PhusionPassenger.require_passenger_lib 'platform_info/operating_system'
 
 module PhusionPassenger
 module AdminTools

data/lib/phusion_passenger/admin_tools/server_instance.rb

@@ -26,11 +26,11 @@ require 'rexml/document'
 require 'fileutils'
 require 'socket'
 require 'ostruct'
-require 'phusion_passenger/admin_tools'
-require 'phusion_passenger/constants'
-require 'phusion_passenger/utils'
-require 'phusion_passenger/message_channel'
-require 'phusion_passenger/message_client'
+PhusionPassenger.require_passenger_lib 'admin_tools'
+PhusionPassenger.require_passenger_lib 'constants'
+PhusionPassenger.require_passenger_lib 'utils'
+PhusionPassenger.require_passenger_lib 'message_channel'
+PhusionPassenger.require_passenger_lib 'message_client'
 
 module PhusionPassenger
 module AdminTools

data/lib/phusion_passenger/analytics_logger.rb

@@ -22,9 +22,9 @@
 #  THE SOFTWARE.
 
 require 'thread'
-require 'phusion_passenger/utils'
-require 'phusion_passenger/debug_logging'
-require 'phusion_passenger/message_channel'
+PhusionPassenger.require_passenger_lib 'utils'
+PhusionPassenger.require_passenger_lib 'debug_logging'
+PhusionPassenger.require_passenger_lib 'message_channel'
 
 module PhusionPassenger
 

data/lib/phusion_passenger/classic_rails/thread_handler_extension.rb

@@ -22,7 +22,7 @@
 #  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 #  THE SOFTWARE.
 
-require 'phusion_passenger/classic_rails/cgi_fixed'
+PhusionPassenger.require_passenger_lib 'classic_rails/cgi_fixed'
 module PhusionPassenger
 module ClassicRails
 

data/lib/phusion_passenger/config.rb

@@ -0,0 +1,125 @@
+#  Phusion Passenger - https://www.phusionpassenger.com/
+#  Copyright (c) 2013 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.
+
+PhusionPassenger.require_passenger_lib 'constants'
+
+module PhusionPassenger
+
+# Core of the `passenger-config` command. Dispatches a subcommand to a specific class.
+module Config
+	KNOWN_COMMANDS = [
+		["restart-app", "RestartAppCommand"],
+		["about", "AboutCommand"]
+	]
+	
+	ABOUT_OPTIONS = [
+		"root",
+		"includedir",
+		"nginx-addon-dir",
+		"nginx-libs",
+		"compiled",
+		"natively-packaged",
+		"installed-from-release-package",
+		"make-locations-ini",
+		"detect-apache2",
+		"ruby-command",
+		"ruby-libdir",
+		"rubyext-compat-id",
+		"cxx-compat-id",
+		"version"
+	]
+
+	def self.run!(argv)
+		command_class, new_argv = lookup_command_class_by_argv(argv)
+		if help_requested?(argv)
+			help
+		elsif command_class
+			command = command_class.new(new_argv)
+			command.run
+		else
+			help
+			abort
+		end
+	end
+
+	def self.help
+		puts "Usage: passenger-config <COMMAND> [options]"
+		puts "Tool for controlling or configurating a #{PROGRAM_NAME} instance or installation."
+		puts
+		puts "Available commands:"
+		KNOWN_COMMANDS.each do |props|
+			command_class = lookup_command_class_by_class_name(props[1])
+			printf "  %-15s %s\n", props[0], command_class.description
+		end
+		puts
+		puts "Type 'passenger-config <COMMAND> --help' for more information."
+	end
+
+private
+	def self.help_requested?(argv)
+		return argv.size == 1 && (argv[0] == "--help" || argv[0] == "-h" || argv[0] == "help")
+	end
+
+	def self.lookup_command_class_by_argv(argv)
+		return nil if argv.empty?
+
+		# Compatibility with version <= 4.0.29: try to pass all
+		# --switch invocations to AboutCommand.
+		if argv[0] =~ /^--/
+			name = argv[0].sub(/^--/, '')
+			if ABOUT_OPTIONS.include?(name)
+				command_class = lookup_command_class_by_class_name("AboutCommand")
+				return [command_class, argv]
+			else
+				return nil
+			end
+		end
+
+		# Convert "passenger-config help <COMMAND>" to "passenger-config <COMMAND> --help".
+		if argv.size == 2 && argv[0] == "help"
+			argv = [argv[1], "--help"]
+		end
+
+		KNOWN_COMMANDS.each do |props|
+			if argv[0] == props[0]
+				command_class = lookup_command_class_by_class_name(props[1])
+				new_argv = argv[1 .. -1]
+				return [command_class, new_argv]
+			end
+		end
+
+		return nil
+	end
+
+	def self.lookup_command_class_by_class_name(class_name)
+		base_name = class_name.gsub(/[A-Z]/) do |match|
+			"_" + match[0..0].downcase
+		end
+		base_name.sub!(/^_/, '')
+		base_name << ".rb"
+		PhusionPassenger.require_passenger_lib("config/#{base_name}")
+		return PhusionPassenger::Config.const_get(class_name)
+	end
+end
+
+end # module PhusionPassenger