passenger 1.0.5 → 2.0.1

data/DEVELOPERS.TXT

@@ -4,25 +4,56 @@
 
 The tests need the following software installed:
 
-* All the usual Passenger dependencies.
+* All the usual Phusion Passenger dependencies.
 * Ruby on Rails >= 2.0.1
 * rspec >= 1.1.2
 * mime-types >= 1.15
 
 The following software is optional:
 
+* RCov, for code coverage
 * RDoc, for generating HTML Ruby API documentation
 * Doxygen, for generating HTML C++ API documentation
 * dot (part of Graphviz), for generating diagrams in HTML API documentation
 * The font "Bitstream Vera Sans", used in the class diagrams. See http://www.gnome.org/fonts
 * AsciiDoc >= 8.2.5, for converting various doc/*.txt documents to HTML
 
-== Compiling Passenger
+== Compiling Phusion Passenger
 
 Run the following command to compile everything:
 
  rake
 
+== Directory structure
+
+The most important directories are:
+[ lib/passenger ]
+  The source code for the spawn server, which is written in Ruby.
+[ ext/passenger ]
+  Native extensions for Ruby, used by the spawn server.
+[ ext/apache2 ]
+  The Phusion Passenger Apache 2 module (mod_passenger).
+[ bin ]
+  Executables.
+[ doc ]
+  Various documentation.
+[ test ]
+  Unit tests and integration tests.
+[ test/support ]
+  Support/utility code, used in the tests.
+[ test/stub ]
+  Stub code, used in the tests.
+
+Less important directories:
+[ lib/rake ]
+  Rake tasks.
+[ ext/boost ]
+  A vendor copy of the Boost C++ library (www.boost.org).
+[ benchmark ]
+  Benchmark tools.
+[ misc ]
+  Miscellaneous tools.
+
 == Tests
 
 Run all tests:

data/INSTALL

@@ -1,2 +1,4 @@
-Please read the file 'doc/Users guide.html' for installation instructions,
-configuration instructions and troubleshooting tips.
+Please read the file README for installation instructions.
+
+If you're having trouble installing Phusion Passenger, please
+read the file 'doc/Users guide.html'.

data/LICENSE

@@ -1,15 +1,16 @@
-Passenger is licensed under the GNU General Public License (GPL) version 2, and
-*only* version 2 (i.e. not version 3 or any later versions).
+Phusion Passenger is licensed under the GNU General Public License (GPL)
+version 2, and *only* version 2 (i.e. not version 3 or any later versions).
 
 In addition to the GNU General Public License v2 licensing terms, we explicitly
-grand you the permission to run any application on top of Passenger, regardless
-of the application's own licensing terms. The application will not be bound to
-the terms of the GPL in any way. That is, the GPL only applies to Passenger
-itself, and not to applications that are run through Passenger.
-
-We also explicitly allow Apache to load the Passenger Apache module, without
-Apache or any other loaded modules needing to be released under the terms of
-the GPL.
+grand you the permission to run any application on top of Phusion Passenger,
+regardless of the application's own licensing terms. The application will not
+be bound to the terms of the GPL in any way. That is, the GPL only applies to
+Phusion Passenger itself, and not to applications that are run through Phusion
+Passenger.
+
+We also explicitly allow Apache to load the Phusion Passenger Apache module,
+without Apache or any other loaded modules needing to be released under the
+terms of the GPL.
 
 ----------------------------------------------------------------------
 

data/README

@@ -1,10 +1,12 @@
 == Introduction
 
-Passenger probably requires no introduction. We kindly refer the reader to
-http://www.modrails.com/ for general information.
+Phusion Passenger probably requires no introduction. We kindly refer the reader
+to http://www.modrails.com/ for general information.
 
 == Installation
 
+=== Regular installation
+
 Run the following script as root:
 
  ./bin/passenger-install-apache2-module
@@ -15,5 +17,22 @@ For troubleshooting, configuration and tips, please read the Users Guide:
 
  doc/Users guide.html
 
-This file is included in the source tarball, may also be viewed online on our
-website.
+This file is included in the source tarball, and may also be viewed online on
+our website.
+
+=== Installing via a gem
+
+You may also first generate a .gem file, and then install that.
+First, make sure that you have the following software installed:
+- Doxygen: http://www.stack.nl/~dimitri/doxygen/
+- Asciidoc: http://www.methods.co.nz/asciidoc/
+
+Next, run:
+
+ rake package
+
+The gem will be available under the 'pkg' folder.
+
+== Legal
+
+Phusion Passenger is a trademark of Hongli Lai & Ninh Bui.

data/Rakefile

@@ -27,7 +27,8 @@ require 'passenger/platform_info'
 ##### Configuration
 
 # Don't forget to edit Configuration.h too
-PACKAGE_VERSION = "1.0.5"
+PACKAGE_VERSION = "2.0.1"
+OPTIMIZE = ["yes", "on", "true"].include?(ENV['OPTIMIZE'])
 
 include PlatformInfo
 APXS2.nil? and raise "Could not find 'apxs' or 'apxs2'."
@@ -37,7 +38,12 @@ APR_FLAGS.nil? and raise "Could not find Apache Portable Runtime (APR)."
 
 CXX = "g++"
 THREADING_FLAGS = "-D_REENTRANT"
-CXXFLAGS = "#{THREADING_FLAGS} -Wall -g -I/usr/local/include " << MULTI_ARCH_FLAGS
+if OPTIMIZE
+	OPTIMIZATION_FLAGS = "-O2 -DNDEBUG"
+else
+	OPTIMIZATION_FLAGS = "-g -DPASSENGER_DEBUG"
+end
+CXXFLAGS = "#{THREADING_FLAGS} #{OPTIMIZATION_FLAGS} -Wall -I/usr/local/include #{MULTI_ARCH_FLAGS}"
 LDFLAGS = ""
 
 
@@ -64,7 +70,7 @@ subdir 'ext/passenger' do
 	task :native_support => ["native_support.#{LIBEXT}"]
 	
 	file 'Makefile' => 'extconf.rb' do
-		sh "ruby extconf.rb"
+		sh "#{RUBY} extconf.rb"
 	end
 	
 	file "native_support.#{LIBEXT}" => ['Makefile', 'native_support.c'] do
@@ -81,14 +87,14 @@ end
 ##### boost::thread static library
 
 subdir 'ext/boost/src' do
-	file 'libboost_thread.a' => Dir['*.cpp'] do
-		# Note: NDEBUG *must* be defined! boost::thread use assert() to check whether
-		# the pthread functions return an error. Because of the way Passenger uses
-		# processes, sometimes pthread errors will occur. These errors are harmless
-		# and should be ignored. Defining NDEBUG guarantees that boost::thread() will
-		# not abort if such an error occured.
-		flags = "-O2 -fPIC -I../.. #{THREADING_FLAGS} -DNDEBUG #{MULTI_ARCH_FLAGS}"
+	file 'libboost_thread.a' => Dir['*.cpp'] + Dir['pthread/*.cpp'] do
+		flags = "#{OPTIMIZATION_FLAGS} -fPIC -I../.. #{THREADING_FLAGS} -DNDEBUG #{MULTI_ARCH_FLAGS}"
 		compile_cxx "*.cpp", flags
+		# NOTE: 'compile_cxx "pthread/*.cpp", flags' doesn't work on some systems,
+		# so we do this instead.
+		Dir['pthread/*.cpp'].each do |file|
+			compile_cxx file, flags
+		end
 		create_static_library "libboost_thread.a", "*.o"
 	end
 	
@@ -101,15 +107,15 @@ end
 ##### Apache module
 
 class APACHE2
-	CXXFLAGS = "-I.. -fPIC -g -DPASSENGER_DEBUG #{APR_FLAGS} #{APXS2_FLAGS} #{CXXFLAGS}"
+	CXXFLAGS = "-I.. -fPIC #{OPTIMIZATION_FLAGS} #{APR_FLAGS} #{APXS2_FLAGS} #{CXXFLAGS}"
 	OBJECTS = {
 		'Configuration.o' => %w(Configuration.cpp Configuration.h),
 		'Hooks.o' => %w(Hooks.cpp Hooks.h
-				Configuration.h ApplicationPool.h StandardApplicationPool.h
-				ApplicationPoolClientServer.h
+				Configuration.h ApplicationPool.h ApplicationPoolServer.h
 				SpawnManager.h Exceptions.h Application.h MessageChannel.h
-				Utils.h),
-		'Utils.o' => %w(Utils.cpp Utils.h),
+				System.h Utils.h),
+		'System.o'  => %w(System.cpp System.h),
+		'Utils.o'   => %w(Utils.cpp Utils.h),
 		'Logging.o' => %w(Logging.cpp Logging.h)
 	}
 end
@@ -118,9 +124,12 @@ subdir 'ext/apache2' do
 	apxs_objects = APACHE2::OBJECTS.keys.join(',')
 
 	desc "Build mod_passenger Apache 2 module"
-	task :apache2 => ['mod_passenger.so', :native_support]
+	task :apache2 => ['mod_passenger.so', 'ApplicationPoolServerExecutable', :native_support]
 	
-	file 'mod_passenger.so' => ['../boost/src/libboost_thread.a', 'mod_passenger.o'] + APACHE2::OBJECTS.keys do
+	file 'mod_passenger.so' => [
+		'../boost/src/libboost_thread.a',
+		'mod_passenger.o'
+	] + APACHE2::OBJECTS.keys do
 		# apxs totally sucks. We couldn't get it working correctly
 		# on MacOS X (it had various problems with building universal
 		# binaries), so we decided to ditch it and build/install the
@@ -134,25 +143,20 @@ subdir 'ext/apache2' do
 			linkflags
 	end
 	
-	desc "Install mod_passenger Apache 2 module"
-	task 'apache2:install' => :apache2 do
-		install_dir = `#{APXS2} -q LIBEXECDIR`.strip
-		# We must remove the module before we copy it, otherwise Apache
-		# may crash. See http://tinyurl.com/2n6ws4
-		sh "rm", "-f", "#{install_dir}/mod_passenger.so"
-		sh "cp", "mod_passenger.so", install_dir
-	end
-	
-	desc "Install mod_passenger Apache 2 module and restart Apache"
-	task 'apache2:install_restart' do
-		sh "#{APACHE2CTL} stop" do end
-		unless `pidof apache2`.strip.empty?
-			sh "killall apache2" do end
-		end
-		Dir.chdir("../..") do
-			Rake::Task['apache2:install'].invoke
-		end
-		sh "#{APACHE2CTL} start"
+	file 'ApplicationPoolServerExecutable' => [
+		'../boost/src/libboost_thread.a',
+		'ApplicationPoolServerExecutable.cpp',
+		'ApplicationPool.h',
+		'StandardApplicationPool.h',
+		'MessageChannel.h',
+		'SpawnManager.h',
+		'System.o',
+		'Utils.o',
+		'Logging.o'
+	] do
+		create_executable "ApplicationPoolServerExecutable",
+			'ApplicationPoolServerExecutable.cpp System.o Utils.o Logging.o',
+			"-I.. #{CXXFLAGS} #{LDFLAGS} -DPASSENGER_DEBUG ../boost/src/libboost_thread.a -lpthread"
 	end
 	
 	file 'mod_passenger.o' => ['mod_passenger.c'] do
@@ -169,7 +173,8 @@ subdir 'ext/apache2' do
 	
 	desc "Remove generated files for mod_passenger Apache 2 module"
 	task 'apache2:clean' do
-		files = [APACHE2::OBJECTS.keys, %w(mod_passenger.o mod_passenger.so)]
+		files = [APACHE2::OBJECTS.keys, %w(mod_passenger.o mod_passenger.so
+			ApplicationPoolServerExecutable)]
 		sh("rm", "-rf", *files.flatten)
 	end
 end
@@ -183,23 +188,26 @@ class TEST
 	
 	AP2_OBJECTS = {
 		'CxxTestMain.o' => %w(CxxTestMain.cpp),
-		'MessageChannelTest.o' => %w(MessageChannelTest.cpp ../ext/apache2/MessageChannel.h),
+		'MessageChannelTest.o' => %w(MessageChannelTest.cpp
+			../ext/apache2/MessageChannel.h
+			../ext/apache2/System.h),
 		'SpawnManagerTest.o' => %w(SpawnManagerTest.cpp
 			../ext/apache2/SpawnManager.h
 			../ext/apache2/Application.h
-			../ext/apache2/MessageChannel.h),
+			../ext/apache2/MessageChannel.h
+			../ext/apache2/System.h),
 		'ApplicationPoolServerTest.o' => %w(ApplicationPoolServerTest.cpp
-			../ext/apache2/StandardApplicationPool.h
-			../ext/apache2/ApplicationPoolClientServer.h
-			../ext/apache2/MessageChannel.h),
+			../ext/apache2/ApplicationPoolServer.h
+			../ext/apache2/MessageChannel.h
+			../ext/apache2/System.h),
 		'ApplicationPoolServer_ApplicationPoolTest.o' => %w(ApplicationPoolServer_ApplicationPoolTest.cpp
 			ApplicationPoolTest.cpp
-			../ext/apache2/ApplicationPoolClientServer.h
+			../ext/apache2/ApplicationPoolServer.h
 			../ext/apache2/ApplicationPool.h
-			../ext/apache2/StandardApplicationPool.h
 			../ext/apache2/SpawnManager.h
 			../ext/apache2/Application.h
-			../ext/apache2/MessageChannel.h),
+			../ext/apache2/MessageChannel.h
+			../ext/apache2/System.h),
 		'StandardApplicationPoolTest.o' => %w(StandardApplicationPoolTest.cpp
 			ApplicationPoolTest.cpp
 			../ext/apache2/ApplicationPool.h
@@ -215,18 +223,34 @@ subdir 'test' do
 	task :test => [:'test:apache2', :'test:ruby', :'test:integration']
 	
 	desc "Run unit tests for the Apache 2 module"
-	task 'test:apache2' => ['Apache2ModuleTests', :native_support] do
+	task 'test:apache2' => [
+		'Apache2ModuleTests',
+		'../ext/apache2/ApplicationPoolServerExecutable',
+		:native_support
+	] do
 		sh "./Apache2ModuleTests"
 	end
 	
 	desc "Run unit tests for the Apache 2 module in Valgrind"
-	task 'test:valgrind' => ['Apache2ModuleTests', :native_support] do
+	task 'test:valgrind' => [
+		'Apache2ModuleTests',
+		'../ext/apache2/ApplicationPoolServerExecutable',
+		:native_support
+	] do
 		sh "valgrind #{ENV['ARGS']} ./Apache2ModuleTests"
 	end
 	
 	desc "Run unit tests for the Ruby libraries"
 	task 'test:ruby' => [:native_support] do
-		sh "spec -c -f s *_spec.rb"
+		sh "spec -c -f s ruby/*.rb ruby/*/*.rb"
+	end
+	
+	task 'test:rcov' => [:native_support] do
+		rspec = PlatformInfo.find_command('spec')
+		sh "rcov", "--exclude",
+			"lib\/spec,\/spec$,_spec\.rb$,support\/,platform_info,integration_tests",
+			rspec, "--", "-c", "-f", "s",
+			*Dir["ruby/*.rb", "ruby/*/*.rb", "integration_tests.rb"]
 	end
 	
 	desc "Run integration tests"
