passenger 3.0.21 → 3.9.1.beta

data/helper-scripts/wsgi-preloader.py

@@ -0,0 +1 @@
+#!/usr/bin/env python

data/lib/phusion_passenger.rb

@@ -1,3 +1,4 @@
+# encoding: utf-8
 #  Phusion Passenger - http://www.modrails.com/
 #  Copyright (c) 2010, 2011, 2012 Phusion
 #
@@ -22,84 +23,138 @@
 #  THE SOFTWARE.
 
 module PhusionPassenger
+	FILE_LOCATION = File.expand_path(__FILE__)
+	
+	
 	###### Version numbers ######
 	
 	# Phusion Passenger version number. Don't forget to edit ext/common/Constants.h too.
-	VERSION_STRING = '3.0.21'
+	VERSION_STRING = '3.9.1.beta'
 	
-	PREFERRED_NGINX_VERSION = '1.2.9'
+	PREFERRED_NGINX_VERSION = '1.2.4'
 	PREFERRED_PCRE_VERSION  = '8.31'
 	STANDALONE_INTERFACE_VERSION  = 1
 	
 	
 	###### Directories ######
-	# Don't forget to modify ext/common/ResourceLocator.h too.
 	
-	# Returns whether this Phusion Passenger installation is packaged
-	# using the OS's native package management system, i.e. as opposed
-	# to being installed from source or with RubyGems.
-	def self.natively_packaged?
-		if !defined?(@natively_packaged)
-			@natively_packaged = !File.exist?("#{LIBDIR}/../Rakefile") ||
-			                     !File.exist?("#{LIBDIR}/../DEVELOPERS.TXT")
+	GLOBAL_NAMESPACE_DIRNAME            = "phusion-passenger"
+	GLOBAL_STANDALONE_NAMESPACE_DIRNAME = "passenger-standalone"
+	# Subdirectory under $HOME to use for storing stuff.
+	USER_NAMESPACE_DIRNAME              = ".passenger"
+	
+	# Directories in which to look for plugins.
+	PLUGIN_DIRS = [
+		"/usr/share/#{GLOBAL_NAMESPACE_DIRNAME}/plugins",
+		"/usr/local/share/#{GLOBAL_NAMESPACE_DIRNAME}/plugins",
+		"~/#{USER_NAMESPACE_DIRNAME}/plugins"
+	]
+	
+	# Directory under $HOME for storing Phusion Passenger Standalone runtime files.
+	LOCAL_STANDALONE_RESOURCE_DIR  = File.join(USER_NAMESPACE_DIRNAME, "standalone")
+	
+	# System-wide directory for storing Phusion Passenger Standalone runtime files.
+	GLOBAL_STANDALONE_RESOURCE_DIR = "/var/lib/#{GLOBAL_STANDALONE_NAMESPACE_DIRNAME}".freeze
+	
+	NATIVELY_PACKAGED_BIN_DIR                = "/usr/bin".freeze
+	NATIVELY_PACKAGED_AGENTS_DIR             = "/usr/lib/#{GLOBAL_NAMESPACE_DIRNAME}/agents".freeze
+	NATIVELY_PACKAGED_HELPER_SCRIPTS_DIR     = "/usr/share/#{GLOBAL_NAMESPACE_DIRNAME}/helper-scripts".freeze
+	NATIVELY_PACKAGED_RESOURCES_DIR          = "/usr/share/#{GLOBAL_NAMESPACE_DIRNAME}".freeze
+	NATIVELY_PACKAGED_DOC_DIR                = "/usr/share/doc/#{GLOBAL_NAMESPACE_DIRNAME}".freeze
+	NATIVELY_PACKAGED_RUNTIME_LIBDIR         = "/usr/lib/#{GLOBAL_NAMESPACE_DIRNAME}".freeze
+	NATIVELY_PACKAGED_HEADER_DIR             = "/usr/include/#{GLOBAL_NAMESPACE_DIRNAME}".freeze
+	NATIVELY_PACKAGED_APACHE2_MODULE         = "/usr/lib/apache2/modules/mod_passenger.so".freeze
+	
+	# Follows the logic of ext/common/ResourceLocator.h, so don't forget to modify that too.
+	def self.locate_directories(source_root_or_location_configuration_file = nil)
+		source_root_or_location_configuration_file ||= find_location_configuration_file
+		root_or_file = @source_root = source_root_or_location_configuration_file
+		
+		if root_or_file && File.file?(root_or_file)
+			filename = root_or_file
+			options  = {}
+			in_locations_section = false
+			File.open(filename, 'r') do |f|
+				while !f.eof?
+					line = f.readline
+					line.strip!
+					next if line.empty?
+					if line =~ /\A\[(.+)\]\Z/
+						in_locations_section = $1 == 'locations'
+					elsif in_locations_section && line =~ /=/
+						key, value = line.split(/ *= */, 2)
+						options[key.freeze] = value.freeze
+					end
+				end
+			end
+			
+			@natively_packaged     = get_bool_option(filename, options, 'natively_packaged')
+			@bin_dir               = get_option(filename, options, 'bin').freeze
+			@agents_dir            = get_option(filename, options, 'agents').freeze
+			@helper_scripts_dir    = get_option(filename, options, 'helper_scripts').freeze
+			@resources_dir         = get_option(filename, options, 'resources').freeze
+			@doc_dir               = get_option(filename, options, 'doc').freeze
+			@apache2_module_path   = get_option(filename, options, 'apache2_module').freeze
+			@ruby_extension_source_dir = get_option(filename, options, 'ruby_extension_source').freeze
+		else
+			@source_root           = File.dirname(File.dirname(FILE_LOCATION))
+			@natively_packaged     = false
+			@bin_dir               = "#{@source_root}/bin".freeze
+			@agents_dir            = "#{@source_root}/agents".freeze
+			@helper_scripts_dir    = "#{@source_root}/helper-scripts".freeze
+			@resources_dir         = "#{@source_root}/resources".freeze
+			@doc_dir               = "#{@source_root}/doc".freeze
+			@apache2_module_path   = "#{@source_root}/libout/apache2/mod_passenger.so".freeze
+			@ruby_extension_source_dir = "#{@source_root}/ext/ruby"
 		end
