passenger 4.0.33 → 4.0.34

data/lib/phusion_passenger/config/about_command.rb

@@ -1,5 +1,5 @@
 #  Phusion Passenger - https://www.phusionpassenger.com/
-#  Copyright (c) 2010-2013 Phusion
+#  Copyright (c) 2010-2014 Phusion
 #
 #  "Phusion Passenger" is a trademark of Hongli Lai & Ninh Bui.
 #
@@ -37,7 +37,7 @@ class AboutCommand < Command
 		puts "Show information about #{PROGRAM_NAME}."
 		puts
 		puts "Available subcommands:"
-		puts "  root                     Show #{PROGRAM_NAME}'s root directory."
+		puts "  root                     Show #{PROGRAM_NAME}'s root."
 		puts "  ruby-libdir              Show #{PROGRAM_NAME}'s Ruby library directory."
 		puts "  includedir               Show the Nginx runtime library headers directory."
 		puts "  nginx-addon-dir          Show #{PROGRAM_NAME}'s Nginx addon directory."
@@ -101,27 +101,48 @@ class AboutCommand < Command
 				exit 1
 			end
 		when "--make-locations-ini"
+			if @argv[1] =~ /^--for-native-packaging-method=(.*)/
+				native_packaging_method = $1
+			else
+				native_packaging_method = nil
+			end
+			
 			puts "[locations]"
-			puts "natively_packaged=#{PhusionPassenger.natively_packaged?}"
-			if PhusionPassenger.natively_packaged?
-				puts "native_packaging_method=#{PhusionPassenger.native_packaging_method}"
+			if native_packaging_method
+				puts "natively_packaged=true"
+				puts "native_packaging_method=#{native_packaging_method}"
+			else
+				puts "natively_packaged=#{PhusionPassenger.natively_packaged?}"
+				if PhusionPassenger.natively_packaged?
+					puts "native_packaging_method=#{PhusionPassenger.native_packaging_method}"
+				end
 			end
 			PhusionPassenger::REQUIRED_LOCATIONS_INI_FIELDS.each do |field|
 				puts "#{field}=#{PhusionPassenger.send(field)}"
 			end
 			PhusionPassenger::OPTIONAL_LOCATIONS_INI_FIELDS.each do |field|
-				if value = PhusionPassenger.send(field)
+				value = PhusionPassenger.send(field)
+				should_print = value &&
+					(!ORIGINALLY_PACKAGED_LOCATIONS_INI_FIELDS.include?(field) || (
+						PhusionPassenger.originally_packaged? &&
+						!native_packaging_method
+					))
+				if should_print
 					puts "#{field}=#{value}"
 				end
 			end
 		when "--detect-apache2"
 			PhusionPassenger.require_passenger_lib 'platform_info/apache_detector'
 			detector = PhusionPassenger::PlatformInfo::ApacheDetector.new(STDOUT)
+			STDOUT.write(Utils::AnsiColors::DEFAULT_TERMINAL_COLOR)
+			STDOUT.flush
 			begin
 				detector.detect_all
 				detector.report
 			ensure
 				detector.finish
+				STDOUT.write(Utils::AnsiColors::RESET)
+				STDOUT.flush
 			end
 		when "--ruby-command"
 			PhusionPassenger.require_passenger_lib 'platform_info/ruby'

data/lib/phusion_passenger/{config.rb → config/main.rb}

@@ -1,5 +1,5 @@
 #  Phusion Passenger - https://www.phusionpassenger.com/
-#  Copyright (c) 2013 Phusion
+#  Copyright (c) 2013-2014 Phusion
 #
 #  "Phusion Passenger" is a trademark of Hongli Lai & Ninh Bui.
 #
@@ -29,6 +29,7 @@ module PhusionPassenger
 module Config
 	KNOWN_COMMANDS = [
 		["restart-app", "RestartAppCommand"],
+		["validate-install", "ValidateInstallCommand"],
 		["about", "AboutCommand"]
 	]
 	
@@ -69,7 +70,7 @@ module Config
 		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
