passenger 4.0.30 → 4.0.31

data/lib/phusion_passenger/config/about_command.rb

@@ -0,0 +1,183 @@
+#  Phusion Passenger - https://www.phusionpassenger.com/
+#  Copyright (c) 2010-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'
+PhusionPassenger.require_passenger_lib 'config/command'
+
+module PhusionPassenger
+module Config
+
+class AboutCommand < Command
+	def self.description
+		return "Show information about #{PROGRAM_NAME}"
+	end
+
+	def self.help
+		puts "Usage: passenger-config about <SUBCOMMAND>"
+		puts "Show information about #{PROGRAM_NAME}."
+		puts
+		puts "Available subcommands:"
+		puts "  root                     Show #{PROGRAM_NAME}'s root directory."
+		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."
+		puts "  nginx-libs               Show Nginx runtime library flags."
+		puts "  compiled                 Check whether runtime libraries are compiled."
+		puts "  natively-packaged        Check whether Phusion Passenger is natively"
+		puts "                           packaged."
+		puts "  installed-from-release-package  Check whether this installation came from"
+		puts "                                  an official release package."
+		puts "  make-locations-ini       Generate a locations.ini based on the current"
+		puts "                           install paths."
+		puts "  detect-apache2           Autodetect Apache installations."
+		puts "  ruby-command             Show the correct command for invoking the Ruby"
+		puts "                           interpreter."
+		puts "  rubyext-compat-id        Show the Ruby extension binary compatibility ID."
+		puts "  cxx-compat-id            Show the C++ binary compatibility ID."
+		puts "  version                  Show the version number."
+	end
+
+	def run
+		PhusionPassenger.require_passenger_lib 'platform_info'
+		PhusionPassenger.require_passenger_lib 'platform_info/compiler'
+
+		subcommand = @argv[0].to_s.dup
+		# Compatibility with version <= 4.0.29: accept both
+		# 'subcommand' and '--subcommand'.
+		subcommand = "--#{subcommand}" if subcommand !~ /^--/
+
+		case subcommand
+		when "--root"
+			puts PhusionPassenger.source_root
+		when "--ruby-libdir"
+			puts PhusionPassenger.ruby_libdir
+		when "--includedir"
+			puts PhusionPassenger.include_dir
+		when "--nginx-addon-dir"
+			puts PhusionPassenger.nginx_module_source_dir
+		when "--nginx-libs"
+			puts "#{common_library.link_objects_as_string} #{PhusionPassenger.lib_dir}/common/libboost_oxt.a"
+		when "--compiled"
+			common_library.link_objects.each do |filename|
+				if !File.exist?(filename)
+					exit 1
+				end
+			end
+			if File.exist?("#{PhusionPassenger.lib_dir}/common/libboost_oxt.a")
+				exit 0
+			else
+				exit 1
+			end
+		when "--natively-packaged"
+			if PhusionPassenger.natively_packaged?
+				exit 0
+			else
+				exit 1
+			end
+		when "--installed-from-release-package"
+			if PhusionPassenger.installed_from_release_package?
+				exit 0
+			else
+				exit 1
+			end
+		when "--make-locations-ini"
+			puts "[locations]"
+			puts "natively_packaged=#{PhusionPassenger.natively_packaged?}"
+			if PhusionPassenger.natively_packaged?
+				puts "native_packaging_method=#{PhusionPassenger.native_packaging_method}"
+			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)
+					puts "#{field}=#{value}"
+				end
+			end
+		when "--detect-apache2"
+			PhusionPassenger.require_passenger_lib 'platform_info/apache_detector'
+			detector = PhusionPassenger::PlatformInfo::ApacheDetector.new(STDOUT)
+			begin
+				detector.detect_all
+				detector.report
+			ensure
+				detector.finish
+			end
+		when "--ruby-command"
+			PhusionPassenger.require_passenger_lib 'platform_info/ruby'
+			ruby = PhusionPassenger::PlatformInfo.ruby_command
+			puts "passenger-config was invoked through the following Ruby interpreter:"
+			puts "  Command: #{ruby}"
+			STDOUT.write "  Version: "
+			STDOUT.flush
+			system("/bin/sh -c '#{ruby} -v'")
+			puts "  To use in Apache: PassengerRuby #{ruby}"
+			puts "  To use in Nginx : passenger_ruby #{ruby}"
+			puts "  To use with Standalone: #{ruby} #{PhusionPassenger.bin_dir}/passenger start"
+			puts
+
+			ruby = PhusionPassenger::PlatformInfo.find_command('ruby')
+			if ruby && !ruby.include?("rvm/rubies/")
+				# If this is an RVM Ruby executable then we don't show it. We want people to
+				# use the RVM wrapper scripts only.
+				puts "The following Ruby interpreter was found first in $PATH:"
+				puts "  Command: #{ruby}"
+				STDOUT.write "  Version: "
+				STDOUT.flush
+				system("/bin/sh -c '#{ruby} -v'")
+				puts "  To use in Apache: PassengerRuby #{ruby}"
+				puts "  To use in Nginx : passenger_ruby #{ruby}"
+				puts "  To use with Standalone: #{ruby} #{PhusionPassenger.bin_dir}/passenger start"
+			elsif !ruby.include?("rvm/rubies/")
+				puts "No Ruby interpreter found in $PATH."
+			end
+			puts
+			puts "## Notes for RVM users"
+			puts "Do you want to know which command to use for a different Ruby interpreter? 'rvm use' that Ruby interpreter, then re-run 'passenger-config --ruby-command'."
+		when "--rubyext-compat-id"
+			PhusionPassenger.require_passenger_lib 'platform_info/binary_compatibility'
+			puts PhusionPassenger::PlatformInfo.ruby_extension_binary_compatibility_id
+		when "--cxx-compat-id"
+			PhusionPassenger.require_passenger_lib 'platform_info/binary_compatibility'
+			puts PhusionPassenger::PlatformInfo.cxx_binary_compatibility_id
+		when "--version"
+			puts PhusionPassenger::VERSION_STRING
+		when "--help"
+			self.class.help
+		else
+			self.class.help
+			exit 1
+		end
+	end
+
+private
+	def common_library
+		PhusionPassenger.require_passenger_lib 'common_library'
+		return COMMON_LIBRARY.
+			only(*NGINX_LIBS_SELECTOR).
+			set_output_dir("#{PhusionPassenger.lib_dir}/common/libpassenger_common")
+	end
+end
+
+end # module Config
+end # module PhusionPassenger