-		return @natively_packaged
 	end
 	
-	NATIVELY_PACKAGED_SOURCE_ROOT        = "/usr/share/phusion-passenger/source"
-	NATIVELY_PACKAGED_DOCDIR             = "/usr/share/doc/phusion-passenger"
-	NATIVELY_PACKAGED_RESOURCES_DIR      = "/usr/share/phusion-passenger"
-	NATIVELY_PACKAGED_AGENTS_DIR         = "/usr/lib/phusion-passenger/agents"
-	NATIVELY_PACKAGED_HELPER_SCRIPTS_DIR = "/usr/share/phusion-passenger/helper-scripts"
-	NATIVELY_PACKAGED_APACHE2_MODULE     = "/usr/lib/apache2/modules/mod_passenger.so"
+	# Returns whether this Phusion Passenger installation is in the 'originally packaged'
+	# configuration (as opposed to the 'natively packaged' configuration.
+	def self.originally_packaged?
+		return !@natively_packaged
+	end
+
+	def self.natively_packaged?
+		return @natively_packaged
+	end
+
+	# When originally packaged, returns the source root.
+	# When natively packaged, returns the location of the location configuration file.
+	def self.source_root
+		return @source_root
+	end
 	
-	# Directory containing the Phusion Passenger Ruby libraries.
-	LIBDIR         = File.expand_path(File.dirname(__FILE__))
+	def self.bin_dir
+		return @bin_dir
+	end
 	