+			printf "  %-18s %s\n", props[0], command_class.description
 		end
 		puts
 		puts "Type 'passenger-config <COMMAND> --help' for more information."

data/lib/phusion_passenger/config/restart_app_command.rb

@@ -1,5 +1,5 @@
 #  Phusion Passenger - https://www.phusionpassenger.com/
-#  Copyright (c) 2010-2013 Phusion
+#  Copyright (c) 2013 Phusion
 #
 #  "Phusion Passenger" is a trademark of Hongli Lai & Ninh Bui.
 #

data/lib/phusion_passenger/config/validate_install_command.rb

@@ -0,0 +1,231 @@
+# 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.
+
+PhusionPassenger.require_passenger_lib 'constants'
+PhusionPassenger.require_passenger_lib 'config/command'
+
+module PhusionPassenger
+module Config
+
+class ValidateInstallCommand < Command
+	# Signifies that there is at least 1 error.
+	FAIL_EXIT_CODE = 1
+	# Signifies that there are no error, but at least 1 warning.
+	WARN_EXIT_CODE = 2
+
+	def self.description
+		return "Validate this #{PROGRAM_NAME} installation"
+	end
+
+	def self.help
+		puts "Usage: passenger-config validate-install"
+		puts "Validate this #{PROGRAM_NAME} installation."
+		puts
+		puts "Exit codes:"
+		puts "  0 - All checks passed. No errors, no warnings."
+		puts "  #{FAIL_EXIT_CODE} - There are some errors."
+		puts "  #{WARN_EXIT_CODE} - There are no errors, but there are some warnings."
+	end
+
+	def run
+		if @argv[0] == '--help'
+			self.class.help
+			exit
+		elsif @argv.size > 0
+			self.class.help
+			exit 1
+		end
+
+		begin
+			require 'rubygems'
+		rescue LoadError
+		end
+		PhusionPassenger.require_passenger_lib 'utils/ansi_colors'
+		PhusionPassenger.require_passenger_lib 'platform_info'
+
+		@error_count = 0
+		@warning_count = 0
+
+		prepare_terminal
+		begin
+			check_tools_in_path
+			check_no_other_installs_in_path
+
+			exit(FAIL_EXIT_CODE) if @error_count > 0
+			exit(WARN_EXIT_CODE) if @warning_count > 0
+		ensure
+			reset_terminal
+		end
+	end
+
+private
+	def prepare_terminal
+		STDOUT.write(Utils::AnsiColors::DEFAULT_TERMINAL_COLOR)
+		STDOUT.flush
+	end
+
+	def reset_terminal
+		STDOUT.write(Utils::AnsiColors::RESET)
+		STDOUT.flush
+	end
+
+	def check_tools_in_path
+		checking "whether this #{PROGRAM_NAME} install is in PATH"
+		paths = ENV['PATH'].to_s.split(':')
+		if paths.include?(gem_bindir) ||
+		   paths.include?(homebrew_bindir) ||
+		   paths.include?(PhusionPassenger.bin_dir)
+			check_ok
+		else
+			check_warning
+			suggest %Q{
+				Please add #{PhusionPassenger.bin_dir} to PATH.
+				Otherwise you will get "command not found" errors upon running
+				passenger-status and other tools.
+
+				Learn more at about PATH at:
+
+				  #{NGINX_DOC_URL}#_the_path_environment_variable
+			}
+		end
+	end
+
+	def check_no_other_installs_in_path
+		logn " * Checking whether there are no other #{PROGRAM_NAME} installations... "
+
+		paths = ENV['PATH'].to_s.split(':')
+		if Process.uid == 0 &&
+		   (sudo_user = ENV['SUDO_USER']) &&
+		   (bash = PlatformInfo.find_command("bash")) &&
+		   PlatformInfo.find_command("sudo")
+			# If we were invoked through sudo then we need to check the original user's PATH too.
+			output = `sudo -u #{sudo_user} #{bash} -lc 'echo; echo PATH FOLLOWS; echo "$PATH"' 2>&1`
+			output.sub!(/.*\nPATH FOLLOWS\n/m, '')
+			output.strip!
+			paths.concat(output.split(':'))
+		end
+
+		paths.delete(gem_bindir)
+		paths.delete(homebrew_bindir)
+		paths.delete(PhusionPassenger.bin_dir)
+		# These may not be in PATH if the user did not run this command through sudo.
+		paths << "/usr/bin"
+		paths << "/usr/sbin"
+		paths.uniq!
+
+		other_installs = []
+		paths.each do |path|
+			filename = "#{path}/passenger-config"
+			if File.exist?(filename)
+				other_installs << filename
+			end
+		end
+		if other_installs.empty?
+			check_ok
+		else
+			check_warning
+			suggest %Q{
+				Besides this #{PROGRAM_NAME} installation, the following other
+				#{PROGRAM_NAME} installations have been detected:
+
+				  #{other_installs.join("\n\t\t\t\t  ")}
+
+				Please uninstall them to avoid confusion or conflicts.
+			}
+		end
+	end
+
+	# Returns the RubyGems bin dir, if Phusion Passenger is installed through RubyGems.
+	def gem_bindir
+		if defined?(Gem) &&
+		   PhusionPassenger.originally_packaged? &&
+		   PhusionPassenger.source_root =~ /^#{Regexp.escape Gem.dir}\// &&
+		   File.exist?("#{Gem.bindir}/passenger-config")
+			return Gem.bindir
+		else
+			return nil
+		end
+	end
+
+	# Returns the Homebrew bin dir, if Phusion Passenger is installed through Homebrew.
+	def homebrew_bindir
+		if PhusionPassenger.native_packaging_method == "homebrew"
+			return "/usr/local/bin"
+		else
+			return nil
+		end
+	end
+
+	def logn(message)
+		if STDOUT.tty?
+			STDOUT.write(Utils::AnsiColors.ansi_colorize(message))
+		else
+			STDOUT.write(Utils::AnsiColors.strip_color_tags(message))
+		end
+		STDOUT.flush
+	end
+
+	def log(message)
+		if STDOUT.tty?
+			STDOUT.puts(Utils::AnsiColors.ansi_colorize(message))
+		else
+			STDOUT.puts(Utils::AnsiColors.strip_color_tags(message))
+		end
+	end
+
+	def checking(message)
+		logn " * Checking #{message}... "
+	end
+
+	def check_ok(message = "✓")
+		log "<green>#{message}</green>"
+	end
+
+	def check_error(message = "✗")
+		log "<red>#{message}</red>"
+		@error_count += 1
+	end
+
+	def check_warning(message = "(!)")
+		log "<yellow>#{message}</yellow>"
+		@warning_count += 1
+	end
+
+	def suggest(message)
+		puts
+		log reindent(unindent(message), 3)
+		puts
+	end
+
+	def unindent(text)
+		return PlatformInfo.send(:unindent, text)
+	end
+
+	def reindent(text, level)
+		return PlatformInfo.send(:reindent, text, level)
+	end
+end
+
+end # module Config
+end # module PhusionPassenger