data/lib/phusion_passenger/config/command.rb

@@ -0,0 +1,57 @@
+#  Phusion Passenger - https://www.phusionpassenger.com/
+#  Copyright (c) 2010-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.
+
+module PhusionPassenger
+module Config
+
+class Command
+	def self.description
+		return nil
+	end
+
+	def initialize(argv)
+		@argv = argv.dup
+		@options = self.class.create_default_options
+	end
+
+private
+	def self.create_default_options
+		return {}
+	end
+
+	def parse_options
+		@parser = self.class.create_option_parser(@options)
+		begin
+			@parser.parse!(@argv)
+		rescue OptionParser::ParseError => e
+			abort @parser.to_s
+		end
+		if @options[:help]
+			puts @parser
+			exit
+		end
+	end
+end
+
+end # module Config
+end # module PhusionPassenger

data/lib/phusion_passenger/config/restart_app_command.rb

@@ -0,0 +1,146 @@
+#  Phusion Passenger - https://www.phusionpassenger.com/
+#  Copyright (c) 2010-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.
+
+require 'optparse'
+PhusionPassenger.require_passenger_lib 'constants'
+PhusionPassenger.require_passenger_lib 'admin_tools/server_instance'
+PhusionPassenger.require_passenger_lib 'config/command'
+PhusionPassenger.require_passenger_lib 'config/utils'
+
+module PhusionPassenger
+module Config
+
+class RestartAppCommand < Command
+	include PhusionPassenger::Config::Utils
+
+	def self.description
+		return "Restart an application"
+	end
+
+	def run
+		parse_options
+		select_passenger_instance
+		@admin_client = connect_to_passenger_admin_socket(:role => :passenger_status)
+		select_app_group_name
+		perform_restart
+	end
+
+private
+	def self.create_option_parser(options)
+		OptionParser.new do |opts|
+			nl = "\n" + ' ' * 37
+			opts.banner =
+				"Usage 1: passenger-config restart-app <APP PATH PREFIX> [OPTIONS]\n" +
+				"Usage 2: passenger-config restart-app --name <APP GROUP NAME> [OPTIONS]"
+			opts.separator ""
+			opts.separator "  Restart an application. The syntax determines how the application that is to"
+			opts.separator "  be restarted, will be selected."
+			opts.separator ""
+			opts.separator "  1. Selects all applications whose paths begin with the given prefix."
+			opts.separator ""
+			opts.separator "     Example: passenger-config restart-app /webapps"
+			opts.separator "     Restarts all apps whose path begin with /webapps, such as /webapps/foo,"
+			opts.separator "     /webapps/bar and /webapps123."
+			opts.separator ""
+			opts.separator "  2. Selects a specific application based on an exact match of its app group"
+			opts.separator "     name."
+			opts.separator ""
+			opts.separator "     Example: passenger-config restart-app --name /webapps/foo"
+			opts.separator "     Restarts only /webapps/foo, but not for example /webapps/foo/bar or"
+			opts.separator "     /webapps/foo123."
+			opts.separator ""
+
+			opts.separator "Options:"
+			opts.on("--name APP_GROUP_NAME", String, "The app group name to select") do |value|
+				options[:app_group_name] = value
+			end
+			opts.on("--rolling-restart", "Perform a rolling restart instead of a#{nl}" +
+				"regular restart (Enterprise only). The#{nl}" +
+				"default is a blocking restart") do |value|
+				if Config::Utils.is_enterprise?
+					options[:rolling_restart] = true
+				else
+					abort "--rolling-restart is only available in #{PROGRAM_NAME} Enterprise: #{ENTERPRISE_URL}"
+				end
+			end
+			opts.on("--instance PID", Integer, "The #{PROGRAM_NAME} instance to select") do |value|
+				options[:instance] = value
+			end
+			opts.on("-h", "--help", "Show this help") do
+				options[:help] = true
+			end
+		end
+	end
+
+	def help
+		puts @parser
+	end
+
+	def parse_options
+		super
+		case @argv.size
+		when 0
+			if !@options[:app_group_name]
+				abort "Please pass either an app path prefix or an app group name. " +
+					"See --help for more information."
+			end
+		when 1
+			if @options[:app_group_name]
+				abort "You've passed an app path prefix, but you cannot also pass an " +
+					"app group name. Please use only either one of them. See --help " +
+					"for more information."
+			end
+		else
+			help
+			abort
+		end
+	end
+
+	def select_app_group_name
+		groups = @server_instance.groups(@admin_client)
+		if app_group_name = @options[:app_group_name]
+			@groups = [groups.find { |g| g.name == app_group_name }]
+			if !@groups[0]
+				abort "There is no #{PROGRAM_NAME}-served application running with the app group name '#{app_group_name}'."
+			end
+		else
+			regex = /^#{Regexp.escape(@argv.first)}/
+			@groups = groups.find_all { |g| g.app_root =~ regex }
+			if @groups.empty?
+				abort "There are no #{PROGRAM_NAME}-served applications running whose paths begin with '#{@argv.first}'."
+			end
+		end
+	end
+
+	def perform_restart
+		restart_method = @options[:rolling_restart] ? "rolling" : "blocking"
+		@groups.each do |group|
+			puts "Restarting #{group.name}"
+			@admin_client.restart_app_group(group.name,
+				:method => restart_method)
+		end
+	end
+end
+
+end # module Config
+end # module PhusionPassenger