@@ -236,9 +260,11 @@ subdir 'test' do
 
 	file 'Apache2ModuleTests' => TEST::AP2_OBJECTS.keys +
 	  ['../ext/boost/src/libboost_thread.a',
+	   '../ext/apache2/System.o',
 	   '../ext/apache2/Utils.o',
 	   '../ext/apache2/Logging.o'] do
 		objects = TEST::AP2_OBJECTS.keys.join(' ') <<
+			" ../ext/apache2/System.o" <<
 			" ../ext/apache2/Utils.o" <<
 			" ../ext/apache2/Logging.o"
 		create_executable "Apache2ModuleTests", objects,
@@ -274,13 +300,32 @@ end
 
 subdir 'benchmark' do
 	file 'DummyRequestHandler' => ['DummyRequestHandler.cpp',
-	  '../ext/apache2/MessageChannel.h'] do
+	  '../ext/apache2/MessageChannel.h',
+	  '../ext/apache2/System.o',
+	  '../ext/boost/src/libboost_thread.a'] do
 		create_executable "DummyRequestHandler", "DummyRequestHandler.cpp",
-			"-I../ext -I../ext/apache2 #{CXXFLAGS} #{LDFLAGS}"
+			"-I../ext -I../ext/apache2 #{CXXFLAGS} #{LDFLAGS} " <<
+			"../ext/apache2/System.o " <<
+			"../ext/boost/src/libboost_thread.a -lpthread"
+	end
+	
+	file 'ApplicationPool' => ['ApplicationPool.cpp',
+	  '../ext/apache2/StandardApplicationPool.h',
+	  '../ext/apache2/ApplicationPoolServerExecutable',
+	  '../ext/apache2/System.o',
+	  '../ext/apache2/Logging.o',
+	  '../ext/apache2/Utils.o',
+	  '../ext/boost/src/libboost_thread.a',
+	  :native_support] do
+		create_executable "ApplicationPool", "ApplicationPool.cpp",
+			"-I../ext -I../ext/apache2 #{CXXFLAGS} #{LDFLAGS} " <<
+			"../ext/apache2/System.o ../ext/apache2/Logging.o " <<
+			"../ext/apache2/Utils.o " <<
+			"../ext/boost/src/libboost_thread.a -lpthread"
 	end
 	
 	task :clean do
