passenger 4.0.60 → 5.0.0.beta1

data/lib/phusion_passenger/config/list_instances_command.rb

@@ -23,7 +23,7 @@
 
 require 'optparse'
 PhusionPassenger.require_passenger_lib 'constants'
-PhusionPassenger.require_passenger_lib 'admin_tools/server_instance'
+PhusionPassenger.require_passenger_lib 'admin_tools/instance_registry'
 PhusionPassenger.require_passenger_lib 'config/command'
 PhusionPassenger.require_passenger_lib 'config/utils'
 PhusionPassenger.require_passenger_lib 'utils/json'
@@ -36,13 +36,13 @@ class ListInstancesCommand < Command
 
 	def run
 		parse_options
-		server_instances = AdminTools::ServerInstance.list
+		instances = AdminTools::InstanceRegistry.new.list
 		if @options[:json]
-			print_json(server_instances)
-		elsif server_instances.empty?
+			print_json(instances)
+		elsif instances.empty?
 			print_no_instances_running
 		else
-			print_instances(server_instances)
+			print_instances(instances)
 		end
 	end
 
@@ -85,31 +85,19 @@ private
 		end
 	end
 
-	def print_json(server_instances)
+	def print_json(instances)
 		result = []
-		server_instances.each do |instance|
-			begin
-				description = instance.web_server_description
-			rescue Errno::EACCES, Errno::ENOENT
-				description = nil
-			end
-			result << {
-				:pid => instance.pid,
-				:description => description
-			}
+		instances.each do |instance|
+			result << instance.properties
 		end
 		puts PhusionPassenger::Utils::JSON.generate(result)
 	end
 
-	def print_instances(server_instances)
-		printf "%-8s   %s\n", "PID", "Description"
-		server_instances.each do |instance|
-			begin
-				description = instance.web_server_description
-			rescue Errno::EACCES, Errno::ENOENT
-				description = nil
-			end
-			printf "%-8s   %s\n", instance.pid, description
+	def print_instances(instances)
+		printf "%-25s  %s\n", "Name", "Description"
+		puts "------------------------------------------------------------------"
+		instances.each do |instance|
+			printf "%-25s  %s\n", instance.name, instance.server_software
 		end
 	end
 end

data/lib/phusion_passenger/config/main.rb

@@ -31,19 +31,29 @@ module Config
 		["detach-process", "DetachProcessCommand"],
 		["restart-app", "RestartAppCommand"],
 		["list-instances", "ListInstancesCommand"],
-		["build-native-support", "BuildNativeSupportCommand"],
+		["reopen-logs", "ReopenLogsCommand"],
+		["admin-command", "AdminCommandCommand"],
 		["validate-install", "ValidateInstallCommand"],
+		["build-native-support", "BuildNativeSupportCommand"],
+
+		["install-agent", "InstallAgentCommand"],
+		["install-standalone-runtime", "InstallStandaloneRuntimeCommand"],
+		["download-agent", "DownloadAgentCommand"],
+		["download-nginx-engine", "DownloadNginxEngineCommand"],
+		["compile-agent", "CompileAgentCommand"],
+		["compile-nginx-engine", "CompileNginxEngineCommand"],
+
 		["system-metrics", "SystemMetricsCommand"],
 		["about", "AboutCommand"]
 	]