data/lib/phusion_passenger/config/utils.rb

@@ -0,0 +1,108 @@
+#  Phusion Passenger - https://www.phusionpassenger.com/
+#  Copyright (c) 2010-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
+module Config
+
+module Utils
+	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 select_passenger_instance
+		if pid = @options[:instance]
+			@server_instance = AdminTools::ServerInstance.for_pid(pid)
+			if !@server_instance
+				puts "*** ERROR: there doesn't seem to be a #{PROGRAM_NAME} instance running on PID #{pid}."
+				list_all_passenger_instances(AdminTools::ServerInstance.list)
+				puts
+				puts "Please pass `--instance <#{PROGRAM_NAME}> PID>` to select a specific #{PROGRAM_NAME} instance."
+				abort
+			end
+		else
+			server_instances = AdminTools::ServerInstance.list
+			if server_instances.empty?
+				abort "*** ERROR: Phusion Passenger doesn't seem to be running."
+			elsif server_instances.size == 1
+				@server_instance = server_instances.first
+			else
+				complain_that_multiple_passenger_instances_are_running(server_instances)
+				abort
+			end
+		end
+	end
+
+	def complain_that_multiple_passenger_instances_are_running(server_instances)
+		puts "It appears that multiple #{PROGRAM_NAME} instances are running. Please select"
+		puts "a specific one by passing:"
+		puts
+		puts "  --instance <#{PROGRAM_NAME} PID>"
+		puts
+		list_all_passenger_instances(server_instances)
+		abort
+	end
+
+	def list_all_passenger_instances(server_instances)
+		puts "The following #{PROGRAM_NAME} instances are running:"
+		server_instances.each do |instance|
+			begin
+				description = instance.web_server_description
+			rescue Errno::EACCES, Errno::ENOENT
+				description = nil
+			end
+			printf "  PID: %-8s   %s\n", instance.pid, description
+		end
+	end
+
+	def connect_to_passenger_admin_socket(options)
+		return @server_instance.connect(options)
+	rescue AdminTools::ServerInstance::RoleDeniedError
+		PhusionPassenger.require_passenger_lib 'platform_info/ruby'
+		STDERR.puts "*** ERROR: You are not authorized to query the status for " +
+			"this #{PROGRAM_NAME} instance. Please try again with '#{PlatformInfo.ruby_sudo_command}'."
+		exit 2
+	rescue AdminTools::ServerInstance::CorruptedDirectoryError
+		STDERR.puts "*** ERROR: The server instance directory #{server_instance.path} is corrupted. " +
+			"This could have two causes:\n" +
+			"\n" +
+			"  1. The #{PROGRAM_NAME} instance is no longer running, but it failed to cleanup the directory. " +
+				"Please delete this directory and ignore the problem.\n" +
+			"  2. An external program corrupted the directory. Please restart this #{PROGRAM_NAME} instance.\n"
+		exit 2
+	end
+
+	def is_enterprise?
+		return defined?(PhusionPassenger::PASSENGER_IS_ENTERPRISE) && PhusionPassenger::PASSENGER_IS_ENTERPRISE
+	end
+end
+
+end # module Config
+end # module PhusionPassenger