passenger 4.0.60 → 5.0.0.beta1

data/lib/phusion_passenger/config/install_standalone_runtime_command.rb

@@ -0,0 +1,231 @@
+#  Phusion Passenger - https://www.phusionpassenger.com/
+#  Copyright (c) 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 'optparse'
+require 'logger'
+PhusionPassenger.require_passenger_lib 'constants'
+PhusionPassenger.require_passenger_lib 'platform_info'
+PhusionPassenger.require_passenger_lib 'config/command'
+PhusionPassenger.require_passenger_lib 'config/install_agent_command'
+PhusionPassenger.require_passenger_lib 'config/download_nginx_engine_command'
+PhusionPassenger.require_passenger_lib 'config/compile_nginx_engine_command'
+PhusionPassenger.require_passenger_lib 'utils/ansi_colors'
+PhusionPassenger.require_passenger_lib 'utils/tmpio'
+
+module PhusionPassenger
+module Config
+
+class InstallStandaloneRuntimeCommand < Command
+	def run
+		@options = {
+			:log_level => Logger::INFO,
+			:colorize => :auto,
+			:force => false,
+			:force_tip => true,
+			:compile => true,
+			:install_agent => true,
+			:install_agent_args => [],
+			:download_args => [
+				"--no-error-colors",
+				"--no-compilation-tip"
+			],
+			:compile_args => []
+		}
+		parse_options
+		initialize_objects
+		sanity_check
+		PhusionPassenger::Utils.mktmpdir("passenger-install.", PlatformInfo.tmpexedir) do |tmpdir|
+			install_agent(tmpdir)
+			if !download_nginx_engine
+				compile_nginx_engine(tmpdir)
+			end
+		end
+	end
+
+private
+	def self.create_option_parser(options)
+		OptionParser.new do |opts|
+			nl = "\n" + ' ' * 37
+			opts.banner = "Usage: passenger-config install-standalone-runtime [OPTIONS]\n"
+			opts.separator ""
+			opts.separator "  Install the #{PROGRAM_NAME} Standalone runtime. This runtime consists of"
+			opts.separator "  the #{PROGRAM_NAME} agent, and an Nginx engine. Installation is done either"
+			opts.separator "  by downloading the necessary files from the #{PROGRAM_NAME} website, or"
+			opts.separator "  by compiling them from source."
+			opts.separator ""
+
+			opts.separator "Options:"
+			opts.on("--working-dir PATH", String, "Store temporary files in the given#{nl}" +
+				"directory, instead of creating one") do |val|
+				options[:install_agent_args] << "--working-dir"
+				options[:install_agent_args] << val
+				options[:compile_args] << "--working-dir"
+				options[:compile_args] << val
+			end
+			opts.on("--url-root URL", String, "Download binaries from a custom URL") do |value|
+				options[:install_agent_args] << "--url-root"
+				options[:install_agent_args] << value
+				options[:download_args] << "--url-root"
+				options[:download_args] << value
+			end
+			opts.on("--nginx-version VERSION", String, "Nginx version to compile. " +
+				"Default: #{PREFERRED_NGINX_VERSION}") do |val|
+				options[:nginx_version] = val
+			end
+			opts.on("--nginx-tarball PATH", String, "Use the given Nginx tarball instead of#{nl}" +
+				"downloading it. You MUST also specify the#{nl}" +
+				"Nginx version with --nginx-version") do |val|
+				options[:nginx_tarball] = val
+			end
+			opts.on("--brief", "Report progress in a brief style") do
+				options[:brief] = true
+				options[:install_agent_args] << "--brief"
+				options[:download_args] << "--log-level"
+				options[:download_args] << "warn"
+				options[:download_args] << "--log-prefix"
+				options[:download_args] << "     "
+				options[:download_args] << "--no-download-progress"
+			end
+			opts.on("-f", "--force", "Skip sanity checks") do
+				options[:force] = true
+				options[:install_agent_args] << "--force"
+				options[:download_args] << "--force"
+				options[:compile_args] << "--force"
+			end
+			opts.on("--no-force-tip", "Do not print any tips regarding the --force parameter") do
+				options[:force_tip] = false
+				options[:install_agent_args] << "--no-force-tip"
+				options[:download_args] << "--no-force-tip"
+				options[:compile_args] << "--no-force-tip"
+			end
+			opts.on("--no-compile", "Download, but do not compile") do
+				options[:compile] = false
+				options[:install_agent_args] << "--no-compile"
+			end
+			opts.on("--skip-agent", "Do not install the agent") do
+				options[:install_agent] = false
+			end
+			opts.on("--skip-cache", "Do not copy the binaries from cache") do
+				options[:install_agent_args] << "--skip-cache"
+				options[:download_args] << "--skip-cache"
+			end
+			opts.on("-h", "--help", "Show this help") do
+				options[:help] = true
+			end
+		end
+	end
+
+	def help
+		puts @parser
+	end
+
+	def initialize_objects
+		@colors = Utils::AnsiColors.new(@options[:colorize])
+		@logger = Logger.new(STDOUT)
+		@logger.level = @options[:log_level]
+		@logger.formatter = proc do |severity, datetime, progname, msg|
+			if severity == "FATAL" || severity == "ERROR"
+				color = @colors.red
+			else
+				color = nil
+			end
+			result = ""
+			msg.split("\n", -1).map do |line|
+				result << "#{color}#{@options[:log_prefix]}#{line}#{@colors.reset}\n"
+			end
+			result
+		end
+		if !@options[:nginx_version]
+			if @options[:nginx_tarball]
+				abort "#{@colors.red}Error: if you specify --nginx-tarball, " +
+					"you must also specify --nginx-version.#{@colors.reset}"
+			else
+				@options[:nginx_version] = PREFERRED_NGINX_VERSION
+			end
+		end
+	end
+
+	def sanity_check
+		return if @options[:force]
+
+		all_installed = PhusionPassenger.find_support_binary(AGENT_EXE) &&
+			PhusionPassenger.find_support_binary("nginx-#{@options[:nginx_version]}")
+		if all_installed
+			@logger.warn "#{@colors.green}The #{PROGRAM_NAME} Standalone runtime is already installed."
+			if @options[:force_tip]
+				@logger.warn "If you want to redownload it, re-run this program with the --force parameter."
+			end
+			exit
+		end
+	end
+
+	def install_agent(tmpdir)
+		if @options[:install_agent]
+			args = @options[:install_agent_args].dup
+			args << "--working-dir"
+			args << tmpdir
+			begin
+				InstallAgentCommand.new(args).run
+			rescue SystemExit => e
+				raise e if !e.success?
+			end
+			puts
+		end
+	end
+
+	def download_nginx_engine
+		if @options[:brief]
+			puts " --> Installing Nginx #{@options[:nginx_version]} engine"
+		else
+			puts "#{@colors.blue_bg}#{@colors.yellow}#{@colors.bold}" +
+				"Downloading an Nginx #{@options[:nginx_version]} engine " +
+				"for your platform#{@colors.reset}"
+			puts
+		end
+		begin
+			DownloadNginxEngineCommand.new(@options[:download_args]).run
+			return true
+		rescue SystemExit => e
+			return e.success?
+		end
+	end
+
+	def compile_nginx_engine(tmpdir)
+		puts
+		puts "---------------------------------------"
+		puts
+		if @options[:compile]
+			puts "No precompiled Nginx engine could be downloaded. Compiling it from source instead."
+			puts
+			args = @options[:compile_args].dup
+			args << "--working-dir"
+			args << tmpdir
+			CompileNginxEngineCommand.new(args).run
+		else
+			abort "No precompiled Nginx engine could be downloaded. Refusing to compile because --no-compile is given."
+		end
+	end
+end
+
+end # module Config
+end # module PhusionPassenger