-	# Directory containing templates.
-	TEMPLATES_DIR  = File.join(LIBDIR, "phusion_passenger", "templates")
+	def self.agents_dir
+		return @agents_dir
+	end
 	
-	# Subdirectory under $HOME to use for storing resource files.
-	LOCAL_DIR      = ".passenger"
+	def self.helper_scripts_dir
+		return @helper_scripts_dir
+	end
 	
-	# Directories in which to look for plugins.
-	PLUGIN_DIRS    = ["/usr/share/phusion-passenger/plugins",
-		"/usr/local/share/phusion-passenger/plugins",
-		"~/#{LOCAL_DIR}/plugins"]
+	def self.resources_dir
+		return @resources_dir
+	end
 	
-	# Directory under $HOME for storing Phusion Passenger Standalone resource files.
-	LOCAL_STANDALONE_RESOURCE_DIR  = File.join(LOCAL_DIR, "standalone")
+	def self.doc_dir
+		return @doc_dir
+	end
 	
-	# System-wide directory for storing Phusion Passenger Standalone resource files.
-	GLOBAL_STANDALONE_RESOURCE_DIR = "/var/lib/passenger-standalone"
+	def self.ruby_libdir
+		@libdir ||= File.dirname(FILE_LOCATION)
+	end
 	
-	if !natively_packaged?
-		# Top directory of the Phusion Passenger source code.
-		SOURCE_ROOT        = File.expand_path(File.join(LIBDIR, ".."))
-		
-		# Documentation directory.
-		DOCDIR             = File.join(SOURCE_ROOT, "doc")
-		
-		# Directory containing Phusion Passenger resource files.
-		RESOURCES_DIR      = File.join(SOURCE_ROOT, "resources")
-		
-		AGENTS_DIR         = File.join(SOURCE_ROOT, "agents")
-		
-		HELPER_SCRIPTS_DIR = File.join(SOURCE_ROOT, "helper-scripts")
-		
-		# Location of the Apache 2 module.
-		APACHE2_MODULE     = File.join(SOURCE_ROOT, "ext", "apache2", "mod_passenger.so")
-		
-		# Directory possibly containing #{archdir}/passenger_native_support.so.
-		# Not available when natively packaged.
-		NATIVE_SUPPORT_DIR = File.join(SOURCE_ROOT, "ext", "ruby")
-	else
-		SOURCE_ROOT        = NATIVELY_PACKAGED_SOURCE_ROOT
-		DOCDIR             = NATIVELY_PACKAGED_DOCDIR
-		RESOURCES_DIR      = NATIVELY_PACKAGED_RESOURCES_DIR
-		AGENTS_DIR         = NATIVELY_PACKAGED_AGENTS_DIR
-		HELPER_SCRIPTS_DIR = NATIVELY_PACKAGED_HELPER_SCRIPTS_DIR
-		APACHE2_MODULE     = NATIVELY_PACKAGED_APACHE2_MODULE
+	def self.apache2_module_path
+		return @apache2_module_path
+	end
+
+	def self.ruby_extension_source_dir
+		return @ruby_extension_source_dir
 	end
 	
 	
@@ -108,8 +163,51 @@ module PhusionPassenger
 	STANDALONE_BINARIES_URL_ROOT  = "http://standalone-binaries.modrails.com"
 	
 	
-	if !$LOAD_PATH.include?(LIBDIR)
-		$LOAD_PATH.unshift(LIBDIR)
+	if !$LOAD_PATH.include?(ruby_libdir)
+		$LOAD_PATH.unshift(ruby_libdir)
 		$LOAD_PATH.uniq!
 	end