-		sh "rm -f DummyRequestHandler"
+		sh "rm -f DummyRequestHandler ApplicationPool"
 	end
 end
 
@@ -345,9 +390,10 @@ spec = Gem::Specification.new do |s|
 	s.author = "Phusion - http://www.phusion.nl/"
 	s.email = "info@phusion.nl"
 	s.requirements << "fastthread" << "Apache 2 with development headers"
-	s.require_path = "lib"
+	s.require_path = ["lib", "ext"]
 	s.add_dependency 'rake', '>= 0.8.1'
 	s.add_dependency 'fastthread', '>= 1.0.1'
+	s.add_dependency 'rack', '>= 0.1.0'
 	s.extensions << 'ext/passenger/extconf.rb'
 	s.files = FileList[
 		'Rakefile',
@@ -356,22 +402,34 @@ spec = Gem::Specification.new do |s|
 		'LICENSE',
 		'INSTALL',
 		'lib/**/*.rb',
+		'lib/**/*.py',
 		'lib/passenger/templates/*',
 		'bin/*',
 		'doc/*',
+		
+		# If you're running 'rake package' for the first time, then these
+		# files don't exist yet, and so won't be matched by the above glob.
+		# So we add these filenames manually.
+		'doc/Users guide.html',
+		'doc/Security of user switching support.html',
+		
 		'doc/*/*',
 		'doc/*/*/*',
 		'doc/*/*/*/*',
 		'doc/*/*/*/*/*',
 		'doc/*/*/*/*/*/*',
+		'man/*',
+		'debian/*',
 		'ext/apache2/*.{cpp,h,c,TXT}',
 		'ext/boost/*.{hpp,TXT}',
-		'ext/boost/**/*.{hpp,cpp,pl,inl}',
+		'ext/boost/**/*.{hpp,cpp,pl,inl,ipp}',
 		'ext/passenger/*.{c,rb}',
 		'benchmark/*.{cpp,rb}',
 		'misc/*',
 		'test/*.{rb,cpp,example}',
 		'test/support/*',
+		'test/ruby/*',
+		'test/ruby/*/*',
 		'test/stub/*',
 		'test/stub/*/*',
 		'test/stub/*/*/*',
@@ -387,7 +445,9 @@ spec = Gem::Specification.new do |s|
 		'passenger-install-apache2-module',
 		'passenger-config',
 		'passenger-memory-stats',
-		'passenger-make-enterprisey'
+		'passenger-make-enterprisey',
+		'passenger-status',
+		'passenger-stress-test'
 	]
 	s.has_rdoc = true
 	s.extra_rdoc_files = ['README']