data/lib/phusion_passenger/config/installation_utils.rb

@@ -0,0 +1,241 @@
+# encoding: utf-8
+#
+#  Phusion Passenger - https://www.phusionpassenger.com/
+#  Copyright (c) 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 'pathname'
+require 'etc'
+PhusionPassenger.require_passenger_lib 'constants'
+PhusionPassenger.require_passenger_lib 'ruby_core_enhancements'
+PhusionPassenger.require_passenger_lib 'console_text_template'
+PhusionPassenger.require_passenger_lib 'platform_info/ruby'
+PhusionPassenger.require_passenger_lib 'platform_info/depcheck'
+PhusionPassenger.require_passenger_lib 'utils/ansi_colors'
+
+module PhusionPassenger
+module Config
+
+module InstallationUtils
+	extend self    # Make methods available as class methods.
+
+	def self.included(klass)
+		# When included into another class, make sure that Utils
+		# methods are made private.
+		public_instance_methods(false).each do |method_name|
+			klass.send(:private, method_name)
+		end
+	end
+
+	def find_or_create_writable_support_binaries_dir!
+		if File.exist?(PhusionPassenger.support_binaries_dir)
+			result = directory_writable?(PhusionPassenger.support_binaries_dir)
+			if result == true  # return value can be a SystemCallError
+				return PhusionPassenger.support_binaries_dir
+			end
+
+			if Process.euid == 0
+				if result == false
+					print_installation_error_header
+					render_template 'installation_utils/support_binaries_dir_not_writable_despite_running_as_root',
+						:dir => PhusionPassenger.support_binaries_dir,
+						:myself => myself
+				else
+					render_template 'installation_utils/unexpected_filesystem_problem',
+						:dir => PhusionPassenger.support_binaries_dir,
+						:exception => result
+				end
+				abort
+			else
+				return find_or_create_writable_user_support_binaries_dir!
+			end
+		else
+			if Process.euid == 0
+				mkdir_p_preserve_parent_owner(PhusionPassenger.support_binaries_dir)
+				return PhusionPassenger.support_binaries_dir
+			else
+				return find_or_create_writable_user_support_binaries_dir!
+			end
+		end
+	end
+
+	def check_for_download_tool!
+		PlatformInfo::Depcheck.load('depcheck_specs/utilities')
+		result = PlatformInfo::Depcheck.find('download-tool').check
+		# Don't output anything if there is a download tool.
+		# We want to be as quiet as possible.
+		return if result && result[:found]
+
+		colors = @colors || Utils::AnsiColors.new
+		puts colors.ansi_colorize("<banner>Checking for basic prerequities...</banner>")
+		puts
+
+		runner = PlatformInfo::Depcheck::ConsoleRunner.new
+		runner.add('download-tool')
+
+		result = runner.check_all
+		puts
+		if !result
+			puts "---------------------------------------"
+			puts
+			render_template 'installation_utils/download_tool_missing',
+				:runner => runner
+			abort
+		end
+	end
+
+	# Override this method to print a different header
+	def print_installation_error_header
+		if @colors
+			red = @colors.red
+			reset = @colors.reset
+		else
+			red = nil
+			reset = nil
+		end
+		@logger.warn "------------------------------------------" if @logger
+		puts "#{red}Cannot proceed with installation#{reset}"
+		puts
+	end
+
+	def rake
+		return "env NOEXEC_DISABLE=1 #{PlatformInfo.rake_command}"
+	end
+
+	def run_rake_task!(target)
+		total_lines = `#{rake} #{target} --dry-run STDERR_TO_STDOUT=1`.split("\n").size - 1
+		backlog = ""
+
+		command = "#{rake} #{target} --trace STDERR_TO_STDOUT=1"
+		IO.popen(command, "rb") do |io|
+			progress = 1
+			while !io.eof?
+				line = io.readline
+				yield(progress, total_lines)
+				if line =~ /^\*\* /
+					backlog.replace("")
+					progress += 1
+				else
+					backlog << line
+				end
+			end
+		end
+		if $?.exitstatus != 0
+			stderr = @stderr || STDERR
+			stderr.puts
+			stderr.puts "*** ERROR: the following command failed:"
+			stderr.puts(backlog)
+			exit 1
+		end
+	end
+
+private
+	# We can't use File.writable() and friends here because they
+	# don't always work right with ACLs. Instead of we use 'real'
+	# checks.
+	def directory_writable?(path)
+		filename = "#{path}/.__test_#{object_id}__.txt"
+		@logger.debug "Checking whether we can write to #{path}..." if @logger
+		begin
+			File.new(filename, "w").close
+			@logger.debug "Yes" if @logger
+			return true
+		rescue Errno::EACCES
+			@logger.debug "No" if @logger
+			return false
+		rescue SystemCallError => e
+			@logger.warn "Unable to check whether we can write to #{path}: #{e}" if @logger
+			return e
+		ensure
+			File.unlink(filename) rescue nil
+		end
+	end
+
+	def find_or_create_writable_user_support_binaries_dir!
+		if !File.exist?(PhusionPassenger.user_support_binaries_dir)
+			create_user_support_binaries_dir!
+		end
+		result = directory_writable?(PhusionPassenger.user_support_binaries_dir)
+		case result
+		when true
+			return PhusionPassenger.user_support_binaries_dir
+		when false
+			print_installation_error_header
+			render_template 'installation_utils/user_support_binaries_dir_not_writable'
+			abort
+		else
+			print_installation_error_header
+			render_template 'installation_utils/unexpected_filesystem_problem',
+				:dir => PhusionPassenger.support_binaries_dir,
+				:exception => result
+			abort
+		end
+	end
+
+	def create_user_support_binaries_dir!
+		dir = PhusionPassenger.user_support_binaries_dir
+		begin
+			mkdir_p_preserve_parent_owner(dir)
+		rescue Errno::EACCES
+			print_installation_error_header
+			render_template 'installation_utils/cannot_create_user_support_binaries_dir',
+				:dir => dir,
+				:myself => myself
+			abort
+		rescue SystemCallError
+			print_installation_error_header
+			render_template 'installation_utils/unexpected_filesystem_problem',
+				:dir => dir,
+				:exception => result
+			abort
+		end
+	end
+
+	# When creating PhusionPassenger.support_binaries_dir, preserve the
+	# parent directory's UID and GID. This way, running `passenger-config compile-agent`
+	# with sudo privileged, even though Phusion Passenger isn't installed as root,
+	# won't mess up permissions.
+	def mkdir_p_preserve_parent_owner(path)
+		Pathname.new(path).descend do |subpath|
+			if !subpath.exist?
+				stat = subpath.parent.stat
+				Dir.mkdir(subpath.to_s)
+				if Process.euid == 0
+					File.chown(stat.uid, stat.gid, subpath.to_s)
+				end
+			end
+		end
+	end
+
+	def myself
+		return `whoami`.strip
+	end
+
+	def render_template(name, options = {})
+		options.merge!(:colors => @colors || PhusionPassenger::Utils::AnsiColors.new)
+		puts ConsoleTextTemplate.new({ :file => "config/#{name}" }, options).result
+	end
+end
+
+end # module Config
+end # module PhusionPassenger