-end if !defined?(PhusionPassenger::LIBDIR)
+
+
+private
+	def self.find_location_configuration_file
+		filename = ENV['PASSENGER_LOCATION_CONFIGURATION_FILE']
+		return filename if filename && !filename.empty?
+
+		filename = File.dirname(FILE_LOCATION) + "/phusion_passenger/locations.ini"
+		return filename if filename && File.exist?(filename)
+
+		require 'etc' if !defined?(Etc)
+		begin
+			home_dir = Etc.getpwuid(Process.uid).dir
+		rescue ArgumentError
+			# Unknown user.
+			home_dir = ENV['HOME']
+		end
+		if home_dir && !home_dir.empty?
+			filename = "#{home_dir}/.passenger/locations.ini"
+			return filename if File.exist?(filename)
+		end
+
+		filename = "/etc/#{GLOBAL_NAMESPACE_DIRNAME}/locations.ini"
+		return filename if File.exist?(filename)
+
+		return nil
+	end
+
+	def self.get_option(filename, options, key, required = true)
+		value = options[key]
+		if value
+			return value
+		elsif required
+			raise "Option '#{key}' missing in file '#{filename}'"
+		else
+			return nil
+		end
+	end
+	
+	def self.get_bool_option(filename, options, key)
+		value = get_option(filename, options, key)
+		return value == 'yes' || value == 'true' || value == 'on' || value == '1'
+	end
+end if !defined?(PhusionPassenger::VERSION_STRING)

data/lib/phusion_passenger/abstract_installer.rb

@@ -25,6 +25,7 @@ require 'phusion_passenger'
 require 'phusion_passenger/constants'
 require 'phusion_passenger/console_text_template'
 require 'phusion_passenger/platform_info'
+require 'phusion_passenger/utils/ansi_colors'
 
 # IMPORTANT: do not directly or indirectly require native_support; we can't compile
 # it yet until we have a compiler, and installers usually check whether a compiler
@@ -35,13 +36,13 @@ module PhusionPassenger
 # Abstract base class for text mode installers. Used by
 # passenger-install-apache2-module and passenger-install-nginx-module.
 #
-# Subclasses must at least implement the #install! method which handles
+# Subclasses must at least implement the #run_steps method which handles
 # the installation itself.
 #
 # Usage:
 #
 #   installer = ConcereteInstallerClass.new(options...)
-#   installer.start
+#   installer.run
 class AbstractInstaller
 	PASSENGER_WEBSITE = "https://www.phusionpassenger.com"
 	PHUSION_WEBSITE = "www.phusion.nl"
@@ -52,18 +53,24 @@ class AbstractInstaller
 	#   installer = AbstractInstaller.new(:foo => "bar")
 	#   installer.instance_variable_get(:"@foo")   # => "bar"
 	def initialize(options = {})
+		@stdout = STDOUT
+		@stderr = STDERR
 		options.each_pair do |key, value|
 			instance_variable_set(:"@#{key}", value)
 		end
 	end
 	
 	# Start the installation by calling the #install! method.
-	def start
+	def run
 		before_install
-		install!
+		run_steps
+		return true
+	rescue Abort
+		puts
+		return false
 	rescue PlatformInfo::RuntimeError => e
 		new_screen
-		color_puts "<red>An error occurred</red>"
+		puts "<red>An error occurred</red>"
 		puts
 		puts e.message
 		exit 1
@@ -71,24 +78,116 @@ class AbstractInstaller
 		after_install
 	end
 
-private
+protected
+	class Abort < StandardError
+	end
+	
+	class CommandError < Abort
+	end
+	
+	
+	def interactive?
+		return !@auto
+	end
+
+	def non_interactive?
+		return !interactive?
+	end
+	
+	
 	def before_install
-		# Hook for subclasses.
+		STDOUT.write(Utils::AnsiColors::DEFAULT_TERMINAL_COLOR)
+		STDOUT.flush
 	end
 	
 	def after_install
-		# Reset terminal colors.
-		STDOUT.write("\e[0m")
+		STDOUT.write(Utils::AnsiColors::RESET)
 		STDOUT.flush
 	end
 	
-	def color_print(text)
-		STDOUT.write(ConsoleTextTemplate.new(:text => text).result)
-		STDOUT.flush
+	def dependencies
+		return []
 	end
 	