data/lib/phusion_passenger/constants.rb

@@ -73,9 +73,11 @@ module PhusionPassenger
 		STANDALONE_DOC_URL  = "http://www.modrails.com/documentation/Users%20guide%20Standalone.html"
 		SUPPORT_URL         = "http://www.phusionpassenger.com/support"
 		ENTERPRISE_URL      = "http://www.phusionpassenger.com/enterprise"
+		DEB_MAIN_PACKAGE          = "passenger"
 		DEB_DEV_PACKAGE           = "passenger-dev"
 		DEB_APACHE_MODULE_PACKAGE = "libapache2-mod-passenger"
 		DEB_NGINX_PACKAGE         = "nginx-extras"
+		RPM_MAIN_PACKAGE          = "passenger"
 		RPM_DEV_PACKAGE           = "passenger-devel"
 		RPM_APACHE_MODULE_PACKAGE = "mod_passenger"
 		RPM_NGINX_PACKAGE         = "nginx"

data/lib/phusion_passenger/loader_shared_helpers.rb

@@ -22,6 +22,7 @@
 #  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 #  THE SOFTWARE.
 
+PhusionPassenger.require_passenger_lib 'constants'
 PhusionPassenger.require_passenger_lib 'public_api'
 PhusionPassenger.require_passenger_lib 'debug_logging'
 