-	
+
 	ABOUT_OPTIONS = [
 		"root",
 		"includedir",
 		"nginx-addon-dir",
 		"nginx-libs",
 		"compiled",
-		"natively-packaged",
+		"custom-packaged",
 		"installed-from-release-package",
 		"make-locations-ini",
 		"detect-apache2",
@@ -70,25 +80,44 @@ module Config
 	end
 
 	def self.help(all = false)
-		puts "Usage: passenger-config <COMMAND> [options]"
-		puts "Tool for controlling or configurating a #{PROGRAM_NAME} instance or installation."
+		puts "Usage: passenger-config <COMMAND> [OPTIONS...]"
+		puts
+		puts "  Tool for managing, controlling and configuring a #{PROGRAM_NAME} instance"
+		puts "  or installation."
 		puts
 		puts "Management commands:"
-		puts "  detach-process        Detach an application process from the process pool"
-		puts "  restart-app           Restart an application"
+		puts "  detach-process         Detach an application process from the process pool"
+		puts "  restart-app            Restart an application"
+		puts "  reopen-logs            Instruct #{PROGRAM_NAME} agents to reopen their log"
+		puts "                         files"
+		if all
+			puts "  admin-command          Invoke an internal #{PROGRAM_NAME} admin command."
+		end
 		puts
 		puts "Informational commands:"
-		puts "  validate-install      Validate this #{PROGRAM_NAME} installation"
-		puts "  list-instances        List running #{PROGRAM_NAME} instances"
-		puts "  about                 Show information about #{PROGRAM_NAME}"
+		puts "  list-instances         List running #{PROGRAM_NAME} instances"
+		puts "  about                  Show information about #{PROGRAM_NAME}"
 		puts
-		puts "Miscellaneous commands:"
-		puts "  build-native-support  Ensure that the native_support library for the current"
-		puts "                        Ruby interpeter is built"
+		puts "#{PROGRAM_NAME} installation management:"
+		puts "  validate-install       Validate this #{PROGRAM_NAME} installation"
+		puts "  build-native-support   Ensure that the native_support library for the current"
+		puts "                         Ruby interpeter is built"
+		puts "  install-agent          Install the #{PROGRAM_NAME} agent binary"
+		puts "  install-standalone-runtime"
+		puts "                         Install the #{PROGRAM_NAME} Standalone"
+		puts "                         runtime"
 		if all
-			puts "  system-metrics        Display system metrics"
+			puts "  download-agent         Download the #{PROGRAM_NAME} agent binary"
+			puts "  download-nginx-engine  Download the Nginx engine for use with"
+			puts "                         #{PROGRAM_NAME} Standalone"
+			puts "  compile-agent          Compile the #{PROGRAM_NAME} agent binary"
+			puts "  compile-nginx-engine   Compile an Nginx engine for use with #{PROGRAM_NAME}"
+			puts "                         Standalone"
 		end
 		puts
+		puts "Miscellaneous commands:"
+		puts "  system-metrics        Display system metrics"
+		puts
 		puts "Run 'passenger-config <COMMAND> --help' for more information about each"
 		puts "command."
 		if !all

data/lib/phusion_passenger/config/nginx_engine_compiler.rb

@@ -0,0 +1,337 @@
+#  encoding: utf-8
+#
+#  Phusion Passenger - https://www.phusionpassenger.com/
+#  Copyright (c) 2010-2014 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 'fileutils'
+require 'logger'
+PhusionPassenger.require_passenger_lib 'constants'
+PhusionPassenger.require_passenger_lib 'abstract_installer'
+PhusionPassenger.require_passenger_lib 'common_library'
+PhusionPassenger.require_passenger_lib 'config/installation_utils'
+PhusionPassenger.require_passenger_lib 'platform_info'
+PhusionPassenger.require_passenger_lib 'platform_info/compiler'
+PhusionPassenger.require_passenger_lib 'utils/shellwords'
+PhusionPassenger.require_passenger_lib 'utils/progress_bar'
+PhusionPassenger.require_passenger_lib 'utils/tmpio'
+
+module PhusionPassenger
+module Config
+
+class NginxEngineCompiler < AbstractInstaller
+	include InstallationUtils
+
+protected
+	def dependencies
+		specs = [
+			'depcheck_specs/compiler_toolchain',
+			'depcheck_specs/ruby',
+			'depcheck_specs/libs',
+			'depcheck_specs/utilities'
+		]
+		ids = [
+			'cc',
+			'c++',
+			'gmake',
+			'rake',
+			'openssl-dev',
+			'zlib-dev',
+			'pcre-dev'
+		].compact
+		return [specs, ids]
+	end
+
+	def users_guide_path
+		return PhusionPassenger.standalone_doc_path
+	end
+
+	def users_guide_url
+		return STANDALONE_DOC_URL
+	end
+
+	def run_steps
+		check_source_code_available!
+		check_precompiled_support_libs_available!
+		if !@force
+			check_whether_os_is_broken
+			check_whether_system_has_enough_ram
+			check_for_download_tool!
+		end
+		check_dependencies(false) || abort
+		puts
+
+		@destdir = find_or_create_writable_support_binaries_dir!
+		puts "<banner>Installing...</banner>"
+		download_and_extract_nginx_sources
+		determine_support_libraries
+		compile_support_libraries
+		configure_and_compile_nginx
+	end
+
+	def before_install
+		super
+		if !@working_dir
+			@working_dir = PhusionPassenger::Utils.mktmpdir("passenger-install.", PlatformInfo.tmpexedir)
+			@owns_working_dir = true
+		end
+		@nginx_version ||= PREFERRED_NGINX_VERSION
+	end
+
+	def after_install
+		super
+		FileUtils.remove_entry_secure(@working_dir) if @owns_working_dir
+	end
+
+private
+	def check_source_code_available!
+		return if File.exist?(PhusionPassenger.nginx_module_source_dir)
+
+		if PhusionPassenger.originally_packaged?
+			puts "<red>Broken #{PROGRAM_NAME} installation detected</red>"
+			puts
+			puts "This program requires the #{PROGRAM_NAME} Nginx module sources " +
+				"before it can compile an Nginx engine. However, the #{PROGRAM_NAME} " +
+				"Nginx module sources are not installed, even though they should have been. " +
+				"This probably means that your #{PROGRAM_NAME} installation has somehow " +
+				"become corrupted. Please re-install #{PROGRAM_NAME}."
+			abort
+		else
+			case PhusionPassenger.packaging_method
+			when "deb"
+				command = "sudo sh -c 'apt-get update && apt-get install #{DEB_DEV_PACKAGE}'"
+			when "rpm"
+				command = "sudo yum install #{RPM_DEV_PACKAGE}-#{VERSION_STRING}"
+			end
+
+			if command
+				if STDIN.tty?
+					puts " --> Installing #{PROGRAM_NAME} Nginx module sources"
+					puts "     Running: #{command}"
+					if !system(command)
+						puts "     <red>*** Command failed: #{command}</red>"
+						abort
+					end
+				else
+					puts " --> #{PROGRAM_NAME} Nginx module sources not installed"
+					puts "     Please install them first: #{command}"
+					abort
+				end
+			else
+				puts " --> #{PROGRAM_NAME} Nginx module sources not installed"
+				puts "     <red>Please ask your #{PROGRAM_NAME} packager or operating " +
+					"system vendor how to install these.</red>"
+				abort
+			end
+		end
+	end
+
+	def check_precompiled_support_libs_available!
+		return if PhusionPassenger.build_system_dir ||
+			File.exist?("#{PhusionPassenger.lib_dir}/common/libboost_oxt.a")
+
+		if PhusionPassenger.originally_packaged?
+			puts "<red>Broken #{PROGRAM_NAME} installation detected</red>"
+			puts
+			puts "This program requires the #{PROGRAM_NAME} support libraries " +
+				"before it can compile an Nginx engine. However, the #{PROGRAM_NAME} " +
+				"support libraries are not installed, even though they should have been. " +
+				"This probably means that your #{PROGRAM_NAME} installation has somehow " +
+				"become corrupted. Please re-install #{PROGRAM_NAME}."
+			abort
+		else
+			case PhusionPassenger.packaging_method
+			when "deb"
+				command = "sudo sh -c 'apt-get update && apt-get install #{DEB_DEV_PACKAGE}'"
+			when "rpm"
+				command = "sudo yum install #{RPM_DEV_PACKAGE}-#{VERSION_STRING}"
+			end
+
+			if command
+				if STDIN.tty?
+					puts " --> Installing #{PROGRAM_NAME} support libraries"
+					puts "     Running: #{command}"
+					if !system(command)
+						puts "     <red>*** Command failed: #{command}</red>"
+						abort
+					end
+				else
+					puts " --> #{PROGRAM_NAME} support libraries not installed"
+					puts "     Please install them first: #{command}"
+					abort
+				end
+			else
+				puts " --> #{PROGRAM_NAME} support libraries not installed"
+				puts "     <red>Please ask your #{PROGRAM_NAME} packager or operating " +
+					"system vendor how to install these.</red>"
+				abort
+			end
+		end
+	end
+
+	def download_and_extract_nginx_sources
+		if @nginx_tarball
+			tarball  = @nginx_tarball
+		else
+			puts "Downloading Nginx #{@nginx_version} source code..."
+			basename = "nginx-#{@nginx_version}.tar.gz"
+			tarball  = "#{@working_dir}/#{basename}"
+			result = download("http://nginx.org/download/#{basename}",
+				tarball, :show_progress => @stdout.tty?)
+			if !result
+				puts
+				show_possible_solutions_for_download_and_extraction_problems
+				abort
+			end
+		end
+		nginx_sources_name = "nginx-#{@nginx_version}"
+
+		puts "Extracting tarball..."
+		e_working_dir = Shellwords.escape(@working_dir)
+		e_tarball = Shellwords.escape(tarball)
+		system("cd #{e_working_dir} && tar xzf #{e_tarball}")
+	end
+
+	def determine_support_libraries
+		lib_dir = "#{@working_dir}/common/libpassenger_common"
+		@support_libs = COMMON_LIBRARY.only(*NGINX_LIBS_SELECTOR).
+			set_output_dir(lib_dir).
+			link_objects
+		@support_libs << "#{@working_dir}/common/libboost_oxt.a"
+		@support_libs_string = @support_libs.join(" ")
+	end
+
+	def compile_support_libraries
+		puts "Compiling support libraries (step 1 of 2)..."
+		progress_bar = ProgressBar.new
+		e_working_dir = Shellwords.escape(@working_dir)
+		args = "#{@support_libs_string} CACHING=false OUTPUT_DIR=#{e_working_dir}"
+		begin
+			progress_bar.set(0.05)
+			Dir.chdir(PhusionPassenger.build_system_dir) do
+				run_rake_task!(args) do |progress, total|
+					progress_bar.set(0.05 + (progress / total.to_f) * 0.95)
+				end
+			end
+			progress_bar.set(1)
+		ensure
+			progress_bar.finish
+		end
+	end
+
+	def configure_and_compile_nginx
+		puts "Compiling Nginx engine (step 2 of 2)..."
+		progress_bar = ProgressBar.new
+		progress_bar.set(0)
+		begin
+			configure_nginx do
+				progress_bar.set(0.25)
+			end
+			compile_nginx do |progress|
+				progress_bar.set(0.25 + progress * 0.75)
+			end
+			progress_bar.set(1)
+		ensure
+			progress_bar.finish
+		end
+
+		FileUtils.cp("#{@working_dir}/nginx-#{@nginx_version}/objs/nginx",
+			"#{@destdir}/nginx-#{@nginx_version}")
+		puts "<green>Compilation finished!</green>"
+	end
+
+	def configure_nginx
+		shell = PlatformInfo.find_command('bash') || "sh"
+		e_nginx_source_dir = Shellwords.escape("#{@working_dir}/nginx-#{@nginx_version}")
+
+		command = "cd #{e_nginx_source_dir} && "
+		command << "env PASSENGER_INCLUDEDIR=#{Shellwords.escape PhusionPassenger.include_dir} " <<
+			"PASSENGER_LIBS=#{Shellwords.escape(@support_libs_string)} "
+		# RPM thinks it's being smart by scanning binaries for
+		# paths and refusing to create package if it detects any
+		# hardcoded thats that point to /usr or other important
+		# locations. For Phusion Passenger Standalone we do not
+		# care at all what the Nginx configured prefix is because
+		# we pass it its resource locations during runtime, so
+		# work around the problem by configure Nginx with prefix
+		# /tmp.
+		command << "#{shell} ./configure --prefix=/tmp " +
+			"#{STANDALONE_NGINX_CONFIGURE_OPTIONS} " +
+			"--add-module=#{Shellwords.escape PhusionPassenger.nginx_module_source_dir}"
+		run_command_yield_activity(command) do |throbber|
+			yield
+		end
+	end
+
+	def compile_nginx
+		backlog = ""
+		e_nginx_source_dir = Shellwords.escape("#{@working_dir}/nginx-#{@nginx_version}")
+
+		# Capture and index the `make --dry-run` output for
+		# progress determination.
+		total_lines = 0
+		dry_run_output = {}
+		`cd #{e_nginx_source_dir} && #{PlatformInfo.gnu_make} --dry-run`.split("\n").each do |line|
+			total_lines += 1
+			dry_run_output[line] = true
+		end
+
+		IO.popen("cd #{e_nginx_source_dir} && #{PlatformInfo.gnu_make} 2>&1", "r") do |io|
+			progress = 1
+			while !io.eof?
+				line = io.readline
+				backlog << line
+				# If the output is part of what we saw when dry-running,
+				# then increase progress bar. Otherwise it could be compiler
+				# warnings or something, so ignore those.
+				if dry_run_output[line.chomp]
+					yield(progress / total_lines.to_f)
+					progress += 1
+				end
+			end
+		end
+		if $?.exitstatus != 0
+			@stderr.puts
+			@stderr.puts "*** ERROR: unable to compile web helper."
+			@stderr.puts backlog
+			exit 1
+		end
+	end
+
+	def run_command_yield_activity(command)
+		backlog = ""
+		IO.popen("#{command} 2>&1", "rb") do |io|
+			while !io.eof?
+				backlog << io.readline
+				yield
+			end
+		end
+		if $?.exitstatus != 0
+			@stderr.puts
+			@stderr.puts backlog
+			@stderr.puts "*** ERROR: command failed: #{command}"
+			exit 1
+		end
+	end
+end
+
+end # module Standalone
+end # module PhusionPassenger