-	def color_puts(text)
-		color_print("#{text}\n")
+	def check_dependencies(show_new_screen = true)
+		new_screen if show_new_screen
+		missing_dependencies = []
+		puts "<banner>Checking for required software...</banner>"
+		puts
+		dependencies.each do |dep|
+			print " * #{dep.name}... "
+			result = dep.check
+			if result.found?
+				if result.found_at
+					puts "<green>found at #{result.found_at}</green>"
+				else
+					puts "<green>found</green>"
+				end
+			else
+				puts "<red>not found</red>"
+				missing_dependencies << dep
+			end
+		end
+		
+		if missing_dependencies.empty?
+			return true
+		else
+			puts
+			puts "<red>Some required software is not installed.</red>"
+			puts "But don't worry, this installer will tell you how to install them.\n"
+			puts "<b>Press Enter to continue, or Ctrl-C to abort.</b>"
+			if PhusionPassenger.originally_packaged?
+				wait
+			else
+				wait(10)
+			end
+			
+			line
+			puts
+			puts "<banner>Installation instructions for required software</banner>"
+			puts
+			missing_dependencies.each do |dep|
+				print_dependency_installation_instructions(dep)
+				puts
+			end
+			if respond_to?(:users_guide)
+				puts "If the aforementioned instructions didn't solve your problem, then please take"
+				puts "a look at the Users Guide:"
+				puts
+				puts "  <yellow>#{users_guide}</yellow>"
+			end
+			return false
+		end
+	end
+	
+	
+	def use_stderr
+		old_stdout = @stdout
+		begin
+			@stdout = STDERR
+			yield
+		ensure
+			@stdout = old_stdout
+		end
+	end
+	
+	def print(text)
+		@stdout.write(Utils::AnsiColors.ansi_colorize(text))
+		@stdout.flush
+	end
+	
+	def puts(text = nil)
+		if text
+			@stdout.puts(Utils::AnsiColors.ansi_colorize(text))
+		else
+			@stdout.puts
+		end
+		@stdout.flush
+	end
+
+	def puts_error(text)
+		@stderr.puts(Utils::AnsiColors.ansi_colorize("<red>#{text}</red>"))
+		@stderr.flush
 	end
 	
 	def render_template(name, options = {})
@@ -105,26 +204,50 @@ private
 		puts "--------------------------------------------"
 	end
 	
-	def prompt(message)
+	def prompt(message, default_value = nil)
 		done = false
 		while !done
-			color_print "#{message}: "
+			print "#{message}: "
+			
+			if non_interactive? && default_value
+				puts default_value
+				return default_value
+			end
+			
 			begin
 				result = STDIN.readline
 			rescue EOFError
 				exit 2
 			end
 			result.strip!
-			done = !block_given? || yield(result)
+			if result.empty?
+				if default_value
+					result = default_value
+					done = true
+				else
+					done = !block_given? || yield(result)
+				end
+			else
+				done = !block_given? || yield(result)
+			end
 		end
 		return result
-	rescue Interrupt
-		exit 2
 	end
 	
+	def prompt_confirmation(message)
+		result = prompt("#{message} [y/n]") do |value|
+			if value.downcase == 'y' || value.downcase == 'n'
+				true
+			else
+				puts_error "Invalid input '#{value}'; please enter either 'y' or 'n'."
+				false
+			end
+		end
+		return result.downcase == 'y'
+	end
+
 	def wait(timeout = nil)
-		return if @auto
-		begin
+		if interactive?
 			if timeout
 				require 'timeout' unless defined?(Timeout)
 				begin
@@ -137,11 +260,12 @@ private
 			else
 				STDIN.readline
 			end
-		rescue Interrupt
-			exit 2
 		end
+	rescue Interrupt
+		raise Abort
 	end
 	
+	
 	def sh(*args)
 		puts "# #{args.join(' ')}"
 		result = system(*args)