@@ -32,11 +33,29 @@ module LoaderSharedHelpers
 	extend self
 
 	# To be called by the (pre)loader as soon as possible.
-	def init
+	def init(options)
 		Thread.main[:name] = "Main thread"
 		# We don't dump PATH info because at this point it's
 		# unlikely to be changed.
 		dump_ruby_environment
+		check_rvm_using_wrapper_script(options)
+		return sanitize_spawn_options(options)
+7	end
+
+	def check_rvm_using_wrapper_script(options)
+		ruby = options["ruby"]
+		if ruby =~ %r(/\.?rvm/) && ruby =~ %r(/bin/ruby$)
+			raise "You've set the `PassengerRuby` (Apache) or `passenger_ruby` (Nginx) option to '#{ruby}'. " +
+				"However, because you are using RVM, this is not allowed: the option must point to " +
+				"an RVM wrapper script, not a raw Ruby binary. This is because RVM is implemented " +
+				"through various environment variables, which are set through the wrapper script.\n" +
+				"\n" +
+				"To find out the correct value for `PassengerRuby`/`passenger_ruby`, please read:\n\n" +
+				"  #{APACHE2_DOC_URL}#PassengerRuby\n\n" +
+				"  #{NGINX_DOC_URL}#PassengerRuby\n\n" +
+				"Scroll to section 'RVM helper tool'.\n" +
+				"\n-------------------------\n"
+		end
 	end
 
 	# To be called whenever the (pre)loader is about to abort with an error.
@@ -201,7 +220,7 @@ module LoaderSharedHelpers
 		# exists then there's a 99.9% chance that loading it is the correct
 		# thing to do.
 		elsif File.exist?('.bundle/environment.rb')
-			running_bundler do
+			running_bundler(options) do
 				require File.expand_path('.bundle/environment')
 			end
 		
@@ -221,7 +240,7 @@ module LoaderSharedHelpers
 			# harmless. If this isn't the correct thing to do after all then
 			# there's always the load_path_setup_file option and
 			# setup_load_paths.rb.
-			running_bundler do
+			running_bundler(options) do
 				require 'rubygems'
 				require 'bundler/setup'
 			end
@@ -325,31 +344,70 @@ module LoaderSharedHelpers
 	end
 
 private
-	def running_bundler
+	def running_bundler(options)
 		yield
 	rescue Exception => e
 		if (defined?(Bundler::GemNotFound) && e.is_a?(Bundler::GemNotFound)) ||
 		   (defined?(Bundler::GitError) && e.is_a?(Bundler::GitError))