@@ -410,6 +470,71 @@ Rake::Task['package:force'].prerequisites.unshift(:doc)
 task :clobber => :'package:clean'
 
 
+##### Misc
+
+desc "Create a fakeroot, useful for building native packages"
+task :fakeroot => [:apache2, :native_support, :doc] do
+	require 'rbconfig'
+	include Config
+	fakeroot = "pkg/fakeroot"
+
+	# We don't use CONFIG['archdir'] and the like because we want
+	# the files to be installed to /usr, and the Ruby interpreter
+	# on the packaging machine might be in /usr/local.
+	libdir = "#{fakeroot}/usr/lib/ruby/#{CONFIG['ruby_version']}"
+	extdir = "#{libdir}/#{CONFIG['arch']}"
+	bindir = "#{fakeroot}/usr/bin"
+	docdir = "#{fakeroot}/usr/share/doc/passenger"
+	libexecdir = "#{fakeroot}/usr/lib/passenger"
+	
+	sh "rm -rf #{fakeroot}"
+	sh "mkdir -p #{fakeroot}"
+	
+	sh "mkdir -p #{libdir}"
+	sh "cp -R lib/passenger #{libdir}/"
+
+	sh "mkdir -p #{fakeroot}/etc"
+	sh "echo -n '#{PACKAGE_VERSION}' > #{fakeroot}/etc/passenger_version.txt"
+	
+	sh "mkdir -p #{extdir}/passenger"
+	sh "cp -R ext/passenger/*.#{LIBEXT} #{extdir}/passenger/"
+	
+	sh "mkdir -p #{bindir}"
+	sh "cp bin/* #{bindir}/"
+	
+	sh "mkdir -p #{libexecdir}"
+	sh "cp ext/apache2/mod_passenger.so #{libexecdir}/"
+	sh "mv #{fakeroot}/usr/bin/passenger-spawn-server #{libexecdir}/"
+	sh "cp ext/apache2/ApplicationPoolServerExecutable #{libexecdir}/"
+	
+	sh "mkdir -p #{docdir}"
+	sh "cp -R doc/* #{docdir}/"
+	sh "rm", "-rf", *Dir["#{docdir}/{definitions.h,Doxyfile,template}"]
+end
+
+desc "Create a Debian package"
+task 'package:debian' => :fakeroot do
+	if Process.euid != 0
+		STDERR.puts
+		STDERR.puts "*** ERROR: the 'package:debian' task must be run as root."
+		STDERR.puts
+		exit 1
+	end
+
+	fakeroot = "pkg/fakeroot"
+	arch = `uname -m`.strip
+	if arch =~ /^i.86$/
+		arch = "i386"
+	end
+	
+	sh "sed -i 's/Version: .*/Version: #{PACKAGE_VERSION}/' debian/control"
+	sh "cp -R debian #{fakeroot}/DEBIAN"
+	sh "sed -i 's/: any/: #{arch}/' #{fakeroot}/DEBIAN/control"
+	sh "chown -R root:root #{fakeroot}"
+	sh "dpkg -b #{fakeroot} pkg/passenger_#{PACKAGE_VERSION}-#{arch}.deb"
+end
+
+
 ##### Misc
 
 desc "Run 'sloccount' to see how much code Passenger has"