@@ -154,85 +278,56 @@ private
 		end
 	end
 	
-	def dependencies
-		return []
+	def sh!(*args)
+		if !sh(*args)
+			puts_error "*** Command failed: #{args.join(' ')}"
+			raise CommandError
+		end
 	end
 	
-	def check_dependencies(show_new_screen = true)
-		new_screen if show_new_screen
-		missing_dependencies = []
-		color_puts "<banner>Checking for required software...</banner>"
-		puts
-		dependencies.each do |dep|
-			color_print " * #{dep.name}... "
-			result = dep.check
-			if result.found?
-				if result.found_at
-					color_puts "<green>found at #{result.found_at}</green>"
-				else
-					color_puts "<green>found</green>"
-				end
-			else
-				color_puts "<red>not found</red>"
-				missing_dependencies << dep
-			end
+	def rake(*args)
+		require 'phusion_passenger/platform_info/ruby'
+		if !PlatformInfo.rake_command
+			puts_error 'Cannot find Rake.'
+			raise Abort
 		end
-		
-		if missing_dependencies.empty?
-			return true
-		else
-			puts
-			color_puts "<red>Some required software is not installed.</red>"
-			color_puts "But don't worry, this installer will tell you how to install them.\n"
-			color_puts "<b>Press Enter to continue, or Ctrl-C to abort.</b>"
-			if PhusionPassenger.natively_packaged?
-				wait(10)
-			else
-				wait
-			end
-			
-			line
-			puts
-			color_puts "<banner>Installation instructions for required software</banner>"
-			puts
-			missing_dependencies.each do |dep|
-				print_dependency_installation_instructions(dep)
-				puts
-			end
-			if respond_to?(:users_guide)
-				color_puts "If the aforementioned instructions didn't solve your problem, then please take"
-				color_puts "a look at the Users Guide:"
-				puts
-				color_puts "  <yellow>#{users_guide}</yellow>"
-			end
-			return false
+		sh("#{PlatformInfo.rake_command} #{args.join(' ')}")
+	end
+
+	def rake!(*args)
+		require 'phusion_passenger/platform_info/ruby'
+		if !PlatformInfo.rake_command
+			puts_error 'Cannot find Rake.'
+			raise Abort
 		end
+		sh!("#{PlatformInfo.rake_command} #{args.join(' ')}")
 	end
 	
+	def download(url, output)
+		if PlatformInfo.find_command("wget")
+			return sh("wget", "-O", output, url)
+		else
+			return sh("curl", url, "-f", "-L", "-o", output)
+		end
+	end
+
+private
 	def print_dependency_installation_instructions(dep)
-		color_puts " * To install <yellow>#{dep.name}</yellow>:"
+		puts " * To install <yellow>#{dep.name}</yellow>:"
 		if dep.install_comments
-			color_puts "   " << dep.install_comments
+			puts "   " << dep.install_comments
 		end
 		if !dep.install_command.nil?
-			color_puts "   Please run <b>#{dep.install_command}</b> as root."
+			puts "   Please run <b>#{dep.install_command}</b> as root."
 		elsif !dep.install_instructions.nil?
-			color_puts "   " << dep.install_instructions
+			puts "   " << dep.install_instructions
 		elsif !dep.website.nil?
-			color_puts "   Please download it from <b>#{dep.website}</b>"
+			puts "   Please download it from <b>#{dep.website}</b>"
 			if !dep.website_comments.nil?
-				color_puts "   (#{dep.website_comments})"
+				puts "   (#{dep.website_comments})"
 			end
 		else
-			color_puts "   Search Google."
-		end
-	end
-	
-	def download(url, output)
-		if PlatformInfo.find_command("wget")
-			return sh("wget", "-O", output, url)
-		else
-			return sh("curl", url, "-f", "-L", "-o", output)
+			puts "   Search Google."
 		end
 	end
 end