-			prepend_exception_comment(e, "It looks like Bundler could not find a gem. This " +
-				"is probably because your\n" +
-				"application is being run under a different environment than it's supposed to.\n" +
-				"Please check the following:\n\n" +
-				" * Is this app supposed to be run as the `#{whoami}` user?\n" +
-				" * Is this app being run on the correct Ruby interpreter? Below you will\n" +
-				"   see which Ruby interpreter Phusion Passenger attempted to use.\n" +
-				" * Are you using RVM? Please check whether the correct gemset is being used.\n" +
-				" * If all of the above fails, try resetting your RVM gemsets:\n" +
-				"   https://github.com/phusion/passenger/wiki/Resetting-RVM-gemsets\n")
+			PhusionPassenger.require_passenger_lib 'platform_info/ruby'
+			comment =
+				"<p>It looks like Bundler could not find a gem. Maybe you didn't install all the " +
+				"gems that this application needs. To install your gems, please run:</p>\n\n" +
+				"  <pre class=\"commands\">bundle install</pre>\n\n"
+			ruby = options["ruby"]
+			if ruby =~ %r(^/usr/local/rvm/)
+				comment <<
+					"<p>If that didn't work, then maybe the problem is that your gems are installed " +
+					"to <code>#{h home_dir}/.rvm/gems</code>, while at the same time you set " +
+					"<code>PassengerRuby</code> (Apache) or <code>passenger_ruby</code> (Nginx) to " +
+					"<code>#{h ruby}</code>. Because of the latter, RVM does not load gems from the " +
+					"home directory.</p>\n\n" +
+					"<p>To make RVM load gems from the home directory, you need to set " +
+					"<code>PassengerRuby</code>/<code>passenger_ruby</code> to an RVM wrapper script " +
+					"inside the home directory:</p>\n\n" +
+					"<ol>\n" +
+					"  <li>Login as #{h whoami}.</li>\n"
+				if PlatformInfo.rvm_installation_mode == :multi
+					comment <<
+						"  <li>Enable RVM mixed mode by running:\n" +
+						"      <pre class=\"commands\">rvm user gemsets</pre></li>\n"
+				end
+				comment <<
+					"  <li>Run this to find out what to set <code>PassengerRuby</code>/<code>passenger_ruby</code> to:\n" +
+					"      <pre class=\"commands\">#{PlatformInfo.ruby_command} \\\n" +
+					"#{PhusionPassenger.bin_dir}/passenger-config --detect-ruby</pre></li>\n" +
+					"</ol>\n\n" +
+					"<p>If that didn't help either, then maybe your application is being run under a " +
+					"different environment than it's supposed to. Please check the following:</p>\n\n"
+			else
+				comment <<
+					"<p>If that didn't work, then the problem is probably caused by your " +
+					"application being run under a different environment than it's supposed to. " +
+					"Please check the following:</p>\n\n"
+			end
+			comment << "<ol>\n"
+			comment <<
+				"  <li>Is this app supposed to be run as the <code>#{h whoami}</code> user?</li>\n" +
+				"  <li>Is this app being run on the correct Ruby interpreter? Below you will\n" +
+				"      see which Ruby interpreter Phusion Passenger attempted to use.</li>\n"
+			if PlatformInfo.in_rvm?
+				comment <<
+					"  <li>Please check whether the correct RVM gemset is being used.</li>\n" +
+					"  <li>Sometimes, RVM gemsets may be broken.\n" +
+					"      <a href=\"https://github.com/phusion/passenger/wiki/Resetting-RVM-gemsets\">Try resetting them.</a></li>\n"
+			end
+			comment << "</ol>\n"
+			prepend_exception_html_comment(e, comment)
 		end
 		raise e
 	end
 
-	def prepend_exception_comment(e, comment)
+	def prepend_exception_html_comment(e, comment)
 		# Since Exception doesn't allow changing the message, we monkeypatch
 		# the #message and #to_s methods.
-		separator = "\n-------- The exception is as follows: -------\n"
-		new_message = comment + separator + e.message
-		new_s = comment + separator + e.to_s
+		separator = "\n<p>-------- The exception is as follows: -------</p>\n"
+		new_message = comment + separator + h(e.message)
+		new_s = comment + separator + h(e.to_s)
 		metaclass = class << e; self; end
 		metaclass.send(:define_method, :message) do
 			new_message
@@ -357,10 +415,18 @@ private
 		metaclass.send(:define_method, :to_s) do
 			new_s
 		end
+		metaclass.send(:define_method, :html?) do
+			true
+		end
+	end
+
+	def h(text)
+		require 'erb' if !defined?(ERB)
+		return ERB::Util.h(text)
 	end
 
 	def whoami
-		require 'etc'
+		require 'etc' if !defined?(Etc)
 		begin
 			user = Etc.getpwuid(Process.uid)
 		rescue ArgumentError
@@ -372,6 +438,13 @@ private
 			return "##{Process.uid}"
 		end
 	end
+
+	def home_dir
+		@home_dir ||= begin
+			require 'etc' if !defined?(Etc)
+			Etc.getpwuid(Process.uid).dir
+		end
+	end
 end
 
 end # module PhusionPassenger